diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/Audio.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/Audio.cs index 24492ccd..408f1abc 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/Audio.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/Audio.cs @@ -41,17 +41,15 @@ namespace WinterLeaf.Demo.Full.Models.User.CustomObjects.Utilities { public class Audio { - public static pInvokes tst = new pInvokes(); - public static void AudioServerPlay2D(string profile) { - foreach (GameConnection clientid in tst.ClientGroup) + foreach (GameConnection clientid in pInvokes.ClientGroup) clientid.play2D(profile); } public static void AudioServerPlay3D(string profile, TransformF transform) { - foreach (GameConnection clientid in tst.ClientGroup) + foreach (GameConnection clientid in pInvokes.ClientGroup) clientid.play3D(profile, transform); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audio.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audio.cs index eace4014..15e206d2 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audio.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audio.cs @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Audio { public class audio { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { SingletonCreator sc = new SingletonCreator("SFXDescription", "AudioMaster"); @@ -124,16 +122,16 @@ public static void initialize() // Volume channel IDs for backwards-compatibility. - omni.iGlobal["$GuiAudioType"] = 1; // Interface. - omni.iGlobal["$SimAudioType"] = 2; // Game. - omni.iGlobal["$MessageAudioType"] = 3; // Notifications. - omni.iGlobal["$MusicAudioType"] = 4; // Music. + pInvokes.iGlobal["$GuiAudioType"] = 1; // Interface. + pInvokes.iGlobal["$SimAudioType"] = 2; // Game. + pInvokes.iGlobal["$MessageAudioType"] = 3; // Notifications. + pInvokes.iGlobal["$MusicAudioType"] = 4; // Music. - omni.sGlobal["$AudioChannels[0]"] = "AudioChannelDefault"; - omni.sGlobal["$AudioChannels[" + omni.sGlobal["$GuiAudioType"] + "]"] = "AudioChannelGui"; - omni.sGlobal["$AudioChannels[" + omni.sGlobal["$SimAudioType"] + "]"] = "AudioChannelEffects"; - omni.sGlobal["$AudioChannels[" + omni.sGlobal["$MessageAudioType"] + "]"] = "AudioChannelMessages"; - omni.sGlobal["$AudioChannels[" + omni.sGlobal["$MusicAudioType"] + "]"] = "AudioChannelMusic"; + pInvokes.sGlobal["$AudioChannels[0]"] = "AudioChannelDefault"; + pInvokes.sGlobal["$AudioChannels[" + pInvokes.sGlobal["$GuiAudioType"] + "]"] = "AudioChannelGui"; + pInvokes.sGlobal["$AudioChannels[" + pInvokes.sGlobal["$SimAudioType"] + "]"] = "AudioChannelEffects"; + pInvokes.sGlobal["$AudioChannels[" + pInvokes.sGlobal["$MessageAudioType"] + "]"] = "AudioChannelMessages"; + pInvokes.sGlobal["$AudioChannels[" + pInvokes.sGlobal["$MusicAudioType"] + "]"] = "AudioChannelMusic"; sc = new SingletonCreator("SimSet", "SFXPausedSet"); sc.Create(); @@ -143,42 +141,42 @@ public static void sfxStartup() { // The console builds should re-detect, by default, so that it plays nicely // along side a PC build in the same script directory. - if (omni.console.GetVarString("$platform") == "xenon") + if (pInvokes.console.GetVarString("$platform") == "xenon") { - if (omni.console.GetVarString("$pref::SFX::provider") == "DirectSound" || omni.console.GetVarString("$pref::SFX::provider") == "OpenAL") - omni.console.SetVar("$pref::SFX::provider", ""); - if (omni.console.GetVarString("$pref::SFX::provider") == "") + if (pInvokes.console.GetVarString("$pref::SFX::provider") == "DirectSound" || pInvokes.console.GetVarString("$pref::SFX::provider") == "OpenAL") + pInvokes.console.SetVar("$pref::SFX::provider", ""); + if (pInvokes.console.GetVarString("$pref::SFX::provider") == "") { - omni.console.SetVar("$pref::SFX::autoDetect", 1); - omni.console.warn("Xbox360 is auto-detecting available sound providers..."); - omni.console.warn(" - You may wish to alter this functionality before release (core/scripts/client/audio.cs)"); + pInvokes.console.SetVar("$pref::SFX::autoDetect", 1); + pInvokes.console.warn("Xbox360 is auto-detecting available sound providers..."); + pInvokes.console.warn(" - You may wish to alter this functionality before release (core/scripts/client/audio.cs)"); } } - omni.console.print("sfxStartup..."); + pInvokes.console.print("sfxStartup..."); // If we have a provider set, try initialize a device now. - if (omni.sGlobal["$pref::SFX::provider"] == "") + if (pInvokes.sGlobal["$pref::SFX::provider"] == "") { if (sfxInit()) return; else { // Force auto-detection. - omni.bGlobal["$pref::SFX::autoDetect"] = true; + pInvokes.bGlobal["$pref::SFX::autoDetect"] = true; if (sfxAutodetect()) return; } } else { - omni.bGlobal["$pref::SFX::autoDetect"] = true; + pInvokes.bGlobal["$pref::SFX::autoDetect"] = true; if (sfxAutodetect()) return; } // Failure. - omni.console.error("Failed to initialize device!\n\n"); - omni.sGlobal["$pref::SFX::provider"] = ""; - omni.sGlobal["$pref::SFX::device"] = ""; + pInvokes.console.error("Failed to initialize device!\n\n"); + pInvokes.sGlobal["$pref::SFX::provider"] = ""; + pInvokes.sGlobal["$pref::SFX::device"] = ""; } public static bool sfxInit() @@ -186,62 +184,62 @@ public static bool sfxInit() // This initializes the sound system device from // the defaults in the $pref::SFX:: globals. // If already initialized, shut down the current device first. - if (omni.Util.sfxGetDeviceInfo() != "") + if (pInvokes.Util.sfxGetDeviceInfo() != "") sfxShutdown(); // Start it up! - int maxBuffers = omni.bGlobal["$pref::SFX::useHardware"] ? -1 : omni.iGlobal["$pref::SFX::maxSoftwareBuffers"]; - if (!omni.Util.sfxCreateDevice(omni.sGlobal["$pref::SFX::provider"], omni.sGlobal["$pref::SFX::device"], omni.bGlobal["$pref::SFX::useHardware"], maxBuffers)) + int maxBuffers = pInvokes.bGlobal["$pref::SFX::useHardware"] ? -1 : pInvokes.iGlobal["$pref::SFX::maxSoftwareBuffers"]; + if (!pInvokes.Util.sfxCreateDevice(pInvokes.sGlobal["$pref::SFX::provider"], pInvokes.sGlobal["$pref::SFX::device"], pInvokes.bGlobal["$pref::SFX::useHardware"], maxBuffers)) return false; // This returns a tab seperated string with // the initialized system info. - string info = omni.Util.sfxGetDeviceInfo(); - omni.sGlobal["$pref::SFX::provider"] = omni.Util.getField(info, 0); - omni.sGlobal["$pref::SFX::device"] = omni.Util.getField(info, 1); - omni.sGlobal["$pref::SFX::useHardware"] = omni.Util.getField(info, 2); + string info = pInvokes.Util.sfxGetDeviceInfo(); + pInvokes.sGlobal["$pref::SFX::provider"] = pInvokes.Util.getField(info, 0); + pInvokes.sGlobal["$pref::SFX::device"] = pInvokes.Util.getField(info, 1); + pInvokes.sGlobal["$pref::SFX::useHardware"] = pInvokes.Util.getField(info, 2); - string useHardware = omni.bGlobal["$pref::SFX::useHardware"] ? "Yes" : "No"; - maxBuffers = omni.Util.getField(info, 3).AsInt(); + string useHardware = pInvokes.bGlobal["$pref::SFX::useHardware"] ? "Yes" : "No"; + maxBuffers = pInvokes.Util.getField(info, 3).AsInt(); - omni.console.print(" Provider: " + omni.console.GetVarString("$pref::SFX::provider")); - omni.console.print(" Device: " + omni.console.GetVarString("$pref::SFX::device")); - omni.console.print(" Hardware: " + useHardware); - omni.console.print(" Buffers: " + maxBuffers.AsString()); + pInvokes.console.print(" Provider: " + pInvokes.console.GetVarString("$pref::SFX::provider")); + pInvokes.console.print(" Device: " + pInvokes.console.GetVarString("$pref::SFX::device")); + pInvokes.console.print(" Hardware: " + useHardware); + pInvokes.console.print(" Buffers: " + maxBuffers.AsString()); - if (omni.Util.isDefined("$pref::SFX::distanceModel") && omni.sGlobal["$pref::SFX::distanceModel"] != "") + if (pInvokes.Util.isDefined("$pref::SFX::distanceModel") && pInvokes.sGlobal["$pref::SFX::distanceModel"] != "") { - TypeSFXDistanceModel t = omni.sGlobal["$pref::SFX::distanceModel"]; - omni.Util.sfxSetDistanceModel(t); + TypeSFXDistanceModel t = pInvokes.sGlobal["$pref::SFX::distanceModel"]; + pInvokes.Util.sfxSetDistanceModel(t); } - if (omni.Util.isDefined("$pref::SFX::dopplerFactor")) - omni.Util.sfxSetDopplerFactor(omni.fGlobal["$pref::SFX::dopplerFactor"]); + if (pInvokes.Util.isDefined("$pref::SFX::dopplerFactor")) + pInvokes.Util.sfxSetDopplerFactor(pInvokes.fGlobal["$pref::SFX::dopplerFactor"]); - if (omni.Util.isDefined("$pref::SFX::rolloffFactor") && omni.sGlobal["$pref::SFX::rolloffFactor"] != "") - omni.Util.sfxSetRolloffFactor(omni.fGlobal["$pref::SFX::rolloffFactor"]); + if (pInvokes.Util.isDefined("$pref::SFX::rolloffFactor") && pInvokes.sGlobal["$pref::SFX::rolloffFactor"] != "") + pInvokes.Util.sfxSetRolloffFactor(pInvokes.fGlobal["$pref::SFX::rolloffFactor"]); // Restore master volume. - sfxSetMasterVolume(omni.fGlobal["$pref::SFX::masterVolume"]); + sfxSetMasterVolume(pInvokes.fGlobal["$pref::SFX::masterVolume"]); // Restore channel volumes. for (int channel = 0; channel <= 8; channel++) - sfxSetChannelVolume(((SimSet) channel), omni.fGlobal["$pref::SFX::channelVolume[" + channel.AsString() + "]"]); + sfxSetChannelVolume(((SimSet) channel), pInvokes.fGlobal["$pref::SFX::channelVolume[" + channel.AsString() + "]"]); return true; } // Destroys the current sound system device. public static void sfxShutdown() { - omni.fGlobal["$pref::SFX::masterVolume"] = sfxGetMasterVolume(); + pInvokes.fGlobal["$pref::SFX::masterVolume"] = sfxGetMasterVolume(); for (int channel = 0; channel <= 8; channel++) - omni.sGlobal["$pref::SFX::channelVolume[" + channel.AsString() + "]"] = sfxGetChannelVolume(channel); + pInvokes.sGlobal["$pref::SFX::channelVolume[" + channel.AsString() + "]"] = sfxGetChannelVolume(channel); // We're assuming here that a null info // string means that no device is loaded. - if (omni.Util.sfxGetDeviceInfo() == "") + if (pInvokes.Util.sfxGetDeviceInfo() == "") return; - omni.Util.sfxDeleteDevice(); + pInvokes.Util.sfxDeleteDevice(); } // Determines which of the two SFX providers is preferable. @@ -272,17 +270,17 @@ public static string sfxCompareProvider(string providerA, string providerB) public static bool sfxAutodetect() { // Get all the available devices. - string devices = omni.Util.sfxGetAvailableDevices(); + string devices = pInvokes.Util.sfxGetAvailableDevices(); // Collect and sort the devices by preferentiality. - int count = omni.Util.getRecordCount(devices); + int count = pInvokes.Util.getRecordCount(devices); ArrayObject deviceTrySequence = new ObjectCreator("ArrayObject").Create().AsString(); for (int i = 0; i < count; i++) { - string info = omni.Util.getRecord(devices, i); - string provider = omni.Util.getField(info, 0); + string info = pInvokes.Util.getRecord(devices, i); + string provider = pInvokes.Util.getField(info, 0); deviceTrySequence.push_back(provider, info); } deviceTrySequence.sortfk("sfxCompareProvider"); @@ -293,23 +291,23 @@ public static bool sfxAutodetect() { string provider = deviceTrySequence.getKey(i); string info = deviceTrySequence.getValue(i); - omni.sGlobal["$pref::SFX::provider"] = provider; - omni.sGlobal["$pref::SFX::device"] = omni.Util.getField(info, 1); - omni.sGlobal["$pref::SFX::useHardware"] = omni.Util.getField(info, 2); + pInvokes.sGlobal["$pref::SFX::provider"] = provider; + pInvokes.sGlobal["$pref::SFX::device"] = pInvokes.Util.getField(info, 1); + pInvokes.sGlobal["$pref::SFX::useHardware"] = pInvokes.Util.getField(info, 2); // By default we've decided to avoid hardware devices as // they are buggy and prone to problems. - omni.bGlobal["$pref::SFX::useHardware"] = false; + pInvokes.bGlobal["$pref::SFX::useHardware"] = false; if (!sfxInit()) continue; - omni.bGlobal["$pref::SFX::autoDetect"] = false; + pInvokes.bGlobal["$pref::SFX::autoDetect"] = false; deviceTrySequence.delete(); return true; } // Found no suitable device. - omni.console.error("sfxAutodetect - Could not initialize a valid SFX device."); - omni.sGlobal["$pref::SFX::provider"] = ""; - omni.sGlobal["$pref::SFX::device"] = ""; - omni.sGlobal["$pref::SFX::useHardware"] = ""; + pInvokes.console.error("sfxAutodetect - Could not initialize a valid SFX device."); + pInvokes.sGlobal["$pref::SFX::provider"] = ""; + pInvokes.sGlobal["$pref::SFX::device"] = ""; + pInvokes.sGlobal["$pref::SFX::useHardware"] = ""; deviceTrySequence.delete(); return false; } @@ -317,7 +315,7 @@ public static bool sfxAutodetect() [ConsoleInteraction(true)] public static SFXSource sfxOldChannelToGroup(string channel) { - return omni.sGlobal["$AudioChannels[" + channel + "]"]; + return pInvokes.sGlobal["$AudioChannels[" + channel + "]"]; } [ConsoleInteraction(true)] @@ -326,9 +324,9 @@ public static string sfxGroupToOldChannel(string group) string id = group.getID().AsString(); for (int i = 0;; i++) { - if (!omni.isGlobal["$AudioChannels[" + i.AsString() + "]"]) + if (!pInvokes.isGlobal["$AudioChannels[" + i.AsString() + "]"]) return "-1"; - else if (omni.sGlobal["$AudioChannels[" + i.AsString() + "]"] == id) + else if (pInvokes.sGlobal["$AudioChannels[" + i.AsString() + "]"] == id) return i.AsString(); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audioData.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audioData.cs index 2aa851ff..b1ed73d2 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audioData.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audioData.cs @@ -42,8 +42,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Audio // before SFXProfile's (the sound itself) when creating new ones public class audioData { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { SingletonCreator sc = new SingletonCreator("SFXDescription", "BulletFireDesc : AudioEffect"); @@ -62,8 +60,8 @@ public static void initialize() sc["pitch"] = 1.4; sc.Create(); - if (omni.Util.isFile("scripts/client/audioData.cs")) - omni.Util.exec("scripts/client/audioData.cs", false, false); + if (pInvokes.Util.isFile("scripts/client/audioData.cs")) + pInvokes.Util.exec("scripts/client/audioData.cs", false, false); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/CenterPrint/centerPrint.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/CenterPrint/centerPrint.cs index eb30afd1..bc8dc1e8 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/CenterPrint/centerPrint.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/CenterPrint/centerPrint.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -42,15 +42,13 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.CenterPrint { public class centerPrint { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.iGlobal["$centerPrintActive"] = 0; - omni.iGlobal["$bottomPrintActive"] = 0; - omni.iGlobal["$CenterPrintSizes[1]"] = 20; - omni.iGlobal["$CenterPrintSizes[2]"] = 36; - omni.iGlobal["$CenterPrintSizes[3]"] = 56; + pInvokes.iGlobal["$centerPrintActive"] = 0; + pInvokes.iGlobal["$bottomPrintActive"] = 0; + pInvokes.iGlobal["$CenterPrintSizes[1]"] = 20; + pInvokes.iGlobal["$CenterPrintSizes[2]"] = 36; + pInvokes.iGlobal["$CenterPrintSizes[3]"] = 56; } [ConsoleInteraction(true)] @@ -58,21 +56,21 @@ public static void clientCmdCenterPrint(string message, string time, string size { GuiBitmapCtrl centerPrintDlg = "centerPrintDlg"; - if (omni.bGlobal["$centerPrintActive"]) + if (pInvokes.bGlobal["$centerPrintActive"]) { if (centerPrintDlg["removePrint"] != "") - omni.Util.cancel(centerPrintDlg["removePrint"].AsInt()); + pInvokes.Util.cancel(centerPrintDlg["removePrint"].AsInt()); } else { centerPrintDlg["visible"] = "1"; - omni.iGlobal["$centerPrintActive"] = 1; + pInvokes.iGlobal["$centerPrintActive"] = 1; } ((GuiMLTextCtrl) "CenterPrintText").setText("" + message); - centerPrintDlg.extent.y = omni.iGlobal["$CenterPrintSizes[" + size + "]"]; + centerPrintDlg.extent.y = pInvokes.iGlobal["$CenterPrintSizes[" + size + "]"]; if (time.AsInt() > 0) - centerPrintDlg["removePrint"] = omni.Util._schedule((time.AsInt()*1000).AsString(), "0", "clientCmdClearCenterPrint").AsString(); + centerPrintDlg["removePrint"] = pInvokes.Util._schedule((time.AsInt()*1000).AsString(), "0", "clientCmdClearCenterPrint").AsString(); } [ConsoleInteraction(true)] @@ -80,20 +78,20 @@ public static void clientCmdBottomPrint(string message, string time, string size { GuiBitmapCtrl bottomPrintDlg = "bottomPrintDlg"; - if (omni.bGlobal["$bottomPrintActive"]) + if (pInvokes.bGlobal["$bottomPrintActive"]) { if (bottomPrintDlg["removePrint"] != "") - omni.Util.cancel(bottomPrintDlg["removePrint"].AsInt()); + pInvokes.Util.cancel(bottomPrintDlg["removePrint"].AsInt()); } else { bottomPrintDlg.setVisible(true); - omni.iGlobal["$bottomPrintActive"] = 1; + pInvokes.iGlobal["$bottomPrintActive"] = 1; } ((GuiMLTextCtrl) "bottomPrintText").setText("" + message); - bottomPrintDlg.extent.y = omni.iGlobal["$CenterPrintSizes[" + size + "]"]; + bottomPrintDlg.extent.y = pInvokes.iGlobal["$CenterPrintSizes[" + size + "]"]; if (time.AsInt() > 0) - bottomPrintDlg["removePrint"] = omni.Util._schedule((time.AsInt()*1000).AsString(), "0", "clientCmdClearbottomPrint").AsString(); + bottomPrintDlg["removePrint"] = pInvokes.Util._schedule((time.AsInt()*1000).AsString(), "0", "clientCmdClearbottomPrint").AsString(); } //Bottom and Center PrintText resize is controled through proxy object printText.cs @@ -101,7 +99,7 @@ public static void clientCmdBottomPrint(string message, string time, string size [ConsoleInteraction(true)] public static void clientCmdClearCenterPrint() { - omni.iGlobal["$centerPrintActive"] = 0; + pInvokes.iGlobal["$centerPrintActive"] = 0; GuiBitmapCtrl CenterPrintDlg = "CenterPrintDlg"; CenterPrintDlg.visible = false; CenterPrintDlg["removePrint"] = ""; @@ -110,7 +108,7 @@ public static void clientCmdClearCenterPrint() [ConsoleInteraction(true)] public static void clientCmdClearBottomPrint() { - omni.iGlobal["$bottomPrintActive"] = 0; + pInvokes.iGlobal["$bottomPrintActive"] = 0; GuiBitmapCtrl BottomPrintDlg = "BottomPrintDlg"; BottomPrintDlg.visible = false; BottomPrintDlg["removePrint"] = ""; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/GameConnection.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/GameConnection.cs index 45ecf1cb..d2c01058 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/GameConnection.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/GameConnection.cs @@ -56,13 +56,13 @@ public override bool OnFunctionNotFoundCallTorqueScript() public static void initialize() { - omni.Util.eval(@"function disconnect(){_disconnect();}"); + Util.eval(@"function disconnect(){_disconnect();}"); } [ConsoleInteraction(true)] public static void handleConnectionErrorMessage(string msgType, string msgString, string msgError) { - omni.console.SetVar("$ServerConnectionErrorMessage", msgError); + console.SetVar("$ServerConnectionErrorMessage", msgError); } [ConsoleInteraction(true)] @@ -201,7 +201,7 @@ public static void _disconnect() { // We need to stop the client side simulation // else physics resources will not cleanup properly. - omni.Util.physicsStopSimulation("client"); + Util.physicsStopSimulation("client"); // Before we destroy the client physics world // make sure all ServerConnection objects are deleted. @@ -221,13 +221,13 @@ public static void _disconnect() public static void disconnectedCleanup() { // End mission, if it's running. - if (omni.console.GetVarBool("$Client::missionRunning")) + if (console.GetVarBool("$Client::missionRunning")) mission.clientEndMission(); // Disable mission lighting if it's going, this is here // in case we're disconnected while the mission is loading. - omni.bGlobal["$lightingMission"] = false; - omni.bGlobal["$sceneLighting::terminateLighting"] = true; + bGlobal["$lightingMission"] = false; + bGlobal["$sceneLighting::terminateLighting"] = true; // Clear misc script stuff ((MessageVector) "HudMessageVector").clear(); @@ -236,10 +236,10 @@ public static void disconnectedCleanup() centerPrint.clientCmdClearBottomPrint(); centerPrint.clientCmdClearCenterPrint(); - if (omni.console.isObject("MainMenuGui")) + if (console.isObject("MainMenuGui")) ((GuiCanvas) "Canvas").setContent("MainMenuGui"); - omni.Util.physicsDestroyWorld("client"); + Util.physicsDestroyWorld("client"); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/ChooseLevel/chooseLevelDlg.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/ChooseLevel/chooseLevelDlg.cs index 769a7d41..23105140 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/ChooseLevel/chooseLevelDlg.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/ChooseLevel/chooseLevelDlg.cs @@ -62,13 +62,13 @@ public static void StartLevel(string mission, string hostingType) { GuiTextListCtrl CL_levelList = "CL_levelList"; if (mission == "") - mission = omni.Util.getField(CL_levelList.getRowTextById(CL_levelList.getSelectedId()), 1); + mission = Util.getField(CL_levelList.getRowTextById(CL_levelList.getSelectedId()), 1); string serverType = hostingType; if (serverType == "") { - if (omni.bGlobal["$pref::HostMultiPlayer"]) + if (bGlobal["$pref::HostMultiPlayer"]) serverType = "MultiPlayer"; else serverType = "SinglePlayer"; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Content Browser/ContentBrowserGui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Content Browser/ContentBrowserGui.cs index e0122e96..2d91c38f 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Content Browser/ContentBrowserGui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Content Browser/ContentBrowserGui.cs @@ -80,8 +80,6 @@ internal int columnId set { this["columnId"] = value.AsString(); } } - //private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { #region GuiWindowCtrl (ContentBrowserGui) oc_Newobject42 @@ -3235,7 +3233,7 @@ public override void onSleep() public static int sortArrayAscending(string itemA, string itemB) { ContentBrowserGui ContentBrowserGui = "ContentBrowserGui"; - return omni.Util.strcmp(omni.Util.getField(itemB, ContentBrowserGui.columnId), omni.Util.getField(itemA, ContentBrowserGui.columnId)); + return Util.strcmp(Util.getField(itemB, ContentBrowserGui.columnId), Util.getField(itemA, ContentBrowserGui.columnId)); } [ConsoleInteraction] @@ -3243,7 +3241,7 @@ public static int sortArrayDescending(string itemA, string itemB) { ContentBrowserGui ContentBrowserGui = "ContentBrowserGui"; - return omni.Util.strcmp(omni.Util.getField(itemB, ContentBrowserGui.columnId), omni.Util.getField(itemA, ContentBrowserGui.columnId)); + return Util.strcmp(Util.getField(itemB, ContentBrowserGui.columnId), Util.getField(itemA, ContentBrowserGui.columnId)); } [ConsoleInteraction] @@ -3254,9 +3252,9 @@ public static bool isMainCanvas(GuiCanvas rootCanvas, string screenPos) { string extent1 = rootCanvas.getWindowPosition().AsString() + rootCanvas.getExtent().AsString(); - string finalPos1 = (omni.Util.getWord(extent1, 0).AsInt() + omni.Util.getWord(extent1, 2).AsInt()) + " " + (omni.Util.getWord(extent1, 1).AsInt() + omni.Util.getWord(extent1, 3).AsInt()); + string finalPos1 = (Util.getWord(extent1, 0).AsInt() + Util.getWord(extent1, 2).AsInt()) + " " + (Util.getWord(extent1, 1).AsInt() + Util.getWord(extent1, 3).AsInt()); - if (omni.Util.getWord(screenPos, 0).AsInt() < omni.Util.getWord(extent1, 0).AsInt() || omni.Util.getWord(screenPos, 1).AsInt() < omni.Util.getWord(extent1, 1).AsInt() || omni.Util.getWord(screenPos, 0).AsInt() > omni.Util.getWord(finalPos1, 0).AsInt() || omni.Util.getWord(screenPos, 1).AsInt() > omni.Util.getWord(finalPos1, 1).AsInt()) + if (Util.getWord(screenPos, 0).AsInt() < Util.getWord(extent1, 0).AsInt() || Util.getWord(screenPos, 1).AsInt() < Util.getWord(extent1, 1).AsInt() || Util.getWord(screenPos, 0).AsInt() > Util.getWord(finalPos1, 0).AsInt() || Util.getWord(screenPos, 1).AsInt() > Util.getWord(finalPos1, 1).AsInt()) { //echo("Outside Root"); } @@ -3268,9 +3266,9 @@ public static bool isMainCanvas(GuiCanvas rootCanvas, string screenPos) string extent = Canvas.getWindowPosition().AsString() + Canvas.getExtent().AsString(); - string finalPos = (omni.Util.getWord(extent, 0).AsInt() + omni.Util.getWord(extent, 2).AsInt()) + " " + (omni.Util.getWord(extent, 1).AsInt() + omni.Util.getWord(extent, 3).AsInt()); + string finalPos = (Util.getWord(extent, 0).AsInt() + Util.getWord(extent, 2).AsInt()) + " " + (Util.getWord(extent, 1).AsInt() + Util.getWord(extent, 3).AsInt()); - if (omni.Util.getWord(screenPos, 0).AsInt() < omni.Util.getWord(extent, 0).AsInt() || omni.Util.getWord(screenPos, 1).AsInt() < omni.Util.getWord(extent, 1).AsInt() || omni.Util.getWord(screenPos, 0).AsInt() > omni.Util.getWord(finalPos, 0).AsInt() || omni.Util.getWord(screenPos, 1).AsInt() > omni.Util.getWord(finalPos, 1).AsInt()) + if (Util.getWord(screenPos, 0).AsInt() < Util.getWord(extent, 0).AsInt() || Util.getWord(screenPos, 1).AsInt() < Util.getWord(extent, 1).AsInt() || Util.getWord(screenPos, 0).AsInt() > Util.getWord(finalPos, 0).AsInt() || Util.getWord(screenPos, 1).AsInt() > Util.getWord(finalPos, 1).AsInt()) { //echo("Outside Canvas"); return false; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Cursor.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Cursor.cs index 6454548b..08f4bebd 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Cursor.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Cursor.cs @@ -40,11 +40,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui { public class cursor { - public static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - if (omni.sGlobal["$platform"] == "macos") + if (pInvokes.sGlobal["$platform"] == "macos") { ObjectCreator oc = new ObjectCreator("GuiCursor", "DefaultCursor"); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/JoinServerDlg.giu.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/JoinServerDlg.giu.cs index ad39af60..cf404a6e 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/JoinServerDlg.giu.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/JoinServerDlg.giu.cs @@ -786,7 +786,7 @@ public void update() [ConsoleInteraction] public static void onServerQueryStatus(string status, string msg, string value) { - omni.Util._echo("ServerQuery: " + " " + status + " " + msg + " " + value); + Util._echo("ServerQuery: " + " " + status + " " + msg + " " + value); // Update query status // States: start, update, ping, query, done // value = % (0-1) done for ping and query states diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Message Boxes/messageBox.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Message Boxes/messageBox.cs index 652e7c6a..6ca9708c 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Message Boxes/messageBox.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Message Boxes/messageBox.cs @@ -47,8 +47,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui { internal class messageBox { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { if ("MessagePopupDlg".isObject()) @@ -68,7 +66,7 @@ public static void initialize() #region exec("./messageBoxOk.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" %guiContent = new GuiControl(MessageBoxOKDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = """ + typeof (MessageBoxOKDlg).FullName + @"""; @@ -135,7 +133,7 @@ public static void initialize() #region exec("./messageBoxYesNo.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" %guiContent = new GuiControl(MessageBoxYesNoDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = """ + typeof (MessageBoxYesNoDlg).FullName + @"""; @@ -218,7 +216,7 @@ public static void initialize() #region exec("./messageBoxYesNoCancel.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" %guiContent = new GuiControl(MessageBoxYesNoCancelDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = """ + typeof (MessageBoxYesNoCancelDlg).FullName + @"""; @@ -330,7 +328,7 @@ public static void initialize() #region exec("./messageBoxOKCancel.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" //--- OBJECT WRITE BEGIN --- %guiContent = new GuiControl(MessageBoxOKCancelDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = ""WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui.Message_Boxes.MessageBoxOKCancelDlg""; @@ -414,7 +412,7 @@ public static void initialize() #region exec("./messageBoxOKCancelDetailsDlg.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" //--- OBJECT WRITE BEGIN --- %guiContent = new GuiControl(MessageBoxOKCancelDetailsDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = ""WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui.Message_Boxes.MessageBoxOKCancelDetailsDlg""; @@ -561,7 +559,7 @@ public static void initialize() #region exec("./messagePopup.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" //--- OBJECT WRITE BEGIN --- %guiContent = new GuiControl(MessagePopupDlg) { profile = ""GuiDefaultProfile""; @@ -615,7 +613,7 @@ public static void initialize() #region exec("./IODropdownDlg.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" //--- OBJECT WRITE BEGIN --- %guiContent = new GuiControl(IODropdownDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = ""WinterLeaf.userObjects.GameCode.Client.Gui.Message_Boxes.IODropdownDlg""; @@ -783,7 +781,7 @@ public static void initialize() #region new SFXDescription(MessageBoxAudioDescription) - omni.console.Eval(@" + pInvokes.console.Eval(@" new SFXDescription(MessageBoxAudioDescription) { volume = 1.0; @@ -814,8 +812,8 @@ public static void messageCallback(GuiControl dlg, string callback) { ((GuiCanvas) "Canvas").popDialog(dlg); if (callback.Trim() != "") - omni.Util.eval(callback); - //omni.console.Eval(callback); + pInvokes.Util.eval(callback); + //pInvokes.console.Eval(callback); } /// @@ -831,7 +829,7 @@ public static void IOCallback(GuiControl dlg, string callback) int id = IODropdownMenu.getSelected(); string text = IODropdownMenu.getTextById(id); callback = callback.Replace("#", text); - omni.console.Eval(callback); + pInvokes.console.Eval(callback); ((GuiCanvas) "Canvas").popDialog(dlg); } @@ -861,7 +859,7 @@ public static void MBSetText(GuiMLTextCtrl text, GuiWindowCtrl frame, string msg frame.canMaximize = false; //TODO - //omni.Util._sfxPlayOnce("messageBoxBeep"); + //pInvokes.Util._sfxPlayOnce("messageBoxBeep"); } [ConsoleInteraction(true)] @@ -984,7 +982,7 @@ public static void MessagePopup(string title, string message, int delay = 0) ((GuiCanvas) "Canvas").pushDialog("MessagePopupDlg"); MBSetText("MessagePopText", "MessagePopFrame", message); if (delay != 0) - omni.Util._schedule(delay.AsString(), "0", "CloseMessagePopup"); + pInvokes.Util._schedule(delay.AsString(), "0", "CloseMessagePopup"); } [ConsoleInteraction(true)] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/Misc.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/Misc.cs index 1e022e9d..347755f2 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/Misc.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/Misc.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -44,91 +44,89 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui.OptionsDlg { internal class Misc { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.iGlobal["$RemapCount"] = 0; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Forward"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "moveforward"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Backward"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "movebackward"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Strafe Left"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "moveleft"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Strafe Right"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "moveright"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Turn Left"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "turnLeft"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Turn Right"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "turnRight"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Look Up"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "panUp"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Look Down"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "panDown"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Jump"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "jump"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Fire Weapon"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "mouseFire"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Adjust Zoom"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "setZoomFov"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Toggle Zoom"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleZoom"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Free Look"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleFreeLook"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Switch 1st/3rd"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleFirstPerson"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Chat to Everyone"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleMessageHud"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Message Hud PageUp"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "pageMessageHudUp"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Message Hud PageDown"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "pageMessageHudDown"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Resize Message Hud"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "resizeMessageHud"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Show Scores"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "showPlayerList"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Animation - Wave"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "celebrationWave"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Animation - Salute"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "celebrationSalute"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Suicide"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "suicide"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Toggle Camera"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleCamera"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Drop Camera at Player"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "dropCameraAtPlayer"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Drop Player at Camera"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "dropPlayerAtCamera"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Bring up Options Dialog"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "bringUpOptions"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; + pInvokes.iGlobal["$RemapCount"] = 0; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Forward"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "moveforward"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Backward"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "movebackward"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Strafe Left"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "moveleft"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Strafe Right"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "moveright"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Turn Left"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "turnLeft"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Turn Right"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "turnRight"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Look Up"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "panUp"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Look Down"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "panDown"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Jump"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "jump"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Fire Weapon"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "mouseFire"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Adjust Zoom"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "setZoomFov"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Toggle Zoom"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleZoom"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Free Look"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleFreeLook"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Switch 1st/3rd"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleFirstPerson"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Chat to Everyone"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleMessageHud"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Message Hud PageUp"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "pageMessageHudUp"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Message Hud PageDown"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "pageMessageHudDown"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Resize Message Hud"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "resizeMessageHud"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Show Scores"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "showPlayerList"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Animation - Wave"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "celebrationWave"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Animation - Salute"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "celebrationSalute"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Suicide"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "suicide"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Toggle Camera"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleCamera"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Drop Camera at Player"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "dropCameraAtPlayer"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Drop Player at Camera"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "dropPlayerAtCamera"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Bring up Options Dialog"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "bringUpOptions"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; - omni.iGlobal["$AudioTestHandle"] = 0; + pInvokes.iGlobal["$AudioTestHandle"] = 0; // Description to use for playing the volume test sound. This isn't // played with the description of the channel that has its volume changed // because we know nothing about the playback state of the channel. If it @@ -137,7 +135,7 @@ public static void initialize() ObjectCreator oc = new ObjectCreator("SFXDescription"); oc["sourceGroup"] = "AudioChannelMaster"; - omni.sGlobal["$AudioTestDescription"] = oc.Create().AsString(); + pInvokes.sGlobal["$AudioTestDescription"] = oc.Create().AsString(); } [ConsoleInteraction(true)] @@ -151,38 +149,38 @@ public static void restoreDefaultMappings() [ConsoleInteraction(true)] public static void OptAudioUpdateMasterVolume(float volume) { - if (volume == omni.fGlobal["$pref::SFX::masterVolume"]) + if (volume == pInvokes.fGlobal["$pref::SFX::masterVolume"]) return; audio.sfxSetMasterVolume(volume); - omni.fGlobal["$pref::SFX::masterVolume"] = volume; + pInvokes.fGlobal["$pref::SFX::masterVolume"] = volume; - if (omni.sGlobal["$AudioTestHandle"].isObject()) - omni.iGlobal["$AudioTestHandle"] = omni.Util.sfxPlayOnce("AudioChannel", "art/sound/ui/volumeTest.wav"); + if (pInvokes.sGlobal["$AudioTestHandle"].isObject()) + pInvokes.iGlobal["$AudioTestHandle"] = pInvokes.Util.sfxPlayOnce("AudioChannel", "art/sound/ui/volumeTest.wav"); } [ConsoleInteraction(true)] public static void OptAudioUpdateChannelVolume(SFXDescription description, float volume) { string channel = audio.sfxGroupToOldChannel(description["sourceGroup"]); - if (volume == omni.fGlobal["$pref::SFX::channelVolume[" + channel + "]"]) + if (volume == pInvokes.fGlobal["$pref::SFX::channelVolume[" + channel + "]"]) return; audio.sfxSetChannelVolume(channel, volume); - omni.fGlobal["$pref::SFX::channelVolume[" + channel + "]"] = volume; + pInvokes.fGlobal["$pref::SFX::channelVolume[" + channel + "]"] = volume; - if (omni.sGlobal["$AudioTestHandle"].isObject()) + if (pInvokes.sGlobal["$AudioTestHandle"].isObject()) { - ((SFXDescription) omni.sGlobal["$AudioTestDescription"])["volume"] = volume.AsString(); - omni.fGlobal["$AudioTestHandle"] = omni.Util.sfxPlayOnce(omni.sGlobal["$AudioTestDescription"], "art/sound/ui/volumeTest.wav"); + ((SFXDescription) pInvokes.sGlobal["$AudioTestDescription"])["volume"] = volume.AsString(); + pInvokes.fGlobal["$AudioTestHandle"] = pInvokes.Util.sfxPlayOnce(pInvokes.sGlobal["$AudioTestDescription"], "art/sound/ui/volumeTest.wav"); } } [ConsoleInteraction(true)] public static void OptMouseSetSensitivity(float value) { - omni.fGlobal["$pref::Input::LinkMouseSensitivity"] = value; + pInvokes.fGlobal["$pref::Input::LinkMouseSensitivity"] = value; } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptRemapInputCtrl.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptRemapInputCtrl.cs index c242d021..b316c4b5 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptRemapInputCtrl.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptRemapInputCtrl.cs @@ -126,9 +126,9 @@ public override void onInputEvent(string device, string action, bool state) [ConsoleInteraction(true)] public static int findRemapCmdIndex(string command) { - for (int i = 0; i < omni.iGlobal["$RemapCount"]; i++) + for (int i = 0; i < iGlobal["$RemapCount"]; i++) { - if (command == omni.sGlobal["$RemapCmd[" + i + "]"]) + if (command == sGlobal["$RemapCmd[" + i + "]"]) return i; } return -1; @@ -143,11 +143,11 @@ public static void unbindExtraActions(string command, int count) if (temp == "") return; - count = omni.Util.getFieldCount(temp) - (count*2); + count = Util.getFieldCount(temp) - (count*2); for (int i = 0; i < count; i += 2) { - string device = omni.Util.getField(temp, i + 0); - string action = omni.Util.getField(temp, i + 1); + string device = Util.getField(temp, i + 0); + string action = Util.getField(temp, i + 1); ((ActionMap) "moveMap").unbind(device, action); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptionsDlg.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptionsDlg.cs index f347a714..47d7c7ab 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptionsDlg.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptionsDlg.cs @@ -3230,12 +3230,12 @@ public override bool OnFunctionNotFoundCallTorqueScript() [ConsoleInteraction(true)] public static string _makePrettyResString(string resString) { - string width = omni.Util.getWord(resString, omni.iGlobal["$WORD::RES_X"]); - string height = omni.Util.getWord(resString, omni.iGlobal["$WORD::RES_Y"]); + string width = Util.getWord(resString, iGlobal["$WORD::RES_X"]); + string height = Util.getWord(resString, iGlobal["$WORD::RES_Y"]); float aspect = width.AsFloat()/height.AsFloat(); - aspect = (float) Math.Round(aspect, 2); // omni.Util.mRound(aspect * 100.0f) * .01f; + aspect = (float) Math.Round(aspect, 2); // Util.mRound(aspect * 100.0f) * .01f; string newaspect = ""; if (aspect == 1.33f) newaspect = "4:3"; @@ -3519,7 +3519,7 @@ public bool applyGraphics(bool testNeedApply) if (!testNeedApply) _updateApplyState(); - omni.Util.export("$pref::*", "prefs.client.cs", false); + Util.export("$pref::*", "prefs.client.cs", false); return false; } @@ -3565,8 +3565,8 @@ public void doRemap() [ConsoleInteraction(true)] public static string buildFullMapString(int index) { - string name = omni.sGlobal["$RemapName[" + index + "]"]; - string cmd = omni.sGlobal["$RemapCmd[" + index + "]"]; + string name = sGlobal["$RemapName[" + index + "]"]; + string cmd = sGlobal["$RemapCmd[" + index + "]"]; string temp = ((ActionMap) "moveMap").getBinding(cmd); if (temp == "") @@ -3574,13 +3574,13 @@ public static string buildFullMapString(int index) string mapString = ""; - int count = omni.Util.getFieldCount(temp); + int count = Util.getFieldCount(temp); for (int i = 0; i < count; i += 2) { if (mapString != "") mapString = mapString + ", "; - string device = omni.Util.getField(temp, i + 0); - string obj = omni.Util.getField(temp, i + 1); + string device = Util.getField(temp, i + 0); + string obj = Util.getField(temp, i + 1); mapString = mapString + getMapDisplayName(device, obj); } return name + "\t" + mapString; @@ -3595,38 +3595,38 @@ public static string getMapDisplayName(string device, string action) if (device == "keyboard") return action; - else if (omni.Util.strstr(device, "mouse") != -1) + else if (Util.strstr(device, "mouse") != -1) { // Substitute "mouse" for "button" in the action string: - int pos = omni.Util.strstr(action, "button"); + int pos = Util.strstr(action, "button"); if (pos != -1) { - mods = omni.Util.getSubStr(action, 0, pos); - Object = omni.Util.getSubStr(action, pos, 1000); - instance = omni.Util.getSubStr(Object, omni.Util.strlen("button"), 1000); + mods = Util.getSubStr(action, 0, pos); + Object = Util.getSubStr(action, pos, 1000); + instance = Util.getSubStr(Object, Util.strlen("button"), 1000); return mods + "mouse" + (instance.AsInt() + 1); } else - omni.console.error("Mouse input object other than button passed to getDisplayMapName!"); + console.error("Mouse input object other than button passed to getDisplayMapName!"); } - else if (omni.Util.strstr(device, "joystick") != -1) + else if (Util.strstr(device, "joystick") != -1) { - int pos = omni.Util.strstr(action, "button"); + int pos = Util.strstr(action, "button"); if (pos != -1) { - mods = omni.Util.getSubStr(action, 0, pos); - Object = omni.Util.getSubStr(action, pos, 1000); - instance = omni.Util.getSubStr(Object, omni.Util.strlen("button"), 1000); + mods = Util.getSubStr(action, 0, pos); + Object = Util.getSubStr(action, pos, 1000); + instance = Util.getSubStr(Object, Util.strlen("button"), 1000); return mods + "joystick" + (instance.AsInt() + 1); } else { - pos = omni.Util.strstr(action, "pov"); + pos = Util.strstr(action, "pov"); if (pos != -1) { - int wordCount = omni.Util.getWordCount(action); - mods = (wordCount > 1) ? omni.Util.getWords(action, 0, wordCount - 2) + " " : ""; - Object = omni.Util.getWord(action, wordCount - 1); + int wordCount = Util.getWordCount(action); + mods = (wordCount > 1) ? Util.getWords(action, 0, wordCount - 2) + " " : ""; + Object = Util.getWord(action, wordCount - 1); switch (Object) { case "upov": @@ -3661,7 +3661,7 @@ public static string getMapDisplayName(string device, string action) } else - omni.console.error("Unsupported Joystick input object passed to getDisplayMapName!"); + console.error("Unsupported Joystick input object passed to getDisplayMapName!"); } } return "??"; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/startupGui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/startupGui.cs index bd81f115..6874934b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/startupGui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/startupGui.cs @@ -168,7 +168,7 @@ public override bool OnFunctionNotFoundCallTorqueScript() public static void loadStartup() { // The index of the current splash screen - omni.iGlobal["$StartupIdx"] = 0; + iGlobal["$StartupIdx"] = 0; // A list of the splash screens and logos // to cycle through. Note that they have to // be in consecutive numerical order @@ -176,7 +176,7 @@ public static void loadStartup() if (!"StartupGui".isObject()) return; StartupGui.bitmap0 = "art/gui/background_g"; - StartupGui.logo0 = "art/gui/omni.png"; + StartupGui.logo0 = "art/gui/png"; StartupGui.logoPos0 = new Point2I(178, 251); StartupGui.logoExtent0 = new Point2I(443, 139); // Call the next() function to set our firt diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/GuiCanvas.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/GuiCanvas.cs index fd8b8d81..706beb62 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/GuiCanvas.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/GuiCanvas.cs @@ -70,23 +70,23 @@ public partial class GuiCanvas public static void initialize() { - omni.bGlobal["$cursorControlled"] = true; + bGlobal["$cursorControlled"] = true; ((GuiCanvas) "Canvas").checkCursor(); } [ConsoleInteraction(true)] public new static void showCursor() { - if (omni.bGlobal["$cursorControlled"]) - omni.Util.lockMouse(false); + if (bGlobal["$cursorControlled"]) + Util.lockMouse(false); ((GuiCanvas) "Canvas").cursorOn(); } [ConsoleInteraction(true)] public new static void hideCursor() { - if (omni.bGlobal["$cursorControlled"]) - omni.Util.lockMouse(true); + if (bGlobal["$cursorControlled"]) + Util.lockMouse(true); ((GuiCanvas) "Canvas").cursorOff(); } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Gui/postFXManager.gui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Gui/postFXManager.gui.cs index e1653a94..bebdd649 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Gui/postFXManager.gui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Gui/postFXManager.gui.cs @@ -7633,23 +7633,23 @@ public override bool OnFunctionNotFoundCallTorqueScript() public static void createGui() { - omni.sGlobal["$PostFXManager::defaultPreset"] = "core/scripts/client/postFx/default.postfxpreset.cs"; + sGlobal["$PostFXManager::defaultPreset"] = "core/scripts/client/postFx/default.postfxpreset.cs"; // Used to name the saved files. - omni.sGlobal["$PostFXManager::fileExtension"] = ".postfxpreset.cs"; + sGlobal["$PostFXManager::fileExtension"] = ".postfxpreset.cs"; // The filter string for file open/save dialogs. - omni.sGlobal["$PostFXManager::fileFilter"] = "Post Effect Presets|*.postfxpreset.cs"; + sGlobal["$PostFXManager::fileFilter"] = "Post Effect Presets|*.postfxpreset.cs"; // Enable / disable PostFX when loading presets or just apply the settings? - omni.bGlobal["$PostFXManager::forceEnableFromPresets"] = true; + bGlobal["$PostFXManager::forceEnableFromPresets"] = true; - omni.bGlobal["$PostFXManager::vebose"] = true; + bGlobal["$PostFXManager::vebose"] = true; if (!guicreated) { //until I rip out gui's I need to execute the script. - //omni.Util.exec("core/scripts/client/postFx/postFXManager.gui", false, false); + //Util.exec("core/scripts/client/postFx/postFXManager.gui", false, false); initialize(); guicreated = true; } @@ -8273,10 +8273,10 @@ public void savePresetHandler(string filename) public static void ppOptionsUpdateDOFSettings() { DOFPostEffect mDOFPostEffect = "DOFPostEffect"; - mDOFPostEffect.setFocusParams(omni.fGlobal["$DOFPostFx::BlurMin"], omni.fGlobal["$DOFPostFx::BlurMax"], omni.fGlobal["$DOFPostFx::FocusRangeMin"], omni.fGlobal["$DOFPostFx::FocusRangeMax"], -omni.fGlobal["$DOFPostFx::BlurCurveNear"], omni.fGlobal["$DOFPostFx::BlurCurveFar"]); - mDOFPostEffect.setAutoFocus(omni.bGlobal["$DOFPostFx::EnableAutoFocus"]); + mDOFPostEffect.setFocusParams(fGlobal["$DOFPostFx::BlurMin"], fGlobal["$DOFPostFx::BlurMax"], fGlobal["$DOFPostFx::FocusRangeMin"], fGlobal["$DOFPostFx::FocusRangeMax"], -fGlobal["$DOFPostFx::BlurCurveNear"], fGlobal["$DOFPostFx::BlurCurveFar"]); + mDOFPostEffect.setAutoFocus(bGlobal["$DOFPostFx::EnableAutoFocus"]); mDOFPostEffect.setFocalDist("0"); - if (omni.bGlobal["$PostFXManager::PostFX::EnableDOF"]) + if (bGlobal["$PostFXManager::PostFX::EnableDOF"]) mDOFPostEffect.enable(); else mDOFPostEffect.disable(); @@ -8292,14 +8292,14 @@ public static void ppColorCorrection_selectFile() [ConsoleInteraction(true)] public static void ppColorCorrection_selectFileHandler(string filename) { - if ((filename == "") || !omni.Util.isFile(filename)) + if ((filename == "") || !Util.isFile(filename)) filename = "core/scripts/client/postFx/null_color_ramp.png"; else - filename = omni.Util.makeRelativePath(filename, omni.Util.getMainDotCsDir()); + filename = Util.makeRelativePath(filename, Util.getMainDotCsDir()); Extendable.PostEffect.mColorCorrectionFileName = filename; - //omni.sGlobal["$HDRPostFX::colorCorrectionRamp"] = filename; + //sGlobal["$HDRPostFX::colorCorrectionRamp"] = filename; ((GuiTextEditCtrl) ((postFXManager) "PostFXManager").findObjectByInternalName("ColorCorrectionFileName", true)).text = filename; } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/CausticsPostEffect.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/CausticsPostEffect.cs index 39ca05e6..2a9c88d3 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/CausticsPostEffect.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/CausticsPostEffect.cs @@ -98,8 +98,8 @@ public static void initialize() ts["target"] = "$backBuffer"; ts.Create(); - omni.iGlobal["$CausticsPFX::refTime"] = omni.Util.getSimTime(); - omni.sGlobal["$CausticsPFX::color"] = "1.0 1.0 1.0 1.0"; + iGlobal["$CausticsPFX::refTime"] = Util.getSimTime(); + sGlobal["$CausticsPFX::color"] = "1.0 1.0 1.0 1.0"; } //private static CausticsPostEffect cpf; @@ -109,8 +109,8 @@ public override void setShaderConsts() //cpf.texture[1] = new TypeImageFilename( "core/scripts/client/postFx/textures/caustics_1.png"); //cpf.texture[2] = new TypeImageFilename( "core/scripts/client/postFx/textures/caustics_2.png"); - this.setShaderConst("$refTime", omni.sGlobal["$CausticsPFX::refTime"]); - setShaderConst("$colorize", omni.sGlobal["$CausticsPFX::color"]); + this.setShaderConst("$refTime", sGlobal["$CausticsPFX::refTime"]); + setShaderConst("$colorize", sGlobal["$CausticsPFX::color"]); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/ChromaticLensPostFX.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/ChromaticLensPostFX.cs index 86d9907e..46e38f94 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/ChromaticLensPostFX.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/ChromaticLensPostFX.cs @@ -50,17 +50,17 @@ public class ChromaticLensPostFX : PostEffect public static void initialize() { - omni.bGlobal["$CAPostFx::enabled"] = false; + bGlobal["$CAPostFx::enabled"] = false; // The lens distortion coefficient. - omni.dGlobal["$CAPostFx::distCoeffecient"] = -0.05; + dGlobal["$CAPostFx::distCoeffecient"] = -0.05; // The cubic distortion value. - omni.dGlobal["$CAPostFx::cubeDistortionFactor"] = -0.1; + dGlobal["$CAPostFx::cubeDistortionFactor"] = -0.1; // The amount and direction of the maxium shift for // the red, green, and blue channels. - omni.sGlobal["$CAPostFx::colorDistortionFactor"] = "0.005 -0.005 0.01"; + sGlobal["$CAPostFx::colorDistortionFactor"] = "0.005 -0.005 0.01"; SingletonCreator ts = new SingletonCreator("GFXStateBlockData", "PFX_DefaultChromaticLensStateBlock"); ts["zDefined"] = true; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/HDRPostEffect.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/HDRPostEffect.cs index ea8f23ed..f4a82c81 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/HDRPostEffect.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/HDRPostEffect.cs @@ -169,54 +169,54 @@ public override void onDisabled() public static void initialize() { // Blends between the scene and the tone mapped scene. - omni.dGlobal["$HDRPostFX::enableToneMapping"] = 1.0; + dGlobal["$HDRPostFX::enableToneMapping"] = 1.0; // The tone mapping middle grey or exposure value used // to adjust the overall "balance" of the image. // // 0.18 is fairly common value. // - omni.dGlobal["$HDRPostFX::keyValue"] = 0.18; + dGlobal["$HDRPostFX::keyValue"] = 0.18; // The minimum luninace value to allow when tone mapping // the scene. Is particularly useful if your scene very // dark or has a black ambient color in places. - omni.dGlobal["$HDRPostFX::minLuminace"] = 0.001; + dGlobal["$HDRPostFX::minLuminace"] = 0.001; // The lowest luminance value which is mapped to white. This // is usually set to the highest visible luminance in your // scene. By setting this to smaller values you get a contrast // enhancement. - omni.dGlobal["$HDRPostFX::whiteCutoff"] = 1.0; + dGlobal["$HDRPostFX::whiteCutoff"] = 1.0; // The rate of adaptation from the previous and new // average scene luminance. - omni.dGlobal["$HDRPostFX::adaptRate"] = 2.0; + dGlobal["$HDRPostFX::adaptRate"] = 2.0; // Blends between the scene and the blue shifted version // of the scene for a cinematic desaturated night effect. - omni.dGlobal["$HDRPostFX::enableBlueShift"] = 0.0; + dGlobal["$HDRPostFX::enableBlueShift"] = 0.0; // The blue shift color value. - omni.sGlobal["$HDRPostFX::blueShiftColor"] = "1.05 0.97 1.27"; + sGlobal["$HDRPostFX::blueShiftColor"] = "1.05 0.97 1.27"; // Blends between the scene and the bloomed scene. - omni.dGlobal["$HDRPostFX::enableBloom"] = 1.0; + dGlobal["$HDRPostFX::enableBloom"] = 1.0; // The threshold luminace value for pixels which are // considered "bright" and need to be bloomed. - omni.dGlobal["$HDRPostFX::brightPassThreshold"] = 1.0; + dGlobal["$HDRPostFX::brightPassThreshold"] = 1.0; // These are used in the gaussian blur of the // bright pass for the bloom effect. - omni.dGlobal["$HDRPostFX::gaussMultiplier"] = 0.3; - omni.dGlobal["$HDRPostFX::gaussMean"] = 0.0; - omni.dGlobal["$HDRPostFX::gaussStdDev"] = 0.8; + dGlobal["$HDRPostFX::gaussMultiplier"] = 0.3; + dGlobal["$HDRPostFX::gaussMean"] = 0.0; + dGlobal["$HDRPostFX::gaussStdDev"] = 0.8; // The 1x255 color correction ramp texture used // by both the HDR shader and the GammaPostFx shader // for doing full screen color correction. - //omni.sGlobal["$HDRPostFX::colorCorrectionRamp"] = "core/scripts/client/postFx/null_color_ramp.png"; + //sGlobal["$HDRPostFX::colorCorrectionRamp"] = "core/scripts/client/postFx/null_color_ramp.png"; mColorCorrectionFileName = "core/scripts/client/postFx/null_color_ramp.png"; SingletonCreator sts = new SingletonCreator("ShaderData", "HDR_BrightPassShader"); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/LightRayPostEffect.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/LightRayPostEffect.cs index ed8b74c5..5307cad1 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/LightRayPostEffect.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/LightRayPostEffect.cs @@ -72,13 +72,13 @@ public override void setShaderConsts() public static void initialize() { - omni.dGlobal["$LightRayPostFX::brightScalar"] = 0.75; - omni.dGlobal["$LightRayPostFX::numSamples"] = 40; - omni.dGlobal["$LightRayPostFX::density"] = 0.94; - omni.dGlobal["$LightRayPostFX::weight"] = 5.65; - omni.dGlobal["$LightRayPostFX::decay"] = 1.0; - omni.dGlobal["$LightRayPostFX::exposure"] = 0.0005; - omni.dGlobal["$LightRayPostFX::resolutionScale"] = 1.0; + dGlobal["$LightRayPostFX::brightScalar"] = 0.75; + dGlobal["$LightRayPostFX::numSamples"] = 40; + dGlobal["$LightRayPostFX::density"] = 0.94; + dGlobal["$LightRayPostFX::weight"] = 5.65; + dGlobal["$LightRayPostFX::decay"] = 1.0; + dGlobal["$LightRayPostFX::exposure"] = 0.0005; + dGlobal["$LightRayPostFX::resolutionScale"] = 1.0; SingletonCreator ts = new SingletonCreator("ShaderData", "LightRayOccludeShader"); ts["DXVertexShaderFile"] = "shaders/common/postFx/postFxV.hlsl"; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/OVRBarrelDistortionMonoPostEffect.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/OVRBarrelDistortionMonoPostEffect.cs index 9a453554..9884054b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/OVRBarrelDistortionMonoPostEffect.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/OVRBarrelDistortionMonoPostEffect.cs @@ -51,7 +51,7 @@ public override bool OnFunctionNotFoundCallTorqueScript() public static void initialize() { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!Util.isFunction("isOculusVRDeviceActive")) return; SingletonCreator ts = new SingletonCreator("ShaderData", "OVRMonoToStereoShader"); @@ -138,7 +138,7 @@ public static void initialize() public override void setShaderConsts() { - string xOffsets = omni.console.Call("getOVRHMDEyeXOffsets", new string[] {"0"}); + string xOffsets = console.Call("getOVRHMDEyeXOffsets", new string[] {"0"}); setShaderConst("$LensXOffsets", xOffsets); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/SSAOPostEffect.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/SSAOPostEffect.cs index 108538ce..7ba5eda0 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/SSAOPostEffect.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/SSAOPostEffect.cs @@ -122,39 +122,39 @@ public override void onDisabled() public static void initialize() { - omni.dGlobal["$SSAOPostFx::overallStrength"] = 2.0; + dGlobal["$SSAOPostFx::overallStrength"] = 2.0; // TODO: Add small/large param docs. // The small radius SSAO settings. - omni.dGlobal["$SSAOPostFx::sRadius"] = 0.1; - omni.dGlobal["$SSAOPostFx::sStrength"] = 6.0; - omni.dGlobal["$SSAOPostFx::sDepthMin"] = 0.1; - omni.dGlobal["$SSAOPostFx::sDepthMax"] = 1.0; - omni.dGlobal["$SSAOPostFx::sDepthPow"] = 1.0; - omni.dGlobal["$SSAOPostFx::sNormalTol"] = 0.0; - omni.dGlobal["$SSAOPostFx::sNormalPow"] = 1.0; + dGlobal["$SSAOPostFx::sRadius"] = 0.1; + dGlobal["$SSAOPostFx::sStrength"] = 6.0; + dGlobal["$SSAOPostFx::sDepthMin"] = 0.1; + dGlobal["$SSAOPostFx::sDepthMax"] = 1.0; + dGlobal["$SSAOPostFx::sDepthPow"] = 1.0; + dGlobal["$SSAOPostFx::sNormalTol"] = 0.0; + dGlobal["$SSAOPostFx::sNormalPow"] = 1.0; // The large radius SSAO settings. - omni.dGlobal["$SSAOPostFx::lRadius"] = 1.0; - omni.dGlobal["$SSAOPostFx::lStrength"] = 10.0; - omni.dGlobal["$SSAOPostFx::lDepthMin"] = 0.2; - omni.dGlobal["$SSAOPostFx::lDepthMax"] = 2.0; - omni.dGlobal["$SSAOPostFx::lDepthPow"] = 0.2; - omni.dGlobal["$SSAOPostFx::lNormalTol"] = -0.5; - omni.dGlobal["$SSAOPostFx::lNormalPow"] = 2.0; + dGlobal["$SSAOPostFx::lRadius"] = 1.0; + dGlobal["$SSAOPostFx::lStrength"] = 10.0; + dGlobal["$SSAOPostFx::lDepthMin"] = 0.2; + dGlobal["$SSAOPostFx::lDepthMax"] = 2.0; + dGlobal["$SSAOPostFx::lDepthPow"] = 0.2; + dGlobal["$SSAOPostFx::lNormalTol"] = -0.5; + dGlobal["$SSAOPostFx::lNormalPow"] = 2.0; // Valid values: 0, 1, 2 - omni.iGlobal["$SSAOPostFx::quality"] = 0; + iGlobal["$SSAOPostFx::quality"] = 0; // - omni.dGlobal["$SSAOPostFx::blurDepthTol"] = 0.001; + dGlobal["$SSAOPostFx::blurDepthTol"] = 0.001; // - omni.dGlobal["$SSAOPostFx::blurNormalTol"] = 0.95; + dGlobal["$SSAOPostFx::blurNormalTol"] = 0.95; // - omni.sGlobal["$SSAOPostFx::targetScale"] = "0.5 0.5"; + sGlobal["$SSAOPostFx::targetScale"] = "0.5 0.5"; SingletonCreator ts = new SingletonCreator("GFXStateBlockData", "SSAOStateBlock : PFX_DefaultStateBlock"); ts["samplersDefined"] = true; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Recordings/recordings.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Recordings/recordings.cs index e5d417d0..3aa6795c 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Recordings/recordings.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/Recordings/recordings.cs @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Recordings { public class recordings { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void StartSelectedDemo() { @@ -54,7 +52,7 @@ public static void StartSelectedDemo() int sel = RecordingsDlgList.getSelectedId(); string rowText = RecordingsDlgList.getRowTextById(sel); - string file = omni.sGlobal["$currentMod"] + "/recordings/" + omni.Util.getField(rowText, 0) + ".rec"; + string file = pInvokes.sGlobal["$currentMod"] + "/recordings/" + pInvokes.Util.getField(rowText, 0) + ".rec"; GameConnection ServerConnection = new ObjectCreator("GameConnection", "ServerConnection").Create(); ((SimGroup) "RootGroup").add(ServerConnection); @@ -95,14 +93,14 @@ public static void startDemoRecord() if (i < 100) num = "0" + num; - file = omni.sGlobal["$currentMod"] + "/recordings/demo" + num + ".rec"; - if (!omni.Util.isFile(file)) + file = pInvokes.sGlobal["$currentMod"] + "/recordings/demo" + num + ".rec"; + if (!pInvokes.Util.isFile(file)) break; } if (i == 1000) return; - omni.sGlobal["$DemoFileName"] = file; + pInvokes.sGlobal["$DemoFileName"] = file; ServerConnection.call("prepDemoRecord"); ServerConnection.startRecording(file); @@ -110,9 +108,9 @@ public static void startDemoRecord() // make sure start worked if (ServerConnection.isDemoRecording()) { - omni.Util._call("deleteFile", file); + pInvokes.Util._call("deleteFile", file); - omni.sGlobal["$DemoFileName"] = ""; + pInvokes.sGlobal["$DemoFileName"] = ""; } } @@ -125,7 +123,7 @@ public static void stopDemoRecord() public static void demoPlaybackComplete() { - omni.Util._call("disconnect"); + pInvokes.Util._call("disconnect"); // Clean up important client-side stuff, such as the group // for particle emitters and the decal manager. This doesn't get // launched during a demo as we short circuit the whole mission diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/art/gui/defaultGameProfiles.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/art/gui/defaultGameProfiles.cs index a1583840..6a481ff4 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/art/gui/defaultGameProfiles.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/art/gui/defaultGameProfiles.cs @@ -40,8 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.art.gui { public class defaultGameProfiles { - private static readonly pInvokes omni = new pInvokes(); - public static void Initialize() { SingletonCreator ts = new SingletonCreator("GuiControlProfile", "ChatHudEditProfile"); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/canvas.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/canvas.cs index 61257ee5..58821102 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/canvas.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/canvas.cs @@ -58,31 +58,31 @@ public override void onWindowClose() public new static void initialize() { - omni.bGlobal["$canvasCreated"] = false; + bGlobal["$canvasCreated"] = false; } public static void initializeCanvas() { - if (omni.bGlobal["$canvasCreated"]) + if (bGlobal["$canvasCreated"]) { - omni.console.error("Cannot instantiate more than one canvas!"); + console.error("Cannot instantiate more than one canvas!"); return; } - if (!createCanvas(omni.sGlobal["$appName"])) + if (!createCanvas(sGlobal["$appName"])) { - omni.console.error("Canvas creation failed. Shutting down."); + console.error("Canvas creation failed. Shutting down."); Main.Quit(); //t3d.Util.quit(); } - omni.bGlobal["$canvasCreated"] = true; + bGlobal["$canvasCreated"] = true; } public static bool createCanvas(string windowTitle) { - if (omni.bGlobal["$isDedicated"]) + if (bGlobal["$isDedicated"]) { - omni.console.Call_Classname("GFXInit", "createNullDevice"); + console.Call_Classname("GFXInit", "createNullDevice"); return true; } // Create the Canvas @@ -90,28 +90,28 @@ public static bool createCanvas(string windowTitle) GuiCanvas canvas = new ObjectCreator("GuiCanvas", "Canvas", typeof (canvas)).Create(); if (canvas.isObject()) - canvas.setWindowTitle(omni.Util.getEngineName() + " - " + omni.sGlobal["$appName"]); + canvas.setWindowTitle(Util.getEngineName() + " - " + sGlobal["$appName"]); return true; } [ConsoleInteraction(true)] public static void configureCanvas() { - if (omni.sGlobal["$pref::Video::Canvas::mode"] == "") - omni.sGlobal["$pref::Video::Canvas::mode"] = "1024 768 false 32 60 4"; + if (sGlobal["$pref::Video::Canvas::mode"] == "") + sGlobal["$pref::Video::Canvas::mode"] = "1024 768 false 32 60 4"; - string resolution = omni.sGlobal["$pref::Video::Canvas::mode"]; - float resX = resolution.Split(' ')[omni.iGlobal["$WORD::RES_X"]].AsFloat(); - float resY = resolution.Split(' ')[omni.iGlobal["$WORD::RES_Y"]].AsFloat(); - string fs = resolution.Split(' ')[omni.iGlobal["$WORD::FULLSCREEN"]]; - string bpp = resolution.Split(' ')[omni.iGlobal["$WORD::BITDEPTH"]]; - string rate = resolution.Split(' ')[omni.iGlobal["$WORD::REFRESH"]]; - string fsaa = resolution.Split(' ')[omni.iGlobal["$WORD::AA"]]; + string resolution = sGlobal["$pref::Video::Canvas::mode"]; + float resX = resolution.Split(' ')[iGlobal["$WORD::RES_X"]].AsFloat(); + float resY = resolution.Split(' ')[iGlobal["$WORD::RES_Y"]].AsFloat(); + string fs = resolution.Split(' ')[iGlobal["$WORD::FULLSCREEN"]]; + string bpp = resolution.Split(' ')[iGlobal["$WORD::BITDEPTH"]]; + string rate = resolution.Split(' ')[iGlobal["$WORD::REFRESH"]]; + string fsaa = resolution.Split(' ')[iGlobal["$WORD::AA"]]; - omni.console.print("--------------"); - omni.console.print("Attempting to set resolution to \"" + resolution + "\""); + console.print("--------------"); + console.print("Attempting to set resolution to \"" + resolution + "\""); - Point3F deskRes = omni.Util.getDesktopResolution(); + Point3F deskRes = Util.getDesktopResolution(); float deskResX = deskRes.x; float deskResY = deskRes.y; float deskResBPP = deskRes.z; @@ -126,15 +126,15 @@ public static void configureCanvas() // Windowed mode has to use the same bit depth as the desktop if (resX >= deskResX || resY >= deskResY) { - omni.Util._warn("Warning: The requested windowed resolution is equal to or larger than the current desktop resolution. Attempting to find a better resolution"); + Util._warn("Warning: The requested windowed resolution is equal to or larger than the current desktop resolution. Attempting to find a better resolution"); int resCount = ((GuiCanvas) "Canvas").getModeCount(); for (int i = (resCount - 1); i >= 0; i--) { string testRes = ((GuiCanvas) "Canvas").getMode(i); - float testResX = testRes.Split(' ')[omni.iGlobal["$WORD::RES_X"]].AsFloat(); - float testResY = testRes.Split(' ')[omni.iGlobal["$WORD::RES_Y"]].AsFloat(); - string testBPP = testRes.Split(' ')[omni.iGlobal["$WORD::BITDEPTH"]]; + float testResX = testRes.Split(' ')[iGlobal["$WORD::RES_X"]].AsFloat(); + float testResY = testRes.Split(' ')[iGlobal["$WORD::RES_Y"]].AsFloat(); + string testBPP = testRes.Split(' ')[iGlobal["$WORD::BITDEPTH"]]; if (testBPP.AsInt() != bpp.AsInt()) continue; @@ -145,25 +145,25 @@ public static void configureCanvas() resX = testResX; resY = testResY; - omni.Util._warn("Warning: Switching to \"" + resX + " " + resY + " " + bpp + "\""); + Util._warn("Warning: Switching to \"" + resX + " " + resY + " " + bpp + "\""); break; } } } - omni.sGlobal["$pref::Video::Canvas::mode"] = resX + " " + resY + " " + fs + " " + bpp + " " + rate + " " + fsaa; + sGlobal["$pref::Video::Canvas::mode"] = resX + " " + resY + " " + fs + " " + bpp + " " + rate + " " + fsaa; string fsLabel = "No"; if (fs.AsBool()) fsLabel = "Yes"; - omni.console.print("Accepted Mode: "); - omni.console.print("--Resolution : " + resX + " " + resY); - omni.console.print("--Full Screen : " + fsLabel); - omni.console.print("--Bits Per Pixel : " + bpp); - omni.console.print("--Refresh Rate : " + rate); - omni.console.print("--FSAA Level : " + fsaa); - omni.console.print("--------------"); + console.print("Accepted Mode: "); + console.print("--Resolution : " + resX + " " + resY); + console.print("--Full Screen : " + fsLabel); + console.print("--Bits Per Pixel : " + bpp); + console.print("--Refresh Rate : " + rate); + console.print("--FSAA Level : " + fsaa); + console.print("--------------"); // Actually set the new video mode ((GuiCanvas) "Canvas").setVideoMode((uint) resX, (uint) resY, fs.AsBool(), bpp.AsUint(), rate.AsUint(), fsaa.AsUint()); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/client.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/client.cs index 6d55f237..52d49acd 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/client.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/client.cs @@ -49,44 +49,42 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class client { - private static readonly pInvokes omni = new pInvokes(); - public static void LoadDefaults() { - omni.sGlobal["$pref::Player::Name"] = "Visitor"; - omni.iGlobal["$pref::Player::defaultFov"] = 65; - omni.iGlobal["$pref::Player::zoomSpeed"] = 0; + pInvokes.sGlobal["$pref::Player::Name"] = "Visitor"; + pInvokes.iGlobal["$pref::Player::defaultFov"] = 65; + pInvokes.iGlobal["$pref::Player::zoomSpeed"] = 0; - omni.iGlobal["$pref::Net::LagThreshold"] = 400; - omni.iGlobal["$pref::Net::Port"] = 28000; + pInvokes.iGlobal["$pref::Net::LagThreshold"] = 400; + pInvokes.iGlobal["$pref::Net::Port"] = 28000; - //omni.iGlobal["$pref::Net::PacketRateToClient"] = 32; - //omni.iGlobal["$pref::Net::PacketRateToServer"] = 32; - //omni.iGlobal["$pref::Net::PacketSize"] = 200; + //pInvokes.iGlobal["$pref::Net::PacketRateToClient"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketRateToServer"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketSize"] = 200; - omni.iGlobal["$pref::HudMessageLogSize"] = 40; - omni.iGlobal["$pref::ChatHudLength"] = 1; + pInvokes.iGlobal["$pref::HudMessageLogSize"] = 40; + pInvokes.iGlobal["$pref::ChatHudLength"] = 1; - omni.iGlobal["$pref::Input::LinkMouseSensitivity"] = 1; + pInvokes.iGlobal["$pref::Input::LinkMouseSensitivity"] = 1; // DInput keyboard, mouse, and joystick prefs - omni.iGlobal["$pref::Input::KeyboardEnabled"] = 1; - omni.iGlobal["$pref::Input::MouseEnabled"] = 1; - omni.iGlobal["$pref::Input::JoystickEnabled"] = 0; - omni.dGlobal["$pref::Input::KeyboardTurnSpeed"] = 0.1; + pInvokes.iGlobal["$pref::Input::KeyboardEnabled"] = 1; + pInvokes.iGlobal["$pref::Input::MouseEnabled"] = 1; + pInvokes.iGlobal["$pref::Input::JoystickEnabled"] = 0; + pInvokes.dGlobal["$pref::Input::KeyboardTurnSpeed"] = 0.1; - omni.iGlobal["$sceneLighting::cacheSize"] = 20000; - omni.sGlobal["$sceneLighting::purgeMethod"] = "lastCreated"; - omni.iGlobal["$sceneLighting::cacheLighting"] = 1; + pInvokes.iGlobal["$sceneLighting::cacheSize"] = 20000; + pInvokes.sGlobal["$sceneLighting::purgeMethod"] = "lastCreated"; + pInvokes.iGlobal["$sceneLighting::cacheLighting"] = 1; - omni.sGlobal["$pref::Video::displayDevice"] = "D3D9"; - omni.iGlobal["$pref::Video::disableVerticalSync"] = 1; - omni.sGlobal["$pref::Video::Canvas::mode"] = "1024 768 false 32 60 4"; - //omni.sGlobal["$pref::Video::Canvas_SceneTree::mode"] = "300 480 false 32 60 4"; - //omni.sGlobal["$pref::Video::Canvas_Inspector::mode"] = "500 480 false 32 60 4"; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "D3D9"; + pInvokes.iGlobal["$pref::Video::disableVerticalSync"] = 1; + pInvokes.sGlobal["$pref::Video::Canvas::mode"] = "1024 768 false 32 60 4"; + //pInvokes.sGlobal["$pref::Video::Canvas_SceneTree::mode"] = "300 480 false 32 60 4"; + //pInvokes.sGlobal["$pref::Video::Canvas_Inspector::mode"] = "500 480 false 32 60 4"; - omni.iGlobal["$pref::Video::defaultFenceCount"] = 0; - omni.iGlobal["$pref::Video::screenShotSession"] = 0; - omni.sGlobal["$pref::Video::screenShotFormat"] = "PNG"; + pInvokes.iGlobal["$pref::Video::defaultFenceCount"] = 0; + pInvokes.iGlobal["$pref::Video::screenShotSession"] = 0; + pInvokes.sGlobal["$pref::Video::screenShotFormat"] = "PNG"; // This disables the hardware FSAA/MSAA so that // we depend completely on the FXAA post effect @@ -96,127 +94,127 @@ public static void LoadDefaults() // will fail to initialize when hardware AA is // enabled... so you've been warned. // - omni.bGlobal["$pref::Video::disableHardwareAA"] = true; + pInvokes.bGlobal["$pref::Video::disableHardwareAA"] = true; - omni.bGlobal["$pref::Video::disableNormalmapping"] = false; + pInvokes.bGlobal["$pref::Video::disableNormalmapping"] = false; - omni.bGlobal["$pref::Video::disablePixSpecular"] = false; + pInvokes.bGlobal["$pref::Video::disablePixSpecular"] = false; - omni.bGlobal["$pref::Video::disableCubemapping"] = false; + pInvokes.bGlobal["$pref::Video::disableCubemapping"] = false; - omni.bGlobal["$pref::Video::disableParallaxMapping"] = false; + pInvokes.bGlobal["$pref::Video::disableParallaxMapping"] = false; - omni.dGlobal["$pref::Video::Gamma"] = 1.0; + pInvokes.dGlobal["$pref::Video::Gamma"] = 1.0; - if (omni.sGlobal["$platform"] == "xenon") + if (pInvokes.sGlobal["$platform"] == "xenon") { // Save some fillrate on the X360, and take advantage of the HW scaling - omni.sGlobal["$pref::Video::Resolution"] = "1152 640"; - omni.sGlobal["$pref::Video::Canvas::mode"] = omni.sGlobal["$pref::Video::Resolution"] + " " + "true 32 60 0"; - omni.iGlobal["$pref::Video::fullScreen"] = 1; + pInvokes.sGlobal["$pref::Video::Resolution"] = "1152 640"; + pInvokes.sGlobal["$pref::Video::Canvas::mode"] = pInvokes.sGlobal["$pref::Video::Resolution"] + " " + "true 32 60 0"; + pInvokes.iGlobal["$pref::Video::fullScreen"] = 1; } // This is the path used by ShaderGen to cache procedural // shaders. If left blank ShaderGen will only cache shaders // to memory and not to disk. - omni.sGlobal["$shaderGen::cachePath"] = "shaders/procedural"; + pInvokes.sGlobal["$shaderGen::cachePath"] = "shaders/procedural"; // The perfered light manager to use at startup. If blank // or if the selected one doesn't work on this platfom it // will try the defaults below. - omni.sGlobal["$pref::lightManager"] = ""; + pInvokes.sGlobal["$pref::lightManager"] = ""; // This is the default list of light managers ordered from // most to least desirable for initialization. - omni.sGlobal["$lightManager::defaults"] = "Advanced Lighting\nBasic Lighting"; + pInvokes.sGlobal["$lightManager::defaults"] = "Advanced Lighting\nBasic Lighting"; // A scale to apply to the camera view distance // typically used for tuning performance. - omni.dGlobal["$pref::camera::distanceScale"] = 1.0; + pInvokes.dGlobal["$pref::camera::distanceScale"] = 1.0; // Causes the system to do a one time autodetect // of an SFX provider and device at startup if the // provider is unset. - omni.bGlobal["$pref::SFX::autoDetect"] = true; + pInvokes.bGlobal["$pref::SFX::autoDetect"] = true; // The sound provider to select at startup. Typically // this is DirectSound, OpenAL, or XACT. There is also // a special Null provider which acts normally, but // plays no sound. - omni.sGlobal["$pref::SFX::provider"] = ""; + pInvokes.sGlobal["$pref::SFX::provider"] = ""; // The sound device to select from the provider. Each // provider may have several different devices. - omni.sGlobal["$pref::SFX::device"] = "OpenAL"; + pInvokes.sGlobal["$pref::SFX::device"] = "OpenAL"; // If true the device will try to use hardware buffers // and sound mixing. If not it will use software. - omni.bGlobal["$pref::SFX::useHardware"] = false; + pInvokes.bGlobal["$pref::SFX::useHardware"] = false; // If you have a software device you have a // choice of how many software buffers to // allow at any one time. More buffers cost // more CPU time to process and mix. - omni.iGlobal["$pref::SFX::maxSoftwareBuffers"] = 16; + pInvokes.iGlobal["$pref::SFX::maxSoftwareBuffers"] = 16; // This is the playback frequency for the primary // sound buffer used for mixing. Although most // providers will reformat on the fly, for best // quality and performance match your sound files // to this setting. - omni.iGlobal["$pref::SFX::frequency"] = 44100; + pInvokes.iGlobal["$pref::SFX::frequency"] = 44100; // This is the playback bitrate for the primary // sound buffer used for mixing. Although most // providers will reformat on the fly, for best // quality and performance match your sound files // to this setting. - omni.iGlobal["$pref::SFX::bitrate"] = 32; + pInvokes.iGlobal["$pref::SFX::bitrate"] = 32; // The overall system volume at startup. Note that // you can only scale volume down, volume does not // get louder than 1. - omni.dGlobal["$pref::SFX::masterVolume"] = 0.8; + pInvokes.dGlobal["$pref::SFX::masterVolume"] = 0.8; // The startup sound channel volumes. These are // used to control the overall volume of different // classes of sounds. - omni.iGlobal["$pref::SFX::channelVolume1"] = 1; - omni.iGlobal["$pref::SFX::channelVolume2"] = 1; - omni.iGlobal["$pref::SFX::channelVolume3"] = 1; - omni.iGlobal["$pref::SFX::channelVolume4"] = 1; - omni.iGlobal["$pref::SFX::channelVolume5"] = 1; - omni.iGlobal["$pref::SFX::channelVolume6"] = 1; - omni.iGlobal["$pref::SFX::channelVolume7"] = 1; - omni.iGlobal["$pref::SFX::channelVolume8"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume1"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume2"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume3"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume4"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume5"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume6"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume7"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume8"] = 1; - omni.sGlobal["$pref::PostEffect::PreferedHDRFormat"] = "GFXFormatR8G8B8A8"; + pInvokes.sGlobal["$pref::PostEffect::PreferedHDRFormat"] = "GFXFormatR8G8B8A8"; // This is an scalar which can be used to reduce the // reflection textures on all objects to save fillrate. - omni.dGlobal["$pref::Reflect::refractTexScale"] = 1.0; + pInvokes.dGlobal["$pref::Reflect::refractTexScale"] = 1.0; // This is the total frame in milliseconds to budget for // reflection rendering. If your CPU bound and have alot // of smaller reflection surfaces try reducing this time. - omni.iGlobal["$pref::Reflect::frameLimitMS"] = 10; + pInvokes.iGlobal["$pref::Reflect::frameLimitMS"] = 10; // Set true to force all water objects to use static cubemap reflections. - omni.bGlobal["$pref::Water::disableTrueReflections"] = false; + pInvokes.bGlobal["$pref::Water::disableTrueReflections"] = false; // A global LOD scalar which can reduce the overall density of placed GroundCover. - omni.dGlobal["$pref::GroundCover::densityScale"] = 1.0; + pInvokes.dGlobal["$pref::GroundCover::densityScale"] = 1.0; // An overall scaler on the lod switching between DTS models. // Smaller numbers makes the lod switch sooner. - omni.dGlobal["$pref::TS::detailAdjust"] = 1.0; - omni.bGlobal["$pref::decalMgr::enabled"] = true; + pInvokes.dGlobal["$pref::TS::detailAdjust"] = 1.0; + pInvokes.bGlobal["$pref::decalMgr::enabled"] = true; // - omni.bGlobal["$pref::Decals::enabled"] = true; + pInvokes.bGlobal["$pref::Decals::enabled"] = true; // - omni.sGlobal["$pref::Decals::lifeTimeScale"] = "1"; + pInvokes.sGlobal["$pref::Decals::lifeTimeScale"] = "1"; // The number of mipmap levels to drop on loaded textures // to reduce video memory usage. @@ -224,13 +222,13 @@ public static void LoadDefaults() // It will skip any textures that have been defined as not // allowing down scaling. // - omni.iGlobal["$pref::Video::textureReductionLevel"] = 0; + pInvokes.iGlobal["$pref::Video::textureReductionLevel"] = 0; // - omni.dGlobal["$pref::Shadows::textureScalar"] = 1.0; + pInvokes.dGlobal["$pref::Shadows::textureScalar"] = 1.0; // - omni.bGlobal["$pref::Shadows::disable"] = false; + pInvokes.bGlobal["$pref::Shadows::disable"] = false; // Sets the shadow filtering mode. // @@ -240,17 +238,17 @@ public static void LoadDefaults() // // SoftShadowHighQuality // - omni.sGlobal["$pref::Shadows::filterMode"] = "SoftShadow"; + pInvokes.sGlobal["$pref::Shadows::filterMode"] = "SoftShadow"; // - omni.iGlobal["$pref::Video::defaultAnisotropy"] = 0; + pInvokes.iGlobal["$pref::Video::defaultAnisotropy"] = 0; // Radius in meters around the camera that ForestItems are affected by wind. // Note that a very large number with a large number of items is not cheap. - omni.iGlobal["$pref::windEffectRadius"] = 25; + pInvokes.iGlobal["$pref::windEffectRadius"] = 25; // AutoDetect graphics quality levels the next startup. - omni.iGlobal["$pref::Video::autoDetect"] = 1; + pInvokes.iGlobal["$pref::Video::autoDetect"] = 1; //----------------------------------------------------------------------------- // Graphics Quality Groups @@ -426,26 +424,26 @@ public static void LoadDefaults() oc["#4"] = so4; oc.Create(); - omni.bGlobal["$PhysXLogWarnings"] = false; - if (omni.sGlobal["$platform"] != "xenon") + pInvokes.bGlobal["$PhysXLogWarnings"] = false; + if (pInvokes.sGlobal["$platform"] != "xenon") { //Todo Settings - Switch this back when fixed. //Settings.LoadSection("scripts/client/prefs.cs"); - omni.Util.exec("prefs.client.cs", false, false); + pInvokes.Util.exec("prefs.client.cs", false, false); } else - omni.console.print("Not loading client prefs.cs on Xbox360"); + pInvokes.console.print("Not loading client prefs.cs on Xbox360"); } [ConsoleInteraction(true)] public static string GraphicsQualityAutodetect() { - omni.bGlobal["$pref::Video::autoDetect = false;"] = false; + pInvokes.bGlobal["$pref::Video::autoDetect = false;"] = false; - float shaderVer = omni.Util.getPixelShaderVersion(); - bool intel = omni.Util.getDisplayDeviceInformation().ToUpper() == "INTEL"; - string videoMem = omni.console.Call_Classname("GFXCardProfilerAPI", "getVideoMemoryMB"); + float shaderVer = pInvokes.Util.getPixelShaderVersion(); + bool intel = pInvokes.Util.getDisplayDeviceInformation().ToUpper() == "INTEL"; + string videoMem = pInvokes.console.Call_Classname("GFXCardProfilerAPI", "getVideoMemoryMB"); return GraphicsQualityAutodetect_Apply(shaderVer, intel, videoMem); } @@ -528,7 +526,7 @@ public static int serverToClientObject(int serverObject) [ConsoleInteraction(true)] public static void netSimulateLag(int msDelay, int packetLossPercent) { - omni.console.commandToServer("NetSimulateLag", new[] {msDelay.AsString(), packetLossPercent.AsString()}); + pInvokes.console.commandToServer("NetSimulateLag", new[] {msDelay.AsString(), packetLossPercent.AsString()}); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/clientCmd.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/clientCmd.cs index 4f8b7239..9beb1afc 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/clientCmd.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/clientCmd.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -40,7 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class clientCmd { - private static readonly pInvokes omni = new pInvokes(); //----------------------------------------------------------------------------- // Server Admin Commands //----------------------------------------------------------------------------- @@ -48,13 +47,13 @@ public class clientCmd public static void SAD(string password) { if (password.Trim() != "") - omni.console.commandToServer("SAD", new[] {password}); + pInvokes.console.commandToServer("SAD", new[] {password}); } [ConsoleInteraction(true)] public static void SadSetPassword(string password) { - omni.console.commandToServer("SADSetPassword", new[] {password}); + pInvokes.console.commandToServer("SADSetPassword", new[] {password}); } //---------------------------------------------------------------------------- diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/commonMaterialData.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/commonMaterialData.cs index c89d87f9..8beccba0 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/commonMaterialData.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/commonMaterialData.cs @@ -40,8 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class commonMaterialData { - private static readonly pInvokes omni = new pInvokes(); - public static void intialize() { //----------------------------------------------------------------------------- @@ -50,11 +48,11 @@ public static void intialize() // handle the "|" operation for combining them together // ie. Scroll | Wave does not work. //----------------------------------------------------------------------------- - omni.iGlobal["$scroll"] = 1; - omni.iGlobal["$rotate"] = 2; - omni.iGlobal["$wave"] = 4; - omni.iGlobal["$scale"] = 8; - omni.iGlobal["$sequence"] = 16; + pInvokes.iGlobal["$scroll"] = 1; + pInvokes.iGlobal["$rotate"] = 2; + pInvokes.iGlobal["$wave"] = 4; + pInvokes.iGlobal["$scale"] = 8; + pInvokes.iGlobal["$sequence"] = 16; // Common stateblock definitions ObjectCreator oc = new ObjectCreator("GFXSamplerStateData", "SamplerClampLinear"); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/core.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/core.cs index fda12218..e8b4218b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/core.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/core.cs @@ -59,11 +59,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class core { - private static readonly pInvokes omni = new pInvokes(); - public static void initializeCore() { - if (omni.bGlobal["$coreInitialized"]) + if (pInvokes.bGlobal["$coreInitialized"]) return; ActionMap GlobalActionMap = "GlobalActionMap"; @@ -76,12 +74,12 @@ public static void initializeCore() audio.initialize(); canvas.initialize(); GuiCanvas.initialize(); - //omni.Util.exec("core/scripts/client/cursor.cs", false, false); - //omni.Util.exec("core/scripts/client/persistenceManagerTest.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/cursor.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/persistenceManagerTest.cs", false, false); // Content. - omni.Util.exec("core/art/gui/profiles.cs", false, false); - //omni.Util.exec("core/scripts/gui/cursors.cs", false, false); + pInvokes.Util.exec("core/art/gui/profiles.cs", false, false); + //pInvokes.Util.exec("core/scripts/gui/cursors.cs", false, false); cursor.initialize(); audioEnviroments.initialize(); @@ -90,38 +88,38 @@ public static void initializeCore() audioAmbiences.initialize(); // Input devices - // omni.Util.exec("core/scripts/client/oculusVR.cs", false, false); + // pInvokes.Util.exec("core/scripts/client/oculusVR.cs", false, false); - omni.Util.setRandomSeed((DateTime.Now.Millisecond + 1)*(DateTime.Now.Second + 1)); + pInvokes.Util.setRandomSeed((DateTime.Now.Millisecond + 1)*(DateTime.Now.Second + 1)); // Set up networking. - omni.Util.setNetPort(0); + pInvokes.Util.setNetPort(0); // Initialize the canvas. canvas.initializeCanvas(); // Start processing file change events. - omni.Util.startFileChangeNotifications(); + pInvokes.Util.startFileChangeNotifications(); // Core Guis. - //omni.Util.exec("core/art/gui/console.gui", false, false); + //pInvokes.Util.exec("core/art/gui/console.gui", false, false); ConsoleDlg.initialize(); - //omni.Util.exec("core/art/gui/consoleVarDlg.gui", false, false); + //pInvokes.Util.exec("core/art/gui/consoleVarDlg.gui", false, false); ConsoleVarDlg.initialize(); - omni.Util.exec("core/art/gui/netGraphGui.gui", false, false); + pInvokes.Util.exec("core/art/gui/netGraphGui.gui", false, false); // Gui Helper Scripts. - //omni.Util.exec("core/scripts/gui/help.cs", false, false); + //pInvokes.Util.exec("core/scripts/gui/help.cs", false, false); // Random Scripts. - //omni.Util.exec("core/scripts/client/screenshot.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/screenshot.cs", false, false); screenshot.initialize(); - //omni.Util.exec("core/scripts/client/helperfuncs.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/helperfuncs.cs", false, false); // Client scripts metrics.initialize(); - //omni.Util.exec("core/scripts/client/recordings.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/recordings.cs", false, false); centerPrint.initialize(); loadCoreMaterials(); commonMaterialData.intialize(); @@ -143,9 +141,9 @@ public static void initializeCore() ((GuiCanvas) "Canvas").setCursor("DefaultCursor"); //Need to call this function through the console because loadKeyBindings is part of a packaged used in tools - omni.console.Call("loadKeybindings"); + pInvokes.console.Call("loadKeybindings"); - omni.bGlobal["$coreInitialized"] = true; + pInvokes.bGlobal["$coreInitialized"] = true; } [ConsoleInteraction(true)] @@ -159,12 +157,12 @@ public static void loadCoreMaterials() { if (File.Exists(file.Substring(0, file.Length - 4))) { - omni.Util.exec(file.Substring(startposition, file.Length - 4).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition, file.Length - 4).Replace("\\", "/"), false, false); filesloaded.Add(file.Substring(startposition, file.Length - 4)); } else { - omni.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); filesloaded.Add(file.Substring(startposition)); } } @@ -173,7 +171,7 @@ public static void loadCoreMaterials() foreach (string file in files) { if (!filesloaded.Contains(file.Substring(startposition))) - omni.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); } } @@ -186,7 +184,7 @@ public static void loadCoreMaterials() public static void shutdownCore() { // Stop file change events. - omni.Util.stopFileChangeNotifications(); + pInvokes.Util.stopFileChangeNotifications(); audio.sfxShutdown(); } @@ -197,15 +195,15 @@ public static void shutdownCore() [ConsoleInteraction(true)] public static void dumpKeybindings() { - for (int i = 0; i < omni.iGlobal["$keybindCount"]; i++) + for (int i = 0; i < pInvokes.iGlobal["$keybindCount"]; i++) { - if (omni.sGlobal["$keybindMap[" + i + "]"].isObject()) + if (pInvokes.sGlobal["$keybindMap[" + i + "]"].isObject()) { // Save and delete. - ModelBase t = omni.sGlobal["$keybindMap[" + i + "]"]; + ModelBase t = pInvokes.sGlobal["$keybindMap[" + i + "]"]; Console.WriteLine(t._ID); - omni.console.Call(omni.sGlobal["$keybindMap[" + i + "]"], "save", new[] {omni.Util.getPrefsPath("bind.cs"), i == 0 ? "false" : "true"}); - omni.sGlobal["$keybindMap[" + i + "]"].delete(); + pInvokes.console.Call(pInvokes.sGlobal["$keybindMap[" + i + "]"], "save", new[] {pInvokes.Util.getPrefsPath("bind.cs"), i == 0 ? "false" : "true"}); + pInvokes.sGlobal["$keybindMap[" + i + "]"].delete(); } } } @@ -217,10 +215,10 @@ public static void handleEscape() { if (((GuiCanvas) "Canvas").getContent() == ((ModelBase) "EditorGui")._iID) { - omni.console.Call("EditorGui", "handleEscape"); + pInvokes.console.Call("EditorGui", "handleEscape"); return; } - else if (omni.console.Call("EditorIsDirty").AsBool()) + else if (pInvokes.console.Call("EditorIsDirty").AsBool()) { messageBox.MessageBoxYesNoCancel("Level Modified", "Level has been modified in the Editor. Save?", "EditorDoExitMission(1);", "EditorDoExitMission();", ""); return; @@ -236,15 +234,15 @@ public static void handleEscape() } if (((GameTSCtrl) "PlayGui").isAwake()) - omni.console.Call("escapeFromGame"); + pInvokes.console.Call("escapeFromGame"); } [ConsoleInteraction(true)] public static void reloadCoreMaterials() { - omni.Util.reloadTextures(); + pInvokes.Util.reloadTextures(); loadCoreMaterials(); - omni.Util.reInitMaterials(); + pInvokes.Util.reInitMaterials(); } /// @@ -260,12 +258,12 @@ public static void loadMaterials() { if (File.Exists(file.Substring(0, file.Length - 4))) { - omni.Util.exec(file.Substring(startposition, file.Length - 4).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition, file.Length - 4).Replace("\\", "/"), false, false); filesloaded.Add(file.Substring(startposition, file.Length - 4)); } else { - omni.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); filesloaded.Add(file.Substring(startposition)); } } @@ -274,7 +272,7 @@ public static void loadMaterials() foreach (string file in files) { if (!filesloaded.Contains(file.Substring(startposition))) - omni.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); } //in the torquescript version they do yet another pass against files in the path/materialEditor folder which @@ -285,9 +283,9 @@ public static void loadMaterials() [ConsoleInteraction(true)] public static void reloadMaterials() { - omni.Util.reloadTextures(); + pInvokes.Util.reloadTextures(); loadMaterials(); - omni.Util.reInitMaterials(); + pInvokes.Util.reInitMaterials(); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/default.bind.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/default.bind.cs index 3dc8e920..e50a760f 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/default.bind.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/default.bind.cs @@ -52,8 +52,6 @@ public class defaultBind { public static int movementSpeed = 1; - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { if ("moveMap".isObject()) @@ -101,8 +99,8 @@ public static void initialize() moveMap.bind("gamepad", "triggerr", "gamepadFire"); moveMap.bind("gamepad", "triggerl", "gamepadAltTrigger"); - if (omni.sGlobal["$Player::CurrentFOV"] == "") - omni.iGlobal["$Player::CurrentFOV"] = omni.iGlobal["$pref::Player::DefaultFOV"]/2; + if (pInvokes.sGlobal["$Player::CurrentFOV"] == "") + pInvokes.iGlobal["$Player::CurrentFOV"] = pInvokes.iGlobal["$pref::Player::DefaultFOV"]/2; moveMap.bind("keyboard", "f", "setZoomFOV"); // f for field of view moveMap.bind("keyboard", "z", "toggleZoom"); // z for zoom @@ -146,7 +144,7 @@ public static void initialize() [ConsoleInteraction(true)] public static void escapeFromGame() { - if (omni.sGlobal["$Server::ServerType"] == "SinglePlayer") + if (pInvokes.sGlobal["$Server::ServerType"] == "SinglePlayer") messageBox.MessageBoxYesNo("Exit", "Exit from this Mission?", "disconnect();", ""); else messageBox.MessageBoxYesNo("Disconnect", "Disconnect from the server?", "disconnect();", ""); @@ -165,7 +163,7 @@ public static void doScreenShotHudless(bool val) if (val) { ((GuiCanvas) "Canvas").setContent("HudlessPlayGui"); - omni.Util._schedule("10", "0", "doScreenShot", val.AsString()); + pInvokes.Util._schedule("10", "0", "doScreenShot", val.AsString()); } else ((GuiCanvas) "Canvas").setContent("PlayGui"); @@ -181,27 +179,27 @@ public static void setSpeed(int speed) [ConsoleInteraction(true)] public static void moveleft(int val) { - omni.iGlobal["$mvLeftAction"] = movementSpeed*val; + pInvokes.iGlobal["$mvLeftAction"] = movementSpeed*val; } [ConsoleInteraction(true)] public static void moveright(int val) { //console.SetVar("$mvRightAction", val.AsInt()*movementSpeed); - omni.iGlobal["$mvRightAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvRightAction"] = val*movementSpeed; } [ConsoleInteraction(true)] public static void moveforward(int val) { //console.SetVar("$mvForwardAction", val.AsInt() * movementSpeed); - omni.iGlobal["$mvForwardAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvForwardAction"] = val*movementSpeed; } [ConsoleInteraction(true)] public static void movebackward(int val) { - omni.iGlobal["$mvBackwardAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvBackwardAction"] = val*movementSpeed; //console.SetVar("$mvBackwardAction", val.AsInt() * movementSpeed); } @@ -210,7 +208,7 @@ public static void moveup(int val) { SimObject obj = ((GameConnection) "ServerConnection").getControlObject(); if (obj.isInNamespaceHierarchy("Camera")) - omni.iGlobal["$mvUpAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvUpAction"] = val*movementSpeed; //console.SetVar("$mvUpAction", val.AsInt() * movementSpeed); } @@ -219,14 +217,14 @@ public static void movedown(int val) { SimObject obj = ((GameConnection) "ServerConnection").getControlObject(); if (obj.isInNamespaceHierarchy("Camera")) - omni.iGlobal["$mvDownAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvDownAction"] = val*movementSpeed; //console.SetVar("$mvDownAction", val.AsInt() * movementSpeed); } [ConsoleInteraction(true)] public static void turnLeft(bool val) { - omni.iGlobal["$mvYawRightSpeed"] = val ? omni.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; + pInvokes.iGlobal["$mvYawRightSpeed"] = val ? pInvokes.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; //console.SetVar("$mvYawRightSpeed", val.AsBool() ? console.GetVarInt("$Pref::Input::KeyboardTurnSpeed") : 0); } @@ -234,34 +232,34 @@ public static void turnLeft(bool val) public static void turnRight(bool val) { //console.SetVar("$mvYawLeftSpeed", val.AsBool() ? console.GetVarInt("$Pref::Input::KeyboardTurnSpeed") : 0); - omni.iGlobal["$mvYawLeftSpeed"] = val ? omni.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; + pInvokes.iGlobal["$mvYawLeftSpeed"] = val ? pInvokes.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; } [ConsoleInteraction(true)] public static void panUp(bool val) { - omni.iGlobal["$mvPitchDownSpeed"] = val ? omni.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; + pInvokes.iGlobal["$mvPitchDownSpeed"] = val ? pInvokes.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; //console.SetVar("$mvPitchDownSpeed", val.AsBool() ? console.GetVarInt("$Pref::Input::KeyboardTurnSpeed") : 0); } [ConsoleInteraction(true)] public static void panDown(bool val) { - omni.iGlobal["$mvPitchUpSpeed"] = val ? omni.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; + pInvokes.iGlobal["$mvPitchUpSpeed"] = val ? pInvokes.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; //console.SetVar("$mvPitchUpSpeed", val.AsBool() ? console.GetVarInt("$Pref::Input::KeyboardTurnSpeed") : 0); } [ConsoleInteraction(true)] public static float getMouseAdjustAmount(float val) { - return ((val*(omni.fGlobal["$cameraFov"]/90.0f)*0.01f)*omni.fGlobal["$pref::Input::LinkMouseSensitivity"]); + return ((val*(pInvokes.fGlobal["$cameraFov"]/90.0f)*0.01f)*pInvokes.fGlobal["$pref::Input::LinkMouseSensitivity"]); //return ((val.AsDouble() * (console.GetVarFloat("$cameraFov") / 90.0) * 0.01) * console.GetVarFloat("$pref::Input::LinkMouseSensitivity")).AsString(); } [ConsoleInteraction(true)] public static float getGamepadAdjustAmount(float val) { - return ((val*(omni.fGlobal["$cameraFov"]/90.0f)*0.01f)*10.0f); + return ((val*(pInvokes.fGlobal["$cameraFov"]/90.0f)*0.01f)*10.0f); //return ((val.AsFloat() * (console.GetVarFloat("$cameraFov") / 90) * 0.01) * 10.0).AsString(); } @@ -271,10 +269,10 @@ public static void yaw(float val) float yawAdj = getMouseAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera()) { - yawAdj = omni.Util.mClamp(yawAdj, (-omni.Util.m2Pi() + (float) 0.01), (omni.Util.m2Pi() - (float) 0.01)); + yawAdj = pInvokes.Util.mClamp(yawAdj, (-pInvokes.Util.m2Pi() + (float) 0.01), (pInvokes.Util.m2Pi() - (float) 0.01)); yawAdj *= (float) 0.5; } - omni.fGlobal["$mvYaw"] = omni.fGlobal["$mvYaw"] + yawAdj; + pInvokes.fGlobal["$mvYaw"] = pInvokes.fGlobal["$mvYaw"] + yawAdj; //console.SetVar("$mvYaw", console.GetVarFloat("$mvYaw") + yawAdj); } @@ -284,17 +282,17 @@ public static void pitch(float val) float pitchAdj = getMouseAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera()) { - pitchAdj = omni.Util.mClamp(pitchAdj, (-omni.Util.m2Pi() + (float) 0.01), (omni.Util.m2Pi() - (float) 0.01)); + pitchAdj = pInvokes.Util.mClamp(pitchAdj, (-pInvokes.Util.m2Pi() + (float) 0.01), (pInvokes.Util.m2Pi() - (float) 0.01)); pitchAdj *= (float) 0.5; } - omni.fGlobal["$mvPitch"] = omni.fGlobal["$mvPitch"] + pitchAdj; + pInvokes.fGlobal["$mvPitch"] = pInvokes.fGlobal["$mvPitch"] + pitchAdj; //console.SetVar("$mvPitch", console.GetVarFloat("$mvPitch") + pitchAdj); } [ConsoleInteraction(true)] public static void Jump(string val) { - omni.iGlobal["$mvTriggerCount2"] = omni.iGlobal["$mvTriggerCount2"] + 1; + pInvokes.iGlobal["$mvTriggerCount2"] = pInvokes.iGlobal["$mvTriggerCount2"] + 1; //console.SetVar("$mvTriggerCount2", console.GetVarInt("$mvTriggerCount2") + 1); } @@ -303,15 +301,15 @@ public static void gamePadMoveX(double val) { if (val > 0) { - omni.dGlobal["$mvRightAction"] = val*movementSpeed; - omni.dGlobal["$mvLeftAction"] = 0; + pInvokes.dGlobal["$mvRightAction"] = val*movementSpeed; + pInvokes.dGlobal["$mvLeftAction"] = 0; //console.SetVar("$mvRightAction", (val * movementSpeed).AsString()); //console.SetVar("$mvLeftAction", 0); } else { - omni.dGlobal["$mvRightAction"] = 0; - omni.dGlobal["$mvLeftAction"] = -val*movementSpeed; + pInvokes.dGlobal["$mvRightAction"] = 0; + pInvokes.dGlobal["$mvLeftAction"] = -val*movementSpeed; //console.SetVar("$mvRightAction", 0); //console.SetVar("$mvLeftAction", (-val * movementSpeed).AsString()); } @@ -322,16 +320,16 @@ public static void gamePadMoveY(double val) { if (val > 0) { - omni.dGlobal["$mvForwardAction"] = val*movementSpeed; - omni.dGlobal["$mvBackwardAction"] = 0; + pInvokes.dGlobal["$mvForwardAction"] = val*movementSpeed; + pInvokes.dGlobal["$mvBackwardAction"] = 0; //console.SetVar("$mvForwardAction", val.AsDouble() * movementSpeed); //console.SetVar("$mvBackwardAction", 0); } else { - omni.dGlobal["$mvForwardAction"] = 0; + pInvokes.dGlobal["$mvForwardAction"] = 0; //console.SetVar("$mvForwardAction", 0); - omni.dGlobal["$mvBackwardAction"] = -val*movementSpeed; + pInvokes.dGlobal["$mvBackwardAction"] = -val*movementSpeed; //console.SetVar("$mvBackwardAction", -val.AsDouble() * movementSpeed); } } @@ -342,22 +340,22 @@ public static void gamepadYaw(float val) float yawAdj = getGamepadAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera()) { - yawAdj = omni.Util.mClamp(yawAdj, (float) (-omni.Util.m2Pi() + 0.01), (float) (omni.Util.m2Pi() - 0.01)); + yawAdj = pInvokes.Util.mClamp(yawAdj, (float) (-pInvokes.Util.m2Pi() + 0.01), (float) (pInvokes.Util.m2Pi() - 0.01)); yawAdj *= (float) 0.5; } if (yawAdj > 0) { - omni.fGlobal["$mvYawLeftSpeed"] = yawAdj; - omni.fGlobal["$mvYawRightSpeed"] = 0; + pInvokes.fGlobal["$mvYawLeftSpeed"] = yawAdj; + pInvokes.fGlobal["$mvYawRightSpeed"] = 0; //console.SetVar("$mvYawLeftSpeed", yawAdj); //console.SetVar("$mvYawRightSpeed", 0); } else { - omni.fGlobal["$mvYawLeftSpeed"] = 0; + pInvokes.fGlobal["$mvYawLeftSpeed"] = 0; //console.SetVar("$mvYawLeftSpeed", 0); - omni.fGlobal["$mvYawRightSpeed"] = -yawAdj; + pInvokes.fGlobal["$mvYawRightSpeed"] = -yawAdj; //console.SetVar("$mvYawRightSpeed", -yawAdj); } } @@ -368,20 +366,20 @@ public static void gamepadPitch(float val) float pitchAdj = getGamepadAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera()) { - pitchAdj = omni.Util.mClamp(pitchAdj, (float) (-omni.Util.m2Pi() + 0.01), (float) (omni.Util.m2Pi() - 0.01)); + pitchAdj = pInvokes.Util.mClamp(pitchAdj, (float) (-pInvokes.Util.m2Pi() + 0.01), (float) (pInvokes.Util.m2Pi() - 0.01)); pitchAdj *= (float) 0.5; } if (pitchAdj > 0) { - omni.fGlobal["$mvPitchDownSpeed"] = -pitchAdj; //- and + swap for INVERTED look - omni.fGlobal["$mvPitchUpSpeed"] = 0; + pInvokes.fGlobal["$mvPitchDownSpeed"] = -pitchAdj; //- and + swap for INVERTED look + pInvokes.fGlobal["$mvPitchUpSpeed"] = 0; //console.SetVar("$mvPitchDownSpeed", pitchAdj); //console.SetVar("$mvPitchUpSpeed", 0); } else { - omni.fGlobal["$mvPitchDownSpeed"] = 0; - omni.fGlobal["$mvPitchUpSpeed"] = pitchAdj; //- and + swap for INVERTED look + pInvokes.fGlobal["$mvPitchDownSpeed"] = 0; + pInvokes.fGlobal["$mvPitchUpSpeed"] = pitchAdj; //- and + swap for INVERTED look //console.SetVar("$mvPitchDownSpeed", 0); //console.SetVar("$mvPitchUpSpeed", -pitchAdj); } @@ -390,75 +388,75 @@ public static void gamepadPitch(float val) [ConsoleInteraction(true)] public static void doCrouch(string val) { - omni.iGlobal["$mvTriggerCount3"] += 1; + pInvokes.iGlobal["$mvTriggerCount3"] += 1; //console.SetVar("$mvTriggerCount3", console.GetVarString("$mvTriggerCount3").AsInt() + 1); } [ConsoleInteraction(true)] public static void doSprint(string val) { - omni.iGlobal["$mvTriggerCount5"] += 1; + pInvokes.iGlobal["$mvTriggerCount5"] += 1; //console.SetVar("$mvTriggerCount5", console.GetVarString("$mvTriggerCount5").AsInt() + 1); } [ConsoleInteraction(true)] public static void mouseFire(string val) { - omni.iGlobal["$mvTriggerCount0"] += 1; + pInvokes.iGlobal["$mvTriggerCount0"] += 1; //console.SetVar("$mvTriggerCount0", console.GetVarString("$mvTriggerCount0").AsInt() + 1); } [ConsoleInteraction(true)] public static void altTrigger(string val) { - omni.iGlobal["$mvTriggerCount1"] += 1; + pInvokes.iGlobal["$mvTriggerCount1"] += 1; //console.SetVar("$mvTriggerCount1", console.GetVarString("$mvTriggerCount1").AsInt() + 1); } [ConsoleInteraction(true)] public static void gamepadFire(double val) { - if (val > .1 && !omni.console.GetVarBool("$gamepadFireTriggered")) + if (val > .1 && !pInvokes.console.GetVarBool("$gamepadFireTriggered")) { - omni.bGlobal["$gamepadFireTriggered"] = true; - omni.Util.rumble("gamepad", (float) 0.25, (float) 0.25); //deviceName, Left Motor(low-frequency),Right Motor(high-frequency)//Rumble Start + pInvokes.bGlobal["$gamepadFireTriggered"] = true; + pInvokes.Util.rumble("gamepad", (float) 0.25, (float) 0.25); //deviceName, Left Motor(low-frequency),Right Motor(high-frequency)//Rumble Start //console.SetVar("$gamepadFireTriggered", true); //console.SetVar("$mvTriggerCount0", console.GetVarString("$mvTriggerCount0").AsInt() + 1); } else { - omni.bGlobal["$gamepadFireTriggered"] = false; - omni.Util.rumble("gamepad", 0, 0); + pInvokes.bGlobal["$gamepadFireTriggered"] = false; + pInvokes.Util.rumble("gamepad", 0, 0); //console.SetVar("$gamepadFireTriggered", false); //console.SetVar("$mvTriggerCount0", console.GetVarString("$mvTriggerCount0").AsInt() + 1); } - omni.iGlobal["$mvTriggerCount0"] += 1; + pInvokes.iGlobal["$mvTriggerCount0"] += 1; } [ConsoleInteraction(true)] public static void gamepadAltTrigger(double val) { - if (val > .1 && !omni.bGlobal["$gamepadFireTriggered"]) + if (val > .1 && !pInvokes.bGlobal["$gamepadFireTriggered"]) { - omni.bGlobal["$gamepadAltTriggerTriggered"] = true; + pInvokes.bGlobal["$gamepadAltTriggerTriggered"] = true; // console.SetVar("$gamepadAltTriggerTriggered", true); } else { - omni.bGlobal["$gamepadAltTriggerTriggered"] = false; + pInvokes.bGlobal["$gamepadAltTriggerTriggered"] = false; //console.SetVar("$gamepadAltTriggerTriggered", false); } - omni.iGlobal["$mvTriggerCount1"] += 1; + pInvokes.iGlobal["$mvTriggerCount1"] += 1; //console.SetVar("$mvTriggerCount1", console.GetVarString("$mvTriggerCount1").AsInt() + 1); } [ConsoleInteraction(true)] public static void toggleZoomFOV() { - float cfov = omni.fGlobal["$Player::CurrentFOV"]/(float) 2.0; + float cfov = pInvokes.fGlobal["$Player::CurrentFOV"]/(float) 2.0; - omni.console.SetVar("$Player::CurrentFOV", cfov); - omni.fGlobal["$Player::CurrentFOV"] = cfov; + pInvokes.console.SetVar("$Player::CurrentFOV", cfov); + pInvokes.fGlobal["$Player::CurrentFOV"] = cfov; if (cfov < 5) resetCurrentFOV(); @@ -466,9 +464,9 @@ public static void toggleZoomFOV() if (((GameConnection) "ServerConnection")["zoomed"].AsBool()) //console.GetVarBool("ServerConnection.zoomed")) - omni.console.Call("setFov", new[] {cfov.AsString()}); + pInvokes.console.Call("setFov", new[] {cfov.AsString()}); else - omni.console.Call("setFov", new[] {omni.console.GetVarString("ServerConnection.getControlCameraDefaultFov()")}); + pInvokes.console.Call("setFov", new[] {pInvokes.console.GetVarString("ServerConnection.getControlCameraDefaultFov()")}); } [ConsoleInteraction(true)] @@ -480,15 +478,15 @@ public static void mouseButtonZoom(bool val) [ConsoleInteraction(true)] public static void resetCurrentFOV() { - omni.fGlobal["$Player::CurrentFOV"] = ((GameConnection) "ServerConnection").getControlCameraDefaultFov()/2.0f; + pInvokes.fGlobal["$Player::CurrentFOV"] = ((GameConnection) "ServerConnection").getControlCameraDefaultFov()/2.0f; //console.SetVar("$Player::CurrentFOV", console.GetVarFloat("ServerConnection.getControlCameraDefaultFov") / (float)2.0); } [ConsoleInteraction(true)] public static void turnOffZoom() { - omni.console.SetVar("ServerConnection.zoomed", false); - omni.console.Call("setFov", new[] {((GameConnection) "ServerConnection").getControlCameraDefaultFov().AsString()}); + pInvokes.console.SetVar("ServerConnection.zoomed", false); + pInvokes.console.Call("setFov", new[] {((GameConnection) "ServerConnection").getControlCameraDefaultFov().AsString()}); postFXManager.ppOptionsUpdateDOFSettings(); } @@ -504,8 +502,8 @@ public static void toggleZoom(bool val) { if (val) { - omni.console.SetVar("ServerConnection.zoomed", true); - omni.console.Call("setFov", new[] {omni.console.GetVarString("$Player::CurrentFOV")}); + pInvokes.console.SetVar("ServerConnection.zoomed", true); + pInvokes.console.Call("setFov", new[] {pInvokes.console.GetVarString("$Player::CurrentFOV")}); ((DOFPostEffect) "DOFPostEffect").setAutoFocus(true); //DOFPostEffectsetAutoFocus("DOFPostEffect", true); @@ -522,7 +520,7 @@ public static void toggleZoom(bool val) [ConsoleInteraction(true)] public static void toggleFreeLook(bool val) { - omni.bGlobal["$mvFreeLook"] = val; + pInvokes.bGlobal["$mvFreeLook"] = val; //console.SetVar("$mvFreeLook", val); } @@ -541,21 +539,21 @@ public static void toggleFirstPerson(bool val) public static void toggleCamera(bool val) { if (val) - omni.console.commandToServer("ToggleCamera"); + pInvokes.console.commandToServer("ToggleCamera"); } [ConsoleInteraction(true)] public static void startRecordingDemo(bool val) { if (val) - omni.console.Call("StartDemoRecord"); + pInvokes.console.Call("StartDemoRecord"); } [ConsoleInteraction(true)] public static void stopRecordingDemo(bool val) { if (val) - omni.console.Call("StopDemoRecord"); + pInvokes.console.Call("StopDemoRecord"); } [ConsoleInteraction(true)] @@ -563,7 +561,7 @@ public static void bringUpOptions(bool val) { if (val) { - omni.console.Call("showCursor"); + pInvokes.console.Call("showCursor"); ((GuiCanvas) "Canvas").pushDialog("OptionsDlg"); } } @@ -647,15 +645,15 @@ public static void doProfile(bool val) { if (val) { - omni.console.print("Starting profile session..."); - omni.Util.profilerReset(); - omni.Util.profilerEnable(true); + pInvokes.console.print("Starting profile session..."); + pInvokes.Util.profilerReset(); + pInvokes.Util.profilerEnable(true); } else { - omni.console.print("Ending profile session..."); - omni.Util.profilerDumpToFile("profilerDumpToFile" + omni.console.Call("getSimTime") + ".txt"); - omni.Util.profilerEnable(false); + pInvokes.console.print("Ending profile session..."); + pInvokes.Util.profilerDumpToFile("profilerDumpToFile" + pInvokes.console.Call("getSimTime") + ".txt"); + pInvokes.Util.profilerEnable(false); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/devHelpers.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/devHelpers.cs index 2377cdc2..817d6a6e 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/devHelpers.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/devHelpers.cs @@ -37,14 +37,12 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { - public class devHelpers + public class devHelpers : pInvokes { - private static readonly pInvokes omni = new pInvokes(); - /// Shortcut for typing dbgSetParameters with the default values torsion uses. public static void dbgTorsion() { - omni.console.Call("dbgSetParameters", new string[] {"6060", "password", "false"}); + console.Call("dbgSetParameters", new string[] {"6060", "password", "false"}); } // Reset the input state to a default of all-keys-up. @@ -55,12 +53,12 @@ public static void mvReset() // for ( %i = 0; %i < 6; %i++ ) //setVariable( "mvTriggerCount" @ %i, 0 ); for (int i = 0; i < 6; i++) - omni.iGlobal["mvTriggerCount" + i] = 0; + iGlobal["mvTriggerCount" + i] = 0; - omni.iGlobal["$mvUpAction"] = 0; - omni.iGlobal["$mvDownAction"] = 0; - omni.iGlobal["$mvLeftAction"] = 0; - omni.iGlobal["$mvRightAction"] = 0; + iGlobal["$mvUpAction"] = 0; + iGlobal["$mvDownAction"] = 0; + iGlobal["$mvLeftAction"] = 0; + iGlobal["$mvRightAction"] = 0; } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/game.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/game.cs index 6c20c390..c25695e7 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/game.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/game.cs @@ -43,8 +43,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class game { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void ClientCmdGameEnd(string endgamepause) { @@ -69,7 +67,7 @@ public static void ClientCmdGameEnd(string endgamepause) ((GuiCanvas) "Canvas").setContent("EndGameGui"); if (endgamepause.AsInt() > 0) - omni.Util._schedule((endgamepause.AsInt()*1000).AsString(), "0", "ShowLoading"); + pInvokes.Util._schedule((endgamepause.AsInt()*1000).AsString(), "0", "ShowLoading"); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/init.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/init.cs index d25030d2..dd28097b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/init.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/init.cs @@ -52,19 +52,17 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class init { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void initClient() { - omni.console.print("\n--------- Initializing " + omni.sGlobal["$appName"] + ": Client Scripts ---------"); + pInvokes.console.print("\n--------- Initializing " + pInvokes.sGlobal["$appName"] + ": Client Scripts ---------"); // Make sure this variable reflects the correct state. - omni.bGlobal["$Server::Dedicated"] = false; + pInvokes.bGlobal["$Server::Dedicated"] = false; // Game information used to query the master server - omni.sGlobal["$Client::GameTypeQuery"] = omni.sGlobal["$appName"]; - omni.sGlobal["$Client::MissionTypeQuery"] = "Any"; + pInvokes.sGlobal["$Client::GameTypeQuery"] = pInvokes.sGlobal["$appName"]; + pInvokes.sGlobal["$Client::MissionTypeQuery"] = "Any"; // These should be game specific GuiProfiles. Custom profiles are saved out // from the Gui Editor. Either of these may override any that already exist. @@ -78,35 +76,35 @@ public static void initClient() canvas.configureCanvas(); // Load up the Game GUIs - //omni.Util.exec("art/gui/PlayGui.gui", false, false); + //pInvokes.Util.exec("art/gui/PlayGui.gui", false, false); playGui.initialize(); - //omni.Util.exec("art/gui/playerList.gui", false, false); + //pInvokes.Util.exec("art/gui/playerList.gui", false, false); - //omni.Util.exec("art/gui/hudlessGui.gui", false, false); + //pInvokes.Util.exec("art/gui/hudlessGui.gui", false, false); hudlessGui.initialize(); // Load up the shell GUIs - //omni.Util.exec("art/gui/mainMenuGui.gui", false, false); + //pInvokes.Util.exec("art/gui/mainMenuGui.gui", false, false); mainMenuGui.initialize(); - //omni.Util.exec("art/gui/joinServerDlg.gui", false, false); + //pInvokes.Util.exec("art/gui/joinServerDlg.gui", false, false); JoinServerDlg.initialize(); - //omni.Util.exec("art/gui/endGameGui.gui", false, false); + //pInvokes.Util.exec("art/gui/endGameGui.gui", false, false); endGameGui.initialize(); - //omni.Util.exec("art/gui/StartupGui.gui", false, false); + //pInvokes.Util.exec("art/gui/StartupGui.gui", false, false); startupGui.initialize(); - //omni.Util.exec("art/gui/chooseLevelDlg.gui", false, false); + //pInvokes.Util.exec("art/gui/chooseLevelDlg.gui", false, false); //chooseLevelDlg.Initialize(); - //omni.Util.exec("art/gui/loadingGui.gui", false, false); + //pInvokes.Util.exec("art/gui/loadingGui.gui", false, false); loadingGui.initialize(); - //omni.Util.exec("art/gui/optionsDlg.gui", false, false); + //pInvokes.Util.exec("art/gui/optionsDlg.gui", false, false); OptionsDlg.initialize(); ToolsDlg.initialize(); @@ -115,10 +113,10 @@ public static void initClient() ContentBrowserGui.initialize(); - //omni.Util.exec("art/gui/remapDlg.gui", false, false); + //pInvokes.Util.exec("art/gui/remapDlg.gui", false, false); RemapDlg.initialize(); - //omni.Util.exec("scripts/gui/optionsDlg.cs", false, false); + //pInvokes.Util.exec("scripts/gui/optionsDlg.cs", false, false); Misc.initialize(); // Client scripts @@ -129,8 +127,8 @@ public static void initClient() // Default player key bindings defaultBind.initialize(); - if (omni.Util.isFile("scripts/client/config.cs")) - omni.Util.exec("scripts/client/config.cs", false, false); + if (pInvokes.Util.isFile("scripts/client/config.cs")) + pInvokes.Util.exec("scripts/client/config.cs", false, false); //string[] files = Directory.GetFiles( System.IO.Path.Combine( AppDomain.CurrentDomain.BaseDirectory,@"art\gui"), "*.png", SearchOption.AllDirectories); //foreach (string file in files) @@ -159,31 +157,31 @@ public static void initClient() // going to connect to a remote server, or host a multi-player // game. - omni.Util.setNetPort(0, false); + pInvokes.Util.setNetPort(0, false); - omni.console.Call("setDefaultFov", new[] {omni.sGlobal["$pref::Player::defaultFov"]}); - omni.console.Call("setZoomSpeed", new[] {omni.sGlobal["$pref::Player::zoomSpeed"]}); + pInvokes.console.Call("setDefaultFov", new[] {pInvokes.sGlobal["$pref::Player::defaultFov"]}); + pInvokes.console.Call("setZoomSpeed", new[] {pInvokes.sGlobal["$pref::Player::zoomSpeed"]}); audioData.initialize(); // Start up the main menu... this is separated out into a // method for easier mod override - if (omni.bGlobal["$startWorldEditor"] || omni.bGlobal["$startGUIEditor"]) + if (pInvokes.bGlobal["$startWorldEditor"] || pInvokes.bGlobal["$startGUIEditor"]) // Editor GUI's will start up in the primary main.cs once // engine is initialized. return; - if (omni.sGlobal["$JoinGameAddress"] != "") + if (pInvokes.sGlobal["$JoinGameAddress"] != "") { loadLoadingGui("loadLoadingGui"); - missionDownload.connect(omni.sGlobal["$JoinGameAddress"]); + missionDownload.connect(pInvokes.sGlobal["$JoinGameAddress"]); } else { // Otherwise go to the splash screen. ((GuiCanvas) "canvas").setCursor("DefaultCursor"); startupGui.loadStartup(); - //omni.console.Call("loadStartup"); + //pInvokes.console.Call("loadStartup"); } } @@ -198,20 +196,20 @@ public static void loadMainMenu() // first check if we have a level file to load - if (omni.sGlobal["$levelToLoad"] != "") + if (pInvokes.sGlobal["$levelToLoad"] != "") { string levelfile = "levels/"; - if (!omni.sGlobal["$levelToLoad"].EndsWith(".mis")) - levelfile += omni.sGlobal["$levelToLoad"] + ".mis"; + if (!pInvokes.sGlobal["$levelToLoad"].EndsWith(".mis")) + levelfile += pInvokes.sGlobal["$levelToLoad"] + ".mis"; else - levelfile += omni.sGlobal["$levelToLoad"]; + levelfile += pInvokes.sGlobal["$levelToLoad"]; // Clear out the $levelToLoad so we don't attempt to load the level again // later on. - omni.sGlobal["$levelToLoad"] = ""; + pInvokes.sGlobal["$levelToLoad"] = ""; - string file = omni.Util.findFirstFile(levelfile, false); + string file = pInvokes.Util.findFirstFile(levelfile, false); if (file != "") server.createAndConnectToLocalServer("SinglePlayer", file); } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting.cs index 6f97e348..1f5b0117 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -40,35 +40,33 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class lighting { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void initLightingSystems() { - omni.console.print("\n--------- Initializing Lighting Systems ---------"); + pInvokes.console.print("\n--------- Initializing Lighting Systems ---------"); - omni.console.print("\n--------- Initializing Advanced Lighting ---------"); + pInvokes.console.print("\n--------- Initializing Advanced Lighting ---------"); Lighting.advanced.init.initialize(); - omni.console.print("\n--------- Initializing Basic Lighting ---------"); + pInvokes.console.print("\n--------- Initializing Basic Lighting ---------"); Lighting.basic.init.initialize(); - omni.console.print("\n--------- Initializing ShadowMaps Lighting ---------"); + pInvokes.console.print("\n--------- Initializing ShadowMaps Lighting ---------"); Lighting.shadowMaps.init.initialize(); - omni.console.print("\n--------- Finished Initializing Advanced Lighting ---------"); + pInvokes.console.print("\n--------- Finished Initializing Advanced Lighting ---------"); // Try the perfered one first. - bool success = omni.Util.setLightManager(omni.sGlobal["$pref::lightManager"]); + bool success = pInvokes.Util.setLightManager(pInvokes.sGlobal["$pref::lightManager"]); if (!success) { // The perfered one fell thru... so go thru the default // light managers until we find one that works. - int lmCount = omni.Util.getFieldCount(omni.sGlobal["$lightManager::defaults"]); + int lmCount = pInvokes.Util.getFieldCount(pInvokes.sGlobal["$lightManager::defaults"]); for (int i = 0; i < lmCount; i++) { - string lmName = omni.Util.getField(omni.sGlobal["$lightManager::defaults"], i); - success = omni.Util.setLightManager(lmName); + string lmName = pInvokes.Util.getField(pInvokes.sGlobal["$lightManager::defaults"], i); + success = pInvokes.Util.setLightManager(lmName); if (success) break; } @@ -81,26 +79,26 @@ public static void initLightingSystems() //t3d.Util.quitWithErrorMessage("Failed to set a light manager!"); Main.quitWithErrorMessage("Failed to set a light manager!"); } - omni.console.print("\n"); + pInvokes.console.print("\n"); } [ConsoleInteraction(true)] public static void onLightManagerActivate(string lmName) { - omni.sGlobal["$pref::lightManager"] = lmName; - omni.console.print("Using " + lmName); + pInvokes.sGlobal["$pref::lightManager"] = lmName; + pInvokes.console.print("Using " + lmName); string activateNewFn = "onActivate" + lmName.Split(' ')[0] + "LM"; - if (omni.console.isFunction(activateNewFn)) - omni.console.Call(activateNewFn); + if (pInvokes.console.isFunction(activateNewFn)) + pInvokes.console.Call(activateNewFn); } [ConsoleInteraction(true)] public static void onLightManagerDeactivate(string lmName) { string deactivateOldfn = "onDeactivate" + lmName.Split(' ')[0] + "LM"; - if (omni.console.isFunction(deactivateOldfn)) - omni.console.Call(deactivateOldfn); + if (pInvokes.console.isFunction(deactivateOldfn)) + pInvokes.console.Call(deactivateOldfn); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/init.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/init.cs index 9ac6b907..c92b7129 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/init.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/init.cs @@ -41,8 +41,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced { public class init { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { shaders.initialize(); @@ -53,9 +51,9 @@ public static void initialize() [ConsoleInteraction(true)] public static void onActivateAdvancedLM() { - if (omni.sGlobal["$platform"] == "macos") + if (pInvokes.sGlobal["$platform"] == "macos") return; - if (omni.sGlobal["$platform"] == "xenon") + if (pInvokes.sGlobal["$platform"] == "xenon") return; ((RenderFormatToken) "AL_FormatToken").enable(); } @@ -69,7 +67,7 @@ public static void onDeactivateAdvancedLM() [ConsoleInteraction(true)] public static void setAdvancedLighting() { - omni.Util.setLightManager("Advanced Lighting"); + pInvokes.Util.setLightManager("Advanced Lighting"); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/lightViz.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/lightViz.cs index 97c0726c..ed8b594b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/lightViz.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/lightViz.cs @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced { public class lightViz { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { ObjectCreator tch = new ObjectCreator("GFXStateBlockData", "AL_DepthVisualizeState"); @@ -134,7 +132,7 @@ public static void toggleDepthViz(string enabled) { if (enabled == "") { - omni.bGlobal["$AL_DepthVisualizeVar"] = !((PostEffect) "AL_DepthVisualize").isEnabled; + pInvokes.bGlobal["$AL_DepthVisualizeVar"] = !((PostEffect) "AL_DepthVisualize").isEnabled; ((PostEffect) "AL_DepthVisualize").toggle(); } else if (enabled.AsBool()) @@ -148,7 +146,7 @@ public static void toggleNormalsViz(string enabled) { if (enabled == "") { - omni.bGlobal["$AL_NormalsVisualizeVar"] = !((PostEffect) "AL_NormalsVisualize").isEnabled; + pInvokes.bGlobal["$AL_NormalsVisualizeVar"] = !((PostEffect) "AL_NormalsVisualize").isEnabled; ((PostEffect) "AL_NormalsVisualize").toggle(); } else if (enabled.AsBool()) @@ -162,7 +160,7 @@ public static void toggleLightColorViz(string enabled) { if (enabled == "") { - omni.bGlobal["$AL_LightColorVisualizeVar"] = !((PostEffect) "AL_LightColorVisualize").isEnabled; + pInvokes.bGlobal["$AL_LightColorVisualizeVar"] = !((PostEffect) "AL_LightColorVisualize").isEnabled; ((PostEffect) "AL_LightColorVisualize").toggle(); } else if (enabled.AsBool()) @@ -176,7 +174,7 @@ public static void toggleLightSpecularViz(string enabled) { if (enabled == "") { - omni.bGlobal["$AL_LightSpecularVisualizeVar"] = !((PostEffect) "AL_LightSpecularVisualize").isEnabled; + pInvokes.bGlobal["$AL_LightSpecularVisualizeVar"] = !((PostEffect) "AL_LightSpecularVisualize").isEnabled; ((PostEffect) "AL_LightSpecularVisualize").toggle(); } else if (enabled.AsBool()) diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shaders.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shaders.cs index a72ad907..a90e3327 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shaders.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shaders.cs @@ -40,8 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced { public class shaders { - public static readonly pInvokes omni = new pInvokes(); - public static void initialize() { ObjectCreator tch = new ObjectCreator("GFXStateBlockData", "AL_VectorLightState"); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.cs index 743aebc3..62b037d9 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.cs @@ -36,6 +36,7 @@ using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; +using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced @@ -84,13 +85,13 @@ public static void toggleShadowViz() { if (((GuiControl) "AL_ShadowVizOverlayCtrl").isAwake()) { - omni.Util.setShadowVizLight("0"); + pInvokes.Util.setShadowVizLight("0"); ((GuiCanvas) "Canvas").popDialog("AL_ShadowVizOverlayCtrl"); } else { ((GuiCanvas) "Canvas").pushDialog("AL_ShadowVizOverlayCtrl", 100); - _setShadowVizLight(omni.console.Call("EWorldEditor", "getSelectedObject", new[] {"0"}), false); + _setShadowVizLight(pInvokes.console.Call("EWorldEditor", "getSelectedObject", new[] {"0"}), false); } } @@ -110,16 +111,16 @@ public static void _setShadowVizLight(string light, bool force) //todo Got a bug here I think, don't know enough about lighting to debug it at the moment. the sizeAndAspect is always blank. string clientLight = client.serverToClientObject(light.AsInt()).AsString(); //console.Call("serverToClientObject", new string[] { light }); - sizeAndAspect = omni.Util.setShadowVizLight(clientLight); + sizeAndAspect = pInvokes.Util.setShadowVizLight(clientLight); } - omni.console.Call(AL_ShadowVizOverlayCtrl.findObjectByInternalName("MatCtrl", true), "setMaterial", new[] {"AL_ShadowVisualizeMaterial"}); + pInvokes.console.Call(AL_ShadowVizOverlayCtrl.findObjectByInternalName("MatCtrl", true), "setMaterial", new[] {"AL_ShadowVisualizeMaterial"}); string text = "ShadowViz"; if (light.isObject() && sizeAndAspect != "") text = text + ":" + sizeAndAspect.Split(' ')[0] + " x " + sizeAndAspect.Split(' ')[1]; - omni.console.SetVar(AL_ShadowVizOverlayCtrl.findObjectByInternalName("WindowCtrl", true), text); + pInvokes.console.SetVar(AL_ShadowVizOverlayCtrl.findObjectByInternalName("WindowCtrl", true), text); } [ConsoleInteraction(true)] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.gui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.gui.cs index babc4095..cf440fc9 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.gui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.gui.cs @@ -39,11 +39,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced { public partial class shadowViz { - private static readonly pInvokes omni = new pInvokes(); - public static void Initialize_Gui() { - omni.console.Eval(@" + pInvokes.console.Eval(@" %guiContent = new GuiControl(AL_ShadowVizOverlayCtrl) { canSaveDynamicFields = ""0""; isContainer = ""1""; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/basic/init.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/basic/init.cs index ecf219ff..939eda25 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/basic/init.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/basic/init.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -43,13 +43,11 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.basic { public class init { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.console.print("\n--------- Initializing Shadow Filter ---------"); + pInvokes.console.print("\n--------- Initializing Shadow Filter ---------"); shadowFilter.initialize(); - omni.console.print("\n--------- Finished Initializing Shadow Filter ---------"); + pInvokes.console.print("\n--------- Finished Initializing Shadow Filter ---------"); SingletonCreator ts = new SingletonCreator("GFXStateBlockData", "BL_ProjectedShadowSBData"); ts["blendDefined"] = true; @@ -90,7 +88,7 @@ public static void initialize() public static void onActivateBasicLM() { // If HDR is enabled... enable the special format token. - if ((omni.sGlobal["$platform"] == "macos") || ((PostEffect) "HDRPostFx").isEnabledX()) + if ((pInvokes.sGlobal["$platform"] == "macos") || ((PostEffect) "HDRPostFx").isEnabledX()) ((RenderFormatToken) "AL_FormatToken").enable(); // Create render pass for projected shadow. @@ -119,7 +117,7 @@ public static void onDeactivateBasicLM() [ConsoleInteraction(true)] public static void setBasicLighting() { - omni.Util.setLightManager("Basic Lighting"); + pInvokes.Util.setLightManager("Basic Lighting"); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/metrics.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/metrics.cs index 01a2a4e7..dca5a283 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/metrics.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/metrics.cs @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class metrics { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { //con.error("------------------------>LOADING FRAMEOVERLAYGUI!!!!!!!!!!!!!!!!!!!!!"); @@ -58,10 +56,10 @@ public static string fpsMetricsCallback() { StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | FPS | "); - outtext.Append(omni.sGlobal["$fps::real"] + " max: "); - outtext.Append(omni.sGlobal["$fps::realMax"] + " min: "); - outtext.Append(omni.sGlobal["$fps::realMin"] + " mspf: "); - outtext.Append((1000.0/omni.dGlobal["$fps::real"])); + outtext.Append(pInvokes.sGlobal["$fps::real"] + " max: "); + outtext.Append(pInvokes.sGlobal["$fps::realMax"] + " min: "); + outtext.Append(pInvokes.sGlobal["$fps::realMin"] + " mspf: "); + outtext.Append((1000.0/pInvokes.dGlobal["$fps::real"])); return outtext.ToString(); //return " | FPS | " + // t3d.sGlobal["$fps::real"] + " max: " + @@ -76,11 +74,11 @@ public static string gfxMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | GFX |"); outtext.Append(" PolyCount: "); - outtext.Append(omni.sGlobal["$GFXDeviceStatistics::polyCount"]); + outtext.Append(pInvokes.sGlobal["$GFXDeviceStatistics::polyCount"]); outtext.Append(" DrawCalls: "); - outtext.Append(omni.sGlobal["$GFXDeviceStatistics::drawCalls"]); + outtext.Append(pInvokes.sGlobal["$GFXDeviceStatistics::drawCalls"]); outtext.Append(" RTChanges: "); - outtext.Append(omni.sGlobal["$GFXDeviceStatistics::renderTargetChanges"]); + outtext.Append(pInvokes.sGlobal["$GFXDeviceStatistics::renderTargetChanges"]); return outtext.ToString(); //return " | GFX |" + @@ -98,11 +96,11 @@ public static string terrainMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Terrain |"); outtext.Append(" Cells: "); - outtext.Append(omni.sGlobal["$TerrainBlock::cellsRendered"]); + outtext.Append(pInvokes.sGlobal["$TerrainBlock::cellsRendered"]); outtext.Append(" Override Cells: "); - outtext.Append(omni.sGlobal["$TerrainBlock::overrideCells"]); + outtext.Append(pInvokes.sGlobal["$TerrainBlock::overrideCells"]); outtext.Append(" DrawCalls: "); - outtext.Append(omni.sGlobal["$TerrainBlock::drawCalls"]); + outtext.Append(pInvokes.sGlobal["$TerrainBlock::drawCalls"]); return outtext.ToString(); //return // " | Terrain |" + @@ -120,11 +118,11 @@ public static string netMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Net |"); outtext.Append(" BitsSent: "); - outtext.Append(omni.sGlobal["$Stats::netBitsSent"]); + outtext.Append(pInvokes.sGlobal["$Stats::netBitsSent"]); outtext.Append(" BitsRcvd: "); - outtext.Append(omni.sGlobal["$Stats::netBitsReceived"]); + outtext.Append(pInvokes.sGlobal["$Stats::netBitsReceived"]); outtext.Append(" GhostUpd: "); - outtext.Append(omni.sGlobal["$Stats::netGhostUpdates"]); + outtext.Append(pInvokes.sGlobal["$Stats::netGhostUpdates"]); return outtext.ToString(); //return @@ -143,13 +141,13 @@ public static string groundCoverMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | GroundCover |"); outtext.Append(" Cells: "); - outtext.Append(omni.sGlobal["$GroundCover::renderedCells"]); + outtext.Append(pInvokes.sGlobal["$GroundCover::renderedCells"]); outtext.Append(" Billboards: "); - outtext.Append(omni.sGlobal["$GroundCover::renderedBillboards"]); + outtext.Append(pInvokes.sGlobal["$GroundCover::renderedBillboards"]); outtext.Append(" Batches: "); - outtext.Append(omni.sGlobal["$GroundCover::renderedBatches"]); + outtext.Append(pInvokes.sGlobal["$GroundCover::renderedBatches"]); outtext.Append(" Shapes: "); - outtext.Append(omni.sGlobal["$GroundCover::renderedShapes"]); + outtext.Append(pInvokes.sGlobal["$GroundCover::renderedShapes"]); return outtext.ToString(); //return @@ -170,28 +168,28 @@ public static string sfxMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | SFX |"); outtext.Append(" Sounds: "); - outtext.Append(omni.sGlobal["$SFX::numSounds"]); + outtext.Append(pInvokes.sGlobal["$SFX::numSounds"]); outtext.Append(" Lists: "); - outtext.Append((omni.iGlobal["$SFX::numSources"] - omni.iGlobal["$SFX::numSounds"] - omni.iGlobal["$SFX::Device::fmodNumEventSource"])); + outtext.Append((pInvokes.iGlobal["$SFX::numSources"] - pInvokes.iGlobal["$SFX::numSounds"] - pInvokes.iGlobal["$SFX::Device::fmodNumEventSource"])); outtext.Append(" Events: "); - outtext.Append(omni.sGlobal["$SFX::fmodNumEventSources"]); + outtext.Append(pInvokes.sGlobal["$SFX::fmodNumEventSources"]); outtext.Append(" Playing: "); - outtext.Append(omni.sGlobal["$SFX::numPlaying"]); + outtext.Append(pInvokes.sGlobal["$SFX::numPlaying"]); outtext.Append(" Culled: "); - outtext.Append(omni.sGlobal["$SFX::numCulled"]); + outtext.Append(pInvokes.sGlobal["$SFX::numCulled"]); outtext.Append(" Voices: "); - outtext.Append(omni.sGlobal["$SFX::numVoices"]); + outtext.Append(pInvokes.sGlobal["$SFX::numVoices"]); outtext.Append(" Buffers: "); - outtext.Append(omni.sGlobal["$SFX::Device::numBuffers"]); + outtext.Append(pInvokes.sGlobal["$SFX::Device::numBuffers"]); outtext.Append(" Memory: "); - outtext.Append((omni.dGlobal["$SFX::Device::numBufferBytes"]/1024.0/1024.0)); + outtext.Append((pInvokes.dGlobal["$SFX::Device::numBufferBytes"]/1024.0/1024.0)); outtext.Append(" MB"); outtext.Append(" Time/S: "); - outtext.Append(omni.sGlobal["$SFX::sourceUpdateTime"]); + outtext.Append(pInvokes.sGlobal["$SFX::sourceUpdateTime"]); outtext.Append(" Time/P: "); - outtext.Append(omni.sGlobal["$SFX::parameterUpdateTime"]); + outtext.Append(pInvokes.sGlobal["$SFX::parameterUpdateTime"]); outtext.Append(" Time/A: "); - outtext.Append(omni.sGlobal["$SFX::ambientUpdateTime"]); + outtext.Append(pInvokes.sGlobal["$SFX::ambientUpdateTime"]); return outtext.ToString(); //return @@ -224,19 +222,19 @@ public static string sfxMetricsCallback() [ConsoleInteraction(true)] public static string sfxSourcesMetricsCallback() { - return omni.Util.sfxDumpSourcesToString(false); + return pInvokes.Util.sfxDumpSourcesToString(false); } [ConsoleInteraction(true)] public static string sfxStatesMetricsCallback() { - return " | SFXStates |" + omni.sGlobal["sfxGetActiveStates"]; + return " | SFXStates |" + pInvokes.sGlobal["sfxGetActiveStates"]; } [ConsoleInteraction(true)] public static string timeMetricsCallback() { - return " | Time |" + " Sim Time: " + omni.Util.getSimTime() + " Mod: " + (omni.Util.getSimTime()%32); + return " | Time |" + " Sim Time: " + pInvokes.Util.getSimTime() + " Mod: " + (pInvokes.Util.getSimTime()%32); } [ConsoleInteraction(true)] @@ -245,24 +243,24 @@ public static string reflectMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | REFLECT |"); outtext.Append(" Objects: "); - outtext.Append(omni.sGlobal["$Reflect::numObjects"]); + outtext.Append(pInvokes.sGlobal["$Reflect::numObjects"]); outtext.Append(" Visible: "); - outtext.Append(omni.sGlobal["$Reflect::numVisible"]); + outtext.Append(pInvokes.sGlobal["$Reflect::numVisible"]); outtext.Append(" Occluded: "); - outtext.Append(omni.sGlobal["$Reflect::numOccluded"]); + outtext.Append(pInvokes.sGlobal["$Reflect::numOccluded"]); outtext.Append(" Updated: "); - outtext.Append(omni.sGlobal["$Reflect::numUpdated"]); + outtext.Append(pInvokes.sGlobal["$Reflect::numUpdated"]); outtext.Append(" Elapsed: "); - outtext.Append(omni.sGlobal["$Reflect::elapsed"]); + outtext.Append(pInvokes.sGlobal["$Reflect::elapsed"]); outtext.Append("\n"); outtext.Append(" Allocated: "); - outtext.Append(omni.sGlobal["$Reflect::renderTargetsAllocated"]); + outtext.Append(pInvokes.sGlobal["$Reflect::renderTargetsAllocated"]); outtext.Append(" Pooled: "); - outtext.Append(omni.sGlobal["$Reflect::poolSize"]); + outtext.Append(pInvokes.sGlobal["$Reflect::poolSize"]); outtext.Append("\n"); outtext.Append(" "); - string[] textstat = omni.sGlobal["$Reflect::textureStats"].Split(' '); + string[] textstat = pInvokes.sGlobal["$Reflect::textureStats"].Split(' '); if (textstat.GetUpperBound(0) > 0) { @@ -320,7 +318,7 @@ public static string reflectMetricsCallback() [ConsoleInteraction(true)] public static string decalMetricsCallback() { - return " | DECAL |" + " Batches: " + omni.sGlobal["$Decal::Batches"] + " Buffers: " + omni.sGlobal["$Decal::Buffers"] + " DecalsRendered: " + omni.sGlobal["$Decal::DecalsRendered"]; + return " | DECAL |" + " Batches: " + pInvokes.sGlobal["$Decal::Batches"] + " Buffers: " + pInvokes.sGlobal["$Decal::Buffers"] + " DecalsRendered: " + pInvokes.sGlobal["$Decal::DecalsRendered"]; } [ConsoleInteraction(true)] @@ -329,31 +327,31 @@ public static string renderMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Render |"); outtext.Append(" Int: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Interior"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Interior"]); outtext.Append(" IntDL: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_InteriorDynamicLighting"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_InteriorDynamicLighting"]); outtext.Append(" Mesh: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Mesh"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Mesh"]); outtext.Append(" MeshDL: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_MeshDynamicLighting"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_MeshDynamicLighting"]); outtext.Append(" Shadow: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Shadow"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Shadow"]); outtext.Append(" Sky: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Sky"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Sky"]); outtext.Append(" Obj: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Object"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Object"]); outtext.Append(" ObjT: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_ObjectTranslucent"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_ObjectTranslucent"]); outtext.Append(" Decal: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Decal"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Decal"]); outtext.Append(" Water: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Water"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Water"]); outtext.Append(" Foliage: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Foliage"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Foliage"]); outtext.Append(" Trans: "); - outtext.Append(omni.sGlobal["$RenderMetris::RIT_Translucent"]); + outtext.Append(pInvokes.sGlobal["$RenderMetris::RIT_Translucent"]); outtext.Append(" Custom: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Custom"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Custom"]); return outtext.ToString(); //return // " | Render |" + @@ -391,19 +389,19 @@ public static string shadowMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Shadow |"); outtext.Append(" Active: "); - outtext.Append(omni.sGlobal["$ShadowStats::activeMaps"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::activeMaps"]); outtext.Append(" Updated: "); - outtext.Append(omni.sGlobal["$ShadowStats::updatedMaps"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::updatedMaps"]); outtext.Append(" PolyCount: "); - outtext.Append(omni.sGlobal["$ShadowStats::polyCount"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::polyCount"]); outtext.Append(" DrawCalls: "); - outtext.Append(omni.sGlobal["$ShadowStats::drawCalls"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::drawCalls"]); outtext.Append(" RTChanges: "); - outtext.Append(omni.sGlobal["$ShadowStats::rtChanges"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::rtChanges"]); outtext.Append(" PoolTexCount: "); - outtext.Append(omni.sGlobal["$ShadowStats::poolTexCount"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::poolTexCount"]); outtext.Append(" PoolTexMB: "); - outtext.Append(omni.sGlobal["$ShadowStats::poolTexMemory"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::poolTexMemory"]); outtext.Append("MB"); return outtext.ToString(); @@ -432,11 +430,11 @@ public static string basicShadowMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Shadow |"); outtext.Append(" Active: "); - outtext.Append(omni.sGlobal["$BasicLightManagerStats::activePlugins"]); + outtext.Append(pInvokes.sGlobal["$BasicLightManagerStats::activePlugins"]); outtext.Append(" Updated: "); - outtext.Append(omni.sGlobal["$BasicLightManagerStats::shadowsUpdated"]); + outtext.Append(pInvokes.sGlobal["$BasicLightManagerStats::shadowsUpdated"]); outtext.Append(" Elapsed Ms: "); - outtext.Append(omni.sGlobal["$BasicLightManagerStats::elapsedUpdateMs"]); + outtext.Append(pInvokes.sGlobal["$BasicLightManagerStats::elapsedUpdateMs"]); return outtext.ToString(); //return // " | Shadow |" + @@ -451,13 +449,13 @@ public static string basicShadowMetricsCallback() [ConsoleInteraction(true)] public static string lightMetricsCallback() { - return " | Deferred Lights |" + " Active: " + omni.sGlobal["$lightMetrics::activeLights"] + " Culled: " + omni.sGlobal["$lightMetrics::culledLights"]; + return " | Deferred Lights |" + " Active: " + pInvokes.sGlobal["$lightMetrics::activeLights"] + " Culled: " + pInvokes.sGlobal["$lightMetrics::culledLights"]; } [ConsoleInteraction(true)] public static string particleMetricsCallback() { - return " | Particles |" + " # Simulated " + omni.sGlobal["$particle::numSimulated"]; + return " | Particles |" + " # Simulated " + pInvokes.sGlobal["$particle::numSimulated"]; } [ConsoleInteraction(true)] @@ -484,15 +482,15 @@ public static string imposterMetricsCallback() StringBuilder sb = new StringBuilder(1000); sb.Append(" | IMPOSTER |"); sb.Append(" Rendered: "); - sb.Append(omni.sGlobal["$ImposterStats::rendered"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::rendered"]); sb.Append(" Batches: "); - sb.Append(omni.sGlobal["$ImposterStats::batches"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::batches"]); sb.Append(" DrawCalls: "); - sb.Append(omni.sGlobal["$ImposterStats::drawCalls"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::drawCalls"]); sb.Append(" Polys: "); - sb.Append(omni.sGlobal["$ImposterStats::polyCount"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::polyCount"]); sb.Append(" RtChanges: "); - sb.Append(omni.sGlobal["$ImposterStats::rtChanges"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::rtChanges"]); return sb.ToString(); } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/mission.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/mission.cs index c61500b9..b05e7bbf 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/mission.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/mission.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -43,14 +43,12 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class mission { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { // Whether the local client is currently running a mission. - omni.bGlobal["$Client::missionRunning"] = false; + pInvokes.bGlobal["$Client::missionRunning"] = false; // Sequence number for currently running mission. - omni.iGlobal["$Client::missionSeq"] = -1; + pInvokes.iGlobal["$Client::missionSeq"] = -1; } // Called when mission is started. @@ -59,12 +57,12 @@ public static void clientStartMission() { // The client recieves a mission start right before // being dropped into the game. - omni.Util.physicsStartSimulation("client"); + pInvokes.Util.physicsStartSimulation("client"); // Start game audio effects channels. ((SFXSource) "AudioChannelEffects").play(-1); // Create client mission cleanup group. new ObjectCreator("SimGroup", "ClientMissionCleanup").Create(); - omni.bGlobal["$Client::missionRunning"] = true; + pInvokes.bGlobal["$Client::missionRunning"] = true; } // Called when mission is ended (either through disconnect or @@ -73,19 +71,19 @@ public static void clientStartMission() public static void clientEndMission() { // Stop physics simulation on client. - omni.Util.physicsStopSimulation("client"); + pInvokes.Util.physicsStopSimulation("client"); // Stop game audio effects channels. ((SFXSource) "AudioChannelEffects").stop(-1); - omni.console.Call("decalManagerClear"); + pInvokes.console.Call("decalManagerClear"); // Delete client mission cleanup group. ((SimGroup) "ClientMissionCleanup").delete(); - omni.Util.clearClientPaths(); + pInvokes.Util.clearClientPaths(); - omni.bGlobal["$Client::missionRunning"] = false; + pInvokes.bGlobal["$Client::missionRunning"] = false; } //---------------------------------------------------------------------------- @@ -96,16 +94,16 @@ public static void clientCmdMissionStart(string seq) { clientStartMission(); - omni.sGlobal["$Client::missionSeq"] = seq; + pInvokes.sGlobal["$Client::missionSeq"] = seq; } [ConsoleInteraction(true)] public static void clientCmdMissionEnd(string seq) { - if (!omni.bGlobal["$Client::missionRunning"] || omni.sGlobal["$Client::missionSeq"] != seq) + if (!pInvokes.bGlobal["$Client::missionRunning"] || pInvokes.sGlobal["$Client::missionSeq"] != seq) return; clientEndMission(); - omni.iGlobal["$Client::missionSeq"] = -1; + pInvokes.iGlobal["$Client::missionSeq"] = -1; } /// Expands the name of a mission into the full @@ -114,20 +112,20 @@ public static string expandMissionFileName(string missionFile) { // Expand any escapes in it. - missionFile = omni.Util._expandFilename(missionFile); + missionFile = pInvokes.Util._expandFilename(missionFile); string newMission = ""; - if (!omni.Util.isFile(missionFile)) + if (!pInvokes.Util.isFile(missionFile)) { if (!missionFile.Trim().EndsWith(".mis")) newMission = missionFile.Trim() + ".mis"; - if (!omni.Util.isFile(newMission)) + if (!pInvokes.Util.isFile(newMission)) { - newMission = omni.Util._expandFilename("levels/" + newMission); + newMission = pInvokes.Util._expandFilename("levels/" + newMission); - if (!omni.Util.isFile(newMission)) + if (!pInvokes.Util.isFile(newMission)) { - omni.console.warn("The mission file '" + missionFile + "' was not found."); + pInvokes.console.warn("The mission file '" + missionFile + "' was not found."); return ""; } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/missionDownload.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/missionDownload.cs index 70f322dd..976e3dad 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/missionDownload.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/missionDownload.cs @@ -46,17 +46,16 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class missionDownload { - private static readonly pInvokes omni = new pInvokes(); private static List MLoadinfo = new List(); [ConsoleInteraction(true)] public static void clientCmdMissionStartPhase1(string seq, string missionName, string musicTrack, string serverCRC) { GameConnection ServerConnection = "ServerConnection"; - omni.Util._echo("*** New Mission: " + missionName); - omni.Util._echo("*** Phase 1: Download Datablocks & Targets"); + pInvokes.Util._echo("*** New Mission: " + missionName); + pInvokes.Util._echo("*** Phase 1: Download Datablocks & Targets"); onMissionDownloadPhase1(missionName, musicTrack); - omni.sGlobal["$ServerDatablockCacheCRC"] = serverCRC; + pInvokes.sGlobal["$ServerDatablockCacheCRC"] = serverCRC; string name = missionName.Replace(" ", ""); if (name.Contains("/")) @@ -64,15 +63,15 @@ public static void clientCmdMissionStartPhase1(string seq, string missionName, s if (name.Contains(".")) name = name.Split('.')[0]; - omni.sGlobal["$ServerDatablockCacheMissionName"] = "DBCaches/" + name + "DB.db"; + pInvokes.sGlobal["$ServerDatablockCacheMissionName"] = "DBCaches/" + name + "DB.db"; if (ServerConnection.callScript("LoadDatablocksFromFile", new[] {serverCRC}).AsBool()) { - omni.console.print("Loaded Datablocks from file."); + pInvokes.console.print("Loaded Datablocks from file."); clientCmdMissionStartPhase2(seq, missionName, true); } else - omni.console.commandToServer("MissionStartPhase1Ack", new string[] {seq}); + pInvokes.console.commandToServer("MissionStartPhase1Ack", new string[] {seq}); } [ConsoleInteraction(true)] @@ -85,29 +84,29 @@ public static void onDataBlockObjectReceived(string index, string total) public static void clientCmdMissionStartPhase2(string seq, string missionName, bool isLoadedFromFile = false) { onPhase1Complete(); - omni.Util._echo("*** Phase 2: Download Ghost Objects"); + pInvokes.Util._echo("*** Phase 2: Download Ghost Objects"); onMissionDownloadPhase2(); //Push the client past the datablock transmition stage. if (isLoadedFromFile) - omni.console.commandToServer("MissionStartPhase2CacheAck"); + pInvokes.console.commandToServer("MissionStartPhase2CacheAck"); //Start next stage. - omni.console.commandToServer("MissionStartPhase2Ack", new string[] {seq, omni.sGlobal["$pref::Player:PlayerDB"]}); + pInvokes.console.commandToServer("MissionStartPhase2Ack", new string[] {seq, pInvokes.sGlobal["$pref::Player:PlayerDB"]}); } [ConsoleInteraction(true)] public static void onGhostAlwaysStarted(string ghostCount) { - omni.sGlobal["$ghostCount"] = ghostCount; - omni.iGlobal["$ghostsRecvd"] = 0; + pInvokes.sGlobal["$ghostCount"] = ghostCount; + pInvokes.iGlobal["$ghostsRecvd"] = 0; } [ConsoleInteraction(true)] public static void onGhostAlwaysObjectReceived() { - omni.iGlobal["$ghostsRecvd"] = omni.iGlobal["$ghostsRecvd"] + 1; - onPhase2Progress((omni.fGlobal["$ghostsRecvd"]/omni.fGlobal["$ghostCount"]).AsString()); + pInvokes.iGlobal["$ghostsRecvd"] = pInvokes.iGlobal["$ghostsRecvd"] + 1; + onPhase2Progress((pInvokes.fGlobal["$ghostsRecvd"]/pInvokes.fGlobal["$ghostCount"]).AsString()); } // @@ -119,45 +118,45 @@ public static void onGhostAlwaysObjectReceived() public static void clientCmdMissionStartPhase3(string seq, string missionName) { onPhase2Complete(); - omni.Util.StartClientReplication(); - omni.Util.StartFoliageReplication(); + pInvokes.Util.StartClientReplication(); + pInvokes.Util.StartFoliageReplication(); // Load the static mission decals. - omni.console.Call("decalManagerLoad", new string[] {missionName + ".decals"}); + pInvokes.console.Call("decalManagerLoad", new string[] {missionName + ".decals"}); - omni.Util._echo("*** Phase 3: Mission Lighting"); - omni.sGlobal["$MSeq"] = seq; - omni.sGlobal["$Client::MissionFile"] = missionName; + pInvokes.Util._echo("*** Phase 3: Mission Lighting"); + pInvokes.sGlobal["$MSeq"] = seq; + pInvokes.sGlobal["$Client::MissionFile"] = missionName; //Need to light the mission before we are ready. //The sceneLightingComplete function will complete the handshake //once the scene lighting is done. - if (omni.Util.lightScene("sceneLightingComplete", "")) + if (pInvokes.Util.lightScene("sceneLightingComplete", "")) { - omni.Util._echo("Lighting mission...."); - omni.Util._schedule("1", "0", "updateLightingProgress"); + pInvokes.Util._echo("Lighting mission...."); + pInvokes.Util._schedule("1", "0", "updateLightingProgress"); onMissionDownloadPhase3(); - omni.bGlobal["$lightingMission"] = true; + pInvokes.bGlobal["$lightingMission"] = true; } } [ConsoleInteraction(true)] public static void updateLightingProgress() { - onPhase3Progress(omni.sGlobal["$SceneLighting::lightingProgress"]); - if (omni.bGlobal["$lightingMission"]) - omni.iGlobal["$lightingProgressThread"] = omni.Util._schedule("1", "0", "updateLightingProgress"); + onPhase3Progress(pInvokes.sGlobal["$SceneLighting::lightingProgress"]); + if (pInvokes.bGlobal["$lightingMission"]) + pInvokes.iGlobal["$lightingProgressThread"] = pInvokes.Util._schedule("1", "0", "updateLightingProgress"); } [ConsoleInteraction(true)] public static void sceneLightingComplete() { - omni.Util._echo("Mission lighting done"); + pInvokes.Util._echo("Mission lighting done"); onPhase3Complete(); //The is also the end of the mission load cycle. onMissionDownloadComplete(); - omni.console.commandToServer("MissionStartPhase3Ack", new string[] {omni.sGlobal["$MSeq"]}); + pInvokes.console.commandToServer("MissionStartPhase3Ack", new string[] {pInvokes.sGlobal["$MSeq"]}); } // @@ -169,16 +168,16 @@ public static void connect(string server) { GameConnection conn = new ObjectCreator("ServerConnection").Create(); ((SimGroup) "RootGroup").add(conn); - conn.setConnectArgs(omni.sGlobal["$pref::Player::Name"]); - conn.setJoinPassword(omni.sGlobal["$Client::Password"]); + conn.setConnectArgs(pInvokes.sGlobal["$pref::Player::Name"]); + conn.setJoinPassword(pInvokes.sGlobal["$Client::Password"]); conn.connect(server); } public static void onMissionDownloadPhase1(string missionName, string musicTrack) { // Load the post effect presets for this mission. - string path = "levels/" + omni.Util.fileBase(missionName) + omni.sGlobal["$PostFXManager::fileExtension"]; - if (omni.Util.isFile(path)) + string path = "levels/" + pInvokes.Util.fileBase(missionName) + pInvokes.sGlobal["$PostFXManager::fileExtension"]; + if (pInvokes.Util.isFile(path)) ((postFXManager) "postFXManager").loadPresetHandler(path); else ((postFXManager) "postFXManager").settingsApplyDefaultPreset(); @@ -271,7 +270,7 @@ public static void onPhase3Progress(string progress) public static void onPhase3Complete() { - omni.bGlobal["$lightingMission"] = false; + pInvokes.bGlobal["$lightingMission"] = false; if (!"LoadingProgress".isObject()) return; ((GuiTextCtrl) "LoadingProgressTxt").setValue("STARTING MISSION"); @@ -296,7 +295,7 @@ public static void initialize() [ConsoleInteraction(true)] public static void handleLoadInfoMessage(string msgType, string msgString, string mapname) { - omni.console.error("Load info Recieved map " + mapname); + pInvokes.console.error("Load info Recieved map " + mapname); GuiChunkedBitmapCtrl LoadingGui = "LoadingGui"; if (((GuiCanvas) "canvas").getContent() != LoadingGui.getId()) diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/oculusVR.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/oculusVR.cs index 86e2930b..1073da00 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/oculusVR.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/oculusVR.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -43,16 +43,14 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class oculusVR { - private static readonly pInvokes omni = new pInvokes(); - // Only load these functions if an Oculus VR device is present [ConsoleInteraction(true)] public static string oculusSensorMetricsCallback() { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return ""; - return " | OVR Sensor 0 |" + " rot: " + omni.Util._call("getOVRSensorEulerRotation", "0"); + return " | OVR Sensor 0 |" + " rot: " + pInvokes.Util._call("getOVRSensorEulerRotation", "0"); } // Call this function from createCanvas() to have the Canvas attach itself @@ -63,9 +61,9 @@ public static string oculusSensorMetricsCallback() [ConsoleInteraction(true)] public static void pointCanvasToOculusVRDisplay() { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - omni.sGlobal["$pref::Video::displayOutputDevice"] = omni.Util._call("getOVRHMDDisplayDeviceName", "0"); + pInvokes.sGlobal["$pref::Video::displayOutputDevice"] = pInvokes.Util._call("getOVRHMDDisplayDeviceName", "0"); } // Call this function from GameConnection::initialControlSet() just before @@ -81,9 +79,9 @@ public static void pointCanvasToOculusVRDisplay() [ConsoleInteraction(true)] public static void enableOculusVRDisplay(GameConnection gameConnection, bool trueStereoRendering) { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - omni.Util._call("setOVRHMDAsGameConnectionDisplayDevice", gameConnection); + pInvokes.Util._call("setOVRHMDAsGameConnectionDisplayDevice", gameConnection); ((GameConnection) "PlayGui")["renderStyle"] = "stereo side by side"; if (trueStereoRendering) @@ -92,7 +90,7 @@ public static void enableOculusVRDisplay(GameConnection gameConnection, bool tru ((PostEffect) "OVRBarrelDistortionMonoPostFX")["isEnabled"] = "true"; // Reset all sensors - omni.Util._call("ovrResetAllSensors"); + pInvokes.Util._call("ovrResetAllSensors"); } // Call this function when ever you wish to turn off the stereo rendering @@ -100,7 +98,7 @@ public static void enableOculusVRDisplay(GameConnection gameConnection, bool tru [ConsoleInteraction(true)] public static void disableOculusVRDisplay(GameConnection gameConnection) { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; gameConnection.clearDisplayDevice(); ((GameConnection) "PlayGui")["renderStyle"] = "standard"; @@ -115,9 +113,9 @@ public static void disableOculusVRDisplay(GameConnection gameConnection) [ConsoleInteraction(true)] public static void setStandardOculusVRControlScheme(GameConnection gameConnection) { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - gameConnection.setControlSchemeParameters(true, true, omni.Util._call("isOVRHMDSimulated", "0").AsBool()); + gameConnection.setControlSchemeParameters(true, true, pInvokes.Util._call("isOVRHMDSimulated", "0").AsBool()); } //----------------------------------------------------------------------------- @@ -130,9 +128,9 @@ public static void setStandardOculusVRControlScheme(GameConnection gameConnectio [ConsoleInteraction(true)] public static void setVideoModeForOculusVRDisplay(string fullscreen) { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - Point2I res = new Point2I(omni.Util._call("getOVRHMDResolution", "0")); + Point2I res = new Point2I(pInvokes.Util._call("getOVRHMDResolution", "0")); ((GuiCanvas) "canvas").setVideoMode((uint) res.x, (uint) res.y, fullscreen.AsBool(), 32, 4); } @@ -141,9 +139,9 @@ public static void setVideoModeForOculusVRDisplay(string fullscreen) [ConsoleInteraction(true)] public static void resetOculusVRSensors() { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - omni.Util._call("ovrResetAllSensors"); + pInvokes.Util._call("ovrResetAllSensors"); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/postFX.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/postFX.cs index 037f5671..1f93cae4 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/postFX.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/postFX.cs @@ -43,8 +43,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class postFX { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { SingletonCreator ts = new SingletonCreator("GFXStateBlockData", "PFX_DefaultStateBlock"); @@ -92,7 +90,7 @@ public static void initPostEffects() postFXManager.createGui(); - omni.Util.exec("core/scripts/client/postFx/default.postfxpreset.cs", false, false); + pInvokes.Util.exec("core/scripts/client/postFx/default.postfxpreset.cs", false, false); } public static void SetPostFXToDefault() diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/screenshot.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/screenshot.cs index ff31161c..095e7c2d 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/screenshot.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/screenshot.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -43,11 +43,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class screenshot { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.iGlobal["$screenshotNumber"] = 0; + pInvokes.iGlobal["$screenshotNumber"] = 0; } [ConsoleInteraction(true)] @@ -89,13 +87,13 @@ public static void recordMovie(string movieName, float fps, string encoder) encoder = "THEORA"; string resolution = ((GuiCanvas) "canvas").getVideoMode(); - omni.Util.startVideoCapture("canvas", movieName, encoder, fps, new Point2I(0, 0)); + pInvokes.Util.startVideoCapture("canvas", movieName, encoder, fps, new Point2I(0, 0)); } [ConsoleInteraction(true)] public static void stopMovie() { - omni.Util.stopVideoCapture(); + pInvokes.Util.stopVideoCapture(); } // This is bound in initializeCommon() to take @@ -112,24 +110,24 @@ public static void doScreenShot(int val) [ConsoleInteraction(true)] public static void _screenShot(uint tiles, float overlap = 0f) { - if (omni.sGlobal["$pref::Video::screenShotSession"] == "") - omni.iGlobal["$pref::Video::screenShotSession"] = 0; + if (pInvokes.sGlobal["$pref::Video::screenShotSession"] == "") + pInvokes.iGlobal["$pref::Video::screenShotSession"] = 0; - if (omni.iGlobal["$screenshotNumber"] == 0) - omni.iGlobal["$pref::Video::screenShotSession"]++; + if (pInvokes.iGlobal["$screenshotNumber"] == 0) + pInvokes.iGlobal["$pref::Video::screenShotSession"]++; - if (omni.iGlobal["$pref::Video::screenShotSession"] > 999) - omni.iGlobal["$pref::Video::screenShotSession"] = 1; + if (pInvokes.iGlobal["$pref::Video::screenShotSession"] > 999) + pInvokes.iGlobal["$pref::Video::screenShotSession"] = 1; - string name = "screenshot_" + formatSessionNumber(omni.iGlobal["$pref::Video::screenShotSession"]) + "-" + formatImageNumber(omni.iGlobal["$screenshotNumber"]); - name = omni.Util._expandFilename(name); + string name = "screenshot_" + formatSessionNumber(pInvokes.iGlobal["$pref::Video::screenShotSession"]) + "-" + formatImageNumber(pInvokes.iGlobal["$screenshotNumber"]); + name = pInvokes.Util._expandFilename(name); - omni.iGlobal["$screenshotNumber"]++; + pInvokes.iGlobal["$screenshotNumber"]++; - if ((omni.sGlobal["$pref::Video::screenShotFormat"] == "JPEG") || (omni.sGlobal["$pref::Video::screenShotFormat"] == "JPG")) - omni.Util.screenShot("screenshots\\" + name, "JPEG", tiles, overlap); + if ((pInvokes.sGlobal["$pref::Video::screenShotFormat"] == "JPEG") || (pInvokes.sGlobal["$pref::Video::screenShotFormat"] == "JPG")) + pInvokes.Util.screenShot("screenshots\\" + name, "JPEG", tiles, overlap); else - omni.Util.screenShot("screenshots\\" + name, "PNG", tiles, overlap); + pInvokes.Util.screenShot("screenshots\\" + name, "PNG", tiles, overlap); } // This will close the console and take a large format diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/scriptDoc.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/scriptDoc.cs index 7e46abcd..262e3f9b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/scriptDoc.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Client/scriptDoc.cs @@ -41,8 +41,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class scriptDoc { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void writeOutFunctions() { @@ -51,8 +49,8 @@ public static void writeOutFunctions() dumpConsoleFunctions(); logger.delete(); */ - omni.console.Eval("new ConsoleLogger(logger, \"scriptFunctions.txt\", false);"); - omni.Util.dumpConsoleFunctions(true, true); + pInvokes.console.Eval("new ConsoleLogger(logger, \"scriptFunctions.txt\", false);"); + pInvokes.Util.dumpConsoleFunctions(true, true); "logger".delete(); } @@ -64,8 +62,8 @@ public static void writeOutClasses() dumpConsoleClasses(); logger.delete(); */ - omni.console.Eval("new ConsoleLogger(logger, \"scriptClasses.txt\", false);"); - omni.Util.dumpConsoleClasses(true, true); + pInvokes.console.Eval("new ConsoleLogger(logger, \"scriptClasses.txt\", false);"); + pInvokes.Util.dumpConsoleClasses(true, true); "logger".delete(); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Common/AggregateControl.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Common/AggregateControl.cs index 701976ca..65c222e1 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Common/AggregateControl.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Common/AggregateControl.cs @@ -69,14 +69,14 @@ public static void shareValueSafe(GuiControl source, GuiControl dest) [ConsoleInteraction] public static void shareValueSafeDelay(GuiControl source, GuiControl dest, int delayMS) { - omni.Util._schedule(delayMS.AsString(), "0", "ShareValueSafe", source, dest); + Util._schedule(delayMS.AsString(), "0", "ShareValueSafe", source, dest); } [ConsoleInteraction] public static bool parseMissionGroup(string className, string childGroup = "") { SimGroup currentGroup = ""; - if (omni.Util.getWordCount(childGroup) == 0) + if (Util.getWordCount(childGroup) == 0) currentGroup = "MissionGroup"; else currentGroup = childGroup; @@ -108,9 +108,9 @@ public static string validateDatablockName(string name) // the first character string firstChar = name.Substring(0, 1); // if the character is a number remove it - if (omni.Util.strpos(numbers, firstChar, 0) != -1) + if (Util.strpos(numbers, firstChar, 0) != -1) { - name = omni.Util.getSubStr(name, 1, name.Length - 1); + name = Util.getSubStr(name, 1, name.Length - 1); name = name.Trim(); } else @@ -120,7 +120,7 @@ public static string validateDatablockName(string name) name = name.Replace(" ", ""); // remove any other invalid characters string invalidCharacters = "-+*/%$&§=()[].?\"#,;!~<>|°^{}"; - name = omni.Util.stripChars(name, invalidCharacters); + name = Util.stripChars(name, invalidCharacters); if (name == "") name = "Unnamed"; return name; @@ -132,13 +132,13 @@ public static string validateDatablockName(string name) [ConsoleInteraction] public static int wordPos(string text, string word, int start = 0) { - if (omni.Util.strpos(text, word, 0) == -1) + if (Util.strpos(text, word, 0) == -1) return -1; - int count = omni.Util.getWordCount(text); + int count = Util.getWordCount(text); for (int i = start; i < count; i++) { - if (omni.Util.getWord(text, i) == word) + if (Util.getWord(text, i) == word) return i; } return -1; @@ -150,15 +150,15 @@ public static int wordPos(string text, string word, int start = 0) [ConsoleInteraction] public static int fieldPos(string text, string field, int start = 0) { - if (omni.Util.strpos(text, field, 0) == -1) + if (Util.strpos(text, field, 0) == -1) return -1; - int count = omni.Util.getFieldCount(text); + int count = Util.getFieldCount(text); if (start > count) return -1; for (int i = start; i < count; i++) { - if (omni.Util.getField(text, i) == field) + if (Util.getField(text, i) == field) return i; } return -1; @@ -189,7 +189,7 @@ public static string parseMissionGroupForIds(string className, string childGroup { string classIds = ""; SimGroup currentGroup; - if (omni.Util.getWordCount(childGroup) == 0) + if (Util.getWordCount(childGroup) == 0) currentGroup = "MissionGroup"; else currentGroup = childGroup; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Main.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Main.cs index cf56be55..b74aa9ad 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Main.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Main.cs @@ -59,8 +59,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode /// public static class Main { - private static readonly pInvokes omni = new pInvokes(); - /// /// Main entry point into the scripts. /// MANDITORY FUNCTION @@ -77,51 +75,51 @@ public static int main(int argc, string[] argv) // // Set the name of our application - omni.sGlobal["$appName"] = "Full"; + pInvokes.sGlobal["$appName"] = "Full"; // The directory it is run from - omni.sGlobal["$defaultGame"] = "scripts"; + pInvokes.sGlobal["$defaultGame"] = "scripts"; // Set profile directory - omni.sGlobal["$Pref::Video::ProfilePath"] = "core/profile"; + pInvokes.sGlobal["$Pref::Video::ProfilePath"] = "core/profile"; - omni.bGlobal["$displayHelp"] = false; + pInvokes.bGlobal["$displayHelp"] = false; - omni.bGlobal["$isDedicated"] = false; + pInvokes.bGlobal["$isDedicated"] = false; - omni.iGlobal["$dirCount"] = 2; + pInvokes.iGlobal["$dirCount"] = 2; - omni.sGlobal["$userDirs"] = omni.sGlobal["$defaultGame"] + ";art;levels"; + pInvokes.sGlobal["$userDirs"] = pInvokes.sGlobal["$defaultGame"] + ";art;levels"; mainParseArgs(); // load tools scripts if we're a tool build - //if (omni.Util.isToolBuild() && !omni.bGlobal["$isDedicated"]) - // omni.sGlobal["$userDirs"] = "tools;" + omni.sGlobal["$userDirs"]; + //if (pInvokes.Util.isToolBuild() && !pInvokes.bGlobal["$isDedicated"]) + // pInvokes.sGlobal["$userDirs"] = "tools;" + pInvokes.sGlobal["$userDirs"]; // Parse the executable arguments with the standard // function from core/main.cs - if (omni.iGlobal["$dirCount"] == 0) + if (pInvokes.iGlobal["$dirCount"] == 0) { - omni.sGlobal["$userDirs"] = omni.sGlobal["$defaultGame"]; - omni.iGlobal["$dirCount"] = 1; + pInvokes.sGlobal["$userDirs"] = pInvokes.sGlobal["$defaultGame"]; + pInvokes.iGlobal["$dirCount"] = 1; } //----------------------------------------------------------------------------- // Display a splash window immediately to improve app responsiveness before // engine is initialized and main window created - if (!omni.bGlobal["$isDedicated"]) - omni.Util.displaySplashWindow("art/gui/omni.bmp"); + if (!pInvokes.bGlobal["$isDedicated"]) + pInvokes.Util.displaySplashWindow("art/gui/pInvokes.bmp"); - if (!omni.bGlobal["$logModeSpecified"]) + if (!pInvokes.bGlobal["$logModeSpecified"]) { - if (omni.sGlobal["$platform"] != "xbox" && omni.sGlobal["$platform"] != "xenon") - omni.Util.setLogMode(6); + if (pInvokes.sGlobal["$platform"] != "xbox" && pInvokes.sGlobal["$platform"] != "xenon") + pInvokes.Util.setLogMode(6); } - omni.Util.nextToken("$userDirs", "currentMod", ";"); + pInvokes.Util.nextToken("$userDirs", "currentMod", ";"); - omni.console.print("--------- Loading DIRS ---------"); + pInvokes.console.print("--------- Loading DIRS ---------"); /*Ok, so here is the deal. Until the tools are converted to a OMNI toolset we need to allow support of * packages in some way. Since packages require a base function and then override it we needed to @@ -136,7 +134,7 @@ public static int main(int argc, string[] argv) * * Pretty slick.... */ - omni.console.Eval(@" + pInvokes.console.Eval(@" function onStart() { onMainStart(); @@ -157,31 +155,31 @@ function loadKeybindings() GameConnection.initialize(); SetConstantsForReferencingVideoResolutionPreference(); - loadDirs(omni.sGlobal["$userDirs"]); + loadDirs(pInvokes.sGlobal["$userDirs"]); //-----> Load tools here - if (omni.Util.isToolBuild() && !omni.bGlobal["$isDedicated"]) - //omni.sGlobal["$userDirs"] = "tools;" + omni.sGlobal["$userDirs"]; + if (pInvokes.Util.isToolBuild() && !pInvokes.bGlobal["$isDedicated"]) + //pInvokes.sGlobal["$userDirs"] = "tools;" + pInvokes.sGlobal["$userDirs"]; Tools.main.initialize(); //We don't need this no more, no more scripts! - // if (omni.iGlobal["$dirCount"] == 0) + // if (pInvokes.iGlobal["$dirCount"] == 0) // { - // omni.Util._call("enableWinConsole", "true"); - // omni.console.error("Error: Unable to load any specified directories"); + // pInvokes.Util._call("enableWinConsole", "true"); + // pInvokes.console.error("Error: Unable to load any specified directories"); //Main.Quit(); //t3d.Util.quit(); //} // Parse the command line arguments - omni.console.print("--------- Parsing Arguments ---------"); + pInvokes.console.print("--------- Parsing Arguments ---------"); mainParseArgs(); - if (omni.bGlobal["$displayHelp"]) + if (pInvokes.bGlobal["$displayHelp"]) { - omni.console.Call("enableWinConsole", new[] {"true"}); + pInvokes.console.Call("enableWinConsole", new[] {"true"}); displayHelp(); //t3d.Util.quit(); Quit(); @@ -189,31 +187,31 @@ function loadKeybindings() else { //due to the Tools, this must be called through the console. - omni.console.Call("onStart"); + pInvokes.console.Call("onStart"); //onStart(); - omni.console.print("Engine initialized..."); + pInvokes.console.print("Engine initialized..."); GuiCanvas canvas1 = "Canvas"; - if (!omni.bGlobal["$isDedicated"]) + if (!pInvokes.bGlobal["$isDedicated"]) { - omni.Util.closeSplashWindow(); + pInvokes.Util.closeSplashWindow(); canvas1.showWindow(); } - if (omni.sGlobal["$platform"] == "xenon") + if (pInvokes.sGlobal["$platform"] == "xenon") { const string mission = "levels//Empty Terrain.mis"; - omni.console.print("Xbox360 Autoloading level: '" + mission + "'"); - string serverType = omni.bGlobal["$pref::HostMultiPlayer"] ? "MultiPlayer" : "SinglePlayer"; + pInvokes.console.print("Xbox360 Autoloading level: '" + mission + "'"); + string serverType = pInvokes.bGlobal["$pref::HostMultiPlayer"] ? "MultiPlayer" : "SinglePlayer"; server.createAndConnectToLocalServer(serverType, mission); } } - for (int i = 1; i < omni.iGlobal["$Game::argc"]; i++) + for (int i = 1; i < pInvokes.iGlobal["$Game::argc"]; i++) { - if (!omni.bGlobal["$argUsed[" + i + "]"]) + if (!pInvokes.bGlobal["$argUsed[" + i + "]"]) { - if (omni.sGlobal["$Game::argv[" + i + "]"].Trim() != "") - omni.console.error("Error: Unknown command line argument: " + omni.sGlobal["$Game::argv[" + i + "]"]); + if (pInvokes.sGlobal["$Game::argv[" + i + "]"].Trim() != "") + pInvokes.console.error("Error: Unknown command line argument: " + pInvokes.sGlobal["$Game::argv[" + i + "]"]); } } @@ -222,12 +220,12 @@ function loadKeybindings() - if (omni.bGlobal["$startWorldEditor"]) + if (pInvokes.bGlobal["$startWorldEditor"]) { canvas.setCursor("DefaultCursor"); canvas.setContent("EditorChooseLevelGui"); } - else if (omni.bGlobal["$startGUIEditor"]) + else if (pInvokes.bGlobal["$startGUIEditor"]) { canvas.setCursor("DefaultCursor"); canvas.setContent("EditorChooseGUI"); @@ -262,34 +260,34 @@ public static void loadDir(string dir) pushBack("$useDirs", dir, ";"); if (!isScriptFile(dir + "/main.cs")) return; - omni.console.print("Calling " + dir + "/main.cs"); - omni.Util.exec(dir + "/main.cs", false, false); + pInvokes.console.print("Calling " + dir + "/main.cs"); + pInvokes.Util.exec(dir + "/main.cs", false, false); } [ConsoleInteraction(true)] public static void onMainExit() { - if (omni.bGlobal["$Server::Dedicated"]) + if (pInvokes.bGlobal["$Server::Dedicated"]) server.destroyServer(); else - omni.console.Call("disconnect"); + pInvokes.console.Call("disconnect"); - omni.Util.physicsDestroy(); + pInvokes.Util.physicsDestroy(); - omni.console.print("Exporting client prefs"); + pInvokes.console.print("Exporting client prefs"); //Todo Settings - Switch this back when fixed. - omni.Util.export("$pref::*", "prefs.client.cs", false); - //omni.Util.exportToSettings("$pref::*", "scripts/client/prefs.cs", false); + pInvokes.Util.export("$pref::*", "prefs.client.cs", false); + //pInvokes.Util.exportToSettings("$pref::*", "scripts/client/prefs.cs", false); // t3d.Util.exportToSettings("$Pref::*", "scripts/client/prefs1.cs", true); - omni.console.print("Exporting server prefs"); + pInvokes.console.print("Exporting server prefs"); //Todo Settings - Switch this back when fixed. - omni.Util.export("$Pref::Server::*", "prefs.server.cs", false); - //omni.Util.exportToSettings("$Pref::Server::*", "scripts/server/prefs.cs", false); + pInvokes.Util.export("$Pref::Server::*", "prefs.server.cs", false); + //pInvokes.Util.exportToSettings("$Pref::Server::*", "scripts/server/prefs.cs", false); - omni.console.Call_Classname("BanList", "Export", new[] {"prefs.banlist.cs"}); + pInvokes.console.Call_Classname("BanList", "Export", new[] {"prefs.banlist.cs"}); core.shutdownCore(); @@ -299,7 +297,7 @@ public static void onMainExit() [ConsoleInteraction(true)] public static bool isScriptFile(string path) { - if (omni.Util.isFile(path + ".dso") || omni.Util.isFile(path)) + if (pInvokes.Util.isFile(path + ".dso") || pInvokes.Util.isFile(path)) return true; return false; } @@ -309,16 +307,16 @@ public static void loadDirs(string dirPath) string[] directorypaths = dirPath.Split(';'); for (int i = directorypaths.Count() - 1; i >= 0; i--) { - if (omni.Util.exec(directorypaths[i] + "/main.cs", false, false)) + if (pInvokes.Util.exec(directorypaths[i] + "/main.cs", false, false)) continue; - omni.console.error("Error: Unable to find specified directory: " + directorypaths[i]); - omni.iGlobal["$dirCount"]--; + pInvokes.console.error("Error: Unable to find specified directory: " + directorypaths[i]); + pInvokes.iGlobal["$dirCount"]--; } } public static void displayHelp() { - omni.console.error("Torque Demo command line options:\n" + " -log Logging behavior; see main.cs comments for details\n" + " -game Reset list of mods to only contain \n" + " Works like the -game argument\n" + " -dir Add to list of directories\n" + " -console Open a separate console\n" + " -show Deprecated\n" + " -jSave Record a journal\n" + " -jPlay Play back a journal\n" + " -jDebug Play back a journal and issue an int3 at the end\n" + " -help Display this help message\n"); + pInvokes.console.error("Torque Demo command line options:\n" + " -log Logging behavior; see main.cs comments for details\n" + " -game Reset list of mods to only contain \n" + " Works like the -game argument\n" + " -dir Add to list of directories\n" + " -console Open a separate console\n" + " -show Deprecated\n" + " -jSave Record a journal\n" + " -jPlay Play back a journal\n" + " -jDebug Play back a journal and issue an int3 at the end\n" + " -help Display this help message\n"); } public static string pushFront(string list, string token, string delim) @@ -337,284 +335,284 @@ public static string pushBack(string list, string token, string delim) public static string popFront(string list, string delim) { - return omni.Util.nextToken(list, "", delim); + return pInvokes.Util.nextToken(list, "", delim); } [ConsoleInteraction(true)] public static void mainParseArgs() { - for (int i = 1; i < omni.iGlobal["$Game::argc"]; i++) + for (int i = 1; i < pInvokes.iGlobal["$Game::argc"]; i++) { - string arg = omni.sGlobal["$Game::argv[" + i + "]"]; - string nextArg = omni.sGlobal["$Game::argv[" + (i + 1) + "]"]; - bool hasNextarg = omni.iGlobal["$Game::argc"] - i > 1; - omni.bGlobal["$logModeSpecified"] = false; + string arg = pInvokes.sGlobal["$Game::argv[" + i + "]"]; + string nextArg = pInvokes.sGlobal["$Game::argv[" + (i + 1) + "]"]; + bool hasNextarg = pInvokes.iGlobal["$Game::argc"] - i > 1; + pInvokes.bGlobal["$logModeSpecified"] = false; Console.WriteLine(arg); switch (arg) { case "-log": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { if (nextArg.AsInt() != 0) nextArg += 4; - omni.Util.setLogMode(nextArg.AsInt()); - omni.bGlobal["$logModeSpecified"] = true; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util.setLogMode(nextArg.AsInt()); + pInvokes.bGlobal["$logModeSpecified"] = true; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -log "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -log "); break; case "-console": - omni.console.Call("enableWinConsole", new string[] {"true"}); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.console.Call("enableWinConsole", new string[] {"true"}); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-jSave": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util._echo("Saving event log to journal: '" + nextArg + "."); - omni.Util.saveJournal(nextArg); - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util._echo("Saving event log to journal: '" + nextArg + "."); + pInvokes.Util.saveJournal(nextArg); + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -jSave "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jSave "); break; case "-jPlay": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util.playJournal(nextArg); - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util.playJournal(nextArg); + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -jPlay "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jPlay "); break; case "-jPlayToVideo": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::journalName"] = nextArg; - omni.bGlobal["$VideoCapture::captureFromJournal"] = true; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::journalName"] = nextArg; + pInvokes.bGlobal["$VideoCapture::captureFromJournal"] = true; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -jPlayToVideo "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jPlayToVideo "); break; case "-vidCapFile": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::fileName"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::fileName"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapFile "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapFile "); break; case "-vidCapFPS": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::fps"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::fps"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapFPS "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapFPS "); break; case "-vidCapEncoder": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::encoder"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::encoder"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapEncoder "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapEncoder "); break; case "-vidCapWidth": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$videoCapture::width"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$videoCapture::width"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapWidth "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapWidth "); break; case "-vidCapHeight": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$videoCapture::height"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$videoCapture::height"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapHeight "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapHeight "); break; case "-jDebug": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util.playJournal(nextArg); - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util.playJournal(nextArg); + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -jDebug "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jDebug "); break; case "-level": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { if (!nextArg.EndsWith(".mis")) { - omni.sGlobal["$levelToLoad"] = nextArg + ".mis"; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$levelToLoad"] = nextArg + ".mis"; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.sGlobal["$levelToLoad"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$levelToLoad"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } } else - omni.console.error("Error: Missing Command Line argument. Usage: -level "); + pInvokes.console.error("Error: Missing Command Line argument. Usage: -level "); break; case "-worldeditor": - omni.bGlobal["$startWorldEditor"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$startWorldEditor"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-guieditor": - omni.bGlobal["$startGUIEditor"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$startGUIEditor"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-help": - omni.bGlobal["$displayHelp"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$displayHelp"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-compileAll": - omni.bGlobal["$compileAll"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$compileAll"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-compileTools": - omni.bGlobal["$compileTools"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$compileTools"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-genScript": - omni.bGlobal["$genScript"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$genScript"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-fullscreen": - omni.console.Call("setFullScreen", new[] {"true"}); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.console.Call("setFullScreen", new[] {"true"}); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-windowed": - omni.console.Call("setFullScreen", new[] {"false"}); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.console.Call("setFullScreen", new[] {"false"}); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-openGL": - omni.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-directX": - omni.sGlobal["$pref::Video::displayDevice"] = "D3D"; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "D3D"; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-voodoo2": - omni.sGlobal["$pref::Video::displayDevice"] = "Voodoo2"; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "Voodoo2"; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-autoVideo": - omni.sGlobal["$pref::Video::displayDevice"] = ""; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = ""; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-prefs": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util.exec(nextArg, true, true); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.Util.exec(nextArg, true, true); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -prefs "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -prefs "); break; case "-dedicated": - omni.bGlobal["$Server::Dedicated"] = true; - omni.bGlobal["$isDedicated"] = true; - omni.console.Call("enableWinConsole", new[] {"true"}); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$Server::Dedicated"] = true; + pInvokes.bGlobal["$isDedicated"] = true; + pInvokes.console.Call("enableWinConsole", new[] {"true"}); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-mission": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$missionArg"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$missionArg"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.console.error("Error: Missing Command Line argument. Usage: -mission "); + pInvokes.console.error("Error: Missing Command Line argument. Usage: -mission "); break; case "-connect": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$JoinGameAddress"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$JoinGameAddress"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.console.error("Error: Missing Command Line argument. Usage: -connect "); + pInvokes.console.error("Error: Missing Command Line argument. Usage: -connect "); break; } } - if (omni.bGlobal["$VideoCapture::captureFromJournal"] && (omni.sGlobal["$VideoCapture::journalName"] != "")) + if (pInvokes.bGlobal["$VideoCapture::captureFromJournal"] && (pInvokes.sGlobal["$VideoCapture::journalName"] != "")) { - if (omni.sGlobal["$VideoCapture::fileName"] == "") - omni.sGlobal["$VideoCapture::fileName"] = omni.sGlobal["$VideoCapture::journalName"]; + if (pInvokes.sGlobal["$VideoCapture::fileName"] == "") + pInvokes.sGlobal["$VideoCapture::fileName"] = pInvokes.sGlobal["$VideoCapture::journalName"]; - if (omni.sGlobal["$VideoCapture::encoder"] == "") - omni.sGlobal["$VideoCapture::encoder"] = "THEORA"; + if (pInvokes.sGlobal["$VideoCapture::encoder"] == "") + pInvokes.sGlobal["$VideoCapture::encoder"] = "THEORA"; - if (omni.sGlobal["$VideoCapture::fps"] == "") - omni.sGlobal["$VideoCapture::fps"] = "30"; + if (pInvokes.sGlobal["$VideoCapture::fps"] == "") + pInvokes.sGlobal["$VideoCapture::fps"] = "30"; - if (omni.sGlobal["$videoCapture::width"] == "") - omni.sGlobal["$videoCapture::width"] = "0"; + if (pInvokes.sGlobal["$videoCapture::width"] == "") + pInvokes.sGlobal["$videoCapture::width"] = "0"; - if (omni.sGlobal["$videoCapture::height"] == "") - omni.sGlobal["$videoCapture::height"] = "0"; + if (pInvokes.sGlobal["$videoCapture::height"] == "") + pInvokes.sGlobal["$videoCapture::height"] = "0"; - omni.Util.playJournalToVideo(omni.sGlobal["$VideoCapture::journalName"], omni.sGlobal["$VideoCapture::fileName"], omni.sGlobal["$VideoCapture::encoder"], omni.fGlobal["$VideoCapture::fps"], new Point2I(omni.sGlobal["$videoCapture::width"].AsInt(), omni.sGlobal["$videoCapture::height"].AsInt())); + pInvokes.Util.playJournalToVideo(pInvokes.sGlobal["$VideoCapture::journalName"], pInvokes.sGlobal["$VideoCapture::fileName"], pInvokes.sGlobal["$VideoCapture::encoder"], pInvokes.fGlobal["$VideoCapture::fps"], new Point2I(pInvokes.sGlobal["$videoCapture::width"].AsInt(), pInvokes.sGlobal["$videoCapture::height"].AsInt())); } } public static void SetConstantsForReferencingVideoResolutionPreference() { - omni.iGlobal["$WORD::RES_X"] = 0; - omni.iGlobal["$WORD::RES_Y"] = 1; - omni.iGlobal["$WORD::FULLSCREEN"] = 2; - omni.iGlobal["$WORD::BITDEPTH"] = 3; - omni.iGlobal["$WORD::REFRESH"] = 4; - omni.iGlobal["$WORD::AA"] = 5; + pInvokes.iGlobal["$WORD::RES_X"] = 0; + pInvokes.iGlobal["$WORD::RES_Y"] = 1; + pInvokes.iGlobal["$WORD::FULLSCREEN"] = 2; + pInvokes.iGlobal["$WORD::BITDEPTH"] = 3; + pInvokes.iGlobal["$WORD::REFRESH"] = 4; + pInvokes.iGlobal["$WORD::AA"] = 5; } [ConsoleInteraction(true)] @@ -629,41 +627,41 @@ public static void onMainStart() // Here is where we will do the video device stuff, so it overwrites the defaults // First set the PCI device variables (yes AGP/PCI-E works too) - omni.iGlobal["$isFirstPersonVar"] = 1; + pInvokes.iGlobal["$isFirstPersonVar"] = 1; // Uncomment to enable AdvancedLighting on the Mac (T3D 2009 Beta 3) - omni.bGlobal["$pref::machax::enableAdvancedLighting"] = true; + pInvokes.bGlobal["$pref::machax::enableAdvancedLighting"] = true; // Uncomment to disable ShaderGen, useful when debugging - //omni.bGlobal["$ShaderGen::GenNewShaders"] = false; + //pInvokes.bGlobal["$ShaderGen::GenNewShaders"] = false; // Uncomment to dump disassembly for any shader that is compiled to disk. // These will appear as shadername_dis.txt in the same path as the // hlsl or glsl shader. - //omni.bGlobal["$gfx::disassembleAllShaders"] = true; + //pInvokes.bGlobal["$gfx::disassembleAllShaders"] = true; // Uncomment useNVPerfHud to allow you to start up correctly // when you drop your executable onto NVPerfHud - //omni.bGlobal["$Video::useNVPerfHud"] = true; + //pInvokes.bGlobal["$Video::useNVPerfHud"] = true; // Uncomment these to allow you to force your app into using // a specific pixel shader version (0 is for fixed function) - //omni.bGlobal["$pref::Video::forcePixVersion"] = true; - //omni.iGlobal["$pref::Video::forcedPixVersion"] = 0; + //pInvokes.bGlobal["$pref::Video::forcePixVersion"] = true; + //pInvokes.iGlobal["$pref::Video::forcedPixVersion"] = 0; - //if (omni.sGlobal["$platform"] == "macos") - //omni.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; + //if (pInvokes.sGlobal["$platform"] == "macos") + //pInvokes.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; //else - //omni.sGlobal["$pref::Video::displayDevice"] = "D3D9"; + //pInvokes.sGlobal["$pref::Video::displayDevice"] = "D3D9"; core.initializeCore(); - omni.Util._echo(" % - Initialized Core"); + pInvokes.Util._echo(" % - Initialized Core"); #region FPS - omni.console.print("\n--------- Initializing Directory: scripts ---------"); + pInvokes.console.print("\n--------- Initializing Directory: scripts ---------"); // Init the physics plugin. - omni.Util.physicsInit("Bullet"); + pInvokes.Util.physicsInit("Bullet"); // Start up the audio system. audio.sfxStartup(); @@ -675,7 +673,7 @@ public static void onMainStart() server.initServer(); // Start up in either client, or dedicated server mode - if (omni.bGlobal["$Server::Dedicated"]) + if (pInvokes.bGlobal["$Server::Dedicated"]) server.initDedicated(); else init.initClient(); @@ -686,10 +684,10 @@ public static void onMainStart() [ConsoleInteraction(true)] public static void mainloadKeybindings() { - omni.iGlobal["$keybindCount"] = 0; + pInvokes.iGlobal["$keybindCount"] = 0; // Load up the active projects keybinds. - if (omni.Util.isFunction("setupKeybinds")) - omni.console.Call("setupKeybinds"); + if (pInvokes.Util.isFunction("setupKeybinds")) + pInvokes.console.Call("setupKeybinds"); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/GameConnection.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/GameConnection.cs index 6d119dc6..c8db23bc 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/GameConnection.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/GameConnection.cs @@ -50,8 +50,6 @@ partial class GameConnection { #region Static Variables - private static readonly pInvokes tst = new pInvokes(); - #endregion #region Overrides diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs index 3aee0bf1..93e68437 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs @@ -46,8 +46,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server.SoftBodies { public class SoftBodies { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { #region SoftBodyData ( PhysFlag ) oc_Newobject1 @@ -91,7 +89,7 @@ public static void initialize() //----------------------------------------------------------------------------- // for Game Mechanics Editor //----------------------------------------------------------------------------- - omni.Util.activatePackage("TemplateFunctions"); + pInvokes.Util.activatePackage("TemplateFunctions"); //TODO FIX //inheritTemplate("PhysFlag", "AbstractRigidBody"); @@ -100,7 +98,7 @@ public static void initialize() //inheritTemplate("PhysSoftSphere", "AbstractRigidBody"); //registerTemplate("PhysSoftSphere", "Physics", "SoftBodyData::create(PhysSoftSphere);"); - omni.Util.deactivatePackage("TemplateFunctions"); + pInvokes.Util.deactivatePackage("TemplateFunctions"); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/centerPrint.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/centerPrint.cs index 4002680f..e214fac6 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/centerPrint.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/centerPrint.cs @@ -47,8 +47,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { public class centerPrint { - public static pInvokes t3d = new pInvokes(); - [ConsoleInteraction(true)] public static void CenterPrintAll(string message, string time, string lines) { @@ -56,8 +54,8 @@ public static void CenterPrintAll(string message, string time, string lines) lines = "1"; foreach (GameConnection client in - t3d.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) - t3d.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); + pInvokes.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) + pInvokes.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] @@ -66,8 +64,8 @@ public static void BottomPrintAll(string message, string time, string lines) if (lines == "" || lines.AsInt() > 3 || lines.AsInt() < 1) lines = "1"; foreach (GameConnection client in - t3d.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) - t3d.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); + pInvokes.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) + pInvokes.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] @@ -76,7 +74,7 @@ public static void CenterPrint(GameConnection client, string message, string tim if (lines == "" || lines.AsInt() > 3 || lines.AsInt() < 1) lines = "1"; - t3d.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); + pInvokes.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] @@ -85,19 +83,19 @@ public static void BottomPrint(GameConnection client, string message, string tim if (lines == "" || lines.AsInt() > 3 || lines.AsInt() < 1) lines = "1"; - t3d.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); + pInvokes.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] public static void ClearCenterPrint(GameConnection client) { - t3d.console.commandToClient(client, "ClearCenterPrint"); + pInvokes.console.commandToClient(client, "ClearCenterPrint"); } [ConsoleInteraction(true)] public static void ClearBottomPrint(GameConnection client) { - t3d.console.commandToClient(client, "clearBottomPrint"); + pInvokes.console.commandToClient(client, "clearBottomPrint"); } [ConsoleInteraction(true)] @@ -109,10 +107,10 @@ public static void ClearCenterPrintAll() { GameConnection cl = ClientGroup.getObject(i); if (!cl.isAIControlled()) - t3d.console.commandToClient(cl, "ClearCenterPrint"); + pInvokes.console.commandToClient(cl, "ClearCenterPrint"); } - //foreach (uint client in t3d.ClientGroup.Cast().Where(client => !client.isAIControlled())) - // t3d.console.commandToClient(client.AsString(), "ClearCenterPrint"); + //foreach (uint client in pInvokes.ClientGroup.Cast().Where(client => !client.isAIControlled())) + // pInvokes.console.commandToClient(client.AsString(), "ClearCenterPrint"); } [ConsoleInteraction(true)] @@ -124,10 +122,10 @@ public static void ClearBottomPrintAll() { GameConnection cl = ClientGroup.getObject(i); if (!cl.isAIControlled()) - t3d.console.commandToClient(cl, "ClearBottomPrint"); + pInvokes.console.commandToClient(cl, "ClearBottomPrint"); } - //foreach (uint client in t3d.ClientGroup.Cast().Where(client => !client.isAIControlled())) - // t3d.console.commandToClient(client.AsString(), "clearBottomPrint"); + //foreach (uint client in pInvokes.ClientGroup.Cast().Where(client => !client.isAIControlled())) + // pInvokes.console.commandToClient(client.AsString(), "clearBottomPrint"); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/commands.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/commands.cs index ee74a248..3b828485 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/commands.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/commands.cs @@ -49,7 +49,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { public class commands { - private static readonly pInvokes omni = new pInvokes(); //----------------------------------------------------------------------------- // Misc. server commands avialable to clients //----------------------------------------------------------------------------- @@ -62,7 +61,7 @@ public static void syncEditorGui() { EditorGui EditorGui = "EditorGui"; if (EditorGui.isObject()) - //omni.console.Call("EditorGui", "syncCameraGui"); + //pInvokes.console.Call("EditorGui", "syncCameraGui"); EditorGui.syncCameraGui(); } @@ -111,7 +110,7 @@ public static void serverCmdSetEditorCameraPlayer(GameConnection client) ((Player) client["player"]).setVelocity(new Point3F("0 0 0")); client.setControlObject(client["player"]); client.setFirstPerson(true); - omni.bGlobal["$isFirstPersonVar"] = true; + pInvokes.bGlobal["$isFirstPersonVar"] = true; syncEditorGui(); } @@ -224,19 +223,19 @@ public static void serverCmdEditorCameraAutoFit(GameConnection client, float rad [ConsoleInteraction(true)] public static void serverCmdSAD(GameConnection client, string password) { - if (password == string.Empty || password != omni.sGlobal["$Pref::Server::AdminPassword"]) + if (password == string.Empty || password != pInvokes.sGlobal["$Pref::Server::AdminPassword"]) return; client["isAdmin"] = true.AsString(); client["isSuperAdmin"] = true.AsString(); - string name = omni.console.getTaggedString(client["playerName"]); + string name = pInvokes.console.getTaggedString(client["playerName"]); } [ConsoleInteraction(true)] public static void serverCmdSADSetPassword(GameConnection client, string password) { if (client["isSuperAdmin"].AsBool()) - omni.sGlobal["$Pref::Server::AdminPassword"] = password; + pInvokes.sGlobal["$Pref::Server::AdminPassword"] = password; } //---------------------------------------------------------------------------- diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/server.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/server.cs index 52cf11f4..7009be5f 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/server.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/server.cs @@ -48,18 +48,16 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { public class server { - public static pInvokes t3d = new pInvokes(); - public static void LoadDefaults() { // List of master servers to query, each one is tried in order // until one responds - t3d.iGlobal["$Pref::Server::RegionMask"] = 2; - t3d.sGlobal["$pref::Master[0]"] = "2:master.garagegames.com:28002"; + pInvokes.iGlobal["$Pref::Server::RegionMask"] = 2; + pInvokes.sGlobal["$pref::Master[0]"] = "2:master.garagegames.com:28002"; // Information about the server - t3d.sGlobal["$Pref::Server::Name"] = "Torque 3D Server"; - t3d.sGlobal["$Pref::Server::Info"] = "This is a Torque 3D server."; + pInvokes.sGlobal["$Pref::Server::Name"] = "Torque 3D Server"; + pInvokes.sGlobal["$Pref::Server::Info"] = "This is a Torque 3D server."; // The connection error message is transmitted to the client immediatly // on connection, if any further error occures during the connection @@ -67,68 +65,68 @@ public static void LoadDefaults() // message is display. This message should be replaced with information // usefull to the client, such as the url or ftp address of where the // latest version of the game can be obtained. - t3d.sGlobal["$Pref::Server::ConnectionError"] = "You do not have the correct version of the FPS starter kit or " + "the related art needed to play on this server, please contact " + "the server operator for more information."; + pInvokes.sGlobal["$Pref::Server::ConnectionError"] = "You do not have the correct version of the FPS starter kit or " + "the related art needed to play on this server, please contact " + "the server operator for more information."; // The network port is also defined by the client, this value // overrides pref::net::port for dedicated servers - t3d.iGlobal["$Pref::Server::Port"] = 28000; + pInvokes.iGlobal["$Pref::Server::Port"] = 28000; // If the password is set, clients must provide it in order // to connect to the server - t3d.sGlobal["$Pref::Server::Password"] = string.Empty; + pInvokes.sGlobal["$Pref::Server::Password"] = string.Empty; // Password for admin clients - t3d.sGlobal["$Pref::Server::AdminPassword"] = string.Empty; + pInvokes.sGlobal["$Pref::Server::AdminPassword"] = string.Empty; // Misc server settings. - t3d.iGlobal["$Pref::Server::MaxPlayers"] = 64; - t3d.iGlobal["$Pref::Server::TimeLimit"] = 20; // In minutes - t3d.iGlobal["$Pref::Server::KickBanTime"] = 300; // specified in seconds - t3d.iGlobal["$Pref::Server::BanTime"] = 1800; // specified in seconds - t3d.iGlobal["$Pref::Server::FloodProtectionEnabled"] = 1; - t3d.iGlobal["$Pref::Server::MaxChatLen"] = 120; + pInvokes.iGlobal["$Pref::Server::MaxPlayers"] = 64; + pInvokes.iGlobal["$Pref::Server::TimeLimit"] = 20; // In minutes + pInvokes.iGlobal["$Pref::Server::KickBanTime"] = 300; // specified in seconds + pInvokes.iGlobal["$Pref::Server::BanTime"] = 1800; // specified in seconds + pInvokes.iGlobal["$Pref::Server::FloodProtectionEnabled"] = 1; + pInvokes.iGlobal["$Pref::Server::MaxChatLen"] = 120; - t3d.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"] = typeof (GameConnection).FullName; + pInvokes.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"] = typeof (GameConnection).FullName; //todo Now add your own game specific server preferences as well as any overloaded core defaults here. // Finally load the preferences saved from the last // game execution if they exist. - if (t3d.sGlobal["$platform"] != "xenon") + if (pInvokes.sGlobal["$platform"] != "xenon") { //Todo Settings - Switch this back when fixed. - t3d.Util.exec("prefs.server.cs", false, false); + pInvokes.Util.exec("prefs.server.cs", false, false); //Settings.LoadSection("scripts/server/prefs.cs"); } else - t3d.Util._error("Not loading server prefs.cs on Xbox360"); + pInvokes.Util._error("Not loading server prefs.cs on Xbox360"); } public static void initDedicated() { - t3d.console.Call("enableWinConsole", new[] {"true"}); + pInvokes.console.Call("enableWinConsole", new[] {"true"}); //con.Eval("enableWinConsole(true);"); - t3d.console.print(@"\n--------- Starting Dedicated Server ---------"); + pInvokes.console.print(@"\n--------- Starting Dedicated Server ---------"); // Make sure this variable reflects the correct state. - t3d.bGlobal["$Server::Dedicated"] = true; + pInvokes.bGlobal["$Server::Dedicated"] = true; // The server isn't started unless a mission has been specified. - if (t3d.sGlobal["$missionArg"] != string.Empty) - createServer("MultiPlayer", t3d.sGlobal["$missionArg"]); + if (pInvokes.sGlobal["$missionArg"] != string.Empty) + createServer("MultiPlayer", pInvokes.sGlobal["$missionArg"]); else - t3d.console.print("No mission specified (use -mission filename)"); + pInvokes.console.print("No mission specified (use -mission filename)"); } public static void initServer() { - t3d.console.print("\n--------- Initializing " + t3d.sGlobal["$appName"] + ": Server Scripts ---------"); + pInvokes.console.print("\n--------- Initializing " + pInvokes.sGlobal["$appName"] + ": Server Scripts ---------"); // Server::Status is returned in the Game Info Query and represents the // current status of the server. This string sould be very short. - t3d.sGlobal["$Server::Status"] = "Unknown"; + pInvokes.sGlobal["$Server::Status"] = "Unknown"; // Turn on testing/debug script functions - t3d.bGlobal["$Server::TestCheats"] = false; + pInvokes.bGlobal["$Server::TestCheats"] = false; // Specify where the mission files are. - t3d.sGlobal["$Server::MissionFileSpec"] = "levels/*.mis"; + pInvokes.sGlobal["$Server::MissionFileSpec"] = "levels/*.mis"; // The common module provides the basic server functionality initBaseServer(); @@ -143,16 +141,16 @@ public static void initBaseServer() missionLoad.InitMissionLoad(); game.initGame(); spawn.init(); - t3d.iGlobal["$Camera::movementSpeed"] = 30; + pInvokes.iGlobal["$Camera::movementSpeed"] = 30; Client.CenterPrint.centerPrint.initialize(); } public static void portInit(int port) { int failCount = 0; - while (failCount < 10 && !t3d.Util.setNetPort(port)) + while (failCount < 10 && !pInvokes.Util.setNetPort(port)) { - t3d.console.print("Port init failed on port " + port + " trying next port."); + pInvokes.console.print("Port init failed on port " + port + " trying next port."); port++; failCount++; } @@ -174,12 +172,12 @@ public static bool createAndConnectToLocalServer(string serverType, string level if (!createServer(serverType, level)) return false; - GameConnection conn = new ObjectCreator("GameConnection", "ServerConnection", t3d.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"]).Create(); + GameConnection conn = new ObjectCreator("GameConnection", "ServerConnection", pInvokes.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"]).Create(); ((SimGroup) "RootGroup").add(conn); - conn.setConnectArgs(t3d.sGlobal["$pref::Player::Name"]); - conn.setJoinPassword(t3d.sGlobal["$Client::Password"]); + conn.setConnectArgs(pInvokes.sGlobal["$pref::Player::Name"]); + conn.setJoinPassword(pInvokes.sGlobal["$Client::Password"]); if (conn.connectLocal() != string.Empty) { @@ -200,51 +198,51 @@ public static bool createAndConnectToLocalServer(string serverType, string level [ConsoleInteraction(true)] public static bool createServer(string serverType, string level) { - t3d.iGlobal["$Server::Session"]++; + pInvokes.iGlobal["$Server::Session"]++; if (level == string.Empty) { - t3d.console.error("createServer(): level name unspecified"); + pInvokes.console.error("createServer(): level name unspecified"); return false; } - level = t3d.Util.makeRelativePath(level, t3d.Util.getWorkingDirectory()); + level = pInvokes.Util.makeRelativePath(level, pInvokes.Util.getWorkingDirectory()); destroyServer(); - t3d.iGlobal["$missionSequence"] = 0; - t3d.iGlobal["$Server::PlayerCount"] = 0; - t3d.sGlobal["$Server::ServerType"] = serverType; - t3d.sGlobal["$Server::LoadFailMsg"] = string.Empty; - t3d.bGlobal["$Physics::isSinglePlayer"] = true; + pInvokes.iGlobal["$missionSequence"] = 0; + pInvokes.iGlobal["$Server::PlayerCount"] = 0; + pInvokes.sGlobal["$Server::ServerType"] = serverType; + pInvokes.sGlobal["$Server::LoadFailMsg"] = string.Empty; + pInvokes.bGlobal["$Physics::isSinglePlayer"] = true; // Setup for multi-player, the network must have been // initialized before now. if (serverType == "MultiPlayer") { - //t3d.iGlobal["$pref::Net::PacketRateToClient"] = 32; - //t3d.iGlobal["$pref::Net::PacketRateToServer"] = 32; - //t3d.iGlobal["$pref::Net::PacketSize"] = 200; + //pInvokes.iGlobal["$pref::Net::PacketRateToClient"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketRateToServer"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketSize"] = 200; - t3d.bGlobal["$Physics::isSinglePlayer"] = false; - t3d.console.print("Starting multiplayer mode"); + pInvokes.bGlobal["$Physics::isSinglePlayer"] = false; + pInvokes.console.print("Starting multiplayer mode"); // Make sure the network port is set to the correct pref. - portInit(t3d.iGlobal["$Pref::Server::Port"]); + portInit(pInvokes.iGlobal["$Pref::Server::Port"]); - t3d.Util.allowConnections(true); + pInvokes.Util.allowConnections(true); - if (t3d.sGlobal["$pref::Net::DisplayOnMaster"] != "Never") - t3d.Util._schedule("0", "0", "startHeartBeat"); + if (pInvokes.sGlobal["$pref::Net::DisplayOnMaster"] != "Never") + pInvokes.Util._schedule("0", "0", "startHeartBeat"); } // Create the ServerGroup that will persist for the lifetime of the server. new ObjectCreator("SimGroup", "ServerGroup").Create(); - t3d.Util.exec("core/art/datablocks/datablockExec.cs", false, false); + pInvokes.Util.exec("core/art/datablocks/datablockExec.cs", false, false); game.onServerCreated(); - t3d.console.Call("loadMission", new[] {level, "true"}); + pInvokes.console.Call("loadMission", new[] {level, "true"}); return true; } @@ -255,12 +253,12 @@ public static bool createServer(string serverType, string level) [ConsoleInteraction(true)] public static void destroyServer() { - t3d.sGlobal["$Server::ServerType"] = string.Empty; - t3d.Util.allowConnections(false); + pInvokes.sGlobal["$Server::ServerType"] = string.Empty; + pInvokes.Util.allowConnections(false); - t3d.console.Call("stopHeartbeat"); + pInvokes.console.Call("stopHeartbeat"); - t3d.bGlobal["$missionRunning"] = false; + pInvokes.bGlobal["$missionRunning"] = false; // End any running levels @@ -273,24 +271,24 @@ public static void destroyServer() "ServerGroup".delete(); // Delete all the connections: - while (t3d.ClientGroup.Count().AsBool()) - t3d.ClientGroup[0].AsString().delete(); + while (pInvokes.ClientGroup.Count().AsBool()) + pInvokes.ClientGroup[0].AsString().delete(); - t3d.sGlobal["$Server::GuidList"] = string.Empty; + pInvokes.sGlobal["$Server::GuidList"] = string.Empty; // Delete all the data blocks... - t3d.Util.deleteDataBlocks(); + pInvokes.Util.deleteDataBlocks(); // Save any server settings - t3d.console.print("Exporting server prefs..."); + pInvokes.console.print("Exporting server prefs..."); //Todo Settings - Switch this back when fixed. - t3d.Util.export("$Pref::Server::*", "core/scripts/prefs.cs", false); - //t3d.Util.exportToSettings("$Pref::Server::*", "core/scripts/prefs.cs", false); + pInvokes.Util.export("$Pref::Server::*", "core/scripts/prefs.cs", false); + //pInvokes.Util.exportToSettings("$Pref::Server::*", "core/scripts/prefs.cs", false); // Increase the server session number. This is used to make sure we're // working with the server session we think we are. - t3d.iGlobal["$Server::Session"]++; + pInvokes.iGlobal["$Server::Session"]++; } [ConsoleInteraction(true)] @@ -302,15 +300,15 @@ public static string onServerInfoQuery() [ConsoleInteraction(true)] public static void resetServerDefaults() { - t3d.console.print("Resetting server defaults..."); + pInvokes.console.print("Resetting server defaults..."); LoadDefaults(); //Todo Settings - Switch this back when fixed. //Settings.LoadSection("core/scripts/prefs.cs"); - t3d.Util.exec("core/scripts/prefs.cs", false, false); + pInvokes.Util.exec("core/scripts/prefs.cs", false, false); // Reload the current level - missionLoad.loadMission(t3d.sGlobal["$Server::MissionFile"], false); + missionLoad.loadMission(pInvokes.sGlobal["$Server::MissionFile"], false); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/spawn.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/spawn.cs index 0763adf3..e6bd545b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/spawn.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Server/spawn.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -43,15 +43,13 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { public class spawn { - private static readonly pInvokes omni = new pInvokes(); - public static void init() { // Leave $Game::defaultPlayerClass and $Game::defaultPlayerDataBlock as empty strings ("") // to spawn a the $Game::defaultCameraClass as the control object. - omni.sGlobal["$Game::DefaultPlayerClass"] = "Player"; - omni.sGlobal["$Game::DefaultPlayerDataBlock"] = "DefaultPlayerData"; - omni.sGlobal["$Game::DefaultPlayerSpawnGroups"] = "PlayerSpawnPoints"; + pInvokes.sGlobal["$Game::DefaultPlayerClass"] = "Player"; + pInvokes.sGlobal["$Game::DefaultPlayerDataBlock"] = "DefaultPlayerData"; + pInvokes.sGlobal["$Game::DefaultPlayerSpawnGroups"] = "PlayerSpawnPoints"; //----------------------------------------------------------------------------- // What kind of "camera" is spawned is either controlled directly by the @@ -59,9 +57,9 @@ public static void init() // which SimGroups to attempt to select the spawn sphere's from by walking down // the list of SpawnGroups till it finds a valid spawn object. //----------------------------------------------------------------------------- - omni.sGlobal["$Game::DefaultCameraClass"] = "Camera"; - omni.sGlobal["$Game::DefaultCameraDataBlock"] = "Observer"; - omni.sGlobal["$Game::DefaultCameraSpawnGroups"] = "CameraSpawnPoints PlayerSpawnPoints"; + pInvokes.sGlobal["$Game::DefaultCameraClass"] = "Camera"; + pInvokes.sGlobal["$Game::DefaultCameraDataBlock"] = "Observer"; + pInvokes.sGlobal["$Game::DefaultCameraSpawnGroups"] = "CameraSpawnPoints PlayerSpawnPoints"; } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Base/Utils/UndoActionReparentObjects.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Base/Utils/UndoActionReparentObjects.ed.cs index c5318dc1..25e80c8a 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Base/Utils/UndoActionReparentObjects.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Base/Utils/UndoActionReparentObjects.ed.cs @@ -56,13 +56,13 @@ public int numObjects [ConsoleInteraction] public string create(string treeView) { - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); ObjectCreator undoObject = new ObjectCreator("UndoScriptAction", "", typeof (UndoActionReparentObjects)); //undoObject["class"] = "UndoActionReparentObjects"; undoObject["numObjects"] = "0"; undoObject["treeView"] = treeView; UndoActionReparentObjects action = undoObject.Create(); - omni.Util.popInstantGroup(); + Util.popInstantGroup(); return action; } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ConvexEditor/gui/CodeBehind/ConvexEditorPlugin.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ConvexEditor/gui/CodeBehind/ConvexEditorPlugin.cs index 6b373a3f..8699954a 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ConvexEditor/gui/CodeBehind/ConvexEditorPlugin.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ConvexEditor/gui/CodeBehind/ConvexEditorPlugin.cs @@ -80,7 +80,7 @@ public override void onWorldEditorStartup() // Add ourselves to the ToolsToolbar string tooltip = "Sketch Tool (" + accel + ")"; - EditorGui.addToToolsToolbar("ConvexEditorPlugin", "ConvexEditorPalette", omni.Util._expandFilename("tools/convexEditor/images/convex-editor-btn"), tooltip); + EditorGui.addToToolsToolbar("ConvexEditorPlugin", "ConvexEditorPalette", Util._expandFilename("tools/convexEditor/images/convex-editor-btn"), tooltip); //connect editor windows ((GuiWindowCollapseCtrl) "ConvexEditorOptionsWindow").attachTo("ConvexEditorTreeWindow"); @@ -102,7 +102,7 @@ public override void onWorldEditorStartup() this["popupMenu"] = ConvexActionsMenu; //exec( "./convexEditorSettingsTab.ed.gui" ); - omni.console.Call("ConvexEditorSettingsTab_initialize"); + console.Call("ConvexEditorSettingsTab_initialize"); ESettingsWindow.addTabPage("EConvexEditorSettingsPage"); } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditor.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditor.cs index 9e40f327..d109d77e 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditor.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditor.cs @@ -48,12 +48,10 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.DatablockEditor.gui.Co { public class DatablockEditor { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "DatablockEditor_initialize")] public static void initialize() { - omni.sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"] = "art/datablocks/managedDatablocks.cs"; + pInvokes.sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"] = "art/datablocks/managedDatablocks.cs"; new ObjectCreator("SimSet", "UnlistedDatablocks").Create(); } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditorPlugin.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditorPlugin.cs index 8198819b..351e6e0c 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditorPlugin.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditorPlugin.cs @@ -51,8 +51,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.DatablockEditor.gui.Co [TypeConverter(typeof (TypeConverterGeneric))] public class DatablockEditorPlugin : WorldEditorPlugin { - private static readonly pInvokes omni = new pInvokes(); - internal ActionMap map { get { return this["map"]; } @@ -96,7 +94,7 @@ public override void onWorldEditorStartup() // Add ourselves to the ToolsToolbar string tooltip = "Datablock Editor (" + accel + ")"; - EditorGui.addToToolsToolbar("DatablockEditorPlugin", "DatablockEditorPalette", omni.Util._expandFilename("tools/worldEditor/images/toolbar/datablock-editor"), tooltip); + EditorGui.addToToolsToolbar("DatablockEditorPlugin", "DatablockEditorPalette", Util._expandFilename("tools/worldEditor/images/toolbar/datablock-editor"), tooltip); //connect editor windows ((GuiWindowCollapseCtrl) "DatablockEditorInspectorWindow").attachTo("DatablockEditorTreeWindow"); @@ -248,7 +246,7 @@ public void populateTrees() // Populate datablock type tree. - string classList = omni.Util.enumerateConsoleClasses("SimDatablock"); + string classList = Util.enumerateConsoleClasses("SimDatablock"); DatablockEditorTypeTree.clear(); foreach (string datablockClass in classList.Split('\t')) @@ -636,7 +634,7 @@ public void selectDatablock(SimObject datablock, bool add = false, bool dontSync if (numSelected == 1) { string fileName = datablock.getFilename(); - fileNameField.setText(fileName != "" ? fileName : omni.sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"]); + fileNameField.setText(fileName != "" ? fileName : sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"]); } else fileNameField.setText(""); @@ -843,11 +841,11 @@ public void createDatablockFinish(string name, string copySource) else eval = dbType + className + "(" + name + ") { canSaveDynamicFields = \"1\"; };"; - string res = omni.Util.eval(eval); + string res = Util.eval(eval); action["db"] = name.getID().AsString(); action["dbName"] = name; - action["fname"] = omni.sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"]; + action["fname"] = sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"]; this.submitUndo(action); @@ -881,7 +879,7 @@ public bool canBeClientSideDatablock(string className) // [ConsoleInteraction] public string createUndo(string desc) { - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); ObjectCreator ocf = new ObjectCreator("UndoScriptAction", "", typeof (T)); //ocf["class"] = className; @@ -893,7 +891,7 @@ public string createUndo(string desc) UndoScriptAction action = ocf.Create(); - omni.Util.popInstantGroup(); + Util.popInstantGroup(); return action; } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/gui/CodeBehind/Debugger.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/gui/CodeBehind/Debugger.ed.cs index 0282ef37..e5a5b1b9 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/gui/CodeBehind/Debugger.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/gui/CodeBehind/Debugger.ed.cs @@ -49,7 +49,6 @@ public class Debugger // onLine is invoked whenever the TCP object receives a line from the server. Treat the first // word as a "command" and dispatch to an appropriate handler. //--------------------------------------------------------------------------------------------- - private static readonly pInvokes omni = new pInvokes(); //--------------------------------------------------------------------------------------------- // Various support functions. @@ -68,9 +67,9 @@ public static void DbgWatchDialogAdd() string expr = WatchDialogExpression.getValue(); if (expr != "") { - DebuggerWatchView.setRowById(omni.iGlobal["$DbgWatchSeq"], expr + "\t(unknown)"); - TCPDebugger.send("EVAL " + omni.iGlobal["$DbgWatchSeq"] + " 0 " + expr + "\r\n"); - omni.iGlobal["$DbgWatchSeq"]++; + DebuggerWatchView.setRowById(pInvokes.iGlobal["$DbgWatchSeq"], expr + "\t(unknown)"); + TCPDebugger.send("EVAL " + pInvokes.iGlobal["$DbgWatchSeq"] + " 0 " + expr + "\r\n"); + pInvokes.iGlobal["$DbgWatchSeq"]++; } Canvas.popDialog(DebuggerWatchDlg); } @@ -90,7 +89,7 @@ public static void DbgWatchDialogEdit() if (id >= 0) { string row = DebuggerWatchView.getRowTextById(id); - string expr = omni.Util.getField(row, 0); + string expr = pInvokes.Util.getField(row, 0); string assignment; if (newValue == "") assignment = expr + " = \"\""; @@ -167,7 +166,7 @@ public static void DbgBreakConditionSet() if (id != -1) { string bkp = DebuggerBreakPoints.getRowTextById(id); - DbgSetBreakPoint(omni.Util.getField(bkp, 1), omni.Util.getField(bkp, 0).AsUInt(), clear.AsBool(), passct, condition); + DbgSetBreakPoint(pInvokes.Util.getField(bkp, 1), pInvokes.Util.getField(bkp, 0).AsUInt(), clear.AsBool(), passct, condition); } Canvas.popDialog(DebuggerBreakConditionDlg); @@ -188,10 +187,10 @@ public static void DbgOpenFile(string file, int line, bool selectLine) // Go to the line. DebuggerFileView.setCurrentLine(line, selectLine); // Get the breakpoints for this file. - if (file != omni.sGlobal["$DebuggerFile"]) + if (file != pInvokes.sGlobal["$DebuggerFile"]) { TCPDebugger.send("BREAKLIST " + file + "\r\n"); - omni.sGlobal["$DebuggerFile"] = file; + pInvokes.sGlobal["$DebuggerFile"] = file; } } } @@ -222,7 +221,7 @@ public static void DbgSetBreakPoint(string file, uint line, bool clear, string p if (!clear) { - if (file == omni.sGlobal["$DebuggerFile"]) + if (file == pInvokes.sGlobal["$DebuggerFile"]) DebuggerFileView.setBreak(line); } DebuggerBreakPoints.addBreak(file, line.AsString(), clear, passct, expr); @@ -237,7 +236,7 @@ public static void DbgRemoveBreakPoint(string file, uint line) DebuggerBreakPoints DebuggerBreakPoints = "DebuggerBreakPoints"; TCPDebugger TCPDebugger = "TCPDebugger"; - if (file == omni.sGlobal["$DebuggerFile"]) + if (file == pInvokes.sGlobal["$DebuggerFile"]) DebuggerFileView.removeBreak(line); TCPDebugger.send("BRKCLR " + file + " " + line + "\r\n"); DebuggerBreakPoints.removeBreak(file, line.AsString()); @@ -254,8 +253,8 @@ public static void DbgDeleteSelectedBreak() if (rowNum >= 0) { string breakText = DebuggerBreakPoints.getRowText(rowNum); - string breakLine = omni.Util.getField(breakText, 0); - string breakFile = omni.Util.getField(breakText, 1); + string breakLine = pInvokes.Util.getField(breakText, 0); + string breakFile = pInvokes.Util.getField(breakText, 1); DbgRemoveBreakPoint(breakFile, breakLine.AsUint()); } } @@ -314,7 +313,7 @@ public static void DbgRefreshWatches() { int id = DebuggerWatchView.getRowId(i); string row = DebuggerWatchView.getRowTextById(id); - string expr = omni.Util.getField(row, 0); + string expr = pInvokes.Util.getField(row, 0); TCPDebugger.send("EVAL " + id + " 0 " + expr + "\r\n"); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/main.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/main.cs index 65ae616d..0ad7ccc0 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/main.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/main.cs @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Debugger { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializeDebugger() { @@ -74,8 +72,8 @@ public static void startDebugger() new ObjectCreator("TCPObject", "TCPDebugger", typeof (gui.CodeBehind.Debugger.TCPDebugger)).Create(); // Used to get unique IDs for breakpoints and watch expressions. - omni.iGlobal["$DbgBreakId"] = 0; - omni.iGlobal["$DbgWatchSeq"] = 1; + pInvokes.iGlobal["$DbgBreakId"] = 0; + pInvokes.iGlobal["$DbgWatchSeq"] = 1; // Set up the GUI. gui.CodeBehind.Debugger.DebuggerConsoleView DebuggerConsoleView = "DebuggerConsoleView"; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DecalEditor/main.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DecalEditor/main.cs index c13bb6a5..e3561ad6 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DecalEditor/main.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DecalEditor/main.cs @@ -44,13 +44,11 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.DecalEditor { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializeDecalEditor() { Omni.self.Print(" % - Initializing Decal Editor"); - omni.sGlobal["$decalDataFile"] = "art/decals/managedDecalData.cs"; + pInvokes.sGlobal["$decalDataFile"] = "art/decals/managedDecalData.cs"; gui.DecalEditorGui.initialize(); // Add ourselves to EditorGui, where all the other tools reside diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/RSSNews/RSSFeedScript.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/RSSNews/RSSFeedScript.ed.cs index cc426f45..dc0cbb18 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/RSSNews/RSSFeedScript.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/RSSNews/RSSFeedScript.ed.cs @@ -46,17 +46,15 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.EditorClasses.RSSNews { public class RSSFeedScript { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "RSSFeedScript_initialize")] public static void initialize() { // RSS ticker configuration: - omni.sGlobal["$RSSFeed::serverName"] = "feeds.garagegames.com"; - omni.iGlobal["$RSSFeed::serverPort"] = 80; - omni.sGlobal["$RSSFeed::serverURL"] = "/product/tgea"; - omni.sGlobal["$RSSFeed::userAgent"] = "TorqueGameEngineAdvances/1.1"; - omni.iGlobal["$RSSFeed::maxNewHeadlines"] = 10; + pInvokes.sGlobal["$RSSFeed::serverName"] = "feeds.garagegames.com"; + pInvokes.iGlobal["$RSSFeed::serverPort"] = 80; + pInvokes.sGlobal["$RSSFeed::serverURL"] = "/product/tgea"; + pInvokes.sGlobal["$RSSFeed::userAgent"] = "TorqueGameEngineAdvances/1.1"; + pInvokes.iGlobal["$RSSFeed::maxNewHeadlines"] = 10; // Load up the helper objects //exec( "./RSSStructs.ed.cs" ); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/fileLoader.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/fileLoader.ed.cs index d844fa9a..dc176ff4 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/fileLoader.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/fileLoader.ed.cs @@ -40,8 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.EditorClasses { public class fileLoader { - public static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void loadDirectory(string path, string type, string dsoType) { @@ -58,7 +56,7 @@ public static void loadDirectory(string path, string type, string dsoType) // First we find all the scripts and compile them if there are any // In the shipping version, this wont find anything. string dsopath; - if (!omni.bGlobal["$Scripts::ignoreDSOs"]) + if (!pInvokes.bGlobal["$Scripts::ignoreDSOs"]) { bool dsoReloc = compileDirectory(cspath, ""); @@ -76,47 +74,47 @@ public static void loadDirectory(string path, string type, string dsoType) dsopath = cspath; //error("Execing Directory " @ %dsopath @ " ..."); - string file = omni.Util.findFirstFile(dsopath, false); + string file = pInvokes.Util.findFirstFile(dsopath, false); while (file != "") { //error(" Found File: " @ %file); // As we cant exec() a .dso directly, we need to strip that part from the filename - int pos = omni.Util.strstr(file, "." + dsoType); + int pos = pInvokes.Util.strstr(file, "." + dsoType); string csfile; if (pos != -1) - csfile = omni.Util.getSubStr(file, 0, pos); + csfile = pInvokes.Util.getSubStr(file, 0, pos); else csfile = file; - omni.Util.exec(csfile, false, false); - file = omni.Util.findNextFile(dsopath); + pInvokes.Util.exec(csfile, false, false); + file = pInvokes.Util.findNextFile(dsopath); } } [ConsoleInteraction] public static bool compileDirectory(string path, string dsoPath) { - string saveDSOPath = omni.sGlobal["$Scripts::OverrideDSOPath"]; - omni.sGlobal["$Scripts::OverrideDSOPath"] = dsoPath; + string saveDSOPath = pInvokes.sGlobal["$Scripts::OverrideDSOPath"]; + pInvokes.sGlobal["$Scripts::OverrideDSOPath"] = dsoPath; bool dsoReloc = false; - string file = omni.Util.findFirstFile(path, false); + string file = pInvokes.Util.findFirstFile(path, false); //error("Compiling Directory " @ %path @ " ..."); while (file != "") { //error(" Found File: " @ %file @ " (" @ getDSOPath(%file) @ ")"); - if (omni.Util.filePath(file) != omni.Util.filePath(omni.Util.getDSOPath(file))) + if (pInvokes.Util.filePath(file) != pInvokes.Util.filePath(pInvokes.Util.getDSOPath(file))) dsoReloc = true; - omni.Util.compile(file, false); - file = omni.Util.findNextFile(path); + pInvokes.Util.compile(file, false); + file = pInvokes.Util.findNextFile(path); } - omni.sGlobal["$Scripts::OverrideDSOPath"] = saveDSOPath; + pInvokes.sGlobal["$Scripts::OverrideDSOPath"] = saveDSOPath; return dsoReloc; } @@ -124,13 +122,13 @@ public static bool compileDirectory(string path, string dsoPath) [ConsoleInteraction] public static void listDirectory(string path) { - string file = omni.Util.findFirstFile(path, false); + string file = pInvokes.Util.findFirstFile(path, false); - omni.Util._echo("Listing Directory " + path + " ..."); + pInvokes.Util._echo("Listing Directory " + path + " ..."); while (file != "") { - omni.Util._echo(" " + file); - file = omni.Util.findNextFile(path); + pInvokes.Util._echo(" " + file); + file = pInvokes.Util.findNextFile(path); } } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/main.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/main.cs index 2cf65ebe..f5d78ce3 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/main.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/main.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -44,16 +44,14 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.EditorClasses { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializeEditorClasses() { Omni.self.Print(" % - Initializing Tools Base"); - omni.sGlobal["$EditorClassesGroup"] = "EditorClassesCleanup"; + pInvokes.sGlobal["$EditorClassesGroup"] = "EditorClassesCleanup"; - if (!omni.sGlobal["$EditorClassesGroup"].isObject()) - new ObjectCreator("SimGroup", omni.sGlobal["$EditorClassesGroup"]).Create(); + if (!pInvokes.sGlobal["$EditorClassesGroup"].isObject()) + new ObjectCreator("SimGroup", pInvokes.sGlobal["$EditorClassesGroup"]).Create(); RSSFeedScript.initialize(); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorGui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorGui.cs index 39160321..fe3d8c1b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorGui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorGui.cs @@ -1779,15 +1779,15 @@ public static void editorPrefsInitialize() EditorSettings.setDefaultValue("dropType", "screenCenter"); EditorSettings.setDefaultValue("undoLimit", "40"); EditorSettings.setDefaultValue("forceLoadDAE", "0"); - EditorSettings.setDefaultValue("displayType", omni.sGlobal["$EditTsCtrl::DisplayTypePerspective"]); + EditorSettings.setDefaultValue("displayType", sGlobal["$EditTsCtrl::DisplayTypePerspective"]); EditorSettings.setDefaultValue("orthoFOV", "50"); EditorSettings.setDefaultValue("orthoShowGrid", "1"); EditorSettings.setDefaultValue("currentEditor", "WorldEditorInspectorPlugin"); EditorSettings.setDefaultValue("newLevelFile", "tools/levels/BlankRoom.mis"); - if (omni.Util.isFile("C:/Program Files/Torsion/Torsion.exe")) + if (Util.isFile("C:/Program Files/Torsion/Torsion.exe")) EditorSettings.setDefaultValue("torsionPath", "C:/Program Files/Torsion/Torsion.exe"); - else if (omni.Util.isFile("C:/Program Files (x86)/Torsion/Torsion.exe")) + else if (Util.isFile("C:/Program Files (x86)/Torsion/Torsion.exe")) EditorSettings.setDefaultValue("torsionPath", "C:/Program Files (x86)/Torsion/Torsion.exe"); else EditorSettings.setDefaultValue("torsionPath", ""); @@ -1932,8 +1932,8 @@ public static void editorPrefsInitialize() [ConsoleInteraction] public static void setDefault(string name, string value) { - if (!omni.Util.isDefined(name)) - omni.Util.eval(name + ' ' + "=" + ' ' + "\"" + value + "\";"); + if (!Util.isDefined(name)) + Util.eval(name + ' ' + "=" + ' ' + "\"" + value + "\";"); } [ConsoleInteraction] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/OpenFileDialog.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/OpenFileDialog.ed.cs index 22b4b9ae..60a5fbdd 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/OpenFileDialog.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/OpenFileDialog.ed.cs @@ -43,8 +43,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Gui { public class OpenFileDialog { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void getLoadFilename(string filespec, string callback, string currentFile) { @@ -67,16 +65,16 @@ public static void getLoadFilename(string filespec, string callback, string curr ofd.Multiselect = false; //FileDialog fd = ofd; - if (omni.Util.filePath(currentFile) != "") - ofd.InitialDirectory = omni.Util.filePath(currentFile); + if (pInvokes.Util.filePath(currentFile) != "") + ofd.InitialDirectory = pInvokes.Util.filePath(currentFile); DialogResult dr = Dialogs.OpenFileDialog(ref ofd); if (dr == DialogResult.OK) { string fileName = Dialogs.GetForwardSlashFile(ofd.FileName); - omni.Util.eval(callback + "(\"" + fileName + "\");"); - omni.sGlobal["$Tools::FileDialogs::LastFilePath"] = omni.Util.filePath(fileName); + pInvokes.Util.eval(callback + "(\"" + fileName + "\");"); + pInvokes.sGlobal["$Tools::FileDialogs::LastFilePath"] = pInvokes.Util.filePath(fileName); } } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/SaveFileDialog.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/SaveFileDialog.ed.cs index 04ee11e5..9d027d13 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/SaveFileDialog.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/SaveFileDialog.ed.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -42,17 +42,15 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Gui { public class SaveFileDialog { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void getSaveFilename(string filespec, string callback, string currentFile, bool overwrite = true) { System.Windows.Forms.SaveFileDialog sfd = new System.Windows.Forms.SaveFileDialog {Filter = filespec, FileName = currentFile, OverwritePrompt = overwrite,}; - if (omni.Util.filePath(currentFile) != "") - sfd.InitialDirectory = omni.Util.filePath(currentFile); + if (pInvokes.Util.filePath(currentFile) != "") + sfd.InitialDirectory = pInvokes.Util.filePath(currentFile); else - sfd.InitialDirectory = omni.Util.getMainDotCsDir(); + sfd.InitialDirectory = pInvokes.Util.getMainDotCsDir(); DialogResult dr = Dialogs.SaveFileDialog(ref sfd); @@ -60,7 +58,7 @@ public static void getSaveFilename(string filespec, string callback, string curr { //string filename = dlg["FileName"]; string filename = Dialogs.GetForwardSlashFile(sfd.FileName); - omni.Util.eval(callback + "(\"" + filename + "\");"); + pInvokes.Util.eval(callback + "(\"" + filename + "\");"); } } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColladaImportDlg.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColladaImportDlg.ed.cs index f76f799e..d8fae074 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColladaImportDlg.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColladaImportDlg.ed.cs @@ -1990,17 +1990,17 @@ public static void updateTSShapeLoadProgress(float progress, string msg) public static void convertColladaModels(string pattern) { // Force loading the COLLADA file (to ensure cached DTS is updated) - omni.bGlobal["$collada::forceLoadDAE"] = true; + bGlobal["$collada::forceLoadDAE"] = true; - string fullPath = omni.Util.findFirstFile("*.dae", false); + string fullPath = Util.findFirstFile("*.dae", false); while (fullPath != "") { // Check if this file is inside the given path - fullPath = omni.Util.makeRelativePath(fullPath, omni.Util.getMainDotCsDir()); - if ((pattern == "") || omni.Util.strIsMatchMultipleExpr(pattern, fullPath, false)) + fullPath = Util.makeRelativePath(fullPath, Util.getMainDotCsDir()); + if ((pattern == "") || Util.strIsMatchMultipleExpr(pattern, fullPath, false)) { // Load the model by creating a temporary TSStatic - omni.Util._echo("Converting " + fullPath + " to DTS..."); + Util._echo("Converting " + fullPath + " to DTS..."); ObjectCreator tempCreator = new ObjectCreator("TSStatic"); tempCreator["shapeName"] = fullPath; tempCreator["collisionType"] = "None"; @@ -2010,10 +2010,10 @@ public static void convertColladaModels(string pattern) temp.delete(); } - fullPath = omni.Util.findNextFile("*.dae"); + fullPath = Util.findNextFile("*.dae"); } - omni.bGlobal["$collada::forceLoadDAE"] = false; + bGlobal["$collada::forceLoadDAE"] = false; } [TypeConverter(typeof (TypeConverterGeneric))] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColorPickerDlg.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColorPickerDlg.ed.cs index c4718ceb..0f979da4 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColorPickerDlg.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColorPickerDlg.ed.cs @@ -485,30 +485,30 @@ public static void initialize() oc_Newobject25.Create(); - omni.sGlobal["$ColorPickerCallback"] = ""; // Control that we need to update - omni.sGlobal["$ColorPickerCancelCallback"] = ""; - omni.sGlobal["$ColorPickerUpdateCallback"] = ""; - omni.iGlobal["$ColorCallbackType"] = 1; // ColorI + sGlobal["$ColorPickerCallback"] = ""; // Control that we need to update + sGlobal["$ColorPickerCancelCallback"] = ""; + sGlobal["$ColorPickerUpdateCallback"] = ""; + iGlobal["$ColorCallbackType"] = 1; // ColorI } [ConsoleInteraction] public static string ColorFloatToInt(string color) { - string red = omni.Util.getWord(color, 0); - string green = omni.Util.getWord(color, 1); - string blue = omni.Util.getWord(color, 2); - string alpha = omni.Util.getWord(color, 3); + string red = Util.getWord(color, 0); + string green = Util.getWord(color, 1); + string blue = Util.getWord(color, 2); + string alpha = Util.getWord(color, 3); - return omni.Util.mCeil(red.AsFloat()*255).AsString() + " " + omni.Util.mCeil(green.AsFloat()*255).AsString() + " " + omni.Util.mCeil(blue.AsFloat()*255).AsString() + " " + omni.Util.mCeil(alpha.AsFloat()*255).AsString(); + return Util.mCeil(red.AsFloat()*255).AsString() + " " + Util.mCeil(green.AsFloat()*255).AsString() + " " + Util.mCeil(blue.AsFloat()*255).AsString() + " " + Util.mCeil(alpha.AsFloat()*255).AsString(); } [ConsoleInteraction] public static string ColorIntToFloat(string color) { - string red = omni.Util.getWord(color, 0); - string green = omni.Util.getWord(color, 1); - string blue = omni.Util.getWord(color, 2); - string alpha = omni.Util.getWord(color, 3); + string red = Util.getWord(color, 0); + string green = Util.getWord(color, 1); + string blue = Util.getWord(color, 2); + string alpha = Util.getWord(color, 3); return (red.AsFloat()/255).AsString() + " " + (green.AsFloat()/255).AsString() + " " + (blue.AsFloat()/255).AsString() + " " + (alpha.AsFloat()/255).AsString(); } @@ -526,11 +526,11 @@ public static void GetColorI(string currentColor, string callback, string root, GuiTextEditCtrl Channel_A_Val = "Channel_A_Val"; ColorPickerDlg ColorPickerDlg = "ColorPickerDlg"; - omni.bGlobal["$ColorPickerSignal"] = true; - omni.sGlobal["$ColorPickerCallback"] = callback; - omni.sGlobal["$ColorPickerCancelCallback"] = cancelCallback; - omni.sGlobal["$ColorPickerUpdateCallback"] = updateCallback; - omni.iGlobal["$ColorCallbackType"] = 1; // ColorI + bGlobal["$ColorPickerSignal"] = true; + sGlobal["$ColorPickerCallback"] = callback; + sGlobal["$ColorPickerCancelCallback"] = cancelCallback; + sGlobal["$ColorPickerUpdateCallback"] = updateCallback; + iGlobal["$ColorCallbackType"] = 1; // ColorI oldColor.color = ColorIntToFloat(currentColor).AsColorF(); myColor.color = ColorIntToFloat(currentColor).AsColorF(); @@ -542,10 +542,10 @@ public static void GetColorI(string currentColor, string callback, string root, ColorAlphaSelect.range = "0 255".AsPoint2F(); // Set the RGBA displays accordingly - float red = omni.Util.getWord(currentColor, 0).AsFloat()/255; - float green = omni.Util.getWord(currentColor, 1).AsFloat()/255; - float blue = omni.Util.getWord(currentColor, 2).AsFloat()/255; - float alpha = omni.Util.getWord(currentColor, 3).AsFloat(); + float red = Util.getWord(currentColor, 0).AsFloat()/255; + float green = Util.getWord(currentColor, 1).AsFloat()/255; + float blue = Util.getWord(currentColor, 2).AsFloat()/255; + float alpha = Util.getWord(currentColor, 3).AsFloat(); // set the initial range blend to correct color, no alpha needed // this should also set the color blend select right now @@ -574,11 +574,11 @@ public static void GetColorF(string currentColor, string callback, string root, GuiTextEditCtrl Channel_A_Val = "Channel_A_Val"; ColorPickerDlg ColorPickerDlg = "ColorPickerDlg"; - omni.bGlobal["$ColorPickerSignal"] = true; - omni.sGlobal["$ColorPickerCallback"] = callback; - omni.sGlobal["$ColorPickerCancelCallback"] = cancelCallback; - omni.sGlobal["$ColorPickerUpdateCallback"] = updateCallback; - omni.iGlobal["$ColorCallbackType"] = 2; // ColorF + bGlobal["$ColorPickerSignal"] = true; + sGlobal["$ColorPickerCallback"] = callback; + sGlobal["$ColorPickerCancelCallback"] = cancelCallback; + sGlobal["$ColorPickerUpdateCallback"] = updateCallback; + iGlobal["$ColorCallbackType"] = 2; // ColorF oldColor.color = currentColor.AsColorF(); myColor.color = currentColor.AsColorF(); @@ -590,10 +590,10 @@ public static void GetColorF(string currentColor, string callback, string root, ColorAlphaSelect.range = "0 1".AsPoint2F(); // Set the RGBA displays accordingly - string red = omni.Util.getWord(currentColor, 0); - string green = omni.Util.getWord(currentColor, 1); - string blue = omni.Util.getWord(currentColor, 2); - string alpha = omni.Util.getWord(currentColor, 3); + string red = Util.getWord(currentColor, 0); + string green = Util.getWord(currentColor, 1); + string blue = Util.getWord(currentColor, 2); + string alpha = Util.getWord(currentColor, 3); // set the initial range blend to correct color, no alpha needed // this should also set the color blend select right now @@ -622,14 +622,14 @@ public static void setColorInfo() string green = Channel_G_Val.getValue(); string blue = Channel_B_Val.getValue(); - if (omni.iGlobal["$ColorCallbackType"] == 1) + if (iGlobal["$ColorCallbackType"] == 1) { red = (red.AsFloat()/255).AsString(); green = (green.AsFloat()/255).AsString(); blue = (blue.AsFloat()/255).AsString(); } - omni.iGlobal["$ColorPickerSignal"] = 1; + iGlobal["$ColorPickerSignal"] = 1; ColorBlendSelect.baseColor = (red + " " + green + " " + blue + " " + "1.0").AsColorF(); ColorBlendSelect.updateColor(); @@ -642,7 +642,7 @@ public static void DoColorPickerCallback() ColorPickerDlg ColorPickerDlg = "ColorPickerDlg"; GuiSwatchButtonCtrl myColor = "myColor"; - omni.Util.eval(omni.sGlobal["$ColorPickerCallback"] + "(\"" + constructNewColor(myColor.color.AsString(), omni.iGlobal["$ColorCallbackType"]) + "\");"); + Util.eval(sGlobal["$ColorPickerCallback"] + "(\"" + constructNewColor(myColor.color.AsString(), iGlobal["$ColorCallbackType"]) + "\");"); ((GuiCanvas) ColorPickerDlg.getRoot()).popDialog(ColorPickerDlg); } @@ -653,8 +653,8 @@ public static void DoColorPickerCancelCallback() GuiSwatchButtonCtrl oldColor = "oldColor"; ((GuiCanvas) ColorPickerDlg.getRoot()).popDialog(ColorPickerDlg); - if (omni.sGlobal["$ColorPickerCancelCallback"] != "") - omni.Util.eval(omni.sGlobal["$ColorPickerCancelCallback"] + "(\"" + constructNewColor(oldColor.color.AsString(), omni.iGlobal["$ColorCallbackType"]) + "\");"); + if (sGlobal["$ColorPickerCancelCallback"] != "") + Util.eval(sGlobal["$ColorPickerCancelCallback"] + "(\"" + constructNewColor(oldColor.color.AsString(), iGlobal["$ColorCallbackType"]) + "\");"); } [ConsoleInteraction] @@ -662,8 +662,8 @@ public static void DoColorPickerUpdateCallback() { GuiSwatchButtonCtrl myColor = "myColor"; - if (omni.sGlobal["$ColorPickerUpdateCallback"] != "") - omni.Util.eval(omni.sGlobal["$ColorPickerUpdateCallback"] + "(\"" + constructNewColor(myColor.color.AsString(), omni.iGlobal["$ColorCallbackType"]) + "\");"); + if (sGlobal["$ColorPickerUpdateCallback"] != "") + Util.eval(sGlobal["$ColorPickerUpdateCallback"] + "(\"" + constructNewColor(myColor.color.AsString(), iGlobal["$ColorCallbackType"]) + "\");"); } [ConsoleInteraction] @@ -675,17 +675,17 @@ public static void updatePickerBaseColor(bool location) string pickColor; - if (omni.bGlobal["$ColorPickerSignal"] && location) + if (bGlobal["$ColorPickerSignal"] && location) pickColor = ColorRangeSelect.baseColor.AsString(); else pickColor = ColorRangeSelect.pickColor.AsString(); - omni.bGlobal["$ColorPickerSignal"] = true; + bGlobal["$ColorPickerSignal"] = true; - string red = omni.Util.getWord(pickColor, 0); - string green = omni.Util.getWord(pickColor, 1); - string blue = omni.Util.getWord(pickColor, 2); - string alpha = omni.Util.getWord(pickColor, 3); + string red = Util.getWord(pickColor, 0); + string green = Util.getWord(pickColor, 1); + string blue = Util.getWord(pickColor, 2); + string alpha = Util.getWord(pickColor, 3); ColorBlendSelect.baseColor = (red + " " + green + " " + blue + " " + "1.0").AsColorF(); ColorBlendSelect.updateColor(); @@ -704,17 +704,17 @@ public static void updateRGBValues(bool location) string pickColor; //update the color based on where it came from - if (omni.bGlobal["$ColorPickerSignal"] && location) + if (bGlobal["$ColorPickerSignal"] && location) pickColor = ColorBlendSelect.baseColor.AsString(); else pickColor = ColorBlendSelect.pickColor.AsString(); //lets prepare the color - string red = omni.Util.getWord(pickColor, 0); - string green = omni.Util.getWord(pickColor, 1); - string blue = omni.Util.getWord(pickColor, 2); + string red = Util.getWord(pickColor, 0); + string green = Util.getWord(pickColor, 1); + string blue = Util.getWord(pickColor, 2); //the alpha should be grabbed from mycolor - string alpha = omni.Util.getWord(myColor.color.AsString(), 3); + string alpha = Util.getWord(myColor.color.AsString(), 3); // set the color! myColor.color = (red + " " + green + " " + blue + " " + alpha).AsColorF(); @@ -722,17 +722,17 @@ public static void updateRGBValues(bool location) DoColorPickerUpdateCallback(); //update differently depending on type - if (omni.iGlobal["$ColorCallbackType"] == 1) + if (iGlobal["$ColorCallbackType"] == 1) { - red = omni.Util.mCeil(red.AsFloat()*255).AsString(); - blue = omni.Util.mCeil(blue.AsFloat()*255).AsString(); - green = omni.Util.mCeil(green.AsFloat()*255).AsString(); + red = Util.mCeil(red.AsFloat()*255).AsString(); + blue = Util.mCeil(blue.AsFloat()*255).AsString(); + green = Util.mCeil(green.AsFloat()*255).AsString(); } else { - red = omni.Util.mFloatLength(red.AsFloat(), 3); - blue = omni.Util.mFloatLength(blue.AsFloat(), 3); - green = omni.Util.mFloatLength(green.AsFloat(), 3); + red = Util.mFloatLength(red.AsFloat(), 3); + blue = Util.mFloatLength(blue.AsFloat(), 3); + green = Util.mFloatLength(green.AsFloat(), 3); } // changes current color values @@ -740,7 +740,7 @@ public static void updateRGBValues(bool location) Channel_G_Val.setValue(green); Channel_B_Val.setValue(blue); - omni.bGlobal["$ColorPickerSignal"] = false; + bGlobal["$ColorPickerSignal"] = false; } [ConsoleInteraction] @@ -749,12 +749,12 @@ public static void updateColorPickerAlpha(string alphaVal) GuiSwatchButtonCtrl myColor = "myColor"; //lets prepare the color - string red = omni.Util.getWord(myColor.color.AsString(), 0); - string green = omni.Util.getWord(myColor.color.AsString(), 1); - string blue = omni.Util.getWord(myColor.color.AsString(), 2); + string red = Util.getWord(myColor.color.AsString(), 0); + string green = Util.getWord(myColor.color.AsString(), 1); + string blue = Util.getWord(myColor.color.AsString(), 2); string alpha = alphaVal; - if (omni.iGlobal["$ColorCallbackType"] == 1) + if (iGlobal["$ColorCallbackType"] == 1) alpha = (alpha.AsFloat()/255).AsString(); myColor.color = (red + " " + green + " " + blue + " " + alpha).AsColorF(); @@ -765,15 +765,15 @@ public static void updateColorPickerAlpha(string alphaVal) [ConsoleInteraction] public static string constructNewColor(string pickColor, int colorType) { - string red = omni.Util.getWord(pickColor, 0); - string green = omni.Util.getWord(pickColor, 1); - string blue = omni.Util.getWord(pickColor, 2); - string alpha = omni.Util.getWord(pickColor, 3); // Copyright (C) 2013 WinterLeaf Entertainment LLC. + string red = Util.getWord(pickColor, 0); + string green = Util.getWord(pickColor, 1); + string blue = Util.getWord(pickColor, 2); + string alpha = Util.getWord(pickColor, 3); // Copyright (C) 2013 WinterLeaf Entertainment LLC. // Update the text controls to reflect new color //setColorInfo(red, green, blue, alpha); if (colorType == 1) // ColorI - return omni.Util.mCeil(red.AsFloat()*255).AsString() + " " + omni.Util.mCeil(green.AsFloat()*255).AsString() + " " + omni.Util.mCeil(blue.AsFloat()*255).AsString() + " " +/* Copyright (C) 2013 WinterLeaf Entertainment LLC. */ omni.Util.mCeil(alpha.AsFloat()*255).AsString(); + return Util.mCeil(red.AsFloat()*255).AsString() + " " + Util.mCeil(green.AsFloat()*255).AsString() + " " + Util.mCeil(blue.AsFloat()*255).AsString() + " " +/* Copyright (C) 2013 WinterLeaf Entertainment LLC. */ Util.mCeil(alpha.AsFloat()*255).AsString(); else // ColorF return red + " " + green + " " + blue + " " + alpha; } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiEaseEditDlg.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiEaseEditDlg.ed.cs index b788c26b..80539f27 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiEaseEditDlg.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiEaseEditDlg.ed.cs @@ -537,10 +537,10 @@ public void setEase(string ease) GuiTextEditSliderCtrl param2Value = this.FOT("param2Value"); easeView.ease = ease.AsEaseF(); - directionList.setSelected(omni.Util.getWord(ease, 0).AsInt(), false); - typeList.setSelected(omni.Util.getWord(ease, 1).AsInt(), false); - param1Value.setValue(omni.Util.getWord(ease, 2)); - param2Value.setValue(omni.Util.getWord(ease, 3)); + directionList.setSelected(Util.getWord(ease, 0).AsInt(), false); + typeList.setSelected(Util.getWord(ease, 1).AsInt(), false); + param1Value.setValue(Util.getWord(ease, 2)); + param2Value.setValue(Util.getWord(ease, 3)); this.onEaseTypeSet(); } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiObjectInspector.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiObjectInspector.ed.cs index 349fff90..b1e0c582 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiObjectInspector.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiObjectInspector.ed.cs @@ -538,17 +538,17 @@ public static void inspectObject(string objectx) if (!objectx.isObject()) { - omni.Util._error("inspectObject: no object '" + objectx + "'"); + Util._error("inspectObject: no object '" + objectx + "'"); return; } // Create a new object inspector window. //exec( "./guiObjectInspector.ed.gui" ); - GuiObjectInspector guiContent = omni.console.Call("GuiObjectInspector_initialize"); + GuiObjectInspector guiContent = console.Call("GuiObjectInspector_initialize"); if (!guiContent.isObject()) { - omni.Util._error("InspectObject: failed to create GUI from 'guiObjectInspector.ed.gui'"); + Util._error("InspectObject: failed to create GUI from 'guiObjectInspector.ed.gui'"); return; } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MaterialSelector.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MaterialSelector.ed.cs index 2a575425..5b15e027 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MaterialSelector.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MaterialSelector.ed.cs @@ -980,9 +980,9 @@ public static void initialize() oc_Newobject42.Create(); - omni.sGlobal["$Pref::MaterialSelector::CurrentStaticFilter"] = "MaterialFilterAllArray"; - omni.sGlobal["$Pref::MaterialSelector::CurrentFilter"] = ""; //ALL - omni.iGlobal["$Pref::MaterialSelector::ThumbnailCountIndex"] = 0; + sGlobal["$Pref::MaterialSelector::CurrentStaticFilter"] = "MaterialFilterAllArray"; + sGlobal["$Pref::MaterialSelector::CurrentFilter"] = ""; //ALL + iGlobal["$Pref::MaterialSelector::ThumbnailCountIndex"] = 0; new ObjectCreator("PersistenceManager", "MaterialSelectorPerMan").Create(); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MessageBoxSaveChangesDlg.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MessageBoxSaveChangesDlg.cs index 25a1f667..07102f28 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MessageBoxSaveChangesDlg.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MessageBoxSaveChangesDlg.cs @@ -247,7 +247,7 @@ public static void checkSaveChangesOld(string data, string saveCallback, string // Sanity Check if (MessageBoxSaveChangesDlg.isAwake()) { - omni.Util._warn("Save Changes Dialog already Awake, NOT creating second instance."); + Util._warn("Save Changes Dialog already Awake, NOT creating second instance."); return; } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ScriptEditorDlg.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ScriptEditorDlg.ed.cs index db0ee927..97b6e1eb 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ScriptEditorDlg.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ScriptEditorDlg.ed.cs @@ -299,7 +299,7 @@ public static void _TextPadOnOk() { string text = textpad.getText(); string command = ScriptEditorDlg["callback"] + "( text );"; - omni.Util.eval(command); + Util.eval(command); } ScriptEditorDlg["callback"] = ""; ((GuiCanvas) ScriptEditorDlg.getRoot()).popDialog(ScriptEditorDlg); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/guiDialogs.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/guiDialogs.cs index 192105cf..52a039fd 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/guiDialogs.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/guiDialogs.cs @@ -40,8 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Gui { public class guiDialogs { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { //omni.Util.exec("tools/gui/fileDialogBase.ed.cs",false,false); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/profiles.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/profiles.ed.cs index 039118a9..0b21f44a 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/profiles.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/profiles.ed.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -38,15 +38,13 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Gui { - public class profiles + public class profiles : pInvokes { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.sGlobal["$Gui::clipboardFile"] = omni.Util._expandFilename("tools/gui/clipboard.gui"); + sGlobal["$Gui::clipboardFile"] = Util._expandFilename("tools/gui/clipboard.gui"); - if (!omni.Util.isObject("ToolsGuiDefaultProfile")) + if (!Util.isObject("ToolsGuiDefaultProfile")) { #region GuiControlProfile (ToolsGuiDefaultProfile) oc_Newobject1 @@ -87,7 +85,7 @@ public static void initialize() oc_Newobject1.Create(); } - if (!omni.Util.isObject("ToolsGuiEditorProfile")) + if (!Util.isObject("ToolsGuiEditorProfile")) { #region GuiControlProfile (ToolsGuiEditorProfile) oc_Newobject2 @@ -128,7 +126,7 @@ public static void initialize() oc_Newobject2.Create(); } - if (!omni.Util.isObject("ToolsGuiSolidDefaultProfile")) + if (!Util.isObject("ToolsGuiSolidDefaultProfile")) { #region GuiControlProfile (ToolsGuiSolidDefaultProfile) oc_Newobject3 @@ -142,7 +140,7 @@ public static void initialize() oc_Newobject3.Create(); } - if (!omni.Util.isObject("ToolsGuiTransparentProfile")) + if (!Util.isObject("ToolsGuiTransparentProfile")) { #region GuiControlProfile (ToolsGuiTransparentProfile) oc_Newobject4 @@ -156,7 +154,7 @@ public static void initialize() oc_Newobject4.Create(); } - if (!omni.Util.isObject("ToolsGuiGroupBorderProfile")) + if (!Util.isObject("ToolsGuiGroupBorderProfile")) { #region GuiControlProfile ( ToolsGuiGroupBorderProfile ) oc_Newobject5 @@ -172,7 +170,7 @@ public static void initialize() oc_Newobject5.Create(); } - if (!omni.Util.isObject("ToolsGuiTabBorderProfile")) + if (!Util.isObject("ToolsGuiTabBorderProfile")) { #region GuiControlProfile ( ToolsGuiTabBorderProfile ) oc_Newobject6 @@ -188,7 +186,7 @@ public static void initialize() oc_Newobject6.Create(); } - if (!omni.Util.isObject("ToolsGuiToolTipProfile")) + if (!Util.isObject("ToolsGuiToolTipProfile")) { #region GuiControlProfile (ToolsGuiToolTipProfile) oc_Newobject7 @@ -205,7 +203,7 @@ public static void initialize() oc_Newobject7.Create(); } - if (!omni.Util.isObject("ToolsGuiModelessDialogProfile")) + if (!Util.isObject("ToolsGuiModelessDialogProfile")) { #region GuiControlProfile ( ToolsGuiModelessDialogProfile ) oc_Newobject8 @@ -218,7 +216,7 @@ public static void initialize() oc_Newobject8.Create(); } - if (!omni.Util.isObject("ToolsGuiFrameSetProfile")) + if (!Util.isObject("ToolsGuiFrameSetProfile")) { #region GuiControlProfile (ToolsGuiFrameSetProfile) oc_Newobject9 @@ -234,7 +232,7 @@ public static void initialize() oc_Newobject9.Create(); } - if (!omni.Util.isObject("ToolsGuiWindowProfile")) + if (!Util.isObject("ToolsGuiWindowProfile")) { #region GuiControlProfile (ToolsGuiWindowProfile) oc_Newobject10 @@ -271,7 +269,7 @@ public static void initialize() oc_Newobject10.Create(); } - if (!omni.Util.isObject("ToolsGuiToolbarWindowProfile")) + if (!Util.isObject("ToolsGuiToolbarWindowProfile")) { #region GuiControlProfile (ToolsGuiToolbarWindowProfile : ToolsGuiWindowProfile) oc_Newobject11 @@ -285,7 +283,7 @@ public static void initialize() oc_Newobject11.Create(); } - if (!omni.Util.isObject("ToolsGuiWindowCollapseProfile")) + if (!Util.isObject("ToolsGuiWindowCollapseProfile")) { #region GuiControlProfile (ToolsGuiWindowCollapseProfile : ToolsGuiWindowProfile) oc_Newobject12 @@ -297,7 +295,7 @@ public static void initialize() oc_Newobject12.Create(); } - if (!omni.Util.isObject("ToolsGuiTextProfile")) + if (!Util.isObject("ToolsGuiTextProfile")) { #region GuiControlProfile (ToolsGuiTextProfile) oc_Newobject13 @@ -326,7 +324,7 @@ public static void initialize() oc_Newobject13.Create(); } - if (!omni.Util.isObject("ToolsGuiTextBoldCenterProfile")) + if (!Util.isObject("ToolsGuiTextBoldCenterProfile")) { #region GuiControlProfile (ToolsGuiTextBoldCenterProfile : ToolsGuiTextProfile) oc_Newobject14 @@ -342,7 +340,7 @@ public static void initialize() oc_Newobject14.Create(); } - if (!omni.Util.isObject("ToolsGuiTextRightProfile")) + if (!Util.isObject("ToolsGuiTextRightProfile")) { #region GuiControlProfile (ToolsGuiTextRightProfile : ToolsGuiTextProfile) oc_Newobject15 @@ -355,7 +353,7 @@ public static void initialize() oc_Newobject15.Create(); } - if (!omni.Util.isObject("ToolsGuiTextCenterProfile")) + if (!Util.isObject("ToolsGuiTextCenterProfile")) { #region GuiControlProfile (ToolsGuiTextCenterProfile : ToolsGuiTextProfile) oc_Newobject16 @@ -368,7 +366,7 @@ public static void initialize() oc_Newobject16.Create(); } - if (!omni.Util.isObject("ToolsGuiInspectorTitleTextProfile")) + if (!Util.isObject("ToolsGuiInspectorTitleTextProfile")) { #region GuiControlProfile (ToolsGuiInspectorTitleTextProfile) oc_Newobject17 @@ -381,7 +379,7 @@ public static void initialize() oc_Newobject17.Create(); } - if (!omni.Util.isObject("ToolsGuiAutoSizeTextProfile")) + if (!Util.isObject("ToolsGuiAutoSizeTextProfile")) { #region GuiControlProfile (ToolsGuiAutoSizeTextProfile) oc_Newobject18 @@ -397,7 +395,7 @@ public static void initialize() oc_Newobject18.Create(); } - if (!omni.Util.isObject("ToolsGuiMLTextProfile")) + if (!Util.isObject("ToolsGuiMLTextProfile")) { #region GuiControlProfile ( ToolsGuiMLTextProfile ) oc_Newobject19 @@ -428,7 +426,7 @@ public static void initialize() oc_Newobject19.Create(); } - if (!omni.Util.isObject("ToolsGuiTextArrayProfile")) + if (!Util.isObject("ToolsGuiTextArrayProfile")) { #region GuiControlProfile ( ToolsGuiTextArrayProfile : ToolsGuiTextProfile ) oc_Newobject20 @@ -447,7 +445,7 @@ public static void initialize() oc_Newobject20.Create(); } - if (!omni.Util.isObject("ToolsGuiTextListProfile")) + if (!Util.isObject("ToolsGuiTextListProfile")) { #region GuiControlProfile ( ToolsGuiTextListProfile : ToolsGuiTextProfile ) oc_Newobject21 @@ -461,7 +459,7 @@ public static void initialize() oc_Newobject21.Create(); } - if (!omni.Util.isObject("ToolsGuiTextEditProfile")) + if (!Util.isObject("ToolsGuiTextEditProfile")) { #region GuiControlProfile ( ToolsGuiTextEditProfile ) oc_Newobject22 @@ -495,7 +493,7 @@ public static void initialize() oc_Newobject22.Create(); } - if (!omni.Util.isObject("ToolsGuiNumericTextEditProfile")) + if (!Util.isObject("ToolsGuiNumericTextEditProfile")) { #region GuiControlProfile ( ToolsGuiNumericTextEditProfile : ToolsGuiTextEditProfile ) oc_Newobject23 @@ -508,7 +506,7 @@ public static void initialize() oc_Newobject23.Create(); } - if (!omni.Util.isObject("ToolsGuiNumericDropSliderTextProfile")) + if (!Util.isObject("ToolsGuiNumericDropSliderTextProfile")) { #region GuiControlProfile ( ToolsGuiNumericDropSliderTextProfile : ToolsGuiTextEditProfile ) oc_Newobject24 @@ -521,7 +519,7 @@ public static void initialize() oc_Newobject24.Create(); } - if (!omni.Util.isObject("ToolsGuiRLProgressBitmapProfile")) + if (!Util.isObject("ToolsGuiRLProgressBitmapProfile")) { #region GuiControlProfile ( ToolsGuiRLProgressBitmapProfile ) oc_Newobject25 @@ -536,7 +534,7 @@ public static void initialize() oc_Newobject25.Create(); } - if (!omni.Util.isObject("ToolsGuiProgressTextProfile")) + if (!Util.isObject("ToolsGuiProgressTextProfile")) { #region GuiControlProfile ( ToolsGuiProgressTextProfile ) oc_Newobject26 @@ -552,7 +550,7 @@ public static void initialize() oc_Newobject26.Create(); } - if (!omni.Util.isObject("ToolsGuiButtonProfile")) + if (!Util.isObject("ToolsGuiButtonProfile")) { #region GuiControlProfile ( ToolsGuiButtonProfile ) oc_Newobject27 @@ -585,7 +583,7 @@ public static void initialize() oc_Newobject27.Create(); } - if (!omni.Util.isObject("ToolsGuiThumbHighlightButtonProfile")) + if (!Util.isObject("ToolsGuiThumbHighlightButtonProfile")) { #region GuiControlProfile ( ToolsGuiThumbHighlightButtonProfile : ToolsGuiButtonProfile ) oc_Newobject28 @@ -598,7 +596,7 @@ public static void initialize() oc_Newobject28.Create(); } - if (!omni.Util.isObject("ToolsGuiIconButtonProfile")) + if (!Util.isObject("ToolsGuiIconButtonProfile")) { #region GuiControlProfile ( ToolsGuiIconButtonProfile ) oc_Newobject29 @@ -620,7 +618,7 @@ public static void initialize() oc_Newobject29.Create(); } - if (!omni.Util.isObject("ToolsGuiIconButtonSmallProfile")) + if (!Util.isObject("ToolsGuiIconButtonSmallProfile")) { #region GuiControlProfile ( ToolsGuiIconButtonSmallProfile : ToolsGuiIconButtonProfile ) oc_Newobject30 @@ -633,7 +631,7 @@ public static void initialize() oc_Newobject30.Create(); } - if (!omni.Util.isObject("ToolsGuiEditorTabPage")) + if (!Util.isObject("ToolsGuiEditorTabPage")) { #region GuiControlProfile (ToolsGuiEditorTabPage) oc_Newobject31 @@ -655,7 +653,7 @@ public static void initialize() oc_Newobject31.Create(); } - if (!omni.Util.isObject("ToolsGuiCheckBoxProfile")) + if (!Util.isObject("ToolsGuiCheckBoxProfile")) { #region GuiControlProfile ( ToolsGuiCheckBoxProfile ) oc_Newobject32 @@ -682,7 +680,7 @@ public static void initialize() oc_Newobject32.Create(); } - if (!omni.Util.isObject("ToolsGuiCheckBoxListProfile")) + if (!Util.isObject("ToolsGuiCheckBoxListProfile")) { #region GuiControlProfile ( ToolsGuiCheckBoxListProfile : ToolsGuiCheckBoxProfile) oc_Newobject33 @@ -696,7 +694,7 @@ public static void initialize() oc_Newobject33.Create(); } - if (!omni.Util.isObject("ToolsGuiCheckBoxListFlipedProfile")) + if (!Util.isObject("ToolsGuiCheckBoxListFlipedProfile")) { #region GuiControlProfile ( ToolsGuiCheckBoxListFlipedProfile : ToolsGuiCheckBoxProfile) oc_Newobject34 @@ -710,7 +708,7 @@ public static void initialize() oc_Newobject34.Create(); } - if (!omni.Util.isObject("ToolsGuiInspectorCheckBoxTitleProfile")) + if (!Util.isObject("ToolsGuiInspectorCheckBoxTitleProfile")) { #region GuiControlProfile ( ToolsGuiInspectorCheckBoxTitleProfile : ToolsGuiCheckBoxProfile ) oc_Newobject35 @@ -725,7 +723,7 @@ public static void initialize() oc_Newobject35.Create(); } - if (!omni.Util.isObject("ToolsGuiRadioProfile")) + if (!Util.isObject("ToolsGuiRadioProfile")) { #region GuiControlProfile ( ToolsGuiRadioProfile ) oc_Newobject36 @@ -747,7 +745,7 @@ public static void initialize() oc_Newobject36.Create(); } - if (!omni.Util.isObject("ToolsGuiScrollProfile")) + if (!Util.isObject("ToolsGuiScrollProfile")) { #region GuiControlProfile ( ToolsGuiScrollProfile ) oc_Newobject37 @@ -768,7 +766,7 @@ public static void initialize() oc_Newobject37.Create(); } - if (!omni.Util.isObject("ToolsGuiOverlayProfile")) + if (!Util.isObject("ToolsGuiOverlayProfile")) { #region GuiControlProfile ( ToolsGuiOverlayProfile ) oc_Newobject00037 @@ -785,7 +783,7 @@ public static void initialize() oc_Newobject00037.Create(); } - if (!omni.Util.isObject("ToolsGuiSliderProfile")) + if (!Util.isObject("ToolsGuiSliderProfile")) { #region GuiControlProfile ( ToolsGuiSliderProfile ) oc_Newobject00038 @@ -798,7 +796,7 @@ public static void initialize() oc_Newobject00038.Create(); } - if (!omni.Util.isObject("ToolsGuiSliderBoxProfile")) + if (!Util.isObject("ToolsGuiSliderBoxProfile")) { #region GuiControlProfile ( ToolsGuiSliderBoxProfile ) oc_Newobject00039 @@ -811,7 +809,7 @@ public static void initialize() oc_Newobject00039.Create(); } - if (!omni.Util.isObject("ToolsGuiPopupMenuItemBorder")) + if (!Util.isObject("ToolsGuiPopupMenuItemBorder")) { #region GuiControlProfile ( ToolsGuiPopupMenuItemBorder ) oc_Newobject38 @@ -842,7 +840,7 @@ public static void initialize() oc_Newobject38.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuEditProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuEditProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuEditProfile ) oc_Newobject39 @@ -873,7 +871,7 @@ public static void initialize() oc_Newobject39.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuDefault")) + if (!Util.isObject("ToolsGuiPopUpMenuDefault")) { #region GuiControlProfile ( ToolsGuiPopUpMenuDefault ) oc_Newobject40 @@ -906,7 +904,7 @@ public static void initialize() oc_Newobject40.Create(); } - if (!omni.Util.isObject("ToolsGuiPopupMenuItemBorder")) + if (!Util.isObject("ToolsGuiPopupMenuItemBorder")) { #region GuiControlProfile ( ToolsGuiPopupMenuItemBorder : ToolsGuiButtonProfile ) oc_Newobject41 @@ -929,7 +927,7 @@ public static void initialize() oc_Newobject41.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuTabProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuTabProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuTabProfile : ToolsGuiDefaultProfile ) oc_Newobject42 @@ -962,7 +960,7 @@ public static void initialize() oc_Newobject42.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuProfile : ToolsGuiPopUpMenuDefault ) oc_Newobject43 @@ -996,7 +994,7 @@ public static void initialize() oc_Newobject43.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuTabProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuTabProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuTabProfile : ToolsGuiPopUpMenuDefault ) oc_Newobject44 @@ -1018,7 +1016,7 @@ public static void initialize() oc_Newobject44.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuEditProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuEditProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuEditProfile : ToolsGuiPopUpMenuDefault ) oc_Newobject45 @@ -1036,7 +1034,7 @@ public static void initialize() oc_Newobject45.Create(); } - if (!omni.Util.isObject("ToolsGuiListBoxProfile")) + if (!Util.isObject("ToolsGuiListBoxProfile")) { #region GuiControlProfile ( ToolsGuiListBoxProfile ) oc_Newobject46 @@ -1050,7 +1048,7 @@ public static void initialize() oc_Newobject46.Create(); } - if (!omni.Util.isObject("ToolsGuiTabBookProfile")) + if (!Util.isObject("ToolsGuiTabBookProfile")) { #region GuiControlProfile ( ToolsGuiTabBookProfile ) oc_Newobject47 @@ -1082,7 +1080,7 @@ public static void initialize() oc_Newobject47.Create(); } - if (!omni.Util.isObject("ToolsGuiTabBookNoBitmapProfile")) + if (!Util.isObject("ToolsGuiTabBookNoBitmapProfile")) { #region GuiControlProfile ( ToolsGuiTabBookNoBitmapProfile : ToolsGuiTabBookProfile ) oc_Newobject48 @@ -1095,7 +1093,7 @@ public static void initialize() oc_Newobject48.Create(); } - if (!omni.Util.isObject("ToolsGuiTabPageProfile")) + if (!Util.isObject("ToolsGuiTabPageProfile")) { #region GuiControlProfile ( ToolsGuiTabPageProfile : ToolsGuiDefaultProfile ) oc_Newobject49 @@ -1113,7 +1111,7 @@ public static void initialize() oc_Newobject49.Create(); } - if (!omni.Util.isObject("ToolsGuiTreeViewProfile")) + if (!Util.isObject("ToolsGuiTreeViewProfile")) { #region GuiControlProfile ( ToolsGuiTreeViewProfile ) oc_Newobject50 @@ -1145,7 +1143,7 @@ public static void initialize() oc_Newobject50.Create(); } - if (!omni.Util.isObject("ToolsGuiTextPadProfile")) + if (!Util.isObject("ToolsGuiTextPadProfile")) { #region GuiControlProfile ( ToolsGuiTextPadProfile ) oc_Newobject51 @@ -1164,7 +1162,7 @@ public static void initialize() oc_Newobject51.Create(); } - if (!omni.Util.isObject("ToolsGuiFormProfile")) + if (!Util.isObject("ToolsGuiFormProfile")) { #region GuiControlProfile ( ToolsGuiFormProfile : ToolsGuiTextProfile ) oc_Newobject52 diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorContentList.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorContentList.ed.cs index 0eb00a9d..b9db1f51 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorContentList.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorContentList.ed.cs @@ -49,11 +49,11 @@ public class GuiEditorContentList : GuiPopUpMenuCtrl [ConsoleInteraction(true, "GuiEditorContentList_initialize")] public static void initialize() { - if (!omni.Util.isDefined("$GuiEditor::GuiFilterList")) + if (!Util.isDefined("$GuiEditor::GuiFilterList")) { /// List of named controls that are filtered out from the /// control list dropdown. - omni.sGlobal["$GuiEditor::GuiFilterList"] = "GuiEditorGui" + '\t' + "AL_ShadowVizOverlayCtrl" + '\t' + "MessageBoxOKDlg" + '\t' + "MessageBoxOKCancelDlg" + '\t' + "MessageBoxOKCancelDetailsDlg" + '\t' + "MessageBoxYesNoDlg" + '\t' + "MessageBoxYesNoCancelDlg" + '\t' + "MessagePopupDlg"; + sGlobal["$GuiEditor::GuiFilterList"] = "GuiEditorGui" + '\t' + "AL_ShadowVizOverlayCtrl" + '\t' + "MessageBoxOKDlg" + '\t' + "MessageBoxOKCancelDlg" + '\t' + "MessageBoxOKCancelDetailsDlg" + '\t' + "MessageBoxYesNoDlg" + '\t' + "MessageBoxYesNoCancelDlg" + '\t' + "MessagePopupDlg"; } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorFileDialog.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorFileDialog.ed.cs index 5ca7a199..164ab130 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorFileDialog.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorFileDialog.ed.cs @@ -54,7 +54,7 @@ public class GuiBuilder : SimObject [ConsoleInteraction(true, "GuiBuilder_initialize")] public static void initialize() { - omni.sGlobal["$GUI::FileSpec"] = "Torque Gui Files (*.gui)|*.gui|All Files (*.*)|*.*"; + sGlobal["$GUI::FileSpec"] = "Torque Gui Files (*.gui)|*.gui|All Files (*.*)|*.*"; } /// GuiBuilder::getSaveName - Open a Native File dialog and retrieve the @@ -69,22 +69,22 @@ public static string GetSaveName(string defaultFileName) if (defaultFileName == "") { string prefix = ""; - if (omni.Util.isFunction("isScriptPathExpando")) + if (Util.isFunction("isScriptPathExpando")) { // if we're editing a game, we want to default to the games dir. // if we're not, then we default to the tools directory or the base. - if (omni.console.Call("isScriptPathExpando", new string[] {"^game"}).AsBool()) + if (console.Call("isScriptPathExpando", new string[] {"^game"}).AsBool()) prefix = "^game/"; - else if (omni.console.Call("isScriptPathExpando", new string[] {"^tools"}).AsBool()) + else if (console.Call("isScriptPathExpando", new string[] {"^tools"}).AsBool()) prefix = "^tools/"; } - defaultFileName = omni.Util._expandFilename(prefix + "gui/untitled.gui"); + defaultFileName = Util._expandFilename(prefix + "gui/untitled.gui"); } else - defaultPath = omni.Util.filePath(defaultFileName); + defaultPath = Util.filePath(defaultFileName); - SaveFileDialog sfd = new SaveFileDialog {Filter = omni.sGlobal["$GUI::FileSpec"], InitialDirectory = omni.Util.makeFullPath(defaultPath, ""), FileName = defaultFileName, OverwritePrompt = true,}; + SaveFileDialog sfd = new SaveFileDialog {Filter = sGlobal["$GUI::FileSpec"], InitialDirectory = Util.makeFullPath(defaultPath, ""), FileName = defaultFileName, OverwritePrompt = true,}; string filename = ""; @@ -93,9 +93,9 @@ public static string GetSaveName(string defaultFileName) if (dr == DialogResult.OK) { filename = Dialogs.GetForwardSlashFile(sfd.FileName); - GuiEditor["LastPath"] = omni.Util.filePath(filename); + GuiEditor["LastPath"] = Util.filePath(filename); //filename = dlg["FileName"]; - if (omni.Util.fileExt(filename) != ".gui") + if (Util.fileExt(filename) != ".gui") filename = filename + ".gui"; } @@ -116,16 +116,16 @@ public string getOpenName(string defaultFileName) GuiEditorGui.GuiEditor GuiEditor = "GuiEditor"; if (defaultFileName == "") - defaultFileName = omni.Util._expandFilename("^game/gui/untitled.gui"); + defaultFileName = Util._expandFilename("^game/gui/untitled.gui"); - OpenFileDialog ofd = new OpenFileDialog {FileName = defaultFileName, InitialDirectory = GuiEditor["LastPath"], Filter = omni.sGlobal["$GUI::FileSpec"], CheckFileExists = true, Multiselect = false}; + OpenFileDialog ofd = new OpenFileDialog {FileName = defaultFileName, InitialDirectory = GuiEditor["LastPath"], Filter = sGlobal["$GUI::FileSpec"], CheckFileExists = true, Multiselect = false}; DialogResult dr = Dialogs.OpenFileDialog(ref ofd); if (dr == DialogResult.OK) { string fileName = Dialogs.GetForwardSlashFile(ofd.FileName); - GuiEditor["LastPath"] = omni.Util.filePath(fileName); + GuiEditor["LastPath"] = Util.filePath(fileName); return fileName; } return ""; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorProfiles.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorProfiles.ed.cs index dce905c6..b3bca594 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorProfiles.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorProfiles.ed.cs @@ -47,13 +47,11 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.GuiEditor.gui.CodeBehi { public class GuiEditorProfiles { - internal static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "GuiEditorProfiles_initialize")] public static void initialize() { - omni.sGlobal["$GUI_EDITOR_DEFAULT_PROFILE_FILENAME"] = "art/gui/customProfiles.cs"; - omni.sGlobal["$GUI_EDITOR_DEFAULT_PROFILE_CATEGORY"] = "Other"; + pInvokes.sGlobal["$GUI_EDITOR_DEFAULT_PROFILE_FILENAME"] = "art/gui/customProfiles.cs"; + pInvokes.sGlobal["$GUI_EDITOR_DEFAULT_PROFILE_CATEGORY"] = "Other"; } //============================================================================================= diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorToolbox.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorToolbox.ed.cs index 90760d2d..4443464d 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorToolbox.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorToolbox.ed.cs @@ -409,7 +409,7 @@ public void startGuiControlDrag(string className) /// Utility function to sort rollouts by their caption. public static int _GuiEditorToolboxSortRollouts(SimObject a, SimObject b) { - return omni.Util.strinatcmp(a["caption"], b["caption"]); + return Util.strinatcmp(a["caption"], b["caption"]); } #region ProxyObjects Operator Overrides diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorUndo.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorUndo.ed.cs index b5931c1c..1d15927a 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorUndo.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorUndo.ed.cs @@ -47,8 +47,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.GuiEditor.gui.CodeBehi { public class GuiEditorUndo { - private static readonly pInvokes omni = new pInvokes(); - [TypeConverter(typeof (TypeConverterGeneric))] public class GenericUndoAction : UndoScriptAction { @@ -60,14 +58,14 @@ public string create() { // The instant group will try to add our // UndoAction if we don't disable it. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); GenericUndoAction act = new ObjectCreator("UndoScriptAction", "", typeof (GenericUndoAction)).Create(); act.actionName = "Edit Objects"; // Restore the instant group. - omni.Util.popInstantGroup(); + Util.popInstantGroup(); return act; } @@ -97,7 +95,7 @@ public void watch(SimObject objectx) this["fieldValues[" + objectx + "," + field + "]"] = objectx.getFieldValue(field, -1); } // clean spurious spaces from the field name list - this["fieldNames[" + objectx + "]"] = omni.Util.trim(this["fieldNames[" + objectx + "]"]); + this["fieldNames[" + objectx + "]"] = pInvokes.Util.trim(this["fieldNames[" + objectx + "]"]); // record that we know this object this["objectIds[" + objectx + "]"] = "1"; this["objectIdList"] = this["objectIdList"] + ' ' + objectx; @@ -128,15 +126,15 @@ public bool learn(SimObject objectx) } // trim - this["newFieldNames[" + objectx + "]"] = omni.Util.trim(this["newFieldNames[" + objectx + "]"]); + this["newFieldNames[" + objectx + "]"] = Util.trim(this["newFieldNames[" + objectx + "]"]); // look for differences //---------------------------------------------------------------------- bool diffs = false; string newFieldNames = this["newFieldNames[" + objectx + "]"]; string oldFieldNames = this["fieldNames[" + objectx + "]"]; - int numNewFields = omni.Util.getWordCount(newFieldNames); - int numOldFields = omni.Util.getWordCount(oldFieldNames); + int numNewFields = Util.getWordCount(newFieldNames); + int numOldFields = Util.getWordCount(oldFieldNames); // compare the old field list to the new field list. // if a field is on the old list that isn't on the new list, // add it to the newNullFields list. @@ -385,7 +383,7 @@ public string create(SimSet set, string root) GuiEditorGui.GuiEditor GuiEditor = "GuiEditor"; // Create action object. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); ObjectCreator undoAct = new ObjectCreator("UndoScriptAction", "", typeof (GuiEditorGroupAction)); undoAct["actionName"] = "Group"; undoAct["count"] = 1; @@ -398,7 +396,7 @@ public string create(SimSet set, string root) undoAct["#object"] = groupCreator; GuiEditorGroupAction action = undoAct.Create(); - omni.Util.popInstantGroup(); + Util.popInstantGroup(); // Add objects from set to group. @@ -810,7 +808,7 @@ public string create(SimSet set, string root) { // Create action object. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); ObjectCreator oc = new ObjectCreator("UndoScriptAction", "", typeof (GuiEditorUngroupAction)); oc["actionName"] = "Ungroup"; @@ -845,7 +843,7 @@ public string create(SimSet set, string root) } } - omni.Util.popInstantGroup(); + Util.popInstantGroup(); action.count = groupCount; return action; @@ -1004,12 +1002,12 @@ public virtual T create(SimSet set, string trash, string treeView, bool clear // The instant group will try to add our // UndoAction if we don't disable it. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); UndoScriptAction act = new ObjectCreator("UndoScriptAction", "", typeof (T)).Create(); // Restore the instant group. - omni.Util.popInstantGroup(); + Util.popInstantGroup(); for (uint i = 0; i < set.getCount(); i++) { diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/EditorChooseGUI.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/EditorChooseGUI.ed.cs index 92e9fd64..4f396847 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/EditorChooseGUI.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/EditorChooseGUI.ed.cs @@ -347,32 +347,32 @@ public static void GE_OpenGUIFile() { GuiCanvas Canvas = "Canvas"; - string openFileName = omni.console.Call_Classname("GuiBuilder", "getOpenName"); + string openFileName = console.Call_Classname("GuiBuilder", "getOpenName"); if (openFileName == "") return; // Make sure the file is valid. - if ((!omni.Util.isFile(openFileName)) && (!omni.Util.isFile(openFileName + ".dso"))) + if ((!Util.isFile(openFileName)) && (!Util.isFile(openFileName + ".dso"))) return; // Allow stomping objects while exec'ing the GUI file as we want to // pull the file's objects even if we have another version of the GUI // already loaded. - string oldRedefineBehavior = omni.sGlobal["$Con::redefineBehavior"]; - omni.sGlobal["$Con::redefineBehavior"] = "replaceExisting"; + string oldRedefineBehavior = sGlobal["$Con::redefineBehavior"]; + sGlobal["$Con::redefineBehavior"] = "replaceExisting"; // Load up the level. - SimObject guiContent = omni.Util.eval(openFileName); + SimObject guiContent = Util.eval(openFileName); - omni.sGlobal["$Con::redefineBehavior"] = oldRedefineBehavior; + sGlobal["$Con::redefineBehavior"] = oldRedefineBehavior; // The level file should have contained a scenegraph, which should now be in the instant // group. And, it should be the only thing in the group. //TODO if (!guiContent.isObject()) { - omni.Util.messageBox(omni.console.Call("getEngineName"), "You have loaded a Gui file that was created before this version. It has been loaded but you must open it manually from the content list dropdown", "Ok", "Information"); + Util.messageBox(console.Call("getEngineName"), "You have loaded a Gui file that was created before this version. It has been loaded but you must open it manually from the content list dropdown", "Ok", "Information"); GuiEditorGui.GuiEditContent(Canvas.getContent().AsString()); return; } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorGui.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorGui.ed.cs index 9a16893a..139fd19e 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorGui.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorGui.ed.cs @@ -2023,14 +2023,14 @@ public static void initialize() oc_Newobject78.Create(); - omni.bGlobal["$InGuiEditor"] = false; - omni.bGlobal["$MLAAFxGuiEditorTemp"] = false; + bGlobal["$InGuiEditor"] = false; + bGlobal["$MLAAFxGuiEditorTemp"] = false; ActionMap GlobalActionMap = "GlobalActionMap"; GlobalActionMap.bind("keyboard", "f10", "toggleGuiEditor"); - omni.Util.eval(@"package GuiEditor_BlockDialogs + Util.eval(@"package GuiEditor_BlockDialogs { function GuiCanvas::pushDialog() {} function GuiCanvas::popDialog() {} @@ -2309,7 +2309,7 @@ public static void GuiEdit(string val) if (val != "") return; - if (!omni.bGlobal["$InGuiEditor"]) + if (!bGlobal["$InGuiEditor"]) { GuiEditContent(Canvas.getContent()); @@ -2317,7 +2317,7 @@ public static void GuiEdit(string val) if (MLAAFx.isObject() && MLAAFx.isEnabled) { MLAAFx.isEnabled = false; - omni.bGlobal["$MLAAFxGuiEditorTemp"] = true; + bGlobal["$MLAAFxGuiEditorTemp"] = true; } } else @@ -2335,7 +2335,7 @@ public static void GuiEditContent(SimObject content) GuiEditor.openForEditing(content); - omni.bGlobal["$InGuiEditor"] = true; + bGlobal["$InGuiEditor"] = true; } [ConsoleInteraction] @@ -2352,7 +2352,7 @@ public static void toggleGuiEditor(bool make) // Cancel the scheduled event to prevent // the level from cycling after it's duration // has elapsed. - omni.Util.cancel(omni.iGlobal["$Game::Schedule"]); + Util.cancel(iGlobal["$Game::Schedule"]); } } @@ -2765,7 +2765,7 @@ public void toggleEdgeSnap() GuiBitmapButtonCtrl GuiEditorEdgeSnapping_btn = "GuiEditorEdgeSnapping_btn"; this.snapToEdges = !this.snapToEdges; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_EDGESNAP_INDEX"], this.snapToEdges); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_EDGESNAP_INDEX"], this.snapToEdges); GuiEditorEdgeSnapping_btn.setStateOn(this.snapToEdges); } @@ -2778,7 +2778,7 @@ public void toggleCenterSnap() GuiBitmapButtonCtrl GuiEditorCenterSnapping_btn = "GuiEditorCenterSnapping_btn"; this.snapToCenters = !this.snapToCenters; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_CENTERSNAP_INDEX"], this.snapToCenters); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_CENTERSNAP_INDEX"], this.snapToCenters); GuiEditorCenterSnapping_btn.setStateOn(this.snapToCenters); } @@ -2790,7 +2790,7 @@ public void toggleFullBoxSelection() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.fullBoxSelection = !this.fullBoxSelection; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("EditMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_FULLBOXSELECT_INDEX"], this.fullBoxSelection); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("EditMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_FULLBOXSELECT_INDEX"], this.fullBoxSelection); } //--------------------------------------------------------------------------------------------- @@ -2801,7 +2801,7 @@ public void toggleDrawGuides() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.drawGuides = !this.drawGuides; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_DRAWGUIDES_INDEX"], this.drawGuides); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_DRAWGUIDES_INDEX"], this.drawGuides); } //--------------------------------------------------------------------------------------------- @@ -2812,7 +2812,7 @@ public void toggleGuideSnap() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.snapToGuides = !this["snapToGuides"].AsBool(); - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_GUIDESNAP_INDEX"], this.snapToGuides); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_GUIDESNAP_INDEX"], this.snapToGuides); } //--------------------------------------------------------------------------------------------- @@ -2823,7 +2823,7 @@ public void toggleControlSnap() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.snapToControls = !this.snapToControls; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_CONTROLSNAP_INDEX"], this.snapToControls); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_CONTROLSNAP_INDEX"], this.snapToControls); } //--------------------------------------------------------------------------------------------- @@ -2834,7 +2834,7 @@ public void toggleCanvasSnap() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.snapToCanvas = !this.snapToCanvas; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_CANVASSNAP_INDEX"], this.snapToCanvas); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_CANVASSNAP_INDEX"], this.snapToCanvas); } //--------------------------------------------------------------------------------------------- @@ -2851,7 +2851,7 @@ public void toggleGridSnap() else this.setSnapToGrid(this["snap2GridSize"].AsUint()); - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_GRIDSNAP_INDEX"], this.snap2Grid); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_GRIDSNAP_INDEX"], this.snap2Grid); GuiEditorSnapCheckBox.setStateOn(this.snap2Grid); } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorPrefsDlg.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorPrefsDlg.ed.cs index c13c6f1e..de435108 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorPrefsDlg.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorPrefsDlg.ed.cs @@ -281,8 +281,8 @@ public static void initialize() oc_Newobject9.Create(); - omni.iGlobal["$GuiEditor::defaultGridSize"] = 8; - omni.iGlobal["$GuiEditor::minGridSize"] = 3; + iGlobal["$GuiEditor::defaultGridSize"] = 8; + iGlobal["$GuiEditor::minGridSize"] = 3; } //----------------------------------------------------------------------------------------- diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/CodeBehind/MeshRoadEditorPlugin.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/CodeBehind/MeshRoadEditorPlugin.cs index 57b0051b..404185b9 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/CodeBehind/MeshRoadEditorPlugin.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/CodeBehind/MeshRoadEditorPlugin.cs @@ -42,6 +42,7 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; +using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.MeshRoadEditor.gui.CodeBehind @@ -95,7 +96,7 @@ public override void onWorldEditorStartup() // Add ourselves to the Editor Settings window //exec( "./meshRoadEditorSettingsTab.gui" ); - omni.console.Call("MeshRoadEditorSettingsTab_initialize"); + pInvokes.console.Call("MeshRoadEditorSettingsTab_initialize"); ESettingsWindow.addTabPage("EMeshRoadEditorSettingsPage"); } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/MeshRoadEditorGui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/MeshRoadEditorGui.cs index 3296e983..d074d725 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/MeshRoadEditorGui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/MeshRoadEditorGui.cs @@ -530,18 +530,18 @@ public static void initialize() oc_Newobject21.Create(); - omni.bGlobal["$MeshRoad::wireframe"] = true; - omni.bGlobal["$MeshRoad::showSpline"] = true; - omni.bGlobal["$MeshRoad::showReflectPlane"] = false; - omni.bGlobal["$MeshRoad::showRoad"] = true; - omni.dGlobal["$MeshRoad::breakAngle"] = 3.0; + bGlobal["$MeshRoad::wireframe"] = true; + bGlobal["$MeshRoad::showSpline"] = true; + bGlobal["$MeshRoad::showReflectPlane"] = false; + bGlobal["$MeshRoad::showRoad"] = true; + dGlobal["$MeshRoad::breakAngle"] = 3.0; } [ConsoleInteraction] public override void onWake() { EWorldEditor EWorldEditor = "EWorldEditor"; - omni.bGlobal["$MeshRoad::EditorOpen"] = true; + bGlobal["$MeshRoad::EditorOpen"] = true; int count = EWorldEditor.getSelectionSize(); for (int i = 0; i < count; i++) @@ -561,7 +561,7 @@ public override void onWake() [ConsoleInteraction] public override void onSleep() { - omni.bGlobal["$MeshRoad::EditorOpen"] = false; + bGlobal["$MeshRoad::EditorOpen"] = false; } [ConsoleInteraction] @@ -591,7 +591,7 @@ public override void onRoadSelected(string road) // Update the materialEditorList if (road.isObject()) - omni.sGlobal["$Tools::materialEditorList"] = road; + sGlobal["$Tools::materialEditorList"] = road; else return; @@ -700,7 +700,7 @@ public void onBrowseClicked() if (dr == DialogResult.OK) { string fileName = Dialogs.GetForwardSlashFile(ofd.FileName); - this["lastPath"] = omni.console.Call("filePath", new string[] {fileName}); + this["lastPath"] = console.Call("filePath", new string[] {fileName}); //string filename = dlg["FileName"]; //TODO diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/CreateNewNavMeshDlg.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/CreateNewNavMeshDlg.cs index d56a985f..c357f4b1 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/CreateNewNavMeshDlg.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/CreateNewNavMeshDlg.cs @@ -50,8 +50,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.NavEditor.gui [TypeConverter(typeof (TypeConverterGeneric))] public class CreateNewNavMeshDlg : GuiControl { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { ObjectCreator oc_Newobject00011; @@ -432,7 +430,7 @@ public static string MissionBoundsExtents(SimSet group) string wbox = "0 0 0 0 0 0"; if (cls == "SimGroup" || cls == "SimSet" || cls == "Path") wbox = MissionBoundsExtents((SimSet) obj); - else if (obj.GetType() == typeof (SceneObject) && ((SceneObject) obj).getType() == omni.iGlobal["$TypeMasks::StaticObjectType"] && !(((SceneObject) obj).getType() == omni.iGlobal["$TypeMasks::EnvironmentObjectType"])) + else if (obj.GetType() == typeof (SceneObject) && ((SceneObject) obj).getType() == iGlobal["$TypeMasks::StaticObjectType"] && !(((SceneObject) obj).getType() == iGlobal["$TypeMasks::EnvironmentObjectType"])) wbox = ((SceneObject) obj).getWorldBox().AsString(); else continue; @@ -440,14 +438,14 @@ public static string MissionBoundsExtents(SimSet group) // Update min point. for (int j = 0; j < 3; j++) { - if (omni.Util.getWord(box, j).AsInt() > omni.Util.getWord(wbox, j).AsInt()) - box = omni.Util.setWord(box, j, omni.Util.getWord(wbox, j)); + if (Util.getWord(box, j).AsInt() > Util.getWord(wbox, j).AsInt()) + box = Util.setWord(box, j, Util.getWord(wbox, j)); } // Update max point. for (int j = 3; j < 6; j++) { - if (omni.Util.getWord(box, j).AsInt() < omni.Util.getWord(wbox, j).AsInt()) - box = omni.Util.setWord(box, j, omni.Util.getWord(wbox, j)); + if (Util.getWord(box, j).AsInt() < Util.getWord(wbox, j).AsInt()) + box = Util.setWord(box, j, Util.getWord(wbox, j)); } } return box; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/NavEditorGui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/NavEditorGui.cs index def6f16d..07c5fce5 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/NavEditorGui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/NavEditorGui.cs @@ -50,8 +50,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.NavEditor.gui [TypeConverter(typeof (TypeConverterGeneric))] public class NavEditorGui : GuiNavEditorCtrl { - private static readonly pInvokes omni = new pInvokes(); - public NavMesh selectedObject { get { return this["selectedObject"]; } @@ -1308,13 +1306,13 @@ public static void initialize() oc_Newobject00056.Create(); } - omni.bGlobal["$Nav::EditorOpen"] = false; - omni.bGlobal["$Nav::Editor::renderMesh"] = true; - omni.bGlobal["$Nav::Editor::renderPortals"] = false; - omni.bGlobal["$Nav::Editor::renderBVTree"] = false; - omni.bGlobal["$Nav::Editor::backgroundBuild"] = true; - omni.bGlobal["$Nav::Editor::saveIntermediates"] = false; - omni.bGlobal["$Nav::Editor::playSoundWhenDone"] = false; + bGlobal["$Nav::EditorOpen"] = false; + bGlobal["$Nav::Editor::renderMesh"] = true; + bGlobal["$Nav::Editor::renderPortals"] = false; + bGlobal["$Nav::Editor::renderBVTree"] = false; + bGlobal["$Nav::Editor::backgroundBuild"] = true; + bGlobal["$Nav::Editor::saveIntermediates"] = false; + bGlobal["$Nav::Editor::playSoundWhenDone"] = false; } [ConsoleInteraction] @@ -1493,12 +1491,12 @@ public static void updateLinkData(GuiControl control, int flags) LinkClimbFlag.setActive(true); LinkTeleportFlag.setActive(true); - LinkWalkFlag.setStateOn(flags == omni.iGlobal["$Nav::WalkFlag"]); - LinkJumpFlag.setStateOn(flags == omni.iGlobal["$Nav::JumpFlag"]); - LinkDropFlag.setStateOn(flags == omni.iGlobal["$Nav::DropFlag"]); - LinkLedgeFlag.setStateOn(flags == omni.iGlobal["$Nav::LedgeFlag"]); - LinkClimbFlag.setStateOn(flags == omni.iGlobal["$Nav::ClimbFlag"]); - LinkTeleportFlag.setStateOn(flags == omni.iGlobal["$Nav::TeleportFlag"]); + LinkWalkFlag.setStateOn(flags == iGlobal["$Nav::WalkFlag"]); + LinkJumpFlag.setStateOn(flags == iGlobal["$Nav::JumpFlag"]); + LinkDropFlag.setStateOn(flags == iGlobal["$Nav::DropFlag"]); + LinkLedgeFlag.setStateOn(flags == iGlobal["$Nav::LedgeFlag"]); + LinkClimbFlag.setStateOn(flags == iGlobal["$Nav::ClimbFlag"]); + LinkTeleportFlag.setStateOn(flags == iGlobal["$Nav::TeleportFlag"]); } [ConsoleInteraction] @@ -1511,7 +1509,7 @@ public static int getLinkFlags(GuiControl control) GuiCheckBoxCtrl LinkClimbFlag = control.FOT("LinkClimbFlag"); GuiCheckBoxCtrl LinkTeleportFlag = control.FOT("LinkTeleportFlag"); - return (LinkWalkFlag.isStateOn() ? omni.iGlobal["$Nav::WalkFlag"] : 0) | (LinkJumpFlag.isStateOn() ? omni.iGlobal["$Nav::JumpFlag"] : 0) | (LinkDropFlag.isStateOn() ? omni.iGlobal["$Nav::DropFlag"] : 0) | (LinkLedgeFlag.isStateOn() ? omni.iGlobal["$Nav::LedgeFlag"] : 0) | (LinkClimbFlag.isStateOn() ? omni.iGlobal["$Nav::ClimbFlag"] : 0) | (LinkTeleportFlag.isStateOn() ? omni.iGlobal["$Nav::TeleportFlag"] : 0); + return (LinkWalkFlag.isStateOn() ? iGlobal["$Nav::WalkFlag"] : 0) | (LinkJumpFlag.isStateOn() ? iGlobal["$Nav::JumpFlag"] : 0) | (LinkDropFlag.isStateOn() ? iGlobal["$Nav::DropFlag"] : 0) | (LinkLedgeFlag.isStateOn() ? iGlobal["$Nav::LedgeFlag"] : 0) | (LinkClimbFlag.isStateOn() ? iGlobal["$Nav::ClimbFlag"] : 0) | (LinkTeleportFlag.isStateOn() ? iGlobal["$Nav::TeleportFlag"] : 0); } [ConsoleInteraction] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/main.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/main.cs index 131cf672..4bbc3ce2 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/main.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/main.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -44,20 +44,18 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.NavEditor { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializeNavEditor() { - omni.Util._echo(" % - Initializing Navigation Editor"); + pInvokes.Util._echo(" % - Initializing Navigation Editor"); - omni.iGlobal["$Nav::WalkFlag"] = 1 << 0; - omni.iGlobal["$Nav::SwimFlag"] = 1 << 1; - omni.iGlobal["$Nav::JumpFlag"] = 1 << 2; - omni.iGlobal["$Nav::LedgeFlag"] = 1 << 3; - omni.iGlobal["$Nav::DropFlag"] = 1 << 4; - omni.iGlobal["$Nav::ClimbFlag"] = 1 << 5; - omni.iGlobal["$Nav::TeleportFlag"] = 1 << 6; + pInvokes.iGlobal["$Nav::WalkFlag"] = 1 << 0; + pInvokes.iGlobal["$Nav::SwimFlag"] = 1 << 1; + pInvokes.iGlobal["$Nav::JumpFlag"] = 1 << 2; + pInvokes.iGlobal["$Nav::LedgeFlag"] = 1 << 3; + pInvokes.iGlobal["$Nav::DropFlag"] = 1 << 4; + pInvokes.iGlobal["$Nav::ClimbFlag"] = 1 << 5; + pInvokes.iGlobal["$Nav::TeleportFlag"] = 1 << 6; // Execute all relevant scripts and GUIs. //exec("./NavEditor.cs"); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleEmitterEditor.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleEmitterEditor.ed.cs index a6c1e75a..1b209a2b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleEmitterEditor.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleEmitterEditor.ed.cs @@ -49,12 +49,10 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.ParticleEditor.gui.Cod { public class ParticleEmitterEditor { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ParticleEmitterEditor_initialize")] public static void initialize() { - omni.sGlobal["$PE_EMITTEREDITOR_DEFAULT_FILENAME"] = "art/particles/managedParticleEmitterData.cs"; + pInvokes.sGlobal["$PE_EMITTEREDITOR_DEFAULT_FILENAME"] = "art/particles/managedParticleEmitterData.cs"; } //============================================================================================= diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleParticleEditor.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleParticleEditor.cs index a73a4942..1a28bd4c 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleParticleEditor.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleParticleEditor.cs @@ -49,12 +49,10 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.ParticleEditor.gui.Cod { public class ParticleParticleEditor { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ParticleParticleEditor_intialize")] public static void initialize() { - omni.sGlobal["$PE_PARTICLEEDITOR_DEFAULT_FILENAME"] = "art/particles/managedParticleData.cs"; + pInvokes.sGlobal["$PE_PARTICLEEDITOR_DEFAULT_FILENAME"] = "art/particles/managedParticleData.cs"; } //============================================================================================= diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/ParticleEditor.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/ParticleEditor.ed.cs index 9679a5a7..eab5097d 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/ParticleEditor.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/ParticleEditor.ed.cs @@ -54,21 +54,21 @@ public class ParticleEditor : ScriptObject [ConsoleInteraction(true, "ParticleEditor_initialize")] public static void initialize() { - omni.sGlobal["$PE_guielement_pos_single_container"] = "0 0"; - omni.sGlobal["$PE_guielement_ext_single_container"] = "184 20"; - omni.sGlobal["$PE_guielement_pos_name"] = "1 0"; - omni.sGlobal["$PE_guielement_ext_name"] = "70 18"; - omni.sGlobal["$PE_guielement_pos_slider"] = "74 2"; - omni.sGlobal["$PE_guielement_ext_slider"] = "58 12"; - omni.sGlobal["$PE_guielement_pos_value"] = "138 0"; - omni.sGlobal["$PE_guielement_ext_value"] = "36 18"; - omni.sGlobal["$PE_guielement_pos_textedit"] = "74 0"; - omni.sGlobal["$PE_guielement_ext_textedit"] = "100 18"; - omni.sGlobal["$PE_guielement_ext_checkbox_name"] = "156 18"; - omni.sGlobal["$PE_guielement_pos_checkbox"] = "161 0"; - omni.sGlobal["$PE_guielement_ext_checkbox"] = "15 18"; - omni.sGlobal["$PE_guielement_pos_colorpicker"] = "158 0"; - omni.sGlobal["$PE_guielement_ext_colorpicker"] = "18 18"; + sGlobal["$PE_guielement_pos_single_container"] = "0 0"; + sGlobal["$PE_guielement_ext_single_container"] = "184 20"; + sGlobal["$PE_guielement_pos_name"] = "1 0"; + sGlobal["$PE_guielement_ext_name"] = "70 18"; + sGlobal["$PE_guielement_pos_slider"] = "74 2"; + sGlobal["$PE_guielement_ext_slider"] = "58 12"; + sGlobal["$PE_guielement_pos_value"] = "138 0"; + sGlobal["$PE_guielement_ext_value"] = "36 18"; + sGlobal["$PE_guielement_pos_textedit"] = "74 0"; + sGlobal["$PE_guielement_ext_textedit"] = "100 18"; + sGlobal["$PE_guielement_ext_checkbox_name"] = "156 18"; + sGlobal["$PE_guielement_pos_checkbox"] = "161 0"; + sGlobal["$PE_guielement_ext_checkbox"] = "15 18"; + sGlobal["$PE_guielement_pos_colorpicker"] = "158 0"; + sGlobal["$PE_guielement_ext_colorpicker"] = "18 18"; #region GuiWindowCollapseCtrl (PE_Window) oc_Newobject243 diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/CodeBehind/RiverEditorPlugin.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/CodeBehind/RiverEditorPlugin.cs index be8492ab..bdb9d8e0 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/CodeBehind/RiverEditorPlugin.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/CodeBehind/RiverEditorPlugin.cs @@ -116,7 +116,7 @@ public override void onActivated() //Copyright Winterleaf Entertainment L.L.C. 2013 this.readSettings(); - omni.bGlobal["$River::EditorOpen"] = true; + bGlobal["$River::EditorOpen"] = true; ((GuiBitmapButtonCtrl) ((GuiDynamicCtrlArrayControl) "ToolsPaletteArray").findObjectByInternalName("RiverEditorAddRiverMode", false)).performClick(); EditorGui.bringToFront("RiverEditorGui"); @@ -166,7 +166,7 @@ public override void onDeactivated() this.writeSettings(); - omni.bGlobal["$River::EditorOpen"] = false; + bGlobal["$River::EditorOpen"] = false; RiverEditorGui.setVisible(false); RiverEditorToolbar.setVisible(false); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/RiverEditorGui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/RiverEditorGui.cs index 013eef3d..531fd5ee 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/RiverEditorGui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/RiverEditorGui.cs @@ -533,11 +533,11 @@ public static void initialize() oc_Newobject21.Create(); - omni.bGlobal["$River::EditorOpen"] = false; - omni.bGlobal["$River::wireframe"] = true; - omni.bGlobal["$River::showSpline"] = true; - omni.bGlobal["$River::showRiver"] = true; - omni.bGlobal["$River::showWalls"] = true; + bGlobal["$River::EditorOpen"] = false; + bGlobal["$River::wireframe"] = true; + bGlobal["$River::showSpline"] = true; + bGlobal["$River::showRiver"] = true; + bGlobal["$River::showWalls"] = true; } [ConsoleInteraction] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/CodeBehind/RoadEditorPlugin.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/CodeBehind/RoadEditorPlugin.cs index 35c02bc4..886ae47b 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/CodeBehind/RoadEditorPlugin.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/CodeBehind/RoadEditorPlugin.cs @@ -43,6 +43,7 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; +using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.RoadEditor.gui.CodeBehind @@ -87,14 +88,14 @@ public override void onWorldEditorStartup() // Add ourselves to the ToolsToolbar string tooltip = "Road Editor (" + accel + ")"; - EditorGui.addToToolsToolbar("RoadEditorPlugin", "RoadEditorPalette", omni.Util._expandFilename("tools/worldEditor/images/toolbar/road-path-editor"), tooltip); + EditorGui.addToToolsToolbar("RoadEditorPlugin", "RoadEditorPalette", pInvokes.Util._expandFilename("tools/worldEditor/images/toolbar/road-path-editor"), tooltip); //connect editor windows ((GuiWindowCollapseCtrl) "RoadEditorOptionsWindow").attachTo("RoadEditorTreeWindow"); // Add ourselves to the Editor Settings window //exec( "./RoadEditorSettingsTab.gui" ); - omni.console.Call("RoadEditorSettingsTab_initialize"); + pInvokes.console.Call("RoadEditorSettingsTab_initialize"); ((ESettingsWindow) "ESettingsWindow").addTabPage("ERoadEditorSettingsPage"); } @@ -210,7 +211,7 @@ public override void onSaveMission(string missionFile) public override bool? setEditorFunction(string overrideGroup = "") { bool terrainExists = AggregateControl.parseMissionGroup("TerrainBlock"); - // omni.console.Call("parseMissionGroup", new string[] { "TerrainBlock" }).AsBool(); + // pInvokes.console.Call("parseMissionGroup", new string[] { "TerrainBlock" }).AsBool(); if (terrainExists == false) messageBox.MessageBoxYesNoCancel("No Terrain", "Would you like to create a New Terrain?", "Canvas.pushDialog(CreateNewTerrainGui);"); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/RoadEditorGui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/RoadEditorGui.cs index 1c9c1796..4833eace 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/RoadEditorGui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/RoadEditorGui.cs @@ -493,7 +493,7 @@ public override void onWake() { EWorldEditor EWorldEditor = "EWorldEditor"; - omni.bGlobal["$DecalRoad::EditorOpen"] = true; + bGlobal["$DecalRoad::EditorOpen"] = true; int count = EWorldEditor.getSelectionSize(); for (uint i = 0; i < count; i++) @@ -511,7 +511,7 @@ public override void onWake() [ConsoleInteraction] public override void onSleep() { - omni.bGlobal["$DecalRoad::EditorOpen"] = false; + bGlobal["$DecalRoad::EditorOpen"] = false; } [ConsoleInteraction] @@ -560,7 +560,7 @@ public override void onRoadSelected(string road) // Update the materialEditorList if (road.isObject()) - omni.sGlobal["$Tools::materialEditorList"] = road; + sGlobal["$Tools::materialEditorList"] = road; else return; @@ -640,7 +640,7 @@ public void onBrowseClicked() if (dr == DialogResult.OK) { string fileName = Dialogs.GetForwardSlashFile(ofd.FileName); - this["lastPath"] = omni.console.Call("filePath", new string[] {fileName}); + this["lastPath"] = console.Call("filePath", new string[] {fileName}); //string filename = fileName; //TODO diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditor.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditor.ed.cs index bb03287d..98ecda5d 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditor.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditor.ed.cs @@ -90,8 +90,8 @@ public static void initialize() [ConsoleInteraction] public static string strcapitalise(string str) { - int len = omni.Util.strlen(str); - return omni.Util.strupr(omni.Util.getSubStr(str, 0, 1)) + omni.Util.getSubStr(str, 1, len - 1); + int len = Util.strlen(str); + return Util.strupr(Util.getSubStr(str, 0, 1)) + Util.getSubStr(str, 1, len - 1); } [ConsoleInteraction] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorActions.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorActions.ed.cs index e92899b5..80e39923 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorActions.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorActions.ed.cs @@ -49,8 +49,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.ShapeEditor.gui.CodeBe { public class ShapeEditorActions { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ShapeEditorActions_initialize")] public static void initialize() { diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorPlugin.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorPlugin.cs index d6938183..668df51d 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorPlugin.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorPlugin.cs @@ -53,8 +53,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.ShapeEditor.gui.CodeBe [TypeConverter(typeof (TypeConverterGeneric))] public class ShapeEditorPlugin : EditorPlugin { - private static readonly pInvokes omni = new pInvokes(); - internal ActionMap map { get { return this["map"]; } @@ -424,8 +422,8 @@ public static void shapeEditorWireframeMode() ShapeEditorToolbar ShapeEditorToolbar = "ShapeEditorToolbar"; GuiBitmapButtonCtrl wireframeMode = ShapeEditorToolbar.FOT("wireframeMode"); - omni.bGlobal["$gfx::wireframe"] = !omni.bGlobal["$gfx::wireframe"]; - wireframeMode.setStateOn(omni.bGlobal["$gfx::wireframe"]); + bGlobal["$gfx::wireframe"] = !bGlobal["$gfx::wireframe"]; + wireframeMode.setStateOn(bGlobal["$gfx::wireframe"]); } //----------------------------------------------------------------------------- diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/MenuHandlers.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/MenuHandlers.ed.cs index 1dc78c6d..60be4998 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/MenuHandlers.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/MenuHandlers.ed.cs @@ -60,12 +60,10 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor { public class MenuHandlers { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "MenuHandlers_initialize")] public static void initialize() { - omni.sGlobal["$Pref::WorldEditor::FileSpec"] = "Torque Mission Files (*.mis)|*.mis|All Files (*.*)|*.*"; + pInvokes.sGlobal["$Pref::WorldEditor::FileSpec"] = "Torque Mission Files (*.mis)|*.mis|All Files (*.*)|*.*"; // Package that gets temporarily activated to toggle editor after mission loading. // Deactivates itself. @@ -80,9 +78,9 @@ public static void initialize() } };"; - omni.Util.eval(package); + pInvokes.Util.eval(package); - //omni.Util.deactivatePackage("BootEditor"); + //pInvokes.Util.deactivatePackage("BootEditor"); } /// Checks the various dirty flags and returns true if the @@ -133,16 +131,16 @@ public static void EditorClearDirty() [ConsoleInteraction] public static void EditorQuitGame() { - if (EditorIsDirty() && !omni.Util.isWebDemo()) + if (EditorIsDirty() && !pInvokes.Util.isWebDemo()) messageBox.MessageBoxYesNoCancel("Level Modified", "Would you like to save your changes before quitting?", "EditorSaveMissionMenu(); quit();", "quit();", ""); else - omni.console.Call("quit"); + pInvokes.console.Call("quit"); } [ConsoleInteraction] public static void EditorExitMission() { - if (EditorIsDirty() && !omni.Util.isWebDemo()) + if (EditorIsDirty() && !pInvokes.Util.isWebDemo()) messageBox.MessageBoxYesNoCancel("Level Modified", "Would you like to save your changes before exiting?", "EditorDoExitMission(true);", "EditorDoExitMission(false);", ""); else EditorDoExitMission(false); @@ -154,7 +152,7 @@ public static void EditorDoExitMission(bool saveFirst) GuiChunkedBitmapCtrl MainMenuGui = "MainMenuGui"; editor Editor = "Editor"; - if (saveFirst && !omni.Util.isWebDemo()) + if (saveFirst && !pInvokes.Util.isWebDemo()) EditorSaveMissionMenu(); else EditorClearDirty(); @@ -162,7 +160,7 @@ public static void EditorDoExitMission(bool saveFirst) if (MainMenuGui.isObject()) Editor.close(MainMenuGui); - omni.console.Call("disconnect"); + pInvokes.console.Call("disconnect"); } [ConsoleInteraction] @@ -173,7 +171,7 @@ public static void EditorOpenTorsionProject(string projectFile) // Make sure we have a valid path to the Torsion installation. string torsionPath = EditorSettings.value("WorldEditor/torsionPath"); - if (!omni.Util.isFile(torsionPath)) + if (!pInvokes.Util.isFile(torsionPath)) { messageBox.MessageBoxOK("Torsion Not Found", "Torsion not found at '" + torsionPath + "'. Please set the correct path in the preferences."); return; @@ -183,14 +181,14 @@ public static void EditorOpenTorsionProject(string projectFile) if (projectFile == "") { - string projectName = omni.Util.fileBase(omni.Util.getExecutableName()); - projectFile = omni.Util.makeFullPath(projectName + ".torsion", ""); - if (!omni.Util.isFile(projectFile)) + string projectName = pInvokes.Util.fileBase(pInvokes.Util.getExecutableName()); + projectFile = pInvokes.Util.makeFullPath(projectName + ".torsion", ""); + if (!pInvokes.Util.isFile(projectFile)) { - projectFile = omni.Util.findFirstFile("*.torsion", false); - if (!omni.Util.isFile(projectFile)) + projectFile = pInvokes.Util.findFirstFile("*.torsion", false); + if (!pInvokes.Util.isFile(projectFile)) { - messageBox.MessageBoxOK("Project File Not Found", "Cannot find .torsion project file in '" + omni.Util.getMainDotCsDir() + "'."); + messageBox.MessageBoxOK("Project File Not Found", "Cannot find .torsion project file in '" + pInvokes.Util.getMainDotCsDir() + "'."); return; } } @@ -198,7 +196,7 @@ public static void EditorOpenTorsionProject(string projectFile) // Open the project in Torsion. - omni.Util.shellExecute(torsionPath, "\"" + projectFile + "\""); + pInvokes.Util.shellExecute(torsionPath, "\"" + projectFile + "\""); } [ConsoleInteraction] @@ -209,7 +207,7 @@ public static void EditorOpenFileInTorsion(string file, string line) // Make sure we have a valid path to the Torsion installation. string torsionPath = EditorSettings.value("WorldEditor/torsionPath"); - if (!omni.Util.isFile(torsionPath)) + if (!pInvokes.Util.isFile(torsionPath)) { messageBox.MessageBoxOK("Torsion Not Found", "Torsion not found at '" + torsionPath + "'. Please set the correct path in the preferences."); return; @@ -218,7 +216,7 @@ public static void EditorOpenFileInTorsion(string file, string line) // If no file was specified, take the current mission file. if (file == "") - file = omni.Util.makeFullPath(omni.sGlobal["$Server::MissionFile"], ""); + file = pInvokes.Util.makeFullPath(pInvokes.sGlobal["$Server::MissionFile"], ""); // Open the file in Torsion. @@ -227,7 +225,7 @@ public static void EditorOpenFileInTorsion(string file, string line) args = args + ":" + line; args = args + "\""; - omni.Util.shellExecute(torsionPath, args); + pInvokes.Util.shellExecute(torsionPath, args); } [ConsoleInteraction] @@ -237,7 +235,7 @@ public static void EditorOpenDeclarationInTorsion(SimObject xobject) if (fileName == "") return; - EditorOpenFileInTorsion(omni.Util.makeFullPath(fileName, "'"), xobject.getDeclarationLine().AsString()); + EditorOpenFileInTorsion(pInvokes.Util.makeFullPath(fileName, "'"), xobject.getDeclarationLine().AsString()); } [ConsoleInteraction] @@ -247,14 +245,14 @@ public static void EditorNewLevel(string file) EditorGui EditorGui = "EditorGui"; Settings EditorSettings = "EditorSettings"; - if (omni.Util.isWebDemo()) + if (pInvokes.Util.isWebDemo()) return; bool saveFirst = false; if (EditorIsDirty()) { - omni.Util._error("knob"); - saveFirst = omni.Util.messageBox("Mission Modified", "Would you like to save changes to the current mission \"" + omni.sGlobal["$Server::MissionFile"] + "\" before creating a new mission?", "SaveDontSave", "Question") == omni.iGlobal["$MROk"]; + pInvokes.Util._error("knob"); + saveFirst = pInvokes.Util.messageBox("Mission Modified", "Would you like to save changes to the current mission \"" + pInvokes.sGlobal["$Server::MissionFile"] + "\" before creating a new mission?", "SaveDontSave", "Question") == pInvokes.iGlobal["$MROk"]; } if (saveFirst) @@ -270,9 +268,9 @@ public static void EditorNewLevel(string file) if (file == "") file = EditorSettings.value("WorldEditor/newLevelFile"); - if (!omni.bGlobal["$missionRunning"]) + if (!pInvokes.bGlobal["$missionRunning"]) { - omni.Util.activatePackage("BootEditor"); + pInvokes.Util.activatePackage("BootEditor"); chooseLevelDlg.StartLevel(file, ""); } else @@ -288,7 +286,7 @@ public static void EditorSaveMissionMenu() { EditorGui EditorGui = "EditorGui"; - if (!omni.bGlobal["$Pref::disableSaving"] && !omni.Util.isWebDemo()) + if (!pInvokes.bGlobal["$Pref::disableSaving"] && !pInvokes.Util.isWebDemo()) { if (EditorGui["saveAs"].AsBool()) EditorSaveMissionAs(""); @@ -312,22 +310,22 @@ public static bool EditorSaveMission() // just save the mission without renaming it // first check for dirty and read-only files: - if ((EWorldEditor.isDirty || ETerrainEditor.isMissionDirty) && !omni.Util.isWriteableFileName(omni.sGlobal["$Server::MissionFile"])) + if ((EWorldEditor.isDirty || ETerrainEditor.isMissionDirty) && !pInvokes.Util.isWriteableFileName(pInvokes.sGlobal["$Server::MissionFile"])) { - omni.Util.messageBox("Error", "Mission file \"" + omni.sGlobal["$Server::MissionFile"] + "\" is read-only. Continue?", "Ok", "Stop"); + pInvokes.Util.messageBox("Error", "Mission file \"" + pInvokes.sGlobal["$Server::MissionFile"] + "\" is read-only. Continue?", "Ok", "Stop"); return false; } if (ETerrainEditor.isDirty) { // Find all of the terrain files - omni.Util.initContainerTypeSearch(omni.uGlobal["$TypeMasks::TerrainObjectType"], false); + pInvokes.Util.initContainerTypeSearch(pInvokes.uGlobal["$TypeMasks::TerrainObjectType"], false); TerrainBlock terrainObject; - while ((terrainObject = omni.Util.containerSearchNext(false)) != 0) + while ((terrainObject = pInvokes.Util.containerSearchNext(false)) != 0) { - if (!omni.Util.isWriteableFileName(terrainObject["terrainFile"])) + if (!pInvokes.Util.isWriteableFileName(terrainObject["terrainFile"])) { - if (omni.Util.messageBox("Error", "Terrain file \"" + terrainObject["terrainFile"] + "\" is read-only. Continue?", "Ok", "Stop") == omni.iGlobal["$MROk"]) + if (pInvokes.Util.messageBox("Error", "Terrain file \"" + terrainObject["terrainFile"] + "\" is read-only. Continue?", "Ok", "Stop") == pInvokes.iGlobal["$MROk"]) continue; else return false; @@ -338,14 +336,14 @@ public static bool EditorSaveMission() // now write the terrain and mission files out: if (EWorldEditor.isDirty || ETerrainEditor["isMissionDirty"].AsBool()) - MissionGroup.save(omni.sGlobal["$Server::MissionFile"], false, ""); + MissionGroup.save(pInvokes.sGlobal["$Server::MissionFile"], false, ""); if (ETerrainEditor["isDirty"].AsBool()) { // Find all of the terrain files - omni.Util.initContainerTypeSearch(omni.uGlobal["$TypeMasks::TerrainObjectType"], false); + pInvokes.Util.initContainerTypeSearch(pInvokes.uGlobal["$TypeMasks::TerrainObjectType"], false); TerrainBlock terrainObject; - while ((terrainObject = omni.Util.containerSearchNext(false)) != 0) + while ((terrainObject = pInvokes.Util.containerSearchNext(false)) != 0) terrainObject.save(terrainObject["terrainFile"]); } @@ -356,7 +354,7 @@ public static bool EditorSaveMission() { EditorPlugin obj = EditorPluginSet.getObject(i); if (obj.isDirty()) - obj.onSaveMission(omni.sGlobal["$Server::MissionFile"]); + obj.onSaveMission(pInvokes.sGlobal["$Server::MissionFile"]); } EditorClearDirty(); @@ -388,13 +386,13 @@ public static void EditorSaveMissionAs(string missionName) EditorGui EditorGui = "EditorGui"; TerrainEditor ETerrainEditor = "ETerrainEditor"; - if (!omni.bGlobal["$Pref::disableSaving"] && !omni.Util.isWebDemo()) + if (!pInvokes.bGlobal["$Pref::disableSaving"] && !pInvokes.Util.isWebDemo()) { // If we didn't get passed a new mission name then // prompt the user for one. if (missionName == "") { - SaveFileDialog sfd = new SaveFileDialog {Filter = omni.sGlobal["$Pref::WorldEditor::FileSpec"], InitialDirectory = Path.Combine(Environment.CurrentDirectory, EditorSettings.value("LevelInformation/levelsDirectory")), OverwritePrompt = true,}; + SaveFileDialog sfd = new SaveFileDialog {Filter = pInvokes.sGlobal["$Pref::WorldEditor::FileSpec"], InitialDirectory = Path.Combine(Environment.CurrentDirectory, EditorSettings.value("LevelInformation/levelsDirectory")), OverwritePrompt = true,}; DialogResult dr = Dialogs.SaveFileDialog(ref sfd); @@ -403,7 +401,7 @@ public static void EditorSaveMissionAs(string missionName) case DialogResult.OK: string filename = Dialogs.GetForwardSlashFile(sfd.FileName); // Immediately override/set the levelsDirectory - EditorSettings.setValue("LevelInformation/levelsDirectory", omni.console.Call("collapseFilename", new string[] {omni.Util.filePath(filename)})); + EditorSettings.setValue("LevelInformation/levelsDirectory", pInvokes.console.Call("collapseFilename", new string[] {pInvokes.Util.filePath(filename)})); missionName = filename; break; @@ -416,36 +414,36 @@ public static void EditorSaveMissionAs(string missionName) } } - if (omni.Util.fileExt(missionName) != ".mis") + if (pInvokes.Util.fileExt(missionName) != ".mis") missionName = missionName + ".mis"; EWorldEditor.isDirty = true; - string saveMissionFile = omni.sGlobal["$Server::MissionFile"]; + string saveMissionFile = pInvokes.sGlobal["$Server::MissionFile"]; - omni.sGlobal["$Server::MissionFile"] = missionName; + pInvokes.sGlobal["$Server::MissionFile"] = missionName; bool copyTerrainsFailed = false; // Rename all the terrain files. Save all previous names so we can // reset them if saving fails. - string newMissionName = omni.Util.fileBase(missionName); - string oldMissionName = omni.Util.fileBase(saveMissionFile); + string newMissionName = pInvokes.Util.fileBase(missionName); + string oldMissionName = pInvokes.Util.fileBase(saveMissionFile); - omni.Util.initContainerTypeSearch(omni.uGlobal["$TypeMasks::TerrainObjectType"]); + pInvokes.Util.initContainerTypeSearch(pInvokes.uGlobal["$TypeMasks::TerrainObjectType"]); ScriptObject savedTerrNames = new ObjectCreator("ScriptObject").Create(); for (int i = 0;; i++) { - string nterrainObject = omni.Util.containerSearchNext(false); + string nterrainObject = pInvokes.Util.containerSearchNext(false); if (nterrainObject == "") break; - TerrainBlock terrainObject = nterrainObject; //omni.Util.containerSearchNext(false); + TerrainBlock terrainObject = nterrainObject; //pInvokes.Util.containerSearchNext(false); //if (terrainObject == null) // break; savedTerrNames["array[" + i + "]"] = terrainObject["terrainFile"]; - string terrainFilePath = omni.Util.makeRelativePath(omni.Util.filePath(terrainObject["terrainFile"]), omni.Util.getMainDotCsDir()); - string terrainFileName = omni.Util.fileName(terrainObject["terrainFile"]); + string terrainFilePath = pInvokes.Util.makeRelativePath(pInvokes.Util.filePath(terrainObject["terrainFile"]), pInvokes.Util.getMainDotCsDir()); + string terrainFileName = pInvokes.Util.fileName(terrainObject["terrainFile"]); // Workaround to have terrains created in an unsaved "New Level..." mission // moved to the correct place. @@ -455,16 +453,16 @@ public static void EditorSaveMissionAs(string missionName) // Try and follow the existing naming convention. // If we can't, use systematic terrain file names. - if (omni.Util.strstr(terrainFileName, oldMissionName) >= 0) - terrainFileName = omni.Util.strreplace(terrainFileName, oldMissionName, newMissionName); + if (pInvokes.Util.strstr(terrainFileName, oldMissionName) >= 0) + terrainFileName = pInvokes.Util.strreplace(terrainFileName, oldMissionName, newMissionName); else terrainFileName = newMissionName + "_" + i + ".ter"; string newTerrainFile = terrainFilePath + "/" + terrainFileName; - if (!omni.Util.isWriteableFileName(newTerrainFile)) + if (!pInvokes.Util.isWriteableFileName(newTerrainFile)) { - if (omni.Util.messageBox("Error", "Terrain file \"" + newTerrainFile + "\" is read-only. Continue?", "Ok", "Stop") == omni.iGlobal["$MROk"]) + if (pInvokes.Util.messageBox("Error", "Terrain file \"" + newTerrainFile + "\" is read-only. Continue?", "Ok", "Stop") == pInvokes.iGlobal["$MROk"]) continue; else { @@ -475,7 +473,7 @@ public static void EditorSaveMissionAs(string missionName) if (!terrainObject.save(newTerrainFile)) { - omni.Util._error("Failed to save '" + newTerrainFile + "'"); + pInvokes.Util._error("Failed to save '" + newTerrainFile + "'"); copyTerrainsFailed = true; break; } @@ -490,12 +488,12 @@ public static void EditorSaveMissionAs(string missionName) { // It failed, so restore the mission and terrain filenames. - omni.sGlobal["$Server::MissionFile"] = saveMissionFile; + pInvokes.sGlobal["$Server::MissionFile"] = saveMissionFile; - omni.Util.initContainerTypeSearch(omni.uGlobal["$TypeMasks::TerrainObjectType"], false); + pInvokes.Util.initContainerTypeSearch(pInvokes.uGlobal["$TypeMasks::TerrainObjectType"], false); for (int i = 0;; i++) { - TerrainBlock terrainObject = omni.Util.containerSearchNext(false); + TerrainBlock terrainObject = pInvokes.Util.containerSearchNext(false); if (terrainObject == null) break; @@ -518,10 +516,10 @@ public static void EditorOpenMission(string filename) EditorGui EditorGui = "EditorGui"; SimSet MissionCleanup = "MissionCleanup"; - if (EditorIsDirty() && !omni.Util.isWebDemo()) + if (EditorIsDirty() && !pInvokes.Util.isWebDemo()) { // "EditorSaveBeforeLoad();", "getLoadFilename(\"*.mis\", \"EditorDoLoadMission\");" - if (omni.Util.messageBox("Mission Modified", "Would you like to save changes to the current mission \"" + omni.sGlobal["$Server::MissionFile"] + "\" before opening a new mission?", "SaveDontSave", "Question") == omni.iGlobal["$MROk"]) + if (pInvokes.Util.messageBox("Mission Modified", "Would you like to save changes to the current mission \"" + pInvokes.sGlobal["$Server::MissionFile"] + "\" before opening a new mission?", "SaveDontSave", "Question") == pInvokes.iGlobal["$MROk"]) { if (!EditorSaveMission()) return; @@ -530,7 +528,7 @@ public static void EditorOpenMission(string filename) if (filename == "") { - OpenFileDialog ofd = new OpenFileDialog {Filter = omni.sGlobal["$Pref::WorldEditor::FileSpec"], InitialDirectory = EditorSettings.value("LevelInformation/levelsDirectory"), CheckFileExists = true, Multiselect = false}; + OpenFileDialog ofd = new OpenFileDialog {Filter = pInvokes.sGlobal["$Pref::WorldEditor::FileSpec"], InitialDirectory = EditorSettings.value("LevelInformation/levelsDirectory"), CheckFileExists = true, Multiselect = false}; DialogResult dr = Dialogs.OpenFileDialog(ref ofd); @@ -539,7 +537,7 @@ public static void EditorOpenMission(string filename) case DialogResult.OK: filename = Dialogs.GetForwardSlashFile(ofd.FileName); // Immediately override/set the levelsDirectory - EditorSettings.setValue("LevelInformation/levelsDirectory", omni.console.Call("collapseFilename", new string[] {omni.Util.filePath(filename)})); + EditorSettings.setValue("LevelInformation/levelsDirectory", pInvokes.console.Call("collapseFilename", new string[] {pInvokes.Util.filePath(filename)})); break; case DialogResult.Abort: case DialogResult.Ignore: @@ -559,26 +557,26 @@ public static void EditorOpenMission(string filename) // If we haven't yet connnected, create a server now. // Otherwise just load the mission. - if (!omni.bGlobal["$missionRunning"]) + if (!pInvokes.bGlobal["$missionRunning"]) { - omni.Util.activatePackage("BootEditor"); + pInvokes.Util.activatePackage("BootEditor"); chooseLevelDlg.StartLevel(filename, ""); } else { missionLoad.loadMission(filename, true); - omni.Util.pushInstantGroup(); + pInvokes.Util.pushInstantGroup(); // recreate and open the editor //Editor::create(); - omni.console.Call("Editor_Create"); + pInvokes.console.Call("Editor_Create"); MissionCleanup.add(Editor); MissionCleanup.add(Editor.getUndoManager()); EditorGui["loadingMission"] = true.AsString(); Editor.open(); - omni.Util.popInstantGroup(); + pInvokes.Util.popInstantGroup(); } } @@ -590,9 +588,9 @@ public static void EditorExportToCollada() ShapeEditor.gui.CodeBehind.ShapeEditor.ShapeEdShapeView ShapeEdShapeView = "ShapeEdShapeView"; EWorldEditor EWorldEditor = "EWorldEditor"; - if (!omni.bGlobal["$Pref::disableSaving"] && !omni.Util.isWebDemo()) + if (!pInvokes.bGlobal["$Pref::disableSaving"] && !pInvokes.Util.isWebDemo()) { - SaveFileDialog sfd = new SaveFileDialog {Filter = @"COLLADA Files (*.dae)|*.dae", InitialDirectory = omni.sGlobal["$Pref::WorldEditor::LastPath"], FileName = "", OverwritePrompt = true,}; + SaveFileDialog sfd = new SaveFileDialog {Filter = @"COLLADA Files (*.dae)|*.dae", InitialDirectory = pInvokes.sGlobal["$Pref::WorldEditor::LastPath"], FileName = "", OverwritePrompt = true,}; string exportFile = ""; @@ -602,7 +600,7 @@ public static void EditorExportToCollada() { case DialogResult.OK: exportFile = Dialogs.GetForwardSlashFile(sfd.FileName); - omni.sGlobal["$Pref::WorldEditor::LastPath"] = omni.Util.filePath(exportFile); + pInvokes.sGlobal["$Pref::WorldEditor::LastPath"] = pInvokes.Util.filePath(exportFile); break; case DialogResult.Abort: case DialogResult.Ignore: @@ -612,7 +610,7 @@ public static void EditorExportToCollada() return; } - if (omni.Util.fileExt(exportFile) != ".dae") + if (pInvokes.Util.fileExt(exportFile) != ".dae") exportFile = exportFile + ".dae"; if (EditorGui.currentEditor.getId() == ShapeEditorPlugin.getId()) @@ -629,9 +627,9 @@ public static void EditorMakePrefab() EditorTree EditorTree = "EditorTree"; // Should this be protected or not? - if (!omni.bGlobal["$Pref::disableSaving"] && !omni.Util.isWebDemo()) + if (!pInvokes.bGlobal["$Pref::disableSaving"] && !pInvokes.Util.isWebDemo()) { - SaveFileDialog sfd = new SaveFileDialog {Filter = @"Prefab Files (*.prefab)|*.prefab", InitialDirectory = omni.sGlobal["$Pref::WorldEditor::LastPath"], FileName = "", OverwritePrompt = true,}; + SaveFileDialog sfd = new SaveFileDialog {Filter = @"Prefab Files (*.prefab)|*.prefab", InitialDirectory = pInvokes.sGlobal["$Pref::WorldEditor::LastPath"], FileName = "", OverwritePrompt = true,}; string saveFile = ""; @@ -641,7 +639,7 @@ public static void EditorMakePrefab() { case DialogResult.OK: saveFile = Dialogs.GetForwardSlashFile(sfd.FileName); - omni.sGlobal["$Pref::WorldEditor::LastPath"] = omni.Util.filePath(saveFile); + pInvokes.sGlobal["$Pref::WorldEditor::LastPath"] = pInvokes.Util.filePath(saveFile); break; case DialogResult.Abort: case DialogResult.Ignore: @@ -651,7 +649,7 @@ public static void EditorMakePrefab() return; } - if (omni.Util.fileExt(saveFile) != ".prefab") + if (pInvokes.Util.fileExt(saveFile) != ".prefab") saveFile = saveFile + ".prefab"; EWorldEditor.makeSelectionPrefab(saveFile); @@ -678,7 +676,7 @@ public static void EditorMount() { EWorldEditor EWorldEditor = "EWorldEditor"; - omni.Util._echo("EditorMount"); + pInvokes.Util._echo("EditorMount"); int size = EWorldEditor.getSelectionSize(); if (size != 2) @@ -696,7 +694,7 @@ public static void EditorUnmount() { EWorldEditor EWorldEditor = "EWorldEditor"; - omni.Util._echo("EditorUnmount"); + pInvokes.Util._echo("EditorUnmount"); SimObject obj = EWorldEditor.getSelectedObject(0); obj.call("unmount"); @@ -756,7 +754,7 @@ public override bool onSelectItem(string id, string text) EWorldEditor EWorldEditor = "EWorldEditor"; // Have the editor align all selected objects by the selected bounds. - EWorldEditor.alignByBounds(omni.Util.getField(this["item[" + id + "]"], 2).AsInt()); + EWorldEditor.alignByBounds(pInvokes.Util.getField(this["item[" + id + "]"], 2).AsInt()); return true; } @@ -885,7 +883,7 @@ public override bool onSelectItem(string id, string text) EWorldEditor EWorldEditor = "EWorldEditor"; // Have the editor align all selected objects by the selected axis. - EWorldEditor.alignByAxis(omni.Util.getField(this["item[" + id + "]"], 2).AsInt()); + EWorldEditor.alignByAxis(pInvokes.Util.getField(this["item[" + id + "]"], 2).AsInt()); return true; } @@ -1156,17 +1154,17 @@ public override bool onSelectItem(string id, string text) GuiSliderCtrl Slider = CameraSpeedDropdownCtrlContainer.FOT("slider"); // Grab and set speed - float speed = omni.Util.getField(this["item[" + id + "]"], 2).AsFloat(); - omni.fGlobal["$Camera::movementSpeed"] = speed; + float speed = pInvokes.Util.getField(this["item[" + id + "]"], 2).AsFloat(); + pInvokes.fGlobal["$Camera::movementSpeed"] = speed; // Update Editor this.checkRadioItem(0, 6, id.AsInt()); // Update Toolbar TextEdit - EWorldEditorCameraSpeed.setText(omni.fGlobal["$Camera::movementSpeed"].AsString()); + EWorldEditorCameraSpeed.setText(pInvokes.fGlobal["$Camera::movementSpeed"].AsString()); // Update Toolbar Slider - Slider.setValue(omni.fGlobal["$Camera::movementSpeed"].AsString()); + Slider.setValue(pInvokes.fGlobal["$Camera::movementSpeed"].AsString()); return true; } @@ -1191,7 +1189,7 @@ public override void setupDefaultState() // Update Editor with default speed defaultSpeed = "25"; } - omni.fGlobal["$Camera::movementSpeed"] = defaultSpeed.AsFloat(); + pInvokes.fGlobal["$Camera::movementSpeed"] = defaultSpeed.AsFloat(); // Update Toolbar TextEdit EWorldEditorCameraSpeed.setText(defaultSpeed); @@ -1235,7 +1233,7 @@ public void setupGuiControls() // Set up the camera speed items float inc = ((maxSpeed - minSpeed)/(this.getItemCount() - 1)); for (int i = 0; i < this.getItemCount(); i++) - this["item[" + i + "]"] = omni.Util.setField(this["item[" + i + "]"], 2, (minSpeed + (inc*i)).AsString()); + this["item[" + i + "]"] = pInvokes.Util.setField(this["item[" + i + "]"], 2, (minSpeed + (inc*i)).AsString()); // Set up min/max camera slider range Slider.range = (minSpeed + " " + maxSpeed).AsPoint2F(); @@ -1365,7 +1363,7 @@ public override bool onSelectItem(string id, string text) // This sets up which drop script function to use when // a drop type is selected in the menu. - EWorldEditor.dropType = omni.Util.getField(this["item[" + id + "]"], 2); + EWorldEditor.dropType = pInvokes.Util.getField(this["item[" + id + "]"], 2); this.checkRadioItem(0, (this.getItemCount() - 1), id.AsInt()); @@ -1384,7 +1382,7 @@ public override void setupDefaultState() int dropTypeIndex = 0; for (; dropTypeIndex < numItems; dropTypeIndex++) { - if (omni.Util.getField(this["item[" + dropTypeIndex + "]"], 2) == EWorldEditor["dropType"]) + if (pInvokes.Util.getField(this["item[" + dropTypeIndex + "]"], 2) == EWorldEditor["dropType"]) break; } @@ -2115,7 +2113,7 @@ public override bool onSelectItem(string id, string text) { EditorGui EditorGui = "EditorGui"; - string toolName = omni.Util.getField(this["item[" + id + "]"], 2); + string toolName = pInvokes.Util.getField(this["item[" + id + "]"], 2); //In the torquescript they passed a local variable called %paletteName as the second parameter. //Well, in reality it's expecting a bool, so an unitialized variable is false by default, so they were sending false diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/UndoManager.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/UndoManager.ed.cs index d1312d53..87ec1624 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/UndoManager.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/UndoManager.ed.cs @@ -212,7 +212,7 @@ public static void submit(SimObject undoObject) // The instant group will try to add our // UndoAction if we don't disable it. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); // Create the undo action. ObjectCreator actionCreator = new ObjectCreator("MECreateUndoAction"); @@ -221,7 +221,7 @@ public static void submit(SimObject undoObject) MECreateUndoAction action = actionCreator.Create(); // Restore the instant group. - omni.Util.popInstantGroup(); + Util.popInstantGroup(); // Set the object to undo. action.addObject(undoObject); @@ -261,7 +261,7 @@ public static void submit(string deleteObjects, bool wordSeperated) // The instant group will try to add our // UndoAction if we don't disable it. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); // Create the undo action. ObjectCreator actionCreator = new ObjectCreator("MEDeleteUndoAction"); @@ -270,27 +270,27 @@ public static void submit(string deleteObjects, bool wordSeperated) MEDeleteUndoAction action = actionCreator.Create(); // Restore the instant group. - omni.Util.popInstantGroup(); + Util.popInstantGroup(); // Add the deletion objects to the action which // will take care of properly deleting them. - deleteObjects = omni.Util.trim(deleteObjects); + deleteObjects = Util.trim(deleteObjects); if (wordSeperated) { - int count = omni.Util.getWordCount(deleteObjects); + int count = Util.getWordCount(deleteObjects); for (int i = 0; i < count; i++) { - SimObject xobject = omni.Util.getWord(deleteObjects, i); + SimObject xobject = Util.getWord(deleteObjects, i); action.deleteObject(xobject); } } else { - int count = omni.Util.getFieldCount(deleteObjects); + int count = Util.getFieldCount(deleteObjects); for (int i = 0; i < count; i++) { - SimObject xobject = omni.Util.getField(deleteObjects, i); + SimObject xobject = Util.getField(deleteObjects, i); action.deleteObject(xobject); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.bind.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.bind.ed.cs index db02913a..b9d1bb5d 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.bind.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.bind.ed.cs @@ -45,8 +45,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor { public class editor_bind_ed { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "editor_bind_ed_cs_initialize")] public static void initialize() { @@ -70,8 +68,8 @@ public static void mouseWheelScroll(float val) //EditorGui-->CameraSpeedSpinner.setText( $Camera::movementSpeed ); float rollAdj = defaultBind.getMouseAdjustAmount(val); - rollAdj = omni.Util.mClamp(rollAdj, (float) (-Math.PI + 0.01), (float) (Math.PI - 0.01)); - omni.fGlobal["$mvRoll"] += rollAdj; + rollAdj = pInvokes.Util.mClamp(rollAdj, (float) (-Math.PI + 0.01), (float) (Math.PI - 0.01)); + pInvokes.fGlobal["$mvRoll"] += rollAdj; } [ConsoleInteraction] @@ -81,14 +79,14 @@ public static void editorYaw(float val) if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera() || ((EWorldEditor) "EWorldEditor").isMiddleMouseDown()) { // Clamp and scale - yawAdj = omni.Util.mClamp(yawAdj, ((float) (-2.0f*Math.PI) + 0.01f), ((float) (2.0f*Math.PI) - 0.01f)); + yawAdj = pInvokes.Util.mClamp(yawAdj, ((float) (-2.0f*Math.PI) + 0.01f), ((float) (2.0f*Math.PI) - 0.01f)); yawAdj *= 0.5f; } if (((SimObject) "EditorSettings")["Camera/invertXAxis"].AsBool()) yawAdj *= -1; - omni.fGlobal["$mvYaw"] += yawAdj; + pInvokes.fGlobal["$mvYaw"] += yawAdj; } [ConsoleInteraction] @@ -97,13 +95,13 @@ public static void editorPitch(float val) float pitchAdj = defaultBind.getMouseAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera() || ((EWorldEditor) "EWorldEditor").isMiddleMouseDown()) { - pitchAdj = omni.Util.mClamp(pitchAdj, ((float) (-2.0f*Math.PI) + 0.01f), ((float) (2.0f*Math.PI) - 0.01f)); + pitchAdj = pInvokes.Util.mClamp(pitchAdj, ((float) (-2.0f*Math.PI) + 0.01f), ((float) (2.0f*Math.PI) - 0.01f)); pitchAdj *= 0.5f; } if (((SimObject) "EditorSettings")["Camera/invertYAxis"].AsBool()) pitchAdj *= -1; - omni.fGlobal["$mvPitch"] += pitchAdj; + pInvokes.fGlobal["$mvPitch"] += pitchAdj; } [ConsoleInteraction] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.ed.cs index 5362737c..90ddb55a 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.ed.cs @@ -69,9 +69,9 @@ public class editor : EditManager [ConsoleInteraction(true, "editor_Initialize")] public static void initialize() { - omni.sGlobal["$RelightCallback"] = ""; + sGlobal["$RelightCallback"] = ""; ((ActionMap) "GlobalActionMap").bind("keyboard", "f11", "toggleEditor"); - omni.Util.eval(@" + Util.eval(@" package EditorDisconnectOverride { @@ -83,7 +83,7 @@ function disconnect() "); - omni.Util.activatePackage("EditorDisconnectOverride"); + Util.activatePackage("EditorDisconnectOverride"); } [ConsoleInteraction(true, "Editor_Create")] @@ -164,12 +164,12 @@ public static void toggleEditor(bool make) editor editor = "editor"; if (make) { - string timerID = omni.console.Call("startPrecisionTimer"); - if (omni.bGlobal["$InGuiEditor"]) - //omni.console.Call("GuiEdit"); + string timerID = console.Call("startPrecisionTimer"); + if (bGlobal["$InGuiEditor"]) + //console.Call("GuiEdit"); GuiEditorGui.GuiEdit(""); - if (!omni.bGlobal["$missionRunning"]) + if (!bGlobal["$missionRunning"]) { // Flag saying, when level is chosen, launch it with the editor open. ((GuiControl) "ChooseLevelDlg")["launchInEditor"] = true.AsString(); @@ -178,7 +178,7 @@ public static void toggleEditor(bool make) } else { - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); if (!"Editor".isObject()) { create(); @@ -191,7 +191,7 @@ public static void toggleEditor(bool make) { if (((LevelInfo) "theLevelInfo")["Type"] == "DemoScene") { - omni.console.commandToServer("dropPlayerAtCamera"); + console.commandToServer("dropPlayerAtCamera"); editor.close("SceneGui"); } else @@ -199,13 +199,13 @@ public static void toggleEditor(bool make) } else { - if (!omni.bGlobal["$GuiEditorBtnPressed"]) + if (!bGlobal["$GuiEditorBtnPressed"]) { ((GuiCanvas) "Canvas").pushDialog("EditorLoadingGui"); ((GuiCanvas) "Canvas").repaint(0); } else - omni.bGlobal["$GuiEditorBtnPressed"] = false; + bGlobal["$GuiEditorBtnPressed"] = false; editor.open(); @@ -213,20 +213,20 @@ public static void toggleEditor(bool make) // the level from cycling after it's duration // has elapsed. - omni.Util.cancel(omni.iGlobal["$Game::Schedule"]); + Util.cancel(iGlobal["$Game::Schedule"]); if (((LevelInfo) "theLevelInfo")["type"] == "DemoScene") - omni.console.commandToServer("dropCameraAtPlayer", new string[] {"true"}); + console.commandToServer("dropCameraAtPlayer", new string[] {"true"}); ((GuiCanvas) "Canvas").popDialog("EditorLoadingGui"); } - omni.Util.popInstantGroup(); + Util.popInstantGroup(); } - string elapsed = omni.console.Call("stopPrecisionTimer", new string[] {timerID}); + string elapsed = console.Call("stopPrecisionTimer", new string[] {timerID}); - omni.Util._warn("Time spent in toggleEditor() : " + (elapsed.AsFloat()/1000.0) + " s"); + Util._warn("Time spent in toggleEditor() : " + (elapsed.AsFloat()/1000.0) + " s"); } } @@ -259,9 +259,9 @@ public static void Editor_Disconnect() editor.close("MainMenuGui"); } - omni.Util.deactivatePackage("EditorDisconnectOverride"); - omni.Util._call("disconnect"); - omni.Util.activatePackage("EditorDisconnectOverride"); + Util.deactivatePackage("EditorDisconnectOverride"); + Util._call("disconnect"); + Util.activatePackage("EditorDisconnectOverride"); } [ConsoleInteraction] @@ -492,7 +492,7 @@ public void lightScene(string callback, bool forceAlways) RelightStatus.visible = true; RelightProgress.setValue("0"); Canvas.repaint(0); - omni.Util.lightScene("EditorLightingComplete", forceAlways.AsString()); + Util.lightScene("EditorLightingComplete", forceAlways.AsString()); updateEditorLightingProgress(); } @@ -501,13 +501,13 @@ public static void EditorLightingComplete() { GuiControl RelightStatus = "RelightStatus"; - omni.bGlobal["$lightingMission"] = false; + bGlobal["$lightingMission"] = false; RelightStatus.visible = false; - if (omni.sGlobal["$RelightCallback"] != "") - omni.Util.eval(omni.sGlobal["$RelightCallback"]); + if (sGlobal["$RelightCallback"] != "") + Util.eval(sGlobal["$RelightCallback"]); - omni.sGlobal["$RelightCallback"] = ""; + sGlobal["$RelightCallback"] = ""; } [ConsoleInteraction] @@ -515,9 +515,9 @@ public static void updateEditorLightingProgress() { GuiProgressBitmapCtrl RelightProgress = "RelightProgress"; - RelightProgress.setValue(omni.sGlobal["$SceneLighting::lightingProgress"]); - if (omni.bGlobal["$lightingMission"]) - omni.iGlobal["$lightingProgressThread"] = omni.Util._schedule("1", "0", "updateEditorLightingProgress"); + RelightProgress.setValue(sGlobal["$SceneLighting::lightingProgress"]); + if (bGlobal["$lightingMission"]) + iGlobal["$lightingProgressThread"] = Util._schedule("1", "0", "updateEditorLightingProgress"); } [ConsoleInteraction] @@ -528,7 +528,7 @@ public bool validateObjectName(string name, bool mustHaveName) messageBox.MessageBoxOK("Missing Object Name", "No name given for object. Please enter a valid object name."); return false; } - if (!omni.Util.isValidObjectName(name)) + if (!Util.isValidObjectName(name)) { messageBox.MessageBoxOK("Invalid Object Name", "'" + name + "' is not a valid object name." + '\n' + "" + '\n' + "Please choose a name that begins with a letter or underscore and is otherwise comprised " + "exclusively of letters, digits, and/or underscores."); return false; @@ -542,7 +542,7 @@ public bool validateObjectName(string name, bool mustHaveName) messageBox.MessageBoxOK("Invalid Object Name", "Object names must be unique, and there is an " + "existing " + ((SimObject) name).getClassName() + " object with the name '" + name + "' (defined " + "in " + filename + "). Please choose another name."); return false; } - if (omni.Util.isClass(name)) + if (Util.isClass(name)) { messageBox.MessageBoxOK("Invalid Object Name", "'" + name + "' is the name of an existing TorqueScript " + "class. Please choose another name."); return false; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/Creator.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/Creator.ed.cs index 69eddc3b..e300ad44 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/Creator.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/Creator.ed.cs @@ -47,8 +47,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui.CodeBe { public class Creator { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static int alphaIconCompare(SimObject a, SimObject b) { @@ -64,7 +62,7 @@ public static int alphaIconCompare(SimObject a, SimObject b) return 1; } - int result = omni.Util.stricmp(a["text"], b["text"]); + int result = pInvokes.Util.stricmp(a["text"], b["text"]); return result; } @@ -74,9 +72,9 @@ public static string genericCreateObject(string className) { EWCreatorWindow EWCreatorWindow = "EWCreatorWindow"; - if (!omni.Util.isClass(className)) + if (!pInvokes.Util.isClass(className)) { - omni.Util._warn("createObject( " + className + " ) - Was not a valid class."); + pInvokes.Util._warn("createObject( " + className + " ) - Was not a valid class."); return ""; } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/EditorChooseLevelGui.ed.cs/staticFunctions.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/EditorChooseLevelGui.ed.cs/staticFunctions.cs index 3bf2f273..82afb8ff 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/EditorChooseLevelGui.ed.cs/staticFunctions.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/EditorChooseLevelGui.ed.cs/staticFunctions.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -43,18 +43,16 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui.CodeBe { public class staticFunctions { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void WE_EditLevel(string levelFile) { - omni.Util._call("EditorOpenMission", levelFile); + pInvokes.Util._call("EditorOpenMission", levelFile); } [ConsoleInteraction] public static void WE_ReturnToMainMenu() { - omni.Util._call("loadMainMenu"); + pInvokes.Util._call("loadMainMenu"); } [ConsoleInteraction] @@ -91,14 +89,14 @@ public static string getLevelDisplayName(string levelFile) file.close(); } MissionInfoObject = "%MissionInfoObject = " + MissionInfoObject + "; return %MissionInfoObject;"; - MissionInfoObject = omni.console.Eval(MissionInfoObject, true); + MissionInfoObject = pInvokes.console.Eval(MissionInfoObject, true); file.delete(); string name = ""; if (((SimObject) MissionInfoObject)["LevelName"] != "") name = ((SimObject) MissionInfoObject)["LevelName"]; else - name = omni.Util.fileBase(levelFile); + name = pInvokes.Util.fileBase(levelFile); MissionInfoObject.delete(); diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/PlugIns/TerrainEditorPlugin.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/PlugIns/TerrainEditorPlugin.cs index db5c609e..7b966718 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/PlugIns/TerrainEditorPlugin.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/PlugIns/TerrainEditorPlugin.cs @@ -58,7 +58,7 @@ internal ActionMap map [ConsoleInteraction] public static void LoadTerrainEditorTextureFileSpec() { - omni.sGlobal["$TerrainEditor::TextureFileSpec"] = "Image Files (*.png, *.jpg, *.dds)|*.png;*.jpg;*.dds|All Files (*.*)|*.*"; + sGlobal["$TerrainEditor::TextureFileSpec"] = "Image Files (*.png, *.jpg, *.dds)|*.png;*.jpg;*.dds|All Files (*.*)|*.*"; } [ConsoleInteraction] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ManageSFXParametersWindow.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ManageSFXParametersWindow.ed.cs index 3ae31245..ba975d70 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ManageSFXParametersWindow.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ManageSFXParametersWindow.ed.cs @@ -42,8 +42,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui { public class ManageSFXParametersWindow { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ManageSFXParametersWindow_initialize")] public static void initialize() { @@ -52,37 +50,37 @@ public static void initialize() //============================================================================= // File to save newly created SFXParameters in by default. - omni.sGlobal["$SFX_PARAMETER_FILE"] = "scripts/client/audioData.cs"; - - omni.sGlobal["$SFX_PARAMETER_CHANNELS[0]"] = "Volume"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[1]"] = "Pitch"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[2]"] = "Priority"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[3]"] = "MinDistance"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[4]"] = "MaxDistance"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[5]"] = "ConeInsideAngle"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[6]"] = "ConeOutsideAngle"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[7]"] = "ConeOutsideVolume"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[8]"] = "PositionX"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[9]"] = "PositionY"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[10]"] = "PositionZ"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[11]"] = "RotationX"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[12]"] = "RotationY"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[13]"] = "RotationZ"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[14]"] = "VelocityX"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[15]"] = "VelocityY"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[16]"] = "VelocityZ"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[17]"] = "Cursor"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[18]"] = "User0"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[19]"] = "User1"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[20]"] = "User2"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[21]"] = "User3"; - - omni.iGlobal["$SFX_PARAMETER_CHANNELS_COUNT"] = 22; + pInvokes.sGlobal["$SFX_PARAMETER_FILE"] = "scripts/client/audioData.cs"; + + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[0]"] = "Volume"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[1]"] = "Pitch"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[2]"] = "Priority"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[3]"] = "MinDistance"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[4]"] = "MaxDistance"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[5]"] = "ConeInsideAngle"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[6]"] = "ConeOutsideAngle"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[7]"] = "ConeOutsideVolume"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[8]"] = "PositionX"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[9]"] = "PositionY"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[10]"] = "PositionZ"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[11]"] = "RotationX"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[12]"] = "RotationY"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[13]"] = "RotationZ"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[14]"] = "VelocityX"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[15]"] = "VelocityY"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[16]"] = "VelocityZ"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[17]"] = "Cursor"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[18]"] = "User0"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[19]"] = "User1"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[20]"] = "User2"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[21]"] = "User3"; + + pInvokes.iGlobal["$SFX_PARAMETER_CHANNELS_COUNT"] = 22; // Interval (in milliseconds) between GUI updates. Each update // syncs the displayed values to the actual parameter states. - omni.iGlobal["$SFX_PARAMETERS_UPDATE_INTERVAL"] = 50; + pInvokes.iGlobal["$SFX_PARAMETERS_UPDATE_INTERVAL"] = 50; #region GuiControl (ManageSFXParametersContainer,EditorGuiGroup) oc_Newobject10 diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ProceduralTerrainPainterGui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ProceduralTerrainPainterGui.cs index d63b36a4..0f5d130a 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ProceduralTerrainPainterGui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ProceduralTerrainPainterGui.cs @@ -42,8 +42,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui { public class ProceduralTerrainPainterGui { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ProceduralTerrainPainterGui_initialize")] public static void initialize() { @@ -520,11 +518,11 @@ public static void initialize() } - omni.iGlobal["$TPPHeightMin"] = -10000; - omni.iGlobal["$TPPHeightMax"] = 10000; - omni.iGlobal["$TPPSlopeMin"] = 0; - omni.iGlobal["$TPPSlopeMax"] = 90; - omni.iGlobal["$TPPCoverage"] = 100; + pInvokes.iGlobal["$TPPHeightMin"] = -10000; + pInvokes.iGlobal["$TPPHeightMax"] = 10000; + pInvokes.iGlobal["$TPPSlopeMin"] = 0; + pInvokes.iGlobal["$TPPSlopeMax"] = 90; + pInvokes.iGlobal["$TPPCoverage"] = 100; } @@ -538,8 +536,8 @@ public static void autoLayers() public static void generateProceduralTerrainMask() { ((GuiCanvas) "Canvas").popDialog("ProceduralTerrainPainterGui"); - ((TerrainEditor) "ETerrainEditor").autoMaterialLayer(omni.fGlobal["$TPPHeightMin"], - omni.fGlobal["$TPPHeightMax"], omni.fGlobal["$TPPSlopeMin"], omni.fGlobal["$TPPSlopeMax"], omni.fGlobal["$TPPCoverage"]); + ((TerrainEditor) "ETerrainEditor").autoMaterialLayer(pInvokes.fGlobal["$TPPHeightMin"], + pInvokes.fGlobal["$TPPHeightMax"], pInvokes.fGlobal["$TPPSlopeMin"], pInvokes.fGlobal["$TPPSlopeMax"], pInvokes.fGlobal["$TPPCoverage"]); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/TerrainPainterToolbar.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/TerrainPainterToolbar.ed.cs index fd1a01be..43f7e783 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/TerrainPainterToolbar.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/TerrainPainterToolbar.ed.cs @@ -45,8 +45,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui { public class TerrainPainterToolbar { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "TerrainPainterToolbar_initialize")] public static void initialize() { @@ -816,7 +814,7 @@ public static void setTerrainEditorMinSlope(float value) float val = ETerrainEditor.setSlopeLimitMinAngle(value); GuiTextEditCtrl SlopeMinAngle = ((GuiControl) "PaintBrushSlopeControl").findObjectByInternalName("SlopeMinAngle", true); - SlopeMinAngle.setValue(omni.Util.mFloatLength(val, 1)); + SlopeMinAngle.setValue(pInvokes.Util.mFloatLength(val, 1)); } [ConsoleInteraction] @@ -826,7 +824,7 @@ public static void setTerrainEditorMaxSlope(float value) float val = ETerrainEditor.setSlopeLimitMaxAngle(value); GuiTextEditCtrl SlopeMaxAngle = ((GuiControl) "PaintBrushSlopeControl").findObjectByInternalName("SlopeMaxAngle", true); - SlopeMaxAngle.setValue(omni.Util.mFloatLength(val, 1)); + SlopeMaxAngle.setValue(pInvokes.Util.mFloatLength(val, 1)); } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/guiTerrainImportGui.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/guiTerrainImportGui.cs index dfd02f42..7e39b4f0 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/guiTerrainImportGui.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/guiTerrainImportGui.cs @@ -717,8 +717,8 @@ public static void initialize() oc_Newobject22.Create(); - omni.sGlobal["$TerrainImportGui::HeightFieldFilter"] = "Heightfield Files (*.png, *.bmp, *.jpg, *.gif)|*.png;*.bmp;*.jpg;*.gif|All Files (*.*)|*.*"; - omni.sGlobal["$TerrainImportGui::OpacityMapFilter"] = "Opacity Map Files (*.png, *.bmp, *.jpg, *.gif)|*.png;*.bmp;*.jpg;*.gif|All Files (*.*)|*.*"; + sGlobal["$TerrainImportGui::HeightFieldFilter"] = "Heightfield Files (*.png, *.bmp, *.jpg, *.gif)|*.png;*.bmp;*.jpg;*.gif|All Files (*.*)|*.*"; + sGlobal["$TerrainImportGui::OpacityMapFilter"] = "Opacity Map Files (*.png, *.bmp, *.jpg, *.gif)|*.png;*.bmp;*.jpg;*.gif|All Files (*.*)|*.*"; } /* @@ -914,15 +914,15 @@ public static void TerrainImportGuiAddOpacityMap(string name) // TODO: Need to actually look at // the file here and figure // out how many channels it has. - string txt = omni.Util.makeRelativePath(name, omni.Util.getWorkingDirectory()); + string txt = Util.makeRelativePath(name, Util.getWorkingDirectory()); // Will need to do this stuff // once per channel in the file // currently it works with just grayscale. string channelsTxt = "R\tG\tB\tA"; - string bitmapInfo = omni.Util.getBitmapInfo(name); + string bitmapInfo = Util.getBitmapInfo(name); - string channelCount = omni.Util.getWord(bitmapInfo, 2); + string channelCount = Util.getWord(bitmapInfo, 2); GuiTextListCtrl opacityList = ((GuiControl) "TerrainImportGui").findObjectByInternalName("OpacityLayerTextList", true); @@ -933,10 +933,10 @@ public static void TerrainImportGuiAddOpacityMap(string name) for (int i = 0; i < channelCount.AsInt(); i++) { namesArray.push_back(txt, name); - channelsArray.push_back(txt, omni.Util.getWord(channelsTxt, i) + "/t" + channelCount); + channelsArray.push_back(txt, Util.getWord(channelsTxt, i) + "/t" + channelCount); //TerrainImportGui.namesArray.echo(); int count = opacityList.rowCount(); - opacityList.addRow(count, txt + "/t" + omni.Util.getWord(channelsTxt, i), -1); + opacityList.addRow(count, txt + "/t" + Util.getWord(channelsTxt, i), -1); } //OpacityMapListBox.addItem( %name ); } @@ -1022,10 +1022,10 @@ public static void TerrainImportGui_TerrainMaterialApplyCallback(string mat, str string rowTxt = opacityList.getRowTextById(itemIdx.AsInt()); - int columTxtCount = omni.Util.getFieldCount(rowTxt); + int columTxtCount = Util.getFieldCount(rowTxt); if (columTxtCount > 2) - rowTxt = omni.Util.getFields(rowTxt, 0, 1); + rowTxt = Util.getFields(rowTxt, 0, 1); opacityList.setRowById(itemIdx.AsInt(), rowTxt + "\t" + ((SimObject) mat).internalName + "/t" + mat); } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/objectBuilderGui.ed.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/objectBuilderGui.ed.cs index d0585c44..eb1030c9 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/objectBuilderGui.ed.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/objectBuilderGui.ed.cs @@ -403,7 +403,7 @@ public static void GenerateScriptObjectCreators() } "; - omni.Util.eval(toeval); + Util.eval(toeval); } [ConsoleInteraction] diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/main.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/main.cs index 2e406ed3..5f5942a1 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/main.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/main.cs @@ -45,8 +45,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools { public class main { - private static readonly pInvokes omni = new pInvokes(); - private static string[] EditorsToLoad = new string[] {"editorClasses", //Must be first "base", //Must be second "worldEditor", //Must be third, rest don't matter. @@ -54,20 +52,20 @@ public class main public static void initialize() { - omni.Util._echo("-------------------->Loading Tools"); + pInvokes.Util._echo("-------------------->Loading Tools"); //--------------------------------------------------------------------------------------------- // Path to the folder that contains the editors we will load. //--------------------------------------------------------------------------------------------- - omni.sGlobal["$Tools::resourcePath"] = "tools/"; + pInvokes.sGlobal["$Tools::resourcePath"] = "tools/"; // These must be loaded first, in this order, before anything else is loaded - omni.sGlobal["$Tools::loadFirst"] = "editorClasses base worldEditor"; + pInvokes.sGlobal["$Tools::loadFirst"] = "editorClasses base worldEditor"; //--------------------------------------------------------------------------------------------- // Object that holds the simObject id that the materialEditor uses to interpret its material list //--------------------------------------------------------------------------------------------- - omni.sGlobal["$Tools::materialEditorList"] = ""; + pInvokes.sGlobal["$Tools::materialEditorList"] = ""; String ToExecute = @" package Tools @@ -101,8 +99,8 @@ function onExit() } }; "; - omni.console.Eval(ToExecute); - omni.Util.activatePackage("Tools"); + pInvokes.console.Eval(ToExecute); + pInvokes.Util.activatePackage("Tools"); } [ConsoleInteraction] @@ -115,29 +113,29 @@ public static void tools_onStart() //new Settings(EditorSettings) { file = "tools/settings.xml"; }; EditorSettings.read(); - omni.Util._echo(" % - Initializing Tools"); + pInvokes.Util._echo(" % - Initializing Tools"); // Default file path when saving from the editor (such as prefabs) - if (omni.sGlobal["$Pref::WorldEditor::LastPath"] == "") - omni.sGlobal["$Pref::WorldEditor::LastPath"] = omni.Util.getMainDotCsDir(); + if (pInvokes.sGlobal["$Pref::WorldEditor::LastPath"] == "") + pInvokes.sGlobal["$Pref::WorldEditor::LastPath"] = pInvokes.Util.getMainDotCsDir(); // Common GUI stuff. //exec( "./gui/cursors.ed.cs" ); - //omni.Util.exec("tools/gui/profiles.ed.cs", false, false); + //pInvokes.Util.exec("tools/gui/profiles.ed.cs", false, false); profiles.initialize(); NavPanelProfiles.initialize(); // Make sure we get editor profiles before any GUI's // BUG: these dialogs are needed earlier in the init sequence, and should be moved to // common, along with the guiProfiles they depend on. - omni.Util.exec("tools/gui/guiDialogs.ed.cs", false, false); + pInvokes.Util.exec("tools/gui/guiDialogs.ed.cs", false, false); guiDialogs.initialize(); //%toggle = $Scripts::ignoreDSOs; //$Scripts::ignoreDSOs = true; - omni.uGlobal["$ignoredDatablockSet"] = new ObjectCreator("SimSet").Create(); + pInvokes.uGlobal["$ignoredDatablockSet"] = new ObjectCreator("SimSet").Create(); //// fill the list of editors //$editors[count] = getWordCount( $Tools::loadFirst ); @@ -179,8 +177,8 @@ public static void tools_onStart() foreach (string editor in EditorsToLoad) { string initializeFunction = "initialize" + editor; - if (omni.Util.isFunction(initializeFunction)) - omni.Util._call(initializeFunction); + if (pInvokes.Util.isFunction(initializeFunction)) + pInvokes.Util._call(initializeFunction); } //%count = $editors[count]; //for ( %i = 0; %i < %count; %i++ ) @@ -195,59 +193,59 @@ public static void tools_onStart() // Popuplate the default SimObject icons that // are used by the various editors. //EditorIconRegistry::loadFromPath( "tools/classIcons/" ); - omni.console.Call_Classname("EditorIconRegistry", "loadFromPath", new[] {"tools/classIcons/"}); + pInvokes.console.Call_Classname("EditorIconRegistry", "loadFromPath", new[] {"tools/classIcons/"}); // Load up the tools resources. All the editors are initialized at this point, so // resources can override, redefine, or add functionality. // Tools::LoadResources( $Tools::resourcePath ); - LoadResources(omni.sGlobal["$Tools::resourcePath"]); + LoadResources(pInvokes.sGlobal["$Tools::resourcePath"]); } [ConsoleInteraction] public static void tools_startToolTime(string tool) { - if (omni.sGlobal["$toolDataToolCount"] == "") - omni.sGlobal["$toolDataToolCount"] = "0"; + if (pInvokes.sGlobal["$toolDataToolCount"] == "") + pInvokes.sGlobal["$toolDataToolCount"] = "0"; - if (omni.sGlobal["$toolDataToolEntry[" + tool + "]"] != "true") + if (pInvokes.sGlobal["$toolDataToolEntry[" + tool + "]"] != "true") { - omni.sGlobal["$toolDataToolEntry[" + tool + "]"] = "true"; - omni.sGlobal["$toolDataToolList[" + omni.sGlobal["$toolDataToolCount"] + "]"] = tool; - omni.iGlobal["$toolDataToolCount"]++; - omni.iGlobal["$toolDataClickCount[" + tool + "]"] = 0; + pInvokes.sGlobal["$toolDataToolEntry[" + tool + "]"] = "true"; + pInvokes.sGlobal["$toolDataToolList[" + pInvokes.sGlobal["$toolDataToolCount"] + "]"] = tool; + pInvokes.iGlobal["$toolDataToolCount"]++; + pInvokes.iGlobal["$toolDataClickCount[" + tool + "]"] = 0; } - omni.iGlobal["$toolDataStartTime[" + tool + "]"] = omni.Util.getSimTime(); - omni.iGlobal["$toolDataClickCount[" + tool + "]"]++; + pInvokes.iGlobal["$toolDataStartTime[" + tool + "]"] = pInvokes.Util.getSimTime(); + pInvokes.iGlobal["$toolDataClickCount[" + tool + "]"]++; } [ConsoleInteraction] public static void tools_endtoolTime(string tool) { int startTime = 0; - if (omni.sGlobal["$toolDataStartTime[" + tool + "]"] != "") - startTime = omni.iGlobal["$toolDataStartTime[" + tool + "]"]; + if (pInvokes.sGlobal["$toolDataStartTime[" + tool + "]"] != "") + startTime = pInvokes.iGlobal["$toolDataStartTime[" + tool + "]"]; - if (omni.sGlobal["$toolDataTotalTime[" + tool + "]"] == "") - omni.iGlobal["$toolDataTotalTime[" + tool + "]"] = 0; + if (pInvokes.sGlobal["$toolDataTotalTime[" + tool + "]"] == "") + pInvokes.iGlobal["$toolDataTotalTime[" + tool + "]"] = 0; - omni.iGlobal["$toolDataTotalTime[" + tool + "]"] += omni.Util.getSimTime() - startTime; + pInvokes.iGlobal["$toolDataTotalTime[" + tool + "]"] += pInvokes.Util.getSimTime() - startTime; } [ConsoleInteraction] public static void tools_dumpToolData() { - int count = omni.iGlobal["$toolDataToolCount"]; + int count = pInvokes.iGlobal["$toolDataToolCount"]; for (int i = 0; i < count; i++) { - string tool = omni.sGlobal["$toolDataToolList[" + i + "]"]; - int totalTime = omni.iGlobal["$toolDataTotalTime[" + tool + "]"]; - int clickCount = omni.iGlobal["$toolDataClickCount[" + tool + "]"]; - omni.Util._echo("---"); - omni.Util._echo("Tool: " + tool); - omni.Util._echo("Time (Seconds): " + (totalTime/1000)); - omni.Util._echo("Activated: " + clickCount); - omni.Util._echo("---"); + string tool = pInvokes.sGlobal["$toolDataToolList[" + i + "]"]; + int totalTime = pInvokes.iGlobal["$toolDataTotalTime[" + tool + "]"]; + int clickCount = pInvokes.iGlobal["$toolDataClickCount[" + tool + "]"]; + pInvokes.Util._echo("---"); + pInvokes.Util._echo("Tool: " + tool); + pInvokes.Util._echo("Time (Seconds): " + (totalTime/1000)); + pInvokes.Util._echo("Activated: " + clickCount); + pInvokes.Util._echo("---"); } } @@ -294,7 +292,7 @@ public static void tools_onExit() // Free all the icon images in the registry. //EditorIconRegistry::clear(); - omni.console.Call_Classname("EditorIconRegistry", "clear"); + pInvokes.console.Call_Classname("EditorIconRegistry", "clear"); // Save any Layouts we might be using //GuiFormManager::SaveLayout(LevelBuilder, Default, User); @@ -310,22 +308,22 @@ public static void tools_onExit() foreach (string editor in EditorsToLoad) { string destroyfunction = "destroy" + editor; - if (omni.Util.isFunction(destroyfunction)) - omni.Util._call(destroyfunction); + if (pInvokes.Util.isFunction(destroyfunction)) + pInvokes.Util._call(destroyfunction); } } public static void LoadResources(string path) { string resourcesPath = path + "resources/"; - string resourcesList = omni.Util.getDirectoryList(resourcesPath, 0); + string resourcesList = pInvokes.Util.getDirectoryList(resourcesPath, 0); - int wordCount = omni.Util.getFieldCount(resourcesList); + int wordCount = pInvokes.Util.getFieldCount(resourcesList); for (int i = 0; i < wordCount; i++) { - string resource = omni.Util.getField(resourcesList, i); - if (omni.Util.isFile(resourcesPath + resource + "/resourceDatabase.cs")) - omni.console.Call_Classname("ResourceObject", "load", new string[] {path, resource}); + string resource = pInvokes.Util.getField(resourcesList, i); + if (pInvokes.Util.isFile(resourcesPath + resource + "/resourceDatabase.cs")) + pInvokes.console.Call_Classname("ResourceObject", "load", new string[] {path, resource}); } } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/PhysicsToolsMenu.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/PhysicsToolsMenu.cs index 05d696ef..ab3d484e 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/PhysicsToolsMenu.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/PhysicsToolsMenu.cs @@ -46,7 +46,7 @@ public class PhysicsToolsMenu : MenuBuilder public override void onMenuSelect() { - bool isEnabled = omni.Util.physicsSimulationEnabled(); + bool isEnabled = Util.physicsSimulationEnabled(); string itemText = !isEnabled ? "Start Simulation" : "Pause Simulation"; string itemCommand = !isEnabled ? "physicsStartSimulation( \"client\" );physicsStartSimulation( \"server\" );" : "physicsStopSimulation( \"client\" );physicsStopSimulation( \"server\" );"; diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/main.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/main.cs index 0a551e2e..9c841518 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/main.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/main.cs @@ -43,16 +43,14 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.physicsTools { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializePhysicsTools() { Omni.self.Print(" % - Initializing Physics Tools"); - if (!omni.Util.physicsPluginPresent()) + if (!pInvokes.Util.physicsPluginPresent()) { - omni.Util._echo("No physics plugin exists."); + pInvokes.Util._echo("No physics plugin exists."); return; } ActionMap globalactionmap = "globalactionmap"; @@ -73,19 +71,19 @@ public static void destroyPhysicsTools() [ConsoleInteraction] public static void physicsToggleSimulation() { - bool isEnabled = omni.Util.physicsSimulationEnabled(); + bool isEnabled = pInvokes.Util.physicsSimulationEnabled(); if (isEnabled) { // physicsStateText.setText("Simulation is paused."); - omni.Util._echo("Simulation is paused."); - omni.Util.physicsStopSimulation("client"); - omni.Util.physicsStopSimulation("server"); + pInvokes.Util._echo("Simulation is paused."); + pInvokes.Util.physicsStopSimulation("client"); + pInvokes.Util.physicsStopSimulation("server"); } else { - omni.Util._echo("Simulation is unpaused."); - omni.Util.physicsStartSimulation("client"); - omni.Util.physicsStartSimulation("server"); + pInvokes.Util._echo("Simulation is unpaused."); + pInvokes.Util.physicsStartSimulation("client"); + pInvokes.Util.physicsStartSimulation("server"); } } } diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/levelInfo.cs b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/levelInfo.cs index 64531974..4412da39 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/levelInfo.cs +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Models.User/GameCode/levelInfo.cs @@ -46,7 +46,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode { public class levelInfo { - private static readonly pInvokes omni = new pInvokes(); //------------------------------------------------------------------------------ // Loading info is text displayed on the client side while the mission // is being loaded. This information is extracted from the mission file @@ -100,10 +99,10 @@ public static void BuildLoadInfo(string mission) infoObject += line + " "; } } - omni.console.Eval(infoObject); + pInvokes.console.Eval(infoObject); } else - omni.console.error(string.Format("Level File {0} not found.", mission)); + pInvokes.console.error(string.Format("Level File {0} not found.", mission)); } //------------------------------------------------------------------------------ @@ -116,10 +115,10 @@ public static void DumpLoadInfo() { LevelInfo thelevelinfo = "theLevelInfo"; - omni.console.print("Level Name: " + thelevelinfo["name"]); - omni.console.print("Level Description:"); + pInvokes.console.print("Level Name: " + thelevelinfo["name"]); + pInvokes.console.print("Level Description:"); for (int i = 0; thelevelinfo["desc[" + i + "]"] != ""; i++) - omni.console.print(" " + thelevelinfo["desc[" + i + "]"]); + pInvokes.console.print(" " + thelevelinfo["desc[" + i + "]"]); } } } \ No newline at end of file diff --git a/Templates/C#-Empty/Winterleaf.Demo.Full/Winterleaf.Demo.Full.csproj b/Templates/C#-Empty/Winterleaf.Demo.Full/Winterleaf.Demo.Full.csproj index 9a201628..a4f35b55 100644 --- a/Templates/C#-Empty/Winterleaf.Demo.Full/Winterleaf.Demo.Full.csproj +++ b/Templates/C#-Empty/Winterleaf.Demo.Full/Winterleaf.Demo.Full.csproj @@ -1305,7 +1305,9 @@ Winterleaf.Engine - + + + // NewElement /> @endtsexample @see readComment()) +/// @brief Add the given comment as a child of the document. +/// @param comment String containing the comment. +/// +/// @tsexample +/// // Create a new XML document with a header, a comment and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addComment(\"This is a test comment\"); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // !--This is a test comment--> +/// // NewElement /> +/// @endtsexample +/// +/// @see readComment()) +/// /// public void addComment(string simxmldocument, string comment){ @@ -20142,7 +27724,34 @@ public void addComment(string simxmldocument, string comment){ m_ts.fnSimXMLDocument_addComment(simxmldocument, comment); } /// -/// @brief Add the given text as a child of current Element. Use getData() to retrieve any text from the current Element. addData() and addText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added data. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addData(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getData() @see addText() @see getText() @see removeText()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getData() to retrieve any text from the current Element. +/// +/// addData() and addText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added data. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addData(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public void addData(string simxmldocument, string text){ @@ -20150,7 +27759,24 @@ public void addData(string simxmldocument, string text){ m_ts.fnSimXMLDocument_addData(simxmldocument, text); } /// -/// @brief Add a XML header to a document. Sometimes called a declaration, you typically add a standard header to the document before adding any elements. SimXMLDocument always produces the following header: ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> @tsexample // Create a new XML document with just a header and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement /> @endtsexample) +/// @brief Add a XML header to a document. +/// +/// Sometimes called a declaration, you typically add a standard header to +/// the document before adding any elements. SimXMLDocument always produces +/// the following header: +/// ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// +/// @tsexample +/// // Create a new XML document with just a header and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement /> +/// @endtsexample) +/// /// public void addHeader(string simxmldocument){ @@ -20158,7 +27784,17 @@ public void addHeader(string simxmldocument){ m_ts.fnSimXMLDocument_addHeader(simxmldocument); } /// -/// @brief Create a new element with the given name as child of current Element's parent and push it onto the Element stack making it the current one. @note This differs from pushNewElement() in that it adds the new Element to the current Element's parent (or document if there is no parent Element). This makes the new Element a sibling of the current one. @param name XML tag for the new Element. @see pushNewElement()) +/// @brief Create a new element with the given name as child of current Element's +/// parent and push it onto the Element stack making it the current one. +/// +/// @note This differs from pushNewElement() in that it adds the new Element to the +/// current Element's parent (or document if there is no parent Element). This makes +/// the new Element a sibling of the current one. +/// +/// @param name XML tag for the new Element. +/// +/// @see pushNewElement()) +/// /// public void addNewElement(string simxmldocument, string name){ @@ -20166,7 +27802,33 @@ public void addNewElement(string simxmldocument, string name){ m_ts.fnSimXMLDocument_addNewElement(simxmldocument, name); } /// -/// @brief Add the given text as a child of current Element. Use getText() to retrieve any text from the current Element and removeText() to clear any text. addText() and addData() may be used interchangeably. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added text. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addText(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getText() @see removeText() @see addData() @see getData()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getText() to retrieve any text from the current Element and removeText() +/// to clear any text. +/// +/// addText() and addData() may be used interchangeably. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added text. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addText(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public void addText(string simxmldocument, string text){ @@ -20174,7 +27836,10 @@ public void addText(string simxmldocument, string text){ m_ts.fnSimXMLDocument_addText(simxmldocument, text); } /// -/// @brief Get a string attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The attribute string if found. Otherwise returns an empty string.) +/// @brief Get a string attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The attribute string if found. Otherwise returns an empty string.) +/// /// public string attribute(string simxmldocument, string attributeName){ @@ -20182,7 +27847,10 @@ public string attribute(string simxmldocument, string attributeName){ return m_ts.fnSimXMLDocument_attribute(simxmldocument, attributeName); } /// -/// @brief Tests if the requested attribute exists. @param attributeName Name of attribute being queried for. @return True if the attribute exists.) +/// @brief Tests if the requested attribute exists. +/// @param attributeName Name of attribute being queried for. +/// @return True if the attribute exists.) +/// /// public bool attributeExists(string simxmldocument, string attributeName){ @@ -20190,7 +27858,12 @@ public bool attributeExists(string simxmldocument, string attributeName){ return m_ts.fnSimXMLDocument_attributeExists(simxmldocument, attributeName); } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using reset() @see reset()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using reset() +/// +/// @see reset()) +/// /// public void clear(string simxmldocument){ @@ -20199,6 +27872,7 @@ public void clear(string simxmldocument){ } /// /// @brief Clear the last error description.) +/// /// public void clearError(string simxmldocument){ @@ -20206,7 +27880,10 @@ public void clearError(string simxmldocument){ m_ts.fnSimXMLDocument_clearError(simxmldocument); } /// -/// @brief Get the Element's value if it exists. Usually returns the text from the Element. @return The value from the Element, or an empty string if none is found.) +/// @brief Get the Element's value if it exists. +/// Usually returns the text from the Element. +/// @return The value from the Element, or an empty string if none is found.) +/// /// public string elementValue(string simxmldocument){ @@ -20214,7 +27891,12 @@ public string elementValue(string simxmldocument){ return m_ts.fnSimXMLDocument_elementValue(simxmldocument); } /// -/// @brief Obtain the name of the current Element's first attribute. @return String containing the first attribute's name, or an empty string if none is found. @see nextAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Obtain the name of the current Element's first attribute. +/// @return String containing the first attribute's name, or an empty string if none is found. +/// @see nextAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string firstAttribute(string simxmldocument){ @@ -20222,7 +27904,39 @@ public string firstAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_firstAttribute(simxmldocument); } /// -/// @brief Gets the text from the current Element. Use addData() to add text to the current Element. getData() and getText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some data/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's data ('Some data' in this example) // into 'result' %result = %x.getData(); echo( %result ); @endtsexample @see addData() @see addText() @see getText() @see removeText()) +/// @brief Gets the text from the current Element. +/// +/// Use addData() to add text to the current Element. +/// +/// getData() and getText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some data/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's data ('Some data' in this example) +/// // into 'result' +/// %result = %x.getData(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public string getData(string simxmldocument){ @@ -20230,7 +27944,9 @@ public string getData(string simxmldocument){ return m_ts.fnSimXMLDocument_getData(simxmldocument); } /// -/// @brief Get last error description. @return A string of the last error message.) +/// @brief Get last error description. +/// @return A string of the last error message.) +/// /// public string getErrorDesc(string simxmldocument){ @@ -20238,7 +27954,38 @@ public string getErrorDesc(string simxmldocument){ return m_ts.fnSimXMLDocument_getErrorDesc(simxmldocument); } /// -/// @brief Gets the text from the current Element. Use addText() to add text to the current Element and removeText() to clear any text. getText() and getData() may be used interchangeably. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample @see addText() @see removeText() @see addData() @see getData()) +/// @brief Gets the text from the current Element. +/// +/// Use addText() to add text to the current Element and removeText() +/// to clear any text. +/// +/// getText() and getData() may be used interchangeably. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public string getText(string simxmldocument){ @@ -20246,7 +27993,12 @@ public string getText(string simxmldocument){ return m_ts.fnSimXMLDocument_getText(simxmldocument); } /// -/// @brief Obtain the name of the current Element's last attribute. @return String containing the last attribute's name, or an empty string if none is found. @see prevAttribute() @see firstAttribute() @see lastAttribute()) +/// @brief Obtain the name of the current Element's last attribute. +/// @return String containing the last attribute's name, or an empty string if none is found. +/// @see prevAttribute() +/// @see firstAttribute() +/// @see lastAttribute()) +/// /// public string lastAttribute(string simxmldocument){ @@ -20254,7 +28006,11 @@ public string lastAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_lastAttribute(simxmldocument); } /// -/// @brief Load in given filename and prepare it for use. @note Clears the current document's contents. @param fileName Name and path of XML document @return True if the file was loaded successfully.) +/// @brief Load in given filename and prepare it for use. +/// @note Clears the current document's contents. +/// @param fileName Name and path of XML document +/// @return True if the file was loaded successfully.) +/// /// public bool loadFile(string simxmldocument, string fileName){ @@ -20262,7 +28018,12 @@ public bool loadFile(string simxmldocument, string fileName){ return m_ts.fnSimXMLDocument_loadFile(simxmldocument, fileName); } /// -/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). @return String containing the next attribute's name, or an empty string if none is found. @see firstAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). +/// @return String containing the next attribute's name, or an empty string if none is found. +/// @see firstAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string nextAttribute(string simxmldocument){ @@ -20270,7 +28031,10 @@ public string nextAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_nextAttribute(simxmldocument); } /// -/// @brief Put the next sibling Element with the given name on the stack, making it the current one. @param name String containing name of the next sibling. @return True if the Element was found and made the current one.) +/// @brief Put the next sibling Element with the given name on the stack, making it the current one. +/// @param name String containing name of the next sibling. +/// @return True if the Element was found and made the current one.) +/// /// public bool nextSiblingElement(string simxmldocument, string name){ @@ -20278,7 +28042,10 @@ public bool nextSiblingElement(string simxmldocument, string name){ return m_ts.fnSimXMLDocument_nextSiblingElement(simxmldocument, name); } /// -/// @brief Create a document from a XML string. @note Clears the current document's contents. @param xmlString Valid XML to parse and store as a document.) +/// @brief Create a document from a XML string. +/// @note Clears the current document's contents. +/// @param xmlString Valid XML to parse and store as a document.) +/// /// public void parse(string simxmldocument, string xmlString){ @@ -20287,6 +28054,7 @@ public void parse(string simxmldocument, string xmlString){ } /// /// @brief Pop the last Element off the stack.) +/// /// public void popElement(string simxmldocument){ @@ -20294,7 +28062,12 @@ public void popElement(string simxmldocument){ m_ts.fnSimXMLDocument_popElement(simxmldocument); } /// -/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). @return String containing the previous attribute's name, or an empty string if none is found. @see lastAttribute() @see firstAttribute() @see nextAttribute()) +/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). +/// @return String containing the previous attribute's name, or an empty string if none is found. +/// @see lastAttribute() +/// @see firstAttribute() +/// @see nextAttribute()) +/// /// public string prevAttribute(string simxmldocument){ @@ -20302,7 +28075,10 @@ public string prevAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_prevAttribute(simxmldocument); } /// -/// @brief Push the child Element at the given index onto the stack, making it the current one. @param index Numerical index of Element being pushed. @return True if the Element was found and made the current one.) +/// @brief Push the child Element at the given index onto the stack, making it the current one. +/// @param index Numerical index of Element being pushed. +/// @return True if the Element was found and made the current one.) +/// /// public bool pushChildElement(string simxmldocument, int index){ @@ -20310,7 +28086,29 @@ public bool pushChildElement(string simxmldocument, int index){ return m_ts.fnSimXMLDocument_pushChildElement(simxmldocument, index); } /// -/// @brief Push the first child Element with the given name onto the stack, making it the current Element. @param name String containing name of the child Element. @return True if the Element was found and made the current one. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample) +/// @brief Push the first child Element with the given name onto the stack, making it the current Element. +/// +/// @param name String containing name of the child Element. +/// @return True if the Element was found and made the current one. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample) +/// /// public bool pushFirstChildElement(string simxmldocument, string name){ @@ -20318,7 +28116,16 @@ public bool pushFirstChildElement(string simxmldocument, string name){ return m_ts.fnSimXMLDocument_pushFirstChildElement(simxmldocument, name); } /// -/// @brief Create a new element with the given name as child of current Element and push it onto the Element stack making it the current one. @note This differs from addNewElement() in that it adds the new Element as a child of the current Element (or a child of the document if no Element exists). @param name XML tag for the new Element. @see addNewElement()) +/// @brief Create a new element with the given name as child of current Element +/// and push it onto the Element stack making it the current one. +/// +/// @note This differs from addNewElement() in that it adds the new Element as a +/// child of the current Element (or a child of the document if no Element exists). +/// +/// @param name XML tag for the new Element. +/// +/// @see addNewElement()) +/// /// public void pushNewElement(string simxmldocument, string name){ @@ -20326,7 +28133,18 @@ public void pushNewElement(string simxmldocument, string name){ m_ts.fnSimXMLDocument_pushNewElement(simxmldocument, name); } /// -/// Gives the comment at the specified index, if any. Unlike addComment() that only works at the document level, readComment() may read comments from the document or any child Element. The current Element (or document if no Elements have been pushed to the stack) is the parent for any comments, and the provided index is the number of comments in to read back. @param index Comment index number to query from the current Element stack @return String containing the comment, or an empty string if no comment is found. @see addComment()) +/// Gives the comment at the specified index, if any. +/// +/// Unlike addComment() that only works at the document level, readComment() may read +/// comments from the document or any child Element. The current Element (or document +/// if no Elements have been pushed to the stack) is the parent for any comments, and the +/// provided index is the number of comments in to read back. +/// +/// @param index Comment index number to query from the current Element stack +/// @return String containing the comment, or an empty string if no comment is found. +/// +/// @see addComment()) +/// /// public string readComment(string simxmldocument, int index){ @@ -20334,7 +28152,18 @@ public string readComment(string simxmldocument, int index){ return m_ts.fnSimXMLDocument_readComment(simxmldocument, index); } /// -/// @brief Remove any text on the current Element. Use getText() to retrieve any text from the current Element and addText() to add text to the current Element. As getData() and addData() are equivalent to getText() and addText(), removeText() will also remove any data from the current Element. @see addText() @see getText() @see addData() @see getData()) +/// @brief Remove any text on the current Element. +/// +/// Use getText() to retrieve any text from the current Element and addText() +/// to add text to the current Element. As getData() and addData() are equivalent +/// to getText() and addText(), removeText() will also remove any data from the +/// current Element. +/// +/// @see addText() +/// @see getText() +/// @see addData() +/// @see getData()) +/// /// public void removeText(string simxmldocument){ @@ -20342,7 +28171,12 @@ public void removeText(string simxmldocument){ m_ts.fnSimXMLDocument_removeText(simxmldocument); } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using clear() @see clear()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using clear() +/// +/// @see clear()) +/// /// public void reset(string simxmldocument){ @@ -20350,7 +28184,10 @@ public void reset(string simxmldocument){ m_ts.fnSimXMLDocument_reset(simxmldocument); } /// -/// @brief Save document to the given file name. @param fileName Path and name of XML file to save to. @return True if the file was successfully saved.) +/// @brief Save document to the given file name. +/// @param fileName Path and name of XML file to save to. +/// @return True if the file was successfully saved.) +/// /// public bool saveFile(string simxmldocument, string fileName){ @@ -20358,7 +28195,10 @@ public bool saveFile(string simxmldocument, string fileName){ return m_ts.fnSimXMLDocument_saveFile(simxmldocument, fileName); } /// -/// @brief Set the attribute of the current Element on the stack to the given value. @param attributeName Name of attribute being changed @param value New value to assign to the attribute) +/// @brief Set the attribute of the current Element on the stack to the given value. +/// @param attributeName Name of attribute being changed +/// @param value New value to assign to the attribute) +/// /// public void setAttribute(string simxmldocument, string attributeName, string value){ @@ -20366,7 +28206,9 @@ public void setAttribute(string simxmldocument, string attributeName, string va m_ts.fnSimXMLDocument_setAttribute(simxmldocument, attributeName, value); } /// -/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. @param objectID ID of SimObject being copied.) +/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. +/// @param objectID ID of SimObject being copied.) +/// /// public void setObjectAttributes(string simxmldocument, string objectID){ @@ -20379,14 +28221,9 @@ public void setObjectAttributes(string simxmldocument, string objectID){ /// public class SkyBoxObject { -private Omni m_ts; - /// - /// - /// - /// -public SkyBoxObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void SkyBox_postApply(string skybox){ @@ -20399,14 +28236,12 @@ public void SkyBox_postApply(string skybox){ /// public class SpawnSphereObject { -private Omni m_ts; - /// - /// - /// - /// -public SpawnSphereObject(ref Omni ts){m_ts = ts;} /// -/// ([string additionalProps]) Spawns the object based on the SpawnSphere's class, datablock, properties, and script settings. Allows you to pass in extra properties. @hide ) +/// ([string additionalProps]) Spawns the object based on the SpawnSphere's +/// class, datablock, properties, and script settings. Allows you to pass in +/// extra properties. +/// @hide ) +/// /// public int SpawnSphere_spawnObject(string spawnsphere, string additionalProps){ @@ -20419,14 +28254,9 @@ public int SpawnSphere_spawnObject(string spawnsphere, string additionalProps){ /// public class StaticShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public StaticShapeObject(ref Omni ts){m_ts = ts;} /// /// @internal) +/// /// public bool StaticShape_getPoweredState(string staticshape){ @@ -20434,7 +28264,9 @@ public bool StaticShape_getPoweredState(string staticshape){ return m_ts.fn_StaticShape_getPoweredState(staticshape); } /// -/// (bool isPowered) @internal) +/// (bool isPowered) +/// @internal) +/// /// public void StaticShape_setPoweredState(string staticshape, bool isPowered){ @@ -20447,14 +28279,11 @@ public void StaticShape_setPoweredState(string staticshape, bool isPowered){ /// public class StreamObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public StreamObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Copy from another StreamObject into this StreamObject @param other The StreamObject to copy from. @return True if the copy was successful.) +/// @brief Copy from another StreamObject into this StreamObject +/// @param other The StreamObject to copy from. +/// @return True if the copy was successful.) +/// /// public bool copyFrom(string streamobject, string other){ @@ -20462,7 +28291,36 @@ public bool copyFrom(string streamobject, string other){ return m_ts.fnStreamObject_copyFrom(streamobject, other); } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains two lines of text repeated: // Hello World // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Get the position of the stream %position = %fsObject.getPosition(); // Print the current position // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline echo(%position); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see setPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains two lines of text repeated: +/// // Hello World +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Get the position of the stream +/// %position = %fsObject.getPosition(); +/// // Print the current position +/// // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline +/// echo(%position); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see setPosition()) +/// /// public int getPosition(string streamobject){ @@ -20470,7 +28328,36 @@ public int getPosition(string streamobject){ return m_ts.fnStreamObject_getPosition(streamobject); } /// -/// @brief Gets a printable string form of the stream's status @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing status constant, one of the following: OK - Stream is active and no file errors IOError - Something went wrong during read or writing the stream EOS - End of Stream reached (mostly for reads) IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn Closed - Tried to operate on a closed stream (or detached filter) UnknownError - Catch all for an error of some kind Invalid - Entire stream is invalid) +/// @brief Gets a printable string form of the stream's status +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing status constant, one of the following: +/// +/// OK - Stream is active and no file errors +/// +/// IOError - Something went wrong during read or writing the stream +/// +/// EOS - End of Stream reached (mostly for reads) +/// +/// IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn +/// +/// Closed - Tried to operate on a closed stream (or detached filter) +/// +/// UnknownError - Catch all for an error of some kind +/// +/// Invalid - Entire stream is invalid) +/// /// public string getStatus(string streamobject){ @@ -20478,7 +28365,30 @@ public string getStatus(string streamobject){ return m_ts.fnStreamObject_getStatus(streamobject); } /// -/// @brief Gets the size of the stream The size is dependent on the type of stream being used. If it is a file stream, returned value will be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject.open(\"./test.txt\", \"read\"); // Found out how large the file stream is // Then print it to the console // Should be 22 %streamSize = %fsObject.getStreamSize(); echo(%streamSize); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Size of stream, in bytes) +/// @brief Gets the size of the stream +/// +/// The size is dependent on the type of stream being used. If it is a file stream, returned value will +/// be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Found out how large the file stream is +/// // Then print it to the console +/// // Should be 22 +/// %streamSize = %fsObject.getStreamSize(); +/// echo(%streamSize); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Size of stream, in bytes) +/// /// public int getStreamSize(string streamobject){ @@ -20486,7 +28396,32 @@ public int getStreamSize(string streamobject){ return m_ts.fnStreamObject_getStreamSize(streamobject); } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOS. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOF() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOS()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOS. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOF() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOS()) +/// /// public bool isEOF(string streamobject){ @@ -20494,7 +28429,32 @@ public bool isEOF(string streamobject){ return m_ts.fnStreamObject_isEOF(streamobject); } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOF. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOS() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOF()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOF. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOS() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOF()) +/// /// public bool isEOS(string streamobject){ @@ -20502,7 +28462,30 @@ public bool isEOS(string streamobject){ return m_ts.fnStreamObject_isEOS(streamobject); } /// -/// @brief Read a line from the stream. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file stream object for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject = new FileStreamObject(); %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Print the line we just read echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing the line of data that was just read @see writeLine()) +/// @brief Read a line from the stream. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file stream object for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject = new FileStreamObject(); +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Print the line we just read +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing the line of data that was just read +/// +/// @see writeLine()) +/// /// public string readLine(string streamobject){ @@ -20510,7 +28493,15 @@ public string readLine(string streamobject){ return m_ts.fnStreamObject_readLine(streamobject); } /// -/// @brief Read in a string up to the given maximum number of characters. @param maxLength The maximum number of characters to read in. @return The string that was read from the stream. @see writeLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string up to the given maximum number of characters. +/// @param maxLength The maximum number of characters to read in. +/// @return The string that was read from the stream. +/// @see writeLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string readLongString(string streamobject, int maxLength){ @@ -20518,7 +28509,14 @@ public string readLongString(string streamobject, int maxLength){ return m_ts.fnStreamObject_readLongString(streamobject, maxLength); } /// -/// @brief Read a string up to a maximum of 256 characters @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read a string up to a maximum of 256 characters +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string readString(string streamobject){ @@ -20526,7 +28524,16 @@ public string readString(string streamobject){ return m_ts.fnStreamObject_readString(streamobject); } /// -/// @brief Read in a string and place it on the string table. @param caseSensitive If false then case will not be taken into account when attempting to match the read in string with what is already in the string table. @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string and place it on the string table. +/// @param caseSensitive If false then case will not be taken into account when attempting +/// to match the read in string with what is already in the string table. +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string readSTString(string streamobject, bool caseSensitive = false){ @@ -20534,7 +28541,35 @@ public string readSTString(string streamobject, bool caseSensitive = false){ return m_ts.fnStreamObject_readSTString(streamobject, caseSensitive); } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // 11111111111 // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Skip ahead by 12, which will bypass the first line entirely %fsObject.setPosition(12); // Read in the next line %line = %fsObject.readLine(); // Print the line just read in, should be \"Hello World\" echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see getPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // 11111111111 +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Skip ahead by 12, which will bypass the first line entirely +/// %fsObject.setPosition(12); +/// // Read in the next line +/// %line = %fsObject.readLine(); +/// // Print the line just read in, should be \"Hello World\" +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see getPosition()) +/// /// public bool setPosition(string streamobject, int newPosition){ @@ -20542,7 +28577,29 @@ public bool setPosition(string streamobject, int newPosition){ return m_ts.fnStreamObject_setPosition(streamobject, newPosition); } /// -/// @brief Write a line to the stream, if it was opened for writing. There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param line The data we are writing out to file. @tsexample // Create a file stream %fsObject = new FileStreamObject(); // Open the file for writing // If it does not exist, it is created. If it does exist, the file is cleared %fsObject.open(\"./test.txt\", \"write\"); // Write a line to the file %fsObject.writeLine(\"Hello World\"); // Write another line to the file %fsObject.writeLine(\"Documentation Rocks!\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see readLine()) +/// @brief Write a line to the stream, if it was opened for writing. +/// +/// There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param line The data we are writing out to file. +/// +/// @tsexample +/// // Create a file stream +/// %fsObject = new FileStreamObject(); +/// // Open the file for writing +/// // If it does not exist, it is created. If it does exist, the file is cleared +/// %fsObject.open(\"./test.txt\", \"write\"); +/// // Write a line to the file +/// %fsObject.writeLine(\"Hello World\"); +/// // Write another line to the file +/// %fsObject.writeLine(\"Documentation Rocks!\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see readLine()) +/// /// public void writeLine(string streamobject, string line){ @@ -20550,7 +28607,15 @@ public void writeLine(string streamobject, string line){ m_ts.fnStreamObject_writeLine(streamobject, line); } /// -/// @brief Write out a string up to the maximum number of characters. @param maxLength The maximum number of characters that will be written. @param string The string to write out to the stream. @see readLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string up to the maximum number of characters. +/// @param maxLength The maximum number of characters that will be written. +/// @param string The string to write out to the stream. +/// @see readLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void writeLongString(string streamobject, int maxLength, string stringx){ @@ -20558,7 +28623,16 @@ public void writeLongString(string streamobject, int maxLength, string stringx) m_ts.fnStreamObject_writeLongString(streamobject, maxLength, stringx); } /// -/// @brief Write out a string with a default maximum length of 256 characters. @param string The string to write out to the stream @param maxLength The maximum string length to write out with a default of 256 characters. This value should not be larger than 256 as it is written to the stream as a single byte. @see readString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string with a default maximum length of 256 characters. +/// @param string The string to write out to the stream +/// @param maxLength The maximum string length to write out with a default of 256 characters. This +/// value should not be larger than 256 as it is written to the stream as a single byte. +/// @see readString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void writeString(string streamobject, string stringx, int maxLength = 256){ @@ -20571,14 +28645,9 @@ public void writeString(string streamobject, string stringx, int maxLength = 25 /// public class SunObject { -private Omni m_ts; - /// - /// - /// - /// -public SunObject(ref Omni ts){m_ts = ts;} /// /// animate( F32 duration, F32 startAzimuth, F32 endAzimuth, F32 startElevation, F32 endElevation )) +/// /// public void Sun_animate(string sun, float duration, float startAzimuth, float endAzimuth, float startElevation, float endElevation){ @@ -20587,6 +28656,7 @@ public void Sun_animate(string sun, float duration, float startAzimuth, float e } /// /// ) +/// /// public void Sun_apply(string sun){ @@ -20599,14 +28669,19 @@ public void Sun_apply(string sun){ /// public class TCPObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public TCPObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Connect to the given address. @param address Server address (including port) to connect to. @tsexample // Set the address. %address = \"www.garagegames.com:80\"; // Inform this TCPObject to connect to the specified address. %thisTCPObj.connect(%address); @endtsexample) +/// @brief Connect to the given address. +/// +/// @param address Server address (including port) to connect to. +/// +/// @tsexample +/// // Set the address. +/// %address = \"www.garagegames.com:80\"; +/// +/// // Inform this TCPObject to connect to the specified address. +/// %thisTCPObj.connect(%address); +/// @endtsexample) +/// /// public void connect(string tcpobject, string address){ @@ -20614,7 +28689,13 @@ public void connect(string tcpobject, string address){ m_ts.fnTCPObject_connect(tcpobject, address); } /// -/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. @tsexample // Inform this TCPObject to disconnect from anything it is currently connected to. %thisTCPObj.disconnect(); @endtsexample) +/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. +/// +/// @tsexample +/// // Inform this TCPObject to disconnect from anything it is currently connected to. +/// %thisTCPObj.disconnect(); +/// @endtsexample) +/// /// public void disconnect(string tcpobject){ @@ -20622,15 +28703,58 @@ public void disconnect(string tcpobject){ m_ts.fnTCPObject_disconnect(tcpobject); } /// -/// @brief Start listening on the specified port for connections. This method starts a listener which looks for incoming TCP connections to a port. You must overload the onConnectionRequest callback to create a new TCPObject to read, write, or reject the new connection. @param port Port for this TCPObject to start listening for connections on. @tsexample // Create a listener on port 8080. new TCPObject( TCPListener ); TCPListener.listen( 8080 ); function TCPListener::onConnectionRequest( %this, %address, %id ) { // Create a new object to manage the connection. new TCPObject( TCPClient, %id ); } function TCPClient::onLine( %this, %line ) { // Print the line of text from client. echo( %line ); } @endtsexample) +/// @brief Start listening on the specified port for connections. +/// +/// This method starts a listener which looks for incoming TCP connections to a port. +/// You must overload the onConnectionRequest callback to create a new TCPObject to +/// read, write, or reject the new connection. +/// +/// @param port Port for this TCPObject to start listening for connections on. +/// +/// @tsexample +/// +/// // Create a listener on port 8080. +/// new TCPObject( TCPListener ); +/// TCPListener.listen( 8080 ); +/// +/// function TCPListener::onConnectionRequest( %this, %address, %id ) +/// { +/// // Create a new object to manage the connection. +/// new TCPObject( TCPClient, %id ); +/// } +/// +/// function TCPClient::onLine( %this, %line ) +/// { +/// // Print the line of text from client. +/// echo( %line ); +/// } +/// +/// @endtsexample) +/// /// -public void listen(string tcpobject, int port){ +public void listen(string tcpobject, uint port){ m_ts.fnTCPObject_listen(tcpobject, port); } /// -/// @brief Transmits the data string to the connected computer. This method is used to send text data to the connected computer regardless if we initiated the connection using connect(), or listening to a port using listen(). @param data The data string to send. @tsexample // Set the command data %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" // Send the command to the connected server. %thisTCPObj.send(%data); @endtsexample) +/// @brief Transmits the data string to the connected computer. +/// +/// This method is used to send text data to the connected computer regardless if we initiated the +/// connection using connect(), or listening to a port using listen(). +/// +/// @param data The data string to send. +/// +/// @tsexample +/// // Set the command data +/// %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; +/// %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; +/// %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" +/// +/// // Send the command to the connected server. +/// %thisTCPObj.send(%data); +/// @endtsexample) +/// /// public void send(string tcpobject, string data){ @@ -20643,14 +28767,9 @@ public void send(string tcpobject, string data){ /// public class TerrainBlockObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainBlockObject(ref Omni ts){m_ts = ts;} /// /// png), (string filename, [string format]) - export the terrain block's heightmap to a bitmap file (default: png) ) +/// /// public bool TerrainBlock_exportHeightMap(string terrainblock, string fileNameStr, string format = "png"){ @@ -20659,6 +28778,7 @@ public bool TerrainBlock_exportHeightMap(string terrainblock, string fileNameSt } /// /// png), (string filePrefix, [string format]) - export the terrain block's layer maps to bitmap files (default: png) ) +/// /// public bool TerrainBlock_exportLayerMaps(string terrainblock, string filePrefixStr, string format = "png"){ @@ -20666,7 +28786,12 @@ public bool TerrainBlock_exportLayerMaps(string terrainblock, string filePrefix return m_ts.fn_TerrainBlock_exportLayerMaps(terrainblock, filePrefixStr, format); } /// -/// @brief Saves the terrain block's terrain file to the specified file name. @param fileName Name and path of file to save terrain data to. @return True if file save was successful, false otherwise) +/// @brief Saves the terrain block's terrain file to the specified file name. +/// +/// @param fileName Name and path of file to save terrain data to. +/// +/// @return True if file save was successful, false otherwise) +/// /// public bool save(string terrainblock, string fileName){ @@ -20679,14 +28804,10 @@ public bool save(string terrainblock, string fileName){ /// public class TerrainEditorObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainEditorObject(ref Omni ts){m_ts = ts;} /// -/// ( string matName ) Adds a new material. ) +/// ( string matName ) +/// Adds a new material. ) +/// /// public int TerrainEditor_addMaterial(string terraineditor, string matName){ @@ -20695,6 +28816,7 @@ public int TerrainEditor_addMaterial(string terraineditor, string matName){ } /// /// ), (TerrainBlock terrain)) +/// /// public void TerrainEditor_attachTerrain(string terraineditor, string terrain = ""){ @@ -20702,15 +28824,17 @@ public void TerrainEditor_attachTerrain(string terraineditor, string terrain = m_ts.fn_TerrainEditor_attachTerrain(terraineditor, terrain); } /// -/// (float minHeight, float maxHeight, float minSlope, float maxSlope)) +/// (F32 minHeight, F32 maxHeight, F32 minSlope, F32 maxSlope , F32 coverage)) +/// /// -public void TerrainEditor_autoMaterialLayer(string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope){ +public void TerrainEditor_autoMaterialLayer(string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope, float coverage){ -m_ts.fn_TerrainEditor_autoMaterialLayer(terraineditor, minHeight, maxHeight, minSlope, maxSlope); +m_ts.fn_TerrainEditor_autoMaterialLayer(terraineditor, minHeight, maxHeight, minSlope, maxSlope, coverage); } /// /// ) +/// /// public void TerrainEditor_clearSelection(string terraineditor){ @@ -20719,6 +28843,7 @@ public void TerrainEditor_clearSelection(string terraineditor){ } /// /// (int num)) +/// /// public string TerrainEditor_getActionName(string terraineditor, uint index){ @@ -20727,6 +28852,7 @@ public string TerrainEditor_getActionName(string terraineditor, uint index){ } /// /// ) +/// /// public int TerrainEditor_getActiveTerrain(string terraineditor){ @@ -20735,6 +28861,7 @@ public int TerrainEditor_getActiveTerrain(string terraineditor){ } /// /// Returns a Point2I.) +/// /// public string TerrainEditor_getBrushPos(string terraineditor){ @@ -20743,6 +28870,7 @@ public string TerrainEditor_getBrushPos(string terraineditor){ } /// /// ()) +/// /// public float TerrainEditor_getBrushPressure(string terraineditor){ @@ -20751,6 +28879,7 @@ public float TerrainEditor_getBrushPressure(string terraineditor){ } /// /// ()) +/// /// public string TerrainEditor_getBrushSize(string terraineditor){ @@ -20759,6 +28888,7 @@ public string TerrainEditor_getBrushSize(string terraineditor){ } /// /// ()) +/// /// public float TerrainEditor_getBrushSoftness(string terraineditor){ @@ -20767,6 +28897,7 @@ public float TerrainEditor_getBrushSoftness(string terraineditor){ } /// /// ()) +/// /// public string TerrainEditor_getBrushType(string terraineditor){ @@ -20775,6 +28906,7 @@ public string TerrainEditor_getBrushType(string terraineditor){ } /// /// ) +/// /// public string TerrainEditor_getCurrentAction(string terraineditor){ @@ -20783,6 +28915,7 @@ public string TerrainEditor_getCurrentAction(string terraineditor){ } /// /// Returns the current material count. ) +/// /// public int TerrainEditor_getMaterialCount(string terraineditor){ @@ -20791,6 +28924,7 @@ public int TerrainEditor_getMaterialCount(string terraineditor){ } /// /// ( string name ) - Returns the index of the material with the given name or -1. ) +/// /// public int TerrainEditor_getMaterialIndex(string terraineditor, string name){ @@ -20799,6 +28933,7 @@ public int TerrainEditor_getMaterialIndex(string terraineditor, string name){ } /// /// ( int index ) - Returns the name of the material at the given index. ) +/// /// public string TerrainEditor_getMaterialName(string terraineditor, int index){ @@ -20807,6 +28942,7 @@ public string TerrainEditor_getMaterialName(string terraineditor, int index){ } /// /// () gets the list of current terrain materials.) +/// /// public string TerrainEditor_getMaterials(string terraineditor){ @@ -20815,6 +28951,7 @@ public string TerrainEditor_getMaterials(string terraineditor){ } /// /// ) +/// /// public int TerrainEditor_getNumActions(string terraineditor){ @@ -20823,6 +28960,7 @@ public int TerrainEditor_getNumActions(string terraineditor){ } /// /// ) +/// /// public int TerrainEditor_getNumTextures(string terraineditor){ @@ -20831,6 +28969,7 @@ public int TerrainEditor_getNumTextures(string terraineditor){ } /// /// ) +/// /// public float TerrainEditor_getSlopeLimitMaxAngle(string terraineditor){ @@ -20839,6 +28978,7 @@ public float TerrainEditor_getSlopeLimitMaxAngle(string terraineditor){ } /// /// ) +/// /// public float TerrainEditor_getSlopeLimitMinAngle(string terraineditor){ @@ -20847,6 +28987,7 @@ public float TerrainEditor_getSlopeLimitMinAngle(string terraineditor){ } /// /// (S32 index)) +/// /// public int TerrainEditor_getTerrainBlock(string terraineditor, int index){ @@ -20855,6 +28996,7 @@ public int TerrainEditor_getTerrainBlock(string terraineditor, int index){ } /// /// ()) +/// /// public int TerrainEditor_getTerrainBlockCount(string terraineditor){ @@ -20863,6 +29005,7 @@ public int TerrainEditor_getTerrainBlockCount(string terraineditor){ } /// /// () gets the list of current terrain materials for all terrain blocks.) +/// /// public string TerrainEditor_getTerrainBlocksMaterialList(string terraineditor){ @@ -20870,7 +29013,12 @@ public string TerrainEditor_getTerrainBlocksMaterialList(string terraineditor){ return m_ts.fn_TerrainEditor_getTerrainBlocksMaterialList(terraineditor); } /// -/// , , ), (x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found).) +/// , , ), +/// (x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found).) +/// /// public int TerrainEditor_getTerrainUnderWorldPoint(string terraineditor, string ptOrX = "", string Y = "", string Z = ""){ @@ -20879,6 +29027,7 @@ public int TerrainEditor_getTerrainUnderWorldPoint(string terraineditor, string } /// /// ) +/// /// public void TerrainEditor_markEmptySquares(string terraineditor){ @@ -20887,6 +29036,7 @@ public void TerrainEditor_markEmptySquares(string terraineditor){ } /// /// ) +/// /// public void TerrainEditor_mirrorTerrain(string terraineditor, int mirrorIndex){ @@ -20895,6 +29045,7 @@ public void TerrainEditor_mirrorTerrain(string terraineditor, int mirrorIndex){ } /// /// ), (string action=NULL)) +/// /// public void TerrainEditor_processAction(string terraineditor, string action = ""){ @@ -20903,6 +29054,7 @@ public void TerrainEditor_processAction(string terraineditor, string action = " } /// /// ( int index ) - Remove the material at the given index. ) +/// /// public void TerrainEditor_removeMaterial(string terraineditor, int index){ @@ -20910,7 +29062,9 @@ public void TerrainEditor_removeMaterial(string terraineditor, int index){ m_ts.fn_TerrainEditor_removeMaterial(terraineditor, index); } /// -/// ( int index, int order ) - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// ( int index, int order ) +/// - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// /// public void TerrainEditor_reorderMaterial(string terraineditor, int index, int orderPos){ @@ -20919,6 +29073,7 @@ public void TerrainEditor_reorderMaterial(string terraineditor, int index, int } /// /// (bool clear)) +/// /// public void TerrainEditor_resetSelWeights(string terraineditor, bool clear){ @@ -20927,6 +29082,7 @@ public void TerrainEditor_resetSelWeights(string terraineditor, bool clear){ } /// /// (string action_name)) +/// /// public void TerrainEditor_setAction(string terraineditor, string action_name){ @@ -20935,6 +29091,7 @@ public void TerrainEditor_setAction(string terraineditor, string action_name){ } /// /// Location) +/// /// public void TerrainEditor_setBrushPos(string terraineditor, Point2I pos){ @@ -20943,6 +29100,7 @@ public void TerrainEditor_setBrushPos(string terraineditor, Point2I pos){ } /// /// (float pressure)) +/// /// public void TerrainEditor_setBrushPressure(string terraineditor, float pressure){ @@ -20951,6 +29109,7 @@ public void TerrainEditor_setBrushPressure(string terraineditor, float pressure } /// /// (int w [, int h])) +/// /// public void TerrainEditor_setBrushSize(string terraineditor, int w, int h = 0){ @@ -20959,6 +29118,7 @@ public void TerrainEditor_setBrushSize(string terraineditor, int w, int h = 0){ } /// /// (float softness)) +/// /// public void TerrainEditor_setBrushSoftness(string terraineditor, float softness){ @@ -20966,7 +29126,9 @@ public void TerrainEditor_setBrushSoftness(string terraineditor, float softness m_ts.fn_TerrainEditor_setBrushSoftness(terraineditor, softness); } /// -/// (string type) One of box, ellipse, selection.) +/// (string type) +/// One of box, ellipse, selection.) +/// /// public void TerrainEditor_setBrushType(string terraineditor, string type){ @@ -20975,6 +29137,7 @@ public void TerrainEditor_setBrushType(string terraineditor, string type){ } /// /// ) +/// /// public float TerrainEditor_setSlopeLimitMaxAngle(string terraineditor, float angle){ @@ -20983,6 +29146,7 @@ public float TerrainEditor_setSlopeLimitMaxAngle(string terraineditor, float an } /// /// ) +/// /// public float TerrainEditor_setSlopeLimitMinAngle(string terraineditor, float angle){ @@ -20991,6 +29155,7 @@ public float TerrainEditor_setSlopeLimitMinAngle(string terraineditor, float an } /// /// (bool overlayEnable) - sets the terraformer current heightmap to draw as an overlay over the current terrain.) +/// /// public void TerrainEditor_setTerraformOverlay(string terraineditor, bool overlayEnable){ @@ -20998,7 +29163,9 @@ public void TerrainEditor_setTerraformOverlay(string terraineditor, bool overla m_ts.fn_TerrainEditor_setTerraformOverlay(terraineditor, overlayEnable); } /// -/// ( int index, string matName ) Changes the material name at the index. ) +/// ( int index, string matName ) +/// Changes the material name at the index. ) +/// /// public bool TerrainEditor_updateMaterial(string terraineditor, uint index, string matName){ @@ -21011,14 +29178,9 @@ public bool TerrainEditor_updateMaterial(string terraineditor, uint index, stri /// public class TerrainSmoothActionObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainSmoothActionObject(ref Omni ts){m_ts = ts;} /// /// ( TerrainBlock obj, F32 factor, U32 steps )) +/// /// public void TerrainSmoothAction_smooth(string terrainsmoothaction, string terrain, float factor, uint steps){ @@ -21031,14 +29193,9 @@ public void TerrainSmoothAction_smooth(string terrainsmoothaction, string terra /// public class TerrainSolderEdgesActionObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainSolderEdgesActionObject(ref Omni ts){m_ts = ts;} /// /// () ) +/// /// public void TerrainSolderEdgesAction_solder(string terrainsolderedgesaction){ @@ -21051,14 +29208,9 @@ public void TerrainSolderEdgesAction_solder(string terrainsolderedgesaction){ /// public class TheoraTextureObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public TheoraTextureObjectObject(ref Omni ts){m_ts = ts;} /// /// Pause playback of the video. ) +/// /// public void TheoraTextureObject_pause(string theoratextureobject){ @@ -21067,6 +29219,7 @@ public void TheoraTextureObject_pause(string theoratextureobject){ } /// /// Start playback of the video. ) +/// /// public void TheoraTextureObject_play(string theoratextureobject){ @@ -21075,6 +29228,7 @@ public void TheoraTextureObject_play(string theoratextureobject){ } /// /// Stop playback of the video. ) +/// /// public void TheoraTextureObject_stop(string theoratextureobject){ @@ -21087,14 +29241,9 @@ public void TheoraTextureObject_stop(string theoratextureobject){ /// public class TimeOfDayObject { -private Omni m_ts; - /// - /// - /// - /// -public TimeOfDayObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void addTimeOfDayEvent(string timeofday, float elevation, string identifier){ @@ -21103,6 +29252,7 @@ public void addTimeOfDayEvent(string timeofday, float elevation, string identif } /// /// ) +/// /// public void animate(string timeofday, float elevation, float degreesPerSecond){ @@ -21111,6 +29261,7 @@ public void animate(string timeofday, float elevation, float degreesPerSecond){ } /// /// ) +/// /// public void setDayLength(string timeofday, float seconds){ @@ -21119,6 +29270,7 @@ public void setDayLength(string timeofday, float seconds){ } /// /// ) +/// /// public void setPlay(string timeofday, bool enabled){ @@ -21127,6 +29279,7 @@ public void setPlay(string timeofday, bool enabled){ } /// /// ) +/// /// public void setTimeOfDay(string timeofday, float time){ @@ -21139,14 +29292,10 @@ public void setTimeOfDay(string timeofday, float time){ /// public class TriggerObject { -private Omni m_ts; - /// - /// - /// - /// -public TriggerObject(ref Omni ts){m_ts = ts;} /// -/// @brief Get the number of objects that are within the Trigger's bounds. @see getObject()) +/// @brief Get the number of objects that are within the Trigger's bounds. +/// @see getObject()) +/// /// public int getNumObjects(string trigger){ @@ -21154,7 +29303,11 @@ public int getNumObjects(string trigger){ return m_ts.fnTrigger_getNumObjects(trigger); } /// -/// @brief Retrieve the requested object that is within the Trigger's bounds. @param index Index of the object to get (range is 0 to getNumObjects()-1) @returns The SimObjectID of the object, or -1 if the requested index is invalid. @see getNumObjects()) +/// @brief Retrieve the requested object that is within the Trigger's bounds. +/// @param index Index of the object to get (range is 0 to getNumObjects()-1) +/// @returns The SimObjectID of the object, or -1 if the requested index is invalid. +/// @see getNumObjects()) +/// /// public int getObject(string trigger, int index){ @@ -21167,14 +29320,12 @@ public int getObject(string trigger, int index){ /// public class TSAttachableObject { -private Omni m_ts; - /// - /// - /// - /// -public TSAttachableObject(ref Omni ts){m_ts = ts;} /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool attachObject(string tsattachable, string obj){ @@ -21182,7 +29333,14 @@ public bool attachObject(string tsattachable, string obj){ return m_ts.fnTSAttachable_attachObject(tsattachable, obj); } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void detachAll(string tsattachable){ @@ -21190,7 +29348,11 @@ public void detachAll(string tsattachable){ m_ts.fnTSAttachable_detachAll(tsattachable); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool detachObject(string tsattachable, string obj){ @@ -21199,6 +29361,7 @@ public bool detachObject(string tsattachable, string obj){ } /// /// Returns the attachment at the passed index value.) +/// /// public string getAttachment(string tsattachable, int index = 0){ @@ -21207,6 +29370,7 @@ public string getAttachment(string tsattachable, int index = 0){ } /// /// Returns the number of objects that are currently attached.) +/// /// public int getNumAttachments(string tsattachable){ @@ -21219,14 +29383,26 @@ public int getNumAttachments(string tsattachable){ /// public class TSDynamicObject { -private Omni m_ts; - /// - /// - /// - /// -public TSDynamicObject(ref Omni ts){m_ts = ts;} /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void changeMaterial(string tsdynamic, string mapTo = "", string oldMat = null , string newMat = null ){ if (oldMat== null) {oldMat = null;} @@ -21236,7 +29412,15 @@ public void changeMaterial(string tsdynamic, string mapTo = "", string oldMat = m_ts.fnTSDynamic_changeMaterial(tsdynamic, mapTo, oldMat, newMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string getModelFile(string tsdynamic){ @@ -21244,7 +29428,10 @@ public string getModelFile(string tsdynamic){ return m_ts.fnTSDynamic_getModelFile(tsdynamic); } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int getTargetCount(string tsdynamic){ @@ -21252,7 +29439,11 @@ public int getTargetCount(string tsdynamic){ return m_ts.fnTSDynamic_getTargetCount(tsdynamic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string getTargetName(string tsdynamic, int index = 0){ @@ -21265,14 +29456,9 @@ public string getTargetName(string tsdynamic, int index = 0){ /// public class TSPathShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public TSPathShapeObject(ref Omni ts){m_ts = ts;} /// /// Returns the looping state for the shape.) +/// /// public bool getLooping(string tspathshape){ @@ -21281,6 +29467,7 @@ public bool getLooping(string tspathshape){ } /// /// Returns the number of nodes on the shape's path.) +/// /// public int getNodeCount(string tspathshape){ @@ -21289,6 +29476,7 @@ public int getNodeCount(string tspathshape){ } /// /// Get the current position of the shape along the path (0.0 - lastNode - 1).) +/// /// public float getPathPosition(string tspathshape){ @@ -21296,7 +29484,12 @@ public float getPathPosition(string tspathshape){ return m_ts.fnTSPathShape_getPathPosition(tspathshape); } /// -/// Removes the knot at the front of the shape's path. @tsexample // Remove the first knot in the shape's path. %pathShape.popFront(); @endtsexample) +/// Removes the knot at the front of the shape's path. +/// @tsexample +/// // Remove the first knot in the shape's path. +/// %pathShape.popFront(); +/// @endtsexample) +/// /// public void popFront(string tspathshape){ @@ -21304,7 +29497,25 @@ public void popFront(string tspathshape){ m_ts.fnTSPathShape_popFront(tspathshape); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the back of its path %pathShape.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the back of its path +/// %pathShape.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void pushBack(string tspathshape, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -21312,7 +29523,25 @@ public void pushBack(string tspathshape, TransformF transform, float speed = 1. m_ts.fnTSPathShape_pushBack(tspathshape, transform.AsString(), speed, type, path); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the front of its path %pathShape.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the front of its path +/// %pathShape.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void pushFront(string tspathshape, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -21320,7 +29549,13 @@ public void pushFront(string tspathshape, TransformF transform, float speed = 1 m_ts.fnTSPathShape_pushFront(tspathshape, transform.AsString(), speed, type, path); } /// -/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. When makeFirstKnot is true a new knot is created and pushed onto the path. @param speed Speed for the first knot if created. @param makeFirstKnot Initialize a new path with the current shape transform. @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. +/// The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. +/// When makeFirstKnot is true a new knot is created and pushed onto the path. +/// @param speed Speed for the first knot if created. +/// @param makeFirstKnot Initialize a new path with the current shape transform. +/// @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// /// public void reset(string tspathshape, float speed = 1.0f, bool makeFirstKnot = true, bool initFromPath = true){ @@ -21328,7 +29563,9 @@ public void reset(string tspathshape, float speed = 1.0f, bool makeFirstKnot = m_ts.fnTSPathShape_reset(tspathshape, speed, makeFirstKnot, initFromPath); } /// -/// Sets whether the path should loop or stop at the last node. @param isLooping New loop flag true/false.) +/// Sets whether the path should loop or stop at the last node. +/// @param isLooping New loop flag true/false.) +/// /// public void setLooping(string tspathshape, bool isLooping = true){ @@ -21336,7 +29573,9 @@ public void setLooping(string tspathshape, bool isLooping = true){ m_ts.fnTSPathShape_setLooping(tspathshape, isLooping); } /// -/// Set the movement state for this shape. @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// Set the movement state for this shape. +/// @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// /// public void setMoveState(string tspathshape, TypePathShapeState newState = null ){ if (newState== null) {newState = TypePathShapeState.Forward;} @@ -21345,7 +29584,9 @@ public void setMoveState(string tspathshape, TypePathShapeState newState = null m_ts.fnTSPathShape_setMoveState(tspathshape, (int)newState ); } /// -/// Set the current position of the shape along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// Set the current position of the shape along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// /// public void setPathPosition(string tspathshape, float position = 0.0f){ @@ -21353,7 +29594,13 @@ public void setPathPosition(string tspathshape, float position = 0.0f){ m_ts.fnTSPathShape_setPathPosition(tspathshape, position); } /// -/// @brief Set the movement target for this shape along its path. The shape will attempt to move along the path to the given target without going past the loop node. Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target state will be cleared. @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the shape to move to along its path.) +/// @brief Set the movement target for this shape along its path. +/// The shape will attempt to move along the path to the given target without going past the loop node. +/// Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target +/// state will be cleared. +/// @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the +/// shape to move to along its path.) +/// /// public void setTarget(string tspathshape, float position = 1.0f){ @@ -21366,14 +29613,33 @@ public void setTarget(string tspathshape, float position = 1.0f){ /// public class TSShapeConstructorObject { -private Omni m_ts; - /// - /// - /// - /// -public TSShapeConstructorObject(ref Omni ts){m_ts = ts;} /// -/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls may optionally be converted to boxes, spheres and/or capsules based on their volume. @param size size for this detail level @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, 26-dop, convex hulls. See the Shape Editor documentation for more details about these types. @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the whole shape), or the name of an object in the shape @param depth maximum split recursion depth (hulls only) @param merge volume % threshold used to merge hulls together (hulls only) @param concavity volume % threshold used to detect concavity (hulls only) @param maxVerts maximum number of vertices per hull (hulls only) @param boxMaxError max % volume difference for a hull to be converted to a box (hulls only) @param sphereMaxError max % volume difference for a hull to be converted to a sphere (hulls only) @param capsuleMaxError max % volume difference for a hull to be converted to a capsule (hulls only) @return true if successful, false otherwise @tsexample %this.addCollisionDetail( -1, \"box\", \"bounds\" ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); @endtsexample ) +/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls +/// may optionally be converted to boxes, spheres and/or capsules based on their +/// volume. +/// @param size size for this detail level +/// @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, +/// 26-dop, convex hulls. See the Shape Editor documentation for more details +/// about these types. +/// @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the +/// whole shape), or the name of an object in the shape +/// @param depth maximum split recursion depth (hulls only) +/// @param merge volume % threshold used to merge hulls together (hulls only) +/// @param concavity volume % threshold used to detect concavity (hulls only) +/// @param maxVerts maximum number of vertices per hull (hulls only) +/// @param boxMaxError max % volume difference for a hull to be converted to a +/// box (hulls only) +/// @param sphereMaxError max % volume difference for a hull to be converted to +/// a sphere (hulls only) +/// @param capsuleMaxError max % volume difference for a hull to be converted to +/// a capsule (hulls only) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addCollisionDetail( -1, \"box\", \"bounds\" ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); +/// @endtsexample ) +/// /// public bool addCollisionDetail(string tsshapeconstructor, int size, string type, string target, int depth = 4, float merge = 30, float concavity = 30, int maxVerts = 32, float boxMaxError = 0, float sphereMaxError = 0, float capsuleMaxError = 0){ @@ -21381,7 +29647,35 @@ public bool addCollisionDetail(string tsshapeconstructor, int size, string type return m_ts.fnTSShapeConstructor_addCollisionDetail(tsshapeconstructor, size, type, target, depth, merge, concavity, maxVerts, boxMaxError, sphereMaxError, capsuleMaxError); } /// -/// Add (or edit) an imposter detail level to the shape. If the shape already contains an imposter detail level, this command will simply change the imposter settings @param size size of the imposter detail level @param equatorSteps defines the number of snapshots to take around the equator. Imagine the object being rotated around the vertical axis, then a snapshot taken at regularly spaced intervals. @param polarSteps defines the number of snapshots taken between the poles (top and bottom), at each equator step. eg. At each equator snapshot, snapshots are taken at regular intervals between the poles. @param dl the detail level to use when generating the snapshots. Note that this is an array index rather than a detail size. So if an object has detail sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots using detail size 150. @param dim defines the size of the imposter images in pixels. The larger the number, the more detailed the billboard will be. @param includePoles flag indicating whether to include the \"pole\" snapshots. ie. the views from the top and bottom of the object. @param polar_angle if pole snapshots are active (@a includePoles is true), this parameter defines the camera angle (in degrees) within which to render the pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot taken at the pole (looking directly down or up at the object) will be rendered when the camera is within 25 degrees of the pole. @return true if successful, false otherwise @tsexample %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level @endtsexample ) +/// Add (or edit) an imposter detail level to the shape. +/// If the shape already contains an imposter detail level, this command will +/// simply change the imposter settings +/// @param size size of the imposter detail level +/// @param equatorSteps defines the number of snapshots to take around the +/// equator. Imagine the object being rotated around the vertical axis, then +/// a snapshot taken at regularly spaced intervals. +/// @param polarSteps defines the number of snapshots taken between the poles +/// (top and bottom), at each equator step. eg. At each equator snapshot, +/// snapshots are taken at regular intervals between the poles. +/// @param dl the detail level to use when generating the snapshots. Note that +/// this is an array index rather than a detail size. So if an object has detail +/// sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots +/// using detail size 150. +/// @param dim defines the size of the imposter images in pixels. The larger the +/// number, the more detailed the billboard will be. +/// @param includePoles flag indicating whether to include the \"pole\" snapshots. +/// ie. the views from the top and bottom of the object. +/// @param polar_angle if pole snapshots are active (@a includePoles is true), this +/// parameter defines the camera angle (in degrees) within which to render the +/// pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot +/// taken at the pole (looking directly down or up at the object) will be rendered +/// when the camera is within 25 degrees of the pole. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); +/// %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level +/// @endtsexample ) +/// /// public int addImposter(string tsshapeconstructor, int size, int equatorSteps, int polarSteps, int dl, int dim, bool includePoles, float polarAngle){ @@ -21389,7 +29683,21 @@ public int addImposter(string tsshapeconstructor, int size, int equatorSteps, i return m_ts.fnTSShapeConstructor_addImposter(tsshapeconstructor, size, equatorSteps, polarSteps, dl, dim, includePoles, polarAngle); } /// -/// Add geometry from another DTS or DAE shape file into this shape. Any materials required by the source mesh are also copied into this shape.br> @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param srcShape name of a shape file (DTS or DAE) that contains the mesh @param srcMesh the full name (object name + detail size) of the mesh to copy from the DTS/DAE file into this shape/li> @return true if successful, false otherwise @tsexample %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); @endtsexample ) +/// Add geometry from another DTS or DAE shape file into this shape. +/// Any materials required by the source mesh are also copied into this shape.br> +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param srcShape name of a shape file (DTS or DAE) that contains the mesh +/// @param srcMesh the full name (object name + detail size) of the mesh to +/// copy from the DTS/DAE file into this shape/li> +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); +/// %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); +/// @endtsexample ) +/// /// public bool addMesh(string tsshapeconstructor, string meshName, string srcShape, string srcMesh){ @@ -21397,7 +29705,21 @@ public bool addMesh(string tsshapeconstructor, string meshName, string srcShape return m_ts.fnTSShapeConstructor_addMesh(tsshapeconstructor, meshName, srcShape, srcMesh); } /// -/// Add a new node. @param name name for the new node (must not already exist) @param parentName name of an existing node to be the parent of the new node. If empty (\"\"), the new node will be at the root level of the node hierarchy. @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); @endtsexample ) +/// Add a new node. +/// @param name name for the new node (must not already exist) +/// @param parentName name of an existing node to be the parent of the new node. +/// If empty (\"\"), the new node will be at the root level of the node hierarchy. +/// @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); +/// %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); +/// %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool addNode(string tsshapeconstructor, string name, string parentName, TransformF txfm = null , bool isWorld = false){ if (txfm== null) {txfm = new TransformF(0,0,0,0,0,1,0);} @@ -21406,7 +29728,29 @@ public bool addNode(string tsshapeconstructor, string name, string parentName, return m_ts.fnTSShapeConstructor_addNode(tsshapeconstructor, name, parentName, txfm.AsString(), isWorld); } /// -/// Add a new mesh primitive to the shape. @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param type one of: \"box\", \"sphere\", \"capsule\" @param params mesh primitive parameters: ul> li>for box: \"size_x size_y size_z\"/li> li>for sphere: \"radius\"/li> li>for capsule: \"height radius\"/li> /ul> /ul> @param txfm local transform offset from the node for this mesh @param nodeName name of the node to attach the new mesh to (will change the object's node if adding a new mesh to an existing object) @return true if successful, false otherwise @tsexample %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); @endtsexample ) +/// Add a new mesh primitive to the shape. +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param type one of: \"box\", \"sphere\", \"capsule\" +/// @param params mesh primitive parameters: +/// ul> +/// li>for box: \"size_x size_y size_z\"/li> +/// li>for sphere: \"radius\"/li> +/// li>for capsule: \"height radius\"/li> +/// /ul> +/// /ul> +/// @param txfm local transform offset from the node for this mesh +/// @param nodeName name of the node to attach the new mesh to (will change the +/// object's node if adding a new mesh to an existing object) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); +/// %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); +/// %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); +/// @endtsexample ) +/// /// public bool addPrimitive(string tsshapeconstructor, string meshName, string type, string paramsx, TransformF txfm, string nodeName){ @@ -21414,7 +29758,34 @@ public bool addPrimitive(string tsshapeconstructor, string meshName, string typ return m_ts.fnTSShapeConstructor_addPrimitive(tsshapeconstructor, meshName, type, paramsx, txfm.AsString(), nodeName); } /// -/// Add a new sequence to the shape. @param source the name of an existing sequence, or the name of a DTS or DAE shape or DSQ sequence file. When the shape file contains more than one sequence, the desired sequence can be specified by appending the name to the end of the shape file. eg. \"myShape.dts run\" would select the \"run\" sequence from the \"myShape.dts\" file. @param name name of the new sequence @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose rotation to the target shape root pose. @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose position to the target shape root pose. @return true if successful, false otherwise @tsexample %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); %this.addSequence( \"./myPlayer.dae run\", \"run\" ); %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end @endtsexample ) +/// Add a new sequence to the shape. +/// @param source the name of an existing sequence, or the name of a DTS or DAE +/// shape or DSQ sequence file. When the shape file contains more than one +/// sequence, the desired sequence can be specified by appending the name to the +/// end of the shape file. eg. \"myShape.dts run\" would select the \"run\" +/// sequence from the \"myShape.dts\" file. +/// @param name name of the new sequence +/// @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. +/// @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. +/// @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose rotation to the target shape root pose. +/// @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose position to the target shape root pose. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); +/// %this.addSequence( \"./myPlayer.dae run\", \"run\" ); +/// %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end +/// %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 +/// %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end +/// @endtsexample ) +/// /// public bool addSequence(string tsshapeconstructor, string source, string name, int start = 0, int end = -1, bool padRot = true, bool padTrans = false){ @@ -21422,7 +29793,16 @@ public bool addSequence(string tsshapeconstructor, string source, string name, return m_ts.fnTSShapeConstructor_addSequence(tsshapeconstructor, source, name, start, end, padRot, padTrans); } /// -/// Add a new trigger to the sequence. @param name name of the sequence to modify @param keyframe keyframe of the new trigger @param state of the new trigger @return true if successful, false otherwise @tsexample %this.addTrigger( \"walk\", 3, 1 ); %this.addTrigger( \"walk\", 5, -1 ); @endtsexample ) +/// Add a new trigger to the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the new trigger +/// @param state of the new trigger +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addTrigger( \"walk\", 3, 1 ); +/// %this.addTrigger( \"walk\", 5, -1 ); +/// @endtsexample ) +/// /// public bool addTrigger(string tsshapeconstructor, string name, int keyframe, int state){ @@ -21430,7 +29810,14 @@ public bool addTrigger(string tsshapeconstructor, string name, int keyframe, in return m_ts.fnTSShapeConstructor_addTrigger(tsshapeconstructor, name, keyframe, state); } /// -/// Dump the shape hierarchy to the console or to a file. Useful for reviewing the result of a series of construction commands. @param filename Destination filename. If not specified, dump to console. @tsexample %this.dumpShape(); // dump to console %this.dumpShape( \"./dump.txt\" ); // dump to file @endtsexample ) +/// Dump the shape hierarchy to the console or to a file. Useful for reviewing +/// the result of a series of construction commands. +/// @param filename Destination filename. If not specified, dump to console. +/// @tsexample +/// %this.dumpShape(); // dump to console +/// %this.dumpShape( \"./dump.txt\" ); // dump to file +/// @endtsexample ) +/// /// public void dumpShape(string tsshapeconstructor, string filename = ""){ @@ -21438,7 +29825,9 @@ public void dumpShape(string tsshapeconstructor, string filename = ""){ m_ts.fnTSShapeConstructor_dumpShape(tsshapeconstructor, filename); } /// -/// Get the bounding box for the shape. @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// Get the bounding box for the shape. +/// @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// /// public Box3F getBounds(string tsshapeconstructor){ @@ -21446,7 +29835,9 @@ public Box3F getBounds(string tsshapeconstructor){ return new Box3F ( m_ts.fnTSShapeConstructor_getBounds(tsshapeconstructor)); } /// -/// Get the total number of detail levels in the shape. @return the number of detail levels in the shape ) +/// Get the total number of detail levels in the shape. +/// @return the number of detail levels in the shape ) +/// /// public int getDetailLevelCount(string tsshapeconstructor){ @@ -21454,7 +29845,15 @@ public int getDetailLevelCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getDetailLevelCount(tsshapeconstructor); } /// -/// Get the index of the detail level with a given size. @param size size of the detail level to lookup @return index of the detail level with the desired size, or -1 if no such detail exists @tsexample if ( %this.getDetailLevelSize( 32 ) == -1 ) echo( \"Error: This shape does not have a detail level at size 32\" ); @endtsexample ) +/// Get the index of the detail level with a given size. +/// @param size size of the detail level to lookup +/// @return index of the detail level with the desired size, or -1 if no such +/// detail exists +/// @tsexample +/// if ( %this.getDetailLevelSize( 32 ) == -1 ) +/// echo( \"Error: This shape does not have a detail level at size 32\" ); +/// @endtsexample ) +/// /// public int getDetailLevelIndex(string tsshapeconstructor, int size){ @@ -21462,7 +29861,16 @@ public int getDetailLevelIndex(string tsshapeconstructor, int size){ return m_ts.fnTSShapeConstructor_getDetailLevelIndex(tsshapeconstructor, size); } /// -/// Get the name of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level name @tsexample // print the names of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getDetailLevelName( %i ) ); @endtsexample ) +/// Get the name of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level name +/// @tsexample +/// // print the names of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getDetailLevelName( %i ) ); +/// @endtsexample ) +/// /// public string getDetailLevelName(string tsshapeconstructor, int index){ @@ -21470,7 +29878,16 @@ public string getDetailLevelName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getDetailLevelName(tsshapeconstructor, index); } /// -/// Get the size of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level size @tsexample // print the sizes of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); @endtsexample ) +/// Get the size of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level size +/// @tsexample +/// // print the sizes of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); +/// @endtsexample ) +/// /// public int getDetailLevelSize(string tsshapeconstructor, int index){ @@ -21478,7 +29895,10 @@ public int getDetailLevelSize(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getDetailLevelSize(tsshapeconstructor, index); } /// -/// Get the index of the imposter (auto-billboard) detail level (if any). @return imposter detail level index, or -1 if the shape does not use imposters. ) +/// Get the index of the imposter (auto-billboard) detail level (if any). +/// @return imposter detail level index, or -1 if the shape does not use +/// imposters. ) +/// /// public int getImposterDetailLevel(string tsshapeconstructor){ @@ -21486,7 +29906,26 @@ public int getImposterDetailLevel(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getImposterDetailLevel(tsshapeconstructor); } /// -/// Get the settings used to generate imposters for the indexed detail level. @param index index of the detail level to query (does not need to be an imposter detail level @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: dl> dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> dt>eqSteps/dt>dd>number of steps around the equator/dd> dt>pSteps/dt>dd>number of steps between the poles/dd> dt>dl/dt>dd>index of the detail level used to generate imposters/dd> dt>dim/dt>dd>size (in pixels) of each imposter image/dd> dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> dt>angle/dt>dd>angle at which to display pole images/dd> /dl> @tsexample // print the imposter detail level settings %index = %this.getImposterDetailLevel(); if ( %index != -1 ) echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); @endtsexample ) +/// Get the settings used to generate imposters for the indexed detail level. +/// @param index index of the detail level to query (does not need to be an +/// imposter detail level +/// @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: +/// dl> +/// dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> +/// dt>eqSteps/dt>dd>number of steps around the equator/dd> +/// dt>pSteps/dt>dd>number of steps between the poles/dd> +/// dt>dl/dt>dd>index of the detail level used to generate imposters/dd> +/// dt>dim/dt>dd>size (in pixels) of each imposter image/dd> +/// dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> +/// dt>angle/dt>dd>angle at which to display pole images/dd> +/// /dl> +/// @tsexample +/// // print the imposter detail level settings +/// %index = %this.getImposterDetailLevel(); +/// if ( %index != -1 ) +/// echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); +/// @endtsexample ) +/// /// public string getImposterSettings(string tsshapeconstructor, int index){ @@ -21494,7 +29933,13 @@ public string getImposterSettings(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getImposterSettings(tsshapeconstructor, index); } /// -/// Get the number of meshes (detail levels) for the specified object. @param name name of the object to query @return the number of meshes for this object. @tsexample %count = %this.getMeshCount( \"SimpleShape\" ); @endtsexample ) +/// Get the number of meshes (detail levels) for the specified object. +/// @param name name of the object to query +/// @return the number of meshes for this object. +/// @tsexample +/// %count = %this.getMeshCount( \"SimpleShape\" ); +/// @endtsexample ) +/// /// public int getMeshCount(string tsshapeconstructor, string name){ @@ -21502,7 +29947,14 @@ public int getMeshCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getMeshCount(tsshapeconstructor, name); } /// -/// Get the name of the material attached to a mesh. Note that only the first material used by the mesh is returned. @param name full name (object name + detail size) of the mesh to query @return name of the material attached to the mesh (suitable for use with the Material mapTo field) @tsexample echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the name of the material attached to a mesh. Note that only the first +/// material used by the mesh is returned. +/// @param name full name (object name + detail size) of the mesh to query +/// @return name of the material attached to the mesh (suitable for use with the Material mapTo field) +/// @tsexample +/// echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string getMeshMaterial(string tsshapeconstructor, string name){ @@ -21510,7 +29962,22 @@ public string getMeshMaterial(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getMeshMaterial(tsshapeconstructor, name); } /// -/// Get the name of the indexed mesh (detail level) for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh name. @tsexample // print the names of all meshes in the shape %objCount = %this.getObjectCount(); for ( %i = 0; %i %objCount; %i++ ) { %objName = %this.getObjectName( %i ); %meshCount = %this.getMeshCount( %objName ); for ( %j = 0; %j %meshCount; %j++ ) echo( %this.getMeshName( %objName, %j ) ); } @endtsexample ) +/// Get the name of the indexed mesh (detail level) for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh name. +/// @tsexample +/// // print the names of all meshes in the shape +/// %objCount = %this.getObjectCount(); +/// for ( %i = 0; %i %objCount; %i++ ) +/// { +/// %objName = %this.getObjectName( %i ); +/// %meshCount = %this.getMeshCount( %objName ); +/// for ( %j = 0; %j %meshCount; %j++ ) +/// echo( %this.getMeshName( %objName, %j ) ); +/// } +/// @endtsexample ) +/// /// public string getMeshName(string tsshapeconstructor, string name, int index){ @@ -21518,7 +29985,18 @@ public string getMeshName(string tsshapeconstructor, string name, int index){ return m_ts.fnTSShapeConstructor_getMeshName(tsshapeconstructor, name, index); } /// -/// Get the detail level size of the indexed mesh for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh detail level size. @tsexample // print sizes for all detail levels of this object %objName = \"trunk\"; %count = %this.getMeshCount( %objName ); for ( %i = 0; %i %count; %i++ ) echo( %this.getMeshSize( %objName, %i ) ); @endtsexample ) +/// Get the detail level size of the indexed mesh for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh detail level size. +/// @tsexample +/// // print sizes for all detail levels of this object +/// %objName = \"trunk\"; +/// %count = %this.getMeshCount( %objName ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getMeshSize( %objName, %i ) ); +/// @endtsexample ) +/// /// public int getMeshSize(string tsshapeconstructor, string name, int index){ @@ -21526,7 +30004,16 @@ public int getMeshSize(string tsshapeconstructor, string name, int index){ return m_ts.fnTSShapeConstructor_getMeshSize(tsshapeconstructor, name, index); } /// -/// Get the display type of the mesh. @param name name of the mesh to query @return the string returned is one of: dl>dt>normal/dt>dd>a normal 3D mesh/dd> dt>billboard/dt>dd>a mesh that always faces the camera/dd> dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> @tsexample echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the display type of the mesh. +/// @param name name of the mesh to query +/// @return the string returned is one of: +/// dl>dt>normal/dt>dd>a normal 3D mesh/dd> +/// dt>billboard/dt>dd>a mesh that always faces the camera/dd> +/// dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> +/// @tsexample +/// echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string getMeshType(string tsshapeconstructor, string name){ @@ -21534,7 +30021,13 @@ public string getMeshType(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getMeshType(tsshapeconstructor, name); } /// -/// Get the number of children of this node. @param name name of the node to query. @return the number of child nodes. @tsexample %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the number of children of this node. +/// @param name name of the node to query. +/// @return the number of child nodes. +/// @tsexample +/// %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int getNodeChildCount(string tsshapeconstructor, string name){ @@ -21542,7 +30035,32 @@ public int getNodeChildCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeChildCount(tsshapeconstructor, name); } /// -/// Get the name of the indexed child node. @param name name of the parent node to query. @param index index of the child node (valid range is 0 - getNodeChildName()-1). @return the name of the indexed child node. @tsexample function dumpNode( %shape, %name, %indent ) { echo( %indent @ %name ); %count = %shape.getNodeChildCount( %name ); for ( %i = 0; %i %count; %i++ ) dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); } function dumpShape( %shape ) { // recursively dump node hierarchy %count = %shape.getNodeCount(); for ( %i = 0; %i %count; %i++ ) { // dump top level nodes %name = %shape.getNodeName( %i ); if ( %shape.getNodeParentName( %name ) $= ) dumpNode( %shape, %name, \"\" ); } } @endtsexample ) +/// Get the name of the indexed child node. +/// @param name name of the parent node to query. +/// @param index index of the child node (valid range is 0 - getNodeChildName()-1). +/// @return the name of the indexed child node. +/// @tsexample +/// function dumpNode( %shape, %name, %indent ) +/// { +/// echo( %indent @ %name ); +/// %count = %shape.getNodeChildCount( %name ); +/// for ( %i = 0; %i %count; %i++ ) +/// dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); +/// } +/// function dumpShape( %shape ) +/// { +/// // recursively dump node hierarchy +/// %count = %shape.getNodeCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// { +/// // dump top level nodes +/// %name = %shape.getNodeName( %i ); +/// if ( %shape.getNodeParentName( %name ) $= ) +/// dumpNode( %shape, %name, \"\" ); +/// } +/// } +/// @endtsexample ) +/// /// public string getNodeChildName(string tsshapeconstructor, string name, int index){ @@ -21550,7 +30068,12 @@ public string getNodeChildName(string tsshapeconstructor, string name, int inde return m_ts.fnTSShapeConstructor_getNodeChildName(tsshapeconstructor, name, index); } /// -/// Get the total number of nodes in the shape. @return the number of nodes in the shape. @tsexample %count = %this.getNodeCount(); @endtsexample ) +/// Get the total number of nodes in the shape. +/// @return the number of nodes in the shape. +/// @tsexample +/// %count = %this.getNodeCount(); +/// @endtsexample ) +/// /// public int getNodeCount(string tsshapeconstructor){ @@ -21558,7 +30081,14 @@ public int getNodeCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getNodeCount(tsshapeconstructor); } /// -/// Get the index of the node. @param name name of the node to lookup. @return the index of the named node, or -1 if no such node exists. @tsexample // get the index of Bip01 Pelvis node in the shape %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the index of the node. +/// @param name name of the node to lookup. +/// @return the index of the named node, or -1 if no such node exists. +/// @tsexample +/// // get the index of Bip01 Pelvis node in the shape +/// %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int getNodeIndex(string tsshapeconstructor, string name){ @@ -21566,7 +30096,16 @@ public int getNodeIndex(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeIndex(tsshapeconstructor, name); } /// -/// Get the name of the indexed node. @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). @return the name of the indexed node, or \"\" if no such node exists. @tsexample // print the names of all the nodes in the shape %count = %this.getNodeCount(); for (%i = 0; %i %count; %i++) echo(%i SPC %this.getNodeName(%i)); @endtsexample ) +/// Get the name of the indexed node. +/// @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). +/// @return the name of the indexed node, or \"\" if no such node exists. +/// @tsexample +/// // print the names of all the nodes in the shape +/// %count = %this.getNodeCount(); +/// for (%i = 0; %i %count; %i++) +/// echo(%i SPC %this.getNodeName(%i)); +/// @endtsexample ) +/// /// public string getNodeName(string tsshapeconstructor, int index){ @@ -21574,7 +30113,13 @@ public string getNodeName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getNodeName(tsshapeconstructor, index); } /// -/// Get the number of geometry objects attached to this node. @param name name of the node to query. @return the number of attached objects. @tsexample %count = %this.getNodeObjectCount( \"Bip01 Head\" ); @endtsexample ) +/// Get the number of geometry objects attached to this node. +/// @param name name of the node to query. +/// @return the number of attached objects. +/// @tsexample +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// @endtsexample ) +/// /// public int getNodeObjectCount(string tsshapeconstructor, string name){ @@ -21582,7 +30127,17 @@ public int getNodeObjectCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeObjectCount(tsshapeconstructor, name); } /// -/// Get the name of the indexed object. @param name name of the node to query. @param index index of the object (valid range is 0 - getNodeObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects attached to the node %count = %this.getNodeObjectCount( \"Bip01 Head\" ); for ( %i = 0; %i %count; %i++ ) echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param name name of the node to query. +/// @param index index of the object (valid range is 0 - getNodeObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects attached to the node +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); +/// @endtsexample ) +/// /// public string getNodeObjectName(string tsshapeconstructor, string name, int index){ @@ -21590,7 +30145,14 @@ public string getNodeObjectName(string tsshapeconstructor, string name, int ind return m_ts.fnTSShapeConstructor_getNodeObjectName(tsshapeconstructor, name, index); } /// -/// Get the name of the node's parent. If the node has no parent (ie. it is at the root level), return an empty string. @param name name of the node to query. @return the name of the node's parent, or \"\" if the node is at the root level @tsexample echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); @endtsexample ) +/// Get the name of the node's parent. If the node has no parent (ie. it is at +/// the root level), return an empty string. +/// @param name name of the node to query. +/// @return the name of the node's parent, or \"\" if the node is at the root level +/// @tsexample +/// echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); +/// @endtsexample ) +/// /// public string getNodeParentName(string tsshapeconstructor, string name){ @@ -21598,7 +30160,16 @@ public string getNodeParentName(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeParentName(tsshapeconstructor, name); } /// -/// Get the base (ie. not animated) transform of a node. @param name name of the node to query. @param isWorld true to get the global transform, false (or omitted) to get the local-to-parent transform. @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". @tsexample %ret = %this.getNodeTransform( \"mount0\" ); %this.setNodeTransform( \"mount4\", %ret ); @endtsexample ) +/// Get the base (ie. not animated) transform of a node. +/// @param name name of the node to query. +/// @param isWorld true to get the global transform, false (or omitted) to get +/// the local-to-parent transform. +/// @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". +/// @tsexample +/// %ret = %this.getNodeTransform( \"mount0\" ); +/// %this.setNodeTransform( \"mount4\", %ret ); +/// @endtsexample ) +/// /// public TransformF getNodeTransform(string tsshapeconstructor, string name, bool isWorld = false){ @@ -21606,7 +30177,12 @@ public TransformF getNodeTransform(string tsshapeconstructor, string name, bool return new TransformF ( m_ts.fnTSShapeConstructor_getNodeTransform(tsshapeconstructor, name, isWorld)); } /// -/// Get the total number of objects in the shape. @return the number of objects in the shape. @tsexample %count = %this.getObjectCount(); @endtsexample ) +/// Get the total number of objects in the shape. +/// @return the number of objects in the shape. +/// @tsexample +/// %count = %this.getObjectCount(); +/// @endtsexample ) +/// /// public int getObjectCount(string tsshapeconstructor){ @@ -21614,7 +30190,13 @@ public int getObjectCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getObjectCount(tsshapeconstructor); } /// -/// Get the index of the first object with the given name. @param name name of the object to get. @return the index of the named object. @tsexample %index = %this.getObjectIndex( \"Head\" ); @endtsexample ) +/// Get the index of the first object with the given name. +/// @param name name of the object to get. +/// @return the index of the named object. +/// @tsexample +/// %index = %this.getObjectIndex( \"Head\" ); +/// @endtsexample ) +/// /// public int getObjectIndex(string tsshapeconstructor, string name){ @@ -21622,7 +30204,16 @@ public int getObjectIndex(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getObjectIndex(tsshapeconstructor, name); } /// -/// Get the name of the indexed object. @param index index of the object to get (valid range is 0 - getObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects in the shape %count = %this.getObjectCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getObjectName( %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param index index of the object to get (valid range is 0 - getObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getObjectName( %i ) ); +/// @endtsexample ) +/// /// public string getObjectName(string tsshapeconstructor, int index){ @@ -21630,7 +30221,14 @@ public string getObjectName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getObjectName(tsshapeconstructor, index); } /// -/// Get the name of the node this object is attached to. @param name name of the object to get. @return the name of the attached node, or an empty string if this object is not attached to a node (usually the case for skinned meshes). @tsexample echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); @endtsexample ) +/// Get the name of the node this object is attached to. +/// @param name name of the object to get. +/// @return the name of the attached node, or an empty string if this +/// object is not attached to a node (usually the case for skinned meshes). +/// @tsexample +/// echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); +/// @endtsexample ) +/// /// public string getObjectNode(string tsshapeconstructor, string name){ @@ -21638,7 +30236,24 @@ public string getObjectNode(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getObjectNode(tsshapeconstructor, name); } /// -/// Get information about blended sequences. @param name name of the sequence to query @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: dl> dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference frame (empty for blend sequences embedded in DTS files)/dd> dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences embedded in DTS files)/dd> /dl> @note Note that only sequences set to be blends using the setSequenceBlend command will contain the blendSeq and blendFrame information. @tsexample %blendData = %this.getSequenceBlend( \"look\" ); if ( getField( %blendData, 0 ) ) echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); @endtsexample ) +/// Get information about blended sequences. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: +/// dl> +/// dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> +/// dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference +/// frame (empty for blend sequences embedded in DTS files)/dd> +/// dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences +/// embedded in DTS files)/dd> +/// /dl> +/// @note Note that only sequences set to be blends using the setSequenceBlend +/// command will contain the blendSeq and blendFrame information. +/// @tsexample +/// %blendData = %this.getSequenceBlend( \"look\" ); +/// if ( getField( %blendData, 0 ) ) +/// echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); +/// @endtsexample ) +/// /// public string getSequenceBlend(string tsshapeconstructor, string name){ @@ -21646,7 +30261,9 @@ public string getSequenceBlend(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceBlend(tsshapeconstructor, name); } /// -/// Get the total number of sequences in the shape. @return the number of sequences in the shape ) +/// Get the total number of sequences in the shape. +/// @return the number of sequences in the shape ) +/// /// public int getSequenceCount(string tsshapeconstructor){ @@ -21654,7 +30271,14 @@ public int getSequenceCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getSequenceCount(tsshapeconstructor); } /// -/// Check if this sequence is cyclic (looping). @param name name of the sequence to query @return true if this sequence is cyclic, false if not @tsexample if ( !%this.getSequenceCyclic( \"ambient\" ) ) error( \"ambient sequence is not cyclic!\" ); @endtsexample ) +/// Check if this sequence is cyclic (looping). +/// @param name name of the sequence to query +/// @return true if this sequence is cyclic, false if not +/// @tsexample +/// if ( !%this.getSequenceCyclic( \"ambient\" ) ) +/// error( \"ambient sequence is not cyclic!\" ); +/// @endtsexample ) +/// /// public bool getSequenceCyclic(string tsshapeconstructor, string name){ @@ -21662,7 +30286,13 @@ public bool getSequenceCyclic(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceCyclic(tsshapeconstructor, name); } /// -/// Get the number of keyframes in the sequence. @param name name of the sequence to query @return number of keyframes in the sequence @tsexample echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); @endtsexample ) +/// Get the number of keyframes in the sequence. +/// @param name name of the sequence to query +/// @return number of keyframes in the sequence +/// @tsexample +/// echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); +/// @endtsexample ) +/// /// public int getSequenceFrameCount(string tsshapeconstructor, string name){ @@ -21670,7 +30300,16 @@ public int getSequenceFrameCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceFrameCount(tsshapeconstructor, name); } /// -/// Get the ground speed of the sequence. @note Note that only the first 2 ground frames of the sequence are examined; the speed is assumed to be constant throughout the sequence. @param name name of the sequence to query @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" @tsexample %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); echo( \"Run moves at \" @ %speed @ \" units per frame\" ); @endtsexample ) +/// Get the ground speed of the sequence. +/// @note Note that only the first 2 ground frames of the sequence are +/// examined; the speed is assumed to be constant throughout the sequence. +/// @param name name of the sequence to query +/// @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" +/// @tsexample +/// %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); +/// echo( \"Run moves at \" @ %speed @ \" units per frame\" ); +/// @endtsexample ) +/// /// public string getSequenceGroundSpeed(string tsshapeconstructor, string name){ @@ -21678,7 +30317,15 @@ public string getSequenceGroundSpeed(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceGroundSpeed(tsshapeconstructor, name); } /// -/// Find the index of the sequence with the given name. @param name name of the sequence to lookup @return index of the sequence with matching name, or -1 if not found @tsexample // Check if a given sequence exists in the shape if ( %this.getSequenceIndex( \"walk\" ) == -1 ) echo( \"Could not find 'walk' sequence\" ); @endtsexample ) +/// Find the index of the sequence with the given name. +/// @param name name of the sequence to lookup +/// @return index of the sequence with matching name, or -1 if not found +/// @tsexample +/// // Check if a given sequence exists in the shape +/// if ( %this.getSequenceIndex( \"walk\" ) == -1 ) +/// echo( \"Could not find 'walk' sequence\" ); +/// @endtsexample ) +/// /// public int getSequenceIndex(string tsshapeconstructor, string name){ @@ -21686,7 +30333,16 @@ public int getSequenceIndex(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceIndex(tsshapeconstructor, name); } /// -/// Get the name of the indexed sequence. @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) @return the name of the sequence @tsexample // print the name of all sequences in the shape %count = %this.getSequenceCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getSequenceName( %i ) ); @endtsexample ) +/// Get the name of the indexed sequence. +/// @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) +/// @return the name of the sequence +/// @tsexample +/// // print the name of all sequences in the shape +/// %count = %this.getSequenceCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getSequenceName( %i ) ); +/// @endtsexample ) +/// /// public string getSequenceName(string tsshapeconstructor, int index){ @@ -21694,7 +30350,10 @@ public string getSequenceName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getSequenceName(tsshapeconstructor, index); } /// -/// Get the priority setting of the sequence. @param name name of the sequence to query @return priority value of the sequence ) +/// Get the priority setting of the sequence. +/// @param name name of the sequence to query +/// @return priority value of the sequence ) +/// /// public float getSequencePriority(string tsshapeconstructor, string name){ @@ -21702,7 +30361,24 @@ public float getSequencePriority(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequencePriority(tsshapeconstructor, name); } /// -/// Get information about where the sequence data came from. For example, whether it was loaded from an external DSQ file. @param name name of the sequence to query @return TAB delimited string of the form: \"from reserved start end total\", where: dl> dt>from/dt>dd>the source of the animation data, such as the path to a DSQ file, or the name of an existing sequence in the shape. This field will be empty for sequences already embedded in the DTS or DAE file./dd> dt>reserved/dt>dd>reserved value/dd> dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> dt>total/dt>dd>the total number of frames in the source sequence/dd> /dl> @tsexample // print the source for the walk animation echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); @endtsexample ) +/// Get information about where the sequence data came from. +/// For example, whether it was loaded from an external DSQ file. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"from reserved start end total\", where: +/// dl> +/// dt>from/dt>dd>the source of the animation data, such as the path to +/// a DSQ file, or the name of an existing sequence in the shape. This field +/// will be empty for sequences already embedded in the DTS or DAE file./dd> +/// dt>reserved/dt>dd>reserved value/dd> +/// dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> +/// dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> +/// dt>total/dt>dd>the total number of frames in the source sequence/dd> +/// /dl> +/// @tsexample +/// // print the source for the walk animation +/// echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); +/// @endtsexample ) +/// /// public string getSequenceSource(string tsshapeconstructor, string name){ @@ -21710,7 +30386,12 @@ public string getSequenceSource(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceSource(tsshapeconstructor, name); } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @tsexample %count = %this.getTargetCount(); @endtsexample ) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @tsexample +/// %count = %this.getTargetCount(); +/// @endtsexample ) +/// /// public int getTargetCount(string tsshapeconstructor){ @@ -21718,7 +30399,15 @@ public int getTargetCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getTargetCount(tsshapeconstructor); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @tsexample %count = %this.getTargetCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); @endtsexample ) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @tsexample +/// %count = %this.getTargetCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); +/// @endtsexample ) +/// /// public string getTargetName(string tsshapeconstructor, int index){ @@ -21726,7 +30415,17 @@ public string getTargetName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getTargetName(tsshapeconstructor, index); } /// -/// Get information about the indexed trigger @param name name of the sequence to query @param index index of the trigger (valid range is 0 - getTriggerCount()-1) @return string of the form \"frame state\" @tsexample // print all triggers in the sequence %count = %this.getTriggerCount( \"back\" ); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getTrigger( \"back\", %i ) ); @endtsexample ) +/// Get information about the indexed trigger +/// @param name name of the sequence to query +/// @param index index of the trigger (valid range is 0 - getTriggerCount()-1) +/// @return string of the form \"frame state\" +/// @tsexample +/// // print all triggers in the sequence +/// %count = %this.getTriggerCount( \"back\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getTrigger( \"back\", %i ) ); +/// @endtsexample ) +/// /// public string getTrigger(string tsshapeconstructor, string name, int index){ @@ -21734,7 +30433,10 @@ public string getTrigger(string tsshapeconstructor, string name, int index){ return m_ts.fnTSShapeConstructor_getTrigger(tsshapeconstructor, name, index); } /// -/// Get the number of triggers in the specified sequence. @param name name of the sequence to query @return number of triggers in the sequence ) +/// Get the number of triggers in the specified sequence. +/// @param name name of the sequence to query +/// @return number of triggers in the sequence ) +/// /// public int getTriggerCount(string tsshapeconstructor, string name){ @@ -21742,7 +30444,9 @@ public int getTriggerCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getTriggerCount(tsshapeconstructor, name); } /// -/// Notify game objects that this shape file has changed, allowing them to update internal data if needed. ) +/// Notify game objects that this shape file has changed, allowing them to update +/// internal data if needed. ) +/// /// public void notifyShapeChanged(string tsshapeconstructor){ @@ -21750,7 +30454,13 @@ public void notifyShapeChanged(string tsshapeconstructor){ m_ts.fnTSShapeConstructor_notifyShapeChanged(tsshapeconstructor); } /// -/// Remove the detail level (including all meshes in the detail level) @param size size of the detail level to remove @return true if successful, false otherwise @tsexample %this.removeDetailLevel( 2 ); @endtsexample ) +/// Remove the detail level (including all meshes in the detail level) +/// @param size size of the detail level to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeDetailLevel( 2 ); +/// @endtsexample ) +/// /// public bool removeDetailLevel(string tsshapeconstructor, int index){ @@ -21758,7 +30468,9 @@ public bool removeDetailLevel(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_removeDetailLevel(tsshapeconstructor, index); } /// -/// () Remove the imposter detail level (if any) from the shape. @return true if successful, false otherwise ) +/// () Remove the imposter detail level (if any) from the shape. +/// @return true if successful, false otherwise ) +/// /// public bool removeImposter(string tsshapeconstructor){ @@ -21766,7 +30478,14 @@ public bool removeImposter(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_removeImposter(tsshapeconstructor); } /// -/// Remove a mesh from the shape. If all geometry is removed from an object, the object is also removed. @param name full name (object name + detail size) of the mesh to remove @return true if successful, false otherwise @tsexample %this.removeMesh( \"SimpleShape128\" ); @endtsexample ) +/// Remove a mesh from the shape. +/// If all geometry is removed from an object, the object is also removed. +/// @param name full name (object name + detail size) of the mesh to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeMesh( \"SimpleShape128\" ); +/// @endtsexample ) +/// /// public bool removeMesh(string tsshapeconstructor, string name){ @@ -21774,7 +30493,16 @@ public bool removeMesh(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeMesh(tsshapeconstructor, name); } /// -/// Remove a node from the shape. The named node is removed from the shape, including from any sequences that use the node. Child nodes and objects attached to the node are re-assigned to the node's parent. @param name name of the node to remove. @return true if successful, false otherwise. @tsexample %this.removeNode( \"Nose\" ); @endtsexample ) +/// Remove a node from the shape. +/// The named node is removed from the shape, including from any sequences that +/// use the node. Child nodes and objects attached to the node are re-assigned +/// to the node's parent. +/// @param name name of the node to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.removeNode( \"Nose\" ); +/// @endtsexample ) +/// /// public bool removeNode(string tsshapeconstructor, string name){ @@ -21782,7 +30510,16 @@ public bool removeNode(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeNode(tsshapeconstructor, name); } /// -/// Remove an object (including all meshes for that object) from the shape. @param name name of the object to remove. @return true if successful, false otherwise. @tsexample // clear all objects in the shape %count = %this.getObjectCount(); for ( %i = %count-1; %i >= 0; %i-- ) %this.removeObject( %this.getObjectName(%i) ); @endtsexample ) +/// Remove an object (including all meshes for that object) from the shape. +/// @param name name of the object to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// // clear all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = %count-1; %i >= 0; %i-- ) +/// %this.removeObject( %this.getObjectName(%i) ); +/// @endtsexample ) +/// /// public bool removeObject(string tsshapeconstructor, string name){ @@ -21790,7 +30527,10 @@ public bool removeObject(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeObject(tsshapeconstructor, name); } /// -/// Remove the sequence from the shape. @param name name of the sequence to remove @return true if successful, false otherwise ) +/// Remove the sequence from the shape. +/// @param name name of the sequence to remove +/// @return true if successful, false otherwise ) +/// /// public bool removeSequence(string tsshapeconstructor, string name){ @@ -21798,7 +30538,15 @@ public bool removeSequence(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeSequence(tsshapeconstructor, name); } /// -/// Remove a trigger from the sequence. @param name name of the sequence to modify @param keyframe keyframe of the trigger to remove @param state of the trigger to remove @return true if successful, false otherwise @tsexample %this.removeTrigger( \"walk\", 3, 1 ); @endtsexample ) +/// Remove a trigger from the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the trigger to remove +/// @param state of the trigger to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeTrigger( \"walk\", 3, 1 ); +/// @endtsexample ) +/// /// public bool removeTrigger(string tsshapeconstructor, string name, int keyframe, int state){ @@ -21806,7 +30554,16 @@ public bool removeTrigger(string tsshapeconstructor, string name, int keyframe, return m_ts.fnTSShapeConstructor_removeTrigger(tsshapeconstructor, name, keyframe, state); } /// -/// Rename a detail level. @note Note that detail level names must be unique, so this command will fail if there is already a detail level with the desired name @param oldName current name of the detail level @param newName new name of the detail level @return true if successful, false otherwise @tsexample %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); @endtsexample ) +/// Rename a detail level. +/// @note Note that detail level names must be unique, so this command will +/// fail if there is already a detail level with the desired name +/// @param oldName current name of the detail level +/// @param newName new name of the detail level +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); +/// @endtsexample ) +/// /// public bool renameDetailLevel(string tsshapeconstructor, string oldName, string newName){ @@ -21814,7 +30571,16 @@ public bool renameDetailLevel(string tsshapeconstructor, string oldName, string return m_ts.fnTSShapeConstructor_renameDetailLevel(tsshapeconstructor, oldName, newName); } /// -/// Rename a node. @note Note that node names must be unique, so this command will fail if there is already a node with the desired name @param oldName current name of the node @param newName new name of the node @return true if successful, false otherwise @tsexample %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); @endtsexample ) +/// Rename a node. +/// @note Note that node names must be unique, so this command will fail if +/// there is already a node with the desired name +/// @param oldName current name of the node +/// @param newName new name of the node +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); +/// @endtsexample ) +/// /// public bool renameNode(string tsshapeconstructor, string oldName, string newName){ @@ -21822,7 +30588,16 @@ public bool renameNode(string tsshapeconstructor, string oldName, string newNam return m_ts.fnTSShapeConstructor_renameNode(tsshapeconstructor, oldName, newName); } /// -/// Rename an object. @note Note that object names must be unique, so this command will fail if there is already an object with the desired name @param oldName current name of the object @param newName new name of the object @return true if successful, false otherwise @tsexample %this.renameObject( \"MyBox\", \"Box\" ); @endtsexample ) +/// Rename an object. +/// @note Note that object names must be unique, so this command will fail if +/// there is already an object with the desired name +/// @param oldName current name of the object +/// @param newName new name of the object +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameObject( \"MyBox\", \"Box\" ); +/// @endtsexample ) +/// /// public bool renameObject(string tsshapeconstructor, string oldName, string newName){ @@ -21830,7 +30605,16 @@ public bool renameObject(string tsshapeconstructor, string oldName, string newN return m_ts.fnTSShapeConstructor_renameObject(tsshapeconstructor, oldName, newName); } /// -/// Rename a sequence. @note Note that sequence names must be unique, so this command will fail if there is already a sequence with the desired name @param oldName current name of the sequence @param newName new name of the sequence @return true if successful, false otherwise @tsexample %this.renameSequence( \"walking\", \"walk\" ); @endtsexample ) +/// Rename a sequence. +/// @note Note that sequence names must be unique, so this command will fail +/// if there is already a sequence with the desired name +/// @param oldName current name of the sequence +/// @param newName new name of the sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameSequence( \"walking\", \"walk\" ); +/// @endtsexample ) +/// /// public bool renameSequence(string tsshapeconstructor, string oldName, string newName){ @@ -21838,7 +30622,12 @@ public bool renameSequence(string tsshapeconstructor, string oldName, string ne return m_ts.fnTSShapeConstructor_renameSequence(tsshapeconstructor, oldName, newName); } /// -/// Save the shape (with all current changes) to a new DTS file. @param filename Destination filename. @tsexample %this.saveShape( \"./myShape.dts\" ); @endtsexample ) +/// Save the shape (with all current changes) to a new DTS file. +/// @param filename Destination filename. +/// @tsexample +/// %this.saveShape( \"./myShape.dts\" ); +/// @endtsexample ) +/// /// public void saveShape(string tsshapeconstructor, string filename){ @@ -21846,7 +30635,10 @@ public void saveShape(string tsshapeconstructor, string filename){ m_ts.fnTSShapeConstructor_saveShape(tsshapeconstructor, filename); } /// -/// Set the shape bounds to the given bounding box. @param Bounding box \"minX minY minZ maxX maxY maxZ\" @return true if successful, false otherwise ) +/// Set the shape bounds to the given bounding box. +/// @param Bounding box \"minX minY minZ maxX maxY maxZ\" +/// @return true if successful, false otherwise ) +/// /// public bool setBounds(string tsshapeconstructor, Box3F bbox){ @@ -21854,7 +30646,16 @@ public bool setBounds(string tsshapeconstructor, Box3F bbox){ return m_ts.fnTSShapeConstructor_setBounds(tsshapeconstructor, bbox.AsString()); } /// -/// Change the size of a detail level. @note Note that detail levels are always sorted in decreasing size order, so this command may cause detail level indices to change. @param index index of the detail level to modify @param newSize new size for the detail level @return new index for this detail level @tsexample %this.setDetailLevelSize( 2, 256 ); @endtsexample ) +/// Change the size of a detail level. +/// @note Note that detail levels are always sorted in decreasing size order, +/// so this command may cause detail level indices to change. +/// @param index index of the detail level to modify +/// @param newSize new size for the detail level +/// @return new index for this detail level +/// @tsexample +/// %this.setDetailLevelSize( 2, 256 ); +/// @endtsexample ) +/// /// public int setDetailLevelSize(string tsshapeconstructor, int index, int newSize){ @@ -21862,7 +30663,17 @@ public int setDetailLevelSize(string tsshapeconstructor, int index, int newSize return m_ts.fnTSShapeConstructor_setDetailLevelSize(tsshapeconstructor, index, newSize); } /// -/// Set the name of the material attached to the mesh. @param meshName full name (object name + detail size) of the mesh to modify @param matName name of the material to attach. This could be the base name of the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a Material object already defined in script. @return true if successful, false otherwise @tsexample // set the mesh material %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); @endtsexample ) +/// Set the name of the material attached to the mesh. +/// @param meshName full name (object name + detail size) of the mesh to modify +/// @param matName name of the material to attach. This could be the base name of +/// the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a +/// Material object already defined in script. +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh material +/// %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); +/// @endtsexample ) +/// /// public bool setMeshMaterial(string tsshapeconstructor, string meshName, string matName){ @@ -21870,7 +30681,14 @@ public bool setMeshMaterial(string tsshapeconstructor, string meshName, string return m_ts.fnTSShapeConstructor_setMeshMaterial(tsshapeconstructor, meshName, matName); } /// -/// Change the detail level size of the named mesh. @param name full name (object name + current size ) of the mesh to modify @param size new detail level size @return true if successful, false otherwise. @tsexample %this.setMeshSize( \"SimpleShape128\", 64 ); @endtsexample ) +/// Change the detail level size of the named mesh. +/// @param name full name (object name + current size ) of the mesh to modify +/// @param size new detail level size +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.setMeshSize( \"SimpleShape128\", 64 ); +/// @endtsexample ) +/// /// public bool setMeshSize(string tsshapeconstructor, string name, int size){ @@ -21878,7 +30696,15 @@ public bool setMeshSize(string tsshapeconstructor, string name, int size){ return m_ts.fnTSShapeConstructor_setMeshSize(tsshapeconstructor, name, size); } /// -/// Set the display type for the mesh. @param name full name (object name + detail size) of the mesh to modify @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" @return true if successful, false otherwise @tsexample // set the mesh to be a billboard %this.setMeshType( \"SimpleShape64\", \"billboard\" ); @endtsexample ) +/// Set the display type for the mesh. +/// @param name full name (object name + detail size) of the mesh to modify +/// @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh to be a billboard +/// %this.setMeshType( \"SimpleShape64\", \"billboard\" ); +/// @endtsexample ) +/// /// public bool setMeshType(string tsshapeconstructor, string name, string type){ @@ -21886,7 +30712,14 @@ public bool setMeshType(string tsshapeconstructor, string name, string type){ return m_ts.fnTSShapeConstructor_setMeshType(tsshapeconstructor, name, type); } /// -/// Set the parent of a node. @param name name of the node to modify @param parentName name of the parent node to set (use \"\" to move the node to the root level) @return true if successful, false if failed @tsexample %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); @endtsexample ) +/// Set the parent of a node. +/// @param name name of the node to modify +/// @param parentName name of the parent node to set (use \"\" to move the node to the root level) +/// @return true if successful, false if failed +/// @tsexample +/// %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); +/// @endtsexample ) +/// /// public bool setNodeParent(string tsshapeconstructor, string name, string parentName){ @@ -21894,7 +30727,20 @@ public bool setNodeParent(string tsshapeconstructor, string name, string parent return m_ts.fnTSShapeConstructor_setNodeParent(tsshapeconstructor, name, parentName); } /// -/// Set the base transform of a node. That is, the transform of the node when in the root (not-animated) pose. @param name name of the node to modify @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); @endtsexample ) +/// Set the base transform of a node. That is, the transform of the node when +/// in the root (not-animated) pose. +/// @param name name of the node to modify +/// @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); +/// %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); +/// %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool setNodeTransform(string tsshapeconstructor, string name, TransformF txfm, bool isWorld = false){ @@ -21902,7 +30748,16 @@ public bool setNodeTransform(string tsshapeconstructor, string name, TransformF return m_ts.fnTSShapeConstructor_setNodeTransform(tsshapeconstructor, name, txfm.AsString(), isWorld); } /// -/// Set the node an object is attached to. When the shape is rendered, the object geometry is rendered at the node's current transform. @param objName name of the object to modify @param nodeName name of the node to attach the object to @return true if successful, false otherwise @tsexample %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); @endtsexample ) +/// Set the node an object is attached to. +/// When the shape is rendered, the object geometry is rendered at the node's +/// current transform. +/// @param objName name of the object to modify +/// @param nodeName name of the node to attach the object to +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); +/// @endtsexample ) +/// /// public bool setObjectNode(string tsshapeconstructor, string objName, string nodeName){ @@ -21910,7 +30765,19 @@ public bool setObjectNode(string tsshapeconstructor, string objName, string nod return m_ts.fnTSShapeConstructor_setObjectNode(tsshapeconstructor, objName, nodeName); } /// -/// Mark a sequence as a blend or non-blend. A blend sequence is one that will be added on top of any other playing sequences. This is done by storing the animated node transforms relative to a reference frame, rather than as absolute transforms. @param name name of the sequence to modify @param blend true to make the sequence a blend, false for a non-blend @param blendSeq the name of the sequence that contains the blend reference frame @param blendFrame the reference frame in the blendSeq sequence @return true if successful, false otherwise @tsexample %this.setSequenceBlend( \"look\", true, \"root\", 0 ); @endtsexample ) +/// Mark a sequence as a blend or non-blend. +/// A blend sequence is one that will be added on top of any other playing +/// sequences. This is done by storing the animated node transforms relative +/// to a reference frame, rather than as absolute transforms. +/// @param name name of the sequence to modify +/// @param blend true to make the sequence a blend, false for a non-blend +/// @param blendSeq the name of the sequence that contains the blend reference frame +/// @param blendFrame the reference frame in the blendSeq sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceBlend( \"look\", true, \"root\", 0 ); +/// @endtsexample ) +/// /// public bool setSequenceBlend(string tsshapeconstructor, string name, bool blend, string blendSeq, int blendFrame){ @@ -21918,7 +30785,15 @@ public bool setSequenceBlend(string tsshapeconstructor, string name, bool blend return m_ts.fnTSShapeConstructor_setSequenceBlend(tsshapeconstructor, name, blend, blendSeq, blendFrame); } /// -/// Mark a sequence as cyclic or non-cyclic. @param name name of the sequence to modify @param cyclic true to make the sequence cyclic, false for non-cyclic @return true if successful, false otherwise @tsexample %this.setSequenceCyclic( \"ambient\", true ); %this.setSequenceCyclic( \"shoot\", false ); @endtsexample ) +/// Mark a sequence as cyclic or non-cyclic. +/// @param name name of the sequence to modify +/// @param cyclic true to make the sequence cyclic, false for non-cyclic +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceCyclic( \"ambient\", true ); +/// %this.setSequenceCyclic( \"shoot\", false ); +/// @endtsexample ) +/// /// public bool setSequenceCyclic(string tsshapeconstructor, string name, bool cyclic){ @@ -21926,7 +30801,22 @@ public bool setSequenceCyclic(string tsshapeconstructor, string name, bool cycl return m_ts.fnTSShapeConstructor_setSequenceCyclic(tsshapeconstructor, name, cyclic); } /// -/// Set the translation and rotation ground speed of the sequence. The ground speed of the sequence is set by generating ground transform keyframes. The ground translational and rotational speed is assumed to be constant for the duration of the sequence. Existing ground frames for the sequence (if any) will be replaced. @param name name of the sequence to modify @param transSpeed translational speed (trans.x trans.y trans.z) in Torque units per frame @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in radians per frame. Default is \"0 0 0\" @return true if successful, false otherwise @tsexample %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); @endtsexample ) +/// Set the translation and rotation ground speed of the sequence. +/// The ground speed of the sequence is set by generating ground transform +/// keyframes. The ground translational and rotational speed is assumed to +/// be constant for the duration of the sequence. Existing ground frames for +/// the sequence (if any) will be replaced. +/// @param name name of the sequence to modify +/// @param transSpeed translational speed (trans.x trans.y trans.z) in +/// Torque units per frame +/// @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in +/// radians per frame. Default is \"0 0 0\" +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); +/// %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); +/// @endtsexample ) +/// /// public bool setSequenceGroundSpeed(string tsshapeconstructor, string name, Point3F transSpeed, Point3F rotSpeed = null ){ if (rotSpeed== null) {rotSpeed = new Point3F(0.0f, 0.0f, 0.0f);} @@ -21935,7 +30825,11 @@ public bool setSequenceGroundSpeed(string tsshapeconstructor, string name, Poin return m_ts.fnTSShapeConstructor_setSequenceGroundSpeed(tsshapeconstructor, name, transSpeed.AsString(), rotSpeed.AsString()); } /// -/// Set the sequence priority. @param name name of the sequence to modify @param priority new priority value @return true if successful, false otherwise ) +/// Set the sequence priority. +/// @param name name of the sequence to modify +/// @param priority new priority value +/// @return true if successful, false otherwise ) +/// /// public bool setSequencePriority(string tsshapeconstructor, string name, float priority){ @@ -21943,7 +30837,10 @@ public bool setSequencePriority(string tsshapeconstructor, string name, float p return m_ts.fnTSShapeConstructor_setSequencePriority(tsshapeconstructor, name, priority); } /// -/// Write the current change set to a TSShapeConstructor script file. The name of the script file is the same as the model, but with .cs extension. eg. myShape.cs for myShape.dts or myShape.dae. ) +/// Write the current change set to a TSShapeConstructor script file. The +/// name of the script file is the same as the model, but with .cs extension. +/// eg. myShape.cs for myShape.dts or myShape.dae. ) +/// /// public void writeChangeSet(string tsshapeconstructor){ @@ -21956,14 +30853,26 @@ public void writeChangeSet(string tsshapeconstructor){ /// public class TSStaticObject { -private Omni m_ts; - /// - /// - /// - /// -public TSStaticObject(ref Omni ts){m_ts = ts;} /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void changeMaterial(string tsstatic, string mapTo = "", string oldMat = null , string newMat = null ){ if (oldMat== null) {oldMat = null;} @@ -21973,7 +30882,15 @@ public void changeMaterial(string tsstatic, string mapTo = "", string oldMat = m_ts.fnTSStatic_changeMaterial(tsstatic, mapTo, oldMat, newMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string getModelFile(string tsstatic){ @@ -21981,7 +30898,10 @@ public string getModelFile(string tsstatic){ return m_ts.fnTSStatic_getModelFile(tsstatic); } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int getTargetCount(string tsstatic){ @@ -21989,7 +30909,11 @@ public int getTargetCount(string tsstatic){ return m_ts.fnTSStatic_getTargetCount(tsstatic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string getTargetName(string tsstatic, int index = 0){ @@ -22002,14 +30926,10 @@ public string getTargetName(string tsstatic, int index = 0){ /// public class TurretShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public TurretShapeObject(ref Omni ts){m_ts = ts;} /// -/// @brief Does the turret respawn after it has been destroyed. @returns True if the turret respawns.) +/// @brief Does the turret respawn after it has been destroyed. +/// @returns True if the turret respawns.) +/// /// public bool doRespawn(string turretshape){ @@ -22017,7 +30937,9 @@ public bool doRespawn(string turretshape){ return m_ts.fnTurretShape_doRespawn(turretshape); } /// -/// @brief Get if the turret is allowed to fire through moves. @return True if the turret is allowed to fire through moves. ) +/// @brief Get if the turret is allowed to fire through moves. +/// @return True if the turret is allowed to fire through moves. ) +/// /// public bool getAllowManualFire(string turretshape){ @@ -22025,7 +30947,9 @@ public bool getAllowManualFire(string turretshape){ return m_ts.fnTurretShape_getAllowManualFire(turretshape); } /// -/// @brief Get if the turret is allowed to rotate through moves. @return True if the turret is allowed to rotate through moves. ) +/// @brief Get if the turret is allowed to rotate through moves. +/// @return True if the turret is allowed to rotate through moves. ) +/// /// public bool getAllowManualRotation(string turretshape){ @@ -22033,7 +30957,15 @@ public bool getAllowManualRotation(string turretshape){ return m_ts.fnTurretShape_getAllowManualRotation(turretshape); } /// -/// @brief Get the name of the turret's current state. The state is one of the following:ul> li>Dead - The TurretShape is destroyed./li> li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> li>Ready - The TurretShape is free to move. The usual state./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// @brief Get the name of the turret's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The TurretShape is destroyed./li> +/// li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> +/// li>Ready - The TurretShape is free to move. The usual state./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// /// public string getState(string turretshape){ @@ -22041,7 +30973,10 @@ public string getState(string turretshape){ return m_ts.fnTurretShape_getState(turretshape); } /// -/// @brief Get Euler rotation of this turret's heading and pitch nodes. @return the orientation of the turret's heading and pitch nodes in the form of rotations around the X, Y and Z axes in degrees. ) +/// @brief Get Euler rotation of this turret's heading and pitch nodes. +/// @return the orientation of the turret's heading and pitch nodes in the +/// form of rotations around the X, Y and Z axes in degrees. ) +/// /// public Point3F getTurretEulerRotation(string turretshape){ @@ -22049,7 +30984,9 @@ public Point3F getTurretEulerRotation(string turretshape){ return new Point3F ( m_ts.fnTurretShape_getTurretEulerRotation(turretshape)); } /// -/// @brief Set if the turret is allowed to fire through moves. @param allow If true then the turret may be fired through moves.) +/// @brief Set if the turret is allowed to fire through moves. +/// @param allow If true then the turret may be fired through moves.) +/// /// public void setAllowManualFire(string turretshape, bool allow){ @@ -22057,7 +30994,9 @@ public void setAllowManualFire(string turretshape, bool allow){ m_ts.fnTurretShape_setAllowManualFire(turretshape, allow); } /// -/// @brief Set if the turret is allowed to rotate through moves. @param allow If true then the turret may be rotated through moves.) +/// @brief Set if the turret is allowed to rotate through moves. +/// @param allow If true then the turret may be rotated through moves.) +/// /// public void setAllowManualRotation(string turretshape, bool allow){ @@ -22065,7 +31004,10 @@ public void setAllowManualRotation(string turretshape, bool allow){ m_ts.fnTurretShape_setAllowManualRotation(turretshape, allow); } /// -/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. @param rot The rotation in degrees. The pitch is the X component and the heading is the Z component. The Y component is ignored.) +/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. +/// @param rot The rotation in degrees. The pitch is the X component and the +/// heading is the Z component. The Y component is ignored.) +/// /// public void setTurretEulerRotation(string turretshape, Point3F rot){ @@ -22078,14 +31020,9 @@ public void setTurretEulerRotation(string turretshape, Point3F rot){ /// public class UndoActionObject { -private Omni m_ts; - /// - /// - /// - /// -public UndoActionObject(ref Omni ts){m_ts = ts;} /// /// ), action.addToManager([undoManager])) +/// /// public void UndoAction_addToManager(string undoaction, string undoManager = ""){ @@ -22094,6 +31031,7 @@ public void UndoAction_addToManager(string undoaction, string undoManager = "") } /// /// () - Reo action contained in undo. ) +/// /// public void UndoAction_redo(string undoaction){ @@ -22102,6 +31040,7 @@ public void UndoAction_redo(string undoaction){ } /// /// () - Undo action contained in undo. ) +/// /// public void UndoAction_undo(string undoaction){ @@ -22114,14 +31053,9 @@ public void UndoAction_undo(string undoaction){ /// public class UndoManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public UndoManagerObject(ref Omni ts){m_ts = ts;} /// /// Clears the undo manager.) +/// /// public void UndoManager_clearAll(string undomanager){ @@ -22130,6 +31064,7 @@ public void UndoManager_clearAll(string undomanager){ } /// /// UndoManager.getNextRedoName();) +/// /// public string UndoManager_getNextRedoName(string undomanager){ @@ -22138,6 +31073,7 @@ public string UndoManager_getNextRedoName(string undomanager){ } /// /// UndoManager.getNextUndoName();) +/// /// public string UndoManager_getNextUndoName(string undomanager){ @@ -22146,6 +31082,7 @@ public string UndoManager_getNextUndoName(string undomanager){ } /// /// (index)) +/// /// public int UndoManager_getRedoAction(string undomanager, int index){ @@ -22154,6 +31091,7 @@ public int UndoManager_getRedoAction(string undomanager, int index){ } /// /// ) +/// /// public int UndoManager_getRedoCount(string undomanager){ @@ -22162,6 +31100,7 @@ public int UndoManager_getRedoCount(string undomanager){ } /// /// (index)) +/// /// public string UndoManager_getRedoName(string undomanager, int index){ @@ -22170,6 +31109,7 @@ public string UndoManager_getRedoName(string undomanager, int index){ } /// /// (index)) +/// /// public int UndoManager_getUndoAction(string undomanager, int index){ @@ -22178,6 +31118,7 @@ public int UndoManager_getUndoAction(string undomanager, int index){ } /// /// ) +/// /// public int UndoManager_getUndoCount(string undomanager){ @@ -22186,6 +31127,7 @@ public int UndoManager_getUndoCount(string undomanager){ } /// /// (index)) +/// /// public string UndoManager_getUndoName(string undomanager, int index){ @@ -22194,6 +31136,7 @@ public string UndoManager_getUndoName(string undomanager, int index){ } /// /// ( bool discard=false ) - Pop the current CompoundUndoAction off the stack. ) +/// /// public void UndoManager_popCompound(string undomanager, bool discard = false){ @@ -22202,6 +31145,7 @@ public void UndoManager_popCompound(string undomanager, bool discard = false){ } /// /// \"\"), ( string name=\"\" ) - Push a CompoundUndoAction onto the compound stack for assembly. ) +/// /// public string UndoManager_pushCompound(string undomanager, string name = "\"\""){ @@ -22210,6 +31154,7 @@ public string UndoManager_pushCompound(string undomanager, string name = "\"\"" } /// /// UndoManager.redo();) +/// /// public void UndoManager_redo(string undomanager){ @@ -22218,6 +31163,7 @@ public void UndoManager_redo(string undomanager){ } /// /// UndoManager.undo();) +/// /// public void UndoManager_undo(string undomanager){ @@ -22230,12 +31176,6 @@ public void UndoManager_undo(string undomanager){ /// public class VolumetricFogObject { -private Omni m_ts; - /// - /// - /// - /// -public VolumetricFogObject(ref Omni ts){m_ts = ts;} /// /// @brief Changes the color of the fog. /// @params new_color the new fog color (rgb 0-255, a is ignored.) @@ -22284,14 +31224,12 @@ public void SetFogModulation(string volumetricfog, float new_strenght, Point2F /// public class WalkableShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public WalkableShapeObject(ref Omni ts){m_ts = ts;} /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool attachObject(string walkableshape, string obj){ @@ -22299,7 +31237,14 @@ public bool attachObject(string walkableshape, string obj){ return m_ts.fnWalkableShape_attachObject(walkableshape, obj); } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void detachAll(string walkableshape){ @@ -22307,7 +31252,11 @@ public void detachAll(string walkableshape){ m_ts.fnWalkableShape_detachAll(walkableshape); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool detachObject(string walkableshape, string obj){ @@ -22316,6 +31265,7 @@ public bool detachObject(string walkableshape, string obj){ } /// /// Returns the attachment at the passed index value.) +/// /// public string getAttachment(string walkableshape, int index = 0){ @@ -22324,6 +31274,7 @@ public string getAttachment(string walkableshape, int index = 0){ } /// /// Returns the number of objects that are currently attached.) +/// /// public int getNumAttachments(string walkableshape){ @@ -22336,14 +31287,10 @@ public int getNumAttachments(string walkableshape){ /// public class WheeledVehicleObject { -private Omni m_ts; - /// - /// - /// - /// -public WheeledVehicleObject(ref Omni ts){m_ts = ts;} /// -/// @brief Get the number of wheels on this vehicle. @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// @brief Get the number of wheels on this vehicle. +/// @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// /// public int getWheelCount(string wheeledvehicle){ @@ -22351,7 +31298,13 @@ public int getWheelCount(string wheeledvehicle){ return m_ts.fnWheeledVehicle_getWheelCount(wheeledvehicle); } /// -/// @brief Set whether the wheel is powered (has torque applied from the engine). A rear wheel drive car for example would set the front wheels to false, and the rear wheels to true. @param wheel index of the wheel to set (hub node #) @param powered flag indicating whether to power the wheel or not @return true if successful, false if failed ) +/// @brief Set whether the wheel is powered (has torque applied from the engine). +/// A rear wheel drive car for example would set the front wheels to false, +/// and the rear wheels to true. +/// @param wheel index of the wheel to set (hub node #) +/// @param powered flag indicating whether to power the wheel or not +/// @return true if successful, false if failed ) +/// /// public bool setWheelPowered(string wheeledvehicle, int wheel, bool powered){ @@ -22359,7 +31312,14 @@ public bool setWheelPowered(string wheeledvehicle, int wheel, bool powered){ return m_ts.fnWheeledVehicle_setWheelPowered(wheeledvehicle, wheel, powered); } /// -/// @brief Set the WheeledVehicleSpring datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param spring WheeledVehicleSpring datablock @return true if successful, false if failed @tsexample %obj.setWheelSpring( 0, FrontSpring ); @endtsexample ) +/// @brief Set the WheeledVehicleSpring datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param spring WheeledVehicleSpring datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelSpring( 0, FrontSpring ); +/// @endtsexample ) +/// /// public bool setWheelSpring(string wheeledvehicle, int wheel, string spring){ @@ -22367,7 +31327,16 @@ public bool setWheelSpring(string wheeledvehicle, int wheel, string spring){ return m_ts.fnWheeledVehicle_setWheelSpring(wheeledvehicle, wheel, spring); } /// -/// @brief Set how much the wheel is affected by steering. The steering factor controls how much the wheel is rotated by the vehicle steering. For example, most cars would have their front wheels set to 1.0, and their rear wheels set to 0 since only the front wheels should turn. Negative values will turn the wheel in the opposite direction to the steering angle. @param wheel index of the wheel to set (hub node #) @param steering steering factor from -1 (full inverse) to 1 (full) @return true if successful, false if failed ) +/// @brief Set how much the wheel is affected by steering. +/// The steering factor controls how much the wheel is rotated by the vehicle +/// steering. For example, most cars would have their front wheels set to 1.0, +/// and their rear wheels set to 0 since only the front wheels should turn. +/// Negative values will turn the wheel in the opposite direction to the steering +/// angle. +/// @param wheel index of the wheel to set (hub node #) +/// @param steering steering factor from -1 (full inverse) to 1 (full) +/// @return true if successful, false if failed ) +/// /// public bool setWheelSteering(string wheeledvehicle, int wheel, float steering){ @@ -22375,7 +31344,14 @@ public bool setWheelSteering(string wheeledvehicle, int wheel, float steering){ return m_ts.fnWheeledVehicle_setWheelSteering(wheeledvehicle, wheel, steering); } /// -/// @brief Set the WheeledVehicleTire datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param tire WheeledVehicleTire datablock @return true if successful, false if failed @tsexample %obj.setWheelTire( 0, FrontTire ); @endtsexample ) +/// @brief Set the WheeledVehicleTire datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param tire WheeledVehicleTire datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelTire( 0, FrontTire ); +/// @endtsexample ) +/// /// public bool setWheelTire(string wheeledvehicle, int wheel, string tire){ @@ -22388,14 +31364,9 @@ public bool setWheelTire(string wheeledvehicle, int wheel, string tire){ /// public class WorldEditorObject { -private Omni m_ts; - /// - /// - /// - /// -public WorldEditorObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void WorldEditor_addUndoState(string worldeditor){ @@ -22403,7 +31374,9 @@ public void WorldEditor_addUndoState(string worldeditor){ m_ts.fn_WorldEditor_addUndoState(worldeditor); } /// -/// (int axis) Align all selected objects along the given axis.) +/// (int axis) +/// Align all selected objects along the given axis.) +/// /// public void WorldEditor_alignByAxis(string worldeditor, int boundsAxis){ @@ -22411,7 +31384,9 @@ public void WorldEditor_alignByAxis(string worldeditor, int boundsAxis){ m_ts.fn_WorldEditor_alignByAxis(worldeditor, boundsAxis); } /// -/// (int boundsAxis) Align all selected objects against the given bounds axis.) +/// (int boundsAxis) +/// Align all selected objects against the given bounds axis.) +/// /// public void WorldEditor_alignByBounds(string worldeditor, int boundsAxis){ @@ -22420,6 +31395,7 @@ public void WorldEditor_alignByBounds(string worldeditor, int boundsAxis){ } /// /// ) +/// /// public bool WorldEditor_canPasteSelection(string worldeditor){ @@ -22428,6 +31404,7 @@ public bool WorldEditor_canPasteSelection(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_clearIgnoreList(string worldeditor){ @@ -22436,6 +31413,7 @@ public void WorldEditor_clearIgnoreList(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_clearSelection(string worldeditor){ @@ -22444,6 +31422,7 @@ public void WorldEditor_clearSelection(string worldeditor){ } /// /// ( String path ) - Export the combined geometry of all selected objects to the specified path in collada format. ) +/// /// public void WorldEditor_colladaExportSelection(string worldeditor, string path){ @@ -22452,6 +31431,7 @@ public void WorldEditor_colladaExportSelection(string worldeditor, string path) } /// /// ) +/// /// public void WorldEditor_copySelection(string worldeditor){ @@ -22460,6 +31440,7 @@ public void WorldEditor_copySelection(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_cutSelection(string worldeditor){ @@ -22468,6 +31449,7 @@ public void WorldEditor_cutSelection(string worldeditor){ } /// /// ( bool skipUndo = false )) +/// /// public void WorldEditor_dropSelection(string worldeditor, bool skipUndo = false){ @@ -22476,6 +31458,7 @@ public void WorldEditor_dropSelection(string worldeditor, bool skipUndo = false } /// /// () - Replace selected Prefab objects with a SimGroup containing all children objects defined in the .prefab. ) +/// /// public void WorldEditor_explodeSelectedPrefab(string worldeditor){ @@ -22484,6 +31467,7 @@ public void WorldEditor_explodeSelectedPrefab(string worldeditor){ } /// /// () - Return the currently active WorldEditorSelection object. ) +/// /// public int WorldEditor_getActiveSelection(string worldeditor){ @@ -22492,6 +31476,7 @@ public int WorldEditor_getActiveSelection(string worldeditor){ } /// /// (int index)) +/// /// public int WorldEditor_getSelectedObject(string worldeditor, int index){ @@ -22500,6 +31485,7 @@ public int WorldEditor_getSelectedObject(string worldeditor, int index){ } /// /// ) +/// /// public string WorldEditor_getSelectionCentroid(string worldeditor){ @@ -22508,6 +31494,7 @@ public string WorldEditor_getSelectionCentroid(string worldeditor){ } /// /// ) +/// /// public Point3F WorldEditor_getSelectionExtent(string worldeditor){ @@ -22516,6 +31503,7 @@ public Point3F WorldEditor_getSelectionExtent(string worldeditor){ } /// /// ) +/// /// public float WorldEditor_getSelectionRadius(string worldeditor){ @@ -22524,6 +31512,7 @@ public float WorldEditor_getSelectionRadius(string worldeditor){ } /// /// () - Return the number of objects currently selected in the editor.) +/// /// public int WorldEditor_getSelectionSize(string worldeditor){ @@ -22531,7 +31520,9 @@ public int WorldEditor_getSelectionSize(string worldeditor){ return m_ts.fn_WorldEditor_getSelectionSize(worldeditor); } /// -/// getSoftSnap() Is soft snapping always on?) +/// getSoftSnap() +/// Is soft snapping always on?) +/// /// public bool WorldEditor_getSoftSnap(string worldeditor){ @@ -22539,7 +31530,9 @@ public bool WorldEditor_getSoftSnap(string worldeditor){ return m_ts.fn_WorldEditor_getSoftSnap(worldeditor); } /// -/// getSoftSnapBackfaceTolerance() The fraction of the soft snap radius that backfaces may be included.) +/// getSoftSnapBackfaceTolerance() +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public float WorldEditor_getSoftSnapBackfaceTolerance(string worldeditor){ @@ -22547,7 +31540,9 @@ public float WorldEditor_getSoftSnapBackfaceTolerance(string worldeditor){ return m_ts.fn_WorldEditor_getSoftSnapBackfaceTolerance(worldeditor); } /// -/// getSoftSnapSize() Get the absolute size to trigger a soft snap.) +/// getSoftSnapSize() +/// Get the absolute size to trigger a soft snap.) +/// /// public float WorldEditor_getSoftSnapSize(string worldeditor){ @@ -22556,6 +31551,7 @@ public float WorldEditor_getSoftSnapSize(string worldeditor){ } /// /// (Object obj, bool hide)) +/// /// public void WorldEditor_hideObject(string worldeditor, string obj, bool hide){ @@ -22564,6 +31560,7 @@ public void WorldEditor_hideObject(string worldeditor, string obj, bool hide){ } /// /// (bool hide)) +/// /// public void WorldEditor_hideSelection(string worldeditor, bool hide){ @@ -22572,6 +31569,7 @@ public void WorldEditor_hideSelection(string worldeditor, bool hide){ } /// /// ) +/// /// public void WorldEditor_invalidateSelectionCentroid(string worldeditor){ @@ -22580,6 +31578,7 @@ public void WorldEditor_invalidateSelectionCentroid(string worldeditor){ } /// /// (bool lock)) +/// /// public void WorldEditor_lockSelection(string worldeditor, bool lockx){ @@ -22588,6 +31587,7 @@ public void WorldEditor_lockSelection(string worldeditor, bool lockx){ } /// /// ( string filename ) - Save selected objects to a .prefab file and replace them in the level with a Prefab object. ) +/// /// public void WorldEditor_makeSelectionPrefab(string worldeditor, string filename){ @@ -22596,6 +31596,7 @@ public void WorldEditor_makeSelectionPrefab(string worldeditor, string filename } /// /// ( Object A, Object B ) ) +/// /// public void WorldEditor_mountRelative(string worldeditor, string objA, string objB){ @@ -22604,6 +31605,7 @@ public void WorldEditor_mountRelative(string worldeditor, string objA, string o } /// /// ) +/// /// public void WorldEditor_pasteSelection(string worldeditor){ @@ -22612,6 +31614,7 @@ public void WorldEditor_pasteSelection(string worldeditor){ } /// /// ( int objID )) +/// /// public void WorldEditor_redirectConsole(string worldeditor, int objID){ @@ -22620,6 +31623,7 @@ public void WorldEditor_redirectConsole(string worldeditor, int objID){ } /// /// ) +/// /// public void WorldEditor_resetSelectedRotation(string worldeditor){ @@ -22628,6 +31632,7 @@ public void WorldEditor_resetSelectedRotation(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_resetSelectedScale(string worldeditor){ @@ -22636,6 +31641,7 @@ public void WorldEditor_resetSelectedScale(string worldeditor){ } /// /// (SimObject obj)) +/// /// public void WorldEditor_selectObject(string worldeditor, string objName){ @@ -22644,6 +31650,7 @@ public void WorldEditor_selectObject(string worldeditor, string objName){ } /// /// ( id set ) - Set the currently active WorldEditorSelection object. ) +/// /// public void WorldEditor_setActiveSelection(string worldeditor, string selection){ @@ -22651,7 +31658,9 @@ public void WorldEditor_setActiveSelection(string worldeditor, string selection m_ts.fn_WorldEditor_setActiveSelection(worldeditor, selection); } /// -/// setSoftSnap(bool) Allow soft snapping all of the time.) +/// setSoftSnap(bool) +/// Allow soft snapping all of the time.) +/// /// public void WorldEditor_setSoftSnap(string worldeditor, bool enable){ @@ -22659,7 +31668,9 @@ public void WorldEditor_setSoftSnap(string worldeditor, bool enable){ m_ts.fn_WorldEditor_setSoftSnap(worldeditor, enable); } /// -/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) The fraction of the soft snap radius that backfaces may be included.) +/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public void WorldEditor_setSoftSnapBackfaceTolerance(string worldeditor, float range){ @@ -22667,7 +31678,9 @@ public void WorldEditor_setSoftSnapBackfaceTolerance(string worldeditor, float m_ts.fn_WorldEditor_setSoftSnapBackfaceTolerance(worldeditor, range); } /// -/// setSoftSnapSize(F32) Set the absolute size to trigger a soft snap.) +/// setSoftSnapSize(F32) +/// Set the absolute size to trigger a soft snap.) +/// /// public void WorldEditor_setSoftSnapSize(string worldeditor, float size){ @@ -22675,7 +31688,9 @@ public void WorldEditor_setSoftSnapSize(string worldeditor, float size){ m_ts.fn_WorldEditor_setSoftSnapSize(worldeditor, size); } /// -/// softSnapDebugRender(bool) Toggle soft snapping debug rendering.) +/// softSnapDebugRender(bool) +/// Toggle soft snapping debug rendering.) +/// /// public void WorldEditor_softSnapDebugRender(string worldeditor, bool enable){ @@ -22683,7 +31698,9 @@ public void WorldEditor_softSnapDebugRender(string worldeditor, bool enable){ m_ts.fn_WorldEditor_softSnapDebugRender(worldeditor, enable); } /// -/// softSnapRender(bool) Render the soft snapping bounds.) +/// softSnapRender(bool) +/// Render the soft snapping bounds.) +/// /// public void WorldEditor_softSnapRender(string worldeditor, bool enable){ @@ -22691,7 +31708,9 @@ public void WorldEditor_softSnapRender(string worldeditor, bool enable){ m_ts.fn_WorldEditor_softSnapRender(worldeditor, enable); } /// -/// softSnapRenderTriangle(bool) Render the soft snapped triangle.) +/// softSnapRenderTriangle(bool) +/// Render the soft snapped triangle.) +/// /// public void WorldEditor_softSnapRenderTriangle(string worldeditor, bool enable){ @@ -22699,7 +31718,9 @@ public void WorldEditor_softSnapRenderTriangle(string worldeditor, bool enable) m_ts.fn_WorldEditor_softSnapRenderTriangle(worldeditor, enable); } /// -/// softSnapSizeByBounds(bool) Use selection bounds size as soft snap bounds.) +/// softSnapSizeByBounds(bool) +/// Use selection bounds size as soft snap bounds.) +/// /// public void WorldEditor_softSnapSizeByBounds(string worldeditor, bool enable){ @@ -22707,7 +31728,9 @@ public void WorldEditor_softSnapSizeByBounds(string worldeditor, bool enable){ m_ts.fn_WorldEditor_softSnapSizeByBounds(worldeditor, enable); } /// -/// transformSelection(...) Transform selection by given parameters.) +/// transformSelection(...) +/// Transform selection by given parameters.) +/// /// public void WorldEditor_transformSelection(string worldeditor, bool position, Point3F point, bool relativePos, bool rotate, Point3F rotation, bool relativeRot, bool rotLocal, int scaleType, Point3F scale, bool sRelative, bool sLocal){ @@ -22716,6 +31739,7 @@ public void WorldEditor_transformSelection(string worldeditor, bool position, P } /// /// (SimObject obj)) +/// /// public void WorldEditor_unselectObject(string worldeditor, string objName){ @@ -22724,6 +31748,7 @@ public void WorldEditor_unselectObject(string worldeditor, string objName){ } /// /// Create a ConvexShape from the given polyhedral object. ) +/// /// public string createConvexShapeFrom(string worldeditor, string polyObject){ @@ -22732,6 +31757,7 @@ public string createConvexShapeFrom(string worldeditor, string polyObject){ } /// /// Grab the geometry from @a geometryProvider, create a @a className object, and assign it the extracted geometry. ) +/// /// public string createPolyhedralObject(string worldeditor, string className, string geometryProvider){ @@ -22740,6 +31766,7 @@ public string createPolyhedralObject(string worldeditor, string className, stri } /// /// Get the soft snap alignment. ) +/// /// public TypeWorldEditorAlignmentType getSoftSnapAlignment(string worldeditor){ @@ -22748,6 +31775,7 @@ public TypeWorldEditorAlignmentType getSoftSnapAlignment(string worldeditor){ } /// /// Get the terrain snap alignment. ) +/// /// public TypeWorldEditorAlignmentType getTerrainSnapAlignment(string worldeditor){ @@ -22756,6 +31784,7 @@ public TypeWorldEditorAlignmentType getTerrainSnapAlignment(string worldeditor) } /// /// ( WorldEditor, ignoreObjClass, void, 3, 0, (string class_name, ...)) +/// /// public void ignoreObjClass(string worldeditor, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -22764,6 +31793,7 @@ public void ignoreObjClass(string worldeditor, string a2= "", string a3= "", st } /// /// Set the soft snap alignment. ) +/// /// public void setSoftSnapAlignment(string worldeditor, TypeWorldEditorAlignmentType type){ @@ -22772,6 +31802,7 @@ public void setSoftSnapAlignment(string worldeditor, TypeWorldEditorAlignmentTy } /// /// Set the terrain snap alignment. ) +/// /// public void setTerrainSnapAlignment(string worldeditor, TypeWorldEditorAlignmentType alignment){ @@ -22784,14 +31815,9 @@ public void setTerrainSnapAlignment(string worldeditor, TypeWorldEditorAlignmen /// public class WorldEditorSelectionObject { -private Omni m_ts; - /// - /// - /// - /// -public WorldEditorSelectionObject(ref Omni ts){m_ts = ts;} /// /// ( WorldEditorSelection, containsGlobalBounds, bool, 2, 2, () - True if an object with global bounds is contained in the selection. ) +/// /// public bool containsGlobalBounds(string worldeditorselection= ""){ @@ -22800,6 +31826,7 @@ public bool containsGlobalBounds(string worldeditorselection= ""){ } /// /// ( WorldEditorSelection, getBoxCentroid, const char*, 2, 2, () - Return the center of the bounding box around the selection. ) +/// /// public string getBoxCentroid(string worldeditorselection= ""){ @@ -22808,6 +31835,7 @@ public string getBoxCentroid(string worldeditorselection= ""){ } /// /// ( WorldEditorSelection, getCentroid, const char*, 2, 2, () - Return the median of all object positions in the selection. ) +/// /// public string getCentroid(string worldeditorselection= ""){ @@ -22816,6 +31844,7 @@ public string getCentroid(string worldeditorselection= ""){ } /// /// ( WorldEditorSelection, offset, void, 3, 4, ( vector delta, float gridSnap=0 ) - Move all objects in the selection by the given delta. ) +/// /// public void offset(string worldeditorselection, string a2= "", string a3= ""){ @@ -22824,6 +31853,7 @@ public void offset(string worldeditorselection, string a2= "", string a3= ""){ } /// /// ( WorldEditorSelection, subtract, void, 3, 3, ( SimSet ) - Remove all objects in the given set from this selection. ) +/// /// public void subtract(string worldeditorselection, string a2= ""){ @@ -22832,6 +31862,7 @@ public void subtract(string worldeditorselection, string a2= ""){ } /// /// ( WorldEditorSelection, union, void, 3, 3, ( SimSet set ) - Add all objects in the given set to this selection. ) +/// /// public void union(string worldeditorselection, string a2= ""){ @@ -22844,14 +31875,15 @@ public void union(string worldeditorselection, string a2= ""){ /// public class ZipObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public ZipObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Add a file to the zip archive @param filename The path and name of the file to add to the zip archive. @param pathInZip The path and name to be given to the file within the zip archive. @param replace If a file already exists within the zip archive at the same location as this new file, this parameter indicates if it should be replaced. By default, it will be replaced. @return True if the file was successfully added to the zip archive.) +/// @brief Add a file to the zip archive +/// +/// @param filename The path and name of the file to add to the zip archive. +/// @param pathInZip The path and name to be given to the file within the zip archive. +/// @param replace If a file already exists within the zip archive at the same location as this +/// new file, this parameter indicates if it should be replaced. By default, it will be replaced. +/// @return True if the file was successfully added to the zip archive.) +/// /// public bool addFile(string zipobject, string filename, string pathInZip, bool replace = true){ @@ -22859,7 +31891,9 @@ public bool addFile(string zipobject, string filename, string pathInZip, bool r return m_ts.fnZipObject_addFile(zipobject, filename, pathInZip, replace); } /// -/// @brief Close an already opened zip archive. @see openArchive()) +/// @brief Close an already opened zip archive. +/// @see openArchive()) +/// /// public void closeArchive(string zipobject){ @@ -22867,7 +31901,11 @@ public void closeArchive(string zipobject){ m_ts.fnZipObject_closeArchive(zipobject); } /// -/// @brief Close a previously opened file within the zip archive. @param stream The StreamObject of a previously opened file within the zip archive. @see openFileForRead() @see openFileForWrite()) +/// @brief Close a previously opened file within the zip archive. +/// @param stream The StreamObject of a previously opened file within the zip archive. +/// @see openFileForRead() +/// @see openFileForWrite()) +/// /// public void closeFile(string zipobject, string stream){ @@ -22875,7 +31913,19 @@ public void closeFile(string zipobject, string stream){ m_ts.fnZipObject_closeFile(zipobject, stream); } /// -/// @brief Deleted the given file from the zip archive @param pathInZip The path and name of the file to be deleted from the zip archive. @return True of the file was successfully deleted. @note Files that have been deleted from the archive will still show up with a getFileEntryCount() until you close the archive. If you need to have the file count up to date with only valid files within the archive, you could close and then open the archive again. @see getFileEntryCount() @see closeArchive() @see openArchive()) +/// @brief Deleted the given file from the zip archive +/// @param pathInZip The path and name of the file to be deleted from the zip archive. +/// @return True of the file was successfully deleted. +/// +/// @note Files that have been deleted from the archive will still show up with a +/// getFileEntryCount() until you close the archive. If you need to have the file +/// count up to date with only valid files within the archive, you could close and then +/// open the archive again. +/// +/// @see getFileEntryCount() +/// @see closeArchive() +/// @see openArchive()) +/// /// public bool deleteFile(string zipobject, string pathInZip){ @@ -22883,7 +31933,11 @@ public bool deleteFile(string zipobject, string pathInZip){ return m_ts.fnZipObject_deleteFile(zipobject, pathInZip); } /// -/// @brief Extact a file from the zip archive and save it to the requested location. @param pathInZip The path and name of the file to be extracted within the zip archive. @param filename The path and name to give the extracted file. @return True if the file was successfully extracted.) +/// @brief Extact a file from the zip archive and save it to the requested location. +/// @param pathInZip The path and name of the file to be extracted within the zip archive. +/// @param filename The path and name to give the extracted file. +/// @return True if the file was successfully extracted.) +/// /// public bool extractFile(string zipobject, string pathInZip, string filename){ @@ -22891,7 +31945,22 @@ public bool extractFile(string zipobject, string pathInZip, string filename){ return m_ts.fnZipObject_extractFile(zipobject, pathInZip, filename); } /// -/// @brief Get information on the requested file within the zip archive. This methods provides five different pieces of information for the requested file: ul>li>filename - The path and name of the file within the zip archive/li> li>uncompressed size/li> li>compressed size/li> li>compression method/li> li>CRC32/li>/ul> Use getFileEntryCount() to obtain the total number of files within the archive. @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. @see getFileEntryCount()) +/// @brief Get information on the requested file within the zip archive. +/// +/// This methods provides five different pieces of information for the requested file: +/// ul>li>filename - The path and name of the file within the zip archive/li> +/// li>uncompressed size/li> +/// li>compressed size/li> +/// li>compression method/li> +/// li>CRC32/li>/ul> +/// +/// Use getFileEntryCount() to obtain the total number of files within the archive. +/// +/// @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. +/// @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. +/// +/// @see getFileEntryCount()) +/// /// public string getFileEntry(string zipobject, int index){ @@ -22899,7 +31968,20 @@ public string getFileEntry(string zipobject, int index){ return m_ts.fnZipObject_getFileEntry(zipobject, index); } /// -/// @brief Get the number of files within the zip archive. Use getFileEntry() to retrive information on each file within the archive. @return The number of files within the zip archive. @note The returned count will include any files that have been deleted from the archive using deleteFile(). To clear out all deleted files, you could close and then open the archive again. @see getFileEntry() @see closeArchive() @see openArchive()) +/// @brief Get the number of files within the zip archive. +/// +/// Use getFileEntry() to retrive information on each file within the archive. +/// +/// @return The number of files within the zip archive. +/// +/// @note The returned count will include any files that have been deleted from +/// the archive using deleteFile(). To clear out all deleted files, you could +/// close and then open the archive again. +/// +/// @see getFileEntry() +/// @see closeArchive() +/// @see openArchive()) +/// /// public int getFileEntryCount(string zipobject){ @@ -22907,7 +31989,23 @@ public int getFileEntryCount(string zipobject){ return m_ts.fnZipObject_getFileEntryCount(zipobject); } /// -/// read ), @brief Open a zip archive for manipulation. Once a zip archive is opened use the various ZipObject methods for working with the files within the archive. Be sure to close the archive when you are done with it. @param filename The path and file name of the zip archive to open. @param accessMode One of read, write or readwrite @return True is the archive was successfully opened. @note If you wish to make any changes to the archive, be sure to open it with a write or readwrite access mode. @see closeArchive()) +/// read ), +/// @brief Open a zip archive for manipulation. +/// +/// Once a zip archive is opened use the various ZipObject methods for +/// working with the files within the archive. Be sure to close the archive when +/// you are done with it. +/// +/// @param filename The path and file name of the zip archive to open. +/// @param accessMode One of read, write or readwrite +/// +/// @return True is the archive was successfully opened. +/// +/// @note If you wish to make any changes to the archive, be sure to open it +/// with a write or readwrite access mode. +/// +/// @see closeArchive()) +/// /// public bool openArchive(string zipobject, string filename, string accessMode = "read"){ @@ -22915,7 +32013,18 @@ public bool openArchive(string zipobject, string filename, string accessMode = return m_ts.fnZipObject_openArchive(zipobject, filename, accessMode); } /// -/// @brief Open a file within the zip archive for reading. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for reading. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string openFileForRead(string zipobject, string filename){ @@ -22923,7 +32032,18 @@ public string openFileForRead(string zipobject, string filename){ return m_ts.fnZipObject_openFileForRead(zipobject, filename); } /// -/// @brief Open a file within the zip archive for writing to. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for writing to. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string openFileForWrite(string zipobject, string filename){ @@ -22936,14 +32056,12 @@ public string openFileForWrite(string zipobject, string filename){ /// public class ZoneObject { -private Omni m_ts; - /// - /// - /// - /// -public ZoneObject(ref Omni ts){m_ts = ts;} /// -/// Dump a list of all objects assigned to the zone to the console as well as a list of all connected zone spaces. @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of objects are updated on demand, the zone contents can be outdated. ) +/// Dump a list of all objects assigned to the zone to the console as well as a list +/// of all connected zone spaces. +/// @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of +/// objects are updated on demand, the zone contents can be outdated. ) +/// /// public void dumpZoneState(string zone, bool updateFirst = true){ @@ -22951,7 +32069,9 @@ public void dumpZoneState(string zone, bool updateFirst = true){ m_ts.fnZone_dumpZoneState(zone, updateFirst); } /// -/// Get the unique numeric ID of the zone in its scene. @return The ID of the zone. ) +/// Get the unique numeric ID of the zone in its scene. +/// @return The ID of the zone. ) +/// /// public int getZoneId(string zone){ diff --git a/Templates/C#-Empty/Winterleaf.Engine.Omni/Classes/ModelBase.cs b/Templates/C#-Empty/Winterleaf.Engine.Omni/Classes/ModelBase.cs index f52ea1bf..ae729213 100644 --- a/Templates/C#-Empty/Winterleaf.Engine.Omni/Classes/ModelBase.cs +++ b/Templates/C#-Empty/Winterleaf.Engine.Omni/Classes/ModelBase.cs @@ -48,8 +48,6 @@ namespace WinterLeaf.Engine.Classes [TypeConverter(typeof (TypeConverterGeneric))] public class ModelBase : pInvokes, IConvertible { - public static readonly pInvokes omni = new pInvokes(); - public static ulong Objectcount = 0; public ModelBase() diff --git a/Templates/C#-Empty/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs b/Templates/C#-Empty/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs index 0564d352..f7930249 100644 --- a/Templates/C#-Empty/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs +++ b/Templates/C#-Empty/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs @@ -5960,7 +5960,7 @@ public object this[string key] public static readonly TypeGuiStackingType Vertical = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeVert,"Vertical","Stack children vertically by setting their Y position"); public static readonly TypeGuiStackingType Horizontal = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeHoriz,"Horizontal","Stack children horizontall by setting their X position"); - public static readonly TypeGuiStackingType Dynamic = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeDyn,"Dynamic","Automatically switch between Vertical and Horizontal stacking. Vertical stacking is chosen when the stack control is taller than it is wide, horizontal stacking is chosen when the stack control is wider than it is tall. "); + public static readonly TypeGuiStackingType Dynamic = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeDyn,"Dynamic","Automatically switch between Vertical and Horizontal stacking. Vertical stacking is chosen when the stack control is taller than it is wide, horizontal stacking is chosen when the stack control is wider than it is tall. "); }; /// @@ -7896,29 +7896,29 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXChannel Volume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVolume,"Volume","Channel controls volume level of attached sound sources. n @see SFXDescription::volume "); - public static readonly TypeSFXChannel Pitch = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPitch,"Pitch","Channel controls pitch of attached sound sources. n @see SFXDescription::pitch "); - public static readonly TypeSFXChannel Priority = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPriority,"Priority","Channel controls virtualizaton priority level of attached sound sources. n @see SFXDescription::priority "); - public static readonly TypeSFXChannel PositionX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionX,"PositionX","Channel controls X coordinate of 3D sound position of attached sources. "); - public static readonly TypeSFXChannel PositionY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionY,"PositionY","Channel controls Y coordinate of 3D sound position of attached sources. "); - public static readonly TypeSFXChannel PositionZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionZ,"PositionZ","Channel controls Z coordinate of 3D sound position of attached sources. "); - public static readonly TypeSFXChannel RotationX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationX,"RotationX","Channel controls X rotation (in degrees) of 3D sound orientation of attached sources. "); - public static readonly TypeSFXChannel RotationY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationY,"RotationY","Channel controls Y rotation (in degrees) of 3D sound orientation of attached sources. "); - public static readonly TypeSFXChannel RotationZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationZ,"RotationZ","Channel controls Z rotation (in degrees) of 3D sound orientation of attached sources. "); - public static readonly TypeSFXChannel VelocityX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityX,"VelocityX","Channel controls X coordinate of 3D sound velocity vector of attached sources. "); - public static readonly TypeSFXChannel VelocityY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityY,"VelocityY","Channel controls Y coordinate of 3D sound velocity vector of attached sources. "); - public static readonly TypeSFXChannel VelocityZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityZ,"VelocityZ","Channel controls Z coordinate of 3D sound velocity vector of attached sources. "); - public static readonly TypeSFXChannel ReferenceDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMinDistance,"ReferenceDistance","Channel controls reference distance of 3D sound of attached sources. n @see SFXDescription::referenceDistance "); - public static readonly TypeSFXChannel MaxDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMaxDistance,"MaxDistance","Channel controls max volume attenuation distance of 3D sound of attached sources. n @see SFXDescription::maxDistance "); - public static readonly TypeSFXChannel ConeInsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeInsideAngle,"ConeInsideAngle","Channel controls angle (in degrees) of 3D sound inner volume cone of attached sources. n @see SFXDescription::coneInsideAngle "); - public static readonly TypeSFXChannel ConeOutsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideAngle,"ConeOutsideAngle","Channel controls angle (in degrees) of 3D sound outer volume cone of attached sources. n @see SFXDescription::coneOutsideAngle "); - public static readonly TypeSFXChannel ConeOutsideVolume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideVolume,"ConeOutsideVolume","Channel controls volume outside of 3D sound outer cone of attached sources. n @see SFXDescription::coneOutsideVolume "); - public static readonly TypeSFXChannel Cursor = new TypeSFXChannel((int)R__SFXChannel.SFXChannelCursor,"Cursor","Channel controls playback cursor of attached sound sources. n n @note Be aware that different types of sound sources interpret play cursor positions differently or do not actually have play cursors (these sources will ignore the channel). "); - public static readonly TypeSFXChannel Status = new TypeSFXChannel((int)R__SFXChannel.SFXChannelStatus,"Status","Channel controls playback status of attached sound sources. n n The channel's value is rounded down to the nearest integer and interpreted in the following way: n - 1: Play n - 2: Stop n - 3: Pause n n "); - public static readonly TypeSFXChannel User0 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser0,"User0","Channel available for custom use. By default ignored by sources. n n @note For FMOD Designer event sources (SFXFMODEventSource), this channel is used for event parameters defined in FMOD Designer and should not be used otherwise. n n @see SFXSource::onParameterValueChange "); - public static readonly TypeSFXChannel User1 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser1,"User1","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); - public static readonly TypeSFXChannel User2 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser2,"User2","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); - public static readonly TypeSFXChannel User3 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser3,"User3","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel Volume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVolume,"Volume","Channel controls volume level of attached sound sources. n @see SFXDescription::volume "); + public static readonly TypeSFXChannel Pitch = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPitch,"Pitch","Channel controls pitch of attached sound sources. n @see SFXDescription::pitch "); + public static readonly TypeSFXChannel Priority = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPriority,"Priority","Channel controls virtualizaton priority level of attached sound sources. n @see SFXDescription::priority "); + public static readonly TypeSFXChannel PositionX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionX,"PositionX"," Channel controls X coordinate of 3D sound position of attached sources. "); + public static readonly TypeSFXChannel PositionY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionY,"PositionY"," Channel controls Y coordinate of 3D sound position of attached sources. "); + public static readonly TypeSFXChannel PositionZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionZ,"PositionZ"," Channel controls Z coordinate of 3D sound position of attached sources. "); + public static readonly TypeSFXChannel RotationX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationX,"RotationX"," Channel controls X rotation (in degrees) of 3D sound orientation of attached sources. "); + public static readonly TypeSFXChannel RotationY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationY,"RotationY"," Channel controls Y rotation (in degrees) of 3D sound orientation of attached sources. "); + public static readonly TypeSFXChannel RotationZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationZ,"RotationZ"," Channel controls Z rotation (in degrees) of 3D sound orientation of attached sources. "); + public static readonly TypeSFXChannel VelocityX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityX,"VelocityX"," Channel controls X coordinate of 3D sound velocity vector of attached sources. "); + public static readonly TypeSFXChannel VelocityY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityY,"VelocityY"," Channel controls Y coordinate of 3D sound velocity vector of attached sources. "); + public static readonly TypeSFXChannel VelocityZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityZ,"VelocityZ"," Channel controls Z coordinate of 3D sound velocity vector of attached sources. "); + public static readonly TypeSFXChannel ReferenceDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMinDistance,"ReferenceDistance","Channel controls reference distance of 3D sound of attached sources. n @see SFXDescription::referenceDistance "); + public static readonly TypeSFXChannel MaxDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMaxDistance,"MaxDistance","Channel controls max volume attenuation distance of 3D sound of attached sources. n @see SFXDescription::maxDistance "); + public static readonly TypeSFXChannel ConeInsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeInsideAngle,"ConeInsideAngle","Channel controls angle (in degrees) of 3D sound inner volume cone of attached sources. n @see SFXDescription::coneInsideAngle "); + public static readonly TypeSFXChannel ConeOutsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideAngle,"ConeOutsideAngle","Channel controls angle (in degrees) of 3D sound outer volume cone of attached sources. n @see SFXDescription::coneOutsideAngle "); + public static readonly TypeSFXChannel ConeOutsideVolume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideVolume,"ConeOutsideVolume","Channel controls volume outside of 3D sound outer cone of attached sources. n @see SFXDescription::coneOutsideVolume "); + public static readonly TypeSFXChannel Cursor = new TypeSFXChannel((int)R__SFXChannel.SFXChannelCursor,"Cursor","Channel controls playback cursor of attached sound sources. n n @note Be aware that different types of sound sources interpret play cursor positions differently or do not actually have play cursors (these sources will ignore the channel). "); + public static readonly TypeSFXChannel Status = new TypeSFXChannel((int)R__SFXChannel.SFXChannelStatus,"Status","Channel controls playback status of attached sound sources. n n The channel's value is rounded down to the nearest integer and interpreted in the following way: n - 1: Play n - 2: Stop n - 3: Pause n n "); + public static readonly TypeSFXChannel User0 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser0,"User0","Channel available for custom use. By default ignored by sources. n n @note For FMOD Designer event sources (SFXFMODEventSource), this channel is used for event parameters defined in FMOD Designer and should not be used otherwise. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel User1 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser1,"User1","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel User2 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser2,"User2","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel User3 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser3,"User3","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); }; /// @@ -7993,8 +7993,8 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXDistanceModel Linear = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLinear,"Linear","Volume attenuates linearly from the references distance onwards to max distance where it reaches zero. "); - public static readonly TypeSFXDistanceModel Logarithmic = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLogarithmic,"Logarithmic","Volume attenuates logarithmically starting from the reference distance and halving every reference distance step from there on. Attenuation stops at max distance but volume won't reach zero. "); + public static readonly TypeSFXDistanceModel Linear = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLinear,"Linear"," Volume attenuates linearly from the references distance onwards to max distance where it reaches zero. "); + public static readonly TypeSFXDistanceModel Logarithmic = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLogarithmic,"Logarithmic","Volume attenuates logarithmically starting from the reference distance and halving every reference distance step from there on. Attenuation stops at max distance but volume won't reach zero. "); }; /// @@ -8069,8 +8069,8 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListLoopMode All = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_All,"All","Loop over all slots, i.e. jump from last to first slot after all slots have played. "); - public static readonly TypeSFXPlayListLoopMode Single = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_Single,"Single","Loop infinitely over the current slot. Only useful in combination with either states or manual playlist control. "); + public static readonly TypeSFXPlayListLoopMode All = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_All,"All"," Loop over all slots, i.e. jump from last to first slot after all slots have played. "); + public static readonly TypeSFXPlayListLoopMode Single = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_Single,"Single"," Loop infinitely over the current slot. Only useful in combination with either states or manual playlist control. "); }; /// @@ -8145,9 +8145,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListRandomMode NotRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_NotRandom,"NotRandom","Play slots in sequential order. No randomization. "); - public static readonly TypeSFXPlayListRandomMode StrictRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_StrictRandom,"StrictRandom","Play a strictly random selection of slots. n n In this mode, a set of numSlotsToPlay random numbers between 0 and numSlotsToPlay-1 (inclusive), i.e. in the range of valid slot indices, is generated and playlist slots are played back in the order of this list. This allows the same slot to occur multiple times in a list and, consequentially, allows for other slots to not appear at all in a given slot ordering. "); - public static readonly TypeSFXPlayListRandomMode OrderedRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_OrderedRandom,"OrderedRandom","Play all slots in the list in a random order. n n In this mode, the @c numSlotsToPlay slots from the list with valid tracks assigned are put into a random order and played. This guarantees that each slots is played exactly once albeit at a random position in the total ordering. "); + public static readonly TypeSFXPlayListRandomMode NotRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_NotRandom,"NotRandom"," Play slots in sequential order. No randomization. "); + public static readonly TypeSFXPlayListRandomMode StrictRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_StrictRandom,"StrictRandom","Play a strictly random selection of slots. n n In this mode, a set of numSlotsToPlay random numbers between 0 and numSlotsToPlay-1 (inclusive), i.e. in the range of valid slot indices, is generated and playlist slots are played back in the order of this list. This allows the same slot to occur multiple times in a list and, consequentially, allows for other slots to not appear at all in a given slot ordering. "); + public static readonly TypeSFXPlayListRandomMode OrderedRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_OrderedRandom,"OrderedRandom","Play all slots in the list in a random order. n n In this mode, the @c numSlotsToPlay slots from the list with valid tracks assigned are put into a random order and played. This guarantees that each slots is played exactly once albeit at a random position in the total ordering. "); }; /// @@ -8222,11 +8222,11 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListReplayMode IgnorePlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_IgnorePlaying,"IgnorePlaying","Ignore any sources that may already be playing on the slot and just create a new source. "); - public static readonly TypeSFXPlayListReplayMode RestartPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_RestartPlaying,"RestartPlaying","Restart all sources that was last created for the slot. "); - public static readonly TypeSFXPlayListReplayMode KeepPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_KeepPlaying,"KeepPlaying","Keep playing the current source(s) as if the source started last on the slot was created in this cycle. For this, the sources associated with the slot are brought to the top of the play stack. "); - public static readonly TypeSFXPlayListReplayMode StartNew = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_StartNew,"StartNew","Stop all sources currently playing on the slot and then create a new source. "); - public static readonly TypeSFXPlayListReplayMode SkipIfPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_SkipIfPlaying,"SkipIfPlaying","If there are sources already playing on the slot, skip the play stage. "); + public static readonly TypeSFXPlayListReplayMode IgnorePlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_IgnorePlaying,"IgnorePlaying"," Ignore any sources that may already be playing on the slot and just create a new source. "); + public static readonly TypeSFXPlayListReplayMode RestartPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_RestartPlaying,"RestartPlaying"," Restart all sources that was last created for the slot. "); + public static readonly TypeSFXPlayListReplayMode KeepPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_KeepPlaying,"KeepPlaying","Keep playing the current source(s) as if the source started last on the slot was created in this cycle. For this, the sources associated with the slot are brought to the top of the play stack. "); + public static readonly TypeSFXPlayListReplayMode StartNew = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_StartNew,"StartNew"," Stop all sources currently playing on the slot and then create a new source. "); + public static readonly TypeSFXPlayListReplayMode SkipIfPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_SkipIfPlaying,"SkipIfPlaying"," If there are sources already playing on the slot, skip the play stage. "); }; /// @@ -8301,9 +8301,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListStateMode StopWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_StopInactive,"StopWhenDeactivated","Stop the sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. "); - public static readonly TypeSFXPlayListStateMode PauseWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_PauseInactive,"PauseWhenDeactivated","Pause all sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. n n When the slot's state is reactivated again, the sources will resume playback. "); - public static readonly TypeSFXPlayListStateMode IgnoreWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_IgnoreInactive,"IgnoreWhenDeactivated","Ignore when a state changes to a setting incompatible with the slot's state setting and just keep playing sources attached to the slot. "); + public static readonly TypeSFXPlayListStateMode StopWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_StopInactive,"StopWhenDeactivated","Stop the sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. "); + public static readonly TypeSFXPlayListStateMode PauseWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_PauseInactive,"PauseWhenDeactivated","Pause all sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. n n When the slot's state is reactivated again, the sources will resume playback. "); + public static readonly TypeSFXPlayListStateMode IgnoreWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_IgnoreInactive,"IgnoreWhenDeactivated","Ignore when a state changes to a setting incompatible with the slot's state setting and just keep playing sources attached to the slot. "); }; /// @@ -8378,11 +8378,11 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListTransitionMode None = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_None,"None","No transition. Immediately move on to processing the slot or immediately move on to the next slot. "); - public static readonly TypeSFXPlayListTransitionMode Wait = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Wait,"Wait","Wait for the sound source spawned last by this playlist to finish playing. Then proceed. "); - public static readonly TypeSFXPlayListTransitionMode WaitAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_WaitAll,"WaitAll","Wait for all sound sources currently spawned by the playlist to finish playing. Then proceed. "); - public static readonly TypeSFXPlayListTransitionMode Stop = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Stop,"Stop","Stop the sound source spawned last by this playlist. Then proceed. "); - public static readonly TypeSFXPlayListTransitionMode StopAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_StopAll,"StopAll","Stop all sound sources spawned by the playlist. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode None = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_None,"None"," No transition. Immediately move on to processing the slot or immediately move on to the next slot. "); + public static readonly TypeSFXPlayListTransitionMode Wait = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Wait,"Wait"," Wait for the sound source spawned last by this playlist to finish playing. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode WaitAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_WaitAll,"WaitAll"," Wait for all sound sources currently spawned by the playlist to finish playing. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode Stop = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Stop,"Stop"," Stop the sound source spawned last by this playlist. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode StopAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_StopAll,"StopAll"," Stop all sound sources spawned by the playlist. Then proceed. "); }; /// @@ -8457,9 +8457,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXStatus Playing = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPlaying,"Playing","The source is currently playing. "); - public static readonly TypeSFXStatus Stopped = new TypeSFXStatus((int)R__SFXStatus.SFXStatusStopped,"Stopped","Playback of the source is stopped. When transitioning to Playing state, playback will start at the beginning of the source. "); - public static readonly TypeSFXStatus Paused = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPaused,"Paused","Playback of the source is paused. Resuming playback will play from the current playback position. "); + public static readonly TypeSFXStatus Playing = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPlaying,"Playing"," The source is currently playing. "); + public static readonly TypeSFXStatus Stopped = new TypeSFXStatus((int)R__SFXStatus.SFXStatusStopped,"Stopped","Playback of the source is stopped. When transitioning to Playing state, playback will start at the beginning of the source. "); + public static readonly TypeSFXStatus Paused = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPaused,"Paused"," Playback of the source is paused. Resuming playback will play from the current playback position. "); }; /// @@ -8534,9 +8534,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeShadowFilterMode None = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_None,"None","@brief Simple point sampled filtering. n This is the fastest and lowest quality mode. "); - public static readonly TypeShadowFilterMode SoftShadow = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadow,"SoftShadow","@brief A variable tap rotated poisson disk soft shadow filter. n It performs 4 taps to classify the point as in shadow, out of shadow, or along a shadow edge. Samples on the edge get an additional 8 taps to soften them. "); - public static readonly TypeShadowFilterMode SoftShadowHighQuality = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadowHighQuality,"SoftShadowHighQuality","@brief A 12 tap rotated poisson disk soft shadow filter. n It performs all the taps for every point without any early rejection. "); + public static readonly TypeShadowFilterMode None = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_None,"None","@brief Simple point sampled filtering. n This is the fastest and lowest quality mode. "); + public static readonly TypeShadowFilterMode SoftShadow = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadow,"SoftShadow","@brief A variable tap rotated poisson disk soft shadow filter. n It performs 4 taps to classify the point as in shadow, out of shadow, or along a shadow edge. Samples on the edge get an additional 8 taps to soften them. "); + public static readonly TypeShadowFilterMode SoftShadowHighQuality = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadowHighQuality,"SoftShadowHighQuality","@brief A 12 tap rotated poisson disk soft shadow filter. n It performs all the taps for every point without any early rejection. "); }; /// diff --git a/Templates/C#-Empty/Winterleaf.Engine.Omni/Omni.Auto.cs b/Templates/C#-Empty/Winterleaf.Engine.Omni/Omni.Auto.cs index 127ae127..c3616d92 100644 --- a/Templates/C#-Empty/Winterleaf.Engine.Omni/Omni.Auto.cs +++ b/Templates/C#-Empty/Winterleaf.Engine.Omni/Omni.Auto.cs @@ -10,7 +10,12 @@ sealed public partial class Omni { /// -/// (aiConnect, S32 , 2, 20, (...) @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. @returns The newly created AIConnection @see GameConnection for parameter information @ingroup AI) +/// (aiConnect, S32 , 2, 20, (...) +/// @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. +/// @returns The newly created AIConnection +/// @see GameConnection for parameter information +/// @ingroup AI) +/// /// public int fn__aiConnect (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -78,7 +83,37 @@ public int fn__aiConnect (string a1, string a2, string a3, string a4, string a5, return SafeNativeMethods.mwle_fn__aiConnect(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( buildTaggedString, const char*, 2, 11, (string format, ...) @brief Build a string using the specified tagged string format. This function takes an already tagged string (passed in as a tagged string ID) and one or more additional strings. If the tagged string contains argument tags that range from %%1 through %%9, then each additional string will be substituted into the tagged string. The final (non-tagged) combined string will be returned. The maximum length of the tagged string plus any inserted additional strings is 511 characters. @param format A tagged string ID that contains zero or more argument tags, in the form of %%1 through %%9. @param ... A variable number of arguments that are insterted into the tagged string based on the argument tags within the format string. @returns An ordinary string that is a combination of the original tagged string with any additional strings passed in inserted in place of each argument tag. @tsexample // Create a tagged string with argument tags %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); // Some point later, combine the tagged string with some other string %string = buildTaggedString(%taggedStringID, %playerName); echo(%string); @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// ( buildTaggedString, const char*, 2, 11, (string format, ...) +/// @brief Build a string using the specified tagged string format. +/// +/// This function takes an already tagged string (passed in as a tagged string ID) and one +/// or more additional strings. If the tagged string contains argument tags that range from +/// %%1 through %%9, then each additional string will be substituted into the tagged string. +/// The final (non-tagged) combined string will be returned. The maximum length of the tagged +/// string plus any inserted additional strings is 511 characters. +/// +/// @param format A tagged string ID that contains zero or more argument tags, in the form of +/// %%1 through %%9. +/// @param ... A variable number of arguments that are insterted into the tagged string +/// based on the argument tags within the format string. +/// +/// @returns An ordinary string that is a combination of the original tagged string with any additional +/// strings passed in inserted in place of each argument tag. +/// +/// @tsexample +/// // Create a tagged string with argument tags +/// %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); +/// +/// // Some point later, combine the tagged string with some other string +/// %string = buildTaggedString(%taggedStringID, %playerName); +/// echo(%string); +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string fn__buildTaggedString (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10) @@ -122,7 +157,21 @@ public string fn__buildTaggedString (string a1, string a2, string a3, string a4, } /// -/// ( call, const char *, 2, 0, ( string functionName, string args... ) Apply the given arguments to the specified global function and return the result of the call. @param functionName The name of the function to call. This function must be in the global namespace, i.e. you cannot call a function in a namespace through #call. Use eval() for that. @return The result of the function call. @tsexample function myFunction( %arg ) { return ( %arg SPC \"World!\" ); } echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. @endtsexample @ingroup Scripting ) +/// ( call, const char *, 2, 0, ( string functionName, string args... ) +/// Apply the given arguments to the specified global function and return the result of the call. +/// @param functionName The name of the function to call. This function must be in the global namespace, i.e. +/// you cannot call a function in a namespace through #call. Use eval() for that. +/// @return The result of the function call. +/// @tsexample +/// function myFunction( %arg ) +/// { +/// return ( %arg SPC \"World!\" ); +/// } +/// +/// echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. +/// @endtsexample +/// @ingroup Scripting ) +/// /// public string fn__call (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -193,7 +242,37 @@ public string fn__call (string a1, string a2, string a3, string a4, string a5, s } /// -/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) @brief Send a command from the server to the client @param client The numeric ID of a client GameConnection @param func Name of the client function being called @param ... Various parameters being passed to client command @tsexample // Set up the client command. Needs to be executed on the client, such as // within scripts/client/client.cs // Update the Ammo Counter with current ammo, if not any then hide the counter. function clientCmdSetAmmoAmountHud(%amount) { if (!%amount) AmmoAmount.setVisible(false); else { AmmoAmount.setVisible(true); AmmoAmount.setText(\"Ammo: \"@%amount); } } // Call it from a server function. Needs to be executed on the server, //such as within scripts/server/game.cs function GameConnection::setAmmoAmountHud(%client, %amount) { commandToClient(%client, 'SetAmmoAmountHud', %amount); } @endtsexample @ingroup Networking) +/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) +/// @brief Send a command from the server to the client +/// +/// @param client The numeric ID of a client GameConnection +/// @param func Name of the client function being called +/// @param ... Various parameters being passed to client command +/// +/// @tsexample +/// // Set up the client command. Needs to be executed on the client, such as +/// // within scripts/client/client.cs +/// // Update the Ammo Counter with current ammo, if not any then hide the counter. +/// function clientCmdSetAmmoAmountHud(%amount) +/// { +/// if (!%amount) +/// AmmoAmount.setVisible(false); +/// else +/// { +/// AmmoAmount.setVisible(true); +/// AmmoAmount.setText(\"Ammo: \"@%amount); +/// } +/// } +/// // Call it from a server function. Needs to be executed on the server, +/// //such as within scripts/server/game.cs +/// function GameConnection::setAmmoAmountHud(%client, %amount) +/// { +/// commandToClient(%client, 'SetAmmoAmountHud', %amount); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void fn__commandToClient (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21) @@ -267,7 +346,42 @@ public void fn__commandToClient (string a1, string a2, string a3, string a4, str SafeNativeMethods.mwle_fn__commandToClient(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19, sba20, sba21); } /// -/// ( commandToServer, void, 2, 21, (string func, ...) @brief Send a command to the server. @param func Name of the server command being called @param ... Various parameters being passed to server command @tsexample // Create a standard function. Needs to be executed on the client, such // as within scripts/client/default.bind.cs function toggleCamera(%val) { // If key was down, call a server command named 'ToggleCamera' if (%val) commandToServer('ToggleCamera'); } // Server command being called from above. Needs to be executed on the // server, such as within scripts/server/commands.cs function serverCmdToggleCamera(%client) { if (%client.getControlObject() == %client.player) { %client.camera.setVelocity(\"0 0 0\"); %control = %client.camera; } else { %client.player.setVelocity(\"0 0 0\"); %control = %client.player; } %client.setControlObject(%control); clientCmdSyncEditorGui(); } @endtsexample @ingroup Networking) +/// ( commandToServer, void, 2, 21, (string func, ...) +/// @brief Send a command to the server. +/// +/// @param func Name of the server command being called +/// @param ... Various parameters being passed to server command +/// +/// @tsexample +/// // Create a standard function. Needs to be executed on the client, such +/// // as within scripts/client/default.bind.cs +/// function toggleCamera(%val) +/// { +/// // If key was down, call a server command named 'ToggleCamera' +/// if (%val) +/// commandToServer('ToggleCamera'); +/// } +/// // Server command being called from above. Needs to be executed on the +/// // server, such as within scripts/server/commands.cs +/// function serverCmdToggleCamera(%client) +/// { +/// if (%client.getControlObject() == %client.player) +/// { +/// %client.camera.setVelocity(\"0 0 0\"); +/// %control = %client.camera; +/// } +/// else +/// { +/// %client.player.setVelocity(\"0 0 0\"); +/// %control = %client.player; +/// } +/// %client.setControlObject(%control); +/// clientCmdSyncEditorGui(); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void fn__commandToServer (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20) @@ -338,7 +452,13 @@ public void fn__commandToServer (string a1, string a2, string a3, string a4, str SafeNativeMethods.mwle_fn__commandToServer(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19, sba20); } /// -/// ( echo, void, 2, 0, ( string message... ) @brief Logs a message to the console. Concatenates all given arguments to a single string and prints the string to the console. A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( echo, void, 2, 0, ( string message... ) +/// @brief Logs a message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console. +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void fn__echo (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -406,7 +526,14 @@ public void fn__echo (string a1, string a2, string a3, string a4, string a5, str SafeNativeMethods.mwle_fn__echo(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( error, void, 2, 0, ( string message... ) @brief Logs an error message to the console. Concatenates all given arguments to a single string and prints the string to the console as an error message (in the in-game console, these will show up using a red font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( error, void, 2, 0, ( string message... ) +/// @brief Logs an error message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as an error +/// message (in the in-game console, these will show up using a red font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void fn__error (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -474,7 +601,15 @@ public void fn__error (string a1, string a2, string a3, string a4, string a5, st SafeNativeMethods.mwle_fn__error(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) @brief Manually execute a special script file that contains game or editor preferences @param relativeFileName Name and path to file from project folder @param noCalls Deprecated @param journalScript Deprecated @return True if script was successfully executed @note Appears to be useless in Torque 3D, should be deprecated @ingroup Scripting) +/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) +/// @brief Manually execute a special script file that contains game or editor preferences +/// @param relativeFileName Name and path to file from project folder +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if script was successfully executed +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @ingroup Scripting) +/// /// public bool fn__execPrefs (string a1, string a2, string a3) @@ -494,7 +629,12 @@ public bool fn__execPrefs (string a1, string a2, string a3) return SafeNativeMethods.mwle_fn__execPrefs(sba1, sba2, sba3)>=1; } /// -/// (expandFilename, const char*, 2, 2, (string filename) @brief Grabs the full path of a specified file @param filename Name of the local file to locate @return String containing the full filepath on disk @ingroup FileSystem) +/// (expandFilename, const char*, 2, 2, (string filename) +/// @brief Grabs the full path of a specified file +/// @param filename Name of the local file to locate +/// @return String containing the full filepath on disk +/// @ingroup FileSystem) +/// /// public string fn__expandFilename (string a1) @@ -511,7 +651,11 @@ public string fn__expandFilename (string a1) } /// -/// (expandOldFilename, const char*, 2, 2, (string filename) @brief Retrofits a filepath that uses old Torque style @return String containing filepath with new formatting @ingroup FileSystem) +/// (expandOldFilename, const char*, 2, 2, (string filename) +/// @brief Retrofits a filepath that uses old Torque style +/// @return String containing filepath with new formatting +/// @ingroup FileSystem) +/// /// public string fn__expandOldFilename (string a1) @@ -528,7 +672,110 @@ public string fn__expandOldFilename (string a1) } /// -/// ( mathInit, void, 1, 10, ( ... ) @brief Install the math library with specified extensions. Possible parameters are: - 'DETECT' Autodetect math lib settings. - 'C' Enable the C math routines. C routines are always enabled. - 'FPU' Enable floating point unit routines. - 'MMX' Enable MMX math routines. - '3DNOW' Enable 3dNow! math routines. - 'SSE' Enable SSE math routines. @ingroup Math) +/// ( getStockColorCount, S32, 1, 1, () - Gets a count of available stock colors. +/// @return A count of available stock colors. ) +/// +/// + +public int fn__getStockColorCount () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorCount'"); + + +return SafeNativeMethods.mwle_fn__getStockColorCount(); +} +/// +/// ( getStockColorF, const char*, 2, 2, (stockColorName) - Gets a floating-point-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// + +public string fn__getStockColorF (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorF'" + string.Format("\"{0}\" ",a1)); +var returnbuff = new StringBuilder(16384); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +SafeNativeMethods.mwle_fn__getStockColorF(sba1, returnbuff); +return returnbuff.ToString(); + +} +/// +/// ( getStockColorI, const char*, 2, 2, (stockColorName) - Gets a byte-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// + +public string fn__getStockColorI (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorI'" + string.Format("\"{0}\" ",a1)); +var returnbuff = new StringBuilder(16384); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +SafeNativeMethods.mwle_fn__getStockColorI(sba1, returnbuff); +return returnbuff.ToString(); + +} +/// +/// ( getStockColorName, const char*, 2, 2, (stockColorIndex) - Gets the stock color name at the specified index. +/// @param stockColorIndex The zero-based index of the stock color name to retrieve. +/// @return The stock color name at the specified index or nothing if the string is invalid. ) +/// +/// + +public string fn__getStockColorName (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorName'" + string.Format("\"{0}\" ",a1)); +var returnbuff = new StringBuilder(16384); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +SafeNativeMethods.mwle_fn__getStockColorName(sba1, returnbuff); +return returnbuff.ToString(); + +} +/// +/// ( isStockColor, bool, 2, 2, (stockColorName) - Gets whether the specified name is a stock color or not. +/// @param stockColorName - The stock color name to test for. +/// @return Whether the specified name is a stock color or not. ) +/// +/// + +public bool fn__isStockColor (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__isStockColor'" + string.Format("\"{0}\" ",a1)); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +return SafeNativeMethods.mwle_fn__isStockColor(sba1)>=1; +} +/// +/// ( mathInit, void, 1, 10, ( ... ) +/// @brief Install the math library with specified extensions. +/// Possible parameters are: +/// - 'DETECT' Autodetect math lib settings. +/// - 'C' Enable the C math routines. C routines are always enabled. +/// - 'FPU' Enable floating point unit routines. +/// - 'MMX' Enable MMX math routines. +/// - '3DNOW' Enable 3dNow! math routines. +/// - 'SSE' Enable SSE math routines. +/// @ingroup Math) +/// +/// +/// /// public void fn__mathInit (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9) @@ -566,7 +813,12 @@ public void fn__mathInit (string a1, string a2, string a3, string a4, string a5, SafeNativeMethods.mwle_fn__mathInit(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9); } /// -/// (resourceDump, void, 1, 1, () @brief List the currently managed resources Currently used by editors only, internal @ingroup Editors @internal) +/// (resourceDump, void, 1, 1, () +/// @brief List the currently managed resources +/// Currently used by editors only, internal +/// @ingroup Editors +/// @internal) +/// /// public void fn__resourceDump () @@ -579,6 +831,7 @@ public void fn__resourceDump () } /// /// (schedule, S32, 4, 0, schedule(time, refobject|0, command, arg1...argN>)) +/// /// public int fn__schedule (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -647,6 +900,7 @@ public int fn__schedule (string a1, string a2, string a3, string a4, string a5, } /// /// (TestFunction2Args, const char *, 3, 3, testFunction(arg1, arg2)) +/// /// public string fn__TestFunction2Args (string a1, string a2) @@ -666,7 +920,14 @@ public string fn__TestFunction2Args (string a1, string a2) } /// -/// ( warn, void, 2, 0, ( string message... ) @brief Logs a warning message to the console. Concatenates all given arguments to a single string and prints the string to the console as a warning message (in the in-game console, these will show up using a turquoise font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( warn, void, 2, 0, ( string message... ) +/// @brief Logs a warning message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as a warning +/// message (in the in-game console, these will show up using a turquoise font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void fn__warn (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -734,7 +995,11 @@ public void fn__warn (string a1, string a2, string a3, string a4, string a5, str SafeNativeMethods.mwle_fn__warn(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// () @brief Activates DirectInput. Also activates any connected joysticks. @ingroup Input) +/// () +/// @brief Activates DirectInput. +/// Also activates any connected joysticks. +/// @ingroup Input) +/// /// public void fn_activateDirectInput () @@ -764,7 +1029,28 @@ public void fn_activatePackage (string packageName) SafeNativeMethods.mwle_fn_activatePackage(sbpackageName); } /// -/// @brief Add a string to the bad word filter The bad word filter is a table containing words which will not be displayed in chat windows. Instead, a designated replacement string will be displayed. There are already a number of bad words automatically defined. @param badWord Exact text of the word to restrict. @return True if word was successfully added, false if the word or a subset of it already exists in the table @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Returns true, word was successfully added addBadWord(%badWord); // Returns false, word has already been added addBadWord(\"Foobar\"); @endtsexample @ingroup Game) +/// @brief Add a string to the bad word filter +/// +/// The bad word filter is a table containing words which will not be +/// displayed in chat windows. Instead, a designated replacement string will be displayed. +/// There are already a number of bad words automatically defined. +/// +/// @param badWord Exact text of the word to restrict. +/// @return True if word was successfully added, false if the word or a subset of it already exists in the table +/// +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Returns true, word was successfully added +/// addBadWord(%badWord); +/// // Returns false, word has already been added +/// addBadWord(\"Foobar\"); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool fn_addBadWord (string badWord) @@ -778,7 +1064,13 @@ public bool fn_addBadWord (string badWord) return SafeNativeMethods.mwle_fn_addBadWord(sbbadWord)>=1; } /// -/// Adds a global shader macro which will be merged with the script defined macros on every shader. The macro will replace the value of an existing macro of the same name. For the new macro to take effect all the shaders in the system need to be reloaded. @see resetLightManager, removeGlobalShaderMacro @ingroup Rendering ) +/// Adds a global shader macro which will be merged with the script defined +/// macros on every shader. The macro will replace the value of an existing +/// macro of the same name. For the new macro to take effect all the shaders +/// in the system need to be reloaded. +/// @see resetLightManager, removeGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void fn_addGlobalShaderMacro (string name, string value) @@ -795,7 +1087,14 @@ public void fn_addGlobalShaderMacro (string name, string value) SafeNativeMethods.mwle_fn_addGlobalShaderMacro(sbname, sbvalue); } /// -/// (string texName, string matName) @brief Maps the given texture to the given material. Generates a console warning before overwriting. Material maps are used by terrain and interiors for triggering effects when an object moves onto a terrain block or interior surface using the associated texture. @ingroup Materials) +/// (string texName, string matName) +/// @brief Maps the given texture to the given material. +/// Generates a console warning before overwriting. +/// Material maps are used by terrain and interiors for triggering +/// effects when an object moves onto a terrain +/// block or interior surface using the associated texture. +/// @ingroup Materials) +/// /// public void fn_addMaterialMapping (string texName, string matName) @@ -812,7 +1111,19 @@ public void fn_addMaterialMapping (string texName, string matName) SafeNativeMethods.mwle_fn_addMaterialMapping(sbtexName, sbmatName); } /// -/// ), @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, so tagging the same string (excluding case differences) will be ignored as a duplicated tag. @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string @see \\ref syntaxDataTypes under Tagged %Strings @see removeTaggedString() @see getTaggedString() @ingroup Networking) +/// ), +/// @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable +/// +/// @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, +/// so tagging the same string (excluding case differences) will be ignored as a duplicated tag. +/// +/// @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see removeTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string fn_addTaggedString (string str) @@ -830,6 +1141,7 @@ public string fn_addTaggedString (string str) } /// /// ), 'playerName'[, 'AIClassType'] );) +/// /// public int fn_aiAddPlayer (string name, string ns) @@ -847,6 +1159,7 @@ public int fn_aiAddPlayer (string name, string ns) } /// /// ai.getAimLocation(); ) +/// /// public string fn_AIClient_getAimLocation (string aiclient) @@ -864,6 +1177,7 @@ public string fn_AIClient_getAimLocation (string aiclient) } /// /// ai.getLocation(); ) +/// /// public string fn_AIClient_getLocation (string aiclient) @@ -881,6 +1195,7 @@ public string fn_AIClient_getLocation (string aiclient) } /// /// ai.getMoveDestination(); ) +/// /// public string fn_AIClient_getMoveDestination (string aiclient) @@ -898,6 +1213,7 @@ public string fn_AIClient_getMoveDestination (string aiclient) } /// /// ai.getTargetObject(); ) +/// /// public int fn_AIClient_getTargetObject (string aiclient) @@ -912,6 +1228,7 @@ public int fn_AIClient_getTargetObject (string aiclient) } /// /// ai.missionCycleCleanup(); ) +/// /// public void fn_AIClient_missionCycleCleanup (string aiclient) @@ -926,6 +1243,7 @@ public void fn_AIClient_missionCycleCleanup (string aiclient) } /// /// ai.move(); ) +/// /// public void fn_AIClient_move (string aiclient) @@ -940,6 +1258,7 @@ public void fn_AIClient_move (string aiclient) } /// /// ai.moveForward(); ) +/// /// public void fn_AIClient_moveForward (string aiclient) @@ -954,6 +1273,7 @@ public void fn_AIClient_moveForward (string aiclient) } /// /// ai.setAimLocation( x y z ); ) +/// /// public void fn_AIClient_setAimLocation (string aiclient, string v) @@ -971,6 +1291,7 @@ public void fn_AIClient_setAimLocation (string aiclient, string v) } /// /// ai.setMoveDestination( x y z ); ) +/// /// public void fn_AIClient_setMoveDestination (string aiclient, string v) @@ -988,6 +1309,7 @@ public void fn_AIClient_setMoveDestination (string aiclient, string v) } /// /// ai.setMoveSpeed( float ); ) +/// /// public void fn_AIClient_setMoveSpeed (string aiclient, float speed) @@ -1002,6 +1324,7 @@ public void fn_AIClient_setMoveSpeed (string aiclient, float speed) } /// /// ai.setTargetObject( obj ); ) +/// /// public void fn_AIClient_setTargetObject (string aiclient, string objName) @@ -1019,6 +1342,7 @@ public void fn_AIClient_setTargetObject (string aiclient, string objName) } /// /// ai.stop(); ) +/// /// public void fn_AIClient_stop (string aiclient) @@ -1033,6 +1357,7 @@ public void fn_AIClient_stop (string aiclient) } /// /// ) +/// /// public string fn_AIConnection_getAddress (string aiconnection) @@ -1049,7 +1374,9 @@ public string fn_AIConnection_getAddress (string aiconnection) } /// -/// getFreeLook() Is freelook on for the current move?) +/// getFreeLook() +/// Is freelook on for the current move?) +/// /// public bool fn_AIConnection_getFreeLook (string aiconnection) @@ -1063,7 +1390,11 @@ public bool fn_AIConnection_getFreeLook (string aiconnection) return SafeNativeMethods.mwle_fn_AIConnection_getFreeLook(sbaiconnection)>=1; } /// -/// (string field) Get the given field of a move. @param field One of {'x','y','z','yaw','pitch','roll'} @returns The requested field on the current move.) +/// (string field) +/// Get the given field of a move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @returns The requested field on the current move.) +/// /// public float fn_AIConnection_getMove (string aiconnection, string field) @@ -1080,7 +1411,9 @@ public float fn_AIConnection_getMove (string aiconnection, string field) return SafeNativeMethods.mwle_fn_AIConnection_getMove(sbaiconnection, sbfield); } /// -/// (int trigger) Is the given trigger set?) +/// (int trigger) +/// Is the given trigger set?) +/// /// public bool fn_AIConnection_getTrigger (string aiconnection, int idx) @@ -1094,7 +1427,9 @@ public bool fn_AIConnection_getTrigger (string aiconnection, int idx) return SafeNativeMethods.mwle_fn_AIConnection_getTrigger(sbaiconnection, idx)>=1; } /// -/// (bool isFreeLook) Enable/disable freelook on the current move.) +/// (bool isFreeLook) +/// Enable/disable freelook on the current move.) +/// /// public void fn_AIConnection_setFreeLook (string aiconnection, bool isFreeLook) @@ -1108,7 +1443,11 @@ public void fn_AIConnection_setFreeLook (string aiconnection, bool isFreeLook) SafeNativeMethods.mwle_fn_AIConnection_setFreeLook(sbaiconnection, isFreeLook); } /// -/// (string field, float value) Set a field on the current move. @param field One of {'x','y','z','yaw','pitch','roll'} @param value Value to set field to.) +/// (string field, float value) +/// Set a field on the current move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @param value Value to set field to.) +/// /// public void fn_AIConnection_setMove (string aiconnection, string field, float value) @@ -1125,7 +1464,9 @@ public void fn_AIConnection_setMove (string aiconnection, string field, float va SafeNativeMethods.mwle_fn_AIConnection_setMove(sbaiconnection, sbfield, value); } /// -/// (int trigger, bool set) Set a trigger.) +/// (int trigger, bool set) +/// Set a trigger.) +/// /// public void fn_AIConnection_setTrigger (string aiconnection, int idx, bool set) @@ -1139,7 +1480,10 @@ public void fn_AIConnection_setTrigger (string aiconnection, int idx, bool set) SafeNativeMethods.mwle_fn_AIConnection_setTrigger(sbaiconnection, idx, set); } /// -/// ( GameBase obj, [Point3F offset] ) Sets the bot's target object. Optionally set an offset from target location. @hide) +/// ( GameBase obj, [Point3F offset] ) +/// Sets the bot's target object. Optionally set an offset from target location. +/// @hide) +/// /// public void fn_AIPlayer_setAimObject (string aiplayer, string objName, string offset) @@ -1159,7 +1503,13 @@ public void fn_AIPlayer_setAimObject (string aiplayer, string objName, string of SafeNativeMethods.mwle_fn_AIPlayer_setAimObject(sbaiplayer, sbobjName, sboffset); } /// -/// allowConnections(bool allow) @brief Sets whether or not the global NetInterface allows connections from remote hosts. @param allow Set to true to allow remote connections. @ingroup Networking) +/// allowConnections(bool allow) +/// @brief Sets whether or not the global NetInterface allows connections from remote hosts. +/// +/// @param allow Set to true to allow remote connections. +/// +/// @ingroup Networking) +/// /// public void fn_allowConnections (bool allow) @@ -1186,7 +1536,16 @@ public void fn_backtrace () SafeNativeMethods.mwle_fn_backtrace(); } /// -/// CSV), (location, [backend]) - @brief Takes a string informing the backend where to store sample data and optionally a name of the specific logging backend to use. The default is the CSV backend. In most cases, the logging store will be a file name. @tsexample beginSampling( \"mysamples.csv\" ); @endtsexample @ingroup Rendering) +/// CSV), (location, [backend]) - +/// @brief Takes a string informing the backend where to store +/// sample data and optionally a name of the specific logging +/// backend to use. The default is the CSV backend. In most +/// cases, the logging store will be a file name. +/// @tsexample +/// beginSampling( \"mysamples.csv\" ); +/// @endtsexample +/// @ingroup Rendering) +/// /// public void fn_beginSampling (string location, string backend) @@ -1203,7 +1562,26 @@ public void fn_beginSampling (string location, string backend) SafeNativeMethods.mwle_fn_beginSampling(sblocation, sbbackend); } /// -/// @brief Calculates how much an explosion effects a specific object. Use this to determine how much damage to apply to objects based on their distance from the explosion's center point, and whether the explosion is blocked by other objects. @param pos Center position of the explosion. @param id Id of the object of which to check coverage. @param covMask Mask of object types that may block the explosion. @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) @tsexample // Get the position of the explosion. %position = %explosion.getPosition(); // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType // Acquire the damage value from 0.0f - 1.0f. %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); // Apply damage to object %sceneObject.applyDamage( %coverage * 20 ); @endtsexample @ingroup FX) +/// @brief Calculates how much an explosion effects a specific object. +/// Use this to determine how much damage to apply to objects based on their +/// distance from the explosion's center point, and whether the explosion is +/// blocked by other objects. +/// @param pos Center position of the explosion. +/// @param id Id of the object of which to check coverage. +/// @param covMask Mask of object types that may block the explosion. +/// @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) +/// @tsexample +/// // Get the position of the explosion. +/// %position = %explosion.getPosition(); +/// // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. +/// %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType +/// // Acquire the damage value from 0.0f - 1.0f. +/// %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); +/// // Apply damage to object +/// %sceneObject.applyDamage( %coverage * 20 ); +/// @endtsexample +/// @ingroup FX) +/// /// public float fn_calcExplosionCoverage (string pos, int id, uint covMask) @@ -1218,6 +1596,7 @@ public float fn_calcExplosionCoverage (string pos, int id, uint covMask) } /// /// cancel(eventId)) +/// /// public void fn_cancel (int eventId) @@ -1229,6 +1608,7 @@ public void fn_cancel (int eventId) } /// /// cancelAll(objectId): cancel pending events on the specified object. Events will be automatically cancelled if object is deleted.) +/// /// public void fn_cancelAll (string objectId) @@ -1243,6 +1623,7 @@ public void fn_cancelAll (string objectId) } /// /// cancelServerQuery(...); ) +/// /// public void fn_cancelServerQuery () @@ -1254,7 +1635,9 @@ public void fn_cancelServerQuery () SafeNativeMethods.mwle_fn_cancelServerQuery(); } /// -/// Release the unused pooled textures in texture manager freeing up video memory. @ingroup GFX ) +/// Release the unused pooled textures in texture manager freeing up video memory. +/// @ingroup GFX ) +/// /// public void fn_cleanupTexturePool () @@ -1267,6 +1650,7 @@ public void fn_cleanupTexturePool () } /// /// ) +/// /// public void fn_clearClientPaths () @@ -1278,7 +1662,11 @@ public void fn_clearClientPaths () SafeNativeMethods.mwle_fn_clearClientPaths(); } /// -/// Clears the flagged state on all allocated GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// Clears the flagged state on all allocated GFX resources. +/// See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// /// public void fn_clearGFXResourceFlags () @@ -1291,6 +1679,7 @@ public void fn_clearGFXResourceFlags () } /// /// ) +/// /// public void fn_clearServerPaths () @@ -1302,7 +1691,25 @@ public void fn_clearServerPaths () SafeNativeMethods.mwle_fn_clearServerPaths(); } /// -/// () @brief Closes the current network port @ingroup Networking) +/// () +/// Returns all pop'd out windows to the main canvas. +/// ) +/// +/// + +public void fn_CloseAllPopOuts () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_CloseAllPopOuts'"); + + +SafeNativeMethods.mwle_fn_CloseAllPopOuts(); +} +/// +/// () +/// @brief Closes the current network port +/// @ingroup Networking) +/// /// public void fn_closeNetPort () @@ -1314,7 +1721,42 @@ public void fn_closeNetPort () SafeNativeMethods.mwle_fn_closeNetPort(); } /// -/// Replace all escape sequences in @a text with their respective character codes. This function replaces all escape sequences (\\\, \\\\t, etc) in the given string with the respective characters they represent. The primary use of this function is for converting strings from their literal form into their compiled/translated form, as is normally done by the TorqueScript compiler. @param text A string. @return A duplicate of @a text with all escape sequences replaced by their respective character codes. @tsexample // Print: // // str // ing // // to the console. Note how the backslash in the string must be escaped here // in order to prevent the TorqueScript compiler from collapsing the escape // sequence in the resulting string. echo( collapseEscape( \"str\ing\" ) ); @endtsexample @see expandEscape @ingroup Strings ) +/// Close our startup splash window. +/// @note This is currently only implemented on Windows. +/// @ingroup Platform ) +/// +/// + +public void fn_closeSplashWindow () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_closeSplashWindow'"); + + +SafeNativeMethods.mwle_fn_closeSplashWindow(); +} +/// +/// Replace all escape sequences in @a text with their respective character codes. +/// This function replaces all escape sequences (\\\, \\\\t, etc) in the given string +/// with the respective characters they represent. +/// The primary use of this function is for converting strings from their literal form into +/// their compiled/translated form, as is normally done by the TorqueScript compiler. +/// @param text A string. +/// @return A duplicate of @a text with all escape sequences replaced by their respective character codes. +/// @tsexample +/// // Print: +/// // +/// // str +/// // ing +/// // +/// // to the console. Note how the backslash in the string must be escaped here +/// // in order to prevent the TorqueScript compiler from collapsing the escape +/// // sequence in the resulting string. +/// echo( collapseEscape( \"str\ing\" ) ); +/// @endtsexample +/// @see expandEscape +/// @ingroup Strings ) +/// /// public string fn_collapseEscape (string text) @@ -1331,7 +1773,20 @@ public string fn_collapseEscape (string text) } /// -/// Compile a file to bytecode. This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file in the current DSO path mirrorring the path of @a fileName. @param fileName Path to the file to compile to bytecode. @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not generate write compiled code to DSO files. @return True if the file was successfully compiled, false if not. @note The definitions contained in the given file will not be made available and no code will actually be executed. Use exec() for that. @see getDSOPath @see exec @ingroup Scripting ) +/// Compile a file to bytecode. +/// This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, +/// if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file +/// in the current DSO path mirrorring the path of @a fileName. +/// @param fileName Path to the file to compile to bytecode. +/// @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not +/// generate write compiled code to DSO files. +/// @return True if the file was successfully compiled, false if not. +/// @note The definitions contained in the given file will not be made available and no code will actually +/// be executed. Use exec() for that. +/// @see getDSOPath +/// @see exec +/// @ingroup Scripting ) +/// /// public bool fn_compile (string fileName, bool overrideNoDSO) @@ -1346,6 +1801,7 @@ public bool fn_compile (string fileName, bool overrideNoDSO) } /// /// addAction( UndoAction ) ) +/// /// public void fn_CompoundUndoAction_addAction (string compoundundoaction, string objName) @@ -1363,6 +1819,7 @@ public void fn_CompoundUndoAction_addAction (string compoundundoaction, string o } /// /// Exports console definition XML representation ) +/// /// public string fn_consoleExportXML () @@ -1377,7 +1834,22 @@ public string fn_consoleExportXML () } /// -/// () Attaches the logger to the console and begins writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Attaches the logger to the console and begins writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool fn_ConsoleLogger_attach (string consolelogger) @@ -1391,7 +1863,22 @@ public bool fn_ConsoleLogger_attach (string consolelogger) return SafeNativeMethods.mwle_fn_ConsoleLogger_attach(sbconsolelogger)>=1; } /// -/// () Detaches the logger from the console and stops writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Detaches the logger from the console and stops writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool fn_ConsoleLogger_detach (string consolelogger) @@ -1405,7 +1892,21 @@ public bool fn_ConsoleLogger_detach (string consolelogger) return SafeNativeMethods.mwle_fn_ConsoleLogger_detach(sbconsolelogger)>=1; } /// -/// @brief See if any objects of the given types are present in box of given extent. @note Extent parameter is last since only one radius is often needed. If one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, if you need to use the client container, you'll need to set all of the radius parameters. Fortunately, this function is mostly used on the server. @param mask Indicates the type of objects we are checking against. @param center Center of box. @param xRadius Search radius in the x-axis. See note above. @param yRadius Search radius in the y-axis. See note above. @param zRadius Search radius in the z-axis. See note above. @param useClientContainer Optionally indicates the search should be within the client container. @return true if the box is empty, false if any object is found. @ingroup Game) +/// @brief See if any objects of the given types are present in box of given extent. +/// @note Extent parameter is last since only one radius is often needed. If +/// one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, +/// if you need to use the client container, you'll need to set all of the radius parameters. +/// Fortunately, this function is mostly used on the server. +/// @param mask Indicates the type of objects we are checking against. +/// @param center Center of box. +/// @param xRadius Search radius in the x-axis. See note above. +/// @param yRadius Search radius in the y-axis. See note above. +/// @param zRadius Search radius in the z-axis. See note above. +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return true if the box is empty, false if any object is found. +/// @ingroup Game) +/// /// public bool fn_containerBoxEmpty (uint mask, string center, float xRadius, float yRadius, float zRadius, bool useClientContainer) @@ -1419,7 +1920,13 @@ public bool fn_containerBoxEmpty (uint mask, string center, float xRadius, float return SafeNativeMethods.mwle_fn_containerBoxEmpty(mask, sbcenter, xRadius, yRadius, zRadius, useClientContainer)>=1; } /// -/// (int mask, Point3F point, float x, float y, float z) @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more results using containerFindNext(). @see containerFindNext @ingroup Game) +/// (int mask, Point3F point, float x, float y, float z) +/// @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. +/// @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more +/// results using containerFindNext(). +/// @see containerFindNext +/// @ingroup Game) +/// /// public string fn_containerFindFirst (uint typeMask, string origin, string size) @@ -1439,7 +1946,13 @@ public string fn_containerFindFirst (uint typeMask, string origin, string size) } /// -/// () @brief Get more results from a previous call to containerFindFirst(). @note You must call containerFindFirst() to begin the search. @returns The next object found, or an empty string if nothing else was found. @see containerFindFirst() @ingroup Game) +/// () +/// @brief Get more results from a previous call to containerFindFirst(). +/// @note You must call containerFindFirst() to begin the search. +/// @returns The next object found, or an empty string if nothing else was found. +/// @see containerFindFirst() +/// @ingroup Game) +/// /// public string fn_containerFindNext () @@ -1454,7 +1967,26 @@ public string fn_containerFindNext () } /// -/// @brief Cast a ray from start to end, checking for collision against items matching mask. If pExempt is specified, then it is temporarily excluded from collision checks (For instance, you might want to exclude the player if said player was firing a weapon.) @param start An XYZ vector containing the tail position of the ray. @param end An XYZ vector containing the head position of the ray @param mask A bitmask corresponding to the type of objects to check for @param pExempt An optional ID for a single object that ignored for this raycast @param useClientContainer Optionally indicates the search should be within the client container. @returns A string containing either null, if nothing was struck, or these fields: ul>li>The ID of the object that was struck./li> li>The x, y, z position that it was struck./li> li>The x, y, z of the normal of the face that was struck./li> li>The distance between the start point and the position we hit./li>/ul> @ingroup Game) +/// @brief Cast a ray from start to end, checking for collision against items matching mask. +/// +/// If pExempt is specified, then it is temporarily excluded from collision checks (For +/// instance, you might want to exclude the player if said player was firing a weapon.) +/// +/// @param start An XYZ vector containing the tail position of the ray. +/// @param end An XYZ vector containing the head position of the ray +/// @param mask A bitmask corresponding to the type of objects to check for +/// @param pExempt An optional ID for a single object that ignored for this raycast +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @returns A string containing either null, if nothing was struck, or these fields: +/// ul>li>The ID of the object that was struck./li> +/// li>The x, y, z position that it was struck./li> +/// li>The x, y, z of the normal of the face that was struck./li> +/// li>The distance between the start point and the position we hit./li>/ul> +/// +/// @ingroup Game) +/// /// public string fn_containerRayCast (string start, string end, uint mask, string pExempt, bool useClientContainer) @@ -1477,7 +2009,17 @@ public string fn_containerRayCast (string start, string end, uint mask, string p } /// -/// @brief Get distance of the center of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the center of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get distance of the center of the current item from the center of the +/// current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the center of the current object to the center of +/// the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float fn_containerSearchCurrDist (bool useClientContainer) @@ -1488,7 +2030,17 @@ public float fn_containerSearchCurrDist (bool useClientContainer) return SafeNativeMethods.mwle_fn_containerSearchCurrDist(useClientContainer); } /// -/// @brief Get the distance of the closest point of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the closest point of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get the distance of the closest point of the current item from the center +/// of the current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the closest point of the current object to the +/// center of the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float fn_containerSearchCurrRadiusDist (bool useClientContainer) @@ -1499,7 +2051,29 @@ public float fn_containerSearchCurrRadiusDist (bool useClientContainer) return SafeNativeMethods.mwle_fn_containerSearchCurrRadiusDist(useClientContainer); } /// -/// @brief Get next item from a search started with initContainerRadiusSearch() or initContainerTypeSearch(). @param useClientContainer Optionally indicates the search should be within the client container. @return the next object found in the search, or null if no more @tsexample // print the names of all nearby ShapeBase derived objects %position = %obj.getPosition; %radius = 20; %mask = $TypeMasks::ShapeBaseObjectType; initContainerRadiusSearch( %position, %radius, %mask ); while ( (%targetObject = containerSearchNext()) != 0 ) { echo( \"Found: \" @ %targetObject.getName() ); } @endtsexample @see initContainerRadiusSearch() @see initContainerTypeSearch() @ingroup Game) +/// @brief Get next item from a search started with initContainerRadiusSearch() or +/// initContainerTypeSearch(). +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return the next object found in the search, or null if no more +/// +/// @tsexample +/// // print the names of all nearby ShapeBase derived objects +/// %position = %obj.getPosition; +/// %radius = 20; +/// %mask = $TypeMasks::ShapeBaseObjectType; +/// initContainerRadiusSearch( %position, %radius, %mask ); +/// while ( (%targetObject = containerSearchNext()) != 0 ) +/// { +/// echo( \"Found: \" @ %targetObject.getName() ); +/// } +/// @endtsexample +/// +/// @see initContainerRadiusSearch() +/// @see initContainerTypeSearch() +/// @ingroup Game) +/// /// public string fn_containerSearchNext (bool useClientContainer) @@ -1513,7 +2087,40 @@ public string fn_containerSearchNext (bool useClientContainer) } /// -/// @brief Checks to see if text is a bad word The text is considered to be a bad word if it has been added to the bad word filter. @param text Text to scan for bad words @return True if the text has bad word(s), false if it is clean @see addBadWord() @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Add a banned word to the bad word filter addBadWord(%badWord); // Create the base string, can come from anywhere like user chat %userText = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // If the text contains a bad word, filter it before printing // Otherwise print the original text if(containsBadWords(%userText)) { // Filter the string %filteredText = filterString(%userText, %replacementChars); // Print filtered text echo(%filteredText); } else echo(%userText); @endtsexample @ingroup Game) +/// @brief Checks to see if text is a bad word +/// +/// The text is considered to be a bad word if it has been added to the bad word filter. +/// +/// @param text Text to scan for bad words +/// @return True if the text has bad word(s), false if it is clean +/// +/// @see addBadWord() +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Add a banned word to the bad word filter +/// addBadWord(%badWord); +/// // Create the base string, can come from anywhere like user chat +/// %userText = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // If the text contains a bad word, filter it before printing +/// // Otherwise print the original text +/// if(containsBadWords(%userText)) +/// { +/// // Filter the string +/// %filteredText = filterString(%userText, %replacementChars); +/// // Print filtered text +/// echo(%filteredText); +/// } +/// else +/// echo(%userText); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool fn_containsBadWords (string text) @@ -1527,7 +2134,11 @@ public bool fn_containsBadWords (string text) return SafeNativeMethods.mwle_fn_containsBadWords(sbtext)>=1; } /// -/// Count the number of bits that are set in the given 32 bit integer. @param v An integer value. @return The number of bits that are set in @a v. @ingroup Utilities ) +/// Count the number of bits that are set in the given 32 bit integer. +/// @param v An integer value. +/// @return The number of bits that are set in @a v. +/// @ingroup Utilities ) +/// /// public int fn_countBits (int v) @@ -1538,7 +2149,14 @@ public int fn_countBits (int v) return SafeNativeMethods.mwle_fn_countBits(v); } /// -/// @brief Create the given directory or the path leading to the given filename. If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components of the path will be created. @param path The path to create. @note Only present in a Tools build of Torque. @ingroup FileSystem ) +/// @brief Create the given directory or the path leading to the given filename. +/// If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, +/// does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components +/// of the path will be created. +/// @param path The path to create. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem ) +/// /// public bool fn_createPath (string path) @@ -1553,6 +2171,7 @@ public bool fn_createPath (string path) } /// /// (string group, string name, string value)) +/// /// public int fn_CreatorTree_addGroup (string creatortree, int group, string name, string value) @@ -1573,6 +2192,7 @@ public int fn_CreatorTree_addGroup (string creatortree, int group, string name, } /// /// (Node group, string name, string value)) +/// /// public int fn_CreatorTree_addItem (string creatortree, int group, string name, string value) @@ -1593,6 +2213,7 @@ public int fn_CreatorTree_addItem (string creatortree, int group, string name, s } /// /// Clear the tree.) +/// /// public void fn_CreatorTree_clear (string creatortree) @@ -1607,6 +2228,7 @@ public void fn_CreatorTree_clear (string creatortree) } /// /// (string world, string type, string filename)) +/// /// public bool fn_CreatorTree_fileNameMatch (string creatortree, string world, string type, string filename) @@ -1630,6 +2252,7 @@ public bool fn_CreatorTree_fileNameMatch (string creatortree, string world, stri } /// /// (Node item)) +/// /// public string fn_CreatorTree_getName (string creatortree, string item) @@ -1650,6 +2273,7 @@ public string fn_CreatorTree_getName (string creatortree, string item) } /// /// (Node n)) +/// /// public int fn_CreatorTree_getParent (string creatortree, int nodeValue) @@ -1664,6 +2288,7 @@ public int fn_CreatorTree_getParent (string creatortree, int nodeValue) } /// /// Return a handle to the currently selected item.) +/// /// public int fn_CreatorTree_getSelected (string creatortree) @@ -1678,6 +2303,7 @@ public int fn_CreatorTree_getSelected (string creatortree) } /// /// (Node n)) +/// /// public string fn_CreatorTree_getValue (string creatortree, int nodeValue) @@ -1695,6 +2321,7 @@ public string fn_CreatorTree_getValue (string creatortree, int nodeValue) } /// /// (Group g)) +/// /// public bool fn_CreatorTree_isGroup (string creatortree, string group) @@ -1711,7 +2338,10 @@ public bool fn_CreatorTree_isGroup (string creatortree, string group) return SafeNativeMethods.mwle_fn_CreatorTree_isGroup(sbcreatortree, sbgroup)>=1; } /// -/// () Forcibly disconnects any attached script debugging client. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Forcibly disconnects any attached script debugging client. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void fn_dbgDisconnect () @@ -1723,7 +2353,9 @@ public void fn_dbgDisconnect () SafeNativeMethods.mwle_fn_dbgDisconnect(); } /// -/// () Clear all break points in the current file.) +/// () +/// Clear all break points in the current file.) +/// /// public void fn_DbgFileView_clearBreakPositions (string dbgfileview) @@ -1737,7 +2369,10 @@ public void fn_DbgFileView_clearBreakPositions (string dbgfileview) SafeNativeMethods.mwle_fn_DbgFileView_clearBreakPositions(sbdbgfileview); } /// -/// (string findThis) Find the specified string in the currently viewed file and scroll it into view.) +/// (string findThis) +/// Find the specified string in the currently viewed file and +/// scroll it into view.) +/// /// public bool fn_DbgFileView_findString (string dbgfileview, string findThis) @@ -1754,7 +2389,11 @@ public bool fn_DbgFileView_findString (string dbgfileview, string findThis) return SafeNativeMethods.mwle_fn_DbgFileView_findString(sbdbgfileview, sbfindThis)>=1; } /// -/// () Get the currently executing file and line, if any. @returns A string containing the file, a tab, and then the line number. Use getField() with this.) +/// () +/// Get the currently executing file and line, if any. +/// @returns A string containing the file, a tab, and then the line number. +/// Use getField() with this.) +/// /// public string fn_DbgFileView_getCurrentLine (string dbgfileview) @@ -1771,7 +2410,10 @@ public string fn_DbgFileView_getCurrentLine (string dbgfileview) } /// -/// (string filename) Open a file for viewing. @note This loads the file from the local system.) +/// (string filename) +/// Open a file for viewing. +/// @note This loads the file from the local system.) +/// /// public bool fn_DbgFileView_open (string dbgfileview, string filename) @@ -1788,7 +2430,9 @@ public bool fn_DbgFileView_open (string dbgfileview, string filename) return SafeNativeMethods.mwle_fn_DbgFileView_open(sbdbgfileview, sbfilename)>=1; } /// -/// (int line) Remove a breakpoint from the specified line.) +/// (int line) +/// Remove a breakpoint from the specified line.) +/// /// public void fn_DbgFileView_removeBreak (string dbgfileview, uint line) @@ -1802,7 +2446,9 @@ public void fn_DbgFileView_removeBreak (string dbgfileview, uint line) SafeNativeMethods.mwle_fn_DbgFileView_removeBreak(sbdbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void fn_DbgFileView_setBreak (string dbgfileview, uint line) @@ -1816,7 +2462,9 @@ public void fn_DbgFileView_setBreak (string dbgfileview, uint line) SafeNativeMethods.mwle_fn_DbgFileView_setBreak(sbdbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void fn_DbgFileView_setBreakPosition (string dbgfileview, uint line) @@ -1830,7 +2478,9 @@ public void fn_DbgFileView_setBreakPosition (string dbgfileview, uint line) SafeNativeMethods.mwle_fn_DbgFileView_setBreakPosition(sbdbgfileview, line); } /// -/// (int line, bool selected) Set the current highlighted line.) +/// (int line, bool selected) +/// Set the current highlighted line.) +/// /// public void fn_DbgFileView_setCurrentLine (string dbgfileview, int line, bool selected) @@ -1844,7 +2494,10 @@ public void fn_DbgFileView_setCurrentLine (string dbgfileview, int line, bool se SafeNativeMethods.mwle_fn_DbgFileView_setCurrentLine(sbdbgfileview, line, selected); } /// -/// () Returns true if a script debugging client is connected else return false. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Returns true if a script debugging client is connected else return false. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public bool fn_dbgIsConnected () @@ -1856,7 +2509,11 @@ public bool fn_dbgIsConnected () return SafeNativeMethods.mwle_fn_dbgIsConnected()>=1; } /// -/// ( int port, string password, bool waitForClient ) Open a debug server port on the specified port, requiring the specified password, and optionally waiting for the debug client to connect. @internal Primarily used for Torsion and other debugging tools) +/// ( int port, string password, bool waitForClient ) +/// Open a debug server port on the specified port, requiring the specified password, +/// and optionally waiting for the debug client to connect. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void fn_dbgSetParameters (int port, string password, bool waitForClient) @@ -1870,7 +2527,11 @@ public void fn_dbgSetParameters (int port, string password, bool waitForClient) SafeNativeMethods.mwle_fn_dbgSetParameters(port, sbpassword, waitForClient); } /// -/// () @brief Disables DirectInput. Also deactivates any connected joysticks. @ingroup Input ) +/// () +/// @brief Disables DirectInput. +/// Also deactivates any connected joysticks. +/// @ingroup Input ) +/// /// public void fn_deactivateDirectInput () @@ -1901,7 +2562,12 @@ public void fn_deactivatePackage (string packageName) SafeNativeMethods.mwle_fn_deactivatePackage(sbpackageName); } /// -/// Drops the engine into the native C++ debugger. This function triggers a debug break and drops the process into the IDE's debugger. If the process is not running with a debugger attached it will generate a runtime error on most platforms. @note This function is not available in shipping builds. @ingroup Debugging ) +/// Drops the engine into the native C++ debugger. +/// This function triggers a debug break and drops the process into the IDE's debugger. If the process is not +/// running with a debugger attached it will generate a runtime error on most platforms. +/// @note This function is not available in shipping builds. +/// @ingroup Debugging ) +/// /// public void fn_debug () @@ -1913,7 +2579,10 @@ public void fn_debug () SafeNativeMethods.mwle_fn_debug(); } /// -/// @brief Dumps all current EngineObject instances to the console. @note This function is only available in debug builds. @ingroup Debugging ) +/// @brief Dumps all current EngineObject instances to the console. +/// @note This function is only available in debug builds. +/// @ingroup Debugging ) +/// /// public void fn_debugDumpAllObjects () @@ -1947,7 +2616,15 @@ public void fn_debugEnumInstances (string className, string functionName) SafeNativeMethods.mwle_fn_debugEnumInstances(sbclassName, sbfunctionName); } /// -/// @brief Logs the value of the given variable to the console. Prints a string of the form \"variableName> = variable value>\" to the console. @param variableName Name of the local or global variable to print. @tsexample %var = 1; debugv( \"%var\" ); // Prints \"%var = 1\" @endtsexample @ingroup Debugging ) +/// @brief Logs the value of the given variable to the console. +/// Prints a string of the form \"variableName> = variable value>\" to the console. +/// @param variableName Name of the local or global variable to print. +/// @tsexample +/// %var = 1; +/// debugv( \"%var\" ); // Prints \"%var = 1\" +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void fn_debugv (string variableName) @@ -1961,7 +2638,26 @@ public void fn_debugv (string variableName) SafeNativeMethods.mwle_fn_debugv(sbvariableName); } /// -/// Adds a new decal to the decal manager. @param position World position for the decal. @param normal Decal normal vector (if the decal was a tire lying flat on a surface, this is the vector pointing in the direction of the axle). @param rot Angle (in radians) to rotate this decal around its normal vector. @param scale Scale factor applied to the decal. @param decalData DecalData datablock to use for the new decal. @param isImmortal Whether or not this decal is immortal. If immortal, it does not expire automatically and must be removed explicitly. @return Returns the ID of the new Decal object or -1 on failure. @tsexample // Specify the decal position %position = \"1.0 1.0 1.0\"; // Specify the up vector %normal = \"0.0 0.0 1.0\"; // Add the new decal. %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); @endtsexample @ingroup Decals ) +/// Adds a new decal to the decal manager. +/// @param position World position for the decal. +/// @param normal Decal normal vector (if the decal was a tire lying flat on a +/// surface, this is the vector pointing in the direction of the axle). +/// @param rot Angle (in radians) to rotate this decal around its normal vector. +/// @param scale Scale factor applied to the decal. +/// @param decalData DecalData datablock to use for the new decal. +/// @param isImmortal Whether or not this decal is immortal. If immortal, it +/// does not expire automatically and must be removed explicitly. +/// @return Returns the ID of the new Decal object or -1 on failure. +/// @tsexample +/// // Specify the decal position +/// %position = \"1.0 1.0 1.0\"; +/// // Specify the up vector +/// %normal = \"0.0 0.0 1.0\"; +/// // Add the new decal. +/// %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public int fn_decalManagerAddDecal (string position, string normal, float rot, float scale, string decalData, bool isImmortal) @@ -1981,7 +2677,13 @@ public int fn_decalManagerAddDecal (string position, string normal, float rot, f return SafeNativeMethods.mwle_fn_decalManagerAddDecal(sbposition, sbnormal, rot, scale, sbdecalData, isImmortal); } /// -/// Removes all decals currently loaded in the decal manager. @tsexample // Tell the decal manager to remove all existing decals. decalManagerClear(); @endtsexample @ingroup Decals ) +/// Removes all decals currently loaded in the decal manager. +/// @tsexample +/// // Tell the decal manager to remove all existing decals. +/// decalManagerClear(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void fn_decalManagerClear () @@ -1993,7 +2695,15 @@ public void fn_decalManagerClear () SafeNativeMethods.mwle_fn_decalManagerClear(); } /// -/// Returns whether the decal manager has unsaved modifications. @return True if the decal manager has unsaved modifications, false if everything has been saved. @tsexample // Ask the decal manager if it has unsaved modifications. %hasUnsavedModifications = decalManagerDirty(); @endtsexample @ingroup Decals ) +/// Returns whether the decal manager has unsaved modifications. +/// @return True if the decal manager has unsaved modifications, false if +/// everything has been saved. +/// @tsexample +/// // Ask the decal manager if it has unsaved modifications. +/// %hasUnsavedModifications = decalManagerDirty(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool fn_decalManagerDirty () @@ -2005,7 +2715,18 @@ public bool fn_decalManagerDirty () return SafeNativeMethods.mwle_fn_decalManagerDirty()>=1; } /// -/// Clears existing decals and replaces them with decals loaded from the specified file. @param fileName Filename to load the decals from. @return True if the decal manager was able to load the requested file, false if it could not. @tsexample // Set the filename to load the decals from. %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to load the decals from the entered filename. decalManagerLoad( %fileName ); @endtsexample @ingroup Decals ) +/// Clears existing decals and replaces them with decals loaded from the specified file. +/// @param fileName Filename to load the decals from. +/// @return True if the decal manager was able to load the requested file, +/// false if it could not. +/// @tsexample +/// // Set the filename to load the decals from. +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to load the decals from the entered filename. +/// decalManagerLoad( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool fn_decalManagerLoad (string fileName) @@ -2019,7 +2740,17 @@ public bool fn_decalManagerLoad (string fileName) return SafeNativeMethods.mwle_fn_decalManagerLoad(sbfileName)>=1; } /// -/// Remove specified decal from the scene. @param decalID ID of the decal to remove. @return Returns true if successful, false if decal ID not found. @tsexample // Specify a decal ID to be removed %decalID = 1; // Tell the decal manager to remove the specified decal ID. decalManagerRemoveDecal( %decalId ) @endtsexample @ingroup Decals ) +/// Remove specified decal from the scene. +/// @param decalID ID of the decal to remove. +/// @return Returns true if successful, false if decal ID not found. +/// @tsexample +/// // Specify a decal ID to be removed +/// %decalID = 1; +/// // Tell the decal manager to remove the specified decal ID. +/// decalManagerRemoveDecal( %decalId ) +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool fn_decalManagerRemoveDecal (int decalID) @@ -2030,7 +2761,18 @@ public bool fn_decalManagerRemoveDecal (int decalID) return SafeNativeMethods.mwle_fn_decalManagerRemoveDecal(decalID)>=1; } /// -/// ), Saves the decals for the active mission in the entered filename. @param decalSaveFile Filename to save the decals to. @tsexample // Set the filename to save the decals in. If no filename is set, then the // decals will default to activeMissionName>.mis.decals %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to save the decals for the active mission. decalManagerSave( %fileName ); @endtsexample @ingroup Decals ) +/// ), +/// Saves the decals for the active mission in the entered filename. +/// @param decalSaveFile Filename to save the decals to. +/// @tsexample +/// // Set the filename to save the decals in. If no filename is set, then the +/// // decals will default to activeMissionName>.mis.decals +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to save the decals for the active mission. +/// decalManagerSave( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void fn_decalManagerSave (string decalSaveFile) @@ -2044,7 +2786,10 @@ public void fn_decalManagerSave (string decalSaveFile) SafeNativeMethods.mwle_fn_decalManagerSave(sbdecalSaveFile); } /// -/// Delete all the datablocks we've downloaded. This is usually done in preparation of downloading a new set of datablocks, such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// Delete all the datablocks we've downloaded. +/// This is usually done in preparation of downloading a new set of datablocks, +/// such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// /// public void fn_deleteDataBlocks () @@ -2056,7 +2801,11 @@ public void fn_deleteDataBlocks () SafeNativeMethods.mwle_fn_deleteDataBlocks(); } /// -/// @brief Deletes the given @a file. @param file %Path of the file to delete. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Deletes the given @a file. +/// @param file %Path of the file to delete. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_deleteFile (string file) @@ -2070,7 +2819,17 @@ public bool fn_deleteFile (string file) return SafeNativeMethods.mwle_fn_deleteFile(sbfile)>=1; } /// -/// Undefine all global variables matching the given name @a pattern. @param pattern A global variable name pattern. Must begin with '$'. @tsexample // Define a global variable in the \"My\" namespace. $My::Variable = \"value\"; // Undefine all variable in the \"My\" namespace. deleteVariables( \"$My::*\" ); @endtsexample @see strIsMatchExpr @ingroup Scripting ) +/// Undefine all global variables matching the given name @a pattern. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @tsexample +/// // Define a global variable in the \"My\" namespace. +/// $My::Variable = \"value\"; +/// // Undefine all variable in the \"My\" namespace. +/// deleteVariables( \"$My::*\" ); +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Scripting ) +/// /// public void fn_deleteVariables (string pattern) @@ -2084,7 +2843,22 @@ public void fn_deleteVariables (string pattern) SafeNativeMethods.mwle_fn_deleteVariables(sbpattern); } /// -/// @brief Dumps a description of GFX resources to a file or the console. @param resourceTypes A space seperated list of resource types or an empty string for all resources. @param filePath A file to dump the list to or an empty string to write to the console. @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. @note The resource types can be one or more of the following: - texture - texture target - window target - vertex buffers - primitive buffers - fences - cubemaps - shaders - stateblocks @ingroup GFX ) +/// @brief Dumps a description of GFX resources to a file or the console. +/// @param resourceTypes A space seperated list of resource types or an empty string for all resources. +/// @param filePath A file to dump the list to or an empty string to write to the console. +/// @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. +/// @note The resource types can be one or more of the following: +/// - texture +/// - texture target +/// - window target +/// - vertex buffers +/// - primitive buffers +/// - fences +/// - cubemaps +/// - shaders +/// - stateblocks +/// @ingroup GFX ) +/// /// public void fn_describeGFXResources (string resourceTypes, string filePath, bool unflaggedOnly) @@ -2101,7 +2875,10 @@ public void fn_describeGFXResources (string resourceTypes, string filePath, bool SafeNativeMethods.mwle_fn_describeGFXResources(sbresourceTypes, sbfilePath, unflaggedOnly); } /// -/// Dumps a description of all state blocks. @param filePath A file to dump the state blocks to or an empty string to write to the console. @ingroup GFX ) +/// Dumps a description of all state blocks. +/// @param filePath A file to dump the state blocks to or an empty string to write to the console. +/// @ingroup GFX ) +/// /// public void fn_describeGFXStateBlocks (string filePath) @@ -2115,7 +2892,26 @@ public void fn_describeGFXStateBlocks (string filePath) SafeNativeMethods.mwle_fn_describeGFXStateBlocks(sbfilePath); } /// -/// @brief Returns the string from a tag string. Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. Use getTaggedString() to convert a tagged string ID back into a regular string at any time. @tsexample // From scripts/client/message.cs function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) { onChatMessage(detag(%msgString), %voice, %pitch); } @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see getTag() @see getTaggedString() @ingroup Networking) +/// @brief Returns the string from a tag string. +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. Use getTaggedString() +/// to convert a tagged string ID back into a regular string at any time. +/// +/// @tsexample +/// // From scripts/client/message.cs +/// function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) +/// { +/// onChatMessage(detag(%msgString), %voice, %pitch); +/// } +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see getTag() +/// @see getTaggedString() +/// +/// @ingroup Networking) +/// /// public string fn_detag (string str) @@ -2132,7 +2928,11 @@ public string fn_detag (string str) } /// -/// () @brief Disables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Disables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public void fn_disableJoystick () @@ -2144,7 +2944,10 @@ public void fn_disableJoystick () SafeNativeMethods.mwle_fn_disableJoystick(); } /// -/// () @brief Disables XInput for Xbox 360 controllers. @ingroup Input) +/// () +/// @brief Disables XInput for Xbox 360 controllers. +/// @ingroup Input) +/// /// public void fn_disableXInput () @@ -2156,7 +2959,15 @@ public void fn_disableXInput () SafeNativeMethods.mwle_fn_disableXInput(); } /// -/// ), (string queueName, string message, string data) @brief Dispatch a message to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @param data Data for message @return True for success, false for failure @see dispatchMessageObject @ingroup Messaging) +/// ), (string queueName, string message, string data) +/// @brief Dispatch a message to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @param data Data for message +/// @return True for success, false for failure +/// @see dispatchMessageObject +/// @ingroup Messaging) +/// /// public bool fn_dispatchMessage (string queueName, string message, string data) @@ -2176,7 +2987,14 @@ public bool fn_dispatchMessage (string queueName, string message, string data) return SafeNativeMethods.mwle_fn_dispatchMessage(sbqueueName, sbmessage, sbdata)>=1; } /// -/// , ), (string queueName, string message) @brief Dispatch a message object to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @return true for success, false for failure @see dispatchMessage @ingroup Messaging) +/// , ), (string queueName, string message) +/// @brief Dispatch a message object to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @return true for success, false for failure +/// @see dispatchMessage +/// @ingroup Messaging) +/// /// public bool fn_dispatchMessageObject (string queueName, string message) @@ -2193,7 +3011,12 @@ public bool fn_dispatchMessageObject (string queueName, string message) return SafeNativeMethods.mwle_fn_dispatchMessageObject(sbqueueName, sbmessage)>=1; } /// -/// art/gui/splash.bmp), Display a startup splash window suitable for showing while the engine still starts up. @note This is currently only implemented on Windows. @return True if the splash window could be successfully initialized. @ingroup Platform ) +/// art/gui/splash.bmp), +/// Display a startup splash window suitable for showing while the engine still starts up. +/// @note This is currently only implemented on Windows. +/// @return True if the splash window could be successfully initialized. +/// @ingroup Platform ) +/// /// public bool fn_displaySplashWindow (string path) @@ -2207,7 +3030,12 @@ public bool fn_displaySplashWindow (string path) return SafeNativeMethods.mwle_fn_displaySplashWindow(sbpath)>=1; } /// -/// (bool enabled) @brief Enables logging of the connection protocols When enabled a lot of network debugging information is sent to the console. @param enabled True to enable, false to disable @ingroup Networking) +/// (bool enabled) +/// @brief Enables logging of the connection protocols +/// When enabled a lot of network debugging information is sent to the console. +/// @param enabled True to enable, false to disable +/// @ingroup Networking) +/// /// public void fn_DNetSetLogging (bool enabled) @@ -2484,7 +3312,11 @@ public string fn_dnt_testcase_9 (string chr) } /// -/// @brief Dumps all declared console classes to the console. @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console classes to the console. +/// @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. +/// @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void fn_dumpConsoleClasses (bool dumpScript, bool dumpEngine) @@ -2495,7 +3327,11 @@ public void fn_dumpConsoleClasses (bool dumpScript, bool dumpEngine) SafeNativeMethods.mwle_fn_dumpConsoleClasses(dumpScript, dumpEngine); } /// -/// @brief Dumps all declared console functions to the console. @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console functions to the console. +/// @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. +/// @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void fn_dumpConsoleFunctions (bool dumpScript, bool dumpEngine) @@ -2506,7 +3342,11 @@ public void fn_dumpConsoleFunctions (bool dumpScript, bool dumpEngine) SafeNativeMethods.mwle_fn_dumpConsoleFunctions(dumpScript, dumpEngine); } /// -/// Dumps the engine scripting documentation to the specified file overwriting any existing content. @param outputFile The relative or absolute output file path and name. @return Returns true if successful. @ingroup Console) +/// Dumps the engine scripting documentation to the specified file overwriting any existing content. +/// @param outputFile The relative or absolute output file path and name. +/// @return Returns true if successful. +/// @ingroup Console) +/// /// public bool fn_dumpEngineDocs (string outputFile) @@ -2520,7 +3360,10 @@ public bool fn_dumpEngineDocs (string outputFile) return SafeNativeMethods.mwle_fn_dumpEngineDocs(sboutputFile)>=1; } /// -/// Dumps to the console a full description of all cached fonts, along with info on the codepoints each contains. @ingroup Font ) +/// Dumps to the console a full description of all cached fonts, along with +/// info on the codepoints each contains. +/// @ingroup Font ) +/// /// public void fn_dumpFontCacheStatus () @@ -2532,7 +3375,9 @@ public void fn_dumpFontCacheStatus () SafeNativeMethods.mwle_fn_dumpFontCacheStatus(); } /// -/// @brief Dumps a formatted list of currently allocated material instances to the console. @ingroup Materials) +/// @brief Dumps a formatted list of currently allocated material instances to the console. +/// @ingroup Materials) +/// /// public void fn_dumpMaterialInstances () @@ -2544,7 +3389,14 @@ public void fn_dumpMaterialInstances () SafeNativeMethods.mwle_fn_dumpMaterialInstances(); } /// -/// @brief Dumps network statistics for each class to the console. The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. The i>num/i> value is the total number of events collected. @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. @ingroup Networking ) +/// @brief Dumps network statistics for each class to the console. +/// +/// The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. +/// The i>num/i> value is the total number of events collected. +/// +/// @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. +/// @ingroup Networking ) +/// /// public void fn_dumpNetStats () @@ -2556,7 +3408,13 @@ public void fn_dumpNetStats () SafeNativeMethods.mwle_fn_dumpNetStats(); } /// -/// @brief Dump the current contents of the networked string table to the console. The results are returned in three columns. The first column is the network string ID. The second column is the string itself. The third column is the reference count to the network string. @note This function is available only in debug builds. @ingroup Networking ) +/// @brief Dump the current contents of the networked string table to the console. +/// The results are returned in three columns. The first column is the network string ID. +/// The second column is the string itself. The third column is the reference count to the +/// network string. +/// @note This function is available only in debug builds. +/// @ingroup Networking ) +/// /// public void fn_dumpNetStringTable () @@ -2569,6 +3427,7 @@ public void fn_dumpNetStringTable () } /// /// Dumps all ProcessObjects in ServerProcessList and ClientProcessList to the console. ) +/// /// public void fn_dumpProcessList (bool allow) @@ -2579,7 +3438,10 @@ public void fn_dumpProcessList (bool allow) SafeNativeMethods.mwle_fn_dumpProcessList(allow); } /// -/// Creates a 64x64 normal map texture filled with noise. The texture is saved to randNormTex.png in the location of the game executable. @ingroup GFX) +/// Creates a 64x64 normal map texture filled with noise. The texture is saved +/// to randNormTex.png in the location of the game executable. +/// @ingroup GFX) +/// /// public void fn_dumpRandomNormalMap () @@ -2604,7 +3466,11 @@ public void fn_dumpSoCount () SafeNativeMethods.mwle_fn_dumpSoCount(); } /// -/// () @brief Dumps information about String memory usage @ingroup Debugging @ingroup Strings) +/// () +/// @brief Dumps information about String memory usage +/// @ingroup Debugging +/// @ingroup Strings) +/// /// public void fn_dumpStringMemStats () @@ -2616,19 +3482,10 @@ public void fn_dumpStringMemStats () SafeNativeMethods.mwle_fn_dumpStringMemStats(); } /// -/// ) -/// - -public void fn_dumpStringTableSize () -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_dumpStringTableSize'"); - - -SafeNativeMethods.mwle_fn_dumpStringTableSize(); -} -/// -/// Dumps a list of all active texture objects to the console. @note This function is only available in debug builds. @ingroup GFX ) +/// Dumps a list of all active texture objects to the console. +/// @note This function is only available in debug builds. +/// @ingroup GFX ) +/// /// public void fn_dumpTextureObjects () @@ -2640,7 +3497,15 @@ public void fn_dumpTextureObjects () SafeNativeMethods.mwle_fn_dumpTextureObjects(); } /// -/// Copy the specified old font to a new name. The new copy will not have a platform font backing it, and so will never have characters added to it. But this is useful for making copies of fonts to add postprocessing effects to via exportCachedFont. @param oldFontName The name of the font face to copy. @param oldFontSize The size of the font to copy. @param newFontName The name of the new font face. @ingroup Font ) +/// Copy the specified old font to a new name. The new copy will not have a +/// platform font backing it, and so will never have characters added to it. +/// But this is useful for making copies of fonts to add postprocessing effects +/// to via exportCachedFont. +/// @param oldFontName The name of the font face to copy. +/// @param oldFontSize The size of the font to copy. +/// @param newFontName The name of the new font face. +/// @ingroup Font ) +/// /// public void fn_duplicateCachedFont (string oldFontName, int oldFontSize, string newFontName) @@ -2657,7 +3522,10 @@ public void fn_duplicateCachedFont (string oldFontName, int oldFontSize, string SafeNativeMethods.mwle_fn_duplicateCachedFont(sboldFontName, oldFontSize, sbnewFontName); } /// -/// () @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. @ingroup Input) +/// () +/// @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. +/// @ingroup Input) +/// /// public void fn_echoInputState () @@ -2670,6 +3538,7 @@ public void fn_echoInputState () } /// /// Perform the onEditorDisabled callback on all SimObjects and set gEditingMission false ) +/// /// public void fn_EditManager_editorDisabled (string editmanager) @@ -2684,6 +3553,7 @@ public void fn_EditManager_editorDisabled (string editmanager) } /// /// Perform the onEditorEnabled callback on all SimObjects and set gEditingMission true ) +/// /// public void fn_EditManager_editorEnabled (string editmanager) @@ -2698,6 +3568,7 @@ public void fn_EditManager_editorEnabled (string editmanager) } /// /// (int slot)) +/// /// public void fn_EditManager_gotoBookmark (string editmanager, int val) @@ -2712,6 +3583,7 @@ public void fn_EditManager_gotoBookmark (string editmanager, int val) } /// /// Return the value of gEditingMission. ) +/// /// public bool fn_EditManager_isEditorEnabled (string editmanager) @@ -2726,6 +3598,7 @@ public bool fn_EditManager_isEditorEnabled (string editmanager) } /// /// (int slot)) +/// /// public void fn_EditManager_setBookmark (string editmanager, int val) @@ -2739,7 +3612,11 @@ public void fn_EditManager_setBookmark (string editmanager, int val) SafeNativeMethods.mwle_fn_EditManager_setBookmark(sbeditmanager, val); } /// -/// () @brief Enables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Enables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public bool fn_enableJoystick () @@ -2751,7 +3628,11 @@ public bool fn_enableJoystick () return SafeNativeMethods.mwle_fn_enableJoystick()>=1; } /// -/// (pattern, [state]) - @brief Enable sampling for all keys that match the given name pattern. Slashes are treated as separators. @ingroup Rendering) +/// (pattern, [state]) - +/// @brief Enable sampling for all keys that match the given name +/// pattern. Slashes are treated as separators. +/// @ingroup Rendering) +/// /// public void fn_enableSamples (string pattern, bool state) @@ -2766,6 +3647,7 @@ public void fn_enableSamples (string pattern, bool state) } /// /// enableWinConsole(bool);) +/// /// public void fn_enableWinConsole (bool flag) @@ -2776,7 +3658,12 @@ public void fn_enableWinConsole (bool flag) SafeNativeMethods.mwle_fn_enableWinConsole(flag); } /// -/// () @brief Enables XInput for Xbox 360 controllers. @note XInput is enabled by default. Disable to use an Xbox 360 Controller as a joystick device. @ingroup Input) +/// () +/// @brief Enables XInput for Xbox 360 controllers. +/// @note XInput is enabled by default. Disable to use an Xbox 360 +/// Controller as a joystick device. +/// @ingroup Input) +/// /// public bool fn_enableXInput () @@ -2788,7 +3675,18 @@ public bool fn_enableXInput () return SafeNativeMethods.mwle_fn_enableXInput()>=1; } /// -/// @brief Test whether the given string ends with the given suffix. @param str The string to test. @param suffix The potential suffix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. @tsexample startsWith( \"TEST123\", \"123\" ) // Returns true. @endtsexample @see startsWith @ingroup Strings ) +/// @brief Test whether the given string ends with the given suffix. +/// @param str The string to test. +/// @param suffix The potential suffix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"123\" ) // Returns true. +/// @endtsexample +/// @see startsWith +/// @ingroup Strings ) +/// /// public bool fn_endsWith (string str, string suffix, bool caseSensitive) @@ -2805,7 +3703,16 @@ public bool fn_endsWith (string str, string suffix, bool caseSensitive) return SafeNativeMethods.mwle_fn_endsWith(sbstr, sbsuffix, caseSensitive)>=1; } /// -/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from a COLLADA file and store it in a GuiTreeView control. This function is used by the COLLADA import gui to show a preview of the scene contents prior to import, and is probably not much use for anything else. @param shapePath COLLADA filename @param ctrl GuiTreeView control to add elements to @return true if successful, false otherwise @ingroup Editors @internal) +/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from +/// a COLLADA file and store it in a GuiTreeView control. This function is +/// used by the COLLADA import gui to show a preview of the scene contents +/// prior to import, and is probably not much use for anything else. +/// @param shapePath COLLADA filename +/// @param ctrl GuiTreeView control to add elements to +/// @return true if successful, false otherwise +/// @ingroup Editors +/// @internal) +/// /// public bool fn_enumColladaForImport (string shapePath, string ctrl) @@ -2822,7 +3729,14 @@ public bool fn_enumColladaForImport (string shapePath, string ctrl) return SafeNativeMethods.mwle_fn_enumColladaForImport(sbshapePath, sbctrl)>=1; } /// -/// ), @brief Returns a list of classes that derive from the named class. If the named class is omitted this dumps all the classes. @param className The optional base class name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// ), +/// @brief Returns a list of classes that derive from the named class. +/// If the named class is omitted this dumps all the classes. +/// @param className The optional base class name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string fn_enumerateConsoleClasses (string className) @@ -2839,7 +3753,12 @@ public string fn_enumerateConsoleClasses (string className) } /// -/// @brief Provide a list of classes that belong to the given category. @param category The category name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// @brief Provide a list of classes that belong to the given category. +/// @param category The category name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string fn_enumerateConsoleClassesByCategory (string category) @@ -2857,6 +3776,7 @@ public string fn_enumerateConsoleClassesByCategory (string category) } /// /// eval(consoleString) ) +/// /// public string fn_eval (string consoleString) @@ -2873,7 +3793,9 @@ public string fn_eval (string consoleString) } /// -/// () Print all registered events to the console. ) +/// () +/// Print all registered events to the console. ) +/// /// public void fn_EventManager_dumpEvents (string eventmanager) @@ -2887,7 +3809,10 @@ public void fn_EventManager_dumpEvents (string eventmanager) SafeNativeMethods.mwle_fn_EventManager_dumpEvents(sbeventmanager); } /// -/// ), ( String event ) Print all subscribers to an event to the console. @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// ), ( String event ) +/// Print all subscribers to an event to the console. +/// @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// /// public void fn_EventManager_dumpSubscribers (string eventmanager, string listenerName) @@ -2904,7 +3829,11 @@ public void fn_EventManager_dumpSubscribers (string eventmanager, string listene SafeNativeMethods.mwle_fn_EventManager_dumpSubscribers(sbeventmanager, sblistenerName); } /// -/// ( String event ) Check if an event is registered or not. @param event The event to check. @return Whether or not the event exists. ) +/// ( String event ) +/// Check if an event is registered or not. +/// @param event The event to check. +/// @return Whether or not the event exists. ) +/// /// public bool fn_EventManager_isRegisteredEvent (string eventmanager, string evt) @@ -2921,7 +3850,12 @@ public bool fn_EventManager_isRegisteredEvent (string eventmanager, string evt) return SafeNativeMethods.mwle_fn_EventManager_isRegisteredEvent(sbeventmanager, sbevt)>=1; } /// -/// ), ( String event, String data ) ~Trigger an event. @param event The event to trigger. @param data The data associated with the event. @return Whether or not the event was dispatched successfully. ) +/// ), ( String event, String data ) +/// ~Trigger an event. +/// @param event The event to trigger. +/// @param data The data associated with the event. +/// @return Whether or not the event was dispatched successfully. ) +/// /// public bool fn_EventManager_postEvent (string eventmanager, string evt, string data) @@ -2941,7 +3875,11 @@ public bool fn_EventManager_postEvent (string eventmanager, string evt, string d return SafeNativeMethods.mwle_fn_EventManager_postEvent(sbeventmanager, sbevt, sbdata)>=1; } /// -/// ( String event ) Register an event with the event manager. @param event The event to register. @return Whether or not the event was registered successfully. ) +/// ( String event ) +/// Register an event with the event manager. +/// @param event The event to register. +/// @return Whether or not the event was registered successfully. ) +/// /// public bool fn_EventManager_registerEvent (string eventmanager, string evt) @@ -2958,7 +3896,11 @@ public bool fn_EventManager_registerEvent (string eventmanager, string evt) return SafeNativeMethods.mwle_fn_EventManager_registerEvent(sbeventmanager, sbevt)>=1; } /// -/// ( SimObject listener, String event ) Remove a listener from an event. @param listener The listener to remove. @param event The event to be removed from.) +/// ( SimObject listener, String event ) +/// Remove a listener from an event. +/// @param listener The listener to remove. +/// @param event The event to be removed from.) +/// /// public void fn_EventManager_remove (string eventmanager, string listenerName, string evt) @@ -2978,7 +3920,10 @@ public void fn_EventManager_remove (string eventmanager, string listenerName, st SafeNativeMethods.mwle_fn_EventManager_remove(sbeventmanager, sblistenerName, sbevt); } /// -/// ( SimObject listener ) Remove a listener from all events. @param listener The listener to remove.) +/// ( SimObject listener ) +/// Remove a listener from all events. +/// @param listener The listener to remove.) +/// /// public void fn_EventManager_removeAll (string eventmanager, string listenerName) @@ -2995,7 +3940,13 @@ public void fn_EventManager_removeAll (string eventmanager, string listenerName) SafeNativeMethods.mwle_fn_EventManager_removeAll(sbeventmanager, sblistenerName); } /// -/// ), ( SimObject listener, String event, String callback ) Subscribe a listener to an event. @param listener The listener to subscribe. @param event The event to subscribe to. @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. @return Whether or not the subscription was successful. ) +/// ), ( SimObject listener, String event, String callback ) +/// Subscribe a listener to an event. +/// @param listener The listener to subscribe. +/// @param event The event to subscribe to. +/// @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. +/// @return Whether or not the subscription was successful. ) +/// /// public bool fn_EventManager_subscribe (string eventmanager, string listenerName, string evt, string callback) @@ -3018,7 +3969,10 @@ public bool fn_EventManager_subscribe (string eventmanager, string listenerName, return SafeNativeMethods.mwle_fn_EventManager_subscribe(sbeventmanager, sblistenerName, sbevt, sbcallback)>=1; } /// -/// ( String event ) Remove an event from the EventManager. @param event The event to remove. ) +/// ( String event ) +/// Remove an event from the EventManager. +/// @param event The event to remove. ) +/// /// public void fn_EventManager_unregisterEvent (string eventmanager, string evt) @@ -3035,7 +3989,17 @@ public void fn_EventManager_unregisterEvent (string eventmanager, string evt) SafeNativeMethods.mwle_fn_EventManager_unregisterEvent(sbeventmanager, sbevt); } /// -/// @brief Used to exclude/prevent all other instances using the same identifier specified @note Not used on OSX, Xbox, or in Win debug builds @param appIdentifier Name of the app set up for exclusive use. @return False if another app is running that specified the same appIdentifier @ingroup Platform @ingroup GuiCore) +/// @brief Used to exclude/prevent all other instances using the same identifier specified +/// +/// @note Not used on OSX, Xbox, or in Win debug builds +/// +/// @param appIdentifier Name of the app set up for exclusive use. +/// +/// @return False if another app is running that specified the same appIdentifier +/// +/// @ingroup Platform +/// @ingroup GuiCore) +/// /// public bool fn_excludeOtherInstance (string appIdentifer) @@ -3049,7 +4013,19 @@ public bool fn_excludeOtherInstance (string appIdentifer) return SafeNativeMethods.mwle_fn_excludeOtherInstance(sbappIdentifer)>=1; } /// -/// Execute the given script file. @param fileName Path to the file to execute @param noCalls Deprecated @param journalScript Deprecated @return True if the script was successfully executed, false if not. @tsexample // Execute the init.cs script file found in the same directory as the current script file. exec( \"./init.cs\" ); @endtsexample @see compile @see eval @ingroup Scripting ) +/// Execute the given script file. +/// @param fileName Path to the file to execute +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if the script was successfully executed, false if not. +/// @tsexample +/// // Execute the init.cs script file found in the same directory as the current script file. +/// exec( \"./init.cs\" ); +/// @endtsexample +/// @see compile +/// @see eval +/// @ingroup Scripting ) +/// /// public bool fn_exec (string fileName, bool noCalls, bool journalScript) @@ -3063,7 +4039,20 @@ public bool fn_exec (string fileName, bool noCalls, bool journalScript) return SafeNativeMethods.mwle_fn_exec(sbfileName, noCalls, journalScript)>=1; } /// -/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their respective escape sequences. All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). The primary use of this function is for converting strings suitable for being passed as string literals to the TorqueScript compiler. @param text A string @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective escape sequences. @tsxample expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". @endtsxample @see collapseEscape @ingroup Strings) +/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their +/// respective escape sequences. +/// All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). +/// The primary use of this function is for converting strings suitable for being passed as string literals +/// to the TorqueScript compiler. +/// @param text A string +/// @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective +/// escape sequences. +/// @tsxample +/// expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". +/// @endtsxample +/// @see collapseEscape +/// @ingroup Strings) +/// /// public string fn_expandEscape (string text) @@ -3080,7 +4069,23 @@ public string fn_expandEscape (string text) } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void fn_export (string pattern, string filename, bool append) @@ -3097,7 +4102,17 @@ public void fn_export (string pattern, string filename, bool append) SafeNativeMethods.mwle_fn_export(sbpattern, sbfilename, append); } /// -/// Export specified font to the specified filename as a PNG. The image can then be processed in Photoshop or another tool and reimported using importCachedFont. Characters in the font are exported as one long strip. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the output PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Export specified font to the specified filename as a PNG. The +/// image can then be processed in Photoshop or another tool and +/// reimported using importCachedFont. Characters in the font are +/// exported as one long strip. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the output PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void fn_exportCachedFont (string faceName, int fontSize, string fileName, int padding, int kerning) @@ -3114,7 +4129,10 @@ public void fn_exportCachedFont (string faceName, int fontSize, string fileName, SafeNativeMethods.mwle_fn_exportCachedFont(sbfaceName, fontSize, sbfileName, padding, kerning); } /// -/// Create a XML document containing a dump of the entire exported engine API. @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. @ingroup Console ) +/// Create a XML document containing a dump of the entire exported engine API. +/// @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. +/// @ingroup Console ) +/// /// public string fn_exportEngineAPIToXML () @@ -3129,7 +4147,23 @@ public string fn_exportEngineAPIToXML () } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void fn_exportToSettings (string pattern, string filename, bool append) @@ -3146,7 +4180,11 @@ public void fn_exportToSettings (string pattern, string filename, bool append) SafeNativeMethods.mwle_fn_exportToSettings(sbpattern, sbfilename, append); } /// -/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ @param simObject Object to copy static-fields from. @param fieldList fields to filter static-fields against. @return No return value.) +/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ +/// @param simObject Object to copy static-fields from. +/// @param fieldList fields to filter static-fields against. +/// @return No return value.) +/// /// public void fn_FieldBrushObject_copyFields (string fieldbrushobject, string simObjName, string pFieldList) @@ -3166,7 +4204,10 @@ public void fn_FieldBrushObject_copyFields (string fieldbrushobject, string simO SafeNativeMethods.mwle_fn_FieldBrushObject_copyFields(sbfieldbrushobject, sbsimObjName, sbpFieldList); } /// -/// (simObject) Paste copied static-fields to selected object./ @param simObject Object to paste static-fields to. @return No return value.) +/// (simObject) Paste copied static-fields to selected object./ +/// @param simObject Object to paste static-fields to. +/// @return No return value.) +/// /// public void fn_FieldBrushObject_pasteFields (string fieldbrushobject, string simObjName) @@ -3183,7 +4224,11 @@ public void fn_FieldBrushObject_pasteFields (string fieldbrushobject, string sim SafeNativeMethods.mwle_fn_FieldBrushObject_pasteFields(sbfieldbrushobject, sbsimObjName); } /// -/// ), (simObject, [groupList]) Query available static-fields for selected object./ @param simObject Object to query static-fields on. @param groupList groups to filter static-fields against. @return Space-seperated static-field list.) +/// ), (simObject, [groupList]) Query available static-fields for selected object./ +/// @param simObject Object to query static-fields on. +/// @param groupList groups to filter static-fields against. +/// @return Space-seperated static-field list.) +/// /// public string fn_FieldBrushObject_queryFields (string fieldbrushobject, string simObjName, string groupList) @@ -3206,7 +4251,10 @@ public string fn_FieldBrushObject_queryFields (string fieldbrushobject, string s } /// -/// (simObject) Query available static-field groups for selected object./ @param simObject Object to query static-field groups on. @return Space-seperated static-field group list.) +/// (simObject) Query available static-field groups for selected object./ +/// @param simObject Object to query static-field groups on. +/// @return Space-seperated static-field group list.) +/// /// public string fn_FieldBrushObject_queryGroups (string fieldbrushobject, string simObjName) @@ -3226,7 +4274,12 @@ public string fn_FieldBrushObject_queryGroups (string fieldbrushobject, string s } /// -/// @brief Get the base of a file name (removes extension) @param fileName Name and path of file to check @return String containing the file name, minus extension @ingroup FileSystem) +/// @brief Get the base of a file name (removes extension and path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus extension and path +/// @ingroup FileSystem) +/// /// public string fn_fileBase (string fileName) @@ -3243,7 +4296,12 @@ public string fn_fileBase (string fileName) } /// -/// @brief Returns a platform specific formatted string with the creation time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the creation time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fn_fileCreatedTime (string fileName) @@ -3260,7 +4318,13 @@ public string fn_fileCreatedTime (string fileName) } /// -/// @brief Delete a file from the hard drive @param path Name and path of the file to delete @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. @return True if file was successfully deleted @ingroup FileSystem) +/// @brief Delete a file from the hard drive +/// +/// @param path Name and path of the file to delete +/// @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. +/// @return True if file was successfully deleted +/// @ingroup FileSystem) +/// /// public bool fn_fileDelete (string path) @@ -3274,7 +4338,12 @@ public bool fn_fileDelete (string path) return SafeNativeMethods.mwle_fn_fileDelete(sbpath)>=1; } /// -/// @brief Get the extension of a file @param fileName Name and path of file @return String containing the extension, such as \".exe\" or \".cs\" @ingroup FileSystem) +/// @brief Get the extension of a file +/// +/// @param fileName Name and path of file +/// @return String containing the extension, such as \".exe\" or \".cs\" +/// @ingroup FileSystem) +/// /// public string fn_fileExt (string fileName) @@ -3291,7 +4360,12 @@ public string fn_fileExt (string fileName) } /// -/// @brief Returns a platform specific formatted string with the last modified time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the last modified time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fn_fileModifiedTime (string fileName) @@ -3308,7 +4382,12 @@ public string fn_fileModifiedTime (string fileName) } /// -/// @brief Get the file name of a file (removes extension and path) @param fileName Name and path of file to check @return String containing the file name, minus extension and path @ingroup FileSystem) +/// @brief Get only the file name of a path and file name string (removes path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus the path +/// @ingroup FileSystem) +/// /// public string fn_fileName (string fileName) @@ -3325,7 +4404,9 @@ public string fn_fileName (string fileName) } /// -/// ), FileObject.writeObject(SimObject, object prepend) @hide) +/// ), FileObject.writeObject(SimObject, object prepend) +/// @hide) +/// /// public void fn_FileObject_writeObject (string fileobject, string simName, string objName) @@ -3345,7 +4426,12 @@ public void fn_FileObject_writeObject (string fileobject, string simName, string SafeNativeMethods.mwle_fn_FileObject_writeObject(sbfileobject, sbsimName, sbobjName); } /// -/// @brief Get the path of a file (removes name and extension) @param fileName Name and path of file to check @return String containing the path, minus name and extension @ingroup FileSystem) +/// @brief Get the path of a file (removes name and extension) +/// +/// @param fileName Name and path of file to check +/// @return String containing the path, minus name and extension +/// @ingroup FileSystem) +/// /// public string fn_filePath (string fileName) @@ -3362,7 +4448,13 @@ public string fn_filePath (string fileName) } /// -/// @brief Determines the size of a file on disk @param fileName Name and path of the file to check @return Returns filesize in KB, or -1 if no file @ingroup FileSystem) +/// @brief Determines the size of a file on disk +/// +/// @param fileName Name and path of the file to check +/// @return Returns filesize in KB, or -1 if no file +/// +/// @ingroup FileSystem) +/// /// public int fn_fileSize (string fileName) @@ -3376,7 +4468,30 @@ public int fn_fileSize (string fileName) return SafeNativeMethods.mwle_fn_fileSize(sbfileName); } /// -/// @brief Replaces the characters in a string with designated text Uses the bad word filter to determine which characters within the string will be replaced. @param baseString The original string to filter. @param replacementChars A string containing letters you wish to swap in the baseString. @return The new scrambled string @see addBadWord() @see containsBadWords() @tsexample // Create the base string, can come from anywhere %baseString = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // Filter the string %newString = filterString(%baseString, %replacementChars); // Print the new string to console echo(%newString); @endtsexample @ingroup Game) +/// @brief Replaces the characters in a string with designated text +/// +/// Uses the bad word filter to determine which characters within the string will be replaced. +/// +/// @param baseString The original string to filter. +/// @param replacementChars A string containing letters you wish to swap in the baseString. +/// @return The new scrambled string +/// +/// @see addBadWord() +/// @see containsBadWords() +/// +/// @tsexample +/// // Create the base string, can come from anywhere +/// %baseString = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // Filter the string +/// %newString = filterString(%baseString, %replacementChars); +/// // Print the new string to console +/// echo(%newString); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public string fn_filterString (string baseString, string replacementChars) @@ -3396,7 +4511,34 @@ public string fn_filterString (string baseString, string replacementChars) } /// -/// @brief Returns the first file in the directory system matching the given pattern. Use the corresponding findNextFile() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCount(). This function differs from findFirstFileMultiExpr() in that it supports a single search pattern being passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return The path of the first file matched by the search or an empty string if no matching file could be found. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findNextFile() @see getFileCount() @see findFirstFileMultiExpr() @ingroup FileSearches ) +/// @brief Returns the first file in the directory system matching the given pattern. +/// +/// Use the corresponding findNextFile() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCount(). +/// +/// This function differs from findFirstFileMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. +/// @return The path of the first file matched by the search or an empty string if no matching file could be found. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findNextFile() +/// @see getFileCount() +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches ) +/// /// public string fn_findFirstFile (string pattern, bool recurse) @@ -3413,7 +4555,42 @@ public string fn_findFirstFile (string pattern, bool recurse) } /// -/// @brief Returns the first file in the directory system matching the given patterns. Use the corresponding findNextFileMultiExpr() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCountMultiExpr(). This function differs from findFirstFile() in that it supports multiple search patterns to be passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename patterns. @return String of the first matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findNextFileMultiExpr() @see getFileCountMultiExpr() @see findFirstFile() @ingroup FileSearches) +/// @brief Returns the first file in the directory system matching the given patterns. +/// +/// Use the corresponding findNextFileMultiExpr() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCountMultiExpr(). +/// +/// This function differs from findFirstFile() in that it supports multiple search patterns +/// to be passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename patterns. +/// @return String of the first matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findNextFileMultiExpr() +/// @see getFileCountMultiExpr() +/// @see findFirstFile() +/// @ingroup FileSearches) +/// /// public string fn_findFirstFileMultiExpr (string pattern, bool recurse) @@ -3430,7 +4607,22 @@ public string fn_findFirstFileMultiExpr (string pattern, bool recurse) } /// -/// ), @brief Returns the next file matching a search begun in findFirstFile(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return The path of the next filename matched by the search or an empty string if no more files match. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findFirstFile() @ingroup FileSearches ) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFile(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return The path of the next filename matched by the search or an empty string if no more files match. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @ingroup FileSearches ) +/// /// public string fn_findNextFile (string pattern) @@ -3447,7 +4639,28 @@ public string fn_findNextFile (string pattern) } /// -/// ), @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return String of the next matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findFirstFileMultiExpr() @ingroup FileSearches) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return String of the next matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches) +/// /// public string fn_findNextFileMultiExpr (string pattern) @@ -3464,7 +4677,16 @@ public string fn_findNextFileMultiExpr (string pattern) } /// -/// Return the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return The word at index 0 in @a text or \"\" if @a text is empty. @note This is equal to @tsexample_nopar getWord( text, 0 ) @endtsexample @see getWord @ingroup FieldManip ) +/// Return the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return The word at index 0 in @a text or \"\" if @a text is empty. +/// @note This is equal to +/// @tsexample_nopar +/// getWord( text, 0 ) +/// @endtsexample +/// @see getWord +/// @ingroup FieldManip ) +/// /// public string fn_firstWord (string text) @@ -3481,7 +4703,13 @@ public string fn_firstWord (string text) } /// -/// @brief Flags all currently allocated GFX resources. Used for resource allocation and leak tracking by flagging current resources then dumping a list of unflagged resources at some later point in execution. @ingroup GFX @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// @brief Flags all currently allocated GFX resources. +/// Used for resource allocation and leak tracking by flagging +/// current resources then dumping a list of unflagged resources +/// at some later point in execution. +/// @ingroup GFX +/// @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void fn_flagCurrentGFXResources () @@ -3493,7 +4721,9 @@ public void fn_flagCurrentGFXResources () SafeNativeMethods.mwle_fn_flagCurrentGFXResources(); } /// -/// Releases all textures and resurrects the texture manager. @ingroup GFX ) +/// Releases all textures and resurrects the texture manager. +/// @ingroup GFX ) +/// /// public void fn_flushTextureCache () @@ -3506,6 +4736,7 @@ public void fn_flushTextureCache () } /// /// () ) +/// /// public void fn_Forest_clear (string forest) @@ -3520,6 +4751,7 @@ public void fn_Forest_clear (string forest) } /// /// ()) +/// /// public bool fn_Forest_isDirty (string forest) @@ -3534,6 +4766,7 @@ public bool fn_Forest_isDirty (string forest) } /// /// ()) +/// /// public void fn_Forest_regenCells (string forest) @@ -3547,7 +4780,8 @@ public void fn_Forest_regenCells (string forest) SafeNativeMethods.mwle_fn_Forest_regenCells(sbforest); } /// -/// ), saveDataFile( [path] ) ) +/// saveDataFile( [path] ) ) +/// /// public void fn_Forest_saveDataFile (string forest, string path) @@ -3565,6 +4799,7 @@ public void fn_Forest_saveDataFile (string forest, string path) } /// /// ( ForestItemData obj ) ) +/// /// public bool fn_ForestBrush_containsItemData (string forestbrush, string obj) @@ -3582,6 +4817,7 @@ public bool fn_ForestBrush_containsItemData (string forestbrush, string obj) } /// /// ) +/// /// public void fn_ForestBrushTool_collectElements (string forestbrushtool) @@ -3596,6 +4832,7 @@ public void fn_ForestBrushTool_collectElements (string forestbrushtool) } /// /// ( ForestItemData obj ) ) +/// /// public void fn_ForestEditorCtrl_deleteMeshSafe (string foresteditorctrl, string obj) @@ -3613,6 +4850,7 @@ public void fn_ForestEditorCtrl_deleteMeshSafe (string foresteditorctrl, string } /// /// () ) +/// /// public int fn_ForestEditorCtrl_getActiveTool (string foresteditorctrl) @@ -3627,6 +4865,7 @@ public int fn_ForestEditorCtrl_getActiveTool (string foresteditorctrl) } /// /// ) +/// /// public bool fn_ForestEditorCtrl_isDirty (string foresteditorctrl) @@ -3641,6 +4880,7 @@ public bool fn_ForestEditorCtrl_isDirty (string foresteditorctrl) } /// /// ( ForestTool tool ) ) +/// /// public void fn_ForestEditorCtrl_setActiveTool (string foresteditorctrl, string toolName) @@ -3658,6 +4898,7 @@ public void fn_ForestEditorCtrl_setActiveTool (string foresteditorctrl, string t } /// /// () ) +/// /// public void fn_ForestEditorCtrl_updateActiveForest (string foresteditorctrl) @@ -3672,6 +4913,7 @@ public void fn_ForestEditorCtrl_updateActiveForest (string foresteditorctrl) } /// /// ) +/// /// public void fn_ForestSelectionTool_clearSelection (string forestselectiontool) @@ -3686,6 +4928,7 @@ public void fn_ForestSelectionTool_clearSelection (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_copySelection (string forestselectiontool) @@ -3700,6 +4943,7 @@ public void fn_ForestSelectionTool_copySelection (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_cutSelection (string forestselectiontool) @@ -3714,6 +4958,7 @@ public void fn_ForestSelectionTool_cutSelection (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_deleteSelection (string forestselectiontool) @@ -3728,6 +4973,7 @@ public void fn_ForestSelectionTool_deleteSelection (string forestselectiontool) } /// /// ) +/// /// public int fn_ForestSelectionTool_getSelectionCount (string forestselectiontool) @@ -3742,6 +4988,7 @@ public int fn_ForestSelectionTool_getSelectionCount (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_pasteSelection (string forestselectiontool) @@ -3755,7 +5002,9 @@ public void fn_ForestSelectionTool_pasteSelection (string forestselectiontool) SafeNativeMethods.mwle_fn_ForestSelectionTool_pasteSelection(sbforestselectiontool); } /// -/// Returns the count of active DDSs files in memory. @ingroup Rendering ) +/// Returns the count of active DDSs files in memory. +/// @ingroup Rendering ) +/// /// public int fn_getActiveDDSFiles () @@ -3767,7 +5016,9 @@ public int fn_getActiveDDSFiles () return SafeNativeMethods.mwle_fn_getActiveDDSFiles(); } /// -/// Returns the active light manager name. @ingroup Lighting ) +/// Returns the active light manager name. +/// @ingroup Lighting ) +/// /// public string fn_getActiveLightManager () @@ -3782,7 +5033,9 @@ public string fn_getActiveLightManager () } /// -/// Get the version of the application build, as a string. @ingroup Debugging) +/// Get the version of the application build, as a string. +/// @ingroup Debugging) +/// /// public int fn_getAppVersionNumber () @@ -3794,7 +5047,9 @@ public int fn_getAppVersionNumber () return SafeNativeMethods.mwle_fn_getAppVersionNumber(); } /// -/// Get the version of the aplication build, as a human readable string. @ingroup Debugging) +/// Get the version of the aplication build, as a human readable string. +/// @ingroup Debugging) +/// /// public string fn_getAppVersionString () @@ -3809,7 +5064,9 @@ public string fn_getAppVersionString () } /// -/// Returns the best texture format for storage of HDR data for the active device. @ingroup GFX ) +/// Returns the best texture format for storage of HDR data for the active device. +/// @ingroup GFX ) +/// /// public int fn_getBestHDRFormat () @@ -3821,7 +5078,10 @@ public int fn_getBestHDRFormat () return SafeNativeMethods.mwle_fn_getBestHDRFormat(); } /// -/// Returns image info in the following format: width TAB height TAB bytesPerPixel. It will return an empty string if the file is not found. @ingroup Rendering ) +/// Returns image info in the following format: width TAB height TAB bytesPerPixel. +/// It will return an empty string if the file is not found. +/// @ingroup Rendering ) +/// /// public string fn_getBitmapInfo (string filename) @@ -3838,7 +5098,11 @@ public string fn_getBitmapInfo (string filename) } /// -/// Get the center point of an axis-aligned box. @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" @return Center of the box. @ingroup Math) +/// Get the center point of an axis-aligned box. +/// @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" +/// @return Center of the box. +/// @ingroup Math) +/// /// public string fn_getBoxCenter (string box) @@ -3855,7 +5119,9 @@ public string fn_getBoxCenter (string box) } /// -/// Get the type of build, \"Debug\" or \"Release\". @ingroup Debugging) +/// Get the type of build, \"Debug\" or \"Release\". +/// @ingroup Debugging) +/// /// public string fn_getBuildString () @@ -3870,7 +5136,10 @@ public string fn_getBuildString () } /// -/// @brief Returns the category of the given class. @param className The name of the class. @ingroup Console) +/// @brief Returns the category of the given class. +/// @param className The name of the class. +/// @ingroup Console) +/// /// public string fn_getCategoryOfClass (string className) @@ -3905,7 +5174,9 @@ public string fn_getClipboard () } /// -/// Get the time of compilation. @ingroup Debugging) +/// Get the time of compilation. +/// @ingroup Debugging) +/// /// public string fn_getCompileTimeString () @@ -3920,7 +5191,11 @@ public string fn_getCompileTimeString () } /// -/// () @brief Gets the primary LangTable used by the game @return ID of the core LangTable @ingroup Localization) +/// () +/// @brief Gets the primary LangTable used by the game +/// @return ID of the core LangTable +/// @ingroup Localization) +/// /// public int fn_getCoreLangTable () @@ -3932,7 +5207,10 @@ public int fn_getCoreLangTable () return SafeNativeMethods.mwle_fn_getCoreLangTable(); } /// -/// @brief Returns the current %ActionMap. @see ActionMap @ingroup Input) +/// @brief Returns the current %ActionMap. +/// @see ActionMap +/// @ingroup Input) +/// /// public string fn_getCurrentActionMap () @@ -3947,7 +5225,12 @@ public string fn_getCurrentActionMap () } /// -/// @brief Return the current working directory. @return The absolute path of the current working directory. @note Only present in a Tools build of Torque. @see getWorkingDirectory() @ingroup FileSystem) +/// @brief Return the current working directory. +/// @return The absolute path of the current working directory. +/// @note Only present in a Tools build of Torque. +/// @see getWorkingDirectory() +/// @ingroup FileSystem) +/// /// public string fn_getCurrentDirectory () @@ -3962,7 +5245,11 @@ public string fn_getCurrentDirectory () } /// -/// @brief Returns the description string for the named class. @param className The name of the class. @return The class description in string format. @ingroup Console) +/// @brief Returns the description string for the named class. +/// @param className The name of the class. +/// @return The class description in string format. +/// @ingroup Console) +/// /// public string fn_getDescriptionOfClass (string className) @@ -3980,6 +5267,7 @@ public string fn_getDescriptionOfClass (string className) } /// /// Returns the width, height, and bitdepth of the screen/desktop.@ingroup GFX ) +/// /// public string fn_getDesktopResolution () @@ -3994,7 +5282,14 @@ public string fn_getDesktopResolution () } /// -/// @brief Gathers a list of directories starting at the given path. @param path String containing the path of the directory @param depth Depth of search, as in how many subdirectories to parse through @return Tab delimited string containing list of directories found during search, \"\" if no files were found @ingroup FileSystem) +/// @brief Gathers a list of directories starting at the given path. +/// +/// @param path String containing the path of the directory +/// @param depth Depth of search, as in how many subdirectories to parse through +/// @return Tab delimited string containing list of directories found during search, \"\" if no files were found +/// +/// @ingroup FileSystem) +/// /// public string fn_getDirectoryList (string path, int depth) @@ -4011,7 +5306,9 @@ public string fn_getDirectoryList (string path, int depth) } /// -/// Get the string describing the active GFX device. @ingroup GFX ) +/// Get the string describing the active GFX device. +/// @ingroup GFX ) +/// /// public string fn_getDisplayDeviceInformation () @@ -4026,7 +5323,9 @@ public string fn_getDisplayDeviceInformation () } /// -/// Returns a tab-seperated string of the detected devices across all adapters. @ingroup GFX ) +/// Returns a tab-seperated string of the detected devices across all adapters. +/// @ingroup GFX ) +/// /// public string fn_getDisplayDeviceList () @@ -4041,7 +5340,15 @@ public string fn_getDisplayDeviceList () } /// -/// Get the absolute path to the file in which the compiled code for the given script file will be stored. @param scriptFileName %Path to the .cs script file. @return The absolute path to the .dso file for the given script file. @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded from the current paths. @see compile @see getPrefsPath @ingroup Scripting ) +/// Get the absolute path to the file in which the compiled code for the given script file will be stored. +/// @param scriptFileName %Path to the .cs script file. +/// @return The absolute path to the .dso file for the given script file. +/// @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded +/// from the current paths. +/// @see compile +/// @see getPrefsPath +/// @ingroup Scripting ) +/// /// public string fn_getDSOPath (string scriptFileName) @@ -4058,7 +5365,9 @@ public string fn_getDSOPath (string scriptFileName) } /// -/// Get the name of the engine product that this is running from, as a string. @ingroup Debugging) +/// Get the name of the engine product that this is running from, as a string. +/// @ingroup Debugging) +/// /// public string fn_getEngineName () @@ -4074,6 +5383,7 @@ public string fn_getEngineName () } /// /// getEventTimeLeft(scheduleId) Get the time left in ms until this event will trigger.) +/// /// public int fn_getEventTimeLeft (int scheduleId) @@ -4084,7 +5394,11 @@ public int fn_getEventTimeLeft (int scheduleId) return SafeNativeMethods.mwle_fn_getEventTimeLeft(scheduleId); } /// -/// @brief Gets the name of the game's executable @return String containing this game's executable name @ingroup FileSystem) +/// @brief Gets the name of the game's executable +/// +/// @return String containing this game's executable name +/// @ingroup FileSystem) +/// /// public string fn_getExecutableName () @@ -4099,7 +5413,9 @@ public string fn_getExecutableName () } /// -/// Gets the clients far clipping. ) +/// Gets the clients far clipping. +/// ) +/// /// public float fn_getFarClippingDistance () @@ -4111,7 +5427,20 @@ public float fn_getFarClippingDistance () return SafeNativeMethods.mwle_fn_getFarClippingDistance(); } /// -/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to extract. @return The field at the given index or \"\" if the index is out of range. @tsexample getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getFields @see getFieldCount @see getWord @see getRecord @ingroup FieldManip ) +/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to extract. +/// @return The field at the given index or \"\" if the index is out of range. +/// @tsexample +/// getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getFields +/// @see getFieldCount +/// @see getWord +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string fn_getField (string text, int index) @@ -4128,7 +5457,16 @@ public string fn_getField (string text, int index) } /// -/// Return the number of newline and/or tab separated fields in @a text. @param text A list of fields separated by newlines and/or tabs. @return The number of newline and/or tab sepearated elements in @a text. @tsexample getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of newline and/or tab separated fields in @a text. +/// @param text A list of fields separated by newlines and/or tabs. +/// @return The number of newline and/or tab sepearated elements in @a text. +/// @tsexample +/// getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int fn_getFieldCount (string text) @@ -4142,7 +5480,23 @@ public int fn_getFieldCount (string text) return SafeNativeMethods.mwle_fn_getFieldCount(sbtext); } /// -/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param startIndex The zero-based index of the first field to extract from @a text. @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of fields from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" @endtsexample @see getField @see getFieldCount @see getWords @see getRecords @ingroup FieldManip ) +/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param startIndex The zero-based index of the first field to extract from @a text. +/// @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of fields from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see getFieldCount +/// @see getWords +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string fn_getFields (string text, int startIndex, int endIndex) @@ -4159,7 +5513,29 @@ public string fn_getFields (string text, int startIndex, int endIndex) } /// -/// @brief Returns the number of files in the directory tree that match the given patterns This function differs from getFileCountMultiExpr() in that it supports a single search pattern being passed in. If you're interested in a list of files that match the given pattern and not just the number of files, use findFirstFile() and findNextFile(). @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern counting files in subdirectories. @return Number of files located using the pattern @tsexample // Count the number of .cs files in a subdirectory and its subdirectories. getFileCount( \"subdirectory/*.cs\" ); @endtsexample @see findFirstFile() @see findNextFile() @see getFileCountMultiExpr() @ingroup FileSearches ) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// This function differs from getFileCountMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// If you're interested in a list of files that match the given pattern and not just +/// the number of files, use findFirstFile() and findNextFile(). +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern +/// counting files in subdirectories. +/// @return Number of files located using the pattern +/// +/// @tsexample +/// // Count the number of .cs files in a subdirectory and its subdirectories. +/// getFileCount( \"subdirectory/*.cs\" ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @see findNextFile() +/// @see getFileCountMultiExpr() +/// @ingroup FileSearches ) +/// /// public int fn_getFileCount (string pattern, bool recurse) @@ -4173,7 +5549,27 @@ public int fn_getFileCount (string pattern, bool recurse) return SafeNativeMethods.mwle_fn_getFileCount(sbpattern, recurse); } /// -/// @brief Returns the number of files in the directory tree that match the given patterns If you're interested in a list of files that match the given patterns and not just the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return Number of files located using the patterns @tsexample // Count all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); @endtsexample @see findFirstFileMultiExpr() @see findNextFileMultiExpr() @ingroup FileSearches) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// If you're interested in a list of files that match the given patterns and not just +/// the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename pattern. +/// @return Number of files located using the patterns +/// +/// @tsexample +/// // Count all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @see findNextFileMultiExpr() +/// @ingroup FileSearches) +/// /// public int fn_getFileCountMultiExpr (string pattern, bool recurse) @@ -4187,7 +5583,14 @@ public int fn_getFileCountMultiExpr (string pattern, bool recurse) return SafeNativeMethods.mwle_fn_getFileCountMultiExpr(sbpattern, recurse); } /// -/// @brief Provides the CRC checksum of the given file. @param fileName The path to the file. @return The calculated CRC checksum of the file, or -1 if the file could not be found. @ingroup FileSystem) +/// @brief Provides the CRC checksum of the given file. +/// +/// @param fileName The path to the file. +/// @return The calculated CRC checksum of the file, or -1 if the file +/// could not be found. +/// +/// @ingroup FileSystem) +/// /// public int fn_getFileCRC (string fileName) @@ -4199,9 +5602,44 @@ public int fn_getFileCRC (string fileName) sbfileName = new StringBuilder(fileName, 1024); return SafeNativeMethods.mwle_fn_getFileCRC(sbfileName); +} +/// +/// Returns a list of supported shape format extensions separated by tabs. +/// Example output: *.dsq TAB *.dae TAB) +/// +/// + +public string fn_getFormatExtensions () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_getFormatExtensions'"); + +var returnbuff = new StringBuilder(16384); + +SafeNativeMethods.mwle_fn_getFormatExtensions(returnbuff); +return returnbuff.ToString(); + +} +/// +/// Returns a list of supported shape formats in filter form. +/// Example output: DSQ Files|*.dsq|COLLADA Files|*.dae|) +/// +/// + +public string fn_getFormatFilters () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_getFormatFilters'"); + +var returnbuff = new StringBuilder(16384); + +SafeNativeMethods.mwle_fn_getFormatFilters(returnbuff); +return returnbuff.ToString(); + } /// /// @brief .) +/// /// public string fn_getFrustumOffset () @@ -4216,7 +5654,12 @@ public string fn_getFrustumOffset () } /// -/// (string funcName) @brief Provides the name of the package the function belongs to @param funcName String containing name of the function @return The name of the function's package @ingroup Packages) +/// (string funcName) +/// @brief Provides the name of the package the function belongs to +/// @param funcName String containing name of the function +/// @return The name of the function's package +/// @ingroup Packages) +/// /// public string fn_getFunctionPackage (string funcName) @@ -4234,6 +5677,7 @@ public string fn_getFunctionPackage (string funcName) } /// /// getJoystickAxes( instance )) +/// /// public string fn_getJoystickAxes (uint deviceID) @@ -4247,7 +5691,9 @@ public string fn_getJoystickAxes (uint deviceID) } /// -/// Returns a tab seperated list of light manager names. @ingroup Lighting ) +/// Returns a tab seperated list of light manager names. +/// @ingroup Lighting ) +/// /// public string fn_getLightManagerNames () @@ -4262,7 +5708,13 @@ public string fn_getLightManagerNames () } /// -/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. This directory will usually contain all the game assets and, in a user-side game installation, will usually be read-only. @return The path to the main game assets. @ingroup FileSystem) +/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. +/// +/// This directory will usually contain all the game assets and, in a user-side game installation, will usually be +/// read-only. +/// @return The path to the main game assets. +/// @ingroup FileSystem) +/// /// public string fn_getMainDotCsDir () @@ -4278,6 +5730,7 @@ public string fn_getMainDotCsDir () } /// /// @hide) +/// /// public string fn_getMapEntry (string texName) @@ -4294,7 +5747,12 @@ public string fn_getMapEntry (string texName) } /// -/// (string texName) @brief Returns the name of the material mapped to this texture. If no materials are found, an empty string is returned. @param texName Name of the texture @ingroup Materials) +/// (string texName) +/// @brief Returns the name of the material mapped to this texture. +/// If no materials are found, an empty string is returned. +/// @param texName Name of the texture +/// @ingroup Materials) +/// /// public string fn_getMaterialMapping (string texName) @@ -4311,7 +5769,12 @@ public string fn_getMaterialMapping (string texName) } /// -/// Calculate the greater of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The greater value of the two specified values. @ingroup Math ) +/// Calculate the greater of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The greater value of the two specified values. +/// @ingroup Math ) +/// /// public float fn_getMax (float v1, float v2) @@ -4323,6 +5786,7 @@ public float fn_getMax (float v1, float v2) } /// /// getMaxFrameAllocation(); ) +/// /// public int fn_getMaxFrameAllocation () @@ -4334,7 +5798,13 @@ public int fn_getMaxFrameAllocation () return SafeNativeMethods.mwle_fn_getMaxFrameAllocation(); } /// -/// (string namespace, string method) @brief Provides the name of the package the method belongs to @param namespace Class or namespace, such as Player @param method Name of the funciton to search for @return The name of the method's package @ingroup Packages) +/// (string namespace, string method) +/// @brief Provides the name of the package the method belongs to +/// @param namespace Class or namespace, such as Player +/// @param method Name of the funciton to search for +/// @return The name of the method's package +/// @ingroup Packages) +/// /// public string fn_getMethodPackage (string nameSpace, string method) @@ -4354,7 +5824,12 @@ public string fn_getMethodPackage (string nameSpace, string method) } /// -/// Calculate the lesser of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The lesser value of the two specified values. @ingroup Math ) +/// Calculate the lesser of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The lesser value of the two specified values. +/// @ingroup Math ) +/// /// public float fn_getMin (float v1, float v2) @@ -4365,7 +5840,9 @@ public float fn_getMin (float v1, float v2) return SafeNativeMethods.mwle_fn_getMin(v1, v2); } /// -/// Get the MissionArea object, if any. @ingroup enviroMisc) +/// Get the MissionArea object, if any. +/// @ingroup enviroMisc) +/// /// public string fn_getMissionAreaServerObject () @@ -4380,7 +5857,12 @@ public string fn_getMissionAreaServerObject () } /// -/// (string path) @brief Attempts to extract a mod directory from path. Returns empty string on failure. @param File path of mod folder @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated @internal) +/// (string path) +/// @brief Attempts to extract a mod directory from path. Returns empty string on failure. +/// @param File path of mod folder +/// @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated +/// @internal) +/// /// public string fn_getModNameFromPath (string path) @@ -4427,7 +5909,9 @@ public string fn_getPackageList () } /// -/// Returns the pixel shader version for the active device. @ingroup GFX ) +/// Returns the pixel shader version for the active device. +/// @ingroup GFX ) +/// /// public float fn_getPixelShaderVersion () @@ -4439,7 +5923,10 @@ public float fn_getPixelShaderVersion () return SafeNativeMethods.mwle_fn_getPixelShaderVersion(); } /// -/// ([relativeFileName]) @note Appears to be useless in Torque 3D, should be deprecated @internal) +/// ([relativeFileName]) +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @internal) +/// /// public string fn_getPrefsPath (string relativeFileName) @@ -4456,7 +5943,19 @@ public string fn_getPrefsPath (string relativeFileName) } /// -/// ( int a, int b ) @brief Returns a random number based on parameters passed in.. If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will return an integer between the specified numbers. @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. @param b Upper bound on the random number. The random number will be = @a b. @return A pseudo-random integer between @a a and @a b, between 0 and a, or a float between 0.0 and 1.1 depending on usage. @note All parameters are optional. @see setRandomSeed @ingroup Random ) +/// ( int a, int b ) +/// @brief Returns a random number based on parameters passed in.. +/// If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one +/// parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will +/// return an integer between the specified numbers. +/// @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. +/// @param b Upper bound on the random number. The random number will be = @a b. +/// @return A pseudo-random integer between @a a and @a b, between 0 and a, or a +/// float between 0.0 and 1.1 depending on usage. +/// @note All parameters are optional. +/// @see setRandomSeed +/// @ingroup Random ) +/// /// public float fn_getRandom (int a, int b) @@ -4467,7 +5966,10 @@ public float fn_getRandom (int a, int b) return SafeNativeMethods.mwle_fn_getRandom(a, b); } /// -/// Get the current seed used by the random number generator. @return The current random number generator seed value. @ingroup Random ) +/// Get the current seed used by the random number generator. +/// @return The current random number generator seed value. +/// @ingroup Random ) +/// /// public int fn_getRandomSeed () @@ -4479,7 +5981,11 @@ public int fn_getRandomSeed () return SafeNativeMethods.mwle_fn_getRandomSeed(); } /// -/// () @brief Return the current real time in milliseconds. Real time is platform defined; typically time since the computer booted. @ingroup Platform) +/// () +/// @brief Return the current real time in milliseconds. +/// Real time is platform defined; typically time since the computer booted. +/// @ingroup Platform) +/// /// public int fn_getRealTime () @@ -4491,7 +5997,20 @@ public int fn_getRealTime () return SafeNativeMethods.mwle_fn_getRealTime(); } /// -/// Extract the record at the given @a index in the newline-separated list in @a text. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to extract. @return The record at the given index or \"\" if @a index is out of range. @tsexample getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getRecords @see getRecordCount @see getWord @see getField @ingroup FieldManip ) +/// Extract the record at the given @a index in the newline-separated list in @a text. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to extract. +/// @return The record at the given index or \"\" if @a index is out of range. +/// @tsexample +/// getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getRecords +/// @see getRecordCount +/// @see getWord +/// @see getField +/// @ingroup FieldManip ) +/// /// public string fn_getRecord (string text, int index) @@ -4508,7 +6027,16 @@ public string fn_getRecord (string text, int index) } /// -/// Return the number of newline-separated records in @a text. @param text A list of records separated by newlines. @return The number of newline-sepearated elements in @a text. @tsexample getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getFieldCount @ingroup FieldManip ) +/// Return the number of newline-separated records in @a text. +/// @param text A list of records separated by newlines. +/// @return The number of newline-sepearated elements in @a text. +/// @tsexample +/// getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getFieldCount +/// @ingroup FieldManip ) +/// /// public int fn_getRecordCount (string text) @@ -4522,7 +6050,23 @@ public int fn_getRecordCount (string text) return SafeNativeMethods.mwle_fn_getRecordCount(sbtext); } /// -/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param startIndex The zero-based index of the first record to extract from @a text. @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of records from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" @endtsexample @see getRecord @see getRecordCount @see getWords @see getFields @ingroup FieldManip ) +/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param startIndex The zero-based index of the first record to extract from @a text. +/// @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of records from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see getRecordCount +/// @see getWords +/// @see getFields +/// @ingroup FieldManip ) +/// /// public string fn_getRecords (string text, int startIndex, int endIndex) @@ -4540,6 +6084,7 @@ public string fn_getRecords (string text, int startIndex, int endIndex) } /// /// getScheduleDuration(%scheduleId); ) +/// /// public int fn_getScheduleDuration (int scheduleId) @@ -4551,6 +6096,7 @@ public int fn_getScheduleDuration (int scheduleId) } /// /// getServerCount(...); ) +/// /// public int fn_getServerCount () @@ -4562,7 +6108,11 @@ public int fn_getServerCount () return SafeNativeMethods.mwle_fn_getServerCount(); } /// -/// () Return the current sim time in milliseconds. @brief Sim time is time since the game started. @ingroup Platform) +/// () +/// Return the current sim time in milliseconds. +/// @brief Sim time is time since the game started. +/// @ingroup Platform) +/// /// public int fn_getSimTime () @@ -4574,7 +6124,19 @@ public int fn_getSimTime () return SafeNativeMethods.mwle_fn_getSimTime(); } /// -/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source string length). @param str The string from which to extract a substring. @param start The offset at which to start copying out characters. @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end of the input string are copied. @return A string that contains the given portion of the input string. @tsexample getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". @endtsexample @ingroup Strings ) +/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str +/// (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source +/// string length). +/// @param str The string from which to extract a substring. +/// @param start The offset at which to start copying out characters. +/// @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end +/// of the input string are copied. +/// @return A string that contains the given portion of the input string. +/// @tsexample +/// getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_getSubStr (string str, int start, int numChars) @@ -4591,7 +6153,20 @@ public string fn_getSubStr (string str, int start, int numChars) } /// -/// ( string textTagString ) @brief Extracts the tag from a tagged string Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. @param textTagString The tagged string to extract. @returns The tag ID of the string. @see \\ref syntaxDataTypes under Tagged %Strings @see detag() @ingroup Networking) +/// ( string textTagString ) +/// @brief Extracts the tag from a tagged string +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. +/// +/// @param textTagString The tagged string to extract. +/// +/// @returns The tag ID of the string. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see detag() +/// @ingroup Networking) +/// /// public string fn_getTag (string textTagString) @@ -4608,7 +6183,22 @@ public string fn_getTag (string textTagString) } /// -/// ), @brief Use the getTaggedString function to convert a tag to a string. This is not the same as detag() which can only be used within the context of a function that receives a tag. This function can be used any time and anywhere to convert a tag to a string. @param tag A numeric tag ID. @returns The string as found in the Net String table. @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see removeTaggedString() @ingroup Networking) +/// ), +/// @brief Use the getTaggedString function to convert a tag to a string. +/// +/// This is not the same as detag() which can only be used within the context +/// of a function that receives a tag. This function can be used any time and +/// anywhere to convert a tag to a string. +/// +/// @param tag A numeric tag ID. +/// +/// @returns The string as found in the Net String table. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see removeTaggedString() +/// @ingroup Networking) +/// /// public string fn_getTaggedString (string tag) @@ -4625,7 +6215,16 @@ public string fn_getTaggedString (string tag) } /// -/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example @note This can be useful to adhering to OS standards and practices, but not really used in Torque 3D right now. @note Be very careful when getting into OS level File I/O. @return String containing path to OS temp directory @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example +/// @note This can be useful to adhering to OS standards and practices, +/// but not really used in Torque 3D right now. +/// @note Be very careful when getting into OS level File I/O. +/// @return String containing path to OS temp directory +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string fn_getTemporaryDirectory () @@ -4640,7 +6239,14 @@ public string fn_getTemporaryDirectory () } /// -/// @brief Creates a name and extension for a potential temporary file This does not create the actual file. It simply creates a random name for a file that does not exist. @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Creates a name and extension for a potential temporary file +/// This does not create the actual file. It simply creates a random name +/// for a file that does not exist. +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string fn_getTemporaryFileName () @@ -4655,7 +6261,11 @@ public string fn_getTemporaryFileName () } /// -/// (Point2 pos) - gets the terrain height at the specified position. @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point2 pos) - gets the terrain height at the specified position. +/// @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float fn_getTerrainHeight (string pos) @@ -4669,7 +6279,12 @@ public float fn_getTerrainHeight (string pos) return SafeNativeMethods.mwle_fn_getTerrainHeight(sbpos); } /// -/// (Point3F pos) - gets the terrain height at the specified position. @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) @note This function is useful if you simply want to grab the terrain height underneath an object. @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point3F pos) - gets the terrain height at the specified position. +/// @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) +/// @note This function is useful if you simply want to grab the terrain height underneath an object. +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float fn_getTerrainHeightBelowPosition (string pos) @@ -4683,7 +6298,12 @@ public float fn_getTerrainHeightBelowPosition (string pos) return SafeNativeMethods.mwle_fn_getTerrainHeightBelowPosition(sbpos); } /// -/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found). @hide) +/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found). +/// @hide) +/// /// public int fn_getTerrainUnderWorldPoint (string position) @@ -4697,7 +6317,9 @@ public int fn_getTerrainUnderWorldPoint (string position) return SafeNativeMethods.mwle_fn_getTerrainUnderWorldPoint(sbposition); } /// -/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB @ingroup GFX ) +/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB +/// @ingroup GFX ) +/// /// public string fn_getTextureProfileStats () @@ -4713,6 +6335,7 @@ public string fn_getTextureProfileStats () } /// /// getTimeSinceStart(%scheduleId); ) +/// /// public int fn_getTimeSinceStart (int scheduleId) @@ -4723,7 +6346,15 @@ public int fn_getTimeSinceStart (int scheduleId) return SafeNativeMethods.mwle_fn_getTimeSinceStart(scheduleId); } /// -/// Get the numeric suffix of the given input string. @param str The string from which to read out the numeric suffix. @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. @tsexample getTrailingNumber( \"test123\" ) // Returns '123'. @endtsexample @see stripTrailingNumber @ingroup Strings ) +/// Get the numeric suffix of the given input string. +/// @param str The string from which to read out the numeric suffix. +/// @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. +/// @tsexample +/// getTrailingNumber( \"test123\" ) // Returns '123'. +/// @endtsexample +/// @see stripTrailingNumber +/// @ingroup Strings ) +/// /// public int fn_getTrailingNumber (string str) @@ -4737,7 +6368,12 @@ public int fn_getTrailingNumber (string str) return SafeNativeMethods.mwle_fn_getTrailingNumber(sbstr); } /// -/// ( String baseName, SimSet set, bool searchChildren ) @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName, SimSet set, bool searchChildren ) +/// @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string fn_getUniqueInternalName (string baseName, string setString, bool searchChildren) @@ -4757,7 +6393,13 @@ public string fn_getUniqueInternalName (string baseName, string setString, bool } /// -/// ( String baseName ) @brief Returns a unique unused SimObject name based on a given base name. @baseName Name to conver to a unique string if another instance exists @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName ) +/// @brief Returns a unique unused SimObject name based on a given base name. +/// @baseName Name to conver to a unique string if another instance exists +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string fn_getUniqueName (string baseName) @@ -4775,6 +6417,7 @@ public string fn_getUniqueName (string baseName) } /// /// getUserDataDirectory()) +/// /// public string fn_getUserDataDirectory () @@ -4790,6 +6433,7 @@ public string fn_getUserDataDirectory () } /// /// getUserHomeDirectory()) +/// /// public string fn_getUserHomeDirectory () @@ -4804,7 +6448,12 @@ public string fn_getUserHomeDirectory () } /// -/// (string varName) @brief Returns the value of the named variable or an empty string if not found. @varName Name of the variable to search for @return Value contained by varName, \"\" if the variable does not exist @ingroup Scripting) +/// (string varName) +/// @brief Returns the value of the named variable or an empty string if not found. +/// @varName Name of the variable to search for +/// @return Value contained by varName, \"\" if the variable does not exist +/// @ingroup Scripting) +/// /// public string fn_getVariable (string varName) @@ -4821,7 +6470,9 @@ public string fn_getVariable (string varName) } /// -/// Get the version of the engine build, as a string. @ingroup Debugging) +/// Get the version of the engine build, as a string. +/// @ingroup Debugging) +/// /// public int fn_getVersionNumber () @@ -4833,7 +6484,9 @@ public int fn_getVersionNumber () return SafeNativeMethods.mwle_fn_getVersionNumber(); } /// -/// Get the version of the engine build, as a human readable string. @ingroup Debugging) +/// Get the version of the engine build, as a human readable string. +/// @ingroup Debugging) +/// /// public string fn_getVersionString () @@ -4848,7 +6501,12 @@ public string fn_getVersionString () } /// -/// Test whether Torque is running in web-deployment mode. In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not be able to enter fullscreen exclusive mode). @return True if Torque is running in web-deployment mode. @ingroup Platform ) +/// Test whether Torque is running in web-deployment mode. +/// In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not +/// be able to enter fullscreen exclusive mode). +/// @return True if Torque is running in web-deployment mode. +/// @ingroup Platform ) +/// /// public bool fn_getWebDeployment () @@ -4860,7 +6518,20 @@ public bool fn_getWebDeployment () return SafeNativeMethods.mwle_fn_getWebDeployment()>=1; } /// -/// Extract the word at the given @a index in the whitespace-separated list in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to extract. @return The word at the given index or \"\" if the index is out of range. @tsexample getWord( \"a b c\", 1 ) // Returns \"b\" @endtsexample @see getWords @see getWordCount @see getField @see getRecord @ingroup FieldManip ) +/// Extract the word at the given @a index in the whitespace-separated list in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to extract. +/// @return The word at the given index or \"\" if the index is out of range. +/// @tsexample +/// getWord( \"a b c\", 1 ) // Returns \"b\" +/// @endtsexample +/// @see getWords +/// @see getWordCount +/// @see getField +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string fn_getWord (string text, int index) @@ -4877,7 +6548,17 @@ public string fn_getWord (string text, int index) } /// -/// Return the number of whitespace-separated words in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @return The number of whitespace-separated words in @a text. @tsexample getWordCount( \"a b c d e\" ) // Returns 5 @endtsexample @see getFieldCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of whitespace-separated words in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @return The number of whitespace-separated words in @a text. +/// @tsexample +/// getWordCount( \"a b c d e\" ) // Returns 5 +/// @endtsexample +/// @see getFieldCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int fn_getWordCount (string text) @@ -4891,7 +6572,23 @@ public int fn_getWordCount (string text) return SafeNativeMethods.mwle_fn_getWordCount(sbtext); } /// -/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param startIndex The zero-based index of the first word to extract from @a text. @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of words from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" @endtsexample @see getWord @see getWordCount @see getFields @see getRecords @ingroup FieldManip ) +/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param startIndex The zero-based index of the first word to extract from @a text. +/// @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of words from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" +/// @endtsexample +/// @see getWord +/// @see getWordCount +/// @see getFields +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string fn_getWords (string text, int startIndex, int endIndex) @@ -4908,7 +6605,11 @@ public string fn_getWords (string text, int startIndex, int endIndex) } /// -/// @brief Reports the current directory @return String containing full file path of working directory @ingroup FileSystem) +/// @brief Reports the current directory +/// +/// @return String containing full file path of working directory +/// @ingroup FileSystem) +/// /// public string fn_getWorkingDirectory () @@ -4923,7 +6624,25 @@ public string fn_getWorkingDirectory () } /// -/// ( int controllerID, string property, bool currentD ) @brief Queries the current state of a connected Xbox 360 controller. XInput Properties: - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. - XI_START, XI_BACK - The Start and Back buttons. - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. @param controllerID Zero-based index of the controller to return information about. @param property Name of input action being queried, such as \"XI_THUMBLX\". @param current True checks current device in action. @return Button queried - 1 if the button is pressed, 0 if it's not. @return Thumbstick queried - Int representing displacement from rest position. @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. @ingroup Input) +/// ( int controllerID, string property, bool currentD ) +/// @brief Queries the current state of a connected Xbox 360 controller. +/// XInput Properties: +/// - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. +/// - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. +/// - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. +/// - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. +/// - XI_START, XI_BACK - The Start and Back buttons. +/// - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. +/// - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. +/// - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. +/// @param controllerID Zero-based index of the controller to return information about. +/// @param property Name of input action being queried, such as \"XI_THUMBLX\". +/// @param current True checks current device in action. +/// @return Button queried - 1 if the button is pressed, 0 if it's not. +/// @return Thumbstick queried - Int representing displacement from rest position. +/// @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. +/// @ingroup Input) +/// /// public int fn_getXInputState (int controllerID, string properties, bool current) @@ -4937,7 +6656,15 @@ public int fn_getXInputState (int controllerID, string properties, bool current) return SafeNativeMethods.mwle_fn_getXInputState(controllerID, sbproperties, current); } /// -/// Open the given URL or file in the user's web browser. @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then the function checks whether the address refers to a file or directory and if so, prepends \"file://\" to @a adress; if the file check fails, \"http://\" is prepended to @a address. @tsexample gotoWebPage( \"http://www.garagegames.com\" ); @endtsexample @ingroup Platform ) +/// Open the given URL or file in the user's web browser. +/// @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then +/// the function checks whether the address refers to a file or directory and if so, prepends \"file://\" +/// to @a adress; if the file check fails, \"http://\" is prepended to @a address. +/// @tsexample +/// gotoWebPage( \"http://www.garagegames.com\" ); +/// @endtsexample +/// @ingroup Platform ) +/// /// public void fn_gotoWebPage (string address) @@ -4951,7 +6678,9 @@ public void fn_gotoWebPage (string address) SafeNativeMethods.mwle_fn_gotoWebPage(sbaddress); } /// -/// ( String filename | String filename, bool resize ) Assign an image to the control. @hide ) +/// ( String filename | String filename, bool resize ) Assign an image to the control. +/// @hide ) +/// /// public void fn_GuiBitmapCtrl_setBitmap (string guibitmapctrl, string fileRoot, bool resize) @@ -4969,6 +6698,7 @@ public void fn_GuiBitmapCtrl_setBitmap (string guibitmapctrl, string fileRoot, b } /// /// () - Is this canvas currently fullscreen? ) +/// /// public bool fn_GuiCanvas_isFullscreen (string guicanvas) @@ -4983,6 +6713,7 @@ public bool fn_GuiCanvas_isFullscreen (string guicanvas) } /// /// () ) +/// /// public bool fn_GuiCanvas_isMaximized (string guicanvas) @@ -4997,6 +6728,7 @@ public bool fn_GuiCanvas_isMaximized (string guicanvas) } /// /// () ) +/// /// public bool fn_GuiCanvas_isMinimized (string guicanvas) @@ -5011,6 +6743,7 @@ public bool fn_GuiCanvas_isMinimized (string guicanvas) } /// /// () - maximize this canvas' window. ) +/// /// public void fn_GuiCanvas_maximizeWindow (string guicanvas) @@ -5025,6 +6758,7 @@ public void fn_GuiCanvas_maximizeWindow (string guicanvas) } /// /// () - minimize this canvas' window. ) +/// /// public void fn_GuiCanvas_minimizeWindow (string guicanvas) @@ -5038,7 +6772,9 @@ public void fn_GuiCanvas_minimizeWindow (string guicanvas) SafeNativeMethods.mwle_fn_GuiCanvas_minimizeWindow(sbguicanvas); } /// -/// (GuiControl ctrl=NULL) @hide) +/// (GuiControl ctrl=NULL) +/// @hide) +/// /// public void fn_GuiCanvas_popDialog (string guicanvas, string gui) @@ -5055,7 +6791,9 @@ public void fn_GuiCanvas_popDialog (string guicanvas, string gui) SafeNativeMethods.mwle_fn_GuiCanvas_popDialog(sbguicanvas, sbgui); } /// -/// (int layer) @hide) +/// (int layer) +/// @hide) +/// /// public void fn_GuiCanvas_popLayer (string guicanvas, int layer) @@ -5069,7 +6807,9 @@ public void fn_GuiCanvas_popLayer (string guicanvas, int layer) SafeNativeMethods.mwle_fn_GuiCanvas_popLayer(sbguicanvas, layer); } /// -/// (GuiControl ctrl, int layer=0, bool center=false) @hide) +/// (GuiControl ctrl, int layer=0, bool center=false) +/// @hide) +/// /// public void fn_GuiCanvas_pushDialog (string guicanvas, string ctrlName, int layer, bool center) @@ -5087,6 +6827,7 @@ public void fn_GuiCanvas_pushDialog (string guicanvas, string ctrlName, int laye } /// /// () - restore this canvas' window. ) +/// /// public void fn_GuiCanvas_restoreWindow (string guicanvas) @@ -5100,7 +6841,9 @@ public void fn_GuiCanvas_restoreWindow (string guicanvas) SafeNativeMethods.mwle_fn_GuiCanvas_restoreWindow(sbguicanvas); } /// -/// (Point2I pos) @hide) +/// (Point2I pos) +/// @hide) +/// /// public void fn_GuiCanvas_setCursorPos (string guicanvas, string pos) @@ -5118,6 +6861,7 @@ public void fn_GuiCanvas_setCursorPos (string guicanvas, string pos) } /// /// () - Claim OS input focus for this canvas' window.) +/// /// public void fn_GuiCanvas_setFocus (string guicanvas) @@ -5131,7 +6875,15 @@ public void fn_GuiCanvas_setFocus (string guicanvas) SafeNativeMethods.mwle_fn_GuiCanvas_setFocus(sbguicanvas); } /// -/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. \\param width The screen width to set. \\param height The screen height to set. \\param fullscreen Specify true to run fullscreen or false to run in a window \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) +/// Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. +/// \\param width The screen width to set. +/// \\param height The screen height to set. +/// \\param fullscreen Specify true to run fullscreen or false to run in a window +/// \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. +/// \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window +/// \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// /// public void fn_GuiCanvas_setVideoMode (string guicanvas, uint width, uint height, bool fullscreen, uint bitDepth, uint refreshRate, uint antialiasLevel) @@ -5146,6 +6898,7 @@ public void fn_GuiCanvas_setVideoMode (string guicanvas, uint width, uint height } /// /// Gets the current position of the selector) +/// /// public string fn_GuiColorPickerCtrl_getSelectorPos (string guicolorpickerctrl) @@ -5163,6 +6916,7 @@ public string fn_GuiColorPickerCtrl_getSelectorPos (string guicolorpickerctrl) } /// /// Sets the current position of the selector) +/// /// public void fn_GuiColorPickerCtrl_setSelectorPos (string guicolorpickerctrl, string newPos) @@ -5180,6 +6934,7 @@ public void fn_GuiColorPickerCtrl_setSelectorPos (string guicolorpickerctrl, str } /// /// Forces update of pick color) +/// /// public void fn_GuiColorPickerCtrl_updateColor (string guicolorpickerctrl) @@ -5194,6 +6949,7 @@ public void fn_GuiColorPickerCtrl_updateColor (string guicolorpickerctrl) } /// /// ) +/// /// public string fn_GuiControl_getBounds (string guicontrol) @@ -5211,6 +6967,7 @@ public string fn_GuiControl_getBounds (string guicontrol) } /// /// ) +/// /// public string fn_GuiControl_getValue (string guicontrol) @@ -5228,6 +6985,7 @@ public string fn_GuiControl_getValue (string guicontrol) } /// /// ) +/// /// public bool fn_GuiControl_isActive (string guicontrol) @@ -5242,6 +7000,7 @@ public bool fn_GuiControl_isActive (string guicontrol) } /// /// (bool isFirst)) +/// /// public void fn_GuiControl_makeFirstResponder (string guicontrol, bool isFirst) @@ -5255,7 +7014,9 @@ public void fn_GuiControl_makeFirstResponder (string guicontrol, bool isFirst) SafeNativeMethods.mwle_fn_GuiControl_makeFirstResponder(sbguicontrol, isFirst); } /// -/// Set the width and height of the control. @hide ) +/// Set the width and height of the control. +/// @hide ) +/// /// public void fn_GuiControl_setExtent (string guicontrol, string ext) @@ -5273,6 +7034,7 @@ public void fn_GuiControl_setExtent (string guicontrol, string ext) } /// /// ( pString ) ) +/// /// public int fn_GuiControlProfile_getStringWidth (string guicontrolprofile, string pString) @@ -5290,6 +7052,7 @@ public int fn_GuiControlProfile_getStringWidth (string guicontrolprofile, string } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_dropSelectionAtScreenCenter (string guiconvexeditorctrl) @@ -5304,6 +7067,7 @@ public void fn_GuiConvexEditorCtrl_dropSelectionAtScreenCenter (string guiconvex } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_handleDelete (string guiconvexeditorctrl) @@ -5318,6 +7082,7 @@ public void fn_GuiConvexEditorCtrl_handleDelete (string guiconvexeditorctrl) } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_handleDeselect (string guiconvexeditorctrl) @@ -5332,6 +7097,7 @@ public void fn_GuiConvexEditorCtrl_handleDeselect (string guiconvexeditorctrl) } /// /// ) +/// /// public int fn_GuiConvexEditorCtrl_hasSelection (string guiconvexeditorctrl) @@ -5346,6 +7112,7 @@ public int fn_GuiConvexEditorCtrl_hasSelection (string guiconvexeditorctrl) } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_hollowSelection (string guiconvexeditorctrl) @@ -5360,6 +7127,7 @@ public void fn_GuiConvexEditorCtrl_hollowSelection (string guiconvexeditorctrl) } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_recenterSelection (string guiconvexeditorctrl) @@ -5374,6 +7142,7 @@ public void fn_GuiConvexEditorCtrl_recenterSelection (string guiconvexeditorctrl } /// /// ( ConvexShape ) ) +/// /// public void fn_GuiConvexEditorCtrl_selectConvex (string guiconvexeditorctrl, string convex) @@ -5391,6 +7160,7 @@ public void fn_GuiConvexEditorCtrl_selectConvex (string guiconvexeditorctrl, str } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_splitSelectedFace (string guiconvexeditorctrl) @@ -5405,6 +7175,7 @@ public void fn_GuiConvexEditorCtrl_splitSelectedFace (string guiconvexeditorctrl } /// /// deleteSelectedDecalDatablock( String datablock ) ) +/// /// public void fn_GuiDecalEditorCtrl_deleteDecalDatablock (string guidecaleditorctrl, string datablock) @@ -5422,6 +7193,7 @@ public void fn_GuiDecalEditorCtrl_deleteDecalDatablock (string guidecaleditorctr } /// /// deleteSelectedDecal() ) +/// /// public void fn_GuiDecalEditorCtrl_deleteSelectedDecal (string guidecaleditorctrl) @@ -5436,6 +7208,7 @@ public void fn_GuiDecalEditorCtrl_deleteSelectedDecal (string guidecaleditorctrl } /// /// editDecalDetails( S32 )() ) +/// /// public void fn_GuiDecalEditorCtrl_editDecalDetails (string guidecaleditorctrl, uint id, string pos, string tan, float size) @@ -5456,6 +7229,7 @@ public void fn_GuiDecalEditorCtrl_editDecalDetails (string guidecaleditorctrl, u } /// /// getDecalCount() ) +/// /// public int fn_GuiDecalEditorCtrl_getDecalCount (string guidecaleditorctrl) @@ -5470,6 +7244,7 @@ public int fn_GuiDecalEditorCtrl_getDecalCount (string guidecaleditorctrl) } /// /// getDecalLookupName( S32 )() ) +/// /// public string fn_GuiDecalEditorCtrl_getDecalLookupName (string guidecaleditorctrl, uint id) @@ -5487,6 +7262,7 @@ public string fn_GuiDecalEditorCtrl_getDecalLookupName (string guidecaleditorctr } /// /// getDecalTransform() ) +/// /// public string fn_GuiDecalEditorCtrl_getDecalTransform (string guidecaleditorctrl, uint id) @@ -5504,6 +7280,7 @@ public string fn_GuiDecalEditorCtrl_getDecalTransform (string guidecaleditorctrl } /// /// getMode() ) +/// /// public string fn_GuiDecalEditorCtrl_getMode (string guidecaleditorctrl) @@ -5521,6 +7298,7 @@ public string fn_GuiDecalEditorCtrl_getMode (string guidecaleditorctrl) } /// /// ) +/// /// public int fn_GuiDecalEditorCtrl_getSelectionCount (string guidecaleditorctrl) @@ -5535,6 +7313,7 @@ public int fn_GuiDecalEditorCtrl_getSelectionCount (string guidecaleditorctrl) } /// /// ) +/// /// public void fn_GuiDecalEditorCtrl_retargetDecalDatablock (string guidecaleditorctrl, string dbFrom, string dbTo) @@ -5555,6 +7334,7 @@ public void fn_GuiDecalEditorCtrl_retargetDecalDatablock (string guidecaleditorc } /// /// selectDecal( S32 )() ) +/// /// public void fn_GuiDecalEditorCtrl_selectDecal (string guidecaleditorctrl, uint id) @@ -5569,6 +7349,7 @@ public void fn_GuiDecalEditorCtrl_selectDecal (string guidecaleditorctrl, uint i } /// /// setMode( String mode )() ) +/// /// public void fn_GuiDecalEditorCtrl_setMode (string guidecaleditorctrl, string newMode) @@ -5586,6 +7367,7 @@ public void fn_GuiDecalEditorCtrl_setMode (string guidecaleditorctrl, string new } /// /// (GuiControl ctrl)) +/// /// public void fn_GuiEditCtrl_addNewCtrl (string guieditctrl, string ctrl) @@ -5603,6 +7385,7 @@ public void fn_GuiEditCtrl_addNewCtrl (string guieditctrl, string ctrl) } /// /// selects a control.) +/// /// public void fn_GuiEditCtrl_addSelection (string guieditctrl, int id) @@ -5617,6 +7400,7 @@ public void fn_GuiEditCtrl_addSelection (string guieditctrl, int id) } /// /// ) +/// /// public void fn_GuiEditCtrl_bringToFront (string guieditctrl) @@ -5631,6 +7415,7 @@ public void fn_GuiEditCtrl_bringToFront (string guieditctrl) } /// /// ( [ int axis ] ) - Clear all currently set guide lines. ) +/// /// public void fn_GuiEditCtrl_clearGuides (string guieditctrl, int axis) @@ -5645,6 +7430,7 @@ public void fn_GuiEditCtrl_clearGuides (string guieditctrl, int axis) } /// /// Clear selected controls list.) +/// /// public void fn_GuiEditCtrl_clearSelection (string guieditctrl) @@ -5659,6 +7445,7 @@ public void fn_GuiEditCtrl_clearSelection (string guieditctrl) } /// /// () - Delete the selected controls.) +/// /// public void fn_GuiEditCtrl_deleteSelection (string guieditctrl) @@ -5673,6 +7460,7 @@ public void fn_GuiEditCtrl_deleteSelection (string guieditctrl) } /// /// ( bool width=true, bool height=true ) - Fit selected controls into their parents. ) +/// /// public void fn_GuiEditCtrl_fitIntoParents (string guieditctrl, bool width, bool height) @@ -5687,6 +7475,7 @@ public void fn_GuiEditCtrl_fitIntoParents (string guieditctrl, bool width, bool } /// /// () - Return the toplevel control edited inside the GUI editor. ) +/// /// public int fn_GuiEditCtrl_getContentControl (string guieditctrl) @@ -5701,6 +7490,7 @@ public int fn_GuiEditCtrl_getContentControl (string guieditctrl) } /// /// Returns the set to which new controls will be added) +/// /// public int fn_GuiEditCtrl_getCurrentAddSet (string guieditctrl) @@ -5715,6 +7505,7 @@ public int fn_GuiEditCtrl_getCurrentAddSet (string guieditctrl) } /// /// () - Return the current mouse mode. ) +/// /// public string fn_GuiEditCtrl_getMouseMode (string guieditctrl) @@ -5732,6 +7523,7 @@ public string fn_GuiEditCtrl_getMouseMode (string guieditctrl) } /// /// () - Return the number of controls currently selected. ) +/// /// public int fn_GuiEditCtrl_getNumSelected (string guieditctrl) @@ -5746,6 +7538,7 @@ public int fn_GuiEditCtrl_getNumSelected (string guieditctrl) } /// /// () - Returns global bounds of current selection as vector 'x y width height'. ) +/// /// public string fn_GuiEditCtrl_getSelectionGlobalBounds (string guieditctrl) @@ -5763,6 +7556,7 @@ public string fn_GuiEditCtrl_getSelectionGlobalBounds (string guieditctrl) } /// /// (int mode) ) +/// /// public void fn_GuiEditCtrl_justify (string guieditctrl, uint mode) @@ -5777,6 +7571,7 @@ public void fn_GuiEditCtrl_justify (string guieditctrl, uint mode) } /// /// ( string fileName=null ) - Load selection from file or clipboard.) +/// /// public void fn_GuiEditCtrl_loadSelection (string guieditctrl, string filename) @@ -5794,6 +7589,7 @@ public void fn_GuiEditCtrl_loadSelection (string guieditctrl, string filename) } /// /// Move all controls in the selection by (dx,dy) pixels.) +/// /// public void fn_GuiEditCtrl_moveSelection (string guieditctrl, string pos) @@ -5811,6 +7607,7 @@ public void fn_GuiEditCtrl_moveSelection (string guieditctrl, string pos) } /// /// ) +/// /// public void fn_GuiEditCtrl_pushToBack (string guieditctrl) @@ -5825,6 +7622,7 @@ public void fn_GuiEditCtrl_pushToBack (string guieditctrl) } /// /// ( GuiControl ctrl [, int axis ] ) - Read the guides from the given control. ) +/// /// public void fn_GuiEditCtrl_readGuides (string guieditctrl, string ctrl, int axis) @@ -5842,6 +7640,7 @@ public void fn_GuiEditCtrl_readGuides (string guieditctrl, string ctrl, int axis } /// /// deselects a control.) +/// /// public void fn_GuiEditCtrl_removeSelection (string guieditctrl, int id) @@ -5856,6 +7655,7 @@ public void fn_GuiEditCtrl_removeSelection (string guieditctrl, int id) } /// /// ( string fileName=null ) - Save selection to file or clipboard.) +/// /// public void fn_GuiEditCtrl_saveSelection (string guieditctrl, string filename) @@ -5873,6 +7673,7 @@ public void fn_GuiEditCtrl_saveSelection (string guieditctrl, string filename) } /// /// (GuiControl ctrl)) +/// /// public void fn_GuiEditCtrl_select (string guieditctrl, string ctrl) @@ -5890,6 +7691,7 @@ public void fn_GuiEditCtrl_select (string guieditctrl, string ctrl) } /// /// ()) +/// /// public void fn_GuiEditCtrl_selectAll (string guieditctrl) @@ -5904,6 +7706,7 @@ public void fn_GuiEditCtrl_selectAll (string guieditctrl) } /// /// ( bool addToSelection=false ) - Select children of currently selected controls. ) +/// /// public void fn_GuiEditCtrl_selectChildren (string guieditctrl, bool addToSelection) @@ -5918,6 +7721,7 @@ public void fn_GuiEditCtrl_selectChildren (string guieditctrl, bool addToSelecti } /// /// ( bool addToSelection=false ) - Select parents of currently selected controls. ) +/// /// public void fn_GuiEditCtrl_selectParents (string guieditctrl, bool addToSelection) @@ -5932,6 +7736,7 @@ public void fn_GuiEditCtrl_selectParents (string guieditctrl, bool addToSelectio } /// /// ( GuiControl ctrl ) - Set the toplevel control to edit in the GUI editor. ) +/// /// public void fn_GuiEditCtrl_setContentControl (string guieditctrl, string ctrl) @@ -5949,6 +7754,7 @@ public void fn_GuiEditCtrl_setContentControl (string guieditctrl, string ctrl) } /// /// (GuiControl ctrl)) +/// /// public void fn_GuiEditCtrl_setCurrentAddSet (string guieditctrl, string addSet) @@ -5966,6 +7772,7 @@ public void fn_GuiEditCtrl_setCurrentAddSet (string guieditctrl, string addSet) } /// /// GuiEditCtrl.setSnapToGrid(gridsize)) +/// /// public void fn_GuiEditCtrl_setSnapToGrid (string guieditctrl, uint gridsize) @@ -5980,6 +7787,7 @@ public void fn_GuiEditCtrl_setSnapToGrid (string guieditctrl, uint gridsize) } /// /// Toggle activation.) +/// /// public void fn_GuiEditCtrl_toggle (string guieditctrl) @@ -5994,6 +7802,7 @@ public void fn_GuiEditCtrl_toggle (string guieditctrl) } /// /// ( GuiControl ctrl [, int axis ] ) - Write the guides to the given control. ) +/// /// public void fn_GuiEditCtrl_writeGuides (string guieditctrl, string ctrl, int axis) @@ -6011,6 +7820,7 @@ public void fn_GuiEditCtrl_writeGuides (string guieditctrl, string ctrl, int axi } /// /// getSelectedPath() - returns the currently selected path in the tree) +/// /// public string fn_GuiFileTreeCtrl_getSelectedPath (string guifiletreectrl) @@ -6028,6 +7838,7 @@ public string fn_GuiFileTreeCtrl_getSelectedPath (string guifiletreectrl) } /// /// () - Reread the directory tree hierarchy. ) +/// /// public void fn_GuiFileTreeCtrl_reload (string guifiletreectrl) @@ -6042,6 +7853,7 @@ public void fn_GuiFileTreeCtrl_reload (string guifiletreectrl) } /// /// setSelectedPath(path) - expands the tree to the specified path) +/// /// public bool fn_GuiFileTreeCtrl_setSelectedPath (string guifiletreectrl, string path) @@ -6058,7 +7870,9 @@ public bool fn_GuiFileTreeCtrl_setSelectedPath (string guifiletreectrl, string p return SafeNativeMethods.mwle_fn_GuiFileTreeCtrl_setSelectedPath(sbguifiletreectrl, sbpath)>=1; } /// -/// Return a tuple containing all the values in the filter. @internal) +/// Return a tuple containing all the values in the filter. +/// @internal) +/// /// public string fn_GuiFilterCtrl_getValue (string guifilterctrl) @@ -6075,7 +7889,9 @@ public string fn_GuiFilterCtrl_getValue (string guifilterctrl) } /// -/// Reset the filtering. @internal) +/// Reset the filtering. +/// @internal) +/// /// public void fn_GuiFilterCtrl_identity (string guifilterctrl) @@ -6090,6 +7906,7 @@ public void fn_GuiFilterCtrl_identity (string guifilterctrl) } /// /// Get color value) +/// /// public string fn_GuiGradientCtrl_getColor (string guigradientctrl, int idx) @@ -6107,6 +7924,7 @@ public string fn_GuiGradientCtrl_getColor (string guigradientctrl, int idx) } /// /// Get color count) +/// /// public int fn_GuiGradientCtrl_getColorCount (string guigradientctrl) @@ -6120,7 +7938,9 @@ public int fn_GuiGradientCtrl_getColorCount (string guigradientctrl) return SafeNativeMethods.mwle_fn_GuiGradientCtrl_getColorCount(sbguigradientctrl); } /// -/// () @internal) +/// () +/// @internal) +/// /// public void fn_GuiIdleCamFadeBitmapCtrl_fadeIn (string guiidlecamfadebitmapctrl) @@ -6134,7 +7954,9 @@ public void fn_GuiIdleCamFadeBitmapCtrl_fadeIn (string guiidlecamfadebitmapctrl) SafeNativeMethods.mwle_fn_GuiIdleCamFadeBitmapCtrl_fadeIn(sbguiidlecamfadebitmapctrl); } /// -/// () @internal) +/// () +/// @internal) +/// /// public void fn_GuiIdleCamFadeBitmapCtrl_fadeOut (string guiidlecamfadebitmapctrl) @@ -6149,6 +7971,7 @@ public void fn_GuiIdleCamFadeBitmapCtrl_fadeOut (string guiidlecamfadebitmapctrl } /// /// ( id object, (bool autoSync = true) ) - Add the object to the list of objects being inspected. ) +/// /// public void fn_GuiInspector_addInspect (string guiinspector, string className, bool autoSync) @@ -6166,6 +7989,7 @@ public void fn_GuiInspector_addInspect (string guiinspector, string className, b } /// /// apply() - Force application of inspected object's attributes ) +/// /// public void fn_GuiInspector_apply (string guiinspector) @@ -6180,6 +8004,7 @@ public void fn_GuiInspector_apply (string guiinspector) } /// /// getInspectObject( int index=0 ) - Returns currently inspected object ) +/// /// public string fn_GuiInspector_getInspectObject (string guiinspector, uint index) @@ -6197,6 +8022,7 @@ public string fn_GuiInspector_getInspectObject (string guiinspector, uint index) } /// /// () - Return the number of objects currently being inspected. ) +/// /// public int fn_GuiInspector_getNumInspectObjects (string guiinspector) @@ -6211,6 +8037,7 @@ public int fn_GuiInspector_getNumInspectObjects (string guiinspector) } /// /// Inspect(Object)) +/// /// public void fn_GuiInspector_inspect (string guiinspector, string className) @@ -6228,6 +8055,7 @@ public void fn_GuiInspector_inspect (string guiinspector, string className) } /// /// Reinspect the currently selected object. ) +/// /// public void fn_GuiInspector_refresh (string guiinspector) @@ -6242,6 +8070,7 @@ public void fn_GuiInspector_refresh (string guiinspector) } /// /// ( id object ) - Remove the object from the list of objects being inspected. ) +/// /// public void fn_GuiInspector_removeInspect (string guiinspector, string obj) @@ -6259,6 +8088,7 @@ public void fn_GuiInspector_removeInspect (string guiinspector, string obj) } /// /// setName(NewObjectName)) +/// /// public void fn_GuiInspector_setName (string guiinspector, string newObjectName) @@ -6276,6 +8106,7 @@ public void fn_GuiInspector_setName (string guiinspector, string newObjectName) } /// /// setObjectField( fieldname, data ) - Set a named fields value on the inspected object if it exists. This triggers all the usual callbacks that would occur if the field had been changed through the gui. ) +/// /// public void fn_GuiInspector_setObjectField (string guiinspector, string fieldname, string data) @@ -6296,6 +8127,7 @@ public void fn_GuiInspector_setObjectField (string guiinspector, string fieldnam } /// /// field.renameField(newDynamicFieldName); ) +/// /// public void fn_GuiInspectorDynamicField_renameField (string guiinspectordynamicfield, string newDynamicFieldName) @@ -6313,6 +8145,7 @@ public void fn_GuiInspectorDynamicField_renameField (string guiinspectordynamicf } /// /// obj.addDynamicField(); ) +/// /// public void fn_GuiInspectorDynamicGroup_addDynamicField (string guiinspectordynamicgroup) @@ -6327,6 +8160,7 @@ public void fn_GuiInspectorDynamicGroup_addDynamicField (string guiinspectordyna } /// /// Refreshes the dynamic fields in the inspector.) +/// /// public bool fn_GuiInspectorDynamicGroup_inspectGroup (string guiinspectordynamicgroup) @@ -6341,6 +8175,7 @@ public bool fn_GuiInspectorDynamicGroup_inspectGroup (string guiinspectordynamic } /// /// ) +/// /// public void fn_GuiInspectorDynamicGroup_removeDynamicField (string guiinspectordynamicgroup) @@ -6355,6 +8190,7 @@ public void fn_GuiInspectorDynamicGroup_removeDynamicField (string guiinspectord } /// /// , true), ( string newValue, bool callbacks=true ) - Set the field's value. Suppress callbacks for undo if callbacks=false. ) +/// /// public void fn_GuiInspectorField_apply (string guiinspectorfield, string newValue, bool callbacks) @@ -6372,6 +8208,7 @@ public void fn_GuiInspectorField_apply (string guiinspectorfield, string newValu } /// /// () - Set field value without recording undo (same as 'apply( value, false )'). ) +/// /// public void fn_GuiInspectorField_applyWithoutUndo (string guiinspectorfield, string data) @@ -6389,6 +8226,7 @@ public void fn_GuiInspectorField_applyWithoutUndo (string guiinspectorfield, str } /// /// () - Return the value currently displayed on the field. ) +/// /// public string fn_GuiInspectorField_getData (string guiinspectorfield) @@ -6406,6 +8244,7 @@ public string fn_GuiInspectorField_getData (string guiinspectorfield) } /// /// () - Return the name of the field edited by this inspector field. ) +/// /// public string fn_GuiInspectorField_getInspectedFieldName (string guiinspectorfield) @@ -6423,6 +8262,7 @@ public string fn_GuiInspectorField_getInspectedFieldName (string guiinspectorfie } /// /// () - Return the type of the field edited by this inspector field. ) +/// /// public string fn_GuiInspectorField_getInspectedFieldType (string guiinspectorfield) @@ -6440,6 +8280,7 @@ public string fn_GuiInspectorField_getInspectedFieldType (string guiinspectorfie } /// /// () - Return the GuiInspector to which this field belongs. ) +/// /// public int fn_GuiInspectorField_getInspector (string guiinspectorfield) @@ -6454,6 +8295,7 @@ public int fn_GuiInspectorField_getInspector (string guiinspectorfield) } /// /// () - Reset to default value. ) +/// /// public void fn_GuiInspectorField_reset (string guiinspectorfield) @@ -6467,7 +8309,9 @@ public void fn_GuiInspectorField_reset (string guiinspectorfield) SafeNativeMethods.mwle_fn_GuiInspectorField_reset(sbguiinspectorfield); } /// -/// ( string materialName ) Set the material to be displayed in the control. ) +/// ( string materialName ) +/// Set the material to be displayed in the control. ) +/// /// public bool fn_GuiMaterialCtrl_setMaterial (string guimaterialctrl, string materialName) @@ -6485,6 +8329,7 @@ public bool fn_GuiMaterialCtrl_setMaterial (string guimaterialctrl, string mater } /// /// deleteNode() ) +/// /// public void fn_GuiMeshRoadEditorCtrl_deleteNode (string guimeshroadeditorctrl) @@ -6499,6 +8344,7 @@ public void fn_GuiMeshRoadEditorCtrl_deleteNode (string guimeshroadeditorctrl) } /// /// ) +/// /// public string fn_GuiMeshRoadEditorCtrl_getMode (string guimeshroadeditorctrl) @@ -6516,6 +8362,7 @@ public string fn_GuiMeshRoadEditorCtrl_getMode (string guimeshroadeditorctrl) } /// /// ) +/// /// public float fn_GuiMeshRoadEditorCtrl_getNodeDepth (string guimeshroadeditorctrl) @@ -6530,6 +8377,7 @@ public float fn_GuiMeshRoadEditorCtrl_getNodeDepth (string guimeshroadeditorctrl } /// /// ) +/// /// public string fn_GuiMeshRoadEditorCtrl_getNodeNormal (string guimeshroadeditorctrl) @@ -6547,6 +8395,7 @@ public string fn_GuiMeshRoadEditorCtrl_getNodeNormal (string guimeshroadeditorct } /// /// ) +/// /// public string fn_GuiMeshRoadEditorCtrl_getNodePosition (string guimeshroadeditorctrl) @@ -6564,6 +8413,7 @@ public string fn_GuiMeshRoadEditorCtrl_getNodePosition (string guimeshroadeditor } /// /// ) +/// /// public float fn_GuiMeshRoadEditorCtrl_getNodeWidth (string guimeshroadeditorctrl) @@ -6578,6 +8428,7 @@ public float fn_GuiMeshRoadEditorCtrl_getNodeWidth (string guimeshroadeditorctrl } /// /// ) +/// /// public int fn_GuiMeshRoadEditorCtrl_getSelectedRoad (string guimeshroadeditorctrl) @@ -6592,6 +8443,7 @@ public int fn_GuiMeshRoadEditorCtrl_getSelectedRoad (string guimeshroadeditorctr } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_matchTerrainToRoad (string guimeshroadeditorctrl) @@ -6606,6 +8458,7 @@ public void fn_GuiMeshRoadEditorCtrl_matchTerrainToRoad (string guimeshroadedito } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_regenerate (string guimeshroadeditorctrl) @@ -6620,6 +8473,7 @@ public void fn_GuiMeshRoadEditorCtrl_regenerate (string guimeshroadeditorctrl) } /// /// setMode( String mode ) ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setMode (string guimeshroadeditorctrl, string mode) @@ -6637,6 +8491,7 @@ public void fn_GuiMeshRoadEditorCtrl_setMode (string guimeshroadeditorctrl, stri } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodeDepth (string guimeshroadeditorctrl, float depth) @@ -6651,6 +8506,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodeDepth (string guimeshroadeditorctrl, } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodeNormal (string guimeshroadeditorctrl, string normal) @@ -6668,6 +8524,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodeNormal (string guimeshroadeditorctrl } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodePosition (string guimeshroadeditorctrl, string pos) @@ -6685,6 +8542,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodePosition (string guimeshroadeditorct } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodeWidth (string guimeshroadeditorctrl, float width) @@ -6699,6 +8557,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodeWidth (string guimeshroadeditorctrl, } /// /// ), ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setSelectedRoad (string guimeshroadeditorctrl, string objName) @@ -6716,6 +8575,7 @@ public void fn_GuiMeshRoadEditorCtrl_setSelectedRoad (string guimeshroadeditorct } /// /// ) +/// /// public string fn_GuiMissionAreaEditorCtrl_getSelectedMissionArea (string guimissionareaeditorctrl) @@ -6733,6 +8593,7 @@ public string fn_GuiMissionAreaEditorCtrl_getSelectedMissionArea (string guimiss } /// /// ), ) +/// /// public void fn_GuiMissionAreaEditorCtrl_setSelectedMissionArea (string guimissionareaeditorctrl, string missionAreaName) @@ -6785,7 +8646,10 @@ public void fn_GuiNavEditorCtrl_setMode (string guinaveditorctrl, string newMode SafeNativeMethods.mwle_fn_GuiNavEditorCtrl_setMode(sbguinaveditorctrl, sbnewMode); } /// -/// (int plotID, float x, float y, bool setAdded = true;) Add a data point to the given plot. @return) +/// (int plotID, float x, float y, bool setAdded = true;) +/// Add a data point to the given plot. +/// @return) +/// /// public string fn_GuiParticleGraphCtrl_addPlotPoint (string guiparticlegraphctrl, int plotID, float x, float y, bool setAdded) @@ -6802,7 +8666,13 @@ public string fn_GuiParticleGraphCtrl_addPlotPoint (string guiparticlegraphctrl, } /// -/// (int plotID, int i, float x, float y) Change a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Change a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public string fn_GuiParticleGraphCtrl_changePlotPoint (string guiparticlegraphctrl, int plotID, int i, float x, float y) @@ -6819,7 +8689,10 @@ public string fn_GuiParticleGraphCtrl_changePlotPoint (string guiparticlegraphct } /// -/// () Clear all of the graphs. @return No return value) +/// () +/// Clear all of the graphs. +/// @return No return value) +/// /// public void fn_GuiParticleGraphCtrl_clearAllGraphs (string guiparticlegraphctrl) @@ -6833,7 +8706,10 @@ public void fn_GuiParticleGraphCtrl_clearAllGraphs (string guiparticlegraphctrl) SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_clearAllGraphs(sbguiparticlegraphctrl); } /// -/// (int plotID) Clear the graph of the given plot. @return No return value) +/// (int plotID) +/// Clear the graph of the given plot. +/// @return No return value) +/// /// public void fn_GuiParticleGraphCtrl_clearGraph (string guiparticlegraphctrl, int plotID) @@ -6847,7 +8723,10 @@ public void fn_GuiParticleGraphCtrl_clearGraph (string guiparticlegraphctrl, int SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_clearGraph(sbguiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the color of the graph passed. @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// (int plotID) +/// Get the color of the graph passed. +/// @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// /// public string fn_GuiParticleGraphCtrl_getGraphColor (string guiparticlegraphctrl, int plotID) @@ -6864,7 +8743,10 @@ public string fn_GuiParticleGraphCtrl_getGraphColor (string guiparticlegraphctrl } /// -/// (int plotID) Get the maximum values of the graph ranges. @return Returns the maximum of the range formatted as \"x-max y-max\") +/// (int plotID) +/// Get the maximum values of the graph ranges. +/// @return Returns the maximum of the range formatted as \"x-max y-max\") +/// /// public string fn_GuiParticleGraphCtrl_getGraphMax (string guiparticlegraphctrl, int plotID) @@ -6881,7 +8763,10 @@ public string fn_GuiParticleGraphCtrl_getGraphMax (string guiparticlegraphctrl, } /// -/// (int plotID) Get the minimum values of the graph ranges. @return Returns the minimum of the range formatted as \"x-min y-min\") +/// (int plotID) +/// Get the minimum values of the graph ranges. +/// @return Returns the minimum of the range formatted as \"x-min y-min\") +/// /// public string fn_GuiParticleGraphCtrl_getGraphMin (string guiparticlegraphctrl, int plotID) @@ -6898,7 +8783,10 @@ public string fn_GuiParticleGraphCtrl_getGraphMin (string guiparticlegraphctrl, } /// -/// (int plotID) Get the name of the graph passed. @return Returns the name of the plot) +/// (int plotID) +/// Get the name of the graph passed. +/// @return Returns the name of the plot) +/// /// public string fn_GuiParticleGraphCtrl_getGraphName (string guiparticlegraphctrl, int plotID) @@ -6915,7 +8803,12 @@ public string fn_GuiParticleGraphCtrl_getGraphName (string guiparticlegraphctrl, } /// -/// (int plotID, float x, float y) Gets the index of the point passed on the plotID passed (graph ID). @param plotID The plot you wish to check. @param x,y The coordinates of the point to get. @return Returns the index of the point.) +/// (int plotID, float x, float y) +/// Gets the index of the point passed on the plotID passed (graph ID). +/// @param plotID The plot you wish to check. +/// @param x,y The coordinates of the point to get. +/// @return Returns the index of the point.) +/// /// public string fn_GuiParticleGraphCtrl_getPlotIndex (string guiparticlegraphctrl, int plotID, float x, float y) @@ -6932,7 +8825,10 @@ public string fn_GuiParticleGraphCtrl_getPlotIndex (string guiparticlegraphctrl, } /// -/// (int plotID, int samples) Get a data point from the plot specified, samples from the start of the graph. @return The data point ID) +/// (int plotID, int samples) +/// Get a data point from the plot specified, samples from the start of the graph. +/// @return The data point ID) +/// /// public string fn_GuiParticleGraphCtrl_getPlotPoint (string guiparticlegraphctrl, int plotID, int samples) @@ -6949,7 +8845,10 @@ public string fn_GuiParticleGraphCtrl_getPlotPoint (string guiparticlegraphctrl, } /// -/// () Gets the selected Plot (a.k.a. graph). @return The plot's ID.) +/// () +/// Gets the selected Plot (a.k.a. graph). +/// @return The plot's ID.) +/// /// public string fn_GuiParticleGraphCtrl_getSelectedPlot (string guiparticlegraphctrl) @@ -6966,7 +8865,10 @@ public string fn_GuiParticleGraphCtrl_getSelectedPlot (string guiparticlegraphct } /// -/// () Gets the selected Point on the Plot (a.k.a. graph). @return The last selected point ID) +/// () +/// Gets the selected Point on the Plot (a.k.a. graph). +/// @return The last selected point ID) +/// /// public string fn_GuiParticleGraphCtrl_getSelectedPoint (string guiparticlegraphctrl) @@ -6983,7 +8885,13 @@ public string fn_GuiParticleGraphCtrl_getSelectedPoint (string guiparticlegraphc } /// -/// (int plotID, int i, float x, float y) Insert a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Insert a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_insertPlotPoint (string guiparticlegraphctrl, int plotID, int i, float x, float y) @@ -6997,7 +8905,9 @@ public void fn_GuiParticleGraphCtrl_insertPlotPoint (string guiparticlegraphctrl SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_insertPlotPoint(sbguiparticlegraphctrl, plotID, i, x, y); } /// -/// (int plotID, int samples) @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// (int plotID, int samples) +/// @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// /// public string fn_GuiParticleGraphCtrl_isExistingPoint (string guiparticlegraphctrl, int plotID, int samples) @@ -7014,7 +8924,10 @@ public string fn_GuiParticleGraphCtrl_isExistingPoint (string guiparticlegraphct } /// -/// () This will reset the currently selected point to nothing. @return No return value.) +/// () +/// This will reset the currently selected point to nothing. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_resetSelectedPoint (string guiparticlegraphctrl) @@ -7028,7 +8941,11 @@ public void fn_GuiParticleGraphCtrl_resetSelectedPoint (string guiparticlegraphc SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_resetSelectedPoint(sbguiparticlegraphctrl); } /// -/// (bool autoMax) Set whether the max will automatically be set when adding points (ie if you add a value over the current max, the max is increased to that value). @return No return value.) +/// (bool autoMax) +/// Set whether the max will automatically be set when adding points +/// (ie if you add a value over the current max, the max is increased to that value). +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setAutoGraphMax (string guiparticlegraphctrl, bool autoMax) @@ -7042,7 +8959,10 @@ public void fn_GuiParticleGraphCtrl_setAutoGraphMax (string guiparticlegraphctrl SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setAutoGraphMax(sbguiparticlegraphctrl, autoMax); } /// -/// (bool autoRemove) Set whether or not a point should be deleted when you drag another one over it. @return No return value.) +/// (bool autoRemove) +/// Set whether or not a point should be deleted when you drag another one over it. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setAutoRemove (string guiparticlegraphctrl, bool autoRemove) @@ -7056,7 +8976,10 @@ public void fn_GuiParticleGraphCtrl_setAutoRemove (string guiparticlegraphctrl, SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setAutoRemove(sbguiparticlegraphctrl, autoRemove); } /// -/// (int plotID, bool isHidden) Set whether the graph number passed is hidden or not. @return No return value.) +/// (int plotID, bool isHidden) +/// Set whether the graph number passed is hidden or not. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphHidden (string guiparticlegraphctrl, int plotID, bool isHidden) @@ -7070,7 +8993,12 @@ public void fn_GuiParticleGraphCtrl_setGraphHidden (string guiparticlegraphctrl, SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphHidden(sbguiparticlegraphctrl, plotID, isHidden); } /// -/// (int plotID, float maxX, float maxY) Set the max values of the graph of plotID. @param plotID The plot to modify @param maxX,maxY The maximum bound of the value range. @return No return value.) +/// (int plotID, float maxX, float maxY) +/// Set the max values of the graph of plotID. +/// @param plotID The plot to modify +/// @param maxX,maxY The maximum bound of the value range. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMax (string guiparticlegraphctrl, int plotID, float maxX, float maxY) @@ -7084,7 +9012,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMax (string guiparticlegraphctrl, in SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMax(sbguiparticlegraphctrl, plotID, maxX, maxY); } /// -/// (int plotID, float maxX) Set the max X value of the graph of plotID. @param plotID The plot to modify. @param maxX The maximum x value. @return No return Value.) +/// (int plotID, float maxX) +/// Set the max X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxX The maximum x value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMaxX (string guiparticlegraphctrl, int plotID, float maxX) @@ -7098,7 +9031,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMaxX (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMaxX(sbguiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float maxY) Set the max Y value of the graph of plotID. @param plotID The plot to modify. @param maxY The maximum y value. @return No return Value.) +/// (int plotID, float maxY) +/// Set the max Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxY The maximum y value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMaxY (string guiparticlegraphctrl, int plotID, float maxX) @@ -7112,7 +9050,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMaxY (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMaxY(sbguiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float minX, float minY) Set the min values of the graph of plotID. @param plotID The plot to modify @param minX,minY The minimum bound of the value range. @return No return value.) +/// (int plotID, float minX, float minY) +/// Set the min values of the graph of plotID. +/// @param plotID The plot to modify +/// @param minX,minY The minimum bound of the value range. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMin (string guiparticlegraphctrl, int plotID, float minX, float minY) @@ -7126,7 +9069,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMin (string guiparticlegraphctrl, in SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMin(sbguiparticlegraphctrl, plotID, minX, minY); } /// -/// (int plotID, float minX) Set the min X value of the graph of plotID. @param plotID The plot to modify. @param minX The minimum x value. @return No return Value.) +/// (int plotID, float minX) +/// Set the min X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minX The minimum x value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMinX (string guiparticlegraphctrl, int plotID, float minX) @@ -7140,7 +9088,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMinX (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMinX(sbguiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, float minY) Set the min Y value of the graph of plotID. @param plotID The plot to modify. @param minY The minimum y value. @return No return Value.) +/// (int plotID, float minY) +/// Set the min Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minY The minimum y value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMinY (string guiparticlegraphctrl, int plotID, float minX) @@ -7154,7 +9107,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMinY (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMinY(sbguiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, string graphName) Set the name of the given plot. @param plotID The plot to modify. @param graphName The name to set on the plot. @return No return value.) +/// (int plotID, string graphName) +/// Set the name of the given plot. +/// @param plotID The plot to modify. +/// @param graphName The name to set on the plot. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphName (string guiparticlegraphctrl, int plotID, string graphName) @@ -7171,7 +9129,10 @@ public void fn_GuiParticleGraphCtrl_setGraphName (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphName(sbguiparticlegraphctrl, plotID, sbgraphName); } /// -/// (bool clamped) Set whether the x position of the selected graph point should be clamped @return No return value.) +/// (bool clamped) +/// Set whether the x position of the selected graph point should be clamped +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setPointXMovementClamped (string guiparticlegraphctrl, bool autoRemove) @@ -7185,7 +9146,10 @@ public void fn_GuiParticleGraphCtrl_setPointXMovementClamped (string guiparticle SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setPointXMovementClamped(sbguiparticlegraphctrl, autoRemove); } /// -/// (bool renderAll) Set whether or not a position should be rendered on every point or just the last selected. @return No return value.) +/// (bool renderAll) +/// Set whether or not a position should be rendered on every point or just the last selected. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setRenderAll (string guiparticlegraphctrl, bool autoRemove) @@ -7199,7 +9163,10 @@ public void fn_GuiParticleGraphCtrl_setRenderAll (string guiparticlegraphctrl, b SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setRenderAll(sbguiparticlegraphctrl, autoRemove); } /// -/// (bool renderGraphTooltip) Set whether or not to render the graph tooltip. @return No return value.) +/// (bool renderGraphTooltip) +/// Set whether or not to render the graph tooltip. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setRenderGraphTooltip (string guiparticlegraphctrl, bool autoRemove) @@ -7213,7 +9180,10 @@ public void fn_GuiParticleGraphCtrl_setRenderGraphTooltip (string guiparticlegra SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setRenderGraphTooltip(sbguiparticlegraphctrl, autoRemove); } /// -/// (int plotID) Set the selected plot (a.k.a. graph). @return No return value ) +/// (int plotID) +/// Set the selected plot (a.k.a. graph). +/// @return No return value ) +/// /// public void fn_GuiParticleGraphCtrl_setSelectedPlot (string guiparticlegraphctrl, int plotID) @@ -7227,7 +9197,10 @@ public void fn_GuiParticleGraphCtrl_setSelectedPlot (string guiparticlegraphctrl SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setSelectedPlot(sbguiparticlegraphctrl, plotID); } /// -/// (int point) Set the selected point on the graph. @return No return value) +/// (int point) +/// Set the selected point on the graph. +/// @return No return value) +/// /// public void fn_GuiParticleGraphCtrl_setSelectedPoint (string guiparticlegraphctrl, int point) @@ -7242,6 +9215,7 @@ public void fn_GuiParticleGraphCtrl_setSelectedPoint (string guiparticlegraphctr } /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void fn_GuiPopUpMenuCtrl_add (string guipopupmenuctrl, string name, int idNum, uint scheme) @@ -7259,6 +9233,7 @@ public void fn_GuiPopUpMenuCtrl_add (string guipopupmenuctrl, string name, int i } /// /// (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void fn_GuiPopUpMenuCtrl_addScheme (string guipopupmenuctrl, uint id, string fontColor, string fontColorHL, string fontColorSEL) @@ -7282,6 +9257,7 @@ public void fn_GuiPopUpMenuCtrl_addScheme (string guipopupmenuctrl, uint id, str } /// /// ( int id, string text ) ) +/// /// public void fn_GuiPopUpMenuCtrl_changeTextById (string guipopupmenuctrl, int id, string text) @@ -7299,6 +9275,7 @@ public void fn_GuiPopUpMenuCtrl_changeTextById (string guipopupmenuctrl, int id, } /// /// Clear the popup list.) +/// /// public void fn_GuiPopUpMenuCtrl_clear (string guipopupmenuctrl) @@ -7313,6 +9290,7 @@ public void fn_GuiPopUpMenuCtrl_clear (string guipopupmenuctrl) } /// /// (S32 entry)) +/// /// public void fn_GuiPopUpMenuCtrl_clearEntry (string guipopupmenuctrl, int entry) @@ -7326,7 +9304,9 @@ public void fn_GuiPopUpMenuCtrl_clearEntry (string guipopupmenuctrl, int entry) SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrl_clearEntry(sbguipopupmenuctrl, entry); } /// -/// (string text) Returns the position of the first entry containing the specified text.) +/// (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int fn_GuiPopUpMenuCtrl_findText (string guipopupmenuctrl, string text) @@ -7344,6 +9324,7 @@ public int fn_GuiPopUpMenuCtrl_findText (string guipopupmenuctrl, string text) } /// /// ) +/// /// public void fn_GuiPopUpMenuCtrl_forceClose (string guipopupmenuctrl) @@ -7358,6 +9339,7 @@ public void fn_GuiPopUpMenuCtrl_forceClose (string guipopupmenuctrl) } /// /// ) +/// /// public void fn_GuiPopUpMenuCtrl_forceOnAction (string guipopupmenuctrl) @@ -7372,6 +9354,7 @@ public void fn_GuiPopUpMenuCtrl_forceOnAction (string guipopupmenuctrl) } /// /// ) +/// /// public int fn_GuiPopUpMenuCtrl_getSelected (string guipopupmenuctrl) @@ -7386,6 +9369,7 @@ public int fn_GuiPopUpMenuCtrl_getSelected (string guipopupmenuctrl) } /// /// ) +/// /// public string fn_GuiPopUpMenuCtrl_getText (string guipopupmenuctrl) @@ -7403,6 +9387,7 @@ public string fn_GuiPopUpMenuCtrl_getText (string guipopupmenuctrl) } /// /// (int id)) +/// /// public string fn_GuiPopUpMenuCtrl_getTextById (string guipopupmenuctrl, int id) @@ -7420,6 +9405,7 @@ public string fn_GuiPopUpMenuCtrl_getTextById (string guipopupmenuctrl, int id) } /// /// (bool doReplaceText)) +/// /// public void fn_GuiPopUpMenuCtrl_replaceText (string guipopupmenuctrl, bool doReplaceText) @@ -7433,7 +9419,11 @@ public void fn_GuiPopUpMenuCtrl_replaceText (string guipopupmenuctrl, bool doRep SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrl_replaceText(sbguipopupmenuctrl, doReplaceText); } /// -/// (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void fn_GuiPopUpMenuCtrl_setEnumContent (string guipopupmenuctrl, string className, string enumName) @@ -7454,6 +9444,7 @@ public void fn_GuiPopUpMenuCtrl_setEnumContent (string guipopupmenuctrl, string } /// /// ([scriptCallback=true])) +/// /// public void fn_GuiPopUpMenuCtrl_setFirstSelected (string guipopupmenuctrl, bool scriptCallback) @@ -7468,6 +9459,7 @@ public void fn_GuiPopUpMenuCtrl_setFirstSelected (string guipopupmenuctrl, bool } /// /// ) +/// /// public void fn_GuiPopUpMenuCtrl_setNoneSelected (string guipopupmenuctrl) @@ -7482,6 +9474,7 @@ public void fn_GuiPopUpMenuCtrl_setNoneSelected (string guipopupmenuctrl) } /// /// (int id, [scriptCallback=true])) +/// /// public void fn_GuiPopUpMenuCtrl_setSelected (string guipopupmenuctrl, int id, bool scriptCallback) @@ -7496,6 +9489,7 @@ public void fn_GuiPopUpMenuCtrl_setSelected (string guipopupmenuctrl, int id, bo } /// /// Get the size of the menu - the number of entries in it.) +/// /// public int fn_GuiPopUpMenuCtrl_size (string guipopupmenuctrl) @@ -7510,6 +9504,7 @@ public int fn_GuiPopUpMenuCtrl_size (string guipopupmenuctrl) } /// /// Sort the list alphabetically.) +/// /// public void fn_GuiPopUpMenuCtrl_sort (string guipopupmenuctrl) @@ -7524,6 +9519,7 @@ public void fn_GuiPopUpMenuCtrl_sort (string guipopupmenuctrl) } /// /// Sort the list by ID.) +/// /// public void fn_GuiPopUpMenuCtrl_sortID (string guipopupmenuctrl) @@ -7538,6 +9534,7 @@ public void fn_GuiPopUpMenuCtrl_sortID (string guipopupmenuctrl) } /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void fn_GuiPopUpMenuCtrlEx_add (string guipopupmenuctrlex, string name, int idNum, uint scheme) @@ -7555,6 +9552,7 @@ public void fn_GuiPopUpMenuCtrlEx_add (string guipopupmenuctrlex, string name, i } /// /// (S32 entry)) +/// /// public void fn_GuiPopUpMenuCtrlEx_clearEntry (string guipopupmenuctrlex, int entry) @@ -7568,7 +9566,11 @@ public void fn_GuiPopUpMenuCtrlEx_clearEntry (string guipopupmenuctrlex, int ent SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_clearEntry(sbguipopupmenuctrlex, entry); } /// -/// (string text) Returns the id of the first entry containing the specified text or -1 if not found. @param text String value used for the query @return Numerical ID of entry containing the text.) +/// (string text) +/// Returns the id of the first entry containing the specified text or -1 if not found. +/// @param text String value used for the query +/// @return Numerical ID of entry containing the text.) +/// /// public int fn_GuiPopUpMenuCtrlEx_findText (string guipopupmenuctrlex, string text) @@ -7585,7 +9587,10 @@ public int fn_GuiPopUpMenuCtrlEx_findText (string guipopupmenuctrlex, string tex return SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_findText(sbguipopupmenuctrlex, sbtext); } /// -/// @brief Get color of an entry's box @param id ID number of entry to query @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// @brief Get color of an entry's box +/// @param id ID number of entry to query +/// @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// /// public string fn_GuiPopUpMenuCtrlEx_getColorById (string guipopupmenuctrlex, int id) @@ -7602,7 +9607,9 @@ public string fn_GuiPopUpMenuCtrlEx_getColorById (string guipopupmenuctrlex, int } /// -/// @brief Flag that causes each new text addition to replace the current entry @param True to turn on replacing, false to disable it) +/// @brief Flag that causes each new text addition to replace the current entry +/// @param True to turn on replacing, false to disable it) +/// /// public void fn_GuiPopUpMenuCtrlEx_replaceText (string guipopupmenuctrlex, int boolVal) @@ -7616,7 +9623,12 @@ public void fn_GuiPopUpMenuCtrlEx_replaceText (string guipopupmenuctrlex, int bo SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_replaceText(sbguipopupmenuctrlex, boolVal); } /// -/// @brief This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away. @param class Name of the class containing the enum @param enum Name of the enum value to acces) +/// @brief This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away. +/// @param class Name of the class containing the enum +/// @param enum Name of the enum value to acces) +/// /// public void fn_GuiPopUpMenuCtrlEx_setEnumContent (string guipopupmenuctrlex, string className, string enumName) @@ -7636,7 +9648,9 @@ public void fn_GuiPopUpMenuCtrlEx_setEnumContent (string guipopupmenuctrlex, str SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_setEnumContent(sbguipopupmenuctrlex, sbclassName, sbenumName); } /// -/// ([scriptCallback=true]) @hide) +/// ([scriptCallback=true]) +/// @hide) +/// /// public void fn_GuiPopUpMenuCtrlEx_setFirstSelected (string guipopupmenuctrlex, bool scriptCallback) @@ -7650,7 +9664,9 @@ public void fn_GuiPopUpMenuCtrlEx_setFirstSelected (string guipopupmenuctrlex, b SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_setFirstSelected(sbguipopupmenuctrlex, scriptCallback); } /// -/// (int id, [scriptCallback=true]) @hide) +/// (int id, [scriptCallback=true]) +/// @hide) +/// /// public void fn_GuiPopUpMenuCtrlEx_setSelected (string guipopupmenuctrlex, int id, bool scriptCallback) @@ -7664,7 +9680,9 @@ public void fn_GuiPopUpMenuCtrlEx_setSelected (string guipopupmenuctrlex, int id SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_setSelected(sbguipopupmenuctrlex, id, scriptCallback); } /// -/// @brief Get the size of the menu @return Number of entries in the menu) +/// @brief Get the size of the menu +/// @return Number of entries in the menu) +/// /// public int fn_GuiPopUpMenuCtrlEx_size (string guipopupmenuctrlex) @@ -7679,6 +9697,7 @@ public int fn_GuiPopUpMenuCtrlEx_size (string guipopupmenuctrlex) } /// /// deleteNode() ) +/// /// public void fn_GuiRiverEditorCtrl_deleteNode (string guirivereditorctrl) @@ -7693,6 +9712,7 @@ public void fn_GuiRiverEditorCtrl_deleteNode (string guirivereditorctrl) } /// /// ) +/// /// public string fn_GuiRiverEditorCtrl_getMode (string guirivereditorctrl) @@ -7710,6 +9730,7 @@ public string fn_GuiRiverEditorCtrl_getMode (string guirivereditorctrl) } /// /// ) +/// /// public float fn_GuiRiverEditorCtrl_getNodeDepth (string guirivereditorctrl) @@ -7724,6 +9745,7 @@ public float fn_GuiRiverEditorCtrl_getNodeDepth (string guirivereditorctrl) } /// /// ) +/// /// public string fn_GuiRiverEditorCtrl_getNodeNormal (string guirivereditorctrl) @@ -7741,6 +9763,7 @@ public string fn_GuiRiverEditorCtrl_getNodeNormal (string guirivereditorctrl) } /// /// ) +/// /// public string fn_GuiRiverEditorCtrl_getNodePosition (string guirivereditorctrl) @@ -7758,6 +9781,7 @@ public string fn_GuiRiverEditorCtrl_getNodePosition (string guirivereditorctrl) } /// /// ) +/// /// public float fn_GuiRiverEditorCtrl_getNodeWidth (string guirivereditorctrl) @@ -7772,6 +9796,7 @@ public float fn_GuiRiverEditorCtrl_getNodeWidth (string guirivereditorctrl) } /// /// ) +/// /// public int fn_GuiRiverEditorCtrl_getSelectedRiver (string guirivereditorctrl) @@ -7786,6 +9811,7 @@ public int fn_GuiRiverEditorCtrl_getSelectedRiver (string guirivereditorctrl) } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_regenerate (string guirivereditorctrl) @@ -7800,6 +9826,7 @@ public void fn_GuiRiverEditorCtrl_regenerate (string guirivereditorctrl) } /// /// setMode( String mode ) ) +/// /// public void fn_GuiRiverEditorCtrl_setMode (string guirivereditorctrl, string mode) @@ -7817,6 +9844,7 @@ public void fn_GuiRiverEditorCtrl_setMode (string guirivereditorctrl, string mod } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodeDepth (string guirivereditorctrl, float depth) @@ -7831,6 +9859,7 @@ public void fn_GuiRiverEditorCtrl_setNodeDepth (string guirivereditorctrl, float } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodeNormal (string guirivereditorctrl, string normal) @@ -7848,6 +9877,7 @@ public void fn_GuiRiverEditorCtrl_setNodeNormal (string guirivereditorctrl, stri } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodePosition (string guirivereditorctrl, string pos) @@ -7865,6 +9895,7 @@ public void fn_GuiRiverEditorCtrl_setNodePosition (string guirivereditorctrl, st } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodeWidth (string guirivereditorctrl, float width) @@ -7879,6 +9910,7 @@ public void fn_GuiRiverEditorCtrl_setNodeWidth (string guirivereditorctrl, float } /// /// ), ) +/// /// public void fn_GuiRiverEditorCtrl_setSelectedRiver (string guirivereditorctrl, string objName) @@ -7896,6 +9928,7 @@ public void fn_GuiRiverEditorCtrl_setSelectedRiver (string guirivereditorctrl, s } /// /// deleteNode() ) +/// /// public void fn_GuiRoadEditorCtrl_deleteNode (string guiroadeditorctrl) @@ -7910,6 +9943,7 @@ public void fn_GuiRoadEditorCtrl_deleteNode (string guiroadeditorctrl) } /// /// ) +/// /// public void fn_GuiRoadEditorCtrl_deleteRoad (string guiroadeditorctrl) @@ -7924,6 +9958,7 @@ public void fn_GuiRoadEditorCtrl_deleteRoad (string guiroadeditorctrl) } /// /// ) +/// /// public string fn_GuiRoadEditorCtrl_getMode (string guiroadeditorctrl) @@ -7941,6 +9976,7 @@ public string fn_GuiRoadEditorCtrl_getMode (string guiroadeditorctrl) } /// /// ) +/// /// public string fn_GuiRoadEditorCtrl_getNodePosition (string guiroadeditorctrl) @@ -7958,6 +9994,7 @@ public string fn_GuiRoadEditorCtrl_getNodePosition (string guiroadeditorctrl) } /// /// ) +/// /// public float fn_GuiRoadEditorCtrl_getNodeWidth (string guiroadeditorctrl) @@ -7972,6 +10009,7 @@ public float fn_GuiRoadEditorCtrl_getNodeWidth (string guiroadeditorctrl) } /// /// ) +/// /// public int fn_GuiRoadEditorCtrl_getSelectedNode (string guiroadeditorctrl) @@ -7986,6 +10024,7 @@ public int fn_GuiRoadEditorCtrl_getSelectedNode (string guiroadeditorctrl) } /// /// ) +/// /// public int fn_GuiRoadEditorCtrl_getSelectedRoad (string guiroadeditorctrl) @@ -8000,6 +10039,7 @@ public int fn_GuiRoadEditorCtrl_getSelectedRoad (string guiroadeditorctrl) } /// /// setMode( String mode ) ) +/// /// public void fn_GuiRoadEditorCtrl_setMode (string guiroadeditorctrl, string mode) @@ -8017,6 +10057,7 @@ public void fn_GuiRoadEditorCtrl_setMode (string guiroadeditorctrl, string mode) } /// /// ) +/// /// public void fn_GuiRoadEditorCtrl_setNodePosition (string guiroadeditorctrl, string pos) @@ -8034,6 +10075,7 @@ public void fn_GuiRoadEditorCtrl_setNodePosition (string guiroadeditorctrl, stri } /// /// ) +/// /// public void fn_GuiRoadEditorCtrl_setNodeWidth (string guiroadeditorctrl, float width) @@ -8048,6 +10090,7 @@ public void fn_GuiRoadEditorCtrl_setNodeWidth (string guiroadeditorctrl, float w } /// /// ), ) +/// /// public void fn_GuiRoadEditorCtrl_setSelectedRoad (string guiroadeditorctrl, string pathRoad) @@ -8065,6 +10108,7 @@ public void fn_GuiRoadEditorCtrl_setSelectedRoad (string guiroadeditorctrl, stri } /// /// Return a Point2F containing the position of the origin.) +/// /// public string fn_GuiTerrPreviewCtrl_getOrigin (string guiterrpreviewctrl) @@ -8082,6 +10126,7 @@ public string fn_GuiTerrPreviewCtrl_getOrigin (string guiterrpreviewctrl) } /// /// Return a Point2F representing the position of the root.) +/// /// public string fn_GuiTerrPreviewCtrl_getRoot (string guiterrpreviewctrl) @@ -8099,6 +10144,7 @@ public string fn_GuiTerrPreviewCtrl_getRoot (string guiterrpreviewctrl) } /// /// Returns a 4-tuple containing: root_x root_y origin_x origin_y) +/// /// public string fn_GuiTerrPreviewCtrl_getValue (string guiterrpreviewctrl) @@ -8116,6 +10162,7 @@ public string fn_GuiTerrPreviewCtrl_getValue (string guiterrpreviewctrl) } /// /// Reset the view of the terrain.) +/// /// public void fn_GuiTerrPreviewCtrl_reset (string guiterrpreviewctrl) @@ -8129,7 +10176,9 @@ public void fn_GuiTerrPreviewCtrl_reset (string guiterrpreviewctrl) SafeNativeMethods.mwle_fn_GuiTerrPreviewCtrl_reset(sbguiterrpreviewctrl); } /// -/// (float x, float y) Set the origin of the view.) +/// (float x, float y) +/// Set the origin of the view.) +/// /// public void fn_GuiTerrPreviewCtrl_setOrigin (string guiterrpreviewctrl, string pos) @@ -8147,6 +10196,7 @@ public void fn_GuiTerrPreviewCtrl_setOrigin (string guiterrpreviewctrl, string p } /// /// Add the origin to the root and reset the origin.) +/// /// public void fn_GuiTerrPreviewCtrl_setRoot (string guiterrpreviewctrl) @@ -8160,7 +10210,9 @@ public void fn_GuiTerrPreviewCtrl_setRoot (string guiterrpreviewctrl) SafeNativeMethods.mwle_fn_GuiTerrPreviewCtrl_setRoot(sbguiterrpreviewctrl); } /// -/// Accepts a 4-tuple in the same form as getValue returns. @see GuiTerrPreviewCtrl::getValue()) +/// Accepts a 4-tuple in the same form as getValue returns. +/// @see GuiTerrPreviewCtrl::getValue()) +/// /// public void fn_GuiTerrPreviewCtrl_setValue (string guiterrpreviewctrl, string tuple) @@ -8178,6 +10230,7 @@ public void fn_GuiTerrPreviewCtrl_setValue (string guiterrpreviewctrl, string tu } /// /// textEditCtrl.selectText( %startBlock, %endBlock ) ) +/// /// public void fn_GuiTextEditCtrl_selectText (string guitexteditctrl, int startBlock, int endBlock) @@ -8192,6 +10245,7 @@ public void fn_GuiTextEditCtrl_selectText (string guitexteditctrl, int startBloc } /// /// ( [tick = true] ) - This will set this object to either be processing ticks or not ) +/// /// public void fn_GuiTickCtrl_setProcessTicks (string guitickctrl, bool tick) @@ -8206,6 +10260,7 @@ public void fn_GuiTickCtrl_setProcessTicks (string guitickctrl, bool tick) } /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void fn_GuiToolboxButtonCtrl_setHoverBitmap (string guitoolboxbuttonctrl, string name) @@ -8223,6 +10278,7 @@ public void fn_GuiToolboxButtonCtrl_setHoverBitmap (string guitoolboxbuttonctrl, } /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void fn_GuiToolboxButtonCtrl_setLoweredBitmap (string guitoolboxbuttonctrl, string name) @@ -8240,6 +10296,7 @@ public void fn_GuiToolboxButtonCtrl_setLoweredBitmap (string guitoolboxbuttonctr } /// /// ( filepath name ) sets the bitmap that shows when the button is active) +/// /// public void fn_GuiToolboxButtonCtrl_setNormalBitmap (string guitoolboxbuttonctrl, string name) @@ -8257,6 +10314,7 @@ public void fn_GuiToolboxButtonCtrl_setNormalBitmap (string guitoolboxbuttonctrl } /// /// addChildSelectionByValue(TreeItemId parent, value)) +/// /// public void fn_GuiTreeViewCtrl_addChildSelectionByValue (string guitreeviewctrl, int id, string tableEntry) @@ -8274,6 +10332,7 @@ public void fn_GuiTreeViewCtrl_addChildSelectionByValue (string guitreeviewctrl, } /// /// (builds an icon table)) +/// /// public bool fn_GuiTreeViewCtrl_buildIconTable (string guitreeviewctrl, string icons) @@ -8291,6 +10350,7 @@ public bool fn_GuiTreeViewCtrl_buildIconTable (string guitreeviewctrl, string ic } /// /// Build the visible tree) +/// /// public void fn_GuiTreeViewCtrl_buildVisibleTree (string guitreeviewctrl, bool forceFullUpdate) @@ -8305,6 +10365,7 @@ public void fn_GuiTreeViewCtrl_buildVisibleTree (string guitreeviewctrl, bool fo } /// /// For internal use. ) +/// /// public void fn_GuiTreeViewCtrl_cancelRename (string guitreeviewctrl) @@ -8319,6 +10380,7 @@ public void fn_GuiTreeViewCtrl_cancelRename (string guitreeviewctrl) } /// /// () - empty tree) +/// /// public void fn_GuiTreeViewCtrl_clear (string guitreeviewctrl) @@ -8333,6 +10395,7 @@ public void fn_GuiTreeViewCtrl_clear (string guitreeviewctrl) } /// /// (TreeItemId item, string newText, string newValue)) +/// /// public bool fn_GuiTreeViewCtrl_editItem (string guitreeviewctrl, int item, string newText, string newValue) @@ -8353,6 +10416,7 @@ public bool fn_GuiTreeViewCtrl_editItem (string guitreeviewctrl, int item, strin } /// /// (TreeItemId item, bool expand=true)) +/// /// public bool fn_GuiTreeViewCtrl_expandItem (string guitreeviewctrl, int id, bool expand) @@ -8367,6 +10431,7 @@ public bool fn_GuiTreeViewCtrl_expandItem (string guitreeviewctrl, int id, bool } /// /// (find item by object id and returns the mId)) +/// /// public int fn_GuiTreeViewCtrl_findItemByObjectId (string guitreeviewctrl, int itemId) @@ -8381,6 +10446,7 @@ public int fn_GuiTreeViewCtrl_findItemByObjectId (string guitreeviewctrl, int it } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getChild (string guitreeviewctrl, int itemId) @@ -8395,6 +10461,7 @@ public int fn_GuiTreeViewCtrl_getChild (string guitreeviewctrl, int itemId) } /// /// Get id for root item.) +/// /// public int fn_GuiTreeViewCtrl_getFirstRootItem (string guitreeviewctrl) @@ -8409,6 +10476,7 @@ public int fn_GuiTreeViewCtrl_getFirstRootItem (string guitreeviewctrl) } /// /// ) +/// /// public int fn_GuiTreeViewCtrl_getItemCount (string guitreeviewctrl) @@ -8423,6 +10491,7 @@ public int fn_GuiTreeViewCtrl_getItemCount (string guitreeviewctrl) } /// /// (TreeItemId item)) +/// /// public string fn_GuiTreeViewCtrl_getItemText (string guitreeviewctrl, int index) @@ -8440,6 +10509,7 @@ public string fn_GuiTreeViewCtrl_getItemText (string guitreeviewctrl, int index) } /// /// (TreeItemId item)) +/// /// public string fn_GuiTreeViewCtrl_getItemValue (string guitreeviewctrl, int itemId) @@ -8457,6 +10527,7 @@ public string fn_GuiTreeViewCtrl_getItemValue (string guitreeviewctrl, int itemI } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getNextSibling (string guitreeviewctrl, int itemId) @@ -8471,6 +10542,7 @@ public int fn_GuiTreeViewCtrl_getNextSibling (string guitreeviewctrl, int itemId } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getParentItem (string guitreeviewctrl, int itemId) @@ -8485,6 +10557,7 @@ public int fn_GuiTreeViewCtrl_getParentItem (string guitreeviewctrl, int itemId) } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getPrevSibling (string guitreeviewctrl, int itemId) @@ -8499,6 +10572,7 @@ public int fn_GuiTreeViewCtrl_getPrevSibling (string guitreeviewctrl, int itemId } /// /// ( int index=0 ) - Return the selected item at the given index.) +/// /// public int fn_GuiTreeViewCtrl_getSelectedItem (string guitreeviewctrl, int index) @@ -8513,6 +10587,7 @@ public int fn_GuiTreeViewCtrl_getSelectedItem (string guitreeviewctrl, int index } /// /// returns a space seperated list of mulitple item ids) +/// /// public string fn_GuiTreeViewCtrl_getSelectedItemList (string guitreeviewctrl) @@ -8530,6 +10605,7 @@ public string fn_GuiTreeViewCtrl_getSelectedItemList (string guitreeviewctrl) } /// /// ) +/// /// public int fn_GuiTreeViewCtrl_getSelectedItemsCount (string guitreeviewctrl) @@ -8544,6 +10620,7 @@ public int fn_GuiTreeViewCtrl_getSelectedItemsCount (string guitreeviewctrl) } /// /// ( int index=0 ) - Return the currently selected SimObject at the given index in inspector mode or -1) +/// /// public int fn_GuiTreeViewCtrl_getSelectedObject (string guitreeviewctrl, int index) @@ -8558,6 +10635,7 @@ public int fn_GuiTreeViewCtrl_getSelectedObject (string guitreeviewctrl, int ind } /// /// Returns a space sperated list of all selected object ids.) +/// /// public string fn_GuiTreeViewCtrl_getSelectedObjectList (string guitreeviewctrl) @@ -8575,6 +10653,7 @@ public string fn_GuiTreeViewCtrl_getSelectedObjectList (string guitreeviewctrl) } /// /// (TreeItemId item,Delimiter=none) gets the text from the current node to the root, concatenating at each branch upward, with a specified delimiter optionally) +/// /// public string fn_GuiTreeViewCtrl_getTextToRoot (string guitreeviewctrl, int itemId, string delimiter) @@ -8595,6 +10674,7 @@ public string fn_GuiTreeViewCtrl_getTextToRoot (string guitreeviewctrl, int item } /// /// ( int id ) - Returns true if the given item contains child items. ) +/// /// public bool fn_GuiTreeViewCtrl_isParentItem (string guitreeviewctrl, int id) @@ -8609,6 +10689,7 @@ public bool fn_GuiTreeViewCtrl_isParentItem (string guitreeviewctrl, int id) } /// /// (TreeItemId item, bool mark=true)) +/// /// public bool fn_GuiTreeViewCtrl_markItem (string guitreeviewctrl, int id, bool mark) @@ -8623,6 +10704,7 @@ public bool fn_GuiTreeViewCtrl_markItem (string guitreeviewctrl, int id, bool ma } /// /// (TreeItemId item)) +/// /// public void fn_GuiTreeViewCtrl_moveItemDown (string guitreeviewctrl, int index) @@ -8637,6 +10719,7 @@ public void fn_GuiTreeViewCtrl_moveItemDown (string guitreeviewctrl, int index) } /// /// (TreeItemId item)) +/// /// public void fn_GuiTreeViewCtrl_moveItemUp (string guitreeviewctrl, int index) @@ -8651,6 +10734,7 @@ public void fn_GuiTreeViewCtrl_moveItemUp (string guitreeviewctrl, int index) } /// /// For internal use. ) +/// /// public void fn_GuiTreeViewCtrl_onRenameValidate (string guitreeviewctrl) @@ -8665,6 +10749,7 @@ public void fn_GuiTreeViewCtrl_onRenameValidate (string guitreeviewctrl) } /// /// (SimSet obj, bool okToEdit=true) Set the root of the tree view to the specified object, or to the root set.) +/// /// public void fn_GuiTreeViewCtrl_open (string guitreeviewctrl, string objName, bool okToEdit) @@ -8682,6 +10767,7 @@ public void fn_GuiTreeViewCtrl_open (string guitreeviewctrl, string objName, boo } /// /// removeAllChildren(TreeItemId parent)) +/// /// public void fn_GuiTreeViewCtrl_removeAllChildren (string guitreeviewctrl, int itemId) @@ -8696,6 +10782,7 @@ public void fn_GuiTreeViewCtrl_removeAllChildren (string guitreeviewctrl, int it } /// /// removeChildSelectionByValue(TreeItemId parent, value)) +/// /// public void fn_GuiTreeViewCtrl_removeChildSelectionByValue (string guitreeviewctrl, int id, string tableEntry) @@ -8713,6 +10800,7 @@ public void fn_GuiTreeViewCtrl_removeChildSelectionByValue (string guitreeviewct } /// /// (TreeItemId item)) +/// /// public bool fn_GuiTreeViewCtrl_removeItem (string guitreeviewctrl, int itemId) @@ -8727,6 +10815,7 @@ public bool fn_GuiTreeViewCtrl_removeItem (string guitreeviewctrl, int itemId) } /// /// (deselects an item)) +/// /// public void fn_GuiTreeViewCtrl_removeSelection (string guitreeviewctrl, int id) @@ -8741,6 +10830,7 @@ public void fn_GuiTreeViewCtrl_removeSelection (string guitreeviewctrl, int id) } /// /// (TreeItemId item)) +/// /// public void fn_GuiTreeViewCtrl_scrollVisible (string guitreeviewctrl, int itemId) @@ -8755,6 +10845,7 @@ public void fn_GuiTreeViewCtrl_scrollVisible (string guitreeviewctrl, int itemId } /// /// (show item by object id. returns true if sucessful.)) +/// /// public int fn_GuiTreeViewCtrl_scrollVisibleByObjectId (string guitreeviewctrl, int itemId) @@ -8769,6 +10860,7 @@ public int fn_GuiTreeViewCtrl_scrollVisibleByObjectId (string guitreeviewctrl, i } /// /// (TreeItemId item, bool select=true)) +/// /// public bool fn_GuiTreeViewCtrl_selectItem (string guitreeviewctrl, int id, bool select) @@ -8783,6 +10875,7 @@ public bool fn_GuiTreeViewCtrl_selectItem (string guitreeviewctrl, int id, bool } /// /// ( bool value=true ) - Enable/disable debug output. ) +/// /// public void fn_GuiTreeViewCtrl_setDebug (string guitreeviewctrl, bool value) @@ -8797,6 +10890,7 @@ public void fn_GuiTreeViewCtrl_setDebug (string guitreeviewctrl, bool value) } /// /// ( int id, int normalImage, int expandedImage ) - Sets the normal and expanded images to show for the given item. ) +/// /// public void fn_GuiTreeViewCtrl_setItemImages (string guitreeviewctrl, int id, sbyte normalImage, sbyte expandedImage) @@ -8811,6 +10905,7 @@ public void fn_GuiTreeViewCtrl_setItemImages (string guitreeviewctrl, int id, sb } /// /// ( int id, string text ) - Set the tooltip to show for the given item. ) +/// /// public void fn_GuiTreeViewCtrl_setItemTooltip (string guitreeviewctrl, int id, string text) @@ -8828,6 +10923,7 @@ public void fn_GuiTreeViewCtrl_setItemTooltip (string guitreeviewctrl, int id, s } /// /// ( TreeItemId id ) - Show the rename text field for the given item (only one at a time). ) +/// /// public void fn_GuiTreeViewCtrl_showItemRenameCtrl (string guitreeviewctrl, int id) @@ -8842,6 +10938,7 @@ public void fn_GuiTreeViewCtrl_showItemRenameCtrl (string guitreeviewctrl, int i } /// /// ( int parent, bool traverseHierarchy=false, bool parentsFirst=false, bool caseSensitive=true ) - Sorts all items of the given parent (or root). With 'hierarchy', traverses hierarchy. ) +/// /// public void fn_GuiTreeViewCtrl_sort (string guitreeviewctrl, int parent, bool traverseHierarchy, bool parentsFirst, bool caseSensitive) @@ -8856,6 +10953,7 @@ public void fn_GuiTreeViewCtrl_sort (string guitreeviewctrl, int parent, bool tr } /// /// loadVars( searchString ) ) +/// /// public void fn_GuiVariableInspector_loadVars (string guivariableinspector, string searchString) @@ -8872,7 +10970,15 @@ public void fn_GuiVariableInspector_loadVars (string guivariableinspector, strin SafeNativeMethods.mwle_fn_GuiVariableInspector_loadVars(sbguivariableinspector, sbsearchString); } /// -/// Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the input PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Import an image strip from exportCachedFont. Call with the +/// same parameters you called exportCachedFont. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the input PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void fn_importCachedFont (string faceName, int fontSize, string fileName, int padding, int kerning) @@ -8889,7 +10995,17 @@ public void fn_importCachedFont (string faceName, int fontSize, string fileName, SafeNativeMethods.mwle_fn_importCachedFont(sbfaceName, fontSize, sbfileName, padding, kerning); } /// -/// @brief Start a search for items at the given position and within the given radius, filtering by mask. @param pos Center position for the search @param radius Search radius @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for items at the given position and within the given radius, filtering by mask. +/// +/// @param pos Center position for the search +/// @param radius Search radius +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void fn_initContainerRadiusSearch (string pos, float radius, uint mask, bool useClientContainer) @@ -8903,7 +11019,15 @@ public void fn_initContainerRadiusSearch (string pos, float radius, uint mask, b SafeNativeMethods.mwle_fn_initContainerRadiusSearch(sbpos, radius, mask, useClientContainer); } /// -/// @brief Start a search for all items of the types specified by the bitset mask. @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for all items of the types specified by the bitset mask. +/// +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void fn_initContainerTypeSearch (uint mask, bool useClientContainer) @@ -8914,7 +11038,10 @@ public void fn_initContainerTypeSearch (uint mask, bool useClientContainer) SafeNativeMethods.mwle_fn_initContainerTypeSearch(mask, useClientContainer); } /// -/// () @brief Initializes variables that track device and vendor information/IDs @ingroup Rendering) +/// () +/// @brief Initializes variables that track device and vendor information/IDs +/// @ingroup Rendering) +/// /// public void fn_initDisplayDeviceInfo () @@ -8926,7 +11053,14 @@ public void fn_initDisplayDeviceInfo () SafeNativeMethods.mwle_fn_initDisplayDeviceInfo(); } /// -/// Test whether the character at the given position is an alpha-numeric character. Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. @see isspace @ingroup Strings ) +/// Test whether the character at the given position is an alpha-numeric character. +/// Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. +/// @see isspace +/// @ingroup Strings ) +/// /// public bool fn_isalnum (string str, int index) @@ -8940,7 +11074,9 @@ public bool fn_isalnum (string str, int index) return SafeNativeMethods.mwle_fn_isalnum(sbstr, index)>=1; } /// -/// @brief Returns true if the passed identifier is the name of a declared class. @ingroup Console) +/// @brief Returns true if the passed identifier is the name of a declared class. +/// @ingroup Console) +/// /// public bool fn_isClass (string identifier) @@ -8954,7 +11090,10 @@ public bool fn_isClass (string identifier) return SafeNativeMethods.mwle_fn_isClass(sbidentifier)>=1; } /// -/// () Returns true if the calling script is a tools script. @hide) +/// () +/// Returns true if the calling script is a tools script. +/// @hide) +/// /// public bool fn_isCurrentScriptToolScript () @@ -8966,7 +11105,10 @@ public bool fn_isCurrentScriptToolScript () return SafeNativeMethods.mwle_fn_isCurrentScriptToolScript()>=1; } /// -/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. @return True if this is a debug build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. +/// @return True if this is a debug build; false otherwise. +/// @ingroup Platform ) +/// /// public bool fn_isDebugBuild () @@ -8978,7 +11120,15 @@ public bool fn_isDebugBuild () return SafeNativeMethods.mwle_fn_isDebugBuild()>=1; } /// -/// ) , (string varName) @brief Determines if a variable exists and contains a value @param varName Name of the variable to search for @return True if the variable was defined in script, false if not @tsexample isDefined( \"$myVar\" ); @endtsexample @ingroup Scripting) +/// ) , (string varName) +/// @brief Determines if a variable exists and contains a value +/// @param varName Name of the variable to search for +/// @return True if the variable was defined in script, false if not +/// @tsexample +/// isDefined( \"$myVar\" ); +/// @endtsexample +/// @ingroup Scripting) +/// /// public bool fn_isDefined (string varName, string varValue) @@ -8996,6 +11146,7 @@ public bool fn_isDefined (string varName, string varValue) } /// /// ) +/// /// public bool fn_isDemo () @@ -9007,7 +11158,15 @@ public bool fn_isDemo () return SafeNativeMethods.mwle_fn_isDemo()>=1; } /// -/// @brief Determines if a specified directory exists or not @param directory String containing path in the form of \"foo/bar\" @return Returns true if the directory was found. @note Do not include a trailing slash '/'. @ingroup FileSystem) +/// @brief Determines if a specified directory exists or not +/// +/// @param directory String containing path in the form of \"foo/bar\" +/// @return Returns true if the directory was found. +/// +/// @note Do not include a trailing slash '/'. +/// +/// @ingroup FileSystem) +/// /// public bool fn_IsDirectory (string directory) @@ -9022,6 +11181,7 @@ public bool fn_IsDirectory (string directory) } /// /// isEventPending(%scheduleId);) +/// /// public bool fn_isEventPending (int scheduleId) @@ -9032,7 +11192,13 @@ public bool fn_isEventPending (int scheduleId) return SafeNativeMethods.mwle_fn_isEventPending(scheduleId)>=1; } /// -/// @brief Determines if the specified file exists or not @param fileName The path to the file. @return Returns true if the file was found. @ingroup FileSystem) +/// @brief Determines if the specified file exists or not +/// +/// @param fileName The path to the file. +/// @return Returns true if the file was found. +/// +/// @ingroup FileSystem) +/// /// public bool fn_isFile (string fileName) @@ -9046,7 +11212,12 @@ public bool fn_isFile (string fileName) return SafeNativeMethods.mwle_fn_isFile(sbfileName)>=1; } /// -/// (string funcName) @brief Determines if a function exists or not @param funcName String containing name of the function @return True if the function exists, false if not @ingroup Scripting) +/// (string funcName) +/// @brief Determines if a function exists or not +/// @param funcName String containing name of the function +/// @return True if the function exists, false if not +/// @ingroup Scripting) +/// /// public bool fn_isFunction (string funcName) @@ -9061,6 +11232,7 @@ public bool fn_isFunction (string funcName) } /// /// isJoystickDetected()) +/// /// public bool fn_isJoystickDetected () @@ -9072,7 +11244,11 @@ public bool fn_isJoystickDetected () return SafeNativeMethods.mwle_fn_isJoystickDetected()>=1; } /// -/// () @brief Queries input manager to see if a joystick is enabled @return 1 if a joystick exists and is enabled, 0 if it's not. @ingroup Input) +/// () +/// @brief Queries input manager to see if a joystick is enabled +/// @return 1 if a joystick exists and is enabled, 0 if it's not. +/// @ingroup Input) +/// /// public bool fn_isJoystickEnabled () @@ -9085,6 +11261,7 @@ public bool fn_isJoystickEnabled () } /// /// isKoreanBuild()) +/// /// public bool fn_isKoreanBuild () @@ -9096,7 +11273,12 @@ public bool fn_isKoreanBuild () return SafeNativeMethods.mwle_fn_isKoreanBuild()>=1; } /// -/// @brief Returns true if the class is derived from the super class. If either class doesn't exist this returns false. @param className The class name. @param superClassName The super class to look for. @ingroup Console) +/// @brief Returns true if the class is derived from the super class. +/// If either class doesn't exist this returns false. +/// @param className The class name. +/// @param superClassName The super class to look for. +/// @ingroup Console) +/// /// public bool fn_isMemberOfClass (string className, string superClassName) @@ -9113,7 +11295,13 @@ public bool fn_isMemberOfClass (string className, string superClassName) return SafeNativeMethods.mwle_fn_isMemberOfClass(sbclassName, sbsuperClassName)>=1; } /// -/// (string namespace, string method) @brief Determines if a class/namespace method exists @param namespace Class or namespace, such as Player @param method Name of the function to search for @return True if the method exists, false if not @ingroup Scripting) +/// (string namespace, string method) +/// @brief Determines if a class/namespace method exists +/// @param namespace Class or namespace, such as Player +/// @param method Name of the function to search for +/// @return True if the method exists, false if not +/// @ingroup Scripting) +/// /// public bool fn_isMethod (string nameSpace, string method) @@ -9131,6 +11319,7 @@ public bool fn_isMethod (string nameSpace, string method) } /// /// isObject(object)) +/// /// public bool fn_isObject (string objectName) @@ -9160,7 +11349,11 @@ public bool fn_isPackage (string identifier) return SafeNativeMethods.mwle_fn_isPackage(sbidentifier)>=1; } /// -/// (string queueName) @brief Determines if a dispatcher queue exists @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Determines if a dispatcher queue exists +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public bool fn_isQueueRegistered (string queueName) @@ -9174,7 +11367,10 @@ public bool fn_isQueueRegistered (string queueName) return SafeNativeMethods.mwle_fn_isQueueRegistered(sbqueueName)>=1; } /// -/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. @return True if this is a shipping build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. +/// @return True if this is a shipping build; false otherwise. +/// @ingroup Platform ) +/// /// public bool fn_isShippingBuild () @@ -9186,7 +11382,14 @@ public bool fn_isShippingBuild () return SafeNativeMethods.mwle_fn_isShippingBuild()>=1; } /// -/// Test whether the character at the given position is a whitespace character. Characters such as tab, space, or newline are considered whitespace. @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is a whitespace character; false otherwise. @see isalnum @ingroup Strings ) +/// Test whether the character at the given position is a whitespace character. +/// Characters such as tab, space, or newline are considered whitespace. +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is a whitespace character; false otherwise. +/// @see isalnum +/// @ingroup Strings ) +/// /// public bool fn_isspace (string str, int index) @@ -9200,7 +11403,10 @@ public bool fn_isspace (string str, int index) return SafeNativeMethods.mwle_fn_isspace(sbstr, index)>=1; } /// -/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. @return True if this is a tool build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. +/// @return True if this is a tool build; false otherwise. +/// @ingroup Platform ) +/// /// public bool fn_isToolBuild () @@ -9212,7 +11418,12 @@ public bool fn_isToolBuild () return SafeNativeMethods.mwle_fn_isToolBuild()>=1; } /// -/// ( string name ) @brief Return true if the given name makes for a valid object name. @param name Name of object @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character @ingroup Console) +/// ( string name ) +/// @brief Return true if the given name makes for a valid object name. +/// @param name Name of object +/// @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character +/// @ingroup Console) +/// /// public bool fn_isValidObjectName (string name) @@ -9227,6 +11438,7 @@ public bool fn_isValidObjectName (string name) } /// /// ) +/// /// public bool fn_isWebDemo () @@ -9238,7 +11450,13 @@ public bool fn_isWebDemo () return SafeNativeMethods.mwle_fn_isWebDemo()>=1; } /// -/// @brief Determines if a file name can be written to using File I/O @param fileName Name and path of file to check @return Returns true if the file can be written to. @ingroup FileSystem) +/// @brief Determines if a file name can be written to using File I/O +/// +/// @param fileName Name and path of file to check +/// @return Returns true if the file can be written to. +/// +/// @ingroup FileSystem) +/// /// public bool fn_isWriteableFileName (string fileName) @@ -9252,7 +11470,13 @@ public bool fn_isWriteableFileName (string fileName) return SafeNativeMethods.mwle_fn_isWriteableFileName(sbfileName)>=1; } /// -/// ( int controllerID ) @brief Checks to see if an Xbox 360 controller is connected @param controllerID Zero-based index of the controller to check. @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput hasn't been initialized. @ingroup Input) +/// ( int controllerID ) +/// @brief Checks to see if an Xbox 360 controller is connected +/// @param controllerID Zero-based index of the controller to check. +/// @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput +/// hasn't been initialized. +/// @ingroup Input) +/// /// public bool fn_isXInputConnected (int controllerID) @@ -9263,7 +11487,14 @@ public bool fn_isXInputConnected (int controllerID) return SafeNativeMethods.mwle_fn_isXInputConnected(controllerID)>=1; } /// -/// , ), (string filename, [string languageName]) @brief Adds a language to the table @param filename Name and path to the language file @param languageName Optional name to assign to the new language entry @return True If file was successfully found and language created ) +/// , ), +/// (string filename, [string languageName]) +/// @brief Adds a language to the table +/// @param filename Name and path to the language file +/// @param languageName Optional name to assign to the new language entry +/// @return True If file was successfully found and language created +/// ) +/// /// public int fn_LangTable_addLanguage (string langtable, string filename, string languageName) @@ -9283,7 +11514,10 @@ public int fn_LangTable_addLanguage (string langtable, string filename, string l return SafeNativeMethods.mwle_fn_LangTable_addLanguage(sblangtable, sbfilename, sblanguageName); } /// -/// () @brief Get the ID of the current language table @return Numerical ID of the current language table) +/// () +/// @brief Get the ID of the current language table +/// @return Numerical ID of the current language table) +/// /// public int fn_LangTable_getCurrentLanguage (string langtable) @@ -9297,7 +11531,11 @@ public int fn_LangTable_getCurrentLanguage (string langtable) return SafeNativeMethods.mwle_fn_LangTable_getCurrentLanguage(sblangtable); } /// -/// (int language) @brief Return the readable name of the language table @param language Numerical ID of the language table to access @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// (int language) +/// @brief Return the readable name of the language table +/// @param language Numerical ID of the language table to access +/// @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// /// public string fn_LangTable_getLangName (string langtable, int langId) @@ -9314,7 +11552,10 @@ public string fn_LangTable_getLangName (string langtable, int langId) } /// -/// () @brief Used to find out how many languages are in the table @return Size of the vector containing the languages, numerical) +/// () +/// @brief Used to find out how many languages are in the table +/// @return Size of the vector containing the languages, numerical) +/// /// public int fn_LangTable_getNumLang (string langtable) @@ -9328,7 +11569,13 @@ public int fn_LangTable_getNumLang (string langtable) return SafeNativeMethods.mwle_fn_LangTable_getNumLang(sblangtable); } /// -/// (string filename) @brief Grabs a string from the specified table If an invalid is passed, the function will attempt to to grab from the default table @param filename Name of the language table to access @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// (string filename) +/// @brief Grabs a string from the specified table +/// If an invalid is passed, the function will attempt to +/// to grab from the default table +/// @param filename Name of the language table to access +/// @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// /// public string fn_LangTable_getString (string langtable, uint id) @@ -9345,7 +11592,10 @@ public string fn_LangTable_getString (string langtable, uint id) } /// -/// (int language) @brief Sets the current language table for grabbing text @param language ID of the table) +/// (int language) +/// @brief Sets the current language table for grabbing text +/// @param language ID of the table) +/// /// public void fn_LangTable_setCurrentLanguage (string langtable, int langId) @@ -9359,7 +11609,10 @@ public void fn_LangTable_setCurrentLanguage (string langtable, int langId) SafeNativeMethods.mwle_fn_LangTable_setCurrentLanguage(sblangtable, langId); } /// -/// (int language) @brief Sets the default language table @param language ID of the table) +/// (int language) +/// @brief Sets the default language table +/// @param language ID of the table) +/// /// public void fn_LangTable_setDefaultLanguage (string langtable, int langId) @@ -9374,6 +11627,7 @@ public void fn_LangTable_setDefaultLanguage (string langtable, int langId) } /// /// Stops the light animation. ) +/// /// public void fn_LightBase_pauseAnimation (string lightbase) @@ -9387,7 +11641,11 @@ public void fn_LightBase_pauseAnimation (string lightbase) SafeNativeMethods.mwle_fn_LightBase_pauseAnimation(sblightbase); } /// -/// ), ( [LightAnimData anim] )\t Plays a light animation on the light. If no LightAnimData is passed the existing one is played. @hide) +/// ), ( [LightAnimData anim] )\t +/// Plays a light animation on the light. If no LightAnimData is passed the +/// existing one is played. +/// @hide) +/// /// public void fn_LightBase_playAnimation (string lightbase, string anim) @@ -9404,7 +11662,15 @@ public void fn_LightBase_playAnimation (string lightbase, string anim) SafeNativeMethods.mwle_fn_LightBase_playAnimation(sblightbase, sbanim); } /// -/// Will generate static lighting for the scene if supported by the active light manager. If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps will be regenerated only if the lighting cache files can be written. @param completeCallbackFn The name of the function to execute when the lighting is complete. @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". @return Returns true if the scene lighting process was started. @ingroup Lighting ) +/// Will generate static lighting for the scene if supported by the active light manager. +/// If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether +/// lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps +/// will be regenerated only if the lighting cache files can be written. +/// @param completeCallbackFn The name of the function to execute when the lighting is complete. +/// @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". +/// @return Returns true if the scene lighting process was started. +/// @ingroup Lighting ) +/// /// public bool fn_lightScene (string completeCallbackFn, string mode) @@ -9421,7 +11687,10 @@ public bool fn_lightScene (string completeCallbackFn, string mode) return SafeNativeMethods.mwle_fn_lightScene(sbcompleteCallbackFn, sbmode)>=1; } /// -/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void fn_listGFXResources (bool unflaggedOnly) @@ -9432,7 +11701,29 @@ public void fn_listGFXResources (bool unflaggedOnly) SafeNativeMethods.mwle_fn_listGFXResources(unflaggedOnly); } /// -/// , ), (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) Load all light instances from a COLLADA (.dae) file and add to the scene. @param filename COLLADA filename to load lights from @param parentGroup (optional) name of an existing simgroup to add the new lights to (defaults to MissionGroup) @param baseObject (optional) name of an object to use as the origin (useful if you are loading the lights for a collada scene and have moved or rotated the geometry) @return true if successful, false otherwise @tsexample // load the lights in room.dae loadColladaLights( \"art/shapes/collada/room.dae\" ); // load the lights in room.dae and add them to the RoomLights group loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); // load the lights in room.dae and use the transform of the \"Room\" object as the origin loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); @endtsexample @note Currently for editor use only @ingroup Editors @internal) +/// , ), +/// (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) +/// Load all light instances from a COLLADA (.dae) file and add to the scene. +/// @param filename COLLADA filename to load lights from +/// @param parentGroup (optional) name of an existing simgroup to add the new +/// lights to (defaults to MissionGroup) +/// @param baseObject (optional) name of an object to use as the origin (useful +/// if you are loading the lights for a collada scene and have moved or rotated +/// the geometry) +/// @return true if successful, false otherwise +/// @tsexample +/// // load the lights in room.dae +/// loadColladaLights( \"art/shapes/collada/room.dae\" ); +/// // load the lights in room.dae and add them to the RoomLights group +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); +/// // load the lights in room.dae and use the transform of the \"Room\" +/// object as the origin +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); +/// @endtsexample +/// @note Currently for editor use only +/// @ingroup Editors +/// @internal) +/// /// public bool fn_loadColladaLights (string filename, string parentGroup, string baseObject) @@ -9452,7 +11743,10 @@ public bool fn_loadColladaLights (string filename, string parentGroup, string ba return SafeNativeMethods.mwle_fn_loadColladaLights(sbfilename, sbparentGroup, sbbaseObject)>=1; } /// -/// @brief Loads a serialized object from a file. @param Name and path to text file containing the object @ingroup Console) +/// @brief Loads a serialized object from a file. +/// @param Name and path to text file containing the object +/// @ingroup Console) +/// /// public string fn_loadObject (string filename) @@ -9469,7 +11763,11 @@ public string fn_loadObject (string filename) } /// -/// (bool isLocked) @brief Lock or unlock the mouse to the window. When true, prevents the mouse from leaving the bounds of the game window. @ingroup Input) +/// (bool isLocked) +/// @brief Lock or unlock the mouse to the window. +/// When true, prevents the mouse from leaving the bounds of the game window. +/// @ingroup Input) +/// /// public void fn_lockMouse (bool isLocked) @@ -9534,7 +11832,16 @@ public void fn_logWarning (string message) SafeNativeMethods.mwle_fn_logWarning(sbmessage); } /// -/// Remove leading whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. @tsexample ltrim( \" string \" ); // Returns \"string \". @endtsexample @see rtrim @see trim @ingroup Strings ) +/// Remove leading whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. +/// @tsexample +/// ltrim( \" string \" ); // Returns \"string \". +/// @endtsexample +/// @see rtrim +/// @see trim +/// @ingroup Strings ) +/// /// public string fn_ltrim (string str) @@ -9551,7 +11858,10 @@ public string fn_ltrim (string str) } /// -/// Return the value of 2*PI (full-circle in radians). @returns The value of 2*PI. @ingroup Math ) +/// Return the value of 2*PI (full-circle in radians). +/// @returns The value of 2*PI. +/// @ingroup Math ) +/// /// public float fn_m2Pi () @@ -9563,7 +11873,11 @@ public float fn_m2Pi () return SafeNativeMethods.mwle_fn_m2Pi(); } /// -/// Calculate absolute value of specified value. @param v Input Value. @returns Absolute value of specified value. @ingroup Math ) +/// Calculate absolute value of specified value. +/// @param v Input Value. +/// @returns Absolute value of specified value. +/// @ingroup Math ) +/// /// public float fn_mAbs (float v) @@ -9574,7 +11888,11 @@ public float fn_mAbs (float v) return SafeNativeMethods.mwle_fn_mAbs(v); } /// -/// Calculate the arc-cosine of v. @param v Input Value (in radians). @returns The arc-cosine of the input value. @ingroup Math ) +/// Calculate the arc-cosine of v. +/// @param v Input Value (in radians). +/// @returns The arc-cosine of the input value. +/// @ingroup Math ) +/// /// public float fn_mAcos (float v) @@ -9585,7 +11903,15 @@ public float fn_mAcos (float v) return SafeNativeMethods.mwle_fn_mAcos(v); } /// -/// ), @brief Converts a relative file path to a full path For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" @param path Name of file or path to check @param cwd Optional current working directory from which to build the full path. @return String containing non-relative directory of path @ingroup FileSystem) +/// ), +/// @brief Converts a relative file path to a full path +/// +/// For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" +/// @param path Name of file or path to check +/// @param cwd Optional current working directory from which to build the full path. +/// @return String containing non-relative directory of path +/// @ingroup FileSystem) +/// /// public string fn_makeFullPath (string path, string cwd) @@ -9605,7 +11931,16 @@ public string fn_makeFullPath (string path, string cwd) } /// -/// ), @brief Turns a full or local path to a relative one For example, \"./game/art\" becomes \"game/art\" @param path Full path (may include a file) to convert @param to Optional base path used for the conversion. If not supplied the current working directory is used. @returns String containing relative path @ingroup FileSystem) +/// ), +/// @brief Turns a full or local path to a relative one +/// +/// For example, \"./game/art\" becomes \"game/art\" +/// @param path Full path (may include a file) to convert +/// @param to Optional base path used for the conversion. If not supplied the current +/// working directory is used. +/// @returns String containing relative path +/// @ingroup FileSystem) +/// /// public string fn_makeRelativePath (string path, string to) @@ -9625,7 +11960,11 @@ public string fn_makeRelativePath (string path, string to) } /// -/// Calculate the arc-sine of v. @param v Input Value (in radians). @returns The arc-sine of the input value. @ingroup Math ) +/// Calculate the arc-sine of v. +/// @param v Input Value (in radians). +/// @returns The arc-sine of the input value. +/// @ingroup Math ) +/// /// public float fn_mAsin (float v) @@ -9636,7 +11975,12 @@ public float fn_mAsin (float v) return SafeNativeMethods.mwle_fn_mAsin(v); } /// -/// Calculate the arc-tangent (slope) of a line defined by rise and run. @param rise of line. @param run of line. @returns The arc-tangent (slope) of a line defined by rise and run. @ingroup Math ) +/// Calculate the arc-tangent (slope) of a line defined by rise and run. +/// @param rise of line. +/// @param run of line. +/// @returns The arc-tangent (slope) of a line defined by rise and run. +/// @ingroup Math ) +/// /// public float fn_mAtan (float rise, float run) @@ -9648,6 +11992,7 @@ public float fn_mAtan (float rise, float run) } /// /// Dumps a formatted list of the currently allocated material instances for this material to the console. ) +/// /// public void fn_Material_dumpInstances (string material) @@ -9662,6 +12007,7 @@ public void fn_Material_dumpInstances (string material) } /// /// Flushes all material instances that use this material. ) +/// /// public void fn_Material_flush (string material) @@ -9676,6 +12022,7 @@ public void fn_Material_flush (string material) } /// /// ) +/// /// public string fn_Material_getAnimFlags (string material, uint id) @@ -9693,6 +12040,7 @@ public string fn_Material_getAnimFlags (string material, uint id) } /// /// Get filename of material) +/// /// public string fn_Material_getFilename (string material) @@ -9710,6 +12058,7 @@ public string fn_Material_getFilename (string material) } /// /// Returns true if this Material was automatically generated by MaterialList::mapMaterials() ) +/// /// public bool fn_Material_isAutoGenerated (string material) @@ -9724,6 +12073,7 @@ public bool fn_Material_isAutoGenerated (string material) } /// /// Reloads all material instances that use this material. ) +/// /// public void fn_Material_reload (string material) @@ -9738,6 +12088,7 @@ public void fn_Material_reload (string material) } /// /// setAutoGenerated(bool isAutoGenerated): Set whether or not the Material is autogenerated. ) +/// /// public void fn_Material_setAutoGenerated (string material, bool isAutoGenerated) @@ -9751,7 +12102,12 @@ public void fn_Material_setAutoGenerated (string material, bool isAutoGenerated) SafeNativeMethods.mwle_fn_Material_setAutoGenerated(sbmaterial, isAutoGenerated); } /// -/// Create a transform from the given translation and orientation. @param position The translation vector for the transform. @param orientation The axis and rotation that orients the transform. @return A transform based on the given position and orientation. @ingroup Matrices ) +/// Create a transform from the given translation and orientation. +/// @param position The translation vector for the transform. +/// @param orientation The axis and rotation that orients the transform. +/// @return A transform based on the given position and orientation. +/// @ingroup Matrices ) +/// /// public string fn_MatrixCreate (string position, string orientation) @@ -9771,7 +12127,11 @@ public string fn_MatrixCreate (string position, string orientation) } /// -/// @Create a matrix from the given rotations. @param Vector3F X, Y, and Z rotation in *radians*. @return A transform based on the given orientation. @ingroup Matrices ) +/// @Create a matrix from the given rotations. +/// @param Vector3F X, Y, and Z rotation in *radians*. +/// @return A transform based on the given orientation. +/// @ingroup Matrices ) +/// /// public string fn_MatrixCreateFromEuler (string angles) @@ -9788,7 +12148,13 @@ public string fn_MatrixCreateFromEuler (string angles) } /// -/// @brief Multiply the given point by the given transform assuming that w=1. This function will multiply the given vector such that translation with take effect. @param transform A transform. @param point A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the given point by the given transform assuming that w=1. +/// This function will multiply the given vector such that translation with take effect. +/// @param transform A transform. +/// @param point A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public string fn_MatrixMulPoint (string transform, string point) @@ -9808,7 +12174,12 @@ public string fn_MatrixMulPoint (string transform, string point) } /// -/// @brief Multiply the two matrices. @param left First transform. @param right Right transform. @return Concatenation of the two transforms. @ingroup Matrices ) +/// @brief Multiply the two matrices. +/// @param left First transform. +/// @param right Right transform. +/// @return Concatenation of the two transforms. +/// @ingroup Matrices ) +/// /// public string fn_MatrixMultiply (string left, string right) @@ -9828,7 +12199,14 @@ public string fn_MatrixMultiply (string left, string right) } /// -/// @brief Multiply the vector by the transform assuming that w=0. This function will multiply the given vector by the given transform such that translation will not affect the vector. @param transform A transform. @param vector A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the vector by the transform assuming that w=0. +/// This function will multiply the given vector by the given transform such that translation will +/// not affect the vector. +/// @param transform A transform. +/// @param vector A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public string fn_MatrixMulVector (string transform, string vector) @@ -9848,7 +12226,11 @@ public string fn_MatrixMulVector (string transform, string vector) } /// -/// Round v up to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v up to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int fn_mCeil (float v) @@ -9859,7 +12241,13 @@ public int fn_mCeil (float v) return SafeNativeMethods.mwle_fn_mCeil(v); } /// -/// Clamp the specified value between two bounds. @param v Input value. @param min Minimum Bound. @param max Maximum Bound. @returns The specified value clamped to the specified bounds. @ingroup Math ) +/// Clamp the specified value between two bounds. +/// @param v Input value. +/// @param min Minimum Bound. +/// @param max Maximum Bound. +/// @returns The specified value clamped to the specified bounds. +/// @ingroup Math ) +/// /// public float fn_mClamp (float v, float min, float max) @@ -9870,7 +12258,11 @@ public float fn_mClamp (float v, float min, float max) return SafeNativeMethods.mwle_fn_mClamp(v, min, max); } /// -/// Calculate the cosine of v. @param v Input Value (in radians). @returns The cosine of the input value. @ingroup Math ) +/// Calculate the cosine of v. +/// @param v Input Value (in radians). +/// @returns The cosine of the input value. +/// @ingroup Math ) +/// /// public float fn_mCos (float v) @@ -9881,7 +12273,11 @@ public float fn_mCos (float v) return SafeNativeMethods.mwle_fn_mCos(v); } /// -/// Convert specified degrees into radians. @param degrees Input Value (in degrees). @returns The specified degrees value converted to radians. @ingroup Math ) +/// Convert specified degrees into radians. +/// @param degrees Input Value (in degrees). +/// @returns The specified degrees value converted to radians. +/// @ingroup Math ) +/// /// public float fn_mDegToRad (float degrees) @@ -9893,6 +12289,7 @@ public float fn_mDegToRad (float degrees) } /// /// ( SimObject obj )) +/// /// public void fn_MECreateUndoAction_addObject (string mecreateundoaction, string obj) @@ -9910,6 +12307,7 @@ public void fn_MECreateUndoAction_addObject (string mecreateundoaction, string o } /// /// ( SimObject obj )) +/// /// public void fn_MEDeleteUndoAction_deleteObject (string medeleteundoaction, string obj) @@ -9927,6 +12325,7 @@ public void fn_MEDeleteUndoAction_deleteObject (string medeleteundoaction, strin } /// /// (GuiCanvas, pos)) +/// /// public void fn_MenuBar_attachToCanvas (string menubar, string canvas, int pos) @@ -9944,6 +12343,7 @@ public void fn_MenuBar_attachToCanvas (string menubar, string canvas, int pos) } /// /// (object, pos) insert object at position) +/// /// public void fn_MenuBar_insert (string menubar, string pObject, int pos) @@ -9961,6 +12361,7 @@ public void fn_MenuBar_insert (string menubar, string pObject, int pos) } /// /// ()) +/// /// public void fn_MenuBar_removeFromCanvas (string menubar) @@ -9975,6 +12376,7 @@ public void fn_MenuBar_removeFromCanvas (string menubar) } /// /// () Increment the reference count for this message) +/// /// public void fn_Message_addReference (string message) @@ -9989,6 +12391,7 @@ public void fn_Message_addReference (string message) } /// /// () Decrement the reference count for this message) +/// /// public void fn_Message_freeReference (string message) @@ -10003,6 +12406,7 @@ public void fn_Message_freeReference (string message) } /// /// () Get message type (script class name or C++ class name if no script defined class)) +/// /// public string fn_Message_getType (string message) @@ -10019,7 +12423,16 @@ public string fn_Message_getType (string message) } /// -/// Display a modal message box using the platform's native message box implementation. @param title The title to display on the message box window. @param message The text message to display in the box. @param buttons Which buttons to put on the message box. @param icons Which icon to show next to the message. @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. @tsexample messageBox( \"Error\", \"\" ); @endtsexample @ingroup Platform ) +/// Display a modal message box using the platform's native message box implementation. +/// @param title The title to display on the message box window. +/// @param message The text message to display in the box. +/// @param buttons Which buttons to put on the message box. +/// @param icons Which icon to show next to the message. +/// @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. +/// @tsexample +/// messageBox( \"Error\", \"\" ); @endtsexample +/// @ingroup Platform ) +/// /// public int fn_messageBox (string title, string message, int buttons, int icons) @@ -10036,7 +12449,10 @@ public int fn_messageBox (string title, string message, int buttons, int icons) return SafeNativeMethods.mwle_fn_messageBox(sbtitle, sbmessage, buttons, icons); } /// -/// ), (string filename, string header=NULL) Dump the message vector to a file, optionally prefixing a header. @hide) +/// ), (string filename, string header=NULL) +/// Dump the message vector to a file, optionally prefixing a header. +/// @hide) +/// /// public void fn_MessageVector_dump (string messagevector, string filename, string header) @@ -10056,7 +12472,12 @@ public void fn_MessageVector_dump (string messagevector, string filename, string SafeNativeMethods.mwle_fn_MessageVector_dump(sbmessagevector, sbfilename, sbheader); } /// -/// Formats the specified number to the given number of decimal places. @param v Number to format. @param precision Number of decimal places to format to (1-9). @returns Number formatted to the specified number of decimal places. @ingroup Math ) +/// Formats the specified number to the given number of decimal places. +/// @param v Number to format. +/// @param precision Number of decimal places to format to (1-9). +/// @returns Number formatted to the specified number of decimal places. +/// @ingroup Math ) +/// /// public string fn_mFloatLength (float v, uint precision) @@ -10070,7 +12491,11 @@ public string fn_mFloatLength (float v, uint precision) } /// -/// Round v down to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v down to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int fn_mFloor (float v) @@ -10081,7 +12506,12 @@ public int fn_mFloor (float v) return SafeNativeMethods.mwle_fn_mFloor(v); } /// -/// Calculate the remainder of v/d. @param v Input Value. @param d Divisor Value. @returns The remainder of v/d. @ingroup Math ) +/// Calculate the remainder of v/d. +/// @param v Input Value. +/// @param d Divisor Value. +/// @returns The remainder of v/d. +/// @ingroup Math ) +/// /// public float fn_mFMod (float v, float d) @@ -10092,7 +12522,11 @@ public float fn_mFMod (float v, float d) return SafeNativeMethods.mwle_fn_mFMod(v, d); } /// -/// Returns whether the value is an exact power of two. @param v Input value. @returns Whether the specified value is an exact power of two. @ingroup Math ) +/// Returns whether the value is an exact power of two. +/// @param v Input value. +/// @returns Whether the specified value is an exact power of two. +/// @ingroup Math ) +/// /// public bool fn_mIsPow2 (int v) @@ -10103,7 +12537,13 @@ public bool fn_mIsPow2 (int v) return SafeNativeMethods.mwle_fn_mIsPow2(v)>=1; } /// -/// Calculate linearly interpolated value between two specified numbers using specified normalized time. @param v1 Interpolate From Input value. @param v2 Interpolate To Input value. @param time Normalized time used to interpolate values (0-1). @returns The interpolated value between the two specified values at normalized time t. @ingroup Math ) +/// Calculate linearly interpolated value between two specified numbers using specified normalized time. +/// @param v1 Interpolate From Input value. +/// @param v2 Interpolate To Input value. +/// @param time Normalized time used to interpolate values (0-1). +/// @returns The interpolated value between the two specified values at normalized time t. +/// @ingroup Math ) +/// /// public float fn_mLerp (float v1, float v2, float time) @@ -10114,7 +12554,11 @@ public float fn_mLerp (float v1, float v2, float time) return SafeNativeMethods.mwle_fn_mLerp(v1, v2, time); } /// -/// Calculate the natural logarithm of v. @param v Input Value. @returns The natural logarithm of the input value. @ingroup Math ) +/// Calculate the natural logarithm of v. +/// @param v Input Value. +/// @returns The natural logarithm of the input value. +/// @ingroup Math ) +/// /// public float fn_mLog (float v) @@ -10125,7 +12569,10 @@ public float fn_mLog (float v) return SafeNativeMethods.mwle_fn_mLog(v); } /// -/// Return the value of PI (half-circle in radians). @returns The value of PI. @ingroup Math ) +/// Return the value of PI (half-circle in radians). +/// @returns The value of PI. +/// @ingroup Math ) +/// /// public float fn_mPi () @@ -10137,7 +12584,12 @@ public float fn_mPi () return SafeNativeMethods.mwle_fn_mPi(); } /// -/// Calculate b raised to the p-th power. @param v Input Value. @param p Power to raise value by. @returns v raised to the p-th power. @ingroup Math ) +/// Calculate b raised to the p-th power. +/// @param v Input Value. +/// @param p Power to raise value by. +/// @returns v raised to the p-th power. +/// @ingroup Math ) +/// /// public float fn_mPow (float v, float p) @@ -10148,7 +12600,11 @@ public float fn_mPow (float v, float p) return SafeNativeMethods.mwle_fn_mPow(v, p); } /// -/// Convert specified radians into degrees. @param radians Input Value (in radians). @returns The specified radians value converted to degrees. @ingroup Math ) +/// Convert specified radians into degrees. +/// @param radians Input Value (in radians). +/// @returns The specified radians value converted to degrees. +/// @ingroup Math ) +/// /// public float fn_mRadToDeg (float radians) @@ -10159,7 +12615,12 @@ public float fn_mRadToDeg (float radians) return SafeNativeMethods.mwle_fn_mRadToDeg(radians); } /// -/// Round v to the nth decimal place or the nearest whole number by default. @param v Value to roundn @param n Number of decimal places to round to, 0 by defaultn @return The rounded value as a S32. @ingroup Math ) +/// Round v to the nth decimal place or the nearest whole number by default. +/// @param v Value to roundn +/// @param n Number of decimal places to round to, 0 by defaultn +/// @return The rounded value as a S32. +/// @ingroup Math ) +/// /// public float fn_mRound (float v, int n) @@ -10170,7 +12631,11 @@ public float fn_mRound (float v, int n) return SafeNativeMethods.mwle_fn_mRound(v, n); } /// -/// Clamp the specified value between 0 and 1 (inclusive). @param v Input value. @returns The specified value clamped between 0 and 1 (inclusive). @ingroup Math ) +/// Clamp the specified value between 0 and 1 (inclusive). +/// @param v Input value. +/// @returns The specified value clamped between 0 and 1 (inclusive). +/// @ingroup Math ) +/// /// public float fn_mSaturate (float v) @@ -10181,7 +12646,11 @@ public float fn_mSaturate (float v) return SafeNativeMethods.mwle_fn_mSaturate(v); } /// -/// Calculate the sine of v. @param v Input Value (in radians). @returns The sine of the input value. @ingroup Math ) +/// Calculate the sine of v. +/// @param v Input Value (in radians). +/// @returns The sine of the input value. +/// @ingroup Math ) +/// /// public float fn_mSin (float v) @@ -10192,7 +12661,15 @@ public float fn_mSin (float v) return SafeNativeMethods.mwle_fn_mSin(v); } /// -/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. @ingroup Math ) +/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions +/// (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. +/// @ingroup Math ) +/// /// public string fn_mSolveCubic (float a, float b, float c, float d) @@ -10206,7 +12683,14 @@ public string fn_mSolveCubic (float a, float b, float c, float d) } /// -/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. @ingroup Math ) +/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions +/// (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. +/// @ingroup Math ) +/// /// public string fn_mSolveQuadratic (float a, float b, float c) @@ -10220,7 +12704,16 @@ public string fn_mSolveQuadratic (float a, float b, float c) } /// -/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @param e Fifth Coefficient. @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. @ingroup Math ) +/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @param e Fifth Coefficient. +/// @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions +/// (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. +/// @ingroup Math ) +/// /// public string fn_mSolveQuartic (float a, float b, float c, float d, float e) @@ -10234,7 +12727,11 @@ public string fn_mSolveQuartic (float a, float b, float c, float d, float e) } /// -/// Calculate the square-root of v. @param v Input Value. @returns The square-root of the input value. @ingroup Math ) +/// Calculate the square-root of v. +/// @param v Input Value. +/// @returns The square-root of the input value. +/// @ingroup Math ) +/// /// public float fn_mSqrt (float v) @@ -10245,7 +12742,11 @@ public float fn_mSqrt (float v) return SafeNativeMethods.mwle_fn_mSqrt(v); } /// -/// Calculate the tangent of v. @param v Input Value (in radians). @returns The tangent of the input value. @ingroup Math ) +/// Calculate the tangent of v. +/// @param v Input Value (in radians). +/// @returns The tangent of the input value. +/// @ingroup Math ) +/// /// public float fn_mTan (float v) @@ -10257,6 +12758,7 @@ public float fn_mTan (float v) } /// /// nameToID(object)) +/// /// public int fn_nameToID (string objectName) @@ -10270,17 +12772,44 @@ public int fn_nameToID (string objectName) return SafeNativeMethods.mwle_fn_nameToID(sbobjectName); } /// -/// ( string str, string token, string delimiters ) Tokenize a string using a set of delimiting characters. This function first skips all leading charaters in @a str that are contained in @a delimiters. From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str until the function returns \"\". @param str A string. @param token The name of the variable in which to store the current token. This variable is set in the scope in which nextToken is called. @param delimiters A string of characters. Each character is considered a delimiter. @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. @tsexample // Prints: // a // b // c %str = \"a b c\"; while ( %str !$= \"\" ) { // First time, stores \"a\" in the variable %token and sets %str to \"b c\". %str = nextToken( %str, \"token\", \" \" ); echo( %token ); } @endtsexample @ingroup Strings ) +/// ( string str, string token, string delimiters ) +/// Tokenize a string using a set of delimiting characters. +/// This function first skips all leading charaters in @a str that are contained in @a delimiters. +/// From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters +/// from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it +/// skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. +/// To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str +/// until the function returns \"\". +/// @param str A string. +/// @param token The name of the variable in which to store the current token. This variable is set in the +/// scope in which nextToken is called. +/// @param delimiters A string of characters. Each character is considered a delimiter. +/// @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. +/// @tsexample +/// // Prints: +/// // a +/// // b +/// // c +/// %str = \"a b c\"; +/// while ( %str !$= \"\" ) +/// { +/// // First time, stores \"a\" in the variable %token and sets %str to \"b c\". +/// %str = nextToken( %str, \"token\", \" \" ); +/// echo( %token ); +/// } +/// @endtsexample +/// @ingroup Strings ) +/// /// -public string fn_nextToken (string str, string token, string delim) +public string fn_nextToken (string str1, string token, string delim) { if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_nextToken'" + string.Format("\"{0}\" \"{1}\" \"{2}\" ",str,token,delim)); +System.Console.WriteLine("----------------->Extern Call 'fn_nextToken'" + string.Format("\"{0}\" \"{1}\" \"{2}\" ",str1,token,delim)); var returnbuff = new StringBuilder(16384); -StringBuilder sbstr = null; -if (str != null) - sbstr = new StringBuilder(str, 1024); +StringBuilder sbstr1 = null; +if (str1 != null) + sbstr1 = new StringBuilder(str1, 1024); StringBuilder sbtoken = null; if (token != null) sbtoken = new StringBuilder(token, 1024); @@ -10288,12 +12817,17 @@ public string fn_nextToken (string str, string token, string delim) if (delim != null) sbdelim = new StringBuilder(delim, 1024); -SafeNativeMethods.mwle_fn_nextToken(sbstr, sbtoken, sbdelim, returnbuff); +SafeNativeMethods.mwle_fn_nextToken(sbstr1, sbtoken, sbdelim, returnbuff); return returnbuff.ToString(); } /// -/// @brief Open the given @a file through the system. This will usually open the file in its associated application. @param file %Path of the file to open. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given @a file through the system. This will usually open the file in its +/// associated application. +/// @param file %Path of the file to open. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void fn_openFile (string file) @@ -10307,7 +12841,11 @@ public void fn_openFile (string file) SafeNativeMethods.mwle_fn_openFile(sbfile); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void fn_openFolder (string path) @@ -10321,7 +12859,13 @@ public void fn_openFolder (string path) SafeNativeMethods.mwle_fn_openFolder(sbpath); } /// -/// @brief Combines two separate strings containing a file path and file name together into a single string @param path String containing file path @param file String containing file name @return String containing concatenated file name and path @ingroup FileSystem) +/// @brief Combines two separate strings containing a file path and file name together into a single string +/// +/// @param path String containing file path +/// @param file String containing file name +/// @return String containing concatenated file name and path +/// @ingroup FileSystem) +/// /// public string fn_pathConcat (string path, string file) @@ -10341,7 +12885,14 @@ public string fn_pathConcat (string path, string file) } /// -/// @brief Copy a file to a new location. @param fromFile %Path of the file to copy. @param toFile %Path where to copy @a fromFile to. @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. @return True if the file was successfully copied, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Copy a file to a new location. +/// @param fromFile %Path of the file to copy. +/// @param toFile %Path where to copy @a fromFile to. +/// @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. +/// @return True if the file was successfully copied, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_pathCopy (string fromFile, string toFile, bool noOverwrite) @@ -10358,7 +12909,23 @@ public bool fn_pathCopy (string fromFile, string toFile, bool noOverwrite) return SafeNativeMethods.mwle_fn_pathCopy(sbfromFile, sbtoFile, noOverwrite)>=1; } /// -/// @brief Load all Path information from the mission. This function is usually called from the loadMissionStage2() server-side function after the mission file has loaded. Internally it places all Paths into the server's PathManager. From this point the Paths are ready for transmission to the clients. @tsexample // Inform the engine to load all Path information from the mission. pathOnMissionLoadDone(); @endtsexample @see NetConnection::transmitPaths() @see NetConnection::clearPaths() @see Path @ingroup Networking) +/// @brief Load all Path information from the mission. +/// +/// This function is usually called from the loadMissionStage2() server-side function +/// after the mission file has loaded. Internally it places all Paths into the server's +/// PathManager. From this point the Paths are ready for transmission to the clients. +/// +/// @tsexample +/// // Inform the engine to load all Path information from the mission. +/// pathOnMissionLoadDone(); +/// @endtsexample +/// +/// @see NetConnection::transmitPaths() +/// @see NetConnection::clearPaths() +/// @see Path +/// +/// @ingroup Networking) +/// /// public void fn_pathOnMissionLoadDone () @@ -10370,7 +12937,9 @@ public void fn_pathOnMissionLoadDone () SafeNativeMethods.mwle_fn_pathOnMissionLoadDone(); } /// -/// () Clears all the tracked objects without saving them. ) +/// () +/// Clears all the tracked objects without saving them. ) +/// /// public void fn_PersistenceManager_clearAll (string persistencemanager) @@ -10384,7 +12953,9 @@ public void fn_PersistenceManager_clearAll (string persistencemanager) SafeNativeMethods.mwle_fn_PersistenceManager_clearAll(sbpersistencemanager); } /// -/// ( fileName ) Delete all of the objects that are created from the given file. ) +/// ( fileName ) +/// Delete all of the objects that are created from the given file. ) +/// /// public void fn_PersistenceManager_deleteObjectsFromFile (string persistencemanager, string fileName) @@ -10401,7 +12972,9 @@ public void fn_PersistenceManager_deleteObjectsFromFile (string persistencemanag SafeNativeMethods.mwle_fn_PersistenceManager_deleteObjectsFromFile(sbpersistencemanager, sbfileName); } /// -/// ( index ) Returns the ith dirty object. ) +/// ( index ) +/// Returns the ith dirty object. ) +/// /// public int fn_PersistenceManager_getDirtyObject (string persistencemanager, int index) @@ -10415,7 +12988,9 @@ public int fn_PersistenceManager_getDirtyObject (string persistencemanager, int return SafeNativeMethods.mwle_fn_PersistenceManager_getDirtyObject(sbpersistencemanager, index); } /// -/// () Returns the number of dirty objects. ) +/// () +/// Returns the number of dirty objects. ) +/// /// public int fn_PersistenceManager_getDirtyObjectCount (string persistencemanager) @@ -10429,7 +13004,9 @@ public int fn_PersistenceManager_getDirtyObjectCount (string persistencemanager) return SafeNativeMethods.mwle_fn_PersistenceManager_getDirtyObjectCount(sbpersistencemanager); } /// -/// () Returns true if the manager has dirty objects to save. ) +/// () +/// Returns true if the manager has dirty objects to save. ) +/// /// public bool fn_PersistenceManager_hasDirty (string persistencemanager) @@ -10443,7 +13020,9 @@ public bool fn_PersistenceManager_hasDirty (string persistencemanager) return SafeNativeMethods.mwle_fn_PersistenceManager_hasDirty(sbpersistencemanager)>=1; } /// -/// (SimObject object) Returns true if the SimObject is on the dirty list.) +/// (SimObject object) +/// Returns true if the SimObject is on the dirty list.) +/// /// public bool fn_PersistenceManager_isDirty (string persistencemanager, string objName) @@ -10460,7 +13039,9 @@ public bool fn_PersistenceManager_isDirty (string persistencemanager, string obj return SafeNativeMethods.mwle_fn_PersistenceManager_isDirty(sbpersistencemanager, sbobjName)>=1; } /// -/// () Prints the dirty list to the console.) +/// () +/// Prints the dirty list to the console.) +/// /// public void fn_PersistenceManager_listDirty (string persistencemanager) @@ -10474,7 +13055,9 @@ public void fn_PersistenceManager_listDirty (string persistencemanager) SafeNativeMethods.mwle_fn_PersistenceManager_listDirty(sbpersistencemanager); } /// -/// (SimObject object) Remove a SimObject from the dirty list.) +/// (SimObject object) +/// Remove a SimObject from the dirty list.) +/// /// public void fn_PersistenceManager_removeDirty (string persistencemanager, string objName) @@ -10491,7 +13074,9 @@ public void fn_PersistenceManager_removeDirty (string persistencemanager, string SafeNativeMethods.mwle_fn_PersistenceManager_removeDirty(sbpersistencemanager, sbobjName); } /// -/// (SimObject object, string fieldName) Remove a specific field from an object declaration.) +/// (SimObject object, string fieldName) +/// Remove a specific field from an object declaration.) +/// /// public void fn_PersistenceManager_removeField (string persistencemanager, string objName, string fieldName) @@ -10511,7 +13096,10 @@ public void fn_PersistenceManager_removeField (string persistencemanager, string SafeNativeMethods.mwle_fn_PersistenceManager_removeField(sbpersistencemanager, sbobjName, sbfieldName); } /// -/// ) , (SimObject object, [filename]) Remove an existing SimObject from a file (can optionally specify a different file than \ the one it was created in.) +/// ) , (SimObject object, [filename]) +/// Remove an existing SimObject from a file (can optionally specify a different file than \ +/// the one it was created in.) +/// /// public void fn_PersistenceManager_removeObjectFromFile (string persistencemanager, string objName, string filename) @@ -10531,7 +13119,9 @@ public void fn_PersistenceManager_removeObjectFromFile (string persistencemanage SafeNativeMethods.mwle_fn_PersistenceManager_removeObjectFromFile(sbpersistencemanager, sbobjName, sbfilename); } /// -/// () Saves all of the SimObject's on the dirty list to their respective files.) +/// () +/// Saves all of the SimObject's on the dirty list to their respective files.) +/// /// public bool fn_PersistenceManager_saveDirty (string persistencemanager) @@ -10545,7 +13135,9 @@ public bool fn_PersistenceManager_saveDirty (string persistencemanager) return SafeNativeMethods.mwle_fn_PersistenceManager_saveDirty(sbpersistencemanager)>=1; } /// -/// (SimObject object) Save a dirty SimObject to it's file.) +/// (SimObject object) +/// Save a dirty SimObject to it's file.) +/// /// public bool fn_PersistenceManager_saveDirtyObject (string persistencemanager, string objName) @@ -10562,7 +13154,9 @@ public bool fn_PersistenceManager_saveDirtyObject (string persistencemanager, st return SafeNativeMethods.mwle_fn_PersistenceManager_saveDirtyObject(sbpersistencemanager, sbobjName)>=1; } /// -/// ), (SimObject object, [filename]) Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// ), (SimObject object, [filename]) +/// Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// /// public void fn_PersistenceManager_setDirty (string persistencemanager, string objName, string fileName) @@ -10582,7 +13176,11 @@ public void fn_PersistenceManager_setDirty (string persistencemanager, string ob SafeNativeMethods.mwle_fn_PersistenceManager_setDirty(sbpersistencemanager, sbobjName, sbfileName); } /// -/// @brief Loads some information to have readily available at simulation time. Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. This function should be used while a level is loading in order to shorten the amount of time to create a PhysicsDebris in game.) +/// @brief Loads some information to have readily available at simulation time. +/// Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. +/// This function should be used while a level is loading in order to shorten +/// the amount of time to create a PhysicsDebris in game.) +/// /// public void fn_PhysicsDebrisData_preload (string physicsdebrisdata) @@ -10597,6 +13195,7 @@ public void fn_PhysicsDebrisData_preload (string physicsdebrisdata) } /// /// physicsDebugDraw( bool enable )) +/// /// public void fn_physicsDebugDraw (bool enable) @@ -10608,6 +13207,7 @@ public void fn_physicsDebugDraw (bool enable) } /// /// physicsDestroy()) +/// /// public void fn_physicsDestroy () @@ -10620,6 +13220,7 @@ public void fn_physicsDestroy () } /// /// physicsDestroyWorld( String worldName )) +/// /// public void fn_physicsDestroyWorld (string worldName) @@ -10634,6 +13235,7 @@ public void fn_physicsDestroyWorld (string worldName) } /// /// physicsGetTimeScale()) +/// /// public float fn_physicsGetTimeScale () @@ -10646,6 +13248,7 @@ public float fn_physicsGetTimeScale () } /// /// ), physicsInit( [string library] )) +/// /// public bool fn_physicsInit (string library) @@ -10660,6 +13263,7 @@ public bool fn_physicsInit (string library) } /// /// physicsInitWorld( String worldName )) +/// /// public bool fn_physicsInitWorld (string worldName) @@ -10673,7 +13277,10 @@ public bool fn_physicsInitWorld (string worldName) return SafeNativeMethods.mwle_fn_physicsInitWorld(sbworldName)>=1; } /// -/// physicsPluginPresent() @brief Returns true if a physics plugin exists and is initialized. @ingroup Physics ) +/// physicsPluginPresent() +/// @brief Returns true if a physics plugin exists and is initialized. +/// @ingroup Physics ) +/// /// public bool fn_physicsPluginPresent () @@ -10686,6 +13293,7 @@ public bool fn_physicsPluginPresent () } /// /// physicsRestoreState()) +/// /// public void fn_physicsRestoreState () @@ -10698,6 +13306,7 @@ public void fn_physicsRestoreState () } /// /// physicsSetTimeScale( F32 scale )) +/// /// public void fn_physicsSetTimeScale (float scale) @@ -10709,6 +13318,7 @@ public void fn_physicsSetTimeScale (float scale) } /// /// physicsStopSimulation( String worldName )) +/// /// public bool fn_physicsSimulationEnabled () @@ -10721,6 +13331,7 @@ public bool fn_physicsSimulationEnabled () } /// /// physicsStartSimulation( String worldName )) +/// /// public void fn_physicsStartSimulation (string worldName) @@ -10735,6 +13346,7 @@ public void fn_physicsStartSimulation (string worldName) } /// /// physicsStopSimulation( String worldName )) +/// /// public void fn_physicsStopSimulation (string worldName) @@ -10749,6 +13361,7 @@ public void fn_physicsStopSimulation (string worldName) } /// /// physicsStoreState()) +/// /// public void fn_physicsStoreState () @@ -10760,7 +13373,11 @@ public void fn_physicsStoreState () SafeNativeMethods.mwle_fn_physicsStoreState(); } /// -/// (string filename) @brief Begin playback of a journal from a specified field. @param filename Name and path of file journal file @ingroup Platform) +/// (string filename) +/// @brief Begin playback of a journal from a specified field. +/// @param filename Name and path of file journal file +/// @ingroup Platform) +/// /// public void fn_playJournal (string filename) @@ -10774,7 +13391,10 @@ public void fn_playJournal (string filename) SafeNativeMethods.mwle_fn_playJournal(sbfilename); } /// -/// THEORA, 30.0f, Point2I::Zero ), Load a journal file and capture it video. @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Load a journal file and capture it video. +/// @ingroup Rendering ) +/// /// public void fn_playJournalToVideo (string journalFile, string videoFile, string encoder, float framerate, string resolution) @@ -10797,7 +13417,12 @@ public void fn_playJournalToVideo (string journalFile, string videoFile, string SafeNativeMethods.mwle_fn_playJournalToVideo(sbjournalFile, sbvideoFile, sbencoder, framerate, sbresolution); } /// -/// () @brief Pop and restore the last setting of $instantGroup off the stack. @note Currently only used for editors @ingroup Editors @internal) +/// () +/// @brief Pop and restore the last setting of $instantGroup off the stack. +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void fn_popInstantGroup () @@ -10809,7 +13434,12 @@ public void fn_popInstantGroup () SafeNativeMethods.mwle_fn_popInstantGroup(); } /// -/// Populate the font cache for all fonts with Unicode code points in the specified range. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for all fonts with Unicode code points in the specified range. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void fn_populateAllFontCacheRange (uint rangeStart, uint rangeEnd) @@ -10820,7 +13450,9 @@ public void fn_populateAllFontCacheRange (uint rangeStart, uint rangeEnd) SafeNativeMethods.mwle_fn_populateAllFontCacheRange(rangeStart, rangeEnd); } /// -/// Populate the font cache for all fonts with characters from the specified string. @ingroup Font ) +/// Populate the font cache for all fonts with characters from the specified string. +/// @ingroup Font ) +/// /// public void fn_populateAllFontCacheString (string stringx) @@ -10834,7 +13466,14 @@ public void fn_populateAllFontCacheString (string stringx) SafeNativeMethods.mwle_fn_populateAllFontCacheString(sbstringx); } /// -/// Populate the font cache for the specified font with Unicode code points in the specified range. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for the specified font with Unicode code points in the specified range. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void fn_populateFontCacheRange (string faceName, int fontSize, uint rangeStart, uint rangeEnd) @@ -10848,7 +13487,12 @@ public void fn_populateFontCacheRange (string faceName, int fontSize, uint range SafeNativeMethods.mwle_fn_populateFontCacheRange(sbfaceName, fontSize, rangeStart, rangeEnd); } /// -/// Populate the font cache for the specified font with characters from the specified string. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param string The string to populate. @ingroup Font ) +/// Populate the font cache for the specified font with characters from the specified string. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param string The string to populate. +/// @ingroup Font ) +/// /// public void fn_populateFontCacheString (string faceName, int fontSize, string stringx) @@ -10866,6 +13510,7 @@ public void fn_populateFontCacheString (string faceName, int fontSize, string st } /// /// (GuiCanvas, pos, title)) +/// /// public void fn_PopupMenu_attachToMenuBar (string popupmenu, string canvasName, int pos, string title) @@ -10886,6 +13531,7 @@ public void fn_PopupMenu_attachToMenuBar (string popupmenu, string canvasName, i } /// /// (pos, checked)) +/// /// public void fn_PopupMenu_checkItem (string popupmenu, int pos, bool checkedx) @@ -10900,6 +13546,7 @@ public void fn_PopupMenu_checkItem (string popupmenu, int pos, bool checkedx) } /// /// (firstPos, lastPos, checkPos)) +/// /// public void fn_PopupMenu_checkRadioItem (string popupmenu, int firstPos, int lastPos, int checkPos) @@ -10914,6 +13561,7 @@ public void fn_PopupMenu_checkRadioItem (string popupmenu, int firstPos, int las } /// /// (pos, enabled)) +/// /// public void fn_PopupMenu_enableItem (string popupmenu, int pos, bool enabled) @@ -10928,6 +13576,7 @@ public void fn_PopupMenu_enableItem (string popupmenu, int pos, bool enabled) } /// /// ()) +/// /// public int fn_PopupMenu_getItemCount (string popupmenu) @@ -10942,6 +13591,7 @@ public int fn_PopupMenu_getItemCount (string popupmenu) } /// /// , ), (pos[, title][, accelerator])) +/// /// public int fn_PopupMenu_insertItem (string popupmenu, int pos, string title, string accelerator) @@ -10962,6 +13612,7 @@ public int fn_PopupMenu_insertItem (string popupmenu, int pos, string title, str } /// /// (pos, title, subMenu)) +/// /// public int fn_PopupMenu_insertSubMenu (string popupmenu, int pos, string title, string subMenu) @@ -10982,6 +13633,7 @@ public int fn_PopupMenu_insertSubMenu (string popupmenu, int pos, string title, } /// /// (pos)) +/// /// public bool fn_PopupMenu_isItemChecked (string popupmenu, int pos) @@ -10996,6 +13648,7 @@ public bool fn_PopupMenu_isItemChecked (string popupmenu, int pos) } /// /// ()) +/// /// public void fn_PopupMenu_removeFromMenuBar (string popupmenu) @@ -11010,6 +13663,7 @@ public void fn_PopupMenu_removeFromMenuBar (string popupmenu) } /// /// (pos)) +/// /// public void fn_PopupMenu_removeItem (string popupmenu, int pos) @@ -11024,6 +13678,7 @@ public void fn_PopupMenu_removeItem (string popupmenu, int pos) } /// /// ), (pos, title[, accelerator])) +/// /// public bool fn_PopupMenu_setItem (string popupmenu, int pos, string title, string accelerator) @@ -11044,6 +13699,7 @@ public bool fn_PopupMenu_setItem (string popupmenu, int pos, string title, strin } /// /// (Canvas,[x, y])) +/// /// public void fn_PopupMenu_showPopup (string popupmenu, string canvasName, int x, int y) @@ -11060,7 +13716,9 @@ public void fn_PopupMenu_showPopup (string popupmenu, string canvasName, int x, SafeNativeMethods.mwle_fn_PopupMenu_showPopup(sbpopupmenu, sbcanvasName, x, y); } /// -/// Preload all datablocks in client mode. (Server parameter is set to false). This will take some time to complete.) +/// Preload all datablocks in client mode. +/// (Server parameter is set to false). This will take some time to complete.) +/// /// public void fn_preloadClientDataBlocks () @@ -11072,7 +13730,11 @@ public void fn_preloadClientDataBlocks () SafeNativeMethods.mwle_fn_preloadClientDataBlocks(); } /// -/// @brief Dumps current profiling stats to the console window. @note Markers disabled with profilerMarkerEnable() will be skipped over. If the profiler is currently running, it will be disabled. @ingroup Debugging) +/// @brief Dumps current profiling stats to the console window. +/// @note Markers disabled with profilerMarkerEnable() will be skipped over. +/// If the profiler is currently running, it will be disabled. +/// @ingroup Debugging) +/// /// public void fn_profilerDump () @@ -11084,7 +13746,15 @@ public void fn_profilerDump () SafeNativeMethods.mwle_fn_profilerDump(); } /// -/// @brief Dumps current profiling stats to a file. @note If the profiler is currently running, it will be disabled. @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). Will attempt to create the file if it does not already exist. @tsexample profilerDumpToFile( \"C:/Torque/log1.txt\" ); @endtsexample @ingroup Debugging ) +/// @brief Dumps current profiling stats to a file. +/// @note If the profiler is currently running, it will be disabled. +/// @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). +/// Will attempt to create the file if it does not already exist. +/// @tsexample +/// profilerDumpToFile( \"C:/Torque/log1.txt\" ); +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void fn_profilerDumpToFile (string fileName) @@ -11098,7 +13768,14 @@ public void fn_profilerDumpToFile (string fileName) SafeNativeMethods.mwle_fn_profilerDumpToFile(sbfileName); } /// -/// @brief Enables or disables the profiler. Data is only gathered while the profiler is enabled. @note Profiler is not available in shipping builds. T3D has predefined profiling areas surrounded by markers, but you may need to define additional markers (in C++) around areas you wish to profile, by using the PROFILE_START( markerName ); and PROFILE_END(); macros. @ingroup Debugging ) +/// @brief Enables or disables the profiler. +/// Data is only gathered while the profiler is enabled. +/// @note Profiler is not available in shipping builds. +/// T3D has predefined profiling areas surrounded by markers, +/// but you may need to define additional markers (in C++) around areas you wish to profile, +/// by using the PROFILE_START( markerName ); and PROFILE_END(); macros. +/// @ingroup Debugging ) +/// /// public void fn_profilerEnable (bool enable) @@ -11109,7 +13786,13 @@ public void fn_profilerEnable (bool enable) SafeNativeMethods.mwle_fn_profilerEnable(enable); } /// -/// @brief Enable or disable a specific profile. @param enable Optional paramater to enable or disable the profile. @param markerName Name of a specific marker to enable or disable. @note Calling this function will first call profilerReset(), clearing all data from profiler. All profile markers are enabled by default. @ingroup Debugging) +/// @brief Enable or disable a specific profile. +/// @param enable Optional paramater to enable or disable the profile. +/// @param markerName Name of a specific marker to enable or disable. +/// @note Calling this function will first call profilerReset(), clearing all data from profiler. +/// All profile markers are enabled by default. +/// @ingroup Debugging) +/// /// public void fn_profilerMarkerEnable (string markerName, bool enable) @@ -11123,7 +13806,11 @@ public void fn_profilerMarkerEnable (string markerName, bool enable) SafeNativeMethods.mwle_fn_profilerMarkerEnable(sbmarkerName, enable); } /// -/// @brief Resets the profiler, clearing it of all its data. If the profiler is currently running, it will first be disabled. All markers will retain their current enabled/disabled status. @ingroup Debugging ) +/// @brief Resets the profiler, clearing it of all its data. +/// If the profiler is currently running, it will first be disabled. +/// All markers will retain their current enabled/disabled status. +/// @ingroup Debugging ) +/// /// public void fn_profilerReset () @@ -11135,7 +13822,13 @@ public void fn_profilerReset () SafeNativeMethods.mwle_fn_profilerReset(); } /// -/// ) , ([group]) @brief Pushes the current $instantGroup on a stack and sets it to the given value (or clears it). @note Currently only used for editors @ingroup Editors @internal) +/// ) , ([group]) +/// @brief Pushes the current $instantGroup on a stack +/// and sets it to the given value (or clears it). +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void fn_pushInstantGroup (string group) @@ -11150,6 +13843,7 @@ public void fn_pushInstantGroup (string group) } /// /// queryAllServers(...); ) +/// /// public void fn_queryAllServers (uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags) @@ -11167,6 +13861,8 @@ public void fn_queryAllServers (uint lanPort, uint flags, string gameType, strin } /// /// queryLanServers(...); ) +/// +/// /// public void fn_queryLanServers (uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags) @@ -11184,6 +13880,7 @@ public void fn_queryLanServers (uint lanPort, uint flags, string gameType, strin } /// /// queryMasterServer(...); ) +/// /// public void fn_queryMasterServer (uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags) @@ -11201,6 +13898,7 @@ public void fn_queryMasterServer (uint lanPort, uint flags, string gameType, str } /// /// querySingleServer(...); ) +/// /// public void fn_querySingleServer (string addrText, byte flags) @@ -11214,6 +13912,43 @@ public void fn_querySingleServer (string addrText, byte flags) SafeNativeMethods.mwle_fn_querySingleServer(sbaddrText, flags); } /// +/// Shut down the engine and exit its process. +/// This function cleanly uninitializes the engine and then exits back to the system with a process +/// exit status indicating a clean exit. +/// @see quitWithErrorMessage +/// @ingroup Platform ) +/// +/// + +public void fn_quit () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_quit'"); + + +SafeNativeMethods.mwle_fn_quit(); +} +/// +/// Display an error message box showing the given @a message and then shut down the engine and exit its process. +/// This function cleanly uninitialized the engine and then exits back to the system with a process +/// exit status indicating an error. +/// @param message The message to log to the console and show in an error message box. +/// @see quit +/// @ingroup Platform ) +/// +/// + +public void fn_quitWithErrorMessage (string message) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_quitWithErrorMessage'" + string.Format("\"{0}\" ",message)); +StringBuilder sbmessage = null; +if (message != null) + sbmessage = new StringBuilder(message, 1024); + +SafeNativeMethods.mwle_fn_quitWithErrorMessage(sbmessage); +} +/// /// readXMLObj.readFile();) /// /// @@ -11238,7 +13973,10 @@ public void fn_realQuit () SafeNativeMethods.mwle_fn_realQuit(); } /// -/// Close the current Redbook device. @brief Deprecated @internal) +/// Close the current Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookClose () @@ -11250,7 +13988,10 @@ public bool fn_redbookClose () return SafeNativeMethods.mwle_fn_redbookClose()>=1; } /// -/// get the number of redbook devices. @brief Deprecated @internal) +/// get the number of redbook devices. +/// @brief Deprecated +/// @internal) +/// /// public int fn_redbookGetDeviceCount () @@ -11262,7 +14003,10 @@ public int fn_redbookGetDeviceCount () return SafeNativeMethods.mwle_fn_redbookGetDeviceCount(); } /// -/// (int index) Get name of specified Redbook device. @brief Deprecated @internal) +/// (int index) Get name of specified Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public string fn_redbookGetDeviceName (int index) @@ -11276,7 +14020,10 @@ public string fn_redbookGetDeviceName (int index) } /// -/// Get a string explaining the last redbook error. @brief Deprecated @internal) +/// Get a string explaining the last redbook error. +/// @brief Deprecated +/// @internal) +/// /// public string fn_redbookGetLastError () @@ -11291,7 +14038,10 @@ public string fn_redbookGetLastError () } /// -/// Return the number of tracks. @brief Deprecated @internal) +/// Return the number of tracks. +/// @brief Deprecated +/// @internal) +/// /// public int fn_redbookGetTrackCount () @@ -11303,7 +14053,10 @@ public int fn_redbookGetTrackCount () return SafeNativeMethods.mwle_fn_redbookGetTrackCount(); } /// -/// Get the volume. @brief Deprecated @internal) +/// Get the volume. +/// @brief Deprecated +/// @internal) +/// /// public float fn_redbookGetVolume () @@ -11315,7 +14068,10 @@ public float fn_redbookGetVolume () return SafeNativeMethods.mwle_fn_redbookGetVolume(); } /// -/// ), (string device=NULL) @brief Deprecated @internal) +/// ), (string device=NULL) +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookOpen (string device) @@ -11329,7 +14085,10 @@ public bool fn_redbookOpen (string device) return SafeNativeMethods.mwle_fn_redbookOpen(sbdevice)>=1; } /// -/// (int track) Play the selected track. @brief Deprecated @internal) +/// (int track) Play the selected track. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookPlay (int track) @@ -11340,7 +14099,10 @@ public bool fn_redbookPlay (int track) return SafeNativeMethods.mwle_fn_redbookPlay(track)>=1; } /// -/// (float volume) Set playback volume. @brief Deprecated @internal) +/// (float volume) Set playback volume. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookSetVolume (float volume) @@ -11351,7 +14113,10 @@ public bool fn_redbookSetVolume (float volume) return SafeNativeMethods.mwle_fn_redbookSetVolume(volume)>=1; } /// -/// Stop playing. @brief Deprecated @internal) +/// Stop playing. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookStop () @@ -11363,7 +14128,12 @@ public bool fn_redbookStop () return SafeNativeMethods.mwle_fn_redbookStop()>=1; } /// -/// (string queueName, string listener) @brief Registers an event message @param queueName String containing the name of queue to attach listener to @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Registers an event message +/// @param queueName String containing the name of queue to attach listener to +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public bool fn_registerMessageListener (string queueName, string listenerName) @@ -11380,7 +14150,11 @@ public bool fn_registerMessageListener (string queueName, string listenerName) return SafeNativeMethods.mwle_fn_registerMessageListener(sbqueueName, sblistenerName)>=1; } /// -/// (string queueName) @brief Registeres a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Registeres a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void fn_registerMessageQueue (string queueName) @@ -11394,7 +14168,9 @@ public void fn_registerMessageQueue (string queueName) SafeNativeMethods.mwle_fn_registerMessageQueue(sbqueueName); } /// -/// @brief Flushes all procedural shaders and re-initializes all active material instances. @ingroup Materials) +/// @brief Flushes all procedural shaders and re-initializes all active material instances. +/// @ingroup Materials) +/// /// public void fn_reInitMaterials () @@ -11406,7 +14182,15 @@ public void fn_reInitMaterials () SafeNativeMethods.mwle_fn_reInitMaterials(); } /// -/// Force the resource at specified input path to be reloaded @param path Path to the resource to be reloaded @tsexample reloadResource( \"art/shapes/box.dts\" ); @endtsexample @note Currently used by editors only @ingroup Editors @internal) +/// Force the resource at specified input path to be reloaded +/// @param path Path to the resource to be reloaded +/// @tsexample +/// reloadResource( \"art/shapes/box.dts\" ); +/// @endtsexample +/// @note Currently used by editors only +/// @ingroup Editors +/// @internal) +/// /// public void fn_reloadResource (string path) @@ -11420,7 +14204,9 @@ public void fn_reloadResource (string path) SafeNativeMethods.mwle_fn_reloadResource(sbpath); } /// -/// Reload all the textures from disk. @ingroup GFX ) +/// Reload all the textures from disk. +/// @ingroup GFX ) +/// /// public void fn_reloadTextures () @@ -11432,7 +14218,19 @@ public void fn_reloadTextures () SafeNativeMethods.mwle_fn_reloadTextures(); } /// -/// Remove the field in @a text at the given @a index. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field in @a text. @return A new string with the field at the given index removed or the original string if @a index is out of range. @tsexample removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" @endtsexample @see removeWord @see removeRecord @ingroup FieldManip ) +/// Remove the field in @a text at the given @a index. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field in @a text. +/// @return A new string with the field at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string fn_removeField (string text, int index) @@ -11449,7 +14247,10 @@ public string fn_removeField (string text, int index) } /// -/// Removes an existing global macro by name. @see addGlobalShaderMacro @ingroup Rendering ) +/// Removes an existing global macro by name. +/// @see addGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void fn_removeGlobalShaderMacro (string name) @@ -11463,7 +14264,19 @@ public void fn_removeGlobalShaderMacro (string name) SafeNativeMethods.mwle_fn_removeGlobalShaderMacro(sbname); } /// -/// Remove the record in @a text at the given @a index. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record in @a text. @return A new string with the record at the given @a index removed or the original string if @a index is out of range. @tsexample removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" @endtsexample @see removeWord @see removeField @ingroup FieldManip ) +/// Remove the record in @a text at the given @a index. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record in @a text. +/// @return A new string with the record at the given @a index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeField +/// @ingroup FieldManip ) +/// /// public string fn_removeRecord (string text, int index) @@ -11480,7 +14293,15 @@ public string fn_removeRecord (string text, int index) } /// -/// @brief Remove a tagged string from the Net String Table @param tag The tag associated with the string @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// @brief Remove a tagged string from the Net String Table +/// +/// @param tag The tag associated with the string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public void fn_removeTaggedString (int tag) @@ -11491,7 +14312,19 @@ public void fn_removeTaggedString (int tag) SafeNativeMethods.mwle_fn_removeTaggedString(tag); } /// -/// Remove the word in @a text at the given @a index. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word in @a text. @return A new string with the word at the given index removed or the original string if @a index is out of range. @tsexample removeWord( \"a b c d\", 2 ) // Returns \"a b d\" @endtsexample @see removeField @see removeRecord @ingroup FieldManip ) +/// Remove the word in @a text at the given @a index. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word in @a text. +/// @return A new string with the word at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeWord( \"a b c d\", 2 ) // Returns \"a b d\" +/// @endtsexample +/// @see removeField +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string fn_removeWord (string text, int index) @@ -11508,7 +14341,12 @@ public string fn_removeWord (string text, int index) } /// -/// @brief Renames the given @a file. @param from %Path of the file to rename from. @param frome %Path of the file to rename to. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Renames the given @a file. +/// @param from %Path of the file to rename from. +/// @param frome %Path of the file to rename to. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_renameFile (string from, string to) @@ -11525,7 +14363,10 @@ public bool fn_renameFile (string from, string to) return SafeNativeMethods.mwle_fn_renameFile(sbfrom, sbto)>=1; } /// -/// () @brief Reset FPS stats (fps::) @ingroup Game) +/// () +/// @brief Reset FPS stats (fps::) +/// @ingroup Game) +/// /// public void fn_resetFPSTracker () @@ -11537,7 +14378,11 @@ public void fn_resetFPSTracker () SafeNativeMethods.mwle_fn_resetFPSTracker(); } /// -/// @brief Deactivates and then activates the currently active light manager. This causes most shaders to be regenerated and is often used when global rendering changes have occured. @ingroup Lighting ) +/// @brief Deactivates and then activates the currently active light manager. +/// This causes most shaders to be regenerated and is often used when global +/// rendering changes have occured. +/// @ingroup Lighting ) +/// /// public void fn_resetLightManager () @@ -11549,7 +14394,12 @@ public void fn_resetLightManager () SafeNativeMethods.mwle_fn_resetLightManager(); } /// -/// () @brief Rebuilds the XInput section of the InputManager Requests a full refresh of events for all controllers. Useful when called at the beginning of game code after actionMaps are set up to hook up all appropriate events. @ingroup Input) +/// () +/// @brief Rebuilds the XInput section of the InputManager +/// Requests a full refresh of events for all controllers. Useful when called at the beginning +/// of game code after actionMaps are set up to hook up all appropriate events. +/// @ingroup Input) +/// /// public void fn_resetXInput () @@ -11561,7 +14411,16 @@ public void fn_resetXInput () SafeNativeMethods.mwle_fn_resetXInput(); } /// -/// Return all but the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return @a text with the first word removed. @note This is equal to @tsexample_nopar getWords( text, 1 ) @endtsexample @see getWords @ingroup FieldManip ) +/// Return all but the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return @a text with the first word removed. +/// @note This is equal to +/// @tsexample_nopar +/// getWords( text, 1 ) +/// @endtsexample +/// @see getWords +/// @ingroup FieldManip ) +/// /// public string fn_restWords (string text) @@ -11578,7 +14437,16 @@ public string fn_restWords (string text) } /// -/// Remove trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. @tsexample rtrim( \" string \" ); // Returns \" string\". @endtsexample @see ltrim @see trim @ingroup Strings ) +/// Remove trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// rtrim( \" string \" ); // Returns \" string\". +/// @endtsexample +/// @see ltrim +/// @see trim +/// @ingroup Strings ) +/// /// public string fn_rtrim (string str) @@ -11595,7 +14463,18 @@ public string fn_rtrim (string str) } /// -/// (string device, float xRumble, float yRumble) @brief Activates the vibration motors in the specified controller. The controller will constantly at it's xRumble and yRumble intensities until changed or told to stop. Valid inputs for xRumble/yRumble are [0 - 1]. @param device Name of the device to rumble. @param xRumble Intensity to apply to the left motor. @param yRumble Intensity to apply to the right motor. @note in an Xbox 360 controller, the left motor is low-frequency, while the right motor is high-frequency. @ingroup Input) +/// (string device, float xRumble, float yRumble) +/// @brief Activates the vibration motors in the specified controller. +/// The controller will constantly at it's xRumble and yRumble intensities until +/// changed or told to stop. +/// Valid inputs for xRumble/yRumble are [0 - 1]. +/// @param device Name of the device to rumble. +/// @param xRumble Intensity to apply to the left motor. +/// @param yRumble Intensity to apply to the right motor. +/// @note in an Xbox 360 controller, the left motor is low-frequency, +/// while the right motor is high-frequency. +/// @ingroup Input) +/// /// public void fn_rumble (string device, float xRumble, float yRumble) @@ -11609,7 +14488,10 @@ public void fn_rumble (string device, float xRumble, float yRumble) SafeNativeMethods.mwle_fn_rumble(sbdevice, xRumble, yRumble); } /// -/// (string filename) Save the journal to the specified file. @ingroup Platform) +/// (string filename) +/// Save the journal to the specified file. +/// @ingroup Platform) +/// /// public void fn_saveJournal (string filename) @@ -11623,7 +14505,11 @@ public void fn_saveJournal (string filename) SafeNativeMethods.mwle_fn_saveJournal(sbfilename); } /// -/// @brief Serialize the object to a file. @param object The object to serialize. @param filename The file name and path. @ingroup Console) +/// @brief Serialize the object to a file. +/// @param object The object to serialize. +/// @param filename The file name and path. +/// @ingroup Console) +/// /// public bool fn_saveObject (string objectx, string filename) @@ -11640,7 +14526,12 @@ public bool fn_saveObject (string objectx, string filename) return SafeNativeMethods.mwle_fn_saveObject(sbobjectx, sbfilename)>=1; } /// -/// Dump the current zoning states of all zone spaces in the scene to the console. @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states are dumped as is. @note Only valid on the client. @ingroup Game ) +/// Dump the current zoning states of all zone spaces in the scene to the console. +/// @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states +/// are dumped as is. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public void fn_sceneDumpZoneStates (bool updateFirst) @@ -11651,7 +14542,12 @@ public void fn_sceneDumpZoneStates (bool updateFirst) SafeNativeMethods.mwle_fn_sceneDumpZoneStates(updateFirst); } /// -/// Return the SceneObject that contains the given zone. @param zoneId ID of zone. @return A SceneObject or NULL if the given @a zoneId is invalid. @note Only valid on the client. @ingroup Game ) +/// Return the SceneObject that contains the given zone. +/// @param zoneId ID of zone. +/// @return A SceneObject or NULL if the given @a zoneId is invalid. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public string fn_sceneGetZoneOwner (uint zoneId) @@ -11665,7 +14561,13 @@ public string fn_sceneGetZoneOwner (uint zoneId) } /// -/// Takes a screenshot with optional tiling to produce huge screenshots. @param file The output image file path. @param format Either JPEG or PNG. @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. @ingroup GFX ) +/// Takes a screenshot with optional tiling to produce huge screenshots. +/// @param file The output image file path. +/// @param format Either JPEG or PNG. +/// @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. +/// @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. +/// @ingroup GFX ) +/// /// public void fn_screenShot (string file, string format, uint tileCount, float tileOverlap) @@ -11682,7 +14584,11 @@ public void fn_screenShot (string file, string format, uint tileCount, float til SafeNativeMethods.mwle_fn_screenShot(sbfile, sbformat, tileCount, tileOverlap); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void fn_selectFile (string path) @@ -11713,7 +14619,11 @@ public bool fn_setClipboard (string text) return SafeNativeMethods.mwle_fn_setClipboard(sbtext)>=1; } /// -/// (string LangTable) @brief Sets the primary LangTable used by the game @param LangTable ID of the core LangTable @ingroup Localization) +/// (string LangTable) +/// @brief Sets the primary LangTable used by the game +/// @param LangTable ID of the core LangTable +/// @ingroup Localization) +/// /// public void fn_setCoreLangTable (string lgTable) @@ -11727,7 +14637,13 @@ public void fn_setCoreLangTable (string lgTable) SafeNativeMethods.mwle_fn_setCoreLangTable(sblgTable); } /// -/// @brief Set the current working directory. @param path The absolute or relative (to the current working directory) path of the directory which should be made the new working directory. @return True if the working directory was successfully changed to @a path, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Set the current working directory. +/// @param path The absolute or relative (to the current working directory) path of the directory which should be made the new +/// working directory. +/// @return True if the working directory was successfully changed to @a path, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_setCurrentDirectory (string path) @@ -11741,7 +14657,10 @@ public bool fn_setCurrentDirectory (string path) return SafeNativeMethods.mwle_fn_setCurrentDirectory(sbpath)>=1; } /// -/// @brief Set the default FOV for a camera. @param defaultFOV The default field of view in degrees @ingroup CameraSystem) +/// @brief Set the default FOV for a camera. +/// @param defaultFOV The default field of view in degrees +/// @ingroup CameraSystem) +/// /// public void fn_setDefaultFov (float defaultFOV) @@ -11752,7 +14671,9 @@ public void fn_setDefaultFov (float defaultFOV) SafeNativeMethods.mwle_fn_setDefaultFov(defaultFOV); } /// -/// Sets the clients far clipping. ) +/// Sets the clients far clipping. +/// ) +/// /// public void fn_setFarClippingDistance (float dist) @@ -11763,7 +14684,21 @@ public void fn_setFarClippingDistance (float dist) SafeNativeMethods.mwle_fn_setFarClippingDistance(dist); } /// -/// Replace the field in @a text at the given @a index with @a replacement. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to replace. @param replacement The string with which to replace the field. @return A new string with the field at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" @endtsexample @see getField @see setWord @see setRecord @ingroup FieldManip ) +/// Replace the field in @a text at the given @a index with @a replacement. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to replace. +/// @param replacement The string with which to replace the field. +/// @return A new string with the field at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see setWord +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string fn_setField (string text, int index, string replacement) @@ -11798,7 +14733,10 @@ public int fn_SetFogVolumeQuality (uint new_quality) return SafeNativeMethods.mwle_fn_SetFogVolumeQuality(new_quality); } /// -/// @brief Set the FOV of the camera. @param FOV The camera's new FOV in degrees @ingroup CameraSystem) +/// @brief Set the FOV of the camera. +/// @param FOV The camera's new FOV in degrees +/// @ingroup CameraSystem) +/// /// public void fn_setFov (float FOV) @@ -11810,6 +14748,7 @@ public void fn_setFov (float FOV) } /// /// @brief .) +/// /// public void fn_setFrustumOffset (string offset) @@ -11823,7 +14762,10 @@ public void fn_setFrustumOffset (string offset) SafeNativeMethods.mwle_fn_setFrustumOffset(sboffset); } /// -/// Finds and activates the named light manager. @return Returns true if the light manager is found and activated. @ingroup Lighting ) +/// Finds and activates the named light manager. +/// @return Returns true if the light manager is found and activated. +/// @ingroup Lighting ) +/// /// public bool fn_setLightManager (string name) @@ -11837,7 +14779,22 @@ public bool fn_setLightManager (string name) return SafeNativeMethods.mwle_fn_setLightManager(sbname)>=1; } /// -/// @brief Determines how log files are written. Sets the operational mode of the console logging system. @param mode Parameter specifying the logging mode. This can be: - 1: Open and close the console log file for each seperate string of output. This will ensure that all parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. - 2: Keep the log file open and write to it continuously. This will make the system operate faster but if the process crashes, parts of the output may not have been written to disk yet and will be missing from the log. Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been issued to the console system into the newly created log file. @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. @ingroup Logging ) +/// @brief Determines how log files are written. +/// Sets the operational mode of the console logging system. +/// @param mode Parameter specifying the logging mode. This can be: +/// - 1: Open and close the console log file for each seperate string of output. This will ensure that all +/// parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. +/// - 2: Keep the log file open and write to it continuously. This will make the system operate faster but +/// if the process crashes, parts of the output may not have been written to disk yet and will be missing from +/// the log. +/// +/// Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be +/// combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been +/// issued to the console system into the newly created log file. +/// +/// @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. +/// @ingroup Logging ) +/// /// public void fn_setLogMode (int mode) @@ -11848,7 +14805,18 @@ public void fn_setLogMode (int mode) SafeNativeMethods.mwle_fn_setLogMode(mode); } /// -/// (int port, bool bind=true) @brief Set the network port for the game to use. @param port The port to use. @param bind True if bind() should be called on the port. @returns True if the port was successfully opened. This will trigger a windows firewall prompt. If you don't have firewall tunneling tech you can set this to false to avoid the prompt. @ingroup Networking) +/// (int port, bool bind=true) +/// @brief Set the network port for the game to use. +/// +/// @param port The port to use. +/// @param bind True if bind() should be called on the port. +/// +/// @returns True if the port was successfully opened. +/// +/// This will trigger a windows firewall prompt. +/// If you don't have firewall tunneling tech you can set this to false to avoid the prompt. +/// @ingroup Networking) +/// /// public bool fn_setNetPort (int port, bool bind) @@ -11859,7 +14827,15 @@ public bool fn_setNetPort (int port, bool bind) return SafeNativeMethods.mwle_fn_setNetPort(port, bind)>=1; } /// -/// @brief Sets the pixel shader version for the active device. This can be used to force a lower pixel shader version than is supported by the device for testing or performance optimization. @param version The floating point shader version number. @note This will only affect shaders/materials created after the call and should be used before the game begins. @see $pref::Video::forcedPixVersion @ingroup GFX ) +/// @brief Sets the pixel shader version for the active device. +/// This can be used to force a lower pixel shader version than is supported by +/// the device for testing or performance optimization. +/// @param version The floating point shader version number. +/// @note This will only affect shaders/materials created after the call +/// and should be used before the game begins. +/// @see $pref::Video::forcedPixVersion +/// @ingroup GFX ) +/// /// public void fn_setPixelShaderVersion (float version) @@ -11870,7 +14846,13 @@ public void fn_setPixelShaderVersion (float version) SafeNativeMethods.mwle_fn_setPixelShaderVersion(version); } /// -/// Set the current seed for the random number generator. Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to the same sequence of pseudo-random numbers. If -1, the current timestamp will be used as the seed which is a good basis for randomization. @ingroup Random ) +/// Set the current seed for the random number generator. +/// Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). +/// @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to +/// the same sequence of pseudo-random numbers. +/// If -1, the current timestamp will be used as the seed which is a good basis for randomization. +/// @ingroup Random ) +/// /// public void fn_setRandomSeed (int seed) @@ -11881,7 +14863,21 @@ public void fn_setRandomSeed (int seed) SafeNativeMethods.mwle_fn_setRandomSeed(seed); } /// -/// Replace the record in @a text at the given @a index with @a replacement. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to replace. @param replacement The string with which to replace the record. @return A new string with the record at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" @endtsexample @see getRecord @see setWord @see setField @ingroup FieldManip ) +/// Replace the record in @a text at the given @a index with @a replacement. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to replace. +/// @param replacement The string with which to replace the record. +/// @return A new string with the record at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see setWord +/// @see setField +/// @ingroup FieldManip ) +/// /// public string fn_setRecord (string text, int index, string replacement) @@ -11901,7 +14897,9 @@ public string fn_setRecord (string text, int index, string replacement) } /// -/// Set the reflection texture format. @ingroup GFX ) +/// Set the reflection texture format. +/// @ingroup GFX ) +/// /// public void fn_setReflectFormat (int format) @@ -11913,6 +14911,7 @@ public void fn_setReflectFormat (int format) } /// /// setServerInfo(...); ) +/// /// public bool fn_setServerInfo (uint index) @@ -11924,6 +14923,7 @@ public bool fn_setServerInfo (uint index) } /// /// ), string sShadowSystemName) +/// /// public bool fn_setShadowManager (string sShadowSystemName) @@ -11938,6 +14938,7 @@ public bool fn_setShadowManager (string sShadowSystemName) } /// /// ), ) +/// /// public string fn_setShadowVizLight (string name) @@ -11955,6 +14956,7 @@ public string fn_setShadowVizLight (string name) } /// /// settingObj.beginGroup(groupName, fromStart = false);) +/// /// public void fn_Settings_beginGroup (string settings, string groupName, bool includeDefaults) @@ -11972,6 +14974,7 @@ public void fn_Settings_beginGroup (string settings, string groupName, bool incl } /// /// settingObj.clearGroups();) +/// /// public void fn_Settings_clearGroups (string settings) @@ -11986,6 +14989,7 @@ public void fn_Settings_clearGroups (string settings) } /// /// settingObj.endGroup();) +/// /// public void fn_Settings_endGroup (string settings) @@ -12000,6 +15004,7 @@ public void fn_Settings_endGroup (string settings) } /// /// , false, false), settingObj.findFirstValue();) +/// /// public string fn_Settings_findFirstValue (string settings, string pattern, bool deepSearch, bool includeDefaults) @@ -12020,6 +15025,7 @@ public string fn_Settings_findFirstValue (string settings, string pattern, bool } /// /// settingObj.findNextValue();) +/// /// public string fn_Settings_findNextValue (string settings) @@ -12037,6 +15043,7 @@ public string fn_Settings_findNextValue (string settings) } /// /// settingObj.getCurrentGroups();) +/// /// public string fn_Settings_getCurrentGroups (string settings) @@ -12054,6 +15061,7 @@ public string fn_Settings_getCurrentGroups (string settings) } /// /// %success = settingObj.read();) +/// /// public bool fn_Settings_read (string settings) @@ -12068,6 +15076,7 @@ public bool fn_Settings_read (string settings) } /// /// settingObj.remove(settingName, includeDefaults = false);) +/// /// public void fn_Settings_remove (string settings, string settingName, bool includeDefaults) @@ -12085,6 +15094,7 @@ public void fn_Settings_remove (string settings, string settingName, bool includ } /// /// settingObj.setDefaultValue(settingName, value);) +/// /// public void fn_Settings_setDefaultValue (string settings, string settingName, string value) @@ -12105,6 +15115,7 @@ public void fn_Settings_setDefaultValue (string settings, string settingName, st } /// /// ), settingObj.setValue(settingName, value);) +/// /// public void fn_Settings_setValue (string settings, string settingName, string value) @@ -12125,6 +15136,7 @@ public void fn_Settings_setValue (string settings, string settingName, string va } /// /// ), settingObj.value(settingName, defaultValue);) +/// /// public string fn_Settings_value (string settings, string settingName, string defaultValue) @@ -12147,7 +15159,13 @@ public string fn_Settings_value (string settings, string settingName, string def } /// -/// (string varName, string value) @brief Sets the value of the named variable. @param varName Name of the variable to locate @param value New value of the variable @return True if variable was successfully found and set @ingroup Scripting) +/// (string varName, string value) +/// @brief Sets the value of the named variable. +/// @param varName Name of the variable to locate +/// @param value New value of the variable +/// @return True if variable was successfully found and set +/// @ingroup Scripting) +/// /// public void fn_setVariable (string varName, string value) @@ -12164,7 +15182,21 @@ public void fn_setVariable (string varName, string value) SafeNativeMethods.mwle_fn_setVariable(sbvarName, sbvalue); } /// -/// Replace the word in @a text at the given @a index with @a replacement. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to replace. @param replacement The string with which to replace the word. @return A new string with the word at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" @endtsexample @see getWord @see setField @see setRecord @ingroup FieldManip ) +/// Replace the word in @a text at the given @a index with @a replacement. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to replace. +/// @param replacement The string with which to replace the word. +/// @return A new string with the word at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" +/// @endtsexample +/// @see getWord +/// @see setField +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string fn_setWord (string text, int index, string replacement) @@ -12184,7 +15216,12 @@ public string fn_setWord (string text, int index, string replacement) } /// -/// @brief Set the zoom speed of the camera. This affects how quickly the camera changes from one field of view to another. @param speed The camera's zoom speed in ms per 90deg FOV change @ingroup CameraSystem) +/// @brief Set the zoom speed of the camera. +/// This affects how quickly the camera changes from one field of view +/// to another. +/// @param speed The camera's zoom speed in ms per 90deg FOV change +/// @ingroup CameraSystem) +/// /// public void fn_setZoomSpeed (int speed) @@ -12195,7 +15232,25 @@ public void fn_setZoomSpeed (int speed) SafeNativeMethods.mwle_fn_setZoomSpeed(speed); } /// -/// Try to create a new sound device using the given properties. If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, if this function fails, it will not restore the previously active device but rather leave the sound system in an uninitialized state. Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized playback and then resume normal playback once the device has been created. In the core scripts, sound is automatically set up during startup in the sfxStartup() function. @param provider The name of the device provider as returned by sfxGetAvailableDevices(). @param device The name of the device as returned by sfxGetAvailableDevices(). @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. @return True if the initialization was successful, false if not. @note This function must be called before any of the sound playback functions can be used. @see sfxGetAvailableDevices @see sfxGetDeviceInfo @see sfxDeleteDevice @ref SFX_devices @ingroup SFX ) +/// Try to create a new sound device using the given properties. +/// If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, +/// if this function fails, it will not restore the previously active device but rather leave the sound system in an +/// uninitialized state. +/// Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized +/// playback and then resume normal playback once the device has been created. +/// In the core scripts, sound is automatically set up during startup in the sfxStartup() function. +/// @param provider The name of the device provider as returned by sfxGetAvailableDevices(). +/// @param device The name of the device as returned by sfxGetAvailableDevices(). +/// @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. +/// @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. +/// @return True if the initialization was successful, false if not. +/// @note This function must be called before any of the sound playback functions can be used. +/// @see sfxGetAvailableDevices +/// @see sfxGetDeviceInfo +/// @see sfxDeleteDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public bool fn_sfxCreateDevice (string provider, string device, bool useHardware, int maxBuffers) @@ -12212,7 +15267,13 @@ public bool fn_sfxCreateDevice (string provider, string device, bool useHardware return SafeNativeMethods.mwle_fn_sfxCreateDevice(sbprovider, sbdevice, useHardware, maxBuffers)>=1; } /// -/// , , , ), ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) Creates a new paused sound source using a profile or a description and filename. The return value is the source which must be released by delete(). @hide ) +/// , , , ), +/// ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) +/// Creates a new paused sound source using a profile or a description +/// and filename. The return value is the source which must be +/// released by delete(). +/// @hide ) +/// /// public int fn_sfxCreateSource (string SFXType, string filename, string x, string y, string z) @@ -12238,7 +15299,14 @@ public int fn_sfxCreateSource (string SFXType, string filename, string x, string return SafeNativeMethods.mwle_fn_sfxCreateSource(sbSFXType, sbfilename, sbx, sby, sbz); } /// -/// Delete the currently active sound device and release all its resources. SFXSources that are still playing will be transitioned to virtualized playback mode. When creating a new device, they will automatically transition back to normal playback. In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. @see sfxCreateDevice @ref SFX_devices @ingroup SFX ) +/// Delete the currently active sound device and release all its resources. +/// SFXSources that are still playing will be transitioned to virtualized playback mode. +/// When creating a new device, they will automatically transition back to normal playback. +/// In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. +/// @see sfxCreateDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public void fn_sfxDeleteDevice () @@ -12250,7 +15318,11 @@ public void fn_sfxDeleteDevice () SafeNativeMethods.mwle_fn_sfxDeleteDevice(); } /// -/// Mark the given @a source for deletion as soon as it moves into stopped state. This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). @param source A sound source. @ingroup SFX ) +/// Mark the given @a source for deletion as soon as it moves into stopped state. +/// This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). +/// @param source A sound source. +/// @ingroup SFX ) +/// /// public void fn_sfxDeleteWhenStopped (string source) @@ -12264,7 +15336,14 @@ public void fn_sfxDeleteWhenStopped (string source) SafeNativeMethods.mwle_fn_sfxDeleteWhenStopped(sbsource); } /// -/// Dump information about all current SFXSource instances to the console. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @see SFXSource @see sfxDumpSourcesToString @ingroup SFX ) +/// Dump information about all current SFXSource instances to the console. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @see SFXSource +/// @see sfxDumpSourcesToString +/// @ingroup SFX ) +/// /// public void fn_sfxDumpSources (bool includeGroups) @@ -12275,7 +15354,15 @@ public void fn_sfxDumpSources (bool includeGroups) SafeNativeMethods.mwle_fn_sfxDumpSources(includeGroups); } /// -/// Dump information about all current SFXSource instances to a string. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @return A string containing a dump of information about all currently instantiated SFXSources. @see SFXSource @see sfxDumpSources @ingroup SFX ) +/// Dump information about all current SFXSource instances to a string. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @return A string containing a dump of information about all currently instantiated SFXSources. +/// @see SFXSource +/// @see sfxDumpSources +/// @ingroup SFX ) +/// /// public string fn_sfxDumpSourcesToString (bool includeGroups) @@ -12289,7 +15376,19 @@ public string fn_sfxDumpSourcesToString (bool includeGroups) } /// -/// Return a newline-separated list of all active states. @return A list of the form @verbatim stateName1 NL stateName2 NL stateName3 ... @endverbatim where each element is the name of an active state object. @tsexample // Disable all active states. foreach$( %state in sfxGetActiveStates() ) %state.disable(); @endtsexample @ingroup SFX ) +/// Return a newline-separated list of all active states. +/// @return A list of the form +/// @verbatim +/// stateName1 NL stateName2 NL stateName3 ... +/// @endverbatim +/// where each element is the name of an active state object. +/// @tsexample +/// // Disable all active states. +/// foreach$( %state in sfxGetActiveStates() ) +/// %state.disable(); +/// @endtsexample +/// @ingroup SFX ) +/// /// public string fn_sfxGetActiveStates () @@ -12304,7 +15403,29 @@ public string fn_sfxGetActiveStates () } /// -/// Get a list of all available sound devices. The return value will be a newline-separated list of entries where each line describes one available sound device. Each such line will have the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. @return A newline-separated list of information about all available sound devices. @see sfxCreateDevice @see sfxGetDeviceInfo @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @ref SFX_devices @ingroup SFX ) +/// Get a list of all available sound devices. +/// The return value will be a newline-separated list of entries where each line describes one available sound +/// device. Each such line will have the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// @return A newline-separated list of information about all available sound devices. +/// @see sfxCreateDevice +/// @see sfxGetDeviceInfo +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string fn_sfxGetAvailableDevices () @@ -12319,7 +15440,36 @@ public string fn_sfxGetAvailableDevices () } /// -/// Return information about the currently active sound device. The return value is a tab-delimited string of the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. - caps: A bitfield of capability flags. @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. @see sfxCreateDevice @see sfxGetAvailableDevices @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @see $SFX::DEVICE_INFO_CAPS @see $SFX::DEVICE_CAPS_REVERB @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT @see $SFX::DEVICE_CAPS_OCCLUSION @see $SFX::DEVICE_CAPS_DSPEFFECTS @see $SFX::DEVICE_CAPS_MULTILISTENER @see $SFX::DEVICE_CAPS_FMODDESIGNER @ref SFX_devices @ingroup SFX ) +/// Return information about the currently active sound device. +/// The return value is a tab-delimited string of the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// - caps: A bitfield of capability flags. +/// @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. +/// @see sfxCreateDevice +/// @see sfxGetAvailableDevices +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @see $SFX::DEVICE_INFO_CAPS +/// @see $SFX::DEVICE_CAPS_REVERB +/// @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT +/// @see $SFX::DEVICE_CAPS_OCCLUSION +/// @see $SFX::DEVICE_CAPS_DSPEFFECTS +/// @see $SFX::DEVICE_CAPS_MULTILISTENER +/// @see $SFX::DEVICE_CAPS_FMODDESIGNER +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string fn_sfxGetDeviceInfo () @@ -12334,7 +15484,12 @@ public string fn_sfxGetDeviceInfo () } /// -/// Get the falloff curve type currently being applied to 3D sounds. @return The current distance model type. @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the falloff curve type currently being applied to 3D sounds. +/// @return The current distance model type. +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public int fn_sfxGetDistanceModel () @@ -12346,7 +15501,12 @@ public int fn_sfxGetDistanceModel () return SafeNativeMethods.mwle_fn_sfxGetDistanceModel(); } /// -/// Get the current global doppler effect setting. @return The current global doppler effect scale factor (>=0). @see sfxSetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Get the current global doppler effect setting. +/// @return The current global doppler effect scale factor (>=0). +/// @see sfxSetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public float fn_sfxGetDopplerFactor () @@ -12358,7 +15518,14 @@ public float fn_sfxGetDopplerFactor () return SafeNativeMethods.mwle_fn_sfxGetDopplerFactor(); } /// -/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. @return The current scale factor for logarithmic 3D sound falloff curves. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. +/// @return The current scale factor for logarithmic 3D sound falloff curves. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public float fn_sfxGetRolloffFactor () @@ -12370,7 +15537,10 @@ public float fn_sfxGetRolloffFactor () return SafeNativeMethods.mwle_fn_sfxGetRolloffFactor(); } /// -/// , , ), Start playing the given source or create a new source for the given track and play it. @hide ) +/// , , ), +/// Start playing the given source or create a new source for the given track and play it. +/// @hide ) +/// /// public int fn_sfxPlay (string trackName, string pointOrX, string y, string z) @@ -12393,7 +15563,11 @@ public int fn_sfxPlay (string trackName, string pointOrX, string y, string z) return SafeNativeMethods.mwle_fn_sfxPlay(sbtrackName, sbpointOrX, sby, sbz); } /// -/// , , , -1.0f), SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) Create a new play-once source for the given profile or description+filename and start playback of the source. @hide ) +/// , , , -1.0f), +/// SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) +/// Create a new play-once source for the given profile or description+filename and start playback of the source. +/// @hide ) +/// /// public int fn_sfxPlayOnce (string SFXType, string filename, string x, string y, string z, float fadeInTime) @@ -12419,7 +15593,11 @@ public int fn_sfxPlayOnce (string SFXType, string filename, string x, string y, return SafeNativeMethods.mwle_fn_sfxPlayOnce(sbSFXType, sbfilename, sbx, sby, sbz, fadeInTime); } /// -/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. @param model The distance model to use for 3D sound. @note This setting takes effect globally and is applied to all 3D sounds. @ingroup SFX ) +/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. +/// @param model The distance model to use for 3D sound. +/// @note This setting takes effect globally and is applied to all 3D sounds. +/// @ingroup SFX ) +/// /// public void fn_sfxSetDistanceModel (int model) @@ -12430,7 +15608,13 @@ public void fn_sfxSetDistanceModel (int model) SafeNativeMethods.mwle_fn_sfxSetDistanceModel(model); } /// -/// Set the global doppler effect scale factor. @param value The new doppler shift scale factor. @pre @a value must be >= 0. @see sfxGetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Set the global doppler effect scale factor. +/// @param value The new doppler shift scale factor. +/// @pre @a value must be >= 0. +/// @see sfxGetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public void fn_sfxSetDopplerFactor (float value) @@ -12441,7 +15625,16 @@ public void fn_sfxSetDopplerFactor (float value) SafeNativeMethods.mwle_fn_sfxSetDopplerFactor(value); } /// -/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. @param value The new scale factor for logarithmic 3D sound falloff curves. @pre @a value must be > 0. @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. +/// @param value The new scale factor for logarithmic 3D sound falloff curves. +/// @pre @a value must be > 0. +/// @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public void fn_sfxSetRolloffFactor (float value) @@ -12452,7 +15645,11 @@ public void fn_sfxSetRolloffFactor (float value) SafeNativeMethods.mwle_fn_sfxSetRolloffFactor(value); } /// -/// ), ( vector position [, vector direction ] ) Set the position and orientation of a 3D sound source. @hide ) +/// ), +/// ( vector position [, vector direction ] ) +/// Set the position and orientation of a 3D sound source. +/// @hide ) +/// /// public void fn_SFXSource_setTransform (string sfxsource, string position, string direction) @@ -12472,7 +15669,11 @@ public void fn_SFXSource_setTransform (string sfxsource, string position, string SafeNativeMethods.mwle_fn_SFXSource_setTransform(sbsfxsource, sbposition, sbdirection); } /// -/// Stop playback of the given @a source. This is equivalent to calling SFXSource::stop(). @param source The source to put into stopped state. @ingroup SFX ) +/// Stop playback of the given @a source. +/// This is equivalent to calling SFXSource::stop(). +/// @param source The source to put into stopped state. +/// @ingroup SFX ) +/// /// public void fn_sfxStop (string source) @@ -12486,7 +15687,15 @@ public void fn_sfxStop (string source) SafeNativeMethods.mwle_fn_sfxStop(sbsource); } /// -/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. The advantage of this function over directly calling delete() is that it will correctly handle volume fades that may be configured on the source. Whereas calling delete() would immediately stop playback and delete the source, this functionality will wait for the fade-out to play and only then stop the source and delete it. @param source A sound source. @ref SFXSource_fades @ingroup SFX ) +/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. +/// The advantage of this function over directly calling delete() is that it will correctly +/// handle volume fades that may be configured on the source. Whereas calling delete() would immediately +/// stop playback and delete the source, this functionality will wait for the fade-out to play and only then +/// stop the source and delete it. +/// @param source A sound source. +/// @ref SFXSource_fades +/// @ingroup SFX ) +/// /// public void fn_sfxStopAndDelete (string source) @@ -12500,7 +15709,13 @@ public void fn_sfxStopAndDelete (string source) SafeNativeMethods.mwle_fn_sfxStopAndDelete(sbsource); } /// -/// , ), (string executable, string args, string directory) @brief Launches an outside executable or batch file @param executable Name of the executable or batch file @param args Optional list of arguments, in string format, to pass to the executable @param directory Optional string containing path to output or shell @ingroup Platform) +/// , ), (string executable, string args, string directory) +/// @brief Launches an outside executable or batch file +/// @param executable Name of the executable or batch file +/// @param args Optional list of arguments, in string format, to pass to the executable +/// @param directory Optional string containing path to output or shell +/// @ingroup Platform) +/// /// public bool fn_shellExecute (string executable, string args, string directory) @@ -12520,7 +15735,10 @@ public bool fn_shellExecute (string executable, string args, string directory) return SafeNativeMethods.mwle_fn_shellExecute(sbexecutable, sbargs, sbdirectory)>=1; } /// -/// (idx) Get the component corresponding to the given index. @param idx An integer index value corresponding to the desired component. @return The id of the component at the given index as an integer) +/// (idx) Get the component corresponding to the given index. +/// @param idx An integer index value corresponding to the desired component. +/// @return The id of the component at the given index as an integer) +/// /// public int fn_SimComponent_getComponent (string simcomponent, int idx) @@ -12534,7 +15752,9 @@ public int fn_SimComponent_getComponent (string simcomponent, int idx) return SafeNativeMethods.mwle_fn_SimComponent_getComponent(sbsimcomponent, idx); } /// -/// () Get the current component count @return The number of components in the list as an integer) +/// () Get the current component count +/// @return The number of components in the list as an integer) +/// /// public int fn_SimComponent_getComponentCount (string simcomponent) @@ -12548,7 +15768,9 @@ public int fn_SimComponent_getComponentCount (string simcomponent) return SafeNativeMethods.mwle_fn_SimComponent_getComponentCount(sbsimcomponent); } /// -/// () Check whether SimComponent is currently a template @return true if is a template and false if not) +/// () Check whether SimComponent is currently a template +/// @return true if is a template and false if not) +/// /// public bool fn_SimComponent_getIsTemplate (string simcomponent) @@ -12562,7 +15784,9 @@ public bool fn_SimComponent_getIsTemplate (string simcomponent) return SafeNativeMethods.mwle_fn_SimComponent_getIsTemplate(sbsimcomponent)>=1; } /// -/// () Check whether SimComponent is currently enabled @return true if enabled and false if not) +/// () Check whether SimComponent is currently enabled +/// @return true if enabled and false if not) +/// /// public bool fn_SimComponent_isEnabled (string simcomponent) @@ -12576,7 +15800,10 @@ public bool fn_SimComponent_isEnabled (string simcomponent) return SafeNativeMethods.mwle_fn_SimComponent_isEnabled(sbsimcomponent)>=1; } /// -/// (enabled) Sets or unsets the enabled flag @param enabled Boolean value @return No return value) +/// (enabled) Sets or unsets the enabled flag +/// @param enabled Boolean value +/// @return No return value) +/// /// public void fn_SimComponent_setEnabled (string simcomponent, bool enabled) @@ -12590,7 +15817,10 @@ public void fn_SimComponent_setEnabled (string simcomponent, bool enabled) SafeNativeMethods.mwle_fn_SimComponent_setEnabled(sbsimcomponent, enabled); } /// -/// (template) Sets or unsets the template flag @param template Boolean value @return No return value) +/// (template) Sets or unsets the template flag +/// @param template Boolean value +/// @return No return value) +/// /// public void fn_SimComponent_setIsTemplate (string simcomponent, bool templateFlag) @@ -12605,6 +15835,7 @@ public void fn_SimComponent_setIsTemplate (string simcomponent, bool templateFla } /// /// Reload the datablock. This can only be used with a local client configuration. ) +/// /// public void fn_SimDataBlock_reloadOnLocalClient (string simdatablock) @@ -13237,6 +16468,7 @@ public void fn_SimObject_setSuperClassNamespace (string simobject, string name) } /// /// () - Try to bind unresolved persistent IDs in the set. ) +/// /// public void fn_SimPersistSet_resolvePersistentIds (string simpersistset) @@ -13251,6 +16483,7 @@ public void fn_SimPersistSet_resolvePersistentIds (string simpersistset) } /// /// addPoint( F32 value, F32 time ) ) +/// /// public void fn_SimResponseCurve_addPoint (string simresponsecurve, float value, float time) @@ -13265,6 +16498,7 @@ public void fn_SimResponseCurve_addPoint (string simresponsecurve, float value, } /// /// clear() ) +/// /// public void fn_SimResponseCurve_clear (string simresponsecurve) @@ -13279,6 +16513,7 @@ public void fn_SimResponseCurve_clear (string simresponsecurve) } /// /// getValue( F32 time ) ) +/// /// public float fn_SimResponseCurve_getValue (string simresponsecurve, float time) @@ -13293,6 +16528,7 @@ public float fn_SimResponseCurve_getValue (string simresponsecurve, float time) } /// /// () Delete all objects in the set. ) +/// /// public void fn_SimSet_deleteAllObjects (string simset) @@ -13306,7 +16542,9 @@ public void fn_SimSet_deleteAllObjects (string simset) SafeNativeMethods.mwle_fn_SimSet_deleteAllObjects(sbsimset); } /// -/// () Get the number of direct and indirect child objects contained in the set. @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// () Get the number of direct and indirect child objects contained in the set. +/// @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// /// public int fn_SimSet_getFullCount (string simset) @@ -13320,7 +16558,9 @@ public int fn_SimSet_getFullCount (string simset) return SafeNativeMethods.mwle_fn_SimSet_getFullCount(sbsimset); } /// -/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. +/// @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// /// public void fn_SimSet_sort (string simset, string callbackFunction) @@ -13337,7 +16577,12 @@ public void fn_SimSet_sort (string simset, string callbackFunction) SafeNativeMethods.mwle_fn_SimSet_sort(sbsimset, sbcallbackFunction); } /// -/// (string attributeName) @brief Get float attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of a float. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get float attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of a float. +/// @deprecated Use attribute().) +/// /// public float fn_SimXMLDocument_attributeF32 (string simxmldocument, string attributeName) @@ -13354,7 +16599,12 @@ public float fn_SimXMLDocument_attributeF32 (string simxmldocument, string attri return SafeNativeMethods.mwle_fn_SimXMLDocument_attributeF32(sbsimxmldocument, sbattributeName); } /// -/// (string attributeName) @brief Get int attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of an integer. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get int attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of an integer. +/// @deprecated Use attribute().) +/// /// public int fn_SimXMLDocument_attributeS32 (string simxmldocument, string attributeName) @@ -13371,7 +16621,11 @@ public int fn_SimXMLDocument_attributeS32 (string simxmldocument, string attribu return SafeNativeMethods.mwle_fn_SimXMLDocument_attributeS32(sbsimxmldocument, sbattributeName); } /// -/// @brief Determines the memory consumption of a class or object. @param objectOrClass The object or class being measured. @return Returns the total size of an object in bytes. @ingroup Debugging) +/// @brief Determines the memory consumption of a class or object. +/// @param objectOrClass The object or class being measured. +/// @return Returns the total size of an object in bytes. +/// @ingroup Debugging) +/// /// public int fn_sizeof (string objectOrClass) @@ -13386,6 +16640,7 @@ public int fn_sizeof (string objectOrClass) } /// /// ) +/// /// public void fn_SkyBox_postApply (string skybox) @@ -13399,7 +16654,25 @@ public void fn_SkyBox_postApply (string skybox) SafeNativeMethods.mwle_fn_SkyBox_postApply(sbskybox); } /// -/// @brief Prevents mouse movement from being processed In the source, whenever a mouse move event occurs GameTSCtrl::onMouseMove() is called. Whenever snapToggle() is called, it will flag a variable that can prevent this from happening: gSnapLine. This variable is not exposed to script, so you need to call this function to trigger it. @tsexample // Snapping is off by default, so we will toggle // it on first: PlayGui.snapToggle(); // Mouse movement should be disabled // Let's turn it back on PlayGui.snapToggle(); @endtsexample @ingroup GuiGame) +/// @brief Prevents mouse movement from being processed +/// +/// In the source, whenever a mouse move event occurs +/// GameTSCtrl::onMouseMove() is called. Whenever snapToggle() +/// is called, it will flag a variable that can prevent this +/// from happening: gSnapLine. This variable is not exposed to +/// script, so you need to call this function to trigger it. +/// +/// @tsexample +/// // Snapping is off by default, so we will toggle +/// // it on first: +/// PlayGui.snapToggle(); +/// // Mouse movement should be disabled +/// // Let's turn it back on +/// PlayGui.snapToggle(); +/// @endtsexample +/// +/// @ingroup GuiGame) +/// /// public void fn_snapToggle () @@ -13411,7 +16684,9 @@ public void fn_snapToggle () SafeNativeMethods.mwle_fn_snapToggle(); } /// -/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) @hide) +/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) +/// @hide) +/// /// public int fn_spawnObject (string spawnClass, string spawnDataBlock, string spawnName, string spawnProperties, string spawnScript, string modelName) @@ -13440,7 +16715,11 @@ public int fn_spawnObject (string spawnClass, string spawnDataBlock, string spaw return SafeNativeMethods.mwle_fn_spawnObject(sbspawnClass, sbspawnDataBlock, sbspawnName, sbspawnProperties, sbspawnScript, sbmodelName); } /// -/// ([string additionalProps]) Spawns the object based on the SpawnSphere's class, datablock, properties, and script settings. Allows you to pass in extra properties. @hide ) +/// ([string additionalProps]) Spawns the object based on the SpawnSphere's +/// class, datablock, properties, and script settings. Allows you to pass in +/// extra properties. +/// @hide ) +/// /// public int fn_SpawnSphere_spawnObject (string spawnsphere, string additionalProps) @@ -13457,7 +16736,14 @@ public int fn_SpawnSphere_spawnObject (string spawnsphere, string additionalProp return SafeNativeMethods.mwle_fn_SpawnSphere_spawnObject(sbspawnsphere, sbadditionalProps); } /// -/// Activates the shape replicator. @tsexample // Call the function StartClientReplication() @endtsexample @ingroup Foliage ) +/// Activates the shape replicator. +/// @tsexample +/// // Call the function +/// StartClientReplication() +/// @endtsexample +/// @ingroup Foliage +/// ) +/// /// public void fn_StartClientReplication () @@ -13469,7 +16755,11 @@ public void fn_StartClientReplication () SafeNativeMethods.mwle_fn_StartClientReplication(); } /// -/// @brief Start watching resources for file changes Typically this is called during initializeCore(). @see stopFileChangeNotifications() @ingroup FileSystem) +/// @brief Start watching resources for file changes +/// Typically this is called during initializeCore(). +/// @see stopFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void fn_startFileChangeNotifications () @@ -13481,7 +16771,13 @@ public void fn_startFileChangeNotifications () SafeNativeMethods.mwle_fn_startFileChangeNotifications(); } /// -/// Activates the foliage replicator. @tsexample // Call the function StartFoliageReplication(); @endtsexample @ingroup Foliage) +/// Activates the foliage replicator. +/// @tsexample +/// // Call the function +/// StartFoliageReplication(); +/// @endtsexample +/// @ingroup Foliage) +/// /// public void fn_StartFoliageReplication () @@ -13494,6 +16790,7 @@ public void fn_StartFoliageReplication () } /// /// startHeartbeat(...); ) +/// /// public void fn_startHeartbeat () @@ -13506,6 +16803,7 @@ public void fn_startHeartbeat () } /// /// startPrecisionTimer() - Create and start a high resolution platform timer. Returns the timer id. ) +/// /// public int fn_startPrecisionTimer () @@ -13517,7 +16815,18 @@ public int fn_startPrecisionTimer () return SafeNativeMethods.mwle_fn_startPrecisionTimer(); } /// -/// Test whether the given string begins with the given prefix. @param str The string to test. @param prefix The potential prefix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. @tsexample startsWith( \"TEST123\", \"test\" ) // Returns true. @endtsexample @see endsWith @ingroup Strings ) +/// Test whether the given string begins with the given prefix. +/// @param str The string to test. +/// @param prefix The potential prefix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"test\" ) // Returns true. +/// @endtsexample +/// @see endsWith +/// @ingroup Strings ) +/// /// public bool fn_startsWith (string str, string prefix, bool caseSensitive) @@ -13534,7 +16843,11 @@ public bool fn_startsWith (string str, string prefix, bool caseSensitive) return SafeNativeMethods.mwle_fn_startsWith(sbstr, sbprefix, caseSensitive)>=1; } /// -/// THEORA, 30.0f, Point2I::Zero ), Begins a video capture session. @see stopVideoCapture @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Begins a video capture session. +/// @see stopVideoCapture +/// @ingroup Rendering ) +/// /// public void fn_startVideoCapture (string canvas, string filename, string encoder, float framerate, string resolution) @@ -13558,6 +16871,7 @@ public void fn_startVideoCapture (string canvas, string filename, string encoder } /// /// @internal) +/// /// public bool fn_StaticShape_getPoweredState (string staticshape) @@ -13571,7 +16885,9 @@ public bool fn_StaticShape_getPoweredState (string staticshape) return SafeNativeMethods.mwle_fn_StaticShape_getPoweredState(sbstaticshape)>=1; } /// -/// (bool isPowered) @internal) +/// (bool isPowered) +/// @internal) +/// /// public void fn_StaticShape_setPoweredState (string staticshape, bool isPowered) @@ -13585,7 +16901,11 @@ public void fn_StaticShape_setPoweredState (string staticshape, bool isPowered) SafeNativeMethods.mwle_fn_StaticShape_setPoweredState(sbstaticshape, isPowered); } /// -/// @brief Stop watching resources for file changes Typically this is called during shutdownCore(). @see startFileChangeNotifications() @ingroup FileSystem) +/// @brief Stop watching resources for file changes +/// Typically this is called during shutdownCore(). +/// @see startFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void fn_stopFileChangeNotifications () @@ -13598,6 +16918,7 @@ public void fn_stopFileChangeNotifications () } /// /// stopHeartbeat(...); ) +/// /// public void fn_stopHeartbeat () @@ -13610,6 +16931,7 @@ public void fn_stopHeartbeat () } /// /// stopPrecisionTimer( S32 id ) - Stop and destroy timer with the passed id. Returns the elapsed milliseconds. ) +/// /// public int fn_stopPrecisionTimer (int id) @@ -13620,7 +16942,10 @@ public int fn_stopPrecisionTimer (int id) return SafeNativeMethods.mwle_fn_stopPrecisionTimer(id); } /// -/// () @brief Stops the rendering sampler @ingroup Rendering) +/// () +/// @brief Stops the rendering sampler +/// @ingroup Rendering) +/// /// public void fn_stopSampling () @@ -13633,6 +16958,7 @@ public void fn_stopSampling () } /// /// stopServerQuery(...); ) +/// /// public void fn_stopServerQuery () @@ -13644,7 +16970,10 @@ public void fn_stopServerQuery () SafeNativeMethods.mwle_fn_stopServerQuery(); } /// -/// Stops the video capture session. @see startVideoCapture @ingroup Rendering ) +/// Stops the video capture session. +/// @see startVideoCapture +/// @ingroup Rendering ) +/// /// public void fn_stopVideoCapture () @@ -13656,7 +16985,11 @@ public void fn_stopVideoCapture () SafeNativeMethods.mwle_fn_stopVideoCapture(); } /// -/// Return the integer character code value corresponding to the first character in the given string. @param chr a (one-character) string. @return the UTF32 code value for the first character in the given string. @ingroup Strings ) +/// Return the integer character code value corresponding to the first character in the given string. +/// @param chr a (one-character) string. +/// @return the UTF32 code value for the first character in the given string. +/// @ingroup Strings ) +/// /// public int fn_strasc (string chr) @@ -13670,7 +17003,13 @@ public int fn_strasc (string chr) return SafeNativeMethods.mwle_fn_strasc(sbchr); } /// -/// Find the first occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strrchr @ingroup Strings ) +/// Find the first occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strrchr +/// @ingroup Strings ) +/// /// public string fn_strchr (string str, string chr) @@ -13690,7 +17029,16 @@ public string fn_strchr (string str, string chr) } /// -/// Find the first occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strchrpos( \"test\", \"s\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the first occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strchrpos( \"test\", \"s\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strchrpos (string str, string chr, int start) @@ -13707,7 +17055,19 @@ public int fn_strchrpos (string str, string chr, int start) return SafeNativeMethods.mwle_fn_strchrpos(sbstr, sbchr, start); } /// -/// Compares two strings using case-b>sensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >1 otherwise. @tsexample if( strcmp( %var, \"foobar\" ) == 0 ) echo( \"%var is equal to 'foobar'\" ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using case-b>sensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >1 otherwise. +/// @tsexample +/// if( strcmp( %var, \"foobar\" ) == 0 ) +/// echo( \"%var is equal to 'foobar'\" ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int fn_strcmp (string str1, string str2) @@ -13724,7 +17084,16 @@ public int fn_strcmp (string str1, string str2) return SafeNativeMethods.mwle_fn_strcmp(sbstr1, sbstr2); } /// -/// Format the given value as a string using printf-style formatting. @param format A printf-style format string. @param value The value argument matching the given format string. @tsexample // Convert the given integer value to a string in a hex notation. %hex = strformat( \"%x\", %value ); @endtsexample @ingroup Strings @see http://en.wikipedia.org/wiki/Printf ) +/// Format the given value as a string using printf-style formatting. +/// @param format A printf-style format string. +/// @param value The value argument matching the given format string. +/// @tsexample +/// // Convert the given integer value to a string in a hex notation. +/// %hex = strformat( \"%x\", %value ); +/// @endtsexample +/// @ingroup Strings +/// @see http://en.wikipedia.org/wiki/Printf ) +/// /// public string fn_strformat (string format, string value) @@ -13744,7 +17113,19 @@ public string fn_strformat (string format, string value) } /// -/// Compares two strings using case-b>insensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >0 otherwise. @tsexample if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) echo( \"this is always true\" ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using case-b>insensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >0 otherwise. +/// @tsexample +/// if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) +/// echo( \"this is always true\" ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int fn_stricmp (string str1, string str2) @@ -13761,7 +17142,35 @@ public int fn_stricmp (string str1, string str2) return SafeNativeMethods.mwle_fn_stricmp(sbstr1, sbstr2); } /// -/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int fn_strinatcmp (string str1, string str2) @@ -13778,7 +17187,15 @@ public int fn_strinatcmp (string str1, string str2) return SafeNativeMethods.mwle_fn_strinatcmp(sbstr1, sbstr2); } /// -/// Remove all occurrences of characters contained in @a chars from @a str. @param str The string to filter characters out from. @param chars A string of characters to filter out from @a str. @return A version of @a str with all occurrences of characters contained in @a chars filtered out. @tsexample stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". @endtsexample @ingroup Strings ) +/// Remove all occurrences of characters contained in @a chars from @a str. +/// @param str The string to filter characters out from. +/// @param chars A string of characters to filter out from @a str. +/// @return A version of @a str with all occurrences of characters contained in @a chars filtered out. +/// @tsexample +/// stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_stripChars (string str, string chars) @@ -13798,7 +17215,18 @@ public string fn_stripChars (string str, string chars) } /// -/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. @param inString String to strip TorqueML control characters from. @tsexample // Define the string to strip TorqueML control characters from %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; // Request the stripped version of the string %strippedString = StripMLControlChars(%string); @endtsexample @return Version of the inputted string with all TorqueML characters removed. @see References @ingroup GuiCore) +/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. +/// @param inString String to strip TorqueML control characters from. +/// @tsexample +/// // Define the string to strip TorqueML control characters from +/// %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; +/// // Request the stripped version of the string +/// %strippedString = StripMLControlChars(%string); +/// @endtsexample +/// @return Version of the inputted string with all TorqueML characters removed. +/// @see References +/// @ingroup GuiCore) +/// /// public string fn_StripMLControlChars (string inString) @@ -13815,7 +17243,15 @@ public string fn_StripMLControlChars (string inString) } /// -/// Strip a numeric suffix from the given string. @param str The string from which to strip its numeric suffix. @return The string @a str without its number suffix or the original string @a str if it has no such suffix. @tsexample stripTrailingNumber( \"test123\" ) // Returns \"test\". @endtsexample @see getTrailingNumber @ingroup Strings ) +/// Strip a numeric suffix from the given string. +/// @param str The string from which to strip its numeric suffix. +/// @return The string @a str without its number suffix or the original string @a str if it has no such suffix. +/// @tsexample +/// stripTrailingNumber( \"test123\" ) // Returns \"test\". +/// @endtsexample +/// @see getTrailingNumber +/// @ingroup Strings ) +/// /// public string fn_stripTrailingNumber (string str) @@ -13832,7 +17268,19 @@ public string fn_stripTrailingNumber (string str) } /// -/// Match a pattern against a string. @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match any number of characters and '?' to match a single character. @param str The string which should be matched against @a pattern. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches the given @a pattern. @tsexample strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. @endtsexample @see strIsMatchMultipleExpr @ingroup Strings ) +/// Match a pattern against a string. +/// @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match +/// any number of characters and '?' to match a single character. +/// @param str The string which should be matched against @a pattern. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches the given @a pattern. +/// @tsexample +/// strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchMultipleExpr +/// @ingroup Strings ) +/// /// public bool fn_strIsMatchExpr (string pattern, string str, bool caseSensitive) @@ -13849,7 +17297,19 @@ public bool fn_strIsMatchExpr (string pattern, string str, bool caseSensitive) return SafeNativeMethods.mwle_fn_strIsMatchExpr(sbpattern, sbstr, caseSensitive)>=1; } /// -/// Match a multiple patterns against a single string. @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match any number of characters and '?' to match a single character. Each of the patterns is tried in turn. @param str The string which should be matched against @a patterns. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches any of the given @a patterns. @tsexample strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. @endtsexample @see strIsMatchExpr @ingroup Strings ) +/// Match a multiple patterns against a single string. +/// @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match +/// any number of characters and '?' to match a single character. Each of the patterns is tried in turn. +/// @param str The string which should be matched against @a patterns. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches any of the given @a patterns. +/// @tsexample +/// strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Strings ) +/// /// public bool fn_strIsMatchMultipleExpr (string patterns, string str, bool caseSensitive) @@ -13866,7 +17326,12 @@ public bool fn_strIsMatchMultipleExpr (string patterns, string str, bool caseSen return SafeNativeMethods.mwle_fn_strIsMatchMultipleExpr(sbpatterns, sbstr, caseSensitive)>=1; } /// -/// Get the length of the given string in bytes. @note This does b>not/b> return a true character count for strings with multi-byte characters! @param str A string. @return The length of the given string in bytes. @ingroup Strings ) +/// Get the length of the given string in bytes. +/// @note This does b>not/b> return a true character count for strings with multi-byte characters! +/// @param str A string. +/// @return The length of the given string in bytes. +/// @ingroup Strings ) +/// /// public int fn_strlen (string str) @@ -13880,7 +17345,15 @@ public int fn_strlen (string str) return SafeNativeMethods.mwle_fn_strlen(sbstr); } /// -/// Return an all lower-case version of the given string. @param str A string. @return A version of @a str with all characters converted to lower-case. @tsexample strlwr( \"TesT1\" ) // Returns \"test1\" @endtsexample @see strupr @ingroup Strings ) +/// Return an all lower-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to lower-case. +/// @tsexample +/// strlwr( \"TesT1\" ) // Returns \"test1\" +/// @endtsexample +/// @see strupr +/// @ingroup Strings ) +/// /// public string fn_strlwr (string str) @@ -13897,7 +17370,35 @@ public string fn_strlwr (string str) } /// -/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int fn_strnatcmp (string str1, string str2) @@ -13914,7 +17415,15 @@ public int fn_strnatcmp (string str1, string str2) return SafeNativeMethods.mwle_fn_strnatcmp(sbstr1, sbstr2); } /// -/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. @param haystack The string to search. @param needle The string to search for. @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. @tsexample strpos( \"b ab\", \"b\", 1 ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. +/// @param haystack The string to search. +/// @param needle The string to search for. +/// @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. +/// @tsexample +/// strpos( \"b ab\", \"b\", 1 ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strpos (string haystack, string needle, int offset) @@ -13931,7 +17440,13 @@ public int fn_strpos (string haystack, string needle, int offset) return SafeNativeMethods.mwle_fn_strpos(sbhaystack, sbneedle, offset); } /// -/// Find the last occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strchr @ingroup Strings ) +/// Find the last occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strchr +/// @ingroup Strings ) +/// /// public string fn_strrchr (string str, string chr) @@ -13951,7 +17466,16 @@ public string fn_strrchr (string str, string chr) } /// -/// Find the last occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strrchrpos( \"test\", \"t\" ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the last occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strrchrpos( \"test\", \"t\" ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strrchrpos (string str, string chr, int start) @@ -13968,7 +17492,17 @@ public int fn_strrchrpos (string str, string chr, int start) return SafeNativeMethods.mwle_fn_strrchrpos(sbstr, sbchr, start); } /// -/// ), Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. @param str The string to repeat multiple times. @param numTimes The number of times to repeat @a str in the result string. @param delimiter The string to put between each repetition of @a str. @return A string containing @a str repeated @a numTimes times. @tsexample strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". @endtsexample @ingroup Strings ) +/// ), +/// Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. +/// @param str The string to repeat multiple times. +/// @param numTimes The number of times to repeat @a str in the result string. +/// @param delimiter The string to put between each repetition of @a str. +/// @return A string containing @a str repeated @a numTimes times. +/// @tsexample +/// strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_strrepeat (string str, int numTimes, string delimiter) @@ -13988,7 +17522,16 @@ public string fn_strrepeat (string str, int numTimes, string delimiter) } /// -/// Replace all occurrences of @a from in @a source with @a to. @param source The string in which to replace the occurrences of @a from. @param from The string to replace in @a source. @param to The string with which to replace occurrences of @from. @return A string with all occurrences of @a from in @a source replaced by @a to. @tsexample strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". @endtsexample @ingroup Strings ) +/// Replace all occurrences of @a from in @a source with @a to. +/// @param source The string in which to replace the occurrences of @a from. +/// @param from The string to replace in @a source. +/// @param to The string with which to replace occurrences of @from. +/// @return A string with all occurrences of @a from in @a source replaced by @a to. +/// @tsexample +/// strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_strreplace (string source, string from, string to) @@ -14011,7 +17554,15 @@ public string fn_strreplace (string source, string from, string to) } /// -/// Find the start of @a substring in the given @a string searching from left to right. @param string The string to search. @param substring The string to search for. @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. @tsexample strstr( \"abcd\", \"c\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the start of @a substring in the given @a string searching from left to right. +/// @param string The string to search. +/// @param substring The string to search for. +/// @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. +/// @tsexample +/// strstr( \"abcd\", \"c\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strstr (string stringx, string substring) @@ -14029,6 +17580,7 @@ public int fn_strstr (string stringx, string substring) } /// /// strToPlayerName(string); ) +/// /// public string fn_strToPlayerName (string ptr) @@ -14045,7 +17597,15 @@ public string fn_strToPlayerName (string ptr) } /// -/// Return an all upper-case version of the given string. @param str A string. @return A version of @a str with all characters converted to upper-case. @tsexample strupr( \"TesT1\" ) // Returns \"TEST1\" @endtsexample @see strlwr @ingroup Strings ) +/// Return an all upper-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to upper-case. +/// @tsexample +/// strupr( \"TesT1\" ) // Returns \"TEST1\" +/// @endtsexample +/// @see strlwr +/// @ingroup Strings ) +/// /// public string fn_strupr (string str) @@ -14063,6 +17623,7 @@ public string fn_strupr (string str) } /// /// animate( F32 duration, F32 startAzimuth, F32 endAzimuth, F32 startElevation, F32 endElevation )) +/// /// public void fn_Sun_animate (string sun, float duration, float startAzimuth, float endAzimuth, float startElevation, float endElevation) @@ -14077,6 +17638,7 @@ public void fn_Sun_animate (string sun, float duration, float startAzimuth, floa } /// /// ) +/// /// public void fn_Sun_apply (string sun) @@ -14090,7 +17652,13 @@ public void fn_Sun_apply (string sun) SafeNativeMethods.mwle_fn_Sun_apply(sbsun); } /// -/// @brief Initializes and open the telnet console. @param port Port to listen on for console connections (0 will shut down listening). @param consolePass Password for read/write access to console. @param listenPass Password for read access to console. @param remoteEcho [optional] Enable echoing back to the client, off by default. @ingroup Debugging) +/// @brief Initializes and open the telnet console. +/// @param port Port to listen on for console connections (0 will shut down listening). +/// @param consolePass Password for read/write access to console. +/// @param listenPass Password for read access to console. +/// @param remoteEcho [optional] Enable echoing back to the client, off by default. +/// @ingroup Debugging) +/// /// public void fn_telnetSetParameters (int port, string consolePass, string listenPass, bool remoteEcho) @@ -14108,6 +17676,7 @@ public void fn_telnetSetParameters (int port, string consolePass, string listenP } /// /// png), (string filename, [string format]) - export the terrain block's heightmap to a bitmap file (default: png) ) +/// /// public bool fn_TerrainBlock_exportHeightMap (string terrainblock, string fileNameStr, string format) @@ -14128,6 +17697,7 @@ public bool fn_TerrainBlock_exportHeightMap (string terrainblock, string fileNam } /// /// png), (string filePrefix, [string format]) - export the terrain block's layer maps to bitmap files (default: png) ) +/// /// public bool fn_TerrainBlock_exportLayerMaps (string terrainblock, string filePrefixStr, string format) @@ -14147,7 +17717,9 @@ public bool fn_TerrainBlock_exportLayerMaps (string terrainblock, string filePre return SafeNativeMethods.mwle_fn_TerrainBlock_exportLayerMaps(sbterrainblock, sbfilePrefixStr, sbformat)>=1; } /// -/// ( string matName ) Adds a new material. ) +/// ( string matName ) +/// Adds a new material. ) +/// /// public int fn_TerrainEditor_addMaterial (string terraineditor, string matName) @@ -14165,6 +17737,7 @@ public int fn_TerrainEditor_addMaterial (string terraineditor, string matName) } /// /// ), (TerrainBlock terrain)) +/// /// public void fn_TerrainEditor_attachTerrain (string terraineditor, string terrain) @@ -14181,21 +17754,23 @@ public void fn_TerrainEditor_attachTerrain (string terraineditor, string terrain SafeNativeMethods.mwle_fn_TerrainEditor_attachTerrain(sbterraineditor, sbterrain); } /// -/// (float minHeight, float maxHeight, float minSlope, float maxSlope)) +/// (F32 minHeight, F32 maxHeight, F32 minSlope, F32 maxSlope , F32 coverage)) +/// /// -public void fn_TerrainEditor_autoMaterialLayer (string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope) +public void fn_TerrainEditor_autoMaterialLayer (string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope, float coverage) { if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_TerrainEditor_autoMaterialLayer'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" \"{4}\" ",terraineditor,minHeight,maxHeight,minSlope,maxSlope)); +System.Console.WriteLine("----------------->Extern Call 'fn_TerrainEditor_autoMaterialLayer'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" \"{4}\" \"{5}\" ",terraineditor,minHeight,maxHeight,minSlope,maxSlope,coverage)); StringBuilder sbterraineditor = null; if (terraineditor != null) sbterraineditor = new StringBuilder(terraineditor, 1024); -SafeNativeMethods.mwle_fn_TerrainEditor_autoMaterialLayer(sbterraineditor, minHeight, maxHeight, minSlope, maxSlope); +SafeNativeMethods.mwle_fn_TerrainEditor_autoMaterialLayer(sbterraineditor, minHeight, maxHeight, minSlope, maxSlope, coverage); } /// /// ) +/// /// public void fn_TerrainEditor_clearSelection (string terraineditor) @@ -14210,6 +17785,7 @@ public void fn_TerrainEditor_clearSelection (string terraineditor) } /// /// (int num)) +/// /// public string fn_TerrainEditor_getActionName (string terraineditor, uint index) @@ -14227,6 +17803,7 @@ public string fn_TerrainEditor_getActionName (string terraineditor, uint index) } /// /// ) +/// /// public int fn_TerrainEditor_getActiveTerrain (string terraineditor) @@ -14241,6 +17818,7 @@ public int fn_TerrainEditor_getActiveTerrain (string terraineditor) } /// /// Returns a Point2I.) +/// /// public string fn_TerrainEditor_getBrushPos (string terraineditor) @@ -14258,6 +17836,7 @@ public string fn_TerrainEditor_getBrushPos (string terraineditor) } /// /// ()) +/// /// public float fn_TerrainEditor_getBrushPressure (string terraineditor) @@ -14272,6 +17851,7 @@ public float fn_TerrainEditor_getBrushPressure (string terraineditor) } /// /// ()) +/// /// public string fn_TerrainEditor_getBrushSize (string terraineditor) @@ -14289,6 +17869,7 @@ public string fn_TerrainEditor_getBrushSize (string terraineditor) } /// /// ()) +/// /// public float fn_TerrainEditor_getBrushSoftness (string terraineditor) @@ -14303,6 +17884,7 @@ public float fn_TerrainEditor_getBrushSoftness (string terraineditor) } /// /// ()) +/// /// public string fn_TerrainEditor_getBrushType (string terraineditor) @@ -14320,6 +17902,7 @@ public string fn_TerrainEditor_getBrushType (string terraineditor) } /// /// ) +/// /// public string fn_TerrainEditor_getCurrentAction (string terraineditor) @@ -14337,6 +17920,7 @@ public string fn_TerrainEditor_getCurrentAction (string terraineditor) } /// /// Returns the current material count. ) +/// /// public int fn_TerrainEditor_getMaterialCount (string terraineditor) @@ -14351,6 +17935,7 @@ public int fn_TerrainEditor_getMaterialCount (string terraineditor) } /// /// ( string name ) - Returns the index of the material with the given name or -1. ) +/// /// public int fn_TerrainEditor_getMaterialIndex (string terraineditor, string name) @@ -14368,6 +17953,7 @@ public int fn_TerrainEditor_getMaterialIndex (string terraineditor, string name) } /// /// ( int index ) - Returns the name of the material at the given index. ) +/// /// public string fn_TerrainEditor_getMaterialName (string terraineditor, int index) @@ -14385,6 +17971,7 @@ public string fn_TerrainEditor_getMaterialName (string terraineditor, int index) } /// /// () gets the list of current terrain materials.) +/// /// public string fn_TerrainEditor_getMaterials (string terraineditor) @@ -14402,6 +17989,7 @@ public string fn_TerrainEditor_getMaterials (string terraineditor) } /// /// ) +/// /// public int fn_TerrainEditor_getNumActions (string terraineditor) @@ -14416,6 +18004,7 @@ public int fn_TerrainEditor_getNumActions (string terraineditor) } /// /// ) +/// /// public int fn_TerrainEditor_getNumTextures (string terraineditor) @@ -14430,6 +18019,7 @@ public int fn_TerrainEditor_getNumTextures (string terraineditor) } /// /// ) +/// /// public float fn_TerrainEditor_getSlopeLimitMaxAngle (string terraineditor) @@ -14444,6 +18034,7 @@ public float fn_TerrainEditor_getSlopeLimitMaxAngle (string terraineditor) } /// /// ) +/// /// public float fn_TerrainEditor_getSlopeLimitMinAngle (string terraineditor) @@ -14458,6 +18049,7 @@ public float fn_TerrainEditor_getSlopeLimitMinAngle (string terraineditor) } /// /// (S32 index)) +/// /// public int fn_TerrainEditor_getTerrainBlock (string terraineditor, int index) @@ -14472,6 +18064,7 @@ public int fn_TerrainEditor_getTerrainBlock (string terraineditor, int index) } /// /// ()) +/// /// public int fn_TerrainEditor_getTerrainBlockCount (string terraineditor) @@ -14486,6 +18079,7 @@ public int fn_TerrainEditor_getTerrainBlockCount (string terraineditor) } /// /// () gets the list of current terrain materials for all terrain blocks.) +/// /// public string fn_TerrainEditor_getTerrainBlocksMaterialList (string terraineditor) @@ -14502,7 +18096,12 @@ public string fn_TerrainEditor_getTerrainBlocksMaterialList (string terrainedito } /// -/// , , ), (x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found).) +/// , , ), +/// (x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found).) +/// /// public int fn_TerrainEditor_getTerrainUnderWorldPoint (string terraineditor, string ptOrX, string Y, string Z) @@ -14526,6 +18125,7 @@ public int fn_TerrainEditor_getTerrainUnderWorldPoint (string terraineditor, str } /// /// ) +/// /// public void fn_TerrainEditor_markEmptySquares (string terraineditor) @@ -14540,6 +18140,7 @@ public void fn_TerrainEditor_markEmptySquares (string terraineditor) } /// /// ) +/// /// public void fn_TerrainEditor_mirrorTerrain (string terraineditor, int mirrorIndex) @@ -14554,6 +18155,7 @@ public void fn_TerrainEditor_mirrorTerrain (string terraineditor, int mirrorInde } /// /// ), (string action=NULL)) +/// /// public void fn_TerrainEditor_processAction (string terraineditor, string action) @@ -14571,6 +18173,7 @@ public void fn_TerrainEditor_processAction (string terraineditor, string action) } /// /// ( int index ) - Remove the material at the given index. ) +/// /// public void fn_TerrainEditor_removeMaterial (string terraineditor, int index) @@ -14584,7 +18187,9 @@ public void fn_TerrainEditor_removeMaterial (string terraineditor, int index) SafeNativeMethods.mwle_fn_TerrainEditor_removeMaterial(sbterraineditor, index); } /// -/// ( int index, int order ) - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// ( int index, int order ) +/// - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// /// public void fn_TerrainEditor_reorderMaterial (string terraineditor, int index, int orderPos) @@ -14599,6 +18204,7 @@ public void fn_TerrainEditor_reorderMaterial (string terraineditor, int index, i } /// /// (bool clear)) +/// /// public void fn_TerrainEditor_resetSelWeights (string terraineditor, bool clear) @@ -14613,6 +18219,7 @@ public void fn_TerrainEditor_resetSelWeights (string terraineditor, bool clear) } /// /// (string action_name)) +/// /// public void fn_TerrainEditor_setAction (string terraineditor, string action_name) @@ -14630,6 +18237,7 @@ public void fn_TerrainEditor_setAction (string terraineditor, string action_name } /// /// Location) +/// /// public void fn_TerrainEditor_setBrushPos (string terraineditor, string pos) @@ -14647,6 +18255,7 @@ public void fn_TerrainEditor_setBrushPos (string terraineditor, string pos) } /// /// (float pressure)) +/// /// public void fn_TerrainEditor_setBrushPressure (string terraineditor, float pressure) @@ -14661,6 +18270,7 @@ public void fn_TerrainEditor_setBrushPressure (string terraineditor, float press } /// /// (int w [, int h])) +/// /// public void fn_TerrainEditor_setBrushSize (string terraineditor, int w, int h) @@ -14675,6 +18285,7 @@ public void fn_TerrainEditor_setBrushSize (string terraineditor, int w, int h) } /// /// (float softness)) +/// /// public void fn_TerrainEditor_setBrushSoftness (string terraineditor, float softness) @@ -14688,7 +18299,9 @@ public void fn_TerrainEditor_setBrushSoftness (string terraineditor, float softn SafeNativeMethods.mwle_fn_TerrainEditor_setBrushSoftness(sbterraineditor, softness); } /// -/// (string type) One of box, ellipse, selection.) +/// (string type) +/// One of box, ellipse, selection.) +/// /// public void fn_TerrainEditor_setBrushType (string terraineditor, string type) @@ -14706,6 +18319,7 @@ public void fn_TerrainEditor_setBrushType (string terraineditor, string type) } /// /// ) +/// /// public float fn_TerrainEditor_setSlopeLimitMaxAngle (string terraineditor, float angle) @@ -14720,6 +18334,7 @@ public float fn_TerrainEditor_setSlopeLimitMaxAngle (string terraineditor, float } /// /// ) +/// /// public float fn_TerrainEditor_setSlopeLimitMinAngle (string terraineditor, float angle) @@ -14734,6 +18349,7 @@ public float fn_TerrainEditor_setSlopeLimitMinAngle (string terraineditor, float } /// /// (bool overlayEnable) - sets the terraformer current heightmap to draw as an overlay over the current terrain.) +/// /// public void fn_TerrainEditor_setTerraformOverlay (string terraineditor, bool overlayEnable) @@ -14747,7 +18363,9 @@ public void fn_TerrainEditor_setTerraformOverlay (string terraineditor, bool ove SafeNativeMethods.mwle_fn_TerrainEditor_setTerraformOverlay(sbterraineditor, overlayEnable); } /// -/// ( int index, string matName ) Changes the material name at the index. ) +/// ( int index, string matName ) +/// Changes the material name at the index. ) +/// /// public bool fn_TerrainEditor_updateMaterial (string terraineditor, uint index, string matName) @@ -14765,6 +18383,7 @@ public bool fn_TerrainEditor_updateMaterial (string terraineditor, uint index, s } /// /// ( TerrainBlock obj, F32 factor, U32 steps )) +/// /// public void fn_TerrainSmoothAction_smooth (string terrainsmoothaction, string terrain, float factor, uint steps) @@ -14782,6 +18401,7 @@ public void fn_TerrainSmoothAction_smooth (string terrainsmoothaction, string te } /// /// () ) +/// /// public void fn_TerrainSolderEdgesAction_solder (string terrainsolderedgesaction) @@ -14796,6 +18416,7 @@ public void fn_TerrainSolderEdgesAction_solder (string terrainsolderedgesaction) } /// /// testBridge(arg1, arg2, arg3)) +/// /// public string fn_testJavaScriptBridge (string arg1, string arg2, string arg3) @@ -14819,6 +18440,7 @@ public string fn_testJavaScriptBridge (string arg1, string arg2, string arg3) } /// /// Pause playback of the video. ) +/// /// public void fn_TheoraTextureObject_pause (string theoratextureobject) @@ -14833,6 +18455,7 @@ public void fn_TheoraTextureObject_pause (string theoratextureobject) } /// /// Start playback of the video. ) +/// /// public void fn_TheoraTextureObject_play (string theoratextureobject) @@ -14847,6 +18470,7 @@ public void fn_TheoraTextureObject_play (string theoratextureobject) } /// /// Stop playback of the video. ) +/// /// public void fn_TheoraTextureObject_stop (string theoratextureobject) @@ -14860,7 +18484,13 @@ public void fn_TheoraTextureObject_stop (string theoratextureobject) SafeNativeMethods.mwle_fn_TheoraTextureObject_stop(sbtheoratextureobject); } /// -/// Enable or disable tracing in the script code VM. When enabled, the script code runtime will trace the invocation and returns from all functions that are called and log them to the console. This is helpful in observing the flow of the script program. @param enable New setting for script trace execution, on by default. @ingroup Debugging ) +/// Enable or disable tracing in the script code VM. +/// When enabled, the script code runtime will trace the invocation and returns +/// from all functions that are called and log them to the console. This is helpful in +/// observing the flow of the script program. +/// @param enable New setting for script trace execution, on by default. +/// @ingroup Debugging ) +/// /// public void fn_trace (bool enable) @@ -14871,7 +18501,14 @@ public void fn_trace (bool enable) SafeNativeMethods.mwle_fn_trace(enable); } /// -/// Remove leading and trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. @tsexample trim( \" string \" ); // Returns \"string\". @endtsexample @ingroup Strings ) +/// Remove leading and trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// trim( \" string \" ); // Returns \"string\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_trim (string str) @@ -14889,6 +18526,7 @@ public string fn_trim (string str) } /// /// tsUpdateImposterImages( bool forceupdate )) +/// /// public void fn_tsUpdateImposterImages (bool forceUpdate) @@ -14900,6 +18538,7 @@ public void fn_tsUpdateImposterImages (bool forceUpdate) } /// /// ), action.addToManager([undoManager])) +/// /// public void fn_UndoAction_addToManager (string undoaction, string undoManager) @@ -14917,6 +18556,7 @@ public void fn_UndoAction_addToManager (string undoaction, string undoManager) } /// /// () - Reo action contained in undo. ) +/// /// public void fn_UndoAction_redo (string undoaction) @@ -14931,6 +18571,7 @@ public void fn_UndoAction_redo (string undoaction) } /// /// () - Undo action contained in undo. ) +/// /// public void fn_UndoAction_undo (string undoaction) @@ -14945,6 +18586,7 @@ public void fn_UndoAction_undo (string undoaction) } /// /// Clears the undo manager.) +/// /// public void fn_UndoManager_clearAll (string undomanager) @@ -14959,6 +18601,7 @@ public void fn_UndoManager_clearAll (string undomanager) } /// /// UndoManager.getNextRedoName();) +/// /// public string fn_UndoManager_getNextRedoName (string undomanager) @@ -14976,6 +18619,7 @@ public string fn_UndoManager_getNextRedoName (string undomanager) } /// /// UndoManager.getNextUndoName();) +/// /// public string fn_UndoManager_getNextUndoName (string undomanager) @@ -14993,6 +18637,7 @@ public string fn_UndoManager_getNextUndoName (string undomanager) } /// /// (index)) +/// /// public int fn_UndoManager_getRedoAction (string undomanager, int index) @@ -15007,6 +18652,7 @@ public int fn_UndoManager_getRedoAction (string undomanager, int index) } /// /// ) +/// /// public int fn_UndoManager_getRedoCount (string undomanager) @@ -15021,6 +18667,7 @@ public int fn_UndoManager_getRedoCount (string undomanager) } /// /// (index)) +/// /// public string fn_UndoManager_getRedoName (string undomanager, int index) @@ -15038,6 +18685,7 @@ public string fn_UndoManager_getRedoName (string undomanager, int index) } /// /// (index)) +/// /// public int fn_UndoManager_getUndoAction (string undomanager, int index) @@ -15052,6 +18700,7 @@ public int fn_UndoManager_getUndoAction (string undomanager, int index) } /// /// ) +/// /// public int fn_UndoManager_getUndoCount (string undomanager) @@ -15066,6 +18715,7 @@ public int fn_UndoManager_getUndoCount (string undomanager) } /// /// (index)) +/// /// public string fn_UndoManager_getUndoName (string undomanager, int index) @@ -15083,6 +18733,7 @@ public string fn_UndoManager_getUndoName (string undomanager, int index) } /// /// ( bool discard=false ) - Pop the current CompoundUndoAction off the stack. ) +/// /// public void fn_UndoManager_popCompound (string undomanager, bool discard) @@ -15097,6 +18748,7 @@ public void fn_UndoManager_popCompound (string undomanager, bool discard) } /// /// \"\"), ( string name=\"\" ) - Push a CompoundUndoAction onto the compound stack for assembly. ) +/// /// public string fn_UndoManager_pushCompound (string undomanager, string name) @@ -15117,6 +18769,7 @@ public string fn_UndoManager_pushCompound (string undomanager, string name) } /// /// UndoManager.redo();) +/// /// public void fn_UndoManager_redo (string undomanager) @@ -15131,6 +18784,7 @@ public void fn_UndoManager_redo (string undomanager) } /// /// UndoManager.undo();) +/// /// public void fn_UndoManager_undo (string undomanager) @@ -15144,21 +18798,12 @@ public void fn_UndoManager_undo (string undomanager) SafeNativeMethods.mwle_fn_UndoManager_undo(sbundomanager); } /// -/// , false), ([searchString[, bool skipInteractive]]) @brief Run unit tests, or just the tests that prefix match against the searchString. @ingroup Console) -/// - -public void fn_unitTest_runTests (string searchString, bool skip) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_unitTest_runTests'" + string.Format("\"{0}\" \"{1}\" ",searchString,skip)); -StringBuilder sbsearchString = null; -if (searchString != null) - sbsearchString = new StringBuilder(searchString, 1024); - -SafeNativeMethods.mwle_fn_unitTest_runTests(sbsearchString, skip); -} -/// -/// (string queueName, string listener) @brief Unregisters an event message @param queueName String containing the name of queue @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Unregisters an event message +/// @param queueName String containing the name of queue +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public void fn_unregisterMessageListener (string queueName, string listenerName) @@ -15175,7 +18820,11 @@ public void fn_unregisterMessageListener (string queueName, string listenerName) SafeNativeMethods.mwle_fn_unregisterMessageListener(sbqueueName, sblistenerName); } /// -/// (string queueName) @brief Unregisters a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Unregisters a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void fn_unregisterMessageQueue (string queueName) @@ -15189,7 +18838,28 @@ public void fn_unregisterMessageQueue (string queueName) SafeNativeMethods.mwle_fn_unregisterMessageQueue(sbqueueName); } /// -/// Add two vectors. @param a The first vector. @param b The second vector. @return The vector @a a + @a b. @tsexample //----------------------------------------------------------------------------- // // VectorAdd( %a, %b ); // // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a + b = ( ax + bx, ay + by, az + bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; // %r = \"1 1 0\"; %r = VectorAdd( %a, %b ); @endtsexample @ingroup Vectors) +/// Add two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a + @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorAdd( %a, %b ); +/// // +/// // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a + b = ( ax + bx, ay + by, az + bz ) +/// // +/// //----------------------------------------------------------------------------- +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; +/// // %r = \"1 1 0\"; +/// %r = VectorAdd( %a, %b ); +/// @endtsexample +/// @ingroup Vectors) +/// /// public string fn_VectorAdd (string a, string b) @@ -15209,7 +18879,30 @@ public string fn_VectorAdd (string a, string b) } /// -/// Calculcate the cross product of two vectors. @param a The first vector. @param b The second vector. @return The cross product @a x @a b. @tsexample //----------------------------------------------------------------------------- // // VectorCross( %a, %b ); // // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; // %r = \"1 -1 -2\"; %r = VectorCross( %a, %b ); @endtsexample @ingroup Vectors ) +/// Calculcate the cross product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The cross product @a x @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorCross( %a, %b ); +/// // +/// // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; +/// // %r = \"1 -1 -2\"; +/// %r = VectorCross( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorCross (string a, string b) @@ -15229,7 +18922,32 @@ public string fn_VectorCross (string a, string b) } /// -/// Compute the distance between two vectors. @param a The first vector. @param b The second vector. @return The length( @a b - @a a ). @tsexample //----------------------------------------------------------------------------- // // VectorDist( %a, %b ); // // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a -> b = ||( b - a )|| // = ||( bx - ax, by - ay, bz - az )|| // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); // %r = mSqrt( 3 ); %r = VectorDist( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the distance between two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The length( @a b - @a a ). +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDist( %a, %b ); +/// // +/// // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a -> b = ||( b - a )|| +/// // = ||( bx - ax, by - ay, bz - az )|| +/// // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); +/// // %r = mSqrt( 3 ); +/// %r = VectorDist( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float fn_VectorDist (string a, string b) @@ -15246,7 +18964,30 @@ public float fn_VectorDist (string a, string b) return SafeNativeMethods.mwle_fn_VectorDist(sba, sbb); } /// -/// Compute the dot product of two vectors. @param a The first vector. @param b The second vector. @return The dot product @a a * @a b. @tsexample //----------------------------------------------------------------------------- // // VectorDot( %a, %b ); // // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: // // a . b = ( ax * bx + ay * by + az * bz ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; // %r = 2; %r = VectorDot( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the dot product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The dot product @a a * @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDot( %a, %b ); +/// // +/// // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: +/// // +/// // a . b = ( ax * bx + ay * by + az * bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; +/// // %r = 2; +/// %r = VectorDot( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float fn_VectorDot (string a, string b) @@ -15263,7 +19004,29 @@ public float fn_VectorDot (string a, string b) return SafeNativeMethods.mwle_fn_VectorDot(sba, sbb); } /// -/// Calculate the magnitude of the given vector. @param v A vector. @return The length of vector @a v. @tsexample //----------------------------------------------------------------------------- // // VectorLen( %a ); // // The length or magnitude of vector a, (ax, ay, az), is: // // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); // %r = mSqrt( 2 ); // %r = 1.414; %r = VectorLen( %a ); @endtsexample @ingroup Vectors ) +/// Calculate the magnitude of the given vector. +/// @param v A vector. +/// @return The length of vector @a v. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLen( %a ); +/// // +/// // The length or magnitude of vector a, (ax, ay, az), is: +/// // +/// // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// +/// // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); +/// // %r = mSqrt( 2 ); +/// // %r = 1.414; +/// %r = VectorLen( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float fn_VectorLen (string v) @@ -15277,7 +19040,35 @@ public float fn_VectorLen (string v) return SafeNativeMethods.mwle_fn_VectorLen(sbv); } /// -/// Linearly interpolate between two vectors by @a t. @param a Vector to start interpolation from. @param b Vector to interpolate to. @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector between @a a and @a b is returned. @return An interpolated vector between @a a and @a b. @tsexample //----------------------------------------------------------------------------- // // VectorLerp( %a, %b ); // // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is // weighted by the interpolation factor, t, is // // r = a + t * ( b - a ) // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; %v = \"0.25\"; // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; // %r = \"1.25 0.75 0.25\"; %r = VectorLerp( %a, %b ); @endtsexample @ingroup Vectors ) +/// Linearly interpolate between two vectors by @a t. +/// @param a Vector to start interpolation from. +/// @param b Vector to interpolate to. +/// @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector +/// between @a a and @a b is returned. +/// @return An interpolated vector between @a a and @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLerp( %a, %b ); +/// // +/// // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is +/// // weighted by the interpolation factor, t, is +/// // +/// // r = a + t * ( b - a ) +/// // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// %v = \"0.25\"; +/// +/// // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; +/// // %r = \"1.25 0.75 0.25\"; +/// %r = VectorLerp( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorLerp (string a, string b, float t) @@ -15297,7 +19088,30 @@ public string fn_VectorLerp (string a, string b, float t) } /// -/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. @param v The vector to normalize. @return The vector @a v scaled to length 1. @tsexample //----------------------------------------------------------------------------- // // VectorNormalize( %a ); // // The normalized vector a, (ax, ay, az), is: // // a^ = a / ||a|| // = ( ax / ||a||, ay / ||a||, az / ||a|| ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %l = 1.414; // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; // %r = \"0.707 0.707 0\"; %r = VectorNormalize( %a ); @endtsexample @ingroup Vectors ) +/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. +/// @param v The vector to normalize. +/// @return The vector @a v scaled to length 1. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorNormalize( %a ); +/// // +/// // The normalized vector a, (ax, ay, az), is: +/// // +/// // a^ = a / ||a|| +/// // = ( ax / ||a||, ay / ||a||, az / ||a|| ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %l = 1.414; +/// +/// // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; +/// // %r = \"0.707 0.707 0\"; +/// %r = VectorNormalize( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorNormalize (string v) @@ -15314,7 +19128,11 @@ public string fn_VectorNormalize (string v) } /// -/// Create an orthogonal basis from the given vector. @param aaf The vector to create the orthogonal basis from. @return A matrix representing the orthogonal basis. @ingroup Vectors ) +/// Create an orthogonal basis from the given vector. +/// @param aaf The vector to create the orthogonal basis from. +/// @return A matrix representing the orthogonal basis. +/// @ingroup Vectors ) +/// /// public string fn_VectorOrthoBasis (string aa) @@ -15332,6 +19150,7 @@ public string fn_VectorOrthoBasis (string aa) } /// /// (Vector3F, float) rotate a vector in 2d) +/// /// public string fn_VectorRot (string v, float angle) @@ -15348,7 +19167,30 @@ public string fn_VectorRot (string v, float angle) } /// -/// Scales a vector by a scalar. @param a The vector to scale. @param scalar The scale factor. @return The vector @a a * @a scalar. @tsexample //----------------------------------------------------------------------------- // // VectorScale( %a, %v ); // // Scaling vector a, (ax, ay, az), but the scalar, v, is: // // a * v = ( ax * v, ay * v, az * v ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %v = \"2\"; // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; // %r = \"2 2 0\"; %r = VectorScale( %a, %v ); @endtsexample @ingroup Vectors ) +/// Scales a vector by a scalar. +/// @param a The vector to scale. +/// @param scalar The scale factor. +/// @return The vector @a a * @a scalar. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorScale( %a, %v ); +/// // +/// // Scaling vector a, (ax, ay, az), but the scalar, v, is: +/// // +/// // a * v = ( ax * v, ay * v, az * v ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %v = \"2\"; +/// +/// // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; +/// // %r = \"2 2 0\"; +/// %r = VectorScale( %a, %v ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorScale (string a, float scalar) @@ -15365,7 +19207,30 @@ public string fn_VectorScale (string a, float scalar) } /// -/// Subtract two vectors. @param a The first vector. @param b The second vector. @return The vector @a a - @a b. @tsexample //----------------------------------------------------------------------------- // // VectorSub( %a, %b ); // // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a - b = ( ax - bx, ay - by, az - bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; // %r = \"1 -1 0\"; %r = VectorSub( %a, %b ); @endtsexample @ingroup Vectors ) +/// Subtract two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a - @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorSub( %a, %b ); +/// // +/// // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a - b = ( ax - bx, ay - by, az - bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// +/// // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; +/// // %r = \"1 -1 0\"; +/// %r = VectorSub( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorSub (string a, string b) @@ -15410,6 +19275,7 @@ public void fn_WalkaboutUpdateMesh (int meshid, int objid, bool remove) } /// /// ) +/// /// public void fn_WorldEditor_addUndoState (string worldeditor) @@ -15423,7 +19289,9 @@ public void fn_WorldEditor_addUndoState (string worldeditor) SafeNativeMethods.mwle_fn_WorldEditor_addUndoState(sbworldeditor); } /// -/// (int axis) Align all selected objects along the given axis.) +/// (int axis) +/// Align all selected objects along the given axis.) +/// /// public void fn_WorldEditor_alignByAxis (string worldeditor, int boundsAxis) @@ -15437,7 +19305,9 @@ public void fn_WorldEditor_alignByAxis (string worldeditor, int boundsAxis) SafeNativeMethods.mwle_fn_WorldEditor_alignByAxis(sbworldeditor, boundsAxis); } /// -/// (int boundsAxis) Align all selected objects against the given bounds axis.) +/// (int boundsAxis) +/// Align all selected objects against the given bounds axis.) +/// /// public void fn_WorldEditor_alignByBounds (string worldeditor, int boundsAxis) @@ -15452,6 +19322,7 @@ public void fn_WorldEditor_alignByBounds (string worldeditor, int boundsAxis) } /// /// ) +/// /// public bool fn_WorldEditor_canPasteSelection (string worldeditor) @@ -15466,6 +19337,7 @@ public bool fn_WorldEditor_canPasteSelection (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_clearIgnoreList (string worldeditor) @@ -15480,6 +19352,7 @@ public void fn_WorldEditor_clearIgnoreList (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_clearSelection (string worldeditor) @@ -15494,6 +19367,7 @@ public void fn_WorldEditor_clearSelection (string worldeditor) } /// /// ( String path ) - Export the combined geometry of all selected objects to the specified path in collada format. ) +/// /// public void fn_WorldEditor_colladaExportSelection (string worldeditor, string path) @@ -15511,6 +19385,7 @@ public void fn_WorldEditor_colladaExportSelection (string worldeditor, string pa } /// /// ) +/// /// public void fn_WorldEditor_copySelection (string worldeditor) @@ -15525,6 +19400,7 @@ public void fn_WorldEditor_copySelection (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_cutSelection (string worldeditor) @@ -15539,6 +19415,7 @@ public void fn_WorldEditor_cutSelection (string worldeditor) } /// /// ( bool skipUndo = false )) +/// /// public void fn_WorldEditor_dropSelection (string worldeditor, bool skipUndo) @@ -15553,6 +19430,7 @@ public void fn_WorldEditor_dropSelection (string worldeditor, bool skipUndo) } /// /// () - Replace selected Prefab objects with a SimGroup containing all children objects defined in the .prefab. ) +/// /// public void fn_WorldEditor_explodeSelectedPrefab (string worldeditor) @@ -15567,6 +19445,7 @@ public void fn_WorldEditor_explodeSelectedPrefab (string worldeditor) } /// /// () - Return the currently active WorldEditorSelection object. ) +/// /// public int fn_WorldEditor_getActiveSelection (string worldeditor) @@ -15581,6 +19460,7 @@ public int fn_WorldEditor_getActiveSelection (string worldeditor) } /// /// (int index)) +/// /// public int fn_WorldEditor_getSelectedObject (string worldeditor, int index) @@ -15595,6 +19475,7 @@ public int fn_WorldEditor_getSelectedObject (string worldeditor, int index) } /// /// ) +/// /// public string fn_WorldEditor_getSelectionCentroid (string worldeditor) @@ -15612,6 +19493,7 @@ public string fn_WorldEditor_getSelectionCentroid (string worldeditor) } /// /// ) +/// /// public string fn_WorldEditor_getSelectionExtent (string worldeditor) @@ -15629,6 +19511,7 @@ public string fn_WorldEditor_getSelectionExtent (string worldeditor) } /// /// ) +/// /// public float fn_WorldEditor_getSelectionRadius (string worldeditor) @@ -15643,6 +19526,7 @@ public float fn_WorldEditor_getSelectionRadius (string worldeditor) } /// /// () - Return the number of objects currently selected in the editor.) +/// /// public int fn_WorldEditor_getSelectionSize (string worldeditor) @@ -15656,7 +19540,9 @@ public int fn_WorldEditor_getSelectionSize (string worldeditor) return SafeNativeMethods.mwle_fn_WorldEditor_getSelectionSize(sbworldeditor); } /// -/// getSoftSnap() Is soft snapping always on?) +/// getSoftSnap() +/// Is soft snapping always on?) +/// /// public bool fn_WorldEditor_getSoftSnap (string worldeditor) @@ -15670,7 +19556,9 @@ public bool fn_WorldEditor_getSoftSnap (string worldeditor) return SafeNativeMethods.mwle_fn_WorldEditor_getSoftSnap(sbworldeditor)>=1; } /// -/// getSoftSnapBackfaceTolerance() The fraction of the soft snap radius that backfaces may be included.) +/// getSoftSnapBackfaceTolerance() +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public float fn_WorldEditor_getSoftSnapBackfaceTolerance (string worldeditor) @@ -15684,7 +19572,9 @@ public float fn_WorldEditor_getSoftSnapBackfaceTolerance (string worldeditor) return SafeNativeMethods.mwle_fn_WorldEditor_getSoftSnapBackfaceTolerance(sbworldeditor); } /// -/// getSoftSnapSize() Get the absolute size to trigger a soft snap.) +/// getSoftSnapSize() +/// Get the absolute size to trigger a soft snap.) +/// /// public float fn_WorldEditor_getSoftSnapSize (string worldeditor) @@ -15699,6 +19589,7 @@ public float fn_WorldEditor_getSoftSnapSize (string worldeditor) } /// /// (Object obj, bool hide)) +/// /// public void fn_WorldEditor_hideObject (string worldeditor, string obj, bool hide) @@ -15716,6 +19607,7 @@ public void fn_WorldEditor_hideObject (string worldeditor, string obj, bool hide } /// /// (bool hide)) +/// /// public void fn_WorldEditor_hideSelection (string worldeditor, bool hide) @@ -15730,6 +19622,7 @@ public void fn_WorldEditor_hideSelection (string worldeditor, bool hide) } /// /// ) +/// /// public void fn_WorldEditor_invalidateSelectionCentroid (string worldeditor) @@ -15744,6 +19637,7 @@ public void fn_WorldEditor_invalidateSelectionCentroid (string worldeditor) } /// /// (bool lock)) +/// /// public void fn_WorldEditor_lockSelection (string worldeditor, bool lockx) @@ -15758,6 +19652,7 @@ public void fn_WorldEditor_lockSelection (string worldeditor, bool lockx) } /// /// ( string filename ) - Save selected objects to a .prefab file and replace them in the level with a Prefab object. ) +/// /// public void fn_WorldEditor_makeSelectionPrefab (string worldeditor, string filename) @@ -15775,6 +19670,7 @@ public void fn_WorldEditor_makeSelectionPrefab (string worldeditor, string filen } /// /// ( Object A, Object B ) ) +/// /// public void fn_WorldEditor_mountRelative (string worldeditor, string objA, string objB) @@ -15795,6 +19691,7 @@ public void fn_WorldEditor_mountRelative (string worldeditor, string objA, strin } /// /// ) +/// /// public void fn_WorldEditor_pasteSelection (string worldeditor) @@ -15809,6 +19706,7 @@ public void fn_WorldEditor_pasteSelection (string worldeditor) } /// /// ( int objID )) +/// /// public void fn_WorldEditor_redirectConsole (string worldeditor, int objID) @@ -15823,6 +19721,7 @@ public void fn_WorldEditor_redirectConsole (string worldeditor, int objID) } /// /// ) +/// /// public void fn_WorldEditor_resetSelectedRotation (string worldeditor) @@ -15837,6 +19736,7 @@ public void fn_WorldEditor_resetSelectedRotation (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_resetSelectedScale (string worldeditor) @@ -15851,6 +19751,7 @@ public void fn_WorldEditor_resetSelectedScale (string worldeditor) } /// /// (SimObject obj)) +/// /// public void fn_WorldEditor_selectObject (string worldeditor, string objName) @@ -15868,6 +19769,7 @@ public void fn_WorldEditor_selectObject (string worldeditor, string objName) } /// /// ( id set ) - Set the currently active WorldEditorSelection object. ) +/// /// public void fn_WorldEditor_setActiveSelection (string worldeditor, string selection) @@ -15884,7 +19786,9 @@ public void fn_WorldEditor_setActiveSelection (string worldeditor, string select SafeNativeMethods.mwle_fn_WorldEditor_setActiveSelection(sbworldeditor, sbselection); } /// -/// setSoftSnap(bool) Allow soft snapping all of the time.) +/// setSoftSnap(bool) +/// Allow soft snapping all of the time.) +/// /// public void fn_WorldEditor_setSoftSnap (string worldeditor, bool enable) @@ -15898,7 +19802,9 @@ public void fn_WorldEditor_setSoftSnap (string worldeditor, bool enable) SafeNativeMethods.mwle_fn_WorldEditor_setSoftSnap(sbworldeditor, enable); } /// -/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) The fraction of the soft snap radius that backfaces may be included.) +/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public void fn_WorldEditor_setSoftSnapBackfaceTolerance (string worldeditor, float range) @@ -15912,7 +19818,9 @@ public void fn_WorldEditor_setSoftSnapBackfaceTolerance (string worldeditor, flo SafeNativeMethods.mwle_fn_WorldEditor_setSoftSnapBackfaceTolerance(sbworldeditor, range); } /// -/// setSoftSnapSize(F32) Set the absolute size to trigger a soft snap.) +/// setSoftSnapSize(F32) +/// Set the absolute size to trigger a soft snap.) +/// /// public void fn_WorldEditor_setSoftSnapSize (string worldeditor, float size) @@ -15926,7 +19834,9 @@ public void fn_WorldEditor_setSoftSnapSize (string worldeditor, float size) SafeNativeMethods.mwle_fn_WorldEditor_setSoftSnapSize(sbworldeditor, size); } /// -/// softSnapDebugRender(bool) Toggle soft snapping debug rendering.) +/// softSnapDebugRender(bool) +/// Toggle soft snapping debug rendering.) +/// /// public void fn_WorldEditor_softSnapDebugRender (string worldeditor, bool enable) @@ -15940,7 +19850,9 @@ public void fn_WorldEditor_softSnapDebugRender (string worldeditor, bool enable) SafeNativeMethods.mwle_fn_WorldEditor_softSnapDebugRender(sbworldeditor, enable); } /// -/// softSnapRender(bool) Render the soft snapping bounds.) +/// softSnapRender(bool) +/// Render the soft snapping bounds.) +/// /// public void fn_WorldEditor_softSnapRender (string worldeditor, bool enable) @@ -15954,7 +19866,9 @@ public void fn_WorldEditor_softSnapRender (string worldeditor, bool enable) SafeNativeMethods.mwle_fn_WorldEditor_softSnapRender(sbworldeditor, enable); } /// -/// softSnapRenderTriangle(bool) Render the soft snapped triangle.) +/// softSnapRenderTriangle(bool) +/// Render the soft snapped triangle.) +/// /// public void fn_WorldEditor_softSnapRenderTriangle (string worldeditor, bool enable) @@ -15968,7 +19882,9 @@ public void fn_WorldEditor_softSnapRenderTriangle (string worldeditor, bool enab SafeNativeMethods.mwle_fn_WorldEditor_softSnapRenderTriangle(sbworldeditor, enable); } /// -/// softSnapSizeByBounds(bool) Use selection bounds size as soft snap bounds.) +/// softSnapSizeByBounds(bool) +/// Use selection bounds size as soft snap bounds.) +/// /// public void fn_WorldEditor_softSnapSizeByBounds (string worldeditor, bool enable) @@ -15982,7 +19898,9 @@ public void fn_WorldEditor_softSnapSizeByBounds (string worldeditor, bool enable SafeNativeMethods.mwle_fn_WorldEditor_softSnapSizeByBounds(sbworldeditor, enable); } /// -/// transformSelection(...) Transform selection by given parameters.) +/// transformSelection(...) +/// Transform selection by given parameters.) +/// /// public void fn_WorldEditor_transformSelection (string worldeditor, bool position, string point, bool relativePos, bool rotate, string rotation, bool relativeRot, bool rotLocal, int scaleType, string scale, bool sRelative, bool sLocal) @@ -16006,6 +19924,7 @@ public void fn_WorldEditor_transformSelection (string worldeditor, bool position } /// /// (SimObject obj)) +/// /// public void fn_WorldEditor_unselectObject (string worldeditor, string objName) @@ -16022,7 +19941,9 @@ public void fn_WorldEditor_unselectObject (string worldeditor, string objName) SafeNativeMethods.mwle_fn_WorldEditor_unselectObject(sbworldeditor, sbobjName); } /// -/// Force all cached fonts to serialize themselves to the cache. @ingroup Font ) +/// Force all cached fonts to serialize themselves to the cache. +/// @ingroup Font ) +/// /// public void fn_writeFontCache () @@ -16034,7 +19955,9 @@ public void fn_writeFontCache () SafeNativeMethods.mwle_fn_writeFontCache(); } /// -/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) @hide) +/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) +/// @hide) +/// /// public bool fnActionMap_bind (string actionmap, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9) @@ -16072,7 +19995,29 @@ public bool fnActionMap_bind (string actionmap, string a2, string a3, string a4, return SafeNativeMethods.mwle_fnActionMap_bind(sbactionmap, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9)>=1; } /// -/// ), @brief Associates a make command and optional break command to a specified input device action. Must include parenthesis and semicolon in the make and break command strings. @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. @param makeCmd The command to execute when the device/action is made. @param breakCmd [optional] The command to execute when the device or action is unmade. @return True the bind was successful, false if the device was unknown or description failed. @tsexample // Print to the console when the spacebar is pressed function onSpaceDown() { echo(\"Space bar down!\"); } // Print to the console when the spacebar is released function onSpaceUp() { echo(\"Space bar up!\"); } // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); @endtsexample) +/// ), +/// @brief Associates a make command and optional break command to a specified input device action. +/// Must include parenthesis and semicolon in the make and break command strings. +/// @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. +/// @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. +/// @param makeCmd The command to execute when the device/action is made. +/// @param breakCmd [optional] The command to execute when the device or action is unmade. +/// @return True the bind was successful, false if the device was unknown or description failed. +/// @tsexample +/// // Print to the console when the spacebar is pressed +/// function onSpaceDown() +/// { +/// echo(\"Space bar down!\"); +/// } +/// // Print to the console when the spacebar is released +/// function onSpaceUp() +/// { +/// echo(\"Space bar up!\"); +/// } +/// // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events +/// moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); +/// @endtsexample) +/// /// public bool fnActionMap_bindCmd (string actionmap, string device, string action, string makeCmd, string breakCmd) @@ -16098,7 +20043,9 @@ public bool fnActionMap_bindCmd (string actionmap, string device, string action, return SafeNativeMethods.mwle_fnActionMap_bindCmd(sbactionmap, sbdevice, sbaction, sbmakeCmd, sbbreakCmd)>=1; } /// -/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) @hide) +/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) +/// @hide) +/// /// public bool fnActionMap_bindObj (string actionmap, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10) @@ -16139,7 +20086,24 @@ public bool fnActionMap_bindObj (string actionmap, string a2, string a3, string return SafeNativeMethods.mwle_fnActionMap_bindObj(sbactionmap, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10)>=1; } /// -/// @brief Gets the ActionMap binding for the specified command. Use getField() on the return value to get the device and action of the binding. @param command The function to search bindings for. @return The binding against the specified command. Returns an empty string(\"\") if a binding wasn't found. @tsexample // Find what the function \"jump()\" is bound to in moveMap %bind = moveMap.getBinding( \"jump\" ); if ( %bind !$= \"\" ) { // Find out what device is used in the binding %device = getField( %bind, 0 ); // Find out what action (such as a key) is used in the binding %action = getField( %bind, 1 ); } @endtsexample @see getField) +/// @brief Gets the ActionMap binding for the specified command. +/// Use getField() on the return value to get the device and action of the binding. +/// @param command The function to search bindings for. +/// @return The binding against the specified command. Returns an empty string(\"\") +/// if a binding wasn't found. +/// @tsexample +/// // Find what the function \"jump()\" is bound to in moveMap +/// %bind = moveMap.getBinding( \"jump\" ); +/// if ( %bind !$= \"\" ) +/// { +/// // Find out what device is used in the binding +/// %device = getField( %bind, 0 ); +/// // Find out what action (such as a key) is used in the binding +/// %action = getField( %bind, 1 ); +/// } +/// @endtsexample +/// @see getField) +/// /// public string fnActionMap_getBinding (string actionmap, string command) @@ -16159,7 +20123,18 @@ public string fnActionMap_getBinding (string actionmap, string command) } /// -/// @brief Gets ActionMap command for the device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The command against the specified device and action. @tsexample // Find what function is bound to a device\'s action // In this example, \"jump()\" was assigned to the space key in another script %command = moveMap.getCommand(\"keyboard\", \"space\"); // Should print \"jump\" in the console echo(%command) @endtsexample) +/// @brief Gets ActionMap command for the device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The command against the specified device and action. +/// @tsexample +/// // Find what function is bound to a device\'s action +/// // In this example, \"jump()\" was assigned to the space key in another script +/// %command = moveMap.getCommand(\"keyboard\", \"space\"); +/// // Should print \"jump\" in the console +/// echo(%command) +/// @endtsexample) +/// /// public string fnActionMap_getCommand (string actionmap, string device, string action) @@ -16182,7 +20157,15 @@ public string fnActionMap_getCommand (string actionmap, string device, string ac } /// -/// @brief Gets the Dead zone for the specified device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone or an empty string(\"\") if the mapping was not found. @tsexample %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Gets the Dead zone for the specified device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone +/// or an empty string(\"\") if the mapping was not found. +/// @tsexample +/// %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public string fnActionMap_getDeadZone (string actionmap, string device, string action) @@ -16205,7 +20188,14 @@ public string fnActionMap_getDeadZone (string actionmap, string device, string a } /// -/// @brief Get any scaling on the specified device and action. @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return Any scaling applied to the specified device and action. @tsexample %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Get any scaling on the specified device and action. +/// @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return Any scaling applied to the specified device and action. +/// @tsexample +/// %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public float fnActionMap_getScale (string actionmap, string device, string action) @@ -16225,7 +20215,16 @@ public float fnActionMap_getScale (string actionmap, string device, string actio return SafeNativeMethods.mwle_fnActionMap_getScale(sbactionmap, sbdevice, sbaction); } /// -/// @brief Determines if the specified device and action is inverted. Should only be used for scrolling devices or gamepad/joystick axes. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return True if the specified device and action is inverted. @tsexample %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) echo(\"Mouse's xAxis is inverted\"); @endtsexample) +/// @brief Determines if the specified device and action is inverted. +/// Should only be used for scrolling devices or gamepad/joystick axes. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the specified device and action is inverted. +/// @tsexample +/// %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) +/// echo(\"Mouse's xAxis is inverted\"); +/// @endtsexample) +/// /// public bool fnActionMap_isInverted (string actionmap, string device, string action) @@ -16245,7 +20244,14 @@ public bool fnActionMap_isInverted (string actionmap, string device, string acti return SafeNativeMethods.mwle_fnActionMap_isInverted(sbactionmap, sbdevice, sbaction)>=1; } /// -/// @brief Pop the ActionMap off the %ActionMap stack. Deactivates an %ActionMap and removes it from the @ActionMap stack. @tsexample // Deactivate moveMap moveMap.pop(); @endtsexample @see ActionMap) +/// @brief Pop the ActionMap off the %ActionMap stack. +/// Deactivates an %ActionMap and removes it from the @ActionMap stack. +/// @tsexample +/// // Deactivate moveMap +/// moveMap.pop(); +/// @endtsexample +/// @see ActionMap) +/// /// public void fnActionMap_pop (string actionmap) @@ -16259,7 +20265,14 @@ public void fnActionMap_pop (string actionmap) SafeNativeMethods.mwle_fnActionMap_pop(sbactionmap); } /// -/// @brief Push the ActionMap onto the %ActionMap stack. Activates an ActionMap and placees it at the top of the ActionMap stack. @tsexample // Make moveMap the active action map moveMap.push(); @endtsexample @see ActionMap) +/// @brief Push the ActionMap onto the %ActionMap stack. +/// Activates an ActionMap and placees it at the top of the ActionMap stack. +/// @tsexample +/// // Make moveMap the active action map +/// moveMap.push(); +/// @endtsexample +/// @see ActionMap) +/// /// public void fnActionMap_push (string actionmap) @@ -16273,7 +20286,15 @@ public void fnActionMap_push (string actionmap) SafeNativeMethods.mwle_fnActionMap_push(sbactionmap); } /// -/// @brief Saves the ActionMap to a file or dumps it to the console. @param fileName The file path to save the ActionMap to. If a filename is not specified the ActionMap will be dumped to the console. @param append Whether to write the ActionMap at the end of the file or overwrite it. @tsexample // Write out the actionmap into the config.cs file moveMap.save( \"scripts/client/config.cs\" ); @endtsexample) +/// @brief Saves the ActionMap to a file or dumps it to the console. +/// @param fileName The file path to save the ActionMap to. If a filename is not specified +/// the ActionMap will be dumped to the console. +/// @param append Whether to write the ActionMap at the end of the file or overwrite it. +/// @tsexample +/// // Write out the actionmap into the config.cs file +/// moveMap.save( \"scripts/client/config.cs\" ); +/// @endtsexample) +/// /// public void fnActionMap_save (string actionmap, string fileName, bool append) @@ -16290,7 +20311,14 @@ public void fnActionMap_save (string actionmap, string fileName, bool append) SafeNativeMethods.mwle_fnActionMap_save(sbactionmap, sbfileName, append); } /// -/// @brief Removes the binding on an input device and action. @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbind(\"keyboard\", \"space\"); @endtsexample) +/// @brief Removes the binding on an input device and action. +/// @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbind(\"keyboard\", \"space\"); +/// @endtsexample) +/// /// public bool fnActionMap_unbind (string actionmap, string device, string action) @@ -16310,7 +20338,15 @@ public bool fnActionMap_unbind (string actionmap, string device, string action) return SafeNativeMethods.mwle_fnActionMap_unbind(sbactionmap, sbdevice, sbaction)>=1; } /// -/// @brief Remove any object-binding on an input device and action. @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @param obj The object to perform unbind against. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); @endtsexample) +/// @brief Remove any object-binding on an input device and action. +/// @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @param obj The object to perform unbind against. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); +/// @endtsexample) +/// /// public bool fnActionMap_unbindObj (string actionmap, string device, string action, string obj) @@ -16333,7 +20369,8 @@ public bool fnActionMap_unbindObj (string actionmap, string device, string actio return SafeNativeMethods.mwle_fnActionMap_unbindObj(sbactionmap, sbdevice, sbaction, sbobj)>=1; } /// -/// ) +/// ) +/// /// public void fnAIPlayer_AISearchSimSet (string aiplayer, float fOV, float farDist, string ObjToSearch, string result) @@ -16353,7 +20390,53 @@ public void fnAIPlayer_AISearchSimSet (string aiplayer, float fOV, float farDist SafeNativeMethods.mwle_fnAIPlayer_AISearchSimSet(sbaiplayer, fOV, farDist, sbObjToSearch, sbresult); } /// -/// @brief Use this to stop aiming at an object or a point. @see setAimLocation() @see setAimObject()) +/// @brief Check whether an object is within a specified veiw cone. +/// @obj Object to check. (If blank, it will check the current target). +/// @fov view angle in degrees.(Defaults to 45) +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// + +public bool fnAIPlayer_checkInFoV (string aiplayer, string obj, float fov, bool checkEnabled) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnAIPlayer_checkInFoV'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" ",aiplayer,obj,fov,checkEnabled)); +StringBuilder sbaiplayer = null; +if (aiplayer != null) + sbaiplayer = new StringBuilder(aiplayer, 1024); +StringBuilder sbobj = null; +if (obj != null) + sbobj = new StringBuilder(obj, 1024); + +return SafeNativeMethods.mwle_fnAIPlayer_checkInFoV(sbaiplayer, sbobj, fov, checkEnabled)>=1; +} +/// +/// @brief Check whether an object is in line of sight. +/// @obj Object to check. (If blank, it will check the current target). +/// @useMuzzle Use muzzle position. Otherwise use eye position. (defaults to false). +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// + +public bool fnAIPlayer_checkInLos (string aiplayer, string obj, bool useMuzzle, bool checkEnabled) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnAIPlayer_checkInLos'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" ",aiplayer,obj,useMuzzle,checkEnabled)); +StringBuilder sbaiplayer = null; +if (aiplayer != null) + sbaiplayer = new StringBuilder(aiplayer, 1024); +StringBuilder sbobj = null; +if (obj != null) + sbobj = new StringBuilder(obj, 1024); + +return SafeNativeMethods.mwle_fnAIPlayer_checkInLos(sbaiplayer, sbobj, useMuzzle, checkEnabled)>=1; +} +/// +/// @brief Use this to stop aiming at an object or a point. +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public void fnAIPlayer_clearAim (string aiplayer) @@ -16444,7 +20527,18 @@ public void fnAIPlayer_followObject (string aiplayer, uint obj, float radius) SafeNativeMethods.mwle_fnAIPlayer_followObject(sbaiplayer, obj, radius); } /// -/// @brief Returns the point the AIPlayer is aiming at. This will reflect the position set by setAimLocation(), or the position of the object that the bot is now aiming at. If the bot is not aiming at anything, this value will change to whatever point the bot's current line-of-sight intercepts. @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". @see setAimLocation() @see setAimObject()) +/// @brief Returns the point the AIPlayer is aiming at. +/// +/// This will reflect the position set by setAimLocation(), +/// or the position of the object that the bot is now aiming at. +/// If the bot is not aiming at anything, this value will +/// change to whatever point the bot's current line-of-sight intercepts. +/// +/// @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public string fnAIPlayer_getAimLocation (string aiplayer) @@ -16461,7 +20555,13 @@ public string fnAIPlayer_getAimLocation (string aiplayer) } /// -/// @brief Gets the object the AIPlayer is targeting. @return Returns -1 if no object is being aimed at, or the SimObjectID of the object the AIPlayer is aiming at. @see setAimObject()) +/// @brief Gets the object the AIPlayer is targeting. +/// +/// @return Returns -1 if no object is being aimed at, +/// or the SimObjectID of the object the AIPlayer is aiming at. +/// +/// @see setAimObject()) +/// /// public int fnAIPlayer_getAimObject (string aiplayer) @@ -16475,7 +20575,14 @@ public int fnAIPlayer_getAimObject (string aiplayer) return SafeNativeMethods.mwle_fnAIPlayer_getAimObject(sbaiplayer); } /// -/// @brief Get the AIPlayer's current destination. @return Returns a point containing the \"x y z\" position of the AIPlayer's current move destination. If no move destination has yet been set, this returns \"0 0 0\". @see setMoveDestination()) +/// @brief Get the AIPlayer's current destination. +/// +/// @return Returns a point containing the \"x y z\" position +/// of the AIPlayer's current move destination. If no move destination +/// has yet been set, this returns \"0 0 0\". +/// +/// @see setMoveDestination()) +/// /// public string fnAIPlayer_getMoveDestination (string aiplayer) @@ -16492,7 +20599,12 @@ public string fnAIPlayer_getMoveDestination (string aiplayer) } /// -/// @brief Gets the move speed of an AI object. @return A speed multiplier between 0.0 and 1.0. @see setMoveSpeed()) +/// @brief Gets the move speed of an AI object. +/// +/// @return A speed multiplier between 0.0 and 1.0. +/// +/// @see setMoveSpeed()) +/// /// public float fnAIPlayer_getMoveSpeed (string aiplayer) @@ -16579,7 +20691,12 @@ public void fnAIPlayer_repath (string aiplayer) SafeNativeMethods.mwle_fnAIPlayer_repath(sbaiplayer); } /// -/// @brief Tells the AIPlayer to aim at the location provided. @param target An \"x y z\" position in the game world to target. @see getAimLocation()) +/// @brief Tells the AIPlayer to aim at the location provided. +/// +/// @param target An \"x y z\" position in the game world to target. +/// +/// @see getAimLocation()) +/// /// public void fnAIPlayer_setAimLocation (string aiplayer, string target) @@ -16596,7 +20713,18 @@ public void fnAIPlayer_setAimLocation (string aiplayer, string target) SafeNativeMethods.mwle_fnAIPlayer_setAimLocation(sbaiplayer, sbtarget); } /// -/// @brief Tells the AI to move to the location provided @param goal Coordinates in world space representing location to move to. @param slowDown A boolean value. If set to true, the bot will slow down when it gets within 5-meters of its move destination. If false, the bot will stop abruptly when it reaches the move destination. By default, this is true. @note Upon reaching a move destination, the bot will clear its move destination and calls to getMoveDestination will return \"0 0 0\". @see getMoveDestination()) +/// @brief Tells the AI to move to the location provided +/// +/// @param goal Coordinates in world space representing location to move to. +/// @param slowDown A boolean value. If set to true, the bot will slow down +/// when it gets within 5-meters of its move destination. If false, the bot +/// will stop abruptly when it reaches the move destination. By default, this is true. +/// +/// @note Upon reaching a move destination, the bot will clear its move destination and +/// calls to getMoveDestination will return \"0 0 0\". +/// +/// @see getMoveDestination()) +/// /// public void fnAIPlayer_setMoveDestination (string aiplayer, string goal, bool slowDown) @@ -16613,7 +20741,14 @@ public void fnAIPlayer_setMoveDestination (string aiplayer, string goal, bool sl SafeNativeMethods.mwle_fnAIPlayer_setMoveDestination(sbaiplayer, sbgoal, slowDown); } /// -/// @brief Sets the move speed for an AI object. @param speed A speed multiplier between 0.0 and 1.0. This is multiplied by the AIPlayer's base movement rates (as defined in its PlayerData datablock) @see getMoveDestination()) +/// @brief Sets the move speed for an AI object. +/// +/// @param speed A speed multiplier between 0.0 and 1.0. +/// This is multiplied by the AIPlayer's base movement rates (as defined in +/// its PlayerData datablock) +/// +/// @see getMoveDestination()) +/// /// public void fnAIPlayer_setMoveSpeed (string aiplayer, float speed) @@ -16670,6 +20805,7 @@ public bool fnAIPlayer_setPathDestination (string aiplayer, string goal) } /// /// @brief Tells the AIPlayer to stop moving.) +/// /// public void fnAIPlayer_stop (string aiplayer) @@ -16684,6 +20820,7 @@ public void fnAIPlayer_stop (string aiplayer) } /// /// @brief Activate a turret from a deactive state.) +/// /// public void fnAITurretShape_activateTurret (string aiturretshape) @@ -16697,7 +20834,10 @@ public void fnAITurretShape_activateTurret (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_activateTurret(sbaiturretshape); } /// -/// @brief Adds object to the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to ignore.) +/// @brief Adds object to the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to ignore.) +/// /// public void fnAITurretShape_addToIgnoreList (string aiturretshape, string obj) @@ -16715,6 +20855,7 @@ public void fnAITurretShape_addToIgnoreList (string aiturretshape, string obj) } /// /// @brief Deactivate a turret from an active state.) +/// /// public void fnAITurretShape_deactivateTurret (string aiturretshape) @@ -16728,7 +20869,9 @@ public void fnAITurretShape_deactivateTurret (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_deactivateTurret(sbaiturretshape); } /// -/// @brief Get the turret's current target. @returns The object that is the target's current target, or 0 if no target.) +/// @brief Get the turret's current target. +/// @returns The object that is the target's current target, or 0 if no target.) +/// /// public string fnAITurretShape_getTarget (string aiturretshape) @@ -16745,7 +20888,9 @@ public string fnAITurretShape_getTarget (string aiturretshape) } /// -/// @brief Get the turret's defined projectile velocity that helps with target leading. @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// @brief Get the turret's defined projectile velocity that helps with target leading. +/// @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// /// public float fnAITurretShape_getWeaponLeadVelocity (string aiturretshape) @@ -16759,7 +20904,9 @@ public float fnAITurretShape_getWeaponLeadVelocity (string aiturretshape) return SafeNativeMethods.mwle_fnAITurretShape_getWeaponLeadVelocity(sbaiturretshape); } /// -/// @brief Indicates if the turret has a target. @returns True if the turret has a target.) +/// @brief Indicates if the turret has a target. +/// @returns True if the turret has a target.) +/// /// public bool fnAITurretShape_hasTarget (string aiturretshape) @@ -16774,6 +20921,7 @@ public bool fnAITurretShape_hasTarget (string aiturretshape) } /// /// @brief Recenter the turret's weapon.) +/// /// public void fnAITurretShape_recenterTurret (string aiturretshape) @@ -16787,7 +20935,10 @@ public void fnAITurretShape_recenterTurret (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_recenterTurret(sbaiturretshape); } /// -/// @brief Removes object from the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to once again allow for targeting.) +/// @brief Removes object from the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to once again allow for targeting.) +/// /// public void fnAITurretShape_removeFromIgnoreList (string aiturretshape, string obj) @@ -16804,7 +20955,9 @@ public void fnAITurretShape_removeFromIgnoreList (string aiturretshape, string o SafeNativeMethods.mwle_fnAITurretShape_removeFromIgnoreList(sbaiturretshape, sbobj); } /// -/// @brief Resets the turret's target tracking. Only resets the internal target tracking. Does not modify the turret's facing.) +/// @brief Resets the turret's target tracking. +/// Only resets the internal target tracking. Does not modify the turret's facing.) +/// /// public void fnAITurretShape_resetTarget (string aiturretshape) @@ -16818,7 +20971,9 @@ public void fnAITurretShape_resetTarget (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_resetTarget(sbaiturretshape); } /// -/// @brief Set the firing state of the turret's guns. @param fire Set to true to activate all guns. False to deactivate them.) +/// @brief Set the firing state of the turret's guns. +/// @param fire Set to true to activate all guns. False to deactivate them.) +/// /// public void fnAITurretShape_setAllGunsFiring (string aiturretshape, bool fire) @@ -16832,7 +20987,10 @@ public void fnAITurretShape_setAllGunsFiring (string aiturretshape, bool fire) SafeNativeMethods.mwle_fnAITurretShape_setAllGunsFiring(sbaiturretshape, fire); } /// -/// @brief Set the firing state of the given gun slot. @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. @param fire Set to true to activate the gun. False to deactivate it.) +/// @brief Set the firing state of the given gun slot. +/// @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. +/// @param fire Set to true to activate the gun. False to deactivate it.) +/// /// public void fnAITurretShape_setGunSlotFiring (string aiturretshape, int slot, bool fire) @@ -16846,7 +21004,14 @@ public void fnAITurretShape_setGunSlotFiring (string aiturretshape, int slot, bo SafeNativeMethods.mwle_fnAITurretShape_setGunSlotFiring(sbaiturretshape, slot, fire); } /// -/// @brief Set the turret's current state. Normally the turret's state comes from updating the state machine but this method allows you to override this and jump to the requested state immediately. @param newState The name of the new state. @param force Is true then force the full processing of the new state even if it is the same as the current state. If false then only the time out value is reset and the state's script method is called, if any.) +/// @brief Set the turret's current state. +/// Normally the turret's state comes from updating the state machine but this method +/// allows you to override this and jump to the requested state immediately. +/// @param newState The name of the new state. +/// @param force Is true then force the full processing of the new state even if it is the +/// same as the current state. If false then only the time out value is reset and the state's +/// script method is called, if any.) +/// /// public void fnAITurretShape_setTurretState (string aiturretshape, string newState, bool force) @@ -16863,7 +21028,12 @@ public void fnAITurretShape_setTurretState (string aiturretshape, string newStat SafeNativeMethods.mwle_fnAITurretShape_setTurretState(sbaiturretshape, sbnewState, force); } /// -/// @brief Set the turret's projectile velocity to help lead the target. This value normally comes from AITurretShapeData::weaponLeadVelocity but this method allows you to override the datablock value. This can be useful if the turret changes ammunition, uses a different weapon than the default, is damaged, etc. @note Setting this to 0 will disable target leading.) +/// @brief Set the turret's projectile velocity to help lead the target. +/// This value normally comes from AITurretShapeData::weaponLeadVelocity but this method +/// allows you to override the datablock value. This can be useful if the turret changes +/// ammunition, uses a different weapon than the default, is damaged, etc. +/// @note Setting this to 0 will disable target leading.) +/// /// public void fnAITurretShape_setWeaponLeadVelocity (string aiturretshape, float velocity) @@ -16878,6 +21048,7 @@ public void fnAITurretShape_setWeaponLeadVelocity (string aiturretshape, float v } /// /// @brief Begin scanning for a target.) +/// /// public void fnAITurretShape_startScanForTargets (string aiturretshape) @@ -16892,6 +21063,7 @@ public void fnAITurretShape_startScanForTargets (string aiturretshape) } /// /// @brief Have the turret track the current target.) +/// /// public void fnAITurretShape_startTrackingTarget (string aiturretshape) @@ -16905,7 +21077,10 @@ public void fnAITurretShape_startTrackingTarget (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_startTrackingTarget(sbaiturretshape); } /// -/// @brief Stop scanning for targets. @note Only impacts the scanning for new targets. Does not effect a turret's current target lock.) +/// @brief Stop scanning for targets. +/// @note Only impacts the scanning for new targets. Does not effect a turret's current +/// target lock.) +/// /// public void fnAITurretShape_stopScanForTargets (string aiturretshape) @@ -16920,6 +21095,7 @@ public void fnAITurretShape_stopScanForTargets (string aiturretshape) } /// /// @brief Stop the turret from tracking the current target.) +/// /// public void fnAITurretShape_stopTrackingTarget (string aiturretshape) @@ -16933,7 +21109,11 @@ public void fnAITurretShape_stopTrackingTarget (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_stopTrackingTarget(sbaiturretshape); } /// -/// ), Adds a new element to the end of an array (same as push_back()). @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array (same as push_back()). +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void fnArrayObject_add (string arrayobject, string key, string value) @@ -16953,7 +21133,9 @@ public void fnArrayObject_add (string arrayobject, string key, string value) SafeNativeMethods.mwle_fnArrayObject_add(sbarrayobject, sbkey, sbvalue); } /// -/// Appends the target array to the array object. @param target ArrayObject to append to the end of this array ) +/// Appends the target array to the array object. +/// @param target ArrayObject to append to the end of this array ) +/// /// public bool fnArrayObject_append (string arrayobject, string target) @@ -16971,6 +21153,7 @@ public bool fnArrayObject_append (string arrayobject, string target) } /// /// Get the number of elements in the array. ) +/// /// public int fnArrayObject_count (string arrayobject) @@ -16984,7 +21167,9 @@ public int fnArrayObject_count (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_count(sbarrayobject); } /// -/// Get the number of times a particular key is found in the array. @param key Key value to count ) +/// Get the number of times a particular key is found in the array. +/// @param key Key value to count ) +/// /// public int fnArrayObject_countKey (string arrayobject, string key) @@ -17001,7 +21186,9 @@ public int fnArrayObject_countKey (string arrayobject, string key) return SafeNativeMethods.mwle_fnArrayObject_countKey(sbarrayobject, sbkey); } /// -/// Get the number of times a particular value is found in the array. @param value Array element value to count ) +/// Get the number of times a particular value is found in the array. +/// @param value Array element value to count ) +/// /// public int fnArrayObject_countValue (string arrayobject, string value) @@ -17018,7 +21205,9 @@ public int fnArrayObject_countValue (string arrayobject, string value) return SafeNativeMethods.mwle_fnArrayObject_countValue(sbarrayobject, sbvalue); } /// -/// Removes elements with matching keys from array. @param target ArrayObject containing keys to remove from this array ) +/// Removes elements with matching keys from array. +/// @param target ArrayObject containing keys to remove from this array ) +/// /// public bool fnArrayObject_crop (string arrayobject, string target) @@ -17035,7 +21224,9 @@ public bool fnArrayObject_crop (string arrayobject, string target) return SafeNativeMethods.mwle_fnArrayObject_crop(sbarrayobject, sbtarget)>=1; } /// -/// Alters array into an exact duplicate of the target array. @param target ArrayObject to duplicate ) +/// Alters array into an exact duplicate of the target array. +/// @param target ArrayObject to duplicate ) +/// /// public bool fnArrayObject_duplicate (string arrayobject, string target) @@ -17053,6 +21244,7 @@ public bool fnArrayObject_duplicate (string arrayobject, string target) } /// /// Echos the array contents to the console ) +/// /// public void fnArrayObject_echo (string arrayobject) @@ -17067,6 +21259,7 @@ public void fnArrayObject_echo (string arrayobject) } /// /// Emptys all elements from an array ) +/// /// public void fnArrayObject_empty (string arrayobject) @@ -17080,7 +21273,9 @@ public void fnArrayObject_empty (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_empty(sbarrayobject); } /// -/// Removes an element at a specific position from the array. @param index 0-based index of the element to remove ) +/// Removes an element at a specific position from the array. +/// @param index 0-based index of the element to remove ) +/// /// public void fnArrayObject_erase (string arrayobject, int index) @@ -17095,6 +21290,7 @@ public void fnArrayObject_erase (string arrayobject, int index) } /// /// Gets the current pointer index ) +/// /// public int fnArrayObject_getCurrent (string arrayobject) @@ -17108,7 +21304,10 @@ public int fnArrayObject_getCurrent (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_getCurrent(sbarrayobject); } /// -/// Search the array from the current position for the key @param value Array key to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the key +/// @param value Array key to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int fnArrayObject_getIndexFromKey (string arrayobject, string key) @@ -17125,7 +21324,10 @@ public int fnArrayObject_getIndexFromKey (string arrayobject, string key) return SafeNativeMethods.mwle_fnArrayObject_getIndexFromKey(sbarrayobject, sbkey); } /// -/// Search the array from the current position for the element @param value Array value to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the element +/// @param value Array value to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int fnArrayObject_getIndexFromValue (string arrayobject, string value) @@ -17142,7 +21344,11 @@ public int fnArrayObject_getIndexFromValue (string arrayobject, string value) return SafeNativeMethods.mwle_fnArrayObject_getIndexFromValue(sbarrayobject, sbvalue); } /// -/// Get the key of the array element at the submitted index. @param index 0-based index of the array element to get @return The key associated with the array element at the specified index, or \"\" if the index is out of range ) +/// Get the key of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The key associated with the array element at the +/// specified index, or \"\" if the index is out of range ) +/// /// public string fnArrayObject_getKey (string arrayobject, int index) @@ -17159,7 +21365,11 @@ public string fnArrayObject_getKey (string arrayobject, int index) } /// -/// Get the value of the array element at the submitted index. @param index 0-based index of the array element to get @return The value of the array element at the specified index, or \"\" if the index is out of range ) +/// Get the value of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The value of the array element at the specified index, +/// or \"\" if the index is out of range ) +/// /// public string fnArrayObject_getValue (string arrayobject, int index) @@ -17176,7 +21386,13 @@ public string fnArrayObject_getValue (string arrayobject, int index) } /// -/// Adds a new element to a specified position in the array. - @a index = 0 will insert an element at the start of the array (same as push_front()) - @a index = %array.count() will insert an element at the end of the array (same as push_back()) @param key Key for the new element @param value Value for the new element @param index 0-based index at which to insert the new element ) +/// Adds a new element to a specified position in the array. +/// - @a index = 0 will insert an element at the start of the array (same as push_front()) +/// - @a index = %array.count() will insert an element at the end of the array (same as push_back()) +/// @param key Key for the new element +/// @param value Value for the new element +/// @param index 0-based index at which to insert the new element ) +/// /// public void fnArrayObject_insert (string arrayobject, string key, string value, int index) @@ -17196,7 +21412,9 @@ public void fnArrayObject_insert (string arrayobject, string key, string value, SafeNativeMethods.mwle_fnArrayObject_insert(sbarrayobject, sbkey, sbvalue, index); } /// -/// Moves array pointer to start of array @return Returns the new array pointer ) +/// Moves array pointer to start of array +/// @return Returns the new array pointer ) +/// /// public int fnArrayObject_moveFirst (string arrayobject) @@ -17210,7 +21428,9 @@ public int fnArrayObject_moveFirst (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_moveFirst(sbarrayobject); } /// -/// Moves array pointer to end of array @return Returns the new array pointer ) +/// Moves array pointer to end of array +/// @return Returns the new array pointer ) +/// /// public int fnArrayObject_moveLast (string arrayobject) @@ -17224,7 +21444,9 @@ public int fnArrayObject_moveLast (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_moveLast(sbarrayobject); } /// -/// Moves array pointer to next position @return Returns the new array pointer, or -1 if already at the end ) +/// Moves array pointer to next position +/// @return Returns the new array pointer, or -1 if already at the end ) +/// /// public int fnArrayObject_moveNext (string arrayobject) @@ -17238,7 +21460,9 @@ public int fnArrayObject_moveNext (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_moveNext(sbarrayobject); } /// -/// Moves array pointer to prev position @return Returns the new array pointer, or -1 if already at the start ) +/// Moves array pointer to prev position +/// @return Returns the new array pointer, or -1 if already at the start ) +/// /// public int fnArrayObject_movePrev (string arrayobject) @@ -17253,6 +21477,7 @@ public int fnArrayObject_movePrev (string arrayobject) } /// /// Removes the last element from the array ) +/// /// public void fnArrayObject_pop_back (string arrayobject) @@ -17267,6 +21492,7 @@ public void fnArrayObject_pop_back (string arrayobject) } /// /// Removes the first element from the array ) +/// /// public void fnArrayObject_pop_front (string arrayobject) @@ -17280,7 +21506,11 @@ public void fnArrayObject_pop_front (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_pop_front(sbarrayobject); } /// -/// ), Adds a new element to the end of an array. @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array. +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void fnArrayObject_push_back (string arrayobject, string key, string value) @@ -17300,7 +21530,9 @@ public void fnArrayObject_push_back (string arrayobject, string key, string valu SafeNativeMethods.mwle_fnArrayObject_push_back(sbarrayobject, sbkey, sbvalue); } /// -/// ), Adds a new element to the front of an array ) +/// ), +/// Adds a new element to the front of an array ) +/// /// public void fnArrayObject_push_front (string arrayobject, string key, string value) @@ -17320,7 +21552,9 @@ public void fnArrayObject_push_front (string arrayobject, string key, string val SafeNativeMethods.mwle_fnArrayObject_push_front(sbarrayobject, sbkey, sbvalue); } /// -/// Sets the current pointer index. @param index New 0-based pointer index ) +/// Sets the current pointer index. +/// @param index New 0-based pointer index ) +/// /// public void fnArrayObject_setCurrent (string arrayobject, int index) @@ -17334,7 +21568,10 @@ public void fnArrayObject_setCurrent (string arrayobject, int index) SafeNativeMethods.mwle_fnArrayObject_setCurrent(sbarrayobject, index); } /// -/// Set the key at the given index. @param key New key value @param index 0-based index of the array element to update ) +/// Set the key at the given index. +/// @param key New key value +/// @param index 0-based index of the array element to update ) +/// /// public void fnArrayObject_setKey (string arrayobject, string key, int index) @@ -17351,7 +21588,10 @@ public void fnArrayObject_setKey (string arrayobject, string key, int index) SafeNativeMethods.mwle_fnArrayObject_setKey(sbarrayobject, sbkey, index); } /// -/// Set the value at the given index. @param value New array element value @param index 0-based index of the array element to update ) +/// Set the value at the given index. +/// @param value New array element value +/// @param index 0-based index of the array element to update ) +/// /// public void fnArrayObject_setValue (string arrayobject, string value, int index) @@ -17368,7 +21608,9 @@ public void fnArrayObject_setValue (string arrayobject, string value, int index) SafeNativeMethods.mwle_fnArrayObject_setValue(sbarrayobject, sbvalue, index); } /// -/// Alpha sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sort (string arrayobject, bool ascending) @@ -17383,6 +21625,7 @@ public void fnArrayObject_sort (string arrayobject, bool ascending) } /// /// Alpha sorts the array by value in ascending order ) +/// /// public void fnArrayObject_sorta (string arrayobject) @@ -17397,6 +21640,7 @@ public void fnArrayObject_sorta (string arrayobject) } /// /// Alpha sorts the array by value in descending order ) +/// /// public void fnArrayObject_sortd (string arrayobject) @@ -17410,7 +21654,16 @@ public void fnArrayObject_sortd (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_sortd(sbarrayobject); } /// -/// Sorts the array by value in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @tsexample function mySortCallback(%a, %b) { return strcmp( %a.name, %b.name ); } %array.sortf( \"mySortCallback\" ); @endtsexample ) +/// Sorts the array by value in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @tsexample +/// function mySortCallback(%a, %b) +/// { +/// return strcmp( %a.name, %b.name ); +/// } +/// %array.sortf( \"mySortCallback\" ); +/// @endtsexample ) +/// /// public void fnArrayObject_sortf (string arrayobject, string functionName) @@ -17427,7 +21680,10 @@ public void fnArrayObject_sortf (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortf(sbarrayobject, sbfunctionName); } /// -/// Sorts the array by value in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by value in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void fnArrayObject_sortfd (string arrayobject, string functionName) @@ -17444,7 +21700,10 @@ public void fnArrayObject_sortfd (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortfd(sbarrayobject, sbfunctionName); } /// -/// Sorts the array by key in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void fnArrayObject_sortfk (string arrayobject, string functionName) @@ -17461,7 +21720,10 @@ public void fnArrayObject_sortfk (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortfk(sbarrayobject, sbfunctionName); } /// -/// Sorts the array by key in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void fnArrayObject_sortfkd (string arrayobject, string functionName) @@ -17478,7 +21740,9 @@ public void fnArrayObject_sortfkd (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortfkd(sbarrayobject, sbfunctionName); } /// -/// Alpha sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sortk (string arrayobject, bool ascending) @@ -17493,6 +21757,7 @@ public void fnArrayObject_sortk (string arrayobject, bool ascending) } /// /// Alpha sorts the array by key in ascending order ) +/// /// public void fnArrayObject_sortka (string arrayobject) @@ -17507,6 +21772,7 @@ public void fnArrayObject_sortka (string arrayobject) } /// /// Alpha sorts the array by key in descending order ) +/// /// public void fnArrayObject_sortkd (string arrayobject) @@ -17520,7 +21786,9 @@ public void fnArrayObject_sortkd (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_sortkd(sbarrayobject); } /// -/// Numerically sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sortn (string arrayobject, bool ascending) @@ -17535,6 +21803,7 @@ public void fnArrayObject_sortn (string arrayobject, bool ascending) } /// /// Numerically sorts the array by value in ascending order ) +/// /// public void fnArrayObject_sortna (string arrayobject) @@ -17549,6 +21818,7 @@ public void fnArrayObject_sortna (string arrayobject) } /// /// Numerically sorts the array by value in descending order ) +/// /// public void fnArrayObject_sortnd (string arrayobject) @@ -17562,7 +21832,9 @@ public void fnArrayObject_sortnd (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_sortnd(sbarrayobject); } /// -/// Numerically sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sortnk (string arrayobject, bool ascending) @@ -17577,6 +21849,7 @@ public void fnArrayObject_sortnk (string arrayobject, bool ascending) } /// /// Numerical sorts the array by key in ascending order ) +/// /// public void fnArrayObject_sortnka (string arrayobject) @@ -17591,6 +21864,7 @@ public void fnArrayObject_sortnka (string arrayobject) } /// /// Numerical sorts the array by key in descending order ) +/// /// public void fnArrayObject_sortnkd (string arrayobject) @@ -17605,6 +21879,7 @@ public void fnArrayObject_sortnkd (string arrayobject) } /// /// Removes any elements that have duplicated keys (leaving the first instance) ) +/// /// public void fnArrayObject_uniqueKey (string arrayobject) @@ -17619,6 +21894,7 @@ public void fnArrayObject_uniqueKey (string arrayobject) } /// /// Removes any elements that have duplicated values (leaving the first instance) ) +/// /// public void fnArrayObject_uniqueValue (string arrayobject) @@ -17632,7 +21908,10 @@ public void fnArrayObject_uniqueValue (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_uniqueValue(sbarrayobject); } /// -/// Move the camera to fully view the given radius. @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). @param radius The radius to view.) +/// Move the camera to fully view the given radius. +/// @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). +/// @param radius The radius to view.) +/// /// public void fnCamera_autoFitRadius (string camera, float radius) @@ -17646,7 +21925,10 @@ public void fnCamera_autoFitRadius (string camera, float radius) SafeNativeMethods.mwle_fnCamera_autoFitRadius(sbcamera, radius); } /// -/// Get the angular velocity for a Newton mode camera. @returns The angular velocity in the form of \"x y z\". @note Only returns useful results when Camera::newtonRotation is set to true.) +/// Get the angular velocity for a Newton mode camera. +/// @returns The angular velocity in the form of \"x y z\". +/// @note Only returns useful results when Camera::newtonRotation is set to true.) +/// /// public string fnCamera_getAngularVelocity (string camera) @@ -17663,7 +21945,9 @@ public string fnCamera_getAngularVelocity (string camera) } /// -/// Returns the current camera control mode. @see CameraMotionMode) +/// Returns the current camera control mode. +/// @see CameraMotionMode) +/// /// public int fnCamera_getMode (string camera) @@ -17677,7 +21961,10 @@ public int fnCamera_getMode (string camera) return SafeNativeMethods.mwle_fnCamera_getMode(sbcamera); } /// -/// Get the camera's offset from its orbit or tracking point. The offset is added to the camera's position when set to CameraMode::OrbitObject. @returns The offset in the form of \"x y z\".) +/// Get the camera's offset from its orbit or tracking point. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @returns The offset in the form of \"x y z\".) +/// /// public string fnCamera_getOffset (string camera) @@ -17694,7 +21981,9 @@ public string fnCamera_getOffset (string camera) } /// -/// Get the camera's position in the world. @returns The position in the form of \"x y z\".) +/// Get the camera's position in the world. +/// @returns The position in the form of \"x y z\".) +/// /// public string fnCamera_getPosition (string camera) @@ -17711,7 +22000,9 @@ public string fnCamera_getPosition (string camera) } /// -/// Get the camera's Euler rotation in radians. @returns The rotation in radians in the form of \"x y z\".) +/// Get the camera's Euler rotation in radians. +/// @returns The rotation in radians in the form of \"x y z\".) +/// /// public string fnCamera_getRotation (string camera) @@ -17728,7 +22019,10 @@ public string fnCamera_getRotation (string camera) } /// -/// Get the velocity for the camera. @returns The camera's velocity in the form of \"x y z\". @note Only useful when the Camera is in Newton mode.) +/// Get the velocity for the camera. +/// @returns The camera's velocity in the form of \"x y z\". +/// @note Only useful when the Camera is in Newton mode.) +/// /// public string fnCamera_getVelocity (string camera) @@ -17745,7 +22039,9 @@ public string fnCamera_getVelocity (string camera) } /// -/// Is the camera in edit orbit mode? @returns true if the camera is in edit orbit mode.) +/// Is the camera in edit orbit mode? +/// @returns true if the camera is in edit orbit mode.) +/// /// public bool fnCamera_isEditOrbitMode (string camera) @@ -17759,7 +22055,9 @@ public bool fnCamera_isEditOrbitMode (string camera) return SafeNativeMethods.mwle_fnCamera_isEditOrbitMode(sbcamera)>=1; } /// -/// Is this a Newton Fly mode camera with damped rotation? @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// Is this a Newton Fly mode camera with damped rotation? +/// @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// /// public bool fnCamera_isRotationDamped (string camera) @@ -17773,7 +22071,9 @@ public bool fnCamera_isRotationDamped (string camera) return SafeNativeMethods.mwle_fnCamera_isRotationDamped(sbcamera)>=1; } /// -/// Point the camera at the specified position. Does not work in Orbit or Track modes. @param point The position to point the camera at.) +/// Point the camera at the specified position. Does not work in Orbit or Track modes. +/// @param point The position to point the camera at.) +/// /// public void fnCamera_lookAt (string camera, string point) @@ -17790,7 +22090,10 @@ public void fnCamera_lookAt (string camera, string point) SafeNativeMethods.mwle_fnCamera_lookAt(sbcamera, sbpoint); } /// -/// Set the angular drag for a Newton mode camera. @param drag The angular drag applied while the camera is rotating. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular drag for a Newton mode camera. +/// @param drag The angular drag applied while the camera is rotating. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void fnCamera_setAngularDrag (string camera, float drag) @@ -17804,7 +22107,10 @@ public void fnCamera_setAngularDrag (string camera, float drag) SafeNativeMethods.mwle_fnCamera_setAngularDrag(sbcamera, drag); } /// -/// Set the angular force for a Newton mode camera. @param force The angular force applied when attempting to rotate the camera. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular force for a Newton mode camera. +/// @param force The angular force applied when attempting to rotate the camera. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void fnCamera_setAngularForce (string camera, float force) @@ -17818,7 +22124,10 @@ public void fnCamera_setAngularForce (string camera, float force) SafeNativeMethods.mwle_fnCamera_setAngularForce(sbcamera, force); } /// -/// Set the angular velocity for a Newton mode camera. @param velocity The angular velocity infor form of \"x y z\". @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular velocity for a Newton mode camera. +/// @param velocity The angular velocity infor form of \"x y z\". +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void fnCamera_setAngularVelocity (string camera, string velocity) @@ -17835,7 +22144,10 @@ public void fnCamera_setAngularVelocity (string camera, string velocity) SafeNativeMethods.mwle_fnCamera_setAngularVelocity(sbcamera, sbvelocity); } /// -/// Set the Newton mode camera brake multiplier when trigger[1] is active. @param multiplier The brake multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera brake multiplier when trigger[1] is active. +/// @param multiplier The brake multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setBrakeMultiplier (string camera, float multiplier) @@ -17849,7 +22161,10 @@ public void fnCamera_setBrakeMultiplier (string camera, float multiplier) SafeNativeMethods.mwle_fnCamera_setBrakeMultiplier(sbcamera, multiplier); } /// -/// Set the drag for a Newton mode camera. @param drag The drag applied to the camera while moving. @note Only used when Camera is in Newton mode.) +/// Set the drag for a Newton mode camera. +/// @param drag The drag applied to the camera while moving. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setDrag (string camera, float drag) @@ -17863,7 +22178,10 @@ public void fnCamera_setDrag (string camera, float drag) SafeNativeMethods.mwle_fnCamera_setDrag(sbcamera, drag); } /// -/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). @note This method is generally used only within the World Editor and other tools. To orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). +/// @note This method is generally used only within the World Editor and other tools. To +/// orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// /// public void fnCamera_setEditOrbitMode (string camera) @@ -17877,7 +22195,9 @@ public void fnCamera_setEditOrbitMode (string camera) SafeNativeMethods.mwle_fnCamera_setEditOrbitMode(sbcamera); } /// -/// Set the editor camera's orbit point. @param point The point the camera will orbit in the form of \"x y z\".) +/// Set the editor camera's orbit point. +/// @param point The point the camera will orbit in the form of \"x y z\".) +/// /// public void fnCamera_setEditOrbitPoint (string camera, string point) @@ -17894,7 +22214,10 @@ public void fnCamera_setEditOrbitPoint (string camera, string point) SafeNativeMethods.mwle_fnCamera_setEditOrbitPoint(sbcamera, sbpoint); } /// -/// Set the force applied to a Newton mode camera while moving. @param force The force applied to the camera while attempting to move. @note Only used when Camera is in Newton mode.) +/// Set the force applied to a Newton mode camera while moving. +/// @param force The force applied to the camera while attempting to move. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setFlyForce (string camera, float force) @@ -17908,7 +22231,11 @@ public void fnCamera_setFlyForce (string camera, float force) SafeNativeMethods.mwle_fnCamera_setFlyForce(sbcamera, force); } /// -/// Set the camera to fly freely. Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode and Camera::newtonRotation.) +/// Set the camera to fly freely. +/// Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion +/// and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode +/// and Camera::newtonRotation.) +/// /// public void fnCamera_setFlyMode (string camera) @@ -17922,7 +22249,10 @@ public void fnCamera_setFlyMode (string camera) SafeNativeMethods.mwle_fnCamera_setFlyMode(sbcamera); } /// -/// Set the mass for a Newton mode camera. @param mass The mass used during ease-in and ease-out calculations. @note Only used when Camera is in Newton mode.) +/// Set the mass for a Newton mode camera. +/// @param mass The mass used during ease-in and ease-out calculations. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setMass (string camera, float mass) @@ -17936,7 +22266,11 @@ public void fnCamera_setMass (string camera, float mass) SafeNativeMethods.mwle_fnCamera_setMass(sbcamera, mass); } /// -/// Set the camera to fly freely, but with ease-in and ease-out. This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but activates the ease-in and ease-out on the camera's movement. To also activate Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// Set the camera to fly freely, but with ease-in and ease-out. +/// This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but +/// activates the ease-in and ease-out on the camera's movement. To also activate +/// Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// /// public void fnCamera_setNewtonFlyMode (string camera) @@ -17950,7 +22284,10 @@ public void fnCamera_setNewtonFlyMode (string camera) SafeNativeMethods.mwle_fnCamera_setNewtonFlyMode(sbcamera); } /// -/// Set the camera's offset. The offset is added to the camera's position when set to CameraMode::OrbitObject. @param offset The distance to offset the camera by in the form of \"x y z\".) +/// Set the camera's offset. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @param offset The distance to offset the camera by in the form of \"x y z\".) +/// /// public void fnCamera_setOffset (string camera, string offset) @@ -17967,10 +22304,21 @@ public void fnCamera_setOffset (string camera, string offset) SafeNativeMethods.mwle_fnCamera_setOffset(sbcamera, sboffset); } /// -/// Set the camera to orbit around the given object, or if none is given, around the given point. @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitObject() @see Camera::setOrbitPoint()) +/// Set the camera to orbit around the given object, or if none is given, around the given point. +/// @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead +/// @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitObject() +/// @see Camera::setOrbitPoint()) +/// /// -public bool fnCamera_setOrbitMode (string camera, string orbitObject, string orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj, string offset, bool lockedx) +public void fnCamera_setOrbitMode (string camera, string orbitObject, string orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj, string offset, bool lockedx) { if(Debugging) System.Console.WriteLine("----------------->Extern Call 'fnCamera_setOrbitMode'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" \"{4}\" \"{5}\" \"{6}\" \"{7}\" \"{8}\" ",camera,orbitObject,orbitPoint,minDistance,maxDistance,initDistance,ownClientObj,offset,lockedx)); @@ -17987,10 +22335,21 @@ public bool fnCamera_setOrbitMode (string camera, string orbitObject, string orb if (offset != null) sboffset = new StringBuilder(offset, 1024); -return SafeNativeMethods.mwle_fnCamera_setOrbitMode(sbcamera, sborbitObject, sborbitPoint, minDistance, maxDistance, initDistance, ownClientObj, sboffset, lockedx)>=1; +SafeNativeMethods.mwle_fnCamera_setOrbitMode(sbcamera, sborbitObject, sborbitPoint, minDistance, maxDistance, initDistance, ownClientObj, sboffset, lockedx); } /// -/// Set the camera to orbit around a given object. @param orbitObject The object to orbit around. @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @returns false if the given object could not be found. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given object. +/// @param orbitObject The object to orbit around. +/// @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @returns false if the given object could not be found. +/// @see Camera::setOrbitMode()) +/// /// public bool fnCamera_setOrbitObject (string camera, string orbitObject, string rotation, float minDistance, float maxDistance, float initDistance, bool ownClientObject, string offset, bool lockedx) @@ -18013,7 +22372,15 @@ public bool fnCamera_setOrbitObject (string camera, string orbitObject, string r return SafeNativeMethods.mwle_fnCamera_setOrbitObject(sbcamera, sborbitObject, sbrotation, minDistance, maxDistance, initDistance, ownClientObject, sboffset, lockedx)>=1; } /// -/// Set the camera to orbit around a given point. @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given point. +/// @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitMode()) +/// /// public void fnCamera_setOrbitPoint (string camera, string orbitPoint, float minDistance, float maxDistance, float initDistance, string offset, bool lockedx) @@ -18033,7 +22400,10 @@ public void fnCamera_setOrbitPoint (string camera, string orbitPoint, float minD SafeNativeMethods.mwle_fnCamera_setOrbitPoint(sbcamera, sborbitPoint, minDistance, maxDistance, initDistance, sboffset, lockedx); } /// -/// Set the camera's Euler rotation in radians. @param rot The rotation in radians in the form of \"x y z\". @note Rotation around the Y axis is ignored ) +/// Set the camera's Euler rotation in radians. +/// @param rot The rotation in radians in the form of \"x y z\". +/// @note Rotation around the Y axis is ignored ) +/// /// public void fnCamera_setRotation (string camera, string rot) @@ -18050,7 +22420,10 @@ public void fnCamera_setRotation (string camera, string rot) SafeNativeMethods.mwle_fnCamera_setRotation(sbcamera, sbrot); } /// -/// Set the Newton mode camera speed multiplier when trigger[0] is active. @param multiplier The speed multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera speed multiplier when trigger[0] is active. +/// @param multiplier The speed multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setSpeedMultiplier (string camera, float multiplier) @@ -18064,7 +22437,11 @@ public void fnCamera_setSpeedMultiplier (string camera, float multiplier) SafeNativeMethods.mwle_fnCamera_setSpeedMultiplier(sbcamera, multiplier); } /// -/// Set the camera to track a given object. @param trackObject The object to track. @param offset [optional] An offset added to the camera's position. Default is no offset. @returns false if the given object could not be found.) +/// Set the camera to track a given object. +/// @param trackObject The object to track. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @returns false if the given object could not be found.) +/// /// public bool fnCamera_setTrackObject (string camera, string trackObject, string offset) @@ -18084,7 +22461,12 @@ public bool fnCamera_setTrackObject (string camera, string trackObject, string o return SafeNativeMethods.mwle_fnCamera_setTrackObject(sbcamera, sbtrackObject, sboffset)>=1; } /// -/// Set if there is a valid editor camera orbit point. When validPoint is set to false the Camera operates as if it is in Fly mode rather than an Orbit mode. @param validPoint Indicates the validity of the orbit point. @note Only used when Camera is in Edit Orbit Mode.) +/// Set if there is a valid editor camera orbit point. +/// When validPoint is set to false the Camera operates as if it is +/// in Fly mode rather than an Orbit mode. +/// @param validPoint Indicates the validity of the orbit point. +/// @note Only used when Camera is in Edit Orbit Mode.) +/// /// public void fnCamera_setValidEditOrbitPoint (string camera, bool validPoint) @@ -18098,7 +22480,10 @@ public void fnCamera_setValidEditOrbitPoint (string camera, bool validPoint) SafeNativeMethods.mwle_fnCamera_setValidEditOrbitPoint(sbcamera, validPoint); } /// -/// Set the velocity for the camera. @param velocity The camera's velocity in the form of \"x y z\". @note Only affects the Camera when in Newton mode.) +/// Set the velocity for the camera. +/// @param velocity The camera's velocity in the form of \"x y z\". +/// @note Only affects the Camera when in Newton mode.) +/// /// public void fnCamera_setVelocity (string camera, string velocity) @@ -18115,20 +22500,6 @@ public void fnCamera_setVelocity (string camera, string velocity) SafeNativeMethods.mwle_fnCamera_setVelocity(sbcamera, sbvelocity); } /// -/// Change coverage of the cloudlayer.) -/// - -public void fnCloudLayer_ChangeCoverage (string cloudlayer, float newCoverage) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fnCloudLayer_ChangeCoverage'" + string.Format("\"{0}\" \"{1}\" ",cloudlayer,newCoverage)); -StringBuilder sbcloudlayer = null; -if (cloudlayer != null) - sbcloudlayer = new StringBuilder(cloudlayer, 1024); - -SafeNativeMethods.mwle_fnCloudLayer_ChangeCoverage(sbcloudlayer, newCoverage); -} -/// /// @brief Returns true if someone is already using this cover point.) /// /// @@ -18144,7 +22515,9 @@ public bool fnCoverPoint_isOccupied (string coverpoint) return SafeNativeMethods.mwle_fnCoverPoint_isOccupied(sbcoverpoint)>=1; } /// -/// Returns the script filename of where the CubemapData object was defined. This is used by the material editor. ) +/// Returns the script filename of where the CubemapData object was +/// defined. This is used by the material editor. ) +/// /// public string fnCubemapData_getFilename (string cubemapdata) @@ -18162,6 +22535,7 @@ public string fnCubemapData_getFilename (string cubemapdata) } /// /// Update the assigned cubemaps faces. ) +/// /// public void fnCubemapData_updateFaces (string cubemapdata) @@ -18175,7 +22549,26 @@ public void fnCubemapData_updateFaces (string cubemapdata) SafeNativeMethods.mwle_fnCubemapData_updateFaces(sbcubemapdata); } /// -/// 1.0 1.0 1.0, 1.0 0.0 0.0), @brief Manually set this piece of debris at the given position with the given velocity. Usually you do not manually create Debris objects as they are generated through other means, such as an Explosion. This method exists when you do manually create a Debris object and want to have it start moving. @param inputPosition Position to place the debris. @param inputVelocity Velocity to move the debris after it has been placed. @return Always returns true. @tsexample // Define the position %position = \"1.0 1.0 1.0\"; // Define the velocity %velocity = \"1.0 0.0 0.0\"; // Inform the debris object of its new position and velocity %debris.init(%position,%velocity); @endtsexample) +/// 1.0 1.0 1.0, 1.0 0.0 0.0), +/// @brief Manually set this piece of debris at the given position with the given velocity. +/// +/// Usually you do not manually create Debris objects as they are generated through other means, +/// such as an Explosion. This method exists when you do manually create a Debris object and +/// want to have it start moving. +/// +/// @param inputPosition Position to place the debris. +/// @param inputVelocity Velocity to move the debris after it has been placed. +/// @return Always returns true. +/// +/// @tsexample +/// // Define the position +/// %position = \"1.0 1.0 1.0\"; +/// // Define the velocity +/// %velocity = \"1.0 0.0 0.0\"; +/// // Inform the debris object of its new position and velocity +/// %debris.init(%position,%velocity); +/// @endtsexample) +/// /// public bool fnDebris_init (string debris, string inputPosition, string inputVelocity) @@ -18196,6 +22589,7 @@ public bool fnDebris_init (string debris, string inputPosition, string inputVelo } /// /// Draws an axis aligned box primitive within the two 3d points. ) +/// /// public void fnDebugDrawer_drawBox (string debugdrawer, string a, string b, string color) @@ -18219,6 +22613,7 @@ public void fnDebugDrawer_drawBox (string debugdrawer, string a, string b, strin } /// /// Draws a line primitive between two 3d points. ) +/// /// public void fnDebugDrawer_drawLine (string debugdrawer, string a, string b, string color) @@ -18242,6 +22637,7 @@ public void fnDebugDrawer_drawLine (string debugdrawer, string a, string b, stri } /// /// Sets the \"time to live\" (TTL) for the last rendered primitive. ) +/// /// public void fnDebugDrawer_setLastTTL (string debugdrawer, uint ms) @@ -18256,6 +22652,7 @@ public void fnDebugDrawer_setLastTTL (string debugdrawer, uint ms) } /// /// Sets the z buffer reading state for the last rendered primitive. ) +/// /// public void fnDebugDrawer_setLastZTest (string debugdrawer, bool enabled) @@ -18270,6 +22667,7 @@ public void fnDebugDrawer_setLastZTest (string debugdrawer, bool enabled) } /// /// Toggles the rendering of DebugDrawer primitives. ) +/// /// public void fnDebugDrawer_toggleDrawing (string debugdrawer) @@ -18284,6 +22682,7 @@ public void fnDebugDrawer_toggleDrawing (string debugdrawer) } /// /// Toggles freeze mode which keeps the currently rendered primitives from expiring. ) +/// /// public void fnDebugDrawer_toggleFreeze (string debugdrawer) @@ -18297,7 +22696,13 @@ public void fnDebugDrawer_toggleFreeze (string debugdrawer) SafeNativeMethods.mwle_fnDebugDrawer_toggleFreeze(sbdebugdrawer); } /// -/// Recompute the imagemap sub-texture rectangles for this DecalData. @tsexample // Inform the decal object to reload its imagemap and frame data. %decalData.texRows = 4; %decalData.postApply(); @endtsexample) +/// Recompute the imagemap sub-texture rectangles for this DecalData. +/// @tsexample +/// // Inform the decal object to reload its imagemap and frame data. +/// %decalData.texRows = 4; +/// %decalData.postApply(); +/// @endtsexample) +/// /// public void fnDecalData_postApply (string decaldata) @@ -18311,7 +22716,12 @@ public void fnDecalData_postApply (string decaldata) SafeNativeMethods.mwle_fnDecalData_postApply(sbdecaldata); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit the material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// the material and other fields ( not including nodes ) +/// to client objects. +/// ) +/// /// public void fnDecalRoad_postApply (string decalroad) @@ -18325,7 +22735,10 @@ public void fnDecalRoad_postApply (string decalroad) SafeNativeMethods.mwle_fnDecalRoad_postApply(sbdecalroad); } /// -/// Intended as a helper to developers and editor scripts. Force DecalRoad to update it's spline and reclip geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force DecalRoad to update it's spline and reclip geometry. +/// ) +/// /// public void fnDecalRoad_regenerate (string decalroad) @@ -18339,7 +22752,13 @@ public void fnDecalRoad_regenerate (string decalroad) SafeNativeMethods.mwle_fnDecalRoad_regenerate(sbdecalroad); } /// -/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method @param methodName The method's name as a string @param argi Any arguments to pass to the method @return No return value @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method +/// @param methodName The method's name as a string +/// @param argi Any arguments to pass to the method +/// @return No return value +/// @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// +/// /// public void fnDynamicConsoleMethodComponent_callMethod (string dynamicconsolemethodcomponent, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21, string a22, string a23, string a24, string a25, string a26, string a27, string a28, string a29, string a30, string a31, string a32, string a33, string a34, string a35, string a36, string a37, string a38, string a39, string a40, string a41, string a42, string a43, string a44, string a45, string a46, string a47, string a48, string a49, string a50, string a51, string a52, string a53, string a54, string a55, string a56, string a57, string a58, string a59, string a60, string a61, string a62, string a63) @@ -18540,6 +22959,7 @@ public void fnDynamicConsoleMethodComponent_callMethod (string dynamicconsolemet } /// /// ) +/// /// public int fnEditTSCtrl_getDisplayType (string edittsctrl) @@ -18554,6 +22974,7 @@ public int fnEditTSCtrl_getDisplayType (string edittsctrl) } /// /// ) +/// /// public int fnEditTSCtrl_getGizmo (string edittsctrl) @@ -18568,6 +22989,7 @@ public int fnEditTSCtrl_getGizmo (string edittsctrl) } /// /// Return the FOV for orthographic views. ) +/// /// public float fnEditTSCtrl_getOrthoFOV (string edittsctrl) @@ -18582,6 +23004,7 @@ public float fnEditTSCtrl_getOrthoFOV (string edittsctrl) } /// /// ) +/// /// public bool fnEditTSCtrl_isMiddleMouseDown (string edittsctrl) @@ -18596,6 +23019,7 @@ public bool fnEditTSCtrl_isMiddleMouseDown (string edittsctrl) } /// /// ) +/// /// public void fnEditTSCtrl_renderBox (string edittsctrl, string pos, string size) @@ -18616,6 +23040,7 @@ public void fnEditTSCtrl_renderBox (string edittsctrl, string pos, string size) } /// /// ) +/// /// public void fnEditTSCtrl_renderCircle (string edittsctrl, string pos, string normal, float radius, int segments) @@ -18636,6 +23061,7 @@ public void fnEditTSCtrl_renderCircle (string edittsctrl, string pos, string nor } /// /// ) +/// /// public void fnEditTSCtrl_renderLine (string edittsctrl, string start, string end, float lineWidth) @@ -18656,6 +23082,7 @@ public void fnEditTSCtrl_renderLine (string edittsctrl, string start, string end } /// /// ) +/// /// public void fnEditTSCtrl_renderSphere (string edittsctrl, string pos, float radius, int sphereLevel) @@ -18673,6 +23100,7 @@ public void fnEditTSCtrl_renderSphere (string edittsctrl, string pos, float radi } /// /// ) +/// /// public void fnEditTSCtrl_renderTriangle (string edittsctrl, string a, string b, string c) @@ -18696,6 +23124,7 @@ public void fnEditTSCtrl_renderTriangle (string edittsctrl, string a, string b, } /// /// ) +/// /// public void fnEditTSCtrl_setDisplayType (string edittsctrl, int displayType) @@ -18710,6 +23139,7 @@ public void fnEditTSCtrl_setDisplayType (string edittsctrl, int displayType) } /// /// Set the FOV for to use for orthographic views. ) +/// /// public void fnEditTSCtrl_setOrthoFOV (string edittsctrl, float fov) @@ -18723,7 +23153,91 @@ public void fnEditTSCtrl_setOrthoFOV (string edittsctrl, float fov) SafeNativeMethods.mwle_fnEditTSCtrl_setOrthoFOV(sbedittsctrl, fov); } /// -/// @brief Launches the OS file browser After an Execute() call, the chosen file name and path is available in one of two areas. If only a single file selection is permitted, the results will be stored in the @a fileName attribute. If multiple file selection is permitted, the results will be stored in the @a files array. The total number of files in the array will be stored in the @a fileCount attribute. @tsexample // NOTE: This is not he preferred class to use, but this still works // Create the file dialog %baseFileDialog = new FileDialog() { // Allow browsing of all file types filters = \"*.*\"; // No default file defaultFile = ; // Set default path relative to project defaultPath = \"./\"; // Set the title title = \"Durpa\"; // Allow changing of path you are browsing changePath = true; }; // Launch the file dialog %baseFileDialog.Execute(); // Don't forget to cleanup %baseFileDialog.delete(); // A better alternative is to use the // derived classes which are specific to file open and save // Create a dialog dedicated to opening files %openFileDlg = new OpenFileDialog() { // Look for jpg image files // First part is the descriptor|second part is the extension Filters = \"Jepg Files|*.jpg\"; // Allow browsing through other folders ChangePath = true; // Only allow opening of one file at a time MultipleFiles = false; }; // Launch the open file dialog %result = %openFileDlg.Execute(); // Obtain the chosen file name and path if ( %result ) { %seletedFile = %openFileDlg.file; } else { %selectedFile = \"\"; } // Cleanup %openFileDlg.delete(); // Create a dialog dedicated to saving a file %saveFileDlg = new SaveFileDialog() { // Only allow for saving of COLLADA files Filters = \"COLLADA Files (*.dae)|*.dae|\"; // Default save path to where the WorldEditor last saved DefaultPath = $pref::WorldEditor::LastPath; // No default file specified DefaultFile = \"\"; // Do not allow the user to change to a new directory ChangePath = false; // Prompt the user if they are going to overwrite an existing file OverwritePrompt = true; }; // Launch the save file dialog %result = %saveFileDlg.Execute(); // Obtain the file name %selectedFile = \"\"; if ( %result ) %selectedFile = %saveFileDlg.file; // Cleanup %saveFileDlg.delete(); @endtsexample @return True if the file was selected was successfully found (opened) or declared (saved).) +/// @brief Launches the OS file browser +/// +/// After an Execute() call, the chosen file name and path is available in one of two areas. +/// If only a single file selection is permitted, the results will be stored in the @a fileName +/// attribute. +/// +/// If multiple file selection is permitted, the results will be stored in the +/// @a files array. The total number of files in the array will be stored in the +/// @a fileCount attribute. +/// +/// @tsexample +/// // NOTE: This is not he preferred class to use, but this still works +/// // Create the file dialog +/// %baseFileDialog = new FileDialog() +/// { +/// // Allow browsing of all file types +/// filters = \"*.*\"; +/// // No default file +/// defaultFile = ; +/// // Set default path relative to project +/// defaultPath = \"./\"; +/// // Set the title +/// title = \"Durpa\"; +/// // Allow changing of path you are browsing +/// changePath = true; +/// }; +/// // Launch the file dialog +/// %baseFileDialog.Execute(); +/// +/// // Don't forget to cleanup +/// %baseFileDialog.delete(); +/// +/// // A better alternative is to use the +/// // derived classes which are specific to file open and save +/// // Create a dialog dedicated to opening files +/// %openFileDlg = new OpenFileDialog() +/// { +/// // Look for jpg image files +/// // First part is the descriptor|second part is the extension +/// Filters = \"Jepg Files|*.jpg\"; +/// // Allow browsing through other folders +/// ChangePath = true; +/// // Only allow opening of one file at a time +/// MultipleFiles = false; +/// }; +/// // Launch the open file dialog +/// %result = %openFileDlg.Execute(); +/// // Obtain the chosen file name and path +/// if ( %result ) +/// { +/// %seletedFile = %openFileDlg.file; +/// } +/// else +/// { +/// %selectedFile = \"\"; +/// } +/// // Cleanup +/// %openFileDlg.delete(); +/// +/// // Create a dialog dedicated to saving a file +/// %saveFileDlg = new SaveFileDialog() +/// { +/// // Only allow for saving of COLLADA files +/// Filters = \"COLLADA Files (*.dae)|*.dae|\"; +/// // Default save path to where the WorldEditor last saved +/// DefaultPath = $pref::WorldEditor::LastPath; +/// // No default file specified +/// DefaultFile = \"\"; +/// // Do not allow the user to change to a new directory +/// ChangePath = false; +/// // Prompt the user if they are going to overwrite an existing file +/// OverwritePrompt = true; +/// }; +/// // Launch the save file dialog +/// %result = %saveFileDlg.Execute(); +/// // Obtain the file name +/// %selectedFile = \"\"; +/// if ( %result ) +/// %selectedFile = %saveFileDlg.file; +/// // Cleanup +/// %saveFileDlg.delete(); +/// @endtsexample +/// +/// @return True if the file was selected was successfully found (opened) or declared (saved).) +/// /// public bool fnFileDialog_Execute (string filedialog) @@ -18737,7 +23251,32 @@ public bool fnFileDialog_Execute (string filedialog) return SafeNativeMethods.mwle_fnFileDialog_Execute(sbfiledialog)>=1; } /// -/// @brief Close the file. It is EXTREMELY important that you call this function when you are finished reading or writing to a file. Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. Remember: Open, Read/Write, Close, Delete...in that order! @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); // Close the file when finished %fileWrite.close(); // Cleanup the file object %fileWrite.delete(); @endtsexample) +/// @brief Close the file. +/// +/// It is EXTREMELY important that you call this function when you are finished reading or writing to a file. +/// Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. +/// Remember: Open, Read/Write, Close, Delete...in that order! +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// // Close the file when finished +/// %fileWrite.close(); +/// // Cleanup the file object +/// %fileWrite.delete(); +/// @endtsexample) +/// /// public void fnFileObject_close (string fileobject) @@ -18751,7 +23290,25 @@ public void fnFileObject_close (string fileobject) SafeNativeMethods.mwle_fnFileObject_close(sbfileobject); } /// -/// @brief Determines if the parser for this FileObject has reached the end of the file @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Keep reading until we reach the end of the file while( !%fileRead.isEOF() ) { %line = %fileRead.readline(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); @endtsexample @return True if the parser has reached the end of the file, false otherwise) +/// @brief Determines if the parser for this FileObject has reached the end of the file +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Keep reading until we reach the end of the file +/// while( !%fileRead.isEOF() ) +/// { +/// %line = %fileRead.readline(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise) +/// /// public bool fnFileObject_isEOF (string fileobject) @@ -18765,7 +23322,23 @@ public bool fnFileObject_isEOF (string fileobject) return SafeNativeMethods.mwle_fnFileObject_isEOF(sbfileobject)>=1; } /// -/// @brief Open a specified file for writing, adding data to the end of the file There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. @param filename Path, name, and extension of file to append to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created // If it does exist, whatever we write will be added to the end %result = %fileWrite.OpenForAppend(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing, adding data to the end of the file +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), +/// which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. +/// +/// @param filename Path, name, and extension of file to append to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// // If it does exist, whatever we write will be added to the end +/// %result = %fileWrite.OpenForAppend(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool fnFileObject_openForAppend (string fileobject, string filename) @@ -18782,7 +23355,21 @@ public bool fnFileObject_openForAppend (string fileobject, string filename) return SafeNativeMethods.mwle_fnFileObject_openForAppend(sbfileobject, sbfilename)>=1; } /// -/// @brief Open a specified file for reading There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %result = %fileRead.OpenForRead(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for reading +/// +/// There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %result = %fileRead.OpenForRead(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool fnFileObject_openForRead (string fileobject, string filename) @@ -18799,7 +23386,21 @@ public bool fnFileObject_openForRead (string fileobject, string filename) return SafeNativeMethods.mwle_fnFileObject_openForRead(sbfileobject, sbfilename)>=1; } /// -/// @brief Open a specified file for writing There is no limit as to what kind of file you can write. Any format and data is allowable, not just text @param filename Path, name, and extension of file to write to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %result = %fileWrite.OpenForWrite(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text +/// +/// @param filename Path, name, and extension of file to write to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %result = %fileWrite.OpenForWrite(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool fnFileObject_openForWrite (string fileobject, string filename) @@ -18816,7 +23417,31 @@ public bool fnFileObject_openForWrite (string fileobject, string filename) return SafeNativeMethods.mwle_fnFileObject_openForWrite(sbfileobject, sbfilename)>=1; } /// -/// @brief Read a line from the file without moving the stream position. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); @endtsexample @return String containing the line of data that was just peeked) +/// @brief Read a line from the file without moving the stream position. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just peeked) +/// /// public string fnFileObject_peekLine (string fileobject) @@ -18833,7 +23458,24 @@ public string fnFileObject_peekLine (string fileobject) } /// -/// @brief Read a line from file. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Read in the first line %line = %fileRead.readline(); // Print the line we just read echo(%line); @endtsexample @return String containing the line of data that was just read) +/// @brief Read a line from file. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Read in the first line +/// %line = %fileRead.readline(); +/// // Print the line we just read +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just read) +/// /// public string fnFileObject_readLine (string fileobject) @@ -18850,7 +23492,24 @@ public string fnFileObject_readLine (string fileobject) } /// -/// @brief Write a line to the file, if it was opened for writing. There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param text The data we are writing out to file. @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %fileWrite.OpenForWrite(\"./test.txt\"); // Write a line to the text files %fileWrite.writeLine(\"READ. READ CODE. CODE\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Write a line to the file, if it was opened for writing. +/// +/// There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param text The data we are writing out to file. +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %fileWrite.OpenForWrite(\"./test.txt\"); +/// // Write a line to the text files +/// %fileWrite.writeLine(\"READ. READ CODE. CODE\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public void fnFileObject_writeLine (string fileobject, string text) @@ -18867,7 +23526,19 @@ public void fnFileObject_writeLine (string fileobject, string text) SafeNativeMethods.mwle_fnFileObject_writeLine(sbfileobject, sbtext); } /// -/// @brief Close the file. You can no longer read or write to it unless you open it again. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see open()) +/// @brief Close the file. You can no longer read or write to it unless you open it again. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see open()) +/// /// public void fnFileStreamObject_close (string filestreamobject) @@ -18881,7 +23552,34 @@ public void fnFileStreamObject_close (string filestreamobject) SafeNativeMethods.mwle_fnFileStreamObject_close(sbfilestreamobject); } /// -/// @brief Open a file for reading, writing, reading and writing, or appending Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting at the end of the files existing contents. @param filename Name of file to open @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the file was successfully opened, false if something went wrong @see close()) +/// @brief Open a file for reading, writing, reading and writing, or appending +/// +/// Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new +/// file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. +/// +/// \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can +/// move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting +/// at the end of the files existing contents. +/// +/// @param filename Name of file to open +/// @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the file was successfully opened, false if something went wrong +/// +/// @see close()) +/// /// public bool fnFileStreamObject_open (string filestreamobject, string filename, string openMode) @@ -18901,7 +23599,10 @@ public bool fnFileStreamObject_open (string filestreamobject, string filename, s return SafeNativeMethods.mwle_fnFileStreamObject_open(sbfilestreamobject, sbfilename, sbopenMode)>=1; } /// -/// @brief Set whether the vehicle should temporarily use the createHoverHeight specified in the datablock.This can help avoid problems with spawning. @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// @brief Set whether the vehicle should temporarily use the createHoverHeight +/// specified in the datablock.This can help avoid problems with spawning. +/// @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// /// public void fnFlyingVehicle_useCreateHeight (string flyingvehicle, bool enabled) @@ -18916,6 +23617,7 @@ public void fnFlyingVehicle_useCreateHeight (string flyingvehicle, bool enabled) } /// /// .) +/// /// public void fnForest_addItem (string forest, string data, string position, float rotation, float scale) @@ -18936,6 +23638,7 @@ public void fnForest_addItem (string forest, string data, string position, float } /// /// .) +/// /// public void fnForest_addItemWithTransform (string forest, string data, string trans, float scale) @@ -18955,7 +23658,16 @@ public void fnForest_addItemWithTransform (string forest, string data, string tr SafeNativeMethods.mwle_fnForest_addItemWithTransform(sbforest, sbdata, sbtrans, scale); } /// -/// @brief Mounts the wind emitter to another scene object @param objectID Unique ID of the object wind emitter should attach to @tsexample // Wind emitter previously created and named %windEmitter // Going to attach it to the player, making him a walking wind storm %windEmitter.attachToObject(%player); @endtsexample) +/// @brief Mounts the wind emitter to another scene object +/// +/// @param objectID Unique ID of the object wind emitter should attach to +/// +/// @tsexample +/// // Wind emitter previously created and named %windEmitter +/// // Going to attach it to the player, making him a walking wind storm +/// %windEmitter.attachToObject(%player); +/// @endtsexample) +/// /// public void fnForestWindEmitter_attachToObject (string forestwindemitter, uint objectID) @@ -18969,21 +23681,14 @@ public void fnForestWindEmitter_attachToObject (string forestwindemitter, uint o SafeNativeMethods.mwle_fnForestWindEmitter_attachToObject(sbforestwindemitter, objectID); } /// -/// @brief Mounts the wind emitter to another scene object @param ) -/// - -public void fnForestWindEmitter_resetWind (string forestwindemitter, int randomSeed) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fnForestWindEmitter_resetWind'" + string.Format("\"{0}\" \"{1}\" ",forestwindemitter,randomSeed)); -StringBuilder sbforestwindemitter = null; -if (forestwindemitter != null) - sbforestwindemitter = new StringBuilder(forestwindemitter, 1024); - -SafeNativeMethods.mwle_fnForestWindEmitter_resetWind(sbforestwindemitter, randomSeed); -} -/// -/// @brief Apply an impulse to this object as defined by a world position and velocity vector. @param pos impulse world position @param vel impulse velocity (impulse force F = m * v) @return Always true @note Not all objects that derrive from GameBase have this defined.) +/// @brief Apply an impulse to this object as defined by a world position and velocity vector. +/// +/// @param pos impulse world position +/// @param vel impulse velocity (impulse force F = m * v) +/// @return Always true +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public bool fnGameBase_applyImpulse (string gamebase, string pos, string vel) @@ -19003,7 +23708,14 @@ public bool fnGameBase_applyImpulse (string gamebase, string pos, string vel) return SafeNativeMethods.mwle_fnGameBase_applyImpulse(sbgamebase, sbpos, sbvel)>=1; } /// -/// @brief Applies a radial impulse to the object using the given origin and force. @param origin World point of origin of the radial impulse. @param radius The radius of the impulse area. @param magnitude The strength of the impulse. @note Not all objects that derrive from GameBase have this defined.) +/// @brief Applies a radial impulse to the object using the given origin and force. +/// +/// @param origin World point of origin of the radial impulse. +/// @param radius The radius of the impulse area. +/// @param magnitude The strength of the impulse. +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public void fnGameBase_applyRadialImpulse (string gamebase, string origin, float radius, float magnitude) @@ -19020,7 +23732,10 @@ public void fnGameBase_applyRadialImpulse (string gamebase, string origin, float SafeNativeMethods.mwle_fnGameBase_applyRadialImpulse(sbgamebase, sborigin, radius, magnitude); } /// -/// @brief Get the datablock used by this object. @return the datablock this GameBase is using. @see setDataBlock()) +/// @brief Get the datablock used by this object. +/// @return the datablock this GameBase is using. +/// @see setDataBlock()) +/// /// public int fnGameBase_getDataBlock (string gamebase) @@ -19034,7 +23749,11 @@ public int fnGameBase_getDataBlock (string gamebase) return SafeNativeMethods.mwle_fnGameBase_getDataBlock(sbgamebase); } /// -/// @brief Assign this GameBase to use the specified datablock. @param data new datablock to use @return true if successful, false if failed. @see getDataBlock()) +/// @brief Assign this GameBase to use the specified datablock. +/// @param data new datablock to use +/// @return true if successful, false if failed. +/// @see getDataBlock()) +/// /// public bool fnGameBase_setDataBlock (string gamebase, string data) @@ -19051,7 +23770,36 @@ public bool fnGameBase_setDataBlock (string gamebase, string data) return SafeNativeMethods.mwle_fnGameBase_setDataBlock(sbgamebase, sbdata)>=1; } /// -/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. Ghosts represent objects on the server that are in scope for the client. These need to be synchronized with the client in order for the client to see and interact with them. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mod paths, this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. +/// +/// Ghosts represent objects on the server that are in scope for the client. These need +/// to be synchronized with the client in order for the client to see and interact with them. +/// This is typically done during the standard mission start phase 2 when following Torque's +/// example mission startup sequence. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mod paths, this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void fnGameConnection_activateGhosting (string gameconnection) @@ -19065,7 +23813,10 @@ public void fnGameConnection_activateGhosting (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_activateGhosting(sbgameconnection); } /// -/// @brief Sets the size of the chase camera's matrix queue. @note This sets the queue size across all GameConnections. @note This is not currently hooked up.) +/// @brief Sets the size of the chase camera's matrix queue. +/// @note This sets the queue size across all GameConnections. +/// @note This is not currently hooked up.) +/// /// public bool fnGameConnection_chaseCam (string gameconnection, int size) @@ -19079,7 +23830,10 @@ public bool fnGameConnection_chaseCam (string gameconnection, int size) return SafeNativeMethods.mwle_fnGameConnection_chaseCam(sbgameconnection, size)>=1; } /// -/// @brief Clear the connection's camera object reference. @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// @brief Clear the connection's camera object reference. +/// +/// @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// /// public void fnGameConnection_clearCameraObject (string gameconnection) @@ -19093,7 +23847,9 @@ public void fnGameConnection_clearCameraObject (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_clearCameraObject(sbgameconnection); } /// -/// @brief Clear any display device. A display device may define a number of properties that are used during rendering.) +/// @brief Clear any display device. +/// A display device may define a number of properties that are used during rendering.) +/// /// public void fnGameConnection_clearDisplayDevice (string gameconnection) @@ -19107,7 +23863,26 @@ public void fnGameConnection_clearDisplayDevice (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_clearDisplayDevice(sbgameconnection); } /// -/// ), @brief On the server, disconnect a client and pass along an optional reason why. This method performs two operations: it disconnects a client connection from the server, and it deletes the connection object. The optional reason is sent in the disconnect packet and is often displayed to the user so they know why they've been disconnected. @param reason [optional] The reason why the user has been disconnected from the server. @tsexample function kick(%client) { messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); if (!%client.isAIControlled()) BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); %client.delete(\"You have been kicked from this server\"); } @endtsexample) +/// ), +/// @brief On the server, disconnect a client and pass along an optional reason why. +/// +/// This method performs two operations: it disconnects a client connection from the server, +/// and it deletes the connection object. The optional reason is sent in the disconnect packet +/// and is often displayed to the user so they know why they've been disconnected. +/// +/// @param reason [optional] The reason why the user has been disconnected from the server. +/// +/// @tsexample +/// function kick(%client) +/// { +/// messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); +/// +/// if (!%client.isAIControlled()) +/// BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); +/// %client.delete(\"You have been kicked from this server\"); +/// } +/// @endtsexample) +/// /// public void fnGameConnection_delete (string gameconnection, string reason) @@ -19124,7 +23899,10 @@ public void fnGameConnection_delete (string gameconnection, string reason) SafeNativeMethods.mwle_fnGameConnection_delete(sbgameconnection, sbreason); } /// -/// @brief Returns the connection's camera object used when not viewing through the control object. @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// @brief Returns the connection's camera object used when not viewing through the control object. +/// +/// @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// /// public string fnGameConnection_getCameraObject (string gameconnection) @@ -19142,6 +23920,7 @@ public string fnGameConnection_getCameraObject (string gameconnection) } /// /// @brief Returns the default field of view as used by the control object's camera.) +/// /// public float fnGameConnection_getControlCameraDefaultFov (string gameconnection) @@ -19156,6 +23935,7 @@ public float fnGameConnection_getControlCameraDefaultFov (string gameconnection) } /// /// @brief Returns the field of view as used by the control object's camera.) +/// /// public float fnGameConnection_getControlCameraFov (string gameconnection) @@ -19169,7 +23949,12 @@ public float fnGameConnection_getControlCameraFov (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_getControlCameraFov(sbgameconnection); } /// -/// @brief On the server, returns the object that the client is controlling. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @see GameConnection::setControlObject()) +/// @brief On the server, returns the object that the client is controlling. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @see GameConnection::setControlObject()) +/// /// public string fnGameConnection_getControlObject (string gameconnection) @@ -19186,7 +23971,11 @@ public string fnGameConnection_getControlObject (string gameconnection) } /// -/// @brief Get the connection's control scheme absolute rotation property. @return True if the connection's control object should use an absolute rotation control scheme. @see GameConnection::setControlSchemeParameters()) +/// @brief Get the connection's control scheme absolute rotation property. +/// +/// @return True if the connection's control object should use an absolute rotation control scheme. +/// @see GameConnection::setControlSchemeParameters()) +/// /// public bool fnGameConnection_getControlSchemeAbsoluteRotation (string gameconnection) @@ -19200,7 +23989,9 @@ public bool fnGameConnection_getControlSchemeAbsoluteRotation (string gameconnec return SafeNativeMethods.mwle_fnGameConnection_getControlSchemeAbsoluteRotation(sbgameconnection)>=1; } /// -/// @brief On the client, get the control object's damage flash level. @return flash level) +/// @brief On the client, get the control object's damage flash level. +/// @return flash level) +/// /// public float fnGameConnection_getDamageFlash (string gameconnection) @@ -19214,7 +24005,9 @@ public float fnGameConnection_getDamageFlash (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_getDamageFlash(sbgameconnection); } /// -/// @brief On the client, get the control object's white-out level. @return white-out level) +/// @brief On the client, get the control object's white-out level. +/// @return white-out level) +/// /// public float fnGameConnection_getWhiteOut (string gameconnection) @@ -19228,7 +24021,9 @@ public float fnGameConnection_getWhiteOut (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_getWhiteOut(sbgameconnection); } /// -/// @brief Returns true if this connection is AI controlled. @see AIConnection) +/// @brief Returns true if this connection is AI controlled. +/// @see AIConnection) +/// /// public bool fnGameConnection_isAIControlled (string gameconnection) @@ -19242,7 +24037,10 @@ public bool fnGameConnection_isAIControlled (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isAIControlled(sbgameconnection)>=1; } /// -/// @brief Returns true if the object being controlled by the client is making use of a rotation damped camera. @see Camera) +/// @brief Returns true if the object being controlled by the client is making use +/// of a rotation damped camera. +/// @see Camera) +/// /// public bool fnGameConnection_isControlObjectRotDampedCamera (string gameconnection) @@ -19256,7 +24054,10 @@ public bool fnGameConnection_isControlObjectRotDampedCamera (string gameconnecti return SafeNativeMethods.mwle_fnGameConnection_isControlObjectRotDampedCamera(sbgameconnection)>=1; } /// -/// @brief Returns true if a previously recorded demo file is now playing. @see GameConnection::playDemo()) +/// @brief Returns true if a previously recorded demo file is now playing. +/// +/// @see GameConnection::playDemo()) +/// /// public bool fnGameConnection_isDemoPlaying (string gameconnection) @@ -19270,7 +24071,10 @@ public bool fnGameConnection_isDemoPlaying (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isDemoPlaying(sbgameconnection)>=1; } /// -/// @brief Returns true if a demo file is now being recorded. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief Returns true if a demo file is now being recorded. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool fnGameConnection_isDemoRecording (string gameconnection) @@ -19284,7 +24088,11 @@ public bool fnGameConnection_isDemoRecording (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isDemoRecording(sbgameconnection)>=1; } /// -/// @brief Returns true if this connection is in first person mode. @note Transition to first person occurs over time via mCameraPos, so this won't immediately return true after a set.) +/// @brief Returns true if this connection is in first person mode. +/// +/// @note Transition to first person occurs over time via mCameraPos, so this +/// won't immediately return true after a set.) +/// /// public bool fnGameConnection_isFirstPerson (string gameconnection) @@ -19298,7 +24106,9 @@ public bool fnGameConnection_isFirstPerson (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isFirstPerson(sbgameconnection)>=1; } /// -/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. @note The list is sent to the console.) +/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. +/// @note The list is sent to the console.) +/// /// public void fnGameConnection_listClassIDs (string gameconnection) @@ -19313,6 +24123,7 @@ public void fnGameConnection_listClassIDs (string gameconnection) } /// /// ) +/// /// public bool fnGameConnection_LoadDatablocksFromFile (string gameconnection, uint crc) @@ -19326,7 +24137,20 @@ public bool fnGameConnection_LoadDatablocksFromFile (string gameconnection, uint return SafeNativeMethods.mwle_fnGameConnection_LoadDatablocksFromFile(sbgameconnection, crc)>=1; } /// -/// @brief Used on the server to play a 2D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @tsexample function ServerPlay2D(%profile) { // Play the given sound profile on every client. // The sounds will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play2D(%profile); } @endtsexample) +/// @brief Used on the server to play a 2D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// +/// @tsexample +/// function ServerPlay2D(%profile) +/// { +/// // Play the given sound profile on every client. +/// // The sounds will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play2D(%profile); +/// } +/// @endtsexample) +/// /// public bool fnGameConnection_play2D (string gameconnection, string profile) @@ -19343,7 +24167,21 @@ public bool fnGameConnection_play2D (string gameconnection, string profile) return SafeNativeMethods.mwle_fnGameConnection_play2D(sbgameconnection, sbprofile)>=1; } /// -/// @brief Used on the server to play a 3D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". @tsexample function ServerPlay3D(%profile,%transform) { // Play the given sound profile at the given position on every client // The sound will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play3D(%profile,%transform); } @endtsexample) +/// @brief Used on the server to play a 3D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". +/// +/// @tsexample +/// function ServerPlay3D(%profile,%transform) +/// { +/// // Play the given sound profile at the given position on every client +/// // The sound will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play3D(%profile,%transform); +/// } +/// @endtsexample) +/// /// public bool fnGameConnection_play3D (string gameconnection, string profile, string location) @@ -19363,7 +24201,19 @@ public bool fnGameConnection_play3D (string gameconnection, string profile, stri return SafeNativeMethods.mwle_fnGameConnection_play3D(sbgameconnection, sbprofile, sblocation)>=1; } /// -/// @brief On the client, play back a previously recorded game session. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @returns True if the playback was successful. False if there was an issue, such as not being able to open the demo file for playback. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief On the client, play back a previously recorded game session. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @returns True if the playback was successful. False if there was an issue, such as +/// not being able to open the demo file for playback. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool fnGameConnection_playDemo (string gameconnection, string demoFileName) @@ -19380,7 +24230,27 @@ public bool fnGameConnection_playDemo (string gameconnection, string demoFileNam return SafeNativeMethods.mwle_fnGameConnection_playDemo(sbgameconnection, sbdemoFileName)>=1; } /// -/// @brief On the server, resets the connection to indicate that ghosting has been disabled. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that ghosts are no longer being transmitted. On the client end, all ghost information will be deleted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, resets the connection to indicate that ghosting has been disabled. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that ghosts are no longer being transmitted. On the client end, all ghost +/// information will be deleted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void fnGameConnection_resetGhosting (string gameconnection) @@ -19394,7 +24264,11 @@ public void fnGameConnection_resetGhosting (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_resetGhosting(sbgameconnection); } /// -/// @brief On the server, sets the client's 3D display to fade to black. @param doFade Set to true to fade to black, and false to fade from black. @param timeMS Time it takes to perform the fade as measured in ms. @note Not currently hooked up, and is not synchronized over the network.) +/// @brief On the server, sets the client's 3D display to fade to black. +/// @param doFade Set to true to fade to black, and false to fade from black. +/// @param timeMS Time it takes to perform the fade as measured in ms. +/// @note Not currently hooked up, and is not synchronized over the network.) +/// /// public void fnGameConnection_setBlackOut (string gameconnection, bool doFade, int timeMS) @@ -19408,7 +24282,11 @@ public void fnGameConnection_setBlackOut (string gameconnection, bool doFade, in SafeNativeMethods.mwle_fnGameConnection_setBlackOut(sbgameconnection, doFade, timeMS); } /// -/// @brief On the server, set the connection's camera object used when not viewing through the control object. @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// @brief On the server, set the connection's camera object used when not viewing +/// through the control object. +/// +/// @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// /// public bool fnGameConnection_setCameraObject (string gameconnection, string camera) @@ -19425,7 +24303,14 @@ public bool fnGameConnection_setCameraObject (string gameconnection, string came return SafeNativeMethods.mwle_fnGameConnection_setCameraObject(sbgameconnection, sbcamera)>=1; } /// -/// (GameConnection, setConnectArgs, void, 3, 17, (const char* args) @brief On the client, pass along a variable set of parameters to the server. Once the connection is established with the server, the server calls its onConnect() method with the client's passed in parameters as aruments. @see GameConnection::onConnect()) +/// (GameConnection, setConnectArgs, void, 3, 17, +/// (const char* args) @brief On the client, pass along a variable set of parameters to the server. +/// +/// Once the connection is established with the server, the server calls its onConnect() method +/// with the client's passed in parameters as aruments. +/// +/// @see GameConnection::onConnect()) +/// /// public void fnGameConnection_setConnectArgs (string gameconnection, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16) @@ -19484,7 +24369,12 @@ public void fnGameConnection_setConnectArgs (string gameconnection, string a2, s SafeNativeMethods.mwle_fnGameConnection_setConnectArgs(sbgameconnection, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16); } /// -/// @brief On the server, sets the control object's camera's field of view. @param newFOV New field of view (in degrees) to force the control object's camera to use. This value is clamped to be within the range of 1 to 179 degrees. @note When transmitted over the network to the client, the resolution is limited to one degree. Any fraction is dropped.) +/// @brief On the server, sets the control object's camera's field of view. +/// @param newFOV New field of view (in degrees) to force the control object's camera to use. This value +/// is clamped to be within the range of 1 to 179 degrees. +/// @note When transmitted over the network to the client, the resolution is limited to +/// one degree. Any fraction is dropped.) +/// /// public void fnGameConnection_setControlCameraFov (string gameconnection, float newFOV) @@ -19498,7 +24388,12 @@ public void fnGameConnection_setControlCameraFov (string gameconnection, float n SafeNativeMethods.mwle_fnGameConnection_setControlCameraFov(sbgameconnection, newFOV); } /// -/// @brief On the server, sets the object that the client will control. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @param ctrlObj The GameBase object on the server to control.) +/// @brief On the server, sets the object that the client will control. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @param ctrlObj The GameBase object on the server to control.) +/// /// public bool fnGameConnection_setControlObject (string gameconnection, string ctrlObj) @@ -19515,7 +24410,11 @@ public bool fnGameConnection_setControlObject (string gameconnection, string ctr return SafeNativeMethods.mwle_fnGameConnection_setControlObject(sbgameconnection, sbctrlObj)>=1; } /// -/// @brief Set the control scheme that may be used by a connection's control object. @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// @brief Set the control scheme that may be used by a connection's control object. +/// +/// @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. +/// @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// /// public void fnGameConnection_setControlSchemeParameters (string gameconnection, bool absoluteRotation, bool addYawToAbsRot, bool addPitchToAbsRot) @@ -19529,7 +24428,10 @@ public void fnGameConnection_setControlSchemeParameters (string gameconnection, SafeNativeMethods.mwle_fnGameConnection_setControlSchemeParameters(sbgameconnection, absoluteRotation, addYawToAbsRot, addPitchToAbsRot); } /// -/// @brief On the server, sets this connection into or out of first person mode. @param firstPerson Set to true to put the connection into first person mode.) +/// @brief On the server, sets this connection into or out of first person mode. +/// +/// @param firstPerson Set to true to put the connection into first person mode.) +/// /// public void fnGameConnection_setFirstPerson (string gameconnection, bool firstPerson) @@ -19543,7 +24445,16 @@ public void fnGameConnection_setFirstPerson (string gameconnection, bool firstPe SafeNativeMethods.mwle_fnGameConnection_setFirstPerson(sbgameconnection, firstPerson); } /// -/// @brief On the client, set the password that will be passed to the server. On the server, this password is compared with what is stored in $pref::Server::Password. If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, if the passed in client password and the server password do not match, the CHR_PASSWORD error string is sent back to the client and the connection is immediately terminated. This password checking is performed quite early on in the connection request process so as to minimize the impact of multiple failed attempts -- also known as hacking.) +/// @brief On the client, set the password that will be passed to the server. +/// +/// On the server, this password is compared with what is stored in $pref::Server::Password. +/// If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, +/// if the passed in client password and the server password do not match, the CHR_PASSWORD +/// error string is sent back to the client and the connection is immediately terminated. +/// +/// This password checking is performed quite early on in the connection request process so as +/// to minimize the impact of multiple failed attempts -- also known as hacking.) +/// /// public void fnGameConnection_setJoinPassword (string gameconnection, string password) @@ -19560,7 +24471,35 @@ public void fnGameConnection_setJoinPassword (string gameconnection, string pass SafeNativeMethods.mwle_fnGameConnection_setJoinPassword(sbgameconnection, sbpassword); } /// -/// @brief On the server, transmits the mission file's CRC value to the client. Typically, during the standard mission start phase 1, the mission file's CRC value on the server is send to the client. This allows the client to determine if the mission has changed since the last time it downloaded this mission and act appropriately, such as rebuilt cached lightmaps. @param CRC The mission file's CRC value on the server. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample) +/// @brief On the server, transmits the mission file's CRC value to the client. +/// +/// Typically, during the standard mission start phase 1, the mission file's CRC value +/// on the server is send to the client. This allows the client to determine if the mission +/// has changed since the last time it downloaded this mission and act appropriately, such as +/// rebuilt cached lightmaps. +/// +/// @param CRC The mission file's CRC value on the server. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample) +/// /// public void fnGameConnection_setMissionCRC (string gameconnection, int CRC) @@ -19574,7 +24513,18 @@ public void fnGameConnection_setMissionCRC (string gameconnection, int CRC) SafeNativeMethods.mwle_fnGameConnection_setMissionCRC(sbgameconnection, CRC); } /// -/// @brief On the client, starts recording the network connection's traffic to a demo file. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @param fileName The file name to use for the demo recording. @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// @brief On the client, starts recording the network connection's traffic to a demo file. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @param fileName The file name to use for the demo recording. +/// +/// @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// /// public void fnGameConnection_startRecording (string gameconnection, string fileName) @@ -19591,7 +24541,10 @@ public void fnGameConnection_startRecording (string gameconnection, string fileN SafeNativeMethods.mwle_fnGameConnection_startRecording(sbgameconnection, sbfileName); } /// -/// @brief On the client, stops the recording of a connection's network traffic to a file. @see GameConnection::startRecording(), GameConnection::playDemo()) +/// @brief On the client, stops the recording of a connection's network traffic to a file. +/// +/// @see GameConnection::startRecording(), GameConnection::playDemo()) +/// /// public void fnGameConnection_stopRecording (string gameconnection) @@ -19605,7 +24558,44 @@ public void fnGameConnection_stopRecording (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_stopRecording(sbgameconnection); } /// -/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. SimDataBlocks, also known as just datablocks, need to be transmitted to the client prior to the client entering the game world. These represent the static data that most objects in the world reference. This is typically done during the standard mission start phase 1 when following Torque's example mission startup sequence. When the datablocks have all been transmitted, onDataBlocksDone() is called to move the mission start process to the next phase. @param sequence The sequence is common between the server and client and ensures that the client is acting on the most recent mission start process. If an errant network packet (one that was lost but has now been found) is received by the client with an incorrect sequence, it is just ignored. This sequence number is updated on the server every time a mission is loaded. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample @see GameConnection::onDataBlocksDone()) +/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. +/// +/// SimDataBlocks, also known as just datablocks, need to be transmitted to the client +/// prior to the client entering the game world. These represent the static data that +/// most objects in the world reference. This is typically done during the standard +/// mission start phase 1 when following Torque's example mission startup sequence. +/// +/// When the datablocks have all been transmitted, onDataBlocksDone() is called to move +/// the mission start process to the next phase. +/// +/// @param sequence The sequence is common between the server and client and ensures +/// that the client is acting on the most recent mission start process. If an errant +/// network packet (one that was lost but has now been found) is received by the client +/// with an incorrect sequence, it is just ignored. This sequence number is updated on +/// the server every time a mission is loaded. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample +/// +/// @see GameConnection::onDataBlocksDone()) +/// /// public void fnGameConnection_transmitDataBlocks (string gameconnection, int sequence) @@ -19619,7 +24609,11 @@ public void fnGameConnection_transmitDataBlocks (string gameconnection, int sequ SafeNativeMethods.mwle_fnGameConnection_transmitDataBlocks(sbgameconnection, sequence); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields to client objects. +/// ) +/// /// public void fnGroundPlane_postApply (string groundplane) @@ -19634,6 +24628,7 @@ public void fnGroundPlane_postApply (string groundplane) } /// /// ( GuiAutoCompleteCtrl, add, void, 3, 5, (string name, int idNum, int scheme=0)) +/// /// public void fnGuiAutoCompleteCtrl_add (string guiautocompletectrl, string a2, string a3, string a4) @@ -19657,6 +24652,7 @@ public void fnGuiAutoCompleteCtrl_add (string guiautocompletectrl, string a2, st } /// /// ( GuiAutoCompleteCtrl, addScheme, void, 6, 6, (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void fnGuiAutoCompleteCtrl_addScheme (string guiautocompletectrl, string a2, string a3, string a4, string a5) @@ -19683,6 +24679,7 @@ public void fnGuiAutoCompleteCtrl_addScheme (string guiautocompletectrl, string } /// /// ( GuiAutoCompleteCtrl, changeTextById, void, 4, 4, ( int id, string text ) ) +/// /// public void fnGuiAutoCompleteCtrl_changeTextById (string guiautocompletectrl, string a2, string a3) @@ -19703,6 +24700,7 @@ public void fnGuiAutoCompleteCtrl_changeTextById (string guiautocompletectrl, st } /// /// ( GuiAutoCompleteCtrl, clear, void, 2, 2, Clear the popup list.) +/// /// public void fnGuiAutoCompleteCtrl_clear (string guiautocompletectrl) @@ -19717,6 +24715,7 @@ public void fnGuiAutoCompleteCtrl_clear (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, clearEntry, void, 3, 3, (S32 entry)) +/// /// public void fnGuiAutoCompleteCtrl_clearEntry (string guiautocompletectrl, string a2) @@ -19733,7 +24732,9 @@ public void fnGuiAutoCompleteCtrl_clearEntry (string guiautocompletectrl, string SafeNativeMethods.mwle_fnGuiAutoCompleteCtrl_clearEntry(sbguiautocompletectrl, sba2); } /// -/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) Returns the position of the first entry containing the specified text.) +/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int fnGuiAutoCompleteCtrl_findText (string guiautocompletectrl, string a2) @@ -19751,6 +24752,7 @@ public int fnGuiAutoCompleteCtrl_findText (string guiautocompletectrl, string a2 } /// /// ( GuiAutoCompleteCtrl, forceClose, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_forceClose (string guiautocompletectrl) @@ -19765,6 +24767,7 @@ public void fnGuiAutoCompleteCtrl_forceClose (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, forceOnAction, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_forceOnAction (string guiautocompletectrl) @@ -19779,6 +24782,7 @@ public void fnGuiAutoCompleteCtrl_forceOnAction (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, getSelected, S32, 2, 2, ) +/// /// public int fnGuiAutoCompleteCtrl_getSelected (string guiautocompletectrl) @@ -19793,6 +24797,7 @@ public int fnGuiAutoCompleteCtrl_getSelected (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, getText, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_getText (string guiautocompletectrl) @@ -19807,6 +24812,7 @@ public void fnGuiAutoCompleteCtrl_getText (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, getTextById, const char*, 3, 3, (int id)) +/// /// public string fnGuiAutoCompleteCtrl_getTextById (string guiautocompletectrl, string a2) @@ -19827,6 +24833,7 @@ public string fnGuiAutoCompleteCtrl_getTextById (string guiautocompletectrl, str } /// /// ( GuiAutoCompleteCtrl, replaceText, void, 3, 3, (bool doReplaceText)) +/// /// public void fnGuiAutoCompleteCtrl_replaceText (string guiautocompletectrl, string a2) @@ -19843,7 +24850,11 @@ public void fnGuiAutoCompleteCtrl_replaceText (string guiautocompletectrl, strin SafeNativeMethods.mwle_fnGuiAutoCompleteCtrl_replaceText(sbguiautocompletectrl, sba2); } /// -/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void fnGuiAutoCompleteCtrl_setEnumContent (string guiautocompletectrl, string a2, string a3) @@ -19864,6 +24875,7 @@ public void fnGuiAutoCompleteCtrl_setEnumContent (string guiautocompletectrl, st } /// /// ( GuiAutoCompleteCtrl, setFirstSelected, void, 2, 3, ([scriptCallback=true])) +/// /// public void fnGuiAutoCompleteCtrl_setFirstSelected (string guiautocompletectrl, string a2) @@ -19881,6 +24893,7 @@ public void fnGuiAutoCompleteCtrl_setFirstSelected (string guiautocompletectrl, } /// /// ( GuiAutoCompleteCtrl, setNoneSelected, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_setNoneSelected (string guiautocompletectrl) @@ -19895,6 +24908,7 @@ public void fnGuiAutoCompleteCtrl_setNoneSelected (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, setSelected, void, 3, 4, (int id, [scriptCallback=true])) +/// /// public void fnGuiAutoCompleteCtrl_setSelected (string guiautocompletectrl, string a2, string a3) @@ -19915,6 +24929,7 @@ public void fnGuiAutoCompleteCtrl_setSelected (string guiautocompletectrl, strin } /// /// ( GuiAutoCompleteCtrl, size, S32, 2, 2, Get the size of the menu - the number of entries in it.) +/// /// public int fnGuiAutoCompleteCtrl_size (string guiautocompletectrl) @@ -19929,6 +24944,7 @@ public int fnGuiAutoCompleteCtrl_size (string guiautocompletectrl) } /// /// (GuiAutoCompleteCtrl, sort, void, 2, 2, Sort the list alphabetically.) +/// /// public void fnGuiAutoCompleteCtrl_sort (string guiautocompletectrl) @@ -19943,6 +24959,7 @@ public void fnGuiAutoCompleteCtrl_sort (string guiautocompletectrl) } /// /// (GuiAutoCompleteCtrl, sortID, void, 2, 2, Sort the list by ID.) +/// /// public void fnGuiAutoCompleteCtrl_sortID (string guiautocompletectrl) @@ -19957,6 +24974,7 @@ public void fnGuiAutoCompleteCtrl_sortID (string guiautocompletectrl) } /// /// Reset scrolling. ) +/// /// public void fnGuiAutoScrollCtrl_reset (string guiautoscrollctrl) @@ -19970,7 +24988,9 @@ public void fnGuiAutoScrollCtrl_reset (string guiautoscrollctrl) SafeNativeMethods.mwle_fnGuiAutoScrollCtrl_reset(sbguiautoscrollctrl); } /// -/// Set the bitmap to show on the button. @param path Path to the texture file in any of the supported formats. ) +/// Set the bitmap to show on the button. +/// @param path Path to the texture file in any of the supported formats. ) +/// /// public void fnGuiBitmapButtonCtrl_setBitmap (string guibitmapbuttonctrl, string path) @@ -19987,7 +25007,10 @@ public void fnGuiBitmapButtonCtrl_setBitmap (string guibitmapbuttonctrl, string SafeNativeMethods.mwle_fnGuiBitmapButtonCtrl_setBitmap(sbguibitmapbuttonctrl, sbpath); } /// -/// Set the offset of the bitmap within the control. @param x The x-axis offset of the image. @param y The y-axis offset of the image.) +/// Set the offset of the bitmap within the control. +/// @param x The x-axis offset of the image. +/// @param y The y-axis offset of the image.) +/// /// public void fnGuiBitmapCtrl_setValue (string guibitmapctrl, int x, int y) @@ -20001,7 +25024,9 @@ public void fnGuiBitmapCtrl_setValue (string guibitmapctrl, int x, int y) SafeNativeMethods.mwle_fnGuiBitmapCtrl_setValue(sbguibitmapctrl, x, y); } /// -/// Get the text display on the button's label (if any). @return The button's label. ) +/// Get the text display on the button's label (if any). +/// @return The button's label. ) +/// /// public string fnGuiButtonBaseCtrl_getText (string guibuttonbasectrl) @@ -20018,7 +25043,10 @@ public string fnGuiButtonBaseCtrl_getText (string guibuttonbasectrl) } /// -/// Simulate a click on the button. This method will trigger the button's action just as if the button had been pressed by the user. ) +/// Simulate a click on the button. +/// This method will trigger the button's action just as if the button had been pressed by the +/// user. ) +/// /// public void fnGuiButtonBaseCtrl_performClick (string guibuttonbasectrl) @@ -20032,7 +25060,9 @@ public void fnGuiButtonBaseCtrl_performClick (string guibuttonbasectrl) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_performClick(sbguibuttonbasectrl); } /// -/// Reset the mousing state of the button. This method should not generally be called. ) +/// Reset the mousing state of the button. +/// This method should not generally be called. ) +/// /// public void fnGuiButtonBaseCtrl_resetState (string guibuttonbasectrl) @@ -20046,7 +25076,12 @@ public void fnGuiButtonBaseCtrl_resetState (string guibuttonbasectrl) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_resetState(sbguibuttonbasectrl); } /// -/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, toggling a button on will toggle all other radio buttons in its group to off. @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the button. To do that, use performClick(). ) +/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, +/// toggling a button on will toggle all other radio buttons in its group to off. +/// @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. +/// @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the +/// button. To do that, use performClick(). ) +/// /// public void fnGuiButtonBaseCtrl_setStateOn (string guibuttonbasectrl, bool isOn) @@ -20060,7 +25095,12 @@ public void fnGuiButtonBaseCtrl_setStateOn (string guibuttonbasectrl, bool isOn) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_setStateOn(sbguibuttonbasectrl, isOn); } /// -/// Set the text displayed on the button's label. @param text The text to display as the button's text label. @note Not all buttons render text labels. @see getText @see setTextID ) +/// Set the text displayed on the button's label. +/// @param text The text to display as the button's text label. +/// @note Not all buttons render text labels. +/// @see getText +/// @see setTextID ) +/// /// public void fnGuiButtonBaseCtrl_setText (string guibuttonbasectrl, string text) @@ -20077,7 +25117,17 @@ public void fnGuiButtonBaseCtrl_setText (string guibuttonbasectrl, string text) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_setText(sbguibuttonbasectrl, sbtext); } /// -/// Set the text displayed on the button's label using a string from the string table assigned to the control. @param id Name of the variable that contains the integer string ID. Used to look up string in table. @note Not all buttons render text labels. @see setText @see getText @see GuiControl::langTableMod @see LangTable @ref Gui_i18n ) +/// Set the text displayed on the button's label using a string from the string table +/// assigned to the control. +/// @param id Name of the variable that contains the integer string ID. Used to look up +/// string in table. +/// @note Not all buttons render text labels. +/// @see setText +/// @see getText +/// @see GuiControl::langTableMod +/// @see LangTable +/// @ref Gui_i18n ) +/// /// public void fnGuiButtonBaseCtrl_setTextID (string guibuttonbasectrl, string id) @@ -20094,7 +25144,10 @@ public void fnGuiButtonBaseCtrl_setTextID (string guibuttonbasectrl, string id) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_setTextID(sbguibuttonbasectrl, sbid); } /// -/// Translate a coordinate from canvas window-space to screen-space. @param coordinate The coordinate in window-space. @return The given coordinate translated to screen-space. ) +/// Translate a coordinate from canvas window-space to screen-space. +/// @param coordinate The coordinate in window-space. +/// @return The given coordinate translated to screen-space. ) +/// /// public string fnGuiCanvas_clientToScreen (string guicanvas, string coordinate) @@ -20114,7 +25167,11 @@ public string fnGuiCanvas_clientToScreen (string guicanvas, string coordinate) } /// -/// @brief Turns on the mouse off. @tsexample Canvas.cursorOff(); @endtsexample) +/// @brief Turns on the mouse off. +/// @tsexample +/// Canvas.cursorOff(); +/// @endtsexample) +/// /// public void fnGuiCanvas_cursorOff (string guicanvas) @@ -20128,7 +25185,11 @@ public void fnGuiCanvas_cursorOff (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_cursorOff(sbguicanvas); } /// -/// @brief Turns on the mouse cursor. @tsexample Canvas.cursorOn(); @endtsexample) +/// @brief Turns on the mouse cursor. +/// @tsexample +/// Canvas.cursorOn(); +/// @endtsexample) +/// /// public void fnGuiCanvas_cursorOn (string guicanvas) @@ -20142,7 +25203,11 @@ public void fnGuiCanvas_cursorOn (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_cursorOn(sbguicanvas); } /// -/// @brief Find the first monitor index that matches the given name. The actual match algorithm depends on the implementation. @param name The name to search for. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Find the first monitor index that matches the given name. +/// The actual match algorithm depends on the implementation. +/// @param name The name to search for. +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int fnGuiCanvas_findFirstMatchingMonitor (string guicanvas, string name) @@ -20159,7 +25224,14 @@ public int fnGuiCanvas_findFirstMatchingMonitor (string guicanvas, string name) return SafeNativeMethods.mwle_fnGuiCanvas_findFirstMatchingMonitor(sbguicanvas, sbname); } /// -/// @brief Get the GuiControl which is being used as the content. @tsexample Canvas.getContent(); @endtsexample @return ID of current content control) +/// @brief Get the GuiControl which is being used as the content. +/// +/// @tsexample +/// Canvas.getContent(); +/// @endtsexample +/// +/// @return ID of current content control) +/// /// public int fnGuiCanvas_getContent (string guicanvas) @@ -20173,7 +25245,13 @@ public int fnGuiCanvas_getContent (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getContent(sbguicanvas); } /// -/// @brief Get the current position of the cursor. @param param Description @tsexample %cursorPos = Canvas.getCursorPos(); @endtsexample @return Screen coordinates of mouse cursor, in format \"X Y\") +/// @brief Get the current position of the cursor. +/// @param param Description +/// @tsexample +/// %cursorPos = Canvas.getCursorPos(); +/// @endtsexample +/// @return Screen coordinates of mouse cursor, in format \"X Y\") +/// /// public string fnGuiCanvas_getCursorPos (string guicanvas) @@ -20190,7 +25268,14 @@ public string fnGuiCanvas_getCursorPos (string guicanvas) } /// -/// @brief Returns the dimensions of the canvas @tsexample %extent = Canvas.getExtent(); @endtsexample @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// @brief Returns the dimensions of the canvas +/// +/// @tsexample +/// %extent = Canvas.getExtent(); +/// @endtsexample +/// +/// @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// /// public string fnGuiCanvas_getExtent (string guicanvas) @@ -20207,7 +25292,11 @@ public string fnGuiCanvas_getExtent (string guicanvas) } /// -/// @brief Gets information on the specified mode of this device. @param modeId Index of the mode to get data from. @return A video mode string given an adapter and mode index. @see GuiCanvas::getVideoMode()) +/// @brief Gets information on the specified mode of this device. +/// @param modeId Index of the mode to get data from. +/// @return A video mode string given an adapter and mode index. +/// @see GuiCanvas::getVideoMode()) +/// /// public string fnGuiCanvas_getMode (string guicanvas, int modeId) @@ -20224,7 +25313,16 @@ public string fnGuiCanvas_getMode (string guicanvas, int modeId) } /// -/// @brief Gets the number of modes available on this device. @param param Description @tsexample %modeCount = Canvas.getModeCount() @endtsexample @return The number of video modes supported by the device) +/// @brief Gets the number of modes available on this device. +/// +/// @param param Description +/// +/// @tsexample +/// %modeCount = Canvas.getModeCount() +/// @endtsexample +/// +/// @return The number of video modes supported by the device) +/// /// public int fnGuiCanvas_getModeCount (string guicanvas) @@ -20238,7 +25336,10 @@ public int fnGuiCanvas_getModeCount (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getModeCount(sbguicanvas); } /// -/// @brief Gets the number of monitors attached to the system. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Gets the number of monitors attached to the system. +/// +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int fnGuiCanvas_getMonitorCount (string guicanvas) @@ -20252,7 +25353,10 @@ public int fnGuiCanvas_getMonitorCount (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getMonitorCount(sbguicanvas); } /// -/// @brief Gets the name of the requested monitor. @param index The monitor index. @return The name of the requested monitor.) +/// @brief Gets the name of the requested monitor. +/// @param index The monitor index. +/// @return The name of the requested monitor.) +/// /// public string fnGuiCanvas_getMonitorName (string guicanvas, int index) @@ -20269,7 +25373,10 @@ public string fnGuiCanvas_getMonitorName (string guicanvas, int index) } /// -/// @brief Gets the region of the requested monitor. @param index The monitor index. @return The rectangular region of the requested monitor.) +/// @brief Gets the region of the requested monitor. +/// @param index The monitor index. +/// @return The rectangular region of the requested monitor.) +/// /// public string fnGuiCanvas_getMonitorRect (string guicanvas, int index) @@ -20286,7 +25393,13 @@ public string fnGuiCanvas_getMonitorRect (string guicanvas, int index) } /// -/// @brief Gets the gui control under the mouse. @tsexample %underMouse = Canvas.getMouseControl(); @endtsexample @return ID of the gui control, if one was found. NULL otherwise) +/// @brief Gets the gui control under the mouse. +/// @tsexample +/// %underMouse = Canvas.getMouseControl(); +/// @endtsexample +/// +/// @return ID of the gui control, if one was found. NULL otherwise) +/// /// public int fnGuiCanvas_getMouseControl (string guicanvas) @@ -20300,7 +25413,21 @@ public int fnGuiCanvas_getMouseControl (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getMouseControl(sbguicanvas); } /// -/// @brief Gets the current screen mode as a string. The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). You will need to parse out each one for individual use. @tsexample %screenWidth = getWord(Canvas.getVideoMode(), 0); %screenHeight = getWord(Canvas.getVideoMode(), 1); %isFullscreen = getWord(Canvas.getVideoMode(), 2); %bitdepth = getWord(Canvas.getVideoMode(), 3); %refreshRate = getWord(Canvas.getVideoMode(), 4); @endtsexample @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// @brief Gets the current screen mode as a string. +/// +/// The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). +/// You will need to parse out each one for individual use. +/// +/// @tsexample +/// %screenWidth = getWord(Canvas.getVideoMode(), 0); +/// %screenHeight = getWord(Canvas.getVideoMode(), 1); +/// %isFullscreen = getWord(Canvas.getVideoMode(), 2); +/// %bitdepth = getWord(Canvas.getVideoMode(), 3); +/// %refreshRate = getWord(Canvas.getVideoMode(), 4); +/// @endtsexample +/// +/// @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// /// public string fnGuiCanvas_getVideoMode (string guicanvas) @@ -20317,7 +25444,9 @@ public string fnGuiCanvas_getVideoMode (string guicanvas) } /// -/// Get the current position of the platform window associated with the canvas. @return The window position of the canvas in screen-space. ) +/// Get the current position of the platform window associated with the canvas. +/// @return The window position of the canvas in screen-space. ) +/// /// public string fnGuiCanvas_getWindowPosition (string guicanvas) @@ -20334,7 +25463,12 @@ public string fnGuiCanvas_getWindowPosition (string guicanvas) } /// -/// @brief Disable rendering of the cursor. @tsexample Canvas.hideCursor(); @endtsexample) +/// @brief Disable rendering of the cursor. +/// +/// @tsexample +/// Canvas.hideCursor(); +/// @endtsexample) +/// /// public void fnGuiCanvas_hideCursor (string guicanvas) @@ -20348,7 +25482,30 @@ public void fnGuiCanvas_hideCursor (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_hideCursor(sbguicanvas); } /// -/// @brief Determines if mouse cursor is enabled. @tsexample // Is cursor on? if(Canvas.isCursorOn()) echo(\"Canvas cursor is on\"); @endtsexample @return Returns true if the cursor is on.) +/// ( GuiCanvas, hideWindow, void, 2, 2, ) +/// +/// + +public void fnGuiCanvas_hideWindow (string guicanvas) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnGuiCanvas_hideWindow'" + string.Format("\"{0}\" ",guicanvas)); +StringBuilder sbguicanvas = null; +if (guicanvas != null) + sbguicanvas = new StringBuilder(guicanvas, 1024); + +SafeNativeMethods.mwle_fnGuiCanvas_hideWindow(sbguicanvas); +} +/// +/// @brief Determines if mouse cursor is enabled. +/// +/// @tsexample +/// // Is cursor on? +/// if(Canvas.isCursorOn()) +/// echo(\"Canvas cursor is on\"); +/// @endtsexample +/// @return Returns true if the cursor is on.) +/// /// public bool fnGuiCanvas_isCursorOn (string guicanvas) @@ -20362,7 +25519,15 @@ public bool fnGuiCanvas_isCursorOn (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_isCursorOn(sbguicanvas)>=1; } /// -/// @brief Determines if mouse cursor is rendering. @tsexample // Is cursor rendering? if(Canvas.isCursorShown()) echo(\"Canvas cursor is rendering\"); @endtsexample @return Returns true if the cursor is rendering.) +/// @brief Determines if mouse cursor is rendering. +/// +/// @tsexample +/// // Is cursor rendering? +/// if(Canvas.isCursorShown()) +/// echo(\"Canvas cursor is rendering\"); +/// @endtsexample +/// @return Returns true if the cursor is rendering.) +/// /// public bool fnGuiCanvas_isCursorShown (string guicanvas) @@ -20376,7 +25541,14 @@ public bool fnGuiCanvas_isCursorShown (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_isCursorShown(sbguicanvas)>=1; } /// -/// @brief This turns on/off front-buffer rendering. @param enable True if all rendering should be done to the front buffer @tsexample Canvas.renderFront(false); @endtsexample) +/// @brief This turns on/off front-buffer rendering. +/// +/// @param enable True if all rendering should be done to the front buffer +/// +/// @tsexample +/// Canvas.renderFront(false); +/// @endtsexample) +/// /// public void fnGuiCanvas_renderFront (string guicanvas, bool enable) @@ -20390,7 +25562,15 @@ public void fnGuiCanvas_renderFront (string guicanvas, bool enable) SafeNativeMethods.mwle_fnGuiCanvas_renderFront(sbguicanvas, enable); } /// -/// @brief Force canvas to redraw. If the elapsed time is greater than the time since the last paint then the repaint will be skipped. @param elapsedMS The optional elapsed time in milliseconds. @tsexample Canvas.repaint(); @endtsexample) +/// @brief Force canvas to redraw. +/// If the elapsed time is greater than the time since the last paint +/// then the repaint will be skipped. +/// @param elapsedMS The optional elapsed time in milliseconds. +/// +/// @tsexample +/// Canvas.repaint(); +/// @endtsexample) +/// /// public void fnGuiCanvas_repaint (string guicanvas, int elapsedMS) @@ -20404,7 +25584,12 @@ public void fnGuiCanvas_repaint (string guicanvas, int elapsedMS) SafeNativeMethods.mwle_fnGuiCanvas_repaint(sbguicanvas, elapsedMS); } /// -/// @brief Reset the update regions for the canvas. @tsexample Canvas.reset(); @endtsexample) +/// @brief Reset the update regions for the canvas. +/// +/// @tsexample +/// Canvas.reset(); +/// @endtsexample) +/// /// public void fnGuiCanvas_reset (string guicanvas) @@ -20418,7 +25603,10 @@ public void fnGuiCanvas_reset (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_reset(sbguicanvas); } /// -/// Translate a coordinate from screen-space to canvas window-space. @param coordinate The coordinate in screen-space. @return The given coordinate translated to window-space. ) +/// Translate a coordinate from screen-space to canvas window-space. +/// @param coordinate The coordinate in screen-space. +/// @return The given coordinate translated to window-space. ) +/// /// public string fnGuiCanvas_screenToClient (string guicanvas, string coordinate) @@ -20438,7 +25626,14 @@ public string fnGuiCanvas_screenToClient (string guicanvas, string coordinate) } /// -/// @brief Set the content of the canvas to a specified control. @param ctrl ID or name of GuiControl to set content to @tsexample Canvas.setContent(PlayGui); @endtsexample) +/// @brief Set the content of the canvas to a specified control. +/// +/// @param ctrl ID or name of GuiControl to set content to +/// +/// @tsexample +/// Canvas.setContent(PlayGui); +/// @endtsexample) +/// /// public void fnGuiCanvas_setContent (string guicanvas, string ctrl) @@ -20455,7 +25650,14 @@ public void fnGuiCanvas_setContent (string guicanvas, string ctrl) SafeNativeMethods.mwle_fnGuiCanvas_setContent(sbguicanvas, sbctrl); } /// -/// @brief Sets the cursor for the canvas. @param cursor Name of the GuiCursor to use @tsexample Canvas.setCursor(\"DefaultCursor\"); @endtsexample) +/// @brief Sets the cursor for the canvas. +/// +/// @param cursor Name of the GuiCursor to use +/// +/// @tsexample +/// Canvas.setCursor(\"DefaultCursor\"); +/// @endtsexample) +/// /// public void fnGuiCanvas_setCursor (string guicanvas, string cursor) @@ -20473,6 +25675,7 @@ public void fnGuiCanvas_setCursor (string guicanvas, string cursor) } /// /// (bool shown) - Enabled when a context menu/popup menu is shown.) +/// /// public void fnGuiCanvas_setPopupShown (string guicanvas, bool shown) @@ -20486,7 +25689,9 @@ public void fnGuiCanvas_setPopupShown (string guicanvas, bool shown) SafeNativeMethods.mwle_fnGuiCanvas_setPopupShown(sbguicanvas, shown); } /// -/// Set the position of the platform window associated with the canvas. @param position The new position of the window in screen-space. ) +/// Set the position of the platform window associated with the canvas. +/// @param position The new position of the window in screen-space. ) +/// /// public void fnGuiCanvas_setWindowPosition (string guicanvas, string position) @@ -20503,7 +25708,14 @@ public void fnGuiCanvas_setWindowPosition (string guicanvas, string position) SafeNativeMethods.mwle_fnGuiCanvas_setWindowPosition(sbguicanvas, sbposition); } /// -/// @brief Change the title of the OS window. @param newTitle String containing the new name @tsexample Canvas.setWindowTitle(\"Documentation Rocks!\"); @endtsexample) +/// @brief Change the title of the OS window. +/// +/// @param newTitle String containing the new name +/// +/// @tsexample +/// Canvas.setWindowTitle(\"Documentation Rocks!\"); +/// @endtsexample) +/// /// public void fnGuiCanvas_setWindowTitle (string guicanvas, string newTitle) @@ -20520,7 +25732,12 @@ public void fnGuiCanvas_setWindowTitle (string guicanvas, string newTitle) SafeNativeMethods.mwle_fnGuiCanvas_setWindowTitle(sbguicanvas, sbnewTitle); } /// -/// @brief Enable rendering of the cursor. @tsexample Canvas.showCursor(); @endtsexample) +/// @brief Enable rendering of the cursor. +/// +/// @tsexample +/// Canvas.showCursor(); +/// @endtsexample) +/// /// public void fnGuiCanvas_showCursor (string guicanvas) @@ -20534,7 +25751,28 @@ public void fnGuiCanvas_showCursor (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_showCursor(sbguicanvas); } /// -/// @brief toggle canvas from fullscreen to windowed mode or back. @tsexample // If we are in windowed mode, the following will put is in fullscreen Canvas.toggleFullscreen(); @endtsexample) +/// ( GuiCanvas, showWindow, void, 2, 2, ) +/// +/// + +public void fnGuiCanvas_showWindow (string guicanvas) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnGuiCanvas_showWindow'" + string.Format("\"{0}\" ",guicanvas)); +StringBuilder sbguicanvas = null; +if (guicanvas != null) + sbguicanvas = new StringBuilder(guicanvas, 1024); + +SafeNativeMethods.mwle_fnGuiCanvas_showWindow(sbguicanvas); +} +/// +/// @brief toggle canvas from fullscreen to windowed mode or back. +/// +/// @tsexample +/// // If we are in windowed mode, the following will put is in fullscreen +/// Canvas.toggleFullscreen(); +/// @endtsexample) +/// /// public void fnGuiCanvas_toggleFullscreen (string guicanvas) @@ -20548,7 +25786,9 @@ public void fnGuiCanvas_toggleFullscreen (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_toggleFullscreen(sbguicanvas); } /// -/// Test whether the checkbox is currently checked. @return True if the checkbox is currently ticked, false otherwise. ) +/// Test whether the checkbox is currently checked. +/// @return True if the checkbox is currently ticked, false otherwise. ) +/// /// public bool fnGuiCheckBoxCtrl_isStateOn (string guicheckboxctrl) @@ -20562,7 +25802,11 @@ public bool fnGuiCheckBoxCtrl_isStateOn (string guicheckboxctrl) return SafeNativeMethods.mwle_fnGuiCheckBoxCtrl_isStateOn(sbguicheckboxctrl)>=1; } /// -/// Set whether the checkbox is ticked or not. @param newState If true the box will be checked, if false, it will be unchecked. @note This method will @b not trigger the command associated with the control. To toggle the checkbox state as if the user had clicked the control, use performClick(). ) +/// Set whether the checkbox is ticked or not. +/// @param newState If true the box will be checked, if false, it will be unchecked. +/// @note This method will @b not trigger the command associated with the control. To toggle the +/// checkbox state as if the user had clicked the control, use performClick(). ) +/// /// public void fnGuiCheckBoxCtrl_setStateOn (string guicheckboxctrl, bool newState) @@ -20576,7 +25820,12 @@ public void fnGuiCheckBoxCtrl_setStateOn (string guicheckboxctrl, bool newState) SafeNativeMethods.mwle_fnGuiCheckBoxCtrl_setStateOn(sbguicheckboxctrl, newState); } /// -/// @brief Set the image rendered in this control. @param filename The image name you want to set @tsexample ChunkedBitmap.setBitmap(\"images/background.png\"); @endtsexample) +/// @brief Set the image rendered in this control. +/// @param filename The image name you want to set +/// @tsexample +/// ChunkedBitmap.setBitmap(\"images/background.png\"); +/// @endtsexample) +/// /// public void fnGuiChunkedBitmapCtrl_setBitmap (string guichunkedbitmapctrl, string filename) @@ -20593,7 +25842,14 @@ public void fnGuiChunkedBitmapCtrl_setBitmap (string guichunkedbitmapctrl, strin SafeNativeMethods.mwle_fnGuiChunkedBitmapCtrl_setBitmap(sbguichunkedbitmapctrl, sbfilename); } /// -/// Returns the current time, in seconds. @return timeInseconds Current time, in seconds @tsexample // Get the current time from the GuiClockHud control %timeInSeconds = %guiClockHud.getTime(); @endtsexample ) +/// Returns the current time, in seconds. +/// @return timeInseconds Current time, in seconds +/// @tsexample +/// // Get the current time from the GuiClockHud control +/// %timeInSeconds = %guiClockHud.getTime(); +/// @endtsexample +/// ) +/// /// public float fnGuiClockHud_getTime (string guiclockhud) @@ -20607,7 +25863,12 @@ public float fnGuiClockHud_getTime (string guiclockhud) return SafeNativeMethods.mwle_fnGuiClockHud_getTime(sbguiclockhud); } /// -/// @brief Sets a time for a countdown clock. Setting the time like this will cause the clock to count backwards from the specified time. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @see setTime ) +/// @brief Sets a time for a countdown clock. +/// Setting the time like this will cause the clock to count backwards from the specified time. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @see setTime +/// ) +/// /// public void fnGuiClockHud_setReverseTime (string guiclockhud, float timeInSeconds) @@ -20621,7 +25882,16 @@ public void fnGuiClockHud_setReverseTime (string guiclockhud, float timeInSecond SafeNativeMethods.mwle_fnGuiClockHud_setReverseTime(sbguiclockhud, timeInSeconds); } /// -/// Sets the current base time for the clock. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @tsexample // Define the time, in seconds %timeInSeconds = 120; // Change the time on the GuiClockHud control %guiClockHud.setTime(%timeInSeconds); @endtsexample ) +/// Sets the current base time for the clock. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @tsexample +/// // Define the time, in seconds +/// %timeInSeconds = 120; +/// // Change the time on the GuiClockHud control +/// %guiClockHud.setTime(%timeInSeconds); +/// @endtsexample +/// ) +/// /// public void fnGuiClockHud_setTime (string guiclockhud, float timeInSeconds) @@ -20635,7 +25905,13 @@ public void fnGuiClockHud_setTime (string guiclockhud, float timeInSeconds) SafeNativeMethods.mwle_fnGuiClockHud_setTime(sbguiclockhud, timeInSeconds); } /// -/// Add the given control as a child to this control. This is synonymous to calling SimGroup::addObject. @param control The control to add as a child. @note The control will retain its current position and size. @see SimGroup::addObject @ref GuiControl_Hierarchy ) +/// Add the given control as a child to this control. +/// This is synonymous to calling SimGroup::addObject. +/// @param control The control to add as a child. +/// @note The control will retain its current position and size. +/// @see SimGroup::addObject +/// @ref GuiControl_Hierarchy ) +/// /// public void fnGuiControl_addGuiControl (string guicontrol, string control) @@ -20653,6 +25929,7 @@ public void fnGuiControl_addGuiControl (string guicontrol, string control) } /// /// Returns if the control's background color can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextBackColor (string guicontrol) @@ -20667,6 +25944,7 @@ public bool fnGuiControl_canChangeContextBackColor (string guicontrol) } /// /// Returns if the control's fill color can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextFillColor (string guicontrol) @@ -20681,6 +25959,7 @@ public bool fnGuiControl_canChangeContextFillColor (string guicontrol) } /// /// Returns if the control's font color can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextFontColor (string guicontrol) @@ -20695,6 +25974,7 @@ public bool fnGuiControl_canChangeContextFontColor (string guicontrol) } /// /// Returns if the control's font size can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextFontSize (string guicontrol) @@ -20709,6 +25989,7 @@ public bool fnGuiControl_canChangeContextFontSize (string guicontrol) } /// /// Returns if the control's window settings can be changed in the game or not. ) +/// /// public bool fnGuiControl_canShowContextWindowSettings (string guicontrol) @@ -20722,7 +26003,9 @@ public bool fnGuiControl_canShowContextWindowSettings (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_canShowContextWindowSettings(sbguicontrol)>=1; } /// -/// Clear this control from being the first responder in its hierarchy chain. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Clear this control from being the first responder in its hierarchy chain. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void fnGuiControl_clearFirstResponder (string guicontrol, bool ignored) @@ -20736,7 +26019,10 @@ public void fnGuiControl_clearFirstResponder (string guicontrol, bool ignored) SafeNativeMethods.mwle_fnGuiControl_clearFirstResponder(sbguicontrol, ignored); } /// -/// Test whether the given control is a direct or indirect child to this control. @param control The potential child control. @return True if the given control is a direct or indirect child to this control. ) +/// Test whether the given control is a direct or indirect child to this control. +/// @param control The potential child control. +/// @return True if the given control is a direct or indirect child to this control. ) +/// /// public bool fnGuiControl_controlIsChild (string guicontrol, string control) @@ -20753,7 +26039,10 @@ public bool fnGuiControl_controlIsChild (string guicontrol, string control) return SafeNativeMethods.mwle_fnGuiControl_controlIsChild(sbguicontrol, sbcontrol)>=1; } /// -/// Test whether the given control is a sibling of this control. @param control The potential sibling control. @return True if the given control is a sibling of this control. ) +/// Test whether the given control is a sibling of this control. +/// @param control The potential sibling control. +/// @return True if the given control is a sibling of this control. ) +/// /// public bool fnGuiControl_controlIsSibling (string guicontrol, string control) @@ -20770,7 +26059,14 @@ public bool fnGuiControl_controlIsSibling (string guicontrol, string control) return SafeNativeMethods.mwle_fnGuiControl_controlIsSibling(sbguicontrol, sbcontrol)>=1; } /// -/// Find the topmost child control located at the given coordinates. @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. @param x The X coordinate in the control's own coordinate space. @param y The Y coordinate in the control's own coordinate space. @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. @see GuiControlProfile::modal @see findHitControls ) +/// Find the topmost child control located at the given coordinates. +/// @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. +/// @param x The X coordinate in the control's own coordinate space. +/// @param y The Y coordinate in the control's own coordinate space. +/// @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. +/// @see GuiControlProfile::modal +/// @see findHitControls ) +/// /// public string fnGuiControl_findHitControl (string guicontrol, int x, int y) @@ -20787,7 +26083,20 @@ public string fnGuiControl_findHitControl (string guicontrol, int x, int y) } /// -/// Find all visible child controls that intersect with the given rectangle. @note Invisible child controls will not be included in the search. @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. @param width The width of the search rectangle in pixels. @param height The height of the search rectangle in pixels. @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. @tsexample // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) %ctrl.setLocked( true ); @endtsexample @see findHitControl ) +/// Find all visible child controls that intersect with the given rectangle. +/// @note Invisible child controls will not be included in the search. +/// @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param width The width of the search rectangle in pixels. +/// @param height The height of the search rectangle in pixels. +/// @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. +/// @tsexample +/// // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. +/// foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) +/// %ctrl.setLocked( true ); +/// @endtsexample +/// @see findHitControl ) +/// /// public string fnGuiControl_findHitControls (string guicontrol, int x, int y, int width, int height) @@ -20805,6 +26114,7 @@ public string fnGuiControl_findHitControls (string guicontrol, int x, int y, int } /// /// Get the alpha fade time for the object. ) +/// /// public int fnGuiControl_getAlphaFadeTime (string guicontrol) @@ -20819,6 +26129,7 @@ public int fnGuiControl_getAlphaFadeTime (string guicontrol) } /// /// Get the alpha for the object. ) +/// /// public float fnGuiControl_getAlphaValue (string guicontrol) @@ -20832,7 +26143,10 @@ public float fnGuiControl_getAlphaValue (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_getAlphaValue(sbguicontrol); } /// -/// Get the aspect ratio of the control's extents. @return The width of the control divided by its height. @see getExtent ) +/// Get the aspect ratio of the control's extents. +/// @return The width of the control divided by its height. +/// @see getExtent ) +/// /// public float fnGuiControl_getAspect (string guicontrol) @@ -20846,7 +26160,9 @@ public float fnGuiControl_getAspect (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_getAspect(sbguicontrol); } /// -/// Get the coordinate of the control's center point relative to its parent. @return The coordinate of the control's center point in parent-relative coordinates. ) +/// Get the coordinate of the control's center point relative to its parent. +/// @return The coordinate of the control's center point in parent-relative coordinates. ) +/// /// public string fnGuiControl_getCenter (string guicontrol) @@ -20864,6 +26180,7 @@ public string fnGuiControl_getCenter (string guicontrol) } /// /// Sets the font size of a control. ) +/// /// public int fnGuiControl_getControlFontSize (string guicontrol) @@ -20878,6 +26195,7 @@ public int fnGuiControl_getControlFontSize (string guicontrol) } /// /// Returns if the control is locked or not. ) +/// /// public bool fnGuiControl_getControlLock (string guicontrol) @@ -20892,6 +26210,7 @@ public bool fnGuiControl_getControlLock (string guicontrol) } /// /// Returns the filename of the texture of the control. ) +/// /// public string fnGuiControl_getControlTextureFile (string guicontrol) @@ -20908,7 +26227,9 @@ public string fnGuiControl_getControlTextureFile (string guicontrol) } /// -/// Get the width and height of the control. @return A point structure containing the width of the control in x and the height in y. ) +/// Get the width and height of the control. +/// @return A point structure containing the width of the control in x and the height in y. ) +/// /// public string fnGuiControl_getExtent (string guicontrol) @@ -20925,7 +26246,13 @@ public string fnGuiControl_getExtent (string guicontrol) } /// -/// Get the first responder set on this GuiControl tree. @return The first responder set on the control's subtree. @see isFirstResponder @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Get the first responder set on this GuiControl tree. +/// @return The first responder set on the control's subtree. +/// @see isFirstResponder +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public string fnGuiControl_getFirstResponder (string guicontrol) @@ -20942,7 +26269,9 @@ public string fnGuiControl_getFirstResponder (string guicontrol) } /// -/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. @Return the center coordinate of the control in root-relative coordinates. ) +/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. +/// @Return the center coordinate of the control in root-relative coordinates. ) +/// /// public string fnGuiControl_getGlobalCenter (string guicontrol) @@ -20959,7 +26288,9 @@ public string fnGuiControl_getGlobalCenter (string guicontrol) } /// -/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. @return The control's current position in root-relative coordinates. ) +/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @return The control's current position in root-relative coordinates. ) +/// /// public string fnGuiControl_getGlobalPosition (string guicontrol) @@ -20976,7 +26307,10 @@ public string fnGuiControl_getGlobalPosition (string guicontrol) } /// -/// Get the maximum allowed size of the control. @return The maximum size to which the control can be shrunk. @see maxExtent ) +/// Get the maximum allowed size of the control. +/// @return The maximum size to which the control can be shrunk. +/// @see maxExtent ) +/// /// public string fnGuiControl_getMaxExtent (string guicontrol) @@ -20993,7 +26327,10 @@ public string fnGuiControl_getMaxExtent (string guicontrol) } /// -/// Get the minimum allowed size of the control. @return The minimum size to which the control can be shrunk. @see minExtent ) +/// Get the minimum allowed size of the control. +/// @return The minimum size to which the control can be shrunk. +/// @see minExtent ) +/// /// public string fnGuiControl_getMinExtent (string guicontrol) @@ -21011,6 +26348,7 @@ public string fnGuiControl_getMinExtent (string guicontrol) } /// /// Get the mouse over alpha for the object. ) +/// /// public float fnGuiControl_getMouseOverAlphaValue (string guicontrol) @@ -21024,7 +26362,9 @@ public float fnGuiControl_getMouseOverAlphaValue (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_getMouseOverAlphaValue(sbguicontrol); } /// -/// Get the immediate parent control of the control. @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// Get the immediate parent control of the control. +/// @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// /// public string fnGuiControl_getParent (string guicontrol) @@ -21041,7 +26381,9 @@ public string fnGuiControl_getParent (string guicontrol) } /// -/// Get the control's current position relative to its parent. @return The coordinate of the control in its parent's coordinate space. ) +/// Get the control's current position relative to its parent. +/// @return The coordinate of the control in its parent's coordinate space. ) +/// /// public string fnGuiControl_getPosition (string guicontrol) @@ -21058,7 +26400,10 @@ public string fnGuiControl_getPosition (string guicontrol) } /// -/// Get the canvas on which the control is placed. @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. @see GuiControl_Hierarchy ) +/// Get the canvas on which the control is placed. +/// @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. +/// @see GuiControl_Hierarchy ) +/// /// public string fnGuiControl_getRoot (string guicontrol) @@ -21076,6 +26421,7 @@ public string fnGuiControl_getRoot (string guicontrol) } /// /// Get root control ) +/// /// public string fnGuiControl_getRootControl (string guicontrol) @@ -21092,7 +26438,11 @@ public string fnGuiControl_getRootControl (string guicontrol) } /// -/// Test whether the control is currently awake. If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. @return True if the control is awake. @ref GuiControl_Waking ) +/// Test whether the control is currently awake. +/// If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. +/// @return True if the control is awake. +/// @ref GuiControl_Waking ) +/// /// public bool fnGuiControl_isAwake (string guicontrol) @@ -21107,6 +26457,7 @@ public bool fnGuiControl_isAwake (string guicontrol) } /// /// Returns if the control's alpha value can be changed in the game or not. ) +/// /// public bool fnGuiControl_isContextAlphaEnabled (string guicontrol) @@ -21121,6 +26472,7 @@ public bool fnGuiControl_isContextAlphaEnabled (string guicontrol) } /// /// Returns if the control's alpha fade value can be changed in the game or not. ) +/// /// public bool fnGuiControl_isContextAlphaFadeEnabled (string guicontrol) @@ -21135,6 +26487,7 @@ public bool fnGuiControl_isContextAlphaFadeEnabled (string guicontrol) } /// /// Returns if the control can be locked in the game or not. ) +/// /// public bool fnGuiControl_isContextLockable (string guicontrol) @@ -21149,6 +26502,7 @@ public bool fnGuiControl_isContextLockable (string guicontrol) } /// /// Returns if the control's mouse-over alpha value can be changed in the game or not. ) +/// /// public bool fnGuiControl_isContextMouseOverAlphaEnabled (string guicontrol) @@ -21163,6 +26517,7 @@ public bool fnGuiControl_isContextMouseOverAlphaEnabled (string guicontrol) } /// /// Returns if the control can be moved in the game or not. ) +/// /// public bool fnGuiControl_isContextMovable (string guicontrol) @@ -21176,7 +26531,12 @@ public bool fnGuiControl_isContextMovable (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isContextMovable(sbguicontrol)>=1; } /// -/// Test whether the control is the current first responder. @return True if the control is the current first responder. @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Test whether the control is the current first responder. +/// @return True if the control is the current first responder. +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public bool fnGuiControl_isFirstResponder (string guicontrol) @@ -21190,7 +26550,9 @@ public bool fnGuiControl_isFirstResponder (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isFirstResponder(sbguicontrol)>=1; } /// -/// Indicates if the mouse is locked in this control. @return True if the mouse is currently locked. ) +/// Indicates if the mouse is locked in this control. +/// @return True if the mouse is currently locked. ) +/// /// public bool fnGuiControl_isMouseLocked (string guicontrol) @@ -21204,7 +26566,12 @@ public bool fnGuiControl_isMouseLocked (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isMouseLocked(sbguicontrol)>=1; } /// -/// Test whether the control is currently set to be visible. @return True if the control is currently set to be visible. @note This method does not tell anything about whether the control is actually visible to the user at the moment. @ref GuiControl_VisibleActive ) +/// Test whether the control is currently set to be visible. +/// @return True if the control is currently set to be visible. +/// @note This method does not tell anything about whether the control is actually visible to +/// the user at the moment. +/// @ref GuiControl_VisibleActive ) +/// /// public bool fnGuiControl_isVisible (string guicontrol) @@ -21218,7 +26585,13 @@ public bool fnGuiControl_isVisible (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isVisible(sbguicontrol)>=1; } /// -/// Test whether the given point lies within the rectangle of the control. @param x X coordinate of the point in parent-relative coordinates. @param y Y coordinate of the point in parent-relative coordinates. @return True if the point is within the control, false if not. @see getExtent @see getPosition ) +/// Test whether the given point lies within the rectangle of the control. +/// @param x X coordinate of the point in parent-relative coordinates. +/// @param y Y coordinate of the point in parent-relative coordinates. +/// @return True if the point is within the control, false if not. +/// @see getExtent +/// @see getPosition ) +/// /// public bool fnGuiControl_pointInControl (string guicontrol, int x, int y) @@ -21247,7 +26620,9 @@ public void fnGuiControl_refresh (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_refresh(sbguicontrol); } /// -/// Removes the plus cursor. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Removes the plus cursor. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void fnGuiControl_resetCur (string guicontrol) @@ -21261,7 +26636,13 @@ public void fnGuiControl_resetCur (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_resetCur(sbguicontrol); } /// -/// Resize and reposition the control using the give coordinates and dimensions. Child controls will resize according to their layout behaviors. @param x The new X coordinate of the control in its parent's coordinate space. @param y The new Y coordinate of the control in its parent's coordinate space. @param width The new width to which the control should be resized. @param height The new height to which the control should be resized. ) +/// Resize and reposition the control using the give coordinates and dimensions. Child controls +/// will resize according to their layout behaviors. +/// @param x The new X coordinate of the control in its parent's coordinate space. +/// @param y The new Y coordinate of the control in its parent's coordinate space. +/// @param width The new width to which the control should be resized. +/// @param height The new height to which the control should be resized. ) +/// /// public void fnGuiControl_resize (string guicontrol, int x, int y, int width, int height) @@ -21276,6 +26657,7 @@ public void fnGuiControl_resize (string guicontrol, int x, int y, int width, int } /// /// ) +/// /// public void fnGuiControl_setActive (string guicontrol, bool state) @@ -21289,7 +26671,9 @@ public void fnGuiControl_setActive (string guicontrol, bool state) SafeNativeMethods.mwle_fnGuiControl_setActive(sbguicontrol, state); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void fnGuiControl_setAlphaFadeTime (string guicontrol, int fadeTime) @@ -21303,7 +26687,9 @@ public void fnGuiControl_setAlphaFadeTime (string guicontrol, int fadeTime) SafeNativeMethods.mwle_fnGuiControl_setAlphaFadeTime(sbguicontrol, fadeTime); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void fnGuiControl_setAlphaValue (string guicontrol, float alpha) @@ -21317,7 +26703,10 @@ public void fnGuiControl_setAlphaValue (string guicontrol, float alpha) SafeNativeMethods.mwle_fnGuiControl_setAlphaValue(sbguicontrol, alpha); } /// -/// Set the control's position by its center point. @param x The X coordinate of the new center point of the control relative to the control's parent. @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// Set the control's position by its center point. +/// @param x The X coordinate of the new center point of the control relative to the control's parent. +/// @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// /// public void fnGuiControl_setCenter (string guicontrol, int x, int y) @@ -21332,6 +26721,7 @@ public void fnGuiControl_setCenter (string guicontrol, int x, int y) } /// /// Displays the option to set the alpha of the control in the game when true. ) +/// /// public void fnGuiControl_setContextAlpha (string guicontrol, bool alpha) @@ -21346,6 +26736,7 @@ public void fnGuiControl_setContextAlpha (string guicontrol, bool alpha) } /// /// Displays the option to set the alpha fade value of the control in the game when true. ) +/// /// public void fnGuiControl_setContextAlphaFade (string guicontrol, bool fade) @@ -21360,6 +26751,7 @@ public void fnGuiControl_setContextAlphaFade (string guicontrol, bool fade) } /// /// Displays the option to set the background color of the control in the game when true. ) +/// /// public void fnGuiControl_setContextBackColor (string guicontrol, bool backColor) @@ -21374,6 +26766,7 @@ public void fnGuiControl_setContextBackColor (string guicontrol, bool backColor) } /// /// Displays the option to set the fill color of the control in the game when true. ) +/// /// public void fnGuiControl_setContextFillColor (string guicontrol, bool fillColor) @@ -21388,6 +26781,7 @@ public void fnGuiControl_setContextFillColor (string guicontrol, bool fillColor) } /// /// Displays the option to set the font color of the control in the game when true. ) +/// /// public void fnGuiControl_setContextFontColor (string guicontrol, bool fontColor) @@ -21402,6 +26796,7 @@ public void fnGuiControl_setContextFontColor (string guicontrol, bool fontColor) } /// /// Displays the option to set the font size of the control in the game when true. ) +/// /// public void fnGuiControl_setContextFontSize (string guicontrol, bool fontSize) @@ -21416,6 +26811,7 @@ public void fnGuiControl_setContextFontSize (string guicontrol, bool fontSize) } /// /// Displays the option to lock the control in the game when true. ) +/// /// public void fnGuiControl_setContextLockControl (string guicontrol, bool lockx) @@ -21430,6 +26826,7 @@ public void fnGuiControl_setContextLockControl (string guicontrol, bool lockx) } /// /// Displays the option to set the mouse-over alpha of the control in the game when true. ) +/// /// public void fnGuiControl_setContextMouseOverAlpha (string guicontrol, bool mouseOver) @@ -21444,6 +26841,7 @@ public void fnGuiControl_setContextMouseOverAlpha (string guicontrol, bool mouse } /// /// Displays the option to move the control in the game when true. ) +/// /// public void fnGuiControl_setContextMoveControl (string guicontrol, bool move) @@ -21458,6 +26856,7 @@ public void fnGuiControl_setContextMoveControl (string guicontrol, bool move) } /// /// Set control background color. ) +/// /// public void fnGuiControl_setControlBackgroundColor (string guicontrol, string color) @@ -21475,6 +26874,7 @@ public void fnGuiControl_setControlBackgroundColor (string guicontrol, string co } /// /// Set control fill color. ) +/// /// public void fnGuiControl_setControlFillColor (string guicontrol, string color) @@ -21492,6 +26892,7 @@ public void fnGuiControl_setControlFillColor (string guicontrol, string color) } /// /// Set control font color. ) +/// /// public void fnGuiControl_setControlFontColor (string guicontrol, string color) @@ -21509,6 +26910,7 @@ public void fnGuiControl_setControlFontColor (string guicontrol, string color) } /// /// Sets the font size of a control. ) +/// /// public void fnGuiControl_setControlFontSize (string guicontrol, int fontSize) @@ -21523,6 +26925,7 @@ public void fnGuiControl_setControlFontSize (string guicontrol, int fontSize) } /// /// Lock the control. ) +/// /// public void fnGuiControl_setControlLock (string guicontrol, bool lockedx) @@ -21537,6 +26940,7 @@ public void fnGuiControl_setControlLock (string guicontrol, bool lockedx) } /// /// Set control texture. ) +/// /// public void fnGuiControl_setControlTexture (string guicontrol, string fileName) @@ -21553,7 +26957,9 @@ public void fnGuiControl_setControlTexture (string guicontrol, string fileName) SafeNativeMethods.mwle_fnGuiControl_setControlTexture(sbguicontrol, sbfileName); } /// -/// Sets the cursor as a plus. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Sets the cursor as a plus. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void fnGuiControl_setCur (string guicontrol) @@ -21567,7 +26973,12 @@ public void fnGuiControl_setCur (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_setCur(sbguicontrol); } /// -/// Make this control the current first responder. @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. @see GuiControlProfile::canKeyFocus @see isFirstResponder @ref GuiControl_FirstResponders ) +/// Make this control the current first responder. +/// @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. +/// @see GuiControlProfile::canKeyFocus +/// @see isFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public void fnGuiControl_setFirstResponder (string guicontrol) @@ -21581,7 +26992,9 @@ public void fnGuiControl_setFirstResponder (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_setFirstResponder(sbguicontrol); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void fnGuiControl_setMouseOverAlphaValue (string guicontrol, float alpha) @@ -21595,7 +27008,10 @@ public void fnGuiControl_setMouseOverAlphaValue (string guicontrol, float alpha) SafeNativeMethods.mwle_fnGuiControl_setMouseOverAlphaValue(sbguicontrol, alpha); } /// -/// Position the control in the local space of the parent control. @param x The new X coordinate of the control relative to its parent's upper left corner. @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// Position the control in the local space of the parent control. +/// @param x The new X coordinate of the control relative to its parent's upper left corner. +/// @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// /// public void fnGuiControl_setPosition (string guicontrol, int x, int y) @@ -21609,7 +27025,10 @@ public void fnGuiControl_setPosition (string guicontrol, int x, int y) SafeNativeMethods.mwle_fnGuiControl_setPosition(sbguicontrol, x, y); } /// -/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. @param x The new X coordinate of the control relative to the root's upper left corner. @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @param x The new X coordinate of the control relative to the root's upper left corner. +/// @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// /// public void fnGuiControl_setPositionGlobal (string guicontrol, int x, int y) @@ -21623,7 +27042,11 @@ public void fnGuiControl_setPositionGlobal (string guicontrol, int x, int y) SafeNativeMethods.mwle_fnGuiControl_setPositionGlobal(sbguicontrol, x, y); } /// -/// Set the control profile for the control to use. The profile used by a control determines a great part of its behavior and appearance. @param profile The new profile the control should use. @ref GuiControl_Profiles ) +/// Set the control profile for the control to use. +/// The profile used by a control determines a great part of its behavior and appearance. +/// @param profile The new profile the control should use. +/// @ref GuiControl_Profiles ) +/// /// public void fnGuiControl_setProfile (string guicontrol, string profile) @@ -21641,6 +27064,7 @@ public void fnGuiControl_setProfile (string guicontrol, string profile) } /// /// Displays the option to set the window settings of the control in the game when true. ) +/// /// public void fnGuiControl_setShowContextWindowSettings (string guicontrol, bool lockx) @@ -21654,7 +27078,9 @@ public void fnGuiControl_setShowContextWindowSettings (string guicontrol, bool l SafeNativeMethods.mwle_fnGuiControl_setShowContextWindowSettings(sbguicontrol, lockx); } /// -/// Set the value associated with the control. @param value The new value for the control. ) +/// Set the value associated with the control. +/// @param value The new value for the control. ) +/// /// public void fnGuiControl_setValue (string guicontrol, string value) @@ -21671,7 +27097,10 @@ public void fnGuiControl_setValue (string guicontrol, string value) SafeNativeMethods.mwle_fnGuiControl_setValue(sbguicontrol, sbvalue); } /// -/// Set whether the control is visible or not. @param state The new visiblity flag state for the control. @ref GuiControl_VisibleActive ) +/// Set whether the control is visible or not. +/// @param state The new visiblity flag state for the control. +/// @ref GuiControl_VisibleActive ) +/// /// public void fnGuiControl_setVisible (string guicontrol, bool state) @@ -21686,6 +27115,7 @@ public void fnGuiControl_setVisible (string guicontrol, bool state) } /// /// Returns true if the control is transparent. ) +/// /// public bool fnGuiControl_transparentControlCheck (string guicontrol) @@ -21699,7 +27129,9 @@ public bool fnGuiControl_transparentControlCheck (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_transparentControlCheck(sbguicontrol)>=1; } /// -/// Get the currently selected filename. @return The filename of the currently selected file ) +/// Get the currently selected filename. +/// @return The filename of the currently selected file ) +/// /// public string fnGuiDirectoryFileListCtrl_getSelectedFile (string guidirectoryfilelistctrl) @@ -21716,7 +27148,9 @@ public string fnGuiDirectoryFileListCtrl_getSelectedFile (string guidirectoryfil } /// -/// Get the list of selected files. @return A space separated list of selected files ) +/// Get the list of selected files. +/// @return A space separated list of selected files ) +/// /// public string fnGuiDirectoryFileListCtrl_getSelectedFiles (string guidirectoryfilelistctrl) @@ -21734,6 +27168,7 @@ public string fnGuiDirectoryFileListCtrl_getSelectedFiles (string guidirectoryfi } /// /// Update the file list. ) +/// /// public void fnGuiDirectoryFileListCtrl_reload (string guidirectoryfilelistctrl) @@ -21747,7 +27182,9 @@ public void fnGuiDirectoryFileListCtrl_reload (string guidirectoryfilelistctrl) SafeNativeMethods.mwle_fnGuiDirectoryFileListCtrl_reload(sbguidirectoryfilelistctrl); } /// -/// Set the file filter. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the file filter. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public void fnGuiDirectoryFileListCtrl_setFilter (string guidirectoryfilelistctrl, string filter) @@ -21764,7 +27201,10 @@ public void fnGuiDirectoryFileListCtrl_setFilter (string guidirectoryfilelistctr SafeNativeMethods.mwle_fnGuiDirectoryFileListCtrl_setFilter(sbguidirectoryfilelistctrl, sbfilter); } /// -/// Set the search path and file filter. @param path Path in game directory from which to list files. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the search path and file filter. +/// @param path Path in game directory from which to list files. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public bool fnGuiDirectoryFileListCtrl_setPath (string guidirectoryfilelistctrl, string path, string filter) @@ -21784,7 +27224,10 @@ public bool fnGuiDirectoryFileListCtrl_setPath (string guidirectoryfilelistctrl, return SafeNativeMethods.mwle_fnGuiDirectoryFileListCtrl_setPath(sbguidirectoryfilelistctrl, sbpath, sbfilter)>=1; } /// -/// Start the drag operation. @param x X coordinate for the mouse pointer offset which the drag control should position itself. @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// Start the drag operation. +/// @param x X coordinate for the mouse pointer offset which the drag control should position itself. +/// @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// /// public void fnGuiDragAndDropControl_startDragging (string guidraganddropcontrol, int x, int y) @@ -21799,6 +27242,7 @@ public void fnGuiDragAndDropControl_startDragging (string guidraganddropcontrol, } /// /// Recalculates the position and size of this control and all its children. ) +/// /// public void fnGuiDynamicCtrlArrayControl_refresh (string guidynamicctrlarraycontrol) @@ -21813,6 +27257,7 @@ public void fnGuiDynamicCtrlArrayControl_refresh (string guidynamicctrlarraycont } /// /// Gets the set of GUI controls currently selected in the editor. ) +/// /// public string fnGuiEditCtrl_getSelection (string guieditctrl) @@ -21830,6 +27275,7 @@ public string fnGuiEditCtrl_getSelection (string guieditctrl) } /// /// Gets the GUI controls(s) that are currently in the trash.) +/// /// public string fnGuiEditCtrl_getTrash (string guieditctrl) @@ -21846,7 +27292,10 @@ public string fnGuiEditCtrl_getTrash (string guieditctrl) } /// -/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) Reset the filter to use the specified points, spread equidistantly across the domain. @internal) +/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) +/// Reset the filter to use the specified points, spread equidistantly across the domain. +/// @internal) +/// /// public void fnGuiFilterCtrl_setValue (string guifilterctrl, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -21914,15 +27363,11 @@ public void fnGuiFilterCtrl_setValue (string guifilterctrl, string a2, string a3 SafeNativeMethods.mwle_fnGuiFilterCtrl_setValue(sbguifilterctrl, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// Recalculates the position and size of this control and all its children. ) +/// Get the ID of this form's menu. +/// @return The ID of the form menu ) /// /// - -/// -/// Get the ID of this form's menu. @return The ID of the form menu ) -/// - public int fnGuiFormCtrl_getMenuID (string guiformctrl) { if(Debugging) @@ -21934,7 +27379,9 @@ public int fnGuiFormCtrl_getMenuID (string guiformctrl) return SafeNativeMethods.mwle_fnGuiFormCtrl_getMenuID(sbguiformctrl); } /// -/// Sets the title of the form. @param caption Form caption ) +/// Sets the title of the form. +/// @param caption Form caption ) +/// /// public void fnGuiFormCtrl_setCaption (string guiformctrl, string caption) @@ -21952,6 +27399,7 @@ public void fnGuiFormCtrl_setCaption (string guiformctrl, string caption) } /// /// Add a new column. ) +/// /// public void fnGuiFrameSetCtrl_addColumn (string guiframesetctrl) @@ -21966,6 +27414,7 @@ public void fnGuiFrameSetCtrl_addColumn (string guiframesetctrl) } /// /// Add a new row. ) +/// /// public void fnGuiFrameSetCtrl_addRow (string guiframesetctrl) @@ -21979,7 +27428,11 @@ public void fnGuiFrameSetCtrl_addRow (string guiframesetctrl) SafeNativeMethods.mwle_fnGuiFrameSetCtrl_addRow(sbguiframesetctrl); } /// -/// dynamic ), Override the i>borderEnable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderEnable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void fnGuiFrameSetCtrl_frameBorder (string guiframesetctrl, int index, string state) @@ -21996,7 +27449,12 @@ public void fnGuiFrameSetCtrl_frameBorder (string guiframesetctrl, int index, st SafeNativeMethods.mwle_fnGuiFrameSetCtrl_frameBorder(sbguiframesetctrl, index, sbstate); } /// -/// Set the minimum width and height for the frame. It will not be possible for the user to resize the frame smaller than this. @param index Index of the frame to modify @param width Minimum width in pixels @param height Minimum height in pixels ) +/// Set the minimum width and height for the frame. It will not be possible +/// for the user to resize the frame smaller than this. +/// @param index Index of the frame to modify +/// @param width Minimum width in pixels +/// @param height Minimum height in pixels ) +/// /// public void fnGuiFrameSetCtrl_frameMinExtent (string guiframesetctrl, int index, int width, int height) @@ -22010,7 +27468,11 @@ public void fnGuiFrameSetCtrl_frameMinExtent (string guiframesetctrl, int index, SafeNativeMethods.mwle_fnGuiFrameSetCtrl_frameMinExtent(sbguiframesetctrl, index, width, height); } /// -/// dynamic ), Override the i>borderMovable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderMovable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void fnGuiFrameSetCtrl_frameMovable (string guiframesetctrl, int index, string state) @@ -22027,7 +27489,11 @@ public void fnGuiFrameSetCtrl_frameMovable (string guiframesetctrl, int index, s SafeNativeMethods.mwle_fnGuiFrameSetCtrl_frameMovable(sbguiframesetctrl, index, sbstate); } /// -/// Set the padding for this frame. Padding introduces blank space on the inside edge of the frame. @param index Index of the frame to modify @param padding Frame top, bottom, left, and right padding ) +/// Set the padding for this frame. Padding introduces blank space on the inside +/// edge of the frame. +/// @param index Index of the frame to modify +/// @param padding Frame top, bottom, left, and right padding ) +/// /// public void fnGuiFrameSetCtrl_framePadding (string guiframesetctrl, int index, string padding) @@ -22044,7 +27510,9 @@ public void fnGuiFrameSetCtrl_framePadding (string guiframesetctrl, int index, s SafeNativeMethods.mwle_fnGuiFrameSetCtrl_framePadding(sbguiframesetctrl, index, sbpadding); } /// -/// Get the number of columns. @return The number of columns ) +/// Get the number of columns. +/// @return The number of columns ) +/// /// public int fnGuiFrameSetCtrl_getColumnCount (string guiframesetctrl) @@ -22058,7 +27526,10 @@ public int fnGuiFrameSetCtrl_getColumnCount (string guiframesetctrl) return SafeNativeMethods.mwle_fnGuiFrameSetCtrl_getColumnCount(sbguiframesetctrl); } /// -/// Get the horizontal offset of a column. @param index Index of the column to query @return Column offset in pixels ) +/// Get the horizontal offset of a column. +/// @param index Index of the column to query +/// @return Column offset in pixels ) +/// /// public int fnGuiFrameSetCtrl_getColumnOffset (string guiframesetctrl, int index) @@ -22072,7 +27543,9 @@ public int fnGuiFrameSetCtrl_getColumnOffset (string guiframesetctrl, int index) return SafeNativeMethods.mwle_fnGuiFrameSetCtrl_getColumnOffset(sbguiframesetctrl, index); } /// -/// Get the padding for this frame. @param index Index of the frame to query ) +/// Get the padding for this frame. +/// @param index Index of the frame to query ) +/// /// public string fnGuiFrameSetCtrl_getFramePadding (string guiframesetctrl, int index) @@ -22089,7 +27562,9 @@ public string fnGuiFrameSetCtrl_getFramePadding (string guiframesetctrl, int ind } /// -/// Get the number of rows. @return The number of rows ) +/// Get the number of rows. +/// @return The number of rows ) +/// /// public int fnGuiFrameSetCtrl_getRowCount (string guiframesetctrl) @@ -22103,7 +27578,10 @@ public int fnGuiFrameSetCtrl_getRowCount (string guiframesetctrl) return SafeNativeMethods.mwle_fnGuiFrameSetCtrl_getRowCount(sbguiframesetctrl); } /// -/// Get the vertical offset of a row. @param index Index of the row to query @return Row offset in pixels ) +/// Get the vertical offset of a row. +/// @param index Index of the row to query +/// @return Row offset in pixels ) +/// /// public int fnGuiFrameSetCtrl_getRowOffset (string guiframesetctrl, int index) @@ -22118,6 +27596,7 @@ public int fnGuiFrameSetCtrl_getRowOffset (string guiframesetctrl, int index) } /// /// Remove the last (rightmost) column. ) +/// /// public void fnGuiFrameSetCtrl_removeColumn (string guiframesetctrl) @@ -22132,6 +27611,7 @@ public void fnGuiFrameSetCtrl_removeColumn (string guiframesetctrl) } /// /// Remove the last (bottom) row. ) +/// /// public void fnGuiFrameSetCtrl_removeRow (string guiframesetctrl) @@ -22145,7 +27625,12 @@ public void fnGuiFrameSetCtrl_removeRow (string guiframesetctrl) SafeNativeMethods.mwle_fnGuiFrameSetCtrl_removeRow(sbguiframesetctrl); } /// -/// Set the horizontal offset of a column. Note that column offsets must always be in increasing order, and therefore this offset must be between the offsets of the colunns either side. @param index Index of the column to modify @param offset New column offset ) +/// Set the horizontal offset of a column. +/// Note that column offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the colunns either side. +/// @param index Index of the column to modify +/// @param offset New column offset ) +/// /// public void fnGuiFrameSetCtrl_setColumnOffset (string guiframesetctrl, int index, int offset) @@ -22159,7 +27644,12 @@ public void fnGuiFrameSetCtrl_setColumnOffset (string guiframesetctrl, int index SafeNativeMethods.mwle_fnGuiFrameSetCtrl_setColumnOffset(sbguiframesetctrl, index, offset); } /// -/// Set the vertical offset of a row. Note that row offsets must always be in increasing order, and therefore this offset must be between the offsets of the rows either side. @param index Index of the row to modify @param offset New row offset ) +/// Set the vertical offset of a row. +/// Note that row offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the rows either side. +/// @param index Index of the row to modify +/// @param offset New row offset ) +/// /// public void fnGuiFrameSetCtrl_setRowOffset (string guiframesetctrl, int index, int offset) @@ -22174,6 +27664,7 @@ public void fnGuiFrameSetCtrl_setRowOffset (string guiframesetctrl, int index, i } /// /// Recalculates child control sizes. ) +/// /// public void fnGuiFrameSetCtrl_updateSizes (string guiframesetctrl) @@ -22188,6 +27679,7 @@ public void fnGuiFrameSetCtrl_updateSizes (string guiframesetctrl) } /// /// Activates the current row. The script callback of the current row will be called (if it has one). ) +/// /// public void fnGuiGameListMenuCtrl_activateRow (string guigamelistmenuctrl) @@ -22201,7 +27693,14 @@ public void fnGuiGameListMenuCtrl_activateRow (string guigamelistmenuctrl) SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_activateRow(sbguigamelistmenuctrl); } /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param useHighlightIcon [optional] Does this row use the highlight icon?. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param useHighlightIcon [optional] Does this row use the highlight icon?. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void fnGuiGameListMenuCtrl_addRow (string guigamelistmenuctrl, string label, string callback, int icon, int yPad, bool useHighlightIcon, bool enabled) @@ -22221,7 +27720,9 @@ public void fnGuiGameListMenuCtrl_addRow (string guigamelistmenuctrl, string lab SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_addRow(sbguigamelistmenuctrl, sblabel, sbcallback, icon, yPad, useHighlightIcon, enabled); } /// -/// Gets the number of rows on the control. @return (int) The number of rows on the control. ) +/// Gets the number of rows on the control. +/// @return (int) The number of rows on the control. ) +/// /// public int fnGuiGameListMenuCtrl_getRowCount (string guigamelistmenuctrl) @@ -22235,7 +27736,10 @@ public int fnGuiGameListMenuCtrl_getRowCount (string guigamelistmenuctrl) return SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_getRowCount(sbguigamelistmenuctrl); } /// -/// Gets the label displayed on the specified row. @param row Index of the row to get the label of. @return The label for the row. ) +/// Gets the label displayed on the specified row. +/// @param row Index of the row to get the label of. +/// @return The label for the row. ) +/// /// public string fnGuiGameListMenuCtrl_getRowLabel (string guigamelistmenuctrl, int row) @@ -22252,7 +27756,9 @@ public string fnGuiGameListMenuCtrl_getRowLabel (string guigamelistmenuctrl, int } /// -/// Gets the index of the currently selected row. @return Index of the selected row. ) +/// Gets the index of the currently selected row. +/// @return Index of the selected row. ) +/// /// public int fnGuiGameListMenuCtrl_getSelectedRow (string guigamelistmenuctrl) @@ -22266,7 +27772,10 @@ public int fnGuiGameListMenuCtrl_getSelectedRow (string guigamelistmenuctrl) return SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_getSelectedRow(sbguigamelistmenuctrl); } /// -/// Determines if the specified row is enabled or disabled. @param row The row to set the enabled status of. @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// Determines if the specified row is enabled or disabled. +/// @param row The row to set the enabled status of. +/// @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// /// public bool fnGuiGameListMenuCtrl_isRowEnabled (string guigamelistmenuctrl, int row) @@ -22280,7 +27789,10 @@ public bool fnGuiGameListMenuCtrl_isRowEnabled (string guigamelistmenuctrl, int return SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_isRowEnabled(sbguigamelistmenuctrl, row)>=1; } /// -/// Sets a row's enabled status according to the given parameters. @param row The index to check for validity. @param enabled Indicate true to enable the row or false to disable it. ) +/// Sets a row's enabled status according to the given parameters. +/// @param row The index to check for validity. +/// @param enabled Indicate true to enable the row or false to disable it. ) +/// /// public void fnGuiGameListMenuCtrl_setRowEnabled (string guigamelistmenuctrl, int row, bool enabled) @@ -22294,7 +27806,10 @@ public void fnGuiGameListMenuCtrl_setRowEnabled (string guigamelistmenuctrl, int SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_setRowEnabled(sbguigamelistmenuctrl, row, enabled); } /// -/// Sets the label on the given row. @param row Index of the row to set the label on. @param label Text to set as the label of the row. ) +/// Sets the label on the given row. +/// @param row Index of the row to set the label on. +/// @param label Text to set as the label of the row. ) +/// /// public void fnGuiGameListMenuCtrl_setRowLabel (string guigamelistmenuctrl, int row, string label) @@ -22311,7 +27826,9 @@ public void fnGuiGameListMenuCtrl_setRowLabel (string guigamelistmenuctrl, int r SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_setRowLabel(sbguigamelistmenuctrl, row, sblabel); } /// -/// Sets the selected row. Only rows that are enabled can be selected. @param row Index of the row to set as selected. ) +/// Sets the selected row. Only rows that are enabled can be selected. +/// @param row Index of the row to set as selected. ) +/// /// public void fnGuiGameListMenuCtrl_setSelected (string guigamelistmenuctrl, int row) @@ -22325,7 +27842,15 @@ public void fnGuiGameListMenuCtrl_setSelected (string guigamelistmenuctrl, int r SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_setSelected(sbguigamelistmenuctrl, row); } /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param options A tab separated list of options. @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param options A tab separated list of options. +/// @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void fnGuiGameListOptionsCtrl_addRow (string guigamelistoptionsctrl, string label, string options, bool wrapOptions, string callback, int icon, int yPad, bool enabled) @@ -22348,7 +27873,10 @@ public void fnGuiGameListOptionsCtrl_addRow (string guigamelistoptionsctrl, stri SafeNativeMethods.mwle_fnGuiGameListOptionsCtrl_addRow(sbguigamelistoptionsctrl, sblabel, sboptions, wrapOptions, sbcallback, icon, yPad, enabled); } /// -/// Gets the text for the currently selected option of the given row. @param row Index of the row to get the option from. @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// Gets the text for the currently selected option of the given row. +/// @param row Index of the row to get the option from. +/// @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// /// public string fnGuiGameListOptionsCtrl_getCurrentOption (string guigamelistoptionsctrl, int row) @@ -22365,7 +27893,11 @@ public string fnGuiGameListOptionsCtrl_getCurrentOption (string guigamelistoptio } /// -/// Set the row's current option to the one specified @param row Index of the row to set an option on. @param option The option to be made active. @return True if the row contained the option and was set, false otherwise. ) +/// Set the row's current option to the one specified +/// @param row Index of the row to set an option on. +/// @param option The option to be made active. +/// @return True if the row contained the option and was set, false otherwise. ) +/// /// public bool fnGuiGameListOptionsCtrl_selectOption (string guigamelistoptionsctrl, int row, string option) @@ -22382,7 +27914,10 @@ public bool fnGuiGameListOptionsCtrl_selectOption (string guigamelistoptionsctrl return SafeNativeMethods.mwle_fnGuiGameListOptionsCtrl_selectOption(sbguigamelistoptionsctrl, row, sboption)>=1; } /// -/// Sets the list of options on the given row. @param row Index of the row to set options on. @param optionsList A tab separated list of options for the control. ) +/// Sets the list of options on the given row. +/// @param row Index of the row to set options on. +/// @param optionsList A tab separated list of options for the control. ) +/// /// public void fnGuiGameListOptionsCtrl_setOptions (string guigamelistoptionsctrl, int row, string optionsList) @@ -22399,7 +27934,16 @@ public void fnGuiGameListOptionsCtrl_setOptions (string guigamelistoptionsctrl, SafeNativeMethods.mwle_fnGuiGameListOptionsCtrl_setOptions(sbguigamelistoptionsctrl, row, sboptionsList); } /// -/// Sets up the given plotting curve to automatically plot the value of the @a variable with a frequency of @a updateFrequency. @param plotId Index of the plotting curve. Must be 0=plotId6. @param variable Name of the global variable. @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). @tsexample // Plot FPS counter at 1 second intervals. %graph.addAutoPlot( 0, \"fps::real\", 1000 ); @endtsexample ) +/// Sets up the given plotting curve to automatically plot the value of the @a variable with a +/// frequency of @a updateFrequency. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param variable Name of the global variable. +/// @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). +/// @tsexample +/// // Plot FPS counter at 1 second intervals. +/// %graph.addAutoPlot( 0, \"fps::real\", 1000 ); +/// @endtsexample ) +/// /// public void fnGuiGraphCtrl_addAutoPlot (string guigraphctrl, int plotId, string variable, int updateFrequency) @@ -22416,7 +27960,13 @@ public void fnGuiGraphCtrl_addAutoPlot (string guigraphctrl, int plotId, string SafeNativeMethods.mwle_fnGuiGraphCtrl_addAutoPlot(sbguigraphctrl, plotId, sbvariable, updateFrequency); } /// -/// Add a data point to the plot's curve. @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. @param value Value of the data point to add to the curve. @note Data values are added to the @b left end of the plotting curve. @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If this limit is exceeded, data points on the right end of the curve are culled. ) +/// Add a data point to the plot's curve. +/// @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. +/// @param value Value of the data point to add to the curve. +/// @note Data values are added to the @b left end of the plotting curve. +/// @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If +/// this limit is exceeded, data points on the right end of the curve are culled. ) +/// /// public void fnGuiGraphCtrl_addDatum (string guigraphctrl, int plotId, float value) @@ -22430,7 +27980,11 @@ public void fnGuiGraphCtrl_addDatum (string guigraphctrl, int plotId, float valu SafeNativeMethods.mwle_fnGuiGraphCtrl_addDatum(sbguigraphctrl, plotId, value); } /// -/// Get a data point on the given plotting curve. @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. @param index Index of the data point on the curve. @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// Get a data point on the given plotting curve. +/// @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. +/// @param index Index of the data point on the curve. +/// @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// /// public float fnGuiGraphCtrl_getDatum (string guigraphctrl, int plotId, int index) @@ -22444,7 +27998,9 @@ public float fnGuiGraphCtrl_getDatum (string guigraphctrl, int plotId, int index return SafeNativeMethods.mwle_fnGuiGraphCtrl_getDatum(sbguigraphctrl, plotId, index); } /// -/// Stop automatic variable plotting for the given curve. @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// Stop automatic variable plotting for the given curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// /// public void fnGuiGraphCtrl_removeAutoPlot (string guigraphctrl, int plotId) @@ -22458,7 +28014,11 @@ public void fnGuiGraphCtrl_removeAutoPlot (string guigraphctrl, int plotId) SafeNativeMethods.mwle_fnGuiGraphCtrl_removeAutoPlot(sbguigraphctrl, plotId); } /// -/// Change the charting type of the given plotting curve. @param plotId Index of the plotting curve. Must be 0=plotId6. @param graphType Charting type to use for the curve. @note Instead of calling this method, you can directly assign to #plotType. ) +/// Change the charting type of the given plotting curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param graphType Charting type to use for the curve. +/// @note Instead of calling this method, you can directly assign to #plotType. ) +/// /// public void fnGuiGraphCtrl_setGraphType (string guigraphctrl, int plotId, int graphType) @@ -22472,7 +28032,17 @@ public void fnGuiGraphCtrl_setGraphType (string guigraphctrl, int plotId, int gr SafeNativeMethods.mwle_fnGuiGraphCtrl_setGraphType(sbguigraphctrl, plotId, graphType); } /// -/// @brief Set the bitmap to use for the button portion of this control. @param buttonFilename Filename for the image @tsexample // Define the button filename %buttonFilename = \"pearlButton\"; // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); @endtsexample @see GuiControl @see GuiButtonCtrl) +/// @brief Set the bitmap to use for the button portion of this control. +/// @param buttonFilename Filename for the image +/// @tsexample +/// // Define the button filename +/// %buttonFilename = \"pearlButton\"; +/// // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap +/// %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); +/// @endtsexample +/// @see GuiControl +/// @see GuiButtonCtrl) +/// /// public void fnGuiIconButtonCtrl_setBitmap (string guiiconbuttonctrl, string buttonFilename) @@ -22489,7 +28059,14 @@ public void fnGuiIconButtonCtrl_setBitmap (string guiiconbuttonctrl, string butt SafeNativeMethods.mwle_fnGuiIconButtonCtrl_setBitmap(sbguiiconbuttonctrl, sbbuttonFilename); } /// -/// @brief Clears the imagelist @tsexample // Inform the GuiImageList control to clear itself. %isFinished = %thisGuiImageList.clear(); @endtsexample @return Returns true when finished. @see SimObject) +/// @brief Clears the imagelist +/// @tsexample +/// // Inform the GuiImageList control to clear itself. +/// %isFinished = %thisGuiImageList.clear(); +/// @endtsexample +/// @return Returns true when finished. +/// @see SimObject) +/// /// public bool fnGuiImageList_clear (string guiimagelist) @@ -22503,7 +28080,14 @@ public bool fnGuiImageList_clear (string guiimagelist) return SafeNativeMethods.mwle_fnGuiImageList_clear(sbguiimagelist)>=1; } /// -/// @brief Gets the number of images in the list. @tsexample // Request the number of images from the GuiImageList control. %imageCount = %thisGuiImageList.count(); @endtsexample @return Number of images in the control. @see SimObject) +/// @brief Gets the number of images in the list. +/// @tsexample +/// // Request the number of images from the GuiImageList control. +/// %imageCount = %thisGuiImageList.count(); +/// @endtsexample +/// @return Number of images in the control. +/// @see SimObject) +/// /// public int fnGuiImageList_count (string guiimagelist) @@ -22517,7 +28101,17 @@ public int fnGuiImageList_count (string guiimagelist) return SafeNativeMethods.mwle_fnGuiImageList_count(sbguiimagelist); } /// -/// @brief Get a path to the texture at the specified index. @param index Index of the image in the list. @tsexample // Define the image index/n %index = \"5\"; // Request the image path location from the control. %imagePath = %thisGuiImageList.getImage(%index); @endtsexample @return File path to the image map for the specified index. @see SimObject) +/// @brief Get a path to the texture at the specified index. +/// @param index Index of the image in the list. +/// @tsexample +/// // Define the image index/n +/// %index = \"5\"; +/// // Request the image path location from the control. +/// %imagePath = %thisGuiImageList.getImage(%index); +/// @endtsexample +/// @return File path to the image map for the specified index. +/// @see SimObject) +/// /// public string fnGuiImageList_getImage (string guiimagelist, int index) @@ -22534,7 +28128,17 @@ public string fnGuiImageList_getImage (string guiimagelist, int index) } /// -/// @brief Retrieves the imageindex of a specified texture in the list. @param imagePath Imagemap including filepath of image to search for @tsexample // Define the imagemap to search for %imagePath = \"./game/client/data/images/thisImage\"; // Request the index entry for the defined imagemap %imageIndex = %thisGuiImageList.getIndex(%imagePath); @endtsexample @return Index of the imagemap matching the defined image path. @see SimObject) +/// @brief Retrieves the imageindex of a specified texture in the list. +/// @param imagePath Imagemap including filepath of image to search for +/// @tsexample +/// // Define the imagemap to search for +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the index entry for the defined imagemap +/// %imageIndex = %thisGuiImageList.getIndex(%imagePath); +/// @endtsexample +/// @return Index of the imagemap matching the defined image path. +/// @see SimObject) +/// /// public int fnGuiImageList_getIndex (string guiimagelist, string imagePath) @@ -22551,7 +28155,17 @@ public int fnGuiImageList_getIndex (string guiimagelist, string imagePath) return SafeNativeMethods.mwle_fnGuiImageList_getIndex(sbguiimagelist, sbimagePath); } /// -/// @brief Insert an image into imagelist- returns the image index or -1 for failure. @param imagePath Imagemap, with path, to add to the list. @tsexample // Define the imagemap to add to the list %imagePath = \"./game/client/data/images/thisImage\"; // Request the GuiImageList control to add the defined image to its list. %imageIndex = %thisGuiImageList.insert(%imagePath); @endtsexample @return The index of the newly inserted imagemap, or -1 if the insertion failed. @see SimObject) +/// @brief Insert an image into imagelist- returns the image index or -1 for failure. +/// @param imagePath Imagemap, with path, to add to the list. +/// @tsexample +/// // Define the imagemap to add to the list +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the GuiImageList control to add the defined image to its list. +/// %imageIndex = %thisGuiImageList.insert(%imagePath); +/// @endtsexample +/// @return The index of the newly inserted imagemap, or -1 if the insertion failed. +/// @see SimObject) +/// /// public int fnGuiImageList_insert (string guiimagelist, string imagePath) @@ -22568,7 +28182,17 @@ public int fnGuiImageList_insert (string guiimagelist, string imagePath) return SafeNativeMethods.mwle_fnGuiImageList_insert(sbguiimagelist, sbimagePath); } /// -/// @brief Removes an image from the list by index. @param index Image index to remove. @tsexample // Define the image index. %imageIndex = \"4\"; // Inform the GuiImageList control to remove the image at the defined index. %wasSuccessful = %thisGuiImageList.remove(%imageIndex); @endtsexample @return True if the operation was successful, false if it was not. @see SimObject) +/// @brief Removes an image from the list by index. +/// @param index Image index to remove. +/// @tsexample +/// // Define the image index. +/// %imageIndex = \"4\"; +/// // Inform the GuiImageList control to remove the image at the defined index. +/// %wasSuccessful = %thisGuiImageList.remove(%imageIndex); +/// @endtsexample +/// @return True if the operation was successful, false if it was not. +/// @see SimObject) +/// /// public bool fnGuiImageList_remove (string guiimagelist, int index) @@ -22583,6 +28207,7 @@ public bool fnGuiImageList_remove (string guiimagelist, int index) } /// /// ( GuiInspectorTypeBitMask32, applyBit, void, 2,2, apply(); ) +/// /// public void fnGuiInspectorTypeBitMask32_applyBit (string guiinspectortypebitmask32) @@ -22597,6 +28222,7 @@ public void fnGuiInspectorTypeBitMask32_applyBit (string guiinspectortypebitmask } /// /// ( GuiInspectorTypeFileName, apply, void, 3,3, apply(newValue); ) +/// /// public void fnGuiInspectorTypeFileName_apply (string guiinspectortypefilename, string a2) @@ -22613,7 +28239,17 @@ public void fnGuiInspectorTypeFileName_apply (string guiinspectortypefilename, s SafeNativeMethods.mwle_fnGuiInspectorTypeFileName_apply(sbguiinspectortypefilename, sba2); } /// -/// @brief Checks if there is an item with the exact text of what is passed in, and if so the item is removed from the list and adds that item's data to the filtered list. @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. @tsexample // Define the itemName that we wish to add to the filtered item list. %itemName = \"This Item Name\"; // Add the item name to the filtered item list. %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); @endtsexample @see GuiControl) +/// @brief Checks if there is an item with the exact text of what is passed in, and if so +/// the item is removed from the list and adds that item's data to the filtered list. +/// @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. +/// @tsexample +/// // Define the itemName that we wish to add to the filtered item list. +/// %itemName = \"This Item Name\"; +/// // Add the item name to the filtered item list. +/// %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_addFilteredItem (string guilistboxctrl, string newItem) @@ -22630,7 +28266,22 @@ public void fnGuiListBoxCtrl_addFilteredItem (string guilistboxctrl, string newI SafeNativeMethods.mwle_fnGuiListBoxCtrl_addFilteredItem(sbguilistboxctrl, sbnewItem); } /// -/// ), @brief Adds an item to the end of the list with an optional color. @param newItem New item to add to the list. @param color Optional color parameter to add to the new item. @tsexample // Define the item to add to the list. %newItem = \"Gideon's Blue Coat\"; // Define the optional color for the new list item. %color = \"0.0 0.0 1.0\"; // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. %thisGuiListBoxCtrl.addItem(%newItem,%color); @endtsexample @return If not void, return value and description @see GuiControl @hide) +/// ), +/// @brief Adds an item to the end of the list with an optional color. +/// @param newItem New item to add to the list. +/// @param color Optional color parameter to add to the new item. +/// @tsexample +/// // Define the item to add to the list. +/// %newItem = \"Gideon's Blue Coat\"; +/// // Define the optional color for the new list item. +/// %color = \"0.0 0.0 1.0\"; +/// // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. +/// %thisGuiListBoxCtrl.addItem(%newItem,%color); +/// @endtsexample +/// @return If not void, return value and description +/// @see GuiControl +/// @hide) +/// /// public int fnGuiListBoxCtrl_addItem (string guilistboxctrl, string newItem, string color) @@ -22650,7 +28301,16 @@ public int fnGuiListBoxCtrl_addItem (string guilistboxctrl, string newItem, stri return SafeNativeMethods.mwle_fnGuiListBoxCtrl_addItem(sbguilistboxctrl, sbnewItem, sbcolor); } /// -/// @brief Removes any custom coloring from an item at the defined index id in the list. @param index Index id for the item to clear any custom color from. @tsexample // Define the index id %index = \"4\"; // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry %thisGuiListBoxCtrl.clearItemColor(%index); @endtsexample @see GuiControl) +/// @brief Removes any custom coloring from an item at the defined index id in the list. +/// @param index Index id for the item to clear any custom color from. +/// @tsexample +/// // Define the index id +/// %index = \"4\"; +/// // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry +/// %thisGuiListBoxCtrl.clearItemColor(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_clearItemColor (string guilistboxctrl, int index) @@ -22664,7 +28324,13 @@ public void fnGuiListBoxCtrl_clearItemColor (string guilistboxctrl, int index) SafeNativeMethods.mwle_fnGuiListBoxCtrl_clearItemColor(sbguilistboxctrl, index); } /// -/// @brief Clears all the items in the listbox. @tsexample // Inform the GuiListBoxCtrl object to clear all items from its list. %thisGuiListBoxCtrl.clearItems(); @endtsexample @see GuiControl) +/// @brief Clears all the items in the listbox. +/// @tsexample +/// // Inform the GuiListBoxCtrl object to clear all items from its list. +/// %thisGuiListBoxCtrl.clearItems(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_clearItems (string guilistboxctrl) @@ -22678,7 +28344,14 @@ public void fnGuiListBoxCtrl_clearItems (string guilistboxctrl) SafeNativeMethods.mwle_fnGuiListBoxCtrl_clearItems(sbguilistboxctrl); } /// -/// @brief Sets all currently selected items to unselected. Detailed description @tsexample // Inform the GuiListBoxCtrl object to set all of its items to unselected./n %thisGuiListBoxCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Sets all currently selected items to unselected. +/// Detailed description +/// @tsexample +/// // Inform the GuiListBoxCtrl object to set all of its items to unselected./n +/// %thisGuiListBoxCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_clearSelection (string guilistboxctrl) @@ -22692,7 +28365,16 @@ public void fnGuiListBoxCtrl_clearSelection (string guilistboxctrl) SafeNativeMethods.mwle_fnGuiListBoxCtrl_clearSelection(sbguilistboxctrl); } /// -/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. @param itemIndex Index id location to remove the item from. @tsexample // Define the index id we want to remove from the list %itemIndex = \"8\"; // Inform the GuiListBoxCtrl object to remove the item at the defined index id. %thisGuiListBoxCtrl.deleteItem(%itemIndex); @endtsexample @see References) +/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. +/// @param itemIndex Index id location to remove the item from. +/// @tsexample +/// // Define the index id we want to remove from the list +/// %itemIndex = \"8\"; +/// // Inform the GuiListBoxCtrl object to remove the item at the defined index id. +/// %thisGuiListBoxCtrl.deleteItem(%itemIndex); +/// @endtsexample +/// @see References) +/// /// public void fnGuiListBoxCtrl_deleteItem (string guilistboxctrl, int itemIndex) @@ -22706,7 +28388,13 @@ public void fnGuiListBoxCtrl_deleteItem (string guilistboxctrl, int itemIndex) SafeNativeMethods.mwle_fnGuiListBoxCtrl_deleteItem(sbguilistboxctrl, itemIndex); } /// -/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. @tsexample \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet %thisGuiListBox.doMirror(); @endtsexample @see GuiCore) +/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. +/// @tsexample +/// \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet +/// %thisGuiListBox.doMirror(); +/// @endtsexample +/// @see GuiCore) +/// /// public void fnGuiListBoxCtrl_doMirror (string guilistboxctrl) @@ -22720,7 +28408,20 @@ public void fnGuiListBoxCtrl_doMirror (string guilistboxctrl) SafeNativeMethods.mwle_fnGuiListBoxCtrl_doMirror(sbguilistboxctrl); } /// -/// @brief Returns index of item with matching text or -1 if none found. @param findText Text in the list to find. @param isCaseSensitive If true, the search will be case sensitive. @tsexample // Define the text we wish to find in the list. %findText = \"Hickory Smoked Gideon\"/n/n // Define if this is a case sensitive search or not. %isCaseSensitive = \"false\"; // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); @endtsexample @return Index id of item with matching text or -1 if none found. @see GuiControl) +/// @brief Returns index of item with matching text or -1 if none found. +/// @param findText Text in the list to find. +/// @param isCaseSensitive If true, the search will be case sensitive. +/// @tsexample +/// // Define the text we wish to find in the list. +/// %findText = \"Hickory Smoked Gideon\"/n/n +/// // Define if this is a case sensitive search or not. +/// %isCaseSensitive = \"false\"; +/// // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. +/// %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); +/// @endtsexample +/// @return Index id of item with matching text or -1 if none found. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_findItemText (string guilistboxctrl, string findText, bool bCaseSensitive) @@ -22737,7 +28438,14 @@ public int fnGuiListBoxCtrl_findItemText (string guilistboxctrl, string findText return SafeNativeMethods.mwle_fnGuiListBoxCtrl_findItemText(sbguilistboxctrl, sbfindText, bCaseSensitive); } /// -/// @brief Returns the number of items in the list. @tsexample // Request the number of items in the list of the GuiListBoxCtrl object. %listItemCount = %thisGuiListBoxCtrl.getItemCount(); @endtsexample @return The number of items in the list. @see GuiControl) +/// @brief Returns the number of items in the list. +/// @tsexample +/// // Request the number of items in the list of the GuiListBoxCtrl object. +/// %listItemCount = %thisGuiListBoxCtrl.getItemCount(); +/// @endtsexample +/// @return The number of items in the list. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getItemCount (string guilistboxctrl) @@ -22751,7 +28459,17 @@ public int fnGuiListBoxCtrl_getItemCount (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getItemCount(sbguilistboxctrl); } /// -/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. @param index Index id to request the associated item from. @tsexample // Define the index id %index = \"12\"; // Request the item from the GuiListBoxCtrl object %object = %thisGuiListBoxCtrl.getItemObject(%index); @endtsexample @return The object associated with the item in the list. @see References) +/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. +/// @param index Index id to request the associated item from. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Request the item from the GuiListBoxCtrl object +/// %object = %thisGuiListBoxCtrl.getItemObject(%index); +/// @endtsexample +/// @return The object associated with the item in the list. +/// @see References) +/// /// public string fnGuiListBoxCtrl_getItemObject (string guilistboxctrl, int index) @@ -22768,7 +28486,17 @@ public string fnGuiListBoxCtrl_getItemObject (string guilistboxctrl, int index) } /// -/// @brief Returns the text of the item at the specified index. @param index Index id to return the item text from. @tsexample // Define the index id entry to request the text from %index = \"12\"; // Request the item id text from the GuiListBoxCtrl object. %text = %thisGuiListBoxCtrl.getItemText(%index); @endtsexample @return The text of the requested index id. @see GuiControl) +/// @brief Returns the text of the item at the specified index. +/// @param index Index id to return the item text from. +/// @tsexample +/// // Define the index id entry to request the text from +/// %index = \"12\"; +/// // Request the item id text from the GuiListBoxCtrl object. +/// %text = %thisGuiListBoxCtrl.getItemText(%index); +/// @endtsexample +/// @return The text of the requested index id. +/// @see GuiControl) +/// /// public string fnGuiListBoxCtrl_getItemText (string guilistboxctrl, int index) @@ -22785,7 +28513,14 @@ public string fnGuiListBoxCtrl_getItemText (string guilistboxctrl, int index) } /// -/// @brief Request the item index for the item that was last clicked. @tsexample // Request the item index for the last clicked item in the list %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); @endtsexample @return Index id for the last clicked item in the list. @see GuiControl) +/// @brief Request the item index for the item that was last clicked. +/// @tsexample +/// // Request the item index for the last clicked item in the list +/// %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); +/// @endtsexample +/// @return Index id for the last clicked item in the list. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getLastClickItem (string guilistboxctrl) @@ -22799,7 +28534,14 @@ public int fnGuiListBoxCtrl_getLastClickItem (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getLastClickItem(sbguilistboxctrl); } /// -/// @brief Returns the number of items currently selected. @tsexample // Request the number of currently selected items %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); @endtsexample @return Number of currently selected items. @see GuiControl) +/// @brief Returns the number of items currently selected. +/// @tsexample +/// // Request the number of currently selected items +/// %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); +/// @endtsexample +/// @return Number of currently selected items. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getSelCount (string guilistboxctrl) @@ -22813,7 +28555,14 @@ public int fnGuiListBoxCtrl_getSelCount (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getSelCount(sbguilistboxctrl); } /// -/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. @tsexample // Request the index id of the currently selected item %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); @endtsexample @return The selected items index or -1 if none selected. @see GuiControl) +/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. +/// @tsexample +/// // Request the index id of the currently selected item +/// %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); +/// @endtsexample +/// @return The selected items index or -1 if none selected. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getSelectedItem (string guilistboxctrl) @@ -22827,7 +28576,14 @@ public int fnGuiListBoxCtrl_getSelectedItem (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getSelectedItem(sbguilistboxctrl); } /// -/// @brief Returns a space delimited list of the selected items indexes in the list. @tsexample // Request a space delimited list of the items in the GuiListBoxCtrl object. %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); @endtsexample @return Space delimited list of the selected items indexes in the list @see GuiControl) +/// @brief Returns a space delimited list of the selected items indexes in the list. +/// @tsexample +/// // Request a space delimited list of the items in the GuiListBoxCtrl object. +/// %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); +/// @endtsexample +/// @return Space delimited list of the selected items indexes in the list +/// @see GuiControl) +/// /// public string fnGuiListBoxCtrl_getSelectedItems (string guilistboxctrl) @@ -22844,7 +28600,20 @@ public string fnGuiListBoxCtrl_getSelectedItems (string guilistboxctrl) } /// -/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. @param text Text item to add. @param index Index id to insert the list item text at. @tsexample // Define the text to insert %text = \"Secret Agent Gideon\"; // Define the index entry to insert the text at %index = \"14\"; // In form the GuiListBoxCtrl object to insert the text at the defined index. %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); @endtsexample @return If successful will return the index id assigned. If unsuccessful, will return -1. @see GuiControl) +/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. +/// @param text Text item to add. +/// @param index Index id to insert the list item text at. +/// @tsexample +/// // Define the text to insert +/// %text = \"Secret Agent Gideon\"; +/// // Define the index entry to insert the text at +/// %index = \"14\"; +/// // In form the GuiListBoxCtrl object to insert the text at the defined index. +/// %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); +/// @endtsexample +/// @return If successful will return the index id assigned. If unsuccessful, will return -1. +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_insertItem (string guilistboxctrl, string text, int index) @@ -22861,7 +28630,16 @@ public void fnGuiListBoxCtrl_insertItem (string guilistboxctrl, string text, int SafeNativeMethods.mwle_fnGuiListBoxCtrl_insertItem(sbguilistboxctrl, sbtext, index); } /// -/// @brief Removes an item of the entered name from the filtered items list. @param itemName Name of the item to remove from the filtered list. @tsexample // Define the itemName that you wish to remove. %itemName = \"This Item Name\"; // Remove the itemName from the GuiListBoxCtrl %thisGuiListBoxCtrl.removeFilteredItem(%itemName); @endtsexample @see GuiControl) +/// @brief Removes an item of the entered name from the filtered items list. +/// @param itemName Name of the item to remove from the filtered list. +/// @tsexample +/// // Define the itemName that you wish to remove. +/// %itemName = \"This Item Name\"; +/// // Remove the itemName from the GuiListBoxCtrl +/// %thisGuiListBoxCtrl.removeFilteredItem(%itemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_removeFilteredItem (string guilistboxctrl, string itemName) @@ -22878,7 +28656,16 @@ public void fnGuiListBoxCtrl_removeFilteredItem (string guilistboxctrl, string i SafeNativeMethods.mwle_fnGuiListBoxCtrl_removeFilteredItem(sbguilistboxctrl, sbitemName); } /// -/// @brief Sets the currently selected item at the specified index. @param indexId Index Id to set selected. @tsexample // Define the index id that we wish to select. %selectId = \"4\"; // Inform the GuiListBoxCtrl object to set the requested index as selected. %thisGuiListBoxCtrl.setCurSel(%selectId); @endtsexample @see GuiControl) +/// @brief Sets the currently selected item at the specified index. +/// @param indexId Index Id to set selected. +/// @tsexample +/// // Define the index id that we wish to select. +/// %selectId = \"4\"; +/// // Inform the GuiListBoxCtrl object to set the requested index as selected. +/// %thisGuiListBoxCtrl.setCurSel(%selectId); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setCurSel (string guilistboxctrl, int indexId) @@ -22892,7 +28679,19 @@ public void fnGuiListBoxCtrl_setCurSel (string guilistboxctrl, int indexId) SafeNativeMethods.mwle_fnGuiListBoxCtrl_setCurSel(sbguilistboxctrl, indexId); } /// -/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list @param indexStart Index Id to start selection. @param indexStop Index Id to end selection. @tsexample // Set start id %indexStart = \"3\"; // Set end id %indexEnd = \"6\"; // Request the GuiListBoxCtrl object to select the defined range. %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); @endtsexample @see GuiControl) +/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list +/// @param indexStart Index Id to start selection. +/// @param indexStop Index Id to end selection. +/// @tsexample +/// // Set start id +/// %indexStart = \"3\"; +/// // Set end id +/// %indexEnd = \"6\"; +/// // Request the GuiListBoxCtrl object to select the defined range. +/// %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setCurSelRange (string guilistboxctrl, int indexStart, int indexStop) @@ -22906,7 +28705,19 @@ public void fnGuiListBoxCtrl_setCurSelRange (string guilistboxctrl, int indexSta SafeNativeMethods.mwle_fnGuiListBoxCtrl_setCurSelRange(sbguilistboxctrl, indexStart, indexStop); } /// -/// @brief Sets the color of a single list entry at the specified index id. @param index Index id to modify the color of in the list. @param color Color value to set the list entry to. @tsexample // Define the index id value %index = \"5\"; // Define the color value %color = \"1.0 0.0 0.0\"; // Inform the GuiListBoxCtrl object to change the color of the requested index %thisGuiListBoxCtrl.setItemColor(%index,%color); @endtsexample @see GuiControl) +/// @brief Sets the color of a single list entry at the specified index id. +/// @param index Index id to modify the color of in the list. +/// @param color Color value to set the list entry to. +/// @tsexample +/// // Define the index id value +/// %index = \"5\"; +/// // Define the color value +/// %color = \"1.0 0.0 0.0\"; +/// // Inform the GuiListBoxCtrl object to change the color of the requested index +/// %thisGuiListBoxCtrl.setItemColor(%index,%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setItemColor (string guilistboxctrl, int index, string color) @@ -22923,7 +28734,19 @@ public void fnGuiListBoxCtrl_setItemColor (string guilistboxctrl, int index, str SafeNativeMethods.mwle_fnGuiListBoxCtrl_setItemColor(sbguilistboxctrl, index, sbcolor); } /// -/// @brief Sets the items text at the specified index. @param index Index id to set the item text at. @param newtext Text to change the list item at index id to. @tsexample // Define the index id/n %index = \"12\"; // Define the text to set the list item to %newtext = \"Gideon's Fancy Goggles\"; // Inform the GuiListBoxCtrl object to change the text at the requested index %thisGuiListBoxCtrl.setItemText(%index,%newText); @endtsexample @see GuiControl) +/// @brief Sets the items text at the specified index. +/// @param index Index id to set the item text at. +/// @param newtext Text to change the list item at index id to. +/// @tsexample +/// // Define the index id/n +/// %index = \"12\"; +/// // Define the text to set the list item to +/// %newtext = \"Gideon's Fancy Goggles\"; +/// // Inform the GuiListBoxCtrl object to change the text at the requested index +/// %thisGuiListBoxCtrl.setItemText(%index,%newText); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setItemText (string guilistboxctrl, int index, string newtext) @@ -22940,7 +28763,19 @@ public void fnGuiListBoxCtrl_setItemText (string guilistboxctrl, int index, stri SafeNativeMethods.mwle_fnGuiListBoxCtrl_setItemText(sbguilistboxctrl, index, sbnewtext); } /// -/// @brief Set the tooltip text to display for the given list item. @param index Index id to change the tooltip text @param text Text for the tooltip. @tsexample // Define the index id %index = \"12\"; // Define the tooltip text %tooltip = \"Gideon's goggles can see through space and time.\" // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); @endtsexample @see GuiControl) +/// @brief Set the tooltip text to display for the given list item. +/// @param index Index id to change the tooltip text +/// @param text Text for the tooltip. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Define the tooltip text +/// %tooltip = \"Gideon's goggles can see through space and time.\" +/// // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id +/// %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setItemTooltip (string guilistboxctrl, int index, string text) @@ -22957,7 +28792,16 @@ public void fnGuiListBoxCtrl_setItemTooltip (string guilistboxctrl, int index, s SafeNativeMethods.mwle_fnGuiListBoxCtrl_setItemTooltip(sbguilistboxctrl, index, sbtext); } /// -/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. @param allowMultSelections Boolean variable to set the use of multiple selections or not. @tsexample // Define the multiple selection use state. %allowMultSelections = \"true\"; // Set the allow multiple selection state on the GuiListBoxCtrl object. %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); @endtsexample @see GuiControl) +/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. +/// @param allowMultSelections Boolean variable to set the use of multiple selections or not. +/// @tsexample +/// // Define the multiple selection use state. +/// %allowMultSelections = \"true\"; +/// // Set the allow multiple selection state on the GuiListBoxCtrl object. +/// %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setMultipleSelection (string guilistboxctrl, bool allowMultSelections) @@ -22971,7 +28815,20 @@ public void fnGuiListBoxCtrl_setMultipleSelection (string guilistboxctrl, bool a SafeNativeMethods.mwle_fnGuiListBoxCtrl_setMultipleSelection(sbguilistboxctrl, allowMultSelections); } /// -/// @brief Sets the item at the index specified to selected or not. Detailed description @param index Item index to set selected or unselected. @param setSelected Boolean selection state to set the requested item index. @tsexample // Define the index %index = \"5\"; // Define the selection state %selected = \"true\" // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. %thisGuiListBoxCtrl.setSelected(%index,%selected); @endtsexample @see GuiControl) +/// @brief Sets the item at the index specified to selected or not. +/// Detailed description +/// @param index Item index to set selected or unselected. +/// @param setSelected Boolean selection state to set the requested item index. +/// @tsexample +/// // Define the index +/// %index = \"5\"; +/// // Define the selection state +/// %selected = \"true\" +/// // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. +/// %thisGuiListBoxCtrl.setSelected(%index,%selected); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setSelected (string guilistboxctrl, int index, bool setSelected) @@ -22986,6 +28843,7 @@ public void fnGuiListBoxCtrl_setSelected (string guilistboxctrl, int index, bool } /// /// Deletes the preview model.) +/// /// public void fnGuiMaterialPreview_deleteModel (string guimaterialpreview) @@ -23000,6 +28858,7 @@ public void fnGuiMaterialPreview_deleteModel (string guimaterialpreview) } /// /// Resets the viewport to default zoom, pan, rotate and lighting.) +/// /// public void fnGuiMaterialPreview_reset (string guimaterialpreview) @@ -23014,6 +28873,7 @@ public void fnGuiMaterialPreview_reset (string guimaterialpreview) } /// /// Sets the color of the ambient light in the scene.) +/// /// public void fnGuiMaterialPreview_setAmbientLightColor (string guimaterialpreview, string color) @@ -23031,6 +28891,7 @@ public void fnGuiMaterialPreview_setAmbientLightColor (string guimaterialpreview } /// /// Sets the color of the light in the scene.) +/// /// public void fnGuiMaterialPreview_setLightColor (string guimaterialpreview, string color) @@ -23047,7 +28908,9 @@ public void fnGuiMaterialPreview_setLightColor (string guimaterialpreview, strin SafeNativeMethods.mwle_fnGuiMaterialPreview_setLightColor(sbguimaterialpreview, sbcolor); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display.) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display.) +/// /// public void fnGuiMaterialPreview_setModel (string guimaterialpreview, string shapeName) @@ -23064,7 +28927,10 @@ public void fnGuiMaterialPreview_setModel (string guimaterialpreview, string sha SafeNativeMethods.mwle_fnGuiMaterialPreview_setModel(sbguimaterialpreview, sbshapeName); } /// -/// Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. @param distance The distance to set the orbit to (will be clamped).) +/// Sets the distance at which the camera orbits the object. Clamped to the +/// acceptable range defined in the class by min and max orbit distances. +/// @param distance The distance to set the orbit to (will be clamped).) +/// /// public void fnGuiMaterialPreview_setOrbitDistance (string guimaterialpreview, float distance) @@ -23078,7 +28944,19 @@ public void fnGuiMaterialPreview_setOrbitDistance (string guimaterialpreview, fl SafeNativeMethods.mwle_fnGuiMaterialPreview_setOrbitDistance(sbguimaterialpreview, distance); } /// -/// @brief Adds a new menu to the menu bar. @param menuText Text to display for the new menu item. @param menuId ID for the new menu item. @tsexample // Define the menu text %menuText = \"New Menu\"; // Define the menu ID. %menuId = \"2\"; // Inform the GuiMenuBar control to add the new menu %thisGuiMenuBar.addMenu(%menuText,%menuId); @endtsexample @see GuiTickCtrl) +/// @brief Adds a new menu to the menu bar. +/// @param menuText Text to display for the new menu item. +/// @param menuId ID for the new menu item. +/// @tsexample +/// // Define the menu text +/// %menuText = \"New Menu\"; +/// // Define the menu ID. +/// %menuId = \"2\"; +/// // Inform the GuiMenuBar control to add the new menu +/// %thisGuiMenuBar.addMenu(%menuText,%menuId); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_addMenu (string guimenubar, string menuText, int menuId) @@ -23095,7 +28973,29 @@ public void fnGuiMenuBar_addMenu (string guimenubar, string menuText, int menuId SafeNativeMethods.mwle_fnGuiMenuBar_addMenu(sbguimenubar, sbmenuText, menuId); } /// -/// ,,0,,-1), @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menu Menu name or menu Id to add the new item to. @param menuItemText Text for the new menu item. @param menuItemId Id for the new menu item. @param accelerator Accelerator key for the new menu item. @param checkGroup Check group to include this menu item in. @tsexample // Define the menu we wish to add the item to %targetMenu = \"New Menu\"; or %menu = \"4\"; // Define the text for the new menu item %menuItemText = \"Menu Item\"; // Define the id for the new menu item %menuItemId = \"3\"; // Set the accelerator key to toggle this menu item with %accelerator = \"n\"; // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. %checkGroup = \"4\"; // Inform the GuiMenuBar control to add the new menu item with the defined fields %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); @endtsexample @see GuiTickCtrl) +/// ,,0,,-1), +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menu Menu name or menu Id to add the new item to. +/// @param menuItemText Text for the new menu item. +/// @param menuItemId Id for the new menu item. +/// @param accelerator Accelerator key for the new menu item. +/// @param checkGroup Check group to include this menu item in. +/// @tsexample +/// // Define the menu we wish to add the item to +/// %targetMenu = \"New Menu\"; or %menu = \"4\"; +/// // Define the text for the new menu item +/// %menuItemText = \"Menu Item\"; +/// // Define the id for the new menu item +/// %menuItemId = \"3\"; +/// // Set the accelerator key to toggle this menu item with +/// %accelerator = \"n\"; +/// // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. +/// %checkGroup = \"4\"; +/// // Inform the GuiMenuBar control to add the new menu item with the defined fields +/// %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_addMenuItem (string guimenubar, string targetMenu, string menuItemText, int menuItemId, string accelerator, int checkGroup) @@ -23118,7 +29018,31 @@ public void fnGuiMenuBar_addMenuItem (string guimenubar, string targetMenu, stri SafeNativeMethods.mwle_fnGuiMenuBar_addMenuItem(sbguimenubar, sbtargetMenu, sbmenuItemText, menuItemId, sbaccelerator, checkGroup); } /// -/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for the new submenu @param submenuItemId Id for the new submenu @param accelerator Accelerator key for the new submenu @param checkGroup Which check group the new submenu should be in, or -1 for none. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"New Submenu Item\"; // Define the id for the new submenu %submenuItemId = \"4\"; // Define the accelerator key for the new submenu %accelerator = \"n\"; // Define the checkgroup for the new submenu %checkgroup = \"7\"; // Request the GuiMenuBar control to add the new submenu with the defined information %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); @endtsexample @see GuiTickCtrl) +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for the new submenu +/// @param submenuItemId Id for the new submenu +/// @param accelerator Accelerator key for the new submenu +/// @param checkGroup Which check group the new submenu should be in, or -1 for none. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"New Submenu Item\"; +/// // Define the id for the new submenu +/// %submenuItemId = \"4\"; +/// // Define the accelerator key for the new submenu +/// %accelerator = \"n\"; +/// // Define the checkgroup for the new submenu +/// %checkgroup = \"7\"; +/// // Request the GuiMenuBar control to add the new submenu with the defined information +/// %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_addSubmenuItem (string guimenubar, string menuTarget, string menuItem, string submenuItemText, int submenuItemId, string accelerator, int checkGroup) @@ -23144,7 +29068,16 @@ public void fnGuiMenuBar_addSubmenuItem (string guimenubar, string menuTarget, s SafeNativeMethods.mwle_fnGuiMenuBar_addSubmenuItem(sbguimenubar, sbmenuTarget, sbmenuItem, sbsubmenuItemText, submenuItemId, sbaccelerator, checkGroup); } /// -/// @brief Removes all the menu items from the specified menu. @param menuTarget Menu to remove all items from @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar control to clear all menu items from the defined menu %thisGuiMenuBar.clearMenuItems(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes all the menu items from the specified menu. +/// @param menuTarget Menu to remove all items from +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar control to clear all menu items from the defined menu +/// %thisGuiMenuBar.clearMenuItems(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_clearMenuItems (string guimenubar, string menuTarget) @@ -23161,7 +29094,13 @@ public void fnGuiMenuBar_clearMenuItems (string guimenubar, string menuTarget) SafeNativeMethods.mwle_fnGuiMenuBar_clearMenuItems(sbguimenubar, sbmenuTarget); } /// -/// @brief Clears all the menus from the menu bar. @tsexample // Inform the GuiMenuBar control to clear all menus from itself. %thisGuiMenuBar.clearMenus(); @endtsexample @see GuiTickCtrl) +/// @brief Clears all the menus from the menu bar. +/// @tsexample +/// // Inform the GuiMenuBar control to clear all menus from itself. +/// %thisGuiMenuBar.clearMenus(); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_clearMenus (string guimenubar, int param1, int param2) @@ -23175,7 +29114,19 @@ public void fnGuiMenuBar_clearMenus (string guimenubar, int param1, int param2) SafeNativeMethods.mwle_fnGuiMenuBar_clearMenus(sbguimenubar, param1, param2); } /// -/// @brief Removes all the menu items from the specified submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Inform the GuiMenuBar to remove all submenu items from the defined menu item %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); @endtsexample @see GuiControl) +/// @brief Removes all the menu items from the specified submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Inform the GuiMenuBar to remove all submenu items from the defined menu item +/// %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMenuBar_clearSubmenuItems (string guimenubar, string menuTarget, string menuItem) @@ -23195,7 +29146,16 @@ public void fnGuiMenuBar_clearSubmenuItems (string guimenubar, string menuTarget SafeNativeMethods.mwle_fnGuiMenuBar_clearSubmenuItems(sbguimenubar, sbmenuTarget, sbmenuItem); } /// -/// @brief Removes the specified menu from the menu bar. @param menuTarget Menu to remove from the menu bar @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar to remove the defined menu from the menu bar %thisGuiMenuBar.removeMenu(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu from the menu bar. +/// @param menuTarget Menu to remove from the menu bar +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar to remove the defined menu from the menu bar +/// %thisGuiMenuBar.removeMenu(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_removeMenu (string guimenubar, string menuTarget) @@ -23212,7 +29172,19 @@ public void fnGuiMenuBar_removeMenu (string guimenubar, string menuTarget) SafeNativeMethods.mwle_fnGuiMenuBar_removeMenu(sbguimenubar, sbmenuTarget); } /// -/// @brief Removes the specified menu item from the menu. @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Request the GuiMenuBar control to remove the define menu item %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu item from the menu. +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Request the GuiMenuBar control to remove the define menu item +/// %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_removeMenuItem (string guimenubar, string menuTarget, string menuItemTarget) @@ -23232,7 +29204,16 @@ public void fnGuiMenuBar_removeMenuItem (string guimenubar, string menuTarget, s SafeNativeMethods.mwle_fnGuiMenuBar_removeMenuItem(sbguimenubar, sbmenuTarget, sbmenuItemTarget); } /// -/// @brief Sets the menu bitmap index for the check mark image. @param bitmapIndex Bitmap index for the check mark image. @tsexample // Define the bitmap index %bitmapIndex = \"2\"; // Inform the GuiMenuBar control of the proper bitmap index for the check mark image %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu bitmap index for the check mark image. +/// @param bitmapIndex Bitmap index for the check mark image. +/// @tsexample +/// // Define the bitmap index +/// %bitmapIndex = \"2\"; +/// // Inform the GuiMenuBar control of the proper bitmap index for the check mark image +/// %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setCheckmarkBitmapIndex (string guimenubar, int bitmapindex) @@ -23246,7 +29227,25 @@ public void fnGuiMenuBar_setCheckmarkBitmapIndex (string guimenubar, int bitmapi SafeNativeMethods.mwle_fnGuiMenuBar_setCheckmarkBitmapIndex(sbguimenubar, bitmapindex); } /// -/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. @param menuTarget Menu to affect @param bitmapindex Bitmap index to set for the menu @param bitmaponly If true, only the bitmap will be rendered @param drawborder If true, a border will be drawn around the menu. @tsexample // Define the menuTarget to affect %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Set the bitmap index %bitmapIndex = \"5\"; // Set if we are only to render the bitmap or not %bitmaponly = \"true\"; // Set if we are rendering a border or not %drawborder = \"true\"; // Inform the GuiMenuBar of the bitmap and rendering changes %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); @endtsexample @see GuiTickCtrl) +/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. +/// @param menuTarget Menu to affect +/// @param bitmapindex Bitmap index to set for the menu +/// @param bitmaponly If true, only the bitmap will be rendered +/// @param drawborder If true, a border will be drawn around the menu. +/// @tsexample +/// // Define the menuTarget to affect +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Set the bitmap index +/// %bitmapIndex = \"5\"; +/// // Set if we are only to render the bitmap or not +/// %bitmaponly = \"true\"; +/// // Set if we are rendering a border or not +/// %drawborder = \"true\"; +/// // Inform the GuiMenuBar of the bitmap and rendering changes +/// %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuBitmapIndex (string guimenubar, string menuTarget, int bitmapindex, bool bitmaponly, bool drawborder) @@ -23263,7 +29262,22 @@ public void fnGuiMenuBar_setMenuBitmapIndex (string guimenubar, string menuTarge SafeNativeMethods.mwle_fnGuiMenuBar_setMenuBitmapIndex(sbguimenubar, sbmenuTarget, bitmapindex, bitmaponly, drawborder); } /// -/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. @param menuTarget Menu to affect the menuItem in @param menuItem Menu item to affect @param bitmapIndex Bitmap index to set the menu item to @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem\" %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the bitmapIndex %bitmapIndex = \"6\"; // Inform the GuiMenuBar control to set the menu item to the defined bitmap %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. +/// @param menuTarget Menu to affect the menuItem in +/// @param menuItem Menu item to affect +/// @param bitmapIndex Bitmap index to set the menu item to +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem\" +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the bitmapIndex +/// %bitmapIndex = \"6\"; +/// // Inform the GuiMenuBar control to set the menu item to the defined bitmap +/// %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemBitmap (string guimenubar, string menuTarget, string menuItemTarget, int bitmapIndex) @@ -23283,7 +29297,18 @@ public void fnGuiMenuBar_setMenuItemBitmap (string guimenubar, string menuTarget SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemBitmap(sbguimenubar, sbmenuTarget, sbmenuItemTarget, bitmapIndex); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to work in @param menuItem Menu item to affect @param checked Whether we are setting it to checked or not @tsexample @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in +/// the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to work in +/// @param menuItem Menu item to affect +/// @param checked Whether we are setting it to checked or not +/// @tsexample +/// +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void fnGuiMenuBar_setMenuItemChecked (string guimenubar, string menuTarget, string menuItemTarget, bool checkedx) @@ -23303,7 +29328,24 @@ public void fnGuiMenuBar_setMenuItemChecked (string guimenubar, string menuTarge SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemChecked(sbguimenubar, sbmenuTarget, sbmenuItemTarget, checkedx); } /// -/// @brief sets the menu item to enabled or disabled based on the enable parameter. The specified menu and menu item can either be text or ids. Detailed description @param menuTarget Menu to work in @param menuItemTarget The menu item inside of the menu to enable or disable @param enabled Boolean enable / disable value. @tsexample // Define the menu %menu = \"New Menu\"; or %menu = \"4\"; // Define the menu item %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the enabled state %enabled = \"true\"; // Inform the GuiMenuBar control to set the enabled state of the requested menu item %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); @endtsexample @see GuiTickCtrl) +/// @brief sets the menu item to enabled or disabled based on the enable parameter. +/// The specified menu and menu item can either be text or ids. +/// Detailed description +/// @param menuTarget Menu to work in +/// @param menuItemTarget The menu item inside of the menu to enable or disable +/// @param enabled Boolean enable / disable value. +/// @tsexample +/// // Define the menu +/// %menu = \"New Menu\"; or %menu = \"4\"; +/// // Define the menu item +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the enabled state +/// %enabled = \"true\"; +/// // Inform the GuiMenuBar control to set the enabled state of the requested menu item +/// %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemEnable (string guimenubar, string menuTarget, string menuItemTarget, bool enabled) @@ -23323,7 +29365,22 @@ public void fnGuiMenuBar_setMenuItemEnable (string guimenubar, string menuTarget SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemEnable(sbguimenubar, sbmenuTarget, sbmenuItemTarget, enabled); } /// -/// @brief Sets the given menu item to be a submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param isSubmenu Whether or not the menuItem will become a subMenu or not @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define whether or not the Menu Item is a sub menu or not %isSubmenu = \"true\"; // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); @endtsexample @see GuiTickCtrl) +/// @brief Sets the given menu item to be a submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param isSubmenu Whether or not the menuItem will become a subMenu or not +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define whether or not the Menu Item is a sub menu or not +/// %isSubmenu = \"true\"; +/// // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. +/// %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemSubmenuState (string guimenubar, string menuTarget, string menuItem, bool isSubmenu) @@ -23343,7 +29400,22 @@ public void fnGuiMenuBar_setMenuItemSubmenuState (string guimenubar, string menu SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemSubmenuState(sbguimenubar, sbmenuTarget, sbmenuItem, isSubmenu); } /// -/// @brief Sets the text of the specified menu item to the new string. @param menuTarget Menu to affect @param menuItem Menu item in the menu to change the text at @param newMenuItemText New menu text @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the new text for the menu item %newMenuItemText = \"Very New Menu Item\"; // Inform the GuiMenuBar control to change the defined menu item with the new text %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu item to the new string. +/// @param menuTarget Menu to affect +/// @param menuItem Menu item in the menu to change the text at +/// @param newMenuItemText New menu text +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the new text for the menu item +/// %newMenuItemText = \"Very New Menu Item\"; +/// // Inform the GuiMenuBar control to change the defined menu item with the new text +/// %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemText (string guimenubar, string menuTarget, string menuItemTarget, string newMenuItemText) @@ -23366,7 +29438,23 @@ public void fnGuiMenuBar_setMenuItemText (string guimenubar, string menuTarget, SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemText(sbguimenubar, sbmenuTarget, sbmenuItemTarget, sbnewMenuItemText); } /// -/// @brief Brief Description. Detailed description @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @param isVisible Visible state to set the menu item to. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the visibility state %isVisible = \"true\"; // Inform the GuiMenuBarControl of the visibility state of the defined menu item %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); @endtsexample @see GuiTickCtrl) +/// @brief Brief Description. +/// Detailed description +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @param isVisible Visible state to set the menu item to. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the visibility state +/// %isVisible = \"true\"; +/// // Inform the GuiMenuBarControl of the visibility state of the defined menu item +/// %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemVisible (string guimenubar, string menuTarget, string menuItemTarget, bool isVisible) @@ -23386,7 +29474,23 @@ public void fnGuiMenuBar_setMenuItemVisible (string guimenubar, string menuTarge SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemVisible(sbguimenubar, sbmenuTarget, sbmenuItemTarget, isVisible); } /// -/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. Detailed description @param horizontalMargin Number of pixels on the left and right side of a menu's text. @param verticalMargin Number of pixels on the top and bottom of a menu's text. @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. @tsexample // Define the horizontalMargin %horizontalMargin = \"5\"; // Define the verticalMargin %verticalMargin = \"5\"; // Define the bitmapToTextSpacing %bitmapToTextSpacing = \"12\"; // Inform the GuiMenuBar control to set its margins based on the defined values. %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. +/// Detailed description +/// @param horizontalMargin Number of pixels on the left and right side of a menu's text. +/// @param verticalMargin Number of pixels on the top and bottom of a menu's text. +/// @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. +/// @tsexample +/// // Define the horizontalMargin +/// %horizontalMargin = \"5\"; +/// // Define the verticalMargin +/// %verticalMargin = \"5\"; +/// // Define the bitmapToTextSpacing +/// %bitmapToTextSpacing = \"12\"; +/// // Inform the GuiMenuBar control to set its margins based on the defined values. +/// %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuMargins (string guimenubar, int horizontalMargin, int verticalMargin, int bitmapToTextSpacing) @@ -23400,7 +29504,19 @@ public void fnGuiMenuBar_setMenuMargins (string guimenubar, int horizontalMargin SafeNativeMethods.mwle_fnGuiMenuBar_setMenuMargins(sbguimenubar, horizontalMargin, verticalMargin, bitmapToTextSpacing); } /// -/// @brief Sets the text of the specified menu to the new string. @param menuTarget Menu to affect @param newMenuText New menu text @tsexample // Define the menu to affect %menu = \"New Menu\"; or %menu = \"3\"; // Define the text to change the menu to %newMenuText = \"Still a New Menu\"; // Inform the GuiMenuBar control to change the defined menu to the defined text %thisGuiMenuBar.setMenuText(%menu,%newMenuText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu to the new string. +/// @param menuTarget Menu to affect +/// @param newMenuText New menu text +/// @tsexample +/// // Define the menu to affect +/// %menu = \"New Menu\"; or %menu = \"3\"; +/// // Define the text to change the menu to +/// %newMenuText = \"Still a New Menu\"; +/// // Inform the GuiMenuBar control to change the defined menu to the defined text +/// %thisGuiMenuBar.setMenuText(%menu,%newMenuText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuText (string guimenubar, string menuTarget, string newMenuText) @@ -23420,7 +29536,19 @@ public void fnGuiMenuBar_setMenuText (string guimenubar, string menuTarget, stri SafeNativeMethods.mwle_fnGuiMenuBar_setMenuText(sbguimenubar, sbmenuTarget, sbnewMenuText); } /// -/// @brief Sets the whether or not to display the specified menu. @param menuTarget Menu item to affect @param visible Whether the menu item will be visible or not @tsexample // Define the menu to work with %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define if the menu should be visible or not %visible = \"true\"; // Inform the GuiMenuBar control of the new visibility state for the defined menu %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); @endtsexample @see GuiTickCtrl) +/// @brief Sets the whether or not to display the specified menu. +/// @param menuTarget Menu item to affect +/// @param visible Whether the menu item will be visible or not +/// @tsexample +/// // Define the menu to work with +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define if the menu should be visible or not +/// %visible = \"true\"; +/// // Inform the GuiMenuBar control of the new visibility state for the defined menu +/// %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuVisible (string guimenubar, string menuTarget, bool visible) @@ -23437,7 +29565,28 @@ public void fnGuiMenuBar_setMenuVisible (string guimenubar, string menuTarget, b SafeNativeMethods.mwle_fnGuiMenuBar_setMenuVisible(sbguimenubar, sbmenuTarget, visible); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for submenu @param checked Whether or not this submenu item will be checked. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"Submenu Item\"; // Define if this submenu item should be checked or not %checked = \"true\"; // Inform the GuiMenuBar control to set the checked state of the defined submenu item %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the +/// bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for submenu +/// @param checked Whether or not this submenu item will be checked. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"Submenu Item\"; +/// // Define if this submenu item should be checked or not +/// %checked = \"true\"; +/// // Inform the GuiMenuBar control to set the checked state of the defined submenu item +/// %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void fnGuiMenuBar_setSubmenuItemChecked (string guimenubar, string menuTarget, string menuItemTarget, string submenuItemText, bool checkedx) @@ -23460,7 +29609,20 @@ public void fnGuiMenuBar_setSubmenuItemChecked (string guimenubar, string menuTa SafeNativeMethods.mwle_fnGuiMenuBar_setSubmenuItemChecked(sbguimenubar, sbmenuTarget, sbmenuItemTarget, sbsubmenuItemText, checkedx); } /// -/// @brief Push a line onto the back of the list. @param item The GUI element being pushed into the control @tsexample // All messages are stored in this HudMessageVector, the actual // MainChatHud only displays the contents of this vector. new MessageVector(HudMessageVector); // Attach the MessageVector to the chat control chatHud.attach(HudMessageVector); @endtsexample @return Value) +/// @brief Push a line onto the back of the list. +/// +/// @param item The GUI element being pushed into the control +/// +/// @tsexample +/// // All messages are stored in this HudMessageVector, the actual +/// // MainChatHud only displays the contents of this vector. +/// new MessageVector(HudMessageVector); +/// // Attach the MessageVector to the chat control +/// chatHud.attach(HudMessageVector); +/// @endtsexample +/// +/// @return Value) +/// /// public bool fnGuiMessageVectorCtrl_attach (string guimessagevectorctrl, string item) @@ -23477,7 +29639,18 @@ public bool fnGuiMessageVectorCtrl_attach (string guimessagevectorctrl, string i return SafeNativeMethods.mwle_fnGuiMessageVectorCtrl_attach(sbguimessagevectorctrl, sbitem)>=1; } /// -/// @brief Stop listing messages from the MessageVector previously attached to, if any. Detailed description @param param Description @tsexample // Deatch the MessageVector from HudMessageVector // HudMessageVector will no longer render the text chatHud.detach(); @endtsexample) +/// @brief Stop listing messages from the MessageVector previously attached to, if any. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Deatch the MessageVector from HudMessageVector +/// // HudMessageVector will no longer render the text +/// chatHud.detach(); +/// @endtsexample) +/// /// public void fnGuiMessageVectorCtrl_detach (string guimessagevectorctrl) @@ -23492,6 +29665,7 @@ public void fnGuiMessageVectorCtrl_detach (string guimessagevectorctrl) } /// /// @brief Set the MissionArea to edit.) +/// /// public void fnGuiMissionAreaCtrl_setMissionArea (string guimissionareactrl, string area) @@ -23509,6 +29683,7 @@ public void fnGuiMissionAreaCtrl_setMissionArea (string guimissionareactrl, stri } /// /// @brief Update the terrain bitmap.) +/// /// public void fnGuiMissionAreaCtrl_updateTerrain (string guimissionareactrl) @@ -23522,7 +29697,19 @@ public void fnGuiMissionAreaCtrl_updateTerrain (string guimissionareactrl) SafeNativeMethods.mwle_fnGuiMissionAreaCtrl_updateTerrain(sbguimissionareactrl); } /// -/// @brief Appends the text in the control with additional text. Also . @param text New text to append to the existing text. @param reformat If true, the control will also be visually reset (defaults to true). @tsexample // Define new text to add %text = \"New Text to Add\"; // Set reformat boolean %reformat = \"true\"; // Inform the control to add the new text %thisGuiMLTextCtrl.addText(%text,%reformat); @endtsexample @see GuiControl) +/// @brief Appends the text in the control with additional text. Also . +/// @param text New text to append to the existing text. +/// @param reformat If true, the control will also be visually reset (defaults to true). +/// @tsexample +/// // Define new text to add +/// %text = \"New Text to Add\"; +/// // Set reformat boolean +/// %reformat = \"true\"; +/// // Inform the control to add the new text +/// %thisGuiMLTextCtrl.addText(%text,%reformat); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_addText (string guimltextctrl, string text, bool reformat) @@ -23539,7 +29726,17 @@ public void fnGuiMLTextCtrl_addText (string guimltextctrl, string text, bool ref SafeNativeMethods.mwle_fnGuiMLTextCtrl_addText(sbguimltextctrl, sbtext, reformat); } /// -/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. @tsexample // Define new text to add %newText = \"BACON!\"; // Add the new text to the control %thisGuiMLTextCtrl.addText(%newText); // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. %thisGuiMLTextCtrl.forceReflow(); @endtsexample @see GuiControl) +/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. +/// @tsexample +/// // Define new text to add +/// %newText = \"BACON!\"; +/// // Add the new text to the control +/// %thisGuiMLTextCtrl.addText(%newText); +/// // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. +/// %thisGuiMLTextCtrl.forceReflow(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_forceReflow (string guimltextctrl) @@ -23553,7 +29750,14 @@ public void fnGuiMLTextCtrl_forceReflow (string guimltextctrl) SafeNativeMethods.mwle_fnGuiMLTextCtrl_forceReflow(sbguimltextctrl); } /// -/// @brief Returns the text from the control, including TorqueML characters. @tsexample // Get the text displayed in the control %controlText = %thisGuiMLTextCtrl.getText(); @endtsexample @return Text string displayed in the control, including any TorqueML characters. @see GuiControl) +/// @brief Returns the text from the control, including TorqueML characters. +/// @tsexample +/// // Get the text displayed in the control +/// %controlText = %thisGuiMLTextCtrl.getText(); +/// @endtsexample +/// @return Text string displayed in the control, including any TorqueML characters. +/// @see GuiControl) +/// /// public string fnGuiMLTextCtrl_getText (string guimltextctrl) @@ -23570,7 +29774,13 @@ public string fnGuiMLTextCtrl_getText (string guimltextctrl) } /// -/// @brief Scroll to the bottom of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its bottom %thisGuiMLTextCtrl.scrollToBottom(); @endtsexample @see GuiControl) +/// @brief Scroll to the bottom of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its bottom +/// %thisGuiMLTextCtrl.scrollToBottom(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_scrollToBottom (string guimltextctrl) @@ -23584,7 +29794,17 @@ public void fnGuiMLTextCtrl_scrollToBottom (string guimltextctrl) SafeNativeMethods.mwle_fnGuiMLTextCtrl_scrollToBottom(sbguimltextctrl); } /// -/// @brief Scroll down to a specified tag. Detailed description @param tagID TagID to scroll the control to @tsexample // Define the TagID we want to scroll the control to %tagId = \"4\"; // Inform the GuiMLTextCtrl to scroll to the defined TagID %thisGuiMLTextCtrl.scrollToTag(%tagId); @endtsexample @see GuiControl) +/// @brief Scroll down to a specified tag. +/// Detailed description +/// @param tagID TagID to scroll the control to +/// @tsexample +/// // Define the TagID we want to scroll the control to +/// %tagId = \"4\"; +/// // Inform the GuiMLTextCtrl to scroll to the defined TagID +/// %thisGuiMLTextCtrl.scrollToTag(%tagId); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_scrollToTag (string guimltextctrl, int tagID) @@ -23598,7 +29818,13 @@ public void fnGuiMLTextCtrl_scrollToTag (string guimltextctrl, int tagID) SafeNativeMethods.mwle_fnGuiMLTextCtrl_scrollToTag(sbguimltextctrl, tagID); } /// -/// @brief Scroll to the top of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its top %thisGuiMLTextCtrl.scrollToTop(); @endtsexample @see GuiControl) +/// @brief Scroll to the top of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its top +/// %thisGuiMLTextCtrl.scrollToTop(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_scrollToTop (string guimltextctrl, int param1, int param2) @@ -23612,7 +29838,16 @@ public void fnGuiMLTextCtrl_scrollToTop (string guimltextctrl, int param1, int p SafeNativeMethods.mwle_fnGuiMLTextCtrl_scrollToTop(sbguimltextctrl, param1, param2); } /// -/// @brief Sets the alpha value of the control. @param alphaVal n - 1.0 floating value for the alpha @tsexample // Define the alphe value %alphaVal = \"0.5\"; // Inform the control to update its alpha value. %thisGuiMLTextCtrl.setAlpha(%alphaVal); @endtsexample @see GuiControl) +/// @brief Sets the alpha value of the control. +/// @param alphaVal n - 1.0 floating value for the alpha +/// @tsexample +/// // Define the alphe value +/// %alphaVal = \"0.5\"; +/// // Inform the control to update its alpha value. +/// %thisGuiMLTextCtrl.setAlpha(%alphaVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_setAlpha (string guimltextctrl, float alphaVal) @@ -23626,7 +29861,17 @@ public void fnGuiMLTextCtrl_setAlpha (string guimltextctrl, float alphaVal) SafeNativeMethods.mwle_fnGuiMLTextCtrl_setAlpha(sbguimltextctrl, alphaVal); } /// -/// @brief Change the text cursor's position to a new defined offset within the text in the control. @param newPos Offset to place cursor. @tsexample // Define cursor offset position %position = \"23\"; // Inform the GuiMLTextCtrl object to move the cursor to the new position. %thisGuiMLTextCtrl.setCursorPosition(%position); @endtsexample @return Returns true if the cursor position moved, or false if the position was not changed. @see GuiControl) +/// @brief Change the text cursor's position to a new defined offset within the text in the control. +/// @param newPos Offset to place cursor. +/// @tsexample +/// // Define cursor offset position +/// %position = \"23\"; +/// // Inform the GuiMLTextCtrl object to move the cursor to the new position. +/// %thisGuiMLTextCtrl.setCursorPosition(%position); +/// @endtsexample +/// @return Returns true if the cursor position moved, or false if the position was not changed. +/// @see GuiControl) +/// /// public bool fnGuiMLTextCtrl_setCursorPosition (string guimltextctrl, int newPos) @@ -23640,7 +29885,16 @@ public bool fnGuiMLTextCtrl_setCursorPosition (string guimltextctrl, int newPos) return SafeNativeMethods.mwle_fnGuiMLTextCtrl_setCursorPosition(sbguimltextctrl, newPos)>=1; } /// -/// @brief Set the text contained in the control. @param text The text to display in the control. @tsexample // Define the text to display %text = \"Nifty Control Text\"; // Set the text displayed within the control %thisGuiMLTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Set the text contained in the control. +/// @param text The text to display in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Nifty Control Text\"; +/// // Set the text displayed within the control +/// %thisGuiMLTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_setText (string guimltextctrl, string text) @@ -23777,7 +30031,14 @@ public void fnGuiNavEditorCtrl_spawnPlayer (string guinaveditorctrl) SafeNativeMethods.mwle_fnGuiNavEditorCtrl_spawnPlayer(sbguinaveditorctrl); } /// -/// @brief Return the current multiplier for camera zooming and rotation. @tsexample // Request the current camera zooming and rotation multiplier value %multiplier = %thisGuiObjectView.getCameraSpeed(); @endtsexample @return Camera zooming / rotation multiplier value. @see GuiControl) +/// @brief Return the current multiplier for camera zooming and rotation. +/// @tsexample +/// // Request the current camera zooming and rotation multiplier value +/// %multiplier = %thisGuiObjectView.getCameraSpeed(); +/// @endtsexample +/// @return Camera zooming / rotation multiplier value. +/// @see GuiControl) +/// /// public float fnGuiObjectView_getCameraSpeed (string guiobjectview) @@ -23791,7 +30052,14 @@ public float fnGuiObjectView_getCameraSpeed (string guiobjectview) return SafeNativeMethods.mwle_fnGuiObjectView_getCameraSpeed(sbguiobjectview); } /// -/// @brief Return the model displayed in this view. @tsexample // Request the displayed model name from the GuiObjectView object. %modelName = %thisGuiObjectView.getModel(); @endtsexample @return Name of the displayed model. @see GuiControl) +/// @brief Return the model displayed in this view. +/// @tsexample +/// // Request the displayed model name from the GuiObjectView object. +/// %modelName = %thisGuiObjectView.getModel(); +/// @endtsexample +/// @return Name of the displayed model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getModel (string guiobjectview) @@ -23808,7 +30076,14 @@ public string fnGuiObjectView_getModel (string guiobjectview) } /// -/// @brief Return the name of the mounted model. @tsexample // Request the name of the mounted model from the GuiObjectView object %mountedModelName = %thisGuiObjectView.getMountedModel(); @endtsexample @return Name of the mounted model. @see GuiControl) +/// @brief Return the name of the mounted model. +/// @tsexample +/// // Request the name of the mounted model from the GuiObjectView object +/// %mountedModelName = %thisGuiObjectView.getMountedModel(); +/// @endtsexample +/// @return Name of the mounted model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getMountedModel (string guiobjectview) @@ -23825,7 +30100,14 @@ public string fnGuiObjectView_getMountedModel (string guiobjectview) } /// -/// @brief Return the name of skin used on the mounted model. @tsexample // Request the skin name from the model mounted on to the main model in the control %mountModelSkin = %thisGuiObjectView.getMountSkin(); @endtsexample @return Name of the skin used on the mounted model. @see GuiControl) +/// @brief Return the name of skin used on the mounted model. +/// @tsexample +/// // Request the skin name from the model mounted on to the main model in the control +/// %mountModelSkin = %thisGuiObjectView.getMountSkin(); +/// @endtsexample +/// @return Name of the skin used on the mounted model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getMountSkin (string guiobjectview, int param1, int param2) @@ -23842,7 +30124,14 @@ public string fnGuiObjectView_getMountSkin (string guiobjectview, int param1, in } /// -/// @brief Return the current distance at which the camera orbits the object. @tsexample // Request the current orbit distance %orbitDistance = %thisGuiObjectView.getOrbitDistance(); @endtsexample @return The distance at which the camera orbits the object. @see GuiControl) +/// @brief Return the current distance at which the camera orbits the object. +/// @tsexample +/// // Request the current orbit distance +/// %orbitDistance = %thisGuiObjectView.getOrbitDistance(); +/// @endtsexample +/// @return The distance at which the camera orbits the object. +/// @see GuiControl) +/// /// public float fnGuiObjectView_getOrbitDistance (string guiobjectview) @@ -23856,7 +30145,14 @@ public float fnGuiObjectView_getOrbitDistance (string guiobjectview) return SafeNativeMethods.mwle_fnGuiObjectView_getOrbitDistance(sbguiobjectview); } /// -/// @brief Return the name of skin used on the primary model. @tsexample // Request the name of the skin used on the primary model in the control %skinName = %thisGuiObjectView.getSkin(); @endtsexample @return Name of the skin used on the primary model. @see GuiControl) +/// @brief Return the name of skin used on the primary model. +/// @tsexample +/// // Request the name of the skin used on the primary model in the control +/// %skinName = %thisGuiObjectView.getSkin(); +/// @endtsexample +/// @return Name of the skin used on the primary model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getSkin (string guiobjectview) @@ -23873,7 +30169,16 @@ public string fnGuiObjectView_getSkin (string guiobjectview) } /// -/// @brief Sets the multiplier for the camera rotation and zoom speed. @param factor Multiplier for camera rotation and zoom speed. @tsexample // Set the factor value %factor = \"0.75\"; // Inform the GuiObjectView object to set the camera speed. %thisGuiObjectView.setCameraSpeed(%factor); @endtsexample @see GuiControl) +/// @brief Sets the multiplier for the camera rotation and zoom speed. +/// @param factor Multiplier for camera rotation and zoom speed. +/// @tsexample +/// // Set the factor value +/// %factor = \"0.75\"; +/// // Inform the GuiObjectView object to set the camera speed. +/// %thisGuiObjectView.setCameraSpeed(%factor); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setCameraSpeed (string guiobjectview, float factor) @@ -23887,7 +30192,16 @@ public void fnGuiObjectView_setCameraSpeed (string guiobjectview, float factor) SafeNativeMethods.mwle_fnGuiObjectView_setCameraSpeed(sbguiobjectview, factor); } /// -/// @brief Set the light ambient color on the sun object used to render the model. @param color Ambient color of sunlight. @tsexample // Define the sun ambient color value %color = \"1.0 0.4 0.6\"; // Inform the GuiObjectView object to set the sun ambient color to the requested value %thisGuiObjectView.setLightAmbient(%color); @endtsexample @see GuiControl) +/// @brief Set the light ambient color on the sun object used to render the model. +/// @param color Ambient color of sunlight. +/// @tsexample +/// // Define the sun ambient color value +/// %color = \"1.0 0.4 0.6\"; +/// // Inform the GuiObjectView object to set the sun ambient color to the requested value +/// %thisGuiObjectView.setLightAmbient(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setLightAmbient (string guiobjectview, string color) @@ -23904,7 +30218,16 @@ public void fnGuiObjectView_setLightAmbient (string guiobjectview, string color) SafeNativeMethods.mwle_fnGuiObjectView_setLightAmbient(sbguiobjectview, sbcolor); } /// -/// @brief Set the light color on the sun object used to render the model. @param color Color of sunlight. @tsexample // Set the color value for the sun %color = \"1.0 0.4 0.5\"; // Inform the GuiObjectView object to change the sun color to the defined value %thisGuiObjectView.setLightColor(%color); @endtsexample @see GuiControl) +/// @brief Set the light color on the sun object used to render the model. +/// @param color Color of sunlight. +/// @tsexample +/// // Set the color value for the sun +/// %color = \"1.0 0.4 0.5\"; +/// // Inform the GuiObjectView object to change the sun color to the defined value +/// %thisGuiObjectView.setLightColor(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setLightColor (string guiobjectview, string color) @@ -23921,7 +30244,16 @@ public void fnGuiObjectView_setLightColor (string guiobjectview, string color) SafeNativeMethods.mwle_fnGuiObjectView_setLightColor(sbguiobjectview, sbcolor); } /// -/// @brief Set the light direction from which to light the model. @param direction XYZ direction from which the light will shine on the model @tsexample // Set the light direction %direction = \"1.0 0.2 0.4\" // Inform the GuiObjectView object to change the light direction to the defined value %thisGuiObjectView.setLightDirection(%direction); @endtsexample @see GuiControl) +/// @brief Set the light direction from which to light the model. +/// @param direction XYZ direction from which the light will shine on the model +/// @tsexample +/// // Set the light direction +/// %direction = \"1.0 0.2 0.4\" +/// // Inform the GuiObjectView object to change the light direction to the defined value +/// %thisGuiObjectView.setLightDirection(%direction); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setLightDirection (string guiobjectview, string direction) @@ -23938,7 +30270,16 @@ public void fnGuiObjectView_setLightDirection (string guiobjectview, string dire SafeNativeMethods.mwle_fnGuiObjectView_setLightDirection(sbguiobjectview, sbdirection); } /// -/// @brief Sets the model to be displayed in this control. @param shapeName Name of the model to display. @tsexample // Define the model we want to display %shapeName = \"gideon.dts\"; // Tell the GuiObjectView object to display the defined model %thisGuiObjectView.setModel(%shapeName); @endtsexample @see GuiControl) +/// @brief Sets the model to be displayed in this control. +/// @param shapeName Name of the model to display. +/// @tsexample +/// // Define the model we want to display +/// %shapeName = \"gideon.dts\"; +/// // Tell the GuiObjectView object to display the defined model +/// %thisGuiObjectView.setModel(%shapeName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setModel (string guiobjectview, string shapeName) @@ -23955,7 +30296,22 @@ public void fnGuiObjectView_setModel (string guiobjectview, string shapeName) SafeNativeMethods.mwle_fnGuiObjectView_setModel(sbguiobjectview, sbshapeName); } /// -/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. Detailed description @param shapeName Name of the model to mount. @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. @tsexample // Set the shapeName to mount %shapeName = \"GideonGlasses.dts\" // Set the mount node of the primary model in the control to mount the new shape at %mountNodeIndexOrName = \"3\"; //OR: %mountNodeIndexOrName = \"Face\"; // Inform the GuiObjectView object to mount the shape at the specified node. %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); @endtsexample @see GuiControl) +/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. +/// Detailed description +/// @param shapeName Name of the model to mount. +/// @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. +/// @tsexample +/// // Set the shapeName to mount +/// %shapeName = \"GideonGlasses.dts\" +/// // Set the mount node of the primary model in the control to mount the new shape at +/// %mountNodeIndexOrName = \"3\"; +/// //OR: +/// %mountNodeIndexOrName = \"Face\"; +/// // Inform the GuiObjectView object to mount the shape at the specified node. +/// %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setMount (string guiobjectview, string shapeName, string mountNodeIndexOrName) @@ -23975,7 +30331,16 @@ public void fnGuiObjectView_setMount (string guiobjectview, string shapeName, st SafeNativeMethods.mwle_fnGuiObjectView_setMount(sbguiobjectview, sbshapeName, sbmountNodeIndexOrName); } /// -/// @brief Sets the model to be mounted on the primary model. @param shapeName Name of the model to mount. @tsexample // Define the model name to mount %modelToMount = \"GideonGlasses.dts\"; // Inform the GuiObjectView object to mount the defined model to the existing model in the control %thisGuiObjectView.setMountedModel(%modelToMount); @endtsexample @see GuiControl) +/// @brief Sets the model to be mounted on the primary model. +/// @param shapeName Name of the model to mount. +/// @tsexample +/// // Define the model name to mount +/// %modelToMount = \"GideonGlasses.dts\"; +/// // Inform the GuiObjectView object to mount the defined model to the existing model in the control +/// %thisGuiObjectView.setMountedModel(%modelToMount); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setMountedModel (string guiobjectview, string shapeName) @@ -23992,7 +30357,16 @@ public void fnGuiObjectView_setMountedModel (string guiobjectview, string shapeN SafeNativeMethods.mwle_fnGuiObjectView_setMountedModel(sbguiobjectview, sbshapeName); } /// -/// @brief Sets the skin to use on the mounted model. @param skinName Name of the skin to set on the model mounted to the main model in the control @tsexample // Define the name of the skin %skinName = \"BronzeGlasses\"; // Inform the GuiObjectView Control of the skin to use on the mounted model %thisGuiObjectViewCtrl.setMountSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the mounted model. +/// @param skinName Name of the skin to set on the model mounted to the main model in the control +/// @tsexample +/// // Define the name of the skin +/// %skinName = \"BronzeGlasses\"; +/// // Inform the GuiObjectView Control of the skin to use on the mounted model +/// %thisGuiObjectViewCtrl.setMountSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setMountSkin (string guiobjectview, string skinName) @@ -24009,7 +30383,17 @@ public void fnGuiObjectView_setMountSkin (string guiobjectview, string skinName) SafeNativeMethods.mwle_fnGuiObjectView_setMountSkin(sbguiobjectview, sbskinName); } /// -/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. Detailed description @param distance The distance to set the orbit to (will be clamped). @tsexample // Define the orbit distance value %orbitDistance = \"1.5\"; // Inform the GuiObjectView object to set the orbit distance to the defined value %thisGuiObjectView.setOrbitDistance(%orbitDistance); @endtsexample @see GuiControl) +/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. +/// Detailed description +/// @param distance The distance to set the orbit to (will be clamped). +/// @tsexample +/// // Define the orbit distance value +/// %orbitDistance = \"1.5\"; +/// // Inform the GuiObjectView object to set the orbit distance to the defined value +/// %thisGuiObjectView.setOrbitDistance(%orbitDistance); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setOrbitDistance (string guiobjectview, float distance) @@ -24023,7 +30407,18 @@ public void fnGuiObjectView_setOrbitDistance (string guiobjectview, float distan SafeNativeMethods.mwle_fnGuiObjectView_setOrbitDistance(sbguiobjectview, distance); } /// -/// @brief Sets the animation to play for the viewed object. @param indexOrName The index or name of the animation to play. @tsexample // Set the animation index value, or animation sequence name. %indexVal = \"3\"; //OR: %indexVal = \"idle\"; // Inform the GuiObjectView object to set the animation sequence of the object in the control. %thisGuiObjectVew.setSeq(%indexVal); @endtsexample @see GuiControl) +/// @brief Sets the animation to play for the viewed object. +/// @param indexOrName The index or name of the animation to play. +/// @tsexample +/// // Set the animation index value, or animation sequence name. +/// %indexVal = \"3\"; +/// //OR: +/// %indexVal = \"idle\"; +/// // Inform the GuiObjectView object to set the animation sequence of the object in the control. +/// %thisGuiObjectVew.setSeq(%indexVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setSeq (string guiobjectview, string indexOrName) @@ -24040,7 +30435,16 @@ public void fnGuiObjectView_setSeq (string guiobjectview, string indexOrName) SafeNativeMethods.mwle_fnGuiObjectView_setSeq(sbguiobjectview, sbindexOrName); } /// -/// @brief Sets the skin to use on the model being displayed. @param skinName Name of the skin to use. @tsexample // Define the skin we want to apply to the main model in the control %skinName = \"disco_gideon\"; // Inform the GuiObjectView control to update the skin the to defined skin %thisGuiObjectView.setSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the model being displayed. +/// @param skinName Name of the skin to use. +/// @tsexample +/// // Define the skin we want to apply to the main model in the control +/// %skinName = \"disco_gideon\"; +/// // Inform the GuiObjectView control to update the skin the to defined skin +/// %thisGuiObjectView.setSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setSkin (string guiobjectview, string skinName) @@ -24057,7 +30461,9 @@ public void fnGuiObjectView_setSkin (string guiobjectview, string skinName) SafeNativeMethods.mwle_fnGuiObjectView_setSkin(sbguiobjectview, sbskinName); } /// -/// Collapse or un-collapse the control. @param collapse True to collapse the control, false to un-collapse it ) +/// Collapse or un-collapse the control. +/// @param collapse True to collapse the control, false to un-collapse it ) +/// /// public void fnGuiPaneControl_setCollapsed (string guipanecontrol, bool collapse) @@ -24071,7 +30477,12 @@ public void fnGuiPaneControl_setCollapsed (string guipanecontrol, bool collapse) SafeNativeMethods.mwle_fnGuiPaneControl_setCollapsed(sbguipanecontrol, collapse); } /// -/// @brief Add a category to the list. Acts as a separator between entries, allowing for sub-lists @param text Name of the new category) +/// @brief Add a category to the list. +/// +/// Acts as a separator between entries, allowing for sub-lists +/// +/// @param text Name of the new category) +/// /// public void fnGuiPopUpMenuCtrlEx_addCategory (string guipopupmenuctrlex, string text) @@ -24088,7 +30499,12 @@ public void fnGuiPopUpMenuCtrlEx_addCategory (string guipopupmenuctrlex, string SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_addCategory(sbguipopupmenuctrlex, sbtext); } /// -/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. @param id Numerical id associated with this scheme @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. +/// @param id Numerical id associated with this scheme +/// @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// /// public void fnGuiPopUpMenuCtrlEx_addScheme (string guipopupmenuctrlex, int id, string fontColor, string fontColorHL, string fontColorSEL) @@ -24112,6 +30528,7 @@ public void fnGuiPopUpMenuCtrlEx_addScheme (string guipopupmenuctrlex, int id, s } /// /// @brief Clear the popup list.) +/// /// public void fnGuiPopUpMenuCtrlEx_clear (string guipopupmenuctrlex) @@ -24126,6 +30543,7 @@ public void fnGuiPopUpMenuCtrlEx_clear (string guipopupmenuctrlex) } /// /// @brief Manually force this control to collapse and close.) +/// /// public void fnGuiPopUpMenuCtrlEx_forceClose (string guipopupmenuctrlex) @@ -24140,6 +30558,7 @@ public void fnGuiPopUpMenuCtrlEx_forceClose (string guipopupmenuctrlex) } /// /// @brief Manually for the onAction function, which updates everything in this control.) +/// /// public void fnGuiPopUpMenuCtrlEx_forceOnAction (string guipopupmenuctrlex) @@ -24153,7 +30572,9 @@ public void fnGuiPopUpMenuCtrlEx_forceOnAction (string guipopupmenuctrlex) SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_forceOnAction(sbguipopupmenuctrlex); } /// -/// @brief Get the current selection of the menu. @return Returns the ID of the currently selected entry) +/// @brief Get the current selection of the menu. +/// @return Returns the ID of the currently selected entry) +/// /// public int fnGuiPopUpMenuCtrlEx_getSelected (string guipopupmenuctrlex) @@ -24167,7 +30588,19 @@ public int fnGuiPopUpMenuCtrlEx_getSelected (string guipopupmenuctrlex) return SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_getSelected(sbguipopupmenuctrlex); } /// -/// @brief Get the. Detailed description @param param Description @tsexample // Comment code(); @endtsexample @return Returns current text in string format) +/// @brief Get the. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Comment +/// code(); +/// @endtsexample +/// +/// @return Returns current text in string format) +/// /// public string fnGuiPopUpMenuCtrlEx_getText (string guipopupmenuctrlex) @@ -24184,7 +30617,10 @@ public string fnGuiPopUpMenuCtrlEx_getText (string guipopupmenuctrlex) } /// -/// @brief Get the text of an entry based on an ID. @param id The ID assigned to the entry being queried @return String contained by the specified entry, NULL if empty or bad ID) +/// @brief Get the text of an entry based on an ID. +/// @param id The ID assigned to the entry being queried +/// @return String contained by the specified entry, NULL if empty or bad ID) +/// /// public string fnGuiPopUpMenuCtrlEx_getTextById (string guipopupmenuctrlex, int id) @@ -24202,6 +30638,7 @@ public string fnGuiPopUpMenuCtrlEx_getTextById (string guipopupmenuctrlex, int i } /// /// @brief Clears selection in the menu.) +/// /// public void fnGuiPopUpMenuCtrlEx_setNoneSelected (string guipopupmenuctrlex, int param) @@ -24215,7 +30652,9 @@ public void fnGuiPopUpMenuCtrlEx_setNoneSelected (string guipopupmenuctrlex, int SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_setNoneSelected(sbguipopupmenuctrlex, param); } /// -/// @brief Set the current text to a specified value. @param text String containing new text to set) +/// @brief Set the current text to a specified value. +/// @param text String containing new text to set) +/// /// public void fnGuiPopUpMenuCtrlEx_setText (string guipopupmenuctrlex, string text) @@ -24233,6 +30672,7 @@ public void fnGuiPopUpMenuCtrlEx_setText (string guipopupmenuctrlex, string text } /// /// @brief Sort the list alphabetically.) +/// /// public void fnGuiPopUpMenuCtrlEx_sort (string guipopupmenuctrlex) @@ -24247,6 +30687,7 @@ public void fnGuiPopUpMenuCtrlEx_sort (string guipopupmenuctrlex) } /// /// @brief Sort the list by ID.) +/// /// public void fnGuiPopUpMenuCtrlEx_sortID (string guipopupmenuctrlex) @@ -24260,7 +30701,11 @@ public void fnGuiPopUpMenuCtrlEx_sortID (string guipopupmenuctrlex) SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_sortID(sbguipopupmenuctrlex); } /// -/// Set the bitmap to use for rendering the progress bar. @param filename ~Path to the bitmap file. @note Directly assign to #bitmap rather than using this method. @see GuiProgressBitmapCtrl::setBitmap ) +/// Set the bitmap to use for rendering the progress bar. +/// @param filename ~Path to the bitmap file. +/// @note Directly assign to #bitmap rather than using this method. +/// @see GuiProgressBitmapCtrl::setBitmap ) +/// /// public void fnGuiProgressBitmapCtrl_setBitmap (string guiprogressbitmapctrl, string filename) @@ -24277,7 +30722,9 @@ public void fnGuiProgressBitmapCtrl_setBitmap (string guiprogressbitmapctrl, str SafeNativeMethods.mwle_fnGuiProgressBitmapCtrl_setBitmap(sbguiprogressbitmapctrl, sbfilename); } /// -/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. +/// @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// /// public void fnGuiRolloutCtrl_collapse (string guirolloutctrl) @@ -24291,7 +30738,9 @@ public void fnGuiRolloutCtrl_collapse (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_collapse(sbguirolloutctrl); } /// -/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. +/// @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// /// public void fnGuiRolloutCtrl_expand (string guirolloutctrl) @@ -24306,6 +30755,7 @@ public void fnGuiRolloutCtrl_expand (string guirolloutctrl) } /// /// Instantly collapse the rollout without animation. To smoothly slide the rollout to collapsed state, use collapse(). ) +/// /// public void fnGuiRolloutCtrl_instantCollapse (string guirolloutctrl) @@ -24320,6 +30770,7 @@ public void fnGuiRolloutCtrl_instantCollapse (string guirolloutctrl) } /// /// Instantly expand the rollout without animation. To smoothly slide the rollout to expanded state, use expand(). ) +/// /// public void fnGuiRolloutCtrl_instantExpand (string guirolloutctrl) @@ -24333,7 +30784,9 @@ public void fnGuiRolloutCtrl_instantExpand (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_instantExpand(sbguirolloutctrl); } /// -/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. @return True if the rollout is expanded, false if not. ) +/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. +/// @return True if the rollout is expanded, false if not. ) +/// /// public bool fnGuiRolloutCtrl_isExpanded (string guirolloutctrl) @@ -24347,7 +30800,9 @@ public bool fnGuiRolloutCtrl_isExpanded (string guirolloutctrl) return SafeNativeMethods.mwle_fnGuiRolloutCtrl_isExpanded(sbguirolloutctrl)>=1; } /// -/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of the rollout size. ) +/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of +/// the rollout size. ) +/// /// public void fnGuiRolloutCtrl_sizeToContents (string guirolloutctrl) @@ -24361,7 +30816,9 @@ public void fnGuiRolloutCtrl_sizeToContents (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_sizeToContents(sbguirolloutctrl); } /// -/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. ) +/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. ) +/// /// public void fnGuiRolloutCtrl_toggleCollapse (string guirolloutctrl) @@ -24375,7 +30832,11 @@ public void fnGuiRolloutCtrl_toggleCollapse (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_toggleCollapse(sbguirolloutctrl); } /// -/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will smoothly slide into the opposite state. ) +/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. +/// @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will +/// smoothly slide into the opposite state. ) +/// /// public void fnGuiRolloutCtrl_toggleExpanded (string guirolloutctrl, bool instantly) @@ -24390,6 +30851,7 @@ public void fnGuiRolloutCtrl_toggleExpanded (string guirolloutctrl, bool instant } /// /// Refresh sizing and positioning of child controls. ) +/// /// public void fnGuiScrollCtrl_computeSizes (string guiscrollctrl) @@ -24403,7 +30865,9 @@ public void fnGuiScrollCtrl_computeSizes (string guiscrollctrl) SafeNativeMethods.mwle_fnGuiScrollCtrl_computeSizes(sbguiscrollctrl); } /// -/// Get the current coordinates of the scrolled content. @return The current position of the scrolled content. ) +/// Get the current coordinates of the scrolled content. +/// @return The current position of the scrolled content. ) +/// /// public string fnGuiScrollCtrl_getScrollPosition (string guiscrollctrl) @@ -24420,7 +30884,9 @@ public string fnGuiScrollCtrl_getScrollPosition (string guiscrollctrl) } /// -/// Get the current X coordinate of the scrolled content. @return The current X coordinate of the scrolled content. ) +/// Get the current X coordinate of the scrolled content. +/// @return The current X coordinate of the scrolled content. ) +/// /// public int fnGuiScrollCtrl_getScrollPositionX (string guiscrollctrl) @@ -24434,7 +30900,9 @@ public int fnGuiScrollCtrl_getScrollPositionX (string guiscrollctrl) return SafeNativeMethods.mwle_fnGuiScrollCtrl_getScrollPositionX(sbguiscrollctrl); } /// -/// Get the current Y coordinate of the scrolled content. @return The current Y coordinate of the scrolled content. ) +/// Get the current Y coordinate of the scrolled content. +/// @return The current Y coordinate of the scrolled content. ) +/// /// public int fnGuiScrollCtrl_getScrollPositionY (string guiscrollctrl) @@ -24449,6 +30917,7 @@ public int fnGuiScrollCtrl_getScrollPositionY (string guiscrollctrl) } /// /// Scroll all the way to the bottom of the vertical scrollbar and the left of the horizontal bar. ) +/// /// public void fnGuiScrollCtrl_scrollToBottom (string guiscrollctrl) @@ -24462,7 +30931,9 @@ public void fnGuiScrollCtrl_scrollToBottom (string guiscrollctrl) SafeNativeMethods.mwle_fnGuiScrollCtrl_scrollToBottom(sbguiscrollctrl); } /// -/// Scroll the control so that the given child @a control is visible. @param control A child control. ) +/// Scroll the control so that the given child @a control is visible. +/// @param control A child control. ) +/// /// public void fnGuiScrollCtrl_scrollToObject (string guiscrollctrl, string control) @@ -24480,6 +30951,7 @@ public void fnGuiScrollCtrl_scrollToObject (string guiscrollctrl, string control } /// /// Scroll all the way to the top of the vertical and left of the horizontal scrollbar. ) +/// /// public void fnGuiScrollCtrl_scrollToTop (string guiscrollctrl) @@ -24493,7 +30965,10 @@ public void fnGuiScrollCtrl_scrollToTop (string guiscrollctrl) SafeNativeMethods.mwle_fnGuiScrollCtrl_scrollToTop(sbguiscrollctrl); } /// -/// Set the position of the scrolled content. @param x Position on X axis. @param y Position on y axis. ) +/// Set the position of the scrolled content. +/// @param x Position on X axis. +/// @param y Position on y axis. ) +/// /// public void fnGuiScrollCtrl_setScrollPosition (string guiscrollctrl, int x, int y) @@ -24508,6 +30983,7 @@ public void fnGuiScrollCtrl_setScrollPosition (string guiscrollctrl, int x, int } /// /// Add a new thread (initially without any sequence set) ) +/// /// public void fnGuiShapeEdPreview_addThread (string guishapeedpreview) @@ -24521,7 +30997,9 @@ public void fnGuiShapeEdPreview_addThread (string guishapeedpreview) SafeNativeMethods.mwle_fnGuiShapeEdPreview_addThread(sbguishapeedpreview); } /// -/// Compute the bounding box of the shape using the current detail and node transforms @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// Compute the bounding box of the shape using the current detail and node transforms +/// @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// /// public string fnGuiShapeEdPreview_computeShapeBounds (string guishapeedpreview) @@ -24538,7 +31016,11 @@ public string fnGuiShapeEdPreview_computeShapeBounds (string guishapeedpreview) } /// -/// Export the current shape and all mounted objects to COLLADA (.dae). Note that animation is not exported, and all geometry is combined into a single mesh. @param path Destination filename ) +/// Export the current shape and all mounted objects to COLLADA (.dae). +/// Note that animation is not exported, and all geometry is combined into a +/// single mesh. +/// @param path Destination filename ) +/// /// public void fnGuiShapeEdPreview_exportToCollada (string guishapeedpreview, string path) @@ -24556,6 +31038,7 @@ public void fnGuiShapeEdPreview_exportToCollada (string guishapeedpreview, strin } /// /// Adjust the camera position and zoom to fit the shape within the view. ) +/// /// public void fnGuiShapeEdPreview_fitToShape (string guishapeedpreview) @@ -24570,6 +31053,7 @@ public void fnGuiShapeEdPreview_fitToShape (string guishapeedpreview) } /// /// Return whether the named object is currently hidden ) +/// /// public bool fnGuiShapeEdPreview_getMeshHidden (string guishapeedpreview, string name) @@ -24586,7 +31070,10 @@ public bool fnGuiShapeEdPreview_getMeshHidden (string guishapeedpreview, string return SafeNativeMethods.mwle_fnGuiShapeEdPreview_getMeshHidden(sbguishapeedpreview, sbname)>=1; } /// -/// Get the playback direction of the sequence playing on this mounted shape @param slot mounted shape slot @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// Get the playback direction of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// /// public float fnGuiShapeEdPreview_getMountThreadDir (string guishapeedpreview, int slot) @@ -24600,7 +31087,10 @@ public float fnGuiShapeEdPreview_getMountThreadDir (string guishapeedpreview, in return SafeNativeMethods.mwle_fnGuiShapeEdPreview_getMountThreadDir(sbguishapeedpreview, slot); } /// -/// Get the playback position of the sequence playing on this mounted shape @param slot mounted shape slot @return playback position of the sequence (0-1) ) +/// Get the playback position of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return playback position of the sequence (0-1) ) +/// /// public float fnGuiShapeEdPreview_getMountThreadPos (string guishapeedpreview, int slot) @@ -24614,7 +31104,10 @@ public float fnGuiShapeEdPreview_getMountThreadPos (string guishapeedpreview, in return SafeNativeMethods.mwle_fnGuiShapeEdPreview_getMountThreadPos(sbguishapeedpreview, slot); } /// -/// Get the name of the sequence playing on this mounted shape @param slot mounted shape slot @return name of the sequence (if any) ) +/// Get the name of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return name of the sequence (if any) ) +/// /// public string fnGuiShapeEdPreview_getMountThreadSequence (string guishapeedpreview, int slot) @@ -24631,7 +31124,9 @@ public string fnGuiShapeEdPreview_getMountThreadSequence (string guishapeedprevi } /// -/// Get the number of threads @return the number of threads ) +/// Get the number of threads +/// @return the number of threads ) +/// /// public int fnGuiShapeEdPreview_getThreadCount (string guishapeedpreview) @@ -24646,6 +31141,7 @@ public int fnGuiShapeEdPreview_getThreadCount (string guishapeedpreview) } /// /// Get the name of the sequence assigned to the active thread ) +/// /// public string fnGuiShapeEdPreview_getThreadSequence (string guishapeedpreview) @@ -24662,7 +31158,12 @@ public string fnGuiShapeEdPreview_getThreadSequence (string guishapeedpreview) } /// -/// Mount a shape onto the main shape at the specified node @param shapePath path to the shape to mount @param nodeName name of the node on the main shape to mount to @param type type of mounting to use (Object, Image or Wheel) @param slot mount slot ) +/// Mount a shape onto the main shape at the specified node +/// @param shapePath path to the shape to mount +/// @param nodeName name of the node on the main shape to mount to +/// @param type type of mounting to use (Object, Image or Wheel) +/// @param slot mount slot ) +/// /// public bool fnGuiShapeEdPreview_mountShape (string guishapeedpreview, string shapePath, string nodeName, string type, int slot) @@ -24686,6 +31187,7 @@ public bool fnGuiShapeEdPreview_mountShape (string guishapeedpreview, string sha } /// /// Refresh the shape (used when the shape meshes or nodes have been added or removed) ) +/// /// public void fnGuiShapeEdPreview_refreshShape (string guishapeedpreview) @@ -24700,6 +31202,7 @@ public void fnGuiShapeEdPreview_refreshShape (string guishapeedpreview) } /// /// Refreshes thread sequences (in case of removed/renamed sequences ) +/// /// public void fnGuiShapeEdPreview_refreshThreadSequences (string guishapeedpreview) @@ -24713,7 +31216,9 @@ public void fnGuiShapeEdPreview_refreshThreadSequences (string guishapeedpreview SafeNativeMethods.mwle_fnGuiShapeEdPreview_refreshThreadSequences(sbguishapeedpreview); } /// -/// Removes the specifed thread @param slot index of the thread to remove ) +/// Removes the specifed thread +/// @param slot index of the thread to remove ) +/// /// public void fnGuiShapeEdPreview_removeThread (string guishapeedpreview, int slot) @@ -24728,6 +31233,7 @@ public void fnGuiShapeEdPreview_removeThread (string guishapeedpreview, int slot } /// /// Show or hide all objects in the shape ) +/// /// public void fnGuiShapeEdPreview_setAllMeshesHidden (string guishapeedpreview, bool hidden) @@ -24742,6 +31248,7 @@ public void fnGuiShapeEdPreview_setAllMeshesHidden (string guishapeedpreview, bo } /// /// Show or hide the named object in the shape ) +/// /// public void fnGuiShapeEdPreview_setMeshHidden (string guishapeedpreview, string name, bool hidden) @@ -24758,7 +31265,10 @@ public void fnGuiShapeEdPreview_setMeshHidden (string guishapeedpreview, string SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMeshHidden(sbguishapeedpreview, sbname, hidden); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display. @return True if the model was loaded successfully, false otherwise. ) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display. +/// @return True if the model was loaded successfully, false otherwise. ) +/// /// public bool fnGuiShapeEdPreview_setModel (string guishapeedpreview, string shapePath) @@ -24775,7 +31285,10 @@ public bool fnGuiShapeEdPreview_setModel (string guishapeedpreview, string shape return SafeNativeMethods.mwle_fnGuiShapeEdPreview_setModel(sbguishapeedpreview, sbshapePath)>=1; } /// -/// Set the node a shape is mounted to. @param slot mounted shape slot @param nodename name of the node to mount to ) +/// Set the node a shape is mounted to. +/// @param slot mounted shape slot +/// @param nodename name of the node to mount to ) +/// /// public void fnGuiShapeEdPreview_setMountNode (string guishapeedpreview, int slot, string nodeName) @@ -24792,7 +31305,10 @@ public void fnGuiShapeEdPreview_setMountNode (string guishapeedpreview, int slot SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountNode(sbguishapeedpreview, slot, sbnodeName); } /// -/// Set the playback direction of the shape mounted in the specified slot @param slot mounted shape slot @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// Set the playback direction of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// /// public void fnGuiShapeEdPreview_setMountThreadDir (string guishapeedpreview, int slot, float dir) @@ -24806,7 +31322,10 @@ public void fnGuiShapeEdPreview_setMountThreadDir (string guishapeedpreview, int SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountThreadDir(sbguishapeedpreview, slot, dir); } /// -/// Set the sequence position of the shape mounted in the specified slot @param slot mounted shape slot @param pos sequence position (0-1) ) +/// Set the sequence position of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param pos sequence position (0-1) ) +/// /// public void fnGuiShapeEdPreview_setMountThreadPos (string guishapeedpreview, int slot, float pos) @@ -24820,7 +31339,10 @@ public void fnGuiShapeEdPreview_setMountThreadPos (string guishapeedpreview, int SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountThreadPos(sbguishapeedpreview, slot, pos); } /// -/// Set the sequence to play for the shape mounted in the specified slot @param slot mounted shape slot @param name name of the sequence to play ) +/// Set the sequence to play for the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param name name of the sequence to play ) +/// /// public void fnGuiShapeEdPreview_setMountThreadSequence (string guishapeedpreview, int slot, string name) @@ -24837,7 +31359,9 @@ public void fnGuiShapeEdPreview_setMountThreadSequence (string guishapeedpreview SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountThreadSequence(sbguishapeedpreview, slot, sbname); } /// -/// Set the camera orbit position @param pos Position in the form \"x y z\" ) +/// Set the camera orbit position +/// @param pos Position in the form \"x y z\" ) +/// /// public void fnGuiShapeEdPreview_setOrbitPos (string guishapeedpreview, string pos) @@ -24854,7 +31378,12 @@ public void fnGuiShapeEdPreview_setOrbitPos (string guishapeedpreview, string po SafeNativeMethods.mwle_fnGuiShapeEdPreview_setOrbitPos(sbguishapeedpreview, sbpos); } /// -/// Sets the sequence to play for the active thread. @param name name of the sequence to play @param duration transition duration (0 for no transition) @param pos position in the new sequence to transition to @param play if true, the new sequence will play during the transition ) +/// Sets the sequence to play for the active thread. +/// @param name name of the sequence to play +/// @param duration transition duration (0 for no transition) +/// @param pos position in the new sequence to transition to +/// @param play if true, the new sequence will play during the transition ) +/// /// public void fnGuiShapeEdPreview_setThreadSequence (string guishapeedpreview, string name, float duration, float pos, bool play) @@ -24871,7 +31400,9 @@ public void fnGuiShapeEdPreview_setThreadSequence (string guishapeedpreview, str SafeNativeMethods.mwle_fnGuiShapeEdPreview_setThreadSequence(sbguishapeedpreview, sbname, duration, pos, play); } /// -/// Set the time scale of all threads @param scale new time scale value ) +/// Set the time scale of all threads +/// @param scale new time scale value ) +/// /// public void fnGuiShapeEdPreview_setTimeScale (string guishapeedpreview, float scale) @@ -24886,6 +31417,7 @@ public void fnGuiShapeEdPreview_setTimeScale (string guishapeedpreview, float sc } /// /// Unmount all shapes ) +/// /// public void fnGuiShapeEdPreview_unmountAll (string guishapeedpreview) @@ -24899,7 +31431,9 @@ public void fnGuiShapeEdPreview_unmountAll (string guishapeedpreview) SafeNativeMethods.mwle_fnGuiShapeEdPreview_unmountAll(sbguishapeedpreview); } /// -/// Unmount the shape in the specified slot @param slot mounted shape slot ) +/// Unmount the shape in the specified slot +/// @param slot mounted shape slot ) +/// /// public void fnGuiShapeEdPreview_unmountShape (string guishapeedpreview, int slot) @@ -24914,6 +31448,7 @@ public void fnGuiShapeEdPreview_unmountShape (string guishapeedpreview, int slot } /// /// Refresh the shape node transforms (used when a node transform has been modified externally) ) +/// /// public void fnGuiShapeEdPreview_updateNodeTransforms (string guishapeedpreview) @@ -24927,7 +31462,9 @@ public void fnGuiShapeEdPreview_updateNodeTransforms (string guishapeedpreview) SafeNativeMethods.mwle_fnGuiShapeEdPreview_updateNodeTransforms(sbguishapeedpreview); } /// -/// Get the current value of the slider based on the position of the thumb. @return Slider position (from range.x to range.y). ) +/// Get the current value of the slider based on the position of the thumb. +/// @return Slider position (from range.x to range.y). ) +/// /// public float fnGuiSliderCtrl_getValue (string guisliderctrl) @@ -24941,7 +31478,10 @@ public float fnGuiSliderCtrl_getValue (string guisliderctrl) return SafeNativeMethods.mwle_fnGuiSliderCtrl_getValue(sbguisliderctrl); } /// -/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful for scrubbing type sliders where the slider position is sync'd to a changing value. When the user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful +/// for scrubbing type sliders where the slider position is sync'd to a changing value. When the +/// user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// /// public bool fnGuiSliderCtrl_isThumbBeingDragged (string guisliderctrl) @@ -24955,7 +31495,10 @@ public bool fnGuiSliderCtrl_isThumbBeingDragged (string guisliderctrl) return SafeNativeMethods.mwle_fnGuiSliderCtrl_isThumbBeingDragged(sbguisliderctrl)>=1; } /// -/// Set position of the thumb on the slider. @param pos New slider position (from range.x to range.y) @param doCallback If true, the altCommand callback will be invoked ) +/// Set position of the thumb on the slider. +/// @param pos New slider position (from range.x to range.y) +/// @param doCallback If true, the altCommand callback will be invoked ) +/// /// public void fnGuiSliderCtrl_setValue (string guisliderctrl, float pos, bool doCallback) @@ -24969,7 +31512,14 @@ public void fnGuiSliderCtrl_setValue (string guisliderctrl, float pos, bool doCa SafeNativeMethods.mwle_fnGuiSliderCtrl_setValue(sbguisliderctrl, pos, doCallback); } /// -/// Prevents control from restacking - useful when adding or removing child controls @param freeze True to freeze the control, false to unfreeze it @tsexample %stackCtrl.freeze(true); // add controls to stack %stackCtrl.freeze(false); @endtsexample ) +/// Prevents control from restacking - useful when adding or removing child controls +/// @param freeze True to freeze the control, false to unfreeze it +/// @tsexample +/// %stackCtrl.freeze(true); +/// // add controls to stack +/// %stackCtrl.freeze(false); +/// @endtsexample ) +/// /// public void fnGuiStackControl_freeze (string guistackcontrol, bool freeze) @@ -24984,6 +31534,7 @@ public void fnGuiStackControl_freeze (string guistackcontrol, bool freeze) } /// /// Return whether or not this control is frozen ) +/// /// public bool fnGuiStackControl_isFrozen (string guistackcontrol) @@ -24998,6 +31549,7 @@ public bool fnGuiStackControl_isFrozen (string guistackcontrol) } /// /// Restack the child controls. ) +/// /// public void fnGuiStackControl_updateStack (string guistackcontrol) @@ -25011,7 +31563,11 @@ public void fnGuiStackControl_updateStack (string guistackcontrol) SafeNativeMethods.mwle_fnGuiStackControl_updateStack(sbguistackcontrol); } /// -/// Set the color of the swatch control. @param newColor The new color string given to the swatch control in float format \"r g b a\". @note It's also important to note that when setColor is called causes the control's altCommand field to be executed. ) +/// Set the color of the swatch control. +/// @param newColor The new color string given to the swatch control in float format \"r g b a\". +/// @note It's also important to note that when setColor is called causes +/// the control's altCommand field to be executed. ) +/// /// public void fnGuiSwatchButtonCtrl_setColor (string guiswatchbuttonctrl, string newColor) @@ -25028,7 +31584,10 @@ public void fnGuiSwatchButtonCtrl_setColor (string guiswatchbuttonctrl, string n SafeNativeMethods.mwle_fnGuiSwatchButtonCtrl_setColor(sbguiswatchbuttonctrl, sbnewColor); } /// -/// ), Add a new tab page to the control. @param title Title text for the tab page header. ) +/// ), +/// Add a new tab page to the control. +/// @param title Title text for the tab page header. ) +/// /// public void fnGuiTabBookCtrl_addPage (string guitabbookctrl, string title) @@ -25045,7 +31604,9 @@ public void fnGuiTabBookCtrl_addPage (string guitabbookctrl, string title) SafeNativeMethods.mwle_fnGuiTabBookCtrl_addPage(sbguitabbookctrl, sbtitle); } /// -/// Get the index of the currently selected tab page. @return Index of the selected tab page or -1 if no tab page is selected. ) +/// Get the index of the currently selected tab page. +/// @return Index of the selected tab page or -1 if no tab page is selected. ) +/// /// public int fnGuiTabBookCtrl_getSelectedPage (string guitabbookctrl) @@ -25059,7 +31620,9 @@ public int fnGuiTabBookCtrl_getSelectedPage (string guitabbookctrl) return SafeNativeMethods.mwle_fnGuiTabBookCtrl_getSelectedPage(sbguitabbookctrl); } /// -/// Set the selected tab page. @param index Index of the tab page. ) +/// Set the selected tab page. +/// @param index Index of the tab page. ) +/// /// public void fnGuiTabBookCtrl_selectPage (string guitabbookctrl, int index) @@ -25201,6 +31764,7 @@ public void fnGuiTableControl_setSelectedRow (string guitablecontrol, int rowNum } /// /// Select this page in its tab book. ) +/// /// public void fnGuiTabPageCtrl_select (string guitabpagectrl) @@ -25214,7 +31778,16 @@ public void fnGuiTabPageCtrl_select (string guitabpagectrl) SafeNativeMethods.mwle_fnGuiTabPageCtrl_select(sbguitabpagectrl); } /// -/// @brief Sets the text in the control. @param text Text to display in the control. @tsexample // Set the text to show in the control %text = \"Gideon - Destroyer of World\"; // Inform the GuiTextCtrl control to change its text to the defined value %thisGuiTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to display in the control. +/// @tsexample +/// // Set the text to show in the control +/// %text = \"Gideon - Destroyer of World\"; +/// // Inform the GuiTextCtrl control to change its text to the defined value +/// %thisGuiTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextCtrl_setText (string guitextctrl, string text) @@ -25231,7 +31804,15 @@ public void fnGuiTextCtrl_setText (string guitextctrl, string text) SafeNativeMethods.mwle_fnGuiTextCtrl_setText(sbguitextctrl, sbtext); } /// -/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. @param textID Name of variable text should be mapped to @tsexample // Inform the GuiTextCtrl control of the textID to use %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); @endtsexample @see GuiControl @see Localization) +/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. +/// @param textID Name of variable text should be mapped to +/// @tsexample +/// // Inform the GuiTextCtrl control of the textID to use +/// %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); +/// @endtsexample +/// @see GuiControl +/// @see Localization) +/// /// public void fnGuiTextCtrl_setTextID (string guitextctrl, string textID) @@ -25248,7 +31829,13 @@ public void fnGuiTextCtrl_setTextID (string guitextctrl, string textID) SafeNativeMethods.mwle_fnGuiTextCtrl_setTextID(sbguitextctrl, sbtextID); } /// -/// @brief Unselects all selected text in the control. @tsexample // Inform the control to unselect all of its selected text %thisGuiTextEditCtrl.clearSelectedText(); @endtsexample @see GuiControl) +/// @brief Unselects all selected text in the control. +/// @tsexample +/// // Inform the control to unselect all of its selected text +/// %thisGuiTextEditCtrl.clearSelectedText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_clearSelectedText (string guitexteditctrl) @@ -25262,7 +31849,13 @@ public void fnGuiTextEditCtrl_clearSelectedText (string guitexteditctrl) SafeNativeMethods.mwle_fnGuiTextEditCtrl_clearSelectedText(sbguitexteditctrl); } /// -/// @brief Force a validation to occur. @tsexample // Inform the control to force a validation of its text. %thisGuiTextEditCtrl.forceValidateText(); @endtsexample @see GuiControl) +/// @brief Force a validation to occur. +/// @tsexample +/// // Inform the control to force a validation of its text. +/// %thisGuiTextEditCtrl.forceValidateText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_forceValidateText (string guitexteditctrl) @@ -25276,7 +31869,14 @@ public void fnGuiTextEditCtrl_forceValidateText (string guitexteditctrl) SafeNativeMethods.mwle_fnGuiTextEditCtrl_forceValidateText(sbguitexteditctrl); } /// -/// @brief Returns the current position of the text cursor in the control. @tsexample // Acquire the cursor position in the control %position = %thisGuiTextEditCtrl.getCursorPost(); @endtsexample @return Text cursor position within the control. @see GuiControl) +/// @brief Returns the current position of the text cursor in the control. +/// @tsexample +/// // Acquire the cursor position in the control +/// %position = %thisGuiTextEditCtrl.getCursorPost(); +/// @endtsexample +/// @return Text cursor position within the control. +/// @see GuiControl) +/// /// public int fnGuiTextEditCtrl_getCursorPos (string guitexteditctrl) @@ -25290,7 +31890,14 @@ public int fnGuiTextEditCtrl_getCursorPos (string guitexteditctrl) return SafeNativeMethods.mwle_fnGuiTextEditCtrl_getCursorPos(sbguitexteditctrl); } /// -/// @brief Acquires the current text displayed in this control. @tsexample // Acquire the value of the text control. %text = %thisGuiTextEditCtrl.getText(); @endtsexample @return The current text within the control. @see GuiControl) +/// @brief Acquires the current text displayed in this control. +/// @tsexample +/// // Acquire the value of the text control. +/// %text = %thisGuiTextEditCtrl.getText(); +/// @endtsexample +/// @return The current text within the control. +/// @see GuiControl) +/// /// public string fnGuiTextEditCtrl_getText (string guitexteditctrl) @@ -25307,7 +31914,14 @@ public string fnGuiTextEditCtrl_getText (string guitexteditctrl) } /// -/// @brief Checks to see if all text in the control has been selected. @tsexample // Check to see if all text has been selected or not. %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); @endtsexample @return True if all text in the control is selected, otherwise false. @see GuiControl) +/// @brief Checks to see if all text in the control has been selected. +/// @tsexample +/// // Check to see if all text has been selected or not. +/// %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); +/// @endtsexample +/// @return True if all text in the control is selected, otherwise false. +/// @see GuiControl) +/// /// public bool fnGuiTextEditCtrl_isAllTextSelected (string guitexteditctrl) @@ -25321,7 +31935,13 @@ public bool fnGuiTextEditCtrl_isAllTextSelected (string guitexteditctrl) return SafeNativeMethods.mwle_fnGuiTextEditCtrl_isAllTextSelected(sbguitexteditctrl)>=1; } /// -/// @brief Selects all text within the control. @tsexample // Inform the control to select all of its text. %thisGuiTextEditCtrl.selectAllText(); @endtsexample @see GuiControl) +/// @brief Selects all text within the control. +/// @tsexample +/// // Inform the control to select all of its text. +/// %thisGuiTextEditCtrl.selectAllText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_selectAllText (string guitexteditctrl) @@ -25335,7 +31955,16 @@ public void fnGuiTextEditCtrl_selectAllText (string guitexteditctrl) SafeNativeMethods.mwle_fnGuiTextEditCtrl_selectAllText(sbguitexteditctrl); } /// -/// @brief Sets the text cursor at the defined position within the control. @param position Text position to set the text cursor. @tsexample // Define the cursor position %position = \"12\"; // Inform the GuiTextEditCtrl control to place the text cursor at the defined position %thisGuiTextEditCtrl.setCursorPos(%position); @endtsexample @see GuiControl) +/// @brief Sets the text cursor at the defined position within the control. +/// @param position Text position to set the text cursor. +/// @tsexample +/// // Define the cursor position +/// %position = \"12\"; +/// // Inform the GuiTextEditCtrl control to place the text cursor at the defined position +/// %thisGuiTextEditCtrl.setCursorPos(%position); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_setCursorPos (string guitexteditctrl, int position) @@ -25349,7 +31978,16 @@ public void fnGuiTextEditCtrl_setCursorPos (string guitexteditctrl, int position SafeNativeMethods.mwle_fnGuiTextEditCtrl_setCursorPos(sbguitexteditctrl, position); } /// -/// @brief Sets the text in the control. @param text Text to place in the control. @tsexample // Define the text to display %text = \"Text!\" // Inform the GuiTextEditCtrl to display the defined text %thisGuiTextEditCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to place in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Text!\" +/// // Inform the GuiTextEditCtrl to display the defined text +/// %thisGuiTextEditCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_setText (string guitexteditctrl, string text) @@ -25366,7 +32004,25 @@ public void fnGuiTextEditCtrl_setText (string guitexteditctrl, string text) SafeNativeMethods.mwle_fnGuiTextEditCtrl_setText(sbguitexteditctrl, sbtext); } /// -/// ,-1), @brief Adds a new row at end of the list with the defined id and text. If index is used, then the new row is inserted at the row location of 'index'. @param id Id of the new row. @param text Text to display at the new row. @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. @tsexample // Define the id %id = \"4\"; // Define the text to display %text = \"Display Text\" // Define the index (optional) %index = \"2\" // Inform the GuiTextListCtrl control to add the new row with the defined information. %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); @endtsexample @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. @see References) +/// ,-1), +/// @brief Adds a new row at end of the list with the defined id and text. +/// If index is used, then the new row is inserted at the row location of 'index'. +/// @param id Id of the new row. +/// @param text Text to display at the new row. +/// @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text to display +/// %text = \"Display Text\" +/// // Define the index (optional) +/// %index = \"2\" +/// // Inform the GuiTextListCtrl control to add the new row with the defined information. +/// %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); +/// @endtsexample +/// @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. +/// @see References) +/// /// public int fnGuiTextListCtrl_addRow (string guitextlistctrl, int id, string text, int index) @@ -25383,7 +32039,13 @@ public int fnGuiTextListCtrl_addRow (string guitextlistctrl, int id, string text return SafeNativeMethods.mwle_fnGuiTextListCtrl_addRow(sbguitextlistctrl, id, sbtext, index); } /// -/// @brief Clear the list. @tsexample // Inform the GuiTextListCtrl control to clear its contents %thisGuiTextListCtrl.clear(); @endtsexample @see GuiControl) +/// @brief Clear the list. +/// @tsexample +/// // Inform the GuiTextListCtrl control to clear its contents +/// %thisGuiTextListCtrl.clear(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_clear (string guitextlistctrl) @@ -25397,7 +32059,13 @@ public void fnGuiTextListCtrl_clear (string guitextlistctrl) SafeNativeMethods.mwle_fnGuiTextListCtrl_clear(sbguitextlistctrl); } /// -/// @brief Set the selection to nothing. @tsexample // Deselect anything that is currently selected %thisGuiTextListCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Set the selection to nothing. +/// @tsexample +/// // Deselect anything that is currently selected +/// %thisGuiTextListCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_clearSelection (string guitextlistctrl) @@ -25412,6 +32080,7 @@ public void fnGuiTextListCtrl_clearSelection (string guitextlistctrl) } /// /// ) +/// /// public int fnGuiTextListCtrl_findColumnTextIndex (string guitextlistctrl, int columnId, string columnText) @@ -25428,7 +32097,17 @@ public int fnGuiTextListCtrl_findColumnTextIndex (string guitextlistctrl, int co return SafeNativeMethods.mwle_fnGuiTextListCtrl_findColumnTextIndex(sbguitextlistctrl, columnId, sbcolumnText); } /// -/// @brief Find needle in the list, and return the row number it was found in. @param needle Text to find in the list. @tsexample // Define the text to find in the list %needle = \"Text To Find\"; // Request the row number that contains the defined text to find %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); @endtsexample @return Row number that the defined text was found in, @see GuiControl) +/// @brief Find needle in the list, and return the row number it was found in. +/// @param needle Text to find in the list. +/// @tsexample +/// // Define the text to find in the list +/// %needle = \"Text To Find\"; +/// // Request the row number that contains the defined text to find +/// %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); +/// @endtsexample +/// @return Row number that the defined text was found in, +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_findTextIndex (string guitextlistctrl, string needle) @@ -25445,7 +32124,17 @@ public int fnGuiTextListCtrl_findTextIndex (string guitextlistctrl, string needl return SafeNativeMethods.mwle_fnGuiTextListCtrl_findTextIndex(sbguitextlistctrl, sbneedle); } /// -/// @brief Get the row ID for an index. @param index Index to get the RowID at @tsexample // Define the index %index = \"3\"; // Request the row ID at the defined index %rowId = %thisGuiTextListCtrl.getRowId(%index); @endtsexample @return RowId at the defined index. @see GuiControl) +/// @brief Get the row ID for an index. +/// @param index Index to get the RowID at +/// @tsexample +/// // Define the index +/// %index = \"3\"; +/// // Request the row ID at the defined index +/// %rowId = %thisGuiTextListCtrl.getRowId(%index); +/// @endtsexample +/// @return RowId at the defined index. +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getRowId (string guitextlistctrl, int index) @@ -25459,7 +32148,16 @@ public int fnGuiTextListCtrl_getRowId (string guitextlistctrl, int index) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getRowId(sbguitextlistctrl, index); } /// -/// @brief Get the row number for a specified id. @param id Id to get the row number at @tsexample // Define the id %id = \"4\"; // Request the row number from the GuiTextListCtrl control at the defined id. %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); @endtsexample @see GuiControl) +/// @brief Get the row number for a specified id. +/// @param id Id to get the row number at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Request the row number from the GuiTextListCtrl control at the defined id. +/// %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getRowNumById (string guitextlistctrl, int id) @@ -25473,7 +32171,17 @@ public int fnGuiTextListCtrl_getRowNumById (string guitextlistctrl, int id) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getRowNumById(sbguitextlistctrl, id); } /// -/// @brief Get the text of the row with the specified index. @param index Row index to acquire the text at. @tsexample // Define the row index %index = \"5\"; // Request the text from the row at the defined index %rowText = %thisGuiTextListCtrl.getRowText(%index); @endtsexample @return Text at the defined row index. @see GuiControl) +/// @brief Get the text of the row with the specified index. +/// @param index Row index to acquire the text at. +/// @tsexample +/// // Define the row index +/// %index = \"5\"; +/// // Request the text from the row at the defined index +/// %rowText = %thisGuiTextListCtrl.getRowText(%index); +/// @endtsexample +/// @return Text at the defined row index. +/// @see GuiControl) +/// /// public string fnGuiTextListCtrl_getRowText (string guitextlistctrl, int index) @@ -25490,7 +32198,16 @@ public string fnGuiTextListCtrl_getRowText (string guitextlistctrl, int index) } /// -/// @brief Get the text of a row with the specified id. @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to return the text at the defined row id %rowText = %thisGuiTextListCtrl.getRowTextById(%id); @endtsexample @return Row text at the requested row id. @see GuiControl) +/// @brief Get the text of a row with the specified id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to return the text at the defined row id +/// %rowText = %thisGuiTextListCtrl.getRowTextById(%id); +/// @endtsexample +/// @return Row text at the requested row id. +/// @see GuiControl) +/// /// public string fnGuiTextListCtrl_getRowTextById (string guitextlistctrl, int id) @@ -25507,7 +32224,14 @@ public string fnGuiTextListCtrl_getRowTextById (string guitextlistctrl, int id) } /// -/// @brief Get the ID of the currently selected item. @tsexample // Acquire the ID of the selected item in the list. %id = %thisGuiTextListCtrl.getSelectedId(); @endtsexample @return The id of the selected item in the list. @see GuiControl) +/// @brief Get the ID of the currently selected item. +/// @tsexample +/// // Acquire the ID of the selected item in the list. +/// %id = %thisGuiTextListCtrl.getSelectedId(); +/// @endtsexample +/// @return The id of the selected item in the list. +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getSelectedId (string guitextlistctrl) @@ -25521,7 +32245,14 @@ public int fnGuiTextListCtrl_getSelectedId (string guitextlistctrl) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getSelectedId(sbguitextlistctrl); } /// -/// @brief Returns the selected row index (not the row ID). @tsexample // Acquire the selected row index %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); @endtsexample @return Index of the selected row @see GuiControl) +/// @brief Returns the selected row index (not the row ID). +/// @tsexample +/// // Acquire the selected row index +/// %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); +/// @endtsexample +/// @return Index of the selected row +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getSelectedRow (string guitextlistctrl) @@ -25535,7 +32266,17 @@ public int fnGuiTextListCtrl_getSelectedRow (string guitextlistctrl) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getSelectedRow(sbguitextlistctrl); } /// -/// @brief Check if the specified row is currently active or not. @param rowNum Row number to check the active state. @tsexample // Define the row number %rowNum = \"5\"; // Request the active state of the defined row number from the GuiTextListCtrl control. %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); @endtsexample @return Active state of the defined row number. @see GuiControl) +/// @brief Check if the specified row is currently active or not. +/// @param rowNum Row number to check the active state. +/// @tsexample +/// // Define the row number +/// %rowNum = \"5\"; +/// // Request the active state of the defined row number from the GuiTextListCtrl control. +/// %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); +/// @endtsexample +/// @return Active state of the defined row number. +/// @see GuiControl) +/// /// public bool fnGuiTextListCtrl_isRowActive (string guitextlistctrl, int rowNum) @@ -25549,7 +32290,16 @@ public bool fnGuiTextListCtrl_isRowActive (string guitextlistctrl, int rowNum) return SafeNativeMethods.mwle_fnGuiTextListCtrl_isRowActive(sbguitextlistctrl, rowNum)>=1; } /// -/// @brief Remove a row from the table, based on its index. @param index Row index to remove from the list. @tsexample // Define the row index %index = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined row index %thisGuiTextListCtrl.removeRow(%index); @endtsexample @see GuiControl) +/// @brief Remove a row from the table, based on its index. +/// @param index Row index to remove from the list. +/// @tsexample +/// // Define the row index +/// %index = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined row index +/// %thisGuiTextListCtrl.removeRow(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_removeRow (string guitextlistctrl, int index) @@ -25563,7 +32313,16 @@ public void fnGuiTextListCtrl_removeRow (string guitextlistctrl, int index) SafeNativeMethods.mwle_fnGuiTextListCtrl_removeRow(sbguitextlistctrl, index); } /// -/// @brief Remove row with the specified id. @param id Id to remove the row entry at @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined id %thisGuiTextListCtrl.removeRowById(%id); @endtsexample @see GuiControl) +/// @brief Remove row with the specified id. +/// @param id Id to remove the row entry at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined id +/// %thisGuiTextListCtrl.removeRowById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_removeRowById (string guitextlistctrl, int id) @@ -25577,7 +32336,14 @@ public void fnGuiTextListCtrl_removeRowById (string guitextlistctrl, int id) SafeNativeMethods.mwle_fnGuiTextListCtrl_removeRowById(sbguitextlistctrl, id); } /// -/// @brief Get the number of rows. @tsexample // Get the number of rows in the list %rowCount = %thisGuiTextListCtrl.rowCount(); @endtsexample @return Number of rows in the list. @see GuiControl) +/// @brief Get the number of rows. +/// @tsexample +/// // Get the number of rows in the list +/// %rowCount = %thisGuiTextListCtrl.rowCount(); +/// @endtsexample +/// @return Number of rows in the list. +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_rowCount (string guitextlistctrl) @@ -25591,7 +32357,16 @@ public int fnGuiTextListCtrl_rowCount (string guitextlistctrl) return SafeNativeMethods.mwle_fnGuiTextListCtrl_rowCount(sbguitextlistctrl); } /// -/// @brief Scroll so the specified row is visible @param rowNum Row number to make visible @tsexample // Define the row number to make visible %rowNum = \"4\"; // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. %thisGuiTextListCtrl.scrollVisible(%rowNum); @endtsexample @see GuiControl) +/// @brief Scroll so the specified row is visible +/// @param rowNum Row number to make visible +/// @tsexample +/// // Define the row number to make visible +/// %rowNum = \"4\"; +/// // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. +/// %thisGuiTextListCtrl.scrollVisible(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_scrollVisible (string guitextlistctrl, int rowNum) @@ -25605,7 +32380,19 @@ public void fnGuiTextListCtrl_scrollVisible (string guitextlistctrl, int rowNum) SafeNativeMethods.mwle_fnGuiTextListCtrl_scrollVisible(sbguitextlistctrl, rowNum); } /// -/// @brief Mark a specified row as active/not. @param rowNum Row number to change the active state. @param active Boolean active state to set the row number. @tsexample // Define the row number %rowNum = \"4\"; // Define the boolean active state %active = \"true\"; // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. %thisGuiTextListCtrl.setRowActive(%rowNum,%active); @endtsexample @see GuiControl) +/// @brief Mark a specified row as active/not. +/// @param rowNum Row number to change the active state. +/// @param active Boolean active state to set the row number. +/// @tsexample +/// // Define the row number +/// %rowNum = \"4\"; +/// // Define the boolean active state +/// %active = \"true\"; +/// // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. +/// %thisGuiTextListCtrl.setRowActive(%rowNum,%active); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setRowActive (string guitextlistctrl, int rowNum, bool active) @@ -25619,7 +32406,19 @@ public void fnGuiTextListCtrl_setRowActive (string guitextlistctrl, int rowNum, SafeNativeMethods.mwle_fnGuiTextListCtrl_setRowActive(sbguitextlistctrl, rowNum, active); } /// -/// @brief Sets the text at the defined id. @param id Id to change. @param text Text to use at the Id. @tsexample // Define the id %id = \"4\"; // Define the text %text = \"Text To Display\"; // Inform the GuiTextListCtrl control to display the defined text at the defined id %thisGuiTextListCtrl.setRowById(%id,%text); @endtsexample @see GuiControl) +/// @brief Sets the text at the defined id. +/// @param id Id to change. +/// @param text Text to use at the Id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text +/// %text = \"Text To Display\"; +/// // Inform the GuiTextListCtrl control to display the defined text at the defined id +/// %thisGuiTextListCtrl.setRowById(%id,%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setRowById (string guitextlistctrl, int id, string text) @@ -25636,7 +32435,16 @@ public void fnGuiTextListCtrl_setRowById (string guitextlistctrl, int id, string SafeNativeMethods.mwle_fnGuiTextListCtrl_setRowById(sbguitextlistctrl, id, sbtext); } /// -/// @brief Finds the specified entry by id, then marks its row as selected. @param id Entry within the text list to make selected. @tsexample // Define the id %id = \"5\"; // Inform the GuiTextListCtrl control to set the defined id entry as selected %thisGuiTextListCtrl.setSelectedById(%id); @endtsexample @see GuiControl) +/// @brief Finds the specified entry by id, then marks its row as selected. +/// @param id Entry within the text list to make selected. +/// @tsexample +/// // Define the id +/// %id = \"5\"; +/// // Inform the GuiTextListCtrl control to set the defined id entry as selected +/// %thisGuiTextListCtrl.setSelectedById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setSelectedById (string guitextlistctrl, int id) @@ -25650,7 +32458,15 @@ public void fnGuiTextListCtrl_setSelectedById (string guitextlistctrl, int id) SafeNativeMethods.mwle_fnGuiTextListCtrl_setSelectedById(sbguitextlistctrl, id); } /// -/// @briefSelects the specified row. @param rowNum Row number to set selected. @tsexample // Define the row number to set selected %rowNum = \"4\"; %guiTextListCtrl.setSelectedRow(%rowNum); @endtsexample @see GuiControl) +/// @briefSelects the specified row. +/// @param rowNum Row number to set selected. +/// @tsexample +/// // Define the row number to set selected +/// %rowNum = \"4\"; +/// %guiTextListCtrl.setSelectedRow(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setSelectedRow (string guitextlistctrl, int rowNum) @@ -25664,7 +32480,19 @@ public void fnGuiTextListCtrl_setSelectedRow (string guitextlistctrl, int rowNum SafeNativeMethods.mwle_fnGuiTextListCtrl_setSelectedRow(sbguitextlistctrl, rowNum); } /// -/// @brief Performs a standard (alphabetical) sort on the values in the specified column. @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sort(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Performs a standard (alphabetical) sort on the values in the specified column. +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sort(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_sort (string guitextlistctrl, int columnId, bool increasing) @@ -25678,7 +32506,20 @@ public void fnGuiTextListCtrl_sort (string guitextlistctrl, int columnId, bool i SafeNativeMethods.mwle_fnGuiTextListCtrl_sort(sbguitextlistctrl, columnId, increasing); } /// -/// @brief Perform a numerical sort on the values in the specified column. Detailed description @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sortNumerical(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Perform a numerical sort on the values in the specified column. +/// Detailed description +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sortNumerical(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_sortNumerical (string guitextlistctrl, int columnID, bool increasing) @@ -25692,7 +32533,9 @@ public void fnGuiTextListCtrl_sortNumerical (string guitextlistctrl, int columnI SafeNativeMethods.mwle_fnGuiTextListCtrl_sortNumerical(sbguitextlistctrl, columnID, increasing); } /// -/// Get the current playback time. @return The elapsed playback time in seconds. ) +/// Get the current playback time. +/// @return The elapsed playback time in seconds. ) +/// /// public float fnGuiTheoraCtrl_getCurrentTime (string guitheoractrl) @@ -25706,7 +32549,9 @@ public float fnGuiTheoraCtrl_getCurrentTime (string guitheoractrl) return SafeNativeMethods.mwle_fnGuiTheoraCtrl_getCurrentTime(sbguitheoractrl); } /// -/// Test whether the video has finished playing. @return True if the video has finished playing, false otherwise. ) +/// Test whether the video has finished playing. +/// @return True if the video has finished playing, false otherwise. ) +/// /// public bool fnGuiTheoraCtrl_isPlaybackDone (string guitheoractrl) @@ -25720,7 +32565,9 @@ public bool fnGuiTheoraCtrl_isPlaybackDone (string guitheoractrl) return SafeNativeMethods.mwle_fnGuiTheoraCtrl_isPlaybackDone(sbguitheoractrl)>=1; } /// -/// Pause playback of the video. If the video is not currently playing, the call is ignored. While stopped, the control displays the last frame. ) +/// Pause playback of the video. If the video is not currently playing, the call is ignored. +/// While stopped, the control displays the last frame. ) +/// /// public void fnGuiTheoraCtrl_pause (string guitheoractrl) @@ -25735,6 +32582,7 @@ public void fnGuiTheoraCtrl_pause (string guitheoractrl) } /// /// Start playing the video. If the video is already playing, the call is ignored. ) +/// /// public void fnGuiTheoraCtrl_play (string guitheoractrl) @@ -25748,7 +32596,10 @@ public void fnGuiTheoraCtrl_play (string guitheoractrl) SafeNativeMethods.mwle_fnGuiTheoraCtrl_play(sbguitheoractrl); } /// -/// Set the video file to play. If a video is already playing, playback is stopped and the new video file is loaded. @param filename The video file to load. ) +/// Set the video file to play. If a video is already playing, playback is stopped and +/// the new video file is loaded. +/// @param filename The video file to load. ) +/// /// public void fnGuiTheoraCtrl_setFile (string guitheoractrl, string filename) @@ -25765,7 +32616,9 @@ public void fnGuiTheoraCtrl_setFile (string guitheoractrl, string filename) SafeNativeMethods.mwle_fnGuiTheoraCtrl_setFile(sbguitheoractrl, sbfilename); } /// -/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. While stopped, the control renders empty with just the background color. ) +/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. +/// While stopped, the control renders empty with just the background color. ) +/// /// public void fnGuiTheoraCtrl_stop (string guitheoractrl) @@ -25779,7 +32632,12 @@ public void fnGuiTheoraCtrl_stop (string guitheoractrl) SafeNativeMethods.mwle_fnGuiTheoraCtrl_stop(sbguitheoractrl); } /// -/// Add an item/object to the current selection. @param id ID of item/object to add to the selection. @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, the control will defer refreshing the tree and wait until addSelection() is called with this parameter set to true. ) +/// Add an item/object to the current selection. +/// @param id ID of item/object to add to the selection. +/// @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, +/// the control will defer refreshing the tree and wait until addSelection() is called with this parameter set +/// to true. ) +/// /// public void fnGuiTreeViewCtrl_addSelection (string guitreeviewctrl, int id, bool isLastSelection) @@ -25793,7 +32651,10 @@ public void fnGuiTreeViewCtrl_addSelection (string guitreeviewctrl, int id, bool SafeNativeMethods.mwle_fnGuiTreeViewCtrl_addSelection(sbguitreeviewctrl, id, isLastSelection); } /// -/// Clear the current item filtering pattern. @see setFilterText @see getFilterText ) +/// Clear the current item filtering pattern. +/// @see setFilterText +/// @see getFilterText ) +/// /// public void fnGuiTreeViewCtrl_clearFilterText (string guitreeviewctrl) @@ -25808,6 +32669,7 @@ public void fnGuiTreeViewCtrl_clearFilterText (string guitreeviewctrl) } /// /// Unselect all currently selected items. ) +/// /// public void fnGuiTreeViewCtrl_clearSelection (string guitreeviewctrl) @@ -25822,6 +32684,7 @@ public void fnGuiTreeViewCtrl_clearSelection (string guitreeviewctrl) } /// /// Delete all items/objects in the current selection. ) +/// /// public void fnGuiTreeViewCtrl_deleteSelection (string guitreeviewctrl) @@ -25835,7 +32698,12 @@ public void fnGuiTreeViewCtrl_deleteSelection (string guitreeviewctrl) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_deleteSelection(sbguitreeviewctrl); } /// -/// Get the child item of the given parent item whose text matches @a childName. @param parentId Item ID of the parent in which to look for the child. @param childName Text of the child item to find. @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. @note This method does not recurse, i.e. it only looks for direct children. ) +/// Get the child item of the given parent item whose text matches @a childName. +/// @param parentId Item ID of the parent in which to look for the child. +/// @param childName Text of the child item to find. +/// @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. +/// @note This method does not recurse, i.e. it only looks for direct children. ) +/// /// public int fnGuiTreeViewCtrl_findChildItemByName (string guitreeviewctrl, int parentId, string childName) @@ -25852,7 +32720,10 @@ public int fnGuiTreeViewCtrl_findChildItemByName (string guitreeviewctrl, int pa return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_findChildItemByName(sbguitreeviewctrl, parentId, sbchildName); } /// -/// Get the ID of the item whose text matches the given @a text. @param text Item text to match. @return ID of the item or -1 if no item matches the given text. ) +/// Get the ID of the item whose text matches the given @a text. +/// @param text Item text to match. +/// @return ID of the item or -1 if no item matches the given text. ) +/// /// public int fnGuiTreeViewCtrl_findItemByName (string guitreeviewctrl, string text) @@ -25869,7 +32740,10 @@ public int fnGuiTreeViewCtrl_findItemByName (string guitreeviewctrl, string text return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_findItemByName(sbguitreeviewctrl, sbtext); } /// -/// Get the ID of the item whose value matches @a value. @param value Value text to match. @return ID of the item or -1 if no item has the given value. ) +/// Get the ID of the item whose value matches @a value. +/// @param value Value text to match. +/// @return ID of the item or -1 if no item has the given value. ) +/// /// public int fnGuiTreeViewCtrl_findItemByValue (string guitreeviewctrl, string value) @@ -25886,7 +32760,12 @@ public int fnGuiTreeViewCtrl_findItemByValue (string guitreeviewctrl, string val return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_findItemByValue(sbguitreeviewctrl, sbvalue); } /// -/// Get the current filter expression. Only tree items whose text matches this expression are displayed. By default, the expression is empty and all items are shown. @return The current filter pattern or an empty string if no filter pattern is currently active. @see setFilterText @see clearFilterText ) +/// Get the current filter expression. Only tree items whose text matches this expression +/// are displayed. By default, the expression is empty and all items are shown. +/// @return The current filter pattern or an empty string if no filter pattern is currently active. +/// @see setFilterText +/// @see clearFilterText ) +/// /// public string fnGuiTreeViewCtrl_getFilterText (string guitreeviewctrl) @@ -25903,7 +32782,9 @@ public string fnGuiTreeViewCtrl_getFilterText (string guitreeviewctrl) } /// -/// Call SimObject::setHidden( @a state ) on all objects in the current selection. @param state Visibility state to set objects in selection to. ) +/// Call SimObject::setHidden( @a state ) on all objects in the current selection. +/// @param state Visibility state to set objects in selection to. ) +/// /// public void fnGuiTreeViewCtrl_hideSelection (string guitreeviewctrl, bool state) @@ -25917,7 +32798,16 @@ public void fnGuiTreeViewCtrl_hideSelection (string guitreeviewctrl, bool state) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_hideSelection(sbguitreeviewctrl, state); } /// -/// , , 0, 0 ), Add a new item to the tree. @param parentId Item ID of parent to which to add the item as a child. 0 is root item. @param text Text to display on the item in the tree. @param value Behind-the-scenes value of the item. @param icon @param normalImage @param expandedImage @return The ID of the newly added item. ) +/// , , 0, 0 ), +/// Add a new item to the tree. +/// @param parentId Item ID of parent to which to add the item as a child. 0 is root item. +/// @param text Text to display on the item in the tree. +/// @param value Behind-the-scenes value of the item. +/// @param icon +/// @param normalImage +/// @param expandedImage +/// @return The ID of the newly added item. ) +/// /// public int fnGuiTreeViewCtrl_insertItem (string guitreeviewctrl, int parentId, string text, string value, string icon, int normalImage, int expandedImage) @@ -25941,6 +32831,7 @@ public int fnGuiTreeViewCtrl_insertItem (string guitreeviewctrl, int parentId, s } /// /// Inserts object as a child to the given parent. ) +/// /// public int fnGuiTreeViewCtrl_insertObject (string guitreeviewctrl, int parentId, string obj, bool OKToEdit) @@ -25957,7 +32848,10 @@ public int fnGuiTreeViewCtrl_insertObject (string guitreeviewctrl, int parentId, return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_insertObject(sbguitreeviewctrl, parentId, sbobj, OKToEdit); } /// -/// Check whether the given item is currently selected in the tree. @param id Item/object ID. @return True if the given item/object is currently selected in the tree. ) +/// Check whether the given item is currently selected in the tree. +/// @param id Item/object ID. +/// @return True if the given item/object is currently selected in the tree. ) +/// /// public bool fnGuiTreeViewCtrl_isItemSelected (string guitreeviewctrl, int id) @@ -25971,7 +32865,10 @@ public bool fnGuiTreeViewCtrl_isItemSelected (string guitreeviewctrl, int id) return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_isItemSelected(sbguitreeviewctrl, id)>=1; } /// -/// Set whether the current selection can be changed by the user or not. @param lock If true, the current selection is frozen and cannot be changed. If false, the selection may be modified. ) +/// Set whether the current selection can be changed by the user or not. +/// @param lock If true, the current selection is frozen and cannot be changed. If false, +/// the selection may be modified. ) +/// /// public void fnGuiTreeViewCtrl_lockSelection (string guitreeviewctrl, bool lockx) @@ -25985,7 +32882,12 @@ public void fnGuiTreeViewCtrl_lockSelection (string guitreeviewctrl, bool lockx) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_lockSelection(sbguitreeviewctrl, lockx); } /// -/// Set the pattern by which to filter items in the tree. Only items in the tree whose text matches this pattern are displayed. @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. @see getFilterText @see clearFilterText ) +/// Set the pattern by which to filter items in the tree. Only items in the tree whose text +/// matches this pattern are displayed. +/// @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. +/// @see getFilterText +/// @see clearFilterText ) +/// /// public void fnGuiTreeViewCtrl_setFilterText (string guitreeviewctrl, string pattern) @@ -26003,6 +32905,7 @@ public void fnGuiTreeViewCtrl_setFilterText (string guitreeviewctrl, string patt } /// /// Toggle the hidden state of all objects in the current selection. ) +/// /// public void fnGuiTreeViewCtrl_toggleHideSelection (string guitreeviewctrl) @@ -26017,6 +32920,7 @@ public void fnGuiTreeViewCtrl_toggleHideSelection (string guitreeviewctrl) } /// /// Toggle the locked state of all objects in the current selection. ) +/// /// public void fnGuiTreeViewCtrl_toggleLockSelection (string guitreeviewctrl) @@ -26030,7 +32934,10 @@ public void fnGuiTreeViewCtrl_toggleLockSelection (string guitreeviewctrl) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_toggleLockSelection(sbguitreeviewctrl); } /// -/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. @param radius Radius in world-space units which should fit in the view. @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. +/// @param radius Radius in world-space units which should fit in the view. +/// @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// /// public float fnGuiTSCtrl_calculateViewDistance (string guitsctrl, float radius) @@ -26045,6 +32952,7 @@ public float fnGuiTSCtrl_calculateViewDistance (string guitsctrl, float radius) } /// /// ) +/// /// public string fnGuiTSCtrl_getClickVector (string guitsctrl, string mousePoint) @@ -26065,6 +32973,7 @@ public string fnGuiTSCtrl_getClickVector (string guitsctrl, string mousePoint) } /// /// ) +/// /// public string fnGuiTSCtrl_getWorldPosition (string guitsctrl, string mousePoint) @@ -26084,7 +32993,9 @@ public string fnGuiTSCtrl_getWorldPosition (string guitsctrl, string mousePoint) } /// -/// Get the ratio between world-space units and pixels. @return The amount of world-space units covered by the extent of a single pixel. ) +/// Get the ratio between world-space units and pixels. +/// @return The amount of world-space units covered by the extent of a single pixel. ) +/// /// public string fnGuiTSCtrl_getWorldToScreenScale (string guitsctrl) @@ -26101,7 +33012,10 @@ public string fnGuiTSCtrl_getWorldToScreenScale (string guitsctrl) } /// -/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. @param worldPosition The world-space position to transform to screen-space. @return The ) +/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. +/// @param worldPosition The world-space position to transform to screen-space. +/// @return The ) +/// /// public string fnGuiTSCtrl_project (string guitsctrl, string worldPosition) @@ -26121,7 +33035,11 @@ public string fnGuiTSCtrl_project (string guitsctrl, string worldPosition) } /// -/// Transform 3D screen-space coordinates (x, y, depth) to world space. This method can be, for example, used to find the world-space position relating to the current mouse cursor position. @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. @return The world-space position corresponding to the given screen-space coordinates. ) +/// Transform 3D screen-space coordinates (x, y, depth) to world space. +/// This method can be, for example, used to find the world-space position relating to the current mouse cursor position. +/// @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. +/// @return The world-space position corresponding to the given screen-space coordinates. ) +/// /// public string fnGuiTSCtrl_unproject (string guitsctrl, string screenPosition) @@ -26142,6 +33060,7 @@ public string fnGuiTSCtrl_unproject (string guitsctrl, string screenPosition) } /// /// ) +/// /// public void fnGuiWindowCtrl_attachTo (string guiwindowctrl, string window) @@ -26159,6 +33078,7 @@ public void fnGuiWindowCtrl_attachTo (string guiwindowctrl, string window) } /// /// Puts the guiwindow back on the main canvas. ) +/// /// public void fnGuiWindowCtrl_ClosePopOut (string guiwindowctrl) @@ -26173,6 +33093,7 @@ public void fnGuiWindowCtrl_ClosePopOut (string guiwindowctrl) } /// /// Returns the title of the window. ) +/// /// public string fnGuiWindowCtrl_getWindowTitle (string guiwindowctrl) @@ -26190,6 +33111,7 @@ public string fnGuiWindowCtrl_getWindowTitle (string guiwindowctrl) } /// /// Returns if the title can be set or not. ) +/// /// public bool fnGuiWindowCtrl_isTitleSet (string guiwindowctrl) @@ -26204,6 +33126,7 @@ public bool fnGuiWindowCtrl_isTitleSet (string guiwindowctrl) } /// /// Puts the guiwindow on a new canvas. ) +/// /// public void fnGuiWindowCtrl_OpenPopOut (string guiwindowctrl) @@ -26218,6 +33141,7 @@ public void fnGuiWindowCtrl_OpenPopOut (string guiwindowctrl) } /// /// Bring the window to the front. ) +/// /// public void fnGuiWindowCtrl_selectWindow (string guiwindowctrl) @@ -26232,6 +33156,7 @@ public void fnGuiWindowCtrl_selectWindow (string guiwindowctrl) } /// /// Set the window's collapsing state. ) +/// /// public void fnGuiWindowCtrl_setCollapseGroup (string guiwindowctrl, bool state) @@ -26246,6 +33171,7 @@ public void fnGuiWindowCtrl_setCollapseGroup (string guiwindowctrl, bool state) } /// /// Displays the option to set the title of the window. ) +/// /// public void fnGuiWindowCtrl_setContextTitle (string guiwindowctrl, bool title) @@ -26260,6 +33186,7 @@ public void fnGuiWindowCtrl_setContextTitle (string guiwindowctrl, bool title) } /// /// Sets the title of the window. ) +/// /// public void fnGuiWindowCtrl_setWindowTitle (string guiwindowctrl, string title) @@ -26277,6 +33204,7 @@ public void fnGuiWindowCtrl_setWindowTitle (string guiwindowctrl, string title) } /// /// Toggle the window collapsing. ) +/// /// public void fnGuiWindowCtrl_toggleCollapseGroup (string guiwindowctrl) @@ -26290,7 +33218,28 @@ public void fnGuiWindowCtrl_toggleCollapseGroup (string guiwindowctrl) SafeNativeMethods.mwle_fnGuiWindowCtrl_toggleCollapseGroup(sbguiwindowctrl); } /// -/// ), @brief Send a GET command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Send the GET command to the server %httpObj.get(%url,%URI,%query); @endtsexample ) +/// ), +/// @brief Send a GET command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Send the GET command to the server +/// %httpObj.get(%url,%URI,%query); +/// @endtsexample +/// ) +/// /// public void fnHTTPObject_get (string httpobject, string Address, string requirstURI, string query) @@ -26313,7 +33262,31 @@ public void fnHTTPObject_get (string httpobject, string Address, string requirst SafeNativeMethods.mwle_fnHTTPObject_get(sbhttpobject, sbAddress, sbrequirstURI, sbquery); } /// -/// @brief Send POST command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. @param post Submission data to be processed. @note The post() method is currently non-functional. @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Specify the submission data. %post = \"\"; // Send the POST command to the server %httpObj.POST(%url,%URI,%query,%post); @endtsexample ) +/// @brief Send POST command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// @param post Submission data to be processed. +/// +/// @note The post() method is currently non-functional. +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Specify the submission data. +/// %post = \"\"; +/// // Send the POST command to the server +/// %httpObj.POST(%url,%URI,%query,%post); +/// @endtsexample +/// ) +/// /// public void fnHTTPObject_post (string httpobject, string Address, string requirstURI, string query, string post) @@ -26339,7 +33312,15 @@ public void fnHTTPObject_post (string httpobject, string Address, string requirs SafeNativeMethods.mwle_fnHTTPObject_post(sbhttpobject, sbAddress, sbrequirstURI, sbquery, sbpost); } /// -/// @brief Get the normal of the surface on which the object is stuck. @return Returns The XYZ normal from where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the normal of the surface on which the object is stuck. +/// @return Returns The XYZ normal from where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string fnItem_getLastStickyNormal (string item) @@ -26356,7 +33337,15 @@ public string fnItem_getLastStickyNormal (string item) } /// -/// @brief Get the position on the surface on which this Item is stuck. @return Returns The XYZ position of where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the position on the surface on which this Item is stuck. +/// @return Returns The XYZ position of where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string fnItem_getLastStickyPos (string item) @@ -26373,7 +33362,14 @@ public string fnItem_getLastStickyPos (string item) } /// -/// @brief Is the object at rest (ie, no longer moving)? @return True if the object is at rest, false if it is not. @tsexample // Query the item on if it is or is not at rest. %isAtRest = %item.isAtRest(); @endtsexample ) +/// @brief Is the object at rest (ie, no longer moving)? +/// @return True if the object is at rest, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not at rest. +/// %isAtRest = %item.isAtRest(); +/// @endtsexample +/// ) +/// /// public bool fnItem_isAtRest (string item) @@ -26387,7 +33383,15 @@ public bool fnItem_isAtRest (string item) return SafeNativeMethods.mwle_fnItem_isAtRest(sbitem)>=1; } /// -/// @brief Is the object still rotating? @return True if the object is still rotating, false if it is not. @tsexample // Query the item on if it is or is not rotating. %isRotating = %itemData.isRotating(); @endtsexample @see rotate ) +/// @brief Is the object still rotating? +/// @return True if the object is still rotating, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not rotating. +/// %isRotating = %itemData.isRotating(); +/// @endtsexample +/// @see rotate +/// ) +/// /// public bool fnItem_isRotating (string item) @@ -26401,7 +33405,15 @@ public bool fnItem_isRotating (string item) return SafeNativeMethods.mwle_fnItem_isRotating(sbitem)>=1; } /// -/// @brief Is the object static (ie, non-movable)? @return True if the object is static, false if it is not. @tsexample // Query the item on if it is or is not static. %isStatic = %itemData.isStatic(); @endtsexample @see static ) +/// @brief Is the object static (ie, non-movable)? +/// @return True if the object is static, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not static. +/// %isStatic = %itemData.isStatic(); +/// @endtsexample +/// @see static +/// ) +/// /// public bool fnItem_isStatic (string item) @@ -26415,7 +33427,23 @@ public bool fnItem_isStatic (string item) return SafeNativeMethods.mwle_fnItem_isStatic(sbitem)>=1; } /// -/// @brief Temporarily disable collisions against a specific ShapeBase object. This is useful to prevent a player from immediately picking up an Item they have just thrown. Only one object may be on the timeout list at a time. The timeout is defined as 15 ticks. @param objectID ShapeBase object ID to disable collisions against. @return Returns true if the ShapeBase object requested could be found, false if it could not. @tsexample // Set the ShapeBase Object ID to disable collisions against %ignoreColObj = %player.getID(); // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. %item.setCollisionTimeout(%ignoreColObj); @endtsexample ) +/// @brief Temporarily disable collisions against a specific ShapeBase object. +/// +/// This is useful to prevent a player from immediately picking up an Item they have +/// just thrown. Only one object may be on the timeout list at a time. The timeout is +/// defined as 15 ticks. +/// +/// @param objectID ShapeBase object ID to disable collisions against. +/// @return Returns true if the ShapeBase object requested could be found, false if it could not. +/// +/// @tsexample +/// // Set the ShapeBase Object ID to disable collisions against +/// %ignoreColObj = %player.getID(); +/// // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. +/// %item.setCollisionTimeout(%ignoreColObj); +/// @endtsexample +/// ) +/// /// public bool fnItem_setCollisionTimeout (string item, int ignoreColObj) @@ -26430,6 +33458,7 @@ public bool fnItem_setCollisionTimeout (string item, int ignoreColObj) } /// /// ( LevelInfo, setNearClip, void, 3, 3, ( F32 nearClip )) +/// /// public void fnLevelInfo_setNearClip (string levelinfo, string a2) @@ -26446,7 +33475,19 @@ public void fnLevelInfo_setNearClip (string levelinfo, string a2) SafeNativeMethods.mwle_fnLevelInfo_setNearClip(sblevelinfo, sba2); } /// -/// @brief Toggles the light on and off @param state Turns the light on (true) or off (false) @tsexample // Disable the light CrystalLight.setLightEnabled(false); // Renable the light CrystalLight.setLightEnabled(true); @endtsexample) +/// @brief Toggles the light on and off +/// +/// @param state Turns the light on (true) or off (false) +/// +/// @tsexample +/// // Disable the light +/// CrystalLight.setLightEnabled(false); +/// // Renable the light +/// CrystalLight.setLightEnabled(true); +/// +/// @endtsexample +/// ) +/// /// public void fnLightBase_setLightEnabled (string lightbase, bool state) @@ -26460,7 +33501,22 @@ public void fnLightBase_setLightEnabled (string lightbase, bool state) SafeNativeMethods.mwle_fnLightBase_setLightEnabled(sblightbase, state); } /// -/// @brief Force an inspectPostApply call for the benefit of tweaking via the console Normally this functionality is only exposed to objects via the World Editor, once changes have been made. Exposing apply to script allows you to make changes to it on the fly without the World Editor. @note This is intended for debugging and tweaking, not for game play @tsexample // Change a property of the light description RocketLauncherLightDesc.brightness = 10; // Make it so RocketLauncherLightDesc.apply(); @endtsexample) +/// @brief Force an inspectPostApply call for the benefit of tweaking via the console +/// +/// Normally this functionality is only exposed to objects via the World Editor, once changes have been made. +/// Exposing apply to script allows you to make changes to it on the fly without the World Editor. +/// +/// @note This is intended for debugging and tweaking, not for game play +/// +/// @tsexample +/// // Change a property of the light description +/// RocketLauncherLightDesc.brightness = 10; +/// // Make it so +/// RocketLauncherLightDesc.apply(); +/// +/// @endtsexample +/// ) +/// /// public void fnLightDescription_apply (string lightdescription) @@ -26474,7 +33530,10 @@ public void fnLightDescription_apply (string lightdescription) SafeNativeMethods.mwle_fnLightDescription_apply(sblightdescription); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply +/// ) +/// /// public void fnLightFlareData_apply (string lightflaredata) @@ -26488,7 +33547,9 @@ public void fnLightFlareData_apply (string lightflaredata) SafeNativeMethods.mwle_fnLightFlareData_apply(sblightflaredata); } /// -/// Creates a LightningStrikeEvent which strikes a specific object. @note This method is currently unimplemented. ) +/// Creates a LightningStrikeEvent which strikes a specific object. +/// @note This method is currently unimplemented. ) +/// /// public void fnLightning_strikeObject (string lightning, string pSB) @@ -26505,7 +33566,13 @@ public void fnLightning_strikeObject (string lightning, string pSB) SafeNativeMethods.mwle_fnLightning_strikeObject(sblightning, sbpSB); } /// -/// Creates a LightningStrikeEvent which attempts to strike and damage a random object in range of the Lightning object. @tsexample // Generate a damaging lightning strike effect on all clients %lightning.strikeRandomPoint(); @endtsexample ) +/// Creates a LightningStrikeEvent which attempts to strike and damage a random +/// object in range of the Lightning object. +/// @tsexample +/// // Generate a damaging lightning strike effect on all clients +/// %lightning.strikeRandomPoint(); +/// @endtsexample ) +/// /// public void fnLightning_strikeRandomPoint (string lightning) @@ -26519,7 +33586,14 @@ public void fnLightning_strikeRandomPoint (string lightning) SafeNativeMethods.mwle_fnLightning_strikeRandomPoint(sblightning); } /// -/// @brief Creates a LightningStrikeEvent that triggers harmless lightning bolts on all clients. No objects will be damaged by these bolts. @tsexample // Generate a harmless lightning strike effect on all clients %lightning.warningFlashes(); @endtsexample ) +/// @brief Creates a LightningStrikeEvent that triggers harmless lightning +/// bolts on all clients. +/// No objects will be damaged by these bolts. +/// @tsexample +/// // Generate a harmless lightning strike effect on all clients +/// %lightning.warningFlashes(); +/// @endtsexample ) +/// /// public void fnLightning_warningFlashes (string lightning) @@ -26533,7 +33607,11 @@ public void fnLightning_warningFlashes (string lightning) SafeNativeMethods.mwle_fnLightning_warningFlashes(sblightning); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void fnMeshRoad_postApply (string meshroad) @@ -26547,7 +33625,10 @@ public void fnMeshRoad_postApply (string meshroad) SafeNativeMethods.mwle_fnMeshRoad_postApply(sbmeshroad); } /// -/// Intended as a helper to developers and editor scripts. Force MeshRoad to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force MeshRoad to recreate its geometry. +/// ) +/// /// public void fnMeshRoad_regenerate (string meshroad) @@ -26561,7 +33642,10 @@ public void fnMeshRoad_regenerate (string meshroad) SafeNativeMethods.mwle_fnMeshRoad_regenerate(sbmeshroad); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void fnMeshRoad_setNodeDepth (string meshroad, int idx, float meters) @@ -26575,7 +33659,11 @@ public void fnMeshRoad_setNodeDepth (string meshroad, int idx, float meters) SafeNativeMethods.mwle_fnMeshRoad_setNodeDepth(sbmeshroad, idx, meters); } /// -/// Clear all messages in the vector @tsexample HudMessageVector.clear(); @endtsexample) +/// Clear all messages in the vector +/// @tsexample +/// HudMessageVector.clear(); +/// @endtsexample) +/// /// public void fnMessageVector_clear (string messagevector) @@ -26589,7 +33677,14 @@ public void fnMessageVector_clear (string messagevector) SafeNativeMethods.mwle_fnMessageVector_clear(sbmessagevector); } /// -/// Delete the line at the specified position. @param deletePos Position in the vector containing the line to be deleted @tsexample // Delete the first line (index 0) in the vector... HudMessageVector.deleteLine(0); @endtsexample @return False if deletePos is greater than the number of lines in the current vector) +/// Delete the line at the specified position. +/// @param deletePos Position in the vector containing the line to be deleted +/// @tsexample +/// // Delete the first line (index 0) in the vector... +/// HudMessageVector.deleteLine(0); +/// @endtsexample +/// @return False if deletePos is greater than the number of lines in the current vector) +/// /// public bool fnMessageVector_deleteLine (string messagevector, int deletePos) @@ -26603,7 +33698,15 @@ public bool fnMessageVector_deleteLine (string messagevector, int deletePos) return SafeNativeMethods.mwle_fnMessageVector_deleteLine(sbmessagevector, deletePos)>=1; } /// -/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate a line of text tagged with the value \"1\", then delete it. %taggedLine = HudMessageVector.getLineIndexByTag(1); HudMessageVector.deleteLine(%taggedLine); @endtsexample @return Line with matching tag, other wise -1) +/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate a line of text tagged with the value \"1\", then delete it. +/// %taggedLine = HudMessageVector.getLineIndexByTag(1); +/// HudMessageVector.deleteLine(%taggedLine); +/// @endtsexample +/// @return Line with matching tag, other wise -1) +/// /// public int fnMessageVector_getLineIndexByTag (string messagevector, int tag) @@ -26617,7 +33720,20 @@ public int fnMessageVector_getLineIndexByTag (string messagevector, int tag) return SafeNativeMethods.mwle_fnMessageVector_getLineIndexByTag(sbmessagevector, tag); } /// -/// Get the tag of a specified line. @param pos Position in vector to grab tag from @tsexample // Remove all lines that do not have a tag value of 1. while( HudMessageVector.getNumLines()) { %tag = HudMessageVector.getLineTag(1); if(%tag != 1) %tag.delete(); HudMessageVector.popFrontLine(); } @endtsexample @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// Get the tag of a specified line. +/// @param pos Position in vector to grab tag from +/// @tsexample +/// // Remove all lines that do not have a tag value of 1. +/// while( HudMessageVector.getNumLines()) +/// { +/// %tag = HudMessageVector.getLineTag(1); +/// if(%tag != 1) +/// %tag.delete(); +/// HudMessageVector.popFrontLine(); +/// } +/// @endtsexample +/// @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// /// public int fnMessageVector_getLineTag (string messagevector, int pos) @@ -26631,7 +33747,15 @@ public int fnMessageVector_getLineTag (string messagevector, int pos) return SafeNativeMethods.mwle_fnMessageVector_getLineTag(sbmessagevector, pos); } /// -/// Get the text at a specified line. @param pos Position in vector to grab text from @tsexample // Print a line of text at position 1. %text = HudMessageVector.getLineText(1); echo(%text); @endtsexample @return Text at specified line, if the position is greater than the number of lines return \"\") +/// Get the text at a specified line. +/// @param pos Position in vector to grab text from +/// @tsexample +/// // Print a line of text at position 1. +/// %text = HudMessageVector.getLineText(1); +/// echo(%text); +/// @endtsexample +/// @return Text at specified line, if the position is greater than the number of lines return \"\") +/// /// public string fnMessageVector_getLineText (string messagevector, int pos) @@ -26648,7 +33772,15 @@ public string fnMessageVector_getLineText (string messagevector, int pos) } /// -/// Scan through the lines in the vector, returning the first line that has a matching tag. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate text in the vector tagged with the value \"1\", then print it %taggedText = HudMessageVector.getLineTextByTag(1); echo(%taggedText); @endtsexample @return Text from a line with matching tag, other wise \"\") +/// Scan through the lines in the vector, returning the first line that has a matching tag. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate text in the vector tagged with the value \"1\", then print it +/// %taggedText = HudMessageVector.getLineTextByTag(1); +/// echo(%taggedText); +/// @endtsexample +/// @return Text from a line with matching tag, other wise \"\") +/// /// public string fnMessageVector_getLineTextByTag (string messagevector, int tag) @@ -26665,7 +33797,13 @@ public string fnMessageVector_getLineTextByTag (string messagevector, int tag) } /// -/// Get the number of lines in the vector. @tsexample // Find out how many lines have been stored in HudMessageVector %chatLines = HudMessageVector.getNumLines(); echo(%chatLines); @endtsexample) +/// Get the number of lines in the vector. +/// @tsexample +/// // Find out how many lines have been stored in HudMessageVector +/// %chatLines = HudMessageVector.getNumLines(); +/// echo(%chatLines); +/// @endtsexample) +/// /// public int fnMessageVector_getNumLines (string messagevector) @@ -26679,7 +33817,15 @@ public int fnMessageVector_getNumLines (string messagevector) return SafeNativeMethods.mwle_fnMessageVector_getNumLines(sbmessagevector); } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.insertLine(1, \"Hello World\", 0); @endtsexample @return False if insertPos is greater than the number of lines in the current vector) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.insertLine(1, \"Hello World\", 0); +/// @endtsexample +/// @return False if insertPos is greater than the number of lines in the current vector) +/// /// public bool fnMessageVector_insertLine (string messagevector, int insertPos, string msg, int tag) @@ -26696,7 +33842,12 @@ public bool fnMessageVector_insertLine (string messagevector, int insertPos, str return SafeNativeMethods.mwle_fnMessageVector_insertLine(sbmessagevector, insertPos, sbmsg, tag)>=1; } /// -/// Pop a line from the back of the list; destroys the line. @tsexample HudMessageVector.popBackLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the back of the list; destroys the line. +/// @tsexample +/// HudMessageVector.popBackLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool fnMessageVector_popBackLine (string messagevector) @@ -26710,7 +33861,12 @@ public bool fnMessageVector_popBackLine (string messagevector) return SafeNativeMethods.mwle_fnMessageVector_popBackLine(sbmessagevector)>=1; } /// -/// Pop a line from the front of the vector, destroying the line. @tsexample HudMessageVector.popFrontLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the front of the vector, destroying the line. +/// @tsexample +/// HudMessageVector.popFrontLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool fnMessageVector_popFrontLine (string messagevector) @@ -26724,7 +33880,14 @@ public bool fnMessageVector_popFrontLine (string messagevector) return SafeNativeMethods.mwle_fnMessageVector_popFrontLine(sbmessagevector)>=1; } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushBackLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushBackLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void fnMessageVector_pushBackLine (string messagevector, string msg, int tag) @@ -26741,7 +33904,14 @@ public void fnMessageVector_pushBackLine (string messagevector, string msg, int SafeNativeMethods.mwle_fnMessageVector_pushBackLine(sbmessagevector, sbmsg, tag); } /// -/// Push a line onto the front of the vector. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushFrontLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the front of the vector. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushFrontLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void fnMessageVector_pushFrontLine (string messagevector, string msg, int tag) @@ -26759,6 +33929,7 @@ public void fnMessageVector_pushFrontLine (string messagevector, string msg, int } /// /// Returns 4 fields: starting x, starting y, extents x, extents y.) +/// /// public string fnMissionArea_getArea (string missionarea) @@ -26775,7 +33946,11 @@ public string fnMissionArea_getArea (string missionarea) } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void fnMissionArea_postApply (string missionarea) @@ -26789,7 +33964,14 @@ public void fnMissionArea_postApply (string missionarea) SafeNativeMethods.mwle_fnMissionArea_postApply(sbmissionarea); } /// -/// @brief - Defines the size of the MissionArea param x Starting X coordinate position for MissionArea param y Starting Y coordinate position for MissionArea param width New width of the MissionArea param height New height of the MissionArea @note Only the server object may be set. ) +/// @brief - Defines the size of the MissionArea +/// param x Starting X coordinate position for MissionArea +/// param y Starting Y coordinate position for MissionArea +/// param width New width of the MissionArea +/// param height New height of the MissionArea +/// @note Only the server object may be set. +/// ) +/// /// public void fnMissionArea_setArea (string missionarea, int x, int y, int width, int height) @@ -27191,7 +34373,15 @@ public int fnNavPath_size (string navpath) return SafeNativeMethods.mwle_fnNavPath_size(sbnavpath); } /// -/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. This method is normally only called when a NetConnection class is first constructed. It need only be manually called if the global variables that set the packet rate or size have changed. @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize have been changed since a NetConnection has been created, this method must be called on all connections for them to follow the new rates or size.) +/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. +/// +/// This method is normally only called when a NetConnection class is first constructed. It need +/// only be manually called if the global variables that set the packet rate or size have changed. +/// +/// @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize +/// have been changed since a NetConnection has been created, this method must be called on +/// all connections for them to follow the new rates or size.) +/// /// public void fnNetConnection_checkMaxRate (string netconnection) @@ -27205,7 +34395,27 @@ public void fnNetConnection_checkMaxRate (string netconnection) SafeNativeMethods.mwle_fnNetConnection_checkMaxRate(sbnetconnection); } /// -/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that motion spline paths have not been transmitted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see transmitPaths() @see Path) +/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that motion spline paths have not been transmitted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see transmitPaths() +/// @see Path) +/// /// public void fnNetConnection_clearPaths (string netconnection) @@ -27219,7 +34429,23 @@ public void fnNetConnection_clearPaths (string netconnection) SafeNativeMethods.mwle_fnNetConnection_clearPaths(sbnetconnection); } /// -/// @brief Connects to the remote address. Attempts to connect with another NetConnection on the given address. Typically once connected, a game's information is passed along from the server to the client, followed by the player entering the game world. The actual procedure is dependent on the NetConnection subclass that is used. i.e. GameConnection. @param remoteAddress The address to connect to in the form of IP:address>:port although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also substitue the word i>broadcast/i> for the address to broadcast the connect request over the local subnet. @see NetConnection::connectLocal() to connect to a server running within the same process as the client. ) +/// @brief Connects to the remote address. +/// +/// Attempts to connect with another NetConnection on the given address. Typically once +/// connected, a game's information is passed along from the server to the client, followed +/// by the player entering the game world. The actual procedure is dependent on +/// the NetConnection subclass that is used. i.e. GameConnection. +/// +/// @param remoteAddress The address to connect to in the form of IP:address>:port +/// although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form +/// of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also +/// substitue the word i>broadcast/i> for the address to broadcast the connect request over +/// the local subnet. +/// +/// @see NetConnection::connectLocal() to connect to a server running within the same process +/// as the client. +/// ) +/// /// public void fnNetConnection_connect (string netconnection, string remoteAddress) @@ -27236,7 +34462,13 @@ public void fnNetConnection_connect (string netconnection, string remoteAddress) SafeNativeMethods.mwle_fnNetConnection_connect(sbnetconnection, sbremoteAddress); } /// -/// @brief Connects with the server that is running within the same process as the client. @returns An error text message upon failure, or an empty string when successful. @see See @ref local_connections for a description of local connections and their use. See NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// @brief Connects with the server that is running within the same process as the client. +/// +/// @returns An error text message upon failure, or an empty string when successful. +/// +/// @see See @ref local_connections for a description of local connections and their use. See +/// NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// /// public string fnNetConnection_connectLocal (string netconnection) @@ -27253,7 +34485,13 @@ public string fnNetConnection_connectLocal (string netconnection) } /// -/// @brief Returns the far end network address for the connection. The address will be in one of the following forms: - b>IP:Broadcast:port>/b> for broadcast type addresses - b>IP:address>:port>/b> for IP addresses - b>local/b> when connected locally (server and client running in same process) +/// @brief Returns the far end network address for the connection. +/// +/// The address will be in one of the following forms: +/// - b>IP:Broadcast:port>/b> for broadcast type addresses +/// - b>IP:address>:port>/b> for IP addresses +/// - b>local/b> when connected locally (server and client running in same process) +/// /// public string fnNetConnection_getAddress (string netconnection) @@ -27270,7 +34508,16 @@ public string fnNetConnection_getAddress (string netconnection) } /// -/// @brief On server or client, convert a real id to the ghost id for this connection. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server or client to discover an object's ghost ID based on its real SimObject ID. @param realID The real SimObject ID of the object. @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On server or client, convert a real id to the ghost id for this connection. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server or client to discover an object's ghost ID based on its real SimObject ID. +/// +/// @param realID The real SimObject ID of the object. +/// @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_getGhostID (string netconnection, int realID) @@ -27303,7 +34550,10 @@ public int fnNetConnection_GetGhostIndex (string netconnection, string obj) return SafeNativeMethods.mwle_fnNetConnection_GetGhostIndex(sbnetconnection, sbobj); } /// -/// @brief Provides the number of active ghosts on the connection. @returns The number of active ghosts. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Provides the number of active ghosts on the connection. +/// @returns The number of active ghosts. +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_getGhostsActive (string netconnection) @@ -27317,7 +34567,10 @@ public int fnNetConnection_getGhostsActive (string netconnection) return SafeNativeMethods.mwle_fnNetConnection_getGhostsActive(sbnetconnection); } /// -/// @brief Returns the percentage of packets lost per tick. @note This method is not yet hooked up.) +/// @brief Returns the percentage of packets lost per tick. +/// +/// @note This method is not yet hooked up.) +/// /// public int fnNetConnection_getPacketLoss (string netconnection) @@ -27331,7 +34584,12 @@ public int fnNetConnection_getPacketLoss (string netconnection) return SafeNativeMethods.mwle_fnNetConnection_getPacketLoss(sbnetconnection); } /// -/// @brief Returns the average round trip time (in ms) for the connection. The round trip time is recalculated every time a notify packet is received. Notify packets are used to information the connection that the far end successfully received the sent packet.) +/// @brief Returns the average round trip time (in ms) for the connection. +/// +/// The round trip time is recalculated every time a notify packet is received. Notify +/// packets are used to information the connection that the far end successfully received +/// the sent packet.) +/// /// public int fnNetConnection_getPing (string netconnection) @@ -27361,7 +34619,21 @@ public int fnNetConnection_ResolveGhost (string netconnection, int ghostIndex) return SafeNativeMethods.mwle_fnNetConnection_ResolveGhost(sbnetconnection, ghostIndex); } /// -/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the client to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = ServerConnection.resolveGhostID( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the client to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = ServerConnection.resolveGhostID( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_resolveGhostID (string netconnection, int ghostID) @@ -27375,7 +34647,21 @@ public int fnNetConnection_resolveGhostID (string netconnection, int ghostID) return SafeNativeMethods.mwle_fnNetConnection_resolveGhostID(sbnetconnection, ghostID); } /// -/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = %client.resolveObjectFromGhostIndex( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = %client.resolveObjectFromGhostIndex( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_resolveObjectFromGhostIndex (string netconnection, int ghostID) @@ -27389,7 +34675,12 @@ public int fnNetConnection_resolveObjectFromGhostIndex (string netconnection, in return SafeNativeMethods.mwle_fnNetConnection_resolveObjectFromGhostIndex(sbnetconnection, ghostID); } /// -/// @brief Simulate network issues on the connection for testing. @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute integer, measured in ms.) +/// @brief Simulate network issues on the connection for testing. +/// +/// @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) +/// @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute +/// integer, measured in ms.) +/// /// public void fnNetConnection_setSimulatedNetParams (string netconnection, float packetLoss, int delay) @@ -27403,7 +34694,44 @@ public void fnNetConnection_setSimulatedNetParams (string netconnection, float p SafeNativeMethods.mwle_fnNetConnection_setSimulatedNetParams(sbnetconnection, packetLoss, delay); } /// -/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. The server transmits all spline motion paths that are within the mission (Path) separate from other objects. This is due to the potentially large number of nodes within each path, which may saturate a packet sent to the client. By managing this step separately, Torque has finer control over how packets are organised vs. doing it during the ghosting stage. Internally a PathManager is used to track all paths defined within a mission on the server, and each one is transmitted using a PathManagerEvent. The client side collects these events and builds the given paths within its own PathManager. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. When a mission is ended, all paths need to be cleared from their respective path managers. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mission paths (SimPath), this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see clearPaths() @see Path) +/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. +/// +/// The server transmits all spline motion paths that are within the mission (Path) separate from +/// other objects. This is due to the potentially large number of nodes within each path, which may +/// saturate a packet sent to the client. By managing this step separately, Torque has finer control +/// over how packets are organised vs. doing it during the ghosting stage. +/// +/// Internally a PathManager is used to track all paths defined within a mission on the server, and each +/// one is transmitted using a PathManagerEvent. The client side collects these events and builds the +/// given paths within its own PathManager. This is typically done during the standard mission start +/// phase 2 when following Torque's example mission startup sequence. +/// +/// When a mission is ended, all paths need to be cleared from their respective path managers. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mission paths (SimPath), this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see clearPaths() +/// @see Path) +/// /// public void fnNetConnection_transmitPaths (string netconnection) @@ -27417,7 +34745,12 @@ public void fnNetConnection_transmitPaths (string netconnection) SafeNativeMethods.mwle_fnNetConnection_transmitPaths(sbnetconnection); } /// -/// @brief Undo the effects of a scopeToClient() call. @param client The connection to remove this object's scoping from @see scopeToClient()) +/// @brief Undo the effects of a scopeToClient() call. +/// +/// @param client The connection to remove this object's scoping from +/// +/// @see scopeToClient()) +/// /// public void fnNetObject_clearScopeToClient (string netobject, string client) @@ -27434,7 +34767,22 @@ public void fnNetObject_clearScopeToClient (string netobject, string client) SafeNativeMethods.mwle_fnNetObject_clearScopeToClient(sbnetobject, sbclient); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. @returns the SimObject ID of the client object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %clientObject = %node.getClientObject(); if(isObject(%clientObject) %clientObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns the SimObject ID of the client object. +/// +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %clientObject = %node.getClientObject(); +/// if(isObject(%clientObject) +/// %clientObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int fnNetObject_getClientObject (string netobject) @@ -27448,7 +34796,14 @@ public int fnNetObject_getClientObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_getClientObject(sbnetobject); } /// -/// @brief Get the ghost index of this object from the server. @returns The ghost ID of this NetObject on the server @tsexample %ghostID = LocalClientConnection.getGhostId( %serverObject ); @endtsexample) +/// @brief Get the ghost index of this object from the server. +/// +/// @returns The ghost ID of this NetObject on the server +/// +/// @tsexample +/// %ghostID = LocalClientConnection.getGhostId( %serverObject ); +/// @endtsexample) +/// /// public int fnNetObject_getGhostID (string netobject) @@ -27462,7 +34817,21 @@ public int fnNetObject_getGhostID (string netobject) return SafeNativeMethods.mwle_fnNetObject_getGhostID(sbnetobject); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. @returns The SimObject ID of the server object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %serverObject = %node.getServerObject(); if(isObject(%serverObject) %serverObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns The SimObject ID of the server object. +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %serverObject = %node.getServerObject(); +/// if(isObject(%serverObject) +/// %serverObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int fnNetObject_getServerObject (string netobject) @@ -27476,7 +34845,9 @@ public int fnNetObject_getServerObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_getServerObject(sbnetobject); } /// -/// @brief Called to check if an object resides on the clientside. @return True if the object resides on the client, false otherwise.) +/// @brief Called to check if an object resides on the clientside. +/// @return True if the object resides on the client, false otherwise.) +/// /// public bool fnNetObject_isClientObject (string netobject) @@ -27490,7 +34861,9 @@ public bool fnNetObject_isClientObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_isClientObject(sbnetobject)>=1; } /// -/// @brief Checks if an object resides on the server. @return True if the object resides on the server, false otherwise.) +/// @brief Checks if an object resides on the server. +/// @return True if the object resides on the server, false otherwise.) +/// /// public bool fnNetObject_isServerObject (string netobject) @@ -27504,7 +34877,29 @@ public bool fnNetObject_isServerObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_isServerObject(sbnetobject)>=1; } /// -/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. @param client The connection this object will always be scoped to @tsexample // Called to create new cameras in TorqueScript // %this - The active GameConnection // %spawnPoint - The spawn point location where we creat the camera function GameConnection::spawnCamera(%this, %spawnPoint) { // If this connection's camera exists if(isObject(%this.camera)) { // Add it to the mission group to be cleaned up later MissionCleanup.add( %this.camera ); // Force it to scope to the client side %this.camera.scopeToClient(%this); } } @endtsexample @see clearScopeToClient()) +/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. +/// +/// @param client The connection this object will always be scoped to +/// +/// @tsexample +/// // Called to create new cameras in TorqueScript +/// // %this - The active GameConnection +/// // %spawnPoint - The spawn point location where we creat the camera +/// function GameConnection::spawnCamera(%this, %spawnPoint) +/// { +/// // If this connection's camera exists +/// if(isObject(%this.camera)) +/// { +/// // Add it to the mission group to be cleaned up later +/// MissionCleanup.add( %this.camera ); +/// // Force it to scope to the client side +/// %this.camera.scopeToClient(%this); +/// } +/// } +/// @endtsexample +/// +/// @see clearScopeToClient()) +/// /// public void fnNetObject_scopeToClient (string netobject, string client) @@ -27521,7 +34916,12 @@ public void fnNetObject_scopeToClient (string netobject, string client) SafeNativeMethods.mwle_fnNetObject_scopeToClient(sbnetobject, sbclient); } /// -/// @brief Always scope this object on all connections. The object is marked as ScopeAlways and is immediately ghosted to all active connections. This function has no effect if the object is not marked as Ghostable.) +/// @brief Always scope this object on all connections. +/// +/// The object is marked as ScopeAlways and is immediately ghosted to +/// all active connections. This function has no effect if the object +/// is not marked as Ghostable.) +/// /// public void fnNetObject_setScopeAlways (string netobject) @@ -27535,7 +34935,16 @@ public void fnNetObject_setScopeAlways (string netobject) SafeNativeMethods.mwle_fnNetObject_setScopeAlways(sbnetobject); } /// -/// Reloads this particle. @tsexample // Get the editor's current particle %particle = PE_ParticleEditor.currParticle // Change a particle value %particle.setFieldValue( %propertyField, %value ); // Reload it %particle.reload(); @endtsexample ) +/// Reloads this particle. +/// @tsexample +/// // Get the editor's current particle +/// %particle = PE_ParticleEditor.currParticle +/// // Change a particle value +/// %particle.setFieldValue( %propertyField, %value ); +/// // Reload it +/// %particle.reload(); +/// @endtsexample ) +/// /// public void fnParticleData_reload (string particledata) @@ -27549,7 +34958,16 @@ public void fnParticleData_reload (string particledata) SafeNativeMethods.mwle_fnParticleData_reload(sbparticledata); } /// -/// Reloads the ParticleData datablocks and other fields used by this emitter. @tsexample // Get the editor's current particle emitter %emitter = PE_EmitterEditor.currEmitter // Change a field value %emitter.setFieldValue( %propertyField, %value ); // Reload this emitter %emitter.reload(); @endtsexample) +/// Reloads the ParticleData datablocks and other fields used by this emitter. +/// @tsexample +/// // Get the editor's current particle emitter +/// %emitter = PE_EmitterEditor.currEmitter +/// // Change a field value +/// %emitter.setFieldValue( %propertyField, %value ); +/// // Reload this emitter +/// %emitter.reload(); +/// @endtsexample) +/// /// public void fnParticleEmitterData_reload (string particleemitterdata) @@ -27563,7 +34981,9 @@ public void fnParticleEmitterData_reload (string particleemitterdata) SafeNativeMethods.mwle_fnParticleEmitterData_reload(sbparticleemitterdata); } /// -/// Turns the emitter on or off. @param active New emitter state ) +/// Turns the emitter on or off. +/// @param active New emitter state ) +/// /// public void fnParticleEmitterNode_setActive (string particleemitternode, bool active) @@ -27577,7 +34997,13 @@ public void fnParticleEmitterNode_setActive (string particleemitternode, bool ac SafeNativeMethods.mwle_fnParticleEmitterNode_setActive(sbparticleemitternode, active); } /// -/// Assigns the datablock for this emitter node. @param emitterDatablock ParticleEmitterData datablock to assign @tsexample // Assign a new emitter datablock %emitter.setEmitterDatablock( %emitterDatablock ); @endtsexample ) +/// Assigns the datablock for this emitter node. +/// @param emitterDatablock ParticleEmitterData datablock to assign +/// @tsexample +/// // Assign a new emitter datablock +/// %emitter.setEmitterDatablock( %emitterDatablock ); +/// @endtsexample ) +/// /// public void fnParticleEmitterNode_setEmitterDataBlock (string particleemitternode, string emitterDatablock) @@ -27594,7 +35020,12 @@ public void fnParticleEmitterNode_setEmitterDataBlock (string particleemitternod SafeNativeMethods.mwle_fnParticleEmitterNode_setEmitterDataBlock(sbparticleemitternode, sbemitterDatablock); } /// -/// Removes the knot at the front of the camera's path. @tsexample // Remove the first knot in the camera's path. %pathCamera.popFront(); @endtsexample) +/// Removes the knot at the front of the camera's path. +/// @tsexample +/// // Remove the first knot in the camera's path. +/// %pathCamera.popFront(); +/// @endtsexample) +/// /// public void fnPathCamera_popFront (string pathcamera) @@ -27608,7 +35039,25 @@ public void fnPathCamera_popFront (string pathcamera) SafeNativeMethods.mwle_fnPathCamera_popFront(sbpathcamera); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the back of its path %pathCamera.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the back of its path +/// %pathCamera.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void fnPathCamera_pushBack (string pathcamera, string transform, float speed, string type, string path) @@ -27631,7 +35080,25 @@ public void fnPathCamera_pushBack (string pathcamera, string transform, float sp SafeNativeMethods.mwle_fnPathCamera_pushBack(sbpathcamera, sbtransform, speed, sbtype, sbpath); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the front of its path %pathCamera.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the front of its path +/// %pathCamera.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void fnPathCamera_pushFront (string pathcamera, string transform, float speed, string type, string path) @@ -27654,7 +35121,20 @@ public void fnPathCamera_pushFront (string pathcamera, string transform, float s SafeNativeMethods.mwle_fnPathCamera_pushFront(sbpathcamera, sbtransform, speed, sbtype, sbpath); } /// -/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. What specifically occurs is a new knot is created from the camera's current transform. Then the current path is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement state is set to Forward. The camera is now ready for a new path to be defined. @param speed Speed for the camera to move along its path after being reset. @tsexample //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. %speed = \"0.50\"; // Inform the path camera to start a new path at // the camera's current position, and set the new // path's speed value. %pathCamera.reset(%speed); @endtsexample) +/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. +/// What specifically occurs is a new knot is created from the camera's current transform. Then the current path +/// is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement +/// state is set to Forward. The camera is now ready for a new path to be defined. +/// @param speed Speed for the camera to move along its path after being reset. +/// @tsexample +/// //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. +/// %speed = \"0.50\"; +/// // Inform the path camera to start a new path at +/// // the camera's current position, and set the new +/// // path's speed value. +/// %pathCamera.reset(%speed); +/// @endtsexample) +/// /// public void fnPathCamera_reset (string pathcamera, float speed) @@ -27668,7 +35148,15 @@ public void fnPathCamera_reset (string pathcamera, float speed) SafeNativeMethods.mwle_fnPathCamera_reset(sbpathcamera, speed); } /// -/// Set the current position of the camera along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. @tsexample // Set the camera on a position along its path from 0.0 - 1.0. %position = \"0.35\"; // Force the pathCamera to its new position along the path. %pathCamera.setPosition(%position); @endtsexample) +/// Set the current position of the camera along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. +/// @tsexample +/// // Set the camera on a position along its path from 0.0 - 1.0. +/// %position = \"0.35\"; +/// // Force the pathCamera to its new position along the path. +/// %pathCamera.setPosition(%position); +/// @endtsexample) +/// /// public void fnPathCamera_setPosition (string pathcamera, float position) @@ -27682,7 +35170,17 @@ public void fnPathCamera_setPosition (string pathcamera, float position) SafeNativeMethods.mwle_fnPathCamera_setPosition(sbpathcamera, position); } /// -/// forward), Set the movement state for this path camera. @param newState New movement state type for this camera. Forward, Backward or Stop. @tsexample // Set the state type (forward, backward, stop). // In this example, the camera will travel from the first node // to the last node (or target if given with setTarget()) %state = \"forward\"; // Inform the pathCamera to change its movement state to the defined value. %pathCamera.setState(%state); @endtsexample) +/// forward), Set the movement state for this path camera. +/// @param newState New movement state type for this camera. Forward, Backward or Stop. +/// @tsexample +/// // Set the state type (forward, backward, stop). +/// // In this example, the camera will travel from the first node +/// // to the last node (or target if given with setTarget()) +/// %state = \"forward\"; +/// // Inform the pathCamera to change its movement state to the defined value. +/// %pathCamera.setState(%state); +/// @endtsexample) +/// /// public void fnPathCamera_setState (string pathcamera, string newState) @@ -27699,7 +35197,18 @@ public void fnPathCamera_setState (string pathcamera, string newState) SafeNativeMethods.mwle_fnPathCamera_setState(sbpathcamera, sbnewState); } /// -/// @brief Set the movement target for this camera along its path. The camera will attempt to move along the path to the given target in the direction provided by setState() (the default is forwards). Once the camera moves past this target it will come to a stop, and the target state will be cleared. @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. @tsexample // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. %position = \"0.50\"; // Inform the pathCamera of the new target position it will move to. %pathCamera.setTarget(%position); @endtsexample) +/// @brief Set the movement target for this camera along its path. +/// The camera will attempt to move along the path to the given target in the direction provided +/// by setState() (the default is forwards). Once the camera moves past this target it will come +/// to a stop, and the target state will be cleared. +/// @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. +/// @tsexample +/// // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. +/// %position = \"0.50\"; +/// // Inform the pathCamera of the new target position it will move to. +/// %pathCamera.setTarget(%position); +/// @endtsexample) +/// /// public void fnPathCamera_setTarget (string pathcamera, float position) @@ -27713,7 +35222,14 @@ public void fnPathCamera_setTarget (string pathcamera, float position) SafeNativeMethods.mwle_fnPathCamera_setTarget(sbpathcamera, position); } /// -/// Activate the physical zone's effects. @tsexample // Activate effects for a specific physical zone. %thisPhysicalZone.activate(); @endtsexample @ingroup Datablocks ) +/// Activate the physical zone's effects. +/// @tsexample +/// // Activate effects for a specific physical zone. +/// %thisPhysicalZone.activate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void fnPhysicalZone_activate (string physicalzone) @@ -27727,7 +35243,14 @@ public void fnPhysicalZone_activate (string physicalzone) SafeNativeMethods.mwle_fnPhysicalZone_activate(sbphysicalzone); } /// -/// Deactivate the physical zone's effects. @tsexample // Deactivate effects for a specific physical zone. %thisPhysicalZone.deactivate(); @endtsexample @ingroup Datablocks ) +/// Deactivate the physical zone's effects. +/// @tsexample +/// // Deactivate effects for a specific physical zone. +/// %thisPhysicalZone.deactivate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void fnPhysicalZone_deactivate (string physicalzone) @@ -27741,7 +35264,14 @@ public void fnPhysicalZone_deactivate (string physicalzone) SafeNativeMethods.mwle_fnPhysicalZone_deactivate(sbphysicalzone); } /// -/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. Performs a physics ray cast of the provided length and direction. The %PhysicsForce will attach itself to the first dynamic PhysicsBody the ray collides with. On every tick, the attached body will be attracted towards the position of the %PhysicsForce. A %PhysicsForce can only be attached to one body at a time. @note To determine if an %attach was successful, check isAttached() immediately after calling this function.n) +/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. +/// Performs a physics ray cast of the provided length and direction. The %PhysicsForce +/// will attach itself to the first dynamic PhysicsBody the ray collides with. +/// On every tick, the attached body will be attracted towards the position of the %PhysicsForce. +/// A %PhysicsForce can only be attached to one body at a time. +/// @note To determine if an %attach was successful, check isAttached() immediately after +/// calling this function.n) +/// /// public void fnPhysicsForce_attach (string physicsforce, string start, string direction, float maxDist) @@ -27761,7 +35291,11 @@ public void fnPhysicsForce_attach (string physicsforce, string start, string dir SafeNativeMethods.mwle_fnPhysicsForce_attach(sbphysicsforce, sbstart, sbdirection, maxDist); } /// -/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. @param force Optional force to apply to the attached PhysicsBody before detaching. @note Has no effect if the %PhysicsForce is not attached to anything.) +/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. +/// @param force Optional force to apply to the attached PhysicsBody +/// before detaching. +/// @note Has no effect if the %PhysicsForce is not attached to anything.) +/// /// public void fnPhysicsForce_detach (string physicsforce, string force) @@ -27778,7 +35312,9 @@ public void fnPhysicsForce_detach (string physicsforce, string force) SafeNativeMethods.mwle_fnPhysicsForce_detach(sbphysicsforce, sbforce); } /// -/// @brief Returns true if the %PhysicsForce is currently attached to an object. @see PhysicsForce::attach()) +/// @brief Returns true if the %PhysicsForce is currently attached to an object. +/// @see PhysicsForce::attach()) +/// /// public bool fnPhysicsForce_isAttached (string physicsforce) @@ -27792,7 +35328,12 @@ public bool fnPhysicsForce_isAttached (string physicsforce) return SafeNativeMethods.mwle_fnPhysicsForce_isAttached(sbphysicsforce)>=1; } /// -/// @brief Disables rendering and physical simulation. Calling destroy() will also spawn any explosions, debris, and/or destroyedShape defined for it, as well as remove it from the scene graph. Destroyed objects are only created on the server. Ghosting will later update the client. @note This does not actually delete the PhysicsShape. ) +/// @brief Disables rendering and physical simulation. +/// Calling destroy() will also spawn any explosions, debris, and/or destroyedShape +/// defined for it, as well as remove it from the scene graph. +/// Destroyed objects are only created on the server. Ghosting will later update the client. +/// @note This does not actually delete the PhysicsShape. ) +/// /// public void fnPhysicsShape_destroy (string physicsshape) @@ -27807,6 +35348,7 @@ public void fnPhysicsShape_destroy (string physicsshape) } /// /// @brief Returns if a PhysicsShape has been destroyed or not. ) +/// /// public bool fnPhysicsShape_isDestroyed (string physicsshape) @@ -27820,7 +35362,11 @@ public bool fnPhysicsShape_isDestroyed (string physicsshape) return SafeNativeMethods.mwle_fnPhysicsShape_isDestroyed(sbphysicsshape)>=1; } /// -/// @brief Restores the shape to its state before being destroyed. Re-enables rendering and physical simulation on the object and adds it to the client's scene graph. Has no effect if the shape is not destroyed.) +/// @brief Restores the shape to its state before being destroyed. +/// Re-enables rendering and physical simulation on the object and +/// adds it to the client's scene graph. +/// Has no effect if the shape is not destroyed.) +/// /// public void fnPhysicsShape_restore (string physicsshape) @@ -27834,7 +35380,19 @@ public void fnPhysicsShape_restore (string physicsshape) SafeNativeMethods.mwle_fnPhysicsShape_restore(sbphysicsshape); } /// -/// @brief Allow all poses a chance to occur. This method resets any poses that have manually been blocked from occuring. This includes the regular pose states such as sprinting, crouch, being prone and swimming. It also includes being able to jump and jet jump. While this is allowing these poses to occur it doesn't mean that they all can due to other conditions. We're just not manually blocking them from being allowed. @see allowJumping() @see allowJetJumping() @see allowSprinting() @see allowCrouching() @see allowProne() @see allowSwimming() ) +/// @brief Allow all poses a chance to occur. +/// This method resets any poses that have manually been blocked from occuring. +/// This includes the regular pose states such as sprinting, crouch, being prone +/// and swimming. It also includes being able to jump and jet jump. While this +/// is allowing these poses to occur it doesn't mean that they all can due to other +/// conditions. We're just not manually blocking them from being allowed. +/// @see allowJumping() +/// @see allowJetJumping() +/// @see allowSprinting() +/// @see allowCrouching() +/// @see allowProne() +/// @see allowSwimming() ) +/// /// public void fnPlayer_allowAllPoses (string player) @@ -27848,7 +35406,13 @@ public void fnPlayer_allowAllPoses (string player) SafeNativeMethods.mwle_fnPlayer_allowAllPoses(sbplayer); } /// -/// @brief Set if the Player is allowed to crouch. The default is to allow crouching unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow crouching at any time. @param state Set to true to allow crouching, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to crouch. +/// The default is to allow crouching unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow crouching +/// at any time. +/// @param state Set to true to allow crouching, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowCrouching (string player, bool state) @@ -27862,7 +35426,13 @@ public void fnPlayer_allowCrouching (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowCrouching(sbplayer, state); } /// -/// @brief Set if the Player is allowed to jet jump. The default is to allow jet jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jet jumping at any time. @param state Set to true to allow jet jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jet jump. +/// The default is to allow jet jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jet jumping +/// at any time. +/// @param state Set to true to allow jet jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowJetJumping (string player, bool state) @@ -27876,7 +35446,13 @@ public void fnPlayer_allowJetJumping (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowJetJumping(sbplayer, state); } /// -/// @brief Set if the Player is allowed to jump. The default is to allow jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jumping at any time. @param state Set to true to allow jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jump. +/// The default is to allow jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jumping +/// at any time. +/// @param state Set to true to allow jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowJumping (string player, bool state) @@ -27890,7 +35466,13 @@ public void fnPlayer_allowJumping (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowJumping(sbplayer, state); } /// -/// @brief Set if the Player is allowed to go prone. The default is to allow being prone unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow going prone at any time. @param state Set to true to allow being prone, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to go prone. +/// The default is to allow being prone unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow going prone +/// at any time. +/// @param state Set to true to allow being prone, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowProne (string player, bool state) @@ -27904,7 +35486,13 @@ public void fnPlayer_allowProne (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowProne(sbplayer, state); } /// -/// @brief Set if the Player is allowed to sprint. The default is to allow sprinting unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow sprinting at any time. @param state Set to true to allow sprinting, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to sprint. +/// The default is to allow sprinting unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow sprinting +/// at any time. +/// @param state Set to true to allow sprinting, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowSprinting (string player, bool state) @@ -27918,7 +35506,13 @@ public void fnPlayer_allowSprinting (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowSprinting(sbplayer, state); } /// -/// @brief Set if the Player is allowed to swim. The default is to allow swimming unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow swimming at any time. @param state Set to true to allow swimming, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to swim. +/// The default is to allow swimming unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow swimming +/// at any time. +/// @param state Set to true to allow swimming, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowSwimming (string player, bool state) @@ -27932,7 +35526,21 @@ public void fnPlayer_allowSwimming (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowSwimming(sbplayer, state); } /// -/// @brief Check if it is safe to dismount at this position. Internally this method casts a ray from oldPos to pos to determine if it hits the terrain, an interior object, a water object, another player, a static shape, a vehicle (exluding the one currently mounted), or physical zone. If this ray is in the clear, then the player's bounding box is also checked for a collision at the pos position. If this displaced bounding box is also in the clear, then checkDismountPoint() returns true. @param oldPos The player's current position @param pos The dismount position to check @return True if the dismount position is clear, false if not @note The player must be already mounted for this method to not assert.) +/// @brief Check if it is safe to dismount at this position. +/// +/// Internally this method casts a ray from oldPos to pos to determine if it hits the +/// terrain, an interior object, a water object, another player, a static shape, +/// a vehicle (exluding the one currently mounted), or physical zone. If this ray +/// is in the clear, then the player's bounding box is also checked for a collision at +/// the pos position. If this displaced bounding box is also in the clear, then +/// checkDismountPoint() returns true. +/// +/// @param oldPos The player's current position +/// @param pos The dismount position to check +/// @return True if the dismount position is clear, false if not +/// +/// @note The player must be already mounted for this method to not assert.) +/// /// public bool fnPlayer_checkDismountPoint (string player, string oldPos, string pos) @@ -27952,7 +35560,23 @@ public bool fnPlayer_checkDismountPoint (string player, string oldPos, string po return SafeNativeMethods.mwle_fnPlayer_checkDismountPoint(sbplayer, sboldPos, sbpos)>=1; } /// -/// @brief Clears the player's current control object. Returns control to the player. This internally calls Player::setControlObject(0). @tsexample %player.clearControlObject(); echo(%player.getControlObject()); //-- Returns 0, player assumes control %player.setControlObject(%vehicle); echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. @endtsexample @note If the player does not have a control object, the player will receive all moves from its GameConnection. If you're looking to remove control from the player itself (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer control to another object, such as a camera. @see setControlObject() @see getControlObject() @see GameConnection::setControlObject()) +/// @brief Clears the player's current control object. +/// Returns control to the player. This internally calls +/// Player::setControlObject(0). +/// @tsexample +/// %player.clearControlObject(); +/// echo(%player.getControlObject()); //-- Returns 0, player assumes control +/// %player.setControlObject(%vehicle); +/// echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. +/// @endtsexample +/// @note If the player does not have a control object, the player will receive all moves +/// from its GameConnection. If you're looking to remove control from the player itself +/// (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer +/// control to another object, such as a camera. +/// @see setControlObject() +/// @see getControlObject() +/// @see GameConnection::setControlObject()) +/// /// public void fnPlayer_clearControlObject (string player) @@ -27966,7 +35590,12 @@ public void fnPlayer_clearControlObject (string player) SafeNativeMethods.mwle_fnPlayer_clearControlObject(sbplayer); } /// -/// @brief Get the current object we are controlling. @return ID of the ShapeBase object we control, or 0 if not controlling an object. @see setControlObject() @see clearControlObject()) +/// @brief Get the current object we are controlling. +/// @return ID of the ShapeBase object we control, or 0 if not controlling an +/// object. +/// @see setControlObject() +/// @see clearControlObject()) +/// /// public int fnPlayer_getControlObject (string player) @@ -27980,7 +35609,59 @@ public int fnPlayer_getControlObject (string player) return SafeNativeMethods.mwle_fnPlayer_getControlObject(sbplayer); } /// -/// @brief Get the named damage location and modifier for a given world position. the Player object can simulate different hit locations based on a pre-defined set of PlayerData defined percentages. These hit percentages divide up the Player's bounding box into different regions. The diagram below demonstrates how the various PlayerData properties split up the bounding volume: img src=\"images/player_damageloc.png\"> While you may pass in any world position and getDamageLocation() will provide a best-fit location, you should be aware that this can produce some interesting results. For example, any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even if the world position is high in the sky. Therefore it may be wise to keep the passed in point to somewhere on the surface of, or within, the Player's bounding volume. @note This method will not return an accurate location when the player is prone or swimming. @param pos A world position for which to retrieve a body region on this player. @return a string containing two words (space separated strings), where the first is a location and the second is a modifier. Posible locations:ul> li>head/li> li>torso/li> li>legs/li>/ul> Head modifiers:ul> li>left_back/li> li>middle_back/li> li>right_back/li> li>left_middle/li> li>middle_middle/li> li>right_middle/li> li>left_front/li> li>middle_front/li> li>right_front/li>/ul> Legs/Torso modifiers:ul> li>front_left/li> li>front_right/li> li>back_left/li> li>back_right/li>/ul> @see PlayerData::boxHeadPercentage @see PlayerData::boxHeadFrontPercentage @see PlayerData::boxHeadBackPercentage @see PlayerData::boxHeadLeftPercentage @see PlayerData::boxHeadRightPercentage @see PlayerData::boxTorsoPercentage ) +/// @brief Get the named damage location and modifier for a given world position. +/// +/// the Player object can simulate different hit locations based on a pre-defined set +/// of PlayerData defined percentages. These hit percentages divide up the Player's +/// bounding box into different regions. The diagram below demonstrates how the various +/// PlayerData properties split up the bounding volume: +/// +/// img src=\"images/player_damageloc.png\"> +/// +/// While you may pass in any world position and getDamageLocation() will provide a best-fit +/// location, you should be aware that this can produce some interesting results. For example, +/// any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even +/// if the world position is high in the sky. Therefore it may be wise to keep the passed in point +/// to somewhere on the surface of, or within, the Player's bounding volume. +/// +/// @note This method will not return an accurate location when the player is +/// prone or swimming. +/// +/// @param pos A world position for which to retrieve a body region on this player. +/// +/// @return a string containing two words (space separated strings), where the +/// first is a location and the second is a modifier. +/// +/// Posible locations:ul> +/// li>head/li> +/// li>torso/li> +/// li>legs/li>/ul> +/// +/// Head modifiers:ul> +/// li>left_back/li> +/// li>middle_back/li> +/// li>right_back/li> +/// li>left_middle/li> +/// li>middle_middle/li> +/// li>right_middle/li> +/// li>left_front/li> +/// li>middle_front/li> +/// li>right_front/li>/ul> +/// +/// Legs/Torso modifiers:ul> +/// li>front_left/li> +/// li>front_right/li> +/// li>back_left/li> +/// li>back_right/li>/ul> +/// +/// @see PlayerData::boxHeadPercentage +/// @see PlayerData::boxHeadFrontPercentage +/// @see PlayerData::boxHeadBackPercentage +/// @see PlayerData::boxHeadLeftPercentage +/// @see PlayerData::boxHeadRightPercentage +/// @see PlayerData::boxTorsoPercentage +/// ) +/// /// public string fnPlayer_getDamageLocation (string player, string pos) @@ -28000,7 +35681,9 @@ public string fnPlayer_getDamageLocation (string player, string pos) } /// -/// @brief Get the number of death animations available to this player. Death animations are assumed to be named death1-N using consecutive indices. ) +/// @brief Get the number of death animations available to this player. +/// Death animations are assumed to be named death1-N using consecutive indices. ) +/// /// public int fnPlayer_getNumDeathAnimations (string player) @@ -28014,7 +35697,17 @@ public int fnPlayer_getNumDeathAnimations (string player) return SafeNativeMethods.mwle_fnPlayer_getNumDeathAnimations(sbplayer); } /// -/// @brief Get the name of the player's current pose. The pose is one of the following:ul> li>Stand - Standard movement pose./li> li>Sprint - Sprinting pose./li> li>Crouch - Crouch pose./li> li>Prone - Prone pose./li> li>Swim - Swimming pose./li>/ul> @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// @brief Get the name of the player's current pose. +/// +/// The pose is one of the following:ul> +/// li>Stand - Standard movement pose./li> +/// li>Sprint - Sprinting pose./li> +/// li>Crouch - Crouch pose./li> +/// li>Prone - Prone pose./li> +/// li>Swim - Swimming pose./li>/ul> +/// +/// @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// /// public string fnPlayer_getPose (string player) @@ -28031,7 +35724,16 @@ public string fnPlayer_getPose (string player) } /// -/// @brief Get the name of the player's current state. The state is one of the following:ul> li>Dead - The Player is dead./li> li>Mounted - The Player is mounted to an object such as a vehicle./li> li>Move - The Player is free to move. The usual state./li> li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// @brief Get the name of the player's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The Player is dead./li> +/// li>Mounted - The Player is mounted to an object such as a vehicle./li> +/// li>Move - The Player is free to move. The usual state./li> +/// li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// /// public string fnPlayer_getState (string player) @@ -28048,7 +35750,58 @@ public string fnPlayer_getState (string player) } /// -/// @brief Set the main action sequence to play for this player. @param name Name of the action sequence to set @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). When set to true no callback is made. @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's spine nodes to animate. @return True if succesful, false if failed @note The spine nodes for the Player's shape are named as follows:ul> li>Bip01 Pelvis/li> li>Bip01 Spine/li> li>Bip01 Spine1/li> li>Bip01 Spine2/li> li>Bip01 Neck/li> li>Bip01 Head/li>/ul> You cannot use setActionThread() to have the Player play one of the motion determined action animation sequences. These sequences are chosen based on how the Player moves and the Player's current pose. The names of these sequences are:ul> li>root/li> li>run/li> li>side/li> li>side_right/li> li>crouch_root/li> li>crouch_forward/li> li>crouch_backward/li> li>crouch_side/li> li>crouch_right/li> li>prone_root/li> li>prone_forward/li> li>prone_backward/li> li>swim_root/li> li>swim_forward/li> li>swim_backward/li> li>swim_left/li> li>swim_right/li> li>fall/li> li>jump/li> li>standjump/li> li>land/li> li>jet/li>/ul> If the player moves in any direction then the animation sequence set using this method will be cancelled and the chosen mation-based sequence will take over. This makes great for times when the Player cannot move, such as when mounted, or when it doesn't matter if the action sequence changes, such as waving and saluting. @tsexample // Place the player in a sitting position after being mounted %player.setActionThread( \"sitting\", true, true ); @endtsexample) +/// @brief Set the main action sequence to play for this player. +/// @param name Name of the action sequence to set +/// @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). +/// When set to true no callback is made. +/// @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's +/// spine nodes to animate. +/// @return True if succesful, false if failed +/// +/// @note The spine nodes for the Player's shape are named as follows:ul> +/// li>Bip01 Pelvis/li> +/// li>Bip01 Spine/li> +/// li>Bip01 Spine1/li> +/// li>Bip01 Spine2/li> +/// li>Bip01 Neck/li> +/// li>Bip01 Head/li>/ul> +/// +/// You cannot use setActionThread() to have the Player play one of the motion +/// determined action animation sequences. These sequences are chosen based on how +/// the Player moves and the Player's current pose. The names of these sequences are:ul> +/// li>root/li> +/// li>run/li> +/// li>side/li> +/// li>side_right/li> +/// li>crouch_root/li> +/// li>crouch_forward/li> +/// li>crouch_backward/li> +/// li>crouch_side/li> +/// li>crouch_right/li> +/// li>prone_root/li> +/// li>prone_forward/li> +/// li>prone_backward/li> +/// li>swim_root/li> +/// li>swim_forward/li> +/// li>swim_backward/li> +/// li>swim_left/li> +/// li>swim_right/li> +/// li>fall/li> +/// li>jump/li> +/// li>standjump/li> +/// li>land/li> +/// li>jet/li>/ul> +/// +/// If the player moves in any direction then the animation sequence set using this +/// method will be cancelled and the chosen mation-based sequence will take over. This makes +/// great for times when the Player cannot move, such as when mounted, or when it doesn't matter +/// if the action sequence changes, such as waving and saluting. +/// +/// @tsexample +/// // Place the player in a sitting position after being mounted +/// %player.setActionThread( \"sitting\", true, true ); +/// @endtsexample) +/// /// public bool fnPlayer_setActionThread (string player, string name, bool hold, bool fsp) @@ -28065,7 +35818,12 @@ public bool fnPlayer_setActionThread (string player, string name, bool hold, boo return SafeNativeMethods.mwle_fnPlayer_setActionThread(sbplayer, sbname, hold, fsp)>=1; } /// -/// @brief Set the sequence that controls the player's arms (dynamically adjusted to match look direction). @param name Name of the sequence to play on the player's arms. @return true if successful, false if failed. @note By default the 'look' sequence is used, if available.) +/// @brief Set the sequence that controls the player's arms (dynamically adjusted +/// to match look direction). +/// @param name Name of the sequence to play on the player's arms. +/// @return true if successful, false if failed. +/// @note By default the 'look' sequence is used, if available.) +/// /// public bool fnPlayer_setArmThread (string player, string name) @@ -28082,7 +35840,23 @@ public bool fnPlayer_setArmThread (string player, string name) return SafeNativeMethods.mwle_fnPlayer_setArmThread(sbplayer, sbname)>=1; } /// -/// @brief Set the object to be controlled by this player It is possible to have the moves sent to the Player object from the GameConnection to be passed along to another object. This happens, for example when a player is mounted to a vehicle. The move commands pass through the Player and on to the vehicle (while the player remains stationary within the vehicle). With setControlObject() you can have the Player pass along its moves to any object. One possible use is for a player to move a remote controlled vehicle. In this case the player does not mount the vehicle directly, but still wants to be able to control it. @param obj Object to control with this player @return True if the object is valid, false if not @see getControlObject() @see clearControlObject() @see GameConnection::setControlObject()) +/// @brief Set the object to be controlled by this player +/// +/// It is possible to have the moves sent to the Player object from the +/// GameConnection to be passed along to another object. This happens, for example +/// when a player is mounted to a vehicle. The move commands pass through the Player +/// and on to the vehicle (while the player remains stationary within the vehicle). +/// With setControlObject() you can have the Player pass along its moves to any object. +/// One possible use is for a player to move a remote controlled vehicle. In this case +/// the player does not mount the vehicle directly, but still wants to be able to control it. +/// +/// @param obj Object to control with this player +/// @return True if the object is valid, false if not +/// +/// @see getControlObject() +/// @see clearControlObject() +/// @see GameConnection::setControlObject()) +/// /// public bool fnPlayer_setControlObject (string player, string obj) @@ -28099,7 +35873,9 @@ public bool fnPlayer_setControlObject (string player, string obj) return SafeNativeMethods.mwle_fnPlayer_setControlObject(sbplayer, sbobj)>=1; } /// -/// Test whether the portal connects interior zones to the outdoor zone. @return True if the portal is an exterior portal. ) +/// Test whether the portal connects interior zones to the outdoor zone. +/// @return True if the portal is an exterior portal. ) +/// /// public bool fnPortal_isExteriorPortal (string portal) @@ -28113,7 +35889,9 @@ public bool fnPortal_isExteriorPortal (string portal) return SafeNativeMethods.mwle_fnPortal_isExteriorPortal(sbportal)>=1; } /// -/// Test whether the portal connects interior zones only. @return True if the portal is an interior portal. ) +/// Test whether the portal connects interior zones only. +/// @return True if the portal is an interior portal. ) +/// /// public bool fnPortal_isInteriorPortal (string portal) @@ -28128,6 +35906,7 @@ public bool fnPortal_isInteriorPortal (string portal) } /// /// Remove all shader macros. ) +/// /// public void fnPostEffect_clearShaderMacros (string posteffect) @@ -28142,6 +35921,7 @@ public void fnPostEffect_clearShaderMacros (string posteffect) } /// /// Disables the effect. ) +/// /// public void fnPostEffect_disable (string posteffect) @@ -28155,7 +35935,9 @@ public void fnPostEffect_disable (string posteffect) SafeNativeMethods.mwle_fnPostEffect_disable(sbposteffect); } /// -/// Dumps this PostEffect shader's disassembly to a temporary text file. @return Full path to the dumped file or an empty string if failed. ) +/// Dumps this PostEffect shader's disassembly to a temporary text file. +/// @return Full path to the dumped file or an empty string if failed. ) +/// /// public string fnPostEffect_dumpShaderDisassembly (string posteffect) @@ -28173,6 +35955,7 @@ public string fnPostEffect_dumpShaderDisassembly (string posteffect) } /// /// Enables the effect. ) +/// /// public void fnPostEffect_enable (string posteffect) @@ -28187,6 +35970,7 @@ public void fnPostEffect_enable (string posteffect) } /// /// @return Width over height of the backbuffer. ) +/// /// public float fnPostEffect_getAspectRatio (string posteffect) @@ -28201,6 +35985,7 @@ public float fnPostEffect_getAspectRatio (string posteffect) } /// /// @return True if the effect is enabled. ) +/// /// public bool fnPostEffect_isEnabled (string posteffect) @@ -28215,6 +36000,7 @@ public bool fnPostEffect_isEnabled (string posteffect) } /// /// Reloads the effect shader and textures. ) +/// /// public void fnPostEffect_reload (string posteffect) @@ -28228,7 +36014,9 @@ public void fnPostEffect_reload (string posteffect) SafeNativeMethods.mwle_fnPostEffect_reload(sbposteffect); } /// -/// Remove a shader macro. This will usually be called within the preProcess callback. @param key Macro to remove. ) +/// Remove a shader macro. This will usually be called within the preProcess callback. +/// @param key Macro to remove. ) +/// /// public void fnPostEffect_removeShaderMacro (string posteffect, string key) @@ -28245,7 +36033,23 @@ public void fnPostEffect_removeShaderMacro (string posteffect, string key) SafeNativeMethods.mwle_fnPostEffect_removeShaderMacro(sbposteffect, sbkey); } /// -/// Sets the value of a uniform defined in the shader. This will usually be called within the setShaderConsts callback. Array type constants are not supported. @param name Name of the constanst, prefixed with '$'. @param value Value to set, space seperate values with more than one element. @tsexample function MyPfx::setShaderConsts( %this ) { // example float4 uniform %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); // example float1 uniform %this.setShaderConst( \"$strength\", \"3.0\" ); // example integer uniform %this.setShaderConst( \"$loops\", \"5\" ); } @endtsexample ) +/// Sets the value of a uniform defined in the shader. This will usually +/// be called within the setShaderConsts callback. Array type constants are +/// not supported. +/// @param name Name of the constanst, prefixed with '$'. +/// @param value Value to set, space seperate values with more than one element. +/// @tsexample +/// function MyPfx::setShaderConsts( %this ) +/// { +/// // example float4 uniform +/// %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); +/// // example float1 uniform +/// %this.setShaderConst( \"$strength\", \"3.0\" ); +/// // example integer uniform +/// %this.setShaderConst( \"$loops\", \"5\" ); +/// } +/// @endtsexample ) +/// /// public void fnPostEffect_setShaderConst (string posteffect, string name, string value) @@ -28265,7 +36069,23 @@ public void fnPostEffect_setShaderConst (string posteffect, string name, string SafeNativeMethods.mwle_fnPostEffect_setShaderConst(sbposteffect, sbname, sbvalue); } /// -/// ), Adds a macro to the effect's shader or sets an existing one's value. This will usually be called within the onAdd or preProcess callback. @param key lval of the macro. @param value rval of the macro, or may be empty. @tsexample function MyPfx::onAdd( %this ) { %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); // In the shader looks like... // #define NUM_SAMPLES 10 // #define HIGH_QUALITY_MODE } @endtsexample ) +/// ), +/// Adds a macro to the effect's shader or sets an existing one's value. +/// This will usually be called within the onAdd or preProcess callback. +/// @param key lval of the macro. +/// @param value rval of the macro, or may be empty. +/// @tsexample +/// function MyPfx::onAdd( %this ) +/// { +/// %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); +/// %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); +/// +/// // In the shader looks like... +/// // #define NUM_SAMPLES 10 +/// // #define HIGH_QUALITY_MODE +/// } +/// @endtsexample ) +/// /// public void fnPostEffect_setShaderMacro (string posteffect, string key, string value) @@ -28285,7 +36105,12 @@ public void fnPostEffect_setShaderMacro (string posteffect, string key, string v SafeNativeMethods.mwle_fnPostEffect_setShaderMacro(sbposteffect, sbkey, sbvalue); } /// -/// This is used to set the texture file and load the texture on a running effect. If the texture file is not different from the current file nothing is changed. If the texture cannot be found a null texture is assigned. @param index The texture stage index. @param filePath The file name of the texture to set. ) +/// This is used to set the texture file and load the texture on a running effect. +/// If the texture file is not different from the current file nothing is changed. If +/// the texture cannot be found a null texture is assigned. +/// @param index The texture stage index. +/// @param filePath The file name of the texture to set. ) +/// /// public void fnPostEffect_setTexture (string posteffect, int index, string filePath) @@ -28302,7 +36127,9 @@ public void fnPostEffect_setTexture (string posteffect, int index, string filePa SafeNativeMethods.mwle_fnPostEffect_setTexture(sbposteffect, index, sbfilePath); } /// -/// Toggles the effect between enabled / disabled. @return True if effect is enabled. ) +/// Toggles the effect between enabled / disabled. +/// @return True if effect is enabled. ) +/// /// public bool fnPostEffect_toggle (string posteffect) @@ -28316,7 +36143,20 @@ public bool fnPostEffect_toggle (string posteffect) return SafeNativeMethods.mwle_fnPostEffect_toggle(sbposteffect)>=1; } /// -/// Smoothly change the maximum number of drops in the effect (from current value to #numDrops * @a percentage). This method can be used to simulate a storm building or fading in intensity as the number of drops in the Precipitation box changes. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @param seconds Length of time (in seconds) over which to increase the drops percentage value. Set to 0 to change instantly. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %seconds = 5.0; // The length of time over which to make the change. %precipitation.modifyStorm( %percentage, %seconds ); @endtsexample ) +/// Smoothly change the maximum number of drops in the effect (from current +/// value to #numDrops * @a percentage). +/// This method can be used to simulate a storm building or fading in intensity +/// as the number of drops in the Precipitation box changes. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @param seconds Length of time (in seconds) over which to increase the drops +/// percentage value. Set to 0 to change instantly. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.modifyStorm( %percentage, %seconds ); +/// @endtsexample ) +/// /// public void fnPrecipitation_modifyStorm (string precipitation, float percentage, float seconds) @@ -28330,7 +36170,17 @@ public void fnPrecipitation_modifyStorm (string precipitation, float percentage, SafeNativeMethods.mwle_fnPrecipitation_modifyStorm(sbprecipitation, percentage, seconds); } /// -/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. The change occurs instantly (use modifyStorm() to change the number of drops over a period of time. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %precipitation.setPercentage( %percentage ); @endtsexample @see modifyStorm ) +/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. +/// The change occurs instantly (use modifyStorm() to change the number of drops +/// over a period of time. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %precipitation.setPercentage( %percentage ); +/// @endtsexample +/// @see modifyStorm ) +/// /// public void fnPrecipitation_setPercentage (string precipitation, float percentage) @@ -28344,7 +36194,18 @@ public void fnPrecipitation_setPercentage (string precipitation, float percentag SafeNativeMethods.mwle_fnPrecipitation_setPercentage(sbprecipitation, percentage); } /// -/// Smoothly change the turbulence parameters over a period of time. @param max New #maxTurbulence value. Set to 0 to disable turbulence. @param speed New #turbulenceSpeed value. @param seconds Length of time (in seconds) over which to interpolate the turbulence settings. Set to 0 to change instantly. @tsexample %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. %speed = 5.0; // The new speed of the turbulance effect. %seconds = 5.0; // The length of time over which to make the change. %precipitation.setTurbulence( %turbulence, %speed, %seconds ); @endtsexample ) +/// Smoothly change the turbulence parameters over a period of time. +/// @param max New #maxTurbulence value. Set to 0 to disable turbulence. +/// @param speed New #turbulenceSpeed value. +/// @param seconds Length of time (in seconds) over which to interpolate the +/// turbulence settings. Set to 0 to change instantly. +/// @tsexample +/// %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. +/// %speed = 5.0; // The new speed of the turbulance effect. +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.setTurbulence( %turbulence, %speed, %seconds ); +/// @endtsexample ) +/// /// public void fnPrecipitation_setTurbulence (string precipitation, float max, float speed, float seconds) @@ -28358,7 +36219,19 @@ public void fnPrecipitation_setTurbulence (string precipitation, float max, floa SafeNativeMethods.mwle_fnPrecipitation_setTurbulence(sbprecipitation, max, speed, seconds); } /// -/// @brief Updates the projectile's positional and collision information. This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. Also responsible for applying gravity, determining collisions, triggering explosions, emitting trail particles, and calculating bounces if necessary. @param seconds Amount of time, in seconds since the simulation's start, to advance. @tsexample // Tell the projectile to process a simulation event, and provide the amount of time // that has passed since the simulation began. %seconds = 2.0; %projectile.presimulate(%seconds); @endtsexample @note This function is not called if the SimObject::hidden is true.) +/// @brief Updates the projectile's positional and collision information. +/// This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. +/// Also responsible for applying gravity, determining collisions, triggering explosions, +/// emitting trail particles, and calculating bounces if necessary. +/// @param seconds Amount of time, in seconds since the simulation's start, to advance. +/// @tsexample +/// // Tell the projectile to process a simulation event, and provide the amount of time +/// // that has passed since the simulation began. +/// %seconds = 2.0; +/// %projectile.presimulate(%seconds); +/// @endtsexample +/// @note This function is not called if the SimObject::hidden is true.) +/// /// public void fnProjectile_presimulate (string projectile, float seconds) @@ -28373,6 +36246,7 @@ public void fnProjectile_presimulate (string projectile, float seconds) } /// /// @brief Manually cause the mine to explode.) +/// /// public void fnProximityMine_explode (string proximitymine) @@ -28387,6 +36261,7 @@ public void fnProximityMine_explode (string proximitymine) } /// /// Returns the bin type string. ) +/// /// public string fnRenderBinManager_getBinType (string renderbinmanager) @@ -28404,6 +36279,7 @@ public string fnRenderBinManager_getBinType (string renderbinmanager) } /// /// A utility method for forcing a network update.) +/// /// public void fnRenderMeshExample_postApply (string rendermeshexample) @@ -28418,6 +36294,7 @@ public void fnRenderMeshExample_postApply (string rendermeshexample) } /// /// Add as a render bin manager to the pass. ) +/// /// public void fnRenderPassManager_addManager (string renderpassmanager, string renderBin) @@ -28435,6 +36312,7 @@ public void fnRenderPassManager_addManager (string renderpassmanager, string ren } /// /// Returns the render bin manager at the index or null if the index is out of range. ) +/// /// public string fnRenderPassManager_getManager (string renderpassmanager, int index) @@ -28452,6 +36330,7 @@ public string fnRenderPassManager_getManager (string renderpassmanager, int inde } /// /// Returns the total number of bin managers. ) +/// /// public int fnRenderPassManager_getManagerCount (string renderpassmanager) @@ -28466,6 +36345,7 @@ public int fnRenderPassManager_getManagerCount (string renderpassmanager) } /// /// Removes a render bin manager. ) +/// /// public void fnRenderPassManager_removeManager (string renderpassmanager, string renderBin) @@ -28483,6 +36363,7 @@ public void fnRenderPassManager_removeManager (string renderpassmanager, string } /// /// @brief Disables the token.) +/// /// public void fnRenderPassStateToken_disable (string renderpassstatetoken) @@ -28497,6 +36378,7 @@ public void fnRenderPassStateToken_disable (string renderpassstatetoken) } /// /// @brief Enables the token. ) +/// /// public void fnRenderPassStateToken_enable (string renderpassstatetoken) @@ -28511,6 +36393,7 @@ public void fnRenderPassStateToken_enable (string renderpassstatetoken) } /// /// @brief Toggles the token from enabled to disabled or vice versa. ) +/// /// public void fnRenderPassStateToken_toggle (string renderpassstatetoken) @@ -28525,6 +36408,7 @@ public void fnRenderPassStateToken_toggle (string renderpassstatetoken) } /// /// @brief Forces the client to jump to the RigidShape's transform rather then warp to it.) +/// /// public void fnRigidShape_forceClientTransform (string rigidshape) @@ -28538,7 +36422,16 @@ public void fnRigidShape_forceClientTransform (string rigidshape) SafeNativeMethods.mwle_fnRigidShape_forceClientTransform(sbrigidshape); } /// -/// @brief Enables or disables the physics simulation on the RigidShape object. @param isFrozen Boolean frozen state to set the object. @tsexample // Define the frozen state. %isFrozen = \"true\"; // Inform the object of the defined frozen state %thisRigidShape.freezeSim(%isFrozen); @endtsexample @see ShapeBaseData) +/// @brief Enables or disables the physics simulation on the RigidShape object. +/// @param isFrozen Boolean frozen state to set the object. +/// @tsexample +/// // Define the frozen state. +/// %isFrozen = \"true\"; +/// // Inform the object of the defined frozen state +/// %thisRigidShape.freezeSim(%isFrozen); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void fnRigidShape_freezeSim (string rigidshape, bool isFrozen) @@ -28552,7 +36445,13 @@ public void fnRigidShape_freezeSim (string rigidshape, bool isFrozen) SafeNativeMethods.mwle_fnRigidShape_freezeSim(sbrigidshape, isFrozen); } /// -/// @brief Clears physic forces from the shape and sets it at rest. @tsexample // Inform the RigidShape object to reset. %thisRigidShape.reset(); @endtsexample @see ShapeBaseData) +/// @brief Clears physic forces from the shape and sets it at rest. +/// @tsexample +/// // Inform the RigidShape object to reset. +/// %thisRigidShape.reset(); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void fnRigidShape_reset (string rigidshape) @@ -28566,7 +36465,10 @@ public void fnRigidShape_reset (string rigidshape) SafeNativeMethods.mwle_fnRigidShape_reset(sbrigidshape); } /// -/// Intended as a helper to developers and editor scripts. Force River to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force River to recreate its geometry. +/// ) +/// /// public void fnRiver_regenerate (string river) @@ -28580,7 +36482,10 @@ public void fnRiver_regenerate (string river) SafeNativeMethods.mwle_fnRiver_regenerate(sbriver); } /// -/// Intended as a helper to developers and editor scripts. BatchSize is not currently used. ) +/// Intended as a helper to developers and editor scripts. +/// BatchSize is not currently used. +/// ) +/// /// public void fnRiver_setBatchSize (string river, float meters) @@ -28594,7 +36499,10 @@ public void fnRiver_setBatchSize (string river, float meters) SafeNativeMethods.mwle_fnRiver_setBatchSize(sbriver, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SubdivideLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SubdivideLength field. +/// ) +/// /// public void fnRiver_setMaxDivisionSize (string river, float meters) @@ -28608,7 +36516,10 @@ public void fnRiver_setMaxDivisionSize (string river, float meters) SafeNativeMethods.mwle_fnRiver_setMaxDivisionSize(sbriver, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SegmentLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SegmentLength field. +/// ) +/// /// public void fnRiver_setMetersPerSegment (string river, float meters) @@ -28622,7 +36533,10 @@ public void fnRiver_setMetersPerSegment (string river, float meters) SafeNativeMethods.mwle_fnRiver_setMetersPerSegment(sbriver, meters); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void fnRiver_setNodeDepth (string river, int idx, float meters) @@ -28636,7 +36550,9 @@ public void fnRiver_setNodeDepth (string river, int idx, float meters) SafeNativeMethods.mwle_fnRiver_setNodeDepth(sbriver, idx, meters); } /// -/// Apply a full network update of all fields to all clients. ) +/// Apply a full network update of all fields to all clients. +/// ) +/// /// public void fnScatterSky_applyChanges (string scattersky) @@ -28650,7 +36566,10 @@ public void fnScatterSky_applyChanges (string scattersky) SafeNativeMethods.mwle_fnScatterSky_applyChanges(sbscattersky); } /// -/// Get Euler rotation of this object. @return the orientation of the object in the form of rotations around the X, Y and Z axes in degrees. ) +/// Get Euler rotation of this object. +/// @return the orientation of the object in the form of rotations around the +/// X, Y and Z axes in degrees. ) +/// /// public string fnSceneObject_getEulerRotation (string sceneobject) @@ -28667,7 +36586,10 @@ public string fnSceneObject_getEulerRotation (string sceneobject) } /// -/// Get the direction this object is facing. @return a vector indicating the direction this object is facing. @note This is the object's y axis. ) +/// Get the direction this object is facing. +/// @return a vector indicating the direction this object is facing. +/// @note This is the object's y axis. ) +/// /// public string fnSceneObject_getForwardVector (string sceneobject) @@ -28684,7 +36606,9 @@ public string fnSceneObject_getForwardVector (string sceneobject) } /// -/// Get the object's inverse transform. @return the inverse transform of the object ) +/// Get the object's inverse transform. +/// @return the inverse transform of the object ) +/// /// public string fnSceneObject_getInverseTransform (string sceneobject) @@ -28701,7 +36625,10 @@ public string fnSceneObject_getInverseTransform (string sceneobject) } /// -/// Get the object mounted at a particular slot. @param slot mount slot index to query @return ID of the object mounted in the slot, or 0 if no object. ) +/// Get the object mounted at a particular slot. +/// @param slot mount slot index to query +/// @return ID of the object mounted in the slot, or 0 if no object. ) +/// /// public int fnSceneObject_getMountedObject (string sceneobject, int slot) @@ -28715,7 +36642,9 @@ public int fnSceneObject_getMountedObject (string sceneobject, int slot) return SafeNativeMethods.mwle_fnSceneObject_getMountedObject(sbsceneobject, slot); } /// -/// Get the number of objects mounted to us. @return the number of mounted objects. ) +/// Get the number of objects mounted to us. +/// @return the number of mounted objects. ) +/// /// public int fnSceneObject_getMountedObjectCount (string sceneobject) @@ -28729,7 +36658,10 @@ public int fnSceneObject_getMountedObjectCount (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_getMountedObjectCount(sbsceneobject); } /// -/// @brief Get the mount node index of the object mounted at our given slot. @param slot mount slot index to query @return index of the mount node used by the object mounted in this slot. ) +/// @brief Get the mount node index of the object mounted at our given slot. +/// @param slot mount slot index to query +/// @return index of the mount node used by the object mounted in this slot. ) +/// /// public int fnSceneObject_getMountedObjectNode (string sceneobject, int slot) @@ -28743,7 +36675,10 @@ public int fnSceneObject_getMountedObjectNode (string sceneobject, int slot) return SafeNativeMethods.mwle_fnSceneObject_getMountedObjectNode(sbsceneobject, slot); } /// -/// @brief Get the object mounted at our given node index. @param node mount node index to query @return ID of the first object mounted at the node, or 0 if none found. ) +/// @brief Get the object mounted at our given node index. +/// @param node mount node index to query +/// @return ID of the first object mounted at the node, or 0 if none found. ) +/// /// public int fnSceneObject_getMountNodeObject (string sceneobject, int node) @@ -28757,7 +36692,10 @@ public int fnSceneObject_getMountNodeObject (string sceneobject, int node) return SafeNativeMethods.mwle_fnSceneObject_getMountNodeObject(sbsceneobject, node); } /// -/// Get the object's bounding box (relative to the object's origin). @return six fields, two Point3Fs, containing the min and max points of the objectbox. ) +/// Get the object's bounding box (relative to the object's origin). +/// @return six fields, two Point3Fs, containing the min and max points of the +/// objectbox. ) +/// /// public string fnSceneObject_getObjectBox (string sceneobject) @@ -28774,7 +36712,9 @@ public string fnSceneObject_getObjectBox (string sceneobject) } /// -/// @brief Get the object we are mounted to. @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// @brief Get the object we are mounted to. +/// @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// /// public int fnSceneObject_getObjectMount (string sceneobject) @@ -28788,7 +36728,9 @@ public int fnSceneObject_getObjectMount (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_getObjectMount(sbsceneobject); } /// -/// Get the object's world position. @return the current world position of the object ) +/// Get the object's world position. +/// @return the current world position of the object ) +/// /// public string fnSceneObject_getPosition (string sceneobject) @@ -28805,7 +36747,10 @@ public string fnSceneObject_getPosition (string sceneobject) } /// -/// Get the right vector of the object. @return a vector indicating the right direction of this object. @note This is the object's x axis. ) +/// Get the right vector of the object. +/// @return a vector indicating the right direction of this object. +/// @note This is the object's x axis. ) +/// /// public string fnSceneObject_getRightVector (string sceneobject) @@ -28822,7 +36767,9 @@ public string fnSceneObject_getRightVector (string sceneobject) } /// -/// Get the object's scale. @return object scale as a Point3F ) +/// Get the object's scale. +/// @return object scale as a Point3F ) +/// /// public string fnSceneObject_getScale (string sceneobject) @@ -28839,7 +36786,9 @@ public string fnSceneObject_getScale (string sceneobject) } /// -/// Get the object's transform. @return the current transform of the object ) +/// Get the object's transform. +/// @return the current transform of the object ) +/// /// public string fnSceneObject_getTransform (string sceneobject) @@ -28856,7 +36805,9 @@ public string fnSceneObject_getTransform (string sceneobject) } /// -/// Return the type mask for this object. @return The numeric type mask for the object. ) +/// Return the type mask for this object. +/// @return The numeric type mask for the object. ) +/// /// public int fnSceneObject_getType (string sceneobject) @@ -28870,7 +36821,10 @@ public int fnSceneObject_getType (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_getType(sbsceneobject); } /// -/// Get the up vector of the object. @return a vector indicating the up direction of this object. @note This is the object's z axis. ) +/// Get the up vector of the object. +/// @return a vector indicating the up direction of this object. +/// @note This is the object's z axis. ) +/// /// public string fnSceneObject_getUpVector (string sceneobject) @@ -28887,7 +36841,10 @@ public string fnSceneObject_getUpVector (string sceneobject) } /// -/// Get the object's world bounding box. @return six fields, two Point3Fs, containing the min and max points of the worldbox. ) +/// Get the object's world bounding box. +/// @return six fields, two Point3Fs, containing the min and max points of the +/// worldbox. ) +/// /// public string fnSceneObject_getWorldBox (string sceneobject) @@ -28904,7 +36861,9 @@ public string fnSceneObject_getWorldBox (string sceneobject) } /// -/// Get the center of the object's world bounding box. @return the center of the world bounding box for this object. ) +/// Get the center of the object's world bounding box. +/// @return the center of the world bounding box for this object. ) +/// /// public string fnSceneObject_getWorldBoxCenter (string sceneobject) @@ -28921,7 +36880,11 @@ public string fnSceneObject_getWorldBoxCenter (string sceneobject) } /// -/// Check if this object has a global bounds set. If global bounds are set to be true, then the object is assumed to have an infinitely large bounding box for collision and rendering purposes. @return true if the object has a global bounds. ) +/// Check if this object has a global bounds set. +/// If global bounds are set to be true, then the object is assumed to have an +/// infinitely large bounding box for collision and rendering purposes. +/// @return true if the object has a global bounds. ) +/// /// public bool fnSceneObject_isGlobalBounds (string sceneobject) @@ -28935,7 +36898,9 @@ public bool fnSceneObject_isGlobalBounds (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_isGlobalBounds(sbsceneobject)>=1; } /// -/// @brief Check if we are mounted to another object. @return true if mounted to another object, false if not mounted. ) +/// @brief Check if we are mounted to another object. +/// @return true if mounted to another object, false if not mounted. ) +/// /// public bool fnSceneObject_isMounted (string sceneobject) @@ -28949,7 +36914,13 @@ public bool fnSceneObject_isMounted (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_isMounted(sbsceneobject)>=1; } /// -/// @brief Mount objB to this object at the desired slot with optional transform. @param objB Object to mount onto us @param slot Mount slot ID @param txfm (optional) mount offset transform @return true if successful, false if failed (objB is not valid) ) +/// @brief Mount objB to this object at the desired slot with optional transform. +/// +/// @param objB Object to mount onto us +/// @param slot Mount slot ID +/// @param txfm (optional) mount offset transform +/// @return true if successful, false if failed (objB is not valid) ) +/// /// public bool fnSceneObject_mountObject (string sceneobject, string objB, int slot, string txfm) @@ -28969,7 +36940,9 @@ public bool fnSceneObject_mountObject (string sceneobject, string objB, int slot return SafeNativeMethods.mwle_fnSceneObject_mountObject(sbsceneobject, sbobjB, slot, sbtxfm)>=1; } /// -/// Set the object's scale. @param scale object scale to set ) +/// Set the object's scale. +/// @param scale object scale to set ) +/// /// public void fnSceneObject_setScale (string sceneobject, string scale) @@ -28986,7 +36959,9 @@ public void fnSceneObject_setScale (string sceneobject, string scale) SafeNativeMethods.mwle_fnSceneObject_setScale(sbsceneobject, sbscale); } /// -/// Set the object's transform (orientation and position). @param txfm object transform to set ) +/// Set the object's transform (orientation and position). +/// @param txfm object transform to set ) +/// /// public void fnSceneObject_setTransform (string sceneobject, string txfm) @@ -29003,7 +36978,9 @@ public void fnSceneObject_setTransform (string sceneobject, string txfm) SafeNativeMethods.mwle_fnSceneObject_setTransform(sbsceneobject, sbtxfm); } /// -/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_TickCounterAdd (string sceneobject, string countername, uint interval) @@ -29020,7 +36997,9 @@ public bool fnSceneObject_TickCounterAdd (string sceneobject, string countername return SafeNativeMethods.mwle_fnSceneObject_TickCounterAdd(sbsceneobject, sbcountername, interval)>=1; } /// -/// @brief returns the interval for a counter. @return true if successful, false if failed ) +/// @brief returns the interval for a counter. +/// @return true if successful, false if failed ) +/// /// public uint fnSceneObject_TickCounterGetInterval (string sceneobject, string countername) @@ -29037,7 +37016,9 @@ public uint fnSceneObject_TickCounterGetInterval (string sceneobject, string cou return SafeNativeMethods.mwle_fnSceneObject_TickCounterGetInterval(sbsceneobject, sbcountername); } /// -/// @brief Checks to see if the counter exists. @return true if successful, false if failed ) +/// @brief Checks to see if the counter exists. +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_TickCounterHas (string sceneobject, string countername) @@ -29054,7 +37035,9 @@ public bool fnSceneObject_TickCounterHas (string sceneobject, string countername return SafeNativeMethods.mwle_fnSceneObject_TickCounterHas(sbsceneobject, sbcountername)>=1; } /// -/// @brief Removes a counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Removes a counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_TickCounterRemove (string sceneobject, string countername) @@ -29071,7 +37054,9 @@ public bool fnSceneObject_TickCounterRemove (string sceneobject, string countern return SafeNativeMethods.mwle_fnSceneObject_TickCounterRemove(sbsceneobject, sbcountername)>=1; } /// -/// @brief resets the current count for a counter. @return true if successful, false if failed ) +/// @brief resets the current count for a counter. +/// @return true if successful, false if failed ) +/// /// public void fnSceneObject_TickCounterReset (string sceneobject, string countername) @@ -29088,7 +37073,8 @@ public void fnSceneObject_TickCounterReset (string sceneobject, string counterna SafeNativeMethods.mwle_fnSceneObject_TickCounterReset(sbsceneobject, sbcountername); } /// -/// @brief Clears all counters from the object.) +/// @brief Clears all counters from the object.) +/// /// public void fnSceneObject_TickCountersClear (string sceneobject) @@ -29102,7 +37088,9 @@ public void fnSceneObject_TickCountersClear (string sceneobject) SafeNativeMethods.mwle_fnSceneObject_TickCountersClear(sbsceneobject); } /// -/// @brief Adds a new counter to be tracked via ticks. ) +/// @brief Adds a new counter to be tracked via ticks. +/// ) +/// /// public void fnSceneObject_TickCounterSuspend (string sceneobject, string countername, bool suspend) @@ -29120,6 +37108,7 @@ public void fnSceneObject_TickCounterSuspend (string sceneobject, string counter } /// /// Unmount us from the currently mounted object if any. ) +/// /// public void fnSceneObject_unmount (string sceneobject) @@ -29133,7 +37122,11 @@ public void fnSceneObject_unmount (string sceneobject) SafeNativeMethods.mwle_fnSceneObject_unmount(sbsceneobject); } /// -/// @brief Unmount an object from ourselves. @param target object to unmount @return true if successful, false if failed ) +/// @brief Unmount an object from ourselves. +/// +/// @param target object to unmount +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_unmountObject (string sceneobject, string target) @@ -29150,7 +37143,12 @@ public bool fnSceneObject_unmountObject (string sceneobject, string target) return SafeNativeMethods.mwle_fnSceneObject_unmountObject(sbsceneobject, sbtarget)>=1; } /// -/// @brief Is this object wanting to receive tick notifications. If this object is set to receive tick notifications then its onInterpolateTick() and onProcessTick() callbacks are called. @return True if object wants tick notifications ) +/// @brief Is this object wanting to receive tick notifications. +/// +/// If this object is set to receive tick notifications then its onInterpolateTick() and +/// onProcessTick() callbacks are called. +/// @return True if object wants tick notifications ) +/// /// public bool fnScriptTickObject_isProcessingTicks (string scripttickobject) @@ -29164,7 +37162,10 @@ public bool fnScriptTickObject_isProcessingTicks (string scripttickobject) return SafeNativeMethods.mwle_fnScriptTickObject_isProcessingTicks(sbscripttickobject)>=1; } /// -/// @brief Sets this object as either tick processing or not. @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// @brief Sets this object as either tick processing or not. +/// +/// @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// /// public void fnScriptTickObject_setProcessTicks (string scripttickobject, bool tick) @@ -29179,6 +37180,7 @@ public void fnScriptTickObject_setProcessTicks (string scripttickobject, bool ti } /// /// (Settings, write, bool, 2, 2, %success = settingObj.write();) +/// /// public bool fnSettings_write (string settings) @@ -29192,7 +37194,10 @@ public bool fnSettings_write (string settings) return SafeNativeMethods.mwle_fnSettings_write(sbsettings)>=1; } /// -/// Get the index of the playlist slot currently processed by the controller. @return The slot index currently being played. @see SFXPlayList ) +/// Get the index of the playlist slot currently processed by the controller. +/// @return The slot index currently being played. +/// @see SFXPlayList ) +/// /// public int fnSFXController_getCurrentSlot (string sfxcontroller) @@ -29206,7 +37211,9 @@ public int fnSFXController_getCurrentSlot (string sfxcontroller) return SafeNativeMethods.mwle_fnSFXController_getCurrentSlot(sbsfxcontroller); } /// -/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. @param index Index of the playlist slot. ) +/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. +/// @param index Index of the playlist slot. ) +/// /// public void fnSFXController_setCurrentSlot (string sfxcontroller, int index) @@ -29220,7 +37227,11 @@ public void fnSFXController_setCurrentSlot (string sfxcontroller, int index) SafeNativeMethods.mwle_fnSFXController_setCurrentSlot(sbsfxcontroller, index); } /// -/// Get the sound source object from the emitter. @return The sound source used by the emitter or null. @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts actually hold on to %SFXSources. ) +/// Get the sound source object from the emitter. +/// @return The sound source used by the emitter or null. +/// @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts +/// actually hold on to %SFXSources. ) +/// /// public string fnSFXEmitter_getSource (string sfxemitter) @@ -29237,7 +37248,9 @@ public string fnSFXEmitter_getSource (string sfxemitter) } /// -/// Manually start playback of the emitter's sound. If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// Manually start playback of the emitter's sound. +/// If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// /// public void fnSFXEmitter_play (string sfxemitter) @@ -29251,7 +37264,9 @@ public void fnSFXEmitter_play (string sfxemitter) SafeNativeMethods.mwle_fnSFXEmitter_play(sbsfxemitter); } /// -/// Manually stop playback of the emitter's sound. If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// Manually stop playback of the emitter's sound. +/// If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// /// public void fnSFXEmitter_stop (string sfxemitter) @@ -29265,7 +37280,9 @@ public void fnSFXEmitter_stop (string sfxemitter) SafeNativeMethods.mwle_fnSFXEmitter_stop(sbsfxemitter); } /// -/// Get the name of the parameter. @return The paramete name. ) +/// Get the name of the parameter. +/// @return The paramete name. ) +/// /// public string fnSFXParameter_getParameterName (string sfxparameter) @@ -29282,7 +37299,9 @@ public string fnSFXParameter_getParameterName (string sfxparameter) } /// -/// Reset the parameter's value to its default. @see SFXParameter::defaultValue ) +/// Reset the parameter's value to its default. +/// @see SFXParameter::defaultValue ) +/// /// public void fnSFXParameter_reset (string sfxparameter) @@ -29296,7 +37315,9 @@ public void fnSFXParameter_reset (string sfxparameter) SafeNativeMethods.mwle_fnSFXParameter_reset(sbsfxparameter); } /// -/// Return the length of the sound data in seconds. @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// Return the length of the sound data in seconds. +/// @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// /// public float fnSFXProfile_getSoundDuration (string sfxprofile) @@ -29310,7 +37331,10 @@ public float fnSFXProfile_getSoundDuration (string sfxprofile) return SafeNativeMethods.mwle_fnSFXProfile_getSoundDuration(sbsfxprofile); } /// -/// Get the total play time (in seconds) of the sound data attached to the sound. @return @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// Get the total play time (in seconds) of the sound data attached to the sound. +/// @return +/// @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// /// public float fnSFXSound_getDuration (string sfxsound) @@ -29324,7 +37348,9 @@ public float fnSFXSound_getDuration (string sfxsound) return SafeNativeMethods.mwle_fnSFXSound_getDuration(sbsfxsound); } /// -/// Get the current playback position in seconds. @return The current play cursor offset. ) +/// Get the current playback position in seconds. +/// @return The current play cursor offset. ) +/// /// public float fnSFXSound_getPosition (string sfxsound) @@ -29338,7 +37364,12 @@ public float fnSFXSound_getPosition (string sfxsound) return SafeNativeMethods.mwle_fnSFXSound_getPosition(sbsfxsound); } /// -/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. For streamed sounds, this will be false during playback when the stream queue for the sound is starved and waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to return false. @return True if the sound is ready for playback. ) +/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. +/// For streamed sounds, this will be false during playback when the stream queue for the sound is starved and +/// waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to +/// return false. +/// @return True if the sound is ready for playback. ) +/// /// public bool fnSFXSound_isReady (string sfxsound) @@ -29352,7 +37383,11 @@ public bool fnSFXSound_isReady (string sfxsound) return SafeNativeMethods.mwle_fnSFXSound_isReady(sbsfxsound)>=1; } /// -/// Set the current playback position in seconds. If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, playback will resume at the given position when play() is called. @param position The new position of the play cursor (in seconds). ) +/// Set the current playback position in seconds. +/// If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, +/// playback will resume at the given position when play() is called. +/// @param position The new position of the play cursor (in seconds). ) +/// /// public void fnSFXSound_setPosition (string sfxsound, float position) @@ -29366,7 +37401,32 @@ public void fnSFXSound_setPosition (string sfxsound, float position) SafeNativeMethods.mwle_fnSFXSound_setPosition(sbsfxsound, position); } /// -/// Add a notification marker called @a name at @a pos seconds of playback. @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there may be a delay between the play cursor actually passing the position and the callback being triggered. @note For looped sounds, the marker will trigger on each iteration. @tsexample // Create a new source. $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); // Assign a class to the source. $source.class = \"BackgroundMusic\"; // Add a playback marker at one minute into playback. $source.addMarker( \"first\", 60 ); // Define the callback function. This function will be called when the playback position passes the one minute mark. function BackgroundMusic::onMarkerPassed( %this, %markerName ) { if( %markerName $= \"first\" ) echo( \"Playback has passed the 60 seconds mark.\" ); } // Play the sound. $source.play(); @endtsexample ) +/// Add a notification marker called @a name at @a pos seconds of playback. +/// @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. +/// @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there +/// may be a delay between the play cursor actually passing the position and the callback being triggered. +/// @note For looped sounds, the marker will trigger on each iteration. +/// @tsexample +/// // Create a new source. +/// $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); +/// +/// // Assign a class to the source. +/// $source.class = \"BackgroundMusic\"; +/// +/// // Add a playback marker at one minute into playback. +/// $source.addMarker( \"first\", 60 ); +/// +/// // Define the callback function. This function will be called when the playback position passes the one minute mark. +/// function BackgroundMusic::onMarkerPassed( %this, %markerName ) +/// { +/// if( %markerName $= \"first\" ) +/// echo( \"Playback has passed the 60 seconds mark.\" ); +/// } +/// +/// // Play the sound. +/// $source.play(); +/// @endtsexample ) +/// /// public void fnSFXSource_addMarker (string sfxsource, string name, float pos) @@ -29383,7 +37443,11 @@ public void fnSFXSource_addMarker (string sfxsource, string name, float pos) SafeNativeMethods.mwle_fnSFXSource_addMarker(sbsfxsource, sbname, pos); } /// -/// Attach @a parameter to the source, Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter will also trigger an initial read-out of the parameter's current value. @param parameter The parameter to attach to the source. ) +/// Attach @a parameter to the source, +/// Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter +/// will also trigger an initial read-out of the parameter's current value. +/// @param parameter The parameter to attach to the source. ) +/// /// public void fnSFXSource_addParameter (string sfxsource, string parameter) @@ -29400,7 +37464,12 @@ public void fnSFXSource_addParameter (string sfxsource, string parameter) SafeNativeMethods.mwle_fnSFXSource_addParameter(sbsfxsource, sbparameter); } /// -/// Get the final effective volume level of the source. This method returns the volume level as it is after source group volume modulation, fades, and distance-based volume attenuation have been applied to the base volume level. @return The effective volume of the source. @ref SFXSource_volume ) +/// Get the final effective volume level of the source. +/// This method returns the volume level as it is after source group volume modulation, fades, and distance-based +/// volume attenuation have been applied to the base volume level. +/// @return The effective volume of the source. +/// @ref SFXSource_volume ) +/// /// public float fnSFXSource_getAttenuatedVolume (string sfxsource) @@ -29414,7 +37483,12 @@ public float fnSFXSource_getAttenuatedVolume (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getAttenuatedVolume(sbsfxsource); } /// -/// Get the fade-in time set on the source. This will initially be SFXDescription::fadeInTime. @return The fade-in time set on the source in seconds. @see SFXDescription::fadeInTime @ref SFXSource_fades ) +/// Get the fade-in time set on the source. +/// This will initially be SFXDescription::fadeInTime. +/// @return The fade-in time set on the source in seconds. +/// @see SFXDescription::fadeInTime +/// @ref SFXSource_fades ) +/// /// public float fnSFXSource_getFadeInTime (string sfxsource) @@ -29428,7 +37502,12 @@ public float fnSFXSource_getFadeInTime (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getFadeInTime(sbsfxsource); } /// -/// Get the fade-out time set on the source. This will initially be SFXDescription::fadeOutTime. @return The fade-out time set on the source in seconds. @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Get the fade-out time set on the source. +/// This will initially be SFXDescription::fadeOutTime. +/// @return The fade-out time set on the source in seconds. +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public float fnSFXSource_getFadeOutTime (string sfxsource) @@ -29442,7 +37521,17 @@ public float fnSFXSource_getFadeOutTime (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getFadeOutTime(sbsfxsource); } /// -/// Get the parameter at the given index. @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). @return The parameter at the given @a index or null if @a index is out of range. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameterCount ) +/// Get the parameter at the given index. +/// @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). +/// @return The parameter at the given @a index or null if @a index is out of range. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameterCount ) +/// /// public string fnSFXSource_getParameter (string sfxsource, int index) @@ -29459,7 +37548,17 @@ public string fnSFXSource_getParameter (string sfxsource, int index) } /// -/// Get the number of SFXParameters that are attached to the source. @return The number of parameters attached to the source. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameter @see addParameter ) +/// Get the number of SFXParameters that are attached to the source. +/// @return The number of parameters attached to the source. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameter +/// @see addParameter ) +/// /// public int fnSFXSource_getParameterCount (string sfxsource) @@ -29473,7 +37572,12 @@ public int fnSFXSource_getParameterCount (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getParameterCount(sbsfxsource); } /// -/// Get the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @return The current pitch scale factor of the source. @see setPitch @see SFXDescription::pitch ) +/// Get the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @return The current pitch scale factor of the source. +/// @see setPitch +/// @see SFXDescription::pitch ) +/// /// public float fnSFXSource_getPitch (string sfxsource) @@ -29487,7 +37591,9 @@ public float fnSFXSource_getPitch (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getPitch(sbsfxsource); } /// -/// Get the current playback status. @return Te current playback status ) +/// Get the current playback status. +/// @return Te current playback status ) +/// /// public int fnSFXSource_getStatus (string sfxsource) @@ -29501,7 +37607,14 @@ public int fnSFXSource_getStatus (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getStatus(sbsfxsource); } /// -/// Get the current base volume level of the source. This is not the final effective volume that the source is playing at but rather the starting volume level before source group modulation, fades, or distance-based volume attenuation are applied. @return The current base volume level. @see setVolume @see SFXDescription::volume @ref SFXSource_volume ) +/// Get the current base volume level of the source. +/// This is not the final effective volume that the source is playing at but rather the starting +/// volume level before source group modulation, fades, or distance-based volume attenuation are applied. +/// @return The current base volume level. +/// @see setVolume +/// @see SFXDescription::volume +/// @ref SFXSource_volume ) +/// /// public float fnSFXSource_getVolume (string sfxsource) @@ -29515,7 +37628,12 @@ public float fnSFXSource_getVolume (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getVolume(sbsfxsource); } /// -/// Test whether the source is currently paused. @return True if the source is in paused state, false otherwise. @see pause @see getStatus @see SFXStatus ) +/// Test whether the source is currently paused. +/// @return True if the source is in paused state, false otherwise. +/// @see pause +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool fnSFXSource_isPaused (string sfxsource) @@ -29529,7 +37647,12 @@ public bool fnSFXSource_isPaused (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_isPaused(sbsfxsource)>=1; } /// -/// Test whether the source is currently playing. @return True if the source is in playing state, false otherwise. @see play @see getStatus @see SFXStatus ) +/// Test whether the source is currently playing. +/// @return True if the source is in playing state, false otherwise. +/// @see play +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool fnSFXSource_isPlaying (string sfxsource) @@ -29543,7 +37666,12 @@ public bool fnSFXSource_isPlaying (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_isPlaying(sbsfxsource)>=1; } /// -/// Test whether the source is currently stopped. @return True if the source is in stopped state, false otherwise. @see stop @see getStatus @see SFXStatus ) +/// Test whether the source is currently stopped. +/// @return True if the source is in stopped state, false otherwise. +/// @see stop +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool fnSFXSource_isStopped (string sfxsource) @@ -29557,7 +37685,13 @@ public bool fnSFXSource_isStopped (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_isStopped(sbsfxsource)>=1; } /// -/// Pause playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately to paused state but will rather remain in playing state until the fade-out time has expired.. ) +/// Pause playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately to paused state but will +/// rather remain in playing state until the fade-out time has expired.. ) +/// /// public void fnSFXSource_pause (string sfxsource, float fadeOutTime) @@ -29571,7 +37705,13 @@ public void fnSFXSource_pause (string sfxsource, float fadeOutTime) SafeNativeMethods.mwle_fnSFXSource_pause(sbsfxsource, fadeOutTime); } /// -/// Start playback of the source. If the sound data for the source has not yet been fully loaded, there will be a delay after calling play and playback will start after the data has become available. @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime set in the source's associated description is used. Pass 0 to disable a fade-in effect that may be configured on the description. ) +/// Start playback of the source. +/// If the sound data for the source has not yet been fully loaded, there will be a delay after calling +/// play and playback will start after the data has become available. +/// @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime +/// set in the source's associated description is used. Pass 0 to disable a fade-in effect that may +/// be configured on the description. ) +/// /// public void fnSFXSource_play (string sfxsource, float fadeInTime) @@ -29585,7 +37725,11 @@ public void fnSFXSource_play (string sfxsource, float fadeInTime) SafeNativeMethods.mwle_fnSFXSource_play(sbsfxsource, fadeInTime); } /// -/// Detach @a parameter from the source. Once detached, the source will no longer react to value changes of the given @a parameter. If the parameter is not attached to the source, the method will do nothing. @param parameter The parameter to detach from the source. ) +/// Detach @a parameter from the source. +/// Once detached, the source will no longer react to value changes of the given @a parameter. +/// If the parameter is not attached to the source, the method will do nothing. +/// @param parameter The parameter to detach from the source. ) +/// /// public void fnSFXSource_removeParameter (string sfxsource, string parameter) @@ -29602,7 +37746,12 @@ public void fnSFXSource_removeParameter (string sfxsource, string parameter) SafeNativeMethods.mwle_fnSFXSource_removeParameter(sbsfxsource, sbparameter); } /// -/// Set up the 3D volume cone for the source. @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. @note This method has no effect on the source if the source is not 3D. ) +/// Set up the 3D volume cone for the source. +/// @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. +/// @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. +/// @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. +/// @note This method has no effect on the source if the source is not 3D. ) +/// /// public void fnSFXSource_setCone (string sfxsource, float innerAngle, float outerAngle, float outsideVolume) @@ -29616,7 +37765,13 @@ public void fnSFXSource_setCone (string sfxsource, float innerAngle, float outer SafeNativeMethods.mwle_fnSFXSource_setCone(sbsfxsource, innerAngle, outerAngle, outsideVolume); } /// -/// Set the fade time parameters of the source. @param fadeInTime The new fade-in time in seconds. @param fadeOutTime The new fade-out time in seconds. @see SFXDescription::fadeInTime @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Set the fade time parameters of the source. +/// @param fadeInTime The new fade-in time in seconds. +/// @param fadeOutTime The new fade-out time in seconds. +/// @see SFXDescription::fadeInTime +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public void fnSFXSource_setFadeTimes (string sfxsource, float fadeInTime, float fadeOutTime) @@ -29630,7 +37785,12 @@ public void fnSFXSource_setFadeTimes (string sfxsource, float fadeInTime, float SafeNativeMethods.mwle_fnSFXSource_setFadeTimes(sbsfxsource, fadeInTime, fadeOutTime); } /// -/// Set the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @param pitch The new pitch scale factor. @see getPitch @see SFXDescription::pitch ) +/// Set the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @param pitch The new pitch scale factor. +/// @see getPitch +/// @see SFXDescription::pitch ) +/// /// public void fnSFXSource_setPitch (string sfxsource, float pitch) @@ -29644,7 +37804,13 @@ public void fnSFXSource_setPitch (string sfxsource, float pitch) SafeNativeMethods.mwle_fnSFXSource_setPitch(sbsfxsource, pitch); } /// -/// Set the base volume level for the source. This volume will be the starting point for source group volume modulation, fades, and distance-based volume attenuation. @param volume The new base volume level for the source. Must be 0>=volume=1. @see getVolume @ref SFXSource_volume ) +/// Set the base volume level for the source. +/// This volume will be the starting point for source group volume modulation, fades, and distance-based +/// volume attenuation. +/// @param volume The new base volume level for the source. Must be 0>=volume=1. +/// @see getVolume +/// @ref SFXSource_volume ) +/// /// public void fnSFXSource_setVolume (string sfxsource, float volume) @@ -29658,7 +37824,13 @@ public void fnSFXSource_setVolume (string sfxsource, float volume) SafeNativeMethods.mwle_fnSFXSource_setVolume(sbsfxsource, volume); } /// -/// Stop playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but will rather remain in playing state until the fade-out time has expired. ) +/// Stop playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but +/// will rather remain in playing state until the fade-out time has expired. ) +/// /// public void fnSFXSource_stop (string sfxsource, float fadeOutTime) @@ -29672,7 +37844,11 @@ public void fnSFXSource_stop (string sfxsource, float fadeOutTime) SafeNativeMethods.mwle_fnSFXSource_stop(sbsfxsource, fadeOutTime); } /// -/// Increase the activation count on the state. If the state isn't already active and it is not disabled, the state will be activated. @see isActive @see deactivate ) +/// Increase the activation count on the state. +/// If the state isn't already active and it is not disabled, the state will be activated. +/// @see isActive +/// @see deactivate ) +/// /// public void fnSFXState_activate (string sfxstate) @@ -29686,7 +37862,11 @@ public void fnSFXState_activate (string sfxstate) SafeNativeMethods.mwle_fnSFXState_activate(sbsfxstate); } /// -/// Decrease the activation count on the state. If the count reaches zero and the state was not disabled, the state will be deactivated. @see isActive @see activate ) +/// Decrease the activation count on the state. +/// If the count reaches zero and the state was not disabled, the state will be deactivated. +/// @see isActive +/// @see activate ) +/// /// public void fnSFXState_deactivate (string sfxstate) @@ -29700,7 +37880,10 @@ public void fnSFXState_deactivate (string sfxstate) SafeNativeMethods.mwle_fnSFXState_deactivate(sbsfxstate); } /// -/// Increase the disabling count of the state. If the state is currently active, it will be deactivated. @see isDisabled ) +/// Increase the disabling count of the state. +/// If the state is currently active, it will be deactivated. +/// @see isDisabled ) +/// /// public void fnSFXState_disable (string sfxstate) @@ -29714,7 +37897,11 @@ public void fnSFXState_disable (string sfxstate) SafeNativeMethods.mwle_fnSFXState_disable(sbsfxstate); } /// -/// Decrease the disabling count of the state. If the disabling count reaches zero while the activation count is still non-zero, the state will be reactivated again. @see isDisabled ) +/// Decrease the disabling count of the state. +/// If the disabling count reaches zero while the activation count is still non-zero, +/// the state will be reactivated again. +/// @see isDisabled ) +/// /// public void fnSFXState_enable (string sfxstate) @@ -29728,7 +37915,11 @@ public void fnSFXState_enable (string sfxstate) SafeNativeMethods.mwle_fnSFXState_enable(sbsfxstate); } /// -/// Test whether the state is currently active. This is true when the activation count is >0 and the disabling count is =0. @return True if the state is currently active. @see activate ) +/// Test whether the state is currently active. +/// This is true when the activation count is >0 and the disabling count is =0. +/// @return True if the state is currently active. +/// @see activate ) +/// /// public bool fnSFXState_isActive (string sfxstate) @@ -29742,7 +37933,11 @@ public bool fnSFXState_isActive (string sfxstate) return SafeNativeMethods.mwle_fnSFXState_isActive(sbsfxstate)>=1; } /// -/// Test whether the state is currently disabled. This is true when the disabling count of the state is non-zero. @return True if the state is disabled. @see disable ) +/// Test whether the state is currently disabled. +/// This is true when the disabling count of the state is non-zero. +/// @return True if the state is disabled. +/// @see disable ) +/// /// public bool fnSFXState_isDisabled (string sfxstate) @@ -29756,7 +37951,13 @@ public bool fnSFXState_isDisabled (string sfxstate) return SafeNativeMethods.mwle_fnSFXState_isDisabled(sbsfxstate)>=1; } /// -/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. @tsexample // Rebuild the shader instances from ShaderData CloudLayerShader CloudLayerShader.reload(); @endtsexample) +/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. +/// +/// @tsexample +/// // Rebuild the shader instances from ShaderData CloudLayerShader +/// CloudLayerShader.reload(); +/// @endtsexample) +/// /// public void fnShaderData_reload (string shaderdata) @@ -29770,7 +37971,10 @@ public void fnShaderData_reload (string shaderdata) SafeNativeMethods.mwle_fnShaderData_reload(sbshaderdata); } /// -/// @brief Increment the current damage level by the specified amount. @param amount value to add to current damage level ) +/// @brief Increment the current damage level by the specified amount. +/// +/// @param amount value to add to current damage level ) +/// /// public void fnShapeBase_applyDamage (string shapebase, float amount) @@ -29784,7 +37988,12 @@ public void fnShapeBase_applyDamage (string shapebase, float amount) SafeNativeMethods.mwle_fnShapeBase_applyDamage(sbshapebase, amount); } /// -/// @brief Apply an impulse to the object. @param pos world position of the impulse @param vec impulse momentum (velocity * mass) @return true ) +/// @brief Apply an impulse to the object. +/// +/// @param pos world position of the impulse +/// @param vec impulse momentum (velocity * mass) +/// @return true ) +/// /// public bool fnShapeBase_applyImpulse (string shapebase, string pos, string vec) @@ -29804,7 +38013,13 @@ public bool fnShapeBase_applyImpulse (string shapebase, string pos, string vec) return SafeNativeMethods.mwle_fnShapeBase_applyImpulse(sbshapebase, sbpos, sbvec)>=1; } /// -/// @brief Repair damage by the specified amount. Note that the damage level is only reduced by repairRate per tick, so it may take several ticks for the total repair to complete. @param amount total repair value (subtracted from damage level over time) ) +/// @brief Repair damage by the specified amount. +/// +/// Note that the damage level is only reduced by repairRate per tick, so it may +/// take several ticks for the total repair to complete. +/// +/// @param amount total repair value (subtracted from damage level over time) ) +/// /// public void fnShapeBase_applyRepair (string shapebase, float amount) @@ -29819,6 +38034,7 @@ public void fnShapeBase_applyRepair (string shapebase, float amount) } /// /// @brief Explodes an object into pieces.) +/// /// public void fnShapeBase_blowUp (string shapebase) @@ -29832,7 +38048,11 @@ public void fnShapeBase_blowUp (string shapebase) SafeNativeMethods.mwle_fnShapeBase_blowUp(sbshapebase); } /// -/// @brief Check if this object can cloak. @return true @note Not implemented as it always returns true.) +/// @brief Check if this object can cloak. +/// @return true +/// +/// @note Not implemented as it always returns true.) +/// /// public bool fnShapeBase_canCloak (string shapebase) @@ -29846,7 +38066,24 @@ public bool fnShapeBase_canCloak (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_canCloak(sbshapebase)>=1; } /// -/// @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void fnShapeBase_changeMaterial (string shapebase, string mapTo, string oldMat, string newMat) @@ -29869,7 +38106,13 @@ public void fnShapeBase_changeMaterial (string shapebase, string mapTo, string o SafeNativeMethods.mwle_fnShapeBase_changeMaterial(sbshapebase, sbmapTo, sboldMat, sbnewMat); } /// -/// @brief Destroy an animation thread, which prevents it from playing. @param slot thread slot to destroy @return true if successful, false if failed @see playThread ) +/// @brief Destroy an animation thread, which prevents it from playing. +/// +/// @param slot thread slot to destroy +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_destroyThread (string shapebase, int slot) @@ -29883,7 +38126,10 @@ public bool fnShapeBase_destroyThread (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_destroyThread(sbshapebase, slot)>=1; } /// -/// @brief Print a list of visible and hidden meshes in the shape to the console for debugging purposes. @note Only in a SHIPPING build.) +/// @brief Print a list of visible and hidden meshes in the shape to the console +/// for debugging purposes. +/// @note Only in a SHIPPING build.) +/// /// public void fnShapeBase_dumpMeshVisibility (string shapebase) @@ -29897,7 +38143,12 @@ public void fnShapeBase_dumpMeshVisibility (string shapebase) SafeNativeMethods.mwle_fnShapeBase_dumpMeshVisibility(sbshapebase); } /// -/// @brief Get the position at which the AI should stand to repair things. If the shape defines a node called \"AIRepairNode\", this method will return the current world position of that node, otherwise \"0 0 0\". @return the AI repair position ) +/// @brief Get the position at which the AI should stand to repair things. +/// +/// If the shape defines a node called \"AIRepairNode\", this method will +/// return the current world position of that node, otherwise \"0 0 0\". +/// @return the AI repair position ) +/// /// public string fnShapeBase_getAIRepairPoint (string shapebase) @@ -29914,7 +38165,10 @@ public string fnShapeBase_getAIRepairPoint (string shapebase) } /// -/// @brief Returns the vertical field of view in degrees for this object if used as a camera. @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// @brief Returns the vertical field of view in degrees for this object if used as a camera. +/// +/// @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// /// public float fnShapeBase_getCameraFov (string shapebase) @@ -29928,7 +38182,15 @@ public float fnShapeBase_getCameraFov (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getCameraFov(sbshapebase); } /// -/// @brief Get the client (if any) that controls this object. The controlling client is the one that will send moves to us to act on. @return the ID of the controlling GameConnection, or 0 if this object is not controlled by any client. @see GameConnection) +/// @brief Get the client (if any) that controls this object. +/// +/// The controlling client is the one that will send moves to us to act on. +/// +/// @return the ID of the controlling GameConnection, or 0 if this object is not +/// controlled by any client. +/// +/// @see GameConnection) +/// /// public int fnShapeBase_getControllingClient (string shapebase) @@ -29942,7 +38204,11 @@ public int fnShapeBase_getControllingClient (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getControllingClient(sbshapebase); } /// -/// @brief Get the object (if any) that controls this object. @return the ID of the controlling ShapeBase object, or 0 if this object is not controlled by another object. ) +/// @brief Get the object (if any) that controls this object. +/// +/// @return the ID of the controlling ShapeBase object, or 0 if this object is +/// not controlled by another object. ) +/// /// public int fnShapeBase_getControllingObject (string shapebase) @@ -29956,7 +38222,12 @@ public int fnShapeBase_getControllingObject (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getControllingObject(sbshapebase); } /// -/// @brief Get the damage flash level. @return flash level @see setDamageFlash ) +/// @brief Get the damage flash level. +/// +/// @return flash level +/// +/// @see setDamageFlash ) +/// /// public float fnShapeBase_getDamageFlash (string shapebase) @@ -29970,7 +38241,12 @@ public float fnShapeBase_getDamageFlash (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDamageFlash(sbshapebase); } /// -/// @brief Get the object's current damage level. @return damage level @see setDamageLevel()) +/// @brief Get the object's current damage level. +/// +/// @return damage level +/// +/// @see setDamageLevel()) +/// /// public float fnShapeBase_getDamageLevel (string shapebase) @@ -29984,7 +38260,12 @@ public float fnShapeBase_getDamageLevel (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDamageLevel(sbshapebase); } /// -/// @brief Get the object's current damage level as a percentage of maxDamage. @return damageLevel / datablock.maxDamage @see setDamageLevel()) +/// @brief Get the object's current damage level as a percentage of maxDamage. +/// +/// @return damageLevel / datablock.maxDamage +/// +/// @see setDamageLevel()) +/// /// public float fnShapeBase_getDamagePercent (string shapebase) @@ -29998,7 +38279,12 @@ public float fnShapeBase_getDamagePercent (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDamagePercent(sbshapebase); } /// -/// @brief Get the object's damage state. @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" @see setDamageState()) +/// @brief Get the object's damage state. +/// +/// @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// +/// @see setDamageState()) +/// /// public string fnShapeBase_getDamageState (string shapebase) @@ -30015,7 +38301,10 @@ public string fnShapeBase_getDamageState (string shapebase) } /// -/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. @return Default FOV ) +/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. +/// +/// @return Default FOV ) +/// /// public float fnShapeBase_getDefaultCameraFov (string shapebase) @@ -30029,7 +38318,12 @@ public float fnShapeBase_getDefaultCameraFov (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDefaultCameraFov(sbshapebase); } /// -/// @brief Get the object's current energy level. @return energy level @see setEnergyLevel()) +/// @brief Get the object's current energy level. +/// +/// @return energy level +/// +/// @see setEnergyLevel()) +/// /// public float fnShapeBase_getEnergyLevel (string shapebase) @@ -30043,7 +38337,11 @@ public float fnShapeBase_getEnergyLevel (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getEnergyLevel(sbshapebase); } /// -/// @brief Get the object's current energy level as a percentage of maxEnergy. @return energyLevel / datablock.maxEnergy @see setEnergyLevel()) +/// @brief Get the object's current energy level as a percentage of maxEnergy. +/// @return energyLevel / datablock.maxEnergy +/// +/// @see setEnergyLevel()) +/// /// public float fnShapeBase_getEnergyPercent (string shapebase) @@ -30057,7 +38355,17 @@ public float fnShapeBase_getEnergyPercent (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getEnergyPercent(sbshapebase); } /// -/// @brief Get the position of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current world position, otherwise it will return the object's current world position. @return the eye position for this object @see getEyeVector @see getEyeTransform ) +/// @brief Get the position of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current world position, otherwise it will return the object's current +/// world position. +/// +/// @return the eye position for this object +/// +/// @see getEyeVector +/// @see getEyeTransform ) +/// /// public string fnShapeBase_getEyePoint (string shapebase) @@ -30074,7 +38382,17 @@ public string fnShapeBase_getEyePoint (string shapebase) } /// -/// @brief Get the 'eye' transform for this object. If the object model has a node called 'eye', this method will return that node's current transform, otherwise it will return the object's current transform. @return the eye transform for this object @see getEyeVector @see getEyePoint ) +/// @brief Get the 'eye' transform for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current transform, otherwise it will return the object's current +/// transform. +/// +/// @return the eye transform for this object +/// +/// @see getEyeVector +/// @see getEyePoint ) +/// /// public string fnShapeBase_getEyeTransform (string shapebase) @@ -30091,7 +38409,17 @@ public string fnShapeBase_getEyeTransform (string shapebase) } /// -/// @brief Get the forward direction of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current forward direction vector, otherwise it will return the object's current forward direction vector. @return the eye vector for this object @see getEyePoint @see getEyeTransform ) +/// @brief Get the forward direction of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current forward direction vector, otherwise it will return the +/// object's current forward direction vector. +/// +/// @return the eye vector for this object +/// +/// @see getEyePoint +/// @see getEyeTransform ) +/// /// public string fnShapeBase_getEyeVector (string shapebase) @@ -30108,7 +38436,11 @@ public string fnShapeBase_getEyeVector (string shapebase) } /// -/// @brief Get the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current alt trigger state ) +/// @brief Get the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current alt trigger state ) +/// /// public bool fnShapeBase_getImageAltTrigger (string shapebase, int slot) @@ -30122,7 +38454,11 @@ public bool fnShapeBase_getImageAltTrigger (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageAltTrigger(sbshapebase, slot)>=1; } /// -/// @brief Get the ammo state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current ammo state ) +/// @brief Get the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current ammo state ) +/// /// public bool fnShapeBase_getImageAmmo (string shapebase, int slot) @@ -30136,7 +38472,12 @@ public bool fnShapeBase_getImageAmmo (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageAmmo(sbshapebase, slot)>=1; } /// -/// @brief Get the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to query @param trigger Generic trigger number @return the Image's current generic trigger state ) +/// @brief Get the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @param trigger Generic trigger number +/// @return the Image's current generic trigger state ) +/// /// public bool fnShapeBase_getImageGenericTrigger (string shapebase, int slot, int trigger) @@ -30150,7 +38491,11 @@ public bool fnShapeBase_getImageGenericTrigger (string shapebase, int slot, int return SafeNativeMethods.mwle_fnShapeBase_getImageGenericTrigger(sbshapebase, slot, trigger)>=1; } /// -/// @brief Get the loaded state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current loaded state ) +/// @brief Get the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current loaded state ) +/// /// public bool fnShapeBase_getImageLoaded (string shapebase, int slot) @@ -30164,7 +38509,11 @@ public bool fnShapeBase_getImageLoaded (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageLoaded(sbshapebase, slot)>=1; } /// -/// @brief Get the script animation prefix of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current script animation prefix ) +/// @brief Get the script animation prefix of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current script animation prefix ) +/// /// public string fnShapeBase_getImageScriptAnimPrefix (string shapebase, int slot) @@ -30181,7 +38530,12 @@ public string fnShapeBase_getImageScriptAnimPrefix (string shapebase, int slot) } /// -/// @brief Get the skin tag ID for the Image mounted in the specified slot. @param slot Image slot to query @return the skinTag value passed to mountImage when the image was mounted ) +/// @brief Get the skin tag ID for the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the skinTag value passed to mountImage when the image was +/// mounted ) +/// /// public int fnShapeBase_getImageSkinTag (string shapebase, int slot) @@ -30195,7 +38549,11 @@ public int fnShapeBase_getImageSkinTag (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageSkinTag(sbshapebase, slot); } /// -/// @brief Get the name of the current state of the Image in the specified slot. @param slot Image slot to query @return name of the current Image state, or \"Error\" if slot is invalid ) +/// @brief Get the name of the current state of the Image in the specified slot. +/// +/// @param slot Image slot to query +/// @return name of the current Image state, or \"Error\" if slot is invalid ) +/// /// public string fnShapeBase_getImageState (string shapebase, int slot) @@ -30212,7 +38570,11 @@ public string fnShapeBase_getImageState (string shapebase, int slot) } /// -/// @brief Get the target state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current target state ) +/// @brief Get the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current target state ) +/// /// public bool fnShapeBase_getImageTarget (string shapebase, int slot) @@ -30226,7 +38588,11 @@ public bool fnShapeBase_getImageTarget (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageTarget(sbshapebase, slot)>=1; } /// -/// @brief Get the trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current trigger state ) +/// @brief Get the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current trigger state ) +/// /// public bool fnShapeBase_getImageTrigger (string shapebase, int slot) @@ -30240,7 +38606,19 @@ public bool fnShapeBase_getImageTrigger (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageTrigger(sbshapebase, slot)>=1; } /// -/// @brief Get the world position this object is looking at. Casts a ray from the eye and returns information about what the ray hits. @param distance maximum distance of the raycast @param typeMask typeMask of objects to include for raycast collision testing @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit @tsexample %lookat = %obj.getLookAtPoint(); echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); @endtsexample ) +/// @brief Get the world position this object is looking at. +/// +/// Casts a ray from the eye and returns information about what the ray hits. +/// +/// @param distance maximum distance of the raycast +/// @param typeMask typeMask of objects to include for raycast collision testing +/// @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit +/// +/// @tsexample +/// %lookat = %obj.getLookAtPoint(); +/// echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); +/// @endtsexample ) +/// /// public string fnShapeBase_getLookAtPoint (string shapebase, float distance, uint typeMask) @@ -30257,7 +38635,9 @@ public string fnShapeBase_getLookAtPoint (string shapebase, float distance, uint } /// -/// Get the object's maxDamage level. @return datablock.maxDamage) +/// Get the object's maxDamage level. +/// @return datablock.maxDamage) +/// /// public float fnShapeBase_getMaxDamage (string shapebase) @@ -30271,7 +38651,10 @@ public float fnShapeBase_getMaxDamage (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getMaxDamage(sbshapebase); } /// -/// @brief Get the model filename used by this shape. @return the shape filename ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename ) +/// /// public string fnShapeBase_getModelFile (string shapebase) @@ -30288,7 +38671,12 @@ public string fnShapeBase_getModelFile (string shapebase) } /// -/// @brief Get the Image mounted in the specified slot. @param slot Image slot to query @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 if no Image is mounted there. ) +/// @brief Get the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 +/// if no Image is mounted there. ) +/// /// public int fnShapeBase_getMountedImage (string shapebase, int slot) @@ -30302,7 +38690,13 @@ public int fnShapeBase_getMountedImage (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getMountedImage(sbshapebase, slot); } /// -/// @brief Get the first slot the given datablock is mounted to on this object. @param image ShapeBaseImageData datablock to query @return index of the first slot the Image is mounted in, or -1 if the Image is not mounted in any slot on this object. ) +/// @brief Get the first slot the given datablock is mounted to on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return index of the first slot the Image is mounted in, or -1 if the Image +/// is not mounted in any slot on this object. ) +/// +/// /// public int fnShapeBase_getMountSlot (string shapebase, string image) @@ -30319,7 +38713,15 @@ public int fnShapeBase_getMountSlot (string shapebase, string image) return SafeNativeMethods.mwle_fnShapeBase_getMountSlot(sbshapebase, sbimage); } /// -/// @brief Get the muzzle position of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle position is the position of that node in world space. If no such node is specified, the slot's mount node is used instead. @param slot Image slot to query @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// @brief Get the muzzle position of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// position is the position of that node in world space. If no such node +/// is specified, the slot's mount node is used instead. +/// +/// @param slot Image slot to query +/// @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// /// public string fnShapeBase_getMuzzlePoint (string shapebase, int slot) @@ -30336,7 +38738,20 @@ public string fnShapeBase_getMuzzlePoint (string shapebase, int slot) } /// -/// @brief Get the muzzle vector of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle vector is the forward direction vector of that node's transform in world space. If no such node is specified, the slot's mount node is used instead. If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) is set in the Image, the muzzle vector is computed to point at whatever object is right in front of the object's 'eye' node. @param slot Image slot to query @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// @brief Get the muzzle vector of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// vector is the forward direction vector of that node's transform in world +/// space. If no such node is specified, the slot's mount node is used +/// instead. +/// +/// If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) +/// is set in the Image, the muzzle vector is computed to point at whatever +/// object is right in front of the object's 'eye' node. +/// +/// @param slot Image slot to query +/// @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// /// public string fnShapeBase_getMuzzleVector (string shapebase, int slot) @@ -30353,7 +38768,20 @@ public string fnShapeBase_getMuzzleVector (string shapebase, int slot) } /// -/// @brief Get the Image that will be mounted next in the specified slot. Calling mountImage when an Image is already mounted does one of two things: ol>li>Mount the new Image immediately, the old Image is discarded and whatever state it was in is ignored./li> li>If the current Image state does not allow Image changes, the new Image is marked as pending, and will not be mounted until the current state completes. eg. if the user changes weapons, you may wish to ensure that the current weapon firing state plays to completion first./li>/ol> This command retrieves the ID of the pending Image (2nd case above). @param slot Image slot to query @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// @brief Get the Image that will be mounted next in the specified slot. +/// +/// Calling mountImage when an Image is already mounted does one of two things: +/// ol>li>Mount the new Image immediately, the old Image is discarded and +/// whatever state it was in is ignored./li> +/// li>If the current Image state does not allow Image changes, the new +/// Image is marked as pending, and will not be mounted until the current +/// state completes. eg. if the user changes weapons, you may wish to ensure +/// that the current weapon firing state plays to completion first./li>/ol> +/// This command retrieves the ID of the pending Image (2nd case above). +/// +/// @param slot Image slot to query +/// @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// /// public int fnShapeBase_getPendingImage (string shapebase, int slot) @@ -30367,7 +38795,12 @@ public int fnShapeBase_getPendingImage (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getPendingImage(sbshapebase, slot); } /// -/// @brief Get the current recharge rate. @return the recharge rate (per tick) @see setRechargeRate()) +/// @brief Get the current recharge rate. +/// +/// @return the recharge rate (per tick) +/// +/// @see setRechargeRate()) +/// /// public float fnShapeBase_getRechargeRate (string shapebase) @@ -30381,7 +38814,12 @@ public float fnShapeBase_getRechargeRate (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getRechargeRate(sbshapebase); } /// -/// @brief Get the per-tick repair amount. @return the current value to be subtracted from damage level each tick @see setRepairRate ) +/// @brief Get the per-tick repair amount. +/// +/// @return the current value to be subtracted from damage level each tick +/// +/// @see setRepairRate ) +/// /// public float fnShapeBase_getRepairRate (string shapebase) @@ -30395,7 +38833,15 @@ public float fnShapeBase_getRepairRate (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getRepairRate(sbshapebase); } /// -/// @brief Get the name of the shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @return the name of the shape @see setShapeName()) +/// @brief Get the name of the shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @return the name of the shape +/// +/// @see setShapeName()) +/// /// public string fnShapeBase_getShapeName (string shapebase) @@ -30412,7 +38858,13 @@ public string fnShapeBase_getShapeName (string shapebase) } /// -/// @brief Get the name of the skin applied to this shape. @return the name of the skin @see skin @see setSkinName()) +/// @brief Get the name of the skin applied to this shape. +/// +/// @return the name of the skin +/// +/// @see skin +/// @see setSkinName()) +/// /// public string fnShapeBase_getSkinName (string shapebase) @@ -30429,7 +38881,11 @@ public string fnShapeBase_getSkinName (string shapebase) } /// -/// @brief Get the world transform of the specified mount slot. @param slot Image slot to query @return the mount transform ) +/// @brief Get the world transform of the specified mount slot. +/// +/// @param slot Image slot to query +/// @return the mount transform ) +/// /// public string fnShapeBase_getSlotTransform (string shapebase, int slot) @@ -30446,7 +38902,12 @@ public string fnShapeBase_getSlotTransform (string shapebase, int slot) } /// -/// @brief Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// @brief Get the number of materials in the shape. +/// +/// @return the number of materials in the shape. +/// +/// @see getTargetName()) +/// /// public int fnShapeBase_getTargetCount (string shapebase) @@ -30460,7 +38921,13 @@ public int fnShapeBase_getTargetCount (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getTargetCount(sbshapebase); } /// -/// @brief Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// @brief Get the name of the indexed shape material. +/// +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// +/// @see getTargetCount()) +/// /// public string fnShapeBase_getTargetName (string shapebase, int index) @@ -30477,7 +38944,10 @@ public string fnShapeBase_getTargetName (string shapebase, int index) } /// -/// @brief Get the object's current velocity. @return the current velocity ) +/// @brief Get the object's current velocity. +/// +/// @return the current velocity ) +/// /// public string fnShapeBase_getVelocity (string shapebase) @@ -30494,7 +38964,12 @@ public string fnShapeBase_getVelocity (string shapebase) } /// -/// @brief Get the white-out level. @return white-out level @see setWhiteOut ) +/// @brief Get the white-out level. +/// +/// @return white-out level +/// +/// @see setWhiteOut ) +/// /// public float fnShapeBase_getWhiteOut (string shapebase) @@ -30508,7 +38983,12 @@ public float fnShapeBase_getWhiteOut (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getWhiteOut(sbshapebase); } /// -/// @brief Check if the given state exists on the mounted Image. @param slot Image slot to query @param state Image state to check for @return true if the Image has the requested state defined. ) +/// @brief Check if the given state exists on the mounted Image. +/// +/// @param slot Image slot to query +/// @param state Image state to check for +/// @return true if the Image has the requested state defined. ) +/// /// public bool fnShapeBase_hasImageState (string shapebase, int slot, string state) @@ -30525,7 +39005,12 @@ public bool fnShapeBase_hasImageState (string shapebase, int slot, string state) return SafeNativeMethods.mwle_fnShapeBase_hasImageState(sbshapebase, slot, sbstate)>=1; } /// -/// @brief Check if this object is cloaked. @return true if cloaked, false if not @see setCloaked()) +/// @brief Check if this object is cloaked. +/// +/// @return true if cloaked, false if not +/// +/// @see setCloaked()) +/// /// public bool fnShapeBase_isCloaked (string shapebase) @@ -30539,7 +39024,13 @@ public bool fnShapeBase_isCloaked (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isCloaked(sbshapebase)>=1; } /// -/// @brief Check if the object is in the Destroyed damage state. @return true if damage state is \"Destroyed\", false if not @see isDisabled() @see isEnabled()) +/// @brief Check if the object is in the Destroyed damage state. +/// +/// @return true if damage state is \"Destroyed\", false if not +/// +/// @see isDisabled() +/// @see isEnabled()) +/// /// public bool fnShapeBase_isDestroyed (string shapebase) @@ -30553,7 +39044,13 @@ public bool fnShapeBase_isDestroyed (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isDestroyed(sbshapebase)>=1; } /// -/// @brief Check if the object is in the Disabled or Destroyed damage state. @return true if damage state is not \"Enabled\", false if it is @see isDestroyed() @see isEnabled()) +/// @brief Check if the object is in the Disabled or Destroyed damage state. +/// +/// @return true if damage state is not \"Enabled\", false if it is +/// +/// @see isDestroyed() +/// @see isEnabled()) +/// /// public bool fnShapeBase_isDisabled (string shapebase) @@ -30567,7 +39064,13 @@ public bool fnShapeBase_isDisabled (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isDisabled(sbshapebase)>=1; } /// -/// @brief Check if the object is in the Enabled damage state. @return true if damage state is \"Enabled\", false if not @see isDestroyed() @see isDisabled()) +/// @brief Check if the object is in the Enabled damage state. +/// +/// @return true if damage state is \"Enabled\", false if not +/// +/// @see isDestroyed() +/// @see isDisabled()) +/// /// public bool fnShapeBase_isEnabled (string shapebase) @@ -30581,7 +39084,9 @@ public bool fnShapeBase_isEnabled (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isEnabled(sbshapebase)>=1; } /// -/// Check if the object is hidden. @return true if the object is hidden, false if visible. ) +/// Check if the object is hidden. +/// @return true if the object is hidden, false if visible. ) +/// /// public bool fnShapeBase_isHidden (string shapebase) @@ -30595,7 +39100,11 @@ public bool fnShapeBase_isHidden (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isHidden(sbshapebase)>=1; } /// -/// @brief Check if the current Image state is firing. @param slot Image slot to query @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// @brief Check if the current Image state is firing. +/// +/// @param slot Image slot to query +/// @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// /// public bool fnShapeBase_isImageFiring (string shapebase, int slot) @@ -30609,7 +39118,11 @@ public bool fnShapeBase_isImageFiring (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_isImageFiring(sbshapebase, slot)>=1; } /// -/// @brief Check if the given datablock is mounted to any slot on this object. @param image ShapeBaseImageData datablock to query @return true if the Image is mounted to any slot, false otherwise. ) +/// @brief Check if the given datablock is mounted to any slot on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return true if the Image is mounted to any slot, false otherwise. ) +/// /// public bool fnShapeBase_isImageMounted (string shapebase, string image) @@ -30626,7 +39139,26 @@ public bool fnShapeBase_isImageMounted (string shapebase, string image) return SafeNativeMethods.mwle_fnShapeBase_isImageMounted(sbshapebase, sbimage)>=1; } /// -/// ), @brief Mount a new Image. @param image the Image to mount @param slot Image slot to mount into (valid range is 0 - 3) @param loaded initial loaded state for the Image @param skinTag tagged string to reskin the mounted Image @return true if successful, false if failed @tsexample %player.mountImage( PistolImage, 1 ); %player.mountImage( CrossbowImage, 0, false ); %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); @endtsexample @see unmountImage() @see getMountedImage() @see getPendingImage() @see isImageMounted()) +/// ), +/// @brief Mount a new Image. +/// +/// @param image the Image to mount +/// @param slot Image slot to mount into (valid range is 0 - 3) +/// @param loaded initial loaded state for the Image +/// @param skinTag tagged string to reskin the mounted Image +/// @return true if successful, false if failed +/// +/// @tsexample +/// %player.mountImage( PistolImage, 1 ); +/// %player.mountImage( CrossbowImage, 0, false ); +/// %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); +/// @endtsexample +/// +/// @see unmountImage() +/// @see getMountedImage() +/// @see getPendingImage() +/// @see isImageMounted()) +/// /// public bool fnShapeBase_mountImage (string shapebase, string image, int slot, bool loaded, string skinTag) @@ -30646,7 +39178,15 @@ public bool fnShapeBase_mountImage (string shapebase, string image, int slot, bo return SafeNativeMethods.mwle_fnShapeBase_mountImage(sbshapebase, sbimage, slot, loaded, sbskinTag)>=1; } /// -/// @brief Pause an animation thread. If restarted using playThread, the animation will resume from the paused position. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Pause an animation thread. +/// +/// If restarted using playThread, the animation +/// will resume from the paused position. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_pauseThread (string shapebase, int slot) @@ -30660,7 +39200,13 @@ public bool fnShapeBase_pauseThread (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_pauseThread(sbshapebase, slot)>=1; } /// -/// @brief Attach a sound to this shape and start playing it. @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play @return true if the sound was attached successfully, false if failed @see stopAudio()) +/// @brief Attach a sound to this shape and start playing it. +/// +/// @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play +/// @return true if the sound was attached successfully, false if failed +/// +/// @see stopAudio()) +/// /// public bool fnShapeBase_playAudio (string shapebase, int slot, string track) @@ -30677,7 +39223,28 @@ public bool fnShapeBase_playAudio (string shapebase, int slot, string track) return SafeNativeMethods.mwle_fnShapeBase_playAudio(sbshapebase, slot, sbtrack)>=1; } /// -/// ), @brief Start a new animation thread, or restart one that has been paused or stopped. @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not specified, the paused or stopped thread in this slot will be resumed. @return true if successful, false if failed @tsexample %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed %obj.pauseThread( 0 ); // Pause the sequence %obj.playThread( 0 ); // Resume playback %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 @endtsexample @see pauseThread() @see stopThread() @see setThreadDir() @see setThreadTimeScale() @see destroyThread()) +/// ), +/// @brief Start a new animation thread, or restart one that has been paused or +/// stopped. +/// +/// @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not +/// specified, the paused or stopped thread in this slot will be resumed. +/// @return true if successful, false if failed +/// +/// @tsexample +/// %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 +/// %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed +/// %obj.pauseThread( 0 ); // Pause the sequence +/// %obj.playThread( 0 ); // Resume playback +/// %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 +/// @endtsexample +/// +/// @see pauseThread() +/// @see stopThread() +/// @see setThreadDir() +/// @see setThreadTimeScale() +/// @see destroyThread()) +/// /// public bool fnShapeBase_playThread (string shapebase, int slot, string name) @@ -30694,7 +39261,13 @@ public bool fnShapeBase_playThread (string shapebase, int slot, string name) return SafeNativeMethods.mwle_fnShapeBase_playThread(sbshapebase, slot, sbname)>=1; } /// -/// @brief Set the hidden state on all the shape meshes. This allows you to hide all meshes in the shape, for example, and then only enable a few. @param hide new hidden state for all meshes ) +/// @brief Set the hidden state on all the shape meshes. +/// +/// This allows you to hide all meshes in the shape, for example, and then only +/// enable a few. +/// +/// @param hide new hidden state for all meshes ) +/// /// public void fnShapeBase_setAllMeshesHidden (string shapebase, bool hide) @@ -30708,7 +39281,10 @@ public void fnShapeBase_setAllMeshesHidden (string shapebase, bool hide) SafeNativeMethods.mwle_fnShapeBase_setAllMeshesHidden(sbshapebase, hide); } /// -/// @brief Set the vertical field of view in degrees for this object if used as a camera. @param fov new FOV value ) +/// @brief Set the vertical field of view in degrees for this object if used as a camera. +/// +/// @param fov new FOV value ) +/// /// public void fnShapeBase_setCameraFov (string shapebase, float fov) @@ -30722,7 +39298,14 @@ public void fnShapeBase_setCameraFov (string shapebase, float fov) SafeNativeMethods.mwle_fnShapeBase_setCameraFov(sbshapebase, fov); } /// -/// @brief Set the cloaked state of this object. When an object is cloaked it is not rendered. @param cloak true to cloak the object, false to uncloak @see isCloaked()) +/// @brief Set the cloaked state of this object. +/// +/// When an object is cloaked it is not rendered. +/// +/// @param cloak true to cloak the object, false to uncloak +/// +/// @see isCloaked()) +/// /// public void fnShapeBase_setCloaked (string shapebase, bool cloak) @@ -30736,7 +39319,17 @@ public void fnShapeBase_setCloaked (string shapebase, bool cloak) SafeNativeMethods.mwle_fnShapeBase_setCloaked(sbshapebase, cloak); } /// -/// @brief Set the damage flash level. Damage flash may be used as a postfx effect to flash the screen when the client is damaged. @note Relies on the flash postFx. @param level flash level (0-1) @see getDamageFlash()) +/// @brief Set the damage flash level. +/// +/// Damage flash may be used as a postfx effect to flash the screen when the +/// client is damaged. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getDamageFlash()) +/// /// public void fnShapeBase_setDamageFlash (string shapebase, float level) @@ -30750,7 +39343,13 @@ public void fnShapeBase_setDamageFlash (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setDamageFlash(sbshapebase, level); } /// -/// @brief Set the object's current damage level. @param level new damage level @see getDamageLevel() @see getDamagePercent()) +/// @brief Set the object's current damage level. +/// +/// @param level new damage level +/// +/// @see getDamageLevel() +/// @see getDamagePercent()) +/// /// public void fnShapeBase_setDamageLevel (string shapebase, float level) @@ -30764,7 +39363,13 @@ public void fnShapeBase_setDamageLevel (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setDamageLevel(sbshapebase, level); } /// -/// @brief Set the object's damage state. @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" @return true if successful, false if failed @see getDamageState()) +/// @brief Set the object's damage state. +/// +/// @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// @return true if successful, false if failed +/// +/// @see getDamageState()) +/// /// public bool fnShapeBase_setDamageState (string shapebase, string state) @@ -30781,7 +39386,17 @@ public bool fnShapeBase_setDamageState (string shapebase, string state) return SafeNativeMethods.mwle_fnShapeBase_setDamageState(sbshapebase, sbstate)>=1; } /// -/// @brief Set the damage direction vector. Currently this is only used to initialise the explosion if this object is blown up. @param vec damage direction vector @tsexample %obj.setDamageVector( \"0 0 1\" ); @endtsexample ) +/// @brief Set the damage direction vector. +/// +/// Currently this is only used to initialise the explosion if this object +/// is blown up. +/// +/// @param vec damage direction vector +/// +/// @tsexample +/// %obj.setDamageVector( \"0 0 1\" ); +/// @endtsexample ) +/// /// public void fnShapeBase_setDamageVector (string shapebase, string vec) @@ -30798,7 +39413,13 @@ public void fnShapeBase_setDamageVector (string shapebase, string vec) SafeNativeMethods.mwle_fnShapeBase_setDamageVector(sbshapebase, sbvec); } /// -/// @brief Set this object's current energy level. @param level new energy level @see getEnergyLevel() @see getEnergyPercent()) +/// @brief Set this object's current energy level. +/// +/// @param level new energy level +/// +/// @see getEnergyLevel() +/// @see getEnergyPercent()) +/// /// public void fnShapeBase_setEnergyLevel (string shapebase, float level) @@ -30812,7 +39433,10 @@ public void fnShapeBase_setEnergyLevel (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setEnergyLevel(sbshapebase, level); } /// -/// @brief Add or remove this object from the scene. When removed from the scene, the object will not be processed or rendered. @param show False to hide the object, true to re-show it ) +/// @brief Add or remove this object from the scene. +/// When removed from the scene, the object will not be processed or rendered. +/// @param show False to hide the object, true to re-show it ) +/// /// public void fnShapeBase_setHidden (string shapebase, bool show) @@ -30826,7 +39450,12 @@ public void fnShapeBase_setHidden (string shapebase, bool show) SafeNativeMethods.mwle_fnShapeBase_setHidden(sbshapebase, show); } /// -/// @brief Set the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new alt trigger state for the Image @return the Image's new alt trigger state ) +/// @brief Set the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new alt trigger state for the Image +/// @return the Image's new alt trigger state ) +/// /// public bool fnShapeBase_setImageAltTrigger (string shapebase, int slot, bool state) @@ -30840,7 +39469,12 @@ public bool fnShapeBase_setImageAltTrigger (string shapebase, int slot, bool sta return SafeNativeMethods.mwle_fnShapeBase_setImageAltTrigger(sbshapebase, slot, state)>=1; } /// -/// @brief Set the ammo state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new ammo state for the Image @return the Image's new ammo state ) +/// @brief Set the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new ammo state for the Image +/// @return the Image's new ammo state ) +/// /// public bool fnShapeBase_setImageAmmo (string shapebase, int slot, bool state) @@ -30854,7 +39488,13 @@ public bool fnShapeBase_setImageAmmo (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageAmmo(sbshapebase, slot, state)>=1; } /// -/// @brief Set the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param trigger Generic trigger number @param state new generic trigger state for the Image @return the Image's new generic trigger state or -1 if there was a problem. ) +/// @brief Set the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param trigger Generic trigger number +/// @param state new generic trigger state for the Image +/// @return the Image's new generic trigger state or -1 if there was a problem. ) +/// /// public int fnShapeBase_setImageGenericTrigger (string shapebase, int slot, int trigger, bool state) @@ -30868,7 +39508,12 @@ public int fnShapeBase_setImageGenericTrigger (string shapebase, int slot, int t return SafeNativeMethods.mwle_fnShapeBase_setImageGenericTrigger(sbshapebase, slot, trigger, state); } /// -/// @brief Set the loaded state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new loaded state for the Image @return the Image's new loaded state ) +/// @brief Set the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new loaded state for the Image +/// @return the Image's new loaded state ) +/// /// public bool fnShapeBase_setImageLoaded (string shapebase, int slot, bool state) @@ -30882,7 +39527,13 @@ public bool fnShapeBase_setImageLoaded (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageLoaded(sbshapebase, slot, state)>=1; } /// -/// @brief Set the script animation prefix for the Image mounted in the specified slot. This is used to further modify the prefix used when deciding which animation sequence to play while this image is mounted. @param slot Image slot to modify @param prefix The prefix applied to the image ) +/// @brief Set the script animation prefix for the Image mounted in the specified slot. +/// This is used to further modify the prefix used when deciding which animation sequence to +/// play while this image is mounted. +/// +/// @param slot Image slot to modify +/// @param prefix The prefix applied to the image ) +/// /// public void fnShapeBase_setImageScriptAnimPrefix (string shapebase, int slot, string prefix) @@ -30899,7 +39550,12 @@ public void fnShapeBase_setImageScriptAnimPrefix (string shapebase, int slot, st SafeNativeMethods.mwle_fnShapeBase_setImageScriptAnimPrefix(sbshapebase, slot, sbprefix); } /// -/// @brief Set the target state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new target state for the Image @return the Image's new target state ) +/// @brief Set the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new target state for the Image +/// @return the Image's new target state ) +/// /// public bool fnShapeBase_setImageTarget (string shapebase, int slot, bool state) @@ -30913,7 +39569,12 @@ public bool fnShapeBase_setImageTarget (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageTarget(sbshapebase, slot, state)>=1; } /// -/// @brief Set the trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new trigger state for the Image @return the Image's new trigger state ) +/// @brief Set the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new trigger state for the Image +/// @return the Image's new trigger state ) +/// /// public bool fnShapeBase_setImageTrigger (string shapebase, int slot, bool state) @@ -30927,21 +39588,11 @@ public bool fnShapeBase_setImageTrigger (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageTrigger(sbshapebase, slot, state)>=1; } /// -/// @brief Setup the invincible effect. This effect is used for HUD feedback to the user that they are invincible. @note Currently not implemented @param time duration in seconds for the invincible effect @param speed speed at which the invincible effect progresses ) -/// - -public void fnShapeBase_setInvincibleMode (string shapebase, float time, float speed) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fnShapeBase_setInvincibleMode'" + string.Format("\"{0}\" \"{1}\" \"{2}\" ",shapebase,time,speed)); -StringBuilder sbshapebase = null; -if (shapebase != null) - sbshapebase = new StringBuilder(shapebase, 1024); - -SafeNativeMethods.mwle_fnShapeBase_setInvincibleMode(sbshapebase, time, speed); -} -/// -/// @brief Set the hidden state on the named shape mesh. @param name name of the mesh to hide/show @param hide new hidden state for the mesh ) +/// @brief Set the hidden state on the named shape mesh. +/// +/// @param name name of the mesh to hide/show +/// @param hide new hidden state for the mesh ) +/// /// public void fnShapeBase_setMeshHidden (string shapebase, string name, bool hide) @@ -30958,7 +39609,15 @@ public void fnShapeBase_setMeshHidden (string shapebase, string name, bool hide) SafeNativeMethods.mwle_fnShapeBase_setMeshHidden(sbshapebase, sbname, hide); } /// -/// @brief Set the recharge rate. The recharge rate is added to the object's current energy level each tick, up to the maxEnergy level set in the ShapeBaseData datablock. @param rate the recharge rate (per tick) @see getRechargeRate()) +/// @brief Set the recharge rate. +/// +/// The recharge rate is added to the object's current energy level each tick, +/// up to the maxEnergy level set in the ShapeBaseData datablock. +/// +/// @param rate the recharge rate (per tick) +/// +/// @see getRechargeRate()) +/// /// public void fnShapeBase_setRechargeRate (string shapebase, float rate) @@ -30972,7 +39631,17 @@ public void fnShapeBase_setRechargeRate (string shapebase, float rate) SafeNativeMethods.mwle_fnShapeBase_setRechargeRate(sbshapebase, rate); } /// -/// @brief Set amount to repair damage by each tick. Note that this value is separate to the repairRate field in ShapeBaseData. This value will be subtracted from the damage level each tick, whereas the ShapeBaseData field limits how much of the applyRepair value is subtracted each tick. Both repair types can be active at the same time. @param rate value to subtract from damage level each tick (must be > 0) @see getRepairRate()) +/// @brief Set amount to repair damage by each tick. +/// +/// Note that this value is separate to the repairRate field in ShapeBaseData. +/// This value will be subtracted from the damage level each tick, whereas the +/// ShapeBaseData field limits how much of the applyRepair value is subtracted +/// each tick. Both repair types can be active at the same time. +/// +/// @param rate value to subtract from damage level each tick (must be > 0) +/// +/// @see getRepairRate()) +/// /// public void fnShapeBase_setRepairRate (string shapebase, float rate) @@ -30986,7 +39655,15 @@ public void fnShapeBase_setRepairRate (string shapebase, float rate) SafeNativeMethods.mwle_fnShapeBase_setRepairRate(sbshapebase, rate); } /// -/// @brief Set the name of this shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @param name new name for the shape @see getShapeName()) +/// @brief Set the name of this shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @param name new name for the shape +/// +/// @see getShapeName()) +/// /// public void fnShapeBase_setShapeName (string shapebase, string name) @@ -31003,7 +39680,16 @@ public void fnShapeBase_setShapeName (string shapebase, string name) SafeNativeMethods.mwle_fnShapeBase_setShapeName(sbshapebase, sbname); } /// -/// @brief Apply a new skin to this shape. 'Skinning' the shape effectively renames the material targets, allowing different materials to be used on different instances of the same model. @param name name of the skin to apply @see skin @see getSkinName()) +/// @brief Apply a new skin to this shape. +/// +/// 'Skinning' the shape effectively renames the material targets, allowing +/// different materials to be used on different instances of the same model. +/// +/// @param name name of the skin to apply +/// +/// @see skin +/// @see getSkinName()) +/// /// public void fnShapeBase_setSkinName (string shapebase, string name) @@ -31020,7 +39706,14 @@ public void fnShapeBase_setSkinName (string shapebase, string name) SafeNativeMethods.mwle_fnShapeBase_setSkinName(sbshapebase, sbname); } /// -/// @brief Set the playback direction of an animation thread. @param slot thread slot to modify @param fwd true to play the animation forwards, false to play backwards @return true if successful, false if failed @see playThread() ) +/// @brief Set the playback direction of an animation thread. +/// +/// @param slot thread slot to modify +/// @param fwd true to play the animation forwards, false to play backwards +/// @return true if successful, false if failed +/// +/// @see playThread() ) +/// /// public bool fnShapeBase_setThreadDir (string shapebase, int slot, bool fwd) @@ -31034,7 +39727,14 @@ public bool fnShapeBase_setThreadDir (string shapebase, int slot, bool fwd) return SafeNativeMethods.mwle_fnShapeBase_setThreadDir(sbshapebase, slot, fwd)>=1; } /// -/// @brief Set the position within an animation thread. @param slot thread slot to modify @param pos position within thread @return true if successful, false if failed @see playThread ) +/// @brief Set the position within an animation thread. +/// +/// @param slot thread slot to modify +/// @param pos position within thread +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_setThreadPosition (string shapebase, int slot, float pos) @@ -31048,7 +39748,14 @@ public bool fnShapeBase_setThreadPosition (string shapebase, int slot, float pos return SafeNativeMethods.mwle_fnShapeBase_setThreadPosition(sbshapebase, slot, pos)>=1; } /// -/// @brief Set the playback time scale of an animation thread. @param slot thread slot to modify @param scale new thread time scale (1=normal speed, 0.5=half speed etc) @return true if successful, false if failed @see playThread ) +/// @brief Set the playback time scale of an animation thread. +/// +/// @param slot thread slot to modify +/// @param scale new thread time scale (1=normal speed, 0.5=half speed etc) +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_setThreadTimeScale (string shapebase, int slot, float scale) @@ -31062,7 +39769,11 @@ public bool fnShapeBase_setThreadTimeScale (string shapebase, int slot, float sc return SafeNativeMethods.mwle_fnShapeBase_setThreadTimeScale(sbshapebase, slot, scale)>=1; } /// -/// @brief Set the object's velocity. @param vel new velocity for the object @return true ) +/// @brief Set the object's velocity. +/// +/// @param vel new velocity for the object +/// @return true ) +/// /// public bool fnShapeBase_setVelocity (string shapebase, string vel) @@ -31079,7 +39790,17 @@ public bool fnShapeBase_setVelocity (string shapebase, string vel) return SafeNativeMethods.mwle_fnShapeBase_setVelocity(sbshapebase, sbvel)>=1; } /// -/// @brief Set the white-out level. White-out may be used as a postfx effect to brighten the screen in response to a game event. @note Relies on the flash postFx. @param level flash level (0-1) @see getWhiteOut()) +/// @brief Set the white-out level. +/// +/// White-out may be used as a postfx effect to brighten the screen in response +/// to a game event. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getWhiteOut()) +/// /// public void fnShapeBase_setWhiteOut (string shapebase, float level) @@ -31093,7 +39814,21 @@ public void fnShapeBase_setWhiteOut (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setWhiteOut(sbshapebase, level); } /// -/// @brief Fade the object in or out without removing it from the scene. A faded out object is still in the scene and can still be collided with, so if you want to disable collisions for this shape after it fades out use setHidden to temporarily remove this shape from the scene. @note Items have the ability to light their surroundings. When an Item with an active light is fading out, the light it emits is correspondingly reduced until it goes out. Likewise, when the item fades in, the light is turned-up till it reaches it's normal brightntess. @param time duration of the fade effect in ms @param delay delay in ms before the fade effect begins @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// @brief Fade the object in or out without removing it from the scene. +/// +/// A faded out object is still in the scene and can still be collided with, +/// so if you want to disable collisions for this shape after it fades out +/// use setHidden to temporarily remove this shape from the scene. +/// +/// @note Items have the ability to light their surroundings. When an Item with +/// an active light is fading out, the light it emits is correspondingly +/// reduced until it goes out. Likewise, when the item fades in, the light is +/// turned-up till it reaches it's normal brightntess. +/// +/// @param time duration of the fade effect in ms +/// @param delay delay in ms before the fade effect begins +/// @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// /// public void fnShapeBase_startFade (string shapebase, int time, int delay, bool fadeOut) @@ -31107,7 +39842,13 @@ public void fnShapeBase_startFade (string shapebase, int time, int delay, bool f SafeNativeMethods.mwle_fnShapeBase_startFade(sbshapebase, time, delay, fadeOut); } /// -/// @brief Stop a sound started with playAudio. @param slot audio slot index (started with playAudio) @return true if the sound was stopped successfully, false if failed @see playAudio()) +/// @brief Stop a sound started with playAudio. +/// +/// @param slot audio slot index (started with playAudio) +/// @return true if the sound was stopped successfully, false if failed +/// +/// @see playAudio()) +/// /// public bool fnShapeBase_stopAudio (string shapebase, int slot) @@ -31121,7 +39862,15 @@ public bool fnShapeBase_stopAudio (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_stopAudio(sbshapebase, slot)>=1; } /// -/// @brief Stop an animation thread. If restarted using playThread, the animation will start from the beginning again. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Stop an animation thread. +/// +/// If restarted using playThread, the animation +/// will start from the beginning again. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_stopThread (string shapebase, int slot) @@ -31135,7 +39884,13 @@ public bool fnShapeBase_stopThread (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_stopThread(sbshapebase, slot)>=1; } /// -/// @brief Unmount the mounted Image in the specified slot. @param slot Image slot to unmount @return true if successful, false if failed @see mountImage()) +/// @brief Unmount the mounted Image in the specified slot. +/// +/// @param slot Image slot to unmount +/// @return true if successful, false if failed +/// +/// @see mountImage()) +/// /// public bool fnShapeBase_unmountImage (string shapebase, int slot) @@ -31149,7 +39904,17 @@ public bool fnShapeBase_unmountImage (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_unmountImage(sbshapebase, slot)>=1; } /// -/// @brief Check if there is the space at the given transform is free to spawn into. The shape's bounding box volume is used to check for collisions at the given world transform. Only interior and static objects are checked for collision. @param txfm Deploy transform to check @return True if the space is free, false if there is already something in the way. @note This is a server side only check, and is not actually limited to spawning.) +/// @brief Check if there is the space at the given transform is free to spawn into. +/// +/// The shape's bounding box volume is used to check for collisions at the given world +/// transform. Only interior and static objects are checked for collision. +/// +/// @param txfm Deploy transform to check +/// @return True if the space is free, false if there is already something in +/// the way. +/// +/// @note This is a server side only check, and is not actually limited to spawning.) +/// /// public bool fnShapeBaseData_checkDeployPos (string shapebasedata, string txfm) @@ -31166,7 +39931,11 @@ public bool fnShapeBaseData_checkDeployPos (string shapebasedata, string txfm) return SafeNativeMethods.mwle_fnShapeBaseData_checkDeployPos(sbshapebasedata, sbtxfm)>=1; } /// -/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). @param pos Desired transform position @param normal Vector of desired direction @return The deploy transform ) +/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). +/// @param pos Desired transform position +/// @param normal Vector of desired direction +/// @return The deploy transform ) +/// /// public string fnShapeBaseData_getDeployTransform (string shapebasedata, string pos, string normal) @@ -31189,7 +39958,11 @@ public string fnShapeBaseData_getDeployTransform (string shapebasedata, string p } /// -/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); Adds additional components to current list. @param Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); +/// Adds additional components to current list. +/// @param Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool fnSimComponent_addComponents (string simcomponent, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21, string a22, string a23, string a24, string a25, string a26, string a27, string a28, string a29, string a30, string a31, string a32, string a33, string a34, string a35, string a36, string a37, string a38, string a39, string a40, string a41, string a42, string a43, string a44, string a45, string a46, string a47, string a48, string a49, string a50, string a51, string a52, string a53, string a54, string a55, string a56, string a57, string a58, string a59, string a60, string a61, string a62, string a63) @@ -31389,7 +40162,11 @@ public bool fnSimComponent_addComponents (string simcomponent, string a2, string return SafeNativeMethods.mwle_fnSimComponent_addComponents(sbsimcomponent, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19, sba20, sba21, sba22, sba23, sba24, sba25, sba26, sba27, sba28, sba29, sba30, sba31, sba32, sba33, sba34, sba35, sba36, sba37, sba38, sba39, sba40, sba41, sba42, sba43, sba44, sba45, sba46, sba47, sba48, sba49, sba50, sba51, sba52, sba53, sba54, sba55, sba56, sba57, sba58, sba59, sba60, sba61, sba62, sba63)>=1; } /// -/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); Removes components by name from current list. @param objNamex Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); +/// Removes components by name from current list. +/// @param objNamex Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool fnSimComponent_removeComponents (string simcomponent, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21, string a22, string a23, string a24, string a25, string a26, string a27, string a28, string a29, string a30, string a31, string a32, string a33, string a34, string a35, string a36, string a37, string a38, string a39, string a40, string a41, string a42, string a43, string a44, string a45, string a46, string a47, string a48, string a49, string a50, string a51, string a52, string a53, string a54, string a55, string a56, string a57, string a58, string a59, string a60, string a61, string a62, string a63) @@ -32155,7 +40932,32 @@ public void fnSimObject_signal (string simobject, string a2, string a3) SafeNativeMethods.mwle_fnSimObject_signal(sbsimobject, sba2, sba3); } /// -/// @brief Sets the internal message variable. SimpleNetObject is set up to automatically transmit this new message to all connected clients. It will appear in the clients' console. @param msg The new message to send @tsexample // On the server, create a new SimpleNetObject. This is a ghost always // object so it will be immediately ghosted to all connected clients. $s = new SimpleNetObject(); // All connected clients will see the following in their console: // // Got message: Hello World! // Now again on the server, change the message. This will cause it to // be sent to all connected clients. $s.setMessage(\"A new message from me!\"); // All connected clients will now see in their console: // // Go message: A new message from me! @endtsexample ) +/// @brief Sets the internal message variable. +/// +/// SimpleNetObject is set up to automatically transmit this new message to +/// all connected clients. It will appear in the clients' console. +/// +/// @param msg The new message to send +/// +/// @tsexample +/// // On the server, create a new SimpleNetObject. This is a ghost always +/// // object so it will be immediately ghosted to all connected clients. +/// $s = new SimpleNetObject(); +/// +/// // All connected clients will see the following in their console: +/// // +/// // Got message: Hello World! +/// +/// // Now again on the server, change the message. This will cause it to +/// // be sent to all connected clients. +/// $s.setMessage(\"A new message from me!\"); +/// +/// // All connected clients will now see in their console: +/// // +/// // Go message: A new message from me! +/// @endtsexample +/// ) +/// /// public void fnSimpleNetObject_setMessage (string simplenetobject, string msg) @@ -32172,7 +40974,10 @@ public void fnSimpleNetObject_setMessage (string simplenetobject, string msg) SafeNativeMethods.mwle_fnSimpleNetObject_setMessage(sbsimplenetobject, sbmsg); } /// -/// Test whether the given object may be added to the set. @param obj The object to test for potential membership. @return True if the object may be added to the set, false otherwise. ) +/// Test whether the given object may be added to the set. +/// @param obj The object to test for potential membership. +/// @return True if the object may be added to the set, false otherwise. ) +/// /// public bool fnSimSet_acceptsAsChild (string simset, string obj) @@ -32189,7 +40994,10 @@ public bool fnSimSet_acceptsAsChild (string simset, string obj) return SafeNativeMethods.mwle_fnSimSet_acceptsAsChild(sbsimset, sbobj)>=1; } /// -/// ( SimSet, add, void, 3, 0, ( SimObject objects... ) Add the given objects to the set. @param objects The objects to add to the set. ) +/// ( SimSet, add, void, 3, 0, +/// ( SimObject objects... ) Add the given objects to the set. +/// @param objects The objects to add to the set. ) +/// /// public void fnSimSet_add (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32257,7 +41065,9 @@ public void fnSimSet_add (string simset, string a2, string a3, string a4, string SafeNativeMethods.mwle_fnSimSet_add(sbsimset, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// Make the given object the first object in the set. @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// Make the given object the first object in the set. +/// @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// /// public void fnSimSet_bringToFront (string simset, string obj) @@ -32274,7 +41084,13 @@ public void fnSimSet_bringToFront (string simset, string obj) SafeNativeMethods.mwle_fnSimSet_bringToFront(sbsimset, sbobj); } /// -/// ( SimSet, callOnChildren, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method recurses into all SimSets that are children to the set. @see callOnChildrenNoRecurse ) +/// ( SimSet, callOnChildren, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method recurses into all SimSets that are children to the set. +/// @see callOnChildrenNoRecurse ) +/// /// public void fnSimSet_callOnChildren (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32342,7 +41158,13 @@ public void fnSimSet_callOnChildren (string simset, string a2, string a3, string SafeNativeMethods.mwle_fnSimSet_callOnChildren(sbsimset, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method does not recurse into child SimSets. @see callOnChildren ) +/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method does not recurse into child SimSets. +/// @see callOnChildren ) +/// /// public void fnSimSet_callOnChildrenNoRecurse (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32411,6 +41233,7 @@ public void fnSimSet_callOnChildrenNoRecurse (string simset, string a2, string a } /// /// Remove all objects from the set. ) +/// /// public void fnSimSet_clear (string simset) @@ -32424,7 +41247,11 @@ public void fnSimSet_clear (string simset) SafeNativeMethods.mwle_fnSimSet_clear(sbsimset); } /// -/// Find an object in the set by its internal name. @param internalName The internal name of the object to look for. @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. @return The object with the given internal name or 0 if no match was found. ) +/// Find an object in the set by its internal name. +/// @param internalName The internal name of the object to look for. +/// @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. +/// @return The object with the given internal name or 0 if no match was found. ) +/// /// public string fnSimSet_findObjectByInternalName (string simset, string internalName, bool searchChildren) @@ -32444,7 +41271,9 @@ public string fnSimSet_findObjectByInternalName (string simset, string internalN } /// -/// Get the number of objects contained in the set. @return The number of objects contained in the set. ) +/// Get the number of objects contained in the set. +/// @return The number of objects contained in the set. ) +/// /// public int fnSimSet_getCount (string simset) @@ -32458,7 +41287,10 @@ public int fnSimSet_getCount (string simset) return SafeNativeMethods.mwle_fnSimSet_getCount(sbsimset); } /// -/// Get the object at the given index. @param index The object index. @return The object at the given index or -1 if index is out of range. ) +/// Get the object at the given index. +/// @param index The object index. +/// @return The object at the given index or -1 if index is out of range. ) +/// /// public string fnSimSet_getObject (string simset, uint index) @@ -32475,7 +41307,10 @@ public string fnSimSet_getObject (string simset, uint index) } /// -/// Return the index of the given object in this set. @param obj The object for which to return the index. Must be contained in the set. @return The index of the object or -1 if the object is not contained in the set. ) +/// Return the index of the given object in this set. +/// @param obj The object for which to return the index. Must be contained in the set. +/// @return The index of the object or -1 if the object is not contained in the set. ) +/// /// public int fnSimSet_getObjectIndex (string simset, string obj) @@ -32492,7 +41327,9 @@ public int fnSimSet_getObjectIndex (string simset, string obj) return SafeNativeMethods.mwle_fnSimSet_getObjectIndex(sbsimset, sbobj); } /// -/// Return a random object from the set. @return A randomly selected object from the set or -1 if the set is empty. ) +/// Return a random object from the set. +/// @return A randomly selected object from the set or -1 if the set is empty. ) +/// /// public string fnSimSet_getRandom (string simset) @@ -32509,7 +41346,10 @@ public string fnSimSet_getRandom (string simset) } /// -/// Test whether the given object belongs to the set. @param obj The object. @return True if the object is contained in the set; false otherwise. ) +/// Test whether the given object belongs to the set. +/// @param obj The object. +/// @return True if the object is contained in the set; false otherwise. ) +/// /// public bool fnSimSet_isMember (string simset, string obj) @@ -32527,6 +41367,7 @@ public bool fnSimSet_isMember (string simset, string obj) } /// /// Dump a list of all objects contained in the set to the console. ) +/// /// public void fnSimSet_listObjects (string simset) @@ -32540,7 +41381,9 @@ public void fnSimSet_listObjects (string simset) SafeNativeMethods.mwle_fnSimSet_listObjects(sbsimset); } /// -/// Make the given object the last object in the set. @param obj The object to bring to the last position. Must be contained in the set. ) +/// Make the given object the last object in the set. +/// @param obj The object to bring to the last position. Must be contained in the set. ) +/// /// public void fnSimSet_pushToBack (string simset, string obj) @@ -32557,7 +41400,10 @@ public void fnSimSet_pushToBack (string simset, string obj) SafeNativeMethods.mwle_fnSimSet_pushToBack(sbsimset, sbobj); } /// -/// ( SimSet, remove, void, 3, 0, ( SimObject objects... ) Remove the given objects from the set. @param objects The objects to remove from the set. ) +/// ( SimSet, remove, void, 3, 0, +/// ( SimObject objects... ) Remove the given objects from the set. +/// @param objects The objects to remove from the set. ) +/// /// public void fnSimSet_remove (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32625,7 +41471,10 @@ public void fnSimSet_remove (string simset, string a2, string a3, string a4, str SafeNativeMethods.mwle_fnSimSet_remove(sbsimset, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// Make sure child1 is ordered right before child2 in the set. @param child1 The first child. The object must already be contained in the set. @param child2 The second child. The object must already be contained in the set. ) +/// Make sure child1 is ordered right before child2 in the set. +/// @param child1 The first child. The object must already be contained in the set. +/// @param child2 The second child. The object must already be contained in the set. ) +/// /// public void fnSimSet_reorderChild (string simset, string child1, string child2) @@ -32645,7 +41494,24 @@ public void fnSimSet_reorderChild (string simset, string child1, string child2) SafeNativeMethods.mwle_fnSimSet_reorderChild(sbsimset, sbchild1, sbchild2); } /// -/// @brief Add the given comment as a child of the document. @param comment String containing the comment. @tsexample // Create a new XML document with a header, a comment and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addComment(\"This is a test comment\"); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // !--This is a test comment--> // NewElement /> @endtsexample @see readComment()) +/// @brief Add the given comment as a child of the document. +/// @param comment String containing the comment. +/// +/// @tsexample +/// // Create a new XML document with a header, a comment and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addComment(\"This is a test comment\"); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // !--This is a test comment--> +/// // NewElement /> +/// @endtsexample +/// +/// @see readComment()) +/// /// public void fnSimXMLDocument_addComment (string simxmldocument, string comment) @@ -32662,7 +41528,34 @@ public void fnSimXMLDocument_addComment (string simxmldocument, string comment) SafeNativeMethods.mwle_fnSimXMLDocument_addComment(sbsimxmldocument, sbcomment); } /// -/// @brief Add the given text as a child of current Element. Use getData() to retrieve any text from the current Element. addData() and addText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added data. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addData(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getData() @see addText() @see getText() @see removeText()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getData() to retrieve any text from the current Element. +/// +/// addData() and addText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added data. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addData(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public void fnSimXMLDocument_addData (string simxmldocument, string text) @@ -32679,7 +41572,24 @@ public void fnSimXMLDocument_addData (string simxmldocument, string text) SafeNativeMethods.mwle_fnSimXMLDocument_addData(sbsimxmldocument, sbtext); } /// -/// @brief Add a XML header to a document. Sometimes called a declaration, you typically add a standard header to the document before adding any elements. SimXMLDocument always produces the following header: ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> @tsexample // Create a new XML document with just a header and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement /> @endtsexample) +/// @brief Add a XML header to a document. +/// +/// Sometimes called a declaration, you typically add a standard header to +/// the document before adding any elements. SimXMLDocument always produces +/// the following header: +/// ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// +/// @tsexample +/// // Create a new XML document with just a header and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement /> +/// @endtsexample) +/// /// public void fnSimXMLDocument_addHeader (string simxmldocument) @@ -32693,7 +41603,17 @@ public void fnSimXMLDocument_addHeader (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_addHeader(sbsimxmldocument); } /// -/// @brief Create a new element with the given name as child of current Element's parent and push it onto the Element stack making it the current one. @note This differs from pushNewElement() in that it adds the new Element to the current Element's parent (or document if there is no parent Element). This makes the new Element a sibling of the current one. @param name XML tag for the new Element. @see pushNewElement()) +/// @brief Create a new element with the given name as child of current Element's +/// parent and push it onto the Element stack making it the current one. +/// +/// @note This differs from pushNewElement() in that it adds the new Element to the +/// current Element's parent (or document if there is no parent Element). This makes +/// the new Element a sibling of the current one. +/// +/// @param name XML tag for the new Element. +/// +/// @see pushNewElement()) +/// /// public void fnSimXMLDocument_addNewElement (string simxmldocument, string name) @@ -32710,7 +41630,33 @@ public void fnSimXMLDocument_addNewElement (string simxmldocument, string name) SafeNativeMethods.mwle_fnSimXMLDocument_addNewElement(sbsimxmldocument, sbname); } /// -/// @brief Add the given text as a child of current Element. Use getText() to retrieve any text from the current Element and removeText() to clear any text. addText() and addData() may be used interchangeably. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added text. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addText(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getText() @see removeText() @see addData() @see getData()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getText() to retrieve any text from the current Element and removeText() +/// to clear any text. +/// +/// addText() and addData() may be used interchangeably. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added text. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addText(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public void fnSimXMLDocument_addText (string simxmldocument, string text) @@ -32727,7 +41673,10 @@ public void fnSimXMLDocument_addText (string simxmldocument, string text) SafeNativeMethods.mwle_fnSimXMLDocument_addText(sbsimxmldocument, sbtext); } /// -/// @brief Get a string attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The attribute string if found. Otherwise returns an empty string.) +/// @brief Get a string attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The attribute string if found. Otherwise returns an empty string.) +/// /// public string fnSimXMLDocument_attribute (string simxmldocument, string attributeName) @@ -32747,7 +41696,10 @@ public string fnSimXMLDocument_attribute (string simxmldocument, string attribut } /// -/// @brief Tests if the requested attribute exists. @param attributeName Name of attribute being queried for. @return True if the attribute exists.) +/// @brief Tests if the requested attribute exists. +/// @param attributeName Name of attribute being queried for. +/// @return True if the attribute exists.) +/// /// public bool fnSimXMLDocument_attributeExists (string simxmldocument, string attributeName) @@ -32764,7 +41716,12 @@ public bool fnSimXMLDocument_attributeExists (string simxmldocument, string attr return SafeNativeMethods.mwle_fnSimXMLDocument_attributeExists(sbsimxmldocument, sbattributeName)>=1; } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using reset() @see reset()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using reset() +/// +/// @see reset()) +/// /// public void fnSimXMLDocument_clear (string simxmldocument) @@ -32779,6 +41736,7 @@ public void fnSimXMLDocument_clear (string simxmldocument) } /// /// @brief Clear the last error description.) +/// /// public void fnSimXMLDocument_clearError (string simxmldocument) @@ -32792,7 +41750,10 @@ public void fnSimXMLDocument_clearError (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_clearError(sbsimxmldocument); } /// -/// @brief Get the Element's value if it exists. Usually returns the text from the Element. @return The value from the Element, or an empty string if none is found.) +/// @brief Get the Element's value if it exists. +/// Usually returns the text from the Element. +/// @return The value from the Element, or an empty string if none is found.) +/// /// public string fnSimXMLDocument_elementValue (string simxmldocument) @@ -32809,7 +41770,12 @@ public string fnSimXMLDocument_elementValue (string simxmldocument) } /// -/// @brief Obtain the name of the current Element's first attribute. @return String containing the first attribute's name, or an empty string if none is found. @see nextAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Obtain the name of the current Element's first attribute. +/// @return String containing the first attribute's name, or an empty string if none is found. +/// @see nextAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string fnSimXMLDocument_firstAttribute (string simxmldocument) @@ -32826,7 +41792,39 @@ public string fnSimXMLDocument_firstAttribute (string simxmldocument) } /// -/// @brief Gets the text from the current Element. Use addData() to add text to the current Element. getData() and getText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some data/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's data ('Some data' in this example) // into 'result' %result = %x.getData(); echo( %result ); @endtsexample @see addData() @see addText() @see getText() @see removeText()) +/// @brief Gets the text from the current Element. +/// +/// Use addData() to add text to the current Element. +/// +/// getData() and getText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some data/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's data ('Some data' in this example) +/// // into 'result' +/// %result = %x.getData(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public string fnSimXMLDocument_getData (string simxmldocument) @@ -32843,7 +41841,9 @@ public string fnSimXMLDocument_getData (string simxmldocument) } /// -/// @brief Get last error description. @return A string of the last error message.) +/// @brief Get last error description. +/// @return A string of the last error message.) +/// /// public string fnSimXMLDocument_getErrorDesc (string simxmldocument) @@ -32860,7 +41860,38 @@ public string fnSimXMLDocument_getErrorDesc (string simxmldocument) } /// -/// @brief Gets the text from the current Element. Use addText() to add text to the current Element and removeText() to clear any text. getText() and getData() may be used interchangeably. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample @see addText() @see removeText() @see addData() @see getData()) +/// @brief Gets the text from the current Element. +/// +/// Use addText() to add text to the current Element and removeText() +/// to clear any text. +/// +/// getText() and getData() may be used interchangeably. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public string fnSimXMLDocument_getText (string simxmldocument) @@ -32877,7 +41908,12 @@ public string fnSimXMLDocument_getText (string simxmldocument) } /// -/// @brief Obtain the name of the current Element's last attribute. @return String containing the last attribute's name, or an empty string if none is found. @see prevAttribute() @see firstAttribute() @see lastAttribute()) +/// @brief Obtain the name of the current Element's last attribute. +/// @return String containing the last attribute's name, or an empty string if none is found. +/// @see prevAttribute() +/// @see firstAttribute() +/// @see lastAttribute()) +/// /// public string fnSimXMLDocument_lastAttribute (string simxmldocument) @@ -32894,7 +41930,11 @@ public string fnSimXMLDocument_lastAttribute (string simxmldocument) } /// -/// @brief Load in given filename and prepare it for use. @note Clears the current document's contents. @param fileName Name and path of XML document @return True if the file was loaded successfully.) +/// @brief Load in given filename and prepare it for use. +/// @note Clears the current document's contents. +/// @param fileName Name and path of XML document +/// @return True if the file was loaded successfully.) +/// /// public bool fnSimXMLDocument_loadFile (string simxmldocument, string fileName) @@ -32911,7 +41951,12 @@ public bool fnSimXMLDocument_loadFile (string simxmldocument, string fileName) return SafeNativeMethods.mwle_fnSimXMLDocument_loadFile(sbsimxmldocument, sbfileName)>=1; } /// -/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). @return String containing the next attribute's name, or an empty string if none is found. @see firstAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). +/// @return String containing the next attribute's name, or an empty string if none is found. +/// @see firstAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string fnSimXMLDocument_nextAttribute (string simxmldocument) @@ -32928,7 +41973,10 @@ public string fnSimXMLDocument_nextAttribute (string simxmldocument) } /// -/// @brief Put the next sibling Element with the given name on the stack, making it the current one. @param name String containing name of the next sibling. @return True if the Element was found and made the current one.) +/// @brief Put the next sibling Element with the given name on the stack, making it the current one. +/// @param name String containing name of the next sibling. +/// @return True if the Element was found and made the current one.) +/// /// public bool fnSimXMLDocument_nextSiblingElement (string simxmldocument, string name) @@ -32945,7 +41993,10 @@ public bool fnSimXMLDocument_nextSiblingElement (string simxmldocument, string n return SafeNativeMethods.mwle_fnSimXMLDocument_nextSiblingElement(sbsimxmldocument, sbname)>=1; } /// -/// @brief Create a document from a XML string. @note Clears the current document's contents. @param xmlString Valid XML to parse and store as a document.) +/// @brief Create a document from a XML string. +/// @note Clears the current document's contents. +/// @param xmlString Valid XML to parse and store as a document.) +/// /// public void fnSimXMLDocument_parse (string simxmldocument, string xmlString) @@ -32963,6 +42014,7 @@ public void fnSimXMLDocument_parse (string simxmldocument, string xmlString) } /// /// @brief Pop the last Element off the stack.) +/// /// public void fnSimXMLDocument_popElement (string simxmldocument) @@ -32976,7 +42028,12 @@ public void fnSimXMLDocument_popElement (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_popElement(sbsimxmldocument); } /// -/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). @return String containing the previous attribute's name, or an empty string if none is found. @see lastAttribute() @see firstAttribute() @see nextAttribute()) +/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). +/// @return String containing the previous attribute's name, or an empty string if none is found. +/// @see lastAttribute() +/// @see firstAttribute() +/// @see nextAttribute()) +/// /// public string fnSimXMLDocument_prevAttribute (string simxmldocument) @@ -32993,7 +42050,10 @@ public string fnSimXMLDocument_prevAttribute (string simxmldocument) } /// -/// @brief Push the child Element at the given index onto the stack, making it the current one. @param index Numerical index of Element being pushed. @return True if the Element was found and made the current one.) +/// @brief Push the child Element at the given index onto the stack, making it the current one. +/// @param index Numerical index of Element being pushed. +/// @return True if the Element was found and made the current one.) +/// /// public bool fnSimXMLDocument_pushChildElement (string simxmldocument, int index) @@ -33007,7 +42067,29 @@ public bool fnSimXMLDocument_pushChildElement (string simxmldocument, int index) return SafeNativeMethods.mwle_fnSimXMLDocument_pushChildElement(sbsimxmldocument, index)>=1; } /// -/// @brief Push the first child Element with the given name onto the stack, making it the current Element. @param name String containing name of the child Element. @return True if the Element was found and made the current one. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample) +/// @brief Push the first child Element with the given name onto the stack, making it the current Element. +/// +/// @param name String containing name of the child Element. +/// @return True if the Element was found and made the current one. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample) +/// /// public bool fnSimXMLDocument_pushFirstChildElement (string simxmldocument, string name) @@ -33024,7 +42106,16 @@ public bool fnSimXMLDocument_pushFirstChildElement (string simxmldocument, strin return SafeNativeMethods.mwle_fnSimXMLDocument_pushFirstChildElement(sbsimxmldocument, sbname)>=1; } /// -/// @brief Create a new element with the given name as child of current Element and push it onto the Element stack making it the current one. @note This differs from addNewElement() in that it adds the new Element as a child of the current Element (or a child of the document if no Element exists). @param name XML tag for the new Element. @see addNewElement()) +/// @brief Create a new element with the given name as child of current Element +/// and push it onto the Element stack making it the current one. +/// +/// @note This differs from addNewElement() in that it adds the new Element as a +/// child of the current Element (or a child of the document if no Element exists). +/// +/// @param name XML tag for the new Element. +/// +/// @see addNewElement()) +/// /// public void fnSimXMLDocument_pushNewElement (string simxmldocument, string name) @@ -33041,7 +42132,18 @@ public void fnSimXMLDocument_pushNewElement (string simxmldocument, string name) SafeNativeMethods.mwle_fnSimXMLDocument_pushNewElement(sbsimxmldocument, sbname); } /// -/// Gives the comment at the specified index, if any. Unlike addComment() that only works at the document level, readComment() may read comments from the document or any child Element. The current Element (or document if no Elements have been pushed to the stack) is the parent for any comments, and the provided index is the number of comments in to read back. @param index Comment index number to query from the current Element stack @return String containing the comment, or an empty string if no comment is found. @see addComment()) +/// Gives the comment at the specified index, if any. +/// +/// Unlike addComment() that only works at the document level, readComment() may read +/// comments from the document or any child Element. The current Element (or document +/// if no Elements have been pushed to the stack) is the parent for any comments, and the +/// provided index is the number of comments in to read back. +/// +/// @param index Comment index number to query from the current Element stack +/// @return String containing the comment, or an empty string if no comment is found. +/// +/// @see addComment()) +/// /// public string fnSimXMLDocument_readComment (string simxmldocument, int index) @@ -33058,7 +42160,18 @@ public string fnSimXMLDocument_readComment (string simxmldocument, int index) } /// -/// @brief Remove any text on the current Element. Use getText() to retrieve any text from the current Element and addText() to add text to the current Element. As getData() and addData() are equivalent to getText() and addText(), removeText() will also remove any data from the current Element. @see addText() @see getText() @see addData() @see getData()) +/// @brief Remove any text on the current Element. +/// +/// Use getText() to retrieve any text from the current Element and addText() +/// to add text to the current Element. As getData() and addData() are equivalent +/// to getText() and addText(), removeText() will also remove any data from the +/// current Element. +/// +/// @see addText() +/// @see getText() +/// @see addData() +/// @see getData()) +/// /// public void fnSimXMLDocument_removeText (string simxmldocument) @@ -33072,7 +42185,12 @@ public void fnSimXMLDocument_removeText (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_removeText(sbsimxmldocument); } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using clear() @see clear()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using clear() +/// +/// @see clear()) +/// /// public void fnSimXMLDocument_reset (string simxmldocument) @@ -33086,7 +42204,10 @@ public void fnSimXMLDocument_reset (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_reset(sbsimxmldocument); } /// -/// @brief Save document to the given file name. @param fileName Path and name of XML file to save to. @return True if the file was successfully saved.) +/// @brief Save document to the given file name. +/// @param fileName Path and name of XML file to save to. +/// @return True if the file was successfully saved.) +/// /// public bool fnSimXMLDocument_saveFile (string simxmldocument, string fileName) @@ -33103,7 +42224,10 @@ public bool fnSimXMLDocument_saveFile (string simxmldocument, string fileName) return SafeNativeMethods.mwle_fnSimXMLDocument_saveFile(sbsimxmldocument, sbfileName)>=1; } /// -/// @brief Set the attribute of the current Element on the stack to the given value. @param attributeName Name of attribute being changed @param value New value to assign to the attribute) +/// @brief Set the attribute of the current Element on the stack to the given value. +/// @param attributeName Name of attribute being changed +/// @param value New value to assign to the attribute) +/// /// public void fnSimXMLDocument_setAttribute (string simxmldocument, string attributeName, string value) @@ -33123,7 +42247,9 @@ public void fnSimXMLDocument_setAttribute (string simxmldocument, string attribu SafeNativeMethods.mwle_fnSimXMLDocument_setAttribute(sbsimxmldocument, sbattributeName, sbvalue); } /// -/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. @param objectID ID of SimObject being copied.) +/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. +/// @param objectID ID of SimObject being copied.) +/// /// public void fnSimXMLDocument_setObjectAttributes (string simxmldocument, string objectID) @@ -33140,7 +42266,10 @@ public void fnSimXMLDocument_setObjectAttributes (string simxmldocument, string SafeNativeMethods.mwle_fnSimXMLDocument_setObjectAttributes(sbsimxmldocument, sbobjectID); } /// -/// @brief Copy from another StreamObject into this StreamObject @param other The StreamObject to copy from. @return True if the copy was successful.) +/// @brief Copy from another StreamObject into this StreamObject +/// @param other The StreamObject to copy from. +/// @return True if the copy was successful.) +/// /// public bool fnStreamObject_copyFrom (string streamobject, string other) @@ -33157,7 +42286,36 @@ public bool fnStreamObject_copyFrom (string streamobject, string other) return SafeNativeMethods.mwle_fnStreamObject_copyFrom(sbstreamobject, sbother)>=1; } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains two lines of text repeated: // Hello World // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Get the position of the stream %position = %fsObject.getPosition(); // Print the current position // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline echo(%position); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see setPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains two lines of text repeated: +/// // Hello World +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Get the position of the stream +/// %position = %fsObject.getPosition(); +/// // Print the current position +/// // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline +/// echo(%position); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see setPosition()) +/// /// public int fnStreamObject_getPosition (string streamobject) @@ -33171,7 +42329,36 @@ public int fnStreamObject_getPosition (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_getPosition(sbstreamobject); } /// -/// @brief Gets a printable string form of the stream's status @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing status constant, one of the following: OK - Stream is active and no file errors IOError - Something went wrong during read or writing the stream EOS - End of Stream reached (mostly for reads) IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn Closed - Tried to operate on a closed stream (or detached filter) UnknownError - Catch all for an error of some kind Invalid - Entire stream is invalid) +/// @brief Gets a printable string form of the stream's status +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing status constant, one of the following: +/// +/// OK - Stream is active and no file errors +/// +/// IOError - Something went wrong during read or writing the stream +/// +/// EOS - End of Stream reached (mostly for reads) +/// +/// IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn +/// +/// Closed - Tried to operate on a closed stream (or detached filter) +/// +/// UnknownError - Catch all for an error of some kind +/// +/// Invalid - Entire stream is invalid) +/// /// public string fnStreamObject_getStatus (string streamobject) @@ -33188,7 +42375,30 @@ public string fnStreamObject_getStatus (string streamobject) } /// -/// @brief Gets the size of the stream The size is dependent on the type of stream being used. If it is a file stream, returned value will be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject.open(\"./test.txt\", \"read\"); // Found out how large the file stream is // Then print it to the console // Should be 22 %streamSize = %fsObject.getStreamSize(); echo(%streamSize); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Size of stream, in bytes) +/// @brief Gets the size of the stream +/// +/// The size is dependent on the type of stream being used. If it is a file stream, returned value will +/// be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Found out how large the file stream is +/// // Then print it to the console +/// // Should be 22 +/// %streamSize = %fsObject.getStreamSize(); +/// echo(%streamSize); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Size of stream, in bytes) +/// /// public int fnStreamObject_getStreamSize (string streamobject) @@ -33202,7 +42412,32 @@ public int fnStreamObject_getStreamSize (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_getStreamSize(sbstreamobject); } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOS. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOF() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOS()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOS. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOF() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOS()) +/// /// public bool fnStreamObject_isEOF (string streamobject) @@ -33216,7 +42451,32 @@ public bool fnStreamObject_isEOF (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_isEOF(sbstreamobject)>=1; } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOF. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOS() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOF()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOF. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOS() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOF()) +/// /// public bool fnStreamObject_isEOS (string streamobject) @@ -33230,7 +42490,30 @@ public bool fnStreamObject_isEOS (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_isEOS(sbstreamobject)>=1; } /// -/// @brief Read a line from the stream. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file stream object for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject = new FileStreamObject(); %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Print the line we just read echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing the line of data that was just read @see writeLine()) +/// @brief Read a line from the stream. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file stream object for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject = new FileStreamObject(); +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Print the line we just read +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing the line of data that was just read +/// +/// @see writeLine()) +/// /// public string fnStreamObject_readLine (string streamobject) @@ -33247,7 +42530,15 @@ public string fnStreamObject_readLine (string streamobject) } /// -/// @brief Read in a string up to the given maximum number of characters. @param maxLength The maximum number of characters to read in. @return The string that was read from the stream. @see writeLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string up to the given maximum number of characters. +/// @param maxLength The maximum number of characters to read in. +/// @return The string that was read from the stream. +/// @see writeLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string fnStreamObject_readLongString (string streamobject, int maxLength) @@ -33264,7 +42555,14 @@ public string fnStreamObject_readLongString (string streamobject, int maxLength) } /// -/// @brief Read a string up to a maximum of 256 characters @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read a string up to a maximum of 256 characters +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string fnStreamObject_readString (string streamobject) @@ -33281,7 +42579,16 @@ public string fnStreamObject_readString (string streamobject) } /// -/// @brief Read in a string and place it on the string table. @param caseSensitive If false then case will not be taken into account when attempting to match the read in string with what is already in the string table. @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string and place it on the string table. +/// @param caseSensitive If false then case will not be taken into account when attempting +/// to match the read in string with what is already in the string table. +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string fnStreamObject_readSTString (string streamobject, bool caseSensitive) @@ -33298,7 +42605,35 @@ public string fnStreamObject_readSTString (string streamobject, bool caseSensiti } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // 11111111111 // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Skip ahead by 12, which will bypass the first line entirely %fsObject.setPosition(12); // Read in the next line %line = %fsObject.readLine(); // Print the line just read in, should be \"Hello World\" echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see getPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // 11111111111 +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Skip ahead by 12, which will bypass the first line entirely +/// %fsObject.setPosition(12); +/// // Read in the next line +/// %line = %fsObject.readLine(); +/// // Print the line just read in, should be \"Hello World\" +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see getPosition()) +/// /// public bool fnStreamObject_setPosition (string streamobject, int newPosition) @@ -33312,7 +42647,29 @@ public bool fnStreamObject_setPosition (string streamobject, int newPosition) return SafeNativeMethods.mwle_fnStreamObject_setPosition(sbstreamobject, newPosition)>=1; } /// -/// @brief Write a line to the stream, if it was opened for writing. There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param line The data we are writing out to file. @tsexample // Create a file stream %fsObject = new FileStreamObject(); // Open the file for writing // If it does not exist, it is created. If it does exist, the file is cleared %fsObject.open(\"./test.txt\", \"write\"); // Write a line to the file %fsObject.writeLine(\"Hello World\"); // Write another line to the file %fsObject.writeLine(\"Documentation Rocks!\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see readLine()) +/// @brief Write a line to the stream, if it was opened for writing. +/// +/// There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param line The data we are writing out to file. +/// +/// @tsexample +/// // Create a file stream +/// %fsObject = new FileStreamObject(); +/// // Open the file for writing +/// // If it does not exist, it is created. If it does exist, the file is cleared +/// %fsObject.open(\"./test.txt\", \"write\"); +/// // Write a line to the file +/// %fsObject.writeLine(\"Hello World\"); +/// // Write another line to the file +/// %fsObject.writeLine(\"Documentation Rocks!\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see readLine()) +/// /// public void fnStreamObject_writeLine (string streamobject, string line) @@ -33329,7 +42686,15 @@ public void fnStreamObject_writeLine (string streamobject, string line) SafeNativeMethods.mwle_fnStreamObject_writeLine(sbstreamobject, sbline); } /// -/// @brief Write out a string up to the maximum number of characters. @param maxLength The maximum number of characters that will be written. @param string The string to write out to the stream. @see readLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string up to the maximum number of characters. +/// @param maxLength The maximum number of characters that will be written. +/// @param string The string to write out to the stream. +/// @see readLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void fnStreamObject_writeLongString (string streamobject, int maxLength, string stringx) @@ -33346,7 +42711,16 @@ public void fnStreamObject_writeLongString (string streamobject, int maxLength, SafeNativeMethods.mwle_fnStreamObject_writeLongString(sbstreamobject, maxLength, sbstringx); } /// -/// @brief Write out a string with a default maximum length of 256 characters. @param string The string to write out to the stream @param maxLength The maximum string length to write out with a default of 256 characters. This value should not be larger than 256 as it is written to the stream as a single byte. @see readString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string with a default maximum length of 256 characters. +/// @param string The string to write out to the stream +/// @param maxLength The maximum string length to write out with a default of 256 characters. This +/// value should not be larger than 256 as it is written to the stream as a single byte. +/// @see readString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void fnStreamObject_writeString (string streamobject, string stringx, int maxLength) @@ -33363,7 +42737,18 @@ public void fnStreamObject_writeString (string streamobject, string stringx, int SafeNativeMethods.mwle_fnStreamObject_writeString(sbstreamobject, sbstringx, maxLength); } /// -/// @brief Connect to the given address. @param address Server address (including port) to connect to. @tsexample // Set the address. %address = \"www.garagegames.com:80\"; // Inform this TCPObject to connect to the specified address. %thisTCPObj.connect(%address); @endtsexample) +/// @brief Connect to the given address. +/// +/// @param address Server address (including port) to connect to. +/// +/// @tsexample +/// // Set the address. +/// %address = \"www.garagegames.com:80\"; +/// +/// // Inform this TCPObject to connect to the specified address. +/// %thisTCPObj.connect(%address); +/// @endtsexample) +/// /// public void fnTCPObject_connect (string tcpobject, string address) @@ -33380,7 +42765,13 @@ public void fnTCPObject_connect (string tcpobject, string address) SafeNativeMethods.mwle_fnTCPObject_connect(sbtcpobject, sbaddress); } /// -/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. @tsexample // Inform this TCPObject to disconnect from anything it is currently connected to. %thisTCPObj.disconnect(); @endtsexample) +/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. +/// +/// @tsexample +/// // Inform this TCPObject to disconnect from anything it is currently connected to. +/// %thisTCPObj.disconnect(); +/// @endtsexample) +/// /// public void fnTCPObject_disconnect (string tcpobject) @@ -33394,10 +42785,37 @@ public void fnTCPObject_disconnect (string tcpobject) SafeNativeMethods.mwle_fnTCPObject_disconnect(sbtcpobject); } /// -/// @brief Start listening on the specified port for connections. This method starts a listener which looks for incoming TCP connections to a port. You must overload the onConnectionRequest callback to create a new TCPObject to read, write, or reject the new connection. @param port Port for this TCPObject to start listening for connections on. @tsexample // Create a listener on port 8080. new TCPObject( TCPListener ); TCPListener.listen( 8080 ); function TCPListener::onConnectionRequest( %this, %address, %id ) { // Create a new object to manage the connection. new TCPObject( TCPClient, %id ); } function TCPClient::onLine( %this, %line ) { // Print the line of text from client. echo( %line ); } @endtsexample) +/// @brief Start listening on the specified port for connections. +/// +/// This method starts a listener which looks for incoming TCP connections to a port. +/// You must overload the onConnectionRequest callback to create a new TCPObject to +/// read, write, or reject the new connection. +/// +/// @param port Port for this TCPObject to start listening for connections on. +/// +/// @tsexample +/// +/// // Create a listener on port 8080. +/// new TCPObject( TCPListener ); +/// TCPListener.listen( 8080 ); +/// +/// function TCPListener::onConnectionRequest( %this, %address, %id ) +/// { +/// // Create a new object to manage the connection. +/// new TCPObject( TCPClient, %id ); +/// } +/// +/// function TCPClient::onLine( %this, %line ) +/// { +/// // Print the line of text from client. +/// echo( %line ); +/// } +/// +/// @endtsexample) +/// /// -public void fnTCPObject_listen (string tcpobject, int port) +public void fnTCPObject_listen (string tcpobject, uint port) { if(Debugging) System.Console.WriteLine("----------------->Extern Call 'fnTCPObject_listen'" + string.Format("\"{0}\" \"{1}\" ",tcpobject,port)); @@ -33408,7 +42826,23 @@ public void fnTCPObject_listen (string tcpobject, int port) SafeNativeMethods.mwle_fnTCPObject_listen(sbtcpobject, port); } /// -/// @brief Transmits the data string to the connected computer. This method is used to send text data to the connected computer regardless if we initiated the connection using connect(), or listening to a port using listen(). @param data The data string to send. @tsexample // Set the command data %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" // Send the command to the connected server. %thisTCPObj.send(%data); @endtsexample) +/// @brief Transmits the data string to the connected computer. +/// +/// This method is used to send text data to the connected computer regardless if we initiated the +/// connection using connect(), or listening to a port using listen(). +/// +/// @param data The data string to send. +/// +/// @tsexample +/// // Set the command data +/// %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; +/// %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; +/// %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" +/// +/// // Send the command to the connected server. +/// %thisTCPObj.send(%data); +/// @endtsexample) +/// /// public void fnTCPObject_send (string tcpobject, string data) @@ -33425,7 +42859,12 @@ public void fnTCPObject_send (string tcpobject, string data) SafeNativeMethods.mwle_fnTCPObject_send(sbtcpobject, sbdata); } /// -/// @brief Saves the terrain block's terrain file to the specified file name. @param fileName Name and path of file to save terrain data to. @return True if file save was successful, false otherwise) +/// @brief Saves the terrain block's terrain file to the specified file name. +/// +/// @param fileName Name and path of file to save terrain data to. +/// +/// @return True if file save was successful, false otherwise) +/// /// public bool fnTerrainBlock_save (string terrainblock, string fileName) @@ -33443,6 +42882,7 @@ public bool fnTerrainBlock_save (string terrainblock, string fileName) } /// /// ) +/// /// public void fnTimeOfDay_addTimeOfDayEvent (string timeofday, float elevation, string identifier) @@ -33460,6 +42900,7 @@ public void fnTimeOfDay_addTimeOfDayEvent (string timeofday, float elevation, st } /// /// ) +/// /// public void fnTimeOfDay_animate (string timeofday, float elevation, float degreesPerSecond) @@ -33474,6 +42915,7 @@ public void fnTimeOfDay_animate (string timeofday, float elevation, float degree } /// /// ) +/// /// public void fnTimeOfDay_setDayLength (string timeofday, float seconds) @@ -33488,6 +42930,7 @@ public void fnTimeOfDay_setDayLength (string timeofday, float seconds) } /// /// ) +/// /// public void fnTimeOfDay_setPlay (string timeofday, bool enabled) @@ -33502,6 +42945,7 @@ public void fnTimeOfDay_setPlay (string timeofday, bool enabled) } /// /// ) +/// /// public void fnTimeOfDay_setTimeOfDay (string timeofday, float time) @@ -33515,7 +42959,9 @@ public void fnTimeOfDay_setTimeOfDay (string timeofday, float time) SafeNativeMethods.mwle_fnTimeOfDay_setTimeOfDay(sbtimeofday, time); } /// -/// @brief Get the number of objects that are within the Trigger's bounds. @see getObject()) +/// @brief Get the number of objects that are within the Trigger's bounds. +/// @see getObject()) +/// /// public int fnTrigger_getNumObjects (string trigger) @@ -33529,7 +42975,11 @@ public int fnTrigger_getNumObjects (string trigger) return SafeNativeMethods.mwle_fnTrigger_getNumObjects(sbtrigger); } /// -/// @brief Retrieve the requested object that is within the Trigger's bounds. @param index Index of the object to get (range is 0 to getNumObjects()-1) @returns The SimObjectID of the object, or -1 if the requested index is invalid. @see getNumObjects()) +/// @brief Retrieve the requested object that is within the Trigger's bounds. +/// @param index Index of the object to get (range is 0 to getNumObjects()-1) +/// @returns The SimObjectID of the object, or -1 if the requested index is invalid. +/// @see getNumObjects()) +/// /// public int fnTrigger_getObject (string trigger, int index) @@ -33543,7 +42993,11 @@ public int fnTrigger_getObject (string trigger, int index) return SafeNativeMethods.mwle_fnTrigger_getObject(sbtrigger, index); } /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool fnTSAttachable_attachObject (string tsattachable, string obj) @@ -33560,7 +43014,14 @@ public bool fnTSAttachable_attachObject (string tsattachable, string obj) return SafeNativeMethods.mwle_fnTSAttachable_attachObject(sbtsattachable, sbobj)>=1; } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void fnTSAttachable_detachAll (string tsattachable) @@ -33574,7 +43035,11 @@ public void fnTSAttachable_detachAll (string tsattachable) SafeNativeMethods.mwle_fnTSAttachable_detachAll(sbtsattachable); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool fnTSAttachable_detachObject (string tsattachable, string obj) @@ -33592,6 +43057,7 @@ public bool fnTSAttachable_detachObject (string tsattachable, string obj) } /// /// Returns the attachment at the passed index value.) +/// /// public string fnTSAttachable_getAttachment (string tsattachable, int index) @@ -33609,6 +43075,7 @@ public string fnTSAttachable_getAttachment (string tsattachable, int index) } /// /// Returns the number of objects that are currently attached.) +/// /// public int fnTSAttachable_getNumAttachments (string tsattachable) @@ -33622,7 +43089,25 @@ public int fnTSAttachable_getNumAttachments (string tsattachable) return SafeNativeMethods.mwle_fnTSAttachable_getNumAttachments(sbtsattachable); } /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void fnTSDynamic_changeMaterial (string tsdynamic, string mapTo, string oldMat, string newMat) @@ -33645,7 +43130,15 @@ public void fnTSDynamic_changeMaterial (string tsdynamic, string mapTo, string o SafeNativeMethods.mwle_fnTSDynamic_changeMaterial(sbtsdynamic, sbmapTo, sboldMat, sbnewMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string fnTSDynamic_getModelFile (string tsdynamic) @@ -33662,7 +43155,10 @@ public string fnTSDynamic_getModelFile (string tsdynamic) } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int fnTSDynamic_getTargetCount (string tsdynamic) @@ -33676,7 +43172,11 @@ public int fnTSDynamic_getTargetCount (string tsdynamic) return SafeNativeMethods.mwle_fnTSDynamic_getTargetCount(sbtsdynamic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string fnTSDynamic_getTargetName (string tsdynamic, int index) @@ -33694,6 +43194,7 @@ public string fnTSDynamic_getTargetName (string tsdynamic, int index) } /// /// Returns the looping state for the shape.) +/// /// public bool fnTSPathShape_getLooping (string tspathshape) @@ -33708,6 +43209,7 @@ public bool fnTSPathShape_getLooping (string tspathshape) } /// /// Returns the number of nodes on the shape's path.) +/// /// public int fnTSPathShape_getNodeCount (string tspathshape) @@ -33722,6 +43224,7 @@ public int fnTSPathShape_getNodeCount (string tspathshape) } /// /// Get the current position of the shape along the path (0.0 - lastNode - 1).) +/// /// public float fnTSPathShape_getPathPosition (string tspathshape) @@ -33735,7 +43238,12 @@ public float fnTSPathShape_getPathPosition (string tspathshape) return SafeNativeMethods.mwle_fnTSPathShape_getPathPosition(sbtspathshape); } /// -/// Removes the knot at the front of the shape's path. @tsexample // Remove the first knot in the shape's path. %pathShape.popFront(); @endtsexample) +/// Removes the knot at the front of the shape's path. +/// @tsexample +/// // Remove the first knot in the shape's path. +/// %pathShape.popFront(); +/// @endtsexample) +/// /// public void fnTSPathShape_popFront (string tspathshape) @@ -33749,7 +43257,25 @@ public void fnTSPathShape_popFront (string tspathshape) SafeNativeMethods.mwle_fnTSPathShape_popFront(sbtspathshape); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the back of its path %pathShape.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the back of its path +/// %pathShape.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void fnTSPathShape_pushBack (string tspathshape, string transform, float speed, string type, string path) @@ -33772,7 +43298,25 @@ public void fnTSPathShape_pushBack (string tspathshape, string transform, float SafeNativeMethods.mwle_fnTSPathShape_pushBack(sbtspathshape, sbtransform, speed, sbtype, sbpath); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the front of its path %pathShape.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the front of its path +/// %pathShape.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void fnTSPathShape_pushFront (string tspathshape, string transform, float speed, string type, string path) @@ -33795,7 +43339,13 @@ public void fnTSPathShape_pushFront (string tspathshape, string transform, float SafeNativeMethods.mwle_fnTSPathShape_pushFront(sbtspathshape, sbtransform, speed, sbtype, sbpath); } /// -/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. When makeFirstKnot is true a new knot is created and pushed onto the path. @param speed Speed for the first knot if created. @param makeFirstKnot Initialize a new path with the current shape transform. @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. +/// The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. +/// When makeFirstKnot is true a new knot is created and pushed onto the path. +/// @param speed Speed for the first knot if created. +/// @param makeFirstKnot Initialize a new path with the current shape transform. +/// @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// /// public void fnTSPathShape_reset (string tspathshape, float speed, bool makeFirstKnot, bool initFromPath) @@ -33809,7 +43359,9 @@ public void fnTSPathShape_reset (string tspathshape, float speed, bool makeFirst SafeNativeMethods.mwle_fnTSPathShape_reset(sbtspathshape, speed, makeFirstKnot, initFromPath); } /// -/// Sets whether the path should loop or stop at the last node. @param isLooping New loop flag true/false.) +/// Sets whether the path should loop or stop at the last node. +/// @param isLooping New loop flag true/false.) +/// /// public void fnTSPathShape_setLooping (string tspathshape, bool isLooping) @@ -33823,7 +43375,9 @@ public void fnTSPathShape_setLooping (string tspathshape, bool isLooping) SafeNativeMethods.mwle_fnTSPathShape_setLooping(sbtspathshape, isLooping); } /// -/// Set the movement state for this shape. @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// Set the movement state for this shape. +/// @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// /// public void fnTSPathShape_setMoveState (string tspathshape, int newState) @@ -33837,7 +43391,9 @@ public void fnTSPathShape_setMoveState (string tspathshape, int newState) SafeNativeMethods.mwle_fnTSPathShape_setMoveState(sbtspathshape, newState); } /// -/// Set the current position of the shape along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// Set the current position of the shape along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// /// public void fnTSPathShape_setPathPosition (string tspathshape, float position) @@ -33851,7 +43407,13 @@ public void fnTSPathShape_setPathPosition (string tspathshape, float position) SafeNativeMethods.mwle_fnTSPathShape_setPathPosition(sbtspathshape, position); } /// -/// @brief Set the movement target for this shape along its path. The shape will attempt to move along the path to the given target without going past the loop node. Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target state will be cleared. @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the shape to move to along its path.) +/// @brief Set the movement target for this shape along its path. +/// The shape will attempt to move along the path to the given target without going past the loop node. +/// Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target +/// state will be cleared. +/// @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the +/// shape to move to along its path.) +/// /// public void fnTSPathShape_setTarget (string tspathshape, float position) @@ -33865,7 +43427,32 @@ public void fnTSPathShape_setTarget (string tspathshape, float position) SafeNativeMethods.mwle_fnTSPathShape_setTarget(sbtspathshape, position); } /// -/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls may optionally be converted to boxes, spheres and/or capsules based on their volume. @param size size for this detail level @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, 26-dop, convex hulls. See the Shape Editor documentation for more details about these types. @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the whole shape), or the name of an object in the shape @param depth maximum split recursion depth (hulls only) @param merge volume % threshold used to merge hulls together (hulls only) @param concavity volume % threshold used to detect concavity (hulls only) @param maxVerts maximum number of vertices per hull (hulls only) @param boxMaxError max % volume difference for a hull to be converted to a box (hulls only) @param sphereMaxError max % volume difference for a hull to be converted to a sphere (hulls only) @param capsuleMaxError max % volume difference for a hull to be converted to a capsule (hulls only) @return true if successful, false otherwise @tsexample %this.addCollisionDetail( -1, \"box\", \"bounds\" ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); @endtsexample ) +/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls +/// may optionally be converted to boxes, spheres and/or capsules based on their +/// volume. +/// @param size size for this detail level +/// @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, +/// 26-dop, convex hulls. See the Shape Editor documentation for more details +/// about these types. +/// @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the +/// whole shape), or the name of an object in the shape +/// @param depth maximum split recursion depth (hulls only) +/// @param merge volume % threshold used to merge hulls together (hulls only) +/// @param concavity volume % threshold used to detect concavity (hulls only) +/// @param maxVerts maximum number of vertices per hull (hulls only) +/// @param boxMaxError max % volume difference for a hull to be converted to a +/// box (hulls only) +/// @param sphereMaxError max % volume difference for a hull to be converted to +/// a sphere (hulls only) +/// @param capsuleMaxError max % volume difference for a hull to be converted to +/// a capsule (hulls only) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addCollisionDetail( -1, \"box\", \"bounds\" ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addCollisionDetail (string tsshapeconstructor, int size, string type, string target, int depth, float merge, float concavity, int maxVerts, float boxMaxError, float sphereMaxError, float capsuleMaxError) @@ -33885,7 +43472,35 @@ public bool fnTSShapeConstructor_addCollisionDetail (string tsshapeconstructor, return SafeNativeMethods.mwle_fnTSShapeConstructor_addCollisionDetail(sbtsshapeconstructor, size, sbtype, sbtarget, depth, merge, concavity, maxVerts, boxMaxError, sphereMaxError, capsuleMaxError)>=1; } /// -/// Add (or edit) an imposter detail level to the shape. If the shape already contains an imposter detail level, this command will simply change the imposter settings @param size size of the imposter detail level @param equatorSteps defines the number of snapshots to take around the equator. Imagine the object being rotated around the vertical axis, then a snapshot taken at regularly spaced intervals. @param polarSteps defines the number of snapshots taken between the poles (top and bottom), at each equator step. eg. At each equator snapshot, snapshots are taken at regular intervals between the poles. @param dl the detail level to use when generating the snapshots. Note that this is an array index rather than a detail size. So if an object has detail sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots using detail size 150. @param dim defines the size of the imposter images in pixels. The larger the number, the more detailed the billboard will be. @param includePoles flag indicating whether to include the \"pole\" snapshots. ie. the views from the top and bottom of the object. @param polar_angle if pole snapshots are active (@a includePoles is true), this parameter defines the camera angle (in degrees) within which to render the pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot taken at the pole (looking directly down or up at the object) will be rendered when the camera is within 25 degrees of the pole. @return true if successful, false otherwise @tsexample %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level @endtsexample ) +/// Add (or edit) an imposter detail level to the shape. +/// If the shape already contains an imposter detail level, this command will +/// simply change the imposter settings +/// @param size size of the imposter detail level +/// @param equatorSteps defines the number of snapshots to take around the +/// equator. Imagine the object being rotated around the vertical axis, then +/// a snapshot taken at regularly spaced intervals. +/// @param polarSteps defines the number of snapshots taken between the poles +/// (top and bottom), at each equator step. eg. At each equator snapshot, +/// snapshots are taken at regular intervals between the poles. +/// @param dl the detail level to use when generating the snapshots. Note that +/// this is an array index rather than a detail size. So if an object has detail +/// sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots +/// using detail size 150. +/// @param dim defines the size of the imposter images in pixels. The larger the +/// number, the more detailed the billboard will be. +/// @param includePoles flag indicating whether to include the \"pole\" snapshots. +/// ie. the views from the top and bottom of the object. +/// @param polar_angle if pole snapshots are active (@a includePoles is true), this +/// parameter defines the camera angle (in degrees) within which to render the +/// pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot +/// taken at the pole (looking directly down or up at the object) will be rendered +/// when the camera is within 25 degrees of the pole. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); +/// %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_addImposter (string tsshapeconstructor, int size, int equatorSteps, int polarSteps, int dl, int dim, bool includePoles, float polarAngle) @@ -33899,7 +43514,21 @@ public int fnTSShapeConstructor_addImposter (string tsshapeconstructor, int size return SafeNativeMethods.mwle_fnTSShapeConstructor_addImposter(sbtsshapeconstructor, size, equatorSteps, polarSteps, dl, dim, includePoles, polarAngle); } /// -/// Add geometry from another DTS or DAE shape file into this shape. Any materials required by the source mesh are also copied into this shape.br> @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param srcShape name of a shape file (DTS or DAE) that contains the mesh @param srcMesh the full name (object name + detail size) of the mesh to copy from the DTS/DAE file into this shape/li> @return true if successful, false otherwise @tsexample %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); @endtsexample ) +/// Add geometry from another DTS or DAE shape file into this shape. +/// Any materials required by the source mesh are also copied into this shape.br> +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param srcShape name of a shape file (DTS or DAE) that contains the mesh +/// @param srcMesh the full name (object name + detail size) of the mesh to +/// copy from the DTS/DAE file into this shape/li> +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); +/// %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addMesh (string tsshapeconstructor, string meshName, string srcShape, string srcMesh) @@ -33922,7 +43551,21 @@ public bool fnTSShapeConstructor_addMesh (string tsshapeconstructor, string mesh return SafeNativeMethods.mwle_fnTSShapeConstructor_addMesh(sbtsshapeconstructor, sbmeshName, sbsrcShape, sbsrcMesh)>=1; } /// -/// Add a new node. @param name name for the new node (must not already exist) @param parentName name of an existing node to be the parent of the new node. If empty (\"\"), the new node will be at the root level of the node hierarchy. @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); @endtsexample ) +/// Add a new node. +/// @param name name for the new node (must not already exist) +/// @param parentName name of an existing node to be the parent of the new node. +/// If empty (\"\"), the new node will be at the root level of the node hierarchy. +/// @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); +/// %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); +/// %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addNode (string tsshapeconstructor, string name, string parentName, string txfm, bool isWorld) @@ -33945,7 +43588,29 @@ public bool fnTSShapeConstructor_addNode (string tsshapeconstructor, string name return SafeNativeMethods.mwle_fnTSShapeConstructor_addNode(sbtsshapeconstructor, sbname, sbparentName, sbtxfm, isWorld)>=1; } /// -/// Add a new mesh primitive to the shape. @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param type one of: \"box\", \"sphere\", \"capsule\" @param params mesh primitive parameters: ul> li>for box: \"size_x size_y size_z\"/li> li>for sphere: \"radius\"/li> li>for capsule: \"height radius\"/li> /ul> /ul> @param txfm local transform offset from the node for this mesh @param nodeName name of the node to attach the new mesh to (will change the object's node if adding a new mesh to an existing object) @return true if successful, false otherwise @tsexample %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); @endtsexample ) +/// Add a new mesh primitive to the shape. +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param type one of: \"box\", \"sphere\", \"capsule\" +/// @param params mesh primitive parameters: +/// ul> +/// li>for box: \"size_x size_y size_z\"/li> +/// li>for sphere: \"radius\"/li> +/// li>for capsule: \"height radius\"/li> +/// /ul> +/// /ul> +/// @param txfm local transform offset from the node for this mesh +/// @param nodeName name of the node to attach the new mesh to (will change the +/// object's node if adding a new mesh to an existing object) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); +/// %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); +/// %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addPrimitive (string tsshapeconstructor, string meshName, string type, string paramsx, string txfm, string nodeName) @@ -33974,7 +43639,34 @@ public bool fnTSShapeConstructor_addPrimitive (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_addPrimitive(sbtsshapeconstructor, sbmeshName, sbtype, sbparamsx, sbtxfm, sbnodeName)>=1; } /// -/// Add a new sequence to the shape. @param source the name of an existing sequence, or the name of a DTS or DAE shape or DSQ sequence file. When the shape file contains more than one sequence, the desired sequence can be specified by appending the name to the end of the shape file. eg. \"myShape.dts run\" would select the \"run\" sequence from the \"myShape.dts\" file. @param name name of the new sequence @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose rotation to the target shape root pose. @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose position to the target shape root pose. @return true if successful, false otherwise @tsexample %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); %this.addSequence( \"./myPlayer.dae run\", \"run\" ); %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end @endtsexample ) +/// Add a new sequence to the shape. +/// @param source the name of an existing sequence, or the name of a DTS or DAE +/// shape or DSQ sequence file. When the shape file contains more than one +/// sequence, the desired sequence can be specified by appending the name to the +/// end of the shape file. eg. \"myShape.dts run\" would select the \"run\" +/// sequence from the \"myShape.dts\" file. +/// @param name name of the new sequence +/// @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. +/// @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. +/// @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose rotation to the target shape root pose. +/// @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose position to the target shape root pose. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); +/// %this.addSequence( \"./myPlayer.dae run\", \"run\" ); +/// %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end +/// %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 +/// %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addSequence (string tsshapeconstructor, string source, string name, int start, int end, bool padRot, bool padTrans) @@ -33994,7 +43686,16 @@ public bool fnTSShapeConstructor_addSequence (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_addSequence(sbtsshapeconstructor, sbsource, sbname, start, end, padRot, padTrans)>=1; } /// -/// Add a new trigger to the sequence. @param name name of the sequence to modify @param keyframe keyframe of the new trigger @param state of the new trigger @return true if successful, false otherwise @tsexample %this.addTrigger( \"walk\", 3, 1 ); %this.addTrigger( \"walk\", 5, -1 ); @endtsexample ) +/// Add a new trigger to the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the new trigger +/// @param state of the new trigger +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addTrigger( \"walk\", 3, 1 ); +/// %this.addTrigger( \"walk\", 5, -1 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addTrigger (string tsshapeconstructor, string name, int keyframe, int state) @@ -34011,7 +43712,14 @@ public bool fnTSShapeConstructor_addTrigger (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_addTrigger(sbtsshapeconstructor, sbname, keyframe, state)>=1; } /// -/// Dump the shape hierarchy to the console or to a file. Useful for reviewing the result of a series of construction commands. @param filename Destination filename. If not specified, dump to console. @tsexample %this.dumpShape(); // dump to console %this.dumpShape( \"./dump.txt\" ); // dump to file @endtsexample ) +/// Dump the shape hierarchy to the console or to a file. Useful for reviewing +/// the result of a series of construction commands. +/// @param filename Destination filename. If not specified, dump to console. +/// @tsexample +/// %this.dumpShape(); // dump to console +/// %this.dumpShape( \"./dump.txt\" ); // dump to file +/// @endtsexample ) +/// /// public void fnTSShapeConstructor_dumpShape (string tsshapeconstructor, string filename) @@ -34028,7 +43736,9 @@ public void fnTSShapeConstructor_dumpShape (string tsshapeconstructor, string fi SafeNativeMethods.mwle_fnTSShapeConstructor_dumpShape(sbtsshapeconstructor, sbfilename); } /// -/// Get the bounding box for the shape. @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// Get the bounding box for the shape. +/// @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// /// public string fnTSShapeConstructor_getBounds (string tsshapeconstructor) @@ -34045,7 +43755,9 @@ public string fnTSShapeConstructor_getBounds (string tsshapeconstructor) } /// -/// Get the total number of detail levels in the shape. @return the number of detail levels in the shape ) +/// Get the total number of detail levels in the shape. +/// @return the number of detail levels in the shape ) +/// /// public int fnTSShapeConstructor_getDetailLevelCount (string tsshapeconstructor) @@ -34059,7 +43771,15 @@ public int fnTSShapeConstructor_getDetailLevelCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getDetailLevelCount(sbtsshapeconstructor); } /// -/// Get the index of the detail level with a given size. @param size size of the detail level to lookup @return index of the detail level with the desired size, or -1 if no such detail exists @tsexample if ( %this.getDetailLevelSize( 32 ) == -1 ) echo( \"Error: This shape does not have a detail level at size 32\" ); @endtsexample ) +/// Get the index of the detail level with a given size. +/// @param size size of the detail level to lookup +/// @return index of the detail level with the desired size, or -1 if no such +/// detail exists +/// @tsexample +/// if ( %this.getDetailLevelSize( 32 ) == -1 ) +/// echo( \"Error: This shape does not have a detail level at size 32\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getDetailLevelIndex (string tsshapeconstructor, int size) @@ -34073,7 +43793,16 @@ public int fnTSShapeConstructor_getDetailLevelIndex (string tsshapeconstructor, return SafeNativeMethods.mwle_fnTSShapeConstructor_getDetailLevelIndex(sbtsshapeconstructor, size); } /// -/// Get the name of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level name @tsexample // print the names of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getDetailLevelName( %i ) ); @endtsexample ) +/// Get the name of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level name +/// @tsexample +/// // print the names of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getDetailLevelName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getDetailLevelName (string tsshapeconstructor, int index) @@ -34090,7 +43819,16 @@ public string fnTSShapeConstructor_getDetailLevelName (string tsshapeconstructor } /// -/// Get the size of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level size @tsexample // print the sizes of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); @endtsexample ) +/// Get the size of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level size +/// @tsexample +/// // print the sizes of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getDetailLevelSize (string tsshapeconstructor, int index) @@ -34104,7 +43842,10 @@ public int fnTSShapeConstructor_getDetailLevelSize (string tsshapeconstructor, i return SafeNativeMethods.mwle_fnTSShapeConstructor_getDetailLevelSize(sbtsshapeconstructor, index); } /// -/// Get the index of the imposter (auto-billboard) detail level (if any). @return imposter detail level index, or -1 if the shape does not use imposters. ) +/// Get the index of the imposter (auto-billboard) detail level (if any). +/// @return imposter detail level index, or -1 if the shape does not use +/// imposters. ) +/// /// public int fnTSShapeConstructor_getImposterDetailLevel (string tsshapeconstructor) @@ -34118,7 +43859,26 @@ public int fnTSShapeConstructor_getImposterDetailLevel (string tsshapeconstructo return SafeNativeMethods.mwle_fnTSShapeConstructor_getImposterDetailLevel(sbtsshapeconstructor); } /// -/// Get the settings used to generate imposters for the indexed detail level. @param index index of the detail level to query (does not need to be an imposter detail level @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: dl> dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> dt>eqSteps/dt>dd>number of steps around the equator/dd> dt>pSteps/dt>dd>number of steps between the poles/dd> dt>dl/dt>dd>index of the detail level used to generate imposters/dd> dt>dim/dt>dd>size (in pixels) of each imposter image/dd> dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> dt>angle/dt>dd>angle at which to display pole images/dd> /dl> @tsexample // print the imposter detail level settings %index = %this.getImposterDetailLevel(); if ( %index != -1 ) echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); @endtsexample ) +/// Get the settings used to generate imposters for the indexed detail level. +/// @param index index of the detail level to query (does not need to be an +/// imposter detail level +/// @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: +/// dl> +/// dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> +/// dt>eqSteps/dt>dd>number of steps around the equator/dd> +/// dt>pSteps/dt>dd>number of steps between the poles/dd> +/// dt>dl/dt>dd>index of the detail level used to generate imposters/dd> +/// dt>dim/dt>dd>size (in pixels) of each imposter image/dd> +/// dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> +/// dt>angle/dt>dd>angle at which to display pole images/dd> +/// /dl> +/// @tsexample +/// // print the imposter detail level settings +/// %index = %this.getImposterDetailLevel(); +/// if ( %index != -1 ) +/// echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getImposterSettings (string tsshapeconstructor, int index) @@ -34135,7 +43895,13 @@ public string fnTSShapeConstructor_getImposterSettings (string tsshapeconstructo } /// -/// Get the number of meshes (detail levels) for the specified object. @param name name of the object to query @return the number of meshes for this object. @tsexample %count = %this.getMeshCount( \"SimpleShape\" ); @endtsexample ) +/// Get the number of meshes (detail levels) for the specified object. +/// @param name name of the object to query +/// @return the number of meshes for this object. +/// @tsexample +/// %count = %this.getMeshCount( \"SimpleShape\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getMeshCount (string tsshapeconstructor, string name) @@ -34152,7 +43918,14 @@ public int fnTSShapeConstructor_getMeshCount (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_getMeshCount(sbtsshapeconstructor, sbname); } /// -/// Get the name of the material attached to a mesh. Note that only the first material used by the mesh is returned. @param name full name (object name + detail size) of the mesh to query @return name of the material attached to the mesh (suitable for use with the Material mapTo field) @tsexample echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the name of the material attached to a mesh. Note that only the first +/// material used by the mesh is returned. +/// @param name full name (object name + detail size) of the mesh to query +/// @return name of the material attached to the mesh (suitable for use with the Material mapTo field) +/// @tsexample +/// echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getMeshMaterial (string tsshapeconstructor, string name) @@ -34172,7 +43945,22 @@ public string fnTSShapeConstructor_getMeshMaterial (string tsshapeconstructor, s } /// -/// Get the name of the indexed mesh (detail level) for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh name. @tsexample // print the names of all meshes in the shape %objCount = %this.getObjectCount(); for ( %i = 0; %i %objCount; %i++ ) { %objName = %this.getObjectName( %i ); %meshCount = %this.getMeshCount( %objName ); for ( %j = 0; %j %meshCount; %j++ ) echo( %this.getMeshName( %objName, %j ) ); } @endtsexample ) +/// Get the name of the indexed mesh (detail level) for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh name. +/// @tsexample +/// // print the names of all meshes in the shape +/// %objCount = %this.getObjectCount(); +/// for ( %i = 0; %i %objCount; %i++ ) +/// { +/// %objName = %this.getObjectName( %i ); +/// %meshCount = %this.getMeshCount( %objName ); +/// for ( %j = 0; %j %meshCount; %j++ ) +/// echo( %this.getMeshName( %objName, %j ) ); +/// } +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getMeshName (string tsshapeconstructor, string name, int index) @@ -34192,7 +43980,18 @@ public string fnTSShapeConstructor_getMeshName (string tsshapeconstructor, strin } /// -/// Get the detail level size of the indexed mesh for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh detail level size. @tsexample // print sizes for all detail levels of this object %objName = \"trunk\"; %count = %this.getMeshCount( %objName ); for ( %i = 0; %i %count; %i++ ) echo( %this.getMeshSize( %objName, %i ) ); @endtsexample ) +/// Get the detail level size of the indexed mesh for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh detail level size. +/// @tsexample +/// // print sizes for all detail levels of this object +/// %objName = \"trunk\"; +/// %count = %this.getMeshCount( %objName ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getMeshSize( %objName, %i ) ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getMeshSize (string tsshapeconstructor, string name, int index) @@ -34209,7 +44008,16 @@ public int fnTSShapeConstructor_getMeshSize (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_getMeshSize(sbtsshapeconstructor, sbname, index); } /// -/// Get the display type of the mesh. @param name name of the mesh to query @return the string returned is one of: dl>dt>normal/dt>dd>a normal 3D mesh/dd> dt>billboard/dt>dd>a mesh that always faces the camera/dd> dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> @tsexample echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the display type of the mesh. +/// @param name name of the mesh to query +/// @return the string returned is one of: +/// dl>dt>normal/dt>dd>a normal 3D mesh/dd> +/// dt>billboard/dt>dd>a mesh that always faces the camera/dd> +/// dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> +/// @tsexample +/// echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getMeshType (string tsshapeconstructor, string name) @@ -34229,7 +44037,13 @@ public string fnTSShapeConstructor_getMeshType (string tsshapeconstructor, strin } /// -/// Get the number of children of this node. @param name name of the node to query. @return the number of child nodes. @tsexample %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the number of children of this node. +/// @param name name of the node to query. +/// @return the number of child nodes. +/// @tsexample +/// %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeChildCount (string tsshapeconstructor, string name) @@ -34246,7 +44060,32 @@ public int fnTSShapeConstructor_getNodeChildCount (string tsshapeconstructor, st return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeChildCount(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed child node. @param name name of the parent node to query. @param index index of the child node (valid range is 0 - getNodeChildName()-1). @return the name of the indexed child node. @tsexample function dumpNode( %shape, %name, %indent ) { echo( %indent @ %name ); %count = %shape.getNodeChildCount( %name ); for ( %i = 0; %i %count; %i++ ) dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); } function dumpShape( %shape ) { // recursively dump node hierarchy %count = %shape.getNodeCount(); for ( %i = 0; %i %count; %i++ ) { // dump top level nodes %name = %shape.getNodeName( %i ); if ( %shape.getNodeParentName( %name ) $= ) dumpNode( %shape, %name, \"\" ); } } @endtsexample ) +/// Get the name of the indexed child node. +/// @param name name of the parent node to query. +/// @param index index of the child node (valid range is 0 - getNodeChildName()-1). +/// @return the name of the indexed child node. +/// @tsexample +/// function dumpNode( %shape, %name, %indent ) +/// { +/// echo( %indent @ %name ); +/// %count = %shape.getNodeChildCount( %name ); +/// for ( %i = 0; %i %count; %i++ ) +/// dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); +/// } +/// function dumpShape( %shape ) +/// { +/// // recursively dump node hierarchy +/// %count = %shape.getNodeCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// { +/// // dump top level nodes +/// %name = %shape.getNodeName( %i ); +/// if ( %shape.getNodeParentName( %name ) $= ) +/// dumpNode( %shape, %name, \"\" ); +/// } +/// } +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeChildName (string tsshapeconstructor, string name, int index) @@ -34266,7 +44105,12 @@ public string fnTSShapeConstructor_getNodeChildName (string tsshapeconstructor, } /// -/// Get the total number of nodes in the shape. @return the number of nodes in the shape. @tsexample %count = %this.getNodeCount(); @endtsexample ) +/// Get the total number of nodes in the shape. +/// @return the number of nodes in the shape. +/// @tsexample +/// %count = %this.getNodeCount(); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeCount (string tsshapeconstructor) @@ -34280,7 +44124,14 @@ public int fnTSShapeConstructor_getNodeCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeCount(sbtsshapeconstructor); } /// -/// Get the index of the node. @param name name of the node to lookup. @return the index of the named node, or -1 if no such node exists. @tsexample // get the index of Bip01 Pelvis node in the shape %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the index of the node. +/// @param name name of the node to lookup. +/// @return the index of the named node, or -1 if no such node exists. +/// @tsexample +/// // get the index of Bip01 Pelvis node in the shape +/// %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeIndex (string tsshapeconstructor, string name) @@ -34297,7 +44148,16 @@ public int fnTSShapeConstructor_getNodeIndex (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeIndex(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed node. @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). @return the name of the indexed node, or \"\" if no such node exists. @tsexample // print the names of all the nodes in the shape %count = %this.getNodeCount(); for (%i = 0; %i %count; %i++) echo(%i SPC %this.getNodeName(%i)); @endtsexample ) +/// Get the name of the indexed node. +/// @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). +/// @return the name of the indexed node, or \"\" if no such node exists. +/// @tsexample +/// // print the names of all the nodes in the shape +/// %count = %this.getNodeCount(); +/// for (%i = 0; %i %count; %i++) +/// echo(%i SPC %this.getNodeName(%i)); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeName (string tsshapeconstructor, int index) @@ -34314,7 +44174,13 @@ public string fnTSShapeConstructor_getNodeName (string tsshapeconstructor, int i } /// -/// Get the number of geometry objects attached to this node. @param name name of the node to query. @return the number of attached objects. @tsexample %count = %this.getNodeObjectCount( \"Bip01 Head\" ); @endtsexample ) +/// Get the number of geometry objects attached to this node. +/// @param name name of the node to query. +/// @return the number of attached objects. +/// @tsexample +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeObjectCount (string tsshapeconstructor, string name) @@ -34331,7 +44197,17 @@ public int fnTSShapeConstructor_getNodeObjectCount (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeObjectCount(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed object. @param name name of the node to query. @param index index of the object (valid range is 0 - getNodeObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects attached to the node %count = %this.getNodeObjectCount( \"Bip01 Head\" ); for ( %i = 0; %i %count; %i++ ) echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param name name of the node to query. +/// @param index index of the object (valid range is 0 - getNodeObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects attached to the node +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeObjectName (string tsshapeconstructor, string name, int index) @@ -34351,7 +44227,14 @@ public string fnTSShapeConstructor_getNodeObjectName (string tsshapeconstructor, } /// -/// Get the name of the node's parent. If the node has no parent (ie. it is at the root level), return an empty string. @param name name of the node to query. @return the name of the node's parent, or \"\" if the node is at the root level @tsexample echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); @endtsexample ) +/// Get the name of the node's parent. If the node has no parent (ie. it is at +/// the root level), return an empty string. +/// @param name name of the node to query. +/// @return the name of the node's parent, or \"\" if the node is at the root level +/// @tsexample +/// echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeParentName (string tsshapeconstructor, string name) @@ -34371,7 +44254,16 @@ public string fnTSShapeConstructor_getNodeParentName (string tsshapeconstructor, } /// -/// Get the base (ie. not animated) transform of a node. @param name name of the node to query. @param isWorld true to get the global transform, false (or omitted) to get the local-to-parent transform. @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". @tsexample %ret = %this.getNodeTransform( \"mount0\" ); %this.setNodeTransform( \"mount4\", %ret ); @endtsexample ) +/// Get the base (ie. not animated) transform of a node. +/// @param name name of the node to query. +/// @param isWorld true to get the global transform, false (or omitted) to get +/// the local-to-parent transform. +/// @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". +/// @tsexample +/// %ret = %this.getNodeTransform( \"mount0\" ); +/// %this.setNodeTransform( \"mount4\", %ret ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeTransform (string tsshapeconstructor, string name, bool isWorld) @@ -34391,7 +44283,12 @@ public string fnTSShapeConstructor_getNodeTransform (string tsshapeconstructor, } /// -/// Get the total number of objects in the shape. @return the number of objects in the shape. @tsexample %count = %this.getObjectCount(); @endtsexample ) +/// Get the total number of objects in the shape. +/// @return the number of objects in the shape. +/// @tsexample +/// %count = %this.getObjectCount(); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getObjectCount (string tsshapeconstructor) @@ -34405,7 +44302,13 @@ public int fnTSShapeConstructor_getObjectCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getObjectCount(sbtsshapeconstructor); } /// -/// Get the index of the first object with the given name. @param name name of the object to get. @return the index of the named object. @tsexample %index = %this.getObjectIndex( \"Head\" ); @endtsexample ) +/// Get the index of the first object with the given name. +/// @param name name of the object to get. +/// @return the index of the named object. +/// @tsexample +/// %index = %this.getObjectIndex( \"Head\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getObjectIndex (string tsshapeconstructor, string name) @@ -34422,7 +44325,16 @@ public int fnTSShapeConstructor_getObjectIndex (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_getObjectIndex(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed object. @param index index of the object to get (valid range is 0 - getObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects in the shape %count = %this.getObjectCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getObjectName( %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param index index of the object to get (valid range is 0 - getObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getObjectName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getObjectName (string tsshapeconstructor, int index) @@ -34439,7 +44351,14 @@ public string fnTSShapeConstructor_getObjectName (string tsshapeconstructor, int } /// -/// Get the name of the node this object is attached to. @param name name of the object to get. @return the name of the attached node, or an empty string if this object is not attached to a node (usually the case for skinned meshes). @tsexample echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); @endtsexample ) +/// Get the name of the node this object is attached to. +/// @param name name of the object to get. +/// @return the name of the attached node, or an empty string if this +/// object is not attached to a node (usually the case for skinned meshes). +/// @tsexample +/// echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getObjectNode (string tsshapeconstructor, string name) @@ -34459,7 +44378,24 @@ public string fnTSShapeConstructor_getObjectNode (string tsshapeconstructor, str } /// -/// Get information about blended sequences. @param name name of the sequence to query @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: dl> dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference frame (empty for blend sequences embedded in DTS files)/dd> dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences embedded in DTS files)/dd> /dl> @note Note that only sequences set to be blends using the setSequenceBlend command will contain the blendSeq and blendFrame information. @tsexample %blendData = %this.getSequenceBlend( \"look\" ); if ( getField( %blendData, 0 ) ) echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); @endtsexample ) +/// Get information about blended sequences. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: +/// dl> +/// dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> +/// dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference +/// frame (empty for blend sequences embedded in DTS files)/dd> +/// dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences +/// embedded in DTS files)/dd> +/// /dl> +/// @note Note that only sequences set to be blends using the setSequenceBlend +/// command will contain the blendSeq and blendFrame information. +/// @tsexample +/// %blendData = %this.getSequenceBlend( \"look\" ); +/// if ( getField( %blendData, 0 ) ) +/// echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceBlend (string tsshapeconstructor, string name) @@ -34479,7 +44415,9 @@ public string fnTSShapeConstructor_getSequenceBlend (string tsshapeconstructor, } /// -/// Get the total number of sequences in the shape. @return the number of sequences in the shape ) +/// Get the total number of sequences in the shape. +/// @return the number of sequences in the shape ) +/// /// public int fnTSShapeConstructor_getSequenceCount (string tsshapeconstructor) @@ -34493,7 +44431,14 @@ public int fnTSShapeConstructor_getSequenceCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceCount(sbtsshapeconstructor); } /// -/// Check if this sequence is cyclic (looping). @param name name of the sequence to query @return true if this sequence is cyclic, false if not @tsexample if ( !%this.getSequenceCyclic( \"ambient\" ) ) error( \"ambient sequence is not cyclic!\" ); @endtsexample ) +/// Check if this sequence is cyclic (looping). +/// @param name name of the sequence to query +/// @return true if this sequence is cyclic, false if not +/// @tsexample +/// if ( !%this.getSequenceCyclic( \"ambient\" ) ) +/// error( \"ambient sequence is not cyclic!\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_getSequenceCyclic (string tsshapeconstructor, string name) @@ -34510,7 +44455,13 @@ public bool fnTSShapeConstructor_getSequenceCyclic (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceCyclic(sbtsshapeconstructor, sbname)>=1; } /// -/// Get the number of keyframes in the sequence. @param name name of the sequence to query @return number of keyframes in the sequence @tsexample echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); @endtsexample ) +/// Get the number of keyframes in the sequence. +/// @param name name of the sequence to query +/// @return number of keyframes in the sequence +/// @tsexample +/// echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getSequenceFrameCount (string tsshapeconstructor, string name) @@ -34527,7 +44478,16 @@ public int fnTSShapeConstructor_getSequenceFrameCount (string tsshapeconstructor return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceFrameCount(sbtsshapeconstructor, sbname); } /// -/// Get the ground speed of the sequence. @note Note that only the first 2 ground frames of the sequence are examined; the speed is assumed to be constant throughout the sequence. @param name name of the sequence to query @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" @tsexample %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); echo( \"Run moves at \" @ %speed @ \" units per frame\" ); @endtsexample ) +/// Get the ground speed of the sequence. +/// @note Note that only the first 2 ground frames of the sequence are +/// examined; the speed is assumed to be constant throughout the sequence. +/// @param name name of the sequence to query +/// @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" +/// @tsexample +/// %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); +/// echo( \"Run moves at \" @ %speed @ \" units per frame\" ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceGroundSpeed (string tsshapeconstructor, string name) @@ -34547,7 +44507,15 @@ public string fnTSShapeConstructor_getSequenceGroundSpeed (string tsshapeconstru } /// -/// Find the index of the sequence with the given name. @param name name of the sequence to lookup @return index of the sequence with matching name, or -1 if not found @tsexample // Check if a given sequence exists in the shape if ( %this.getSequenceIndex( \"walk\" ) == -1 ) echo( \"Could not find 'walk' sequence\" ); @endtsexample ) +/// Find the index of the sequence with the given name. +/// @param name name of the sequence to lookup +/// @return index of the sequence with matching name, or -1 if not found +/// @tsexample +/// // Check if a given sequence exists in the shape +/// if ( %this.getSequenceIndex( \"walk\" ) == -1 ) +/// echo( \"Could not find 'walk' sequence\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getSequenceIndex (string tsshapeconstructor, string name) @@ -34564,7 +44532,16 @@ public int fnTSShapeConstructor_getSequenceIndex (string tsshapeconstructor, str return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceIndex(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed sequence. @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) @return the name of the sequence @tsexample // print the name of all sequences in the shape %count = %this.getSequenceCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getSequenceName( %i ) ); @endtsexample ) +/// Get the name of the indexed sequence. +/// @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) +/// @return the name of the sequence +/// @tsexample +/// // print the name of all sequences in the shape +/// %count = %this.getSequenceCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getSequenceName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceName (string tsshapeconstructor, int index) @@ -34581,7 +44558,10 @@ public string fnTSShapeConstructor_getSequenceName (string tsshapeconstructor, i } /// -/// Get the priority setting of the sequence. @param name name of the sequence to query @return priority value of the sequence ) +/// Get the priority setting of the sequence. +/// @param name name of the sequence to query +/// @return priority value of the sequence ) +/// /// public float fnTSShapeConstructor_getSequencePriority (string tsshapeconstructor, string name) @@ -34598,7 +44578,24 @@ public float fnTSShapeConstructor_getSequencePriority (string tsshapeconstructor return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequencePriority(sbtsshapeconstructor, sbname); } /// -/// Get information about where the sequence data came from. For example, whether it was loaded from an external DSQ file. @param name name of the sequence to query @return TAB delimited string of the form: \"from reserved start end total\", where: dl> dt>from/dt>dd>the source of the animation data, such as the path to a DSQ file, or the name of an existing sequence in the shape. This field will be empty for sequences already embedded in the DTS or DAE file./dd> dt>reserved/dt>dd>reserved value/dd> dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> dt>total/dt>dd>the total number of frames in the source sequence/dd> /dl> @tsexample // print the source for the walk animation echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); @endtsexample ) +/// Get information about where the sequence data came from. +/// For example, whether it was loaded from an external DSQ file. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"from reserved start end total\", where: +/// dl> +/// dt>from/dt>dd>the source of the animation data, such as the path to +/// a DSQ file, or the name of an existing sequence in the shape. This field +/// will be empty for sequences already embedded in the DTS or DAE file./dd> +/// dt>reserved/dt>dd>reserved value/dd> +/// dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> +/// dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> +/// dt>total/dt>dd>the total number of frames in the source sequence/dd> +/// /dl> +/// @tsexample +/// // print the source for the walk animation +/// echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceSource (string tsshapeconstructor, string name) @@ -34618,7 +44615,12 @@ public string fnTSShapeConstructor_getSequenceSource (string tsshapeconstructor, } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @tsexample %count = %this.getTargetCount(); @endtsexample ) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @tsexample +/// %count = %this.getTargetCount(); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getTargetCount (string tsshapeconstructor) @@ -34632,7 +44634,15 @@ public int fnTSShapeConstructor_getTargetCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getTargetCount(sbtsshapeconstructor); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @tsexample %count = %this.getTargetCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); @endtsexample ) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @tsexample +/// %count = %this.getTargetCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getTargetName (string tsshapeconstructor, int index) @@ -34649,7 +44659,17 @@ public string fnTSShapeConstructor_getTargetName (string tsshapeconstructor, int } /// -/// Get information about the indexed trigger @param name name of the sequence to query @param index index of the trigger (valid range is 0 - getTriggerCount()-1) @return string of the form \"frame state\" @tsexample // print all triggers in the sequence %count = %this.getTriggerCount( \"back\" ); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getTrigger( \"back\", %i ) ); @endtsexample ) +/// Get information about the indexed trigger +/// @param name name of the sequence to query +/// @param index index of the trigger (valid range is 0 - getTriggerCount()-1) +/// @return string of the form \"frame state\" +/// @tsexample +/// // print all triggers in the sequence +/// %count = %this.getTriggerCount( \"back\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getTrigger( \"back\", %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getTrigger (string tsshapeconstructor, string name, int index) @@ -34669,7 +44689,10 @@ public string fnTSShapeConstructor_getTrigger (string tsshapeconstructor, string } /// -/// Get the number of triggers in the specified sequence. @param name name of the sequence to query @return number of triggers in the sequence ) +/// Get the number of triggers in the specified sequence. +/// @param name name of the sequence to query +/// @return number of triggers in the sequence ) +/// /// public int fnTSShapeConstructor_getTriggerCount (string tsshapeconstructor, string name) @@ -34686,7 +44709,9 @@ public int fnTSShapeConstructor_getTriggerCount (string tsshapeconstructor, stri return SafeNativeMethods.mwle_fnTSShapeConstructor_getTriggerCount(sbtsshapeconstructor, sbname); } /// -/// Notify game objects that this shape file has changed, allowing them to update internal data if needed. ) +/// Notify game objects that this shape file has changed, allowing them to update +/// internal data if needed. ) +/// /// public void fnTSShapeConstructor_notifyShapeChanged (string tsshapeconstructor) @@ -34700,7 +44725,13 @@ public void fnTSShapeConstructor_notifyShapeChanged (string tsshapeconstructor) SafeNativeMethods.mwle_fnTSShapeConstructor_notifyShapeChanged(sbtsshapeconstructor); } /// -/// Remove the detail level (including all meshes in the detail level) @param size size of the detail level to remove @return true if successful, false otherwise @tsexample %this.removeDetailLevel( 2 ); @endtsexample ) +/// Remove the detail level (including all meshes in the detail level) +/// @param size size of the detail level to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeDetailLevel( 2 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeDetailLevel (string tsshapeconstructor, int index) @@ -34714,7 +44745,9 @@ public bool fnTSShapeConstructor_removeDetailLevel (string tsshapeconstructor, i return SafeNativeMethods.mwle_fnTSShapeConstructor_removeDetailLevel(sbtsshapeconstructor, index)>=1; } /// -/// () Remove the imposter detail level (if any) from the shape. @return true if successful, false otherwise ) +/// () Remove the imposter detail level (if any) from the shape. +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_removeImposter (string tsshapeconstructor) @@ -34728,7 +44761,14 @@ public bool fnTSShapeConstructor_removeImposter (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_removeImposter(sbtsshapeconstructor)>=1; } /// -/// Remove a mesh from the shape. If all geometry is removed from an object, the object is also removed. @param name full name (object name + detail size) of the mesh to remove @return true if successful, false otherwise @tsexample %this.removeMesh( \"SimpleShape128\" ); @endtsexample ) +/// Remove a mesh from the shape. +/// If all geometry is removed from an object, the object is also removed. +/// @param name full name (object name + detail size) of the mesh to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeMesh( \"SimpleShape128\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeMesh (string tsshapeconstructor, string name) @@ -34745,7 +44785,16 @@ public bool fnTSShapeConstructor_removeMesh (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_removeMesh(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove a node from the shape. The named node is removed from the shape, including from any sequences that use the node. Child nodes and objects attached to the node are re-assigned to the node's parent. @param name name of the node to remove. @return true if successful, false otherwise. @tsexample %this.removeNode( \"Nose\" ); @endtsexample ) +/// Remove a node from the shape. +/// The named node is removed from the shape, including from any sequences that +/// use the node. Child nodes and objects attached to the node are re-assigned +/// to the node's parent. +/// @param name name of the node to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.removeNode( \"Nose\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeNode (string tsshapeconstructor, string name) @@ -34762,7 +44811,16 @@ public bool fnTSShapeConstructor_removeNode (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_removeNode(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove an object (including all meshes for that object) from the shape. @param name name of the object to remove. @return true if successful, false otherwise. @tsexample // clear all objects in the shape %count = %this.getObjectCount(); for ( %i = %count-1; %i >= 0; %i-- ) %this.removeObject( %this.getObjectName(%i) ); @endtsexample ) +/// Remove an object (including all meshes for that object) from the shape. +/// @param name name of the object to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// // clear all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = %count-1; %i >= 0; %i-- ) +/// %this.removeObject( %this.getObjectName(%i) ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeObject (string tsshapeconstructor, string name) @@ -34779,7 +44837,10 @@ public bool fnTSShapeConstructor_removeObject (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_removeObject(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove the sequence from the shape. @param name name of the sequence to remove @return true if successful, false otherwise ) +/// Remove the sequence from the shape. +/// @param name name of the sequence to remove +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_removeSequence (string tsshapeconstructor, string name) @@ -34796,7 +44857,15 @@ public bool fnTSShapeConstructor_removeSequence (string tsshapeconstructor, stri return SafeNativeMethods.mwle_fnTSShapeConstructor_removeSequence(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove a trigger from the sequence. @param name name of the sequence to modify @param keyframe keyframe of the trigger to remove @param state of the trigger to remove @return true if successful, false otherwise @tsexample %this.removeTrigger( \"walk\", 3, 1 ); @endtsexample ) +/// Remove a trigger from the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the trigger to remove +/// @param state of the trigger to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeTrigger( \"walk\", 3, 1 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeTrigger (string tsshapeconstructor, string name, int keyframe, int state) @@ -34813,7 +44882,16 @@ public bool fnTSShapeConstructor_removeTrigger (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_removeTrigger(sbtsshapeconstructor, sbname, keyframe, state)>=1; } /// -/// Rename a detail level. @note Note that detail level names must be unique, so this command will fail if there is already a detail level with the desired name @param oldName current name of the detail level @param newName new name of the detail level @return true if successful, false otherwise @tsexample %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); @endtsexample ) +/// Rename a detail level. +/// @note Note that detail level names must be unique, so this command will +/// fail if there is already a detail level with the desired name +/// @param oldName current name of the detail level +/// @param newName new name of the detail level +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameDetailLevel (string tsshapeconstructor, string oldName, string newName) @@ -34833,7 +44911,16 @@ public bool fnTSShapeConstructor_renameDetailLevel (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_renameDetailLevel(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Rename a node. @note Note that node names must be unique, so this command will fail if there is already a node with the desired name @param oldName current name of the node @param newName new name of the node @return true if successful, false otherwise @tsexample %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); @endtsexample ) +/// Rename a node. +/// @note Note that node names must be unique, so this command will fail if +/// there is already a node with the desired name +/// @param oldName current name of the node +/// @param newName new name of the node +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameNode (string tsshapeconstructor, string oldName, string newName) @@ -34853,7 +44940,16 @@ public bool fnTSShapeConstructor_renameNode (string tsshapeconstructor, string o return SafeNativeMethods.mwle_fnTSShapeConstructor_renameNode(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Rename an object. @note Note that object names must be unique, so this command will fail if there is already an object with the desired name @param oldName current name of the object @param newName new name of the object @return true if successful, false otherwise @tsexample %this.renameObject( \"MyBox\", \"Box\" ); @endtsexample ) +/// Rename an object. +/// @note Note that object names must be unique, so this command will fail if +/// there is already an object with the desired name +/// @param oldName current name of the object +/// @param newName new name of the object +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameObject( \"MyBox\", \"Box\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameObject (string tsshapeconstructor, string oldName, string newName) @@ -34873,7 +44969,16 @@ public bool fnTSShapeConstructor_renameObject (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_renameObject(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Rename a sequence. @note Note that sequence names must be unique, so this command will fail if there is already a sequence with the desired name @param oldName current name of the sequence @param newName new name of the sequence @return true if successful, false otherwise @tsexample %this.renameSequence( \"walking\", \"walk\" ); @endtsexample ) +/// Rename a sequence. +/// @note Note that sequence names must be unique, so this command will fail +/// if there is already a sequence with the desired name +/// @param oldName current name of the sequence +/// @param newName new name of the sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameSequence( \"walking\", \"walk\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameSequence (string tsshapeconstructor, string oldName, string newName) @@ -34893,7 +44998,12 @@ public bool fnTSShapeConstructor_renameSequence (string tsshapeconstructor, stri return SafeNativeMethods.mwle_fnTSShapeConstructor_renameSequence(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Save the shape (with all current changes) to a new DTS file. @param filename Destination filename. @tsexample %this.saveShape( \"./myShape.dts\" ); @endtsexample ) +/// Save the shape (with all current changes) to a new DTS file. +/// @param filename Destination filename. +/// @tsexample +/// %this.saveShape( \"./myShape.dts\" ); +/// @endtsexample ) +/// /// public void fnTSShapeConstructor_saveShape (string tsshapeconstructor, string filename) @@ -34910,7 +45020,10 @@ public void fnTSShapeConstructor_saveShape (string tsshapeconstructor, string fi SafeNativeMethods.mwle_fnTSShapeConstructor_saveShape(sbtsshapeconstructor, sbfilename); } /// -/// Set the shape bounds to the given bounding box. @param Bounding box \"minX minY minZ maxX maxY maxZ\" @return true if successful, false otherwise ) +/// Set the shape bounds to the given bounding box. +/// @param Bounding box \"minX minY minZ maxX maxY maxZ\" +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_setBounds (string tsshapeconstructor, string bbox) @@ -34927,7 +45040,16 @@ public bool fnTSShapeConstructor_setBounds (string tsshapeconstructor, string bb return SafeNativeMethods.mwle_fnTSShapeConstructor_setBounds(sbtsshapeconstructor, sbbbox)>=1; } /// -/// Change the size of a detail level. @note Note that detail levels are always sorted in decreasing size order, so this command may cause detail level indices to change. @param index index of the detail level to modify @param newSize new size for the detail level @return new index for this detail level @tsexample %this.setDetailLevelSize( 2, 256 ); @endtsexample ) +/// Change the size of a detail level. +/// @note Note that detail levels are always sorted in decreasing size order, +/// so this command may cause detail level indices to change. +/// @param index index of the detail level to modify +/// @param newSize new size for the detail level +/// @return new index for this detail level +/// @tsexample +/// %this.setDetailLevelSize( 2, 256 ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_setDetailLevelSize (string tsshapeconstructor, int index, int newSize) @@ -34941,7 +45063,17 @@ public int fnTSShapeConstructor_setDetailLevelSize (string tsshapeconstructor, i return SafeNativeMethods.mwle_fnTSShapeConstructor_setDetailLevelSize(sbtsshapeconstructor, index, newSize); } /// -/// Set the name of the material attached to the mesh. @param meshName full name (object name + detail size) of the mesh to modify @param matName name of the material to attach. This could be the base name of the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a Material object already defined in script. @return true if successful, false otherwise @tsexample // set the mesh material %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); @endtsexample ) +/// Set the name of the material attached to the mesh. +/// @param meshName full name (object name + detail size) of the mesh to modify +/// @param matName name of the material to attach. This could be the base name of +/// the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a +/// Material object already defined in script. +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh material +/// %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setMeshMaterial (string tsshapeconstructor, string meshName, string matName) @@ -34961,7 +45093,14 @@ public bool fnTSShapeConstructor_setMeshMaterial (string tsshapeconstructor, str return SafeNativeMethods.mwle_fnTSShapeConstructor_setMeshMaterial(sbtsshapeconstructor, sbmeshName, sbmatName)>=1; } /// -/// Change the detail level size of the named mesh. @param name full name (object name + current size ) of the mesh to modify @param size new detail level size @return true if successful, false otherwise. @tsexample %this.setMeshSize( \"SimpleShape128\", 64 ); @endtsexample ) +/// Change the detail level size of the named mesh. +/// @param name full name (object name + current size ) of the mesh to modify +/// @param size new detail level size +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.setMeshSize( \"SimpleShape128\", 64 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setMeshSize (string tsshapeconstructor, string name, int size) @@ -34978,7 +45117,15 @@ public bool fnTSShapeConstructor_setMeshSize (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_setMeshSize(sbtsshapeconstructor, sbname, size)>=1; } /// -/// Set the display type for the mesh. @param name full name (object name + detail size) of the mesh to modify @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" @return true if successful, false otherwise @tsexample // set the mesh to be a billboard %this.setMeshType( \"SimpleShape64\", \"billboard\" ); @endtsexample ) +/// Set the display type for the mesh. +/// @param name full name (object name + detail size) of the mesh to modify +/// @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh to be a billboard +/// %this.setMeshType( \"SimpleShape64\", \"billboard\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setMeshType (string tsshapeconstructor, string name, string type) @@ -34998,7 +45145,14 @@ public bool fnTSShapeConstructor_setMeshType (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_setMeshType(sbtsshapeconstructor, sbname, sbtype)>=1; } /// -/// Set the parent of a node. @param name name of the node to modify @param parentName name of the parent node to set (use \"\" to move the node to the root level) @return true if successful, false if failed @tsexample %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); @endtsexample ) +/// Set the parent of a node. +/// @param name name of the node to modify +/// @param parentName name of the parent node to set (use \"\" to move the node to the root level) +/// @return true if successful, false if failed +/// @tsexample +/// %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setNodeParent (string tsshapeconstructor, string name, string parentName) @@ -35018,7 +45172,20 @@ public bool fnTSShapeConstructor_setNodeParent (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_setNodeParent(sbtsshapeconstructor, sbname, sbparentName)>=1; } /// -/// Set the base transform of a node. That is, the transform of the node when in the root (not-animated) pose. @param name name of the node to modify @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); @endtsexample ) +/// Set the base transform of a node. That is, the transform of the node when +/// in the root (not-animated) pose. +/// @param name name of the node to modify +/// @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); +/// %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); +/// %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setNodeTransform (string tsshapeconstructor, string name, string txfm, bool isWorld) @@ -35038,7 +45205,16 @@ public bool fnTSShapeConstructor_setNodeTransform (string tsshapeconstructor, st return SafeNativeMethods.mwle_fnTSShapeConstructor_setNodeTransform(sbtsshapeconstructor, sbname, sbtxfm, isWorld)>=1; } /// -/// Set the node an object is attached to. When the shape is rendered, the object geometry is rendered at the node's current transform. @param objName name of the object to modify @param nodeName name of the node to attach the object to @return true if successful, false otherwise @tsexample %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); @endtsexample ) +/// Set the node an object is attached to. +/// When the shape is rendered, the object geometry is rendered at the node's +/// current transform. +/// @param objName name of the object to modify +/// @param nodeName name of the node to attach the object to +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setObjectNode (string tsshapeconstructor, string objName, string nodeName) @@ -35058,7 +45234,19 @@ public bool fnTSShapeConstructor_setObjectNode (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_setObjectNode(sbtsshapeconstructor, sbobjName, sbnodeName)>=1; } /// -/// Mark a sequence as a blend or non-blend. A blend sequence is one that will be added on top of any other playing sequences. This is done by storing the animated node transforms relative to a reference frame, rather than as absolute transforms. @param name name of the sequence to modify @param blend true to make the sequence a blend, false for a non-blend @param blendSeq the name of the sequence that contains the blend reference frame @param blendFrame the reference frame in the blendSeq sequence @return true if successful, false otherwise @tsexample %this.setSequenceBlend( \"look\", true, \"root\", 0 ); @endtsexample ) +/// Mark a sequence as a blend or non-blend. +/// A blend sequence is one that will be added on top of any other playing +/// sequences. This is done by storing the animated node transforms relative +/// to a reference frame, rather than as absolute transforms. +/// @param name name of the sequence to modify +/// @param blend true to make the sequence a blend, false for a non-blend +/// @param blendSeq the name of the sequence that contains the blend reference frame +/// @param blendFrame the reference frame in the blendSeq sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceBlend( \"look\", true, \"root\", 0 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setSequenceBlend (string tsshapeconstructor, string name, bool blend, string blendSeq, int blendFrame) @@ -35078,7 +45266,15 @@ public bool fnTSShapeConstructor_setSequenceBlend (string tsshapeconstructor, st return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequenceBlend(sbtsshapeconstructor, sbname, blend, sbblendSeq, blendFrame)>=1; } /// -/// Mark a sequence as cyclic or non-cyclic. @param name name of the sequence to modify @param cyclic true to make the sequence cyclic, false for non-cyclic @return true if successful, false otherwise @tsexample %this.setSequenceCyclic( \"ambient\", true ); %this.setSequenceCyclic( \"shoot\", false ); @endtsexample ) +/// Mark a sequence as cyclic or non-cyclic. +/// @param name name of the sequence to modify +/// @param cyclic true to make the sequence cyclic, false for non-cyclic +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceCyclic( \"ambient\", true ); +/// %this.setSequenceCyclic( \"shoot\", false ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setSequenceCyclic (string tsshapeconstructor, string name, bool cyclic) @@ -35095,7 +45291,22 @@ public bool fnTSShapeConstructor_setSequenceCyclic (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequenceCyclic(sbtsshapeconstructor, sbname, cyclic)>=1; } /// -/// Set the translation and rotation ground speed of the sequence. The ground speed of the sequence is set by generating ground transform keyframes. The ground translational and rotational speed is assumed to be constant for the duration of the sequence. Existing ground frames for the sequence (if any) will be replaced. @param name name of the sequence to modify @param transSpeed translational speed (trans.x trans.y trans.z) in Torque units per frame @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in radians per frame. Default is \"0 0 0\" @return true if successful, false otherwise @tsexample %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); @endtsexample ) +/// Set the translation and rotation ground speed of the sequence. +/// The ground speed of the sequence is set by generating ground transform +/// keyframes. The ground translational and rotational speed is assumed to +/// be constant for the duration of the sequence. Existing ground frames for +/// the sequence (if any) will be replaced. +/// @param name name of the sequence to modify +/// @param transSpeed translational speed (trans.x trans.y trans.z) in +/// Torque units per frame +/// @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in +/// radians per frame. Default is \"0 0 0\" +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); +/// %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setSequenceGroundSpeed (string tsshapeconstructor, string name, string transSpeed, string rotSpeed) @@ -35118,7 +45329,11 @@ public bool fnTSShapeConstructor_setSequenceGroundSpeed (string tsshapeconstruct return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequenceGroundSpeed(sbtsshapeconstructor, sbname, sbtransSpeed, sbrotSpeed)>=1; } /// -/// Set the sequence priority. @param name name of the sequence to modify @param priority new priority value @return true if successful, false otherwise ) +/// Set the sequence priority. +/// @param name name of the sequence to modify +/// @param priority new priority value +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_setSequencePriority (string tsshapeconstructor, string name, float priority) @@ -35135,7 +45350,10 @@ public bool fnTSShapeConstructor_setSequencePriority (string tsshapeconstructor, return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequencePriority(sbtsshapeconstructor, sbname, priority)>=1; } /// -/// Write the current change set to a TSShapeConstructor script file. The name of the script file is the same as the model, but with .cs extension. eg. myShape.cs for myShape.dts or myShape.dae. ) +/// Write the current change set to a TSShapeConstructor script file. The +/// name of the script file is the same as the model, but with .cs extension. +/// eg. myShape.cs for myShape.dts or myShape.dae. ) +/// /// public void fnTSShapeConstructor_writeChangeSet (string tsshapeconstructor) @@ -35149,7 +45367,25 @@ public void fnTSShapeConstructor_writeChangeSet (string tsshapeconstructor) SafeNativeMethods.mwle_fnTSShapeConstructor_writeChangeSet(sbtsshapeconstructor); } /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void fnTSStatic_changeMaterial (string tsstatic, string mapTo, string oldMat, string newMat) @@ -35172,7 +45408,15 @@ public void fnTSStatic_changeMaterial (string tsstatic, string mapTo, string old SafeNativeMethods.mwle_fnTSStatic_changeMaterial(sbtsstatic, sbmapTo, sboldMat, sbnewMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string fnTSStatic_getModelFile (string tsstatic) @@ -35189,7 +45433,10 @@ public string fnTSStatic_getModelFile (string tsstatic) } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int fnTSStatic_getTargetCount (string tsstatic) @@ -35203,7 +45450,11 @@ public int fnTSStatic_getTargetCount (string tsstatic) return SafeNativeMethods.mwle_fnTSStatic_getTargetCount(sbtsstatic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string fnTSStatic_getTargetName (string tsstatic, int index) @@ -35220,7 +45471,9 @@ public string fnTSStatic_getTargetName (string tsstatic, int index) } /// -/// @brief Does the turret respawn after it has been destroyed. @returns True if the turret respawns.) +/// @brief Does the turret respawn after it has been destroyed. +/// @returns True if the turret respawns.) +/// /// public bool fnTurretShape_doRespawn (string turretshape) @@ -35234,7 +45487,9 @@ public bool fnTurretShape_doRespawn (string turretshape) return SafeNativeMethods.mwle_fnTurretShape_doRespawn(sbturretshape)>=1; } /// -/// @brief Get if the turret is allowed to fire through moves. @return True if the turret is allowed to fire through moves. ) +/// @brief Get if the turret is allowed to fire through moves. +/// @return True if the turret is allowed to fire through moves. ) +/// /// public bool fnTurretShape_getAllowManualFire (string turretshape) @@ -35248,7 +45503,9 @@ public bool fnTurretShape_getAllowManualFire (string turretshape) return SafeNativeMethods.mwle_fnTurretShape_getAllowManualFire(sbturretshape)>=1; } /// -/// @brief Get if the turret is allowed to rotate through moves. @return True if the turret is allowed to rotate through moves. ) +/// @brief Get if the turret is allowed to rotate through moves. +/// @return True if the turret is allowed to rotate through moves. ) +/// /// public bool fnTurretShape_getAllowManualRotation (string turretshape) @@ -35262,7 +45519,15 @@ public bool fnTurretShape_getAllowManualRotation (string turretshape) return SafeNativeMethods.mwle_fnTurretShape_getAllowManualRotation(sbturretshape)>=1; } /// -/// @brief Get the name of the turret's current state. The state is one of the following:ul> li>Dead - The TurretShape is destroyed./li> li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> li>Ready - The TurretShape is free to move. The usual state./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// @brief Get the name of the turret's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The TurretShape is destroyed./li> +/// li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> +/// li>Ready - The TurretShape is free to move. The usual state./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// /// public string fnTurretShape_getState (string turretshape) @@ -35279,7 +45544,10 @@ public string fnTurretShape_getState (string turretshape) } /// -/// @brief Get Euler rotation of this turret's heading and pitch nodes. @return the orientation of the turret's heading and pitch nodes in the form of rotations around the X, Y and Z axes in degrees. ) +/// @brief Get Euler rotation of this turret's heading and pitch nodes. +/// @return the orientation of the turret's heading and pitch nodes in the +/// form of rotations around the X, Y and Z axes in degrees. ) +/// /// public string fnTurretShape_getTurretEulerRotation (string turretshape) @@ -35296,7 +45564,9 @@ public string fnTurretShape_getTurretEulerRotation (string turretshape) } /// -/// @brief Set if the turret is allowed to fire through moves. @param allow If true then the turret may be fired through moves.) +/// @brief Set if the turret is allowed to fire through moves. +/// @param allow If true then the turret may be fired through moves.) +/// /// public void fnTurretShape_setAllowManualFire (string turretshape, bool allow) @@ -35310,7 +45580,9 @@ public void fnTurretShape_setAllowManualFire (string turretshape, bool allow) SafeNativeMethods.mwle_fnTurretShape_setAllowManualFire(sbturretshape, allow); } /// -/// @brief Set if the turret is allowed to rotate through moves. @param allow If true then the turret may be rotated through moves.) +/// @brief Set if the turret is allowed to rotate through moves. +/// @param allow If true then the turret may be rotated through moves.) +/// /// public void fnTurretShape_setAllowManualRotation (string turretshape, bool allow) @@ -35324,7 +45596,10 @@ public void fnTurretShape_setAllowManualRotation (string turretshape, bool allow SafeNativeMethods.mwle_fnTurretShape_setAllowManualRotation(sbturretshape, allow); } /// -/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. @param rot The rotation in degrees. The pitch is the X component and the heading is the Z component. The Y component is ignored.) +/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. +/// @param rot The rotation in degrees. The pitch is the X component and the +/// heading is the Z component. The Y component is ignored.) +/// /// public void fnTurretShape_setTurretEulerRotation (string turretshape, string rot) @@ -35419,7 +45694,11 @@ public void fnVolumetricFog_SetFogModulation (string volumetricfog, float new_st SafeNativeMethods.mwle_fnVolumetricFog_SetFogModulation(sbvolumetricfog, new_strenght, sbnew_speed1, sbnew_speed2); } /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool fnWalkableShape_attachObject (string walkableshape, string obj) @@ -35436,7 +45715,14 @@ public bool fnWalkableShape_attachObject (string walkableshape, string obj) return SafeNativeMethods.mwle_fnWalkableShape_attachObject(sbwalkableshape, sbobj)>=1; } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void fnWalkableShape_detachAll (string walkableshape) @@ -35450,7 +45736,11 @@ public void fnWalkableShape_detachAll (string walkableshape) SafeNativeMethods.mwle_fnWalkableShape_detachAll(sbwalkableshape); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool fnWalkableShape_detachObject (string walkableshape, string obj) @@ -35468,6 +45758,7 @@ public bool fnWalkableShape_detachObject (string walkableshape, string obj) } /// /// Returns the attachment at the passed index value.) +/// /// public string fnWalkableShape_getAttachment (string walkableshape, int index) @@ -35485,6 +45776,7 @@ public string fnWalkableShape_getAttachment (string walkableshape, int index) } /// /// Returns the number of objects that are currently attached.) +/// /// public int fnWalkableShape_getNumAttachments (string walkableshape) @@ -35498,7 +45790,9 @@ public int fnWalkableShape_getNumAttachments (string walkableshape) return SafeNativeMethods.mwle_fnWalkableShape_getNumAttachments(sbwalkableshape); } /// -/// @brief Get the number of wheels on this vehicle. @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// @brief Get the number of wheels on this vehicle. +/// @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// /// public int fnWheeledVehicle_getWheelCount (string wheeledvehicle) @@ -35512,7 +45806,13 @@ public int fnWheeledVehicle_getWheelCount (string wheeledvehicle) return SafeNativeMethods.mwle_fnWheeledVehicle_getWheelCount(sbwheeledvehicle); } /// -/// @brief Set whether the wheel is powered (has torque applied from the engine). A rear wheel drive car for example would set the front wheels to false, and the rear wheels to true. @param wheel index of the wheel to set (hub node #) @param powered flag indicating whether to power the wheel or not @return true if successful, false if failed ) +/// @brief Set whether the wheel is powered (has torque applied from the engine). +/// A rear wheel drive car for example would set the front wheels to false, +/// and the rear wheels to true. +/// @param wheel index of the wheel to set (hub node #) +/// @param powered flag indicating whether to power the wheel or not +/// @return true if successful, false if failed ) +/// /// public bool fnWheeledVehicle_setWheelPowered (string wheeledvehicle, int wheel, bool powered) @@ -35526,7 +45826,14 @@ public bool fnWheeledVehicle_setWheelPowered (string wheeledvehicle, int wheel, return SafeNativeMethods.mwle_fnWheeledVehicle_setWheelPowered(sbwheeledvehicle, wheel, powered)>=1; } /// -/// @brief Set the WheeledVehicleSpring datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param spring WheeledVehicleSpring datablock @return true if successful, false if failed @tsexample %obj.setWheelSpring( 0, FrontSpring ); @endtsexample ) +/// @brief Set the WheeledVehicleSpring datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param spring WheeledVehicleSpring datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelSpring( 0, FrontSpring ); +/// @endtsexample ) +/// /// public bool fnWheeledVehicle_setWheelSpring (string wheeledvehicle, int wheel, string spring) @@ -35543,7 +45850,16 @@ public bool fnWheeledVehicle_setWheelSpring (string wheeledvehicle, int wheel, s return SafeNativeMethods.mwle_fnWheeledVehicle_setWheelSpring(sbwheeledvehicle, wheel, sbspring)>=1; } /// -/// @brief Set how much the wheel is affected by steering. The steering factor controls how much the wheel is rotated by the vehicle steering. For example, most cars would have their front wheels set to 1.0, and their rear wheels set to 0 since only the front wheels should turn. Negative values will turn the wheel in the opposite direction to the steering angle. @param wheel index of the wheel to set (hub node #) @param steering steering factor from -1 (full inverse) to 1 (full) @return true if successful, false if failed ) +/// @brief Set how much the wheel is affected by steering. +/// The steering factor controls how much the wheel is rotated by the vehicle +/// steering. For example, most cars would have their front wheels set to 1.0, +/// and their rear wheels set to 0 since only the front wheels should turn. +/// Negative values will turn the wheel in the opposite direction to the steering +/// angle. +/// @param wheel index of the wheel to set (hub node #) +/// @param steering steering factor from -1 (full inverse) to 1 (full) +/// @return true if successful, false if failed ) +/// /// public bool fnWheeledVehicle_setWheelSteering (string wheeledvehicle, int wheel, float steering) @@ -35557,7 +45873,14 @@ public bool fnWheeledVehicle_setWheelSteering (string wheeledvehicle, int wheel, return SafeNativeMethods.mwle_fnWheeledVehicle_setWheelSteering(sbwheeledvehicle, wheel, steering)>=1; } /// -/// @brief Set the WheeledVehicleTire datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param tire WheeledVehicleTire datablock @return true if successful, false if failed @tsexample %obj.setWheelTire( 0, FrontTire ); @endtsexample ) +/// @brief Set the WheeledVehicleTire datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param tire WheeledVehicleTire datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelTire( 0, FrontTire ); +/// @endtsexample ) +/// /// public bool fnWheeledVehicle_setWheelTire (string wheeledvehicle, int wheel, string tire) @@ -35575,6 +45898,7 @@ public bool fnWheeledVehicle_setWheelTire (string wheeledvehicle, int wheel, str } /// /// Create a ConvexShape from the given polyhedral object. ) +/// /// public string fnWorldEditor_createConvexShapeFrom (string worldeditor, string polyObject) @@ -35595,6 +45919,7 @@ public string fnWorldEditor_createConvexShapeFrom (string worldeditor, string po } /// /// Grab the geometry from @a geometryProvider, create a @a className object, and assign it the extracted geometry. ) +/// /// public string fnWorldEditor_createPolyhedralObject (string worldeditor, string className, string geometryProvider) @@ -35618,6 +45943,7 @@ public string fnWorldEditor_createPolyhedralObject (string worldeditor, string c } /// /// Get the soft snap alignment. ) +/// /// public int fnWorldEditor_getSoftSnapAlignment (string worldeditor) @@ -35632,6 +45958,7 @@ public int fnWorldEditor_getSoftSnapAlignment (string worldeditor) } /// /// Get the terrain snap alignment. ) +/// /// public int fnWorldEditor_getTerrainSnapAlignment (string worldeditor) @@ -35646,6 +45973,7 @@ public int fnWorldEditor_getTerrainSnapAlignment (string worldeditor) } /// /// ( WorldEditor, ignoreObjClass, void, 3, 0, (string class_name, ...)) +/// /// public void fnWorldEditor_ignoreObjClass (string worldeditor, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -35714,6 +46042,7 @@ public void fnWorldEditor_ignoreObjClass (string worldeditor, string a2, string } /// /// Set the soft snap alignment. ) +/// /// public void fnWorldEditor_setSoftSnapAlignment (string worldeditor, int type) @@ -35728,6 +46057,7 @@ public void fnWorldEditor_setSoftSnapAlignment (string worldeditor, int type) } /// /// Set the terrain snap alignment. ) +/// /// public void fnWorldEditor_setTerrainSnapAlignment (string worldeditor, int alignment) @@ -35742,6 +46072,7 @@ public void fnWorldEditor_setTerrainSnapAlignment (string worldeditor, int align } /// /// ( WorldEditorSelection, containsGlobalBounds, bool, 2, 2, () - True if an object with global bounds is contained in the selection. ) +/// /// public bool fnWorldEditorSelection_containsGlobalBounds (string worldeditorselection) @@ -35756,6 +46087,7 @@ public bool fnWorldEditorSelection_containsGlobalBounds (string worldeditorselec } /// /// ( WorldEditorSelection, getBoxCentroid, const char*, 2, 2, () - Return the center of the bounding box around the selection. ) +/// /// public string fnWorldEditorSelection_getBoxCentroid (string worldeditorselection) @@ -35773,6 +46105,7 @@ public string fnWorldEditorSelection_getBoxCentroid (string worldeditorselection } /// /// ( WorldEditorSelection, getCentroid, const char*, 2, 2, () - Return the median of all object positions in the selection. ) +/// /// public string fnWorldEditorSelection_getCentroid (string worldeditorselection) @@ -35790,6 +46123,7 @@ public string fnWorldEditorSelection_getCentroid (string worldeditorselection) } /// /// ( WorldEditorSelection, offset, void, 3, 4, ( vector delta, float gridSnap=0 ) - Move all objects in the selection by the given delta. ) +/// /// public void fnWorldEditorSelection_offset (string worldeditorselection, string a2, string a3) @@ -35810,6 +46144,7 @@ public void fnWorldEditorSelection_offset (string worldeditorselection, string a } /// /// ( WorldEditorSelection, subtract, void, 3, 3, ( SimSet ) - Remove all objects in the given set from this selection. ) +/// /// public void fnWorldEditorSelection_subtract (string worldeditorselection, string a2) @@ -35827,6 +46162,7 @@ public void fnWorldEditorSelection_subtract (string worldeditorselection, string } /// /// ( WorldEditorSelection, union, void, 3, 3, ( SimSet set ) - Add all objects in the given set to this selection. ) +/// /// public void fnWorldEditorSelection_union (string worldeditorselection, string a2) @@ -35843,7 +46179,14 @@ public void fnWorldEditorSelection_union (string worldeditorselection, string a2 SafeNativeMethods.mwle_fnWorldEditorSelection_union(sbworldeditorselection, sba2); } /// -/// @brief Add a file to the zip archive @param filename The path and name of the file to add to the zip archive. @param pathInZip The path and name to be given to the file within the zip archive. @param replace If a file already exists within the zip archive at the same location as this new file, this parameter indicates if it should be replaced. By default, it will be replaced. @return True if the file was successfully added to the zip archive.) +/// @brief Add a file to the zip archive +/// +/// @param filename The path and name of the file to add to the zip archive. +/// @param pathInZip The path and name to be given to the file within the zip archive. +/// @param replace If a file already exists within the zip archive at the same location as this +/// new file, this parameter indicates if it should be replaced. By default, it will be replaced. +/// @return True if the file was successfully added to the zip archive.) +/// /// public bool fnZipObject_addFile (string zipobject, string filename, string pathInZip, bool replace) @@ -35863,7 +46206,9 @@ public bool fnZipObject_addFile (string zipobject, string filename, string pathI return SafeNativeMethods.mwle_fnZipObject_addFile(sbzipobject, sbfilename, sbpathInZip, replace)>=1; } /// -/// @brief Close an already opened zip archive. @see openArchive()) +/// @brief Close an already opened zip archive. +/// @see openArchive()) +/// /// public void fnZipObject_closeArchive (string zipobject) @@ -35877,7 +46222,11 @@ public void fnZipObject_closeArchive (string zipobject) SafeNativeMethods.mwle_fnZipObject_closeArchive(sbzipobject); } /// -/// @brief Close a previously opened file within the zip archive. @param stream The StreamObject of a previously opened file within the zip archive. @see openFileForRead() @see openFileForWrite()) +/// @brief Close a previously opened file within the zip archive. +/// @param stream The StreamObject of a previously opened file within the zip archive. +/// @see openFileForRead() +/// @see openFileForWrite()) +/// /// public void fnZipObject_closeFile (string zipobject, string stream) @@ -35894,7 +46243,19 @@ public void fnZipObject_closeFile (string zipobject, string stream) SafeNativeMethods.mwle_fnZipObject_closeFile(sbzipobject, sbstream); } /// -/// @brief Deleted the given file from the zip archive @param pathInZip The path and name of the file to be deleted from the zip archive. @return True of the file was successfully deleted. @note Files that have been deleted from the archive will still show up with a getFileEntryCount() until you close the archive. If you need to have the file count up to date with only valid files within the archive, you could close and then open the archive again. @see getFileEntryCount() @see closeArchive() @see openArchive()) +/// @brief Deleted the given file from the zip archive +/// @param pathInZip The path and name of the file to be deleted from the zip archive. +/// @return True of the file was successfully deleted. +/// +/// @note Files that have been deleted from the archive will still show up with a +/// getFileEntryCount() until you close the archive. If you need to have the file +/// count up to date with only valid files within the archive, you could close and then +/// open the archive again. +/// +/// @see getFileEntryCount() +/// @see closeArchive() +/// @see openArchive()) +/// /// public bool fnZipObject_deleteFile (string zipobject, string pathInZip) @@ -35911,7 +46272,11 @@ public bool fnZipObject_deleteFile (string zipobject, string pathInZip) return SafeNativeMethods.mwle_fnZipObject_deleteFile(sbzipobject, sbpathInZip)>=1; } /// -/// @brief Extact a file from the zip archive and save it to the requested location. @param pathInZip The path and name of the file to be extracted within the zip archive. @param filename The path and name to give the extracted file. @return True if the file was successfully extracted.) +/// @brief Extact a file from the zip archive and save it to the requested location. +/// @param pathInZip The path and name of the file to be extracted within the zip archive. +/// @param filename The path and name to give the extracted file. +/// @return True if the file was successfully extracted.) +/// /// public bool fnZipObject_extractFile (string zipobject, string pathInZip, string filename) @@ -35931,7 +46296,22 @@ public bool fnZipObject_extractFile (string zipobject, string pathInZip, string return SafeNativeMethods.mwle_fnZipObject_extractFile(sbzipobject, sbpathInZip, sbfilename)>=1; } /// -/// @brief Get information on the requested file within the zip archive. This methods provides five different pieces of information for the requested file: ul>li>filename - The path and name of the file within the zip archive/li> li>uncompressed size/li> li>compressed size/li> li>compression method/li> li>CRC32/li>/ul> Use getFileEntryCount() to obtain the total number of files within the archive. @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. @see getFileEntryCount()) +/// @brief Get information on the requested file within the zip archive. +/// +/// This methods provides five different pieces of information for the requested file: +/// ul>li>filename - The path and name of the file within the zip archive/li> +/// li>uncompressed size/li> +/// li>compressed size/li> +/// li>compression method/li> +/// li>CRC32/li>/ul> +/// +/// Use getFileEntryCount() to obtain the total number of files within the archive. +/// +/// @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. +/// @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. +/// +/// @see getFileEntryCount()) +/// /// public string fnZipObject_getFileEntry (string zipobject, int index) @@ -35948,7 +46328,20 @@ public string fnZipObject_getFileEntry (string zipobject, int index) } /// -/// @brief Get the number of files within the zip archive. Use getFileEntry() to retrive information on each file within the archive. @return The number of files within the zip archive. @note The returned count will include any files that have been deleted from the archive using deleteFile(). To clear out all deleted files, you could close and then open the archive again. @see getFileEntry() @see closeArchive() @see openArchive()) +/// @brief Get the number of files within the zip archive. +/// +/// Use getFileEntry() to retrive information on each file within the archive. +/// +/// @return The number of files within the zip archive. +/// +/// @note The returned count will include any files that have been deleted from +/// the archive using deleteFile(). To clear out all deleted files, you could +/// close and then open the archive again. +/// +/// @see getFileEntry() +/// @see closeArchive() +/// @see openArchive()) +/// /// public int fnZipObject_getFileEntryCount (string zipobject) @@ -35962,7 +46355,23 @@ public int fnZipObject_getFileEntryCount (string zipobject) return SafeNativeMethods.mwle_fnZipObject_getFileEntryCount(sbzipobject); } /// -/// read ), @brief Open a zip archive for manipulation. Once a zip archive is opened use the various ZipObject methods for working with the files within the archive. Be sure to close the archive when you are done with it. @param filename The path and file name of the zip archive to open. @param accessMode One of read, write or readwrite @return True is the archive was successfully opened. @note If you wish to make any changes to the archive, be sure to open it with a write or readwrite access mode. @see closeArchive()) +/// read ), +/// @brief Open a zip archive for manipulation. +/// +/// Once a zip archive is opened use the various ZipObject methods for +/// working with the files within the archive. Be sure to close the archive when +/// you are done with it. +/// +/// @param filename The path and file name of the zip archive to open. +/// @param accessMode One of read, write or readwrite +/// +/// @return True is the archive was successfully opened. +/// +/// @note If you wish to make any changes to the archive, be sure to open it +/// with a write or readwrite access mode. +/// +/// @see closeArchive()) +/// /// public bool fnZipObject_openArchive (string zipobject, string filename, string accessMode) @@ -35982,7 +46391,18 @@ public bool fnZipObject_openArchive (string zipobject, string filename, string a return SafeNativeMethods.mwle_fnZipObject_openArchive(sbzipobject, sbfilename, sbaccessMode)>=1; } /// -/// @brief Open a file within the zip archive for reading. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for reading. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string fnZipObject_openFileForRead (string zipobject, string filename) @@ -36002,7 +46422,18 @@ public string fnZipObject_openFileForRead (string zipobject, string filename) } /// -/// @brief Open a file within the zip archive for writing to. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for writing to. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string fnZipObject_openFileForWrite (string zipobject, string filename) @@ -36022,7 +46453,11 @@ public string fnZipObject_openFileForWrite (string zipobject, string filename) } /// -/// Dump a list of all objects assigned to the zone to the console as well as a list of all connected zone spaces. @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of objects are updated on demand, the zone contents can be outdated. ) +/// Dump a list of all objects assigned to the zone to the console as well as a list +/// of all connected zone spaces. +/// @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of +/// objects are updated on demand, the zone contents can be outdated. ) +/// /// public void fnZone_dumpZoneState (string zone, bool updateFirst) @@ -36036,7 +46471,9 @@ public void fnZone_dumpZoneState (string zone, bool updateFirst) SafeNativeMethods.mwle_fnZone_dumpZoneState(sbzone, updateFirst); } /// -/// Get the unique numeric ID of the zone in its scene. @return The ID of the zone. ) +/// Get the unique numeric ID of the zone in its scene. +/// @return The ID of the zone. ) +/// /// public int fnZone_getZoneId (string zone) diff --git a/Templates/C#-Empty/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj b/Templates/C#-Empty/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj index c6b4a471..fb20969d 100644 --- a/Templates/C#-Empty/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj +++ b/Templates/C#-Empty/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj @@ -14,10 +14,14 @@ 512 - SAK - SAK - SAK - SAK + + + + + + + + x86 @@ -193,6 +197,15 @@ + + + + + + + + + @@ -206,5 +219,4 @@ - \ No newline at end of file diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIClient_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIClient_Base.cs index eadad2c1..87ef5021 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIClient_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIClient_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIConnection_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIConnection_Base.cs index cadb3ceb..f234b5f5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIConnection_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIConnection_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIPlayer_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIPlayer_Base.cs index 01f485e3..639e05c6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIPlayer_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AIPlayer_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AITurretShapeData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AITurretShapeData_Base.cs index e9539f21..06194bd0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AITurretShapeData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AITurretShapeData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AITurretShape_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AITurretShape_Base.cs index 929cd7bb..e17f3f52 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AITurretShape_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AITurretShape_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ActionMap_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ActionMap_Base.cs index c1da6611..0afc5c14 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ActionMap_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ActionMap_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AdvancedLightBinManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AdvancedLightBinManager_Base.cs index 43dfdcb6..e461f0d0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AdvancedLightBinManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/AdvancedLightBinManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ArrayObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ArrayObject_Base.cs index 812dea8e..3bb6c07b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ArrayObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ArrayObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BarrelDistortionPostEffect_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BarrelDistortionPostEffect_Base.cs index 960e9c23..302e3f8d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BarrelDistortionPostEffect_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BarrelDistortionPostEffect_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BaseMaterialDefinition_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BaseMaterialDefinition_Base.cs index c09190ed..566e5b54 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BaseMaterialDefinition_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BaseMaterialDefinition_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BasicClouds_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BasicClouds_Base.cs index 21423222..0a8d4dc8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BasicClouds_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/BasicClouds_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CachedInterfaceExampleComponent_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CachedInterfaceExampleComponent_Base.cs index 63db9df6..a5336868 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CachedInterfaceExampleComponent_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CachedInterfaceExampleComponent_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CameraBookmark_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CameraBookmark_Base.cs index d5ad3e26..8d0424ec 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CameraBookmark_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CameraBookmark_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CameraData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CameraData_Base.cs index 2a0f9b4b..5a47317d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CameraData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CameraData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Camera_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Camera_Base.cs index 3c3df2ab..284dc393 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Camera_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Camera_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CloudLayer_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CloudLayer_Base.cs index 2de0e054..4d9bb616 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CloudLayer_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CloudLayer_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CompoundUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CompoundUndoAction_Base.cs index 65c59469..4fb39206 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CompoundUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CompoundUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ConsoleLogger_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ConsoleLogger_Base.cs index 84e5dbbf..6eef8924 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ConsoleLogger_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ConsoleLogger_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ConvexShape_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ConvexShape_Base.cs index 0827ed5a..3b2f8a9f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ConvexShape_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ConvexShape_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CoverPoint_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CoverPoint_Base.cs index ec4472bc..6b1adacb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CoverPoint_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CoverPoint_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CreatorTree_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CreatorTree_Base.cs index 0c12eb67..327e5d72 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CreatorTree_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CreatorTree_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CubemapData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CubemapData_Base.cs index 83db5db6..40c95e0e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CubemapData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CubemapData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CustomMaterial_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CustomMaterial_Base.cs index cc3ee6b4..0d0ebf46 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CustomMaterial_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/CustomMaterial_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DBDeleteUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DBDeleteUndoAction_Base.cs index 5307497d..ed04cfc3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DBDeleteUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DBDeleteUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DBRetargetUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DBRetargetUndoAction_Base.cs index a0a3ceea..67e616e9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DBRetargetUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DBRetargetUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DICreateUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DICreateUndoAction_Base.cs index 3cb05bca..ef1f6fe2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DICreateUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DICreateUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DIDeleteUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DIDeleteUndoAction_Base.cs index 8370270d..3bc790e1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DIDeleteUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DIDeleteUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DInputManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DInputManager_Base.cs index f85b1517..772d5793 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DInputManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DInputManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DbgFileView_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DbgFileView_Base.cs index 0e9ad4f9..c4c6c646 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DbgFileView_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DbgFileView_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DebrisData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DebrisData_Base.cs index 31599dcd..79cae856 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DebrisData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DebrisData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Debris_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Debris_Base.cs index 62dda289..97688e0b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Debris_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Debris_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DebugDrawer_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DebugDrawer_Base.cs index fbd68712..dfbbb84e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DebugDrawer_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DebugDrawer_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalData_Base.cs index 7ce48f4b..b62eb0ef 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalManager_Base.cs index 85e4fc3f..1399c937 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalRoad_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalRoad_Base.cs index 6bcd2350..69642bd0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalRoad_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DecalRoad_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DynamicConsoleMethodComponent_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DynamicConsoleMethodComponent_Base.cs index 2b669ab6..d3b25697 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DynamicConsoleMethodComponent_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/DynamicConsoleMethodComponent_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EditManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EditManager_Base.cs index 97813e40..e353c267 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EditManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EditManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EditTSCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EditTSCtrl_Base.cs index 6208b233..fafdc370 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EditTSCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EditTSCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EventManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EventManager_Base.cs index 65a8f4f0..9c6103f1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EventManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/EventManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ExplodePrefabUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ExplodePrefabUndoAction_Base.cs index 7e72e8e4..2a11add9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ExplodePrefabUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ExplodePrefabUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ExplosionData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ExplosionData_Base.cs index 92ab37c9..22a783d8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ExplosionData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ExplosionData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Explosion_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Explosion_Base.cs index 96ccfc7e..e912ce69 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Explosion_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Explosion_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FieldBrushObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FieldBrushObject_Base.cs index 03890eaa..856a2ba4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FieldBrushObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FieldBrushObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileDialog_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileDialog_Base.cs index a781ebe3..3c08dc11 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileDialog_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileDialog_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileObject_Base.cs index 830808d6..cdcfa152 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileStreamObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileStreamObject_Base.cs index 4863ed4b..8379db34 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileStreamObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FileStreamObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FlyingVehicleData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FlyingVehicleData_Base.cs index e3c38805..1a610f02 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FlyingVehicleData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FlyingVehicleData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FlyingVehicle_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FlyingVehicle_Base.cs index 211589f0..0f3f42ae 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FlyingVehicle_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/FlyingVehicle_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForcedMaterialMeshMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForcedMaterialMeshMgr_Base.cs index 322a2f4e..9dba035a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForcedMaterialMeshMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForcedMaterialMeshMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrushElement_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrushElement_Base.cs index 48491658..939eb6c4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrushElement_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrushElement_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrushTool_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrushTool_Base.cs index 94eeabf7..284e2ec3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrushTool_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrushTool_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrush_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrush_Base.cs index e9137110..90a0f286 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrush_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestBrush_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestCreateUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestCreateUndoAction_Base.cs index 20d7c991..84781340 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestCreateUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestCreateUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestDeleteUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestDeleteUndoAction_Base.cs index 210c0c2c..b4d6f66e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestDeleteUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestDeleteUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestEditorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestEditorCtrl_Base.cs index 43283817..1a9c5422 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestEditorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestEditorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestItemData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestItemData_Base.cs index bd8915f2..4d020d37 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestItemData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestItemData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestSelectionTool_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestSelectionTool_Base.cs index 65a82c94..d62cfd25 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestSelectionTool_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestSelectionTool_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestTool_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestTool_Base.cs index d4ade3c4..927f7e24 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestTool_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestTool_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestUndoAction_Base.cs index 011e9a97..cd2b373f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestUpdateAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestUpdateAction_Base.cs index d9b9d938..977d7213 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestUpdateAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestUpdateAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestWindEmitter_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestWindEmitter_Base.cs index 0c5ed333..13318851 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestWindEmitter_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ForestWindEmitter_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Forest_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Forest_Base.cs index ba34530c..17f2e35c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Forest_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Forest_Base.cs @@ -1,34 +1,62 @@ - - +// WinterLeaf Entertainment +// Copyright (c) 2014, WinterLeaf Entertainment LLC +// +// All rights reserved. +// +// The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). +// +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// +// This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". +// +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// +// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: +// +// Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. +// Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +// With respect to any Product that the Licensee develop using the Software: +// Licensee shall: +// display the OMNI Logo, in the start-up sequence of the Product (unless waived by WinterLeaf Entertainment); +// display in the "About" box or in the credits screen of the Product the text "OMNI by WinterLeaf Entertainment"; +// display the OMNI Logo, on all external Product packaging materials and the back cover of any printed instruction manual or the end of any electronic instruction manual; +// notify WinterLeaf Entertainment in writing that You are publicly releasing a Product that was developed using the Software within the first 30 days following the release; and +// the Licensee hereby grant WinterLeaf Entertainment permission to refer to the Licensee or the name of any Product the Licensee develops using the Software for marketing purposes. All goodwill in each party's trademarks and logos will inure to the sole benefit of that party. +// Neither the name of WinterLeaf Entertainment LLC or OMNI nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. +// The following restrictions apply to the use of OMNI "Community Edition": +// Licensee may not: +// create any derivative works of OMNI Engine, including but not limited to translations, localizations, or game making software other than Games; +// redistribute, encumber, sell, rent, lease, sublicense, or otherwise transfer rights to OMNI "Community Edition"; or +// remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or +// use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or +// use the Software for any illegal purpose. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region + using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using WinterLeaf.Engine; -using WinterLeaf.Engine.Classes; -using WinterLeaf.Engine.Containers; -using WinterLeaf.Engine.Enums; using System.ComponentModel; -using System.Threading; -using WinterLeaf.Engine.Classes.Interopt; +using WinterLeaf.Demo.Full.Models.User.Extendable; +using WinterLeaf.Engine; using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Engine.Classes.Interopt; +using WinterLeaf.Engine.Containers; + #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base - { +namespace WinterLeaf.Demo.Full.Models.Base +{ /// /// /// - [TypeConverter(typeof(TypeConverterGeneric))] - public partial class Forest_Base: SceneObject -{ + [TypeConverter(typeof (TypeConverterGeneric))] + public partial class Forest_Base : SceneObject + { + #region ProxyObjects Operator Overrides -#region ProxyObjects Operator Overrides /// /// /// @@ -36,27 +64,29 @@ public partial class Forest_Base: SceneObject /// /// public static bool operator ==(Forest_Base ts, string simobjectid) - { - return object.ReferenceEquals(ts, null) ? object.ReferenceEquals(simobjectid, null) : ts.Equals(simobjectid); - } - /// + { + return ReferenceEquals(ts, null) ? ReferenceEquals(simobjectid, null) : ts.Equals(simobjectid); + } + + /// /// /// /// public override int GetHashCode() - { + { return base.GetHashCode(); - } - /// + } + + /// /// /// /// /// public override bool Equals(object obj) - { - - return (this._ID ==(string)myReflections.ChangeType( obj,typeof(string))); - } + { + return (this._ID == (string) myReflections.ChangeType(obj, typeof (string))); + } + /// /// /// @@ -64,25 +94,23 @@ public override bool Equals(object obj) /// /// public static bool operator !=(Forest_Base ts, string simobjectid) - { - if (object.ReferenceEquals(ts, null)) - return !object.ReferenceEquals(simobjectid, null); + { + if (ReferenceEquals(ts, null)) + return !ReferenceEquals(simobjectid, null); return !ts.Equals(simobjectid); + } - } - - - /// + /// /// /// /// /// - public static implicit operator string( Forest_Base ts) - { - if (object.ReferenceEquals(ts, null)) - return "0"; + public static implicit operator string(Forest_Base ts) + { + if (ReferenceEquals(ts, null)) + return "0"; return ts._ID; - } + } /// /// @@ -90,20 +118,20 @@ public static implicit operator string( Forest_Base ts) /// /// public static implicit operator Forest_Base(string ts) - { + { uint simobjectid = resolveobject(ts); - return (Forest_Base) Omni.self.getSimObject(simobjectid,typeof(Forest_Base)); - } + return (Forest_Base) Omni.self.getSimObject(simobjectid, typeof (Forest_Base)); + } /// /// /// /// /// - public static implicit operator int( Forest_Base ts) - { - return (int)ts._iID; - } + public static implicit operator int(Forest_Base ts) + { + return (int) ts._iID; + } /// /// @@ -111,122 +139,119 @@ public static implicit operator int( Forest_Base ts) /// /// public static implicit operator Forest_Base(int simobjectid) - { - return (Forest) Omni.self.getSimObject((uint)simobjectid,typeof(Forest_Base)); - } - + { + return (Forest) Omni.self.getSimObject((uint) simobjectid, typeof (Forest_Base)); + } /// /// /// /// /// - public static implicit operator uint( Forest_Base ts) - { + public static implicit operator uint(Forest_Base ts) + { return ts._iID; - } + } /// /// /// /// public static implicit operator Forest_Base(uint simobjectid) - { - return (Forest_Base) Omni.self.getSimObject(simobjectid,typeof(Forest_Base)); - } -#endregion -#region Init Persists -/// -/// The source forest data file. -/// -[MemberGroup("")] -public String dataFile - { - get - { - return Omni.self.GetVar(_ID + ".dataFile").AsString(); - } - set - { - Omni.self.SetVar(_ID + ".dataFile", value.AsString()); - } - } -/// -/// Scalar applied to the farclip distance when Forest renders into a reflection. -/// -[MemberGroup("Lod")] -public float lodReflectScalar - { - get - { - return Omni.self.GetVar(_ID + ".lodReflectScalar").AsFloat(); - } - set - { - Omni.self.SetVar(_ID + ".lodReflectScalar", value.AsString()); - } - } + { + return (Forest_Base) Omni.self.getSimObject(simobjectid, typeof (Forest_Base)); + } -#endregion -#region Member Functions -/// -/// () ) -/// -/// -[MemberFunctionConsoleInteraction(true)] -public void clear(){ - -pInvokes.m_ts.fn_Forest_clear(_ID); -} -/// -/// ()) -/// -/// -[MemberFunctionConsoleInteraction(true)] -public bool isDirty(){ - -return pInvokes.m_ts.fn_Forest_isDirty(_ID); -} -/// -/// ()) -/// -/// -[MemberFunctionConsoleInteraction(true)] -public void regenCells(){ - -pInvokes.m_ts.fn_Forest_regenCells(_ID); -} -/// -/// ), saveDataFile( [path] ) ) -/// -/// -[MemberFunctionConsoleInteraction(true)] -public void saveDataFile(string path = null){ - -pInvokes.m_ts.fn_Forest_saveDataFile(_ID, path); -} -/// -/// .) -/// -/// -[MemberFunctionConsoleInteraction(true)] -public void addItem(string data, Point3F position, float rotation, float scale){ - -pInvokes.m_ts.fnForest_addItem(_ID, data, position.AsString(), rotation, scale); -} -/// -/// .) -/// -/// -[MemberFunctionConsoleInteraction(true)] -public void addItemWithTransform(string data, TransformF trans, float scale){ - -pInvokes.m_ts.fnForest_addItemWithTransform(_ID, data, trans.AsString(), scale); -} + #endregion -#endregion -#region T3D Callbacks + #region Init Persists -#endregion -public Forest_Base (){} -}} + /// + /// The source forest data file. + /// + [MemberGroup("")] + public String dataFile + { + get { return Omni.self.GetVar(_ID + ".dataFile").AsString(); } + set { Omni.self.SetVar(_ID + ".dataFile", value.AsString()); } + } + + /// + /// Scalar applied to the farclip distance when Forest renders into a reflection. + /// + [MemberGroup("Lod")] + public float lodReflectScalar + { + get { return Omni.self.GetVar(_ID + ".lodReflectScalar").AsFloat(); } + set { Omni.self.SetVar(_ID + ".lodReflectScalar", value.AsString()); } + } + + #endregion + + #region Member Functions + + /// + /// () ) + /// + [MemberFunctionConsoleInteraction(true)] + public void clear() + { + m_ts.fn_Forest_clear(_ID); + } + + /// + /// ()) + /// + [MemberFunctionConsoleInteraction(true)] + public bool isDirty() + { + return m_ts.fn_Forest_isDirty(_ID); + } + + /// + /// ()) + /// + [MemberFunctionConsoleInteraction(true)] + public void regenCells() + { + m_ts.fn_Forest_regenCells(_ID); + } + + /// + /// ), saveDataFile( [path] ) ) + /// + [MemberFunctionConsoleInteraction(true)] + public void saveDataFile(string path = null) + { + m_ts.fn_Forest_saveDataFile(_ID, path); + } + + /// + /// .) + /// + [MemberFunctionConsoleInteraction(true)] + public void addItem(string data, Point3F position, float rotation, float scale) + { + m_ts.fnForest_addItem(_ID, data, position.AsString(), rotation, scale); + } + + /// + /// .) + /// + [MemberFunctionConsoleInteraction(true)] + public void addItemWithTransform(string data, TransformF trans, float scale) + { + m_ts.fnForest_addItemWithTransform(_ID, data, trans.AsString(), scale); + } + + #endregion + + #region T3D Callbacks + + #endregion + + public Forest_Base() + { + } + } +} \ No newline at end of file diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GFXSamplerStateData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GFXSamplerStateData_Base.cs index 639e5dda..068e7634 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GFXSamplerStateData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GFXSamplerStateData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GFXStateBlockData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GFXStateBlockData_Base.cs index 8a5ddcdc..83b81863 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GFXStateBlockData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GFXStateBlockData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameBaseData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameBaseData_Base.cs index af4c4655..3bc382e1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameBaseData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameBaseData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameBase_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameBase_Base.cs index e67a3a9a..758d3273 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameBase_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameBase_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameConnection_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameConnection_Base.cs index 1613245c..661780cc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameConnection_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameConnection_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameTSCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameTSCtrl_Base.cs index ea197374..0d658059 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameTSCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GameTSCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GizmoProfile_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GizmoProfile_Base.cs index 832495b8..a548e2cd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GizmoProfile_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GizmoProfile_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Gizmo_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Gizmo_Base.cs index fce859a0..1a2a842e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Gizmo_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Gizmo_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GroundCover_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GroundCover_Base.cs index 4954d0a3..b366ed78 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GroundCover_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GroundCover_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GroundPlane_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GroundPlane_Base.cs index 389c5915..7b833f56 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GroundPlane_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GroundPlane_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiArrayCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiArrayCtrl_Base.cs index e984d353..3f0eaf63 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiArrayCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiArrayCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiAutoCompleteCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiAutoCompleteCtrl_Base.cs index 18166785..1e1f9eab 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiAutoCompleteCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiAutoCompleteCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiAutoScrollCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiAutoScrollCtrl_Base.cs index bcc65dd7..af6bb2a6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiAutoScrollCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiAutoScrollCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBackgroundCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBackgroundCtrl_Base.cs index 9ddd2df5..f1890a32 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBackgroundCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBackgroundCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapBorderCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapBorderCtrl_Base.cs index e4b91199..10c5467f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapBorderCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapBorderCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapButtonCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapButtonCtrl_Base.cs index af735414..10002094 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapButtonCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapButtonCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapButtonTextCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapButtonTextCtrl_Base.cs index b0be6421..c0efb4f3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapButtonTextCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapButtonTextCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapCtrl_Base.cs index 2d05fbd5..dff858a3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBitmapCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBorderButtonCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBorderButtonCtrl_Base.cs index 5a12c1e7..96f1abc8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBorderButtonCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBorderButtonCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBubbleTextCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBubbleTextCtrl_Base.cs index 28f74a66..1177c5f2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBubbleTextCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiBubbleTextCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiButtonBaseCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiButtonBaseCtrl_Base.cs index a2c29cfc..8de59c61 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiButtonBaseCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiButtonBaseCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiButtonCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiButtonCtrl_Base.cs index 4ea6c969..9d93fe30 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiButtonCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiButtonCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCanvas_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCanvas_Base.cs index 0c2340c2..57d1b469 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCanvas_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCanvas_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCheckBoxCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCheckBoxCtrl_Base.cs index d379cc6c..b52606f3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCheckBoxCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCheckBoxCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiChunkedBitmapCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiChunkedBitmapCtrl_Base.cs index bb2b74a5..126f2b95 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiChunkedBitmapCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiChunkedBitmapCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiClockHud_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiClockHud_Base.cs index 806c809d..3ab7f041 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiClockHud_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiClockHud_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiColorPickerCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiColorPickerCtrl_Base.cs index ac32d9fc..d2960f39 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiColorPickerCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiColorPickerCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsoleEditCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsoleEditCtrl_Base.cs index e58537cb..b1497d3f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsoleEditCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsoleEditCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsoleTextCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsoleTextCtrl_Base.cs index e501deac..0e08c53c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsoleTextCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsoleTextCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsole_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsole_Base.cs index 9ba2e170..a4e45e1f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsole_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConsole_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiContainer_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiContainer_Base.cs index 0a7a08a8..5a330732 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiContainer_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiContainer_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControlArrayControl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControlArrayControl_Base.cs index cbf2c12b..57316f71 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControlArrayControl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControlArrayControl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControlProfile_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControlProfile_Base.cs index 47955608..3f9bb226 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControlProfile_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControlProfile_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControl_Base.cs index db89b0de..c0a52d29 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiControl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConvexEditorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConvexEditorCtrl_Base.cs index b8923ded..59e68caf 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConvexEditorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiConvexEditorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCrossHairHud_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCrossHairHud_Base.cs index 73ba792d..19ca8d30 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCrossHairHud_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCrossHairHud_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCursor_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCursor_Base.cs index 453f9478..388888a3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCursor_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiCursor_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDecalEditorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDecalEditorCtrl_Base.cs index 1721178c..5f26307a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDecalEditorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDecalEditorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDecoyCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDecoyCtrl_Base.cs index 2beca056..1bf13662 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDecoyCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDecoyCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDirectoryFileListCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDirectoryFileListCtrl_Base.cs index 0e7e5ead..6b2b639a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDirectoryFileListCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDirectoryFileListCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDragAndDropControl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDragAndDropControl_Base.cs index 4d372baa..797b4f00 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDragAndDropControl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDragAndDropControl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDynamicCtrlArrayControl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDynamicCtrlArrayControl_Base.cs index ea0ff6ee..646dfb56 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDynamicCtrlArrayControl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiDynamicCtrlArrayControl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEaseViewCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEaseViewCtrl_Base.cs index 185ebb1c..15c1f0ef 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEaseViewCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEaseViewCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEditCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEditCtrl_Base.cs index 4baeec48..ff144a7d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEditCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEditCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEditorRuler_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEditorRuler_Base.cs index dd6714fb..bd180799 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEditorRuler_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiEditorRuler_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFadeinBitmapCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFadeinBitmapCtrl_Base.cs index d94ff1ef..85bb40bf 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFadeinBitmapCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFadeinBitmapCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFileTreeCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFileTreeCtrl_Base.cs index 42b1dbea..bb31c6c8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFileTreeCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFileTreeCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFilterCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFilterCtrl_Base.cs index bb2a06c6..2e4e5bf9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFilterCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFilterCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFlexibleArrayControl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFlexibleArrayControl_Base.cs index f4ea08e3..a44a1e22 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFlexibleArrayControl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFlexibleArrayControl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFormCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFormCtrl_Base.cs index 2c9a83ea..06599dcd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFormCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFormCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFrameSetCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFrameSetCtrl_Base.cs index 0618f4f6..7967b46f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFrameSetCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiFrameSetCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListMenuCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListMenuCtrl_Base.cs index f1b8428d..49bc92e2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListMenuCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListMenuCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListMenuProfile_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListMenuProfile_Base.cs index 5caa5bb8..cec89697 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListMenuProfile_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListMenuProfile_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListOptionsCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListOptionsCtrl_Base.cs index 5e0b6925..510845f1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListOptionsCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListOptionsCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListOptionsProfile_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListOptionsProfile_Base.cs index 15b3d74f..e518ed49 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListOptionsProfile_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGameListOptionsProfile_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGradientCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGradientCtrl_Base.cs index 1beae033..fd0b0942 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGradientCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGradientCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGradientSwatchCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGradientSwatchCtrl_Base.cs index e673943b..efc5bf35 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGradientSwatchCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGradientSwatchCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGraphCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGraphCtrl_Base.cs index aab4fe75..2612075d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGraphCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiGraphCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiHealthBarHud_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiHealthBarHud_Base.cs index 8d077f86..154d1a07 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiHealthBarHud_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiHealthBarHud_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiHealthTextHud_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiHealthTextHud_Base.cs index 929979a3..d2a57bf6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiHealthTextHud_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiHealthTextHud_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiIconButtonCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiIconButtonCtrl_Base.cs index 8101b248..02dae3c4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiIconButtonCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiIconButtonCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiIdleCamFadeBitmapCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiIdleCamFadeBitmapCtrl_Base.cs index 94336abe..b1793aa0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiIdleCamFadeBitmapCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiIdleCamFadeBitmapCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiImageList_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiImageList_Base.cs index 246a068a..b533dac3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiImageList_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiImageList_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInputCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInputCtrl_Base.cs index d1400622..674f4214 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInputCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInputCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorCustomField_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorCustomField_Base.cs index 1e1aa860..eb8a6e68 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorCustomField_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorCustomField_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDatablockField_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDatablockField_Base.cs index 80a5d6b5..65cb1498 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDatablockField_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDatablockField_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDynamicField_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDynamicField_Base.cs index 8ecf4d9a..eab5a6c5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDynamicField_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDynamicField_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDynamicGroup_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDynamicGroup_Base.cs index 8d846e95..cc6df29b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDynamicGroup_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorDynamicGroup_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorField_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorField_Base.cs index 742703d0..0237b938 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorField_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorField_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorGroup_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorGroup_Base.cs index 4bba27f5..c998d31c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorGroup_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorGroup_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeBitMask32Helper_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeBitMask32Helper_Base.cs index a2ff9aff..a2c1034d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeBitMask32Helper_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeBitMask32Helper_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeBitMask32_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeBitMask32_Base.cs index d8647219..b3586b29 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeBitMask32_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeBitMask32_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCheckBox_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCheckBox_Base.cs index 58c988e4..2f12303e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCheckBox_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCheckBox_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColorF_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColorF_Base.cs index 14c3a134..f8002d97 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColorF_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColorF_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColorI_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColorI_Base.cs index dceb90f7..d04e0cfe 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColorI_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColorI_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColor_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColor_Base.cs index a746293c..dc42dd09 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColor_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeColor_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCommand_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCommand_Base.cs index 89cf97b4..cb06a38b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCommand_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCommand_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCubemapName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCubemapName_Base.cs index 5daaaad6..672140f3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCubemapName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeCubemapName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeEaseF_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeEaseF_Base.cs index bd9a1b7a..d07470ee 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeEaseF_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeEaseF_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeEnum_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeEnum_Base.cs index b3104987..5ea89ba9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeEnum_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeEnum_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeFileName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeFileName_Base.cs index c889aeb6..923c8dd4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeFileName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeFileName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeGuiControl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeGuiControl_Base.cs index 2e2bef65..171f86ce 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeGuiControl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeGuiControl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeGuiProfile_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeGuiProfile_Base.cs index a729e7f1..005c141c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeGuiProfile_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeGuiProfile_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeImageFileName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeImageFileName_Base.cs index 9a0785b9..f73a57a0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeImageFileName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeImageFileName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeMaterialName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeMaterialName_Base.cs index 60d5c51e..4127a618 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeMaterialName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeMaterialName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeMenuBase_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeMenuBase_Base.cs index b8d311cb..ac734ab2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeMenuBase_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeMenuBase_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeName_Base.cs index c9a7de9d..3c6e87d4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypePrefabFilename_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypePrefabFilename_Base.cs index e3495b73..07e3e19d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypePrefabFilename_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypePrefabFilename_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeRectUV_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeRectUV_Base.cs index 34b42139..d2ca5a07 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeRectUV_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeRectUV_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeRegularMaterialName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeRegularMaterialName_Base.cs index 5121fc5e..5cd49a19 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeRegularMaterialName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeRegularMaterialName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeS32_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeS32_Base.cs index 2e958522..30cf5429 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeS32_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeS32_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXAmbienceName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXAmbienceName_Base.cs index 0a7bff3d..cf4e6947 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXAmbienceName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXAmbienceName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXDescriptionName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXDescriptionName_Base.cs index af01d2e0..4f2dacf7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXDescriptionName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXDescriptionName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXEnvironmentName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXEnvironmentName_Base.cs index ef4d2100..fdff0e65 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXEnvironmentName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXEnvironmentName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXParameterName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXParameterName_Base.cs index 32f71aa8..7bf4214a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXParameterName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXParameterName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXSourceName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXSourceName_Base.cs index b9174056..0e22b81c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXSourceName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXSourceName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXStateName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXStateName_Base.cs index 6ee55e68..c37ffb80 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXStateName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXStateName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXTrackName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXTrackName_Base.cs index da82ffd8..624d587a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXTrackName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeSFXTrackName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeShapeFilename_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeShapeFilename_Base.cs index 3717db9a..d12c41e2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeShapeFilename_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeShapeFilename_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeTerrainMaterialIndex_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeTerrainMaterialIndex_Base.cs index aa815d0f..e056d5e4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeTerrainMaterialIndex_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeTerrainMaterialIndex_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeTerrainMaterialName_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeTerrainMaterialName_Base.cs index 9465118f..98beb425 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeTerrainMaterialName_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorTypeTerrainMaterialName_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorVariableField_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorVariableField_Base.cs index 1801093e..7a27b250 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorVariableField_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorVariableField_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorVariableGroup_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorVariableGroup_Base.cs index edf3d97d..df539f72 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorVariableGroup_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspectorVariableGroup_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspector_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspector_Base.cs index 943af5b1..4ff43f05 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspector_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiInspector_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiListBoxCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiListBoxCtrl_Base.cs index dbeada55..c0c7d8c2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiListBoxCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiListBoxCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMLTextCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMLTextCtrl_Base.cs index 79fd1780..9f5f2062 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMLTextCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMLTextCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMLTextEditCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMLTextEditCtrl_Base.cs index bff300f9..fcc75366 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMLTextEditCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMLTextEditCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMaterialCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMaterialCtrl_Base.cs index f00dccba..ef3a963f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMaterialCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMaterialCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMaterialPreview_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMaterialPreview_Base.cs index 29d357d2..9b44cc68 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMaterialPreview_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMaterialPreview_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuBackgroundCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuBackgroundCtrl_Base.cs index 2c958084..3d7f2014 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuBackgroundCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuBackgroundCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuBar_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuBar_Base.cs index 40197534..207d833f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuBar_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuBar_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuTextListCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuTextListCtrl_Base.cs index 1caf8f0e..ae853247 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuTextListCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMenuTextListCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMeshRoadEditorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMeshRoadEditorCtrl_Base.cs index d9ab049d..d6ecd319 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMeshRoadEditorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMeshRoadEditorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMessageVectorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMessageVectorCtrl_Base.cs index d7c06d05..89188463 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMessageVectorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMessageVectorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMissionAreaCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMissionAreaCtrl_Base.cs index 9c889795..6963f82e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMissionAreaCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMissionAreaCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMissionAreaEditorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMissionAreaEditorCtrl_Base.cs index c029a052..7c121c95 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMissionAreaEditorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMissionAreaEditorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMouseEventCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMouseEventCtrl_Base.cs index 348af12e..917e09d3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMouseEventCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiMouseEventCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiNavEditorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiNavEditorCtrl_Base.cs index 92b5cede..c40f8ae0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiNavEditorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiNavEditorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiNoMouseCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiNoMouseCtrl_Base.cs index 07076171..1d0e5b05 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiNoMouseCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiNoMouseCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiObjectView_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiObjectView_Base.cs index b15ad86d..5fae6869 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiObjectView_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiObjectView_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPaneControl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPaneControl_Base.cs index fff31dde..bfa586df 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPaneControl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPaneControl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPanel_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPanel_Base.cs index 62d86909..ab58586b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPanel_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPanel_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiParticleGraphCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiParticleGraphCtrl_Base.cs index 0559f749..b887c1ef 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiParticleGraphCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiParticleGraphCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopUpMenuCtrlEx_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopUpMenuCtrlEx_Base.cs index fac817ce..a7877fa6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopUpMenuCtrlEx_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopUpMenuCtrlEx_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopUpMenuCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopUpMenuCtrl_Base.cs index 43b8f717..dfa49062 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopUpMenuCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopUpMenuCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopupTextListCtrlEx_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopupTextListCtrlEx_Base.cs index 960cfca7..f40a0546 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopupTextListCtrlEx_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopupTextListCtrlEx_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopupTextListCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopupTextListCtrl_Base.cs index ca9f5f5a..7bfa8de9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopupTextListCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiPopupTextListCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiProgressBitmapCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiProgressBitmapCtrl_Base.cs index bf83d4fa..0ceb445c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiProgressBitmapCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiProgressBitmapCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiProgressCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiProgressCtrl_Base.cs index 3c9f1be3..b9ee8e17 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiProgressCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiProgressCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRadioCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRadioCtrl_Base.cs index 8032ee63..71c03505 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRadioCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRadioCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRectHandles_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRectHandles_Base.cs index 23639bb9..011f728a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRectHandles_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRectHandles_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRiverEditorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRiverEditorCtrl_Base.cs index ab614e4f..bf994947 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRiverEditorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRiverEditorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRoadEditorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRoadEditorCtrl_Base.cs index 7027a447..57d04370 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRoadEditorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRoadEditorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRolloutCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRolloutCtrl_Base.cs index 12ce3185..57628ebf 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRolloutCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiRolloutCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiScriptNotifyCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiScriptNotifyCtrl_Base.cs index f4dd33ce..8753b833 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiScriptNotifyCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiScriptNotifyCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiScrollCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiScrollCtrl_Base.cs index eabef084..ae8df3e9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiScrollCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiScrollCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSeparatorCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSeparatorCtrl_Base.cs index ded4818c..316ee1d3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSeparatorCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSeparatorCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiShapeEdPreview_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiShapeEdPreview_Base.cs index 925dc25c..a1145423 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiShapeEdPreview_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiShapeEdPreview_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiShapeNameHud_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiShapeNameHud_Base.cs index 311799c5..8f8ce091 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiShapeNameHud_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiShapeNameHud_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSliderCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSliderCtrl_Base.cs index a409b41a..b151cb91 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSliderCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSliderCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSpeedometerHud_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSpeedometerHud_Base.cs index 19a628fd..43229219 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSpeedometerHud_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSpeedometerHud_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSplitContainer_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSplitContainer_Base.cs index d070caa7..95ea76d4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSplitContainer_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSplitContainer_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiStackControl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiStackControl_Base.cs index 4f4a4d8a..a4e1c860 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiStackControl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiStackControl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSubmenuBackgroundCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSubmenuBackgroundCtrl_Base.cs index c9959655..f6490cb0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSubmenuBackgroundCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSubmenuBackgroundCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSwatchButtonCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSwatchButtonCtrl_Base.cs index 4d7c16f8..85a2fccd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSwatchButtonCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiSwatchButtonCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTSCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTSCtrl_Base.cs index 55437c9b..dbd8281a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTSCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTSCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTabBookCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTabBookCtrl_Base.cs index 80b1a48e..aa20512e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTabBookCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTabBookCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTabPageCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTabPageCtrl_Base.cs index c4ca8486..3c306c67 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTabPageCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTabPageCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTableControl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTableControl_Base.cs index e4f709f9..587fbd56 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTableControl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTableControl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTerrPreviewCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTerrPreviewCtrl_Base.cs index 584855c2..e8110cf9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTerrPreviewCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTerrPreviewCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextCtrl_Base.cs index 92b4913f..a538d771 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditCtrl_Base.cs index 13f3d046..54b752c9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditSliderBitmapCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditSliderBitmapCtrl_Base.cs index 682650a6..b77a2ea2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditSliderBitmapCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditSliderBitmapCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditSliderCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditSliderCtrl_Base.cs index 88402bf0..582b48b4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditSliderCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextEditSliderCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextListCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextListCtrl_Base.cs index fb542bf7..b05d4996 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextListCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTextListCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTheoraCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTheoraCtrl_Base.cs index ed6018e5..a5e4fbb8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTheoraCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTheoraCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTickCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTickCtrl_Base.cs index 2d4e80ae..9991ed04 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTickCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTickCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiToggleButtonCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiToggleButtonCtrl_Base.cs index c62bd777..7a92e5cb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiToggleButtonCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiToggleButtonCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiToolboxButtonCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiToolboxButtonCtrl_Base.cs index a80afdbb..369cf78a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiToolboxButtonCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiToolboxButtonCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTreeViewCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTreeViewCtrl_Base.cs index 61a4e806..f253f018 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTreeViewCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiTreeViewCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiVariableInspector_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiVariableInspector_Base.cs index 33f6424c..a1f5f607 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiVariableInspector_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiVariableInspector_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiWindowCollapseCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiWindowCollapseCtrl_Base.cs index 8e6d8856..15ccb8ad 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiWindowCollapseCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiWindowCollapseCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiWindowCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiWindowCtrl_Base.cs index 4e1a719c..ad991b1d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiWindowCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/GuiWindowCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HTTPObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HTTPObject_Base.cs index 7c129c4b..2bcd072e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HTTPObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HTTPObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HoverVehicleData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HoverVehicleData_Base.cs index 953bb38f..6a8654b5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HoverVehicleData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HoverVehicleData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HoverVehicle_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HoverVehicle_Base.cs index 96355cc3..6040582b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HoverVehicle_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/HoverVehicle_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/InspectorFieldUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/InspectorFieldUndoAction_Base.cs index db6a09d3..6a595a05 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/InspectorFieldUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/InspectorFieldUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ItemData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ItemData_Base.cs index ee44aa93..014b94c4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ItemData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ItemData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Item_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Item_Base.cs index f748be96..60e04596 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Item_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Item_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LangTable_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LangTable_Base.cs index 7abe0d1b..1c1eb85c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LangTable_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LangTable_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LeapMotionFrame_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LeapMotionFrame_Base.cs index e6335c2a..e1971086 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LeapMotionFrame_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LeapMotionFrame_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LevelInfo_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LevelInfo_Base.cs index 4699ebd5..9bc52e30 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LevelInfo_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LevelInfo_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightAnimData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightAnimData_Base.cs index 6933227d..a81b97d9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightAnimData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightAnimData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightBase_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightBase_Base.cs index 47ae6793..f83486dd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightBase_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightBase_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightDescription_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightDescription_Base.cs index 697f3022..8de174ee 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightDescription_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightDescription_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightFlareData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightFlareData_Base.cs index 4ed59f01..5ca4b71c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightFlareData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightFlareData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightningData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightningData_Base.cs index e353639b..466706ce 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightningData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/LightningData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Lightning_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Lightning_Base.cs index 1564f793..88a8ba7a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Lightning_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Lightning_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MECreateUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MECreateUndoAction_Base.cs index 69e28e58..e6afa962 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MECreateUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MECreateUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MEDeleteUndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MEDeleteUndoAction_Base.cs index 5701319a..46ba94f6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MEDeleteUndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MEDeleteUndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Marker_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Marker_Base.cs index 55e9dbc2..bbab4bbd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Marker_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Marker_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Material_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Material_Base.cs index 1b8a08ab..632e2942 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Material_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Material_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MenuBar_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MenuBar_Base.cs index 4a5404ed..0c8f85e3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MenuBar_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MenuBar_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MeshRoad_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MeshRoad_Base.cs index 9c98949a..e01b5163 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MeshRoad_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MeshRoad_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MessageForwarder_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MessageForwarder_Base.cs index e0302742..6501bdb7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MessageForwarder_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MessageForwarder_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MessageVector_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MessageVector_Base.cs index 707fb52b..3ebee146 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MessageVector_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MessageVector_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Message_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Message_Base.cs index 62ed6edc..e0615c52 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Message_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Message_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionArea_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionArea_Base.cs index 017f373d..61e3b40b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionArea_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionArea_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionMarkerData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionMarkerData_Base.cs index 440af003..65eff0b5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionMarkerData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionMarkerData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionMarker_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionMarker_Base.cs index 062360d7..a23a93fb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionMarker_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MissionMarker_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MoreAdvancedComponent_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MoreAdvancedComponent_Base.cs index ea1ecca2..7f18efc4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MoreAdvancedComponent_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/MoreAdvancedComponent_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NavMesh_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NavMesh_Base.cs index 7d3e9914..0b6f6184 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NavMesh_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NavMesh_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NavPath_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NavPath_Base.cs index 920923c8..c5fb4eff 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NavPath_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NavPath_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NetConnection_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NetConnection_Base.cs index 8149b771..d61f5e70 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NetConnection_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NetConnection_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NetObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NetObject_Base.cs index b75efbc7..ea4dc6a8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NetObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/NetObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/OpenFileDialog_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/OpenFileDialog_Base.cs index d43f930e..87924ca5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/OpenFileDialog_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/OpenFileDialog_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/OpenFolderDialog_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/OpenFolderDialog_Base.cs index d561a9d5..73cd9d93 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/OpenFolderDialog_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/OpenFolderDialog_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleData_Base.cs index 7c6bd007..787f36ae 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterData_Base.cs index 1847bc27..d90d8c22 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterNodeData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterNodeData_Base.cs index b74f6a08..fadb60b8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterNodeData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterNodeData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterNode_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterNode_Base.cs index adf48eac..ae949be5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterNode_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitterNode_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitter_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitter_Base.cs index 1dea7538..37f313bb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitter_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ParticleEmitter_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PathCameraData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PathCameraData_Base.cs index 8e6ae225..462ac038 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PathCameraData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PathCameraData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PathCamera_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PathCamera_Base.cs index 09fe6401..995e471b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PathCamera_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PathCamera_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Path_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Path_Base.cs index 81022bba..c2e3640a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Path_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Path_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PersistenceManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PersistenceManager_Base.cs index 30d53115..6251f2f1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PersistenceManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PersistenceManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicalZone_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicalZone_Base.cs index 982d9150..b6c10137 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicalZone_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicalZone_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsDebrisData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsDebrisData_Base.cs index 3aa3e559..6c7a9458 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsDebrisData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsDebrisData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsDebris_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsDebris_Base.cs index ef07c165..7c299efc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsDebris_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsDebris_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsForce_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsForce_Base.cs index 45ed96f1..905a7b86 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsForce_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsForce_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsShapeData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsShapeData_Base.cs index 529cdf8d..9f734e8c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsShapeData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsShapeData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsShape_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsShape_Base.cs index 977a553e..af2f005b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsShape_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PhysicsShape_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PlayerData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PlayerData_Base.cs index 2318dfe0..424d61b7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PlayerData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PlayerData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Player_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Player_Base.cs index dfb9c467..9f675f7d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Player_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Player_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PointLight_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PointLight_Base.cs index 94c86f09..94a8a80d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PointLight_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PointLight_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PopupMenu_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PopupMenu_Base.cs index 38125aa8..a618b920 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PopupMenu_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PopupMenu_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PopupTextListCtrl_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PopupTextListCtrl_Base.cs index 44a0734e..31ccbf72 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PopupTextListCtrl_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PopupTextListCtrl_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PostEffect_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PostEffect_Base.cs index 7899be76..eaa6c09a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PostEffect_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PostEffect_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PrecipitationData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PrecipitationData_Base.cs index 45c4a955..5a8ceedf 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PrecipitationData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PrecipitationData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Precipitation_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Precipitation_Base.cs index 49f85671..38171688 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Precipitation_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Precipitation_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Prefab_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Prefab_Base.cs index 0bbd78fa..952485d2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Prefab_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Prefab_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProjectileData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProjectileData_Base.cs index 3243ddfd..1f863256 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProjectileData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProjectileData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Projectile_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Projectile_Base.cs index e55743cc..1f89ec83 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Projectile_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Projectile_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProximityMineData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProximityMineData_Base.cs index 329a31ee..6ff92d45 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProximityMineData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProximityMineData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProximityMine_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProximityMine_Base.cs index 6824f7f7..593a6c16 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProximityMine_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ProximityMine_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxCloth_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxCloth_Base.cs index 913ca338..2af6a4a9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxCloth_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxCloth_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxFluid_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxFluid_Base.cs index 01d3f5e7..79bb5a0e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxFluid_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxFluid_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMaterial_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMaterial_Base.cs index 76b7b843..3a6d5a89 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMaterial_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMaterial_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMultiActorData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMultiActorData_Base.cs index 3d45d0f0..bc8628ca 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMultiActorData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMultiActorData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMultiActor_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMultiActor_Base.cs index 3de1bb9d..a84c6158 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMultiActor_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/PxMultiActor_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RazerHydraFrame_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RazerHydraFrame_Base.cs index db376197..7f45464f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RazerHydraFrame_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RazerHydraFrame_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ReadXML_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ReadXML_Base.cs index bcda059a..39dd00cc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ReadXML_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ReadXML_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ReflectorDesc_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ReflectorDesc_Base.cs index fddd4103..a62195a0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ReflectorDesc_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ReflectorDesc_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderBinManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderBinManager_Base.cs index 113a978e..6075d084 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderBinManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderBinManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderFormatToken_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderFormatToken_Base.cs index dd57e3e0..c13ebedf 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderFormatToken_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderFormatToken_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderGlowMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderGlowMgr_Base.cs index d4734245..67f26c44 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderGlowMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderGlowMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderImposterMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderImposterMgr_Base.cs index 6870746f..a058d04a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderImposterMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderImposterMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderMeshExample_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderMeshExample_Base.cs index dd17813d..39e4075b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderMeshExample_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderMeshExample_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderMeshMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderMeshMgr_Base.cs index 56093aa1..d309a2c8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderMeshMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderMeshMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderObjectExample_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderObjectExample_Base.cs index 43e517c8..15b328ca 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderObjectExample_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderObjectExample_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderObjectMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderObjectMgr_Base.cs index 7496864a..afe8f359 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderObjectMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderObjectMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderOcclusionMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderOcclusionMgr_Base.cs index cd50bb36..75d39aff 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderOcclusionMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderOcclusionMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderParticleMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderParticleMgr_Base.cs index 66a2c1b7..c3fef87f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderParticleMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderParticleMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassManager_Base.cs index 07ecb29d..b413df60 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassStateBin_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassStateBin_Base.cs index c4e537f8..9296c4cb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassStateBin_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassStateBin_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassStateToken_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassStateToken_Base.cs index 193aca93..50a23904 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassStateToken_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPassStateToken_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPrePassMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPrePassMgr_Base.cs index 86ec26e5..4f22dd09 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPrePassMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderPrePassMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderShapeExample_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderShapeExample_Base.cs index 286776a8..5f53aa2e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderShapeExample_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderShapeExample_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTerrainMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTerrainMgr_Base.cs index 17ffa380..b5ad4ac3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTerrainMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTerrainMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTexTargetBinManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTexTargetBinManager_Base.cs index c482819a..18629f19 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTexTargetBinManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTexTargetBinManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTranslucentMgr_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTranslucentMgr_Base.cs index e6a87c4b..a248332c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTranslucentMgr_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RenderTranslucentMgr_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RigidShapeData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RigidShapeData_Base.cs index 82b4cfbb..75a56ffa 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RigidShapeData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RigidShapeData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RigidShape_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RigidShape_Base.cs index 0ae8f06d..c7721b0a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RigidShape_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/RigidShape_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/River_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/River_Base.cs index a3836941..3c03d839 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/River_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/River_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXAmbience_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXAmbience_Base.cs index cdb61529..89465313 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXAmbience_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXAmbience_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXController_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXController_Base.cs index b308b924..ef6d89dc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXController_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXController_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXDescription_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXDescription_Base.cs index e80f6712..01d0d894 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXDescription_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXDescription_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXEmitter_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXEmitter_Base.cs index 741f471c..4f50fa80 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXEmitter_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXEmitter_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXEnvironment_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXEnvironment_Base.cs index 350592e5..a4b607d2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXEnvironment_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXEnvironment_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEventGroup_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEventGroup_Base.cs index 73f1e2d0..2ce44f23 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEventGroup_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEventGroup_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEventSource_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEventSource_Base.cs index c686e862..b24c3c49 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEventSource_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEventSource_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEvent_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEvent_Base.cs index d50499de..f2c64482 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEvent_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODEvent_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODProject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODProject_Base.cs index d7c495e2..9fd8f201 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODProject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXFMODProject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXParameter_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXParameter_Base.cs index 01161abd..86d7d494 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXParameter_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXParameter_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXPlayList_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXPlayList_Base.cs index e6bb0c62..81996fd7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXPlayList_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXPlayList_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXProfile_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXProfile_Base.cs index a3577398..9be16a62 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXProfile_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXProfile_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXSound_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXSound_Base.cs index 531bf693..4a59f3b5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXSound_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXSound_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXSource_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXSource_Base.cs index f0db3414..2d495d3a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXSource_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXSource_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXState_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXState_Base.cs index 46acc65b..c378766e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXState_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXState_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXTrack_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXTrack_Base.cs index 1baeee3e..e60c1d80 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXTrack_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SFXTrack_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SaveFileDialog_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SaveFileDialog_Base.cs index 8e6afb6e..a7dab222 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SaveFileDialog_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SaveFileDialog_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScatterSky_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScatterSky_Base.cs index 3cd6fb5a..9391be31 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScatterSky_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScatterSky_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneLighting_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneLighting_Base.cs index 71886a0e..14706854 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneLighting_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneLighting_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneObject_Base.cs index 375d5199..2c468eeb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneRootZone_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneRootZone_Base.cs index 1490455f..e7aefd8f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneRootZone_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneRootZone_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneSimpleZone_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneSimpleZone_Base.cs index 4b95200e..95c44900 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneSimpleZone_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneSimpleZone_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneSpace_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneSpace_Base.cs index a7a9fc45..6fba8957 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneSpace_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneSpace_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneZoneSpace_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneZoneSpace_Base.cs index c1ae84df..1d1f0bf1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneZoneSpace_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SceneZoneSpace_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScopeAlwaysShape_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScopeAlwaysShape_Base.cs index a046f14f..facad36a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScopeAlwaysShape_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScopeAlwaysShape_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptGroup_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptGroup_Base.cs index 482b1536..d9759fc8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptGroup_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptGroup_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptMsgListener_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptMsgListener_Base.cs index b3561d2d..a5061ae6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptMsgListener_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptMsgListener_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptObject_Base.cs index aa884596..ac204f6b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptTickObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptTickObject_Base.cs index 99348629..ac724a12 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptTickObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ScriptTickObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Settings_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Settings_Base.cs index 93a7ca46..922395c9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Settings_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Settings_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShaderData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShaderData_Base.cs index 27b29b3a..35e84b37 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShaderData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShaderData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShadowRenderPassManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShadowRenderPassManager_Base.cs index 5a6538af..db02d3fd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShadowRenderPassManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShadowRenderPassManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBaseData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBaseData_Base.cs index b0a0c415..78966c7f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBaseData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBaseData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBaseImageData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBaseImageData_Base.cs index ff89bf49..de5b3256 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBaseImageData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBaseImageData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBase_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBase_Base.cs index 87692fda..0ea2c7bd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBase_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ShapeBase_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimComponent_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimComponent_Base.cs index cfef9185..d69d07fe 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimComponent_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimComponent_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimDataBlock_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimDataBlock_Base.cs index 8f82d9ff..57f6becf 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimDataBlock_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimDataBlock_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimGroup_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimGroup_Base.cs index 845d0e34..1dec111d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimGroup_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimGroup_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimObject_Base.cs index 9b706770..154aa970 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimPersistSet_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimPersistSet_Base.cs index 3573f761..3825ecf6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimPersistSet_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimPersistSet_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimResponseCurve_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimResponseCurve_Base.cs index 2d44de30..b4a1c65c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimResponseCurve_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimResponseCurve_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimSet_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimSet_Base.cs index cc863c58..7424940d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimSet_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimSet_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimXMLDocument_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimXMLDocument_Base.cs index c3b6150d..13710f77 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimXMLDocument_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimXMLDocument_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimpleComponent_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimpleComponent_Base.cs index 73353f7c..84e6b3a1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimpleComponent_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimpleComponent_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimpleNetObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimpleNetObject_Base.cs index 034918f7..644e72ee 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimpleNetObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SimpleNetObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SkyBox_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SkyBox_Base.cs index 681a529e..5a37f165 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SkyBox_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SkyBox_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SpawnSphere_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SpawnSphere_Base.cs index b70ce8d8..25d9fc5d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SpawnSphere_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SpawnSphere_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SplashData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SplashData_Base.cs index 48f71d59..84035332 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SplashData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SplashData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Splash_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Splash_Base.cs index 63631b9e..9c33fbc5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Splash_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Splash_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SpotLight_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SpotLight_Base.cs index 6c1dcc5b..02c6cd56 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SpotLight_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/SpotLight_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StaticShapeData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StaticShapeData_Base.cs index 2988d560..dfe9cdf5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StaticShapeData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StaticShapeData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StaticShape_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StaticShape_Base.cs index 2a931d26..5a9c64bc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StaticShape_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StaticShape_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StreamObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StreamObject_Base.cs index 3e60a422..bd180c1a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StreamObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/StreamObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Sun_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Sun_Base.cs index 73cbcaec..1a9530c5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Sun_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Sun_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/T3DSceneClient_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/T3DSceneClient_Base.cs index 1970c0a5..85ccb631 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/T3DSceneClient_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/T3DSceneClient_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/T3DSceneComponent_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/T3DSceneComponent_Base.cs index dc68f30f..6946b791 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/T3DSceneComponent_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/T3DSceneComponent_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TCPObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TCPObject_Base.cs index 839b440b..9802d6e8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TCPObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TCPObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSAttachable_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSAttachable_Base.cs index 64dd5b39..5b740d91 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSAttachable_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSAttachable_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSDynamic_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSDynamic_Base.cs index d4b35475..832bca36 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSDynamic_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSDynamic_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSForestItemData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSForestItemData_Base.cs index fe097ce1..3d2a9f93 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSForestItemData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSForestItemData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSPathShape_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSPathShape_Base.cs index a173c3ee..44148053 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSPathShape_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSPathShape_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSShapeConstructor_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSShapeConstructor_Base.cs index 5d9b2923..a336eb8b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSShapeConstructor_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSShapeConstructor_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSStatic_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSStatic_Base.cs index bcbb2644..4761683b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSStatic_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TSStatic_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainBlock_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainBlock_Base.cs index b48e45ee..547fae23 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainBlock_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainBlock_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainEditor_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainEditor_Base.cs index 1e8740c3..53ba769e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainEditor_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainEditor_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainMaterial_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainMaterial_Base.cs index a4ec2b70..ef474cde 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainMaterial_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainMaterial_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainSmoothAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainSmoothAction_Base.cs index d196095e..4f48f293 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainSmoothAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainSmoothAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainSolderEdgesAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainSolderEdgesAction_Base.cs index 253f25b2..7da3bff7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainSolderEdgesAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TerrainSolderEdgesAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TheoraTextureObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TheoraTextureObject_Base.cs index 77c6f6b8..87839e71 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TheoraTextureObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TheoraTextureObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TimeOfDay_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TimeOfDay_Base.cs index 8280458c..2f852f1a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TimeOfDay_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TimeOfDay_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TriggerData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TriggerData_Base.cs index eeccf19c..4d4b47b5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TriggerData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TriggerData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Trigger_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Trigger_Base.cs index 4771832f..abd083d1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Trigger_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Trigger_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TurretShapeData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TurretShapeData_Base.cs index 6e0103cc..173eefd3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TurretShapeData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TurretShapeData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TurretShape_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TurretShape_Base.cs index 14fe47d3..a30865a6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TurretShape_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/TurretShape_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoAction_Base.cs index f014c02a..b2f35596 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoManager_Base.cs index 8b34ed50..1abfcb7b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoScriptAction_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoScriptAction_Base.cs index 9f0a017e..007399e5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoScriptAction_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/UndoScriptAction_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VehicleBlocker_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VehicleBlocker_Base.cs index 78194198..6c3903ab 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VehicleBlocker_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VehicleBlocker_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VehicleData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VehicleData_Base.cs index 7076e4e2..a5a8ed4d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VehicleData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VehicleData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Vehicle_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Vehicle_Base.cs index 94e48df9..4119fb85 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Vehicle_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/Vehicle_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VolumetricFogRTManager_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VolumetricFogRTManager_Base.cs index 52670087..c435f32a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VolumetricFogRTManager_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VolumetricFogRTManager_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VolumetricFog_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VolumetricFog_Base.cs index 242a46fe..f59484c2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VolumetricFog_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/VolumetricFog_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WalkableShape_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WalkableShape_Base.cs index 50717487..4c075beb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WalkableShape_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WalkableShape_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterBlock_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterBlock_Base.cs index 34471c0b..3247871b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterBlock_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterBlock_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterObject_Base.cs index be7925c2..c357c1d1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterPlane_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterPlane_Base.cs index a6a68e47..55acd24c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterPlane_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WaterPlane_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WayPoint_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WayPoint_Base.cs index 9f213cfb..1ca18e10 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WayPoint_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WayPoint_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleData_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleData_Base.cs index 7e798455..a0aba033 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleData_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleData_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleSpring_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleSpring_Base.cs index fcf4be49..ffd4b7ea 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleSpring_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleSpring_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleTire_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleTire_Base.cs index f1b0e026..2f63caf6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleTire_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicleTire_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicle_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicle_Base.cs index e7fa4663..288f4bfd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicle_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WheeledVehicle_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WorldEditorSelection_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WorldEditorSelection_Base.cs index ae36a3c7..5e725a86 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WorldEditorSelection_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WorldEditorSelection_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WorldEditor_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WorldEditor_Base.cs index 13319fa2..1fdd6d0b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WorldEditor_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/WorldEditor_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ZipObject_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ZipObject_Base.cs index 607cdb2b..ff5e0304 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ZipObject_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/ZipObject_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxFoliageReplicator_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxFoliageReplicator_Base.cs index 70607cff..e645a351 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxFoliageReplicator_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxFoliageReplicator_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxShapeReplicatedStatic_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxShapeReplicatedStatic_Base.cs index bb73469c..e3c90ba0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxShapeReplicatedStatic_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxShapeReplicatedStatic_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxShapeReplicator_Base.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxShapeReplicator_Base.cs index f4b45eb3..875d030d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxShapeReplicator_Base.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.Base/fxShapeReplicator_Base.cs @@ -16,10 +16,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; +using WinterLeaf.Demo.Full.Models.User.Extendable; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.Base +namespace WinterLeaf.Demo.Full.Models.Base { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/Audio.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/Audio.cs index 8eef5a0e..20cd6942 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/Audio.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/Audio.cs @@ -8,11 +8,9 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.CustomObjects.Utilities { public class Audio { - public static pInvokes tst = new pInvokes(); - static public void AudioServerPlay2D(string profile) { - foreach (GameConnection clientid in tst.ClientGroup) + foreach (GameConnection clientid in pInvokes.ClientGroup) clientid.play2D(profile); } @@ -20,7 +18,7 @@ static public void AudioServerPlay2D(string profile) static public void AudioServerPlay3D(string profile, TransformF transform) { - foreach (GameConnection clientid in tst.ClientGroup) + foreach (GameConnection clientid in pInvokes.ClientGroup) clientid.play3D(profile, transform); } } diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/RadiusDamage.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/RadiusDamage.cs index 33259829..39c130da 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/RadiusDamage.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/RadiusDamage.cs @@ -11,14 +11,12 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.CustomObjects.Utilities { class radiusDamage { - private static pInvokes tst = new pInvokes(); - public static void RadiusDamage(GameBase sourceobject, Point3F position, float radius, float damage, string damageType, float impulse) { // Use the container system to iterate through all the objects // within our explosion radius. We'll apply damage to all ShapeBase // objects. - Dictionary r = tst.console.initContainerRadiusSearch(position, radius, (uint)SceneObjectTypesAsUint.ShapeBaseObjectType); + Dictionary r = pInvokes.console.initContainerRadiusSearch(position, radius, (uint)SceneObjectTypesAsUint.ShapeBaseObjectType); float halfRadius = radius / (float)2.0; foreach (ShapeBase targetObject in r.Keys) { @@ -29,7 +27,7 @@ public static void RadiusDamage(GameBase sourceobject, Point3F position, float r UInt32 mask = (uint)SceneObjectTypesAsUint.TerrainObjectType | (uint)SceneObjectTypesAsUint.StaticShapeObjectType | (uint)SceneObjectTypesAsUint.VehicleObjectType ; - float coverage = tst.Util.calcExplosionCoverage(new Point3F(position), targetObject, mask); + float coverage = pInvokes.Util.calcExplosionCoverage(new Point3F(position), targetObject, mask); if (!coverage.AsBool()) continue; float dist = r[targetObject]; diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/message.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/message.cs index e284dc88..47bf0b0e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/message.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/CustomObjects/Utilities/message.cs @@ -17,34 +17,32 @@ class message static int SPAM_PENALTY_PERIOD = 10000; static private string _SPAM_MESSAGE = ""; - private static pInvokes tst = new pInvokes(); - public static string SPAM_MESSAGE { get { if (_SPAM_MESSAGE == "") - _SPAM_MESSAGE = tst.console.ColorEncode(@"\c3FLOOD PROTECTION:\cr You must wait another %1 seconds."); + _SPAM_MESSAGE = pInvokes.console.ColorEncode(@"\c3FLOOD PROTECTION:\cr You must wait another %1 seconds."); return _SPAM_MESSAGE; } } static public void MessageTeam(string team, string msgType, string msgString, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { - foreach (GameConnection clientid in tst.ClientGroup.Where(clientid => ((GameConnection)clientid)["team"] == team)) + foreach (GameConnection clientid in pInvokes.ClientGroup.Where(clientid => ((GameConnection)clientid)["team"] == team)) MessageClient(clientid, msgType, msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); } static public void MessageTeamExcept(GameConnection client, string msgType, string msgString, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { string team = client["team"]; - foreach (GameConnection clientid in tst.ClientGroup.Where(clientid => client["team"] == team && (clientid != client))) + foreach (GameConnection clientid in pInvokes.ClientGroup.Where(clientid => client["team"] == team && (clientid != client))) MessageClient(clientid, msgType, msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); } static public void MessageAllExcept(string client, string team, string msgtype, string msgstring, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { - foreach (GameConnection recipient in tst.ClientGroup.Where(recipient => ((GameConnection)recipient != client) && ((GameConnection)recipient)["team"] != team)) + foreach (GameConnection recipient in pInvokes.ClientGroup.Where(recipient => ((GameConnection)recipient != client) && ((GameConnection)recipient)["team"] != team)) MessageClient(recipient, msgtype, msgstring, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); } @@ -61,13 +59,13 @@ static public void GameConnectionspamReset(GameConnection thisobj) static public bool SpamAlert(GameConnection client) { - if (!tst.bGlobal["$Pref::Server::FloodProtectionEnabled"]) + if (!pInvokes.bGlobal["$Pref::Server::FloodProtectionEnabled"]) return false; if (!client["isSpamming"].AsBool() && client["spamMessageCount"].AsInt() >= SPAM_MESSAGE_THRESHOLD) { - tst.console.error("Client " + client + " is spamming, message count = " + client["spamMessageCount"]); - client["spamProtectStart"] = tst.console.getSimTime().AsString(); + pInvokes.console.error("Client " + client + " is spamming, message count = " + client["spamMessageCount"]); + client["spamProtectStart"] = pInvokes.console.getSimTime().AsString(); client["isSpamming"] = true.AsString(); using (BackgroundWorker bwr_SPAM_PENALTY_PERIOD = new BackgroundWorker()) { @@ -78,7 +76,7 @@ static public bool SpamAlert(GameConnection client) if (client["isSpamming"].AsBool()) { - double wait = Math.Floor((SPAM_PENALTY_PERIOD - (tst.console.getSimTime() - client["spamProtectStart"].AsDouble()) / 1000)); + double wait = Math.Floor((SPAM_PENALTY_PERIOD - (pInvokes.console.getSimTime() - client["spamProtectStart"].AsDouble()) / 1000)); MessageClient(client, "", SPAM_MESSAGE, wait.AsString()); return true; } @@ -89,7 +87,7 @@ static public bool SpamAlert(GameConnection client) bwrSPAM_PROTECTION_PERIOD.DoWork += new DoWorkEventHandler(bwrSPAM_PROTECTION_PERIOD_DoWork); } - + return false; @@ -128,9 +126,9 @@ static void bwr_SPAM_PENALTY_PERIOD_DoWork(object sender, DoWorkEventArgs e) static public void ChatMessageClient(GameConnection client, GameConnection sender, string voiceTag, string voicePitch, string msgString, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "") { - if (tst.console.isObject(client)) + if (pInvokes.console.isObject(client)) if (!client["muted[" + sender + "]"].AsBool()) - tst.console.commandToClient(client, "ChatMessage", new string[] { sender, voiceTag, voicePitch, tst.console.addTaggedString(msgString), a1, a2, a3, a4, a5, a6, a7, a8, a9, a10 }); + pInvokes.console.commandToClient(client, "ChatMessage", new string[] { sender, voiceTag, voicePitch, pInvokes.console.addTaggedString(msgString), a1, a2, a3, a4, a5, a6, a7, a8, a9, a10 }); } static public void ChatMessageTeam(GameConnection sender, string team, string msgString, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "") @@ -138,15 +136,15 @@ static public void ChatMessageTeam(GameConnection sender, string team, string ms if ((msgString.Trim().Length == 0) || SpamAlert(sender)) return; - foreach (GameConnection obj in tst.ClientGroup.Where(obj => ((GameConnection)obj)["team"] == sender["team"])) - ChatMessageClient(obj, sender, tst.console.GetVarString(string.Format("{0}.voiceTag", sender)), tst.console.GetVarString(string.Format("{0}.voicePitch", sender)), msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); + foreach (GameConnection obj in pInvokes.ClientGroup.Where(obj => ((GameConnection)obj)["team"] == sender["team"])) + ChatMessageClient(obj, sender, pInvokes.console.GetVarString(string.Format("{0}.voiceTag", sender)), pInvokes.console.GetVarString(string.Format("{0}.voicePitch", sender)), msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); } static public void ChatMessageAll(GameConnection sender, string msgString, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "") { if ((msgString.Trim().Length == 0) || SpamAlert(sender)) return; - foreach (GameConnection obj in tst.ClientGroup) + foreach (GameConnection obj in pInvokes.ClientGroup) { if (sender["team"].AsInt() != 0) ChatMessageClient(obj, sender, sender["voiceTag"], sender["voicePitch"], msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); @@ -161,22 +159,22 @@ static public void ChatMessageAll(GameConnection sender, string msgString, strin static public void MessageClient(GameConnection client, string msgtype, string msgstring, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { - string function = tst.console.addTaggedString("ServerMessage"); + string function = pInvokes.console.addTaggedString("ServerMessage"); string tmsgtype = ""; if (msgtype.Length > 0) - tmsgtype = (byte)msgtype[0] == (byte)1 ? msgtype : tst.console.addTaggedString(msgtype); + tmsgtype = (byte)msgtype[0] == (byte)1 ? msgtype : pInvokes.console.addTaggedString(msgtype); string tmsgstring = ""; if (msgstring.Length > 0) - tmsgstring = (byte)msgstring[0] == (byte)1 ? msgstring : tst.console.addTaggedString(msgstring); - if (tst.console.isObject(client)) - tst.console.commandToClient(client, function, new[] { tmsgtype, tmsgstring, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13 }); + tmsgstring = (byte)msgstring[0] == (byte)1 ? msgstring : pInvokes.console.addTaggedString(msgstring); + if (pInvokes.console.isObject(client)) + pInvokes.console.commandToClient(client, function, new[] { tmsgtype, tmsgstring, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13 }); } static public void MessageAll(string msgtype, string msgstring, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { - foreach (GameConnection clientid in tst.ClientGroup) + foreach (GameConnection clientid in pInvokes.ClientGroup) MessageClient(clientid, msgtype, msgstring, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); } diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIClient.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIClient.cs index df9ee980..e779f69f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIClient.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIClient.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIConnection.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIConnection.cs index 9cf45662..605f2f10 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIConnection.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIConnection.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIPlayer.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIPlayer.cs index 00af1ac6..9f66cf43 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIPlayer.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AIPlayer.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AITurretShape.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AITurretShape.cs index 32a8ecbf..3a4a27df 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AITurretShape.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AITurretShape.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AITurretShapeData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AITurretShapeData.cs index f93db2bd..041df2a5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AITurretShapeData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AITurretShapeData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ActionMap.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ActionMap.cs index afb14e96..fdb3a554 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ActionMap.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ActionMap.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AdvancedLightBinManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AdvancedLightBinManager.cs index 1ee136e9..41ce0435 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AdvancedLightBinManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/AdvancedLightBinManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ArrayObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ArrayObject.cs index 027daba3..69672f89 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ArrayObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ArrayObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BarrelDistortionPostEffect.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BarrelDistortionPostEffect.cs index 38eb5e5f..90a8ef07 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BarrelDistortionPostEffect.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BarrelDistortionPostEffect.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BaseMaterialDefinition.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BaseMaterialDefinition.cs index 07cf6620..6a9406e9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BaseMaterialDefinition.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BaseMaterialDefinition.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BasicClouds.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BasicClouds.cs index 1cdb16fa..f4f37ca3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BasicClouds.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/BasicClouds.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CachedInterfaceExampleComponent.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CachedInterfaceExampleComponent.cs index 43b03ea5..e7a8d903 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CachedInterfaceExampleComponent.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CachedInterfaceExampleComponent.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Camera.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Camera.cs index bbce40b8..5177cb3d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Camera.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Camera.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CameraBookmark.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CameraBookmark.cs index 953bbf00..c685290f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CameraBookmark.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CameraBookmark.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CameraData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CameraData.cs index 0bd1b34e..2a714128 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CameraData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CameraData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CloudLayer.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CloudLayer.cs index feb31ef1..243358e1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CloudLayer.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CloudLayer.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CompoundUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CompoundUndoAction.cs index 2f1c3758..b2a8519e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CompoundUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CompoundUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ConsoleLogger.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ConsoleLogger.cs index cb849ee2..9da832ff 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ConsoleLogger.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ConsoleLogger.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ConvexShape.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ConvexShape.cs index 24180479..99798964 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ConvexShape.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ConvexShape.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CoverPoint.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CoverPoint.cs index 4a94e751..212a630c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CoverPoint.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CoverPoint.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CreatorTree.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CreatorTree.cs index 3a10ffd5..36796d1c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CreatorTree.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CreatorTree.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CubemapData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CubemapData.cs index 5edb9d3a..24aee606 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CubemapData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CubemapData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CustomMaterial.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CustomMaterial.cs index 490b6679..096f0322 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CustomMaterial.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/CustomMaterial.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DBDeleteUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DBDeleteUndoAction.cs index db9394da..86962a0a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DBDeleteUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DBDeleteUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DBRetargetUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DBRetargetUndoAction.cs index cd1152a0..ec930c49 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DBRetargetUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DBRetargetUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DICreateUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DICreateUndoAction.cs index 7c1e83f1..9408fd0c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DICreateUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DICreateUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DIDeleteUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DIDeleteUndoAction.cs index 870d5ef5..3f3ec3a4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DIDeleteUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DIDeleteUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DInputManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DInputManager.cs index 8955ecba..88d7e4c9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DInputManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DInputManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DbgFileView.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DbgFileView.cs index eaf2b131..24792951 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DbgFileView.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DbgFileView.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Debris.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Debris.cs index eb564527..08821397 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Debris.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Debris.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DebrisData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DebrisData.cs index 2044deea..71cc8ac5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DebrisData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DebrisData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DebugDrawer.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DebugDrawer.cs index 00abcb2a..5dd99308 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DebugDrawer.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DebugDrawer.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalData.cs index b46a45d7..08ee0ffd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalManager.cs index 03e161d8..344aa057 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalRoad.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalRoad.cs index 8fc39611..e7feeea2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalRoad.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DecalRoad.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DynamicConsoleMethodComponent.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DynamicConsoleMethodComponent.cs index 6dbfe97f..54b14028 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DynamicConsoleMethodComponent.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/DynamicConsoleMethodComponent.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EditManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EditManager.cs index 974bef48..4924b20c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EditManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EditManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EditTSCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EditTSCtrl.cs index 09f16f2e..e5ba4273 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EditTSCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EditTSCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EventManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EventManager.cs index 08ca1246..d55fd9af 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EventManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/EventManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ExplodePrefabUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ExplodePrefabUndoAction.cs index 2e2aa1e7..aefb9871 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ExplodePrefabUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ExplodePrefabUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Explosion.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Explosion.cs index 55dd82e0..1e60222a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Explosion.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Explosion.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ExplosionData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ExplosionData.cs index 33185512..a176b37a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ExplosionData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ExplosionData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FieldBrushObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FieldBrushObject.cs index f47fe1c8..4c5a4de1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FieldBrushObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FieldBrushObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileDialog.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileDialog.cs index 177f831a..de5936df 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileDialog.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileDialog.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileObject.cs index 002673b2..e6f683a0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileStreamObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileStreamObject.cs index 5d8f5c9e..392b16ce 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileStreamObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FileStreamObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FlyingVehicle.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FlyingVehicle.cs index d85df499..4b0d2f80 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FlyingVehicle.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FlyingVehicle.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FlyingVehicleData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FlyingVehicleData.cs index 410d135b..814bc320 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FlyingVehicleData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/FlyingVehicleData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForcedMaterialMeshMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForcedMaterialMeshMgr.cs index 602ce213..646960e7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForcedMaterialMeshMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForcedMaterialMeshMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Forest.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Forest.cs index acc5066f..aed7548a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Forest.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Forest.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrush.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrush.cs index efda0d67..873087d7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrush.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrush.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrushElement.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrushElement.cs index a7572e91..cfffd9c0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrushElement.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrushElement.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrushTool.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrushTool.cs index f7260104..b7c14809 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrushTool.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestBrushTool.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestCreateUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestCreateUndoAction.cs index 54281762..d5587b42 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestCreateUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestCreateUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestDeleteUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestDeleteUndoAction.cs index b704cb5c..08c0c8af 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestDeleteUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestDeleteUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestEditorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestEditorCtrl.cs index 26e50f96..4118d1cc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestEditorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestEditorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestItemData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestItemData.cs index 2f4b100c..909db276 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestItemData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestItemData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestSelectionTool.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestSelectionTool.cs index 30e05d31..c141f96d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestSelectionTool.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestSelectionTool.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestTool.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestTool.cs index 5a6ce9d6..0b7711a8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestTool.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestTool.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestUndoAction.cs index d32d1040..137ac282 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestUpdateAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestUpdateAction.cs index c1e0b49c..c02f3f5e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestUpdateAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestUpdateAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestWindEmitter.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestWindEmitter.cs index 8a9a8581..af949119 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestWindEmitter.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ForestWindEmitter.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GFXSamplerStateData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GFXSamplerStateData.cs index 97024e48..4004c9b5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GFXSamplerStateData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GFXSamplerStateData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GFXStateBlockData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GFXStateBlockData.cs index 3433b0e4..4c7b0a5b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GFXStateBlockData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GFXStateBlockData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameBase.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameBase.cs index 45fafe26..53bdddaa 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameBase.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameBase.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameBaseData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameBaseData.cs index 8fc08abe..75327c0f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameBaseData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameBaseData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameConnection.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameConnection.cs index a0c842e9..4d049ccb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameConnection.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameConnection.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameTSCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameTSCtrl.cs index a58531db..2081c2a1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameTSCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GameTSCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Gizmo.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Gizmo.cs index a7fdd9f5..eae5d4d8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Gizmo.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Gizmo.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GizmoProfile.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GizmoProfile.cs index 41bd6536..ee4f1e69 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GizmoProfile.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GizmoProfile.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GroundCover.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GroundCover.cs index b68480e4..bf684341 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GroundCover.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GroundCover.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GroundPlane.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GroundPlane.cs index a55fae32..304bd8fa 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GroundPlane.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GroundPlane.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiArrayCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiArrayCtrl.cs index f661fc83..63906476 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiArrayCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiArrayCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiAutoCompleteCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiAutoCompleteCtrl.cs index d1bfee94..5e6c6796 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiAutoCompleteCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiAutoCompleteCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiAutoScrollCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiAutoScrollCtrl.cs index 1abff770..ae548fb8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiAutoScrollCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiAutoScrollCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBackgroundCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBackgroundCtrl.cs index e2d1b0b4..cd81a693 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBackgroundCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBackgroundCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapBorderCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapBorderCtrl.cs index 9d06b008..93b44673 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapBorderCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapBorderCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapButtonCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapButtonCtrl.cs index ce4d53ac..260470d7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapButtonCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapButtonCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapButtonTextCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapButtonTextCtrl.cs index cb6b7dd1..168862c0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapButtonTextCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapButtonTextCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapCtrl.cs index a8c213dd..04880d08 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBitmapCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBorderButtonCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBorderButtonCtrl.cs index 21e2fdbc..ceede37e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBorderButtonCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBorderButtonCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBubbleTextCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBubbleTextCtrl.cs index 07c8767f..49266753 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBubbleTextCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiBubbleTextCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiButtonBaseCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiButtonBaseCtrl.cs index 67168ec9..9faa8c0e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiButtonBaseCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiButtonBaseCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiButtonCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiButtonCtrl.cs index 7b091cc4..7c81c014 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiButtonCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiButtonCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCanvas.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCanvas.cs index 37252899..982108b7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCanvas.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCanvas.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCheckBoxCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCheckBoxCtrl.cs index e257a2bd..da84ec82 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCheckBoxCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCheckBoxCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiChunkedBitmapCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiChunkedBitmapCtrl.cs index c09cb63b..4dc9c139 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiChunkedBitmapCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiChunkedBitmapCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiClockHud.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiClockHud.cs index 36d53182..4192036a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiClockHud.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiClockHud.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiColorPickerCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiColorPickerCtrl.cs index 013bcdd0..1fd45a32 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiColorPickerCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiColorPickerCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsole.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsole.cs index 95f673e5..8dce4cf2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsole.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsole.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsoleEditCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsoleEditCtrl.cs index b739b22e..59ee06d3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsoleEditCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsoleEditCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsoleTextCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsoleTextCtrl.cs index 30a2b1c8..a1c5b45d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsoleTextCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConsoleTextCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiContainer.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiContainer.cs index e2ee9bd6..6d3c72df 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiContainer.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiContainer.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControl.cs index b9a425e5..61d5bad9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControlArrayControl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControlArrayControl.cs index eff37d78..a11013de 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControlArrayControl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControlArrayControl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControlProfile.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControlProfile.cs index e03eedf5..e9e1a021 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControlProfile.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiControlProfile.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConvexEditorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConvexEditorCtrl.cs index 749120fd..719fa725 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConvexEditorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiConvexEditorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCrossHairHud.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCrossHairHud.cs index 9073545f..b2e1c96d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCrossHairHud.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCrossHairHud.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCursor.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCursor.cs index 45d5001f..b45acbcf 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCursor.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiCursor.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDecalEditorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDecalEditorCtrl.cs index 640bc7b2..e8196ef8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDecalEditorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDecalEditorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDecoyCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDecoyCtrl.cs index bde40e77..8792fbba 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDecoyCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDecoyCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDirectoryFileListCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDirectoryFileListCtrl.cs index e7909951..99c3088b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDirectoryFileListCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDirectoryFileListCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDragAndDropControl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDragAndDropControl.cs index 9bd1d6b2..8f004eba 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDragAndDropControl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDragAndDropControl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDynamicCtrlArrayControl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDynamicCtrlArrayControl.cs index 07a95a38..a46914df 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDynamicCtrlArrayControl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiDynamicCtrlArrayControl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEaseViewCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEaseViewCtrl.cs index ede89d9d..1e73b821 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEaseViewCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEaseViewCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEditCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEditCtrl.cs index 0cbf8b6e..af78cb69 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEditCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEditCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEditorRuler.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEditorRuler.cs index 3f516922..c12511b8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEditorRuler.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiEditorRuler.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFadeinBitmapCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFadeinBitmapCtrl.cs index a4014766..6a15cee0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFadeinBitmapCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFadeinBitmapCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFileTreeCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFileTreeCtrl.cs index d2f89f19..d2282553 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFileTreeCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFileTreeCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFilterCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFilterCtrl.cs index 58f4f8ec..89768d11 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFilterCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFilterCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFlexibleArrayControl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFlexibleArrayControl.cs index 04beab83..2ced08f1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFlexibleArrayControl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFlexibleArrayControl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFormCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFormCtrl.cs index 628b8db0..6decfed3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFormCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFormCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFrameSetCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFrameSetCtrl.cs index dee935b8..22f4a0f6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFrameSetCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiFrameSetCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListMenuCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListMenuCtrl.cs index a5350de9..7635502e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListMenuCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListMenuCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListMenuProfile.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListMenuProfile.cs index 48efd6cf..98fe0b6c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListMenuProfile.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListMenuProfile.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListOptionsCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListOptionsCtrl.cs index 6aae97f2..740008c2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListOptionsCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListOptionsCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListOptionsProfile.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListOptionsProfile.cs index d2119697..e190c8be 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListOptionsProfile.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGameListOptionsProfile.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGradientCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGradientCtrl.cs index 5f882743..2ef802f9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGradientCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGradientCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGradientSwatchCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGradientSwatchCtrl.cs index 3f30f361..9715b824 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGradientSwatchCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGradientSwatchCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGraphCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGraphCtrl.cs index 9d8a3577..99409de4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGraphCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiGraphCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiHealthBarHud.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiHealthBarHud.cs index 333dce0c..d7befbe5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiHealthBarHud.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiHealthBarHud.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiHealthTextHud.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiHealthTextHud.cs index b682cf13..e1bd111f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiHealthTextHud.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiHealthTextHud.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiIconButtonCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiIconButtonCtrl.cs index d85f1327..75580d7e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiIconButtonCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiIconButtonCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiIdleCamFadeBitmapCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiIdleCamFadeBitmapCtrl.cs index 7271c165..573f9a62 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiIdleCamFadeBitmapCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiIdleCamFadeBitmapCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiImageList.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiImageList.cs index 47daf088..35f92048 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiImageList.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiImageList.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInputCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInputCtrl.cs index 4c5d46cd..2a23960a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInputCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInputCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspector.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspector.cs index c9661ceb..adb6cc20 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspector.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspector.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorCustomField.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorCustomField.cs index 3b8d8551..12c88c56 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorCustomField.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorCustomField.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDatablockField.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDatablockField.cs index 0c2761bd..0589841c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDatablockField.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDatablockField.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDynamicField.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDynamicField.cs index 0d376268..02d72b78 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDynamicField.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDynamicField.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDynamicGroup.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDynamicGroup.cs index 831c8380..01af1435 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDynamicGroup.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorDynamicGroup.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorField.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorField.cs index aac82b13..e655fb52 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorField.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorField.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorGroup.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorGroup.cs index e5e07313..d2423419 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorGroup.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorGroup.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeBitMask32.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeBitMask32.cs index 67e72b3a..e2a6b9b7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeBitMask32.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeBitMask32.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeBitMask32Helper.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeBitMask32Helper.cs index 60ebaa19..71d5ecfb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeBitMask32Helper.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeBitMask32Helper.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCheckBox.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCheckBox.cs index df6bb868..645fe2c2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCheckBox.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCheckBox.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColor.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColor.cs index 17b47323..832efe34 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColor.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColor.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColorF.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColorF.cs index aebc3e61..bebcf42f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColorF.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColorF.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColorI.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColorI.cs index dc0f9fc6..bac2f65c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColorI.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeColorI.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCommand.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCommand.cs index c1775963..78ff0d66 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCommand.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCommand.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCubemapName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCubemapName.cs index 050045d2..22f05459 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCubemapName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeCubemapName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeEaseF.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeEaseF.cs index 73eb9195..f69d11dc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeEaseF.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeEaseF.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeEnum.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeEnum.cs index 5dcbc2e5..2213b717 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeEnum.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeEnum.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeFileName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeFileName.cs index 54723268..7d9b3da6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeFileName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeFileName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeGuiControl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeGuiControl.cs index af8c275e..2c93e6f7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeGuiControl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeGuiControl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeGuiProfile.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeGuiProfile.cs index ea85d3e9..ea85f12c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeGuiProfile.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeGuiProfile.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeImageFileName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeImageFileName.cs index 5620da3c..b7902c2f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeImageFileName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeImageFileName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeMaterialName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeMaterialName.cs index c9470e82..22bfba89 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeMaterialName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeMaterialName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeMenuBase.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeMenuBase.cs index e289027b..55252808 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeMenuBase.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeMenuBase.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeName.cs index 04fb9c8d..e2026575 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypePrefabFilename.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypePrefabFilename.cs index 4a2eb76e..8b05755b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypePrefabFilename.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypePrefabFilename.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeRectUV.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeRectUV.cs index c44208b0..b4177db0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeRectUV.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeRectUV.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeRegularMaterialName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeRegularMaterialName.cs index 08d0a92c..10101e18 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeRegularMaterialName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeRegularMaterialName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeS32.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeS32.cs index 7f3a6cab..6c83d3b1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeS32.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeS32.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXAmbienceName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXAmbienceName.cs index 8660a6e3..599080b0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXAmbienceName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXAmbienceName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXDescriptionName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXDescriptionName.cs index 468ebcc8..aa278914 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXDescriptionName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXDescriptionName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXEnvironmentName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXEnvironmentName.cs index a958a4cb..96ba6132 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXEnvironmentName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXEnvironmentName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXParameterName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXParameterName.cs index 09b1fc81..73d9603d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXParameterName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXParameterName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXSourceName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXSourceName.cs index ed1a8ad4..c54c19e8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXSourceName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXSourceName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXStateName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXStateName.cs index 4a9c614f..f4554bf4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXStateName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXStateName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXTrackName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXTrackName.cs index 79dccaf1..b2063ba4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXTrackName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeSFXTrackName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeShapeFilename.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeShapeFilename.cs index 75ad7302..1cac71dc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeShapeFilename.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeShapeFilename.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeTerrainMaterialIndex.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeTerrainMaterialIndex.cs index bf6ca58b..fb681cb9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeTerrainMaterialIndex.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeTerrainMaterialIndex.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeTerrainMaterialName.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeTerrainMaterialName.cs index 4051c07d..2368ee5a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeTerrainMaterialName.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorTypeTerrainMaterialName.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorVariableField.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorVariableField.cs index a39bcac4..511021ec 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorVariableField.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorVariableField.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorVariableGroup.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorVariableGroup.cs index b34a903d..6e90ff67 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorVariableGroup.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiInspectorVariableGroup.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiListBoxCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiListBoxCtrl.cs index 882e8bce..ed8024b6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiListBoxCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiListBoxCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMLTextCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMLTextCtrl.cs index f17a8001..7f6bd165 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMLTextCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMLTextCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMLTextEditCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMLTextEditCtrl.cs index a2abaa51..ba75ab64 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMLTextEditCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMLTextEditCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMaterialCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMaterialCtrl.cs index 41f846fa..f7fab761 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMaterialCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMaterialCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMaterialPreview.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMaterialPreview.cs index 3215be85..e58876a2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMaterialPreview.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMaterialPreview.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuBackgroundCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuBackgroundCtrl.cs index c4f1b43c..d4d2bc8b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuBackgroundCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuBackgroundCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuBar.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuBar.cs index 6572bb42..ed7c345c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuBar.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuBar.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuTextListCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuTextListCtrl.cs index 270f6178..0301f941 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuTextListCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMenuTextListCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMeshRoadEditorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMeshRoadEditorCtrl.cs index 97c6f88c..5157cc05 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMeshRoadEditorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMeshRoadEditorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMessageVectorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMessageVectorCtrl.cs index dc1289c3..c2779b06 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMessageVectorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMessageVectorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMissionAreaCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMissionAreaCtrl.cs index 714f94a1..f41aabfe 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMissionAreaCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMissionAreaCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMissionAreaEditorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMissionAreaEditorCtrl.cs index f8c32a5f..8842de6a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMissionAreaEditorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMissionAreaEditorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMouseEventCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMouseEventCtrl.cs index 22a140a8..8fa0fdd6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMouseEventCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiMouseEventCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiNavEditorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiNavEditorCtrl.cs index 83850797..2095c118 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiNavEditorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiNavEditorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiNoMouseCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiNoMouseCtrl.cs index 86e5f52d..5c0289e2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiNoMouseCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiNoMouseCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiObjectView.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiObjectView.cs index 424bec51..47c7551d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiObjectView.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiObjectView.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPaneControl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPaneControl.cs index 0a7b0e6a..42f5dac2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPaneControl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPaneControl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPanel.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPanel.cs index 7ee4b395..a2797802 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPanel.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPanel.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiParticleGraphCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiParticleGraphCtrl.cs index f28407a7..2890a6de 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiParticleGraphCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiParticleGraphCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopUpMenuCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopUpMenuCtrl.cs index fb9e26ed..5a23af3c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopUpMenuCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopUpMenuCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopUpMenuCtrlEx.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopUpMenuCtrlEx.cs index 42f64ebd..d50a92bf 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopUpMenuCtrlEx.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopUpMenuCtrlEx.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopupTextListCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopupTextListCtrl.cs index 2644153c..63110ddd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopupTextListCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopupTextListCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopupTextListCtrlEx.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopupTextListCtrlEx.cs index 6a417e1b..b0cf3a2b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopupTextListCtrlEx.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiPopupTextListCtrlEx.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiProgressBitmapCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiProgressBitmapCtrl.cs index f9f527f8..ba9ff736 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiProgressBitmapCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiProgressBitmapCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiProgressCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiProgressCtrl.cs index 95651389..383b7b7d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiProgressCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiProgressCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRadioCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRadioCtrl.cs index bc788834..3dc3fddd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRadioCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRadioCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRectHandles.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRectHandles.cs index bb85da38..aadb7dec 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRectHandles.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRectHandles.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRiverEditorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRiverEditorCtrl.cs index 98ca2c1d..2eeabcf9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRiverEditorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRiverEditorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRoadEditorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRoadEditorCtrl.cs index 5c786e19..da8563a2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRoadEditorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRoadEditorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRolloutCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRolloutCtrl.cs index bedab3c6..3b263105 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRolloutCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiRolloutCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiScriptNotifyCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiScriptNotifyCtrl.cs index 6142e1f3..c952167a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiScriptNotifyCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiScriptNotifyCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiScrollCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiScrollCtrl.cs index d67da981..383a7e54 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiScrollCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiScrollCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSeparatorCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSeparatorCtrl.cs index d1eff8d7..9cfba1a6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSeparatorCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSeparatorCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiShapeEdPreview.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiShapeEdPreview.cs index a8cbabdd..ab567b71 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiShapeEdPreview.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiShapeEdPreview.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiShapeNameHud.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiShapeNameHud.cs index f9763650..f901e465 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiShapeNameHud.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiShapeNameHud.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSliderCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSliderCtrl.cs index 2835e8de..30c6ba08 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSliderCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSliderCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSpeedometerHud.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSpeedometerHud.cs index 59132c2e..1246e99a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSpeedometerHud.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSpeedometerHud.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSplitContainer.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSplitContainer.cs index d5416ef3..d9919f90 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSplitContainer.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSplitContainer.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiStackControl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiStackControl.cs index 7d7a9cf3..cd2b97b0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiStackControl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiStackControl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSubmenuBackgroundCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSubmenuBackgroundCtrl.cs index 325ea3cc..32bc169b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSubmenuBackgroundCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSubmenuBackgroundCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSwatchButtonCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSwatchButtonCtrl.cs index a956ea71..01aa0928 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSwatchButtonCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiSwatchButtonCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTSCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTSCtrl.cs index bb3ff809..38ca40ac 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTSCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTSCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTabBookCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTabBookCtrl.cs index e815ea5a..19630440 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTabBookCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTabBookCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTabPageCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTabPageCtrl.cs index 27b5a2b5..629f29a7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTabPageCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTabPageCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTableControl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTableControl.cs index de6f81bd..e5b842ed 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTableControl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTableControl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTerrPreviewCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTerrPreviewCtrl.cs index dee29d70..9a4223bd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTerrPreviewCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTerrPreviewCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextCtrl.cs index bb4ddb82..1540e8c0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditCtrl.cs index 1d4f4e3e..c1902b98 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditSliderBitmapCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditSliderBitmapCtrl.cs index 049296be..f334c3ff 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditSliderBitmapCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditSliderBitmapCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditSliderCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditSliderCtrl.cs index 2262ff05..b44f9e2d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditSliderCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextEditSliderCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextListCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextListCtrl.cs index ba348a22..cc00d372 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextListCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTextListCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTheoraCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTheoraCtrl.cs index 3d02e5df..05f6a739 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTheoraCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTheoraCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTickCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTickCtrl.cs index 4ae021bc..85720000 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTickCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTickCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiToggleButtonCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiToggleButtonCtrl.cs index 39b4049d..a90156f3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiToggleButtonCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiToggleButtonCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiToolboxButtonCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiToolboxButtonCtrl.cs index 73402fb8..f896846d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiToolboxButtonCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiToolboxButtonCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTreeViewCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTreeViewCtrl.cs index cfb07ff4..c83138ea 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTreeViewCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiTreeViewCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiVariableInspector.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiVariableInspector.cs index 91723c33..5c9e6110 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiVariableInspector.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiVariableInspector.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiWindowCollapseCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiWindowCollapseCtrl.cs index c0034d6a..a4a1cf4f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiWindowCollapseCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiWindowCollapseCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiWindowCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiWindowCtrl.cs index c9c53fdb..d6b50555 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiWindowCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/GuiWindowCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HTTPObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HTTPObject.cs index 03250e7e..15fe2e2d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HTTPObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HTTPObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HoverVehicle.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HoverVehicle.cs index 9ed29abd..42638816 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HoverVehicle.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HoverVehicle.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HoverVehicleData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HoverVehicleData.cs index ecf001d7..636a0cc2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HoverVehicleData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/HoverVehicleData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/InspectorFieldUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/InspectorFieldUndoAction.cs index 99b2e782..375af909 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/InspectorFieldUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/InspectorFieldUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Item.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Item.cs index 5719679e..6a7b3602 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Item.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Item.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ItemData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ItemData.cs index 4a1c5b75..f730d1e6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ItemData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ItemData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LangTable.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LangTable.cs index 7a5a902b..f68f3d8c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LangTable.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LangTable.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LeapMotionFrame.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LeapMotionFrame.cs index ba88e02e..45e06b6e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LeapMotionFrame.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LeapMotionFrame.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LevelInfo.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LevelInfo.cs index 2b47a05d..382d6ddc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LevelInfo.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LevelInfo.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightAnimData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightAnimData.cs index 475e4872..ccbb82dc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightAnimData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightAnimData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightBase.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightBase.cs index 40a084cf..bf44972a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightBase.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightBase.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightDescription.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightDescription.cs index abbe08d8..9a4a6b36 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightDescription.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightDescription.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightFlareData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightFlareData.cs index ed5263e7..13132300 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightFlareData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightFlareData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Lightning.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Lightning.cs index 09af6b17..977ee4fa 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Lightning.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Lightning.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightningData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightningData.cs index 8face391..211e3566 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightningData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/LightningData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MECreateUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MECreateUndoAction.cs index 3534337b..0f1d5682 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MECreateUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MECreateUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MEDeleteUndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MEDeleteUndoAction.cs index a108c5c4..bf2390d6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MEDeleteUndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MEDeleteUndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Marker.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Marker.cs index ec9c38c9..65346be9 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Marker.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Marker.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Material.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Material.cs index 2b3c32d0..394d9c55 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Material.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Material.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MenuBar.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MenuBar.cs index 76929eab..5bbe7036 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MenuBar.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MenuBar.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MeshRoad.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MeshRoad.cs index e3bc2cf2..87b73952 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MeshRoad.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MeshRoad.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Message.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Message.cs index e511ce85..88f167d0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Message.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Message.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MessageForwarder.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MessageForwarder.cs index 6848e4a6..4af48429 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MessageForwarder.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MessageForwarder.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MessageVector.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MessageVector.cs index 5555e5e0..447e84a8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MessageVector.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MessageVector.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionArea.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionArea.cs index b5274c70..fcb7e6b0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionArea.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionArea.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionMarker.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionMarker.cs index 186fa892..561f1e2f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionMarker.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionMarker.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionMarkerData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionMarkerData.cs index fa46170d..65558595 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionMarkerData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MissionMarkerData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MoreAdvancedComponent.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MoreAdvancedComponent.cs index 13dfecd7..065ef282 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MoreAdvancedComponent.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/MoreAdvancedComponent.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NavMesh.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NavMesh.cs index c35db32c..48bc1fe3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NavMesh.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NavMesh.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NavPath.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NavPath.cs index 85c927c2..a44bb626 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NavPath.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NavPath.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NetConnection.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NetConnection.cs index 0f68e792..3654a5ff 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NetConnection.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NetConnection.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NetObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NetObject.cs index 6020ce18..c1750d9f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NetObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/NetObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/OpenFileDialog.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/OpenFileDialog.cs index 7e0100a0..a5b755a2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/OpenFileDialog.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/OpenFileDialog.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/OpenFolderDialog.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/OpenFolderDialog.cs index db4a02f8..6c11fd46 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/OpenFolderDialog.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/OpenFolderDialog.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleData.cs index 091440ad..25bdc626 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitter.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitter.cs index adea967f..cd42d56c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitter.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitter.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterData.cs index 555079ea..934078fb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterNode.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterNode.cs index 2774372b..2eab6c67 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterNode.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterNode.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterNodeData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterNodeData.cs index d3b3b252..a0b92978 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterNodeData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ParticleEmitterNodeData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Path.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Path.cs index 66dd013b..b2f63fcc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Path.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Path.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PathCamera.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PathCamera.cs index 9dbbd957..3c14a120 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PathCamera.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PathCamera.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PathCameraData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PathCameraData.cs index c369e09b..783adc00 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PathCameraData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PathCameraData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PersistenceManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PersistenceManager.cs index 06d683d3..2c118002 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PersistenceManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PersistenceManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicalZone.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicalZone.cs index 62d6730d..3bdc1c36 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicalZone.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicalZone.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsDebris.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsDebris.cs index ad7fd11f..4a04fb62 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsDebris.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsDebris.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsDebrisData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsDebrisData.cs index 7ae2d28b..f5c13f7a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsDebrisData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsDebrisData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsForce.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsForce.cs index 34f97f2f..4b885445 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsForce.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsForce.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsShape.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsShape.cs index 26fd44d0..16039ba7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsShape.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsShape.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsShapeData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsShapeData.cs index 131c6ff6..262ce385 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsShapeData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PhysicsShapeData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Player.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Player.cs index 0a4e5a5c..8db252b8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Player.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Player.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PlayerData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PlayerData.cs index 24e3c4b8..68140295 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PlayerData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PlayerData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PointLight.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PointLight.cs index 15d27bb2..80ea9324 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PointLight.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PointLight.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PopupMenu.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PopupMenu.cs index 1e208824..d7e3060a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PopupMenu.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PopupMenu.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PopupTextListCtrl.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PopupTextListCtrl.cs index 44bc1104..3c0c81c4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PopupTextListCtrl.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PopupTextListCtrl.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PostEffect.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PostEffect.cs index 91b013c1..64bddc8c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PostEffect.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PostEffect.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Precipitation.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Precipitation.cs index 0d3a9958..5486815e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Precipitation.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Precipitation.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PrecipitationData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PrecipitationData.cs index c75bb45c..a647c0ba 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PrecipitationData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PrecipitationData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Prefab.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Prefab.cs index d84d4694..bf4f6a1f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Prefab.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Prefab.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Projectile.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Projectile.cs index cb12627e..221b7fa4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Projectile.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Projectile.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProjectileData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProjectileData.cs index 273d4dce..a5be6d39 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProjectileData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProjectileData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProximityMine.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProximityMine.cs index 6875ca07..8a87f2db 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProximityMine.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProximityMine.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProximityMineData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProximityMineData.cs index 13bd9f6c..6233e400 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProximityMineData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ProximityMineData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxCloth.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxCloth.cs index dba293ca..976102cb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxCloth.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxCloth.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxFluid.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxFluid.cs index 6e939e23..205b7245 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxFluid.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxFluid.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMaterial.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMaterial.cs index 4886f363..91259703 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMaterial.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMaterial.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMultiActor.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMultiActor.cs index bf66d912..4233742f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMultiActor.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMultiActor.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMultiActorData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMultiActorData.cs index fc00df46..1ecdd8ad 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMultiActorData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/PxMultiActorData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RazerHydraFrame.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RazerHydraFrame.cs index c81eef96..f2019fdb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RazerHydraFrame.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RazerHydraFrame.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ReadXML.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ReadXML.cs index 1154d76b..18f5843c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ReadXML.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ReadXML.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ReflectorDesc.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ReflectorDesc.cs index e65deb5d..5557df7f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ReflectorDesc.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ReflectorDesc.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderBinManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderBinManager.cs index d6cd4c22..dc25b220 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderBinManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderBinManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderFormatToken.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderFormatToken.cs index 8ac36e24..72bc10e1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderFormatToken.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderFormatToken.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderGlowMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderGlowMgr.cs index debbe3f3..f4f83afe 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderGlowMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderGlowMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderImposterMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderImposterMgr.cs index 26af58d0..23f38140 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderImposterMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderImposterMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderMeshExample.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderMeshExample.cs index 89f4a761..48799d48 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderMeshExample.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderMeshExample.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderMeshMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderMeshMgr.cs index 2f6a9155..041330e5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderMeshMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderMeshMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderObjectExample.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderObjectExample.cs index 971cc445..56175f11 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderObjectExample.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderObjectExample.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderObjectMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderObjectMgr.cs index 7d4a6388..c1b71494 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderObjectMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderObjectMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderOcclusionMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderOcclusionMgr.cs index 37052b74..d86f5093 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderOcclusionMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderOcclusionMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderParticleMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderParticleMgr.cs index fac08fba..0f2f0054 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderParticleMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderParticleMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassManager.cs index 3959d378..16887922 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassStateBin.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassStateBin.cs index 40d142e6..bcbec33a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassStateBin.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassStateBin.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassStateToken.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassStateToken.cs index 21b62c80..fe1164e2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassStateToken.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPassStateToken.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPrePassMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPrePassMgr.cs index 748bfa27..3a10f63c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPrePassMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderPrePassMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderShapeExample.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderShapeExample.cs index e0897188..19534501 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderShapeExample.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderShapeExample.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTerrainMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTerrainMgr.cs index 697c95a7..88491285 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTerrainMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTerrainMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTexTargetBinManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTexTargetBinManager.cs index 6c20bc19..d3f84beb 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTexTargetBinManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTexTargetBinManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTranslucentMgr.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTranslucentMgr.cs index d36347fb..fc3712ac 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTranslucentMgr.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RenderTranslucentMgr.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RigidShape.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RigidShape.cs index f91c3efe..3951041d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RigidShape.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RigidShape.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RigidShapeData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RigidShapeData.cs index 4fe6db8d..cde2f034 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RigidShapeData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/RigidShapeData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/River.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/River.cs index b136ed42..2b6f85ac 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/River.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/River.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXAmbience.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXAmbience.cs index f4d54348..f104a84f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXAmbience.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXAmbience.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXController.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXController.cs index 391bdd3e..36d6af51 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXController.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXController.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXDescription.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXDescription.cs index e893156b..76b649d2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXDescription.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXDescription.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXEmitter.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXEmitter.cs index ecbe8461..123265ad 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXEmitter.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXEmitter.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXEnvironment.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXEnvironment.cs index eb2cf534..828326e2 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXEnvironment.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXEnvironment.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEvent.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEvent.cs index fd791805..eb0ad9f0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEvent.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEvent.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEventGroup.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEventGroup.cs index d9dfc170..e4af36f1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEventGroup.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEventGroup.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEventSource.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEventSource.cs index 8157c6f9..4792f95d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEventSource.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODEventSource.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODProject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODProject.cs index fb550960..62f674e7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODProject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXFMODProject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXParameter.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXParameter.cs index 634e3ebf..58c70a28 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXParameter.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXParameter.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXPlayList.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXPlayList.cs index 4548003e..a4447ad1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXPlayList.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXPlayList.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXProfile.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXProfile.cs index 7a1b73d4..672dc418 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXProfile.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXProfile.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXSound.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXSound.cs index 9ce8598d..334fcc3c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXSound.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXSound.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXSource.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXSource.cs index 800fe973..9da5e560 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXSource.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXSource.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXState.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXState.cs index 4a1ac046..41a7cf5e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXState.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXState.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXTrack.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXTrack.cs index 0217bbec..aa95aabc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXTrack.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SFXTrack.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SaveFileDialog.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SaveFileDialog.cs index b4b8217d..8bb45aee 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SaveFileDialog.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SaveFileDialog.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScatterSky.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScatterSky.cs index 9a00f27c..3a3c5c99 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScatterSky.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScatterSky.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneLighting.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneLighting.cs index 7b185267..c9a9463a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneLighting.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneLighting.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneObject.cs index 81c9171f..6ea58765 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneRootZone.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneRootZone.cs index 0146203b..91b65e27 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneRootZone.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneRootZone.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneSimpleZone.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneSimpleZone.cs index 8ee279b5..771350b8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneSimpleZone.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneSimpleZone.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneSpace.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneSpace.cs index a94f12e4..5cda4e7c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneSpace.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneSpace.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneZoneSpace.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneZoneSpace.cs index 35f298ca..ea1121d3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneZoneSpace.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SceneZoneSpace.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScopeAlwaysShape.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScopeAlwaysShape.cs index 94443ebb..faa2932f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScopeAlwaysShape.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScopeAlwaysShape.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptGroup.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptGroup.cs index 2f6bb905..b7a2e66f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptGroup.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptGroup.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptMsgListener.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptMsgListener.cs index 272364f0..da0a89d3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptMsgListener.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptMsgListener.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptObject.cs index e37e952e..d7abff50 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptTickObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptTickObject.cs index 48913908..42502c68 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptTickObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ScriptTickObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Settings.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Settings.cs index d795cbe5..bd94c17c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Settings.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Settings.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShaderData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShaderData.cs index 4f2e60cc..b4c098b7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShaderData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShaderData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShadowRenderPassManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShadowRenderPassManager.cs index b64ecc5c..2e4aab1a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShadowRenderPassManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShadowRenderPassManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBase.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBase.cs index e3187374..32592e72 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBase.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBase.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBaseData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBaseData.cs index 211181e6..d4e6dde3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBaseData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBaseData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBaseImageData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBaseImageData.cs index d0167230..4271425b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBaseImageData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ShapeBaseImageData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimComponent.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimComponent.cs index b957b7e8..bd15a973 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimComponent.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimComponent.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimDataBlock.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimDataBlock.cs index 1ac290be..4149202f 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimDataBlock.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimDataBlock.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimGroup.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimGroup.cs index 38b612bb..4c815408 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimGroup.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimGroup.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimObject.cs index 1e76cebf..6478504d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimPersistSet.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimPersistSet.cs index a5c6e888..ae20b175 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimPersistSet.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimPersistSet.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimResponseCurve.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimResponseCurve.cs index 8143f96b..e28f9818 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimResponseCurve.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimResponseCurve.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimSet.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimSet.cs index adf38877..1c20e4f1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimSet.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimSet.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimXMLDocument.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimXMLDocument.cs index ac4c2a4b..07dbdf09 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimXMLDocument.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimXMLDocument.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimpleComponent.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimpleComponent.cs index 8195d55d..100c8fda 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimpleComponent.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimpleComponent.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimpleNetObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimpleNetObject.cs index 51db3068..139acdc8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimpleNetObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SimpleNetObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SkyBox.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SkyBox.cs index 885f30d1..af8565ee 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SkyBox.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SkyBox.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SpawnSphere.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SpawnSphere.cs index 3d82d4fc..766c9e91 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SpawnSphere.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SpawnSphere.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Splash.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Splash.cs index 46a8d3ab..728829ad 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Splash.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Splash.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SplashData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SplashData.cs index e3446c85..051c9ae4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SplashData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SplashData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SpotLight.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SpotLight.cs index 0c6fc0fe..df1b5f41 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SpotLight.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/SpotLight.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StaticShape.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StaticShape.cs index f7e789b7..f6f733cd 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StaticShape.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StaticShape.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StaticShapeData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StaticShapeData.cs index eb0ffc02..93714973 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StaticShapeData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StaticShapeData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StreamObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StreamObject.cs index 39b9544d..0f3b4453 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StreamObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/StreamObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Sun.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Sun.cs index 82d3ad5e..5900ea0d 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Sun.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Sun.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/T3DSceneClient.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/T3DSceneClient.cs index 05e491cf..86130d97 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/T3DSceneClient.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/T3DSceneClient.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/T3DSceneComponent.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/T3DSceneComponent.cs index 82954d5e..fd1bf0ca 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/T3DSceneComponent.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/T3DSceneComponent.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TCPObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TCPObject.cs index 9a87e3d3..0dd67c8e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TCPObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TCPObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSAttachable.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSAttachable.cs index e3373daf..2da725e5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSAttachable.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSAttachable.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSDynamic.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSDynamic.cs index 7707c32d..98343531 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSDynamic.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSDynamic.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSForestItemData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSForestItemData.cs index a83072da..5057f038 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSForestItemData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSForestItemData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSPathShape.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSPathShape.cs index 410376c6..f17e18e7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSPathShape.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSPathShape.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSShapeConstructor.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSShapeConstructor.cs index b1afed3a..f7f5d201 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSShapeConstructor.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSShapeConstructor.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSStatic.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSStatic.cs index 6e6f304c..149bd8ee 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSStatic.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TSStatic.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainBlock.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainBlock.cs index 0bc5e114..b488e630 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainBlock.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainBlock.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainEditor.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainEditor.cs index 2d700a3d..fc2f8496 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainEditor.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainEditor.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainMaterial.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainMaterial.cs index be76bb64..b7beed92 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainMaterial.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainMaterial.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainSmoothAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainSmoothAction.cs index e0559606..bfdfacef 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainSmoothAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainSmoothAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainSolderEdgesAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainSolderEdgesAction.cs index a139cd46..56608b55 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainSolderEdgesAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TerrainSolderEdgesAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TheoraTextureObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TheoraTextureObject.cs index ca3635d1..85e0a2aa 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TheoraTextureObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TheoraTextureObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TimeOfDay.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TimeOfDay.cs index c95b8676..4f4eebd1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TimeOfDay.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TimeOfDay.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Trigger.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Trigger.cs index 8d16d7f1..4591284b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Trigger.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Trigger.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TriggerData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TriggerData.cs index f5107b39..d367e856 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TriggerData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TriggerData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TurretShape.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TurretShape.cs index 3c4e9027..58413999 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TurretShape.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TurretShape.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TurretShapeData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TurretShapeData.cs index 98b7a773..28c3c922 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TurretShapeData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/TurretShapeData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoAction.cs index a4440698..0b0056aa 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoManager.cs index 3b9b9722..93d7e0b5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoScriptAction.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoScriptAction.cs index 07034102..997753ff 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoScriptAction.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/UndoScriptAction.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Vehicle.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Vehicle.cs index d9e8a968..772b0b3c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Vehicle.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/Vehicle.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VehicleBlocker.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VehicleBlocker.cs index 1c829601..6acb1774 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VehicleBlocker.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VehicleBlocker.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VehicleData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VehicleData.cs index 29b3c9c3..f69b77f1 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VehicleData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VehicleData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VolumetricFog.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VolumetricFog.cs index dc1a128a..af0796a0 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VolumetricFog.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VolumetricFog.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VolumetricFogRTManager.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VolumetricFogRTManager.cs index b87efdf0..5cd7092c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VolumetricFogRTManager.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/VolumetricFogRTManager.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WalkableShape.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WalkableShape.cs index d50007aa..db4d0a09 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WalkableShape.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WalkableShape.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterBlock.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterBlock.cs index 7558e99c..258a7214 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterBlock.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterBlock.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterObject.cs index 2f56a1b6..c20d7585 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterPlane.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterPlane.cs index 757fbe94..e32389c5 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterPlane.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WaterPlane.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WayPoint.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WayPoint.cs index 8cbe92b7..b4d8483b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WayPoint.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WayPoint.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicle.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicle.cs index 6c3de1e1..4e3f3cab 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicle.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicle.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleData.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleData.cs index a89f78e9..f0633997 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleData.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleData.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleSpring.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleSpring.cs index 3adc846f..2b72378e 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleSpring.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleSpring.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleTire.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleTire.cs index f462a9fd..34537886 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleTire.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WheeledVehicleTire.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WorldEditor.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WorldEditor.cs index e3348bd4..f3b18db3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WorldEditor.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WorldEditor.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WorldEditorSelection.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WorldEditorSelection.cs index ee67c796..8a6154b4 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WorldEditorSelection.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/WorldEditorSelection.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ZipObject.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ZipObject.cs index 8304a5bf..8b0c05d8 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ZipObject.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/ZipObject.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxFoliageReplicator.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxFoliageReplicator.cs index 64146432..fb92023a 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxFoliageReplicator.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxFoliageReplicator.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxShapeReplicatedStatic.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxShapeReplicatedStatic.cs index e50ce623..fd2edd33 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxShapeReplicatedStatic.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxShapeReplicatedStatic.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxShapeReplicator.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxShapeReplicator.cs index d9caf814..6302cbd7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxShapeReplicator.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/Extendable/fxShapeReplicator.cs @@ -15,10 +15,10 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; -using Winterleaf.Demo.Full.Dedicated.Models.Base; +using WinterLeaf.Demo.Full.Models.Base; #endregion -namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable +namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// /// diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Main.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Main.cs index 93343173..16239953 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Main.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Main.cs @@ -20,12 +20,10 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.GameCode /// /// This is a required file, replaces main.cs in the root directory /// - /// + /// public static class Main { - private static readonly pInvokes omni = new pInvokes(); - /// /// Main entry point into the scripts. /// MANDITORY FUNCTION @@ -35,79 +33,79 @@ public static class Main [ConsoleInteraction(true)] public static int main(int argc, string[] argv) { - //t3d.Util._call("enableWinConsole", "true"); - //t3d.sGlobal["$test[1]"] = "test"; - //Console.WriteLine(t3d.sGlobal["$test[1]"]); + //pInvokes.Util._call("enableWinConsole", "true"); + //pInvokes.sGlobal["$test[1]"] = "test"; + //Console.WriteLine(pInvokes.sGlobal["$test[1]"]); - // + // // Set the name of our application - omni.sGlobal["$appName"] = "Full"; + pInvokes.sGlobal["$appName"] = "Full"; // The directory it is run from - omni.sGlobal["$defaultGame"] = "scripts"; + pInvokes.sGlobal["$defaultGame"] = "scripts"; // Set profile directory - omni.sGlobal["$Pref::Video::ProfilePath"] = "core/profile"; + pInvokes.sGlobal["$Pref::Video::ProfilePath"] = "core/profile"; - omni.bGlobal["$displayHelp"] = false; + pInvokes.bGlobal["$displayHelp"] = false; - omni.bGlobal["$isDedicated"] = false; + pInvokes.bGlobal["$isDedicated"] = false; - omni.iGlobal["$dirCount"] = 2; + pInvokes.iGlobal["$dirCount"] = 2; - omni.sGlobal["$userDirs"] = omni.sGlobal["$defaultGame"] + ";art;levels"; + pInvokes.sGlobal["$userDirs"] = pInvokes.sGlobal["$defaultGame"] + ";art;levels"; mainParseArgs(); // load tools scripts if we're a tool build - //if (omni.Util.isToolBuild() && !omni.bGlobal["$isDedicated"]) - // omni.sGlobal["$userDirs"] = "tools;" + omni.sGlobal["$userDirs"]; + //if (pInvokes.Util.isToolBuild() && !pInvokes.bGlobal["$isDedicated"]) + // pInvokes.sGlobal["$userDirs"] = "tools;" + pInvokes.sGlobal["$userDirs"]; // Parse the executable arguments with the standard // function from core/main.cs - if (omni.iGlobal["$dirCount"] == 0) + if (pInvokes.iGlobal["$dirCount"] == 0) { - omni.sGlobal["$userDirs"] = omni.sGlobal["$defaultGame"]; - omni.iGlobal["$dirCount"] = 1; + pInvokes.sGlobal["$userDirs"] = pInvokes.sGlobal["$defaultGame"]; + pInvokes.iGlobal["$dirCount"] = 1; } //----------------------------------------------------------------------------- // Display a splash window immediately to improve app responsiveness before // engine is initialized and main window created - if (!omni.bGlobal["$isDedicated"]) + if (!pInvokes.bGlobal["$isDedicated"]) { - omni.Util.displaySplashWindow("art/gui/omni.bmp"); + pInvokes.Util.displaySplashWindow("art/gui/pInvokes.bmp"); } - if (!omni.bGlobal["$logModeSpecified"]) + if (!pInvokes.bGlobal["$logModeSpecified"]) { - if (omni.sGlobal["$platform"] != "xbox" && omni.sGlobal["$platform"] != "xenon") - omni.Util.setLogMode(6); + if (pInvokes.sGlobal["$platform"] != "xbox" && pInvokes.sGlobal["$platform"] != "xenon") + pInvokes.Util.setLogMode(6); } - omni.Util.nextToken("$userDirs", "currentMod", ";"); + pInvokes.Util.nextToken("$userDirs", "currentMod", ";"); - omni.console.print("--------- Loading DIRS ---------"); + pInvokes.console.print("--------- Loading DIRS ---------"); /*Ok, so here is the deal. Until the tools are converted to a OMNI toolset we need to allow support of * packages in some way. Since packages require a base function and then override it we needed to * provide the basic torquescript functions for onStart,onExit,parseArgs. Instead of putting any * code into them, we just put a call back to our C# function. - * + * * So for example we defined a torquescript function onStart() it calls onMainStart() and onMainStart is wired via reflections * to the C# function event_onMainStart. Thus we satisfy the requirements of packages, in which the base function * must exist outside of a package to be overriden by a package. Therefore, since the Tools are still all in TorqueScript, * the Tools Package can now override onStart, onExit and parseArgs. - * - * + * + * * Pretty slick.... */ - omni.console.Eval(@" + pInvokes.console.Eval(@" function onStart() { onMainStart(); @@ -129,52 +127,52 @@ function loadKeybindings() SetConstantsForReferencingVideoResolutionPreference(); - loadDirs(omni.sGlobal["$userDirs"]); + loadDirs(pInvokes.sGlobal["$userDirs"]); //-----> Load tools here // Parse the command line arguments - omni.console.print("--------- Parsing Arguments ---------"); + pInvokes.console.print("--------- Parsing Arguments ---------"); mainParseArgs(); - if (omni.bGlobal["$displayHelp"]) + if (pInvokes.bGlobal["$displayHelp"]) { - omni.console.Call("enableWinConsole", new[] { "true" }); + pInvokes.console.Call("enableWinConsole", new[] { "true" }); displayHelp(); - //t3d.Util.quit(); + //pInvokes.Util.quit(); Main.Quit(); } else { //due to the Tools, this must be called through the console. - omni.console.Call("onStart"); + pInvokes.console.Call("onStart"); //onStart(); - omni.console.print("Engine initialized..."); - if (omni.sGlobal["$platform"] == "xenon") + pInvokes.console.print("Engine initialized..."); + if (pInvokes.sGlobal["$platform"] == "xenon") { const string mission = "levels//Empty Terrain.mis"; - omni.console.print("Xbox360 Autoloading level: '" + mission + "'"); - string serverType = omni.bGlobal["$pref::HostMultiPlayer"] ? "MultiPlayer" : "SinglePlayer"; + pInvokes.console.print("Xbox360 Autoloading level: '" + mission + "'"); + string serverType = pInvokes.bGlobal["$pref::HostMultiPlayer"] ? "MultiPlayer" : "SinglePlayer"; Winterleaf.Demo.Full.Dedicated.Models.User.GameCode.Server.server.createAndConnectToLocalServer(serverType, mission); } } - for (int i = 1; i < omni.iGlobal["$Game::argc"]; i++) + for (int i = 1; i < pInvokes.iGlobal["$Game::argc"]; i++) { - if (!omni.bGlobal["$argUsed[" + i + "]"]) - if (omni.sGlobal["$Game::argv[" + i + "]"].Trim() != "") - omni.console.error("Error: Unknown command line argument: " + - omni.sGlobal["$Game::argv[" + i + "]"]); + if (!pInvokes.bGlobal["$argUsed[" + i + "]"]) + if (pInvokes.sGlobal["$Game::argv[" + i + "]"].Trim() != "") + pInvokes.console.error("Error: Unknown command line argument: " + + pInvokes.sGlobal["$Game::argv[" + i + "]"]); } GuiCanvas canvas = "Canvas"; - if (omni.bGlobal["$startWorldEditor"]) + if (pInvokes.bGlobal["$startWorldEditor"]) { canvas.setCursor("DefaultCursor"); canvas.setContent("EditorChooseLevelGui"); } - else if (omni.bGlobal["$startGUIEditor"]) + else if (pInvokes.bGlobal["$startGUIEditor"]) { canvas.setCursor("DefaultCursor"); canvas.setContent("EditorChooseGUI"); @@ -210,37 +208,37 @@ public static void loadDir(string dir) pushBack("$useDirs", dir, ";"); if (!isScriptFile(dir + "/main.cs")) return; - omni.console.print("Calling " + dir + "/main.cs"); - omni.Util.exec(dir + "/main.cs", false, false); + pInvokes.console.print("Calling " + dir + "/main.cs"); + pInvokes.Util.exec(dir + "/main.cs", false, false); } [ConsoleInteraction(true)] public static void onMainExit() { - if (omni.bGlobal["$Server::Dedicated"]) + if (pInvokes.bGlobal["$Server::Dedicated"]) Winterleaf.Demo.Full.Dedicated.Models.User.GameCode.Server.server.destroyServer(); else - omni.console.Call("disconnect"); + pInvokes.console.Call("disconnect"); - omni.Util.physicsDestroy(); + pInvokes.Util.physicsDestroy(); - omni.console.print("Exporting client prefs"); + pInvokes.console.print("Exporting client prefs"); //Todo Settings - Switch this back when fixed. - omni.Util.export("$pref::*", "prefs.client.cs", false); - //omni.Util.exportToSettings("$pref::*", "scripts/client/prefs.cs", false); - // t3d.Util.exportToSettings("$Pref::*", "scripts/client/prefs1.cs", true); + pInvokes.Util.export("$pref::*", "prefs.client.cs", false); + //pInvokes.Util.exportToSettings("$pref::*", "scripts/client/prefs.cs", false); + // pInvokes.Util.exportToSettings("$Pref::*", "scripts/client/prefs1.cs", true); - omni.console.print("Exporting server prefs"); + pInvokes.console.print("Exporting server prefs"); //Todo Settings - Switch this back when fixed. - omni.Util.export("$Pref::Server::*", "prefs.server.cs", false); - //omni.Util.exportToSettings("$Pref::Server::*", "scripts/server/prefs.cs", false); + pInvokes.Util.export("$Pref::Server::*", "prefs.server.cs", false); + //pInvokes.Util.exportToSettings("$Pref::Server::*", "scripts/server/prefs.cs", false); - omni.console.Call_Classname("BanList", "Export", new[] { "prefs.banlist.cs" }); + pInvokes.console.Call_Classname("BanList", "Export", new[] { "prefs.banlist.cs" }); - omni.Util.stopFileChangeNotifications(); + pInvokes.Util.stopFileChangeNotifications(); Omni.self.StopEngine(); } @@ -249,7 +247,7 @@ public static void onMainExit() [ConsoleInteraction(true)] public static bool isScriptFile(string path) { - if (omni.Util.isFile(path + ".dso") || omni.Util.isFile(path)) + if (pInvokes.Util.isFile(path + ".dso") || pInvokes.Util.isFile(path)) return true; return false; } @@ -259,17 +257,17 @@ public static void loadDirs(string dirPath) string[] directorypaths = dirPath.Split(';'); for (int i = directorypaths.Count() - 1; i >= 0; i--) { - if (omni.Util.exec(directorypaths[i] + "/main.cs", false, false)) + if (pInvokes.Util.exec(directorypaths[i] + "/main.cs", false, false)) continue; - omni.console.error("Error: Unable to find specified directory: " + directorypaths[i]); - omni.iGlobal["$dirCount"]--; + pInvokes.console.error("Error: Unable to find specified directory: " + directorypaths[i]); + pInvokes.iGlobal["$dirCount"]--; } } public static void displayHelp() { - omni.console.error("Torque Demo command line options:\n" + + pInvokes.console.error("Torque Demo command line options:\n" + " -log Logging behavior; see main.cs comments for details\n" + " -game Reset list of mods to only contain \n" + " Works like the -game argument\n" + @@ -297,319 +295,319 @@ public static string pushBack(string list, string token, string delim) public static string popFront(string list, string delim) { - return omni.Util.nextToken(list, "", delim); + return pInvokes.Util.nextToken(list, "", delim); } [ConsoleInteraction(true)] public static void mainParseArgs() { - for (int i = 1; i < omni.iGlobal["$Game::argc"]; i++) + for (int i = 1; i < pInvokes.iGlobal["$Game::argc"]; i++) { - string arg = omni.sGlobal["$Game::argv[" + i + "]"]; - string nextArg = omni.sGlobal["$Game::argv[" + (i + 1) + "]"]; - bool hasNextarg = omni.iGlobal["$Game::argc"] - i > 1; - omni.bGlobal["$logModeSpecified"] = false; + string arg = pInvokes.sGlobal["$Game::argv[" + i + "]"]; + string nextArg = pInvokes.sGlobal["$Game::argv[" + (i + 1) + "]"]; + bool hasNextarg = pInvokes.iGlobal["$Game::argc"] - i > 1; + pInvokes.bGlobal["$logModeSpecified"] = false; System.Console.WriteLine(arg); switch (arg) { case "-log": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { if (nextArg.AsInt() != 0) { nextArg += 4; } - omni.Util.setLogMode(nextArg.AsInt()); - omni.bGlobal["$logModeSpecified"] = true; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util.setLogMode(nextArg.AsInt()); + pInvokes.bGlobal["$logModeSpecified"] = true; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.Util._error("Error: Missing Command Line argument. Usage: -log "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -log "); } break; case "-console": - omni.console.Call("enableWinConsole", new string[] { "true" }); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.console.Call("enableWinConsole", new string[] { "true" }); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-jSave": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util._echo("Saving event log to journal: '" + nextArg + "."); - omni.Util.saveJournal(nextArg); - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util._echo("Saving event log to journal: '" + nextArg + "."); + pInvokes.Util.saveJournal(nextArg); + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.Util._error("Error: Missing Command Line argument. Usage: -jSave "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jSave "); } break; case "-jPlay": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util.playJournal(nextArg); - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util.playJournal(nextArg); + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.Util._error("Error: Missing Command Line argument. Usage: -jPlay "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jPlay "); } break; case "-jPlayToVideo": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::journalName"] = nextArg; - omni.bGlobal["$VideoCapture::captureFromJournal"] = true; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::journalName"] = nextArg; + pInvokes.bGlobal["$VideoCapture::captureFromJournal"] = true; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error( + pInvokes.Util._error( "Error: Missing Command Line argument. Usage: -jPlayToVideo "); break; case "-vidCapFile": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::fileName"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::fileName"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.Util._error( + pInvokes.Util._error( "Error: Missing Command Line argument. Usage: -vidCapFile "); } break; case "-vidCapFPS": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::fps"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::fps"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.Util._error( + pInvokes.Util._error( "Error: Missing Command Line argument. Usage: -vidCapFPS "); } break; case "-vidCapEncoder": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::encoder"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::encoder"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.Util._error( + pInvokes.Util._error( "Error: Missing Command Line argument. Usage: -vidCapEncoder "); } break; case "-vidCapWidth": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$videoCapture::width"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$videoCapture::width"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.Util._error( + pInvokes.Util._error( "Error: Missing Command Line argument. Usage: -vidCapWidth "); } break; case "-vidCapHeight": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$videoCapture::height"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$videoCapture::height"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.Util._error( + pInvokes.Util._error( "Error: Missing Command Line argument. Usage: -vidCapHeight "); } break; case "-jDebug": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util.playJournal(nextArg); - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util.playJournal(nextArg); + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.Util._error("Error: Missing Command Line argument. Usage: -jDebug "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jDebug "); } break; case "-level": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { if (!nextArg.EndsWith(".mis")) { - omni.sGlobal["$levelToLoad"] = nextArg + ".mis"; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$levelToLoad"] = nextArg + ".mis"; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.sGlobal["$levelToLoad"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$levelToLoad"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } } else { - omni.console.error( + pInvokes.console.error( "Error: Missing Command Line argument. Usage: -level "); } break; case "-worldeditor": - omni.bGlobal["$startWorldEditor"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$startWorldEditor"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-guieditor": - omni.bGlobal["$startGUIEditor"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$startGUIEditor"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-help": - omni.bGlobal["$displayHelp"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$displayHelp"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-compileAll": - omni.bGlobal["$compileAll"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$compileAll"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-compileTools": - omni.bGlobal["$compileTools"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$compileTools"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-genScript": - omni.bGlobal["$genScript"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$genScript"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-fullscreen": - omni.console.Call("setFullScreen", new[] { "true" }); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.console.Call("setFullScreen", new[] { "true" }); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-windowed": - omni.console.Call("setFullScreen", new[] { "false" }); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.console.Call("setFullScreen", new[] { "false" }); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-openGL": - omni.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-directX": - omni.sGlobal["$pref::Video::displayDevice"] = "D3D"; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "D3D"; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-voodoo2": - omni.sGlobal["$pref::Video::displayDevice"] = "Voodoo2"; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "Voodoo2"; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-autoVideo": - omni.sGlobal["$pref::Video::displayDevice"] = ""; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = ""; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-prefs": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util.exec(nextArg, true, true); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.Util.exec(nextArg, true, true); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; i++; } else { - omni.Util._error("Error: Missing Command Line argument. Usage: -prefs "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -prefs "); } break; case "-dedicated": - omni.bGlobal["$Server::Dedicated"] = true; - omni.bGlobal["$isDedicated"] = true; - omni.console.Call("enableWinConsole", new[] { "true" }); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$Server::Dedicated"] = true; + pInvokes.bGlobal["$isDedicated"] = true; + pInvokes.console.Call("enableWinConsole", new[] { "true" }); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-mission": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$missionArg"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$missionArg"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.console.error("Error: Missing Command Line argument. Usage: -mission "); + pInvokes.console.error("Error: Missing Command Line argument. Usage: -mission "); break; case "-connect": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$JoinGameAddress"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$JoinGameAddress"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.console.error("Error: Missing Command Line argument. Usage: -connect "); + pInvokes.console.error("Error: Missing Command Line argument. Usage: -connect "); break; } } - if (omni.bGlobal["$VideoCapture::captureFromJournal"] && (omni.sGlobal["$VideoCapture::journalName"] != "")) + if (pInvokes.bGlobal["$VideoCapture::captureFromJournal"] && (pInvokes.sGlobal["$VideoCapture::journalName"] != "")) { - if (omni.sGlobal["$VideoCapture::fileName"] == "") - omni.sGlobal["$VideoCapture::fileName"] = omni.sGlobal["$VideoCapture::journalName"]; + if (pInvokes.sGlobal["$VideoCapture::fileName"] == "") + pInvokes.sGlobal["$VideoCapture::fileName"] = pInvokes.sGlobal["$VideoCapture::journalName"]; - if (omni.sGlobal["$VideoCapture::encoder"] == "") - omni.sGlobal["$VideoCapture::encoder"] = "THEORA"; + if (pInvokes.sGlobal["$VideoCapture::encoder"] == "") + pInvokes.sGlobal["$VideoCapture::encoder"] = "THEORA"; - if (omni.sGlobal["$VideoCapture::fps"] == "") - omni.sGlobal["$VideoCapture::fps"] = "30"; + if (pInvokes.sGlobal["$VideoCapture::fps"] == "") + pInvokes.sGlobal["$VideoCapture::fps"] = "30"; - if (omni.sGlobal["$videoCapture::width"] == "") - omni.sGlobal["$videoCapture::width"] = "0"; + if (pInvokes.sGlobal["$videoCapture::width"] == "") + pInvokes.sGlobal["$videoCapture::width"] = "0"; - if (omni.sGlobal["$videoCapture::height"] == "") - omni.sGlobal["$videoCapture::height"] = "0"; + if (pInvokes.sGlobal["$videoCapture::height"] == "") + pInvokes.sGlobal["$videoCapture::height"] = "0"; - omni.Util.playJournalToVideo(omni.sGlobal["$VideoCapture::journalName"], - omni.sGlobal["$VideoCapture::fileName"], omni.sGlobal["$VideoCapture::encoder"], - omni.fGlobal["$VideoCapture::fps"], - new Point2I(omni.sGlobal["$videoCapture::width"].AsInt(), - omni.sGlobal["$videoCapture::height"].AsInt())); + pInvokes.Util.playJournalToVideo(pInvokes.sGlobal["$VideoCapture::journalName"], + pInvokes.sGlobal["$VideoCapture::fileName"], pInvokes.sGlobal["$VideoCapture::encoder"], + pInvokes.fGlobal["$VideoCapture::fps"], + new Point2I(pInvokes.sGlobal["$videoCapture::width"].AsInt(), + pInvokes.sGlobal["$videoCapture::height"].AsInt())); } } public static void SetConstantsForReferencingVideoResolutionPreference() { - omni.iGlobal["$WORD::RES_X"] = 0; - omni.iGlobal["$WORD::RES_Y"] = 1; - omni.iGlobal["$WORD::FULLSCREEN"] = 2; - omni.iGlobal["$WORD::BITDEPTH"] = 3; - omni.iGlobal["$WORD::REFRESH"] = 4; - omni.iGlobal["$WORD::AA"] = 5; + pInvokes.iGlobal["$WORD::RES_X"] = 0; + pInvokes.iGlobal["$WORD::RES_Y"] = 1; + pInvokes.iGlobal["$WORD::FULLSCREEN"] = 2; + pInvokes.iGlobal["$WORD::BITDEPTH"] = 3; + pInvokes.iGlobal["$WORD::REFRESH"] = 4; + pInvokes.iGlobal["$WORD::AA"] = 5; } [ConsoleInteraction(true)] @@ -617,62 +615,62 @@ public static void onMainStart() { #region FPS - + Server.server.LoadDefaults(); #endregion // Here is where we will do the video device stuff, so it overwrites the defaults // First set the PCI device variables (yes AGP/PCI-E works too) - omni.iGlobal["$isFirstPersonVar"] = 1; + pInvokes.iGlobal["$isFirstPersonVar"] = 1; // Uncomment to enable AdvancedLighting on the Mac (T3D 2009 Beta 3) - omni.bGlobal["$pref::machax::enableAdvancedLighting"] = true; + pInvokes.bGlobal["$pref::machax::enableAdvancedLighting"] = true; // Uncomment to disable ShaderGen, useful when debugging - //omni.bGlobal["$ShaderGen::GenNewShaders"] = false; + //pInvokes.bGlobal["$ShaderGen::GenNewShaders"] = false; // Uncomment to dump disassembly for any shader that is compiled to disk. // These will appear as shadername_dis.txt in the same path as the - // hlsl or glsl shader. - //omni.bGlobal["$gfx::disassembleAllShaders"] = true; + // hlsl or glsl shader. + //pInvokes.bGlobal["$gfx::disassembleAllShaders"] = true; // Uncomment useNVPerfHud to allow you to start up correctly // when you drop your executable onto NVPerfHud - //omni.bGlobal["$Video::useNVPerfHud"] = true; + //pInvokes.bGlobal["$Video::useNVPerfHud"] = true; // Uncomment these to allow you to force your app into using // a specific pixel shader version (0 is for fixed function) - //omni.bGlobal["$pref::Video::forcePixVersion"] = true; - //omni.iGlobal["$pref::Video::forcedPixVersion"] = 0; + //pInvokes.bGlobal["$pref::Video::forcePixVersion"] = true; + //pInvokes.iGlobal["$pref::Video::forcedPixVersion"] = 0; - //if (omni.sGlobal["$platform"] == "macos") - //omni.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; + //if (pInvokes.sGlobal["$platform"] == "macos") + //pInvokes.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; //else - //omni.sGlobal["$pref::Video::displayDevice"] = "D3D9"; - if (omni.bGlobal["$isDedicated"]) + //pInvokes.sGlobal["$pref::Video::displayDevice"] = "D3D9"; + if (pInvokes.bGlobal["$isDedicated"]) { - omni.Util.setRandomSeed((DateTime.Now.Millisecond + 1) * (DateTime.Now.Second + 1)); + pInvokes.Util.setRandomSeed((DateTime.Now.Millisecond + 1) * (DateTime.Now.Second + 1)); // Set up networking. - omni.Util.setNetPort(0); + pInvokes.Util.setNetPort(0); // Initialize the canvas. - omni.console.Call_Classname("GFXInit", "createNullDevice"); - // Start processing file change events. - omni.Util.startFileChangeNotifications(); + pInvokes.console.Call_Classname("GFXInit", "createNullDevice"); + // Start processing file change events. + pInvokes.Util.startFileChangeNotifications(); } - - omni.Util._echo(" % - Initialized Core"); + + pInvokes.Util._echo(" % - Initialized Core"); #region FPS - omni.console.print("\n--------- Initializing Directory: scripts ---------"); + pInvokes.console.print("\n--------- Initializing Directory: scripts ---------"); // Init the physics plugin. - omni.Util.physicsInit("Bullet"); + pInvokes.Util.physicsInit("Bullet"); // Start up the audio system. //audio.sfxStartup(); @@ -695,10 +693,10 @@ public static void onMainStart() [ConsoleInteraction(true)] public static void mainloadKeybindings() { - omni.iGlobal["$keybindCount"] = 0; + pInvokes.iGlobal["$keybindCount"] = 0; // Load up the active projects keybinds. - if (omni.Util.isFunction("setupKeybinds")) - omni.console.Call("setupKeybinds"); + if (pInvokes.Util.isFunction("setupKeybinds")) + pInvokes.console.Call("setupKeybinds"); } @@ -707,4 +705,4 @@ public static void mainloadKeybindings() } -} \ No newline at end of file +} diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/AI/AI.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/AI/AI.cs index 76f2ce60..d56d5401 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/AI/AI.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/AI/AI.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -55,7 +55,6 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.GameCode.Server.AI public class AI { private static readonly Random r = new Random(); - private static readonly pInvokes omni = new pInvokes(); internal static readonly ConcurrentList m_thoughtqueue = new ConcurrentList(); internal static int _lastcount; private static readonly object _lastcount_lock = new object(); @@ -94,7 +93,7 @@ public static void createAI(int count) if (lastcount > 0) { - omni.console.error("Mobs already spawned"); + pInvokes.console.error("Mobs already spawned"); return; } using (BackgroundWorker bwr_AIThought = new BackgroundWorker()) @@ -134,8 +133,8 @@ public static void deleteAI() for (int i = 0; i < lastcount; i++) { ScriptObject mobholder = "Mob" + i.AsString(); - omni.Util.cancelAll(mobholder); - omni.Util.cancelAll(mobholder["player"]); + pInvokes.Util.cancelAll(mobholder); + pInvokes.Util.cancelAll(mobholder["player"]); mobholder["player"].delete(); mobholder.delete(); } @@ -227,7 +226,7 @@ public static UInt32 Spawn(string name, TransformF spawnpoint) /// public static DemoPlayer SpawnOnPath(string ainame, SimSet path) { - if (!omni.console.isObject(path)) + if (!pInvokes.console.isObject(path)) return null; Marker node = path.getObject((uint) r.Next(0, path.getCount() - 1)); @@ -248,7 +247,7 @@ public static void spawnAI(ScriptObject aiManager) { if (!aiManager.isObject()) { - omni.console.error("Bad aiManager!"); + pInvokes.console.error("Bad aiManager!"); return; } @@ -256,12 +255,12 @@ public static void spawnAI(ScriptObject aiManager) if (aiPlayer == null) { - omni.console.error("UNABLE TO SPAWN MONSTER!@!!!!!a"); + pInvokes.console.error("UNABLE TO SPAWN MONSTER!@!!!!!a"); return; } - if (!omni.console.isObject(aiPlayer)) + if (!pInvokes.console.isObject(aiPlayer)) { - omni.console.error("UNABLE TO SPAWN MONSTER!@!!!!!"); + pInvokes.console.error("UNABLE TO SPAWN MONSTER!@!!!!!"); return; } @@ -370,4 +369,4 @@ public threadparam(int delay, int mobroot) } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/GameConnection.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/GameConnection.cs index 43aa7634..5927c974 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/GameConnection.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/GameConnection.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -55,8 +55,6 @@ partial class GameConnection { #region Static Variables - private static readonly pInvokes tst = new pInvokes(); - #endregion #region Overrides @@ -86,7 +84,7 @@ public override void onDrop(string disconnectReason) /// anything else will be sent back as an error to the client. /// All the connect args are passed also to onConnectRequest /// - /// NOTE: Need to fallback to Con::execute() as IMPLEMENT_CALLBACK does not + /// NOTE: Need to fallback to Con::execute() as IMPLEMENT_CALLBACK does not /// support variadic functions. ///todo research this a bit, from what I read this function can take up to 16 params. It's a console execute because of variable args. /// @@ -209,12 +207,12 @@ public virtual int GetDeaths(GameConnection client) public virtual void onLeaveMissionArea() { - message.MessageClient(this, "MsgClientJoin", tst.console.ColorEncode(@"\c2Now leaving the mission area!")); + message.MessageClient(this, "MsgClientJoin", pInvokes.console.ColorEncode(@"\c2Now leaving the mission area!")); } public virtual void onEnterMissionArea() { - message.MessageClient(this, "MsgClientJoin", tst.console.ColorEncode(@"\c2Now entering the mission area!")); + message.MessageClient(this, "MsgClientJoin", pInvokes.console.ColorEncode(@"\c2Now entering the mission area!")); } #endregion @@ -880,4 +878,4 @@ public virtual void onDeath(GameBase sourceobject, GameConnection sourceclient, missionLoad.cycleGame(); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/ShapeBase/ShapeBase.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/ShapeBase/ShapeBase.cs index 89ad2858..e2dbbebc 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/ShapeBase/ShapeBase.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/ShapeBase/ShapeBase.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -49,12 +49,10 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.Extendable { /// - /// + /// /// public partial class ShapeBase { - private static pInvokes tst = new pInvokes(); - public override bool OnFunctionNotFoundCallTorqueScript() { return false; @@ -98,7 +96,7 @@ public virtual void clearDamageDt() if (this["damageSchedule"] == string.Empty) return; - new pInvokes().Util.cancel(this["damageSchedule"].AsInt()); + pInvokes.Util.cancel(this["damageSchedule"].AsInt()); this["damageSchedule"] = string.Empty; } @@ -441,4 +439,4 @@ public virtual void cycleWeapon(string direction) Use(weapon); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs index 892598d3..9382420b 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. //----------------------------------------------------------------------------- // Logicking's Game Factory @@ -46,8 +46,6 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.GameCode.Server.SoftBodies { public class SoftBodies { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { #region SoftBodyData ( PhysFlag ) oc_Newobject1 @@ -91,7 +89,7 @@ public static void initialize() //----------------------------------------------------------------------------- // for Game Mechanics Editor //----------------------------------------------------------------------------- - omni.Util.activatePackage("TemplateFunctions"); + pInvokes.Util.activatePackage("TemplateFunctions"); //TODO FIX //inheritTemplate("PhysFlag", "AbstractRigidBody"); @@ -100,7 +98,7 @@ public static void initialize() //inheritTemplate("PhysSoftSphere", "AbstractRigidBody"); //registerTemplate("PhysSoftSphere", "Physics", "SoftBodyData::create(PhysSoftSphere);"); - omni.Util.deactivatePackage("TemplateFunctions"); + pInvokes.Util.deactivatePackage("TemplateFunctions"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/centerPrint.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/centerPrint.cs index 1891bfe1..1be10631 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/centerPrint.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/centerPrint.cs @@ -56,8 +56,8 @@ public static void CenterPrintAll(string message, string time, string lines) lines = "1"; foreach (GameConnection client in - t3d.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) - t3d.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); + pInvokes.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) + pInvokes.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] @@ -66,8 +66,8 @@ public static void BottomPrintAll(string message, string time, string lines) if (lines == "" || lines.AsInt() > 3 || lines.AsInt() < 1) lines = "1"; foreach (GameConnection client in - t3d.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) - t3d.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); + pInvokes.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) + pInvokes.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] @@ -76,7 +76,7 @@ public static void CenterPrint(GameConnection client, string message, string tim if (lines == "" || lines.AsInt() > 3 || lines.AsInt() < 1) lines = "1"; - t3d.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); + pInvokes.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] @@ -85,19 +85,19 @@ public static void BottomPrint(GameConnection client, string message, string tim if (lines == "" || lines.AsInt() > 3 || lines.AsInt() < 1) lines = "1"; - t3d.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); + pInvokes.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] public static void ClearCenterPrint(GameConnection client) { - t3d.console.commandToClient(client, "ClearCenterPrint"); + pInvokes.console.commandToClient(client, "ClearCenterPrint"); } [ConsoleInteraction(true)] public static void ClearBottomPrint(GameConnection client) { - t3d.console.commandToClient(client, "clearBottomPrint"); + pInvokes.console.commandToClient(client, "clearBottomPrint"); } [ConsoleInteraction(true)] @@ -109,10 +109,10 @@ public static void ClearCenterPrintAll() { GameConnection cl = ClientGroup.getObject(i); if (!cl.isAIControlled()) - t3d.console.commandToClient(cl, "ClearCenterPrint"); + pInvokes.console.commandToClient(cl, "ClearCenterPrint"); } - //foreach (uint client in t3d.ClientGroup.Cast().Where(client => !client.isAIControlled())) - // t3d.console.commandToClient(client.AsString(), "ClearCenterPrint"); + //foreach (uint client in pInvokes.ClientGroup.Cast().Where(client => !client.isAIControlled())) + // pInvokes.console.commandToClient(client.AsString(), "ClearCenterPrint"); } [ConsoleInteraction(true)] @@ -124,10 +124,10 @@ public static void ClearBottomPrintAll() { GameConnection cl = ClientGroup.getObject(i); if (!cl.isAIControlled()) - t3d.console.commandToClient(cl, "ClearBottomPrint"); + pInvokes.console.commandToClient(cl, "ClearBottomPrint"); } - //foreach (uint client in t3d.ClientGroup.Cast().Where(client => !client.isAIControlled())) - // t3d.console.commandToClient(client.AsString(), "clearBottomPrint"); + //foreach (uint client in pInvokes.ClientGroup.Cast().Where(client => !client.isAIControlled())) + // pInvokes.console.commandToClient(client.AsString(), "clearBottomPrint"); } } } \ No newline at end of file diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/commands.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/commands.cs index d14aebf5..8bca29c7 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/commands.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/commands.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -50,7 +50,6 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.GameCode.Server { public class commands { - private static readonly pInvokes omni = new pInvokes(); //----------------------------------------------------------------------------- // Misc. server commands avialable to clients //----------------------------------------------------------------------------- @@ -100,7 +99,7 @@ public static void serverCmdSetEditorCameraPlayer(GameConnection client) ((Player) client["player"]).setVelocity(new Point3F("0 0 0")); client.setControlObject(client["player"]); client.setFirstPerson(true); - omni.bGlobal["$isFirstPersonVar"] = true; + pInvokes.bGlobal["$isFirstPersonVar"] = true; } [ConsoleInteraction(true)] @@ -109,7 +108,7 @@ public static void serverCmdSetEditorCameraPlayerThird(GameConnection client) ((Player) client["player"]).setVelocity(new Point3F("0 0 0")); client.setControlObject(client["player"]); client.setFirstPerson(false); - omni.bGlobal["$isFirstPersonVar"] = false; + pInvokes.bGlobal["$isFirstPersonVar"] = false; } [ConsoleInteraction(true)] @@ -121,7 +120,7 @@ public static void serverCmdDropPlayerAtCamera(GameConnection client) ShapeBase obj = null; obj = player.getObjectMount(); - if (!omni.console.isObject(obj)) + if (!pInvokes.console.isObject(obj)) obj = client["player"]; obj.setTransform(((Extendable.Camera) client["Camera"]).getTransform()); @@ -240,21 +239,21 @@ public static void serverCmdEditorCameraAutoFit(GameConnection client, float rad [ConsoleInteraction(true)] public static void serverCmdSAD(GameConnection client, string password) { - if (password == string.Empty || password != omni.sGlobal["$Pref::Server::AdminPassword"]) + if (password == string.Empty || password != pInvokes.sGlobal["$Pref::Server::AdminPassword"]) return; client["isAdmin"] = true.AsString(); client["isSuperAdmin"] = true.AsString(); - string name = omni.console.getTaggedString(client["playerName"]); + string name = pInvokes.console.getTaggedString(client["playerName"]); - message.MessageAll("MsgAdminForce", omni.console.ColorEncode(string.Format(@"\c2{0} has become Admin by force.", name)), client); + message.MessageAll("MsgAdminForce", pInvokes.console.ColorEncode(string.Format(@"\c2{0} has become Admin by force.", name)), client); } [ConsoleInteraction(true)] public static void serverCmdSADSetPassword(GameConnection client, string password) { if (client["isSuperAdmin"].AsBool()) - omni.sGlobal["$Pref::Server::AdminPassword"] = password; + pInvokes.sGlobal["$Pref::Server::AdminPassword"] = password; } //---------------------------------------------------------------------------- @@ -264,17 +263,17 @@ public static void serverCmdSADSetPassword(GameConnection client, string passwor [ConsoleInteraction(true)] public static void serverCmdTeamMessageSent(GameConnection client, string text) { - if (text.Trim().Length >= omni.iGlobal["$Pref::Server::MaxChatLen"]) - text = text.Substring(0, omni.iGlobal["$Pref::Server::MaxChatLen"]); - message.ChatMessageTeam(client, client["team"], omni.console.ColorEncode(@"\c3%1: %2"), client["playerName"], text); + if (text.Trim().Length >= pInvokes.iGlobal["$Pref::Server::MaxChatLen"]) + text = text.Substring(0, pInvokes.iGlobal["$Pref::Server::MaxChatLen"]); + message.ChatMessageTeam(client, client["team"], pInvokes.console.ColorEncode(@"\c3%1: %2"), client["playerName"], text); } [ConsoleInteraction(true)] public static void ServerCmdMessageSent(GameConnection client, string text) { - if (text.Trim().Length >= omni.iGlobal["$Pref::Server::MaxChatLen"]) - text = text.Substring(0, omni.iGlobal["$Pref::Server::MaxChatLen"]); - message.ChatMessageAll(client, omni.console.ColorEncode(@"\c4%1: %2"), client["playerName"], text); + if (text.Trim().Length >= pInvokes.iGlobal["$Pref::Server::MaxChatLen"]) + text = text.Substring(0, pInvokes.iGlobal["$Pref::Server::MaxChatLen"]); + message.ChatMessageAll(client, pInvokes.console.ColorEncode(@"\c4%1: %2"), client["playerName"], text); } [ConsoleInteraction(true)] @@ -303,10 +302,10 @@ public static void serverCmdThrow(GameConnection client, string data) { Player player = client["player"]; - if (!player.isObject() || (player.getState() == "Dead") || !omni.bGlobal["$Game::Running"]) + if (!player.isObject() || (player.getState() == "Dead") || !pInvokes.bGlobal["$Game::Running"]) return; - SimObject mountedimage = player.getMountedImage(omni.iGlobal["$WeaponSlot"]); + SimObject mountedimage = player.getMountedImage(pInvokes.iGlobal["$WeaponSlot"]); switch (data) { case "Weapon": @@ -345,7 +344,7 @@ public static void serverCmdCycleWeapon(GameConnection client, string direction) [ConsoleInteraction(true)] public static void serverCmdUnmountWeapon(GameConnection client) { - ((Player) client["player"]).unmountImage(omni.iGlobal["$WeaponSlot"]); + ((Player) client["player"]).unmountImage(pInvokes.iGlobal["$WeaponSlot"]); } [ConsoleInteraction(true)] @@ -353,13 +352,13 @@ public static void serverCmdReloadWeapon(GameConnection client) { Player player = client["player"]; - WeaponImage image = player.getMountedImage(omni.iGlobal["$WeaponSlot"]); + WeaponImage image = player.getMountedImage(pInvokes.iGlobal["$WeaponSlot"]); if (player.getInventory(image["ammo"]) == image["ammo.maxInventory"].AsInt()) return; if (image > 0) - image.clearAmmoClip(player, omni.sGlobal["$WeaponSlot"].AsInt()); + image.clearAmmoClip(player, pInvokes.sGlobal["$WeaponSlot"].AsInt()); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/gameDM.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/gameDM.cs index 252b3e28..20e2eef3 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/gameDM.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/gameDM.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using Winterleaf.Demo.Full.Dedicated.Models.User.CustomObjects.Utilities; using Winterleaf.Demo.Full.Dedicated.Models.User.Extendable; @@ -43,8 +43,6 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.GameCode.Server { internal class gameDM : gameBase { - public static pInvokes omni = new pInvokes(); - //To extend the base game functionality override the functions here. public override void onMissionLoaded() { @@ -83,10 +81,10 @@ public static void sendMsgClientKilled_Default(string msgtype, GameConnection cl if (sourceclient == client) sendMsgClientKilled_Suicide(msgtype, client, sourceclient, damloc); - else if (omni.console.GetVarString(sourceclient["team"]) != string.Empty && sourceclient["team"] != client["team"]) + else if (pInvokes.console.GetVarString(sourceclient["team"]) != string.Empty && sourceclient["team"] != client["team"]) message.MessageAll(msgtype, "%1 killed by %2 - friendly fire!", client["playerName"], sourceclient["playerName"]); else message.MessageAll(msgtype, "%1 gets nailed by %2!", client["playerName"], sourceclient.isObject() ? sourceclient["playerName"] : "a Bot!"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/kickban.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/kickban.cs index 60ca15b1..5d34511c 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/kickban.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/kickban.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -46,24 +46,22 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.GameCode.Server { public class kickban { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void Kick(GameConnection client) { - message.MessageAll("MsgAdminForce", omni.console.ColorEncode(@"\c2The Admin has kicked %1."), client["playerName"]); + message.MessageAll("MsgAdminForce", pInvokes.console.ColorEncode(@"\c2The Admin has kicked %1."), client["playerName"]); if (!client.isAIControlled()) - omni.console.Call_Classname("BanList", "add", new[] {client["guid"], client.getAddress(), omni.sGlobal["$Pref::Server::KickBanTime"]}); + pInvokes.console.Call_Classname("BanList", "add", new[] {client["guid"], client.getAddress(), pInvokes.sGlobal["$Pref::Server::KickBanTime"]}); client.delete("You have been kicked from this server"); } [ConsoleInteraction(true)] public static void Ban(GameConnection client) { - message.MessageAll("MsgAdminForce", omni.console.ColorEncode(@"\c2The Admin has banned %1."), client["playerName"]); + message.MessageAll("MsgAdminForce", pInvokes.console.ColorEncode(@"\c2The Admin has banned %1."), client["playerName"]); if (!client.isAIControlled()) - omni.console.Call_Classname("BanList", "add", new[] {client["guid"], client.getAddress(), omni.sGlobal["$Pref::Server::BanTime"]}); + pInvokes.console.Call_Classname("BanList", "add", new[] {client["guid"], client.getAddress(), pInvokes.sGlobal["$Pref::Server::BanTime"]}); client.delete("You have been banned from this server"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/server.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/server.cs index b7a7475f..afb341e6 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/server.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/server.cs @@ -54,12 +54,12 @@ public static void LoadDefaults() { // List of master servers to query, each one is tried in order // until one responds - t3d.iGlobal["$Pref::Server::RegionMask"] = 2; - t3d.sGlobal["$pref::Master[0]"] = "2:master.garagegames.com:28002"; + pInvokes.iGlobal["$Pref::Server::RegionMask"] = 2; + pInvokes.sGlobal["$pref::Master[0]"] = "2:master.garagegames.com:28002"; // Information about the server - t3d.sGlobal["$Pref::Server::Name"] = "Torque 3D Server"; - t3d.sGlobal["$Pref::Server::Info"] = "This is a Torque 3D server."; + pInvokes.sGlobal["$Pref::Server::Name"] = "Torque 3D Server"; + pInvokes.sGlobal["$Pref::Server::Info"] = "This is a Torque 3D server."; // The connection error message is transmitted to the client immediatly // on connection, if any further error occures during the connection @@ -67,68 +67,68 @@ public static void LoadDefaults() // message is display. This message should be replaced with information // usefull to the client, such as the url or ftp address of where the // latest version of the game can be obtained. - t3d.sGlobal["$Pref::Server::ConnectionError"] = "You do not have the correct version of the FPS starter kit or " + "the related art needed to play on this server, please contact " + "the server operator for more information."; + pInvokes.sGlobal["$Pref::Server::ConnectionError"] = "You do not have the correct version of the FPS starter kit or " + "the related art needed to play on this server, please contact " + "the server operator for more information."; // The network port is also defined by the client, this value // overrides pref::net::port for dedicated servers - t3d.iGlobal["$Pref::Server::Port"] = 28000; + pInvokes.iGlobal["$Pref::Server::Port"] = 28000; // If the password is set, clients must provide it in order // to connect to the server - t3d.sGlobal["$Pref::Server::Password"] = string.Empty; + pInvokes.sGlobal["$Pref::Server::Password"] = string.Empty; // Password for admin clients - t3d.sGlobal["$Pref::Server::AdminPassword"] = string.Empty; + pInvokes.sGlobal["$Pref::Server::AdminPassword"] = string.Empty; // Misc server settings. - t3d.iGlobal["$Pref::Server::MaxPlayers"] = 64; - t3d.iGlobal["$Pref::Server::TimeLimit"] = 20; // In minutes - t3d.iGlobal["$Pref::Server::KickBanTime"] = 300; // specified in seconds - t3d.iGlobal["$Pref::Server::BanTime"] = 1800; // specified in seconds - t3d.iGlobal["$Pref::Server::FloodProtectionEnabled"] = 1; - t3d.iGlobal["$Pref::Server::MaxChatLen"] = 120; + pInvokes.iGlobal["$Pref::Server::MaxPlayers"] = 64; + pInvokes.iGlobal["$Pref::Server::TimeLimit"] = 20; // In minutes + pInvokes.iGlobal["$Pref::Server::KickBanTime"] = 300; // specified in seconds + pInvokes.iGlobal["$Pref::Server::BanTime"] = 1800; // specified in seconds + pInvokes.iGlobal["$Pref::Server::FloodProtectionEnabled"] = 1; + pInvokes.iGlobal["$Pref::Server::MaxChatLen"] = 120; - t3d.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"] = typeof (GameConnectionDM).FullName; + pInvokes.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"] = typeof (GameConnectionDM).FullName; //todo Now add your own game specific server preferences as well as any overloaded core defaults here. // Finally load the preferences saved from the last // game execution if they exist. - if (t3d.sGlobal["$platform"] != "xenon") + if (pInvokes.sGlobal["$platform"] != "xenon") { //Todo Settings - Switch this back when fixed. - t3d.Util.exec("prefs.server.cs", false, false); + pInvokes.Util.exec("prefs.server.cs", false, false); //Settings.LoadSection("scripts/server/prefs.cs"); } else - t3d.Util._error("Not loading server prefs.cs on Xbox360"); + pInvokes.Util._error("Not loading server prefs.cs on Xbox360"); } public static void initDedicated() { - t3d.console.Call("enableWinConsole", new[] {"true"}); + pInvokes.console.Call("enableWinConsole", new[] {"true"}); //con.Eval("enableWinConsole(true);"); - t3d.console.print(@"\n--------- Starting Dedicated Server ---------"); + pInvokes.console.print(@"\n--------- Starting Dedicated Server ---------"); // Make sure this variable reflects the correct state. - t3d.bGlobal["$Server::Dedicated"] = true; + pInvokes.bGlobal["$Server::Dedicated"] = true; // The server isn't started unless a mission has been specified. - if (t3d.sGlobal["$missionArg"] != string.Empty) - createServer("MultiPlayer", t3d.sGlobal["$missionArg"]); + if (pInvokes.sGlobal["$missionArg"] != string.Empty) + createServer("MultiPlayer", pInvokes.sGlobal["$missionArg"]); else - t3d.console.print("No mission specified (use -mission filename)"); + pInvokes.console.print("No mission specified (use -mission filename)"); } public static void initServer() { - t3d.console.print("\n--------- Initializing " + t3d.sGlobal["$appName"] + ": Server Scripts ---------"); + pInvokes.console.print("\n--------- Initializing " + pInvokes.sGlobal["$appName"] + ": Server Scripts ---------"); // Server::Status is returned in the Game Info Query and represents the // current status of the server. This string sould be very short. - t3d.sGlobal["$Server::Status"] = "Unknown"; + pInvokes.sGlobal["$Server::Status"] = "Unknown"; // Turn on testing/debug script functions - t3d.bGlobal["$Server::TestCheats"] = false; + pInvokes.bGlobal["$Server::TestCheats"] = false; // Specify where the mission files are. - t3d.sGlobal["$Server::MissionFileSpec"] = "levels/*.mis"; + pInvokes.sGlobal["$Server::MissionFileSpec"] = "levels/*.mis"; // The common module provides the basic server functionality initBaseServer(); @@ -143,16 +143,16 @@ public static void initBaseServer() missionLoad.InitMissionLoad(); game.initGame(); spawn.init(); - t3d.iGlobal["$Camera::movementSpeed"] = 30; + pInvokes.iGlobal["$Camera::movementSpeed"] = 30; // Models.User.GameCode.Client.CenterPrint.centerPrint.initialize(); } public static void portInit(int port) { int failCount = 0; - while (failCount < 10 && !t3d.Util.setNetPort(port)) + while (failCount < 10 && !pInvokes.Util.setNetPort(port)) { - t3d.console.print("Port init failed on port " + port + " trying next port."); + pInvokes.console.print("Port init failed on port " + port + " trying next port."); port++; failCount++; } @@ -174,12 +174,12 @@ public static bool createAndConnectToLocalServer(string serverType, string level if (!createServer(serverType, level)) return false; - GameConnection conn = new ObjectCreator("GameConnection", "ServerConnection", t3d.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"]).Create(); + GameConnection conn = new ObjectCreator("GameConnection", "ServerConnection", pInvokes.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"]).Create(); ((SimGroup) "RootGroup").add(conn); - conn.setConnectArgs(t3d.sGlobal["$pref::Player::Name"]); - conn.setJoinPassword(t3d.sGlobal["$Client::Password"]); + conn.setConnectArgs(pInvokes.sGlobal["$pref::Player::Name"]); + conn.setJoinPassword(pInvokes.sGlobal["$Client::Password"]); if (conn.connectLocal() != string.Empty) { @@ -200,51 +200,51 @@ public static bool createAndConnectToLocalServer(string serverType, string level [ConsoleInteraction(true)] public static bool createServer(string serverType, string level) { - t3d.iGlobal["$Server::Session"]++; + pInvokes.iGlobal["$Server::Session"]++; if (level == string.Empty) { - t3d.console.error("createServer(): level name unspecified"); + pInvokes.console.error("createServer(): level name unspecified"); return false; } - level = t3d.Util.makeRelativePath(level, t3d.Util.getWorkingDirectory()); + level = pInvokes.Util.makeRelativePath(level, pInvokes.Util.getWorkingDirectory()); destroyServer(); - t3d.iGlobal["$missionSequence"] = 0; - t3d.iGlobal["$Server::PlayerCount"] = 0; - t3d.sGlobal["$Server::ServerType"] = serverType; - t3d.sGlobal["$Server::LoadFailMsg"] = string.Empty; - t3d.bGlobal["$Physics::isSinglePlayer"] = true; + pInvokes.iGlobal["$missionSequence"] = 0; + pInvokes.iGlobal["$Server::PlayerCount"] = 0; + pInvokes.sGlobal["$Server::ServerType"] = serverType; + pInvokes.sGlobal["$Server::LoadFailMsg"] = string.Empty; + pInvokes.bGlobal["$Physics::isSinglePlayer"] = true; // Setup for multi-player, the network must have been // initialized before now. if (serverType == "MultiPlayer") { - //t3d.iGlobal["$pref::Net::PacketRateToClient"] = 32; - //t3d.iGlobal["$pref::Net::PacketRateToServer"] = 32; - //t3d.iGlobal["$pref::Net::PacketSize"] = 200; + //pInvokes.iGlobal["$pref::Net::PacketRateToClient"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketRateToServer"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketSize"] = 200; - t3d.bGlobal["$Physics::isSinglePlayer"] = false; - t3d.console.print("Starting multiplayer mode"); + pInvokes.bGlobal["$Physics::isSinglePlayer"] = false; + pInvokes.console.print("Starting multiplayer mode"); // Make sure the network port is set to the correct pref. - portInit(t3d.iGlobal["$Pref::Server::Port"]); + portInit(pInvokes.iGlobal["$Pref::Server::Port"]); - t3d.Util.allowConnections(true); + pInvokes.Util.allowConnections(true); - if (t3d.sGlobal["$pref::Net::DisplayOnMaster"] != "Never") - t3d.Util._schedule("0", "0", "startHeartBeat"); + if (pInvokes.sGlobal["$pref::Net::DisplayOnMaster"] != "Never") + pInvokes.Util._schedule("0", "0", "startHeartBeat"); } // Create the ServerGroup that will persist for the lifetime of the server. new ObjectCreator("SimGroup", "ServerGroup").Create(); - t3d.Util.exec("core/art/datablocks/datablockExec.cs", false, false); + pInvokes.Util.exec("core/art/datablocks/datablockExec.cs", false, false); game.onServerCreated(); - t3d.console.Call("loadMission", new[] {level, "true"}); + pInvokes.console.Call("loadMission", new[] {level, "true"}); return true; } @@ -255,12 +255,12 @@ public static bool createServer(string serverType, string level) [ConsoleInteraction(true)] public static void destroyServer() { - t3d.sGlobal["$Server::ServerType"] = string.Empty; - t3d.Util.allowConnections(false); + pInvokes.sGlobal["$Server::ServerType"] = string.Empty; + pInvokes.Util.allowConnections(false); - t3d.console.Call("stopHeartbeat"); + pInvokes.console.Call("stopHeartbeat"); - t3d.bGlobal["$missionRunning"] = false; + pInvokes.bGlobal["$missionRunning"] = false; // End any running levels @@ -273,24 +273,24 @@ public static void destroyServer() "ServerGroup".delete(); // Delete all the connections: - while (t3d.ClientGroup.Count().AsBool()) - t3d.ClientGroup[0].AsString().delete(); + while (pInvokes.ClientGroup.Count().AsBool()) + pInvokes.ClientGroup[0].AsString().delete(); - t3d.sGlobal["$Server::GuidList"] = string.Empty; + pInvokes.sGlobal["$Server::GuidList"] = string.Empty; // Delete all the data blocks... - t3d.Util.deleteDataBlocks(); + pInvokes.Util.deleteDataBlocks(); // Save any server settings - t3d.console.print("Exporting server prefs..."); + pInvokes.console.print("Exporting server prefs..."); //Todo Settings - Switch this back when fixed. - t3d.Util.export("$Pref::Server::*", "core/scripts/prefs.cs", false); - //t3d.Util.exportToSettings("$Pref::Server::*", "core/scripts/prefs.cs", false); + pInvokes.Util.export("$Pref::Server::*", "core/scripts/prefs.cs", false); + //pInvokes.Util.exportToSettings("$Pref::Server::*", "core/scripts/prefs.cs", false); // Increase the server session number. This is used to make sure we're // working with the server session we think we are. - t3d.iGlobal["$Server::Session"]++; + pInvokes.iGlobal["$Server::Session"]++; } [ConsoleInteraction(true)] @@ -302,15 +302,15 @@ public static string onServerInfoQuery() [ConsoleInteraction(true)] public static void resetServerDefaults() { - t3d.console.print("Resetting server defaults..."); + pInvokes.console.print("Resetting server defaults..."); LoadDefaults(); //Todo Settings - Switch this back when fixed. //Settings.LoadSection("core/scripts/prefs.cs"); - t3d.Util.exec("core/scripts/prefs.cs", false, false); + pInvokes.Util.exec("core/scripts/prefs.cs", false, false); // Reload the current level - missionLoad.loadMission(t3d.sGlobal["$Server::MissionFile"], false); + missionLoad.loadMission(pInvokes.sGlobal["$Server::MissionFile"], false); } } } \ No newline at end of file diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/spawn.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/spawn.cs index 8f4fbf18..fb31f1ef 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/spawn.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/Server/spawn.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -43,15 +43,13 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.GameCode.Server { public class spawn { - private static readonly pInvokes omni = new pInvokes(); - public static void init() { // Leave $Game::defaultPlayerClass and $Game::defaultPlayerDataBlock as empty strings ("") // to spawn a the $Game::defaultCameraClass as the control object. - omni.sGlobal["$Game::DefaultPlayerClass"] = "Player"; - omni.sGlobal["$Game::DefaultPlayerDataBlock"] = "DefaultPlayerData"; - omni.sGlobal["$Game::DefaultPlayerSpawnGroups"] = "PlayerSpawnPoints"; + pInvokes.sGlobal["$Game::DefaultPlayerClass"] = "Player"; + pInvokes.sGlobal["$Game::DefaultPlayerDataBlock"] = "DefaultPlayerData"; + pInvokes.sGlobal["$Game::DefaultPlayerSpawnGroups"] = "PlayerSpawnPoints"; //----------------------------------------------------------------------------- // What kind of "camera" is spawned is either controlled directly by the @@ -59,9 +57,9 @@ public static void init() // which SimGroups to attempt to select the spawn sphere's from by walking down // the list of SpawnGroups till it finds a valid spawn object. //----------------------------------------------------------------------------- - omni.sGlobal["$Game::DefaultCameraClass"] = "Camera"; - omni.sGlobal["$Game::DefaultCameraDataBlock"] = "Observer"; - omni.sGlobal["$Game::DefaultCameraSpawnGroups"] = "CameraSpawnPoints PlayerSpawnPoints"; + pInvokes.sGlobal["$Game::DefaultCameraClass"] = "Camera"; + pInvokes.sGlobal["$Game::DefaultCameraDataBlock"] = "Observer"; + pInvokes.sGlobal["$Game::DefaultCameraSpawnGroups"] = "CameraSpawnPoints PlayerSpawnPoints"; } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/levelInfo.cs b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/levelInfo.cs index 5a12af8e..6a645d20 100644 --- a/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/levelInfo.cs +++ b/Templates/C#-Full-Ded/WinterLeaf.Demo.Full.Dedicated/Models.User/GameCode/levelInfo.cs @@ -11,7 +11,6 @@ namespace Winterleaf.Demo.Full.Dedicated.Models.User.GameCode { public class levelInfo { - private static readonly pInvokes omni = new pInvokes(); //------------------------------------------------------------------------------ // Loading info is text displayed on the client side while the mission // is being loaded. This information is extracted from the mission file @@ -66,11 +65,11 @@ public static void BuildLoadInfo(string mission) infoObject += line + " "; } } - omni.console.Eval(infoObject); + pInvokes.console.Eval(infoObject); } else { - omni.console.error(string.Format("Level File {0} not found.", mission)); + pInvokes.console.error(string.Format("Level File {0} not found.", mission)); } } @@ -84,10 +83,10 @@ public static void DumpLoadInfo() { LevelInfo thelevelinfo = "theLevelInfo"; - omni.console.print("Level Name: " + thelevelinfo["name"]); - omni.console.print("Level Description:"); + pInvokes.console.print("Level Name: " + thelevelinfo["name"]); + pInvokes.console.print("Level Description:"); for (int i = 0; thelevelinfo["desc[" + i + "]"] != ""; i++) - omni.console.print(" " + thelevelinfo["desc[" + i + "]"]); + pInvokes.console.print(" " + thelevelinfo["desc[" + i + "]"]); } } - } \ No newline at end of file + } diff --git a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/Interopt/SafeNativeMethods.cs b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/Interopt/SafeNativeMethods.cs index f6f15481..8ad3ba2a 100644 --- a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/Interopt/SafeNativeMethods.cs +++ b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/Interopt/SafeNativeMethods.cs @@ -514,6 +514,21 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn__expandOldFilename mwle_fn__expandOldFilename; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn__expandOldFilename([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn__getStockColorCount mwle_fn__getStockColorCount; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate int wle_fn__getStockColorCount(); +static internal wle_fn__getStockColorF mwle_fn__getStockColorF; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn__getStockColorF([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn__getStockColorI mwle_fn__getStockColorI; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn__getStockColorI([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn__getStockColorName mwle_fn__getStockColorName; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn__getStockColorName([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn__isStockColor mwle_fn__isStockColor; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate int wle_fn__isStockColor([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1); static internal wle_fn__mathInit mwle_fn__mathInit; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn__mathInit([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a2, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a3, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a4, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a5, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a6, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a7, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a8, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a9); @@ -643,9 +658,15 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_clearServerPaths mwle_fn_clearServerPaths; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_clearServerPaths(); +static internal wle_fn_CloseAllPopOuts mwle_fn_CloseAllPopOuts; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_CloseAllPopOuts(); static internal wle_fn_closeNetPort mwle_fn_closeNetPort; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_closeNetPort(); +static internal wle_fn_closeSplashWindow mwle_fn_closeSplashWindow; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_closeSplashWindow(); static internal wle_fn_collapseEscape mwle_fn_collapseEscape; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_collapseEscape([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder text,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); @@ -901,9 +922,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_dumpStringMemStats mwle_fn_dumpStringMemStats; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_dumpStringMemStats(); -static internal wle_fn_dumpStringTableSize mwle_fn_dumpStringTableSize; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fn_dumpStringTableSize(); static internal wle_fn_dumpTextureObjects mwle_fn_dumpTextureObjects; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_dumpTextureObjects(); @@ -1207,6 +1225,12 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_getFileCRC mwle_fn_getFileCRC; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fn_getFileCRC([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder fileName); +static internal wle_fn_getFormatExtensions mwle_fn_getFormatExtensions; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_getFormatExtensions([MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn_getFormatFilters mwle_fn_getFormatFilters; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_getFormatFilters([MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); static internal wle_fn_getFrustumOffset mwle_fn_getFrustumOffset; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_getFrustumOffset([MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); @@ -2418,7 +2442,7 @@ static private void MapConsoleExterns(string dllname) internal delegate int wle_fn_nameToID([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder objectName); static internal wle_fn_nextToken mwle_fn_nextToken; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fn_nextToken([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder str, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder token, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder delim,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); + internal delegate void wle_fn_nextToken([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder str1, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder token, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder delim,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); static internal wle_fn_openFile mwle_fn_openFile; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_openFile([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder file); @@ -2605,6 +2629,12 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_querySingleServer mwle_fn_querySingleServer; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_querySingleServer([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder addrText, [In] byte flags); +static internal wle_fn_quit mwle_fn_quit; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_quit(); +static internal wle_fn_quitWithErrorMessage mwle_fn_quitWithErrorMessage; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_quitWithErrorMessage([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder message); static internal wle_fn_ReadXML_readFile mwle_fn_ReadXML_readFile; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fn_ReadXML_readFile([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder readxml); @@ -3168,7 +3198,7 @@ static private void MapConsoleExterns(string dllname) internal delegate void wle_fn_TerrainEditor_attachTerrain([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terraineditor, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terrain); static internal wle_fn_TerrainEditor_autoMaterialLayer mwle_fn_TerrainEditor_autoMaterialLayer; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fn_TerrainEditor_autoMaterialLayer([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terraineditor, [In] float minHeight, [In] float maxHeight, [In] float minSlope, [In] float maxSlope); + internal delegate void wle_fn_TerrainEditor_autoMaterialLayer([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terraineditor, [In] float minHeight, [In] float maxHeight, [In] float minSlope, [In] float maxSlope, [In] float coverage); static internal wle_fn_TerrainEditor_clearSelection mwle_fn_TerrainEditor_clearSelection; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_TerrainEditor_clearSelection([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terraineditor); @@ -3355,9 +3385,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_UndoManager_undo mwle_fn_UndoManager_undo; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_UndoManager_undo([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder undomanager); -static internal wle_fn_unitTest_runTests mwle_fn_unitTest_runTests; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fn_unitTest_runTests([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder searchString, [In] bool skip); static internal wle_fn_unregisterMessageListener mwle_fn_unregisterMessageListener; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_unregisterMessageListener([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder queueName, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder listenerName); @@ -3571,6 +3598,12 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnAIPlayer_AISearchSimSet mwle_fnAIPlayer_AISearchSimSet; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnAIPlayer_AISearchSimSet([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder aiplayer, [In] float fOV, [In] float farDist, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder ObjToSearch, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder result); +static internal wle_fnAIPlayer_checkInFoV mwle_fnAIPlayer_checkInFoV; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate int wle_fnAIPlayer_checkInFoV([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder aiplayer, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder obj, [In] float fov, [In] bool checkEnabled); +static internal wle_fnAIPlayer_checkInLos mwle_fnAIPlayer_checkInLos; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate int wle_fnAIPlayer_checkInLos([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder aiplayer, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder obj, [In] bool useMuzzle, [In] bool checkEnabled); static internal wle_fnAIPlayer_clearAim mwle_fnAIPlayer_clearAim; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnAIPlayer_clearAim([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder aiplayer); @@ -3882,7 +3915,7 @@ static private void MapConsoleExterns(string dllname) internal delegate void wle_fnCamera_setOffset([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder offset); static internal wle_fnCamera_setOrbitMode mwle_fnCamera_setOrbitMode; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate int wle_fnCamera_setOrbitMode([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitObject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitPoint, [In] float minDistance, [In] float maxDistance, [In] float initDistance, [In] bool ownClientObj, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder offset, [In] bool lockedx); + internal delegate void wle_fnCamera_setOrbitMode([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitObject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitPoint, [In] float minDistance, [In] float maxDistance, [In] float initDistance, [In] bool ownClientObj, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder offset, [In] bool lockedx); static internal wle_fnCamera_setOrbitObject mwle_fnCamera_setOrbitObject; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnCamera_setOrbitObject([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitObject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder rotation, [In] float minDistance, [In] float maxDistance, [In] float initDistance, [In] bool ownClientObject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder offset, [In] bool lockedx); @@ -3904,9 +3937,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnCamera_setVelocity mwle_fnCamera_setVelocity; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnCamera_setVelocity([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder velocity); -static internal wle_fnCloudLayer_ChangeCoverage mwle_fnCloudLayer_ChangeCoverage; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fnCloudLayer_ChangeCoverage([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder cloudlayer, [In] float newCoverage); static internal wle_fnCoverPoint_isOccupied mwle_fnCoverPoint_isOccupied; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnCoverPoint_isOccupied([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder coverpoint); @@ -4027,9 +4057,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnForestWindEmitter_attachToObject mwle_fnForestWindEmitter_attachToObject; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnForestWindEmitter_attachToObject([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder forestwindemitter, [In] uint objectID); -static internal wle_fnForestWindEmitter_resetWind mwle_fnForestWindEmitter_resetWind; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fnForestWindEmitter_resetWind([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder forestwindemitter, [In] int randomSeed); static internal wle_fnGameBase_applyImpulse mwle_fnGameBase_applyImpulse; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnGameBase_applyImpulse([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder gamebase, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder pos, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder vel); @@ -4282,6 +4309,9 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnGuiCanvas_hideCursor mwle_fnGuiCanvas_hideCursor; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnGuiCanvas_hideCursor([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); +static internal wle_fnGuiCanvas_hideWindow mwle_fnGuiCanvas_hideWindow; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fnGuiCanvas_hideWindow([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); static internal wle_fnGuiCanvas_isCursorOn mwle_fnGuiCanvas_isCursorOn; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnGuiCanvas_isCursorOn([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); @@ -4318,6 +4348,9 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnGuiCanvas_showCursor mwle_fnGuiCanvas_showCursor; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnGuiCanvas_showCursor([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); +static internal wle_fnGuiCanvas_showWindow mwle_fnGuiCanvas_showWindow; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fnGuiCanvas_showWindow([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); static internal wle_fnGuiCanvas_toggleFullscreen mwle_fnGuiCanvas_toggleFullscreen; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnGuiCanvas_toggleFullscreen([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); @@ -6325,9 +6358,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnShapeBase_setImageTrigger mwle_fnShapeBase_setImageTrigger; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnShapeBase_setImageTrigger([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder shapebase, [In] int slot, [In] bool state); -static internal wle_fnShapeBase_setInvincibleMode mwle_fnShapeBase_setInvincibleMode; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fnShapeBase_setInvincibleMode([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder shapebase, [In] float time, [In] float speed); static internal wle_fnShapeBase_setMeshHidden mwle_fnShapeBase_setMeshHidden; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnShapeBase_setMeshHidden([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder shapebase, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder name, [In] bool hide); @@ -6651,7 +6681,7 @@ static private void MapConsoleExterns(string dllname) internal delegate void wle_fnTCPObject_disconnect([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder tcpobject); static internal wle_fnTCPObject_listen mwle_fnTCPObject_listen; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fnTCPObject_listen([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder tcpobject, [In] int port); + internal delegate void wle_fnTCPObject_listen([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder tcpobject, [In] uint port); static internal wle_fnTCPObject_send mwle_fnTCPObject_send; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnTCPObject_send([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder tcpobject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder data); @@ -7119,6 +7149,11 @@ static private void ClearAutoExterns(){ mwle_fn__execPrefs= null; mwle_fn__expandFilename= null; mwle_fn__expandOldFilename= null; +mwle_fn__getStockColorCount= null; +mwle_fn__getStockColorF= null; +mwle_fn__getStockColorI= null; +mwle_fn__getStockColorName= null; +mwle_fn__isStockColor= null; mwle_fn__mathInit= null; mwle_fn__resourceDump= null; mwle_fn__schedule= null; @@ -7162,7 +7197,9 @@ static private void ClearAutoExterns(){ mwle_fn_clearClientPaths= null; mwle_fn_clearGFXResourceFlags= null; mwle_fn_clearServerPaths= null; +mwle_fn_CloseAllPopOuts= null; mwle_fn_closeNetPort= null; +mwle_fn_closeSplashWindow= null; mwle_fn_collapseEscape= null; mwle_fn_compile= null; mwle_fn_CompoundUndoAction_addAction= null; @@ -7248,7 +7285,6 @@ static private void ClearAutoExterns(){ mwle_fn_dumpRandomNormalMap= null; mwle_fn_dumpSoCount= null; mwle_fn_dumpStringMemStats= null; -mwle_fn_dumpStringTableSize= null; mwle_fn_dumpTextureObjects= null; mwle_fn_duplicateCachedFont= null; mwle_fn_echoInputState= null; @@ -7350,6 +7386,8 @@ static private void ClearAutoExterns(){ mwle_fn_getFileCount= null; mwle_fn_getFileCountMultiExpr= null; mwle_fn_getFileCRC= null; +mwle_fn_getFormatExtensions= null; +mwle_fn_getFormatFilters= null; mwle_fn_getFrustumOffset= null; mwle_fn_getFunctionPackage= null; mwle_fn_getJoystickAxes= null; @@ -7816,6 +7854,8 @@ static private void ClearAutoExterns(){ mwle_fn_queryLanServers= null; mwle_fn_queryMasterServer= null; mwle_fn_querySingleServer= null; +mwle_fn_quit= null; +mwle_fn_quitWithErrorMessage= null; mwle_fn_ReadXML_readFile= null; mwle_fn_realQuit= null; mwle_fn_redbookClose= null; @@ -8066,7 +8106,6 @@ static private void ClearAutoExterns(){ mwle_fn_UndoManager_pushCompound= null; mwle_fn_UndoManager_redo= null; mwle_fn_UndoManager_undo= null; -mwle_fn_unitTest_runTests= null; mwle_fn_unregisterMessageListener= null; mwle_fn_unregisterMessageQueue= null; mwle_fn_VectorAdd= null; @@ -8138,6 +8177,8 @@ static private void ClearAutoExterns(){ mwle_fnActionMap_unbind= null; mwle_fnActionMap_unbindObj= null; mwle_fnAIPlayer_AISearchSimSet= null; +mwle_fnAIPlayer_checkInFoV= null; +mwle_fnAIPlayer_checkInLos= null; mwle_fnAIPlayer_clearAim= null; mwle_fnAIPlayer_findCover= null; mwle_fnAIPlayer_findNavMesh= null; @@ -8249,7 +8290,6 @@ static private void ClearAutoExterns(){ mwle_fnCamera_setTrackObject= null; mwle_fnCamera_setValidEditOrbitPoint= null; mwle_fnCamera_setVelocity= null; -mwle_fnCloudLayer_ChangeCoverage= null; mwle_fnCoverPoint_isOccupied= null; mwle_fnCubemapData_getFilename= null; mwle_fnCubemapData_updateFaces= null; @@ -8290,7 +8330,6 @@ static private void ClearAutoExterns(){ mwle_fnForest_addItem= null; mwle_fnForest_addItemWithTransform= null; mwle_fnForestWindEmitter_attachToObject= null; -mwle_fnForestWindEmitter_resetWind= null; mwle_fnGameBase_applyImpulse= null; mwle_fnGameBase_applyRadialImpulse= null; mwle_fnGameBase_getDataBlock= null; @@ -8375,6 +8414,7 @@ static private void ClearAutoExterns(){ mwle_fnGuiCanvas_getVideoMode= null; mwle_fnGuiCanvas_getWindowPosition= null; mwle_fnGuiCanvas_hideCursor= null; +mwle_fnGuiCanvas_hideWindow= null; mwle_fnGuiCanvas_isCursorOn= null; mwle_fnGuiCanvas_isCursorShown= null; mwle_fnGuiCanvas_renderFront= null; @@ -8387,6 +8427,7 @@ static private void ClearAutoExterns(){ mwle_fnGuiCanvas_setWindowPosition= null; mwle_fnGuiCanvas_setWindowTitle= null; mwle_fnGuiCanvas_showCursor= null; +mwle_fnGuiCanvas_showWindow= null; mwle_fnGuiCanvas_toggleFullscreen= null; mwle_fnGuiCheckBoxCtrl_isStateOn= null; mwle_fnGuiCheckBoxCtrl_setStateOn= null; @@ -9056,7 +9097,6 @@ static private void ClearAutoExterns(){ mwle_fnShapeBase_setImageScriptAnimPrefix= null; mwle_fnShapeBase_setImageTarget= null; mwle_fnShapeBase_setImageTrigger= null; -mwle_fnShapeBase_setInvincibleMode= null; mwle_fnShapeBase_setMeshHidden= null; mwle_fnShapeBase_setRechargeRate= null; mwle_fnShapeBase_setRepairRate= null; @@ -9328,6 +9368,11 @@ static private void ClearAutoExterns(){ mwle_fn__execPrefs= (wle_fn__execPrefs)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__execPrefs"), typeof(wle_fn__execPrefs)); mwle_fn__expandFilename= (wle_fn__expandFilename)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__expandFilename"), typeof(wle_fn__expandFilename)); mwle_fn__expandOldFilename= (wle_fn__expandOldFilename)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__expandOldFilename"), typeof(wle_fn__expandOldFilename)); +mwle_fn__getStockColorCount= (wle_fn__getStockColorCount)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__getStockColorCount"), typeof(wle_fn__getStockColorCount)); +mwle_fn__getStockColorF= (wle_fn__getStockColorF)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__getStockColorF"), typeof(wle_fn__getStockColorF)); +mwle_fn__getStockColorI= (wle_fn__getStockColorI)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__getStockColorI"), typeof(wle_fn__getStockColorI)); +mwle_fn__getStockColorName= (wle_fn__getStockColorName)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__getStockColorName"), typeof(wle_fn__getStockColorName)); +mwle_fn__isStockColor= (wle_fn__isStockColor)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__isStockColor"), typeof(wle_fn__isStockColor)); mwle_fn__mathInit= (wle_fn__mathInit)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__mathInit"), typeof(wle_fn__mathInit)); mwle_fn__resourceDump= (wle_fn__resourceDump)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__resourceDump"), typeof(wle_fn__resourceDump)); mwle_fn__schedule= (wle_fn__schedule)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__schedule"), typeof(wle_fn__schedule)); @@ -9371,7 +9416,9 @@ static private void ClearAutoExterns(){ mwle_fn_clearClientPaths= (wle_fn_clearClientPaths)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_clearClientPaths"), typeof(wle_fn_clearClientPaths)); mwle_fn_clearGFXResourceFlags= (wle_fn_clearGFXResourceFlags)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_clearGFXResourceFlags"), typeof(wle_fn_clearGFXResourceFlags)); mwle_fn_clearServerPaths= (wle_fn_clearServerPaths)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_clearServerPaths"), typeof(wle_fn_clearServerPaths)); +mwle_fn_CloseAllPopOuts= (wle_fn_CloseAllPopOuts)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_CloseAllPopOuts"), typeof(wle_fn_CloseAllPopOuts)); mwle_fn_closeNetPort= (wle_fn_closeNetPort)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_closeNetPort"), typeof(wle_fn_closeNetPort)); +mwle_fn_closeSplashWindow= (wle_fn_closeSplashWindow)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_closeSplashWindow"), typeof(wle_fn_closeSplashWindow)); mwle_fn_collapseEscape= (wle_fn_collapseEscape)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_collapseEscape"), typeof(wle_fn_collapseEscape)); mwle_fn_compile= (wle_fn_compile)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_compile"), typeof(wle_fn_compile)); mwle_fn_CompoundUndoAction_addAction= (wle_fn_CompoundUndoAction_addAction)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_CompoundUndoAction_addAction"), typeof(wle_fn_CompoundUndoAction_addAction)); @@ -9457,7 +9504,6 @@ static private void ClearAutoExterns(){ mwle_fn_dumpRandomNormalMap= (wle_fn_dumpRandomNormalMap)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpRandomNormalMap"), typeof(wle_fn_dumpRandomNormalMap)); mwle_fn_dumpSoCount= (wle_fn_dumpSoCount)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpSoCount"), typeof(wle_fn_dumpSoCount)); mwle_fn_dumpStringMemStats= (wle_fn_dumpStringMemStats)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpStringMemStats"), typeof(wle_fn_dumpStringMemStats)); -mwle_fn_dumpStringTableSize= (wle_fn_dumpStringTableSize)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpStringTableSize"), typeof(wle_fn_dumpStringTableSize)); mwle_fn_dumpTextureObjects= (wle_fn_dumpTextureObjects)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpTextureObjects"), typeof(wle_fn_dumpTextureObjects)); mwle_fn_duplicateCachedFont= (wle_fn_duplicateCachedFont)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_duplicateCachedFont"), typeof(wle_fn_duplicateCachedFont)); mwle_fn_echoInputState= (wle_fn_echoInputState)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_echoInputState"), typeof(wle_fn_echoInputState)); @@ -9559,6 +9605,8 @@ static private void ClearAutoExterns(){ mwle_fn_getFileCount= (wle_fn_getFileCount)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFileCount"), typeof(wle_fn_getFileCount)); mwle_fn_getFileCountMultiExpr= (wle_fn_getFileCountMultiExpr)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFileCountMultiExpr"), typeof(wle_fn_getFileCountMultiExpr)); mwle_fn_getFileCRC= (wle_fn_getFileCRC)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFileCRC"), typeof(wle_fn_getFileCRC)); +mwle_fn_getFormatExtensions= (wle_fn_getFormatExtensions)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFormatExtensions"), typeof(wle_fn_getFormatExtensions)); +mwle_fn_getFormatFilters= (wle_fn_getFormatFilters)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFormatFilters"), typeof(wle_fn_getFormatFilters)); mwle_fn_getFrustumOffset= (wle_fn_getFrustumOffset)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFrustumOffset"), typeof(wle_fn_getFrustumOffset)); mwle_fn_getFunctionPackage= (wle_fn_getFunctionPackage)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFunctionPackage"), typeof(wle_fn_getFunctionPackage)); mwle_fn_getJoystickAxes= (wle_fn_getJoystickAxes)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getJoystickAxes"), typeof(wle_fn_getJoystickAxes)); @@ -10025,6 +10073,8 @@ static private void ClearAutoExterns(){ mwle_fn_queryLanServers= (wle_fn_queryLanServers)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_queryLanServers"), typeof(wle_fn_queryLanServers)); mwle_fn_queryMasterServer= (wle_fn_queryMasterServer)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_queryMasterServer"), typeof(wle_fn_queryMasterServer)); mwle_fn_querySingleServer= (wle_fn_querySingleServer)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_querySingleServer"), typeof(wle_fn_querySingleServer)); +mwle_fn_quit= (wle_fn_quit)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_quit"), typeof(wle_fn_quit)); +mwle_fn_quitWithErrorMessage= (wle_fn_quitWithErrorMessage)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_quitWithErrorMessage"), typeof(wle_fn_quitWithErrorMessage)); mwle_fn_ReadXML_readFile= (wle_fn_ReadXML_readFile)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_ReadXML_readFile"), typeof(wle_fn_ReadXML_readFile)); mwle_fn_realQuit= (wle_fn_realQuit)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_realQuit"), typeof(wle_fn_realQuit)); mwle_fn_redbookClose= (wle_fn_redbookClose)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_redbookClose"), typeof(wle_fn_redbookClose)); @@ -10275,7 +10325,6 @@ static private void ClearAutoExterns(){ mwle_fn_UndoManager_pushCompound= (wle_fn_UndoManager_pushCompound)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_UndoManager_pushCompound"), typeof(wle_fn_UndoManager_pushCompound)); mwle_fn_UndoManager_redo= (wle_fn_UndoManager_redo)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_UndoManager_redo"), typeof(wle_fn_UndoManager_redo)); mwle_fn_UndoManager_undo= (wle_fn_UndoManager_undo)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_UndoManager_undo"), typeof(wle_fn_UndoManager_undo)); -mwle_fn_unitTest_runTests= (wle_fn_unitTest_runTests)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_unitTest_runTests"), typeof(wle_fn_unitTest_runTests)); mwle_fn_unregisterMessageListener= (wle_fn_unregisterMessageListener)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_unregisterMessageListener"), typeof(wle_fn_unregisterMessageListener)); mwle_fn_unregisterMessageQueue= (wle_fn_unregisterMessageQueue)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_unregisterMessageQueue"), typeof(wle_fn_unregisterMessageQueue)); mwle_fn_VectorAdd= (wle_fn_VectorAdd)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_VectorAdd"), typeof(wle_fn_VectorAdd)); @@ -10347,6 +10396,8 @@ static private void ClearAutoExterns(){ mwle_fnActionMap_unbind= (wle_fnActionMap_unbind)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnActionMap_unbind"), typeof(wle_fnActionMap_unbind)); mwle_fnActionMap_unbindObj= (wle_fnActionMap_unbindObj)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnActionMap_unbindObj"), typeof(wle_fnActionMap_unbindObj)); mwle_fnAIPlayer_AISearchSimSet= (wle_fnAIPlayer_AISearchSimSet)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_AISearchSimSet"), typeof(wle_fnAIPlayer_AISearchSimSet)); +mwle_fnAIPlayer_checkInFoV= (wle_fnAIPlayer_checkInFoV)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_checkInFoV"), typeof(wle_fnAIPlayer_checkInFoV)); +mwle_fnAIPlayer_checkInLos= (wle_fnAIPlayer_checkInLos)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_checkInLos"), typeof(wle_fnAIPlayer_checkInLos)); mwle_fnAIPlayer_clearAim= (wle_fnAIPlayer_clearAim)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_clearAim"), typeof(wle_fnAIPlayer_clearAim)); mwle_fnAIPlayer_findCover= (wle_fnAIPlayer_findCover)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_findCover"), typeof(wle_fnAIPlayer_findCover)); mwle_fnAIPlayer_findNavMesh= (wle_fnAIPlayer_findNavMesh)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_findNavMesh"), typeof(wle_fnAIPlayer_findNavMesh)); @@ -10458,7 +10509,6 @@ static private void ClearAutoExterns(){ mwle_fnCamera_setTrackObject= (wle_fnCamera_setTrackObject)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCamera_setTrackObject"), typeof(wle_fnCamera_setTrackObject)); mwle_fnCamera_setValidEditOrbitPoint= (wle_fnCamera_setValidEditOrbitPoint)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCamera_setValidEditOrbitPoint"), typeof(wle_fnCamera_setValidEditOrbitPoint)); mwle_fnCamera_setVelocity= (wle_fnCamera_setVelocity)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCamera_setVelocity"), typeof(wle_fnCamera_setVelocity)); -mwle_fnCloudLayer_ChangeCoverage= (wle_fnCloudLayer_ChangeCoverage)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCloudLayer_ChangeCoverage"), typeof(wle_fnCloudLayer_ChangeCoverage)); mwle_fnCoverPoint_isOccupied= (wle_fnCoverPoint_isOccupied)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCoverPoint_isOccupied"), typeof(wle_fnCoverPoint_isOccupied)); mwle_fnCubemapData_getFilename= (wle_fnCubemapData_getFilename)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCubemapData_getFilename"), typeof(wle_fnCubemapData_getFilename)); mwle_fnCubemapData_updateFaces= (wle_fnCubemapData_updateFaces)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCubemapData_updateFaces"), typeof(wle_fnCubemapData_updateFaces)); @@ -10499,7 +10549,6 @@ static private void ClearAutoExterns(){ mwle_fnForest_addItem= (wle_fnForest_addItem)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnForest_addItem"), typeof(wle_fnForest_addItem)); mwle_fnForest_addItemWithTransform= (wle_fnForest_addItemWithTransform)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnForest_addItemWithTransform"), typeof(wle_fnForest_addItemWithTransform)); mwle_fnForestWindEmitter_attachToObject= (wle_fnForestWindEmitter_attachToObject)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnForestWindEmitter_attachToObject"), typeof(wle_fnForestWindEmitter_attachToObject)); -mwle_fnForestWindEmitter_resetWind= (wle_fnForestWindEmitter_resetWind)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnForestWindEmitter_resetWind"), typeof(wle_fnForestWindEmitter_resetWind)); mwle_fnGameBase_applyImpulse= (wle_fnGameBase_applyImpulse)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGameBase_applyImpulse"), typeof(wle_fnGameBase_applyImpulse)); mwle_fnGameBase_applyRadialImpulse= (wle_fnGameBase_applyRadialImpulse)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGameBase_applyRadialImpulse"), typeof(wle_fnGameBase_applyRadialImpulse)); mwle_fnGameBase_getDataBlock= (wle_fnGameBase_getDataBlock)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGameBase_getDataBlock"), typeof(wle_fnGameBase_getDataBlock)); @@ -10584,6 +10633,7 @@ static private void ClearAutoExterns(){ mwle_fnGuiCanvas_getVideoMode= (wle_fnGuiCanvas_getVideoMode)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_getVideoMode"), typeof(wle_fnGuiCanvas_getVideoMode)); mwle_fnGuiCanvas_getWindowPosition= (wle_fnGuiCanvas_getWindowPosition)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_getWindowPosition"), typeof(wle_fnGuiCanvas_getWindowPosition)); mwle_fnGuiCanvas_hideCursor= (wle_fnGuiCanvas_hideCursor)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_hideCursor"), typeof(wle_fnGuiCanvas_hideCursor)); +mwle_fnGuiCanvas_hideWindow= (wle_fnGuiCanvas_hideWindow)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_hideWindow"), typeof(wle_fnGuiCanvas_hideWindow)); mwle_fnGuiCanvas_isCursorOn= (wle_fnGuiCanvas_isCursorOn)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_isCursorOn"), typeof(wle_fnGuiCanvas_isCursorOn)); mwle_fnGuiCanvas_isCursorShown= (wle_fnGuiCanvas_isCursorShown)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_isCursorShown"), typeof(wle_fnGuiCanvas_isCursorShown)); mwle_fnGuiCanvas_renderFront= (wle_fnGuiCanvas_renderFront)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_renderFront"), typeof(wle_fnGuiCanvas_renderFront)); @@ -10596,6 +10646,7 @@ static private void ClearAutoExterns(){ mwle_fnGuiCanvas_setWindowPosition= (wle_fnGuiCanvas_setWindowPosition)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_setWindowPosition"), typeof(wle_fnGuiCanvas_setWindowPosition)); mwle_fnGuiCanvas_setWindowTitle= (wle_fnGuiCanvas_setWindowTitle)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_setWindowTitle"), typeof(wle_fnGuiCanvas_setWindowTitle)); mwle_fnGuiCanvas_showCursor= (wle_fnGuiCanvas_showCursor)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_showCursor"), typeof(wle_fnGuiCanvas_showCursor)); +mwle_fnGuiCanvas_showWindow= (wle_fnGuiCanvas_showWindow)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_showWindow"), typeof(wle_fnGuiCanvas_showWindow)); mwle_fnGuiCanvas_toggleFullscreen= (wle_fnGuiCanvas_toggleFullscreen)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_toggleFullscreen"), typeof(wle_fnGuiCanvas_toggleFullscreen)); mwle_fnGuiCheckBoxCtrl_isStateOn= (wle_fnGuiCheckBoxCtrl_isStateOn)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCheckBoxCtrl_isStateOn"), typeof(wle_fnGuiCheckBoxCtrl_isStateOn)); mwle_fnGuiCheckBoxCtrl_setStateOn= (wle_fnGuiCheckBoxCtrl_setStateOn)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCheckBoxCtrl_setStateOn"), typeof(wle_fnGuiCheckBoxCtrl_setStateOn)); @@ -11265,7 +11316,6 @@ static private void ClearAutoExterns(){ mwle_fnShapeBase_setImageScriptAnimPrefix= (wle_fnShapeBase_setImageScriptAnimPrefix)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setImageScriptAnimPrefix"), typeof(wle_fnShapeBase_setImageScriptAnimPrefix)); mwle_fnShapeBase_setImageTarget= (wle_fnShapeBase_setImageTarget)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setImageTarget"), typeof(wle_fnShapeBase_setImageTarget)); mwle_fnShapeBase_setImageTrigger= (wle_fnShapeBase_setImageTrigger)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setImageTrigger"), typeof(wle_fnShapeBase_setImageTrigger)); -mwle_fnShapeBase_setInvincibleMode= (wle_fnShapeBase_setInvincibleMode)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setInvincibleMode"), typeof(wle_fnShapeBase_setInvincibleMode)); mwle_fnShapeBase_setMeshHidden= (wle_fnShapeBase_setMeshHidden)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setMeshHidden"), typeof(wle_fnShapeBase_setMeshHidden)); mwle_fnShapeBase_setRechargeRate= (wle_fnShapeBase_setRechargeRate)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setRechargeRate"), typeof(wle_fnShapeBase_setRechargeRate)); mwle_fnShapeBase_setRepairRate= (wle_fnShapeBase_setRepairRate)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setRepairRate"), typeof(wle_fnShapeBase_setRepairRate)); diff --git a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/Interopt/pInvokes.cs b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/Interopt/pInvokes.cs index e3e6805f..df4c9203 100644 --- a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/Interopt/pInvokes.cs +++ b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/Interopt/pInvokes.cs @@ -34,11 +34,11 @@ public uint this[string key] set { m_ts.SetVar(key, value); } } } - private readonly muglobals _muglobals = new muglobals(); + private static readonly muglobals _muglobals = new muglobals(); /// /// used to set/get bool globals /// - public muglobals uGlobal + public static muglobals uGlobal { get { return _muglobals; } } @@ -64,12 +64,12 @@ public override string ToString() return base.ToString(); } - readonly mglobalsIsDefined _mglobalsIsDefined = new mglobalsIsDefined(); + private readonly static mglobalsIsDefined _mglobalsIsDefined = new mglobalsIsDefined(); /// /// Used to grab string globals /// - public mglobalsIsDefined isGlobal + public static mglobalsIsDefined isGlobal { get { return _mglobalsIsDefined; } } @@ -89,11 +89,11 @@ public string this[string key] set { m_ts.SetVar(key, value); } } } - public readonly msglobals _msglobals = new msglobals(); + private static readonly msglobals _msglobals = new msglobals(); /// /// Used to grab string globals /// - public msglobals sGlobal + public static msglobals sGlobal { get { return _msglobals; } } @@ -115,11 +115,11 @@ public int this[string key] } } - private readonly miglobals _miglobals = new miglobals(); + private static readonly miglobals _miglobals = new miglobals(); /// /// used to set/get int globals /// - public miglobals iGlobal + public static miglobals iGlobal { get { return _miglobals; } } @@ -139,11 +139,11 @@ public bool this[string key] set { m_ts.SetVar(key, value); } } } - private readonly mbglobals _mbglobals = new mbglobals(); + private static readonly mbglobals _mbglobals = new mbglobals(); /// /// used to set/get bool globals /// - public mbglobals bGlobal + public static mbglobals bGlobal { get { return _mbglobals; } } @@ -165,11 +165,11 @@ public float this[string key] set { m_ts.SetVar(key, value); } } } - private readonly mfglobals _mfglobals = new mfglobals(); + private static readonly mfglobals _mfglobals = new mfglobals(); /// /// used to set/get bool globals /// - public mfglobals fGlobal + public static mfglobals fGlobal { get { return _mfglobals; } } @@ -191,11 +191,11 @@ public double this[string key] set { m_ts.SetVar(key, value); } } } - public readonly mdglobals _mdglobals = new mdglobals(); + public static readonly mdglobals _mdglobals = new mdglobals(); /// /// used to set/get bool globals /// - public mdglobals dGlobal + public static mdglobals dGlobal { get { return _mdglobals; } } @@ -209,17 +209,17 @@ public mdglobals dGlobal /// /// A property exposing Custom dnTorque Console Functions. /// - private ConsoleObject _mConsoleobject; + private static ConsoleObject _mConsoleobject; /// /// A property exposing Custom Math console functions. /// - private tMath _mMathobject; + private static tMath _mMathobject; /// /// A property exposing Custom dnTorque Console Functions. /// - public ConsoleObject console + public static ConsoleObject console { get { return _mConsoleobject; } } @@ -227,7 +227,7 @@ public ConsoleObject console /// /// A property exposing Custom Math console functions. /// - public tMath math + public static tMath math { get { return _mMathobject; } } @@ -236,7 +236,7 @@ public tMath math /// /// A list of all the Connection Object ID's active in Torque at the moment of request. /// - public List ClientGroup + public static List ClientGroup { get { @@ -253,7 +253,7 @@ public List ClientGroup /// The count of connection ID's /// /// - public UInt32 ClientGroup__GetCount() + public static UInt32 ClientGroup__GetCount() { return m_ts.ClientGroupGetCount(); } @@ -263,7 +263,7 @@ public UInt32 ClientGroup__GetCount() /// /// /// - public uint ClientGroup__GetItem(UInt32 index) + public static uint ClientGroup__GetItem(UInt32 index) { return m_ts.ClientGroupGetObject(index); } @@ -272,7 +272,7 @@ public uint ClientGroup__GetItem(UInt32 index) /// Removes the tagged string from Torque. /// /// - public void removeTaggedString(string tag) + public static void removeTaggedString(string tag) { m_ts._removeTaggedString(tag); } @@ -282,9 +282,6 @@ public void removeTaggedString(string tag) /// public class ConsoleObject { - private Omni m_ts; - - /// /// /// @@ -474,16 +471,6 @@ public string Call(string simobject, string function) return m_ts.SimObjectCall(simobject, function, new string[] { }); } - - /// - /// Constructor. - /// - /// - public ConsoleObject(ref Omni ts) - { - m_ts = ts; - } - /// /// Returns the string for the passed tag. /// @@ -1202,18 +1189,6 @@ public class tMath /// /// /// - private Omni m_ts; - /// - /// - /// - /// - public tMath(ref Omni ts) - { - m_ts = ts; - } - /// - /// - /// public static double M_2PI_F { get { return 3.1415926535897932384626433f * 2.0f; } @@ -1278,1240 +1253,1233 @@ public pInvokes(ref Omni c) public void SetUp(ref Omni c) { m_ts = c; - _mConsoleobject = new ConsoleObject(ref c); - _mMathobject = new tMath(ref c); - _mUtil = new UtilObject(ref c); - _mAIClient = new AIClientObject(ref c); - _mAIConnection = new AIConnectionObject(ref c); - _mAIPlayer = new AIPlayerObject(ref c); - _mCompoundUndoAction = new CompoundUndoActionObject(ref c); - _mConsoleLogger = new ConsoleLoggerObject(ref c); - _mCreatorTree = new CreatorTreeObject(ref c); - _mDbgFileView = new DbgFileViewObject(ref c); - _mEditManager = new EditManagerObject(ref c); - _mEventManager = new EventManagerObject(ref c); - _mFieldBrushObject = new FieldBrushObjectObject(ref c); - _mFileObject = new FileObjectObject(ref c); - _mForest = new ForestObject(ref c); - _mForestBrush = new ForestBrushObject(ref c); - _mForestBrushTool = new ForestBrushToolObject(ref c); - _mForestEditorCtrl = new ForestEditorCtrlObject(ref c); - _mForestSelectionTool = new ForestSelectionToolObject(ref c); - _mGuiBitmapCtrl = new GuiBitmapCtrlObject(ref c); - _mGuiCanvas = new GuiCanvasObject(ref c); - _mGuiColorPickerCtrl = new GuiColorPickerCtrlObject(ref c); - _mGuiControl = new GuiControlObject(ref c); - _mGuiControlProfile = new GuiControlProfileObject(ref c); - _mGuiConvexEditorCtrl = new GuiConvexEditorCtrlObject(ref c); - _mGuiDecalEditorCtrl = new GuiDecalEditorCtrlObject(ref c); - _mGuiEditCtrl = new GuiEditCtrlObject(ref c); - _mGuiFileTreeCtrl = new GuiFileTreeCtrlObject(ref c); - _mGuiFilterCtrl = new GuiFilterCtrlObject(ref c); - _mGuiGradientCtrl = new GuiGradientCtrlObject(ref c); - _mGuiIdleCamFadeBitmapCtrl = new GuiIdleCamFadeBitmapCtrlObject(ref c); - _mGuiInspector = new GuiInspectorObject(ref c); - _mGuiInspectorDynamicField = new GuiInspectorDynamicFieldObject(ref c); - _mGuiInspectorDynamicGroup = new GuiInspectorDynamicGroupObject(ref c); - _mGuiInspectorField = new GuiInspectorFieldObject(ref c); - _mGuiMaterialCtrl = new GuiMaterialCtrlObject(ref c); - _mGuiMeshRoadEditorCtrl = new GuiMeshRoadEditorCtrlObject(ref c); - _mGuiMissionAreaEditorCtrl = new GuiMissionAreaEditorCtrlObject(ref c); - _mGuiNavEditorCtrl = new GuiNavEditorCtrlObject(ref c); - _mGuiParticleGraphCtrl = new GuiParticleGraphCtrlObject(ref c); - _mGuiPopUpMenuCtrl = new GuiPopUpMenuCtrlObject(ref c); - _mGuiPopUpMenuCtrlEx = new GuiPopUpMenuCtrlExObject(ref c); - _mGuiRiverEditorCtrl = new GuiRiverEditorCtrlObject(ref c); - _mGuiRoadEditorCtrl = new GuiRoadEditorCtrlObject(ref c); - _mGuiTerrPreviewCtrl = new GuiTerrPreviewCtrlObject(ref c); - _mGuiTextEditCtrl = new GuiTextEditCtrlObject(ref c); - _mGuiTickCtrl = new GuiTickCtrlObject(ref c); - _mGuiToolboxButtonCtrl = new GuiToolboxButtonCtrlObject(ref c); - _mGuiTreeViewCtrl = new GuiTreeViewCtrlObject(ref c); - _mGuiVariableInspector = new GuiVariableInspectorObject(ref c); - _mLangTable = new LangTableObject(ref c); - _mLightBase = new LightBaseObject(ref c); - _mMaterial = new MaterialObject(ref c); - _mMECreateUndoAction = new MECreateUndoActionObject(ref c); - _mMEDeleteUndoAction = new MEDeleteUndoActionObject(ref c); - _mMenuBar = new MenuBarObject(ref c); - _mMessage = new MessageObject(ref c); - _mMessageVector = new MessageVectorObject(ref c); - _mPersistenceManager = new PersistenceManagerObject(ref c); - _mPhysicsDebrisData = new PhysicsDebrisDataObject(ref c); - _mPopupMenu = new PopupMenuObject(ref c); - _mReadXML = new ReadXMLObject(ref c); - _mSettings = new SettingsObject(ref c); - _mSFXSource = new SFXSourceObject(ref c); - _mSimComponent = new SimComponentObject(ref c); - _mSimDataBlock = new SimDataBlockObject(ref c); - _mSimObject = new SimObjectObject(ref c); - _mSimPersistSet = new SimPersistSetObject(ref c); - _mSimResponseCurve = new SimResponseCurveObject(ref c); - _mSimSet = new SimSetObject(ref c); - _mSimXMLDocument = new SimXMLDocumentObject(ref c); - _mSkyBox = new SkyBoxObject(ref c); - _mSpawnSphere = new SpawnSphereObject(ref c); - _mStaticShape = new StaticShapeObject(ref c); - _mSun = new SunObject(ref c); - _mTerrainBlock = new TerrainBlockObject(ref c); - _mTerrainEditor = new TerrainEditorObject(ref c); - _mTerrainSmoothAction = new TerrainSmoothActionObject(ref c); - _mTerrainSolderEdgesAction = new TerrainSolderEdgesActionObject(ref c); - _mTheoraTextureObject = new TheoraTextureObjectObject(ref c); - _mUndoAction = new UndoActionObject(ref c); - _mUndoManager = new UndoManagerObject(ref c); - _mWorldEditor = new WorldEditorObject(ref c); - _mActionMap = new ActionMapObject(ref c); - _mAITurretShape = new AITurretShapeObject(ref c); - _mArrayObject = new ArrayObjectObject(ref c); - _mCamera = new CameraObject(ref c); - _mCloudLayer = new CloudLayerObject(ref c); - _mCoverPoint = new CoverPointObject(ref c); - _mCubemapData = new CubemapDataObject(ref c); - _mDebris = new DebrisObject(ref c); - _mDebugDrawer = new DebugDrawerObject(ref c); - _mDecalData = new DecalDataObject(ref c); - _mDecalRoad = new DecalRoadObject(ref c); - _mDynamicConsoleMethodComponent = new DynamicConsoleMethodComponentObject(ref c); - _mEditTSCtrl = new EditTSCtrlObject(ref c); - _mFileDialog = new FileDialogObject(ref c); - _mFileStreamObject = new FileStreamObjectObject(ref c); - _mFlyingVehicle = new FlyingVehicleObject(ref c); - _mForestWindEmitter = new ForestWindEmitterObject(ref c); - _mGameBase = new GameBaseObject(ref c); - _mGameConnection = new GameConnectionObject(ref c); - _mGroundPlane = new GroundPlaneObject(ref c); - _mGuiAutoCompleteCtrl = new GuiAutoCompleteCtrlObject(ref c); - _mGuiAutoScrollCtrl = new GuiAutoScrollCtrlObject(ref c); - _mGuiBitmapButtonCtrl = new GuiBitmapButtonCtrlObject(ref c); - _mGuiButtonBaseCtrl = new GuiButtonBaseCtrlObject(ref c); - _mGuiCheckBoxCtrl = new GuiCheckBoxCtrlObject(ref c); - _mGuiChunkedBitmapCtrl = new GuiChunkedBitmapCtrlObject(ref c); - _mGuiClockHud = new GuiClockHudObject(ref c); - _mGuiDirectoryFileListCtrl = new GuiDirectoryFileListCtrlObject(ref c); - _mGuiDragAndDropControl = new GuiDragAndDropControlObject(ref c); - _mGuiDynamicCtrlArrayControl = new GuiDynamicCtrlArrayControlObject(ref c); - _mGuiFormCtrl = new GuiFormCtrlObject(ref c); - _mGuiFrameSetCtrl = new GuiFrameSetCtrlObject(ref c); - _mGuiGameListMenuCtrl = new GuiGameListMenuCtrlObject(ref c); - _mGuiGameListOptionsCtrl = new GuiGameListOptionsCtrlObject(ref c); - _mGuiGraphCtrl = new GuiGraphCtrlObject(ref c); - _mGuiIconButtonCtrl = new GuiIconButtonCtrlObject(ref c); - _mGuiImageList = new GuiImageListObject(ref c); - _mGuiInspectorTypeBitMask32 = new GuiInspectorTypeBitMask32Object(ref c); - _mGuiInspectorTypeFileName = new GuiInspectorTypeFileNameObject(ref c); - _mGuiListBoxCtrl = new GuiListBoxCtrlObject(ref c); - _mGuiMaterialPreview = new GuiMaterialPreviewObject(ref c); - _mGuiMenuBar = new GuiMenuBarObject(ref c); - _mGuiMessageVectorCtrl = new GuiMessageVectorCtrlObject(ref c); - _mGuiMissionAreaCtrl = new GuiMissionAreaCtrlObject(ref c); - _mGuiMLTextCtrl = new GuiMLTextCtrlObject(ref c); - _mGuiObjectView = new GuiObjectViewObject(ref c); - _mGuiPaneControl = new GuiPaneControlObject(ref c); - _mGuiProgressBitmapCtrl = new GuiProgressBitmapCtrlObject(ref c); - _mGuiRolloutCtrl = new GuiRolloutCtrlObject(ref c); - _mGuiScrollCtrl = new GuiScrollCtrlObject(ref c); - _mGuiShapeEdPreview = new GuiShapeEdPreviewObject(ref c); - _mGuiSliderCtrl = new GuiSliderCtrlObject(ref c); - _mGuiStackControl = new GuiStackControlObject(ref c); - _mGuiSwatchButtonCtrl = new GuiSwatchButtonCtrlObject(ref c); - _mGuiTabBookCtrl = new GuiTabBookCtrlObject(ref c); - _mGuiTableControl = new GuiTableControlObject(ref c); - _mGuiTabPageCtrl = new GuiTabPageCtrlObject(ref c); - _mGuiTextCtrl = new GuiTextCtrlObject(ref c); - _mGuiTextListCtrl = new GuiTextListCtrlObject(ref c); - _mGuiTheoraCtrl = new GuiTheoraCtrlObject(ref c); - _mGuiTSCtrl = new GuiTSCtrlObject(ref c); - _mGuiWindowCtrl = new GuiWindowCtrlObject(ref c); - _mHTTPObject = new HTTPObjectObject(ref c); - _mItem = new ItemObject(ref c); - _mLevelInfo = new LevelInfoObject(ref c); - _mLightDescription = new LightDescriptionObject(ref c); - _mLightFlareData = new LightFlareDataObject(ref c); - _mLightning = new LightningObject(ref c); - _mMeshRoad = new MeshRoadObject(ref c); - _mMissionArea = new MissionAreaObject(ref c); - _mNavMesh = new NavMeshObject(ref c); - _mNavPath = new NavPathObject(ref c); - _mNetConnection = new NetConnectionObject(ref c); - _mNetObject = new NetObjectObject(ref c); - _mParticleData = new ParticleDataObject(ref c); - _mParticleEmitterData = new ParticleEmitterDataObject(ref c); - _mParticleEmitterNode = new ParticleEmitterNodeObject(ref c); - _mPathCamera = new PathCameraObject(ref c); - _mPhysicalZone = new PhysicalZoneObject(ref c); - _mPhysicsForce = new PhysicsForceObject(ref c); - _mPhysicsShape = new PhysicsShapeObject(ref c); - _mPlayer = new PlayerObject(ref c); - _mPortal = new PortalObject(ref c); - _mPostEffect = new PostEffectObject(ref c); - _mPrecipitation = new PrecipitationObject(ref c); - _mProjectile = new ProjectileObject(ref c); - _mProximityMine = new ProximityMineObject(ref c); - _mRenderBinManager = new RenderBinManagerObject(ref c); - _mRenderMeshExample = new RenderMeshExampleObject(ref c); - _mRenderPassManager = new RenderPassManagerObject(ref c); - _mRenderPassStateToken = new RenderPassStateTokenObject(ref c); - _mRigidShape = new RigidShapeObject(ref c); - _mRiver = new RiverObject(ref c); - _mScatterSky = new ScatterSkyObject(ref c); - _mSceneObject = new SceneObjectObject(ref c); - _mScriptTickObject = new ScriptTickObjectObject(ref c); - _mSFXController = new SFXControllerObject(ref c); - _mSFXEmitter = new SFXEmitterObject(ref c); - _mSFXParameter = new SFXParameterObject(ref c); - _mSFXProfile = new SFXProfileObject(ref c); - _mSFXSound = new SFXSoundObject(ref c); - _mSFXState = new SFXStateObject(ref c); - _mShaderData = new ShaderDataObject(ref c); - _mShapeBase = new ShapeBaseObject(ref c); - _mShapeBaseData = new ShapeBaseDataObject(ref c); - _mSimpleNetObject = new SimpleNetObjectObject(ref c); - _mStreamObject = new StreamObjectObject(ref c); - _mTCPObject = new TCPObjectObject(ref c); - _mTimeOfDay = new TimeOfDayObject(ref c); - _mTrigger = new TriggerObject(ref c); - _mTSAttachable = new TSAttachableObject(ref c); - _mTSDynamic = new TSDynamicObject(ref c); - _mTSPathShape = new TSPathShapeObject(ref c); - _mTSShapeConstructor = new TSShapeConstructorObject(ref c); - _mTSStatic = new TSStaticObject(ref c); - _mTurretShape = new TurretShapeObject(ref c); - _mVolumetricFog = new VolumetricFogObject(ref c); - _mWalkableShape = new WalkableShapeObject(ref c); - _mWheeledVehicle = new WheeledVehicleObject(ref c); - _mWorldEditorSelection = new WorldEditorSelectionObject(ref c); - _mZipObject = new ZipObjectObject(ref c); - _mZone = new ZoneObject(ref c); -} -public UtilObject _mUtil; - /// - /// - /// -public UtilObject Util{get { return _mUtil; }} -public AIClientObject _mAIClient; + _mConsoleobject = new ConsoleObject(); + _mMathobject = new tMath(); + _mUtil = new UtilObject(); + _mAIClient = new AIClientObject(); + _mAIConnection = new AIConnectionObject(); + _mAIPlayer = new AIPlayerObject(); + _mCompoundUndoAction = new CompoundUndoActionObject(); + _mConsoleLogger = new ConsoleLoggerObject(); + _mCreatorTree = new CreatorTreeObject(); + _mDbgFileView = new DbgFileViewObject(); + _mEditManager = new EditManagerObject(); + _mEventManager = new EventManagerObject(); + _mFieldBrushObject = new FieldBrushObjectObject(); + _mFileObject = new FileObjectObject(); + _mForest = new ForestObject(); + _mForestBrush = new ForestBrushObject(); + _mForestBrushTool = new ForestBrushToolObject(); + _mForestEditorCtrl = new ForestEditorCtrlObject(); + _mForestSelectionTool = new ForestSelectionToolObject(); + _mGuiBitmapCtrl = new GuiBitmapCtrlObject(); + _mGuiCanvas = new GuiCanvasObject(); + _mGuiColorPickerCtrl = new GuiColorPickerCtrlObject(); + _mGuiControl = new GuiControlObject(); + _mGuiControlProfile = new GuiControlProfileObject(); + _mGuiConvexEditorCtrl = new GuiConvexEditorCtrlObject(); + _mGuiDecalEditorCtrl = new GuiDecalEditorCtrlObject(); + _mGuiEditCtrl = new GuiEditCtrlObject(); + _mGuiFileTreeCtrl = new GuiFileTreeCtrlObject(); + _mGuiFilterCtrl = new GuiFilterCtrlObject(); + _mGuiGradientCtrl = new GuiGradientCtrlObject(); + _mGuiIdleCamFadeBitmapCtrl = new GuiIdleCamFadeBitmapCtrlObject(); + _mGuiInspector = new GuiInspectorObject(); + _mGuiInspectorDynamicField = new GuiInspectorDynamicFieldObject(); + _mGuiInspectorDynamicGroup = new GuiInspectorDynamicGroupObject(); + _mGuiInspectorField = new GuiInspectorFieldObject(); + _mGuiMaterialCtrl = new GuiMaterialCtrlObject(); + _mGuiMeshRoadEditorCtrl = new GuiMeshRoadEditorCtrlObject(); + _mGuiMissionAreaEditorCtrl = new GuiMissionAreaEditorCtrlObject(); + _mGuiNavEditorCtrl = new GuiNavEditorCtrlObject(); + _mGuiParticleGraphCtrl = new GuiParticleGraphCtrlObject(); + _mGuiPopUpMenuCtrl = new GuiPopUpMenuCtrlObject(); + _mGuiPopUpMenuCtrlEx = new GuiPopUpMenuCtrlExObject(); + _mGuiRiverEditorCtrl = new GuiRiverEditorCtrlObject(); + _mGuiRoadEditorCtrl = new GuiRoadEditorCtrlObject(); + _mGuiTerrPreviewCtrl = new GuiTerrPreviewCtrlObject(); + _mGuiTextEditCtrl = new GuiTextEditCtrlObject(); + _mGuiTickCtrl = new GuiTickCtrlObject(); + _mGuiToolboxButtonCtrl = new GuiToolboxButtonCtrlObject(); + _mGuiTreeViewCtrl = new GuiTreeViewCtrlObject(); + _mGuiVariableInspector = new GuiVariableInspectorObject(); + _mLangTable = new LangTableObject(); + _mLightBase = new LightBaseObject(); + _mMaterial = new MaterialObject(); + _mMECreateUndoAction = new MECreateUndoActionObject(); + _mMEDeleteUndoAction = new MEDeleteUndoActionObject(); + _mMenuBar = new MenuBarObject(); + _mMessage = new MessageObject(); + _mMessageVector = new MessageVectorObject(); + _mPersistenceManager = new PersistenceManagerObject(); + _mPhysicsDebrisData = new PhysicsDebrisDataObject(); + _mPopupMenu = new PopupMenuObject(); + _mReadXML = new ReadXMLObject(); + _mSettings = new SettingsObject(); + _mSFXSource = new SFXSourceObject(); + _mSimComponent = new SimComponentObject(); + _mSimDataBlock = new SimDataBlockObject(); + _mSimObject = new SimObjectObject(); + _mSimPersistSet = new SimPersistSetObject(); + _mSimResponseCurve = new SimResponseCurveObject(); + _mSimSet = new SimSetObject(); + _mSimXMLDocument = new SimXMLDocumentObject(); + _mSkyBox = new SkyBoxObject(); + _mSpawnSphere = new SpawnSphereObject(); + _mStaticShape = new StaticShapeObject(); + _mSun = new SunObject(); + _mTerrainBlock = new TerrainBlockObject(); + _mTerrainEditor = new TerrainEditorObject(); + _mTerrainSmoothAction = new TerrainSmoothActionObject(); + _mTerrainSolderEdgesAction = new TerrainSolderEdgesActionObject(); + _mTheoraTextureObject = new TheoraTextureObjectObject(); + _mUndoAction = new UndoActionObject(); + _mUndoManager = new UndoManagerObject(); + _mWorldEditor = new WorldEditorObject(); + _mActionMap = new ActionMapObject(); + _mAITurretShape = new AITurretShapeObject(); + _mArrayObject = new ArrayObjectObject(); + _mCamera = new CameraObject(); + _mCoverPoint = new CoverPointObject(); + _mCubemapData = new CubemapDataObject(); + _mDebris = new DebrisObject(); + _mDebugDrawer = new DebugDrawerObject(); + _mDecalData = new DecalDataObject(); + _mDecalRoad = new DecalRoadObject(); + _mDynamicConsoleMethodComponent = new DynamicConsoleMethodComponentObject(); + _mEditTSCtrl = new EditTSCtrlObject(); + _mFileDialog = new FileDialogObject(); + _mFileStreamObject = new FileStreamObjectObject(); + _mFlyingVehicle = new FlyingVehicleObject(); + _mForestWindEmitter = new ForestWindEmitterObject(); + _mGameBase = new GameBaseObject(); + _mGameConnection = new GameConnectionObject(); + _mGroundPlane = new GroundPlaneObject(); + _mGuiAutoCompleteCtrl = new GuiAutoCompleteCtrlObject(); + _mGuiAutoScrollCtrl = new GuiAutoScrollCtrlObject(); + _mGuiBitmapButtonCtrl = new GuiBitmapButtonCtrlObject(); + _mGuiButtonBaseCtrl = new GuiButtonBaseCtrlObject(); + _mGuiCheckBoxCtrl = new GuiCheckBoxCtrlObject(); + _mGuiChunkedBitmapCtrl = new GuiChunkedBitmapCtrlObject(); + _mGuiClockHud = new GuiClockHudObject(); + _mGuiDirectoryFileListCtrl = new GuiDirectoryFileListCtrlObject(); + _mGuiDragAndDropControl = new GuiDragAndDropControlObject(); + _mGuiDynamicCtrlArrayControl = new GuiDynamicCtrlArrayControlObject(); + _mGuiFormCtrl = new GuiFormCtrlObject(); + _mGuiFrameSetCtrl = new GuiFrameSetCtrlObject(); + _mGuiGameListMenuCtrl = new GuiGameListMenuCtrlObject(); + _mGuiGameListOptionsCtrl = new GuiGameListOptionsCtrlObject(); + _mGuiGraphCtrl = new GuiGraphCtrlObject(); + _mGuiIconButtonCtrl = new GuiIconButtonCtrlObject(); + _mGuiImageList = new GuiImageListObject(); + _mGuiInspectorTypeBitMask32 = new GuiInspectorTypeBitMask32Object(); + _mGuiInspectorTypeFileName = new GuiInspectorTypeFileNameObject(); + _mGuiListBoxCtrl = new GuiListBoxCtrlObject(); + _mGuiMaterialPreview = new GuiMaterialPreviewObject(); + _mGuiMenuBar = new GuiMenuBarObject(); + _mGuiMessageVectorCtrl = new GuiMessageVectorCtrlObject(); + _mGuiMissionAreaCtrl = new GuiMissionAreaCtrlObject(); + _mGuiMLTextCtrl = new GuiMLTextCtrlObject(); + _mGuiObjectView = new GuiObjectViewObject(); + _mGuiPaneControl = new GuiPaneControlObject(); + _mGuiProgressBitmapCtrl = new GuiProgressBitmapCtrlObject(); + _mGuiRolloutCtrl = new GuiRolloutCtrlObject(); + _mGuiScrollCtrl = new GuiScrollCtrlObject(); + _mGuiShapeEdPreview = new GuiShapeEdPreviewObject(); + _mGuiSliderCtrl = new GuiSliderCtrlObject(); + _mGuiStackControl = new GuiStackControlObject(); + _mGuiSwatchButtonCtrl = new GuiSwatchButtonCtrlObject(); + _mGuiTabBookCtrl = new GuiTabBookCtrlObject(); + _mGuiTableControl = new GuiTableControlObject(); + _mGuiTabPageCtrl = new GuiTabPageCtrlObject(); + _mGuiTextCtrl = new GuiTextCtrlObject(); + _mGuiTextListCtrl = new GuiTextListCtrlObject(); + _mGuiTheoraCtrl = new GuiTheoraCtrlObject(); + _mGuiTSCtrl = new GuiTSCtrlObject(); + _mGuiWindowCtrl = new GuiWindowCtrlObject(); + _mHTTPObject = new HTTPObjectObject(); + _mItem = new ItemObject(); + _mLevelInfo = new LevelInfoObject(); + _mLightDescription = new LightDescriptionObject(); + _mLightFlareData = new LightFlareDataObject(); + _mLightning = new LightningObject(); + _mMeshRoad = new MeshRoadObject(); + _mMissionArea = new MissionAreaObject(); + _mNavMesh = new NavMeshObject(); + _mNavPath = new NavPathObject(); + _mNetConnection = new NetConnectionObject(); + _mNetObject = new NetObjectObject(); + _mParticleData = new ParticleDataObject(); + _mParticleEmitterData = new ParticleEmitterDataObject(); + _mParticleEmitterNode = new ParticleEmitterNodeObject(); + _mPathCamera = new PathCameraObject(); + _mPhysicalZone = new PhysicalZoneObject(); + _mPhysicsForce = new PhysicsForceObject(); + _mPhysicsShape = new PhysicsShapeObject(); + _mPlayer = new PlayerObject(); + _mPortal = new PortalObject(); + _mPostEffect = new PostEffectObject(); + _mPrecipitation = new PrecipitationObject(); + _mProjectile = new ProjectileObject(); + _mProximityMine = new ProximityMineObject(); + _mRenderBinManager = new RenderBinManagerObject(); + _mRenderMeshExample = new RenderMeshExampleObject(); + _mRenderPassManager = new RenderPassManagerObject(); + _mRenderPassStateToken = new RenderPassStateTokenObject(); + _mRigidShape = new RigidShapeObject(); + _mRiver = new RiverObject(); + _mScatterSky = new ScatterSkyObject(); + _mSceneObject = new SceneObjectObject(); + _mScriptTickObject = new ScriptTickObjectObject(); + _mSFXController = new SFXControllerObject(); + _mSFXEmitter = new SFXEmitterObject(); + _mSFXParameter = new SFXParameterObject(); + _mSFXProfile = new SFXProfileObject(); + _mSFXSound = new SFXSoundObject(); + _mSFXState = new SFXStateObject(); + _mShaderData = new ShaderDataObject(); + _mShapeBase = new ShapeBaseObject(); + _mShapeBaseData = new ShapeBaseDataObject(); + _mSimpleNetObject = new SimpleNetObjectObject(); + _mStreamObject = new StreamObjectObject(); + _mTCPObject = new TCPObjectObject(); + _mTimeOfDay = new TimeOfDayObject(); + _mTrigger = new TriggerObject(); + _mTSAttachable = new TSAttachableObject(); + _mTSDynamic = new TSDynamicObject(); + _mTSPathShape = new TSPathShapeObject(); + _mTSShapeConstructor = new TSShapeConstructorObject(); + _mTSStatic = new TSStaticObject(); + _mTurretShape = new TurretShapeObject(); + _mVolumetricFog = new VolumetricFogObject(); + _mWalkableShape = new WalkableShapeObject(); + _mWheeledVehicle = new WheeledVehicleObject(); + _mWorldEditorSelection = new WorldEditorSelectionObject(); + _mZipObject = new ZipObjectObject(); + _mZone = new ZoneObject(); +} +private static UtilObject _mUtil; /// /// /// -public AIClientObject AIClient{get { return _mAIClient; }} -public AIConnectionObject _mAIConnection; +public static UtilObject Util{get { return _mUtil; }} +private static AIClientObject _mAIClient; /// /// /// -public AIConnectionObject AIConnection{get { return _mAIConnection; }} -public AIPlayerObject _mAIPlayer; +public static AIClientObject AIClient{get { return _mAIClient; }} +private static AIConnectionObject _mAIConnection; /// /// /// -public AIPlayerObject AIPlayer{get { return _mAIPlayer; }} -public CompoundUndoActionObject _mCompoundUndoAction; +public static AIConnectionObject AIConnection{get { return _mAIConnection; }} +private static AIPlayerObject _mAIPlayer; /// /// /// -public CompoundUndoActionObject CompoundUndoAction{get { return _mCompoundUndoAction; }} -public ConsoleLoggerObject _mConsoleLogger; +public static AIPlayerObject AIPlayer{get { return _mAIPlayer; }} +private static CompoundUndoActionObject _mCompoundUndoAction; /// /// /// -public ConsoleLoggerObject ConsoleLogger{get { return _mConsoleLogger; }} -public CreatorTreeObject _mCreatorTree; +public static CompoundUndoActionObject CompoundUndoAction{get { return _mCompoundUndoAction; }} +private static ConsoleLoggerObject _mConsoleLogger; /// /// /// -public CreatorTreeObject CreatorTree{get { return _mCreatorTree; }} -public DbgFileViewObject _mDbgFileView; +public static ConsoleLoggerObject ConsoleLogger{get { return _mConsoleLogger; }} +private static CreatorTreeObject _mCreatorTree; /// /// /// -public DbgFileViewObject DbgFileView{get { return _mDbgFileView; }} -public EditManagerObject _mEditManager; +public static CreatorTreeObject CreatorTree{get { return _mCreatorTree; }} +private static DbgFileViewObject _mDbgFileView; /// /// /// -public EditManagerObject EditManager{get { return _mEditManager; }} -public EventManagerObject _mEventManager; +public static DbgFileViewObject DbgFileView{get { return _mDbgFileView; }} +private static EditManagerObject _mEditManager; /// /// /// -public EventManagerObject EventManager{get { return _mEventManager; }} -public FieldBrushObjectObject _mFieldBrushObject; +public static EditManagerObject EditManager{get { return _mEditManager; }} +private static EventManagerObject _mEventManager; /// /// /// -public FieldBrushObjectObject FieldBrushObject{get { return _mFieldBrushObject; }} -public FileObjectObject _mFileObject; +public static EventManagerObject EventManager{get { return _mEventManager; }} +private static FieldBrushObjectObject _mFieldBrushObject; /// /// /// -public FileObjectObject FileObject{get { return _mFileObject; }} -public ForestObject _mForest; +public static FieldBrushObjectObject FieldBrushObject{get { return _mFieldBrushObject; }} +private static FileObjectObject _mFileObject; /// /// /// -public ForestObject Forest{get { return _mForest; }} -public ForestBrushObject _mForestBrush; +public static FileObjectObject FileObject{get { return _mFileObject; }} +private static ForestObject _mForest; /// /// /// -public ForestBrushObject ForestBrush{get { return _mForestBrush; }} -public ForestBrushToolObject _mForestBrushTool; +public static ForestObject Forest{get { return _mForest; }} +private static ForestBrushObject _mForestBrush; /// /// /// -public ForestBrushToolObject ForestBrushTool{get { return _mForestBrushTool; }} -public ForestEditorCtrlObject _mForestEditorCtrl; +public static ForestBrushObject ForestBrush{get { return _mForestBrush; }} +private static ForestBrushToolObject _mForestBrushTool; /// /// /// -public ForestEditorCtrlObject ForestEditorCtrl{get { return _mForestEditorCtrl; }} -public ForestSelectionToolObject _mForestSelectionTool; +public static ForestBrushToolObject ForestBrushTool{get { return _mForestBrushTool; }} +private static ForestEditorCtrlObject _mForestEditorCtrl; /// /// /// -public ForestSelectionToolObject ForestSelectionTool{get { return _mForestSelectionTool; }} -public GuiBitmapCtrlObject _mGuiBitmapCtrl; +public static ForestEditorCtrlObject ForestEditorCtrl{get { return _mForestEditorCtrl; }} +private static ForestSelectionToolObject _mForestSelectionTool; /// /// /// -public GuiBitmapCtrlObject GuiBitmapCtrl{get { return _mGuiBitmapCtrl; }} -public GuiCanvasObject _mGuiCanvas; +public static ForestSelectionToolObject ForestSelectionTool{get { return _mForestSelectionTool; }} +private static GuiBitmapCtrlObject _mGuiBitmapCtrl; /// /// /// -public GuiCanvasObject GuiCanvas{get { return _mGuiCanvas; }} -public GuiColorPickerCtrlObject _mGuiColorPickerCtrl; +public static GuiBitmapCtrlObject GuiBitmapCtrl{get { return _mGuiBitmapCtrl; }} +private static GuiCanvasObject _mGuiCanvas; /// /// /// -public GuiColorPickerCtrlObject GuiColorPickerCtrl{get { return _mGuiColorPickerCtrl; }} -public GuiControlObject _mGuiControl; +public static GuiCanvasObject GuiCanvas{get { return _mGuiCanvas; }} +private static GuiColorPickerCtrlObject _mGuiColorPickerCtrl; /// /// /// -public GuiControlObject GuiControl{get { return _mGuiControl; }} -public GuiControlProfileObject _mGuiControlProfile; +public static GuiColorPickerCtrlObject GuiColorPickerCtrl{get { return _mGuiColorPickerCtrl; }} +private static GuiControlObject _mGuiControl; /// /// /// -public GuiControlProfileObject GuiControlProfile{get { return _mGuiControlProfile; }} -public GuiConvexEditorCtrlObject _mGuiConvexEditorCtrl; +public static GuiControlObject GuiControl{get { return _mGuiControl; }} +private static GuiControlProfileObject _mGuiControlProfile; /// /// /// -public GuiConvexEditorCtrlObject GuiConvexEditorCtrl{get { return _mGuiConvexEditorCtrl; }} -public GuiDecalEditorCtrlObject _mGuiDecalEditorCtrl; +public static GuiControlProfileObject GuiControlProfile{get { return _mGuiControlProfile; }} +private static GuiConvexEditorCtrlObject _mGuiConvexEditorCtrl; /// /// /// -public GuiDecalEditorCtrlObject GuiDecalEditorCtrl{get { return _mGuiDecalEditorCtrl; }} -public GuiEditCtrlObject _mGuiEditCtrl; +public static GuiConvexEditorCtrlObject GuiConvexEditorCtrl{get { return _mGuiConvexEditorCtrl; }} +private static GuiDecalEditorCtrlObject _mGuiDecalEditorCtrl; /// /// /// -public GuiEditCtrlObject GuiEditCtrl{get { return _mGuiEditCtrl; }} -public GuiFileTreeCtrlObject _mGuiFileTreeCtrl; +public static GuiDecalEditorCtrlObject GuiDecalEditorCtrl{get { return _mGuiDecalEditorCtrl; }} +private static GuiEditCtrlObject _mGuiEditCtrl; /// /// /// -public GuiFileTreeCtrlObject GuiFileTreeCtrl{get { return _mGuiFileTreeCtrl; }} -public GuiFilterCtrlObject _mGuiFilterCtrl; +public static GuiEditCtrlObject GuiEditCtrl{get { return _mGuiEditCtrl; }} +private static GuiFileTreeCtrlObject _mGuiFileTreeCtrl; /// /// /// -public GuiFilterCtrlObject GuiFilterCtrl{get { return _mGuiFilterCtrl; }} -public GuiGradientCtrlObject _mGuiGradientCtrl; +public static GuiFileTreeCtrlObject GuiFileTreeCtrl{get { return _mGuiFileTreeCtrl; }} +private static GuiFilterCtrlObject _mGuiFilterCtrl; /// /// /// -public GuiGradientCtrlObject GuiGradientCtrl{get { return _mGuiGradientCtrl; }} -public GuiIdleCamFadeBitmapCtrlObject _mGuiIdleCamFadeBitmapCtrl; +public static GuiFilterCtrlObject GuiFilterCtrl{get { return _mGuiFilterCtrl; }} +private static GuiGradientCtrlObject _mGuiGradientCtrl; /// /// /// -public GuiIdleCamFadeBitmapCtrlObject GuiIdleCamFadeBitmapCtrl{get { return _mGuiIdleCamFadeBitmapCtrl; }} -public GuiInspectorObject _mGuiInspector; +public static GuiGradientCtrlObject GuiGradientCtrl{get { return _mGuiGradientCtrl; }} +private static GuiIdleCamFadeBitmapCtrlObject _mGuiIdleCamFadeBitmapCtrl; /// /// /// -public GuiInspectorObject GuiInspector{get { return _mGuiInspector; }} -public GuiInspectorDynamicFieldObject _mGuiInspectorDynamicField; +public static GuiIdleCamFadeBitmapCtrlObject GuiIdleCamFadeBitmapCtrl{get { return _mGuiIdleCamFadeBitmapCtrl; }} +private static GuiInspectorObject _mGuiInspector; /// /// /// -public GuiInspectorDynamicFieldObject GuiInspectorDynamicField{get { return _mGuiInspectorDynamicField; }} -public GuiInspectorDynamicGroupObject _mGuiInspectorDynamicGroup; +public static GuiInspectorObject GuiInspector{get { return _mGuiInspector; }} +private static GuiInspectorDynamicFieldObject _mGuiInspectorDynamicField; /// /// /// -public GuiInspectorDynamicGroupObject GuiInspectorDynamicGroup{get { return _mGuiInspectorDynamicGroup; }} -public GuiInspectorFieldObject _mGuiInspectorField; +public static GuiInspectorDynamicFieldObject GuiInspectorDynamicField{get { return _mGuiInspectorDynamicField; }} +private static GuiInspectorDynamicGroupObject _mGuiInspectorDynamicGroup; /// /// /// -public GuiInspectorFieldObject GuiInspectorField{get { return _mGuiInspectorField; }} -public GuiMaterialCtrlObject _mGuiMaterialCtrl; +public static GuiInspectorDynamicGroupObject GuiInspectorDynamicGroup{get { return _mGuiInspectorDynamicGroup; }} +private static GuiInspectorFieldObject _mGuiInspectorField; /// /// /// -public GuiMaterialCtrlObject GuiMaterialCtrl{get { return _mGuiMaterialCtrl; }} -public GuiMeshRoadEditorCtrlObject _mGuiMeshRoadEditorCtrl; +public static GuiInspectorFieldObject GuiInspectorField{get { return _mGuiInspectorField; }} +private static GuiMaterialCtrlObject _mGuiMaterialCtrl; /// /// /// -public GuiMeshRoadEditorCtrlObject GuiMeshRoadEditorCtrl{get { return _mGuiMeshRoadEditorCtrl; }} -public GuiMissionAreaEditorCtrlObject _mGuiMissionAreaEditorCtrl; +public static GuiMaterialCtrlObject GuiMaterialCtrl{get { return _mGuiMaterialCtrl; }} +private static GuiMeshRoadEditorCtrlObject _mGuiMeshRoadEditorCtrl; /// /// /// -public GuiMissionAreaEditorCtrlObject GuiMissionAreaEditorCtrl{get { return _mGuiMissionAreaEditorCtrl; }} -public GuiNavEditorCtrlObject _mGuiNavEditorCtrl; +public static GuiMeshRoadEditorCtrlObject GuiMeshRoadEditorCtrl{get { return _mGuiMeshRoadEditorCtrl; }} +private static GuiMissionAreaEditorCtrlObject _mGuiMissionAreaEditorCtrl; /// /// /// -public GuiNavEditorCtrlObject GuiNavEditorCtrl{get { return _mGuiNavEditorCtrl; }} -public GuiParticleGraphCtrlObject _mGuiParticleGraphCtrl; +public static GuiMissionAreaEditorCtrlObject GuiMissionAreaEditorCtrl{get { return _mGuiMissionAreaEditorCtrl; }} +private static GuiNavEditorCtrlObject _mGuiNavEditorCtrl; /// /// /// -public GuiParticleGraphCtrlObject GuiParticleGraphCtrl{get { return _mGuiParticleGraphCtrl; }} -public GuiPopUpMenuCtrlObject _mGuiPopUpMenuCtrl; +public static GuiNavEditorCtrlObject GuiNavEditorCtrl{get { return _mGuiNavEditorCtrl; }} +private static GuiParticleGraphCtrlObject _mGuiParticleGraphCtrl; /// /// /// -public GuiPopUpMenuCtrlObject GuiPopUpMenuCtrl{get { return _mGuiPopUpMenuCtrl; }} -public GuiPopUpMenuCtrlExObject _mGuiPopUpMenuCtrlEx; +public static GuiParticleGraphCtrlObject GuiParticleGraphCtrl{get { return _mGuiParticleGraphCtrl; }} +private static GuiPopUpMenuCtrlObject _mGuiPopUpMenuCtrl; /// /// /// -public GuiPopUpMenuCtrlExObject GuiPopUpMenuCtrlEx{get { return _mGuiPopUpMenuCtrlEx; }} -public GuiRiverEditorCtrlObject _mGuiRiverEditorCtrl; +public static GuiPopUpMenuCtrlObject GuiPopUpMenuCtrl{get { return _mGuiPopUpMenuCtrl; }} +private static GuiPopUpMenuCtrlExObject _mGuiPopUpMenuCtrlEx; /// /// /// -public GuiRiverEditorCtrlObject GuiRiverEditorCtrl{get { return _mGuiRiverEditorCtrl; }} -public GuiRoadEditorCtrlObject _mGuiRoadEditorCtrl; +public static GuiPopUpMenuCtrlExObject GuiPopUpMenuCtrlEx{get { return _mGuiPopUpMenuCtrlEx; }} +private static GuiRiverEditorCtrlObject _mGuiRiverEditorCtrl; /// /// /// -public GuiRoadEditorCtrlObject GuiRoadEditorCtrl{get { return _mGuiRoadEditorCtrl; }} -public GuiTerrPreviewCtrlObject _mGuiTerrPreviewCtrl; +public static GuiRiverEditorCtrlObject GuiRiverEditorCtrl{get { return _mGuiRiverEditorCtrl; }} +private static GuiRoadEditorCtrlObject _mGuiRoadEditorCtrl; /// /// /// -public GuiTerrPreviewCtrlObject GuiTerrPreviewCtrl{get { return _mGuiTerrPreviewCtrl; }} -public GuiTextEditCtrlObject _mGuiTextEditCtrl; +public static GuiRoadEditorCtrlObject GuiRoadEditorCtrl{get { return _mGuiRoadEditorCtrl; }} +private static GuiTerrPreviewCtrlObject _mGuiTerrPreviewCtrl; /// /// /// -public GuiTextEditCtrlObject GuiTextEditCtrl{get { return _mGuiTextEditCtrl; }} -public GuiTickCtrlObject _mGuiTickCtrl; +public static GuiTerrPreviewCtrlObject GuiTerrPreviewCtrl{get { return _mGuiTerrPreviewCtrl; }} +private static GuiTextEditCtrlObject _mGuiTextEditCtrl; /// /// /// -public GuiTickCtrlObject GuiTickCtrl{get { return _mGuiTickCtrl; }} -public GuiToolboxButtonCtrlObject _mGuiToolboxButtonCtrl; +public static GuiTextEditCtrlObject GuiTextEditCtrl{get { return _mGuiTextEditCtrl; }} +private static GuiTickCtrlObject _mGuiTickCtrl; /// /// /// -public GuiToolboxButtonCtrlObject GuiToolboxButtonCtrl{get { return _mGuiToolboxButtonCtrl; }} -public GuiTreeViewCtrlObject _mGuiTreeViewCtrl; +public static GuiTickCtrlObject GuiTickCtrl{get { return _mGuiTickCtrl; }} +private static GuiToolboxButtonCtrlObject _mGuiToolboxButtonCtrl; /// /// /// -public GuiTreeViewCtrlObject GuiTreeViewCtrl{get { return _mGuiTreeViewCtrl; }} -public GuiVariableInspectorObject _mGuiVariableInspector; +public static GuiToolboxButtonCtrlObject GuiToolboxButtonCtrl{get { return _mGuiToolboxButtonCtrl; }} +private static GuiTreeViewCtrlObject _mGuiTreeViewCtrl; /// /// /// -public GuiVariableInspectorObject GuiVariableInspector{get { return _mGuiVariableInspector; }} -public LangTableObject _mLangTable; +public static GuiTreeViewCtrlObject GuiTreeViewCtrl{get { return _mGuiTreeViewCtrl; }} +private static GuiVariableInspectorObject _mGuiVariableInspector; /// /// /// -public LangTableObject LangTable{get { return _mLangTable; }} -public LightBaseObject _mLightBase; +public static GuiVariableInspectorObject GuiVariableInspector{get { return _mGuiVariableInspector; }} +private static LangTableObject _mLangTable; /// /// /// -public LightBaseObject LightBase{get { return _mLightBase; }} -public MaterialObject _mMaterial; +public static LangTableObject LangTable{get { return _mLangTable; }} +private static LightBaseObject _mLightBase; /// /// /// -public MaterialObject Material{get { return _mMaterial; }} -public MECreateUndoActionObject _mMECreateUndoAction; +public static LightBaseObject LightBase{get { return _mLightBase; }} +private static MaterialObject _mMaterial; /// /// /// -public MECreateUndoActionObject MECreateUndoAction{get { return _mMECreateUndoAction; }} -public MEDeleteUndoActionObject _mMEDeleteUndoAction; +public static MaterialObject Material{get { return _mMaterial; }} +private static MECreateUndoActionObject _mMECreateUndoAction; /// /// /// -public MEDeleteUndoActionObject MEDeleteUndoAction{get { return _mMEDeleteUndoAction; }} -public MenuBarObject _mMenuBar; +public static MECreateUndoActionObject MECreateUndoAction{get { return _mMECreateUndoAction; }} +private static MEDeleteUndoActionObject _mMEDeleteUndoAction; /// /// /// -public MenuBarObject MenuBar{get { return _mMenuBar; }} -public MessageObject _mMessage; +public static MEDeleteUndoActionObject MEDeleteUndoAction{get { return _mMEDeleteUndoAction; }} +private static MenuBarObject _mMenuBar; /// /// /// -public MessageObject Message{get { return _mMessage; }} -public MessageVectorObject _mMessageVector; +public static MenuBarObject MenuBar{get { return _mMenuBar; }} +private static MessageObject _mMessage; /// /// /// -public MessageVectorObject MessageVector{get { return _mMessageVector; }} -public PersistenceManagerObject _mPersistenceManager; +public static MessageObject Message{get { return _mMessage; }} +private static MessageVectorObject _mMessageVector; /// /// /// -public PersistenceManagerObject PersistenceManager{get { return _mPersistenceManager; }} -public PhysicsDebrisDataObject _mPhysicsDebrisData; +public static MessageVectorObject MessageVector{get { return _mMessageVector; }} +private static PersistenceManagerObject _mPersistenceManager; /// /// /// -public PhysicsDebrisDataObject PhysicsDebrisData{get { return _mPhysicsDebrisData; }} -public PopupMenuObject _mPopupMenu; +public static PersistenceManagerObject PersistenceManager{get { return _mPersistenceManager; }} +private static PhysicsDebrisDataObject _mPhysicsDebrisData; /// /// /// -public PopupMenuObject PopupMenu{get { return _mPopupMenu; }} -public ReadXMLObject _mReadXML; +public static PhysicsDebrisDataObject PhysicsDebrisData{get { return _mPhysicsDebrisData; }} +private static PopupMenuObject _mPopupMenu; /// /// /// -public ReadXMLObject ReadXML{get { return _mReadXML; }} -public SettingsObject _mSettings; +public static PopupMenuObject PopupMenu{get { return _mPopupMenu; }} +private static ReadXMLObject _mReadXML; /// /// /// -public SettingsObject Settings{get { return _mSettings; }} -public SFXSourceObject _mSFXSource; +public static ReadXMLObject ReadXML{get { return _mReadXML; }} +private static SettingsObject _mSettings; /// /// /// -public SFXSourceObject SFXSource{get { return _mSFXSource; }} -public SimComponentObject _mSimComponent; +public static SettingsObject Settings{get { return _mSettings; }} +private static SFXSourceObject _mSFXSource; /// /// /// -public SimComponentObject SimComponent{get { return _mSimComponent; }} -public SimDataBlockObject _mSimDataBlock; +public static SFXSourceObject SFXSource{get { return _mSFXSource; }} +private static SimComponentObject _mSimComponent; /// /// /// -public SimDataBlockObject SimDataBlock{get { return _mSimDataBlock; }} -public SimObjectObject _mSimObject; +public static SimComponentObject SimComponent{get { return _mSimComponent; }} +private static SimDataBlockObject _mSimDataBlock; /// /// /// -public SimObjectObject SimObject{get { return _mSimObject; }} -public SimPersistSetObject _mSimPersistSet; +public static SimDataBlockObject SimDataBlock{get { return _mSimDataBlock; }} +private static SimObjectObject _mSimObject; /// /// /// -public SimPersistSetObject SimPersistSet{get { return _mSimPersistSet; }} -public SimResponseCurveObject _mSimResponseCurve; +public static SimObjectObject SimObject{get { return _mSimObject; }} +private static SimPersistSetObject _mSimPersistSet; /// /// /// -public SimResponseCurveObject SimResponseCurve{get { return _mSimResponseCurve; }} -public SimSetObject _mSimSet; +public static SimPersistSetObject SimPersistSet{get { return _mSimPersistSet; }} +private static SimResponseCurveObject _mSimResponseCurve; /// /// /// -public SimSetObject SimSet{get { return _mSimSet; }} -public SimXMLDocumentObject _mSimXMLDocument; +public static SimResponseCurveObject SimResponseCurve{get { return _mSimResponseCurve; }} +private static SimSetObject _mSimSet; /// /// /// -public SimXMLDocumentObject SimXMLDocument{get { return _mSimXMLDocument; }} -public SkyBoxObject _mSkyBox; +public static SimSetObject SimSet{get { return _mSimSet; }} +private static SimXMLDocumentObject _mSimXMLDocument; /// /// /// -public SkyBoxObject SkyBox{get { return _mSkyBox; }} -public SpawnSphereObject _mSpawnSphere; +public static SimXMLDocumentObject SimXMLDocument{get { return _mSimXMLDocument; }} +private static SkyBoxObject _mSkyBox; /// /// /// -public SpawnSphereObject SpawnSphere{get { return _mSpawnSphere; }} -public StaticShapeObject _mStaticShape; +public static SkyBoxObject SkyBox{get { return _mSkyBox; }} +private static SpawnSphereObject _mSpawnSphere; /// /// /// -public StaticShapeObject StaticShape{get { return _mStaticShape; }} -public SunObject _mSun; +public static SpawnSphereObject SpawnSphere{get { return _mSpawnSphere; }} +private static StaticShapeObject _mStaticShape; /// /// /// -public SunObject Sun{get { return _mSun; }} -public TerrainBlockObject _mTerrainBlock; +public static StaticShapeObject StaticShape{get { return _mStaticShape; }} +private static SunObject _mSun; /// /// /// -public TerrainBlockObject TerrainBlock{get { return _mTerrainBlock; }} -public TerrainEditorObject _mTerrainEditor; +public static SunObject Sun{get { return _mSun; }} +private static TerrainBlockObject _mTerrainBlock; /// /// /// -public TerrainEditorObject TerrainEditor{get { return _mTerrainEditor; }} -public TerrainSmoothActionObject _mTerrainSmoothAction; +public static TerrainBlockObject TerrainBlock{get { return _mTerrainBlock; }} +private static TerrainEditorObject _mTerrainEditor; /// /// /// -public TerrainSmoothActionObject TerrainSmoothAction{get { return _mTerrainSmoothAction; }} -public TerrainSolderEdgesActionObject _mTerrainSolderEdgesAction; +public static TerrainEditorObject TerrainEditor{get { return _mTerrainEditor; }} +private static TerrainSmoothActionObject _mTerrainSmoothAction; /// /// /// -public TerrainSolderEdgesActionObject TerrainSolderEdgesAction{get { return _mTerrainSolderEdgesAction; }} -public TheoraTextureObjectObject _mTheoraTextureObject; +public static TerrainSmoothActionObject TerrainSmoothAction{get { return _mTerrainSmoothAction; }} +private static TerrainSolderEdgesActionObject _mTerrainSolderEdgesAction; /// /// /// -public TheoraTextureObjectObject TheoraTextureObject{get { return _mTheoraTextureObject; }} -public UndoActionObject _mUndoAction; +public static TerrainSolderEdgesActionObject TerrainSolderEdgesAction{get { return _mTerrainSolderEdgesAction; }} +private static TheoraTextureObjectObject _mTheoraTextureObject; /// /// /// -public UndoActionObject UndoAction{get { return _mUndoAction; }} -public UndoManagerObject _mUndoManager; +public static TheoraTextureObjectObject TheoraTextureObject{get { return _mTheoraTextureObject; }} +private static UndoActionObject _mUndoAction; /// /// /// -public UndoManagerObject UndoManager{get { return _mUndoManager; }} -public WorldEditorObject _mWorldEditor; +public static UndoActionObject UndoAction{get { return _mUndoAction; }} +private static UndoManagerObject _mUndoManager; /// /// /// -public WorldEditorObject WorldEditor{get { return _mWorldEditor; }} -public ActionMapObject _mActionMap; +public static UndoManagerObject UndoManager{get { return _mUndoManager; }} +private static WorldEditorObject _mWorldEditor; /// /// /// -public ActionMapObject ActionMap{get { return _mActionMap; }} -public AITurretShapeObject _mAITurretShape; +public static WorldEditorObject WorldEditor{get { return _mWorldEditor; }} +private static ActionMapObject _mActionMap; /// /// /// -public AITurretShapeObject AITurretShape{get { return _mAITurretShape; }} -public ArrayObjectObject _mArrayObject; +public static ActionMapObject ActionMap{get { return _mActionMap; }} +private static AITurretShapeObject _mAITurretShape; /// /// /// -public ArrayObjectObject ArrayObject{get { return _mArrayObject; }} -public CameraObject _mCamera; +public static AITurretShapeObject AITurretShape{get { return _mAITurretShape; }} +private static ArrayObjectObject _mArrayObject; /// /// /// -public CameraObject Camera{get { return _mCamera; }} -public CloudLayerObject _mCloudLayer; +public static ArrayObjectObject ArrayObject{get { return _mArrayObject; }} +private static CameraObject _mCamera; /// /// /// -public CloudLayerObject CloudLayer{get { return _mCloudLayer; }} -public CoverPointObject _mCoverPoint; +public static CameraObject Camera{get { return _mCamera; }} +private static CoverPointObject _mCoverPoint; /// /// /// -public CoverPointObject CoverPoint{get { return _mCoverPoint; }} -public CubemapDataObject _mCubemapData; +public static CoverPointObject CoverPoint{get { return _mCoverPoint; }} +private static CubemapDataObject _mCubemapData; /// /// /// -public CubemapDataObject CubemapData{get { return _mCubemapData; }} -public DebrisObject _mDebris; +public static CubemapDataObject CubemapData{get { return _mCubemapData; }} +private static DebrisObject _mDebris; /// /// /// -public DebrisObject Debris{get { return _mDebris; }} -public DebugDrawerObject _mDebugDrawer; +public static DebrisObject Debris{get { return _mDebris; }} +private static DebugDrawerObject _mDebugDrawer; /// /// /// -public DebugDrawerObject DebugDrawer{get { return _mDebugDrawer; }} -public DecalDataObject _mDecalData; +public static DebugDrawerObject DebugDrawer{get { return _mDebugDrawer; }} +private static DecalDataObject _mDecalData; /// /// /// -public DecalDataObject DecalData{get { return _mDecalData; }} -public DecalRoadObject _mDecalRoad; +public static DecalDataObject DecalData{get { return _mDecalData; }} +private static DecalRoadObject _mDecalRoad; /// /// /// -public DecalRoadObject DecalRoad{get { return _mDecalRoad; }} -public DynamicConsoleMethodComponentObject _mDynamicConsoleMethodComponent; +public static DecalRoadObject DecalRoad{get { return _mDecalRoad; }} +private static DynamicConsoleMethodComponentObject _mDynamicConsoleMethodComponent; /// /// /// -public DynamicConsoleMethodComponentObject DynamicConsoleMethodComponent{get { return _mDynamicConsoleMethodComponent; }} -public EditTSCtrlObject _mEditTSCtrl; +public static DynamicConsoleMethodComponentObject DynamicConsoleMethodComponent{get { return _mDynamicConsoleMethodComponent; }} +private static EditTSCtrlObject _mEditTSCtrl; /// /// /// -public EditTSCtrlObject EditTSCtrl{get { return _mEditTSCtrl; }} -public FileDialogObject _mFileDialog; +public static EditTSCtrlObject EditTSCtrl{get { return _mEditTSCtrl; }} +private static FileDialogObject _mFileDialog; /// /// /// -public FileDialogObject FileDialog{get { return _mFileDialog; }} -public FileStreamObjectObject _mFileStreamObject; +public static FileDialogObject FileDialog{get { return _mFileDialog; }} +private static FileStreamObjectObject _mFileStreamObject; /// /// /// -public FileStreamObjectObject FileStreamObject{get { return _mFileStreamObject; }} -public FlyingVehicleObject _mFlyingVehicle; +public static FileStreamObjectObject FileStreamObject{get { return _mFileStreamObject; }} +private static FlyingVehicleObject _mFlyingVehicle; /// /// /// -public FlyingVehicleObject FlyingVehicle{get { return _mFlyingVehicle; }} -public ForestWindEmitterObject _mForestWindEmitter; +public static FlyingVehicleObject FlyingVehicle{get { return _mFlyingVehicle; }} +private static ForestWindEmitterObject _mForestWindEmitter; /// /// /// -public ForestWindEmitterObject ForestWindEmitter{get { return _mForestWindEmitter; }} -public GameBaseObject _mGameBase; +public static ForestWindEmitterObject ForestWindEmitter{get { return _mForestWindEmitter; }} +private static GameBaseObject _mGameBase; /// /// /// -public GameBaseObject GameBase{get { return _mGameBase; }} -public GameConnectionObject _mGameConnection; +public static GameBaseObject GameBase{get { return _mGameBase; }} +private static GameConnectionObject _mGameConnection; /// /// /// -public GameConnectionObject GameConnection{get { return _mGameConnection; }} -public GroundPlaneObject _mGroundPlane; +public static GameConnectionObject GameConnection{get { return _mGameConnection; }} +private static GroundPlaneObject _mGroundPlane; /// /// /// -public GroundPlaneObject GroundPlane{get { return _mGroundPlane; }} -public GuiAutoCompleteCtrlObject _mGuiAutoCompleteCtrl; +public static GroundPlaneObject GroundPlane{get { return _mGroundPlane; }} +private static GuiAutoCompleteCtrlObject _mGuiAutoCompleteCtrl; /// /// /// -public GuiAutoCompleteCtrlObject GuiAutoCompleteCtrl{get { return _mGuiAutoCompleteCtrl; }} -public GuiAutoScrollCtrlObject _mGuiAutoScrollCtrl; +public static GuiAutoCompleteCtrlObject GuiAutoCompleteCtrl{get { return _mGuiAutoCompleteCtrl; }} +private static GuiAutoScrollCtrlObject _mGuiAutoScrollCtrl; /// /// /// -public GuiAutoScrollCtrlObject GuiAutoScrollCtrl{get { return _mGuiAutoScrollCtrl; }} -public GuiBitmapButtonCtrlObject _mGuiBitmapButtonCtrl; +public static GuiAutoScrollCtrlObject GuiAutoScrollCtrl{get { return _mGuiAutoScrollCtrl; }} +private static GuiBitmapButtonCtrlObject _mGuiBitmapButtonCtrl; /// /// /// -public GuiBitmapButtonCtrlObject GuiBitmapButtonCtrl{get { return _mGuiBitmapButtonCtrl; }} -public GuiButtonBaseCtrlObject _mGuiButtonBaseCtrl; +public static GuiBitmapButtonCtrlObject GuiBitmapButtonCtrl{get { return _mGuiBitmapButtonCtrl; }} +private static GuiButtonBaseCtrlObject _mGuiButtonBaseCtrl; /// /// /// -public GuiButtonBaseCtrlObject GuiButtonBaseCtrl{get { return _mGuiButtonBaseCtrl; }} -public GuiCheckBoxCtrlObject _mGuiCheckBoxCtrl; +public static GuiButtonBaseCtrlObject GuiButtonBaseCtrl{get { return _mGuiButtonBaseCtrl; }} +private static GuiCheckBoxCtrlObject _mGuiCheckBoxCtrl; /// /// /// -public GuiCheckBoxCtrlObject GuiCheckBoxCtrl{get { return _mGuiCheckBoxCtrl; }} -public GuiChunkedBitmapCtrlObject _mGuiChunkedBitmapCtrl; +public static GuiCheckBoxCtrlObject GuiCheckBoxCtrl{get { return _mGuiCheckBoxCtrl; }} +private static GuiChunkedBitmapCtrlObject _mGuiChunkedBitmapCtrl; /// /// /// -public GuiChunkedBitmapCtrlObject GuiChunkedBitmapCtrl{get { return _mGuiChunkedBitmapCtrl; }} -public GuiClockHudObject _mGuiClockHud; +public static GuiChunkedBitmapCtrlObject GuiChunkedBitmapCtrl{get { return _mGuiChunkedBitmapCtrl; }} +private static GuiClockHudObject _mGuiClockHud; /// /// /// -public GuiClockHudObject GuiClockHud{get { return _mGuiClockHud; }} -public GuiDirectoryFileListCtrlObject _mGuiDirectoryFileListCtrl; +public static GuiClockHudObject GuiClockHud{get { return _mGuiClockHud; }} +private static GuiDirectoryFileListCtrlObject _mGuiDirectoryFileListCtrl; /// /// /// -public GuiDirectoryFileListCtrlObject GuiDirectoryFileListCtrl{get { return _mGuiDirectoryFileListCtrl; }} -public GuiDragAndDropControlObject _mGuiDragAndDropControl; +public static GuiDirectoryFileListCtrlObject GuiDirectoryFileListCtrl{get { return _mGuiDirectoryFileListCtrl; }} +private static GuiDragAndDropControlObject _mGuiDragAndDropControl; /// /// /// -public GuiDragAndDropControlObject GuiDragAndDropControl{get { return _mGuiDragAndDropControl; }} -public GuiDynamicCtrlArrayControlObject _mGuiDynamicCtrlArrayControl; +public static GuiDragAndDropControlObject GuiDragAndDropControl{get { return _mGuiDragAndDropControl; }} +private static GuiDynamicCtrlArrayControlObject _mGuiDynamicCtrlArrayControl; /// /// /// -public GuiDynamicCtrlArrayControlObject GuiDynamicCtrlArrayControl{get { return _mGuiDynamicCtrlArrayControl; }} -public GuiFormCtrlObject _mGuiFormCtrl; +public static GuiDynamicCtrlArrayControlObject GuiDynamicCtrlArrayControl{get { return _mGuiDynamicCtrlArrayControl; }} +private static GuiFormCtrlObject _mGuiFormCtrl; /// /// /// -public GuiFormCtrlObject GuiFormCtrl{get { return _mGuiFormCtrl; }} -public GuiFrameSetCtrlObject _mGuiFrameSetCtrl; +public static GuiFormCtrlObject GuiFormCtrl{get { return _mGuiFormCtrl; }} +private static GuiFrameSetCtrlObject _mGuiFrameSetCtrl; /// /// /// -public GuiFrameSetCtrlObject GuiFrameSetCtrl{get { return _mGuiFrameSetCtrl; }} -public GuiGameListMenuCtrlObject _mGuiGameListMenuCtrl; +public static GuiFrameSetCtrlObject GuiFrameSetCtrl{get { return _mGuiFrameSetCtrl; }} +private static GuiGameListMenuCtrlObject _mGuiGameListMenuCtrl; /// /// /// -public GuiGameListMenuCtrlObject GuiGameListMenuCtrl{get { return _mGuiGameListMenuCtrl; }} -public GuiGameListOptionsCtrlObject _mGuiGameListOptionsCtrl; +public static GuiGameListMenuCtrlObject GuiGameListMenuCtrl{get { return _mGuiGameListMenuCtrl; }} +private static GuiGameListOptionsCtrlObject _mGuiGameListOptionsCtrl; /// /// /// -public GuiGameListOptionsCtrlObject GuiGameListOptionsCtrl{get { return _mGuiGameListOptionsCtrl; }} -public GuiGraphCtrlObject _mGuiGraphCtrl; +public static GuiGameListOptionsCtrlObject GuiGameListOptionsCtrl{get { return _mGuiGameListOptionsCtrl; }} +private static GuiGraphCtrlObject _mGuiGraphCtrl; /// /// /// -public GuiGraphCtrlObject GuiGraphCtrl{get { return _mGuiGraphCtrl; }} -public GuiIconButtonCtrlObject _mGuiIconButtonCtrl; +public static GuiGraphCtrlObject GuiGraphCtrl{get { return _mGuiGraphCtrl; }} +private static GuiIconButtonCtrlObject _mGuiIconButtonCtrl; /// /// /// -public GuiIconButtonCtrlObject GuiIconButtonCtrl{get { return _mGuiIconButtonCtrl; }} -public GuiImageListObject _mGuiImageList; +public static GuiIconButtonCtrlObject GuiIconButtonCtrl{get { return _mGuiIconButtonCtrl; }} +private static GuiImageListObject _mGuiImageList; /// /// /// -public GuiImageListObject GuiImageList{get { return _mGuiImageList; }} -public GuiInspectorTypeBitMask32Object _mGuiInspectorTypeBitMask32; +public static GuiImageListObject GuiImageList{get { return _mGuiImageList; }} +private static GuiInspectorTypeBitMask32Object _mGuiInspectorTypeBitMask32; /// /// /// -public GuiInspectorTypeBitMask32Object GuiInspectorTypeBitMask32{get { return _mGuiInspectorTypeBitMask32; }} -public GuiInspectorTypeFileNameObject _mGuiInspectorTypeFileName; +public static GuiInspectorTypeBitMask32Object GuiInspectorTypeBitMask32{get { return _mGuiInspectorTypeBitMask32; }} +private static GuiInspectorTypeFileNameObject _mGuiInspectorTypeFileName; /// /// /// -public GuiInspectorTypeFileNameObject GuiInspectorTypeFileName{get { return _mGuiInspectorTypeFileName; }} -public GuiListBoxCtrlObject _mGuiListBoxCtrl; +public static GuiInspectorTypeFileNameObject GuiInspectorTypeFileName{get { return _mGuiInspectorTypeFileName; }} +private static GuiListBoxCtrlObject _mGuiListBoxCtrl; /// /// /// -public GuiListBoxCtrlObject GuiListBoxCtrl{get { return _mGuiListBoxCtrl; }} -public GuiMaterialPreviewObject _mGuiMaterialPreview; +public static GuiListBoxCtrlObject GuiListBoxCtrl{get { return _mGuiListBoxCtrl; }} +private static GuiMaterialPreviewObject _mGuiMaterialPreview; /// /// /// -public GuiMaterialPreviewObject GuiMaterialPreview{get { return _mGuiMaterialPreview; }} -public GuiMenuBarObject _mGuiMenuBar; +public static GuiMaterialPreviewObject GuiMaterialPreview{get { return _mGuiMaterialPreview; }} +private static GuiMenuBarObject _mGuiMenuBar; /// /// /// -public GuiMenuBarObject GuiMenuBar{get { return _mGuiMenuBar; }} -public GuiMessageVectorCtrlObject _mGuiMessageVectorCtrl; +public static GuiMenuBarObject GuiMenuBar{get { return _mGuiMenuBar; }} +private static GuiMessageVectorCtrlObject _mGuiMessageVectorCtrl; /// /// /// -public GuiMessageVectorCtrlObject GuiMessageVectorCtrl{get { return _mGuiMessageVectorCtrl; }} -public GuiMissionAreaCtrlObject _mGuiMissionAreaCtrl; +public static GuiMessageVectorCtrlObject GuiMessageVectorCtrl{get { return _mGuiMessageVectorCtrl; }} +private static GuiMissionAreaCtrlObject _mGuiMissionAreaCtrl; /// /// /// -public GuiMissionAreaCtrlObject GuiMissionAreaCtrl{get { return _mGuiMissionAreaCtrl; }} -public GuiMLTextCtrlObject _mGuiMLTextCtrl; +public static GuiMissionAreaCtrlObject GuiMissionAreaCtrl{get { return _mGuiMissionAreaCtrl; }} +private static GuiMLTextCtrlObject _mGuiMLTextCtrl; /// /// /// -public GuiMLTextCtrlObject GuiMLTextCtrl{get { return _mGuiMLTextCtrl; }} -public GuiObjectViewObject _mGuiObjectView; +public static GuiMLTextCtrlObject GuiMLTextCtrl{get { return _mGuiMLTextCtrl; }} +private static GuiObjectViewObject _mGuiObjectView; /// /// /// -public GuiObjectViewObject GuiObjectView{get { return _mGuiObjectView; }} -public GuiPaneControlObject _mGuiPaneControl; +public static GuiObjectViewObject GuiObjectView{get { return _mGuiObjectView; }} +private static GuiPaneControlObject _mGuiPaneControl; /// /// /// -public GuiPaneControlObject GuiPaneControl{get { return _mGuiPaneControl; }} -public GuiProgressBitmapCtrlObject _mGuiProgressBitmapCtrl; +public static GuiPaneControlObject GuiPaneControl{get { return _mGuiPaneControl; }} +private static GuiProgressBitmapCtrlObject _mGuiProgressBitmapCtrl; /// /// /// -public GuiProgressBitmapCtrlObject GuiProgressBitmapCtrl{get { return _mGuiProgressBitmapCtrl; }} -public GuiRolloutCtrlObject _mGuiRolloutCtrl; +public static GuiProgressBitmapCtrlObject GuiProgressBitmapCtrl{get { return _mGuiProgressBitmapCtrl; }} +private static GuiRolloutCtrlObject _mGuiRolloutCtrl; /// /// /// -public GuiRolloutCtrlObject GuiRolloutCtrl{get { return _mGuiRolloutCtrl; }} -public GuiScrollCtrlObject _mGuiScrollCtrl; +public static GuiRolloutCtrlObject GuiRolloutCtrl{get { return _mGuiRolloutCtrl; }} +private static GuiScrollCtrlObject _mGuiScrollCtrl; /// /// /// -public GuiScrollCtrlObject GuiScrollCtrl{get { return _mGuiScrollCtrl; }} -public GuiShapeEdPreviewObject _mGuiShapeEdPreview; +public static GuiScrollCtrlObject GuiScrollCtrl{get { return _mGuiScrollCtrl; }} +private static GuiShapeEdPreviewObject _mGuiShapeEdPreview; /// /// /// -public GuiShapeEdPreviewObject GuiShapeEdPreview{get { return _mGuiShapeEdPreview; }} -public GuiSliderCtrlObject _mGuiSliderCtrl; +public static GuiShapeEdPreviewObject GuiShapeEdPreview{get { return _mGuiShapeEdPreview; }} +private static GuiSliderCtrlObject _mGuiSliderCtrl; /// /// /// -public GuiSliderCtrlObject GuiSliderCtrl{get { return _mGuiSliderCtrl; }} -public GuiStackControlObject _mGuiStackControl; +public static GuiSliderCtrlObject GuiSliderCtrl{get { return _mGuiSliderCtrl; }} +private static GuiStackControlObject _mGuiStackControl; /// /// /// -public GuiStackControlObject GuiStackControl{get { return _mGuiStackControl; }} -public GuiSwatchButtonCtrlObject _mGuiSwatchButtonCtrl; +public static GuiStackControlObject GuiStackControl{get { return _mGuiStackControl; }} +private static GuiSwatchButtonCtrlObject _mGuiSwatchButtonCtrl; /// /// /// -public GuiSwatchButtonCtrlObject GuiSwatchButtonCtrl{get { return _mGuiSwatchButtonCtrl; }} -public GuiTabBookCtrlObject _mGuiTabBookCtrl; +public static GuiSwatchButtonCtrlObject GuiSwatchButtonCtrl{get { return _mGuiSwatchButtonCtrl; }} +private static GuiTabBookCtrlObject _mGuiTabBookCtrl; /// /// /// -public GuiTabBookCtrlObject GuiTabBookCtrl{get { return _mGuiTabBookCtrl; }} -public GuiTableControlObject _mGuiTableControl; +public static GuiTabBookCtrlObject GuiTabBookCtrl{get { return _mGuiTabBookCtrl; }} +private static GuiTableControlObject _mGuiTableControl; /// /// /// -public GuiTableControlObject GuiTableControl{get { return _mGuiTableControl; }} -public GuiTabPageCtrlObject _mGuiTabPageCtrl; +public static GuiTableControlObject GuiTableControl{get { return _mGuiTableControl; }} +private static GuiTabPageCtrlObject _mGuiTabPageCtrl; /// /// /// -public GuiTabPageCtrlObject GuiTabPageCtrl{get { return _mGuiTabPageCtrl; }} -public GuiTextCtrlObject _mGuiTextCtrl; +public static GuiTabPageCtrlObject GuiTabPageCtrl{get { return _mGuiTabPageCtrl; }} +private static GuiTextCtrlObject _mGuiTextCtrl; /// /// /// -public GuiTextCtrlObject GuiTextCtrl{get { return _mGuiTextCtrl; }} -public GuiTextListCtrlObject _mGuiTextListCtrl; +public static GuiTextCtrlObject GuiTextCtrl{get { return _mGuiTextCtrl; }} +private static GuiTextListCtrlObject _mGuiTextListCtrl; /// /// /// -public GuiTextListCtrlObject GuiTextListCtrl{get { return _mGuiTextListCtrl; }} -public GuiTheoraCtrlObject _mGuiTheoraCtrl; +public static GuiTextListCtrlObject GuiTextListCtrl{get { return _mGuiTextListCtrl; }} +private static GuiTheoraCtrlObject _mGuiTheoraCtrl; /// /// /// -public GuiTheoraCtrlObject GuiTheoraCtrl{get { return _mGuiTheoraCtrl; }} -public GuiTSCtrlObject _mGuiTSCtrl; +public static GuiTheoraCtrlObject GuiTheoraCtrl{get { return _mGuiTheoraCtrl; }} +private static GuiTSCtrlObject _mGuiTSCtrl; /// /// /// -public GuiTSCtrlObject GuiTSCtrl{get { return _mGuiTSCtrl; }} -public GuiWindowCtrlObject _mGuiWindowCtrl; +public static GuiTSCtrlObject GuiTSCtrl{get { return _mGuiTSCtrl; }} +private static GuiWindowCtrlObject _mGuiWindowCtrl; /// /// /// -public GuiWindowCtrlObject GuiWindowCtrl{get { return _mGuiWindowCtrl; }} -public HTTPObjectObject _mHTTPObject; +public static GuiWindowCtrlObject GuiWindowCtrl{get { return _mGuiWindowCtrl; }} +private static HTTPObjectObject _mHTTPObject; /// /// /// -public HTTPObjectObject HTTPObject{get { return _mHTTPObject; }} -public ItemObject _mItem; +public static HTTPObjectObject HTTPObject{get { return _mHTTPObject; }} +private static ItemObject _mItem; /// /// /// -public ItemObject Item{get { return _mItem; }} -public LevelInfoObject _mLevelInfo; +public static ItemObject Item{get { return _mItem; }} +private static LevelInfoObject _mLevelInfo; /// /// /// -public LevelInfoObject LevelInfo{get { return _mLevelInfo; }} -public LightDescriptionObject _mLightDescription; +public static LevelInfoObject LevelInfo{get { return _mLevelInfo; }} +private static LightDescriptionObject _mLightDescription; /// /// /// -public LightDescriptionObject LightDescription{get { return _mLightDescription; }} -public LightFlareDataObject _mLightFlareData; +public static LightDescriptionObject LightDescription{get { return _mLightDescription; }} +private static LightFlareDataObject _mLightFlareData; /// /// /// -public LightFlareDataObject LightFlareData{get { return _mLightFlareData; }} -public LightningObject _mLightning; +public static LightFlareDataObject LightFlareData{get { return _mLightFlareData; }} +private static LightningObject _mLightning; /// /// /// -public LightningObject Lightning{get { return _mLightning; }} -public MeshRoadObject _mMeshRoad; +public static LightningObject Lightning{get { return _mLightning; }} +private static MeshRoadObject _mMeshRoad; /// /// /// -public MeshRoadObject MeshRoad{get { return _mMeshRoad; }} -public MissionAreaObject _mMissionArea; +public static MeshRoadObject MeshRoad{get { return _mMeshRoad; }} +private static MissionAreaObject _mMissionArea; /// /// /// -public MissionAreaObject MissionArea{get { return _mMissionArea; }} -public NavMeshObject _mNavMesh; +public static MissionAreaObject MissionArea{get { return _mMissionArea; }} +private static NavMeshObject _mNavMesh; /// /// /// -public NavMeshObject NavMesh{get { return _mNavMesh; }} -public NavPathObject _mNavPath; +public static NavMeshObject NavMesh{get { return _mNavMesh; }} +private static NavPathObject _mNavPath; /// /// /// -public NavPathObject NavPath{get { return _mNavPath; }} -public NetConnectionObject _mNetConnection; +public static NavPathObject NavPath{get { return _mNavPath; }} +private static NetConnectionObject _mNetConnection; /// /// /// -public NetConnectionObject NetConnection{get { return _mNetConnection; }} -public NetObjectObject _mNetObject; +public static NetConnectionObject NetConnection{get { return _mNetConnection; }} +private static NetObjectObject _mNetObject; /// /// /// -public NetObjectObject NetObject{get { return _mNetObject; }} -public ParticleDataObject _mParticleData; +public static NetObjectObject NetObject{get { return _mNetObject; }} +private static ParticleDataObject _mParticleData; /// /// /// -public ParticleDataObject ParticleData{get { return _mParticleData; }} -public ParticleEmitterDataObject _mParticleEmitterData; +public static ParticleDataObject ParticleData{get { return _mParticleData; }} +private static ParticleEmitterDataObject _mParticleEmitterData; /// /// /// -public ParticleEmitterDataObject ParticleEmitterData{get { return _mParticleEmitterData; }} -public ParticleEmitterNodeObject _mParticleEmitterNode; +public static ParticleEmitterDataObject ParticleEmitterData{get { return _mParticleEmitterData; }} +private static ParticleEmitterNodeObject _mParticleEmitterNode; /// /// /// -public ParticleEmitterNodeObject ParticleEmitterNode{get { return _mParticleEmitterNode; }} -public PathCameraObject _mPathCamera; +public static ParticleEmitterNodeObject ParticleEmitterNode{get { return _mParticleEmitterNode; }} +private static PathCameraObject _mPathCamera; /// /// /// -public PathCameraObject PathCamera{get { return _mPathCamera; }} -public PhysicalZoneObject _mPhysicalZone; +public static PathCameraObject PathCamera{get { return _mPathCamera; }} +private static PhysicalZoneObject _mPhysicalZone; /// /// /// -public PhysicalZoneObject PhysicalZone{get { return _mPhysicalZone; }} -public PhysicsForceObject _mPhysicsForce; +public static PhysicalZoneObject PhysicalZone{get { return _mPhysicalZone; }} +private static PhysicsForceObject _mPhysicsForce; /// /// /// -public PhysicsForceObject PhysicsForce{get { return _mPhysicsForce; }} -public PhysicsShapeObject _mPhysicsShape; +public static PhysicsForceObject PhysicsForce{get { return _mPhysicsForce; }} +private static PhysicsShapeObject _mPhysicsShape; /// /// /// -public PhysicsShapeObject PhysicsShape{get { return _mPhysicsShape; }} -public PlayerObject _mPlayer; +public static PhysicsShapeObject PhysicsShape{get { return _mPhysicsShape; }} +private static PlayerObject _mPlayer; /// /// /// -public PlayerObject Player{get { return _mPlayer; }} -public PortalObject _mPortal; +public static PlayerObject Player{get { return _mPlayer; }} +private static PortalObject _mPortal; /// /// /// -public PortalObject Portal{get { return _mPortal; }} -public PostEffectObject _mPostEffect; +public static PortalObject Portal{get { return _mPortal; }} +private static PostEffectObject _mPostEffect; /// /// /// -public PostEffectObject PostEffect{get { return _mPostEffect; }} -public PrecipitationObject _mPrecipitation; +public static PostEffectObject PostEffect{get { return _mPostEffect; }} +private static PrecipitationObject _mPrecipitation; /// /// /// -public PrecipitationObject Precipitation{get { return _mPrecipitation; }} -public ProjectileObject _mProjectile; +public static PrecipitationObject Precipitation{get { return _mPrecipitation; }} +private static ProjectileObject _mProjectile; /// /// /// -public ProjectileObject Projectile{get { return _mProjectile; }} -public ProximityMineObject _mProximityMine; +public static ProjectileObject Projectile{get { return _mProjectile; }} +private static ProximityMineObject _mProximityMine; /// /// /// -public ProximityMineObject ProximityMine{get { return _mProximityMine; }} -public RenderBinManagerObject _mRenderBinManager; +public static ProximityMineObject ProximityMine{get { return _mProximityMine; }} +private static RenderBinManagerObject _mRenderBinManager; /// /// /// -public RenderBinManagerObject RenderBinManager{get { return _mRenderBinManager; }} -public RenderMeshExampleObject _mRenderMeshExample; +public static RenderBinManagerObject RenderBinManager{get { return _mRenderBinManager; }} +private static RenderMeshExampleObject _mRenderMeshExample; /// /// /// -public RenderMeshExampleObject RenderMeshExample{get { return _mRenderMeshExample; }} -public RenderPassManagerObject _mRenderPassManager; +public static RenderMeshExampleObject RenderMeshExample{get { return _mRenderMeshExample; }} +private static RenderPassManagerObject _mRenderPassManager; /// /// /// -public RenderPassManagerObject RenderPassManager{get { return _mRenderPassManager; }} -public RenderPassStateTokenObject _mRenderPassStateToken; +public static RenderPassManagerObject RenderPassManager{get { return _mRenderPassManager; }} +private static RenderPassStateTokenObject _mRenderPassStateToken; /// /// /// -public RenderPassStateTokenObject RenderPassStateToken{get { return _mRenderPassStateToken; }} -public RigidShapeObject _mRigidShape; +public static RenderPassStateTokenObject RenderPassStateToken{get { return _mRenderPassStateToken; }} +private static RigidShapeObject _mRigidShape; /// /// /// -public RigidShapeObject RigidShape{get { return _mRigidShape; }} -public RiverObject _mRiver; +public static RigidShapeObject RigidShape{get { return _mRigidShape; }} +private static RiverObject _mRiver; /// /// /// -public RiverObject River{get { return _mRiver; }} -public ScatterSkyObject _mScatterSky; +public static RiverObject River{get { return _mRiver; }} +private static ScatterSkyObject _mScatterSky; /// /// /// -public ScatterSkyObject ScatterSky{get { return _mScatterSky; }} -public SceneObjectObject _mSceneObject; +public static ScatterSkyObject ScatterSky{get { return _mScatterSky; }} +private static SceneObjectObject _mSceneObject; /// /// /// -public SceneObjectObject SceneObject{get { return _mSceneObject; }} -public ScriptTickObjectObject _mScriptTickObject; +public static SceneObjectObject SceneObject{get { return _mSceneObject; }} +private static ScriptTickObjectObject _mScriptTickObject; /// /// /// -public ScriptTickObjectObject ScriptTickObject{get { return _mScriptTickObject; }} -public SFXControllerObject _mSFXController; +public static ScriptTickObjectObject ScriptTickObject{get { return _mScriptTickObject; }} +private static SFXControllerObject _mSFXController; /// /// /// -public SFXControllerObject SFXController{get { return _mSFXController; }} -public SFXEmitterObject _mSFXEmitter; +public static SFXControllerObject SFXController{get { return _mSFXController; }} +private static SFXEmitterObject _mSFXEmitter; /// /// /// -public SFXEmitterObject SFXEmitter{get { return _mSFXEmitter; }} -public SFXParameterObject _mSFXParameter; +public static SFXEmitterObject SFXEmitter{get { return _mSFXEmitter; }} +private static SFXParameterObject _mSFXParameter; /// /// /// -public SFXParameterObject SFXParameter{get { return _mSFXParameter; }} -public SFXProfileObject _mSFXProfile; +public static SFXParameterObject SFXParameter{get { return _mSFXParameter; }} +private static SFXProfileObject _mSFXProfile; /// /// /// -public SFXProfileObject SFXProfile{get { return _mSFXProfile; }} -public SFXSoundObject _mSFXSound; +public static SFXProfileObject SFXProfile{get { return _mSFXProfile; }} +private static SFXSoundObject _mSFXSound; /// /// /// -public SFXSoundObject SFXSound{get { return _mSFXSound; }} -public SFXStateObject _mSFXState; +public static SFXSoundObject SFXSound{get { return _mSFXSound; }} +private static SFXStateObject _mSFXState; /// /// /// -public SFXStateObject SFXState{get { return _mSFXState; }} -public ShaderDataObject _mShaderData; +public static SFXStateObject SFXState{get { return _mSFXState; }} +private static ShaderDataObject _mShaderData; /// /// /// -public ShaderDataObject ShaderData{get { return _mShaderData; }} -public ShapeBaseObject _mShapeBase; +public static ShaderDataObject ShaderData{get { return _mShaderData; }} +private static ShapeBaseObject _mShapeBase; /// /// /// -public ShapeBaseObject ShapeBase{get { return _mShapeBase; }} -public ShapeBaseDataObject _mShapeBaseData; +public static ShapeBaseObject ShapeBase{get { return _mShapeBase; }} +private static ShapeBaseDataObject _mShapeBaseData; /// /// /// -public ShapeBaseDataObject ShapeBaseData{get { return _mShapeBaseData; }} -public SimpleNetObjectObject _mSimpleNetObject; +public static ShapeBaseDataObject ShapeBaseData{get { return _mShapeBaseData; }} +private static SimpleNetObjectObject _mSimpleNetObject; /// /// /// -public SimpleNetObjectObject SimpleNetObject{get { return _mSimpleNetObject; }} -public StreamObjectObject _mStreamObject; +public static SimpleNetObjectObject SimpleNetObject{get { return _mSimpleNetObject; }} +private static StreamObjectObject _mStreamObject; /// /// /// -public StreamObjectObject StreamObject{get { return _mStreamObject; }} -public TCPObjectObject _mTCPObject; +public static StreamObjectObject StreamObject{get { return _mStreamObject; }} +private static TCPObjectObject _mTCPObject; /// /// /// -public TCPObjectObject TCPObject{get { return _mTCPObject; }} -public TimeOfDayObject _mTimeOfDay; +public static TCPObjectObject TCPObject{get { return _mTCPObject; }} +private static TimeOfDayObject _mTimeOfDay; /// /// /// -public TimeOfDayObject TimeOfDay{get { return _mTimeOfDay; }} -public TriggerObject _mTrigger; +public static TimeOfDayObject TimeOfDay{get { return _mTimeOfDay; }} +private static TriggerObject _mTrigger; /// /// /// -public TriggerObject Trigger{get { return _mTrigger; }} -public TSAttachableObject _mTSAttachable; +public static TriggerObject Trigger{get { return _mTrigger; }} +private static TSAttachableObject _mTSAttachable; /// /// /// -public TSAttachableObject TSAttachable{get { return _mTSAttachable; }} -public TSDynamicObject _mTSDynamic; +public static TSAttachableObject TSAttachable{get { return _mTSAttachable; }} +private static TSDynamicObject _mTSDynamic; /// /// /// -public TSDynamicObject TSDynamic{get { return _mTSDynamic; }} -public TSPathShapeObject _mTSPathShape; +public static TSDynamicObject TSDynamic{get { return _mTSDynamic; }} +private static TSPathShapeObject _mTSPathShape; /// /// /// -public TSPathShapeObject TSPathShape{get { return _mTSPathShape; }} -public TSShapeConstructorObject _mTSShapeConstructor; +public static TSPathShapeObject TSPathShape{get { return _mTSPathShape; }} +private static TSShapeConstructorObject _mTSShapeConstructor; /// /// /// -public TSShapeConstructorObject TSShapeConstructor{get { return _mTSShapeConstructor; }} -public TSStaticObject _mTSStatic; +public static TSShapeConstructorObject TSShapeConstructor{get { return _mTSShapeConstructor; }} +private static TSStaticObject _mTSStatic; /// /// /// -public TSStaticObject TSStatic{get { return _mTSStatic; }} -public TurretShapeObject _mTurretShape; +public static TSStaticObject TSStatic{get { return _mTSStatic; }} +private static TurretShapeObject _mTurretShape; /// /// /// -public TurretShapeObject TurretShape{get { return _mTurretShape; }} -public VolumetricFogObject _mVolumetricFog; +public static TurretShapeObject TurretShape{get { return _mTurretShape; }} +private static VolumetricFogObject _mVolumetricFog; /// /// /// -public VolumetricFogObject VolumetricFog{get { return _mVolumetricFog; }} -public WalkableShapeObject _mWalkableShape; +public static VolumetricFogObject VolumetricFog{get { return _mVolumetricFog; }} +private static WalkableShapeObject _mWalkableShape; /// /// /// -public WalkableShapeObject WalkableShape{get { return _mWalkableShape; }} -public WheeledVehicleObject _mWheeledVehicle; +public static WalkableShapeObject WalkableShape{get { return _mWalkableShape; }} +private static WheeledVehicleObject _mWheeledVehicle; /// /// /// -public WheeledVehicleObject WheeledVehicle{get { return _mWheeledVehicle; }} -public WorldEditorSelectionObject _mWorldEditorSelection; +public static WheeledVehicleObject WheeledVehicle{get { return _mWheeledVehicle; }} +private static WorldEditorSelectionObject _mWorldEditorSelection; /// /// /// -public WorldEditorSelectionObject WorldEditorSelection{get { return _mWorldEditorSelection; }} -public ZipObjectObject _mZipObject; +public static WorldEditorSelectionObject WorldEditorSelection{get { return _mWorldEditorSelection; }} +private static ZipObjectObject _mZipObject; /// /// /// -public ZipObjectObject ZipObject{get { return _mZipObject; }} -public ZoneObject _mZone; +public static ZipObjectObject ZipObject{get { return _mZipObject; }} +private static ZoneObject _mZone; /// /// /// -public ZoneObject Zone{get { return _mZone; }} +public static ZoneObject Zone{get { return _mZone; }} /// /// /// public class UtilObject { -private Omni m_ts; - /// - /// - /// - /// -public UtilObject(ref Omni ts){m_ts = ts;} /// -/// (aiConnect, S32 , 2, 20, (...) @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. @returns The newly created AIConnection @see GameConnection for parameter information @ingroup AI) +/// (aiConnect, S32 , 2, 20, (...) +/// @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. +/// @returns The newly created AIConnection +/// @see GameConnection for parameter information +/// @ingroup AI) +/// /// public int _aiConnect(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2519,7 +2487,37 @@ public int _aiConnect(string a1, string a2= "", string a3= "", string a4= "", s return m_ts.fn__aiConnect(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( buildTaggedString, const char*, 2, 11, (string format, ...) @brief Build a string using the specified tagged string format. This function takes an already tagged string (passed in as a tagged string ID) and one or more additional strings. If the tagged string contains argument tags that range from %%1 through %%9, then each additional string will be substituted into the tagged string. The final (non-tagged) combined string will be returned. The maximum length of the tagged string plus any inserted additional strings is 511 characters. @param format A tagged string ID that contains zero or more argument tags, in the form of %%1 through %%9. @param ... A variable number of arguments that are insterted into the tagged string based on the argument tags within the format string. @returns An ordinary string that is a combination of the original tagged string with any additional strings passed in inserted in place of each argument tag. @tsexample // Create a tagged string with argument tags %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); // Some point later, combine the tagged string with some other string %string = buildTaggedString(%taggedStringID, %playerName); echo(%string); @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// ( buildTaggedString, const char*, 2, 11, (string format, ...) +/// @brief Build a string using the specified tagged string format. +/// +/// This function takes an already tagged string (passed in as a tagged string ID) and one +/// or more additional strings. If the tagged string contains argument tags that range from +/// %%1 through %%9, then each additional string will be substituted into the tagged string. +/// The final (non-tagged) combined string will be returned. The maximum length of the tagged +/// string plus any inserted additional strings is 511 characters. +/// +/// @param format A tagged string ID that contains zero or more argument tags, in the form of +/// %%1 through %%9. +/// @param ... A variable number of arguments that are insterted into the tagged string +/// based on the argument tags within the format string. +/// +/// @returns An ordinary string that is a combination of the original tagged string with any additional +/// strings passed in inserted in place of each argument tag. +/// +/// @tsexample +/// // Create a tagged string with argument tags +/// %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); +/// +/// // Some point later, combine the tagged string with some other string +/// %string = buildTaggedString(%taggedStringID, %playerName); +/// echo(%string); +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string _buildTaggedString(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= ""){ @@ -2527,7 +2525,21 @@ public string _buildTaggedString(string a1, string a2= "", string a3= "", strin return m_ts.fn__buildTaggedString(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); } /// -/// ( call, const char *, 2, 0, ( string functionName, string args... ) Apply the given arguments to the specified global function and return the result of the call. @param functionName The name of the function to call. This function must be in the global namespace, i.e. you cannot call a function in a namespace through #call. Use eval() for that. @return The result of the function call. @tsexample function myFunction( %arg ) { return ( %arg SPC \"World!\" ); } echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. @endtsexample @ingroup Scripting ) +/// ( call, const char *, 2, 0, ( string functionName, string args... ) +/// Apply the given arguments to the specified global function and return the result of the call. +/// @param functionName The name of the function to call. This function must be in the global namespace, i.e. +/// you cannot call a function in a namespace through #call. Use eval() for that. +/// @return The result of the function call. +/// @tsexample +/// function myFunction( %arg ) +/// { +/// return ( %arg SPC \"World!\" ); +/// } +/// +/// echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. +/// @endtsexample +/// @ingroup Scripting ) +/// /// public string _call(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2535,7 +2547,37 @@ public string _call(string a1, string a2= "", string a3= "", string a4= "", str return m_ts.fn__call(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) @brief Send a command from the server to the client @param client The numeric ID of a client GameConnection @param func Name of the client function being called @param ... Various parameters being passed to client command @tsexample // Set up the client command. Needs to be executed on the client, such as // within scripts/client/client.cs // Update the Ammo Counter with current ammo, if not any then hide the counter. function clientCmdSetAmmoAmountHud(%amount) { if (!%amount) AmmoAmount.setVisible(false); else { AmmoAmount.setVisible(true); AmmoAmount.setText(\"Ammo: \"@%amount); } } // Call it from a server function. Needs to be executed on the server, //such as within scripts/server/game.cs function GameConnection::setAmmoAmountHud(%client, %amount) { commandToClient(%client, 'SetAmmoAmountHud', %amount); } @endtsexample @ingroup Networking) +/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) +/// @brief Send a command from the server to the client +/// +/// @param client The numeric ID of a client GameConnection +/// @param func Name of the client function being called +/// @param ... Various parameters being passed to client command +/// +/// @tsexample +/// // Set up the client command. Needs to be executed on the client, such as +/// // within scripts/client/client.cs +/// // Update the Ammo Counter with current ammo, if not any then hide the counter. +/// function clientCmdSetAmmoAmountHud(%amount) +/// { +/// if (!%amount) +/// AmmoAmount.setVisible(false); +/// else +/// { +/// AmmoAmount.setVisible(true); +/// AmmoAmount.setText(\"Ammo: \"@%amount); +/// } +/// } +/// // Call it from a server function. Needs to be executed on the server, +/// //such as within scripts/server/game.cs +/// function GameConnection::setAmmoAmountHud(%client, %amount) +/// { +/// commandToClient(%client, 'SetAmmoAmountHud', %amount); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void _commandToClient(string a1, string a2, string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= "", string a21= ""){ @@ -2543,7 +2585,42 @@ public void _commandToClient(string a1, string a2, string a3= "", string a4= "" m_ts.fn__commandToClient(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21); } /// -/// ( commandToServer, void, 2, 21, (string func, ...) @brief Send a command to the server. @param func Name of the server command being called @param ... Various parameters being passed to server command @tsexample // Create a standard function. Needs to be executed on the client, such // as within scripts/client/default.bind.cs function toggleCamera(%val) { // If key was down, call a server command named 'ToggleCamera' if (%val) commandToServer('ToggleCamera'); } // Server command being called from above. Needs to be executed on the // server, such as within scripts/server/commands.cs function serverCmdToggleCamera(%client) { if (%client.getControlObject() == %client.player) { %client.camera.setVelocity(\"0 0 0\"); %control = %client.camera; } else { %client.player.setVelocity(\"0 0 0\"); %control = %client.player; } %client.setControlObject(%control); clientCmdSyncEditorGui(); } @endtsexample @ingroup Networking) +/// ( commandToServer, void, 2, 21, (string func, ...) +/// @brief Send a command to the server. +/// +/// @param func Name of the server command being called +/// @param ... Various parameters being passed to server command +/// +/// @tsexample +/// // Create a standard function. Needs to be executed on the client, such +/// // as within scripts/client/default.bind.cs +/// function toggleCamera(%val) +/// { +/// // If key was down, call a server command named 'ToggleCamera' +/// if (%val) +/// commandToServer('ToggleCamera'); +/// } +/// // Server command being called from above. Needs to be executed on the +/// // server, such as within scripts/server/commands.cs +/// function serverCmdToggleCamera(%client) +/// { +/// if (%client.getControlObject() == %client.player) +/// { +/// %client.camera.setVelocity(\"0 0 0\"); +/// %control = %client.camera; +/// } +/// else +/// { +/// %client.player.setVelocity(\"0 0 0\"); +/// %control = %client.player; +/// } +/// %client.setControlObject(%control); +/// clientCmdSyncEditorGui(); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void _commandToServer(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= ""){ @@ -2551,7 +2628,13 @@ public void _commandToServer(string a1, string a2= "", string a3= "", string a4 m_ts.fn__commandToServer(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20); } /// -/// ( echo, void, 2, 0, ( string message... ) @brief Logs a message to the console. Concatenates all given arguments to a single string and prints the string to the console. A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( echo, void, 2, 0, ( string message... ) +/// @brief Logs a message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console. +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void _echo(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2559,7 +2642,14 @@ public void _echo(string a1, string a2= "", string a3= "", string a4= "", strin m_ts.fn__echo(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( error, void, 2, 0, ( string message... ) @brief Logs an error message to the console. Concatenates all given arguments to a single string and prints the string to the console as an error message (in the in-game console, these will show up using a red font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( error, void, 2, 0, ( string message... ) +/// @brief Logs an error message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as an error +/// message (in the in-game console, these will show up using a red font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void _error(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2567,7 +2657,15 @@ public void _error(string a1, string a2= "", string a3= "", string a4= "", stri m_ts.fn__error(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) @brief Manually execute a special script file that contains game or editor preferences @param relativeFileName Name and path to file from project folder @param noCalls Deprecated @param journalScript Deprecated @return True if script was successfully executed @note Appears to be useless in Torque 3D, should be deprecated @ingroup Scripting) +/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) +/// @brief Manually execute a special script file that contains game or editor preferences +/// @param relativeFileName Name and path to file from project folder +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if script was successfully executed +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @ingroup Scripting) +/// /// public bool _execPrefs(string a1, string a2= "", string a3= ""){ @@ -2575,7 +2673,12 @@ public bool _execPrefs(string a1, string a2= "", string a3= ""){ return m_ts.fn__execPrefs(a1, a2, a3); } /// -/// (expandFilename, const char*, 2, 2, (string filename) @brief Grabs the full path of a specified file @param filename Name of the local file to locate @return String containing the full filepath on disk @ingroup FileSystem) +/// (expandFilename, const char*, 2, 2, (string filename) +/// @brief Grabs the full path of a specified file +/// @param filename Name of the local file to locate +/// @return String containing the full filepath on disk +/// @ingroup FileSystem) +/// /// public string _expandFilename(string a1){ @@ -2583,7 +2686,11 @@ public string _expandFilename(string a1){ return m_ts.fn__expandFilename(a1); } /// -/// (expandOldFilename, const char*, 2, 2, (string filename) @brief Retrofits a filepath that uses old Torque style @return String containing filepath with new formatting @ingroup FileSystem) +/// (expandOldFilename, const char*, 2, 2, (string filename) +/// @brief Retrofits a filepath that uses old Torque style +/// @return String containing filepath with new formatting +/// @ingroup FileSystem) +/// /// public string _expandOldFilename(string a1){ @@ -2591,7 +2698,73 @@ public string _expandOldFilename(string a1){ return m_ts.fn__expandOldFilename(a1); } /// -/// ( mathInit, void, 1, 10, ( ... ) @brief Install the math library with specified extensions. Possible parameters are: - 'DETECT' Autodetect math lib settings. - 'C' Enable the C math routines. C routines are always enabled. - 'FPU' Enable floating point unit routines. - 'MMX' Enable MMX math routines. - '3DNOW' Enable 3dNow! math routines. - 'SSE' Enable SSE math routines. @ingroup Math) +/// ( getStockColorCount, S32, 1, 1, () - Gets a count of available stock colors. +/// @return A count of available stock colors. ) +/// +/// +public int _getStockColorCount(){ + + +return m_ts.fn__getStockColorCount(); +} +/// +/// ( getStockColorF, const char*, 2, 2, (stockColorName) - Gets a floating-point-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// +public string _getStockColorF(string a1){ + + +return m_ts.fn__getStockColorF(a1); +} +/// +/// ( getStockColorI, const char*, 2, 2, (stockColorName) - Gets a byte-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// +public string _getStockColorI(string a1){ + + +return m_ts.fn__getStockColorI(a1); +} +/// +/// ( getStockColorName, const char*, 2, 2, (stockColorIndex) - Gets the stock color name at the specified index. +/// @param stockColorIndex The zero-based index of the stock color name to retrieve. +/// @return The stock color name at the specified index or nothing if the string is invalid. ) +/// +/// +public string _getStockColorName(string a1){ + + +return m_ts.fn__getStockColorName(a1); +} +/// +/// ( isStockColor, bool, 2, 2, (stockColorName) - Gets whether the specified name is a stock color or not. +/// @param stockColorName - The stock color name to test for. +/// @return Whether the specified name is a stock color or not. ) +/// +/// +public bool _isStockColor(string a1){ + + +return m_ts.fn__isStockColor(a1); +} +/// +/// ( mathInit, void, 1, 10, ( ... ) +/// @brief Install the math library with specified extensions. +/// Possible parameters are: +/// - 'DETECT' Autodetect math lib settings. +/// - 'C' Enable the C math routines. C routines are always enabled. +/// - 'FPU' Enable floating point unit routines. +/// - 'MMX' Enable MMX math routines. +/// - '3DNOW' Enable 3dNow! math routines. +/// - 'SSE' Enable SSE math routines. +/// @ingroup Math) +/// +/// +/// /// public void _mathInit(string a1= "", string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= ""){ @@ -2599,7 +2772,12 @@ public void _mathInit(string a1= "", string a2= "", string a3= "", string a4= " m_ts.fn__mathInit(a1, a2, a3, a4, a5, a6, a7, a8, a9); } /// -/// (resourceDump, void, 1, 1, () @brief List the currently managed resources Currently used by editors only, internal @ingroup Editors @internal) +/// (resourceDump, void, 1, 1, () +/// @brief List the currently managed resources +/// Currently used by editors only, internal +/// @ingroup Editors +/// @internal) +/// /// public void _resourceDump(){ @@ -2608,6 +2786,7 @@ public void _resourceDump(){ } /// /// (schedule, S32, 4, 0, schedule(time, refobject|0, command, arg1...argN>)) +/// /// public int _schedule(string a1, string a2, string a3, string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2616,6 +2795,7 @@ public int _schedule(string a1, string a2, string a3, string a4= "", string a5= } /// /// (TestFunction2Args, const char *, 3, 3, testFunction(arg1, arg2)) +/// /// public string _TestFunction2Args(string a1, string a2){ @@ -2623,7 +2803,14 @@ public string _TestFunction2Args(string a1, string a2){ return m_ts.fn__TestFunction2Args(a1, a2); } /// -/// ( warn, void, 2, 0, ( string message... ) @brief Logs a warning message to the console. Concatenates all given arguments to a single string and prints the string to the console as a warning message (in the in-game console, these will show up using a turquoise font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( warn, void, 2, 0, ( string message... ) +/// @brief Logs a warning message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as a warning +/// message (in the in-game console, these will show up using a turquoise font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void _warn(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2631,7 +2818,11 @@ public void _warn(string a1, string a2= "", string a3= "", string a4= "", strin m_ts.fn__warn(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// () @brief Activates DirectInput. Also activates any connected joysticks. @ingroup Input) +/// () +/// @brief Activates DirectInput. +/// Also activates any connected joysticks. +/// @ingroup Input) +/// /// public void activateDirectInput(){ @@ -2651,7 +2842,28 @@ public void activatePackage(string packageName){ m_ts.fn_activatePackage(packageName); } /// -/// @brief Add a string to the bad word filter The bad word filter is a table containing words which will not be displayed in chat windows. Instead, a designated replacement string will be displayed. There are already a number of bad words automatically defined. @param badWord Exact text of the word to restrict. @return True if word was successfully added, false if the word or a subset of it already exists in the table @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Returns true, word was successfully added addBadWord(%badWord); // Returns false, word has already been added addBadWord(\"Foobar\"); @endtsexample @ingroup Game) +/// @brief Add a string to the bad word filter +/// +/// The bad word filter is a table containing words which will not be +/// displayed in chat windows. Instead, a designated replacement string will be displayed. +/// There are already a number of bad words automatically defined. +/// +/// @param badWord Exact text of the word to restrict. +/// @return True if word was successfully added, false if the word or a subset of it already exists in the table +/// +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Returns true, word was successfully added +/// addBadWord(%badWord); +/// // Returns false, word has already been added +/// addBadWord(\"Foobar\"); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool addBadWord(string badWord){ @@ -2659,7 +2871,13 @@ public bool addBadWord(string badWord){ return m_ts.fn_addBadWord(badWord); } /// -/// Adds a global shader macro which will be merged with the script defined macros on every shader. The macro will replace the value of an existing macro of the same name. For the new macro to take effect all the shaders in the system need to be reloaded. @see resetLightManager, removeGlobalShaderMacro @ingroup Rendering ) +/// Adds a global shader macro which will be merged with the script defined +/// macros on every shader. The macro will replace the value of an existing +/// macro of the same name. For the new macro to take effect all the shaders +/// in the system need to be reloaded. +/// @see resetLightManager, removeGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void addGlobalShaderMacro(string name, string value = null ){ if (value== null) {value = null;} @@ -2668,7 +2886,14 @@ public void addGlobalShaderMacro(string name, string value = null ){ m_ts.fn_addGlobalShaderMacro(name, value); } /// -/// (string texName, string matName) @brief Maps the given texture to the given material. Generates a console warning before overwriting. Material maps are used by terrain and interiors for triggering effects when an object moves onto a terrain block or interior surface using the associated texture. @ingroup Materials) +/// (string texName, string matName) +/// @brief Maps the given texture to the given material. +/// Generates a console warning before overwriting. +/// Material maps are used by terrain and interiors for triggering +/// effects when an object moves onto a terrain +/// block or interior surface using the associated texture. +/// @ingroup Materials) +/// /// public void addMaterialMapping(string texName, string matName){ @@ -2676,7 +2901,19 @@ public void addMaterialMapping(string texName, string matName){ m_ts.fn_addMaterialMapping(texName, matName); } /// -/// ), @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, so tagging the same string (excluding case differences) will be ignored as a duplicated tag. @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string @see \\ref syntaxDataTypes under Tagged %Strings @see removeTaggedString() @see getTaggedString() @ingroup Networking) +/// ), +/// @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable +/// +/// @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, +/// so tagging the same string (excluding case differences) will be ignored as a duplicated tag. +/// +/// @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see removeTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string addTaggedString(string str = ""){ @@ -2685,6 +2922,7 @@ public string addTaggedString(string str = ""){ } /// /// ), 'playerName'[, 'AIClassType'] );) +/// /// public int aiAddPlayer(string name, string ns = ""){ @@ -2692,7 +2930,13 @@ public int aiAddPlayer(string name, string ns = ""){ return m_ts.fn_aiAddPlayer(name, ns); } /// -/// allowConnections(bool allow) @brief Sets whether or not the global NetInterface allows connections from remote hosts. @param allow Set to true to allow remote connections. @ingroup Networking) +/// allowConnections(bool allow) +/// @brief Sets whether or not the global NetInterface allows connections from remote hosts. +/// +/// @param allow Set to true to allow remote connections. +/// +/// @ingroup Networking) +/// /// public void allowConnections(bool allow){ @@ -2712,7 +2956,16 @@ public void backtrace(){ m_ts.fn_backtrace(); } /// -/// CSV), (location, [backend]) - @brief Takes a string informing the backend where to store sample data and optionally a name of the specific logging backend to use. The default is the CSV backend. In most cases, the logging store will be a file name. @tsexample beginSampling( \"mysamples.csv\" ); @endtsexample @ingroup Rendering) +/// CSV), (location, [backend]) - +/// @brief Takes a string informing the backend where to store +/// sample data and optionally a name of the specific logging +/// backend to use. The default is the CSV backend. In most +/// cases, the logging store will be a file name. +/// @tsexample +/// beginSampling( \"mysamples.csv\" ); +/// @endtsexample +/// @ingroup Rendering) +/// /// public void beginSampling(string location, string backend = "CSV"){ @@ -2720,7 +2973,26 @@ public void beginSampling(string location, string backend = "CSV"){ m_ts.fn_beginSampling(location, backend); } /// -/// @brief Calculates how much an explosion effects a specific object. Use this to determine how much damage to apply to objects based on their distance from the explosion's center point, and whether the explosion is blocked by other objects. @param pos Center position of the explosion. @param id Id of the object of which to check coverage. @param covMask Mask of object types that may block the explosion. @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) @tsexample // Get the position of the explosion. %position = %explosion.getPosition(); // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType // Acquire the damage value from 0.0f - 1.0f. %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); // Apply damage to object %sceneObject.applyDamage( %coverage * 20 ); @endtsexample @ingroup FX) +/// @brief Calculates how much an explosion effects a specific object. +/// Use this to determine how much damage to apply to objects based on their +/// distance from the explosion's center point, and whether the explosion is +/// blocked by other objects. +/// @param pos Center position of the explosion. +/// @param id Id of the object of which to check coverage. +/// @param covMask Mask of object types that may block the explosion. +/// @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) +/// @tsexample +/// // Get the position of the explosion. +/// %position = %explosion.getPosition(); +/// // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. +/// %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType +/// // Acquire the damage value from 0.0f - 1.0f. +/// %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); +/// // Apply damage to object +/// %sceneObject.applyDamage( %coverage * 20 ); +/// @endtsexample +/// @ingroup FX) +/// /// public float calcExplosionCoverage(Point3F pos, int id, uint covMask){ @@ -2729,6 +3001,7 @@ public float calcExplosionCoverage(Point3F pos, int id, uint covMask){ } /// /// cancel(eventId)) +/// /// public void cancel(int eventId){ @@ -2737,6 +3010,7 @@ public void cancel(int eventId){ } /// /// cancelAll(objectId): cancel pending events on the specified object. Events will be automatically cancelled if object is deleted.) +/// /// public void cancelAll(string objectId){ @@ -2745,6 +3019,7 @@ public void cancelAll(string objectId){ } /// /// cancelServerQuery(...); ) +/// /// public void cancelServerQuery(){ @@ -2752,7 +3027,9 @@ public void cancelServerQuery(){ m_ts.fn_cancelServerQuery(); } /// -/// Release the unused pooled textures in texture manager freeing up video memory. @ingroup GFX ) +/// Release the unused pooled textures in texture manager freeing up video memory. +/// @ingroup GFX ) +/// /// public void cleanupTexturePool(){ @@ -2761,6 +3038,7 @@ public void cleanupTexturePool(){ } /// /// ) +/// /// public void clearClientPaths(){ @@ -2768,7 +3046,11 @@ public void clearClientPaths(){ m_ts.fn_clearClientPaths(); } /// -/// Clears the flagged state on all allocated GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// Clears the flagged state on all allocated GFX resources. +/// See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// /// public void clearGFXResourceFlags(){ @@ -2777,6 +3059,7 @@ public void clearGFXResourceFlags(){ } /// /// ) +/// /// public void clearServerPaths(){ @@ -2784,7 +3067,21 @@ public void clearServerPaths(){ m_ts.fn_clearServerPaths(); } /// -/// () @brief Closes the current network port @ingroup Networking) +/// () +/// Returns all pop'd out windows to the main canvas. +/// ) +/// +/// +public void CloseAllPopOuts(){ + + +m_ts.fn_CloseAllPopOuts(); +} +/// +/// () +/// @brief Closes the current network port +/// @ingroup Networking) +/// /// public void closeNetPort(){ @@ -2792,7 +3089,38 @@ public void closeNetPort(){ m_ts.fn_closeNetPort(); } /// -/// Replace all escape sequences in @a text with their respective character codes. This function replaces all escape sequences (\\\, \\\\t, etc) in the given string with the respective characters they represent. The primary use of this function is for converting strings from their literal form into their compiled/translated form, as is normally done by the TorqueScript compiler. @param text A string. @return A duplicate of @a text with all escape sequences replaced by their respective character codes. @tsexample // Print: // // str // ing // // to the console. Note how the backslash in the string must be escaped here // in order to prevent the TorqueScript compiler from collapsing the escape // sequence in the resulting string. echo( collapseEscape( \"str\ing\" ) ); @endtsexample @see expandEscape @ingroup Strings ) +/// Close our startup splash window. +/// @note This is currently only implemented on Windows. +/// @ingroup Platform ) +/// +/// +public void closeSplashWindow(){ + + +m_ts.fn_closeSplashWindow(); +} +/// +/// Replace all escape sequences in @a text with their respective character codes. +/// This function replaces all escape sequences (\\\, \\\\t, etc) in the given string +/// with the respective characters they represent. +/// The primary use of this function is for converting strings from their literal form into +/// their compiled/translated form, as is normally done by the TorqueScript compiler. +/// @param text A string. +/// @return A duplicate of @a text with all escape sequences replaced by their respective character codes. +/// @tsexample +/// // Print: +/// // +/// // str +/// // ing +/// // +/// // to the console. Note how the backslash in the string must be escaped here +/// // in order to prevent the TorqueScript compiler from collapsing the escape +/// // sequence in the resulting string. +/// echo( collapseEscape( \"str\ing\" ) ); +/// @endtsexample +/// @see expandEscape +/// @ingroup Strings ) +/// /// public string collapseEscape(string text){ @@ -2800,7 +3128,20 @@ public string collapseEscape(string text){ return m_ts.fn_collapseEscape(text); } /// -/// Compile a file to bytecode. This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file in the current DSO path mirrorring the path of @a fileName. @param fileName Path to the file to compile to bytecode. @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not generate write compiled code to DSO files. @return True if the file was successfully compiled, false if not. @note The definitions contained in the given file will not be made available and no code will actually be executed. Use exec() for that. @see getDSOPath @see exec @ingroup Scripting ) +/// Compile a file to bytecode. +/// This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, +/// if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file +/// in the current DSO path mirrorring the path of @a fileName. +/// @param fileName Path to the file to compile to bytecode. +/// @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not +/// generate write compiled code to DSO files. +/// @return True if the file was successfully compiled, false if not. +/// @note The definitions contained in the given file will not be made available and no code will actually +/// be executed. Use exec() for that. +/// @see getDSOPath +/// @see exec +/// @ingroup Scripting ) +/// /// public bool compile(string fileName, bool overrideNoDSO = false){ @@ -2809,6 +3150,7 @@ public bool compile(string fileName, bool overrideNoDSO = false){ } /// /// Exports console definition XML representation ) +/// /// public string consoleExportXML(){ @@ -2816,7 +3158,21 @@ public string consoleExportXML(){ return m_ts.fn_consoleExportXML(); } /// -/// @brief See if any objects of the given types are present in box of given extent. @note Extent parameter is last since only one radius is often needed. If one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, if you need to use the client container, you'll need to set all of the radius parameters. Fortunately, this function is mostly used on the server. @param mask Indicates the type of objects we are checking against. @param center Center of box. @param xRadius Search radius in the x-axis. See note above. @param yRadius Search radius in the y-axis. See note above. @param zRadius Search radius in the z-axis. See note above. @param useClientContainer Optionally indicates the search should be within the client container. @return true if the box is empty, false if any object is found. @ingroup Game) +/// @brief See if any objects of the given types are present in box of given extent. +/// @note Extent parameter is last since only one radius is often needed. If +/// one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, +/// if you need to use the client container, you'll need to set all of the radius parameters. +/// Fortunately, this function is mostly used on the server. +/// @param mask Indicates the type of objects we are checking against. +/// @param center Center of box. +/// @param xRadius Search radius in the x-axis. See note above. +/// @param yRadius Search radius in the y-axis. See note above. +/// @param zRadius Search radius in the z-axis. See note above. +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return true if the box is empty, false if any object is found. +/// @ingroup Game) +/// /// public bool containerBoxEmpty(uint mask, Point3F center, float xRadius, float yRadius = -1, float zRadius = -1, bool useClientContainer = false){ @@ -2824,7 +3180,13 @@ public bool containerBoxEmpty(uint mask, Point3F center, float xRadius, float y return m_ts.fn_containerBoxEmpty(mask, center.AsString(), xRadius, yRadius, zRadius, useClientContainer); } /// -/// (int mask, Point3F point, float x, float y, float z) @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more results using containerFindNext(). @see containerFindNext @ingroup Game) +/// (int mask, Point3F point, float x, float y, float z) +/// @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. +/// @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more +/// results using containerFindNext(). +/// @see containerFindNext +/// @ingroup Game) +/// /// public string containerFindFirst(uint typeMask, Point3F origin, Point3F size){ @@ -2832,7 +3194,13 @@ public string containerFindFirst(uint typeMask, Point3F origin, Point3F size){ return m_ts.fn_containerFindFirst(typeMask, origin.AsString(), size.AsString()); } /// -/// () @brief Get more results from a previous call to containerFindFirst(). @note You must call containerFindFirst() to begin the search. @returns The next object found, or an empty string if nothing else was found. @see containerFindFirst() @ingroup Game) +/// () +/// @brief Get more results from a previous call to containerFindFirst(). +/// @note You must call containerFindFirst() to begin the search. +/// @returns The next object found, or an empty string if nothing else was found. +/// @see containerFindFirst() +/// @ingroup Game) +/// /// public string containerFindNext(){ @@ -2840,7 +3208,26 @@ public string containerFindNext(){ return m_ts.fn_containerFindNext(); } /// -/// @brief Cast a ray from start to end, checking for collision against items matching mask. If pExempt is specified, then it is temporarily excluded from collision checks (For instance, you might want to exclude the player if said player was firing a weapon.) @param start An XYZ vector containing the tail position of the ray. @param end An XYZ vector containing the head position of the ray @param mask A bitmask corresponding to the type of objects to check for @param pExempt An optional ID for a single object that ignored for this raycast @param useClientContainer Optionally indicates the search should be within the client container. @returns A string containing either null, if nothing was struck, or these fields: ul>li>The ID of the object that was struck./li> li>The x, y, z position that it was struck./li> li>The x, y, z of the normal of the face that was struck./li> li>The distance between the start point and the position we hit./li>/ul> @ingroup Game) +/// @brief Cast a ray from start to end, checking for collision against items matching mask. +/// +/// If pExempt is specified, then it is temporarily excluded from collision checks (For +/// instance, you might want to exclude the player if said player was firing a weapon.) +/// +/// @param start An XYZ vector containing the tail position of the ray. +/// @param end An XYZ vector containing the head position of the ray +/// @param mask A bitmask corresponding to the type of objects to check for +/// @param pExempt An optional ID for a single object that ignored for this raycast +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @returns A string containing either null, if nothing was struck, or these fields: +/// ul>li>The ID of the object that was struck./li> +/// li>The x, y, z position that it was struck./li> +/// li>The x, y, z of the normal of the face that was struck./li> +/// li>The distance between the start point and the position we hit./li>/ul> +/// +/// @ingroup Game) +/// /// public string containerRayCast(Point3F start, Point3F end, uint mask, string pExempt = null , bool useClientContainer = false){ if (pExempt== null) {pExempt = null;} @@ -2849,7 +3236,17 @@ public string containerRayCast(Point3F start, Point3F end, uint mask, string pE return m_ts.fn_containerRayCast(start.AsString(), end.AsString(), mask, pExempt, useClientContainer); } /// -/// @brief Get distance of the center of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the center of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get distance of the center of the current item from the center of the +/// current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the center of the current object to the center of +/// the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float containerSearchCurrDist(bool useClientContainer = false){ @@ -2857,7 +3254,17 @@ public float containerSearchCurrDist(bool useClientContainer = false){ return m_ts.fn_containerSearchCurrDist(useClientContainer); } /// -/// @brief Get the distance of the closest point of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the closest point of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get the distance of the closest point of the current item from the center +/// of the current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the closest point of the current object to the +/// center of the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float containerSearchCurrRadiusDist(bool useClientContainer = false){ @@ -2865,7 +3272,29 @@ public float containerSearchCurrRadiusDist(bool useClientContainer = false){ return m_ts.fn_containerSearchCurrRadiusDist(useClientContainer); } /// -/// @brief Get next item from a search started with initContainerRadiusSearch() or initContainerTypeSearch(). @param useClientContainer Optionally indicates the search should be within the client container. @return the next object found in the search, or null if no more @tsexample // print the names of all nearby ShapeBase derived objects %position = %obj.getPosition; %radius = 20; %mask = $TypeMasks::ShapeBaseObjectType; initContainerRadiusSearch( %position, %radius, %mask ); while ( (%targetObject = containerSearchNext()) != 0 ) { echo( \"Found: \" @ %targetObject.getName() ); } @endtsexample @see initContainerRadiusSearch() @see initContainerTypeSearch() @ingroup Game) +/// @brief Get next item from a search started with initContainerRadiusSearch() or +/// initContainerTypeSearch(). +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return the next object found in the search, or null if no more +/// +/// @tsexample +/// // print the names of all nearby ShapeBase derived objects +/// %position = %obj.getPosition; +/// %radius = 20; +/// %mask = $TypeMasks::ShapeBaseObjectType; +/// initContainerRadiusSearch( %position, %radius, %mask ); +/// while ( (%targetObject = containerSearchNext()) != 0 ) +/// { +/// echo( \"Found: \" @ %targetObject.getName() ); +/// } +/// @endtsexample +/// +/// @see initContainerRadiusSearch() +/// @see initContainerTypeSearch() +/// @ingroup Game) +/// /// public string containerSearchNext(bool useClientContainer = false){ @@ -2873,7 +3302,40 @@ public string containerSearchNext(bool useClientContainer = false){ return m_ts.fn_containerSearchNext(useClientContainer); } /// -/// @brief Checks to see if text is a bad word The text is considered to be a bad word if it has been added to the bad word filter. @param text Text to scan for bad words @return True if the text has bad word(s), false if it is clean @see addBadWord() @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Add a banned word to the bad word filter addBadWord(%badWord); // Create the base string, can come from anywhere like user chat %userText = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // If the text contains a bad word, filter it before printing // Otherwise print the original text if(containsBadWords(%userText)) { // Filter the string %filteredText = filterString(%userText, %replacementChars); // Print filtered text echo(%filteredText); } else echo(%userText); @endtsexample @ingroup Game) +/// @brief Checks to see if text is a bad word +/// +/// The text is considered to be a bad word if it has been added to the bad word filter. +/// +/// @param text Text to scan for bad words +/// @return True if the text has bad word(s), false if it is clean +/// +/// @see addBadWord() +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Add a banned word to the bad word filter +/// addBadWord(%badWord); +/// // Create the base string, can come from anywhere like user chat +/// %userText = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // If the text contains a bad word, filter it before printing +/// // Otherwise print the original text +/// if(containsBadWords(%userText)) +/// { +/// // Filter the string +/// %filteredText = filterString(%userText, %replacementChars); +/// // Print filtered text +/// echo(%filteredText); +/// } +/// else +/// echo(%userText); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool containsBadWords(string text){ @@ -2881,7 +3343,11 @@ public bool containsBadWords(string text){ return m_ts.fn_containsBadWords(text); } /// -/// Count the number of bits that are set in the given 32 bit integer. @param v An integer value. @return The number of bits that are set in @a v. @ingroup Utilities ) +/// Count the number of bits that are set in the given 32 bit integer. +/// @param v An integer value. +/// @return The number of bits that are set in @a v. +/// @ingroup Utilities ) +/// /// public int countBits(int v){ @@ -2889,7 +3355,14 @@ public int countBits(int v){ return m_ts.fn_countBits(v); } /// -/// @brief Create the given directory or the path leading to the given filename. If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components of the path will be created. @param path The path to create. @note Only present in a Tools build of Torque. @ingroup FileSystem ) +/// @brief Create the given directory or the path leading to the given filename. +/// If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, +/// does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components +/// of the path will be created. +/// @param path The path to create. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem ) +/// /// public bool createPath(string path){ @@ -2897,7 +3370,10 @@ public bool createPath(string path){ return m_ts.fn_createPath(path); } /// -/// () Forcibly disconnects any attached script debugging client. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Forcibly disconnects any attached script debugging client. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void dbgDisconnect(){ @@ -2905,7 +3381,10 @@ public void dbgDisconnect(){ m_ts.fn_dbgDisconnect(); } /// -/// () Returns true if a script debugging client is connected else return false. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Returns true if a script debugging client is connected else return false. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public bool dbgIsConnected(){ @@ -2913,7 +3392,11 @@ public bool dbgIsConnected(){ return m_ts.fn_dbgIsConnected(); } /// -/// ( int port, string password, bool waitForClient ) Open a debug server port on the specified port, requiring the specified password, and optionally waiting for the debug client to connect. @internal Primarily used for Torsion and other debugging tools) +/// ( int port, string password, bool waitForClient ) +/// Open a debug server port on the specified port, requiring the specified password, +/// and optionally waiting for the debug client to connect. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void dbgSetParameters(int port, string password, bool waitForClient = false){ @@ -2921,7 +3404,11 @@ public void dbgSetParameters(int port, string password, bool waitForClient = fa m_ts.fn_dbgSetParameters(port, password, waitForClient); } /// -/// () @brief Disables DirectInput. Also deactivates any connected joysticks. @ingroup Input ) +/// () +/// @brief Disables DirectInput. +/// Also deactivates any connected joysticks. +/// @ingroup Input ) +/// /// public void deactivateDirectInput(){ @@ -2942,7 +3429,12 @@ public void deactivatePackage(string packageName){ m_ts.fn_deactivatePackage(packageName); } /// -/// Drops the engine into the native C++ debugger. This function triggers a debug break and drops the process into the IDE's debugger. If the process is not running with a debugger attached it will generate a runtime error on most platforms. @note This function is not available in shipping builds. @ingroup Debugging ) +/// Drops the engine into the native C++ debugger. +/// This function triggers a debug break and drops the process into the IDE's debugger. If the process is not +/// running with a debugger attached it will generate a runtime error on most platforms. +/// @note This function is not available in shipping builds. +/// @ingroup Debugging ) +/// /// public void debug(){ @@ -2950,7 +3442,10 @@ public void debug(){ m_ts.fn_debug(); } /// -/// @brief Dumps all current EngineObject instances to the console. @note This function is only available in debug builds. @ingroup Debugging ) +/// @brief Dumps all current EngineObject instances to the console. +/// @note This function is only available in debug builds. +/// @ingroup Debugging ) +/// /// public void debugDumpAllObjects(){ @@ -2971,7 +3466,15 @@ public void debugEnumInstances(string className, string functionName){ m_ts.fn_debugEnumInstances(className, functionName); } /// -/// @brief Logs the value of the given variable to the console. Prints a string of the form \"variableName> = variable value>\" to the console. @param variableName Name of the local or global variable to print. @tsexample %var = 1; debugv( \"%var\" ); // Prints \"%var = 1\" @endtsexample @ingroup Debugging ) +/// @brief Logs the value of the given variable to the console. +/// Prints a string of the form \"variableName> = variable value>\" to the console. +/// @param variableName Name of the local or global variable to print. +/// @tsexample +/// %var = 1; +/// debugv( \"%var\" ); // Prints \"%var = 1\" +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void debugv(string variableName){ @@ -2979,7 +3482,26 @@ public void debugv(string variableName){ m_ts.fn_debugv(variableName); } /// -/// Adds a new decal to the decal manager. @param position World position for the decal. @param normal Decal normal vector (if the decal was a tire lying flat on a surface, this is the vector pointing in the direction of the axle). @param rot Angle (in radians) to rotate this decal around its normal vector. @param scale Scale factor applied to the decal. @param decalData DecalData datablock to use for the new decal. @param isImmortal Whether or not this decal is immortal. If immortal, it does not expire automatically and must be removed explicitly. @return Returns the ID of the new Decal object or -1 on failure. @tsexample // Specify the decal position %position = \"1.0 1.0 1.0\"; // Specify the up vector %normal = \"0.0 0.0 1.0\"; // Add the new decal. %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); @endtsexample @ingroup Decals ) +/// Adds a new decal to the decal manager. +/// @param position World position for the decal. +/// @param normal Decal normal vector (if the decal was a tire lying flat on a +/// surface, this is the vector pointing in the direction of the axle). +/// @param rot Angle (in radians) to rotate this decal around its normal vector. +/// @param scale Scale factor applied to the decal. +/// @param decalData DecalData datablock to use for the new decal. +/// @param isImmortal Whether or not this decal is immortal. If immortal, it +/// does not expire automatically and must be removed explicitly. +/// @return Returns the ID of the new Decal object or -1 on failure. +/// @tsexample +/// // Specify the decal position +/// %position = \"1.0 1.0 1.0\"; +/// // Specify the up vector +/// %normal = \"0.0 0.0 1.0\"; +/// // Add the new decal. +/// %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public int decalManagerAddDecal(Point3F position, Point3F normal, float rot, float scale, string decalData, bool isImmortal = false){ @@ -2987,7 +3509,13 @@ public int decalManagerAddDecal(Point3F position, Point3F normal, float rot, fl return m_ts.fn_decalManagerAddDecal(position.AsString(), normal.AsString(), rot, scale, decalData, isImmortal); } /// -/// Removes all decals currently loaded in the decal manager. @tsexample // Tell the decal manager to remove all existing decals. decalManagerClear(); @endtsexample @ingroup Decals ) +/// Removes all decals currently loaded in the decal manager. +/// @tsexample +/// // Tell the decal manager to remove all existing decals. +/// decalManagerClear(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void decalManagerClear(){ @@ -2995,7 +3523,15 @@ public void decalManagerClear(){ m_ts.fn_decalManagerClear(); } /// -/// Returns whether the decal manager has unsaved modifications. @return True if the decal manager has unsaved modifications, false if everything has been saved. @tsexample // Ask the decal manager if it has unsaved modifications. %hasUnsavedModifications = decalManagerDirty(); @endtsexample @ingroup Decals ) +/// Returns whether the decal manager has unsaved modifications. +/// @return True if the decal manager has unsaved modifications, false if +/// everything has been saved. +/// @tsexample +/// // Ask the decal manager if it has unsaved modifications. +/// %hasUnsavedModifications = decalManagerDirty(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool decalManagerDirty(){ @@ -3003,7 +3539,18 @@ public bool decalManagerDirty(){ return m_ts.fn_decalManagerDirty(); } /// -/// Clears existing decals and replaces them with decals loaded from the specified file. @param fileName Filename to load the decals from. @return True if the decal manager was able to load the requested file, false if it could not. @tsexample // Set the filename to load the decals from. %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to load the decals from the entered filename. decalManagerLoad( %fileName ); @endtsexample @ingroup Decals ) +/// Clears existing decals and replaces them with decals loaded from the specified file. +/// @param fileName Filename to load the decals from. +/// @return True if the decal manager was able to load the requested file, +/// false if it could not. +/// @tsexample +/// // Set the filename to load the decals from. +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to load the decals from the entered filename. +/// decalManagerLoad( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool decalManagerLoad(string fileName){ @@ -3011,7 +3558,17 @@ public bool decalManagerLoad(string fileName){ return m_ts.fn_decalManagerLoad(fileName); } /// -/// Remove specified decal from the scene. @param decalID ID of the decal to remove. @return Returns true if successful, false if decal ID not found. @tsexample // Specify a decal ID to be removed %decalID = 1; // Tell the decal manager to remove the specified decal ID. decalManagerRemoveDecal( %decalId ) @endtsexample @ingroup Decals ) +/// Remove specified decal from the scene. +/// @param decalID ID of the decal to remove. +/// @return Returns true if successful, false if decal ID not found. +/// @tsexample +/// // Specify a decal ID to be removed +/// %decalID = 1; +/// // Tell the decal manager to remove the specified decal ID. +/// decalManagerRemoveDecal( %decalId ) +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool decalManagerRemoveDecal(int decalID){ @@ -3019,7 +3576,18 @@ public bool decalManagerRemoveDecal(int decalID){ return m_ts.fn_decalManagerRemoveDecal(decalID); } /// -/// ), Saves the decals for the active mission in the entered filename. @param decalSaveFile Filename to save the decals to. @tsexample // Set the filename to save the decals in. If no filename is set, then the // decals will default to activeMissionName>.mis.decals %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to save the decals for the active mission. decalManagerSave( %fileName ); @endtsexample @ingroup Decals ) +/// ), +/// Saves the decals for the active mission in the entered filename. +/// @param decalSaveFile Filename to save the decals to. +/// @tsexample +/// // Set the filename to save the decals in. If no filename is set, then the +/// // decals will default to activeMissionName>.mis.decals +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to save the decals for the active mission. +/// decalManagerSave( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void decalManagerSave(string decalSaveFile = ""){ @@ -3027,7 +3595,10 @@ public void decalManagerSave(string decalSaveFile = ""){ m_ts.fn_decalManagerSave(decalSaveFile); } /// -/// Delete all the datablocks we've downloaded. This is usually done in preparation of downloading a new set of datablocks, such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// Delete all the datablocks we've downloaded. +/// This is usually done in preparation of downloading a new set of datablocks, +/// such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// /// public void deleteDataBlocks(){ @@ -3035,7 +3606,11 @@ public void deleteDataBlocks(){ m_ts.fn_deleteDataBlocks(); } /// -/// @brief Deletes the given @a file. @param file %Path of the file to delete. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Deletes the given @a file. +/// @param file %Path of the file to delete. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool deleteFile(string file){ @@ -3043,7 +3618,17 @@ public bool deleteFile(string file){ return m_ts.fn_deleteFile(file); } /// -/// Undefine all global variables matching the given name @a pattern. @param pattern A global variable name pattern. Must begin with '$'. @tsexample // Define a global variable in the \"My\" namespace. $My::Variable = \"value\"; // Undefine all variable in the \"My\" namespace. deleteVariables( \"$My::*\" ); @endtsexample @see strIsMatchExpr @ingroup Scripting ) +/// Undefine all global variables matching the given name @a pattern. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @tsexample +/// // Define a global variable in the \"My\" namespace. +/// $My::Variable = \"value\"; +/// // Undefine all variable in the \"My\" namespace. +/// deleteVariables( \"$My::*\" ); +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Scripting ) +/// /// public void deleteVariables(string pattern){ @@ -3051,7 +3636,22 @@ public void deleteVariables(string pattern){ m_ts.fn_deleteVariables(pattern); } /// -/// @brief Dumps a description of GFX resources to a file or the console. @param resourceTypes A space seperated list of resource types or an empty string for all resources. @param filePath A file to dump the list to or an empty string to write to the console. @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. @note The resource types can be one or more of the following: - texture - texture target - window target - vertex buffers - primitive buffers - fences - cubemaps - shaders - stateblocks @ingroup GFX ) +/// @brief Dumps a description of GFX resources to a file or the console. +/// @param resourceTypes A space seperated list of resource types or an empty string for all resources. +/// @param filePath A file to dump the list to or an empty string to write to the console. +/// @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. +/// @note The resource types can be one or more of the following: +/// - texture +/// - texture target +/// - window target +/// - vertex buffers +/// - primitive buffers +/// - fences +/// - cubemaps +/// - shaders +/// - stateblocks +/// @ingroup GFX ) +/// /// public void describeGFXResources(string resourceTypes, string filePath, bool unflaggedOnly = false){ @@ -3059,7 +3659,10 @@ public void describeGFXResources(string resourceTypes, string filePath, bool un m_ts.fn_describeGFXResources(resourceTypes, filePath, unflaggedOnly); } /// -/// Dumps a description of all state blocks. @param filePath A file to dump the state blocks to or an empty string to write to the console. @ingroup GFX ) +/// Dumps a description of all state blocks. +/// @param filePath A file to dump the state blocks to or an empty string to write to the console. +/// @ingroup GFX ) +/// /// public void describeGFXStateBlocks(string filePath){ @@ -3067,7 +3670,26 @@ public void describeGFXStateBlocks(string filePath){ m_ts.fn_describeGFXStateBlocks(filePath); } /// -/// @brief Returns the string from a tag string. Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. Use getTaggedString() to convert a tagged string ID back into a regular string at any time. @tsexample // From scripts/client/message.cs function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) { onChatMessage(detag(%msgString), %voice, %pitch); } @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see getTag() @see getTaggedString() @ingroup Networking) +/// @brief Returns the string from a tag string. +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. Use getTaggedString() +/// to convert a tagged string ID back into a regular string at any time. +/// +/// @tsexample +/// // From scripts/client/message.cs +/// function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) +/// { +/// onChatMessage(detag(%msgString), %voice, %pitch); +/// } +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see getTag() +/// @see getTaggedString() +/// +/// @ingroup Networking) +/// /// public string detag(string str){ @@ -3075,7 +3697,11 @@ public string detag(string str){ return m_ts.fn_detag(str); } /// -/// () @brief Disables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Disables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public void disableJoystick(){ @@ -3083,7 +3709,10 @@ public void disableJoystick(){ m_ts.fn_disableJoystick(); } /// -/// () @brief Disables XInput for Xbox 360 controllers. @ingroup Input) +/// () +/// @brief Disables XInput for Xbox 360 controllers. +/// @ingroup Input) +/// /// public void disableXInput(){ @@ -3091,7 +3720,15 @@ public void disableXInput(){ m_ts.fn_disableXInput(); } /// -/// ), (string queueName, string message, string data) @brief Dispatch a message to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @param data Data for message @return True for success, false for failure @see dispatchMessageObject @ingroup Messaging) +/// ), (string queueName, string message, string data) +/// @brief Dispatch a message to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @param data Data for message +/// @return True for success, false for failure +/// @see dispatchMessageObject +/// @ingroup Messaging) +/// /// public bool dispatchMessage(string queueName, string message, string data = ""){ @@ -3099,7 +3736,14 @@ public bool dispatchMessage(string queueName, string message, string data = "") return m_ts.fn_dispatchMessage(queueName, message, data); } /// -/// , ), (string queueName, string message) @brief Dispatch a message object to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @return true for success, false for failure @see dispatchMessage @ingroup Messaging) +/// , ), (string queueName, string message) +/// @brief Dispatch a message object to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @return true for success, false for failure +/// @see dispatchMessage +/// @ingroup Messaging) +/// /// public bool dispatchMessageObject(string queueName = "", string message = ""){ @@ -3107,7 +3751,12 @@ public bool dispatchMessageObject(string queueName = "", string message = ""){ return m_ts.fn_dispatchMessageObject(queueName, message); } /// -/// art/gui/splash.bmp), Display a startup splash window suitable for showing while the engine still starts up. @note This is currently only implemented on Windows. @return True if the splash window could be successfully initialized. @ingroup Platform ) +/// art/gui/splash.bmp), +/// Display a startup splash window suitable for showing while the engine still starts up. +/// @note This is currently only implemented on Windows. +/// @return True if the splash window could be successfully initialized. +/// @ingroup Platform ) +/// /// public bool displaySplashWindow(string path = "art/gui/splash.bmp"){ @@ -3115,7 +3764,12 @@ public bool displaySplashWindow(string path = "art/gui/splash.bmp"){ return m_ts.fn_displaySplashWindow(path); } /// -/// (bool enabled) @brief Enables logging of the connection protocols When enabled a lot of network debugging information is sent to the console. @param enabled True to enable, false to disable @ingroup Networking) +/// (bool enabled) +/// @brief Enables logging of the connection protocols +/// When enabled a lot of network debugging information is sent to the console. +/// @param enabled True to enable, false to disable +/// @ingroup Networking) +/// /// public void DNetSetLogging(bool enabled){ @@ -3263,7 +3917,11 @@ public Point3F dnt_testcase_9(Point3F chr){ return new Point3F ( m_ts.fn_dnt_testcase_9(chr.AsString())); } /// -/// @brief Dumps all declared console classes to the console. @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console classes to the console. +/// @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. +/// @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void dumpConsoleClasses(bool dumpScript = true, bool dumpEngine = true){ @@ -3271,7 +3929,11 @@ public void dumpConsoleClasses(bool dumpScript = true, bool dumpEngine = true){ m_ts.fn_dumpConsoleClasses(dumpScript, dumpEngine); } /// -/// @brief Dumps all declared console functions to the console. @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console functions to the console. +/// @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. +/// @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void dumpConsoleFunctions(bool dumpScript = true, bool dumpEngine = true){ @@ -3279,7 +3941,11 @@ public void dumpConsoleFunctions(bool dumpScript = true, bool dumpEngine = true m_ts.fn_dumpConsoleFunctions(dumpScript, dumpEngine); } /// -/// Dumps the engine scripting documentation to the specified file overwriting any existing content. @param outputFile The relative or absolute output file path and name. @return Returns true if successful. @ingroup Console) +/// Dumps the engine scripting documentation to the specified file overwriting any existing content. +/// @param outputFile The relative or absolute output file path and name. +/// @return Returns true if successful. +/// @ingroup Console) +/// /// public bool dumpEngineDocs(string outputFile){ @@ -3287,7 +3953,10 @@ public bool dumpEngineDocs(string outputFile){ return m_ts.fn_dumpEngineDocs(outputFile); } /// -/// Dumps to the console a full description of all cached fonts, along with info on the codepoints each contains. @ingroup Font ) +/// Dumps to the console a full description of all cached fonts, along with +/// info on the codepoints each contains. +/// @ingroup Font ) +/// /// public void dumpFontCacheStatus(){ @@ -3295,7 +3964,9 @@ public void dumpFontCacheStatus(){ m_ts.fn_dumpFontCacheStatus(); } /// -/// @brief Dumps a formatted list of currently allocated material instances to the console. @ingroup Materials) +/// @brief Dumps a formatted list of currently allocated material instances to the console. +/// @ingroup Materials) +/// /// public void dumpMaterialInstances(){ @@ -3303,7 +3974,14 @@ public void dumpMaterialInstances(){ m_ts.fn_dumpMaterialInstances(); } /// -/// @brief Dumps network statistics for each class to the console. The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. The i>num/i> value is the total number of events collected. @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. @ingroup Networking ) +/// @brief Dumps network statistics for each class to the console. +/// +/// The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. +/// The i>num/i> value is the total number of events collected. +/// +/// @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. +/// @ingroup Networking ) +/// /// public void dumpNetStats(){ @@ -3311,7 +3989,13 @@ public void dumpNetStats(){ m_ts.fn_dumpNetStats(); } /// -/// @brief Dump the current contents of the networked string table to the console. The results are returned in three columns. The first column is the network string ID. The second column is the string itself. The third column is the reference count to the network string. @note This function is available only in debug builds. @ingroup Networking ) +/// @brief Dump the current contents of the networked string table to the console. +/// The results are returned in three columns. The first column is the network string ID. +/// The second column is the string itself. The third column is the reference count to the +/// network string. +/// @note This function is available only in debug builds. +/// @ingroup Networking ) +/// /// public void dumpNetStringTable(){ @@ -3320,6 +4004,7 @@ public void dumpNetStringTable(){ } /// /// Dumps all ProcessObjects in ServerProcessList and ClientProcessList to the console. ) +/// /// public void dumpProcessList(bool allow){ @@ -3327,7 +4012,10 @@ public void dumpProcessList(bool allow){ m_ts.fn_dumpProcessList(allow); } /// -/// Creates a 64x64 normal map texture filled with noise. The texture is saved to randNormTex.png in the location of the game executable. @ingroup GFX) +/// Creates a 64x64 normal map texture filled with noise. The texture is saved +/// to randNormTex.png in the location of the game executable. +/// @ingroup GFX) +/// /// public void dumpRandomNormalMap(){ @@ -3344,7 +4032,11 @@ public void dumpSoCount(){ m_ts.fn_dumpSoCount(); } /// -/// () @brief Dumps information about String memory usage @ingroup Debugging @ingroup Strings) +/// () +/// @brief Dumps information about String memory usage +/// @ingroup Debugging +/// @ingroup Strings) +/// /// public void dumpStringMemStats(){ @@ -3352,15 +4044,10 @@ public void dumpStringMemStats(){ m_ts.fn_dumpStringMemStats(); } /// -/// ) -/// -public void dumpStringTableSize(){ - - -m_ts.fn_dumpStringTableSize(); -} -/// -/// Dumps a list of all active texture objects to the console. @note This function is only available in debug builds. @ingroup GFX ) +/// Dumps a list of all active texture objects to the console. +/// @note This function is only available in debug builds. +/// @ingroup GFX ) +/// /// public void dumpTextureObjects(){ @@ -3368,7 +4055,15 @@ public void dumpTextureObjects(){ m_ts.fn_dumpTextureObjects(); } /// -/// Copy the specified old font to a new name. The new copy will not have a platform font backing it, and so will never have characters added to it. But this is useful for making copies of fonts to add postprocessing effects to via exportCachedFont. @param oldFontName The name of the font face to copy. @param oldFontSize The size of the font to copy. @param newFontName The name of the new font face. @ingroup Font ) +/// Copy the specified old font to a new name. The new copy will not have a +/// platform font backing it, and so will never have characters added to it. +/// But this is useful for making copies of fonts to add postprocessing effects +/// to via exportCachedFont. +/// @param oldFontName The name of the font face to copy. +/// @param oldFontSize The size of the font to copy. +/// @param newFontName The name of the new font face. +/// @ingroup Font ) +/// /// public void duplicateCachedFont(string oldFontName, int oldFontSize, string newFontName){ @@ -3376,7 +4071,10 @@ public void duplicateCachedFont(string oldFontName, int oldFontSize, string new m_ts.fn_duplicateCachedFont(oldFontName, oldFontSize, newFontName); } /// -/// () @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. @ingroup Input) +/// () +/// @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. +/// @ingroup Input) +/// /// public void echoInputState(){ @@ -3384,7 +4082,11 @@ public void echoInputState(){ m_ts.fn_echoInputState(); } /// -/// () @brief Enables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Enables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public bool enableJoystick(){ @@ -3392,7 +4094,11 @@ public bool enableJoystick(){ return m_ts.fn_enableJoystick(); } /// -/// (pattern, [state]) - @brief Enable sampling for all keys that match the given name pattern. Slashes are treated as separators. @ingroup Rendering) +/// (pattern, [state]) - +/// @brief Enable sampling for all keys that match the given name +/// pattern. Slashes are treated as separators. +/// @ingroup Rendering) +/// /// public void enableSamples(string pattern, bool state = true){ @@ -3401,6 +4107,7 @@ public void enableSamples(string pattern, bool state = true){ } /// /// enableWinConsole(bool);) +/// /// public void enableWinConsole(bool flag){ @@ -3408,7 +4115,12 @@ public void enableWinConsole(bool flag){ m_ts.fn_enableWinConsole(flag); } /// -/// () @brief Enables XInput for Xbox 360 controllers. @note XInput is enabled by default. Disable to use an Xbox 360 Controller as a joystick device. @ingroup Input) +/// () +/// @brief Enables XInput for Xbox 360 controllers. +/// @note XInput is enabled by default. Disable to use an Xbox 360 +/// Controller as a joystick device. +/// @ingroup Input) +/// /// public bool enableXInput(){ @@ -3416,7 +4128,18 @@ public bool enableXInput(){ return m_ts.fn_enableXInput(); } /// -/// @brief Test whether the given string ends with the given suffix. @param str The string to test. @param suffix The potential suffix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. @tsexample startsWith( \"TEST123\", \"123\" ) // Returns true. @endtsexample @see startsWith @ingroup Strings ) +/// @brief Test whether the given string ends with the given suffix. +/// @param str The string to test. +/// @param suffix The potential suffix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"123\" ) // Returns true. +/// @endtsexample +/// @see startsWith +/// @ingroup Strings ) +/// /// public bool endsWith(string str, string suffix, bool caseSensitive = false){ @@ -3424,7 +4147,16 @@ public bool endsWith(string str, string suffix, bool caseSensitive = false){ return m_ts.fn_endsWith(str, suffix, caseSensitive); } /// -/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from a COLLADA file and store it in a GuiTreeView control. This function is used by the COLLADA import gui to show a preview of the scene contents prior to import, and is probably not much use for anything else. @param shapePath COLLADA filename @param ctrl GuiTreeView control to add elements to @return true if successful, false otherwise @ingroup Editors @internal) +/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from +/// a COLLADA file and store it in a GuiTreeView control. This function is +/// used by the COLLADA import gui to show a preview of the scene contents +/// prior to import, and is probably not much use for anything else. +/// @param shapePath COLLADA filename +/// @param ctrl GuiTreeView control to add elements to +/// @return true if successful, false otherwise +/// @ingroup Editors +/// @internal) +/// /// public bool enumColladaForImport(string shapePath, string ctrl){ @@ -3432,7 +4164,14 @@ public bool enumColladaForImport(string shapePath, string ctrl){ return m_ts.fn_enumColladaForImport(shapePath, ctrl); } /// -/// ), @brief Returns a list of classes that derive from the named class. If the named class is omitted this dumps all the classes. @param className The optional base class name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// ), +/// @brief Returns a list of classes that derive from the named class. +/// If the named class is omitted this dumps all the classes. +/// @param className The optional base class name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string enumerateConsoleClasses(string className = ""){ @@ -3440,7 +4179,12 @@ public string enumerateConsoleClasses(string className = ""){ return m_ts.fn_enumerateConsoleClasses(className); } /// -/// @brief Provide a list of classes that belong to the given category. @param category The category name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// @brief Provide a list of classes that belong to the given category. +/// @param category The category name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string enumerateConsoleClassesByCategory(string category){ @@ -3449,6 +4193,7 @@ public string enumerateConsoleClassesByCategory(string category){ } /// /// eval(consoleString) ) +/// /// public string eval(string consoleString){ @@ -3456,7 +4201,17 @@ public string eval(string consoleString){ return m_ts.fn_eval(consoleString); } /// -/// @brief Used to exclude/prevent all other instances using the same identifier specified @note Not used on OSX, Xbox, or in Win debug builds @param appIdentifier Name of the app set up for exclusive use. @return False if another app is running that specified the same appIdentifier @ingroup Platform @ingroup GuiCore) +/// @brief Used to exclude/prevent all other instances using the same identifier specified +/// +/// @note Not used on OSX, Xbox, or in Win debug builds +/// +/// @param appIdentifier Name of the app set up for exclusive use. +/// +/// @return False if another app is running that specified the same appIdentifier +/// +/// @ingroup Platform +/// @ingroup GuiCore) +/// /// public bool excludeOtherInstance(string appIdentifer){ @@ -3464,7 +4219,19 @@ public bool excludeOtherInstance(string appIdentifer){ return m_ts.fn_excludeOtherInstance(appIdentifer); } /// -/// Execute the given script file. @param fileName Path to the file to execute @param noCalls Deprecated @param journalScript Deprecated @return True if the script was successfully executed, false if not. @tsexample // Execute the init.cs script file found in the same directory as the current script file. exec( \"./init.cs\" ); @endtsexample @see compile @see eval @ingroup Scripting ) +/// Execute the given script file. +/// @param fileName Path to the file to execute +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if the script was successfully executed, false if not. +/// @tsexample +/// // Execute the init.cs script file found in the same directory as the current script file. +/// exec( \"./init.cs\" ); +/// @endtsexample +/// @see compile +/// @see eval +/// @ingroup Scripting ) +/// /// public bool exec(string fileName, bool noCalls = false, bool journalScript = false){ @@ -3472,7 +4239,20 @@ public bool exec(string fileName, bool noCalls = false, bool journalScript = fa return m_ts.fn_exec(fileName, noCalls, journalScript); } /// -/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their respective escape sequences. All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). The primary use of this function is for converting strings suitable for being passed as string literals to the TorqueScript compiler. @param text A string @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective escape sequences. @tsxample expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". @endtsxample @see collapseEscape @ingroup Strings) +/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their +/// respective escape sequences. +/// All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). +/// The primary use of this function is for converting strings suitable for being passed as string literals +/// to the TorqueScript compiler. +/// @param text A string +/// @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective +/// escape sequences. +/// @tsxample +/// expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". +/// @endtsxample +/// @see collapseEscape +/// @ingroup Strings) +/// /// public string expandEscape(string text){ @@ -3480,7 +4260,23 @@ public string expandEscape(string text){ return m_ts.fn_expandEscape(text); } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void export(string pattern, string filename = "", bool append = false){ @@ -3488,7 +4284,17 @@ public void export(string pattern, string filename = "", bool append = false){ m_ts.fn_export(pattern, filename, append); } /// -/// Export specified font to the specified filename as a PNG. The image can then be processed in Photoshop or another tool and reimported using importCachedFont. Characters in the font are exported as one long strip. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the output PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Export specified font to the specified filename as a PNG. The +/// image can then be processed in Photoshop or another tool and +/// reimported using importCachedFont. Characters in the font are +/// exported as one long strip. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the output PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void exportCachedFont(string faceName, int fontSize, string fileName, int padding, int kerning){ @@ -3496,7 +4302,10 @@ public void exportCachedFont(string faceName, int fontSize, string fileName, in m_ts.fn_exportCachedFont(faceName, fontSize, fileName, padding, kerning); } /// -/// Create a XML document containing a dump of the entire exported engine API. @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. @ingroup Console ) +/// Create a XML document containing a dump of the entire exported engine API. +/// @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. +/// @ingroup Console ) +/// /// public string exportEngineAPIToXML(){ @@ -3504,7 +4313,23 @@ public string exportEngineAPIToXML(){ return m_ts.fn_exportEngineAPIToXML(); } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void exportToSettings(string pattern, string filename = "", bool append = false){ @@ -3512,7 +4337,12 @@ public void exportToSettings(string pattern, string filename = "", bool append m_ts.fn_exportToSettings(pattern, filename, append); } /// -/// @brief Get the base of a file name (removes extension) @param fileName Name and path of file to check @return String containing the file name, minus extension @ingroup FileSystem) +/// @brief Get the base of a file name (removes extension and path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus extension and path +/// @ingroup FileSystem) +/// /// public string fileBase(string fileName){ @@ -3520,7 +4350,12 @@ public string fileBase(string fileName){ return m_ts.fn_fileBase(fileName); } /// -/// @brief Returns a platform specific formatted string with the creation time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the creation time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fileCreatedTime(string fileName){ @@ -3528,7 +4363,13 @@ public string fileCreatedTime(string fileName){ return m_ts.fn_fileCreatedTime(fileName); } /// -/// @brief Delete a file from the hard drive @param path Name and path of the file to delete @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. @return True if file was successfully deleted @ingroup FileSystem) +/// @brief Delete a file from the hard drive +/// +/// @param path Name and path of the file to delete +/// @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. +/// @return True if file was successfully deleted +/// @ingroup FileSystem) +/// /// public bool fileDelete(string path){ @@ -3536,7 +4377,12 @@ public bool fileDelete(string path){ return m_ts.fn_fileDelete(path); } /// -/// @brief Get the extension of a file @param fileName Name and path of file @return String containing the extension, such as \".exe\" or \".cs\" @ingroup FileSystem) +/// @brief Get the extension of a file +/// +/// @param fileName Name and path of file +/// @return String containing the extension, such as \".exe\" or \".cs\" +/// @ingroup FileSystem) +/// /// public string fileExt(string fileName){ @@ -3544,7 +4390,12 @@ public string fileExt(string fileName){ return m_ts.fn_fileExt(fileName); } /// -/// @brief Returns a platform specific formatted string with the last modified time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the last modified time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fileModifiedTime(string fileName){ @@ -3552,7 +4403,12 @@ public string fileModifiedTime(string fileName){ return m_ts.fn_fileModifiedTime(fileName); } /// -/// @brief Get the file name of a file (removes extension and path) @param fileName Name and path of file to check @return String containing the file name, minus extension and path @ingroup FileSystem) +/// @brief Get only the file name of a path and file name string (removes path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus the path +/// @ingroup FileSystem) +/// /// public string fileName(string fileName){ @@ -3560,7 +4416,12 @@ public string fileName(string fileName){ return m_ts.fn_fileName(fileName); } /// -/// @brief Get the path of a file (removes name and extension) @param fileName Name and path of file to check @return String containing the path, minus name and extension @ingroup FileSystem) +/// @brief Get the path of a file (removes name and extension) +/// +/// @param fileName Name and path of file to check +/// @return String containing the path, minus name and extension +/// @ingroup FileSystem) +/// /// public string filePath(string fileName){ @@ -3568,7 +4429,13 @@ public string filePath(string fileName){ return m_ts.fn_filePath(fileName); } /// -/// @brief Determines the size of a file on disk @param fileName Name and path of the file to check @return Returns filesize in KB, or -1 if no file @ingroup FileSystem) +/// @brief Determines the size of a file on disk +/// +/// @param fileName Name and path of the file to check +/// @return Returns filesize in KB, or -1 if no file +/// +/// @ingroup FileSystem) +/// /// public int fileSize(string fileName){ @@ -3576,7 +4443,30 @@ public int fileSize(string fileName){ return m_ts.fn_fileSize(fileName); } /// -/// @brief Replaces the characters in a string with designated text Uses the bad word filter to determine which characters within the string will be replaced. @param baseString The original string to filter. @param replacementChars A string containing letters you wish to swap in the baseString. @return The new scrambled string @see addBadWord() @see containsBadWords() @tsexample // Create the base string, can come from anywhere %baseString = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // Filter the string %newString = filterString(%baseString, %replacementChars); // Print the new string to console echo(%newString); @endtsexample @ingroup Game) +/// @brief Replaces the characters in a string with designated text +/// +/// Uses the bad word filter to determine which characters within the string will be replaced. +/// +/// @param baseString The original string to filter. +/// @param replacementChars A string containing letters you wish to swap in the baseString. +/// @return The new scrambled string +/// +/// @see addBadWord() +/// @see containsBadWords() +/// +/// @tsexample +/// // Create the base string, can come from anywhere +/// %baseString = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // Filter the string +/// %newString = filterString(%baseString, %replacementChars); +/// // Print the new string to console +/// echo(%newString); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public string filterString(string baseString = null , string replacementChars = null ){ if (baseString== null) {baseString = null;} @@ -3586,7 +4476,34 @@ public string filterString(string baseString = null , string replacementChars = return m_ts.fn_filterString(baseString, replacementChars); } /// -/// @brief Returns the first file in the directory system matching the given pattern. Use the corresponding findNextFile() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCount(). This function differs from findFirstFileMultiExpr() in that it supports a single search pattern being passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return The path of the first file matched by the search or an empty string if no matching file could be found. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findNextFile() @see getFileCount() @see findFirstFileMultiExpr() @ingroup FileSearches ) +/// @brief Returns the first file in the directory system matching the given pattern. +/// +/// Use the corresponding findNextFile() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCount(). +/// +/// This function differs from findFirstFileMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. +/// @return The path of the first file matched by the search or an empty string if no matching file could be found. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findNextFile() +/// @see getFileCount() +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches ) +/// /// public string findFirstFile(string pattern, bool recurse = true){ @@ -3594,7 +4511,42 @@ public string findFirstFile(string pattern, bool recurse = true){ return m_ts.fn_findFirstFile(pattern, recurse); } /// -/// @brief Returns the first file in the directory system matching the given patterns. Use the corresponding findNextFileMultiExpr() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCountMultiExpr(). This function differs from findFirstFile() in that it supports multiple search patterns to be passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename patterns. @return String of the first matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findNextFileMultiExpr() @see getFileCountMultiExpr() @see findFirstFile() @ingroup FileSearches) +/// @brief Returns the first file in the directory system matching the given patterns. +/// +/// Use the corresponding findNextFileMultiExpr() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCountMultiExpr(). +/// +/// This function differs from findFirstFile() in that it supports multiple search patterns +/// to be passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename patterns. +/// @return String of the first matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findNextFileMultiExpr() +/// @see getFileCountMultiExpr() +/// @see findFirstFile() +/// @ingroup FileSearches) +/// /// public string findFirstFileMultiExpr(string pattern, bool recurse = true){ @@ -3602,7 +4554,22 @@ public string findFirstFileMultiExpr(string pattern, bool recurse = true){ return m_ts.fn_findFirstFileMultiExpr(pattern, recurse); } /// -/// ), @brief Returns the next file matching a search begun in findFirstFile(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return The path of the next filename matched by the search or an empty string if no more files match. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findFirstFile() @ingroup FileSearches ) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFile(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return The path of the next filename matched by the search or an empty string if no more files match. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @ingroup FileSearches ) +/// /// public string findNextFile(string pattern = ""){ @@ -3610,7 +4577,28 @@ public string findNextFile(string pattern = ""){ return m_ts.fn_findNextFile(pattern); } /// -/// ), @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return String of the next matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findFirstFileMultiExpr() @ingroup FileSearches) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return String of the next matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches) +/// /// public string findNextFileMultiExpr(string pattern = ""){ @@ -3618,7 +4606,16 @@ public string findNextFileMultiExpr(string pattern = ""){ return m_ts.fn_findNextFileMultiExpr(pattern); } /// -/// Return the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return The word at index 0 in @a text or \"\" if @a text is empty. @note This is equal to @tsexample_nopar getWord( text, 0 ) @endtsexample @see getWord @ingroup FieldManip ) +/// Return the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return The word at index 0 in @a text or \"\" if @a text is empty. +/// @note This is equal to +/// @tsexample_nopar +/// getWord( text, 0 ) +/// @endtsexample +/// @see getWord +/// @ingroup FieldManip ) +/// /// public string firstWord(string text){ @@ -3626,7 +4623,13 @@ public string firstWord(string text){ return m_ts.fn_firstWord(text); } /// -/// @brief Flags all currently allocated GFX resources. Used for resource allocation and leak tracking by flagging current resources then dumping a list of unflagged resources at some later point in execution. @ingroup GFX @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// @brief Flags all currently allocated GFX resources. +/// Used for resource allocation and leak tracking by flagging +/// current resources then dumping a list of unflagged resources +/// at some later point in execution. +/// @ingroup GFX +/// @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void flagCurrentGFXResources(){ @@ -3634,7 +4637,9 @@ public void flagCurrentGFXResources(){ m_ts.fn_flagCurrentGFXResources(); } /// -/// Releases all textures and resurrects the texture manager. @ingroup GFX ) +/// Releases all textures and resurrects the texture manager. +/// @ingroup GFX ) +/// /// public void flushTextureCache(){ @@ -3642,7 +4647,9 @@ public void flushTextureCache(){ m_ts.fn_flushTextureCache(); } /// -/// Returns the count of active DDSs files in memory. @ingroup Rendering ) +/// Returns the count of active DDSs files in memory. +/// @ingroup Rendering ) +/// /// public int getActiveDDSFiles(){ @@ -3650,7 +4657,9 @@ public int getActiveDDSFiles(){ return m_ts.fn_getActiveDDSFiles(); } /// -/// Returns the active light manager name. @ingroup Lighting ) +/// Returns the active light manager name. +/// @ingroup Lighting ) +/// /// public string getActiveLightManager(){ @@ -3658,7 +4667,9 @@ public string getActiveLightManager(){ return m_ts.fn_getActiveLightManager(); } /// -/// Get the version of the application build, as a string. @ingroup Debugging) +/// Get the version of the application build, as a string. +/// @ingroup Debugging) +/// /// public int getAppVersionNumber(){ @@ -3666,7 +4677,9 @@ public int getAppVersionNumber(){ return m_ts.fn_getAppVersionNumber(); } /// -/// Get the version of the aplication build, as a human readable string. @ingroup Debugging) +/// Get the version of the aplication build, as a human readable string. +/// @ingroup Debugging) +/// /// public string getAppVersionString(){ @@ -3674,7 +4687,9 @@ public string getAppVersionString(){ return m_ts.fn_getAppVersionString(); } /// -/// Returns the best texture format for storage of HDR data for the active device. @ingroup GFX ) +/// Returns the best texture format for storage of HDR data for the active device. +/// @ingroup GFX ) +/// /// public TypeGFXFormat getBestHDRFormat(){ @@ -3682,7 +4697,10 @@ public TypeGFXFormat getBestHDRFormat(){ return (TypeGFXFormat)( m_ts.fn_getBestHDRFormat()); } /// -/// Returns image info in the following format: width TAB height TAB bytesPerPixel. It will return an empty string if the file is not found. @ingroup Rendering ) +/// Returns image info in the following format: width TAB height TAB bytesPerPixel. +/// It will return an empty string if the file is not found. +/// @ingroup Rendering ) +/// /// public string getBitmapInfo(string filename){ @@ -3690,7 +4708,11 @@ public string getBitmapInfo(string filename){ return m_ts.fn_getBitmapInfo(filename); } /// -/// Get the center point of an axis-aligned box. @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" @return Center of the box. @ingroup Math) +/// Get the center point of an axis-aligned box. +/// @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" +/// @return Center of the box. +/// @ingroup Math) +/// /// public Point3F getBoxCenter(Box3F box){ @@ -3698,7 +4720,9 @@ public Point3F getBoxCenter(Box3F box){ return new Point3F ( m_ts.fn_getBoxCenter(box.AsString())); } /// -/// Get the type of build, \"Debug\" or \"Release\". @ingroup Debugging) +/// Get the type of build, \"Debug\" or \"Release\". +/// @ingroup Debugging) +/// /// public string getBuildString(){ @@ -3706,7 +4730,10 @@ public string getBuildString(){ return m_ts.fn_getBuildString(); } /// -/// @brief Returns the category of the given class. @param className The name of the class. @ingroup Console) +/// @brief Returns the category of the given class. +/// @param className The name of the class. +/// @ingroup Console) +/// /// public string getCategoryOfClass(string className){ @@ -3725,7 +4752,9 @@ public string getClipboard(){ return m_ts.fn_getClipboard(); } /// -/// Get the time of compilation. @ingroup Debugging) +/// Get the time of compilation. +/// @ingroup Debugging) +/// /// public string getCompileTimeString(){ @@ -3733,7 +4762,11 @@ public string getCompileTimeString(){ return m_ts.fn_getCompileTimeString(); } /// -/// () @brief Gets the primary LangTable used by the game @return ID of the core LangTable @ingroup Localization) +/// () +/// @brief Gets the primary LangTable used by the game +/// @return ID of the core LangTable +/// @ingroup Localization) +/// /// public int getCoreLangTable(){ @@ -3741,7 +4774,10 @@ public int getCoreLangTable(){ return m_ts.fn_getCoreLangTable(); } /// -/// @brief Returns the current %ActionMap. @see ActionMap @ingroup Input) +/// @brief Returns the current %ActionMap. +/// @see ActionMap +/// @ingroup Input) +/// /// public string getCurrentActionMap(){ @@ -3749,7 +4785,12 @@ public string getCurrentActionMap(){ return m_ts.fn_getCurrentActionMap(); } /// -/// @brief Return the current working directory. @return The absolute path of the current working directory. @note Only present in a Tools build of Torque. @see getWorkingDirectory() @ingroup FileSystem) +/// @brief Return the current working directory. +/// @return The absolute path of the current working directory. +/// @note Only present in a Tools build of Torque. +/// @see getWorkingDirectory() +/// @ingroup FileSystem) +/// /// public string getCurrentDirectory(){ @@ -3757,7 +4798,11 @@ public string getCurrentDirectory(){ return m_ts.fn_getCurrentDirectory(); } /// -/// @brief Returns the description string for the named class. @param className The name of the class. @return The class description in string format. @ingroup Console) +/// @brief Returns the description string for the named class. +/// @param className The name of the class. +/// @return The class description in string format. +/// @ingroup Console) +/// /// public string getDescriptionOfClass(string className){ @@ -3766,6 +4811,7 @@ public string getDescriptionOfClass(string className){ } /// /// Returns the width, height, and bitdepth of the screen/desktop.@ingroup GFX ) +/// /// public Point3F getDesktopResolution(){ @@ -3773,7 +4819,14 @@ public Point3F getDesktopResolution(){ return new Point3F ( m_ts.fn_getDesktopResolution()); } /// -/// @brief Gathers a list of directories starting at the given path. @param path String containing the path of the directory @param depth Depth of search, as in how many subdirectories to parse through @return Tab delimited string containing list of directories found during search, \"\" if no files were found @ingroup FileSystem) +/// @brief Gathers a list of directories starting at the given path. +/// +/// @param path String containing the path of the directory +/// @param depth Depth of search, as in how many subdirectories to parse through +/// @return Tab delimited string containing list of directories found during search, \"\" if no files were found +/// +/// @ingroup FileSystem) +/// /// public string getDirectoryList(string path, int depth = 0){ @@ -3781,7 +4834,9 @@ public string getDirectoryList(string path, int depth = 0){ return m_ts.fn_getDirectoryList(path, depth); } /// -/// Get the string describing the active GFX device. @ingroup GFX ) +/// Get the string describing the active GFX device. +/// @ingroup GFX ) +/// /// public string getDisplayDeviceInformation(){ @@ -3789,7 +4844,9 @@ public string getDisplayDeviceInformation(){ return m_ts.fn_getDisplayDeviceInformation(); } /// -/// Returns a tab-seperated string of the detected devices across all adapters. @ingroup GFX ) +/// Returns a tab-seperated string of the detected devices across all adapters. +/// @ingroup GFX ) +/// /// public string getDisplayDeviceList(){ @@ -3797,7 +4854,15 @@ public string getDisplayDeviceList(){ return m_ts.fn_getDisplayDeviceList(); } /// -/// Get the absolute path to the file in which the compiled code for the given script file will be stored. @param scriptFileName %Path to the .cs script file. @return The absolute path to the .dso file for the given script file. @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded from the current paths. @see compile @see getPrefsPath @ingroup Scripting ) +/// Get the absolute path to the file in which the compiled code for the given script file will be stored. +/// @param scriptFileName %Path to the .cs script file. +/// @return The absolute path to the .dso file for the given script file. +/// @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded +/// from the current paths. +/// @see compile +/// @see getPrefsPath +/// @ingroup Scripting ) +/// /// public string getDSOPath(string scriptFileName){ @@ -3805,7 +4870,9 @@ public string getDSOPath(string scriptFileName){ return m_ts.fn_getDSOPath(scriptFileName); } /// -/// Get the name of the engine product that this is running from, as a string. @ingroup Debugging) +/// Get the name of the engine product that this is running from, as a string. +/// @ingroup Debugging) +/// /// public string getEngineName(){ @@ -3814,6 +4881,7 @@ public string getEngineName(){ } /// /// getEventTimeLeft(scheduleId) Get the time left in ms until this event will trigger.) +/// /// public int getEventTimeLeft(int scheduleId){ @@ -3821,7 +4889,11 @@ public int getEventTimeLeft(int scheduleId){ return m_ts.fn_getEventTimeLeft(scheduleId); } /// -/// @brief Gets the name of the game's executable @return String containing this game's executable name @ingroup FileSystem) +/// @brief Gets the name of the game's executable +/// +/// @return String containing this game's executable name +/// @ingroup FileSystem) +/// /// public string getExecutableName(){ @@ -3829,7 +4901,9 @@ public string getExecutableName(){ return m_ts.fn_getExecutableName(); } /// -/// Gets the clients far clipping. ) +/// Gets the clients far clipping. +/// ) +/// /// public float getFarClippingDistance(){ @@ -3837,7 +4911,20 @@ public float getFarClippingDistance(){ return m_ts.fn_getFarClippingDistance(); } /// -/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to extract. @return The field at the given index or \"\" if the index is out of range. @tsexample getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getFields @see getFieldCount @see getWord @see getRecord @ingroup FieldManip ) +/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to extract. +/// @return The field at the given index or \"\" if the index is out of range. +/// @tsexample +/// getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getFields +/// @see getFieldCount +/// @see getWord +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string getField(string text, int index){ @@ -3845,7 +4932,16 @@ public string getField(string text, int index){ return m_ts.fn_getField(text, index); } /// -/// Return the number of newline and/or tab separated fields in @a text. @param text A list of fields separated by newlines and/or tabs. @return The number of newline and/or tab sepearated elements in @a text. @tsexample getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of newline and/or tab separated fields in @a text. +/// @param text A list of fields separated by newlines and/or tabs. +/// @return The number of newline and/or tab sepearated elements in @a text. +/// @tsexample +/// getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int getFieldCount(string text){ @@ -3853,7 +4949,23 @@ public int getFieldCount(string text){ return m_ts.fn_getFieldCount(text); } /// -/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param startIndex The zero-based index of the first field to extract from @a text. @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of fields from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" @endtsexample @see getField @see getFieldCount @see getWords @see getRecords @ingroup FieldManip ) +/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param startIndex The zero-based index of the first field to extract from @a text. +/// @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of fields from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see getFieldCount +/// @see getWords +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string getFields(string text, int startIndex, int endIndex = -1){ @@ -3861,7 +4973,29 @@ public string getFields(string text, int startIndex, int endIndex = -1){ return m_ts.fn_getFields(text, startIndex, endIndex); } /// -/// @brief Returns the number of files in the directory tree that match the given patterns This function differs from getFileCountMultiExpr() in that it supports a single search pattern being passed in. If you're interested in a list of files that match the given pattern and not just the number of files, use findFirstFile() and findNextFile(). @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern counting files in subdirectories. @return Number of files located using the pattern @tsexample // Count the number of .cs files in a subdirectory and its subdirectories. getFileCount( \"subdirectory/*.cs\" ); @endtsexample @see findFirstFile() @see findNextFile() @see getFileCountMultiExpr() @ingroup FileSearches ) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// This function differs from getFileCountMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// If you're interested in a list of files that match the given pattern and not just +/// the number of files, use findFirstFile() and findNextFile(). +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern +/// counting files in subdirectories. +/// @return Number of files located using the pattern +/// +/// @tsexample +/// // Count the number of .cs files in a subdirectory and its subdirectories. +/// getFileCount( \"subdirectory/*.cs\" ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @see findNextFile() +/// @see getFileCountMultiExpr() +/// @ingroup FileSearches ) +/// /// public int getFileCount(string pattern, bool recurse = true){ @@ -3869,7 +5003,27 @@ public int getFileCount(string pattern, bool recurse = true){ return m_ts.fn_getFileCount(pattern, recurse); } /// -/// @brief Returns the number of files in the directory tree that match the given patterns If you're interested in a list of files that match the given patterns and not just the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return Number of files located using the patterns @tsexample // Count all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); @endtsexample @see findFirstFileMultiExpr() @see findNextFileMultiExpr() @ingroup FileSearches) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// If you're interested in a list of files that match the given patterns and not just +/// the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename pattern. +/// @return Number of files located using the patterns +/// +/// @tsexample +/// // Count all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @see findNextFileMultiExpr() +/// @ingroup FileSearches) +/// /// public int getFileCountMultiExpr(string pattern, bool recurse = true){ @@ -3877,7 +5031,14 @@ public int getFileCountMultiExpr(string pattern, bool recurse = true){ return m_ts.fn_getFileCountMultiExpr(pattern, recurse); } /// -/// @brief Provides the CRC checksum of the given file. @param fileName The path to the file. @return The calculated CRC checksum of the file, or -1 if the file could not be found. @ingroup FileSystem) +/// @brief Provides the CRC checksum of the given file. +/// +/// @param fileName The path to the file. +/// @return The calculated CRC checksum of the file, or -1 if the file +/// could not be found. +/// +/// @ingroup FileSystem) +/// /// public int getFileCRC(string fileName){ @@ -3885,7 +5046,28 @@ public int getFileCRC(string fileName){ return m_ts.fn_getFileCRC(fileName); } /// +/// Returns a list of supported shape format extensions separated by tabs. +/// Example output: *.dsq TAB *.dae TAB) +/// +/// +public string getFormatExtensions(){ + + +return m_ts.fn_getFormatExtensions(); +} +/// +/// Returns a list of supported shape formats in filter form. +/// Example output: DSQ Files|*.dsq|COLLADA Files|*.dae|) +/// +/// +public string getFormatFilters(){ + + +return m_ts.fn_getFormatFilters(); +} +/// /// @brief .) +/// /// public Point4F getFrustumOffset(){ @@ -3893,7 +5075,12 @@ public Point4F getFrustumOffset(){ return new Point4F ( m_ts.fn_getFrustumOffset()); } /// -/// (string funcName) @brief Provides the name of the package the function belongs to @param funcName String containing name of the function @return The name of the function's package @ingroup Packages) +/// (string funcName) +/// @brief Provides the name of the package the function belongs to +/// @param funcName String containing name of the function +/// @return The name of the function's package +/// @ingroup Packages) +/// /// public string getFunctionPackage(string funcName){ @@ -3902,6 +5089,7 @@ public string getFunctionPackage(string funcName){ } /// /// getJoystickAxes( instance )) +/// /// public string getJoystickAxes(uint deviceID){ @@ -3909,7 +5097,9 @@ public string getJoystickAxes(uint deviceID){ return m_ts.fn_getJoystickAxes(deviceID); } /// -/// Returns a tab seperated list of light manager names. @ingroup Lighting ) +/// Returns a tab seperated list of light manager names. +/// @ingroup Lighting ) +/// /// public string getLightManagerNames(){ @@ -3917,7 +5107,13 @@ public string getLightManagerNames(){ return m_ts.fn_getLightManagerNames(); } /// -/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. This directory will usually contain all the game assets and, in a user-side game installation, will usually be read-only. @return The path to the main game assets. @ingroup FileSystem) +/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. +/// +/// This directory will usually contain all the game assets and, in a user-side game installation, will usually be +/// read-only. +/// @return The path to the main game assets. +/// @ingroup FileSystem) +/// /// public string getMainDotCsDir(){ @@ -3926,6 +5122,7 @@ public string getMainDotCsDir(){ } /// /// @hide) +/// /// public string getMapEntry(string texName){ @@ -3933,7 +5130,12 @@ public string getMapEntry(string texName){ return m_ts.fn_getMapEntry(texName); } /// -/// (string texName) @brief Returns the name of the material mapped to this texture. If no materials are found, an empty string is returned. @param texName Name of the texture @ingroup Materials) +/// (string texName) +/// @brief Returns the name of the material mapped to this texture. +/// If no materials are found, an empty string is returned. +/// @param texName Name of the texture +/// @ingroup Materials) +/// /// public string getMaterialMapping(string texName){ @@ -3941,7 +5143,12 @@ public string getMaterialMapping(string texName){ return m_ts.fn_getMaterialMapping(texName); } /// -/// Calculate the greater of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The greater value of the two specified values. @ingroup Math ) +/// Calculate the greater of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The greater value of the two specified values. +/// @ingroup Math ) +/// /// public float getMax(float v1, float v2){ @@ -3950,6 +5157,7 @@ public float getMax(float v1, float v2){ } /// /// getMaxFrameAllocation(); ) +/// /// public int getMaxFrameAllocation(){ @@ -3957,7 +5165,13 @@ public int getMaxFrameAllocation(){ return m_ts.fn_getMaxFrameAllocation(); } /// -/// (string namespace, string method) @brief Provides the name of the package the method belongs to @param namespace Class or namespace, such as Player @param method Name of the funciton to search for @return The name of the method's package @ingroup Packages) +/// (string namespace, string method) +/// @brief Provides the name of the package the method belongs to +/// @param namespace Class or namespace, such as Player +/// @param method Name of the funciton to search for +/// @return The name of the method's package +/// @ingroup Packages) +/// /// public string getMethodPackage(string nameSpace, string method){ @@ -3965,7 +5179,12 @@ public string getMethodPackage(string nameSpace, string method){ return m_ts.fn_getMethodPackage(nameSpace, method); } /// -/// Calculate the lesser of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The lesser value of the two specified values. @ingroup Math ) +/// Calculate the lesser of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The lesser value of the two specified values. +/// @ingroup Math ) +/// /// public float getMin(float v1, float v2){ @@ -3973,7 +5192,9 @@ public float getMin(float v1, float v2){ return m_ts.fn_getMin(v1, v2); } /// -/// Get the MissionArea object, if any. @ingroup enviroMisc) +/// Get the MissionArea object, if any. +/// @ingroup enviroMisc) +/// /// public string getMissionAreaServerObject(){ @@ -3981,7 +5202,12 @@ public string getMissionAreaServerObject(){ return m_ts.fn_getMissionAreaServerObject(); } /// -/// (string path) @brief Attempts to extract a mod directory from path. Returns empty string on failure. @param File path of mod folder @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated @internal) +/// (string path) +/// @brief Attempts to extract a mod directory from path. Returns empty string on failure. +/// @param File path of mod folder +/// @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated +/// @internal) +/// /// public string getModNameFromPath(string path){ @@ -4008,7 +5234,9 @@ public string getPackageList(){ return m_ts.fn_getPackageList(); } /// -/// Returns the pixel shader version for the active device. @ingroup GFX ) +/// Returns the pixel shader version for the active device. +/// @ingroup GFX ) +/// /// public float getPixelShaderVersion(){ @@ -4016,7 +5244,10 @@ public float getPixelShaderVersion(){ return m_ts.fn_getPixelShaderVersion(); } /// -/// ([relativeFileName]) @note Appears to be useless in Torque 3D, should be deprecated @internal) +/// ([relativeFileName]) +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @internal) +/// /// public string getPrefsPath(string relativeFileName){ @@ -4024,7 +5255,19 @@ public string getPrefsPath(string relativeFileName){ return m_ts.fn_getPrefsPath(relativeFileName); } /// -/// ( int a, int b ) @brief Returns a random number based on parameters passed in.. If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will return an integer between the specified numbers. @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. @param b Upper bound on the random number. The random number will be = @a b. @return A pseudo-random integer between @a a and @a b, between 0 and a, or a float between 0.0 and 1.1 depending on usage. @note All parameters are optional. @see setRandomSeed @ingroup Random ) +/// ( int a, int b ) +/// @brief Returns a random number based on parameters passed in.. +/// If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one +/// parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will +/// return an integer between the specified numbers. +/// @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. +/// @param b Upper bound on the random number. The random number will be = @a b. +/// @return A pseudo-random integer between @a a and @a b, between 0 and a, or a +/// float between 0.0 and 1.1 depending on usage. +/// @note All parameters are optional. +/// @see setRandomSeed +/// @ingroup Random ) +/// /// public float getRandom(int a = 1, int b = 0){ @@ -4032,7 +5275,10 @@ public float getRandom(int a = 1, int b = 0){ return m_ts.fn_getRandom(a, b); } /// -/// Get the current seed used by the random number generator. @return The current random number generator seed value. @ingroup Random ) +/// Get the current seed used by the random number generator. +/// @return The current random number generator seed value. +/// @ingroup Random ) +/// /// public int getRandomSeed(){ @@ -4040,7 +5286,11 @@ public int getRandomSeed(){ return m_ts.fn_getRandomSeed(); } /// -/// () @brief Return the current real time in milliseconds. Real time is platform defined; typically time since the computer booted. @ingroup Platform) +/// () +/// @brief Return the current real time in milliseconds. +/// Real time is platform defined; typically time since the computer booted. +/// @ingroup Platform) +/// /// public int getRealTime(){ @@ -4048,7 +5298,20 @@ public int getRealTime(){ return m_ts.fn_getRealTime(); } /// -/// Extract the record at the given @a index in the newline-separated list in @a text. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to extract. @return The record at the given index or \"\" if @a index is out of range. @tsexample getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getRecords @see getRecordCount @see getWord @see getField @ingroup FieldManip ) +/// Extract the record at the given @a index in the newline-separated list in @a text. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to extract. +/// @return The record at the given index or \"\" if @a index is out of range. +/// @tsexample +/// getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getRecords +/// @see getRecordCount +/// @see getWord +/// @see getField +/// @ingroup FieldManip ) +/// /// public string getRecord(string text, int index){ @@ -4056,7 +5319,16 @@ public string getRecord(string text, int index){ return m_ts.fn_getRecord(text, index); } /// -/// Return the number of newline-separated records in @a text. @param text A list of records separated by newlines. @return The number of newline-sepearated elements in @a text. @tsexample getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getFieldCount @ingroup FieldManip ) +/// Return the number of newline-separated records in @a text. +/// @param text A list of records separated by newlines. +/// @return The number of newline-sepearated elements in @a text. +/// @tsexample +/// getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getFieldCount +/// @ingroup FieldManip ) +/// /// public int getRecordCount(string text){ @@ -4064,7 +5336,23 @@ public int getRecordCount(string text){ return m_ts.fn_getRecordCount(text); } /// -/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param startIndex The zero-based index of the first record to extract from @a text. @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of records from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" @endtsexample @see getRecord @see getRecordCount @see getWords @see getFields @ingroup FieldManip ) +/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param startIndex The zero-based index of the first record to extract from @a text. +/// @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of records from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see getRecordCount +/// @see getWords +/// @see getFields +/// @ingroup FieldManip ) +/// /// public string getRecords(string text, int startIndex, int endIndex = -1){ @@ -4073,6 +5361,7 @@ public string getRecords(string text, int startIndex, int endIndex = -1){ } /// /// getScheduleDuration(%scheduleId); ) +/// /// public int getScheduleDuration(int scheduleId){ @@ -4081,6 +5370,7 @@ public int getScheduleDuration(int scheduleId){ } /// /// getServerCount(...); ) +/// /// public int getServerCount(){ @@ -4088,7 +5378,11 @@ public int getServerCount(){ return m_ts.fn_getServerCount(); } /// -/// () Return the current sim time in milliseconds. @brief Sim time is time since the game started. @ingroup Platform) +/// () +/// Return the current sim time in milliseconds. +/// @brief Sim time is time since the game started. +/// @ingroup Platform) +/// /// public int getSimTime(){ @@ -4096,7 +5390,19 @@ public int getSimTime(){ return m_ts.fn_getSimTime(); } /// -/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source string length). @param str The string from which to extract a substring. @param start The offset at which to start copying out characters. @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end of the input string are copied. @return A string that contains the given portion of the input string. @tsexample getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". @endtsexample @ingroup Strings ) +/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str +/// (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source +/// string length). +/// @param str The string from which to extract a substring. +/// @param start The offset at which to start copying out characters. +/// @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end +/// of the input string are copied. +/// @return A string that contains the given portion of the input string. +/// @tsexample +/// getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string getSubStr(string str, int start, int numChars = -1){ @@ -4104,7 +5410,20 @@ public string getSubStr(string str, int start, int numChars = -1){ return m_ts.fn_getSubStr(str, start, numChars); } /// -/// ( string textTagString ) @brief Extracts the tag from a tagged string Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. @param textTagString The tagged string to extract. @returns The tag ID of the string. @see \\ref syntaxDataTypes under Tagged %Strings @see detag() @ingroup Networking) +/// ( string textTagString ) +/// @brief Extracts the tag from a tagged string +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. +/// +/// @param textTagString The tagged string to extract. +/// +/// @returns The tag ID of the string. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see detag() +/// @ingroup Networking) +/// /// public string getTag(string textTagString){ @@ -4112,7 +5431,22 @@ public string getTag(string textTagString){ return m_ts.fn_getTag(textTagString); } /// -/// ), @brief Use the getTaggedString function to convert a tag to a string. This is not the same as detag() which can only be used within the context of a function that receives a tag. This function can be used any time and anywhere to convert a tag to a string. @param tag A numeric tag ID. @returns The string as found in the Net String table. @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see removeTaggedString() @ingroup Networking) +/// ), +/// @brief Use the getTaggedString function to convert a tag to a string. +/// +/// This is not the same as detag() which can only be used within the context +/// of a function that receives a tag. This function can be used any time and +/// anywhere to convert a tag to a string. +/// +/// @param tag A numeric tag ID. +/// +/// @returns The string as found in the Net String table. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see removeTaggedString() +/// @ingroup Networking) +/// /// public string getTaggedString(string tag = ""){ @@ -4120,7 +5454,16 @@ public string getTaggedString(string tag = ""){ return m_ts.fn_getTaggedString(tag); } /// -/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example @note This can be useful to adhering to OS standards and practices, but not really used in Torque 3D right now. @note Be very careful when getting into OS level File I/O. @return String containing path to OS temp directory @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example +/// @note This can be useful to adhering to OS standards and practices, +/// but not really used in Torque 3D right now. +/// @note Be very careful when getting into OS level File I/O. +/// @return String containing path to OS temp directory +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string getTemporaryDirectory(){ @@ -4128,7 +5471,14 @@ public string getTemporaryDirectory(){ return m_ts.fn_getTemporaryDirectory(); } /// -/// @brief Creates a name and extension for a potential temporary file This does not create the actual file. It simply creates a random name for a file that does not exist. @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Creates a name and extension for a potential temporary file +/// This does not create the actual file. It simply creates a random name +/// for a file that does not exist. +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string getTemporaryFileName(){ @@ -4136,7 +5486,11 @@ public string getTemporaryFileName(){ return m_ts.fn_getTemporaryFileName(); } /// -/// (Point2 pos) - gets the terrain height at the specified position. @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point2 pos) - gets the terrain height at the specified position. +/// @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float getTerrainHeight(Point2F pos){ @@ -4144,7 +5498,12 @@ public float getTerrainHeight(Point2F pos){ return m_ts.fn_getTerrainHeight(pos.AsString()); } /// -/// (Point3F pos) - gets the terrain height at the specified position. @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) @note This function is useful if you simply want to grab the terrain height underneath an object. @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point3F pos) - gets the terrain height at the specified position. +/// @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) +/// @note This function is useful if you simply want to grab the terrain height underneath an object. +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float getTerrainHeightBelowPosition(Point3F pos){ @@ -4152,7 +5511,12 @@ public float getTerrainHeightBelowPosition(Point3F pos){ return m_ts.fn_getTerrainHeightBelowPosition(pos.AsString()); } /// -/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found). @hide) +/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found). +/// @hide) +/// /// public int getTerrainUnderWorldPoint(Point3F position){ @@ -4160,7 +5524,9 @@ public int getTerrainUnderWorldPoint(Point3F position){ return m_ts.fn_getTerrainUnderWorldPoint(position.AsString()); } /// -/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB @ingroup GFX ) +/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB +/// @ingroup GFX ) +/// /// public string getTextureProfileStats(){ @@ -4169,6 +5535,7 @@ public string getTextureProfileStats(){ } /// /// getTimeSinceStart(%scheduleId); ) +/// /// public int getTimeSinceStart(int scheduleId){ @@ -4176,7 +5543,15 @@ public int getTimeSinceStart(int scheduleId){ return m_ts.fn_getTimeSinceStart(scheduleId); } /// -/// Get the numeric suffix of the given input string. @param str The string from which to read out the numeric suffix. @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. @tsexample getTrailingNumber( \"test123\" ) // Returns '123'. @endtsexample @see stripTrailingNumber @ingroup Strings ) +/// Get the numeric suffix of the given input string. +/// @param str The string from which to read out the numeric suffix. +/// @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. +/// @tsexample +/// getTrailingNumber( \"test123\" ) // Returns '123'. +/// @endtsexample +/// @see stripTrailingNumber +/// @ingroup Strings ) +/// /// public int getTrailingNumber(string str){ @@ -4184,7 +5559,12 @@ public int getTrailingNumber(string str){ return m_ts.fn_getTrailingNumber(str); } /// -/// ( String baseName, SimSet set, bool searchChildren ) @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName, SimSet set, bool searchChildren ) +/// @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string getUniqueInternalName(string baseName, string setString, bool searchChildren){ @@ -4192,7 +5572,13 @@ public string getUniqueInternalName(string baseName, string setString, bool sea return m_ts.fn_getUniqueInternalName(baseName, setString, searchChildren); } /// -/// ( String baseName ) @brief Returns a unique unused SimObject name based on a given base name. @baseName Name to conver to a unique string if another instance exists @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName ) +/// @brief Returns a unique unused SimObject name based on a given base name. +/// @baseName Name to conver to a unique string if another instance exists +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string getUniqueName(string baseName){ @@ -4201,6 +5587,7 @@ public string getUniqueName(string baseName){ } /// /// getUserDataDirectory()) +/// /// public string getUserDataDirectory(){ @@ -4209,6 +5596,7 @@ public string getUserDataDirectory(){ } /// /// getUserHomeDirectory()) +/// /// public string getUserHomeDirectory(){ @@ -4216,7 +5604,12 @@ public string getUserHomeDirectory(){ return m_ts.fn_getUserHomeDirectory(); } /// -/// (string varName) @brief Returns the value of the named variable or an empty string if not found. @varName Name of the variable to search for @return Value contained by varName, \"\" if the variable does not exist @ingroup Scripting) +/// (string varName) +/// @brief Returns the value of the named variable or an empty string if not found. +/// @varName Name of the variable to search for +/// @return Value contained by varName, \"\" if the variable does not exist +/// @ingroup Scripting) +/// /// public string getVariable(string varName){ @@ -4224,7 +5617,9 @@ public string getVariable(string varName){ return m_ts.fn_getVariable(varName); } /// -/// Get the version of the engine build, as a string. @ingroup Debugging) +/// Get the version of the engine build, as a string. +/// @ingroup Debugging) +/// /// public int getVersionNumber(){ @@ -4232,7 +5627,9 @@ public int getVersionNumber(){ return m_ts.fn_getVersionNumber(); } /// -/// Get the version of the engine build, as a human readable string. @ingroup Debugging) +/// Get the version of the engine build, as a human readable string. +/// @ingroup Debugging) +/// /// public string getVersionString(){ @@ -4240,7 +5637,12 @@ public string getVersionString(){ return m_ts.fn_getVersionString(); } /// -/// Test whether Torque is running in web-deployment mode. In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not be able to enter fullscreen exclusive mode). @return True if Torque is running in web-deployment mode. @ingroup Platform ) +/// Test whether Torque is running in web-deployment mode. +/// In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not +/// be able to enter fullscreen exclusive mode). +/// @return True if Torque is running in web-deployment mode. +/// @ingroup Platform ) +/// /// public bool getWebDeployment(){ @@ -4248,7 +5650,20 @@ public bool getWebDeployment(){ return m_ts.fn_getWebDeployment(); } /// -/// Extract the word at the given @a index in the whitespace-separated list in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to extract. @return The word at the given index or \"\" if the index is out of range. @tsexample getWord( \"a b c\", 1 ) // Returns \"b\" @endtsexample @see getWords @see getWordCount @see getField @see getRecord @ingroup FieldManip ) +/// Extract the word at the given @a index in the whitespace-separated list in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to extract. +/// @return The word at the given index or \"\" if the index is out of range. +/// @tsexample +/// getWord( \"a b c\", 1 ) // Returns \"b\" +/// @endtsexample +/// @see getWords +/// @see getWordCount +/// @see getField +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string getWord(string text, int index){ @@ -4256,7 +5671,17 @@ public string getWord(string text, int index){ return m_ts.fn_getWord(text, index); } /// -/// Return the number of whitespace-separated words in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @return The number of whitespace-separated words in @a text. @tsexample getWordCount( \"a b c d e\" ) // Returns 5 @endtsexample @see getFieldCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of whitespace-separated words in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @return The number of whitespace-separated words in @a text. +/// @tsexample +/// getWordCount( \"a b c d e\" ) // Returns 5 +/// @endtsexample +/// @see getFieldCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int getWordCount(string text){ @@ -4264,7 +5689,23 @@ public int getWordCount(string text){ return m_ts.fn_getWordCount(text); } /// -/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param startIndex The zero-based index of the first word to extract from @a text. @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of words from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" @endtsexample @see getWord @see getWordCount @see getFields @see getRecords @ingroup FieldManip ) +/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param startIndex The zero-based index of the first word to extract from @a text. +/// @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of words from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" +/// @endtsexample +/// @see getWord +/// @see getWordCount +/// @see getFields +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string getWords(string text, int startIndex, int endIndex = -1){ @@ -4272,7 +5713,11 @@ public string getWords(string text, int startIndex, int endIndex = -1){ return m_ts.fn_getWords(text, startIndex, endIndex); } /// -/// @brief Reports the current directory @return String containing full file path of working directory @ingroup FileSystem) +/// @brief Reports the current directory +/// +/// @return String containing full file path of working directory +/// @ingroup FileSystem) +/// /// public string getWorkingDirectory(){ @@ -4280,7 +5725,25 @@ public string getWorkingDirectory(){ return m_ts.fn_getWorkingDirectory(); } /// -/// ( int controllerID, string property, bool currentD ) @brief Queries the current state of a connected Xbox 360 controller. XInput Properties: - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. - XI_START, XI_BACK - The Start and Back buttons. - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. @param controllerID Zero-based index of the controller to return information about. @param property Name of input action being queried, such as \"XI_THUMBLX\". @param current True checks current device in action. @return Button queried - 1 if the button is pressed, 0 if it's not. @return Thumbstick queried - Int representing displacement from rest position. @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. @ingroup Input) +/// ( int controllerID, string property, bool currentD ) +/// @brief Queries the current state of a connected Xbox 360 controller. +/// XInput Properties: +/// - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. +/// - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. +/// - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. +/// - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. +/// - XI_START, XI_BACK - The Start and Back buttons. +/// - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. +/// - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. +/// - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. +/// @param controllerID Zero-based index of the controller to return information about. +/// @param property Name of input action being queried, such as \"XI_THUMBLX\". +/// @param current True checks current device in action. +/// @return Button queried - 1 if the button is pressed, 0 if it's not. +/// @return Thumbstick queried - Int representing displacement from rest position. +/// @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. +/// @ingroup Input) +/// /// public int getXInputState(int controllerID, string properties, bool current = false){ @@ -4288,7 +5751,15 @@ public int getXInputState(int controllerID, string properties, bool current = f return m_ts.fn_getXInputState(controllerID, properties, current); } /// -/// Open the given URL or file in the user's web browser. @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then the function checks whether the address refers to a file or directory and if so, prepends \"file://\" to @a adress; if the file check fails, \"http://\" is prepended to @a address. @tsexample gotoWebPage( \"http://www.garagegames.com\" ); @endtsexample @ingroup Platform ) +/// Open the given URL or file in the user's web browser. +/// @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then +/// the function checks whether the address refers to a file or directory and if so, prepends \"file://\" +/// to @a adress; if the file check fails, \"http://\" is prepended to @a address. +/// @tsexample +/// gotoWebPage( \"http://www.garagegames.com\" ); +/// @endtsexample +/// @ingroup Platform ) +/// /// public void gotoWebPage(string address){ @@ -4296,7 +5767,15 @@ public void gotoWebPage(string address){ m_ts.fn_gotoWebPage(address); } /// -/// Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the input PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Import an image strip from exportCachedFont. Call with the +/// same parameters you called exportCachedFont. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the input PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void importCachedFont(string faceName, int fontSize, string fileName, int padding, int kerning){ @@ -4304,7 +5783,17 @@ public void importCachedFont(string faceName, int fontSize, string fileName, in m_ts.fn_importCachedFont(faceName, fontSize, fileName, padding, kerning); } /// -/// @brief Start a search for items at the given position and within the given radius, filtering by mask. @param pos Center position for the search @param radius Search radius @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for items at the given position and within the given radius, filtering by mask. +/// +/// @param pos Center position for the search +/// @param radius Search radius +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void initContainerRadiusSearch(Point3F pos, float radius, uint mask, bool useClientContainer = false){ @@ -4312,7 +5801,15 @@ public void initContainerRadiusSearch(Point3F pos, float radius, uint mask, boo m_ts.fn_initContainerRadiusSearch(pos.AsString(), radius, mask, useClientContainer); } /// -/// @brief Start a search for all items of the types specified by the bitset mask. @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for all items of the types specified by the bitset mask. +/// +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void initContainerTypeSearch(uint mask, bool useClientContainer = false){ @@ -4320,7 +5817,10 @@ public void initContainerTypeSearch(uint mask, bool useClientContainer = false) m_ts.fn_initContainerTypeSearch(mask, useClientContainer); } /// -/// () @brief Initializes variables that track device and vendor information/IDs @ingroup Rendering) +/// () +/// @brief Initializes variables that track device and vendor information/IDs +/// @ingroup Rendering) +/// /// public void initDisplayDeviceInfo(){ @@ -4328,7 +5828,14 @@ public void initDisplayDeviceInfo(){ m_ts.fn_initDisplayDeviceInfo(); } /// -/// Test whether the character at the given position is an alpha-numeric character. Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. @see isspace @ingroup Strings ) +/// Test whether the character at the given position is an alpha-numeric character. +/// Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. +/// @see isspace +/// @ingroup Strings ) +/// /// public bool isalnum(string str, int index){ @@ -4336,7 +5843,9 @@ public bool isalnum(string str, int index){ return m_ts.fn_isalnum(str, index); } /// -/// @brief Returns true if the passed identifier is the name of a declared class. @ingroup Console) +/// @brief Returns true if the passed identifier is the name of a declared class. +/// @ingroup Console) +/// /// public bool isClass(string identifier){ @@ -4344,7 +5853,10 @@ public bool isClass(string identifier){ return m_ts.fn_isClass(identifier); } /// -/// () Returns true if the calling script is a tools script. @hide) +/// () +/// Returns true if the calling script is a tools script. +/// @hide) +/// /// public bool isCurrentScriptToolScript(){ @@ -4352,7 +5864,10 @@ public bool isCurrentScriptToolScript(){ return m_ts.fn_isCurrentScriptToolScript(); } /// -/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. @return True if this is a debug build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. +/// @return True if this is a debug build; false otherwise. +/// @ingroup Platform ) +/// /// public bool isDebugBuild(){ @@ -4360,7 +5875,15 @@ public bool isDebugBuild(){ return m_ts.fn_isDebugBuild(); } /// -/// ) , (string varName) @brief Determines if a variable exists and contains a value @param varName Name of the variable to search for @return True if the variable was defined in script, false if not @tsexample isDefined( \"$myVar\" ); @endtsexample @ingroup Scripting) +/// ) , (string varName) +/// @brief Determines if a variable exists and contains a value +/// @param varName Name of the variable to search for +/// @return True if the variable was defined in script, false if not +/// @tsexample +/// isDefined( \"$myVar\" ); +/// @endtsexample +/// @ingroup Scripting) +/// /// public bool isDefined(string varName, string varValue = ""){ @@ -4369,6 +5892,7 @@ public bool isDefined(string varName, string varValue = ""){ } /// /// ) +/// /// public bool isDemo(){ @@ -4376,7 +5900,15 @@ public bool isDemo(){ return m_ts.fn_isDemo(); } /// -/// @brief Determines if a specified directory exists or not @param directory String containing path in the form of \"foo/bar\" @return Returns true if the directory was found. @note Do not include a trailing slash '/'. @ingroup FileSystem) +/// @brief Determines if a specified directory exists or not +/// +/// @param directory String containing path in the form of \"foo/bar\" +/// @return Returns true if the directory was found. +/// +/// @note Do not include a trailing slash '/'. +/// +/// @ingroup FileSystem) +/// /// public bool IsDirectory(string directory){ @@ -4385,6 +5917,7 @@ public bool IsDirectory(string directory){ } /// /// isEventPending(%scheduleId);) +/// /// public bool isEventPending(int scheduleId){ @@ -4392,7 +5925,13 @@ public bool isEventPending(int scheduleId){ return m_ts.fn_isEventPending(scheduleId); } /// -/// @brief Determines if the specified file exists or not @param fileName The path to the file. @return Returns true if the file was found. @ingroup FileSystem) +/// @brief Determines if the specified file exists or not +/// +/// @param fileName The path to the file. +/// @return Returns true if the file was found. +/// +/// @ingroup FileSystem) +/// /// public bool isFile(string fileName){ @@ -4400,7 +5939,12 @@ public bool isFile(string fileName){ return m_ts.fn_isFile(fileName); } /// -/// (string funcName) @brief Determines if a function exists or not @param funcName String containing name of the function @return True if the function exists, false if not @ingroup Scripting) +/// (string funcName) +/// @brief Determines if a function exists or not +/// @param funcName String containing name of the function +/// @return True if the function exists, false if not +/// @ingroup Scripting) +/// /// public bool isFunction(string funcName){ @@ -4409,6 +5953,7 @@ public bool isFunction(string funcName){ } /// /// isJoystickDetected()) +/// /// public bool isJoystickDetected(){ @@ -4416,7 +5961,11 @@ public bool isJoystickDetected(){ return m_ts.fn_isJoystickDetected(); } /// -/// () @brief Queries input manager to see if a joystick is enabled @return 1 if a joystick exists and is enabled, 0 if it's not. @ingroup Input) +/// () +/// @brief Queries input manager to see if a joystick is enabled +/// @return 1 if a joystick exists and is enabled, 0 if it's not. +/// @ingroup Input) +/// /// public bool isJoystickEnabled(){ @@ -4425,6 +5974,7 @@ public bool isJoystickEnabled(){ } /// /// isKoreanBuild()) +/// /// public bool isKoreanBuild(){ @@ -4432,7 +5982,12 @@ public bool isKoreanBuild(){ return m_ts.fn_isKoreanBuild(); } /// -/// @brief Returns true if the class is derived from the super class. If either class doesn't exist this returns false. @param className The class name. @param superClassName The super class to look for. @ingroup Console) +/// @brief Returns true if the class is derived from the super class. +/// If either class doesn't exist this returns false. +/// @param className The class name. +/// @param superClassName The super class to look for. +/// @ingroup Console) +/// /// public bool isMemberOfClass(string className, string superClassName){ @@ -4440,7 +5995,13 @@ public bool isMemberOfClass(string className, string superClassName){ return m_ts.fn_isMemberOfClass(className, superClassName); } /// -/// (string namespace, string method) @brief Determines if a class/namespace method exists @param namespace Class or namespace, such as Player @param method Name of the function to search for @return True if the method exists, false if not @ingroup Scripting) +/// (string namespace, string method) +/// @brief Determines if a class/namespace method exists +/// @param namespace Class or namespace, such as Player +/// @param method Name of the function to search for +/// @return True if the method exists, false if not +/// @ingroup Scripting) +/// /// public bool isMethod(string nameSpace, string method){ @@ -4449,6 +6010,7 @@ public bool isMethod(string nameSpace, string method){ } /// /// isObject(object)) +/// /// public bool isObject(string objectName){ @@ -4466,7 +6028,11 @@ public bool isPackage(string identifier){ return m_ts.fn_isPackage(identifier); } /// -/// (string queueName) @brief Determines if a dispatcher queue exists @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Determines if a dispatcher queue exists +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public bool isQueueRegistered(string queueName){ @@ -4474,7 +6040,10 @@ public bool isQueueRegistered(string queueName){ return m_ts.fn_isQueueRegistered(queueName); } /// -/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. @return True if this is a shipping build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. +/// @return True if this is a shipping build; false otherwise. +/// @ingroup Platform ) +/// /// public bool isShippingBuild(){ @@ -4482,7 +6051,14 @@ public bool isShippingBuild(){ return m_ts.fn_isShippingBuild(); } /// -/// Test whether the character at the given position is a whitespace character. Characters such as tab, space, or newline are considered whitespace. @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is a whitespace character; false otherwise. @see isalnum @ingroup Strings ) +/// Test whether the character at the given position is a whitespace character. +/// Characters such as tab, space, or newline are considered whitespace. +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is a whitespace character; false otherwise. +/// @see isalnum +/// @ingroup Strings ) +/// /// public bool isspace(string str, int index){ @@ -4490,7 +6066,10 @@ public bool isspace(string str, int index){ return m_ts.fn_isspace(str, index); } /// -/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. @return True if this is a tool build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. +/// @return True if this is a tool build; false otherwise. +/// @ingroup Platform ) +/// /// public bool isToolBuild(){ @@ -4498,7 +6077,12 @@ public bool isToolBuild(){ return m_ts.fn_isToolBuild(); } /// -/// ( string name ) @brief Return true if the given name makes for a valid object name. @param name Name of object @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character @ingroup Console) +/// ( string name ) +/// @brief Return true if the given name makes for a valid object name. +/// @param name Name of object +/// @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character +/// @ingroup Console) +/// /// public bool isValidObjectName(string name){ @@ -4507,6 +6091,7 @@ public bool isValidObjectName(string name){ } /// /// ) +/// /// public bool isWebDemo(){ @@ -4514,7 +6099,13 @@ public bool isWebDemo(){ return m_ts.fn_isWebDemo(); } /// -/// @brief Determines if a file name can be written to using File I/O @param fileName Name and path of file to check @return Returns true if the file can be written to. @ingroup FileSystem) +/// @brief Determines if a file name can be written to using File I/O +/// +/// @param fileName Name and path of file to check +/// @return Returns true if the file can be written to. +/// +/// @ingroup FileSystem) +/// /// public bool isWriteableFileName(string fileName){ @@ -4522,7 +6113,13 @@ public bool isWriteableFileName(string fileName){ return m_ts.fn_isWriteableFileName(fileName); } /// -/// ( int controllerID ) @brief Checks to see if an Xbox 360 controller is connected @param controllerID Zero-based index of the controller to check. @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput hasn't been initialized. @ingroup Input) +/// ( int controllerID ) +/// @brief Checks to see if an Xbox 360 controller is connected +/// @param controllerID Zero-based index of the controller to check. +/// @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput +/// hasn't been initialized. +/// @ingroup Input) +/// /// public bool isXInputConnected(int controllerID){ @@ -4530,7 +6127,15 @@ public bool isXInputConnected(int controllerID){ return m_ts.fn_isXInputConnected(controllerID); } /// -/// Will generate static lighting for the scene if supported by the active light manager. If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps will be regenerated only if the lighting cache files can be written. @param completeCallbackFn The name of the function to execute when the lighting is complete. @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". @return Returns true if the scene lighting process was started. @ingroup Lighting ) +/// Will generate static lighting for the scene if supported by the active light manager. +/// If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether +/// lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps +/// will be regenerated only if the lighting cache files can be written. +/// @param completeCallbackFn The name of the function to execute when the lighting is complete. +/// @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". +/// @return Returns true if the scene lighting process was started. +/// @ingroup Lighting ) +/// /// public bool lightScene(string completeCallbackFn = null , string mode = null ){ if (completeCallbackFn== null) {completeCallbackFn = null;} @@ -4540,7 +6145,10 @@ public bool lightScene(string completeCallbackFn = null , string mode = null ){ return m_ts.fn_lightScene(completeCallbackFn, mode); } /// -/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void listGFXResources(bool unflaggedOnly = false){ @@ -4548,7 +6156,29 @@ public void listGFXResources(bool unflaggedOnly = false){ m_ts.fn_listGFXResources(unflaggedOnly); } /// -/// , ), (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) Load all light instances from a COLLADA (.dae) file and add to the scene. @param filename COLLADA filename to load lights from @param parentGroup (optional) name of an existing simgroup to add the new lights to (defaults to MissionGroup) @param baseObject (optional) name of an object to use as the origin (useful if you are loading the lights for a collada scene and have moved or rotated the geometry) @return true if successful, false otherwise @tsexample // load the lights in room.dae loadColladaLights( \"art/shapes/collada/room.dae\" ); // load the lights in room.dae and add them to the RoomLights group loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); // load the lights in room.dae and use the transform of the \"Room\" object as the origin loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); @endtsexample @note Currently for editor use only @ingroup Editors @internal) +/// , ), +/// (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) +/// Load all light instances from a COLLADA (.dae) file and add to the scene. +/// @param filename COLLADA filename to load lights from +/// @param parentGroup (optional) name of an existing simgroup to add the new +/// lights to (defaults to MissionGroup) +/// @param baseObject (optional) name of an object to use as the origin (useful +/// if you are loading the lights for a collada scene and have moved or rotated +/// the geometry) +/// @return true if successful, false otherwise +/// @tsexample +/// // load the lights in room.dae +/// loadColladaLights( \"art/shapes/collada/room.dae\" ); +/// // load the lights in room.dae and add them to the RoomLights group +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); +/// // load the lights in room.dae and use the transform of the \"Room\" +/// object as the origin +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); +/// @endtsexample +/// @note Currently for editor use only +/// @ingroup Editors +/// @internal) +/// /// public bool loadColladaLights(string filename, string parentGroup = "", string baseObject = ""){ @@ -4556,7 +6186,10 @@ public bool loadColladaLights(string filename, string parentGroup = "", string return m_ts.fn_loadColladaLights(filename, parentGroup, baseObject); } /// -/// @brief Loads a serialized object from a file. @param Name and path to text file containing the object @ingroup Console) +/// @brief Loads a serialized object from a file. +/// @param Name and path to text file containing the object +/// @ingroup Console) +/// /// public string loadObject(string filename){ @@ -4564,7 +6197,11 @@ public string loadObject(string filename){ return m_ts.fn_loadObject(filename); } /// -/// (bool isLocked) @brief Lock or unlock the mouse to the window. When true, prevents the mouse from leaving the bounds of the game window. @ingroup Input) +/// (bool isLocked) +/// @brief Lock or unlock the mouse to the window. +/// When true, prevents the mouse from leaving the bounds of the game window. +/// @ingroup Input) +/// /// public void lockMouse(bool isLocked){ @@ -4608,7 +6245,16 @@ public void logWarning(string message){ m_ts.fn_logWarning(message); } /// -/// Remove leading whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. @tsexample ltrim( \" string \" ); // Returns \"string \". @endtsexample @see rtrim @see trim @ingroup Strings ) +/// Remove leading whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. +/// @tsexample +/// ltrim( \" string \" ); // Returns \"string \". +/// @endtsexample +/// @see rtrim +/// @see trim +/// @ingroup Strings ) +/// /// public string ltrim(string str){ @@ -4616,7 +6262,10 @@ public string ltrim(string str){ return m_ts.fn_ltrim(str); } /// -/// Return the value of 2*PI (full-circle in radians). @returns The value of 2*PI. @ingroup Math ) +/// Return the value of 2*PI (full-circle in radians). +/// @returns The value of 2*PI. +/// @ingroup Math ) +/// /// public float m2Pi(){ @@ -4624,7 +6273,11 @@ public float m2Pi(){ return m_ts.fn_m2Pi(); } /// -/// Calculate absolute value of specified value. @param v Input Value. @returns Absolute value of specified value. @ingroup Math ) +/// Calculate absolute value of specified value. +/// @param v Input Value. +/// @returns Absolute value of specified value. +/// @ingroup Math ) +/// /// public float mAbs(float v){ @@ -4632,7 +6285,11 @@ public float mAbs(float v){ return m_ts.fn_mAbs(v); } /// -/// Calculate the arc-cosine of v. @param v Input Value (in radians). @returns The arc-cosine of the input value. @ingroup Math ) +/// Calculate the arc-cosine of v. +/// @param v Input Value (in radians). +/// @returns The arc-cosine of the input value. +/// @ingroup Math ) +/// /// public float mAcos(float v){ @@ -4640,7 +6297,15 @@ public float mAcos(float v){ return m_ts.fn_mAcos(v); } /// -/// ), @brief Converts a relative file path to a full path For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" @param path Name of file or path to check @param cwd Optional current working directory from which to build the full path. @return String containing non-relative directory of path @ingroup FileSystem) +/// ), +/// @brief Converts a relative file path to a full path +/// +/// For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" +/// @param path Name of file or path to check +/// @param cwd Optional current working directory from which to build the full path. +/// @return String containing non-relative directory of path +/// @ingroup FileSystem) +/// /// public string makeFullPath(string path, string cwd = ""){ @@ -4648,7 +6313,16 @@ public string makeFullPath(string path, string cwd = ""){ return m_ts.fn_makeFullPath(path, cwd); } /// -/// ), @brief Turns a full or local path to a relative one For example, \"./game/art\" becomes \"game/art\" @param path Full path (may include a file) to convert @param to Optional base path used for the conversion. If not supplied the current working directory is used. @returns String containing relative path @ingroup FileSystem) +/// ), +/// @brief Turns a full or local path to a relative one +/// +/// For example, \"./game/art\" becomes \"game/art\" +/// @param path Full path (may include a file) to convert +/// @param to Optional base path used for the conversion. If not supplied the current +/// working directory is used. +/// @returns String containing relative path +/// @ingroup FileSystem) +/// /// public string makeRelativePath(string path, string to = ""){ @@ -4656,7 +6330,11 @@ public string makeRelativePath(string path, string to = ""){ return m_ts.fn_makeRelativePath(path, to); } /// -/// Calculate the arc-sine of v. @param v Input Value (in radians). @returns The arc-sine of the input value. @ingroup Math ) +/// Calculate the arc-sine of v. +/// @param v Input Value (in radians). +/// @returns The arc-sine of the input value. +/// @ingroup Math ) +/// /// public float mAsin(float v){ @@ -4664,7 +6342,12 @@ public float mAsin(float v){ return m_ts.fn_mAsin(v); } /// -/// Calculate the arc-tangent (slope) of a line defined by rise and run. @param rise of line. @param run of line. @returns The arc-tangent (slope) of a line defined by rise and run. @ingroup Math ) +/// Calculate the arc-tangent (slope) of a line defined by rise and run. +/// @param rise of line. +/// @param run of line. +/// @returns The arc-tangent (slope) of a line defined by rise and run. +/// @ingroup Math ) +/// /// public float mAtan(float rise, float run){ @@ -4672,7 +6355,12 @@ public float mAtan(float rise, float run){ return m_ts.fn_mAtan(rise, run); } /// -/// Create a transform from the given translation and orientation. @param position The translation vector for the transform. @param orientation The axis and rotation that orients the transform. @return A transform based on the given position and orientation. @ingroup Matrices ) +/// Create a transform from the given translation and orientation. +/// @param position The translation vector for the transform. +/// @param orientation The axis and rotation that orients the transform. +/// @return A transform based on the given position and orientation. +/// @ingroup Matrices ) +/// /// public TransformF MatrixCreate(Point3F position, AngAxisF orientation){ @@ -4680,7 +6368,11 @@ public TransformF MatrixCreate(Point3F position, AngAxisF orientation){ return new TransformF ( m_ts.fn_MatrixCreate(position.AsString(), orientation.AsString())); } /// -/// @Create a matrix from the given rotations. @param Vector3F X, Y, and Z rotation in *radians*. @return A transform based on the given orientation. @ingroup Matrices ) +/// @Create a matrix from the given rotations. +/// @param Vector3F X, Y, and Z rotation in *radians*. +/// @return A transform based on the given orientation. +/// @ingroup Matrices ) +/// /// public TransformF MatrixCreateFromEuler(Point3F angles){ @@ -4688,7 +6380,13 @@ public TransformF MatrixCreateFromEuler(Point3F angles){ return new TransformF ( m_ts.fn_MatrixCreateFromEuler(angles.AsString())); } /// -/// @brief Multiply the given point by the given transform assuming that w=1. This function will multiply the given vector such that translation with take effect. @param transform A transform. @param point A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the given point by the given transform assuming that w=1. +/// This function will multiply the given vector such that translation with take effect. +/// @param transform A transform. +/// @param point A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public Point3F MatrixMulPoint(TransformF transform, Point3F point){ @@ -4696,7 +6394,12 @@ public Point3F MatrixMulPoint(TransformF transform, Point3F point){ return new Point3F ( m_ts.fn_MatrixMulPoint(transform.AsString(), point.AsString())); } /// -/// @brief Multiply the two matrices. @param left First transform. @param right Right transform. @return Concatenation of the two transforms. @ingroup Matrices ) +/// @brief Multiply the two matrices. +/// @param left First transform. +/// @param right Right transform. +/// @return Concatenation of the two transforms. +/// @ingroup Matrices ) +/// /// public TransformF MatrixMultiply(TransformF left, TransformF right){ @@ -4704,7 +6407,14 @@ public TransformF MatrixMultiply(TransformF left, TransformF right){ return new TransformF ( m_ts.fn_MatrixMultiply(left.AsString(), right.AsString())); } /// -/// @brief Multiply the vector by the transform assuming that w=0. This function will multiply the given vector by the given transform such that translation will not affect the vector. @param transform A transform. @param vector A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the vector by the transform assuming that w=0. +/// This function will multiply the given vector by the given transform such that translation will +/// not affect the vector. +/// @param transform A transform. +/// @param vector A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public Point3F MatrixMulVector(TransformF transform, Point3F vector){ @@ -4712,7 +6422,11 @@ public Point3F MatrixMulVector(TransformF transform, Point3F vector){ return new Point3F ( m_ts.fn_MatrixMulVector(transform.AsString(), vector.AsString())); } /// -/// Round v up to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v up to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int mCeil(float v){ @@ -4720,7 +6434,13 @@ public int mCeil(float v){ return m_ts.fn_mCeil(v); } /// -/// Clamp the specified value between two bounds. @param v Input value. @param min Minimum Bound. @param max Maximum Bound. @returns The specified value clamped to the specified bounds. @ingroup Math ) +/// Clamp the specified value between two bounds. +/// @param v Input value. +/// @param min Minimum Bound. +/// @param max Maximum Bound. +/// @returns The specified value clamped to the specified bounds. +/// @ingroup Math ) +/// /// public float mClamp(float v, float min, float max){ @@ -4728,7 +6448,11 @@ public float mClamp(float v, float min, float max){ return m_ts.fn_mClamp(v, min, max); } /// -/// Calculate the cosine of v. @param v Input Value (in radians). @returns The cosine of the input value. @ingroup Math ) +/// Calculate the cosine of v. +/// @param v Input Value (in radians). +/// @returns The cosine of the input value. +/// @ingroup Math ) +/// /// public float mCos(float v){ @@ -4736,7 +6460,11 @@ public float mCos(float v){ return m_ts.fn_mCos(v); } /// -/// Convert specified degrees into radians. @param degrees Input Value (in degrees). @returns The specified degrees value converted to radians. @ingroup Math ) +/// Convert specified degrees into radians. +/// @param degrees Input Value (in degrees). +/// @returns The specified degrees value converted to radians. +/// @ingroup Math ) +/// /// public float mDegToRad(float degrees){ @@ -4744,7 +6472,16 @@ public float mDegToRad(float degrees){ return m_ts.fn_mDegToRad(degrees); } /// -/// Display a modal message box using the platform's native message box implementation. @param title The title to display on the message box window. @param message The text message to display in the box. @param buttons Which buttons to put on the message box. @param icons Which icon to show next to the message. @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. @tsexample messageBox( \"Error\", \"\" ); @endtsexample @ingroup Platform ) +/// Display a modal message box using the platform's native message box implementation. +/// @param title The title to display on the message box window. +/// @param message The text message to display in the box. +/// @param buttons Which buttons to put on the message box. +/// @param icons Which icon to show next to the message. +/// @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. +/// @tsexample +/// messageBox( \"Error\", \"\" ); @endtsexample +/// @ingroup Platform ) +/// /// public int messageBox(string title, string message, TypeMBButtons buttons = null , TypeMBIcons icons = null ){ if (buttons== null) {buttons = 1;} @@ -4754,7 +6491,12 @@ public int messageBox(string title, string message, TypeMBButtons buttons = nul return m_ts.fn_messageBox(title, message, (int)buttons , (int)icons ); } /// -/// Formats the specified number to the given number of decimal places. @param v Number to format. @param precision Number of decimal places to format to (1-9). @returns Number formatted to the specified number of decimal places. @ingroup Math ) +/// Formats the specified number to the given number of decimal places. +/// @param v Number to format. +/// @param precision Number of decimal places to format to (1-9). +/// @returns Number formatted to the specified number of decimal places. +/// @ingroup Math ) +/// /// public string mFloatLength(float v, uint precision){ @@ -4762,7 +6504,11 @@ public string mFloatLength(float v, uint precision){ return m_ts.fn_mFloatLength(v, precision); } /// -/// Round v down to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v down to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int mFloor(float v){ @@ -4770,7 +6516,12 @@ public int mFloor(float v){ return m_ts.fn_mFloor(v); } /// -/// Calculate the remainder of v/d. @param v Input Value. @param d Divisor Value. @returns The remainder of v/d. @ingroup Math ) +/// Calculate the remainder of v/d. +/// @param v Input Value. +/// @param d Divisor Value. +/// @returns The remainder of v/d. +/// @ingroup Math ) +/// /// public float mFMod(float v, float d){ @@ -4778,7 +6529,11 @@ public float mFMod(float v, float d){ return m_ts.fn_mFMod(v, d); } /// -/// Returns whether the value is an exact power of two. @param v Input value. @returns Whether the specified value is an exact power of two. @ingroup Math ) +/// Returns whether the value is an exact power of two. +/// @param v Input value. +/// @returns Whether the specified value is an exact power of two. +/// @ingroup Math ) +/// /// public bool mIsPow2(int v){ @@ -4786,7 +6541,13 @@ public bool mIsPow2(int v){ return m_ts.fn_mIsPow2(v); } /// -/// Calculate linearly interpolated value between two specified numbers using specified normalized time. @param v1 Interpolate From Input value. @param v2 Interpolate To Input value. @param time Normalized time used to interpolate values (0-1). @returns The interpolated value between the two specified values at normalized time t. @ingroup Math ) +/// Calculate linearly interpolated value between two specified numbers using specified normalized time. +/// @param v1 Interpolate From Input value. +/// @param v2 Interpolate To Input value. +/// @param time Normalized time used to interpolate values (0-1). +/// @returns The interpolated value between the two specified values at normalized time t. +/// @ingroup Math ) +/// /// public float mLerp(float v1, float v2, float time){ @@ -4794,7 +6555,11 @@ public float mLerp(float v1, float v2, float time){ return m_ts.fn_mLerp(v1, v2, time); } /// -/// Calculate the natural logarithm of v. @param v Input Value. @returns The natural logarithm of the input value. @ingroup Math ) +/// Calculate the natural logarithm of v. +/// @param v Input Value. +/// @returns The natural logarithm of the input value. +/// @ingroup Math ) +/// /// public float mLog(float v){ @@ -4802,7 +6567,10 @@ public float mLog(float v){ return m_ts.fn_mLog(v); } /// -/// Return the value of PI (half-circle in radians). @returns The value of PI. @ingroup Math ) +/// Return the value of PI (half-circle in radians). +/// @returns The value of PI. +/// @ingroup Math ) +/// /// public float mPi(){ @@ -4810,7 +6578,12 @@ public float mPi(){ return m_ts.fn_mPi(); } /// -/// Calculate b raised to the p-th power. @param v Input Value. @param p Power to raise value by. @returns v raised to the p-th power. @ingroup Math ) +/// Calculate b raised to the p-th power. +/// @param v Input Value. +/// @param p Power to raise value by. +/// @returns v raised to the p-th power. +/// @ingroup Math ) +/// /// public float mPow(float v, float p){ @@ -4818,7 +6591,11 @@ public float mPow(float v, float p){ return m_ts.fn_mPow(v, p); } /// -/// Convert specified radians into degrees. @param radians Input Value (in radians). @returns The specified radians value converted to degrees. @ingroup Math ) +/// Convert specified radians into degrees. +/// @param radians Input Value (in radians). +/// @returns The specified radians value converted to degrees. +/// @ingroup Math ) +/// /// public float mRadToDeg(float radians){ @@ -4826,7 +6603,12 @@ public float mRadToDeg(float radians){ return m_ts.fn_mRadToDeg(radians); } /// -/// Round v to the nth decimal place or the nearest whole number by default. @param v Value to roundn @param n Number of decimal places to round to, 0 by defaultn @return The rounded value as a S32. @ingroup Math ) +/// Round v to the nth decimal place or the nearest whole number by default. +/// @param v Value to roundn +/// @param n Number of decimal places to round to, 0 by defaultn +/// @return The rounded value as a S32. +/// @ingroup Math ) +/// /// public float mRound(float v, int n = 0){ @@ -4834,7 +6616,11 @@ public float mRound(float v, int n = 0){ return m_ts.fn_mRound(v, n); } /// -/// Clamp the specified value between 0 and 1 (inclusive). @param v Input value. @returns The specified value clamped between 0 and 1 (inclusive). @ingroup Math ) +/// Clamp the specified value between 0 and 1 (inclusive). +/// @param v Input value. +/// @returns The specified value clamped between 0 and 1 (inclusive). +/// @ingroup Math ) +/// /// public float mSaturate(float v){ @@ -4842,7 +6628,11 @@ public float mSaturate(float v){ return m_ts.fn_mSaturate(v); } /// -/// Calculate the sine of v. @param v Input Value (in radians). @returns The sine of the input value. @ingroup Math ) +/// Calculate the sine of v. +/// @param v Input Value (in radians). +/// @returns The sine of the input value. +/// @ingroup Math ) +/// /// public float mSin(float v){ @@ -4850,7 +6640,15 @@ public float mSin(float v){ return m_ts.fn_mSin(v); } /// -/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. @ingroup Math ) +/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions +/// (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. +/// @ingroup Math ) +/// /// public string mSolveCubic(float a, float b, float c, float d){ @@ -4858,7 +6656,14 @@ public string mSolveCubic(float a, float b, float c, float d){ return m_ts.fn_mSolveCubic(a, b, c, d); } /// -/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. @ingroup Math ) +/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions +/// (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. +/// @ingroup Math ) +/// /// public string mSolveQuadratic(float a, float b, float c){ @@ -4866,7 +6671,16 @@ public string mSolveQuadratic(float a, float b, float c){ return m_ts.fn_mSolveQuadratic(a, b, c); } /// -/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @param e Fifth Coefficient. @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. @ingroup Math ) +/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @param e Fifth Coefficient. +/// @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions +/// (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. +/// @ingroup Math ) +/// /// public string mSolveQuartic(float a, float b, float c, float d, float e){ @@ -4874,7 +6688,11 @@ public string mSolveQuartic(float a, float b, float c, float d, float e){ return m_ts.fn_mSolveQuartic(a, b, c, d, e); } /// -/// Calculate the square-root of v. @param v Input Value. @returns The square-root of the input value. @ingroup Math ) +/// Calculate the square-root of v. +/// @param v Input Value. +/// @returns The square-root of the input value. +/// @ingroup Math ) +/// /// public float mSqrt(float v){ @@ -4882,7 +6700,11 @@ public float mSqrt(float v){ return m_ts.fn_mSqrt(v); } /// -/// Calculate the tangent of v. @param v Input Value (in radians). @returns The tangent of the input value. @ingroup Math ) +/// Calculate the tangent of v. +/// @param v Input Value (in radians). +/// @returns The tangent of the input value. +/// @ingroup Math ) +/// /// public float mTan(float v){ @@ -4891,6 +6713,7 @@ public float mTan(float v){ } /// /// nameToID(object)) +/// /// public int nameToID(string objectName){ @@ -4898,15 +6721,47 @@ public int nameToID(string objectName){ return m_ts.fn_nameToID(objectName); } /// -/// ( string str, string token, string delimiters ) Tokenize a string using a set of delimiting characters. This function first skips all leading charaters in @a str that are contained in @a delimiters. From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str until the function returns \"\". @param str A string. @param token The name of the variable in which to store the current token. This variable is set in the scope in which nextToken is called. @param delimiters A string of characters. Each character is considered a delimiter. @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. @tsexample // Prints: // a // b // c %str = \"a b c\"; while ( %str !$= \"\" ) { // First time, stores \"a\" in the variable %token and sets %str to \"b c\". %str = nextToken( %str, \"token\", \" \" ); echo( %token ); } @endtsexample @ingroup Strings ) +/// ( string str, string token, string delimiters ) +/// Tokenize a string using a set of delimiting characters. +/// This function first skips all leading charaters in @a str that are contained in @a delimiters. +/// From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters +/// from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it +/// skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. +/// To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str +/// until the function returns \"\". +/// @param str A string. +/// @param token The name of the variable in which to store the current token. This variable is set in the +/// scope in which nextToken is called. +/// @param delimiters A string of characters. Each character is considered a delimiter. +/// @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. +/// @tsexample +/// // Prints: +/// // a +/// // b +/// // c +/// %str = \"a b c\"; +/// while ( %str !$= \"\" ) +/// { +/// // First time, stores \"a\" in the variable %token and sets %str to \"b c\". +/// %str = nextToken( %str, \"token\", \" \" ); +/// echo( %token ); +/// } +/// @endtsexample +/// @ingroup Strings ) +/// /// -public string nextToken(string str, string token, string delim){ +public string nextToken(string str1, string token, string delim){ -return m_ts.fn_nextToken(str, token, delim); +return m_ts.fn_nextToken(str1, token, delim); } /// -/// @brief Open the given @a file through the system. This will usually open the file in its associated application. @param file %Path of the file to open. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given @a file through the system. This will usually open the file in its +/// associated application. +/// @param file %Path of the file to open. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void openFile(string file){ @@ -4914,7 +6769,11 @@ public void openFile(string file){ m_ts.fn_openFile(file); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void openFolder(string path){ @@ -4922,7 +6781,13 @@ public void openFolder(string path){ m_ts.fn_openFolder(path); } /// -/// @brief Combines two separate strings containing a file path and file name together into a single string @param path String containing file path @param file String containing file name @return String containing concatenated file name and path @ingroup FileSystem) +/// @brief Combines two separate strings containing a file path and file name together into a single string +/// +/// @param path String containing file path +/// @param file String containing file name +/// @return String containing concatenated file name and path +/// @ingroup FileSystem) +/// /// public string pathConcat(string path, string file){ @@ -4930,7 +6795,14 @@ public string pathConcat(string path, string file){ return m_ts.fn_pathConcat(path, file); } /// -/// @brief Copy a file to a new location. @param fromFile %Path of the file to copy. @param toFile %Path where to copy @a fromFile to. @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. @return True if the file was successfully copied, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Copy a file to a new location. +/// @param fromFile %Path of the file to copy. +/// @param toFile %Path where to copy @a fromFile to. +/// @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. +/// @return True if the file was successfully copied, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool pathCopy(string fromFile, string toFile, bool noOverwrite = true){ @@ -4938,7 +6810,23 @@ public bool pathCopy(string fromFile, string toFile, bool noOverwrite = true){ return m_ts.fn_pathCopy(fromFile, toFile, noOverwrite); } /// -/// @brief Load all Path information from the mission. This function is usually called from the loadMissionStage2() server-side function after the mission file has loaded. Internally it places all Paths into the server's PathManager. From this point the Paths are ready for transmission to the clients. @tsexample // Inform the engine to load all Path information from the mission. pathOnMissionLoadDone(); @endtsexample @see NetConnection::transmitPaths() @see NetConnection::clearPaths() @see Path @ingroup Networking) +/// @brief Load all Path information from the mission. +/// +/// This function is usually called from the loadMissionStage2() server-side function +/// after the mission file has loaded. Internally it places all Paths into the server's +/// PathManager. From this point the Paths are ready for transmission to the clients. +/// +/// @tsexample +/// // Inform the engine to load all Path information from the mission. +/// pathOnMissionLoadDone(); +/// @endtsexample +/// +/// @see NetConnection::transmitPaths() +/// @see NetConnection::clearPaths() +/// @see Path +/// +/// @ingroup Networking) +/// /// public void pathOnMissionLoadDone(){ @@ -4947,6 +6835,7 @@ public void pathOnMissionLoadDone(){ } /// /// physicsDebugDraw( bool enable )) +/// /// public void physicsDebugDraw(bool enable){ @@ -4955,6 +6844,7 @@ public void physicsDebugDraw(bool enable){ } /// /// physicsDestroy()) +/// /// public void physicsDestroy(){ @@ -4963,6 +6853,7 @@ public void physicsDestroy(){ } /// /// physicsDestroyWorld( String worldName )) +/// /// public void physicsDestroyWorld(string worldName){ @@ -4971,6 +6862,7 @@ public void physicsDestroyWorld(string worldName){ } /// /// physicsGetTimeScale()) +/// /// public float physicsGetTimeScale(){ @@ -4979,6 +6871,7 @@ public float physicsGetTimeScale(){ } /// /// ), physicsInit( [string library] )) +/// /// public bool physicsInit(string library = ""){ @@ -4987,6 +6880,7 @@ public bool physicsInit(string library = ""){ } /// /// physicsInitWorld( String worldName )) +/// /// public bool physicsInitWorld(string worldName){ @@ -4994,7 +6888,10 @@ public bool physicsInitWorld(string worldName){ return m_ts.fn_physicsInitWorld(worldName); } /// -/// physicsPluginPresent() @brief Returns true if a physics plugin exists and is initialized. @ingroup Physics ) +/// physicsPluginPresent() +/// @brief Returns true if a physics plugin exists and is initialized. +/// @ingroup Physics ) +/// /// public bool physicsPluginPresent(){ @@ -5003,6 +6900,7 @@ public bool physicsPluginPresent(){ } /// /// physicsRestoreState()) +/// /// public void physicsRestoreState(){ @@ -5011,6 +6909,7 @@ public void physicsRestoreState(){ } /// /// physicsSetTimeScale( F32 scale )) +/// /// public void physicsSetTimeScale(float scale){ @@ -5019,6 +6918,7 @@ public void physicsSetTimeScale(float scale){ } /// /// physicsStopSimulation( String worldName )) +/// /// public bool physicsSimulationEnabled(){ @@ -5027,6 +6927,7 @@ public bool physicsSimulationEnabled(){ } /// /// physicsStartSimulation( String worldName )) +/// /// public void physicsStartSimulation(string worldName){ @@ -5035,6 +6936,7 @@ public void physicsStartSimulation(string worldName){ } /// /// physicsStopSimulation( String worldName )) +/// /// public void physicsStopSimulation(string worldName){ @@ -5043,6 +6945,7 @@ public void physicsStopSimulation(string worldName){ } /// /// physicsStoreState()) +/// /// public void physicsStoreState(){ @@ -5050,7 +6953,11 @@ public void physicsStoreState(){ m_ts.fn_physicsStoreState(); } /// -/// (string filename) @brief Begin playback of a journal from a specified field. @param filename Name and path of file journal file @ingroup Platform) +/// (string filename) +/// @brief Begin playback of a journal from a specified field. +/// @param filename Name and path of file journal file +/// @ingroup Platform) +/// /// public void playJournal(string filename){ @@ -5058,7 +6965,10 @@ public void playJournal(string filename){ m_ts.fn_playJournal(filename); } /// -/// THEORA, 30.0f, Point2I::Zero ), Load a journal file and capture it video. @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Load a journal file and capture it video. +/// @ingroup Rendering ) +/// /// public void playJournalToVideo(string journalFile, string videoFile = null , string encoder = "THEORA", float framerate = 30.0f, Point2I resolution = null ){ if (videoFile== null) {videoFile = null;} @@ -5068,7 +6978,12 @@ public void playJournalToVideo(string journalFile, string videoFile = null , st m_ts.fn_playJournalToVideo(journalFile, videoFile, encoder, framerate, resolution.AsString()); } /// -/// () @brief Pop and restore the last setting of $instantGroup off the stack. @note Currently only used for editors @ingroup Editors @internal) +/// () +/// @brief Pop and restore the last setting of $instantGroup off the stack. +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void popInstantGroup(){ @@ -5076,7 +6991,12 @@ public void popInstantGroup(){ m_ts.fn_popInstantGroup(); } /// -/// Populate the font cache for all fonts with Unicode code points in the specified range. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for all fonts with Unicode code points in the specified range. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void populateAllFontCacheRange(uint rangeStart, uint rangeEnd){ @@ -5084,7 +7004,9 @@ public void populateAllFontCacheRange(uint rangeStart, uint rangeEnd){ m_ts.fn_populateAllFontCacheRange(rangeStart, rangeEnd); } /// -/// Populate the font cache for all fonts with characters from the specified string. @ingroup Font ) +/// Populate the font cache for all fonts with characters from the specified string. +/// @ingroup Font ) +/// /// public void populateAllFontCacheString(string stringx){ @@ -5092,7 +7014,14 @@ public void populateAllFontCacheString(string stringx){ m_ts.fn_populateAllFontCacheString(stringx); } /// -/// Populate the font cache for the specified font with Unicode code points in the specified range. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for the specified font with Unicode code points in the specified range. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void populateFontCacheRange(string faceName, int fontSize, uint rangeStart, uint rangeEnd){ @@ -5100,7 +7029,12 @@ public void populateFontCacheRange(string faceName, int fontSize, uint rangeSta m_ts.fn_populateFontCacheRange(faceName, fontSize, rangeStart, rangeEnd); } /// -/// Populate the font cache for the specified font with characters from the specified string. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param string The string to populate. @ingroup Font ) +/// Populate the font cache for the specified font with characters from the specified string. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param string The string to populate. +/// @ingroup Font ) +/// /// public void populateFontCacheString(string faceName, int fontSize, string stringx){ @@ -5108,7 +7042,9 @@ public void populateFontCacheString(string faceName, int fontSize, string strin m_ts.fn_populateFontCacheString(faceName, fontSize, stringx); } /// -/// Preload all datablocks in client mode. (Server parameter is set to false). This will take some time to complete.) +/// Preload all datablocks in client mode. +/// (Server parameter is set to false). This will take some time to complete.) +/// /// public void preloadClientDataBlocks(){ @@ -5116,7 +7052,11 @@ public void preloadClientDataBlocks(){ m_ts.fn_preloadClientDataBlocks(); } /// -/// @brief Dumps current profiling stats to the console window. @note Markers disabled with profilerMarkerEnable() will be skipped over. If the profiler is currently running, it will be disabled. @ingroup Debugging) +/// @brief Dumps current profiling stats to the console window. +/// @note Markers disabled with profilerMarkerEnable() will be skipped over. +/// If the profiler is currently running, it will be disabled. +/// @ingroup Debugging) +/// /// public void profilerDump(){ @@ -5124,7 +7064,15 @@ public void profilerDump(){ m_ts.fn_profilerDump(); } /// -/// @brief Dumps current profiling stats to a file. @note If the profiler is currently running, it will be disabled. @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). Will attempt to create the file if it does not already exist. @tsexample profilerDumpToFile( \"C:/Torque/log1.txt\" ); @endtsexample @ingroup Debugging ) +/// @brief Dumps current profiling stats to a file. +/// @note If the profiler is currently running, it will be disabled. +/// @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). +/// Will attempt to create the file if it does not already exist. +/// @tsexample +/// profilerDumpToFile( \"C:/Torque/log1.txt\" ); +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void profilerDumpToFile(string fileName){ @@ -5132,7 +7080,14 @@ public void profilerDumpToFile(string fileName){ m_ts.fn_profilerDumpToFile(fileName); } /// -/// @brief Enables or disables the profiler. Data is only gathered while the profiler is enabled. @note Profiler is not available in shipping builds. T3D has predefined profiling areas surrounded by markers, but you may need to define additional markers (in C++) around areas you wish to profile, by using the PROFILE_START( markerName ); and PROFILE_END(); macros. @ingroup Debugging ) +/// @brief Enables or disables the profiler. +/// Data is only gathered while the profiler is enabled. +/// @note Profiler is not available in shipping builds. +/// T3D has predefined profiling areas surrounded by markers, +/// but you may need to define additional markers (in C++) around areas you wish to profile, +/// by using the PROFILE_START( markerName ); and PROFILE_END(); macros. +/// @ingroup Debugging ) +/// /// public void profilerEnable(bool enable){ @@ -5140,7 +7095,13 @@ public void profilerEnable(bool enable){ m_ts.fn_profilerEnable(enable); } /// -/// @brief Enable or disable a specific profile. @param enable Optional paramater to enable or disable the profile. @param markerName Name of a specific marker to enable or disable. @note Calling this function will first call profilerReset(), clearing all data from profiler. All profile markers are enabled by default. @ingroup Debugging) +/// @brief Enable or disable a specific profile. +/// @param enable Optional paramater to enable or disable the profile. +/// @param markerName Name of a specific marker to enable or disable. +/// @note Calling this function will first call profilerReset(), clearing all data from profiler. +/// All profile markers are enabled by default. +/// @ingroup Debugging) +/// /// public void profilerMarkerEnable(string markerName, bool enable = true){ @@ -5148,7 +7109,11 @@ public void profilerMarkerEnable(string markerName, bool enable = true){ m_ts.fn_profilerMarkerEnable(markerName, enable); } /// -/// @brief Resets the profiler, clearing it of all its data. If the profiler is currently running, it will first be disabled. All markers will retain their current enabled/disabled status. @ingroup Debugging ) +/// @brief Resets the profiler, clearing it of all its data. +/// If the profiler is currently running, it will first be disabled. +/// All markers will retain their current enabled/disabled status. +/// @ingroup Debugging ) +/// /// public void profilerReset(){ @@ -5156,7 +7121,13 @@ public void profilerReset(){ m_ts.fn_profilerReset(); } /// -/// ) , ([group]) @brief Pushes the current $instantGroup on a stack and sets it to the given value (or clears it). @note Currently only used for editors @ingroup Editors @internal) +/// ) , ([group]) +/// @brief Pushes the current $instantGroup on a stack +/// and sets it to the given value (or clears it). +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void pushInstantGroup(string group = ""){ @@ -5165,6 +7136,7 @@ public void pushInstantGroup(string group = ""){ } /// /// queryAllServers(...); ) +/// /// public void queryAllServers(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags){ @@ -5173,6 +7145,8 @@ public void queryAllServers(uint lanPort, uint flags, string gameType, string m } /// /// queryLanServers(...); ) +/// +/// /// public void queryLanServers(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags){ @@ -5181,6 +7155,7 @@ public void queryLanServers(uint lanPort, uint flags, string gameType, string m } /// /// queryMasterServer(...); ) +/// /// public void queryMasterServer(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags){ @@ -5189,19 +7164,50 @@ public void queryMasterServer(uint lanPort, uint flags, string gameType, string } /// /// querySingleServer(...); ) +/// /// public void querySingleServer(string addrText, byte flags = 0){ m_ts.fn_querySingleServer(addrText, flags); } +/// +/// Shut down the engine and exit its process. +/// This function cleanly uninitializes the engine and then exits back to the system with a process +/// exit status indicating a clean exit. +/// @see quitWithErrorMessage +/// @ingroup Platform ) +/// +/// +public void quit(){ + + +m_ts.fn_quit(); +} +/// +/// Display an error message box showing the given @a message and then shut down the engine and exit its process. +/// This function cleanly uninitialized the engine and then exits back to the system with a process +/// exit status indicating an error. +/// @param message The message to log to the console and show in an error message box. +/// @see quit +/// @ingroup Platform ) +/// +/// +public void quitWithErrorMessage(string message){ + + +m_ts.fn_quitWithErrorMessage(message); +} public void realQuit(){ m_ts.fn_realQuit(); } /// -/// Close the current Redbook device. @brief Deprecated @internal) +/// Close the current Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public bool redbookClose(){ @@ -5209,7 +7215,10 @@ public bool redbookClose(){ return m_ts.fn_redbookClose(); } /// -/// get the number of redbook devices. @brief Deprecated @internal) +/// get the number of redbook devices. +/// @brief Deprecated +/// @internal) +/// /// public int redbookGetDeviceCount(){ @@ -5217,7 +7226,10 @@ public int redbookGetDeviceCount(){ return m_ts.fn_redbookGetDeviceCount(); } /// -/// (int index) Get name of specified Redbook device. @brief Deprecated @internal) +/// (int index) Get name of specified Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public string redbookGetDeviceName(int index){ @@ -5225,7 +7237,10 @@ public string redbookGetDeviceName(int index){ return m_ts.fn_redbookGetDeviceName(index); } /// -/// Get a string explaining the last redbook error. @brief Deprecated @internal) +/// Get a string explaining the last redbook error. +/// @brief Deprecated +/// @internal) +/// /// public string redbookGetLastError(){ @@ -5233,7 +7248,10 @@ public string redbookGetLastError(){ return m_ts.fn_redbookGetLastError(); } /// -/// Return the number of tracks. @brief Deprecated @internal) +/// Return the number of tracks. +/// @brief Deprecated +/// @internal) +/// /// public int redbookGetTrackCount(){ @@ -5241,7 +7259,10 @@ public int redbookGetTrackCount(){ return m_ts.fn_redbookGetTrackCount(); } /// -/// Get the volume. @brief Deprecated @internal) +/// Get the volume. +/// @brief Deprecated +/// @internal) +/// /// public float redbookGetVolume(){ @@ -5249,7 +7270,10 @@ public float redbookGetVolume(){ return m_ts.fn_redbookGetVolume(); } /// -/// ), (string device=NULL) @brief Deprecated @internal) +/// ), (string device=NULL) +/// @brief Deprecated +/// @internal) +/// /// public bool redbookOpen(string device = ""){ @@ -5257,7 +7281,10 @@ public bool redbookOpen(string device = ""){ return m_ts.fn_redbookOpen(device); } /// -/// (int track) Play the selected track. @brief Deprecated @internal) +/// (int track) Play the selected track. +/// @brief Deprecated +/// @internal) +/// /// public bool redbookPlay(int track){ @@ -5265,7 +7292,10 @@ public bool redbookPlay(int track){ return m_ts.fn_redbookPlay(track); } /// -/// (float volume) Set playback volume. @brief Deprecated @internal) +/// (float volume) Set playback volume. +/// @brief Deprecated +/// @internal) +/// /// public bool redbookSetVolume(float volume){ @@ -5273,7 +7303,10 @@ public bool redbookSetVolume(float volume){ return m_ts.fn_redbookSetVolume(volume); } /// -/// Stop playing. @brief Deprecated @internal) +/// Stop playing. +/// @brief Deprecated +/// @internal) +/// /// public bool redbookStop(){ @@ -5281,7 +7314,12 @@ public bool redbookStop(){ return m_ts.fn_redbookStop(); } /// -/// (string queueName, string listener) @brief Registers an event message @param queueName String containing the name of queue to attach listener to @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Registers an event message +/// @param queueName String containing the name of queue to attach listener to +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public bool registerMessageListener(string queueName, string listenerName){ @@ -5289,7 +7327,11 @@ public bool registerMessageListener(string queueName, string listenerName){ return m_ts.fn_registerMessageListener(queueName, listenerName); } /// -/// (string queueName) @brief Registeres a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Registeres a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void registerMessageQueue(string queueName){ @@ -5297,7 +7339,9 @@ public void registerMessageQueue(string queueName){ m_ts.fn_registerMessageQueue(queueName); } /// -/// @brief Flushes all procedural shaders and re-initializes all active material instances. @ingroup Materials) +/// @brief Flushes all procedural shaders and re-initializes all active material instances. +/// @ingroup Materials) +/// /// public void reInitMaterials(){ @@ -5305,7 +7349,15 @@ public void reInitMaterials(){ m_ts.fn_reInitMaterials(); } /// -/// Force the resource at specified input path to be reloaded @param path Path to the resource to be reloaded @tsexample reloadResource( \"art/shapes/box.dts\" ); @endtsexample @note Currently used by editors only @ingroup Editors @internal) +/// Force the resource at specified input path to be reloaded +/// @param path Path to the resource to be reloaded +/// @tsexample +/// reloadResource( \"art/shapes/box.dts\" ); +/// @endtsexample +/// @note Currently used by editors only +/// @ingroup Editors +/// @internal) +/// /// public void reloadResource(string path){ @@ -5313,7 +7365,9 @@ public void reloadResource(string path){ m_ts.fn_reloadResource(path); } /// -/// Reload all the textures from disk. @ingroup GFX ) +/// Reload all the textures from disk. +/// @ingroup GFX ) +/// /// public void reloadTextures(){ @@ -5321,7 +7375,19 @@ public void reloadTextures(){ m_ts.fn_reloadTextures(); } /// -/// Remove the field in @a text at the given @a index. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field in @a text. @return A new string with the field at the given index removed or the original string if @a index is out of range. @tsexample removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" @endtsexample @see removeWord @see removeRecord @ingroup FieldManip ) +/// Remove the field in @a text at the given @a index. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field in @a text. +/// @return A new string with the field at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string removeField(string text, int index){ @@ -5329,7 +7395,10 @@ public string removeField(string text, int index){ return m_ts.fn_removeField(text, index); } /// -/// Removes an existing global macro by name. @see addGlobalShaderMacro @ingroup Rendering ) +/// Removes an existing global macro by name. +/// @see addGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void removeGlobalShaderMacro(string name){ @@ -5337,7 +7406,19 @@ public void removeGlobalShaderMacro(string name){ m_ts.fn_removeGlobalShaderMacro(name); } /// -/// Remove the record in @a text at the given @a index. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record in @a text. @return A new string with the record at the given @a index removed or the original string if @a index is out of range. @tsexample removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" @endtsexample @see removeWord @see removeField @ingroup FieldManip ) +/// Remove the record in @a text at the given @a index. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record in @a text. +/// @return A new string with the record at the given @a index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeField +/// @ingroup FieldManip ) +/// /// public string removeRecord(string text, int index){ @@ -5345,7 +7426,15 @@ public string removeRecord(string text, int index){ return m_ts.fn_removeRecord(text, index); } /// -/// @brief Remove a tagged string from the Net String Table @param tag The tag associated with the string @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// @brief Remove a tagged string from the Net String Table +/// +/// @param tag The tag associated with the string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public void removeTaggedString(int tag = -1){ @@ -5353,7 +7442,19 @@ public void removeTaggedString(int tag = -1){ m_ts.fn_removeTaggedString(tag); } /// -/// Remove the word in @a text at the given @a index. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word in @a text. @return A new string with the word at the given index removed or the original string if @a index is out of range. @tsexample removeWord( \"a b c d\", 2 ) // Returns \"a b d\" @endtsexample @see removeField @see removeRecord @ingroup FieldManip ) +/// Remove the word in @a text at the given @a index. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word in @a text. +/// @return A new string with the word at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeWord( \"a b c d\", 2 ) // Returns \"a b d\" +/// @endtsexample +/// @see removeField +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string removeWord(string text, int index){ @@ -5361,7 +7462,12 @@ public string removeWord(string text, int index){ return m_ts.fn_removeWord(text, index); } /// -/// @brief Renames the given @a file. @param from %Path of the file to rename from. @param frome %Path of the file to rename to. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Renames the given @a file. +/// @param from %Path of the file to rename from. +/// @param frome %Path of the file to rename to. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool renameFile(string from, string to){ @@ -5369,7 +7475,10 @@ public bool renameFile(string from, string to){ return m_ts.fn_renameFile(from, to); } /// -/// () @brief Reset FPS stats (fps::) @ingroup Game) +/// () +/// @brief Reset FPS stats (fps::) +/// @ingroup Game) +/// /// public void resetFPSTracker(){ @@ -5377,7 +7486,11 @@ public void resetFPSTracker(){ m_ts.fn_resetFPSTracker(); } /// -/// @brief Deactivates and then activates the currently active light manager. This causes most shaders to be regenerated and is often used when global rendering changes have occured. @ingroup Lighting ) +/// @brief Deactivates and then activates the currently active light manager. +/// This causes most shaders to be regenerated and is often used when global +/// rendering changes have occured. +/// @ingroup Lighting ) +/// /// public void resetLightManager(){ @@ -5385,7 +7498,12 @@ public void resetLightManager(){ m_ts.fn_resetLightManager(); } /// -/// () @brief Rebuilds the XInput section of the InputManager Requests a full refresh of events for all controllers. Useful when called at the beginning of game code after actionMaps are set up to hook up all appropriate events. @ingroup Input) +/// () +/// @brief Rebuilds the XInput section of the InputManager +/// Requests a full refresh of events for all controllers. Useful when called at the beginning +/// of game code after actionMaps are set up to hook up all appropriate events. +/// @ingroup Input) +/// /// public void resetXInput(){ @@ -5393,7 +7511,16 @@ public void resetXInput(){ m_ts.fn_resetXInput(); } /// -/// Return all but the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return @a text with the first word removed. @note This is equal to @tsexample_nopar getWords( text, 1 ) @endtsexample @see getWords @ingroup FieldManip ) +/// Return all but the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return @a text with the first word removed. +/// @note This is equal to +/// @tsexample_nopar +/// getWords( text, 1 ) +/// @endtsexample +/// @see getWords +/// @ingroup FieldManip ) +/// /// public string restWords(string text){ @@ -5401,7 +7528,16 @@ public string restWords(string text){ return m_ts.fn_restWords(text); } /// -/// Remove trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. @tsexample rtrim( \" string \" ); // Returns \" string\". @endtsexample @see ltrim @see trim @ingroup Strings ) +/// Remove trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// rtrim( \" string \" ); // Returns \" string\". +/// @endtsexample +/// @see ltrim +/// @see trim +/// @ingroup Strings ) +/// /// public string rtrim(string str){ @@ -5409,7 +7545,18 @@ public string rtrim(string str){ return m_ts.fn_rtrim(str); } /// -/// (string device, float xRumble, float yRumble) @brief Activates the vibration motors in the specified controller. The controller will constantly at it's xRumble and yRumble intensities until changed or told to stop. Valid inputs for xRumble/yRumble are [0 - 1]. @param device Name of the device to rumble. @param xRumble Intensity to apply to the left motor. @param yRumble Intensity to apply to the right motor. @note in an Xbox 360 controller, the left motor is low-frequency, while the right motor is high-frequency. @ingroup Input) +/// (string device, float xRumble, float yRumble) +/// @brief Activates the vibration motors in the specified controller. +/// The controller will constantly at it's xRumble and yRumble intensities until +/// changed or told to stop. +/// Valid inputs for xRumble/yRumble are [0 - 1]. +/// @param device Name of the device to rumble. +/// @param xRumble Intensity to apply to the left motor. +/// @param yRumble Intensity to apply to the right motor. +/// @note in an Xbox 360 controller, the left motor is low-frequency, +/// while the right motor is high-frequency. +/// @ingroup Input) +/// /// public void rumble(string device, float xRumble, float yRumble){ @@ -5417,7 +7564,10 @@ public void rumble(string device, float xRumble, float yRumble){ m_ts.fn_rumble(device, xRumble, yRumble); } /// -/// (string filename) Save the journal to the specified file. @ingroup Platform) +/// (string filename) +/// Save the journal to the specified file. +/// @ingroup Platform) +/// /// public void saveJournal(string filename){ @@ -5425,7 +7575,11 @@ public void saveJournal(string filename){ m_ts.fn_saveJournal(filename); } /// -/// @brief Serialize the object to a file. @param object The object to serialize. @param filename The file name and path. @ingroup Console) +/// @brief Serialize the object to a file. +/// @param object The object to serialize. +/// @param filename The file name and path. +/// @ingroup Console) +/// /// public bool saveObject(string objectx, string filename){ @@ -5433,7 +7587,12 @@ public bool saveObject(string objectx, string filename){ return m_ts.fn_saveObject(objectx, filename); } /// -/// Dump the current zoning states of all zone spaces in the scene to the console. @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states are dumped as is. @note Only valid on the client. @ingroup Game ) +/// Dump the current zoning states of all zone spaces in the scene to the console. +/// @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states +/// are dumped as is. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public void sceneDumpZoneStates(bool updateFirst = true){ @@ -5441,7 +7600,12 @@ public void sceneDumpZoneStates(bool updateFirst = true){ m_ts.fn_sceneDumpZoneStates(updateFirst); } /// -/// Return the SceneObject that contains the given zone. @param zoneId ID of zone. @return A SceneObject or NULL if the given @a zoneId is invalid. @note Only valid on the client. @ingroup Game ) +/// Return the SceneObject that contains the given zone. +/// @param zoneId ID of zone. +/// @return A SceneObject or NULL if the given @a zoneId is invalid. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public string sceneGetZoneOwner(uint zoneId = 1){ @@ -5449,7 +7613,13 @@ public string sceneGetZoneOwner(uint zoneId = 1){ return m_ts.fn_sceneGetZoneOwner(zoneId); } /// -/// Takes a screenshot with optional tiling to produce huge screenshots. @param file The output image file path. @param format Either JPEG or PNG. @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. @ingroup GFX ) +/// Takes a screenshot with optional tiling to produce huge screenshots. +/// @param file The output image file path. +/// @param format Either JPEG or PNG. +/// @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. +/// @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. +/// @ingroup GFX ) +/// /// public void screenShot(string file, string format, uint tileCount = 1, float tileOverlap = 0){ @@ -5457,7 +7627,11 @@ public void screenShot(string file, string format, uint tileCount = 1, float ti m_ts.fn_screenShot(file, format, tileCount, tileOverlap); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void selectFile(string path){ @@ -5476,7 +7650,11 @@ public bool setClipboard(string text){ return m_ts.fn_setClipboard(text); } /// -/// (string LangTable) @brief Sets the primary LangTable used by the game @param LangTable ID of the core LangTable @ingroup Localization) +/// (string LangTable) +/// @brief Sets the primary LangTable used by the game +/// @param LangTable ID of the core LangTable +/// @ingroup Localization) +/// /// public void setCoreLangTable(string lgTable){ @@ -5484,7 +7662,13 @@ public void setCoreLangTable(string lgTable){ m_ts.fn_setCoreLangTable(lgTable); } /// -/// @brief Set the current working directory. @param path The absolute or relative (to the current working directory) path of the directory which should be made the new working directory. @return True if the working directory was successfully changed to @a path, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Set the current working directory. +/// @param path The absolute or relative (to the current working directory) path of the directory which should be made the new +/// working directory. +/// @return True if the working directory was successfully changed to @a path, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool setCurrentDirectory(string path){ @@ -5492,7 +7676,10 @@ public bool setCurrentDirectory(string path){ return m_ts.fn_setCurrentDirectory(path); } /// -/// @brief Set the default FOV for a camera. @param defaultFOV The default field of view in degrees @ingroup CameraSystem) +/// @brief Set the default FOV for a camera. +/// @param defaultFOV The default field of view in degrees +/// @ingroup CameraSystem) +/// /// public void setDefaultFov(float defaultFOV){ @@ -5500,7 +7687,9 @@ public void setDefaultFov(float defaultFOV){ m_ts.fn_setDefaultFov(defaultFOV); } /// -/// Sets the clients far clipping. ) +/// Sets the clients far clipping. +/// ) +/// /// public void setFarClippingDistance(float dist){ @@ -5508,7 +7697,21 @@ public void setFarClippingDistance(float dist){ m_ts.fn_setFarClippingDistance(dist); } /// -/// Replace the field in @a text at the given @a index with @a replacement. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to replace. @param replacement The string with which to replace the field. @return A new string with the field at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" @endtsexample @see getField @see setWord @see setRecord @ingroup FieldManip ) +/// Replace the field in @a text at the given @a index with @a replacement. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to replace. +/// @param replacement The string with which to replace the field. +/// @return A new string with the field at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see setWord +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string setField(string text, int index, string replacement){ @@ -5528,7 +7731,10 @@ public int SetFogVolumeQuality(uint new_quality){ return m_ts.fn_SetFogVolumeQuality(new_quality); } /// -/// @brief Set the FOV of the camera. @param FOV The camera's new FOV in degrees @ingroup CameraSystem) +/// @brief Set the FOV of the camera. +/// @param FOV The camera's new FOV in degrees +/// @ingroup CameraSystem) +/// /// public void setFov(float FOV){ @@ -5537,6 +7743,7 @@ public void setFov(float FOV){ } /// /// @brief .) +/// /// public void setFrustumOffset(Point4F offset){ @@ -5544,7 +7751,10 @@ public void setFrustumOffset(Point4F offset){ m_ts.fn_setFrustumOffset(offset.AsString()); } /// -/// Finds and activates the named light manager. @return Returns true if the light manager is found and activated. @ingroup Lighting ) +/// Finds and activates the named light manager. +/// @return Returns true if the light manager is found and activated. +/// @ingroup Lighting ) +/// /// public bool setLightManager(string name){ @@ -5552,7 +7762,22 @@ public bool setLightManager(string name){ return m_ts.fn_setLightManager(name); } /// -/// @brief Determines how log files are written. Sets the operational mode of the console logging system. @param mode Parameter specifying the logging mode. This can be: - 1: Open and close the console log file for each seperate string of output. This will ensure that all parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. - 2: Keep the log file open and write to it continuously. This will make the system operate faster but if the process crashes, parts of the output may not have been written to disk yet and will be missing from the log. Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been issued to the console system into the newly created log file. @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. @ingroup Logging ) +/// @brief Determines how log files are written. +/// Sets the operational mode of the console logging system. +/// @param mode Parameter specifying the logging mode. This can be: +/// - 1: Open and close the console log file for each seperate string of output. This will ensure that all +/// parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. +/// - 2: Keep the log file open and write to it continuously. This will make the system operate faster but +/// if the process crashes, parts of the output may not have been written to disk yet and will be missing from +/// the log. +/// +/// Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be +/// combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been +/// issued to the console system into the newly created log file. +/// +/// @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. +/// @ingroup Logging ) +/// /// public void setLogMode(int mode){ @@ -5560,7 +7785,18 @@ public void setLogMode(int mode){ m_ts.fn_setLogMode(mode); } /// -/// (int port, bool bind=true) @brief Set the network port for the game to use. @param port The port to use. @param bind True if bind() should be called on the port. @returns True if the port was successfully opened. This will trigger a windows firewall prompt. If you don't have firewall tunneling tech you can set this to false to avoid the prompt. @ingroup Networking) +/// (int port, bool bind=true) +/// @brief Set the network port for the game to use. +/// +/// @param port The port to use. +/// @param bind True if bind() should be called on the port. +/// +/// @returns True if the port was successfully opened. +/// +/// This will trigger a windows firewall prompt. +/// If you don't have firewall tunneling tech you can set this to false to avoid the prompt. +/// @ingroup Networking) +/// /// public bool setNetPort(int port, bool bind = true){ @@ -5568,7 +7804,15 @@ public bool setNetPort(int port, bool bind = true){ return m_ts.fn_setNetPort(port, bind); } /// -/// @brief Sets the pixel shader version for the active device. This can be used to force a lower pixel shader version than is supported by the device for testing or performance optimization. @param version The floating point shader version number. @note This will only affect shaders/materials created after the call and should be used before the game begins. @see $pref::Video::forcedPixVersion @ingroup GFX ) +/// @brief Sets the pixel shader version for the active device. +/// This can be used to force a lower pixel shader version than is supported by +/// the device for testing or performance optimization. +/// @param version The floating point shader version number. +/// @note This will only affect shaders/materials created after the call +/// and should be used before the game begins. +/// @see $pref::Video::forcedPixVersion +/// @ingroup GFX ) +/// /// public void setPixelShaderVersion(float version){ @@ -5576,7 +7820,13 @@ public void setPixelShaderVersion(float version){ m_ts.fn_setPixelShaderVersion(version); } /// -/// Set the current seed for the random number generator. Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to the same sequence of pseudo-random numbers. If -1, the current timestamp will be used as the seed which is a good basis for randomization. @ingroup Random ) +/// Set the current seed for the random number generator. +/// Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). +/// @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to +/// the same sequence of pseudo-random numbers. +/// If -1, the current timestamp will be used as the seed which is a good basis for randomization. +/// @ingroup Random ) +/// /// public void setRandomSeed(int seed = -1){ @@ -5584,7 +7834,21 @@ public void setRandomSeed(int seed = -1){ m_ts.fn_setRandomSeed(seed); } /// -/// Replace the record in @a text at the given @a index with @a replacement. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to replace. @param replacement The string with which to replace the record. @return A new string with the record at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" @endtsexample @see getRecord @see setWord @see setField @ingroup FieldManip ) +/// Replace the record in @a text at the given @a index with @a replacement. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to replace. +/// @param replacement The string with which to replace the record. +/// @return A new string with the record at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see setWord +/// @see setField +/// @ingroup FieldManip ) +/// /// public string setRecord(string text, int index, string replacement){ @@ -5592,7 +7856,9 @@ public string setRecord(string text, int index, string replacement){ return m_ts.fn_setRecord(text, index, replacement); } /// -/// Set the reflection texture format. @ingroup GFX ) +/// Set the reflection texture format. +/// @ingroup GFX ) +/// /// public void setReflectFormat(TypeGFXFormat format){ @@ -5601,6 +7867,7 @@ public void setReflectFormat(TypeGFXFormat format){ } /// /// setServerInfo(...); ) +/// /// public bool setServerInfo(uint index){ @@ -5609,6 +7876,7 @@ public bool setServerInfo(uint index){ } /// /// ), string sShadowSystemName) +/// /// public bool setShadowManager(string sShadowSystemName = ""){ @@ -5617,6 +7885,7 @@ public bool setShadowManager(string sShadowSystemName = ""){ } /// /// ), ) +/// /// public string setShadowVizLight(string name = ""){ @@ -5624,7 +7893,13 @@ public string setShadowVizLight(string name = ""){ return m_ts.fn_setShadowVizLight(name); } /// -/// (string varName, string value) @brief Sets the value of the named variable. @param varName Name of the variable to locate @param value New value of the variable @return True if variable was successfully found and set @ingroup Scripting) +/// (string varName, string value) +/// @brief Sets the value of the named variable. +/// @param varName Name of the variable to locate +/// @param value New value of the variable +/// @return True if variable was successfully found and set +/// @ingroup Scripting) +/// /// public void setVariable(string varName, string value){ @@ -5632,7 +7907,21 @@ public void setVariable(string varName, string value){ m_ts.fn_setVariable(varName, value); } /// -/// Replace the word in @a text at the given @a index with @a replacement. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to replace. @param replacement The string with which to replace the word. @return A new string with the word at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" @endtsexample @see getWord @see setField @see setRecord @ingroup FieldManip ) +/// Replace the word in @a text at the given @a index with @a replacement. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to replace. +/// @param replacement The string with which to replace the word. +/// @return A new string with the word at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" +/// @endtsexample +/// @see getWord +/// @see setField +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string setWord(string text, int index, string replacement){ @@ -5640,7 +7929,12 @@ public string setWord(string text, int index, string replacement){ return m_ts.fn_setWord(text, index, replacement); } /// -/// @brief Set the zoom speed of the camera. This affects how quickly the camera changes from one field of view to another. @param speed The camera's zoom speed in ms per 90deg FOV change @ingroup CameraSystem) +/// @brief Set the zoom speed of the camera. +/// This affects how quickly the camera changes from one field of view +/// to another. +/// @param speed The camera's zoom speed in ms per 90deg FOV change +/// @ingroup CameraSystem) +/// /// public void setZoomSpeed(int speed){ @@ -5648,7 +7942,25 @@ public void setZoomSpeed(int speed){ m_ts.fn_setZoomSpeed(speed); } /// -/// Try to create a new sound device using the given properties. If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, if this function fails, it will not restore the previously active device but rather leave the sound system in an uninitialized state. Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized playback and then resume normal playback once the device has been created. In the core scripts, sound is automatically set up during startup in the sfxStartup() function. @param provider The name of the device provider as returned by sfxGetAvailableDevices(). @param device The name of the device as returned by sfxGetAvailableDevices(). @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. @return True if the initialization was successful, false if not. @note This function must be called before any of the sound playback functions can be used. @see sfxGetAvailableDevices @see sfxGetDeviceInfo @see sfxDeleteDevice @ref SFX_devices @ingroup SFX ) +/// Try to create a new sound device using the given properties. +/// If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, +/// if this function fails, it will not restore the previously active device but rather leave the sound system in an +/// uninitialized state. +/// Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized +/// playback and then resume normal playback once the device has been created. +/// In the core scripts, sound is automatically set up during startup in the sfxStartup() function. +/// @param provider The name of the device provider as returned by sfxGetAvailableDevices(). +/// @param device The name of the device as returned by sfxGetAvailableDevices(). +/// @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. +/// @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. +/// @return True if the initialization was successful, false if not. +/// @note This function must be called before any of the sound playback functions can be used. +/// @see sfxGetAvailableDevices +/// @see sfxGetDeviceInfo +/// @see sfxDeleteDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public bool sfxCreateDevice(string provider, string device, bool useHardware, int maxBuffers){ @@ -5656,7 +7968,13 @@ public bool sfxCreateDevice(string provider, string device, bool useHardware, i return m_ts.fn_sfxCreateDevice(provider, device, useHardware, maxBuffers); } /// -/// , , , ), ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) Creates a new paused sound source using a profile or a description and filename. The return value is the source which must be released by delete(). @hide ) +/// , , , ), +/// ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) +/// Creates a new paused sound source using a profile or a description +/// and filename. The return value is the source which must be +/// released by delete(). +/// @hide ) +/// /// public int sfxCreateSource(string SFXType, string filename = "", string x = "", string y = "", string z = ""){ @@ -5664,7 +7982,14 @@ public int sfxCreateSource(string SFXType, string filename = "", string x = "", return m_ts.fn_sfxCreateSource(SFXType, filename, x, y, z); } /// -/// Delete the currently active sound device and release all its resources. SFXSources that are still playing will be transitioned to virtualized playback mode. When creating a new device, they will automatically transition back to normal playback. In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. @see sfxCreateDevice @ref SFX_devices @ingroup SFX ) +/// Delete the currently active sound device and release all its resources. +/// SFXSources that are still playing will be transitioned to virtualized playback mode. +/// When creating a new device, they will automatically transition back to normal playback. +/// In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. +/// @see sfxCreateDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public void sfxDeleteDevice(){ @@ -5672,7 +7997,11 @@ public void sfxDeleteDevice(){ m_ts.fn_sfxDeleteDevice(); } /// -/// Mark the given @a source for deletion as soon as it moves into stopped state. This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). @param source A sound source. @ingroup SFX ) +/// Mark the given @a source for deletion as soon as it moves into stopped state. +/// This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). +/// @param source A sound source. +/// @ingroup SFX ) +/// /// public void sfxDeleteWhenStopped(string source){ @@ -5680,7 +8009,14 @@ public void sfxDeleteWhenStopped(string source){ m_ts.fn_sfxDeleteWhenStopped(source); } /// -/// Dump information about all current SFXSource instances to the console. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @see SFXSource @see sfxDumpSourcesToString @ingroup SFX ) +/// Dump information about all current SFXSource instances to the console. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @see SFXSource +/// @see sfxDumpSourcesToString +/// @ingroup SFX ) +/// /// public void sfxDumpSources(bool includeGroups = false){ @@ -5688,7 +8024,15 @@ public void sfxDumpSources(bool includeGroups = false){ m_ts.fn_sfxDumpSources(includeGroups); } /// -/// Dump information about all current SFXSource instances to a string. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @return A string containing a dump of information about all currently instantiated SFXSources. @see SFXSource @see sfxDumpSources @ingroup SFX ) +/// Dump information about all current SFXSource instances to a string. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @return A string containing a dump of information about all currently instantiated SFXSources. +/// @see SFXSource +/// @see sfxDumpSources +/// @ingroup SFX ) +/// /// public string sfxDumpSourcesToString(bool includeGroups = false){ @@ -5696,7 +8040,19 @@ public string sfxDumpSourcesToString(bool includeGroups = false){ return m_ts.fn_sfxDumpSourcesToString(includeGroups); } /// -/// Return a newline-separated list of all active states. @return A list of the form @verbatim stateName1 NL stateName2 NL stateName3 ... @endverbatim where each element is the name of an active state object. @tsexample // Disable all active states. foreach$( %state in sfxGetActiveStates() ) %state.disable(); @endtsexample @ingroup SFX ) +/// Return a newline-separated list of all active states. +/// @return A list of the form +/// @verbatim +/// stateName1 NL stateName2 NL stateName3 ... +/// @endverbatim +/// where each element is the name of an active state object. +/// @tsexample +/// // Disable all active states. +/// foreach$( %state in sfxGetActiveStates() ) +/// %state.disable(); +/// @endtsexample +/// @ingroup SFX ) +/// /// public string sfxGetActiveStates(){ @@ -5704,7 +8060,29 @@ public string sfxGetActiveStates(){ return m_ts.fn_sfxGetActiveStates(); } /// -/// Get a list of all available sound devices. The return value will be a newline-separated list of entries where each line describes one available sound device. Each such line will have the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. @return A newline-separated list of information about all available sound devices. @see sfxCreateDevice @see sfxGetDeviceInfo @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @ref SFX_devices @ingroup SFX ) +/// Get a list of all available sound devices. +/// The return value will be a newline-separated list of entries where each line describes one available sound +/// device. Each such line will have the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// @return A newline-separated list of information about all available sound devices. +/// @see sfxCreateDevice +/// @see sfxGetDeviceInfo +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string sfxGetAvailableDevices(){ @@ -5712,7 +8090,36 @@ public string sfxGetAvailableDevices(){ return m_ts.fn_sfxGetAvailableDevices(); } /// -/// Return information about the currently active sound device. The return value is a tab-delimited string of the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. - caps: A bitfield of capability flags. @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. @see sfxCreateDevice @see sfxGetAvailableDevices @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @see $SFX::DEVICE_INFO_CAPS @see $SFX::DEVICE_CAPS_REVERB @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT @see $SFX::DEVICE_CAPS_OCCLUSION @see $SFX::DEVICE_CAPS_DSPEFFECTS @see $SFX::DEVICE_CAPS_MULTILISTENER @see $SFX::DEVICE_CAPS_FMODDESIGNER @ref SFX_devices @ingroup SFX ) +/// Return information about the currently active sound device. +/// The return value is a tab-delimited string of the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// - caps: A bitfield of capability flags. +/// @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. +/// @see sfxCreateDevice +/// @see sfxGetAvailableDevices +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @see $SFX::DEVICE_INFO_CAPS +/// @see $SFX::DEVICE_CAPS_REVERB +/// @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT +/// @see $SFX::DEVICE_CAPS_OCCLUSION +/// @see $SFX::DEVICE_CAPS_DSPEFFECTS +/// @see $SFX::DEVICE_CAPS_MULTILISTENER +/// @see $SFX::DEVICE_CAPS_FMODDESIGNER +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string sfxGetDeviceInfo(){ @@ -5720,7 +8127,12 @@ public string sfxGetDeviceInfo(){ return m_ts.fn_sfxGetDeviceInfo(); } /// -/// Get the falloff curve type currently being applied to 3D sounds. @return The current distance model type. @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the falloff curve type currently being applied to 3D sounds. +/// @return The current distance model type. +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public TypeSFXDistanceModel sfxGetDistanceModel(){ @@ -5728,7 +8140,12 @@ public TypeSFXDistanceModel sfxGetDistanceModel(){ return (TypeSFXDistanceModel)( m_ts.fn_sfxGetDistanceModel()); } /// -/// Get the current global doppler effect setting. @return The current global doppler effect scale factor (>=0). @see sfxSetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Get the current global doppler effect setting. +/// @return The current global doppler effect scale factor (>=0). +/// @see sfxSetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public float sfxGetDopplerFactor(){ @@ -5736,7 +8153,14 @@ public float sfxGetDopplerFactor(){ return m_ts.fn_sfxGetDopplerFactor(); } /// -/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. @return The current scale factor for logarithmic 3D sound falloff curves. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. +/// @return The current scale factor for logarithmic 3D sound falloff curves. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public float sfxGetRolloffFactor(){ @@ -5744,7 +8168,10 @@ public float sfxGetRolloffFactor(){ return m_ts.fn_sfxGetRolloffFactor(); } /// -/// , , ), Start playing the given source or create a new source for the given track and play it. @hide ) +/// , , ), +/// Start playing the given source or create a new source for the given track and play it. +/// @hide ) +/// /// public int sfxPlay(string trackName, string pointOrX = "", string y = "", string z = ""){ @@ -5752,7 +8179,11 @@ public int sfxPlay(string trackName, string pointOrX = "", string y = "", strin return m_ts.fn_sfxPlay(trackName, pointOrX, y, z); } /// -/// , , , -1.0f), SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) Create a new play-once source for the given profile or description+filename and start playback of the source. @hide ) +/// , , , -1.0f), +/// SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) +/// Create a new play-once source for the given profile or description+filename and start playback of the source. +/// @hide ) +/// /// public int sfxPlayOnce(string SFXType, string filename, string x = "", string y = "", string z = "", float fadeInTime = -1.0f){ @@ -5760,7 +8191,11 @@ public int sfxPlayOnce(string SFXType, string filename, string x = "", string y return m_ts.fn_sfxPlayOnce(SFXType, filename, x, y, z, fadeInTime); } /// -/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. @param model The distance model to use for 3D sound. @note This setting takes effect globally and is applied to all 3D sounds. @ingroup SFX ) +/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. +/// @param model The distance model to use for 3D sound. +/// @note This setting takes effect globally and is applied to all 3D sounds. +/// @ingroup SFX ) +/// /// public void sfxSetDistanceModel(TypeSFXDistanceModel model){ @@ -5768,7 +8203,13 @@ public void sfxSetDistanceModel(TypeSFXDistanceModel model){ m_ts.fn_sfxSetDistanceModel((int)model ); } /// -/// Set the global doppler effect scale factor. @param value The new doppler shift scale factor. @pre @a value must be >= 0. @see sfxGetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Set the global doppler effect scale factor. +/// @param value The new doppler shift scale factor. +/// @pre @a value must be >= 0. +/// @see sfxGetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public void sfxSetDopplerFactor(float value){ @@ -5776,7 +8217,16 @@ public void sfxSetDopplerFactor(float value){ m_ts.fn_sfxSetDopplerFactor(value); } /// -/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. @param value The new scale factor for logarithmic 3D sound falloff curves. @pre @a value must be > 0. @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. +/// @param value The new scale factor for logarithmic 3D sound falloff curves. +/// @pre @a value must be > 0. +/// @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public void sfxSetRolloffFactor(float value){ @@ -5784,7 +8234,11 @@ public void sfxSetRolloffFactor(float value){ m_ts.fn_sfxSetRolloffFactor(value); } /// -/// Stop playback of the given @a source. This is equivalent to calling SFXSource::stop(). @param source The source to put into stopped state. @ingroup SFX ) +/// Stop playback of the given @a source. +/// This is equivalent to calling SFXSource::stop(). +/// @param source The source to put into stopped state. +/// @ingroup SFX ) +/// /// public void sfxStop(string source){ @@ -5792,7 +8246,15 @@ public void sfxStop(string source){ m_ts.fn_sfxStop(source); } /// -/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. The advantage of this function over directly calling delete() is that it will correctly handle volume fades that may be configured on the source. Whereas calling delete() would immediately stop playback and delete the source, this functionality will wait for the fade-out to play and only then stop the source and delete it. @param source A sound source. @ref SFXSource_fades @ingroup SFX ) +/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. +/// The advantage of this function over directly calling delete() is that it will correctly +/// handle volume fades that may be configured on the source. Whereas calling delete() would immediately +/// stop playback and delete the source, this functionality will wait for the fade-out to play and only then +/// stop the source and delete it. +/// @param source A sound source. +/// @ref SFXSource_fades +/// @ingroup SFX ) +/// /// public void sfxStopAndDelete(string source){ @@ -5800,7 +8262,13 @@ public void sfxStopAndDelete(string source){ m_ts.fn_sfxStopAndDelete(source); } /// -/// , ), (string executable, string args, string directory) @brief Launches an outside executable or batch file @param executable Name of the executable or batch file @param args Optional list of arguments, in string format, to pass to the executable @param directory Optional string containing path to output or shell @ingroup Platform) +/// , ), (string executable, string args, string directory) +/// @brief Launches an outside executable or batch file +/// @param executable Name of the executable or batch file +/// @param args Optional list of arguments, in string format, to pass to the executable +/// @param directory Optional string containing path to output or shell +/// @ingroup Platform) +/// /// public bool shellExecute(string executable, string args = "", string directory = ""){ @@ -5808,7 +8276,11 @@ public bool shellExecute(string executable, string args = "", string directory return m_ts.fn_shellExecute(executable, args, directory); } /// -/// @brief Determines the memory consumption of a class or object. @param objectOrClass The object or class being measured. @return Returns the total size of an object in bytes. @ingroup Debugging) +/// @brief Determines the memory consumption of a class or object. +/// @param objectOrClass The object or class being measured. +/// @return Returns the total size of an object in bytes. +/// @ingroup Debugging) +/// /// public int sizeofx(string objectOrClass){ @@ -5816,7 +8288,25 @@ public int sizeofx(string objectOrClass){ return m_ts.fn_sizeof(objectOrClass); } /// -/// @brief Prevents mouse movement from being processed In the source, whenever a mouse move event occurs GameTSCtrl::onMouseMove() is called. Whenever snapToggle() is called, it will flag a variable that can prevent this from happening: gSnapLine. This variable is not exposed to script, so you need to call this function to trigger it. @tsexample // Snapping is off by default, so we will toggle // it on first: PlayGui.snapToggle(); // Mouse movement should be disabled // Let's turn it back on PlayGui.snapToggle(); @endtsexample @ingroup GuiGame) +/// @brief Prevents mouse movement from being processed +/// +/// In the source, whenever a mouse move event occurs +/// GameTSCtrl::onMouseMove() is called. Whenever snapToggle() +/// is called, it will flag a variable that can prevent this +/// from happening: gSnapLine. This variable is not exposed to +/// script, so you need to call this function to trigger it. +/// +/// @tsexample +/// // Snapping is off by default, so we will toggle +/// // it on first: +/// PlayGui.snapToggle(); +/// // Mouse movement should be disabled +/// // Let's turn it back on +/// PlayGui.snapToggle(); +/// @endtsexample +/// +/// @ingroup GuiGame) +/// /// public void snapToggle(){ @@ -5824,7 +8314,9 @@ public void snapToggle(){ m_ts.fn_snapToggle(); } /// -/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) @hide) +/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) +/// @hide) +/// /// public int spawnObject(string spawnClass, string spawnDataBlock = "", string spawnName = "", string spawnProperties = "", string spawnScript = "", string modelName = ""){ @@ -5832,7 +8324,14 @@ public int spawnObject(string spawnClass, string spawnDataBlock = "", string sp return m_ts.fn_spawnObject(spawnClass, spawnDataBlock, spawnName, spawnProperties, spawnScript, modelName); } /// -/// Activates the shape replicator. @tsexample // Call the function StartClientReplication() @endtsexample @ingroup Foliage ) +/// Activates the shape replicator. +/// @tsexample +/// // Call the function +/// StartClientReplication() +/// @endtsexample +/// @ingroup Foliage +/// ) +/// /// public void StartClientReplication(){ @@ -5840,7 +8339,11 @@ public void StartClientReplication(){ m_ts.fn_StartClientReplication(); } /// -/// @brief Start watching resources for file changes Typically this is called during initializeCore(). @see stopFileChangeNotifications() @ingroup FileSystem) +/// @brief Start watching resources for file changes +/// Typically this is called during initializeCore(). +/// @see stopFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void startFileChangeNotifications(){ @@ -5848,7 +8351,13 @@ public void startFileChangeNotifications(){ m_ts.fn_startFileChangeNotifications(); } /// -/// Activates the foliage replicator. @tsexample // Call the function StartFoliageReplication(); @endtsexample @ingroup Foliage) +/// Activates the foliage replicator. +/// @tsexample +/// // Call the function +/// StartFoliageReplication(); +/// @endtsexample +/// @ingroup Foliage) +/// /// public void StartFoliageReplication(){ @@ -5857,6 +8366,7 @@ public void StartFoliageReplication(){ } /// /// startHeartbeat(...); ) +/// /// public void startHeartbeat(){ @@ -5865,6 +8375,7 @@ public void startHeartbeat(){ } /// /// startPrecisionTimer() - Create and start a high resolution platform timer. Returns the timer id. ) +/// /// public int startPrecisionTimer(){ @@ -5872,7 +8383,18 @@ public int startPrecisionTimer(){ return m_ts.fn_startPrecisionTimer(); } /// -/// Test whether the given string begins with the given prefix. @param str The string to test. @param prefix The potential prefix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. @tsexample startsWith( \"TEST123\", \"test\" ) // Returns true. @endtsexample @see endsWith @ingroup Strings ) +/// Test whether the given string begins with the given prefix. +/// @param str The string to test. +/// @param prefix The potential prefix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"test\" ) // Returns true. +/// @endtsexample +/// @see endsWith +/// @ingroup Strings ) +/// /// public bool startsWith(string str, string prefix, bool caseSensitive = false){ @@ -5880,7 +8402,11 @@ public bool startsWith(string str, string prefix, bool caseSensitive = false){ return m_ts.fn_startsWith(str, prefix, caseSensitive); } /// -/// THEORA, 30.0f, Point2I::Zero ), Begins a video capture session. @see stopVideoCapture @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Begins a video capture session. +/// @see stopVideoCapture +/// @ingroup Rendering ) +/// /// public void startVideoCapture(string canvas, string filename, string encoder = "THEORA", float framerate = 30.0f, Point2I resolution = null ){ if (resolution== null) {resolution = new Point2I(0,0);} @@ -5889,7 +8415,11 @@ public void startVideoCapture(string canvas, string filename, string encoder = m_ts.fn_startVideoCapture(canvas, filename, encoder, framerate, resolution.AsString()); } /// -/// @brief Stop watching resources for file changes Typically this is called during shutdownCore(). @see startFileChangeNotifications() @ingroup FileSystem) +/// @brief Stop watching resources for file changes +/// Typically this is called during shutdownCore(). +/// @see startFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void stopFileChangeNotifications(){ @@ -5898,6 +8428,7 @@ public void stopFileChangeNotifications(){ } /// /// stopHeartbeat(...); ) +/// /// public void stopHeartbeat(){ @@ -5906,6 +8437,7 @@ public void stopHeartbeat(){ } /// /// stopPrecisionTimer( S32 id ) - Stop and destroy timer with the passed id. Returns the elapsed milliseconds. ) +/// /// public int stopPrecisionTimer(int id){ @@ -5913,7 +8445,10 @@ public int stopPrecisionTimer(int id){ return m_ts.fn_stopPrecisionTimer(id); } /// -/// () @brief Stops the rendering sampler @ingroup Rendering) +/// () +/// @brief Stops the rendering sampler +/// @ingroup Rendering) +/// /// public void stopSampling(){ @@ -5922,6 +8457,7 @@ public void stopSampling(){ } /// /// stopServerQuery(...); ) +/// /// public void stopServerQuery(){ @@ -5929,7 +8465,10 @@ public void stopServerQuery(){ m_ts.fn_stopServerQuery(); } /// -/// Stops the video capture session. @see startVideoCapture @ingroup Rendering ) +/// Stops the video capture session. +/// @see startVideoCapture +/// @ingroup Rendering ) +/// /// public void stopVideoCapture(){ @@ -5937,7 +8476,11 @@ public void stopVideoCapture(){ m_ts.fn_stopVideoCapture(); } /// -/// Return the integer character code value corresponding to the first character in the given string. @param chr a (one-character) string. @return the UTF32 code value for the first character in the given string. @ingroup Strings ) +/// Return the integer character code value corresponding to the first character in the given string. +/// @param chr a (one-character) string. +/// @return the UTF32 code value for the first character in the given string. +/// @ingroup Strings ) +/// /// public int strasc(string chr){ @@ -5945,7 +8488,13 @@ public int strasc(string chr){ return m_ts.fn_strasc(chr); } /// -/// Find the first occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strrchr @ingroup Strings ) +/// Find the first occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strrchr +/// @ingroup Strings ) +/// /// public string strchr(string str, string chr){ @@ -5953,7 +8502,16 @@ public string strchr(string str, string chr){ return m_ts.fn_strchr(str, chr); } /// -/// Find the first occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strchrpos( \"test\", \"s\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the first occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strchrpos( \"test\", \"s\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int strchrpos(string str, string chr, int start = 0){ @@ -5961,7 +8519,19 @@ public int strchrpos(string str, string chr, int start = 0){ return m_ts.fn_strchrpos(str, chr, start); } /// -/// Compares two strings using case-b>sensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >1 otherwise. @tsexample if( strcmp( %var, \"foobar\" ) == 0 ) echo( \"%var is equal to 'foobar'\" ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using case-b>sensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >1 otherwise. +/// @tsexample +/// if( strcmp( %var, \"foobar\" ) == 0 ) +/// echo( \"%var is equal to 'foobar'\" ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int strcmp(string str1, string str2){ @@ -5969,7 +8539,16 @@ public int strcmp(string str1, string str2){ return m_ts.fn_strcmp(str1, str2); } /// -/// Format the given value as a string using printf-style formatting. @param format A printf-style format string. @param value The value argument matching the given format string. @tsexample // Convert the given integer value to a string in a hex notation. %hex = strformat( \"%x\", %value ); @endtsexample @ingroup Strings @see http://en.wikipedia.org/wiki/Printf ) +/// Format the given value as a string using printf-style formatting. +/// @param format A printf-style format string. +/// @param value The value argument matching the given format string. +/// @tsexample +/// // Convert the given integer value to a string in a hex notation. +/// %hex = strformat( \"%x\", %value ); +/// @endtsexample +/// @ingroup Strings +/// @see http://en.wikipedia.org/wiki/Printf ) +/// /// public string strformat(string format, string value){ @@ -5977,7 +8556,19 @@ public string strformat(string format, string value){ return m_ts.fn_strformat(format, value); } /// -/// Compares two strings using case-b>insensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >0 otherwise. @tsexample if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) echo( \"this is always true\" ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using case-b>insensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >0 otherwise. +/// @tsexample +/// if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) +/// echo( \"this is always true\" ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int stricmp(string str1, string str2){ @@ -5985,7 +8576,35 @@ public int stricmp(string str1, string str2){ return m_ts.fn_stricmp(str1, str2); } /// -/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int strinatcmp(string str1, string str2){ @@ -5993,7 +8612,15 @@ public int strinatcmp(string str1, string str2){ return m_ts.fn_strinatcmp(str1, str2); } /// -/// Remove all occurrences of characters contained in @a chars from @a str. @param str The string to filter characters out from. @param chars A string of characters to filter out from @a str. @return A version of @a str with all occurrences of characters contained in @a chars filtered out. @tsexample stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". @endtsexample @ingroup Strings ) +/// Remove all occurrences of characters contained in @a chars from @a str. +/// @param str The string to filter characters out from. +/// @param chars A string of characters to filter out from @a str. +/// @return A version of @a str with all occurrences of characters contained in @a chars filtered out. +/// @tsexample +/// stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string stripChars(string str, string chars){ @@ -6001,7 +8628,18 @@ public string stripChars(string str, string chars){ return m_ts.fn_stripChars(str, chars); } /// -/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. @param inString String to strip TorqueML control characters from. @tsexample // Define the string to strip TorqueML control characters from %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; // Request the stripped version of the string %strippedString = StripMLControlChars(%string); @endtsexample @return Version of the inputted string with all TorqueML characters removed. @see References @ingroup GuiCore) +/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. +/// @param inString String to strip TorqueML control characters from. +/// @tsexample +/// // Define the string to strip TorqueML control characters from +/// %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; +/// // Request the stripped version of the string +/// %strippedString = StripMLControlChars(%string); +/// @endtsexample +/// @return Version of the inputted string with all TorqueML characters removed. +/// @see References +/// @ingroup GuiCore) +/// /// public string StripMLControlChars(string inString){ @@ -6009,7 +8647,15 @@ public string StripMLControlChars(string inString){ return m_ts.fn_StripMLControlChars(inString); } /// -/// Strip a numeric suffix from the given string. @param str The string from which to strip its numeric suffix. @return The string @a str without its number suffix or the original string @a str if it has no such suffix. @tsexample stripTrailingNumber( \"test123\" ) // Returns \"test\". @endtsexample @see getTrailingNumber @ingroup Strings ) +/// Strip a numeric suffix from the given string. +/// @param str The string from which to strip its numeric suffix. +/// @return The string @a str without its number suffix or the original string @a str if it has no such suffix. +/// @tsexample +/// stripTrailingNumber( \"test123\" ) // Returns \"test\". +/// @endtsexample +/// @see getTrailingNumber +/// @ingroup Strings ) +/// /// public string stripTrailingNumber(string str){ @@ -6017,7 +8663,19 @@ public string stripTrailingNumber(string str){ return m_ts.fn_stripTrailingNumber(str); } /// -/// Match a pattern against a string. @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match any number of characters and '?' to match a single character. @param str The string which should be matched against @a pattern. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches the given @a pattern. @tsexample strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. @endtsexample @see strIsMatchMultipleExpr @ingroup Strings ) +/// Match a pattern against a string. +/// @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match +/// any number of characters and '?' to match a single character. +/// @param str The string which should be matched against @a pattern. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches the given @a pattern. +/// @tsexample +/// strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchMultipleExpr +/// @ingroup Strings ) +/// /// public bool strIsMatchExpr(string pattern, string str, bool caseSensitive = false){ @@ -6025,7 +8683,19 @@ public bool strIsMatchExpr(string pattern, string str, bool caseSensitive = fal return m_ts.fn_strIsMatchExpr(pattern, str, caseSensitive); } /// -/// Match a multiple patterns against a single string. @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match any number of characters and '?' to match a single character. Each of the patterns is tried in turn. @param str The string which should be matched against @a patterns. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches any of the given @a patterns. @tsexample strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. @endtsexample @see strIsMatchExpr @ingroup Strings ) +/// Match a multiple patterns against a single string. +/// @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match +/// any number of characters and '?' to match a single character. Each of the patterns is tried in turn. +/// @param str The string which should be matched against @a patterns. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches any of the given @a patterns. +/// @tsexample +/// strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Strings ) +/// /// public bool strIsMatchMultipleExpr(string patterns, string str, bool caseSensitive = false){ @@ -6033,7 +8703,12 @@ public bool strIsMatchMultipleExpr(string patterns, string str, bool caseSensit return m_ts.fn_strIsMatchMultipleExpr(patterns, str, caseSensitive); } /// -/// Get the length of the given string in bytes. @note This does b>not/b> return a true character count for strings with multi-byte characters! @param str A string. @return The length of the given string in bytes. @ingroup Strings ) +/// Get the length of the given string in bytes. +/// @note This does b>not/b> return a true character count for strings with multi-byte characters! +/// @param str A string. +/// @return The length of the given string in bytes. +/// @ingroup Strings ) +/// /// public int strlen(string str){ @@ -6041,7 +8716,15 @@ public int strlen(string str){ return m_ts.fn_strlen(str); } /// -/// Return an all lower-case version of the given string. @param str A string. @return A version of @a str with all characters converted to lower-case. @tsexample strlwr( \"TesT1\" ) // Returns \"test1\" @endtsexample @see strupr @ingroup Strings ) +/// Return an all lower-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to lower-case. +/// @tsexample +/// strlwr( \"TesT1\" ) // Returns \"test1\" +/// @endtsexample +/// @see strupr +/// @ingroup Strings ) +/// /// public string strlwr(string str){ @@ -6049,7 +8732,35 @@ public string strlwr(string str){ return m_ts.fn_strlwr(str); } /// -/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int strnatcmp(string str1, string str2){ @@ -6057,7 +8768,15 @@ public int strnatcmp(string str1, string str2){ return m_ts.fn_strnatcmp(str1, str2); } /// -/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. @param haystack The string to search. @param needle The string to search for. @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. @tsexample strpos( \"b ab\", \"b\", 1 ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. +/// @param haystack The string to search. +/// @param needle The string to search for. +/// @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. +/// @tsexample +/// strpos( \"b ab\", \"b\", 1 ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int strpos(string haystack, string needle, int offset = 0){ @@ -6065,7 +8784,13 @@ public int strpos(string haystack, string needle, int offset = 0){ return m_ts.fn_strpos(haystack, needle, offset); } /// -/// Find the last occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strchr @ingroup Strings ) +/// Find the last occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strchr +/// @ingroup Strings ) +/// /// public string strrchr(string str, string chr){ @@ -6073,7 +8798,16 @@ public string strrchr(string str, string chr){ return m_ts.fn_strrchr(str, chr); } /// -/// Find the last occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strrchrpos( \"test\", \"t\" ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the last occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strrchrpos( \"test\", \"t\" ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int strrchrpos(string str, string chr, int start = 0){ @@ -6081,7 +8815,17 @@ public int strrchrpos(string str, string chr, int start = 0){ return m_ts.fn_strrchrpos(str, chr, start); } /// -/// ), Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. @param str The string to repeat multiple times. @param numTimes The number of times to repeat @a str in the result string. @param delimiter The string to put between each repetition of @a str. @return A string containing @a str repeated @a numTimes times. @tsexample strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". @endtsexample @ingroup Strings ) +/// ), +/// Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. +/// @param str The string to repeat multiple times. +/// @param numTimes The number of times to repeat @a str in the result string. +/// @param delimiter The string to put between each repetition of @a str. +/// @return A string containing @a str repeated @a numTimes times. +/// @tsexample +/// strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string strrepeat(string str, int numTimes, string delimiter = ""){ @@ -6089,7 +8833,16 @@ public string strrepeat(string str, int numTimes, string delimiter = ""){ return m_ts.fn_strrepeat(str, numTimes, delimiter); } /// -/// Replace all occurrences of @a from in @a source with @a to. @param source The string in which to replace the occurrences of @a from. @param from The string to replace in @a source. @param to The string with which to replace occurrences of @from. @return A string with all occurrences of @a from in @a source replaced by @a to. @tsexample strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". @endtsexample @ingroup Strings ) +/// Replace all occurrences of @a from in @a source with @a to. +/// @param source The string in which to replace the occurrences of @a from. +/// @param from The string to replace in @a source. +/// @param to The string with which to replace occurrences of @from. +/// @return A string with all occurrences of @a from in @a source replaced by @a to. +/// @tsexample +/// strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string strreplace(string source, string from, string to){ @@ -6097,7 +8850,15 @@ public string strreplace(string source, string from, string to){ return m_ts.fn_strreplace(source, from, to); } /// -/// Find the start of @a substring in the given @a string searching from left to right. @param string The string to search. @param substring The string to search for. @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. @tsexample strstr( \"abcd\", \"c\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the start of @a substring in the given @a string searching from left to right. +/// @param string The string to search. +/// @param substring The string to search for. +/// @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. +/// @tsexample +/// strstr( \"abcd\", \"c\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int strstr(string stringx, string substring){ @@ -6106,6 +8867,7 @@ public int strstr(string stringx, string substring){ } /// /// strToPlayerName(string); ) +/// /// public string strToPlayerName(string ptr){ @@ -6113,7 +8875,15 @@ public string strToPlayerName(string ptr){ return m_ts.fn_strToPlayerName(ptr); } /// -/// Return an all upper-case version of the given string. @param str A string. @return A version of @a str with all characters converted to upper-case. @tsexample strupr( \"TesT1\" ) // Returns \"TEST1\" @endtsexample @see strlwr @ingroup Strings ) +/// Return an all upper-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to upper-case. +/// @tsexample +/// strupr( \"TesT1\" ) // Returns \"TEST1\" +/// @endtsexample +/// @see strlwr +/// @ingroup Strings ) +/// /// public string strupr(string str){ @@ -6121,7 +8891,13 @@ public string strupr(string str){ return m_ts.fn_strupr(str); } /// -/// @brief Initializes and open the telnet console. @param port Port to listen on for console connections (0 will shut down listening). @param consolePass Password for read/write access to console. @param listenPass Password for read access to console. @param remoteEcho [optional] Enable echoing back to the client, off by default. @ingroup Debugging) +/// @brief Initializes and open the telnet console. +/// @param port Port to listen on for console connections (0 will shut down listening). +/// @param consolePass Password for read/write access to console. +/// @param listenPass Password for read access to console. +/// @param remoteEcho [optional] Enable echoing back to the client, off by default. +/// @ingroup Debugging) +/// /// public void telnetSetParameters(int port, string consolePass, string listenPass, bool remoteEcho = false){ @@ -6130,6 +8906,7 @@ public void telnetSetParameters(int port, string consolePass, string listenPass } /// /// testBridge(arg1, arg2, arg3)) +/// /// public string testJavaScriptBridge(string arg1, string arg2, string arg3){ @@ -6137,7 +8914,13 @@ public string testJavaScriptBridge(string arg1, string arg2, string arg3){ return m_ts.fn_testJavaScriptBridge(arg1, arg2, arg3); } /// -/// Enable or disable tracing in the script code VM. When enabled, the script code runtime will trace the invocation and returns from all functions that are called and log them to the console. This is helpful in observing the flow of the script program. @param enable New setting for script trace execution, on by default. @ingroup Debugging ) +/// Enable or disable tracing in the script code VM. +/// When enabled, the script code runtime will trace the invocation and returns +/// from all functions that are called and log them to the console. This is helpful in +/// observing the flow of the script program. +/// @param enable New setting for script trace execution, on by default. +/// @ingroup Debugging ) +/// /// public void trace(bool enable = true){ @@ -6145,7 +8928,14 @@ public void trace(bool enable = true){ m_ts.fn_trace(enable); } /// -/// Remove leading and trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. @tsexample trim( \" string \" ); // Returns \"string\". @endtsexample @ingroup Strings ) +/// Remove leading and trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// trim( \" string \" ); // Returns \"string\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string trim(string str){ @@ -6154,6 +8944,7 @@ public string trim(string str){ } /// /// tsUpdateImposterImages( bool forceupdate )) +/// /// public void tsUpdateImposterImages(bool forceUpdate = false){ @@ -6161,15 +8952,12 @@ public void tsUpdateImposterImages(bool forceUpdate = false){ m_ts.fn_tsUpdateImposterImages(forceUpdate); } /// -/// , false), ([searchString[, bool skipInteractive]]) @brief Run unit tests, or just the tests that prefix match against the searchString. @ingroup Console) -/// -public void unitTest_runTests(string searchString = "", bool skip = false){ - - -m_ts.fn_unitTest_runTests(searchString, skip); -} -/// -/// (string queueName, string listener) @brief Unregisters an event message @param queueName String containing the name of queue @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Unregisters an event message +/// @param queueName String containing the name of queue +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public void unregisterMessageListener(string queueName, string listenerName){ @@ -6177,7 +8965,11 @@ public void unregisterMessageListener(string queueName, string listenerName){ m_ts.fn_unregisterMessageListener(queueName, listenerName); } /// -/// (string queueName) @brief Unregisters a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Unregisters a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void unregisterMessageQueue(string queueName){ @@ -6185,7 +8977,28 @@ public void unregisterMessageQueue(string queueName){ m_ts.fn_unregisterMessageQueue(queueName); } /// -/// Add two vectors. @param a The first vector. @param b The second vector. @return The vector @a a + @a b. @tsexample //----------------------------------------------------------------------------- // // VectorAdd( %a, %b ); // // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a + b = ( ax + bx, ay + by, az + bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; // %r = \"1 1 0\"; %r = VectorAdd( %a, %b ); @endtsexample @ingroup Vectors) +/// Add two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a + @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorAdd( %a, %b ); +/// // +/// // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a + b = ( ax + bx, ay + by, az + bz ) +/// // +/// //----------------------------------------------------------------------------- +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; +/// // %r = \"1 1 0\"; +/// %r = VectorAdd( %a, %b ); +/// @endtsexample +/// @ingroup Vectors) +/// /// public Point3F VectorAdd(Point3F a, Point3F b){ @@ -6193,7 +9006,30 @@ public Point3F VectorAdd(Point3F a, Point3F b){ return new Point3F ( m_ts.fn_VectorAdd(a.AsString(), b.AsString())); } /// -/// Calculcate the cross product of two vectors. @param a The first vector. @param b The second vector. @return The cross product @a x @a b. @tsexample //----------------------------------------------------------------------------- // // VectorCross( %a, %b ); // // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; // %r = \"1 -1 -2\"; %r = VectorCross( %a, %b ); @endtsexample @ingroup Vectors ) +/// Calculcate the cross product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The cross product @a x @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorCross( %a, %b ); +/// // +/// // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; +/// // %r = \"1 -1 -2\"; +/// %r = VectorCross( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorCross(Point3F a, Point3F b){ @@ -6201,7 +9037,32 @@ public Point3F VectorCross(Point3F a, Point3F b){ return new Point3F ( m_ts.fn_VectorCross(a.AsString(), b.AsString())); } /// -/// Compute the distance between two vectors. @param a The first vector. @param b The second vector. @return The length( @a b - @a a ). @tsexample //----------------------------------------------------------------------------- // // VectorDist( %a, %b ); // // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a -> b = ||( b - a )|| // = ||( bx - ax, by - ay, bz - az )|| // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); // %r = mSqrt( 3 ); %r = VectorDist( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the distance between two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The length( @a b - @a a ). +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDist( %a, %b ); +/// // +/// // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a -> b = ||( b - a )|| +/// // = ||( bx - ax, by - ay, bz - az )|| +/// // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); +/// // %r = mSqrt( 3 ); +/// %r = VectorDist( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float VectorDist(Point3F a, Point3F b){ @@ -6209,7 +9070,30 @@ public float VectorDist(Point3F a, Point3F b){ return m_ts.fn_VectorDist(a.AsString(), b.AsString()); } /// -/// Compute the dot product of two vectors. @param a The first vector. @param b The second vector. @return The dot product @a a * @a b. @tsexample //----------------------------------------------------------------------------- // // VectorDot( %a, %b ); // // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: // // a . b = ( ax * bx + ay * by + az * bz ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; // %r = 2; %r = VectorDot( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the dot product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The dot product @a a * @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDot( %a, %b ); +/// // +/// // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: +/// // +/// // a . b = ( ax * bx + ay * by + az * bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; +/// // %r = 2; +/// %r = VectorDot( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float VectorDot(Point3F a, Point3F b){ @@ -6217,7 +9101,29 @@ public float VectorDot(Point3F a, Point3F b){ return m_ts.fn_VectorDot(a.AsString(), b.AsString()); } /// -/// Calculate the magnitude of the given vector. @param v A vector. @return The length of vector @a v. @tsexample //----------------------------------------------------------------------------- // // VectorLen( %a ); // // The length or magnitude of vector a, (ax, ay, az), is: // // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); // %r = mSqrt( 2 ); // %r = 1.414; %r = VectorLen( %a ); @endtsexample @ingroup Vectors ) +/// Calculate the magnitude of the given vector. +/// @param v A vector. +/// @return The length of vector @a v. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLen( %a ); +/// // +/// // The length or magnitude of vector a, (ax, ay, az), is: +/// // +/// // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// +/// // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); +/// // %r = mSqrt( 2 ); +/// // %r = 1.414; +/// %r = VectorLen( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float VectorLen(Point3F v){ @@ -6225,7 +9131,35 @@ public float VectorLen(Point3F v){ return m_ts.fn_VectorLen(v.AsString()); } /// -/// Linearly interpolate between two vectors by @a t. @param a Vector to start interpolation from. @param b Vector to interpolate to. @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector between @a a and @a b is returned. @return An interpolated vector between @a a and @a b. @tsexample //----------------------------------------------------------------------------- // // VectorLerp( %a, %b ); // // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is // weighted by the interpolation factor, t, is // // r = a + t * ( b - a ) // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; %v = \"0.25\"; // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; // %r = \"1.25 0.75 0.25\"; %r = VectorLerp( %a, %b ); @endtsexample @ingroup Vectors ) +/// Linearly interpolate between two vectors by @a t. +/// @param a Vector to start interpolation from. +/// @param b Vector to interpolate to. +/// @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector +/// between @a a and @a b is returned. +/// @return An interpolated vector between @a a and @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLerp( %a, %b ); +/// // +/// // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is +/// // weighted by the interpolation factor, t, is +/// // +/// // r = a + t * ( b - a ) +/// // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// %v = \"0.25\"; +/// +/// // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; +/// // %r = \"1.25 0.75 0.25\"; +/// %r = VectorLerp( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorLerp(Point3F a, Point3F b, float t){ @@ -6233,7 +9167,30 @@ public Point3F VectorLerp(Point3F a, Point3F b, float t){ return new Point3F ( m_ts.fn_VectorLerp(a.AsString(), b.AsString(), t)); } /// -/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. @param v The vector to normalize. @return The vector @a v scaled to length 1. @tsexample //----------------------------------------------------------------------------- // // VectorNormalize( %a ); // // The normalized vector a, (ax, ay, az), is: // // a^ = a / ||a|| // = ( ax / ||a||, ay / ||a||, az / ||a|| ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %l = 1.414; // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; // %r = \"0.707 0.707 0\"; %r = VectorNormalize( %a ); @endtsexample @ingroup Vectors ) +/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. +/// @param v The vector to normalize. +/// @return The vector @a v scaled to length 1. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorNormalize( %a ); +/// // +/// // The normalized vector a, (ax, ay, az), is: +/// // +/// // a^ = a / ||a|| +/// // = ( ax / ||a||, ay / ||a||, az / ||a|| ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %l = 1.414; +/// +/// // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; +/// // %r = \"0.707 0.707 0\"; +/// %r = VectorNormalize( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorNormalize(Point3F v){ @@ -6241,7 +9198,11 @@ public Point3F VectorNormalize(Point3F v){ return new Point3F ( m_ts.fn_VectorNormalize(v.AsString())); } /// -/// Create an orthogonal basis from the given vector. @param aaf The vector to create the orthogonal basis from. @return A matrix representing the orthogonal basis. @ingroup Vectors ) +/// Create an orthogonal basis from the given vector. +/// @param aaf The vector to create the orthogonal basis from. +/// @return A matrix representing the orthogonal basis. +/// @ingroup Vectors ) +/// /// public MatrixF VectorOrthoBasis(AngAxisF aa){ @@ -6250,6 +9211,7 @@ public MatrixF VectorOrthoBasis(AngAxisF aa){ } /// /// (Vector3F, float) rotate a vector in 2d) +/// /// public string VectorRot(Point3F v, float angle){ @@ -6257,7 +9219,30 @@ public string VectorRot(Point3F v, float angle){ return m_ts.fn_VectorRot(v.AsString(), angle); } /// -/// Scales a vector by a scalar. @param a The vector to scale. @param scalar The scale factor. @return The vector @a a * @a scalar. @tsexample //----------------------------------------------------------------------------- // // VectorScale( %a, %v ); // // Scaling vector a, (ax, ay, az), but the scalar, v, is: // // a * v = ( ax * v, ay * v, az * v ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %v = \"2\"; // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; // %r = \"2 2 0\"; %r = VectorScale( %a, %v ); @endtsexample @ingroup Vectors ) +/// Scales a vector by a scalar. +/// @param a The vector to scale. +/// @param scalar The scale factor. +/// @return The vector @a a * @a scalar. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorScale( %a, %v ); +/// // +/// // Scaling vector a, (ax, ay, az), but the scalar, v, is: +/// // +/// // a * v = ( ax * v, ay * v, az * v ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %v = \"2\"; +/// +/// // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; +/// // %r = \"2 2 0\"; +/// %r = VectorScale( %a, %v ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorScale(Point3F a, float scalar){ @@ -6265,7 +9250,30 @@ public Point3F VectorScale(Point3F a, float scalar){ return new Point3F ( m_ts.fn_VectorScale(a.AsString(), scalar)); } /// -/// Subtract two vectors. @param a The first vector. @param b The second vector. @return The vector @a a - @a b. @tsexample //----------------------------------------------------------------------------- // // VectorSub( %a, %b ); // // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a - b = ( ax - bx, ay - by, az - bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; // %r = \"1 -1 0\"; %r = VectorSub( %a, %b ); @endtsexample @ingroup Vectors ) +/// Subtract two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a - @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorSub( %a, %b ); +/// // +/// // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a - b = ( ax - bx, ay - by, az - bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// +/// // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; +/// // %r = \"1 -1 0\"; +/// %r = VectorSub( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorSub(Point3F a, Point3F b){ @@ -6291,7 +9299,9 @@ public void WalkaboutUpdateMesh(int meshid = 0, int objid = 0, bool remove = fa m_ts.fn_WalkaboutUpdateMesh(meshid, objid, remove); } /// -/// Force all cached fonts to serialize themselves to the cache. @ingroup Font ) +/// Force all cached fonts to serialize themselves to the cache. +/// @ingroup Font ) +/// /// public void writeFontCache(){ @@ -6304,14 +9314,10 @@ public void writeFontCache(){ /// public class ActionMapObject { -private Omni m_ts; - /// - /// - /// - /// -public ActionMapObject(ref Omni ts){m_ts = ts;} /// -/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) @hide) +/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) +/// @hide) +/// /// public bool bind(string actionmap, string a2, string a3, string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= ""){ @@ -6319,7 +9325,29 @@ public bool bind(string actionmap, string a2, string a3, string a4= "", string return m_ts.fnActionMap_bind(actionmap, a2, a3, a4, a5, a6, a7, a8, a9); } /// -/// ), @brief Associates a make command and optional break command to a specified input device action. Must include parenthesis and semicolon in the make and break command strings. @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. @param makeCmd The command to execute when the device/action is made. @param breakCmd [optional] The command to execute when the device or action is unmade. @return True the bind was successful, false if the device was unknown or description failed. @tsexample // Print to the console when the spacebar is pressed function onSpaceDown() { echo(\"Space bar down!\"); } // Print to the console when the spacebar is released function onSpaceUp() { echo(\"Space bar up!\"); } // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); @endtsexample) +/// ), +/// @brief Associates a make command and optional break command to a specified input device action. +/// Must include parenthesis and semicolon in the make and break command strings. +/// @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. +/// @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. +/// @param makeCmd The command to execute when the device/action is made. +/// @param breakCmd [optional] The command to execute when the device or action is unmade. +/// @return True the bind was successful, false if the device was unknown or description failed. +/// @tsexample +/// // Print to the console when the spacebar is pressed +/// function onSpaceDown() +/// { +/// echo(\"Space bar down!\"); +/// } +/// // Print to the console when the spacebar is released +/// function onSpaceUp() +/// { +/// echo(\"Space bar up!\"); +/// } +/// // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events +/// moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); +/// @endtsexample) +/// /// public bool bindCmd(string actionmap, string device, string action, string makeCmd, string breakCmd = ""){ @@ -6327,7 +9355,9 @@ public bool bindCmd(string actionmap, string device, string action, string make return m_ts.fnActionMap_bindCmd(actionmap, device, action, makeCmd, breakCmd); } /// -/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) @hide) +/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) +/// @hide) +/// /// public bool bindObj(string actionmap, string a2, string a3, string a4, string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= ""){ @@ -6335,7 +9365,24 @@ public bool bindObj(string actionmap, string a2, string a3, string a4, string a return m_ts.fnActionMap_bindObj(actionmap, a2, a3, a4, a5, a6, a7, a8, a9, a10); } /// -/// @brief Gets the ActionMap binding for the specified command. Use getField() on the return value to get the device and action of the binding. @param command The function to search bindings for. @return The binding against the specified command. Returns an empty string(\"\") if a binding wasn't found. @tsexample // Find what the function \"jump()\" is bound to in moveMap %bind = moveMap.getBinding( \"jump\" ); if ( %bind !$= \"\" ) { // Find out what device is used in the binding %device = getField( %bind, 0 ); // Find out what action (such as a key) is used in the binding %action = getField( %bind, 1 ); } @endtsexample @see getField) +/// @brief Gets the ActionMap binding for the specified command. +/// Use getField() on the return value to get the device and action of the binding. +/// @param command The function to search bindings for. +/// @return The binding against the specified command. Returns an empty string(\"\") +/// if a binding wasn't found. +/// @tsexample +/// // Find what the function \"jump()\" is bound to in moveMap +/// %bind = moveMap.getBinding( \"jump\" ); +/// if ( %bind !$= \"\" ) +/// { +/// // Find out what device is used in the binding +/// %device = getField( %bind, 0 ); +/// // Find out what action (such as a key) is used in the binding +/// %action = getField( %bind, 1 ); +/// } +/// @endtsexample +/// @see getField) +/// /// public string getBinding(string actionmap, string command){ @@ -6343,7 +9390,18 @@ public string getBinding(string actionmap, string command){ return m_ts.fnActionMap_getBinding(actionmap, command); } /// -/// @brief Gets ActionMap command for the device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The command against the specified device and action. @tsexample // Find what function is bound to a device\'s action // In this example, \"jump()\" was assigned to the space key in another script %command = moveMap.getCommand(\"keyboard\", \"space\"); // Should print \"jump\" in the console echo(%command) @endtsexample) +/// @brief Gets ActionMap command for the device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The command against the specified device and action. +/// @tsexample +/// // Find what function is bound to a device\'s action +/// // In this example, \"jump()\" was assigned to the space key in another script +/// %command = moveMap.getCommand(\"keyboard\", \"space\"); +/// // Should print \"jump\" in the console +/// echo(%command) +/// @endtsexample) +/// /// public string getCommand(string actionmap, string device, string action){ @@ -6351,7 +9409,15 @@ public string getCommand(string actionmap, string device, string action){ return m_ts.fnActionMap_getCommand(actionmap, device, action); } /// -/// @brief Gets the Dead zone for the specified device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone or an empty string(\"\") if the mapping was not found. @tsexample %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Gets the Dead zone for the specified device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone +/// or an empty string(\"\") if the mapping was not found. +/// @tsexample +/// %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public string getDeadZone(string actionmap, string device, string action){ @@ -6359,7 +9425,14 @@ public string getDeadZone(string actionmap, string device, string action){ return m_ts.fnActionMap_getDeadZone(actionmap, device, action); } /// -/// @brief Get any scaling on the specified device and action. @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return Any scaling applied to the specified device and action. @tsexample %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Get any scaling on the specified device and action. +/// @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return Any scaling applied to the specified device and action. +/// @tsexample +/// %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public float getScale(string actionmap, string device, string action){ @@ -6367,7 +9440,16 @@ public float getScale(string actionmap, string device, string action){ return m_ts.fnActionMap_getScale(actionmap, device, action); } /// -/// @brief Determines if the specified device and action is inverted. Should only be used for scrolling devices or gamepad/joystick axes. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return True if the specified device and action is inverted. @tsexample %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) echo(\"Mouse's xAxis is inverted\"); @endtsexample) +/// @brief Determines if the specified device and action is inverted. +/// Should only be used for scrolling devices or gamepad/joystick axes. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the specified device and action is inverted. +/// @tsexample +/// %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) +/// echo(\"Mouse's xAxis is inverted\"); +/// @endtsexample) +/// /// public bool isInverted(string actionmap, string device, string action){ @@ -6375,7 +9457,14 @@ public bool isInverted(string actionmap, string device, string action){ return m_ts.fnActionMap_isInverted(actionmap, device, action); } /// -/// @brief Pop the ActionMap off the %ActionMap stack. Deactivates an %ActionMap and removes it from the @ActionMap stack. @tsexample // Deactivate moveMap moveMap.pop(); @endtsexample @see ActionMap) +/// @brief Pop the ActionMap off the %ActionMap stack. +/// Deactivates an %ActionMap and removes it from the @ActionMap stack. +/// @tsexample +/// // Deactivate moveMap +/// moveMap.pop(); +/// @endtsexample +/// @see ActionMap) +/// /// public void pop(string actionmap){ @@ -6383,7 +9472,14 @@ public void pop(string actionmap){ m_ts.fnActionMap_pop(actionmap); } /// -/// @brief Push the ActionMap onto the %ActionMap stack. Activates an ActionMap and placees it at the top of the ActionMap stack. @tsexample // Make moveMap the active action map moveMap.push(); @endtsexample @see ActionMap) +/// @brief Push the ActionMap onto the %ActionMap stack. +/// Activates an ActionMap and placees it at the top of the ActionMap stack. +/// @tsexample +/// // Make moveMap the active action map +/// moveMap.push(); +/// @endtsexample +/// @see ActionMap) +/// /// public void push(string actionmap){ @@ -6391,7 +9487,15 @@ public void push(string actionmap){ m_ts.fnActionMap_push(actionmap); } /// -/// @brief Saves the ActionMap to a file or dumps it to the console. @param fileName The file path to save the ActionMap to. If a filename is not specified the ActionMap will be dumped to the console. @param append Whether to write the ActionMap at the end of the file or overwrite it. @tsexample // Write out the actionmap into the config.cs file moveMap.save( \"scripts/client/config.cs\" ); @endtsexample) +/// @brief Saves the ActionMap to a file or dumps it to the console. +/// @param fileName The file path to save the ActionMap to. If a filename is not specified +/// the ActionMap will be dumped to the console. +/// @param append Whether to write the ActionMap at the end of the file or overwrite it. +/// @tsexample +/// // Write out the actionmap into the config.cs file +/// moveMap.save( \"scripts/client/config.cs\" ); +/// @endtsexample) +/// /// public void save(string actionmap, string fileName = null , bool append = false){ if (fileName== null) {fileName = null;} @@ -6400,7 +9504,14 @@ public void save(string actionmap, string fileName = null , bool append = false m_ts.fnActionMap_save(actionmap, fileName, append); } /// -/// @brief Removes the binding on an input device and action. @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbind(\"keyboard\", \"space\"); @endtsexample) +/// @brief Removes the binding on an input device and action. +/// @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbind(\"keyboard\", \"space\"); +/// @endtsexample) +/// /// public bool unbind(string actionmap, string device, string action){ @@ -6408,7 +9519,15 @@ public bool unbind(string actionmap, string device, string action){ return m_ts.fnActionMap_unbind(actionmap, device, action); } /// -/// @brief Remove any object-binding on an input device and action. @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @param obj The object to perform unbind against. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); @endtsexample) +/// @brief Remove any object-binding on an input device and action. +/// @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @param obj The object to perform unbind against. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); +/// @endtsexample) +/// /// public bool unbindObj(string actionmap, string device, string action, string obj){ @@ -6421,14 +9540,9 @@ public bool unbindObj(string actionmap, string device, string action, string ob /// public class AIClientObject { -private Omni m_ts; - /// - /// - /// - /// -public AIClientObject(ref Omni ts){m_ts = ts;} /// /// ai.getAimLocation(); ) +/// /// public string AIClient_getAimLocation(string aiclient){ @@ -6437,6 +9551,7 @@ public string AIClient_getAimLocation(string aiclient){ } /// /// ai.getLocation(); ) +/// /// public string AIClient_getLocation(string aiclient){ @@ -6445,6 +9560,7 @@ public string AIClient_getLocation(string aiclient){ } /// /// ai.getMoveDestination(); ) +/// /// public string AIClient_getMoveDestination(string aiclient){ @@ -6453,6 +9569,7 @@ public string AIClient_getMoveDestination(string aiclient){ } /// /// ai.getTargetObject(); ) +/// /// public int AIClient_getTargetObject(string aiclient){ @@ -6461,6 +9578,7 @@ public int AIClient_getTargetObject(string aiclient){ } /// /// ai.missionCycleCleanup(); ) +/// /// public void AIClient_missionCycleCleanup(string aiclient){ @@ -6469,6 +9587,7 @@ public void AIClient_missionCycleCleanup(string aiclient){ } /// /// ai.move(); ) +/// /// public void AIClient_move(string aiclient){ @@ -6477,6 +9596,7 @@ public void AIClient_move(string aiclient){ } /// /// ai.moveForward(); ) +/// /// public void AIClient_moveForward(string aiclient){ @@ -6485,6 +9605,7 @@ public void AIClient_moveForward(string aiclient){ } /// /// ai.setAimLocation( x y z ); ) +/// /// public void AIClient_setAimLocation(string aiclient, Point3F v){ @@ -6493,6 +9614,7 @@ public void AIClient_setAimLocation(string aiclient, Point3F v){ } /// /// ai.setMoveDestination( x y z ); ) +/// /// public void AIClient_setMoveDestination(string aiclient, Point3F v){ @@ -6501,6 +9623,7 @@ public void AIClient_setMoveDestination(string aiclient, Point3F v){ } /// /// ai.setMoveSpeed( float ); ) +/// /// public void AIClient_setMoveSpeed(string aiclient, float speed){ @@ -6509,6 +9632,7 @@ public void AIClient_setMoveSpeed(string aiclient, float speed){ } /// /// ai.setTargetObject( obj ); ) +/// /// public void AIClient_setTargetObject(string aiclient, string objName){ @@ -6517,6 +9641,7 @@ public void AIClient_setTargetObject(string aiclient, string objName){ } /// /// ai.stop(); ) +/// /// public void AIClient_stop(string aiclient){ @@ -6529,14 +9654,9 @@ public void AIClient_stop(string aiclient){ /// public class AIConnectionObject { -private Omni m_ts; - /// - /// - /// - /// -public AIConnectionObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public string AIConnection_getAddress(string aiconnection){ @@ -6544,7 +9664,9 @@ public string AIConnection_getAddress(string aiconnection){ return m_ts.fn_AIConnection_getAddress(aiconnection); } /// -/// getFreeLook() Is freelook on for the current move?) +/// getFreeLook() +/// Is freelook on for the current move?) +/// /// public bool AIConnection_getFreeLook(string aiconnection){ @@ -6552,7 +9674,11 @@ public bool AIConnection_getFreeLook(string aiconnection){ return m_ts.fn_AIConnection_getFreeLook(aiconnection); } /// -/// (string field) Get the given field of a move. @param field One of {'x','y','z','yaw','pitch','roll'} @returns The requested field on the current move.) +/// (string field) +/// Get the given field of a move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @returns The requested field on the current move.) +/// /// public float AIConnection_getMove(string aiconnection, string field){ @@ -6560,7 +9686,9 @@ public float AIConnection_getMove(string aiconnection, string field){ return m_ts.fn_AIConnection_getMove(aiconnection, field); } /// -/// (int trigger) Is the given trigger set?) +/// (int trigger) +/// Is the given trigger set?) +/// /// public bool AIConnection_getTrigger(string aiconnection, int idx){ @@ -6568,7 +9696,9 @@ public bool AIConnection_getTrigger(string aiconnection, int idx){ return m_ts.fn_AIConnection_getTrigger(aiconnection, idx); } /// -/// (bool isFreeLook) Enable/disable freelook on the current move.) +/// (bool isFreeLook) +/// Enable/disable freelook on the current move.) +/// /// public void AIConnection_setFreeLook(string aiconnection, bool isFreeLook){ @@ -6576,7 +9706,11 @@ public void AIConnection_setFreeLook(string aiconnection, bool isFreeLook){ m_ts.fn_AIConnection_setFreeLook(aiconnection, isFreeLook); } /// -/// (string field, float value) Set a field on the current move. @param field One of {'x','y','z','yaw','pitch','roll'} @param value Value to set field to.) +/// (string field, float value) +/// Set a field on the current move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @param value Value to set field to.) +/// /// public void AIConnection_setMove(string aiconnection, string field, float value){ @@ -6584,7 +9718,9 @@ public void AIConnection_setMove(string aiconnection, string field, float value m_ts.fn_AIConnection_setMove(aiconnection, field, value); } /// -/// (int trigger, bool set) Set a trigger.) +/// (int trigger, bool set) +/// Set a trigger.) +/// /// public void AIConnection_setTrigger(string aiconnection, int idx, bool set){ @@ -6597,14 +9733,11 @@ public void AIConnection_setTrigger(string aiconnection, int idx, bool set){ /// public class AIPlayerObject { -private Omni m_ts; - /// - /// - /// - /// -public AIPlayerObject(ref Omni ts){m_ts = ts;} /// -/// ( GameBase obj, [Point3F offset] ) Sets the bot's target object. Optionally set an offset from target location. @hide) +/// ( GameBase obj, [Point3F offset] ) +/// Sets the bot's target object. Optionally set an offset from target location. +/// @hide) +/// /// public void AIPlayer_setAimObject(string aiplayer, string objName, Point3F offset = null ){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} @@ -6613,7 +9746,8 @@ public void AIPlayer_setAimObject(string aiplayer, string objName, Point3F offs m_ts.fn_AIPlayer_setAimObject(aiplayer, objName, offset.AsString()); } /// -/// ) +/// ) +/// /// public void AISearchSimSet(string aiplayer, float fOV, float farDist, string ObjToSearch, string result){ @@ -6621,7 +9755,37 @@ public void AISearchSimSet(string aiplayer, float fOV, float farDist, string Ob m_ts.fnAIPlayer_AISearchSimSet(aiplayer, fOV, farDist, ObjToSearch, result); } /// -/// @brief Use this to stop aiming at an object or a point. @see setAimLocation() @see setAimObject()) +/// @brief Check whether an object is within a specified veiw cone. +/// @obj Object to check. (If blank, it will check the current target). +/// @fov view angle in degrees.(Defaults to 45) +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// +public bool checkInFoV(string aiplayer, string obj = null , float fov = 45.0f, bool checkEnabled = false){ +if (obj== null) {obj = null;} + + +return m_ts.fnAIPlayer_checkInFoV(aiplayer, obj, fov, checkEnabled); +} +/// +/// @brief Check whether an object is in line of sight. +/// @obj Object to check. (If blank, it will check the current target). +/// @useMuzzle Use muzzle position. Otherwise use eye position. (defaults to false). +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// +public bool checkInLos(string aiplayer, string obj = null , bool useMuzzle = false, bool checkEnabled = false){ +if (obj== null) {obj = null;} + + +return m_ts.fnAIPlayer_checkInLos(aiplayer, obj, useMuzzle, checkEnabled); +} +/// +/// @brief Use this to stop aiming at an object or a point. +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public void clearAim(string aiplayer){ @@ -6679,7 +9843,18 @@ public void followObject(string aiplayer, uint obj, float radius){ m_ts.fnAIPlayer_followObject(aiplayer, obj, radius); } /// -/// @brief Returns the point the AIPlayer is aiming at. This will reflect the position set by setAimLocation(), or the position of the object that the bot is now aiming at. If the bot is not aiming at anything, this value will change to whatever point the bot's current line-of-sight intercepts. @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". @see setAimLocation() @see setAimObject()) +/// @brief Returns the point the AIPlayer is aiming at. +/// +/// This will reflect the position set by setAimLocation(), +/// or the position of the object that the bot is now aiming at. +/// If the bot is not aiming at anything, this value will +/// change to whatever point the bot's current line-of-sight intercepts. +/// +/// @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public Point3F getAimLocation(string aiplayer){ @@ -6687,7 +9862,13 @@ public Point3F getAimLocation(string aiplayer){ return new Point3F ( m_ts.fnAIPlayer_getAimLocation(aiplayer)); } /// -/// @brief Gets the object the AIPlayer is targeting. @return Returns -1 if no object is being aimed at, or the SimObjectID of the object the AIPlayer is aiming at. @see setAimObject()) +/// @brief Gets the object the AIPlayer is targeting. +/// +/// @return Returns -1 if no object is being aimed at, +/// or the SimObjectID of the object the AIPlayer is aiming at. +/// +/// @see setAimObject()) +/// /// public int getAimObject(string aiplayer){ @@ -6695,7 +9876,14 @@ public int getAimObject(string aiplayer){ return m_ts.fnAIPlayer_getAimObject(aiplayer); } /// -/// @brief Get the AIPlayer's current destination. @return Returns a point containing the \"x y z\" position of the AIPlayer's current move destination. If no move destination has yet been set, this returns \"0 0 0\". @see setMoveDestination()) +/// @brief Get the AIPlayer's current destination. +/// +/// @return Returns a point containing the \"x y z\" position +/// of the AIPlayer's current move destination. If no move destination +/// has yet been set, this returns \"0 0 0\". +/// +/// @see setMoveDestination()) +/// /// public Point3F getMoveDestination(string aiplayer){ @@ -6703,7 +9891,12 @@ public Point3F getMoveDestination(string aiplayer){ return new Point3F ( m_ts.fnAIPlayer_getMoveDestination(aiplayer)); } /// -/// @brief Gets the move speed of an AI object. @return A speed multiplier between 0.0 and 1.0. @see setMoveSpeed()) +/// @brief Gets the move speed of an AI object. +/// +/// @return A speed multiplier between 0.0 and 1.0. +/// +/// @see setMoveSpeed()) +/// /// public float getMoveSpeed(string aiplayer){ @@ -6754,7 +9947,12 @@ public void repath(string aiplayer){ m_ts.fnAIPlayer_repath(aiplayer); } /// -/// @brief Tells the AIPlayer to aim at the location provided. @param target An \"x y z\" position in the game world to target. @see getAimLocation()) +/// @brief Tells the AIPlayer to aim at the location provided. +/// +/// @param target An \"x y z\" position in the game world to target. +/// +/// @see getAimLocation()) +/// /// public void setAimLocation(string aiplayer, Point3F target){ @@ -6762,7 +9960,18 @@ public void setAimLocation(string aiplayer, Point3F target){ m_ts.fnAIPlayer_setAimLocation(aiplayer, target.AsString()); } /// -/// @brief Tells the AI to move to the location provided @param goal Coordinates in world space representing location to move to. @param slowDown A boolean value. If set to true, the bot will slow down when it gets within 5-meters of its move destination. If false, the bot will stop abruptly when it reaches the move destination. By default, this is true. @note Upon reaching a move destination, the bot will clear its move destination and calls to getMoveDestination will return \"0 0 0\". @see getMoveDestination()) +/// @brief Tells the AI to move to the location provided +/// +/// @param goal Coordinates in world space representing location to move to. +/// @param slowDown A boolean value. If set to true, the bot will slow down +/// when it gets within 5-meters of its move destination. If false, the bot +/// will stop abruptly when it reaches the move destination. By default, this is true. +/// +/// @note Upon reaching a move destination, the bot will clear its move destination and +/// calls to getMoveDestination will return \"0 0 0\". +/// +/// @see getMoveDestination()) +/// /// public void setMoveDestination(string aiplayer, Point3F goal, bool slowDown = true){ @@ -6770,7 +9979,14 @@ public void setMoveDestination(string aiplayer, Point3F goal, bool slowDown = t m_ts.fnAIPlayer_setMoveDestination(aiplayer, goal.AsString(), slowDown); } /// -/// @brief Sets the move speed for an AI object. @param speed A speed multiplier between 0.0 and 1.0. This is multiplied by the AIPlayer's base movement rates (as defined in its PlayerData datablock) @see getMoveDestination()) +/// @brief Sets the move speed for an AI object. +/// +/// @param speed A speed multiplier between 0.0 and 1.0. +/// This is multiplied by the AIPlayer's base movement rates (as defined in +/// its PlayerData datablock) +/// +/// @see getMoveDestination()) +/// /// public void setMoveSpeed(string aiplayer, float speed){ @@ -6803,6 +10019,7 @@ public bool setPathDestination(string aiplayer, Point3F goal){ } /// /// @brief Tells the AIPlayer to stop moving.) +/// /// public void stop(string aiplayer){ @@ -6815,14 +10032,9 @@ public void stop(string aiplayer){ /// public class AITurretShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public AITurretShapeObject(ref Omni ts){m_ts = ts;} /// /// @brief Activate a turret from a deactive state.) +/// /// public void activateTurret(string aiturretshape){ @@ -6830,7 +10042,10 @@ public void activateTurret(string aiturretshape){ m_ts.fnAITurretShape_activateTurret(aiturretshape); } /// -/// @brief Adds object to the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to ignore.) +/// @brief Adds object to the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to ignore.) +/// /// public void addToIgnoreList(string aiturretshape, string obj){ @@ -6839,6 +10054,7 @@ public void addToIgnoreList(string aiturretshape, string obj){ } /// /// @brief Deactivate a turret from an active state.) +/// /// public void deactivateTurret(string aiturretshape){ @@ -6846,7 +10062,9 @@ public void deactivateTurret(string aiturretshape){ m_ts.fnAITurretShape_deactivateTurret(aiturretshape); } /// -/// @brief Get the turret's current target. @returns The object that is the target's current target, or 0 if no target.) +/// @brief Get the turret's current target. +/// @returns The object that is the target's current target, or 0 if no target.) +/// /// public string getTarget(string aiturretshape){ @@ -6854,7 +10072,9 @@ public string getTarget(string aiturretshape){ return m_ts.fnAITurretShape_getTarget(aiturretshape); } /// -/// @brief Get the turret's defined projectile velocity that helps with target leading. @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// @brief Get the turret's defined projectile velocity that helps with target leading. +/// @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// /// public float getWeaponLeadVelocity(string aiturretshape){ @@ -6862,7 +10082,9 @@ public float getWeaponLeadVelocity(string aiturretshape){ return m_ts.fnAITurretShape_getWeaponLeadVelocity(aiturretshape); } /// -/// @brief Indicates if the turret has a target. @returns True if the turret has a target.) +/// @brief Indicates if the turret has a target. +/// @returns True if the turret has a target.) +/// /// public bool hasTarget(string aiturretshape){ @@ -6871,6 +10093,7 @@ public bool hasTarget(string aiturretshape){ } /// /// @brief Recenter the turret's weapon.) +/// /// public void recenterTurret(string aiturretshape){ @@ -6878,7 +10101,10 @@ public void recenterTurret(string aiturretshape){ m_ts.fnAITurretShape_recenterTurret(aiturretshape); } /// -/// @brief Removes object from the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to once again allow for targeting.) +/// @brief Removes object from the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to once again allow for targeting.) +/// /// public void removeFromIgnoreList(string aiturretshape, string obj){ @@ -6886,7 +10112,9 @@ public void removeFromIgnoreList(string aiturretshape, string obj){ m_ts.fnAITurretShape_removeFromIgnoreList(aiturretshape, obj); } /// -/// @brief Resets the turret's target tracking. Only resets the internal target tracking. Does not modify the turret's facing.) +/// @brief Resets the turret's target tracking. +/// Only resets the internal target tracking. Does not modify the turret's facing.) +/// /// public void resetTarget(string aiturretshape){ @@ -6894,7 +10122,9 @@ public void resetTarget(string aiturretshape){ m_ts.fnAITurretShape_resetTarget(aiturretshape); } /// -/// @brief Set the firing state of the turret's guns. @param fire Set to true to activate all guns. False to deactivate them.) +/// @brief Set the firing state of the turret's guns. +/// @param fire Set to true to activate all guns. False to deactivate them.) +/// /// public void setAllGunsFiring(string aiturretshape, bool fire){ @@ -6902,7 +10132,10 @@ public void setAllGunsFiring(string aiturretshape, bool fire){ m_ts.fnAITurretShape_setAllGunsFiring(aiturretshape, fire); } /// -/// @brief Set the firing state of the given gun slot. @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. @param fire Set to true to activate the gun. False to deactivate it.) +/// @brief Set the firing state of the given gun slot. +/// @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. +/// @param fire Set to true to activate the gun. False to deactivate it.) +/// /// public void setGunSlotFiring(string aiturretshape, int slot, bool fire){ @@ -6910,7 +10143,14 @@ public void setGunSlotFiring(string aiturretshape, int slot, bool fire){ m_ts.fnAITurretShape_setGunSlotFiring(aiturretshape, slot, fire); } /// -/// @brief Set the turret's current state. Normally the turret's state comes from updating the state machine but this method allows you to override this and jump to the requested state immediately. @param newState The name of the new state. @param force Is true then force the full processing of the new state even if it is the same as the current state. If false then only the time out value is reset and the state's script method is called, if any.) +/// @brief Set the turret's current state. +/// Normally the turret's state comes from updating the state machine but this method +/// allows you to override this and jump to the requested state immediately. +/// @param newState The name of the new state. +/// @param force Is true then force the full processing of the new state even if it is the +/// same as the current state. If false then only the time out value is reset and the state's +/// script method is called, if any.) +/// /// public void setTurretState(string aiturretshape, string newState, bool force = false){ @@ -6918,7 +10158,12 @@ public void setTurretState(string aiturretshape, string newState, bool force = m_ts.fnAITurretShape_setTurretState(aiturretshape, newState, force); } /// -/// @brief Set the turret's projectile velocity to help lead the target. This value normally comes from AITurretShapeData::weaponLeadVelocity but this method allows you to override the datablock value. This can be useful if the turret changes ammunition, uses a different weapon than the default, is damaged, etc. @note Setting this to 0 will disable target leading.) +/// @brief Set the turret's projectile velocity to help lead the target. +/// This value normally comes from AITurretShapeData::weaponLeadVelocity but this method +/// allows you to override the datablock value. This can be useful if the turret changes +/// ammunition, uses a different weapon than the default, is damaged, etc. +/// @note Setting this to 0 will disable target leading.) +/// /// public void setWeaponLeadVelocity(string aiturretshape, float velocity){ @@ -6927,6 +10172,7 @@ public void setWeaponLeadVelocity(string aiturretshape, float velocity){ } /// /// @brief Begin scanning for a target.) +/// /// public void startScanForTargets(string aiturretshape){ @@ -6935,6 +10181,7 @@ public void startScanForTargets(string aiturretshape){ } /// /// @brief Have the turret track the current target.) +/// /// public void startTrackingTarget(string aiturretshape){ @@ -6942,7 +10189,10 @@ public void startTrackingTarget(string aiturretshape){ m_ts.fnAITurretShape_startTrackingTarget(aiturretshape); } /// -/// @brief Stop scanning for targets. @note Only impacts the scanning for new targets. Does not effect a turret's current target lock.) +/// @brief Stop scanning for targets. +/// @note Only impacts the scanning for new targets. Does not effect a turret's current +/// target lock.) +/// /// public void stopScanForTargets(string aiturretshape){ @@ -6951,6 +10201,7 @@ public void stopScanForTargets(string aiturretshape){ } /// /// @brief Stop the turret from tracking the current target.) +/// /// public void stopTrackingTarget(string aiturretshape){ @@ -6963,14 +10214,12 @@ public void stopTrackingTarget(string aiturretshape){ /// public class ArrayObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public ArrayObjectObject(ref Omni ts){m_ts = ts;} /// -/// ), Adds a new element to the end of an array (same as push_back()). @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array (same as push_back()). +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void add(string arrayobject, string key, string value = ""){ @@ -6978,7 +10227,9 @@ public void add(string arrayobject, string key, string value = ""){ m_ts.fnArrayObject_add(arrayobject, key, value); } /// -/// Appends the target array to the array object. @param target ArrayObject to append to the end of this array ) +/// Appends the target array to the array object. +/// @param target ArrayObject to append to the end of this array ) +/// /// public bool append(string arrayobject, string target){ @@ -6987,6 +10238,7 @@ public bool append(string arrayobject, string target){ } /// /// Get the number of elements in the array. ) +/// /// public int count(string arrayobject){ @@ -6994,7 +10246,9 @@ public int count(string arrayobject){ return m_ts.fnArrayObject_count(arrayobject); } /// -/// Get the number of times a particular key is found in the array. @param key Key value to count ) +/// Get the number of times a particular key is found in the array. +/// @param key Key value to count ) +/// /// public int countKey(string arrayobject, string key){ @@ -7002,7 +10256,9 @@ public int countKey(string arrayobject, string key){ return m_ts.fnArrayObject_countKey(arrayobject, key); } /// -/// Get the number of times a particular value is found in the array. @param value Array element value to count ) +/// Get the number of times a particular value is found in the array. +/// @param value Array element value to count ) +/// /// public int countValue(string arrayobject, string value){ @@ -7010,7 +10266,9 @@ public int countValue(string arrayobject, string value){ return m_ts.fnArrayObject_countValue(arrayobject, value); } /// -/// Removes elements with matching keys from array. @param target ArrayObject containing keys to remove from this array ) +/// Removes elements with matching keys from array. +/// @param target ArrayObject containing keys to remove from this array ) +/// /// public bool crop(string arrayobject, string target){ @@ -7018,7 +10276,9 @@ public bool crop(string arrayobject, string target){ return m_ts.fnArrayObject_crop(arrayobject, target); } /// -/// Alters array into an exact duplicate of the target array. @param target ArrayObject to duplicate ) +/// Alters array into an exact duplicate of the target array. +/// @param target ArrayObject to duplicate ) +/// /// public bool duplicate(string arrayobject, string target){ @@ -7027,6 +10287,7 @@ public bool duplicate(string arrayobject, string target){ } /// /// Echos the array contents to the console ) +/// /// public void echo(string arrayobject){ @@ -7035,6 +10296,7 @@ public void echo(string arrayobject){ } /// /// Emptys all elements from an array ) +/// /// public void empty(string arrayobject){ @@ -7042,7 +10304,9 @@ public void empty(string arrayobject){ m_ts.fnArrayObject_empty(arrayobject); } /// -/// Removes an element at a specific position from the array. @param index 0-based index of the element to remove ) +/// Removes an element at a specific position from the array. +/// @param index 0-based index of the element to remove ) +/// /// public void erase(string arrayobject, int index){ @@ -7051,6 +10315,7 @@ public void erase(string arrayobject, int index){ } /// /// Gets the current pointer index ) +/// /// public int getCurrent(string arrayobject){ @@ -7058,7 +10323,10 @@ public int getCurrent(string arrayobject){ return m_ts.fnArrayObject_getCurrent(arrayobject); } /// -/// Search the array from the current position for the key @param value Array key to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the key +/// @param value Array key to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int getIndexFromKey(string arrayobject, string key){ @@ -7066,7 +10334,10 @@ public int getIndexFromKey(string arrayobject, string key){ return m_ts.fnArrayObject_getIndexFromKey(arrayobject, key); } /// -/// Search the array from the current position for the element @param value Array value to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the element +/// @param value Array value to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int getIndexFromValue(string arrayobject, string value){ @@ -7074,7 +10345,11 @@ public int getIndexFromValue(string arrayobject, string value){ return m_ts.fnArrayObject_getIndexFromValue(arrayobject, value); } /// -/// Get the key of the array element at the submitted index. @param index 0-based index of the array element to get @return The key associated with the array element at the specified index, or \"\" if the index is out of range ) +/// Get the key of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The key associated with the array element at the +/// specified index, or \"\" if the index is out of range ) +/// /// public string getKey(string arrayobject, int index){ @@ -7082,7 +10357,11 @@ public string getKey(string arrayobject, int index){ return m_ts.fnArrayObject_getKey(arrayobject, index); } /// -/// Get the value of the array element at the submitted index. @param index 0-based index of the array element to get @return The value of the array element at the specified index, or \"\" if the index is out of range ) +/// Get the value of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The value of the array element at the specified index, +/// or \"\" if the index is out of range ) +/// /// public string getValue(string arrayobject, int index){ @@ -7090,7 +10369,13 @@ public string getValue(string arrayobject, int index){ return m_ts.fnArrayObject_getValue(arrayobject, index); } /// -/// Adds a new element to a specified position in the array. - @a index = 0 will insert an element at the start of the array (same as push_front()) - @a index = %array.count() will insert an element at the end of the array (same as push_back()) @param key Key for the new element @param value Value for the new element @param index 0-based index at which to insert the new element ) +/// Adds a new element to a specified position in the array. +/// - @a index = 0 will insert an element at the start of the array (same as push_front()) +/// - @a index = %array.count() will insert an element at the end of the array (same as push_back()) +/// @param key Key for the new element +/// @param value Value for the new element +/// @param index 0-based index at which to insert the new element ) +/// /// public void insert(string arrayobject, string key, string value, int index){ @@ -7098,7 +10383,9 @@ public void insert(string arrayobject, string key, string value, int index){ m_ts.fnArrayObject_insert(arrayobject, key, value, index); } /// -/// Moves array pointer to start of array @return Returns the new array pointer ) +/// Moves array pointer to start of array +/// @return Returns the new array pointer ) +/// /// public int moveFirst(string arrayobject){ @@ -7106,7 +10393,9 @@ public int moveFirst(string arrayobject){ return m_ts.fnArrayObject_moveFirst(arrayobject); } /// -/// Moves array pointer to end of array @return Returns the new array pointer ) +/// Moves array pointer to end of array +/// @return Returns the new array pointer ) +/// /// public int moveLast(string arrayobject){ @@ -7114,7 +10403,9 @@ public int moveLast(string arrayobject){ return m_ts.fnArrayObject_moveLast(arrayobject); } /// -/// Moves array pointer to next position @return Returns the new array pointer, or -1 if already at the end ) +/// Moves array pointer to next position +/// @return Returns the new array pointer, or -1 if already at the end ) +/// /// public int moveNext(string arrayobject){ @@ -7122,7 +10413,9 @@ public int moveNext(string arrayobject){ return m_ts.fnArrayObject_moveNext(arrayobject); } /// -/// Moves array pointer to prev position @return Returns the new array pointer, or -1 if already at the start ) +/// Moves array pointer to prev position +/// @return Returns the new array pointer, or -1 if already at the start ) +/// /// public int movePrev(string arrayobject){ @@ -7131,6 +10424,7 @@ public int movePrev(string arrayobject){ } /// /// Removes the last element from the array ) +/// /// public void pop_back(string arrayobject){ @@ -7139,6 +10433,7 @@ public void pop_back(string arrayobject){ } /// /// Removes the first element from the array ) +/// /// public void pop_front(string arrayobject){ @@ -7146,7 +10441,11 @@ public void pop_front(string arrayobject){ m_ts.fnArrayObject_pop_front(arrayobject); } /// -/// ), Adds a new element to the end of an array. @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array. +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void push_back(string arrayobject, string key, string value = ""){ @@ -7154,7 +10453,9 @@ public void push_back(string arrayobject, string key, string value = ""){ m_ts.fnArrayObject_push_back(arrayobject, key, value); } /// -/// ), Adds a new element to the front of an array ) +/// ), +/// Adds a new element to the front of an array ) +/// /// public void push_front(string arrayobject, string key, string value = ""){ @@ -7162,7 +10463,9 @@ public void push_front(string arrayobject, string key, string value = ""){ m_ts.fnArrayObject_push_front(arrayobject, key, value); } /// -/// Sets the current pointer index. @param index New 0-based pointer index ) +/// Sets the current pointer index. +/// @param index New 0-based pointer index ) +/// /// public void setCurrent(string arrayobject, int index){ @@ -7170,7 +10473,10 @@ public void setCurrent(string arrayobject, int index){ m_ts.fnArrayObject_setCurrent(arrayobject, index); } /// -/// Set the key at the given index. @param key New key value @param index 0-based index of the array element to update ) +/// Set the key at the given index. +/// @param key New key value +/// @param index 0-based index of the array element to update ) +/// /// public void setKey(string arrayobject, string key, int index){ @@ -7178,7 +10484,10 @@ public void setKey(string arrayobject, string key, int index){ m_ts.fnArrayObject_setKey(arrayobject, key, index); } /// -/// Set the value at the given index. @param value New array element value @param index 0-based index of the array element to update ) +/// Set the value at the given index. +/// @param value New array element value +/// @param index 0-based index of the array element to update ) +/// /// public void setValue(string arrayobject, string value, int index){ @@ -7186,7 +10495,9 @@ public void setValue(string arrayobject, string value, int index){ m_ts.fnArrayObject_setValue(arrayobject, value, index); } /// -/// Alpha sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void sort(string arrayobject, bool ascending = false){ @@ -7195,6 +10506,7 @@ public void sort(string arrayobject, bool ascending = false){ } /// /// Alpha sorts the array by value in ascending order ) +/// /// public void sorta(string arrayobject){ @@ -7203,6 +10515,7 @@ public void sorta(string arrayobject){ } /// /// Alpha sorts the array by value in descending order ) +/// /// public void sortd(string arrayobject){ @@ -7210,7 +10523,16 @@ public void sortd(string arrayobject){ m_ts.fnArrayObject_sortd(arrayobject); } /// -/// Sorts the array by value in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @tsexample function mySortCallback(%a, %b) { return strcmp( %a.name, %b.name ); } %array.sortf( \"mySortCallback\" ); @endtsexample ) +/// Sorts the array by value in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @tsexample +/// function mySortCallback(%a, %b) +/// { +/// return strcmp( %a.name, %b.name ); +/// } +/// %array.sortf( \"mySortCallback\" ); +/// @endtsexample ) +/// /// public void sortf(string arrayobject, string functionName){ @@ -7218,7 +10540,10 @@ public void sortf(string arrayobject, string functionName){ m_ts.fnArrayObject_sortf(arrayobject, functionName); } /// -/// Sorts the array by value in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by value in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void sortfd(string arrayobject, string functionName){ @@ -7226,7 +10551,10 @@ public void sortfd(string arrayobject, string functionName){ m_ts.fnArrayObject_sortfd(arrayobject, functionName); } /// -/// Sorts the array by key in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void sortfk(string arrayobject, string functionName){ @@ -7234,7 +10562,10 @@ public void sortfk(string arrayobject, string functionName){ m_ts.fnArrayObject_sortfk(arrayobject, functionName); } /// -/// Sorts the array by key in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void sortfkd(string arrayobject, string functionName){ @@ -7242,7 +10573,9 @@ public void sortfkd(string arrayobject, string functionName){ m_ts.fnArrayObject_sortfkd(arrayobject, functionName); } /// -/// Alpha sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void sortk(string arrayobject, bool ascending = false){ @@ -7251,6 +10584,7 @@ public void sortk(string arrayobject, bool ascending = false){ } /// /// Alpha sorts the array by key in ascending order ) +/// /// public void sortka(string arrayobject){ @@ -7259,6 +10593,7 @@ public void sortka(string arrayobject){ } /// /// Alpha sorts the array by key in descending order ) +/// /// public void sortkd(string arrayobject){ @@ -7266,7 +10601,9 @@ public void sortkd(string arrayobject){ m_ts.fnArrayObject_sortkd(arrayobject); } /// -/// Numerically sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void sortn(string arrayobject, bool ascending = false){ @@ -7275,6 +10612,7 @@ public void sortn(string arrayobject, bool ascending = false){ } /// /// Numerically sorts the array by value in ascending order ) +/// /// public void sortna(string arrayobject){ @@ -7283,6 +10621,7 @@ public void sortna(string arrayobject){ } /// /// Numerically sorts the array by value in descending order ) +/// /// public void sortnd(string arrayobject){ @@ -7290,7 +10629,9 @@ public void sortnd(string arrayobject){ m_ts.fnArrayObject_sortnd(arrayobject); } /// -/// Numerically sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void sortnk(string arrayobject, bool ascending = false){ @@ -7299,6 +10640,7 @@ public void sortnk(string arrayobject, bool ascending = false){ } /// /// Numerical sorts the array by key in ascending order ) +/// /// public void sortnka(string arrayobject){ @@ -7307,6 +10649,7 @@ public void sortnka(string arrayobject){ } /// /// Numerical sorts the array by key in descending order ) +/// /// public void sortnkd(string arrayobject){ @@ -7315,6 +10658,7 @@ public void sortnkd(string arrayobject){ } /// /// Removes any elements that have duplicated keys (leaving the first instance) ) +/// /// public void uniqueKey(string arrayobject){ @@ -7323,6 +10667,7 @@ public void uniqueKey(string arrayobject){ } /// /// Removes any elements that have duplicated values (leaving the first instance) ) +/// /// public void uniqueValue(string arrayobject){ @@ -7335,14 +10680,11 @@ public void uniqueValue(string arrayobject){ /// public class CameraObject { -private Omni m_ts; - /// - /// - /// - /// -public CameraObject(ref Omni ts){m_ts = ts;} /// -/// Move the camera to fully view the given radius. @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). @param radius The radius to view.) +/// Move the camera to fully view the given radius. +/// @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). +/// @param radius The radius to view.) +/// /// public void autoFitRadius(string camera, float radius){ @@ -7350,7 +10692,10 @@ public void autoFitRadius(string camera, float radius){ m_ts.fnCamera_autoFitRadius(camera, radius); } /// -/// Get the angular velocity for a Newton mode camera. @returns The angular velocity in the form of \"x y z\". @note Only returns useful results when Camera::newtonRotation is set to true.) +/// Get the angular velocity for a Newton mode camera. +/// @returns The angular velocity in the form of \"x y z\". +/// @note Only returns useful results when Camera::newtonRotation is set to true.) +/// /// public Point3F getAngularVelocity(string camera){ @@ -7358,7 +10703,9 @@ public Point3F getAngularVelocity(string camera){ return new Point3F ( m_ts.fnCamera_getAngularVelocity(camera)); } /// -/// Returns the current camera control mode. @see CameraMotionMode) +/// Returns the current camera control mode. +/// @see CameraMotionMode) +/// /// public TypeCameraMotionMode getMode(string camera){ @@ -7366,7 +10713,10 @@ public TypeCameraMotionMode getMode(string camera){ return (TypeCameraMotionMode)( m_ts.fnCamera_getMode(camera)); } /// -/// Get the camera's offset from its orbit or tracking point. The offset is added to the camera's position when set to CameraMode::OrbitObject. @returns The offset in the form of \"x y z\".) +/// Get the camera's offset from its orbit or tracking point. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @returns The offset in the form of \"x y z\".) +/// /// public Point3F getOffset(string camera){ @@ -7374,7 +10724,9 @@ public Point3F getOffset(string camera){ return new Point3F ( m_ts.fnCamera_getOffset(camera)); } /// -/// Get the camera's position in the world. @returns The position in the form of \"x y z\".) +/// Get the camera's position in the world. +/// @returns The position in the form of \"x y z\".) +/// /// public Point3F getPosition(string camera){ @@ -7382,7 +10734,9 @@ public Point3F getPosition(string camera){ return new Point3F ( m_ts.fnCamera_getPosition(camera)); } /// -/// Get the camera's Euler rotation in radians. @returns The rotation in radians in the form of \"x y z\".) +/// Get the camera's Euler rotation in radians. +/// @returns The rotation in radians in the form of \"x y z\".) +/// /// public Point3F getRotation(string camera){ @@ -7390,7 +10744,10 @@ public Point3F getRotation(string camera){ return new Point3F ( m_ts.fnCamera_getRotation(camera)); } /// -/// Get the velocity for the camera. @returns The camera's velocity in the form of \"x y z\". @note Only useful when the Camera is in Newton mode.) +/// Get the velocity for the camera. +/// @returns The camera's velocity in the form of \"x y z\". +/// @note Only useful when the Camera is in Newton mode.) +/// /// public Point3F getVelocity(string camera){ @@ -7398,7 +10755,9 @@ public Point3F getVelocity(string camera){ return new Point3F ( m_ts.fnCamera_getVelocity(camera)); } /// -/// Is the camera in edit orbit mode? @returns true if the camera is in edit orbit mode.) +/// Is the camera in edit orbit mode? +/// @returns true if the camera is in edit orbit mode.) +/// /// public bool isEditOrbitMode(string camera){ @@ -7406,7 +10765,9 @@ public bool isEditOrbitMode(string camera){ return m_ts.fnCamera_isEditOrbitMode(camera); } /// -/// Is this a Newton Fly mode camera with damped rotation? @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// Is this a Newton Fly mode camera with damped rotation? +/// @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// /// public bool isRotationDamped(string camera){ @@ -7414,7 +10775,9 @@ public bool isRotationDamped(string camera){ return m_ts.fnCamera_isRotationDamped(camera); } /// -/// Point the camera at the specified position. Does not work in Orbit or Track modes. @param point The position to point the camera at.) +/// Point the camera at the specified position. Does not work in Orbit or Track modes. +/// @param point The position to point the camera at.) +/// /// public void lookAt(string camera, Point3F point){ @@ -7422,7 +10785,10 @@ public void lookAt(string camera, Point3F point){ m_ts.fnCamera_lookAt(camera, point.AsString()); } /// -/// Set the angular drag for a Newton mode camera. @param drag The angular drag applied while the camera is rotating. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular drag for a Newton mode camera. +/// @param drag The angular drag applied while the camera is rotating. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void setAngularDrag(string camera, float drag){ @@ -7430,7 +10796,10 @@ public void setAngularDrag(string camera, float drag){ m_ts.fnCamera_setAngularDrag(camera, drag); } /// -/// Set the angular force for a Newton mode camera. @param force The angular force applied when attempting to rotate the camera. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular force for a Newton mode camera. +/// @param force The angular force applied when attempting to rotate the camera. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void setAngularForce(string camera, float force){ @@ -7438,7 +10807,10 @@ public void setAngularForce(string camera, float force){ m_ts.fnCamera_setAngularForce(camera, force); } /// -/// Set the angular velocity for a Newton mode camera. @param velocity The angular velocity infor form of \"x y z\". @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular velocity for a Newton mode camera. +/// @param velocity The angular velocity infor form of \"x y z\". +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void setAngularVelocity(string camera, Point3F velocity){ @@ -7446,7 +10818,10 @@ public void setAngularVelocity(string camera, Point3F velocity){ m_ts.fnCamera_setAngularVelocity(camera, velocity.AsString()); } /// -/// Set the Newton mode camera brake multiplier when trigger[1] is active. @param multiplier The brake multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera brake multiplier when trigger[1] is active. +/// @param multiplier The brake multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setBrakeMultiplier(string camera, float multiplier){ @@ -7454,7 +10829,10 @@ public void setBrakeMultiplier(string camera, float multiplier){ m_ts.fnCamera_setBrakeMultiplier(camera, multiplier); } /// -/// Set the drag for a Newton mode camera. @param drag The drag applied to the camera while moving. @note Only used when Camera is in Newton mode.) +/// Set the drag for a Newton mode camera. +/// @param drag The drag applied to the camera while moving. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setDrag(string camera, float drag){ @@ -7462,7 +10840,10 @@ public void setDrag(string camera, float drag){ m_ts.fnCamera_setDrag(camera, drag); } /// -/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). @note This method is generally used only within the World Editor and other tools. To orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). +/// @note This method is generally used only within the World Editor and other tools. To +/// orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// /// public void setEditOrbitMode(string camera){ @@ -7470,7 +10851,9 @@ public void setEditOrbitMode(string camera){ m_ts.fnCamera_setEditOrbitMode(camera); } /// -/// Set the editor camera's orbit point. @param point The point the camera will orbit in the form of \"x y z\".) +/// Set the editor camera's orbit point. +/// @param point The point the camera will orbit in the form of \"x y z\".) +/// /// public void setEditOrbitPoint(string camera, Point3F point){ @@ -7478,7 +10861,10 @@ public void setEditOrbitPoint(string camera, Point3F point){ m_ts.fnCamera_setEditOrbitPoint(camera, point.AsString()); } /// -/// Set the force applied to a Newton mode camera while moving. @param force The force applied to the camera while attempting to move. @note Only used when Camera is in Newton mode.) +/// Set the force applied to a Newton mode camera while moving. +/// @param force The force applied to the camera while attempting to move. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setFlyForce(string camera, float force){ @@ -7486,7 +10872,11 @@ public void setFlyForce(string camera, float force){ m_ts.fnCamera_setFlyForce(camera, force); } /// -/// Set the camera to fly freely. Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode and Camera::newtonRotation.) +/// Set the camera to fly freely. +/// Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion +/// and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode +/// and Camera::newtonRotation.) +/// /// public void setFlyMode(string camera){ @@ -7494,7 +10884,10 @@ public void setFlyMode(string camera){ m_ts.fnCamera_setFlyMode(camera); } /// -/// Set the mass for a Newton mode camera. @param mass The mass used during ease-in and ease-out calculations. @note Only used when Camera is in Newton mode.) +/// Set the mass for a Newton mode camera. +/// @param mass The mass used during ease-in and ease-out calculations. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setMass(string camera, float mass){ @@ -7502,7 +10895,11 @@ public void setMass(string camera, float mass){ m_ts.fnCamera_setMass(camera, mass); } /// -/// Set the camera to fly freely, but with ease-in and ease-out. This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but activates the ease-in and ease-out on the camera's movement. To also activate Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// Set the camera to fly freely, but with ease-in and ease-out. +/// This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but +/// activates the ease-in and ease-out on the camera's movement. To also activate +/// Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// /// public void setNewtonFlyMode(string camera){ @@ -7510,7 +10907,10 @@ public void setNewtonFlyMode(string camera){ m_ts.fnCamera_setNewtonFlyMode(camera); } /// -/// Set the camera's offset. The offset is added to the camera's position when set to CameraMode::OrbitObject. @param offset The distance to offset the camera by in the form of \"x y z\".) +/// Set the camera's offset. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @param offset The distance to offset the camera by in the form of \"x y z\".) +/// /// public void setOffset(string camera, Point3F offset){ @@ -7518,16 +10918,38 @@ public void setOffset(string camera, Point3F offset){ m_ts.fnCamera_setOffset(camera, offset.AsString()); } /// -/// Set the camera to orbit around the given object, or if none is given, around the given point. @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitObject() @see Camera::setOrbitPoint()) +/// Set the camera to orbit around the given object, or if none is given, around the given point. +/// @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead +/// @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitObject() +/// @see Camera::setOrbitPoint()) +/// /// -public bool setOrbitMode(string camera, string orbitObject, TransformF orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj = false, Point3F offset = null , bool lockedx = false){ +public void setOrbitMode(string camera, string orbitObject, TransformF orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj = false, Point3F offset = null , bool lockedx = false){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} -return m_ts.fnCamera_setOrbitMode(camera, orbitObject, orbitPoint.AsString(), minDistance, maxDistance, initDistance, ownClientObj, offset.AsString(), lockedx); +m_ts.fnCamera_setOrbitMode(camera, orbitObject, orbitPoint.AsString(), minDistance, maxDistance, initDistance, ownClientObj, offset.AsString(), lockedx); } /// -/// Set the camera to orbit around a given object. @param orbitObject The object to orbit around. @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @returns false if the given object could not be found. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given object. +/// @param orbitObject The object to orbit around. +/// @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @returns false if the given object could not be found. +/// @see Camera::setOrbitMode()) +/// /// public bool setOrbitObject(string camera, string orbitObject, Point3F rotation, float minDistance, float maxDistance, float initDistance, bool ownClientObject = false, Point3F offset = null , bool lockedx = false){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} @@ -7536,7 +10958,15 @@ public bool setOrbitObject(string camera, string orbitObject, Point3F rotation, return m_ts.fnCamera_setOrbitObject(camera, orbitObject, rotation.AsString(), minDistance, maxDistance, initDistance, ownClientObject, offset.AsString(), lockedx); } /// -/// Set the camera to orbit around a given point. @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given point. +/// @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitMode()) +/// /// public void setOrbitPoint(string camera, TransformF orbitPoint, float minDistance, float maxDistance, float initDistance, Point3F offset = null , bool lockedx = false){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} @@ -7545,7 +10975,10 @@ public void setOrbitPoint(string camera, TransformF orbitPoint, float minDistan m_ts.fnCamera_setOrbitPoint(camera, orbitPoint.AsString(), minDistance, maxDistance, initDistance, offset.AsString(), lockedx); } /// -/// Set the camera's Euler rotation in radians. @param rot The rotation in radians in the form of \"x y z\". @note Rotation around the Y axis is ignored ) +/// Set the camera's Euler rotation in radians. +/// @param rot The rotation in radians in the form of \"x y z\". +/// @note Rotation around the Y axis is ignored ) +/// /// public void setRotation(string camera, Point3F rot){ @@ -7553,7 +10986,10 @@ public void setRotation(string camera, Point3F rot){ m_ts.fnCamera_setRotation(camera, rot.AsString()); } /// -/// Set the Newton mode camera speed multiplier when trigger[0] is active. @param multiplier The speed multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera speed multiplier when trigger[0] is active. +/// @param multiplier The speed multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setSpeedMultiplier(string camera, float multiplier){ @@ -7561,7 +10997,11 @@ public void setSpeedMultiplier(string camera, float multiplier){ m_ts.fnCamera_setSpeedMultiplier(camera, multiplier); } /// -/// Set the camera to track a given object. @param trackObject The object to track. @param offset [optional] An offset added to the camera's position. Default is no offset. @returns false if the given object could not be found.) +/// Set the camera to track a given object. +/// @param trackObject The object to track. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @returns false if the given object could not be found.) +/// /// public bool setTrackObject(string camera, string trackObject, Point3F offset = null ){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} @@ -7570,7 +11010,12 @@ public bool setTrackObject(string camera, string trackObject, Point3F offset = return m_ts.fnCamera_setTrackObject(camera, trackObject, offset.AsString()); } /// -/// Set if there is a valid editor camera orbit point. When validPoint is set to false the Camera operates as if it is in Fly mode rather than an Orbit mode. @param validPoint Indicates the validity of the orbit point. @note Only used when Camera is in Edit Orbit Mode.) +/// Set if there is a valid editor camera orbit point. +/// When validPoint is set to false the Camera operates as if it is +/// in Fly mode rather than an Orbit mode. +/// @param validPoint Indicates the validity of the orbit point. +/// @note Only used when Camera is in Edit Orbit Mode.) +/// /// public void setValidEditOrbitPoint(string camera, bool validPoint){ @@ -7578,47 +11023,25 @@ public void setValidEditOrbitPoint(string camera, bool validPoint){ m_ts.fnCamera_setValidEditOrbitPoint(camera, validPoint); } /// -/// Set the velocity for the camera. @param velocity The camera's velocity in the form of \"x y z\". @note Only affects the Camera when in Newton mode.) +/// Set the velocity for the camera. +/// @param velocity The camera's velocity in the form of \"x y z\". +/// @note Only affects the Camera when in Newton mode.) +/// /// public void setVelocity(string camera, Point3F velocity){ m_ts.fnCamera_setVelocity(camera, velocity.AsString()); } -} - /// - /// - /// - public class CloudLayerObject -{ -private Omni m_ts; - /// - /// - /// - /// -public CloudLayerObject(ref Omni ts){m_ts = ts;} -/// -/// Change coverage of the cloudlayer.) -/// -public void ChangeCoverage(string cloudlayer, float newCoverage){ - - -m_ts.fnCloudLayer_ChangeCoverage(cloudlayer, newCoverage); -} } /// /// /// public class CompoundUndoActionObject { -private Omni m_ts; - /// - /// - /// - /// -public CompoundUndoActionObject(ref Omni ts){m_ts = ts;} /// /// addAction( UndoAction ) ) +/// /// public void CompoundUndoAction_addAction(string compoundundoaction, string objName){ @@ -7631,14 +11054,23 @@ public void CompoundUndoAction_addAction(string compoundundoaction, string objN /// public class ConsoleLoggerObject { -private Omni m_ts; - /// - /// - /// - /// -public ConsoleLoggerObject(ref Omni ts){m_ts = ts;} /// -/// () Attaches the logger to the console and begins writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Attaches the logger to the console and begins writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool ConsoleLogger_attach(string consolelogger){ @@ -7646,7 +11078,22 @@ public bool ConsoleLogger_attach(string consolelogger){ return m_ts.fn_ConsoleLogger_attach(consolelogger); } /// -/// () Detaches the logger from the console and stops writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Detaches the logger from the console and stops writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool ConsoleLogger_detach(string consolelogger){ @@ -7659,12 +11106,6 @@ public bool ConsoleLogger_detach(string consolelogger){ /// public class CoverPointObject { -private Omni m_ts; - /// - /// - /// - /// -public CoverPointObject(ref Omni ts){m_ts = ts;} /// /// @brief Returns true if someone is already using this cover point.) /// @@ -7680,14 +11121,9 @@ public bool isOccupied(string coverpoint){ /// public class CreatorTreeObject { -private Omni m_ts; - /// - /// - /// - /// -public CreatorTreeObject(ref Omni ts){m_ts = ts;} /// /// (string group, string name, string value)) +/// /// public int CreatorTree_addGroup(string creatortree, int group, string name, string value){ @@ -7696,6 +11132,7 @@ public int CreatorTree_addGroup(string creatortree, int group, string name, str } /// /// (Node group, string name, string value)) +/// /// public int CreatorTree_addItem(string creatortree, int group, string name, string value){ @@ -7704,6 +11141,7 @@ public int CreatorTree_addItem(string creatortree, int group, string name, stri } /// /// Clear the tree.) +/// /// public void CreatorTree_clear(string creatortree){ @@ -7712,6 +11150,7 @@ public void CreatorTree_clear(string creatortree){ } /// /// (string world, string type, string filename)) +/// /// public bool CreatorTree_fileNameMatch(string creatortree, string world, string type, string filename){ @@ -7720,6 +11159,7 @@ public bool CreatorTree_fileNameMatch(string creatortree, string world, string } /// /// (Node item)) +/// /// public string CreatorTree_getName(string creatortree, string item){ @@ -7728,6 +11168,7 @@ public string CreatorTree_getName(string creatortree, string item){ } /// /// (Node n)) +/// /// public int CreatorTree_getParent(string creatortree, int nodeValue){ @@ -7736,6 +11177,7 @@ public int CreatorTree_getParent(string creatortree, int nodeValue){ } /// /// Return a handle to the currently selected item.) +/// /// public int CreatorTree_getSelected(string creatortree){ @@ -7744,6 +11186,7 @@ public int CreatorTree_getSelected(string creatortree){ } /// /// (Node n)) +/// /// public string CreatorTree_getValue(string creatortree, int nodeValue){ @@ -7752,6 +11195,7 @@ public string CreatorTree_getValue(string creatortree, int nodeValue){ } /// /// (Group g)) +/// /// public bool CreatorTree_isGroup(string creatortree, string group){ @@ -7764,14 +11208,10 @@ public bool CreatorTree_isGroup(string creatortree, string group){ /// public class CubemapDataObject { -private Omni m_ts; - /// - /// - /// - /// -public CubemapDataObject(ref Omni ts){m_ts = ts;} /// -/// Returns the script filename of where the CubemapData object was defined. This is used by the material editor. ) +/// Returns the script filename of where the CubemapData object was +/// defined. This is used by the material editor. ) +/// /// public string getFilename(string cubemapdata){ @@ -7780,6 +11220,7 @@ public string getFilename(string cubemapdata){ } /// /// Update the assigned cubemaps faces. ) +/// /// public void updateFaces(string cubemapdata){ @@ -7792,14 +11233,10 @@ public void updateFaces(string cubemapdata){ /// public class DbgFileViewObject { -private Omni m_ts; - /// - /// - /// - /// -public DbgFileViewObject(ref Omni ts){m_ts = ts;} /// -/// () Clear all break points in the current file.) +/// () +/// Clear all break points in the current file.) +/// /// public void DbgFileView_clearBreakPositions(string dbgfileview){ @@ -7807,7 +11244,10 @@ public void DbgFileView_clearBreakPositions(string dbgfileview){ m_ts.fn_DbgFileView_clearBreakPositions(dbgfileview); } /// -/// (string findThis) Find the specified string in the currently viewed file and scroll it into view.) +/// (string findThis) +/// Find the specified string in the currently viewed file and +/// scroll it into view.) +/// /// public bool DbgFileView_findString(string dbgfileview, string findThis){ @@ -7815,7 +11255,11 @@ public bool DbgFileView_findString(string dbgfileview, string findThis){ return m_ts.fn_DbgFileView_findString(dbgfileview, findThis); } /// -/// () Get the currently executing file and line, if any. @returns A string containing the file, a tab, and then the line number. Use getField() with this.) +/// () +/// Get the currently executing file and line, if any. +/// @returns A string containing the file, a tab, and then the line number. +/// Use getField() with this.) +/// /// public string DbgFileView_getCurrentLine(string dbgfileview){ @@ -7823,7 +11267,10 @@ public string DbgFileView_getCurrentLine(string dbgfileview){ return m_ts.fn_DbgFileView_getCurrentLine(dbgfileview); } /// -/// (string filename) Open a file for viewing. @note This loads the file from the local system.) +/// (string filename) +/// Open a file for viewing. +/// @note This loads the file from the local system.) +/// /// public bool DbgFileView_open(string dbgfileview, string filename){ @@ -7831,7 +11278,9 @@ public bool DbgFileView_open(string dbgfileview, string filename){ return m_ts.fn_DbgFileView_open(dbgfileview, filename); } /// -/// (int line) Remove a breakpoint from the specified line.) +/// (int line) +/// Remove a breakpoint from the specified line.) +/// /// public void DbgFileView_removeBreak(string dbgfileview, uint line){ @@ -7839,7 +11288,9 @@ public void DbgFileView_removeBreak(string dbgfileview, uint line){ m_ts.fn_DbgFileView_removeBreak(dbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void DbgFileView_setBreak(string dbgfileview, uint line){ @@ -7847,7 +11298,9 @@ public void DbgFileView_setBreak(string dbgfileview, uint line){ m_ts.fn_DbgFileView_setBreak(dbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void DbgFileView_setBreakPosition(string dbgfileview, uint line){ @@ -7855,7 +11308,9 @@ public void DbgFileView_setBreakPosition(string dbgfileview, uint line){ m_ts.fn_DbgFileView_setBreakPosition(dbgfileview, line); } /// -/// (int line, bool selected) Set the current highlighted line.) +/// (int line, bool selected) +/// Set the current highlighted line.) +/// /// public void DbgFileView_setCurrentLine(string dbgfileview, int line, bool selected){ @@ -7868,14 +11323,27 @@ public void DbgFileView_setCurrentLine(string dbgfileview, int line, bool selec /// public class DebrisObject { -private Omni m_ts; - /// - /// - /// - /// -public DebrisObject(ref Omni ts){m_ts = ts;} /// -/// 1.0 1.0 1.0, 1.0 0.0 0.0), @brief Manually set this piece of debris at the given position with the given velocity. Usually you do not manually create Debris objects as they are generated through other means, such as an Explosion. This method exists when you do manually create a Debris object and want to have it start moving. @param inputPosition Position to place the debris. @param inputVelocity Velocity to move the debris after it has been placed. @return Always returns true. @tsexample // Define the position %position = \"1.0 1.0 1.0\"; // Define the velocity %velocity = \"1.0 0.0 0.0\"; // Inform the debris object of its new position and velocity %debris.init(%position,%velocity); @endtsexample) +/// 1.0 1.0 1.0, 1.0 0.0 0.0), +/// @brief Manually set this piece of debris at the given position with the given velocity. +/// +/// Usually you do not manually create Debris objects as they are generated through other means, +/// such as an Explosion. This method exists when you do manually create a Debris object and +/// want to have it start moving. +/// +/// @param inputPosition Position to place the debris. +/// @param inputVelocity Velocity to move the debris after it has been placed. +/// @return Always returns true. +/// +/// @tsexample +/// // Define the position +/// %position = \"1.0 1.0 1.0\"; +/// // Define the velocity +/// %velocity = \"1.0 0.0 0.0\"; +/// // Inform the debris object of its new position and velocity +/// %debris.init(%position,%velocity); +/// @endtsexample) +/// /// public bool init(string debris, string inputPosition = "1.01.01.0", string inputVelocity = "1.00.00.0"){ @@ -7888,14 +11356,9 @@ public bool init(string debris, string inputPosition = "1.01.01.0", string inpu /// public class DebugDrawerObject { -private Omni m_ts; - /// - /// - /// - /// -public DebugDrawerObject(ref Omni ts){m_ts = ts;} /// /// Draws an axis aligned box primitive within the two 3d points. ) +/// /// public void drawBox(string debugdrawer, Point3F a, Point3F b, ColorF color = null ){ if (color== null) {color = new ColorF(1.0f, 1.0f, 1.0f,1.0f);} @@ -7905,6 +11368,7 @@ public void drawBox(string debugdrawer, Point3F a, Point3F b, ColorF color = nu } /// /// Draws a line primitive between two 3d points. ) +/// /// public void drawLine(string debugdrawer, Point3F a, Point3F b, ColorF color = null ){ if (color== null) {color = new ColorF(1.0f, 1.0f, 1.0f,1.0f);} @@ -7914,6 +11378,7 @@ public void drawLine(string debugdrawer, Point3F a, Point3F b, ColorF color = n } /// /// Sets the \"time to live\" (TTL) for the last rendered primitive. ) +/// /// public void setLastTTL(string debugdrawer, uint ms){ @@ -7922,6 +11387,7 @@ public void setLastTTL(string debugdrawer, uint ms){ } /// /// Sets the z buffer reading state for the last rendered primitive. ) +/// /// public void setLastZTest(string debugdrawer, bool enabled){ @@ -7930,6 +11396,7 @@ public void setLastZTest(string debugdrawer, bool enabled){ } /// /// Toggles the rendering of DebugDrawer primitives. ) +/// /// public void toggleDrawing(string debugdrawer){ @@ -7938,6 +11405,7 @@ public void toggleDrawing(string debugdrawer){ } /// /// Toggles freeze mode which keeps the currently rendered primitives from expiring. ) +/// /// public void toggleFreeze(string debugdrawer){ @@ -7950,14 +11418,14 @@ public void toggleFreeze(string debugdrawer){ /// public class DecalDataObject { -private Omni m_ts; - /// - /// - /// - /// -public DecalDataObject(ref Omni ts){m_ts = ts;} /// -/// Recompute the imagemap sub-texture rectangles for this DecalData. @tsexample // Inform the decal object to reload its imagemap and frame data. %decalData.texRows = 4; %decalData.postApply(); @endtsexample) +/// Recompute the imagemap sub-texture rectangles for this DecalData. +/// @tsexample +/// // Inform the decal object to reload its imagemap and frame data. +/// %decalData.texRows = 4; +/// %decalData.postApply(); +/// @endtsexample) +/// /// public void postApply(string decaldata){ @@ -7970,14 +11438,13 @@ public void postApply(string decaldata){ /// public class DecalRoadObject { -private Omni m_ts; - /// - /// - /// - /// -public DecalRoadObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit the material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// the material and other fields ( not including nodes ) +/// to client objects. +/// ) +/// /// public void postApply(string decalroad){ @@ -7985,7 +11452,10 @@ public void postApply(string decalroad){ m_ts.fnDecalRoad_postApply(decalroad); } /// -/// Intended as a helper to developers and editor scripts. Force DecalRoad to update it's spline and reclip geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force DecalRoad to update it's spline and reclip geometry. +/// ) +/// /// public void regenerate(string decalroad){ @@ -7998,14 +11468,14 @@ public void regenerate(string decalroad){ /// public class DynamicConsoleMethodComponentObject { -private Omni m_ts; - /// - /// - /// - /// -public DynamicConsoleMethodComponentObject(ref Omni ts){m_ts = ts;} /// -/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method @param methodName The method's name as a string @param argi Any arguments to pass to the method @return No return value @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method +/// @param methodName The method's name as a string +/// @param argi Any arguments to pass to the method +/// @return No return value +/// @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// +/// /// public void callMethod(string dynamicconsolemethodcomponent, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= "", string a21= "", string a22= "", string a23= "", string a24= "", string a25= "", string a26= "", string a27= "", string a28= "", string a29= "", string a30= "", string a31= "", string a32= "", string a33= "", string a34= "", string a35= "", string a36= "", string a37= "", string a38= "", string a39= "", string a40= "", string a41= "", string a42= "", string a43= "", string a44= "", string a45= "", string a46= "", string a47= "", string a48= "", string a49= "", string a50= "", string a51= "", string a52= "", string a53= "", string a54= "", string a55= "", string a56= "", string a57= "", string a58= "", string a59= "", string a60= "", string a61= "", string a62= "", string a63= ""){ @@ -8018,14 +11488,9 @@ public void callMethod(string dynamicconsolemethodcomponent, string a2= "", str /// public class EditManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public EditManagerObject(ref Omni ts){m_ts = ts;} /// /// Perform the onEditorDisabled callback on all SimObjects and set gEditingMission false ) +/// /// public void EditManager_editorDisabled(string editmanager){ @@ -8034,6 +11499,7 @@ public void EditManager_editorDisabled(string editmanager){ } /// /// Perform the onEditorEnabled callback on all SimObjects and set gEditingMission true ) +/// /// public void EditManager_editorEnabled(string editmanager){ @@ -8042,6 +11508,7 @@ public void EditManager_editorEnabled(string editmanager){ } /// /// (int slot)) +/// /// public void EditManager_gotoBookmark(string editmanager, int val){ @@ -8050,6 +11517,7 @@ public void EditManager_gotoBookmark(string editmanager, int val){ } /// /// Return the value of gEditingMission. ) +/// /// public bool EditManager_isEditorEnabled(string editmanager){ @@ -8058,6 +11526,7 @@ public bool EditManager_isEditorEnabled(string editmanager){ } /// /// (int slot)) +/// /// public void EditManager_setBookmark(string editmanager, int val){ @@ -8070,14 +11539,9 @@ public void EditManager_setBookmark(string editmanager, int val){ /// public class EditTSCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public EditTSCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public int getDisplayType(string edittsctrl){ @@ -8086,6 +11550,7 @@ public int getDisplayType(string edittsctrl){ } /// /// ) +/// /// public int getGizmo(string edittsctrl){ @@ -8094,6 +11559,7 @@ public int getGizmo(string edittsctrl){ } /// /// Return the FOV for orthographic views. ) +/// /// public float getOrthoFOV(string edittsctrl){ @@ -8102,6 +11568,7 @@ public float getOrthoFOV(string edittsctrl){ } /// /// ) +/// /// public bool isMiddleMouseDown(string edittsctrl){ @@ -8110,6 +11577,7 @@ public bool isMiddleMouseDown(string edittsctrl){ } /// /// ) +/// /// public void renderBox(string edittsctrl, Point3F pos, Point3F size){ @@ -8118,6 +11586,7 @@ public void renderBox(string edittsctrl, Point3F pos, Point3F size){ } /// /// ) +/// /// public void renderCircle(string edittsctrl, Point3F pos, Point3F normal, float radius, int segments = 0){ @@ -8126,6 +11595,7 @@ public void renderCircle(string edittsctrl, Point3F pos, Point3F normal, float } /// /// ) +/// /// public void renderLine(string edittsctrl, Point3F start, Point3F end, float lineWidth = 0){ @@ -8134,6 +11604,7 @@ public void renderLine(string edittsctrl, Point3F start, Point3F end, float lin } /// /// ) +/// /// public void renderSphere(string edittsctrl, Point3F pos, float radius, int sphereLevel = 0){ @@ -8142,6 +11613,7 @@ public void renderSphere(string edittsctrl, Point3F pos, float radius, int sphe } /// /// ) +/// /// public void renderTriangle(string edittsctrl, Point3F a, Point3F b, Point3F c){ @@ -8150,6 +11622,7 @@ public void renderTriangle(string edittsctrl, Point3F a, Point3F b, Point3F c){ } /// /// ) +/// /// public void setDisplayType(string edittsctrl, int displayType){ @@ -8158,6 +11631,7 @@ public void setDisplayType(string edittsctrl, int displayType){ } /// /// Set the FOV for to use for orthographic views. ) +/// /// public void setOrthoFOV(string edittsctrl, float fov){ @@ -8170,14 +11644,10 @@ public void setOrthoFOV(string edittsctrl, float fov){ /// public class EventManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public EventManagerObject(ref Omni ts){m_ts = ts;} /// -/// () Print all registered events to the console. ) +/// () +/// Print all registered events to the console. ) +/// /// public void EventManager_dumpEvents(string eventmanager){ @@ -8185,7 +11655,10 @@ public void EventManager_dumpEvents(string eventmanager){ m_ts.fn_EventManager_dumpEvents(eventmanager); } /// -/// ), ( String event ) Print all subscribers to an event to the console. @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// ), ( String event ) +/// Print all subscribers to an event to the console. +/// @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// /// public void EventManager_dumpSubscribers(string eventmanager, string listenerName = ""){ @@ -8193,7 +11666,11 @@ public void EventManager_dumpSubscribers(string eventmanager, string listenerNa m_ts.fn_EventManager_dumpSubscribers(eventmanager, listenerName); } /// -/// ( String event ) Check if an event is registered or not. @param event The event to check. @return Whether or not the event exists. ) +/// ( String event ) +/// Check if an event is registered or not. +/// @param event The event to check. +/// @return Whether or not the event exists. ) +/// /// public bool EventManager_isRegisteredEvent(string eventmanager, string evt){ @@ -8201,7 +11678,12 @@ public bool EventManager_isRegisteredEvent(string eventmanager, string evt){ return m_ts.fn_EventManager_isRegisteredEvent(eventmanager, evt); } /// -/// ), ( String event, String data ) ~Trigger an event. @param event The event to trigger. @param data The data associated with the event. @return Whether or not the event was dispatched successfully. ) +/// ), ( String event, String data ) +/// ~Trigger an event. +/// @param event The event to trigger. +/// @param data The data associated with the event. +/// @return Whether or not the event was dispatched successfully. ) +/// /// public bool EventManager_postEvent(string eventmanager, string evt, string data = ""){ @@ -8209,7 +11691,11 @@ public bool EventManager_postEvent(string eventmanager, string evt, string data return m_ts.fn_EventManager_postEvent(eventmanager, evt, data); } /// -/// ( String event ) Register an event with the event manager. @param event The event to register. @return Whether or not the event was registered successfully. ) +/// ( String event ) +/// Register an event with the event manager. +/// @param event The event to register. +/// @return Whether or not the event was registered successfully. ) +/// /// public bool EventManager_registerEvent(string eventmanager, string evt){ @@ -8217,7 +11703,11 @@ public bool EventManager_registerEvent(string eventmanager, string evt){ return m_ts.fn_EventManager_registerEvent(eventmanager, evt); } /// -/// ( SimObject listener, String event ) Remove a listener from an event. @param listener The listener to remove. @param event The event to be removed from.) +/// ( SimObject listener, String event ) +/// Remove a listener from an event. +/// @param listener The listener to remove. +/// @param event The event to be removed from.) +/// /// public void EventManager_remove(string eventmanager, string listenerName, string evt){ @@ -8225,7 +11715,10 @@ public void EventManager_remove(string eventmanager, string listenerName, strin m_ts.fn_EventManager_remove(eventmanager, listenerName, evt); } /// -/// ( SimObject listener ) Remove a listener from all events. @param listener The listener to remove.) +/// ( SimObject listener ) +/// Remove a listener from all events. +/// @param listener The listener to remove.) +/// /// public void EventManager_removeAll(string eventmanager, string listenerName){ @@ -8233,7 +11726,13 @@ public void EventManager_removeAll(string eventmanager, string listenerName){ m_ts.fn_EventManager_removeAll(eventmanager, listenerName); } /// -/// ), ( SimObject listener, String event, String callback ) Subscribe a listener to an event. @param listener The listener to subscribe. @param event The event to subscribe to. @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. @return Whether or not the subscription was successful. ) +/// ), ( SimObject listener, String event, String callback ) +/// Subscribe a listener to an event. +/// @param listener The listener to subscribe. +/// @param event The event to subscribe to. +/// @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. +/// @return Whether or not the subscription was successful. ) +/// /// public bool EventManager_subscribe(string eventmanager, string listenerName, string evt, string callback = ""){ @@ -8241,7 +11740,10 @@ public bool EventManager_subscribe(string eventmanager, string listenerName, st return m_ts.fn_EventManager_subscribe(eventmanager, listenerName, evt, callback); } /// -/// ( String event ) Remove an event from the EventManager. @param event The event to remove. ) +/// ( String event ) +/// Remove an event from the EventManager. +/// @param event The event to remove. ) +/// /// public void EventManager_unregisterEvent(string eventmanager, string evt){ @@ -8254,14 +11756,12 @@ public void EventManager_unregisterEvent(string eventmanager, string evt){ /// public class FieldBrushObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public FieldBrushObjectObject(ref Omni ts){m_ts = ts;} /// -/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ @param simObject Object to copy static-fields from. @param fieldList fields to filter static-fields against. @return No return value.) +/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ +/// @param simObject Object to copy static-fields from. +/// @param fieldList fields to filter static-fields against. +/// @return No return value.) +/// /// public void FieldBrushObject_copyFields(string fieldbrushobject, string simObjName, string pFieldList = ""){ @@ -8269,7 +11769,10 @@ public void FieldBrushObject_copyFields(string fieldbrushobject, string simObjN m_ts.fn_FieldBrushObject_copyFields(fieldbrushobject, simObjName, pFieldList); } /// -/// (simObject) Paste copied static-fields to selected object./ @param simObject Object to paste static-fields to. @return No return value.) +/// (simObject) Paste copied static-fields to selected object./ +/// @param simObject Object to paste static-fields to. +/// @return No return value.) +/// /// public void FieldBrushObject_pasteFields(string fieldbrushobject, string simObjName){ @@ -8277,7 +11780,11 @@ public void FieldBrushObject_pasteFields(string fieldbrushobject, string simObj m_ts.fn_FieldBrushObject_pasteFields(fieldbrushobject, simObjName); } /// -/// ), (simObject, [groupList]) Query available static-fields for selected object./ @param simObject Object to query static-fields on. @param groupList groups to filter static-fields against. @return Space-seperated static-field list.) +/// ), (simObject, [groupList]) Query available static-fields for selected object./ +/// @param simObject Object to query static-fields on. +/// @param groupList groups to filter static-fields against. +/// @return Space-seperated static-field list.) +/// /// public string FieldBrushObject_queryFields(string fieldbrushobject, string simObjName, string groupList = ""){ @@ -8285,7 +11792,10 @@ public string FieldBrushObject_queryFields(string fieldbrushobject, string simO return m_ts.fn_FieldBrushObject_queryFields(fieldbrushobject, simObjName, groupList); } /// -/// (simObject) Query available static-field groups for selected object./ @param simObject Object to query static-field groups on. @return Space-seperated static-field group list.) +/// (simObject) Query available static-field groups for selected object./ +/// @param simObject Object to query static-field groups on. +/// @return Space-seperated static-field group list.) +/// /// public string FieldBrushObject_queryGroups(string fieldbrushobject, string simObjName){ @@ -8298,14 +11808,92 @@ public string FieldBrushObject_queryGroups(string fieldbrushobject, string simO /// public class FileDialogObject { -private Omni m_ts; - /// - /// - /// - /// -public FileDialogObject(ref Omni ts){m_ts = ts;} /// -/// @brief Launches the OS file browser After an Execute() call, the chosen file name and path is available in one of two areas. If only a single file selection is permitted, the results will be stored in the @a fileName attribute. If multiple file selection is permitted, the results will be stored in the @a files array. The total number of files in the array will be stored in the @a fileCount attribute. @tsexample // NOTE: This is not he preferred class to use, but this still works // Create the file dialog %baseFileDialog = new FileDialog() { // Allow browsing of all file types filters = \"*.*\"; // No default file defaultFile = ; // Set default path relative to project defaultPath = \"./\"; // Set the title title = \"Durpa\"; // Allow changing of path you are browsing changePath = true; }; // Launch the file dialog %baseFileDialog.Execute(); // Don't forget to cleanup %baseFileDialog.delete(); // A better alternative is to use the // derived classes which are specific to file open and save // Create a dialog dedicated to opening files %openFileDlg = new OpenFileDialog() { // Look for jpg image files // First part is the descriptor|second part is the extension Filters = \"Jepg Files|*.jpg\"; // Allow browsing through other folders ChangePath = true; // Only allow opening of one file at a time MultipleFiles = false; }; // Launch the open file dialog %result = %openFileDlg.Execute(); // Obtain the chosen file name and path if ( %result ) { %seletedFile = %openFileDlg.file; } else { %selectedFile = \"\"; } // Cleanup %openFileDlg.delete(); // Create a dialog dedicated to saving a file %saveFileDlg = new SaveFileDialog() { // Only allow for saving of COLLADA files Filters = \"COLLADA Files (*.dae)|*.dae|\"; // Default save path to where the WorldEditor last saved DefaultPath = $pref::WorldEditor::LastPath; // No default file specified DefaultFile = \"\"; // Do not allow the user to change to a new directory ChangePath = false; // Prompt the user if they are going to overwrite an existing file OverwritePrompt = true; }; // Launch the save file dialog %result = %saveFileDlg.Execute(); // Obtain the file name %selectedFile = \"\"; if ( %result ) %selectedFile = %saveFileDlg.file; // Cleanup %saveFileDlg.delete(); @endtsexample @return True if the file was selected was successfully found (opened) or declared (saved).) +/// @brief Launches the OS file browser +/// +/// After an Execute() call, the chosen file name and path is available in one of two areas. +/// If only a single file selection is permitted, the results will be stored in the @a fileName +/// attribute. +/// +/// If multiple file selection is permitted, the results will be stored in the +/// @a files array. The total number of files in the array will be stored in the +/// @a fileCount attribute. +/// +/// @tsexample +/// // NOTE: This is not he preferred class to use, but this still works +/// // Create the file dialog +/// %baseFileDialog = new FileDialog() +/// { +/// // Allow browsing of all file types +/// filters = \"*.*\"; +/// // No default file +/// defaultFile = ; +/// // Set default path relative to project +/// defaultPath = \"./\"; +/// // Set the title +/// title = \"Durpa\"; +/// // Allow changing of path you are browsing +/// changePath = true; +/// }; +/// // Launch the file dialog +/// %baseFileDialog.Execute(); +/// +/// // Don't forget to cleanup +/// %baseFileDialog.delete(); +/// +/// // A better alternative is to use the +/// // derived classes which are specific to file open and save +/// // Create a dialog dedicated to opening files +/// %openFileDlg = new OpenFileDialog() +/// { +/// // Look for jpg image files +/// // First part is the descriptor|second part is the extension +/// Filters = \"Jepg Files|*.jpg\"; +/// // Allow browsing through other folders +/// ChangePath = true; +/// // Only allow opening of one file at a time +/// MultipleFiles = false; +/// }; +/// // Launch the open file dialog +/// %result = %openFileDlg.Execute(); +/// // Obtain the chosen file name and path +/// if ( %result ) +/// { +/// %seletedFile = %openFileDlg.file; +/// } +/// else +/// { +/// %selectedFile = \"\"; +/// } +/// // Cleanup +/// %openFileDlg.delete(); +/// +/// // Create a dialog dedicated to saving a file +/// %saveFileDlg = new SaveFileDialog() +/// { +/// // Only allow for saving of COLLADA files +/// Filters = \"COLLADA Files (*.dae)|*.dae|\"; +/// // Default save path to where the WorldEditor last saved +/// DefaultPath = $pref::WorldEditor::LastPath; +/// // No default file specified +/// DefaultFile = \"\"; +/// // Do not allow the user to change to a new directory +/// ChangePath = false; +/// // Prompt the user if they are going to overwrite an existing file +/// OverwritePrompt = true; +/// }; +/// // Launch the save file dialog +/// %result = %saveFileDlg.Execute(); +/// // Obtain the file name +/// %selectedFile = \"\"; +/// if ( %result ) +/// %selectedFile = %saveFileDlg.file; +/// // Cleanup +/// %saveFileDlg.delete(); +/// @endtsexample +/// +/// @return True if the file was selected was successfully found (opened) or declared (saved).) +/// /// public bool Execute(string filedialog){ @@ -8318,14 +11906,10 @@ public bool Execute(string filedialog){ /// public class FileObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public FileObjectObject(ref Omni ts){m_ts = ts;} /// -/// ), FileObject.writeObject(SimObject, object prepend) @hide) +/// ), FileObject.writeObject(SimObject, object prepend) +/// @hide) +/// /// public void FileObject_writeObject(string fileobject, string simName, string objName = ""){ @@ -8333,7 +11917,32 @@ public void FileObject_writeObject(string fileobject, string simName, string ob m_ts.fn_FileObject_writeObject(fileobject, simName, objName); } /// -/// @brief Close the file. It is EXTREMELY important that you call this function when you are finished reading or writing to a file. Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. Remember: Open, Read/Write, Close, Delete...in that order! @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); // Close the file when finished %fileWrite.close(); // Cleanup the file object %fileWrite.delete(); @endtsexample) +/// @brief Close the file. +/// +/// It is EXTREMELY important that you call this function when you are finished reading or writing to a file. +/// Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. +/// Remember: Open, Read/Write, Close, Delete...in that order! +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// // Close the file when finished +/// %fileWrite.close(); +/// // Cleanup the file object +/// %fileWrite.delete(); +/// @endtsexample) +/// /// public void close(string fileobject){ @@ -8341,7 +11950,25 @@ public void close(string fileobject){ m_ts.fnFileObject_close(fileobject); } /// -/// @brief Determines if the parser for this FileObject has reached the end of the file @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Keep reading until we reach the end of the file while( !%fileRead.isEOF() ) { %line = %fileRead.readline(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); @endtsexample @return True if the parser has reached the end of the file, false otherwise) +/// @brief Determines if the parser for this FileObject has reached the end of the file +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Keep reading until we reach the end of the file +/// while( !%fileRead.isEOF() ) +/// { +/// %line = %fileRead.readline(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise) +/// /// public bool isEOF(string fileobject){ @@ -8349,7 +11976,23 @@ public bool isEOF(string fileobject){ return m_ts.fnFileObject_isEOF(fileobject); } /// -/// @brief Open a specified file for writing, adding data to the end of the file There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. @param filename Path, name, and extension of file to append to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created // If it does exist, whatever we write will be added to the end %result = %fileWrite.OpenForAppend(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing, adding data to the end of the file +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), +/// which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. +/// +/// @param filename Path, name, and extension of file to append to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// // If it does exist, whatever we write will be added to the end +/// %result = %fileWrite.OpenForAppend(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool openForAppend(string fileobject, string filename){ @@ -8357,7 +12000,21 @@ public bool openForAppend(string fileobject, string filename){ return m_ts.fnFileObject_openForAppend(fileobject, filename); } /// -/// @brief Open a specified file for reading There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %result = %fileRead.OpenForRead(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for reading +/// +/// There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %result = %fileRead.OpenForRead(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool openForRead(string fileobject, string filename){ @@ -8365,7 +12022,21 @@ public bool openForRead(string fileobject, string filename){ return m_ts.fnFileObject_openForRead(fileobject, filename); } /// -/// @brief Open a specified file for writing There is no limit as to what kind of file you can write. Any format and data is allowable, not just text @param filename Path, name, and extension of file to write to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %result = %fileWrite.OpenForWrite(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text +/// +/// @param filename Path, name, and extension of file to write to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %result = %fileWrite.OpenForWrite(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool openForWrite(string fileobject, string filename){ @@ -8373,7 +12044,31 @@ public bool openForWrite(string fileobject, string filename){ return m_ts.fnFileObject_openForWrite(fileobject, filename); } /// -/// @brief Read a line from the file without moving the stream position. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); @endtsexample @return String containing the line of data that was just peeked) +/// @brief Read a line from the file without moving the stream position. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just peeked) +/// /// public string peekLine(string fileobject){ @@ -8381,7 +12076,24 @@ public string peekLine(string fileobject){ return m_ts.fnFileObject_peekLine(fileobject); } /// -/// @brief Read a line from file. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Read in the first line %line = %fileRead.readline(); // Print the line we just read echo(%line); @endtsexample @return String containing the line of data that was just read) +/// @brief Read a line from file. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Read in the first line +/// %line = %fileRead.readline(); +/// // Print the line we just read +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just read) +/// /// public string readLine(string fileobject){ @@ -8389,7 +12101,24 @@ public string readLine(string fileobject){ return m_ts.fnFileObject_readLine(fileobject); } /// -/// @brief Write a line to the file, if it was opened for writing. There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param text The data we are writing out to file. @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %fileWrite.OpenForWrite(\"./test.txt\"); // Write a line to the text files %fileWrite.writeLine(\"READ. READ CODE. CODE\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Write a line to the file, if it was opened for writing. +/// +/// There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param text The data we are writing out to file. +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %fileWrite.OpenForWrite(\"./test.txt\"); +/// // Write a line to the text files +/// %fileWrite.writeLine(\"READ. READ CODE. CODE\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public void writeLine(string fileobject, string text){ @@ -8402,14 +12131,20 @@ public void writeLine(string fileobject, string text){ /// public class FileStreamObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public FileStreamObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Close the file. You can no longer read or write to it unless you open it again. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see open()) +/// @brief Close the file. You can no longer read or write to it unless you open it again. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see open()) +/// /// public void close(string filestreamobject){ @@ -8417,7 +12152,34 @@ public void close(string filestreamobject){ m_ts.fnFileStreamObject_close(filestreamobject); } /// -/// @brief Open a file for reading, writing, reading and writing, or appending Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting at the end of the files existing contents. @param filename Name of file to open @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the file was successfully opened, false if something went wrong @see close()) +/// @brief Open a file for reading, writing, reading and writing, or appending +/// +/// Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new +/// file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. +/// +/// \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can +/// move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting +/// at the end of the files existing contents. +/// +/// @param filename Name of file to open +/// @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the file was successfully opened, false if something went wrong +/// +/// @see close()) +/// /// public bool open(string filestreamobject, string filename, string openMode){ @@ -8430,14 +12192,11 @@ public bool open(string filestreamobject, string filename, string openMode){ /// public class FlyingVehicleObject { -private Omni m_ts; - /// - /// - /// - /// -public FlyingVehicleObject(ref Omni ts){m_ts = ts;} /// -/// @brief Set whether the vehicle should temporarily use the createHoverHeight specified in the datablock.This can help avoid problems with spawning. @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// @brief Set whether the vehicle should temporarily use the createHoverHeight +/// specified in the datablock.This can help avoid problems with spawning. +/// @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// /// public void useCreateHeight(string flyingvehicle, bool enabled){ @@ -8450,14 +12209,9 @@ public void useCreateHeight(string flyingvehicle, bool enabled){ /// public class ForestObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestObject(ref Omni ts){m_ts = ts;} /// /// () ) +/// /// public void Forest_clear(string forest){ @@ -8466,6 +12220,7 @@ public void Forest_clear(string forest){ } /// /// ()) +/// /// public bool Forest_isDirty(string forest){ @@ -8474,6 +12229,7 @@ public bool Forest_isDirty(string forest){ } /// /// ()) +/// /// public void Forest_regenCells(string forest){ @@ -8481,15 +12237,18 @@ public void Forest_regenCells(string forest){ m_ts.fn_Forest_regenCells(forest); } /// -/// ), saveDataFile( [path] ) ) +/// saveDataFile( [path] ) ) +/// /// -public void Forest_saveDataFile(string forest, string path = ""){ +public void Forest_saveDataFile(string forest, string path = null ){ +if (path== null) {path = null;} m_ts.fn_Forest_saveDataFile(forest, path); } /// /// .) +/// /// public void addItem(string forest, string data, Point3F position, float rotation, float scale){ @@ -8498,6 +12257,7 @@ public void addItem(string forest, string data, Point3F position, float rotatio } /// /// .) +/// /// public void addItemWithTransform(string forest, string data, TransformF trans, float scale){ @@ -8510,14 +12270,9 @@ public void addItemWithTransform(string forest, string data, TransformF trans, /// public class ForestBrushObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestBrushObject(ref Omni ts){m_ts = ts;} /// /// ( ForestItemData obj ) ) +/// /// public bool ForestBrush_containsItemData(string forestbrush, string obj){ @@ -8530,14 +12285,9 @@ public bool ForestBrush_containsItemData(string forestbrush, string obj){ /// public class ForestBrushToolObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestBrushToolObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void ForestBrushTool_collectElements(string forestbrushtool){ @@ -8550,14 +12300,9 @@ public void ForestBrushTool_collectElements(string forestbrushtool){ /// public class ForestEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// ( ForestItemData obj ) ) +/// /// public void ForestEditorCtrl_deleteMeshSafe(string foresteditorctrl, string obj){ @@ -8566,6 +12311,7 @@ public void ForestEditorCtrl_deleteMeshSafe(string foresteditorctrl, string obj } /// /// () ) +/// /// public int ForestEditorCtrl_getActiveTool(string foresteditorctrl){ @@ -8574,6 +12320,7 @@ public int ForestEditorCtrl_getActiveTool(string foresteditorctrl){ } /// /// ) +/// /// public bool ForestEditorCtrl_isDirty(string foresteditorctrl){ @@ -8582,6 +12329,7 @@ public bool ForestEditorCtrl_isDirty(string foresteditorctrl){ } /// /// ( ForestTool tool ) ) +/// /// public void ForestEditorCtrl_setActiveTool(string foresteditorctrl, string toolName){ @@ -8590,6 +12338,7 @@ public void ForestEditorCtrl_setActiveTool(string foresteditorctrl, string tool } /// /// () ) +/// /// public void ForestEditorCtrl_updateActiveForest(string foresteditorctrl){ @@ -8602,14 +12351,9 @@ public void ForestEditorCtrl_updateActiveForest(string foresteditorctrl){ /// public class ForestSelectionToolObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestSelectionToolObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void ForestSelectionTool_clearSelection(string forestselectiontool){ @@ -8618,6 +12362,7 @@ public void ForestSelectionTool_clearSelection(string forestselectiontool){ } /// /// ) +/// /// public void ForestSelectionTool_copySelection(string forestselectiontool){ @@ -8626,6 +12371,7 @@ public void ForestSelectionTool_copySelection(string forestselectiontool){ } /// /// ) +/// /// public void ForestSelectionTool_cutSelection(string forestselectiontool){ @@ -8634,6 +12380,7 @@ public void ForestSelectionTool_cutSelection(string forestselectiontool){ } /// /// ) +/// /// public void ForestSelectionTool_deleteSelection(string forestselectiontool){ @@ -8642,6 +12389,7 @@ public void ForestSelectionTool_deleteSelection(string forestselectiontool){ } /// /// ) +/// /// public int ForestSelectionTool_getSelectionCount(string forestselectiontool){ @@ -8650,6 +12398,7 @@ public int ForestSelectionTool_getSelectionCount(string forestselectiontool){ } /// /// ) +/// /// public void ForestSelectionTool_pasteSelection(string forestselectiontool){ @@ -8662,42 +12411,38 @@ public void ForestSelectionTool_pasteSelection(string forestselectiontool){ /// public class ForestWindEmitterObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestWindEmitterObject(ref Omni ts){m_ts = ts;} /// -/// @brief Mounts the wind emitter to another scene object @param objectID Unique ID of the object wind emitter should attach to @tsexample // Wind emitter previously created and named %windEmitter // Going to attach it to the player, making him a walking wind storm %windEmitter.attachToObject(%player); @endtsexample) +/// @brief Mounts the wind emitter to another scene object +/// +/// @param objectID Unique ID of the object wind emitter should attach to +/// +/// @tsexample +/// // Wind emitter previously created and named %windEmitter +/// // Going to attach it to the player, making him a walking wind storm +/// %windEmitter.attachToObject(%player); +/// @endtsexample) +/// /// public void attachToObject(string forestwindemitter, uint objectID){ m_ts.fnForestWindEmitter_attachToObject(forestwindemitter, objectID); } -/// -/// @brief Mounts the wind emitter to another scene object @param ) -/// -public void resetWind(string forestwindemitter, int randomSeed){ - - -m_ts.fnForestWindEmitter_resetWind(forestwindemitter, randomSeed); -} } /// /// /// public class GameBaseObject { -private Omni m_ts; - /// - /// - /// - /// -public GameBaseObject(ref Omni ts){m_ts = ts;} /// -/// @brief Apply an impulse to this object as defined by a world position and velocity vector. @param pos impulse world position @param vel impulse velocity (impulse force F = m * v) @return Always true @note Not all objects that derrive from GameBase have this defined.) +/// @brief Apply an impulse to this object as defined by a world position and velocity vector. +/// +/// @param pos impulse world position +/// @param vel impulse velocity (impulse force F = m * v) +/// @return Always true +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public bool applyImpulse(string gamebase, Point3F pos, Point3F vel){ @@ -8705,7 +12450,14 @@ public bool applyImpulse(string gamebase, Point3F pos, Point3F vel){ return m_ts.fnGameBase_applyImpulse(gamebase, pos.AsString(), vel.AsString()); } /// -/// @brief Applies a radial impulse to the object using the given origin and force. @param origin World point of origin of the radial impulse. @param radius The radius of the impulse area. @param magnitude The strength of the impulse. @note Not all objects that derrive from GameBase have this defined.) +/// @brief Applies a radial impulse to the object using the given origin and force. +/// +/// @param origin World point of origin of the radial impulse. +/// @param radius The radius of the impulse area. +/// @param magnitude The strength of the impulse. +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public void applyRadialImpulse(string gamebase, Point3F origin, float radius, float magnitude){ @@ -8713,7 +12465,10 @@ public void applyRadialImpulse(string gamebase, Point3F origin, float radius, f m_ts.fnGameBase_applyRadialImpulse(gamebase, origin.AsString(), radius, magnitude); } /// -/// @brief Get the datablock used by this object. @return the datablock this GameBase is using. @see setDataBlock()) +/// @brief Get the datablock used by this object. +/// @return the datablock this GameBase is using. +/// @see setDataBlock()) +/// /// public int getDataBlock(string gamebase){ @@ -8721,7 +12476,11 @@ public int getDataBlock(string gamebase){ return m_ts.fnGameBase_getDataBlock(gamebase); } /// -/// @brief Assign this GameBase to use the specified datablock. @param data new datablock to use @return true if successful, false if failed. @see getDataBlock()) +/// @brief Assign this GameBase to use the specified datablock. +/// @param data new datablock to use +/// @return true if successful, false if failed. +/// @see getDataBlock()) +/// /// public bool setDataBlock(string gamebase, string data){ @@ -8734,14 +12493,37 @@ public bool setDataBlock(string gamebase, string data){ /// public class GameConnectionObject { -private Omni m_ts; - /// - /// - /// - /// -public GameConnectionObject(ref Omni ts){m_ts = ts;} /// -/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. Ghosts represent objects on the server that are in scope for the client. These need to be synchronized with the client in order for the client to see and interact with them. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mod paths, this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. +/// +/// Ghosts represent objects on the server that are in scope for the client. These need +/// to be synchronized with the client in order for the client to see and interact with them. +/// This is typically done during the standard mission start phase 2 when following Torque's +/// example mission startup sequence. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mod paths, this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void activateGhosting(string gameconnection){ @@ -8749,7 +12531,10 @@ public void activateGhosting(string gameconnection){ m_ts.fnGameConnection_activateGhosting(gameconnection); } /// -/// @brief Sets the size of the chase camera's matrix queue. @note This sets the queue size across all GameConnections. @note This is not currently hooked up.) +/// @brief Sets the size of the chase camera's matrix queue. +/// @note This sets the queue size across all GameConnections. +/// @note This is not currently hooked up.) +/// /// public bool chaseCam(string gameconnection, int size){ @@ -8757,7 +12542,10 @@ public bool chaseCam(string gameconnection, int size){ return m_ts.fnGameConnection_chaseCam(gameconnection, size); } /// -/// @brief Clear the connection's camera object reference. @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// @brief Clear the connection's camera object reference. +/// +/// @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// /// public void clearCameraObject(string gameconnection){ @@ -8765,7 +12553,9 @@ public void clearCameraObject(string gameconnection){ m_ts.fnGameConnection_clearCameraObject(gameconnection); } /// -/// @brief Clear any display device. A display device may define a number of properties that are used during rendering.) +/// @brief Clear any display device. +/// A display device may define a number of properties that are used during rendering.) +/// /// public void clearDisplayDevice(string gameconnection){ @@ -8773,7 +12563,26 @@ public void clearDisplayDevice(string gameconnection){ m_ts.fnGameConnection_clearDisplayDevice(gameconnection); } /// -/// ), @brief On the server, disconnect a client and pass along an optional reason why. This method performs two operations: it disconnects a client connection from the server, and it deletes the connection object. The optional reason is sent in the disconnect packet and is often displayed to the user so they know why they've been disconnected. @param reason [optional] The reason why the user has been disconnected from the server. @tsexample function kick(%client) { messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); if (!%client.isAIControlled()) BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); %client.delete(\"You have been kicked from this server\"); } @endtsexample) +/// ), +/// @brief On the server, disconnect a client and pass along an optional reason why. +/// +/// This method performs two operations: it disconnects a client connection from the server, +/// and it deletes the connection object. The optional reason is sent in the disconnect packet +/// and is often displayed to the user so they know why they've been disconnected. +/// +/// @param reason [optional] The reason why the user has been disconnected from the server. +/// +/// @tsexample +/// function kick(%client) +/// { +/// messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); +/// +/// if (!%client.isAIControlled()) +/// BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); +/// %client.delete(\"You have been kicked from this server\"); +/// } +/// @endtsexample) +/// /// public void delete(string gameconnection, string reason = ""){ @@ -8781,7 +12590,10 @@ public void delete(string gameconnection, string reason = ""){ m_ts.fnGameConnection_delete(gameconnection, reason); } /// -/// @brief Returns the connection's camera object used when not viewing through the control object. @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// @brief Returns the connection's camera object used when not viewing through the control object. +/// +/// @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// /// public string getCameraObject(string gameconnection){ @@ -8790,6 +12602,7 @@ public string getCameraObject(string gameconnection){ } /// /// @brief Returns the default field of view as used by the control object's camera.) +/// /// public float getControlCameraDefaultFov(string gameconnection){ @@ -8798,6 +12611,7 @@ public float getControlCameraDefaultFov(string gameconnection){ } /// /// @brief Returns the field of view as used by the control object's camera.) +/// /// public float getControlCameraFov(string gameconnection){ @@ -8805,7 +12619,12 @@ public float getControlCameraFov(string gameconnection){ return m_ts.fnGameConnection_getControlCameraFov(gameconnection); } /// -/// @brief On the server, returns the object that the client is controlling. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @see GameConnection::setControlObject()) +/// @brief On the server, returns the object that the client is controlling. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @see GameConnection::setControlObject()) +/// /// public string getControlObject(string gameconnection){ @@ -8813,7 +12632,11 @@ public string getControlObject(string gameconnection){ return m_ts.fnGameConnection_getControlObject(gameconnection); } /// -/// @brief Get the connection's control scheme absolute rotation property. @return True if the connection's control object should use an absolute rotation control scheme. @see GameConnection::setControlSchemeParameters()) +/// @brief Get the connection's control scheme absolute rotation property. +/// +/// @return True if the connection's control object should use an absolute rotation control scheme. +/// @see GameConnection::setControlSchemeParameters()) +/// /// public bool getControlSchemeAbsoluteRotation(string gameconnection){ @@ -8821,7 +12644,9 @@ public bool getControlSchemeAbsoluteRotation(string gameconnection){ return m_ts.fnGameConnection_getControlSchemeAbsoluteRotation(gameconnection); } /// -/// @brief On the client, get the control object's damage flash level. @return flash level) +/// @brief On the client, get the control object's damage flash level. +/// @return flash level) +/// /// public float getDamageFlash(string gameconnection){ @@ -8829,7 +12654,9 @@ public float getDamageFlash(string gameconnection){ return m_ts.fnGameConnection_getDamageFlash(gameconnection); } /// -/// @brief On the client, get the control object's white-out level. @return white-out level) +/// @brief On the client, get the control object's white-out level. +/// @return white-out level) +/// /// public float getWhiteOut(string gameconnection){ @@ -8837,7 +12664,9 @@ public float getWhiteOut(string gameconnection){ return m_ts.fnGameConnection_getWhiteOut(gameconnection); } /// -/// @brief Returns true if this connection is AI controlled. @see AIConnection) +/// @brief Returns true if this connection is AI controlled. +/// @see AIConnection) +/// /// public bool isAIControlled(string gameconnection){ @@ -8845,7 +12674,10 @@ public bool isAIControlled(string gameconnection){ return m_ts.fnGameConnection_isAIControlled(gameconnection); } /// -/// @brief Returns true if the object being controlled by the client is making use of a rotation damped camera. @see Camera) +/// @brief Returns true if the object being controlled by the client is making use +/// of a rotation damped camera. +/// @see Camera) +/// /// public bool isControlObjectRotDampedCamera(string gameconnection){ @@ -8853,7 +12685,10 @@ public bool isControlObjectRotDampedCamera(string gameconnection){ return m_ts.fnGameConnection_isControlObjectRotDampedCamera(gameconnection); } /// -/// @brief Returns true if a previously recorded demo file is now playing. @see GameConnection::playDemo()) +/// @brief Returns true if a previously recorded demo file is now playing. +/// +/// @see GameConnection::playDemo()) +/// /// public bool isDemoPlaying(string gameconnection){ @@ -8861,7 +12696,10 @@ public bool isDemoPlaying(string gameconnection){ return m_ts.fnGameConnection_isDemoPlaying(gameconnection); } /// -/// @brief Returns true if a demo file is now being recorded. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief Returns true if a demo file is now being recorded. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool isDemoRecording(string gameconnection){ @@ -8869,7 +12707,11 @@ public bool isDemoRecording(string gameconnection){ return m_ts.fnGameConnection_isDemoRecording(gameconnection); } /// -/// @brief Returns true if this connection is in first person mode. @note Transition to first person occurs over time via mCameraPos, so this won't immediately return true after a set.) +/// @brief Returns true if this connection is in first person mode. +/// +/// @note Transition to first person occurs over time via mCameraPos, so this +/// won't immediately return true after a set.) +/// /// public bool isFirstPerson(string gameconnection){ @@ -8877,7 +12719,9 @@ public bool isFirstPerson(string gameconnection){ return m_ts.fnGameConnection_isFirstPerson(gameconnection); } /// -/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. @note The list is sent to the console.) +/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. +/// @note The list is sent to the console.) +/// /// public void listClassIDs(string gameconnection){ @@ -8886,6 +12730,7 @@ public void listClassIDs(string gameconnection){ } /// /// ) +/// /// public bool LoadDatablocksFromFile(string gameconnection, uint crc){ @@ -8893,7 +12738,20 @@ public bool LoadDatablocksFromFile(string gameconnection, uint crc){ return m_ts.fnGameConnection_LoadDatablocksFromFile(gameconnection, crc); } /// -/// @brief Used on the server to play a 2D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @tsexample function ServerPlay2D(%profile) { // Play the given sound profile on every client. // The sounds will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play2D(%profile); } @endtsexample) +/// @brief Used on the server to play a 2D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// +/// @tsexample +/// function ServerPlay2D(%profile) +/// { +/// // Play the given sound profile on every client. +/// // The sounds will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play2D(%profile); +/// } +/// @endtsexample) +/// /// public bool play2D(string gameconnection, string profile){ @@ -8901,7 +12759,21 @@ public bool play2D(string gameconnection, string profile){ return m_ts.fnGameConnection_play2D(gameconnection, profile); } /// -/// @brief Used on the server to play a 3D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". @tsexample function ServerPlay3D(%profile,%transform) { // Play the given sound profile at the given position on every client // The sound will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play3D(%profile,%transform); } @endtsexample) +/// @brief Used on the server to play a 3D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". +/// +/// @tsexample +/// function ServerPlay3D(%profile,%transform) +/// { +/// // Play the given sound profile at the given position on every client +/// // The sound will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play3D(%profile,%transform); +/// } +/// @endtsexample) +/// /// public bool play3D(string gameconnection, string profile, TransformF location){ @@ -8909,7 +12781,19 @@ public bool play3D(string gameconnection, string profile, TransformF location){ return m_ts.fnGameConnection_play3D(gameconnection, profile, location.AsString()); } /// -/// @brief On the client, play back a previously recorded game session. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @returns True if the playback was successful. False if there was an issue, such as not being able to open the demo file for playback. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief On the client, play back a previously recorded game session. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @returns True if the playback was successful. False if there was an issue, such as +/// not being able to open the demo file for playback. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool playDemo(string gameconnection, string demoFileName){ @@ -8917,7 +12801,27 @@ public bool playDemo(string gameconnection, string demoFileName){ return m_ts.fnGameConnection_playDemo(gameconnection, demoFileName); } /// -/// @brief On the server, resets the connection to indicate that ghosting has been disabled. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that ghosts are no longer being transmitted. On the client end, all ghost information will be deleted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, resets the connection to indicate that ghosting has been disabled. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that ghosts are no longer being transmitted. On the client end, all ghost +/// information will be deleted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void resetGhosting(string gameconnection){ @@ -8925,7 +12829,11 @@ public void resetGhosting(string gameconnection){ m_ts.fnGameConnection_resetGhosting(gameconnection); } /// -/// @brief On the server, sets the client's 3D display to fade to black. @param doFade Set to true to fade to black, and false to fade from black. @param timeMS Time it takes to perform the fade as measured in ms. @note Not currently hooked up, and is not synchronized over the network.) +/// @brief On the server, sets the client's 3D display to fade to black. +/// @param doFade Set to true to fade to black, and false to fade from black. +/// @param timeMS Time it takes to perform the fade as measured in ms. +/// @note Not currently hooked up, and is not synchronized over the network.) +/// /// public void setBlackOut(string gameconnection, bool doFade, int timeMS){ @@ -8933,7 +12841,11 @@ public void setBlackOut(string gameconnection, bool doFade, int timeMS){ m_ts.fnGameConnection_setBlackOut(gameconnection, doFade, timeMS); } /// -/// @brief On the server, set the connection's camera object used when not viewing through the control object. @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// @brief On the server, set the connection's camera object used when not viewing +/// through the control object. +/// +/// @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// /// public bool setCameraObject(string gameconnection, string camera){ @@ -8941,7 +12853,14 @@ public bool setCameraObject(string gameconnection, string camera){ return m_ts.fnGameConnection_setCameraObject(gameconnection, camera); } /// -/// (GameConnection, setConnectArgs, void, 3, 17, (const char* args) @brief On the client, pass along a variable set of parameters to the server. Once the connection is established with the server, the server calls its onConnect() method with the client's passed in parameters as aruments. @see GameConnection::onConnect()) +/// (GameConnection, setConnectArgs, void, 3, 17, +/// (const char* args) @brief On the client, pass along a variable set of parameters to the server. +/// +/// Once the connection is established with the server, the server calls its onConnect() method +/// with the client's passed in parameters as aruments. +/// +/// @see GameConnection::onConnect()) +/// /// public void setConnectArgs(string gameconnection, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= ""){ @@ -8949,7 +12868,12 @@ public void setConnectArgs(string gameconnection, string a2= "", string a3= "", m_ts.fnGameConnection_setConnectArgs(gameconnection, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16); } /// -/// @brief On the server, sets the control object's camera's field of view. @param newFOV New field of view (in degrees) to force the control object's camera to use. This value is clamped to be within the range of 1 to 179 degrees. @note When transmitted over the network to the client, the resolution is limited to one degree. Any fraction is dropped.) +/// @brief On the server, sets the control object's camera's field of view. +/// @param newFOV New field of view (in degrees) to force the control object's camera to use. This value +/// is clamped to be within the range of 1 to 179 degrees. +/// @note When transmitted over the network to the client, the resolution is limited to +/// one degree. Any fraction is dropped.) +/// /// public void setControlCameraFov(string gameconnection, float newFOV){ @@ -8957,7 +12881,12 @@ public void setControlCameraFov(string gameconnection, float newFOV){ m_ts.fnGameConnection_setControlCameraFov(gameconnection, newFOV); } /// -/// @brief On the server, sets the object that the client will control. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @param ctrlObj The GameBase object on the server to control.) +/// @brief On the server, sets the object that the client will control. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @param ctrlObj The GameBase object on the server to control.) +/// /// public bool setControlObject(string gameconnection, string ctrlObj){ @@ -8965,7 +12894,11 @@ public bool setControlObject(string gameconnection, string ctrlObj){ return m_ts.fnGameConnection_setControlObject(gameconnection, ctrlObj); } /// -/// @brief Set the control scheme that may be used by a connection's control object. @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// @brief Set the control scheme that may be used by a connection's control object. +/// +/// @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. +/// @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// /// public void setControlSchemeParameters(string gameconnection, bool absoluteRotation, bool addYawToAbsRot, bool addPitchToAbsRot){ @@ -8973,7 +12906,10 @@ public void setControlSchemeParameters(string gameconnection, bool absoluteRota m_ts.fnGameConnection_setControlSchemeParameters(gameconnection, absoluteRotation, addYawToAbsRot, addPitchToAbsRot); } /// -/// @brief On the server, sets this connection into or out of first person mode. @param firstPerson Set to true to put the connection into first person mode.) +/// @brief On the server, sets this connection into or out of first person mode. +/// +/// @param firstPerson Set to true to put the connection into first person mode.) +/// /// public void setFirstPerson(string gameconnection, bool firstPerson){ @@ -8981,7 +12917,16 @@ public void setFirstPerson(string gameconnection, bool firstPerson){ m_ts.fnGameConnection_setFirstPerson(gameconnection, firstPerson); } /// -/// @brief On the client, set the password that will be passed to the server. On the server, this password is compared with what is stored in $pref::Server::Password. If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, if the passed in client password and the server password do not match, the CHR_PASSWORD error string is sent back to the client and the connection is immediately terminated. This password checking is performed quite early on in the connection request process so as to minimize the impact of multiple failed attempts -- also known as hacking.) +/// @brief On the client, set the password that will be passed to the server. +/// +/// On the server, this password is compared with what is stored in $pref::Server::Password. +/// If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, +/// if the passed in client password and the server password do not match, the CHR_PASSWORD +/// error string is sent back to the client and the connection is immediately terminated. +/// +/// This password checking is performed quite early on in the connection request process so as +/// to minimize the impact of multiple failed attempts -- also known as hacking.) +/// /// public void setJoinPassword(string gameconnection, string password){ @@ -8989,7 +12934,35 @@ public void setJoinPassword(string gameconnection, string password){ m_ts.fnGameConnection_setJoinPassword(gameconnection, password); } /// -/// @brief On the server, transmits the mission file's CRC value to the client. Typically, during the standard mission start phase 1, the mission file's CRC value on the server is send to the client. This allows the client to determine if the mission has changed since the last time it downloaded this mission and act appropriately, such as rebuilt cached lightmaps. @param CRC The mission file's CRC value on the server. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample) +/// @brief On the server, transmits the mission file's CRC value to the client. +/// +/// Typically, during the standard mission start phase 1, the mission file's CRC value +/// on the server is send to the client. This allows the client to determine if the mission +/// has changed since the last time it downloaded this mission and act appropriately, such as +/// rebuilt cached lightmaps. +/// +/// @param CRC The mission file's CRC value on the server. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample) +/// /// public void setMissionCRC(string gameconnection, int CRC){ @@ -8997,7 +12970,18 @@ public void setMissionCRC(string gameconnection, int CRC){ m_ts.fnGameConnection_setMissionCRC(gameconnection, CRC); } /// -/// @brief On the client, starts recording the network connection's traffic to a demo file. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @param fileName The file name to use for the demo recording. @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// @brief On the client, starts recording the network connection's traffic to a demo file. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @param fileName The file name to use for the demo recording. +/// +/// @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// /// public void startRecording(string gameconnection, string fileName){ @@ -9005,7 +12989,10 @@ public void startRecording(string gameconnection, string fileName){ m_ts.fnGameConnection_startRecording(gameconnection, fileName); } /// -/// @brief On the client, stops the recording of a connection's network traffic to a file. @see GameConnection::startRecording(), GameConnection::playDemo()) +/// @brief On the client, stops the recording of a connection's network traffic to a file. +/// +/// @see GameConnection::startRecording(), GameConnection::playDemo()) +/// /// public void stopRecording(string gameconnection){ @@ -9013,7 +13000,44 @@ public void stopRecording(string gameconnection){ m_ts.fnGameConnection_stopRecording(gameconnection); } /// -/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. SimDataBlocks, also known as just datablocks, need to be transmitted to the client prior to the client entering the game world. These represent the static data that most objects in the world reference. This is typically done during the standard mission start phase 1 when following Torque's example mission startup sequence. When the datablocks have all been transmitted, onDataBlocksDone() is called to move the mission start process to the next phase. @param sequence The sequence is common between the server and client and ensures that the client is acting on the most recent mission start process. If an errant network packet (one that was lost but has now been found) is received by the client with an incorrect sequence, it is just ignored. This sequence number is updated on the server every time a mission is loaded. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample @see GameConnection::onDataBlocksDone()) +/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. +/// +/// SimDataBlocks, also known as just datablocks, need to be transmitted to the client +/// prior to the client entering the game world. These represent the static data that +/// most objects in the world reference. This is typically done during the standard +/// mission start phase 1 when following Torque's example mission startup sequence. +/// +/// When the datablocks have all been transmitted, onDataBlocksDone() is called to move +/// the mission start process to the next phase. +/// +/// @param sequence The sequence is common between the server and client and ensures +/// that the client is acting on the most recent mission start process. If an errant +/// network packet (one that was lost but has now been found) is received by the client +/// with an incorrect sequence, it is just ignored. This sequence number is updated on +/// the server every time a mission is loaded. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample +/// +/// @see GameConnection::onDataBlocksDone()) +/// /// public void transmitDataBlocks(string gameconnection, int sequence){ @@ -9026,14 +13050,12 @@ public void transmitDataBlocks(string gameconnection, int sequence){ /// public class GroundPlaneObject { -private Omni m_ts; - /// - /// - /// - /// -public GroundPlaneObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields to client objects. +/// ) +/// /// public void postApply(string groundplane){ @@ -9046,14 +13068,9 @@ public void postApply(string groundplane){ /// public class GuiAutoCompleteCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiAutoCompleteCtrlObject(ref Omni ts){m_ts = ts;} /// /// ( GuiAutoCompleteCtrl, add, void, 3, 5, (string name, int idNum, int scheme=0)) +/// /// public void add(string guiautocompletectrl, string a2= "", string a3= "", string a4= ""){ @@ -9062,6 +13079,7 @@ public void add(string guiautocompletectrl, string a2= "", string a3= "", strin } /// /// ( GuiAutoCompleteCtrl, addScheme, void, 6, 6, (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void addScheme(string guiautocompletectrl, string a2, string a3, string a4, string a5= ""){ @@ -9070,6 +13088,7 @@ public void addScheme(string guiautocompletectrl, string a2, string a3, string } /// /// ( GuiAutoCompleteCtrl, changeTextById, void, 4, 4, ( int id, string text ) ) +/// /// public void changeTextById(string guiautocompletectrl, string a2, string a3= ""){ @@ -9078,6 +13097,7 @@ public void changeTextById(string guiautocompletectrl, string a2, string a3= "" } /// /// ( GuiAutoCompleteCtrl, clear, void, 2, 2, Clear the popup list.) +/// /// public void clear(string guiautocompletectrl= ""){ @@ -9086,6 +13106,7 @@ public void clear(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, clearEntry, void, 3, 3, (S32 entry)) +/// /// public void clearEntry(string guiautocompletectrl, string a2= ""){ @@ -9093,7 +13114,9 @@ public void clearEntry(string guiautocompletectrl, string a2= ""){ m_ts.fnGuiAutoCompleteCtrl_clearEntry(guiautocompletectrl, a2); } /// -/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) Returns the position of the first entry containing the specified text.) +/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int findText(string guiautocompletectrl, string a2= ""){ @@ -9102,6 +13125,7 @@ public int findText(string guiautocompletectrl, string a2= ""){ } /// /// ( GuiAutoCompleteCtrl, forceClose, void, 2, 2, ) +/// /// public void forceClose(string guiautocompletectrl= ""){ @@ -9110,6 +13134,7 @@ public void forceClose(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, forceOnAction, void, 2, 2, ) +/// /// public void forceOnAction(string guiautocompletectrl= ""){ @@ -9118,6 +13143,7 @@ public void forceOnAction(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, getSelected, S32, 2, 2, ) +/// /// public int getSelected(string guiautocompletectrl= ""){ @@ -9126,6 +13152,7 @@ public int getSelected(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, getText, void, 2, 2, ) +/// /// public void getText(string guiautocompletectrl= ""){ @@ -9134,6 +13161,7 @@ public void getText(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, getTextById, const char*, 3, 3, (int id)) +/// /// public string getTextById(string guiautocompletectrl, string a2= ""){ @@ -9142,6 +13170,7 @@ public string getTextById(string guiautocompletectrl, string a2= ""){ } /// /// ( GuiAutoCompleteCtrl, replaceText, void, 3, 3, (bool doReplaceText)) +/// /// public void replaceText(string guiautocompletectrl, string a2= ""){ @@ -9149,7 +13178,11 @@ public void replaceText(string guiautocompletectrl, string a2= ""){ m_ts.fnGuiAutoCompleteCtrl_replaceText(guiautocompletectrl, a2); } /// -/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void setEnumContent(string guiautocompletectrl, string a2, string a3= ""){ @@ -9158,6 +13191,7 @@ public void setEnumContent(string guiautocompletectrl, string a2, string a3= "" } /// /// ( GuiAutoCompleteCtrl, setFirstSelected, void, 2, 3, ([scriptCallback=true])) +/// /// public void setFirstSelected(string guiautocompletectrl= "", string a2= ""){ @@ -9166,6 +13200,7 @@ public void setFirstSelected(string guiautocompletectrl= "", string a2= ""){ } /// /// ( GuiAutoCompleteCtrl, setNoneSelected, void, 2, 2, ) +/// /// public void setNoneSelected(string guiautocompletectrl= ""){ @@ -9174,6 +13209,7 @@ public void setNoneSelected(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, setSelected, void, 3, 4, (int id, [scriptCallback=true])) +/// /// public void setSelected(string guiautocompletectrl, string a2= "", string a3= ""){ @@ -9182,6 +13218,7 @@ public void setSelected(string guiautocompletectrl, string a2= "", string a3= " } /// /// ( GuiAutoCompleteCtrl, size, S32, 2, 2, Get the size of the menu - the number of entries in it.) +/// /// public int size(string guiautocompletectrl= ""){ @@ -9190,6 +13227,7 @@ public int size(string guiautocompletectrl= ""){ } /// /// (GuiAutoCompleteCtrl, sort, void, 2, 2, Sort the list alphabetically.) +/// /// public void sort(string guiautocompletectrl= ""){ @@ -9198,6 +13236,7 @@ public void sort(string guiautocompletectrl= ""){ } /// /// (GuiAutoCompleteCtrl, sortID, void, 2, 2, Sort the list by ID.) +/// /// public void sortID(string guiautocompletectrl= ""){ @@ -9210,14 +13249,9 @@ public void sortID(string guiautocompletectrl= ""){ /// public class GuiAutoScrollCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiAutoScrollCtrlObject(ref Omni ts){m_ts = ts;} /// /// Reset scrolling. ) +/// /// public void reset(string guiautoscrollctrl){ @@ -9230,14 +13264,10 @@ public void reset(string guiautoscrollctrl){ /// public class GuiBitmapButtonCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiBitmapButtonCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Set the bitmap to show on the button. @param path Path to the texture file in any of the supported formats. ) +/// Set the bitmap to show on the button. +/// @param path Path to the texture file in any of the supported formats. ) +/// /// public void setBitmap(string guibitmapbuttonctrl, string path){ @@ -9250,14 +13280,10 @@ public void setBitmap(string guibitmapbuttonctrl, string path){ /// public class GuiBitmapCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiBitmapCtrlObject(ref Omni ts){m_ts = ts;} /// -/// ( String filename | String filename, bool resize ) Assign an image to the control. @hide ) +/// ( String filename | String filename, bool resize ) Assign an image to the control. +/// @hide ) +/// /// public void GuiBitmapCtrl_setBitmap(string guibitmapctrl, string fileRoot, bool resize = false){ @@ -9265,7 +13291,10 @@ public void GuiBitmapCtrl_setBitmap(string guibitmapctrl, string fileRoot, bool m_ts.fn_GuiBitmapCtrl_setBitmap(guibitmapctrl, fileRoot, resize); } /// -/// Set the offset of the bitmap within the control. @param x The x-axis offset of the image. @param y The y-axis offset of the image.) +/// Set the offset of the bitmap within the control. +/// @param x The x-axis offset of the image. +/// @param y The y-axis offset of the image.) +/// /// public void setValue(string guibitmapctrl, int x, int y){ @@ -9278,14 +13307,10 @@ public void setValue(string guibitmapctrl, int x, int y){ /// public class GuiButtonBaseCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiButtonBaseCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the text display on the button's label (if any). @return The button's label. ) +/// Get the text display on the button's label (if any). +/// @return The button's label. ) +/// /// public string getText(string guibuttonbasectrl){ @@ -9293,7 +13318,10 @@ public string getText(string guibuttonbasectrl){ return m_ts.fnGuiButtonBaseCtrl_getText(guibuttonbasectrl); } /// -/// Simulate a click on the button. This method will trigger the button's action just as if the button had been pressed by the user. ) +/// Simulate a click on the button. +/// This method will trigger the button's action just as if the button had been pressed by the +/// user. ) +/// /// public void performClick(string guibuttonbasectrl){ @@ -9301,7 +13329,9 @@ public void performClick(string guibuttonbasectrl){ m_ts.fnGuiButtonBaseCtrl_performClick(guibuttonbasectrl); } /// -/// Reset the mousing state of the button. This method should not generally be called. ) +/// Reset the mousing state of the button. +/// This method should not generally be called. ) +/// /// public void resetState(string guibuttonbasectrl){ @@ -9309,7 +13339,12 @@ public void resetState(string guibuttonbasectrl){ m_ts.fnGuiButtonBaseCtrl_resetState(guibuttonbasectrl); } /// -/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, toggling a button on will toggle all other radio buttons in its group to off. @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the button. To do that, use performClick(). ) +/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, +/// toggling a button on will toggle all other radio buttons in its group to off. +/// @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. +/// @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the +/// button. To do that, use performClick(). ) +/// /// public void setStateOn(string guibuttonbasectrl, bool isOn = true){ @@ -9317,7 +13352,12 @@ public void setStateOn(string guibuttonbasectrl, bool isOn = true){ m_ts.fnGuiButtonBaseCtrl_setStateOn(guibuttonbasectrl, isOn); } /// -/// Set the text displayed on the button's label. @param text The text to display as the button's text label. @note Not all buttons render text labels. @see getText @see setTextID ) +/// Set the text displayed on the button's label. +/// @param text The text to display as the button's text label. +/// @note Not all buttons render text labels. +/// @see getText +/// @see setTextID ) +/// /// public void setText(string guibuttonbasectrl, string text){ @@ -9325,7 +13365,17 @@ public void setText(string guibuttonbasectrl, string text){ m_ts.fnGuiButtonBaseCtrl_setText(guibuttonbasectrl, text); } /// -/// Set the text displayed on the button's label using a string from the string table assigned to the control. @param id Name of the variable that contains the integer string ID. Used to look up string in table. @note Not all buttons render text labels. @see setText @see getText @see GuiControl::langTableMod @see LangTable @ref Gui_i18n ) +/// Set the text displayed on the button's label using a string from the string table +/// assigned to the control. +/// @param id Name of the variable that contains the integer string ID. Used to look up +/// string in table. +/// @note Not all buttons render text labels. +/// @see setText +/// @see getText +/// @see GuiControl::langTableMod +/// @see LangTable +/// @ref Gui_i18n ) +/// /// public void setTextID(string guibuttonbasectrl, string id){ @@ -9338,14 +13388,9 @@ public void setTextID(string guibuttonbasectrl, string id){ /// public class GuiCanvasObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiCanvasObject(ref Omni ts){m_ts = ts;} /// /// () - Is this canvas currently fullscreen? ) +/// /// public bool GuiCanvas_isFullscreen(string guicanvas){ @@ -9354,6 +13399,7 @@ public bool GuiCanvas_isFullscreen(string guicanvas){ } /// /// () ) +/// /// public bool GuiCanvas_isMaximized(string guicanvas){ @@ -9362,6 +13408,7 @@ public bool GuiCanvas_isMaximized(string guicanvas){ } /// /// () ) +/// /// public bool GuiCanvas_isMinimized(string guicanvas){ @@ -9370,6 +13417,7 @@ public bool GuiCanvas_isMinimized(string guicanvas){ } /// /// () - maximize this canvas' window. ) +/// /// public void GuiCanvas_maximizeWindow(string guicanvas){ @@ -9378,6 +13426,7 @@ public void GuiCanvas_maximizeWindow(string guicanvas){ } /// /// () - minimize this canvas' window. ) +/// /// public void GuiCanvas_minimizeWindow(string guicanvas){ @@ -9385,7 +13434,9 @@ public void GuiCanvas_minimizeWindow(string guicanvas){ m_ts.fn_GuiCanvas_minimizeWindow(guicanvas); } /// -/// (GuiControl ctrl=NULL) @hide) +/// (GuiControl ctrl=NULL) +/// @hide) +/// /// public void GuiCanvas_popDialog(string guicanvas, string gui){ @@ -9393,7 +13444,9 @@ public void GuiCanvas_popDialog(string guicanvas, string gui){ m_ts.fn_GuiCanvas_popDialog(guicanvas, gui); } /// -/// (int layer) @hide) +/// (int layer) +/// @hide) +/// /// public void GuiCanvas_popLayer(string guicanvas, int layer = 0){ @@ -9401,7 +13454,9 @@ public void GuiCanvas_popLayer(string guicanvas, int layer = 0){ m_ts.fn_GuiCanvas_popLayer(guicanvas, layer); } /// -/// (GuiControl ctrl, int layer=0, bool center=false) @hide) +/// (GuiControl ctrl, int layer=0, bool center=false) +/// @hide) +/// /// public void GuiCanvas_pushDialog(string guicanvas, string ctrlName, int layer = 0, bool center = false){ @@ -9410,6 +13465,7 @@ public void GuiCanvas_pushDialog(string guicanvas, string ctrlName, int layer = } /// /// () - restore this canvas' window. ) +/// /// public void GuiCanvas_restoreWindow(string guicanvas){ @@ -9417,7 +13473,9 @@ public void GuiCanvas_restoreWindow(string guicanvas){ m_ts.fn_GuiCanvas_restoreWindow(guicanvas); } /// -/// (Point2I pos) @hide) +/// (Point2I pos) +/// @hide) +/// /// public void GuiCanvas_setCursorPos(string guicanvas, Point2I pos){ @@ -9426,6 +13484,7 @@ public void GuiCanvas_setCursorPos(string guicanvas, Point2I pos){ } /// /// () - Claim OS input focus for this canvas' window.) +/// /// public void GuiCanvas_setFocus(string guicanvas){ @@ -9433,7 +13492,15 @@ public void GuiCanvas_setFocus(string guicanvas){ m_ts.fn_GuiCanvas_setFocus(guicanvas); } /// -/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. \\param width The screen width to set. \\param height The screen height to set. \\param fullscreen Specify true to run fullscreen or false to run in a window \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) +/// Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. +/// \\param width The screen width to set. +/// \\param height The screen height to set. +/// \\param fullscreen Specify true to run fullscreen or false to run in a window +/// \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. +/// \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window +/// \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// /// public void GuiCanvas_setVideoMode(string guicanvas, uint width, uint height, bool fullscreen = false, uint bitDepth = 0, uint refreshRate = 0, uint antialiasLevel = 0){ @@ -9441,7 +13508,10 @@ public void GuiCanvas_setVideoMode(string guicanvas, uint width, uint height, b m_ts.fn_GuiCanvas_setVideoMode(guicanvas, width, height, fullscreen, bitDepth, refreshRate, antialiasLevel); } /// -/// Translate a coordinate from canvas window-space to screen-space. @param coordinate The coordinate in window-space. @return The given coordinate translated to screen-space. ) +/// Translate a coordinate from canvas window-space to screen-space. +/// @param coordinate The coordinate in window-space. +/// @return The given coordinate translated to screen-space. ) +/// /// public Point2I clientToScreen(string guicanvas, Point2I coordinate){ @@ -9449,7 +13519,11 @@ public Point2I clientToScreen(string guicanvas, Point2I coordinate){ return new Point2I ( m_ts.fnGuiCanvas_clientToScreen(guicanvas, coordinate.AsString())); } /// -/// @brief Turns on the mouse off. @tsexample Canvas.cursorOff(); @endtsexample) +/// @brief Turns on the mouse off. +/// @tsexample +/// Canvas.cursorOff(); +/// @endtsexample) +/// /// public void cursorOff(string guicanvas){ @@ -9457,7 +13531,11 @@ public void cursorOff(string guicanvas){ m_ts.fnGuiCanvas_cursorOff(guicanvas); } /// -/// @brief Turns on the mouse cursor. @tsexample Canvas.cursorOn(); @endtsexample) +/// @brief Turns on the mouse cursor. +/// @tsexample +/// Canvas.cursorOn(); +/// @endtsexample) +/// /// public void cursorOn(string guicanvas){ @@ -9465,7 +13543,11 @@ public void cursorOn(string guicanvas){ m_ts.fnGuiCanvas_cursorOn(guicanvas); } /// -/// @brief Find the first monitor index that matches the given name. The actual match algorithm depends on the implementation. @param name The name to search for. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Find the first monitor index that matches the given name. +/// The actual match algorithm depends on the implementation. +/// @param name The name to search for. +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int findFirstMatchingMonitor(string guicanvas, string name){ @@ -9473,7 +13555,14 @@ public int findFirstMatchingMonitor(string guicanvas, string name){ return m_ts.fnGuiCanvas_findFirstMatchingMonitor(guicanvas, name); } /// -/// @brief Get the GuiControl which is being used as the content. @tsexample Canvas.getContent(); @endtsexample @return ID of current content control) +/// @brief Get the GuiControl which is being used as the content. +/// +/// @tsexample +/// Canvas.getContent(); +/// @endtsexample +/// +/// @return ID of current content control) +/// /// public int getContent(string guicanvas){ @@ -9481,7 +13570,13 @@ public int getContent(string guicanvas){ return m_ts.fnGuiCanvas_getContent(guicanvas); } /// -/// @brief Get the current position of the cursor. @param param Description @tsexample %cursorPos = Canvas.getCursorPos(); @endtsexample @return Screen coordinates of mouse cursor, in format \"X Y\") +/// @brief Get the current position of the cursor. +/// @param param Description +/// @tsexample +/// %cursorPos = Canvas.getCursorPos(); +/// @endtsexample +/// @return Screen coordinates of mouse cursor, in format \"X Y\") +/// /// public Point2I getCursorPos(string guicanvas){ @@ -9489,7 +13584,14 @@ public Point2I getCursorPos(string guicanvas){ return new Point2I ( m_ts.fnGuiCanvas_getCursorPos(guicanvas)); } /// -/// @brief Returns the dimensions of the canvas @tsexample %extent = Canvas.getExtent(); @endtsexample @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// @brief Returns the dimensions of the canvas +/// +/// @tsexample +/// %extent = Canvas.getExtent(); +/// @endtsexample +/// +/// @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// /// public Point2I getExtent(string guicanvas){ @@ -9497,7 +13599,11 @@ public Point2I getExtent(string guicanvas){ return new Point2I ( m_ts.fnGuiCanvas_getExtent(guicanvas)); } /// -/// @brief Gets information on the specified mode of this device. @param modeId Index of the mode to get data from. @return A video mode string given an adapter and mode index. @see GuiCanvas::getVideoMode()) +/// @brief Gets information on the specified mode of this device. +/// @param modeId Index of the mode to get data from. +/// @return A video mode string given an adapter and mode index. +/// @see GuiCanvas::getVideoMode()) +/// /// public string getMode(string guicanvas, int modeId){ @@ -9505,7 +13611,16 @@ public string getMode(string guicanvas, int modeId){ return m_ts.fnGuiCanvas_getMode(guicanvas, modeId); } /// -/// @brief Gets the number of modes available on this device. @param param Description @tsexample %modeCount = Canvas.getModeCount() @endtsexample @return The number of video modes supported by the device) +/// @brief Gets the number of modes available on this device. +/// +/// @param param Description +/// +/// @tsexample +/// %modeCount = Canvas.getModeCount() +/// @endtsexample +/// +/// @return The number of video modes supported by the device) +/// /// public int getModeCount(string guicanvas){ @@ -9513,7 +13628,10 @@ public int getModeCount(string guicanvas){ return m_ts.fnGuiCanvas_getModeCount(guicanvas); } /// -/// @brief Gets the number of monitors attached to the system. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Gets the number of monitors attached to the system. +/// +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int getMonitorCount(string guicanvas){ @@ -9521,7 +13639,10 @@ public int getMonitorCount(string guicanvas){ return m_ts.fnGuiCanvas_getMonitorCount(guicanvas); } /// -/// @brief Gets the name of the requested monitor. @param index The monitor index. @return The name of the requested monitor.) +/// @brief Gets the name of the requested monitor. +/// @param index The monitor index. +/// @return The name of the requested monitor.) +/// /// public string getMonitorName(string guicanvas, int index){ @@ -9529,7 +13650,10 @@ public string getMonitorName(string guicanvas, int index){ return m_ts.fnGuiCanvas_getMonitorName(guicanvas, index); } /// -/// @brief Gets the region of the requested monitor. @param index The monitor index. @return The rectangular region of the requested monitor.) +/// @brief Gets the region of the requested monitor. +/// @param index The monitor index. +/// @return The rectangular region of the requested monitor.) +/// /// public RectI getMonitorRect(string guicanvas, int index){ @@ -9537,7 +13661,13 @@ public RectI getMonitorRect(string guicanvas, int index){ return new RectI ( m_ts.fnGuiCanvas_getMonitorRect(guicanvas, index)); } /// -/// @brief Gets the gui control under the mouse. @tsexample %underMouse = Canvas.getMouseControl(); @endtsexample @return ID of the gui control, if one was found. NULL otherwise) +/// @brief Gets the gui control under the mouse. +/// @tsexample +/// %underMouse = Canvas.getMouseControl(); +/// @endtsexample +/// +/// @return ID of the gui control, if one was found. NULL otherwise) +/// /// public int getMouseControl(string guicanvas){ @@ -9545,7 +13675,21 @@ public int getMouseControl(string guicanvas){ return m_ts.fnGuiCanvas_getMouseControl(guicanvas); } /// -/// @brief Gets the current screen mode as a string. The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). You will need to parse out each one for individual use. @tsexample %screenWidth = getWord(Canvas.getVideoMode(), 0); %screenHeight = getWord(Canvas.getVideoMode(), 1); %isFullscreen = getWord(Canvas.getVideoMode(), 2); %bitdepth = getWord(Canvas.getVideoMode(), 3); %refreshRate = getWord(Canvas.getVideoMode(), 4); @endtsexample @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// @brief Gets the current screen mode as a string. +/// +/// The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). +/// You will need to parse out each one for individual use. +/// +/// @tsexample +/// %screenWidth = getWord(Canvas.getVideoMode(), 0); +/// %screenHeight = getWord(Canvas.getVideoMode(), 1); +/// %isFullscreen = getWord(Canvas.getVideoMode(), 2); +/// %bitdepth = getWord(Canvas.getVideoMode(), 3); +/// %refreshRate = getWord(Canvas.getVideoMode(), 4); +/// @endtsexample +/// +/// @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// /// public string getVideoMode(string guicanvas){ @@ -9553,7 +13697,9 @@ public string getVideoMode(string guicanvas){ return m_ts.fnGuiCanvas_getVideoMode(guicanvas); } /// -/// Get the current position of the platform window associated with the canvas. @return The window position of the canvas in screen-space. ) +/// Get the current position of the platform window associated with the canvas. +/// @return The window position of the canvas in screen-space. ) +/// /// public Point2I getWindowPosition(string guicanvas){ @@ -9561,7 +13707,12 @@ public Point2I getWindowPosition(string guicanvas){ return new Point2I ( m_ts.fnGuiCanvas_getWindowPosition(guicanvas)); } /// -/// @brief Disable rendering of the cursor. @tsexample Canvas.hideCursor(); @endtsexample) +/// @brief Disable rendering of the cursor. +/// +/// @tsexample +/// Canvas.hideCursor(); +/// @endtsexample) +/// /// public void hideCursor(string guicanvas){ @@ -9569,7 +13720,24 @@ public void hideCursor(string guicanvas){ m_ts.fnGuiCanvas_hideCursor(guicanvas); } /// -/// @brief Determines if mouse cursor is enabled. @tsexample // Is cursor on? if(Canvas.isCursorOn()) echo(\"Canvas cursor is on\"); @endtsexample @return Returns true if the cursor is on.) +/// ( GuiCanvas, hideWindow, void, 2, 2, ) +/// +/// +public void hideWindow(string guicanvas= ""){ + + +m_ts.fnGuiCanvas_hideWindow(guicanvas); +} +/// +/// @brief Determines if mouse cursor is enabled. +/// +/// @tsexample +/// // Is cursor on? +/// if(Canvas.isCursorOn()) +/// echo(\"Canvas cursor is on\"); +/// @endtsexample +/// @return Returns true if the cursor is on.) +/// /// public bool isCursorOn(string guicanvas){ @@ -9577,7 +13745,15 @@ public bool isCursorOn(string guicanvas){ return m_ts.fnGuiCanvas_isCursorOn(guicanvas); } /// -/// @brief Determines if mouse cursor is rendering. @tsexample // Is cursor rendering? if(Canvas.isCursorShown()) echo(\"Canvas cursor is rendering\"); @endtsexample @return Returns true if the cursor is rendering.) +/// @brief Determines if mouse cursor is rendering. +/// +/// @tsexample +/// // Is cursor rendering? +/// if(Canvas.isCursorShown()) +/// echo(\"Canvas cursor is rendering\"); +/// @endtsexample +/// @return Returns true if the cursor is rendering.) +/// /// public bool isCursorShown(string guicanvas){ @@ -9585,7 +13761,14 @@ public bool isCursorShown(string guicanvas){ return m_ts.fnGuiCanvas_isCursorShown(guicanvas); } /// -/// @brief This turns on/off front-buffer rendering. @param enable True if all rendering should be done to the front buffer @tsexample Canvas.renderFront(false); @endtsexample) +/// @brief This turns on/off front-buffer rendering. +/// +/// @param enable True if all rendering should be done to the front buffer +/// +/// @tsexample +/// Canvas.renderFront(false); +/// @endtsexample) +/// /// public void renderFront(string guicanvas, bool enable){ @@ -9593,7 +13776,15 @@ public void renderFront(string guicanvas, bool enable){ m_ts.fnGuiCanvas_renderFront(guicanvas, enable); } /// -/// @brief Force canvas to redraw. If the elapsed time is greater than the time since the last paint then the repaint will be skipped. @param elapsedMS The optional elapsed time in milliseconds. @tsexample Canvas.repaint(); @endtsexample) +/// @brief Force canvas to redraw. +/// If the elapsed time is greater than the time since the last paint +/// then the repaint will be skipped. +/// @param elapsedMS The optional elapsed time in milliseconds. +/// +/// @tsexample +/// Canvas.repaint(); +/// @endtsexample) +/// /// public void repaint(string guicanvas, int elapsedMS = 0){ @@ -9601,7 +13792,12 @@ public void repaint(string guicanvas, int elapsedMS = 0){ m_ts.fnGuiCanvas_repaint(guicanvas, elapsedMS); } /// -/// @brief Reset the update regions for the canvas. @tsexample Canvas.reset(); @endtsexample) +/// @brief Reset the update regions for the canvas. +/// +/// @tsexample +/// Canvas.reset(); +/// @endtsexample) +/// /// public void reset(string guicanvas){ @@ -9609,7 +13805,10 @@ public void reset(string guicanvas){ m_ts.fnGuiCanvas_reset(guicanvas); } /// -/// Translate a coordinate from screen-space to canvas window-space. @param coordinate The coordinate in screen-space. @return The given coordinate translated to window-space. ) +/// Translate a coordinate from screen-space to canvas window-space. +/// @param coordinate The coordinate in screen-space. +/// @return The given coordinate translated to window-space. ) +/// /// public Point2I screenToClient(string guicanvas, Point2I coordinate){ @@ -9617,7 +13816,14 @@ public Point2I screenToClient(string guicanvas, Point2I coordinate){ return new Point2I ( m_ts.fnGuiCanvas_screenToClient(guicanvas, coordinate.AsString())); } /// -/// @brief Set the content of the canvas to a specified control. @param ctrl ID or name of GuiControl to set content to @tsexample Canvas.setContent(PlayGui); @endtsexample) +/// @brief Set the content of the canvas to a specified control. +/// +/// @param ctrl ID or name of GuiControl to set content to +/// +/// @tsexample +/// Canvas.setContent(PlayGui); +/// @endtsexample) +/// /// public void setContent(string guicanvas, string ctrl){ @@ -9625,7 +13831,14 @@ public void setContent(string guicanvas, string ctrl){ m_ts.fnGuiCanvas_setContent(guicanvas, ctrl); } /// -/// @brief Sets the cursor for the canvas. @param cursor Name of the GuiCursor to use @tsexample Canvas.setCursor(\"DefaultCursor\"); @endtsexample) +/// @brief Sets the cursor for the canvas. +/// +/// @param cursor Name of the GuiCursor to use +/// +/// @tsexample +/// Canvas.setCursor(\"DefaultCursor\"); +/// @endtsexample) +/// /// public void setCursor(string guicanvas, string cursor){ @@ -9634,6 +13847,7 @@ public void setCursor(string guicanvas, string cursor){ } /// /// (bool shown) - Enabled when a context menu/popup menu is shown.) +/// /// public void setPopupShown(string guicanvas, bool shown){ @@ -9641,7 +13855,9 @@ public void setPopupShown(string guicanvas, bool shown){ m_ts.fnGuiCanvas_setPopupShown(guicanvas, shown); } /// -/// Set the position of the platform window associated with the canvas. @param position The new position of the window in screen-space. ) +/// Set the position of the platform window associated with the canvas. +/// @param position The new position of the window in screen-space. ) +/// /// public void setWindowPosition(string guicanvas, Point2I position){ @@ -9649,7 +13865,14 @@ public void setWindowPosition(string guicanvas, Point2I position){ m_ts.fnGuiCanvas_setWindowPosition(guicanvas, position.AsString()); } /// -/// @brief Change the title of the OS window. @param newTitle String containing the new name @tsexample Canvas.setWindowTitle(\"Documentation Rocks!\"); @endtsexample) +/// @brief Change the title of the OS window. +/// +/// @param newTitle String containing the new name +/// +/// @tsexample +/// Canvas.setWindowTitle(\"Documentation Rocks!\"); +/// @endtsexample) +/// /// public void setWindowTitle(string guicanvas, string newTitle){ @@ -9657,7 +13880,12 @@ public void setWindowTitle(string guicanvas, string newTitle){ m_ts.fnGuiCanvas_setWindowTitle(guicanvas, newTitle); } /// -/// @brief Enable rendering of the cursor. @tsexample Canvas.showCursor(); @endtsexample) +/// @brief Enable rendering of the cursor. +/// +/// @tsexample +/// Canvas.showCursor(); +/// @endtsexample) +/// /// public void showCursor(string guicanvas){ @@ -9665,7 +13893,22 @@ public void showCursor(string guicanvas){ m_ts.fnGuiCanvas_showCursor(guicanvas); } /// -/// @brief toggle canvas from fullscreen to windowed mode or back. @tsexample // If we are in windowed mode, the following will put is in fullscreen Canvas.toggleFullscreen(); @endtsexample) +/// ( GuiCanvas, showWindow, void, 2, 2, ) +/// +/// +public void showWindow(string guicanvas= ""){ + + +m_ts.fnGuiCanvas_showWindow(guicanvas); +} +/// +/// @brief toggle canvas from fullscreen to windowed mode or back. +/// +/// @tsexample +/// // If we are in windowed mode, the following will put is in fullscreen +/// Canvas.toggleFullscreen(); +/// @endtsexample) +/// /// public void toggleFullscreen(string guicanvas){ @@ -9678,14 +13921,10 @@ public void toggleFullscreen(string guicanvas){ /// public class GuiCheckBoxCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiCheckBoxCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Test whether the checkbox is currently checked. @return True if the checkbox is currently ticked, false otherwise. ) +/// Test whether the checkbox is currently checked. +/// @return True if the checkbox is currently ticked, false otherwise. ) +/// /// public bool isStateOn(string guicheckboxctrl){ @@ -9693,7 +13932,11 @@ public bool isStateOn(string guicheckboxctrl){ return m_ts.fnGuiCheckBoxCtrl_isStateOn(guicheckboxctrl); } /// -/// Set whether the checkbox is ticked or not. @param newState If true the box will be checked, if false, it will be unchecked. @note This method will @b not trigger the command associated with the control. To toggle the checkbox state as if the user had clicked the control, use performClick(). ) +/// Set whether the checkbox is ticked or not. +/// @param newState If true the box will be checked, if false, it will be unchecked. +/// @note This method will @b not trigger the command associated with the control. To toggle the +/// checkbox state as if the user had clicked the control, use performClick(). ) +/// /// public void setStateOn(string guicheckboxctrl, bool newState){ @@ -9706,14 +13949,13 @@ public void setStateOn(string guicheckboxctrl, bool newState){ /// public class GuiChunkedBitmapCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiChunkedBitmapCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Set the image rendered in this control. @param filename The image name you want to set @tsexample ChunkedBitmap.setBitmap(\"images/background.png\"); @endtsexample) +/// @brief Set the image rendered in this control. +/// @param filename The image name you want to set +/// @tsexample +/// ChunkedBitmap.setBitmap(\"images/background.png\"); +/// @endtsexample) +/// /// public void setBitmap(string guichunkedbitmapctrl, string filename){ @@ -9726,14 +13968,15 @@ public void setBitmap(string guichunkedbitmapctrl, string filename){ /// public class GuiClockHudObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiClockHudObject(ref Omni ts){m_ts = ts;} /// -/// Returns the current time, in seconds. @return timeInseconds Current time, in seconds @tsexample // Get the current time from the GuiClockHud control %timeInSeconds = %guiClockHud.getTime(); @endtsexample ) +/// Returns the current time, in seconds. +/// @return timeInseconds Current time, in seconds +/// @tsexample +/// // Get the current time from the GuiClockHud control +/// %timeInSeconds = %guiClockHud.getTime(); +/// @endtsexample +/// ) +/// /// public float getTime(string guiclockhud){ @@ -9741,7 +13984,12 @@ public float getTime(string guiclockhud){ return m_ts.fnGuiClockHud_getTime(guiclockhud); } /// -/// @brief Sets a time for a countdown clock. Setting the time like this will cause the clock to count backwards from the specified time. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @see setTime ) +/// @brief Sets a time for a countdown clock. +/// Setting the time like this will cause the clock to count backwards from the specified time. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @see setTime +/// ) +/// /// public void setReverseTime(string guiclockhud, float timeInSeconds = 60){ @@ -9749,7 +13997,16 @@ public void setReverseTime(string guiclockhud, float timeInSeconds = 60){ m_ts.fnGuiClockHud_setReverseTime(guiclockhud, timeInSeconds); } /// -/// Sets the current base time for the clock. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @tsexample // Define the time, in seconds %timeInSeconds = 120; // Change the time on the GuiClockHud control %guiClockHud.setTime(%timeInSeconds); @endtsexample ) +/// Sets the current base time for the clock. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @tsexample +/// // Define the time, in seconds +/// %timeInSeconds = 120; +/// // Change the time on the GuiClockHud control +/// %guiClockHud.setTime(%timeInSeconds); +/// @endtsexample +/// ) +/// /// public void setTime(string guiclockhud, float timeInSeconds = 60){ @@ -9762,14 +14019,9 @@ public void setTime(string guiclockhud, float timeInSeconds = 60){ /// public class GuiColorPickerCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiColorPickerCtrlObject(ref Omni ts){m_ts = ts;} /// /// Gets the current position of the selector) +/// /// public Point2I GuiColorPickerCtrl_getSelectorPos(string guicolorpickerctrl){ @@ -9778,6 +14030,7 @@ public Point2I GuiColorPickerCtrl_getSelectorPos(string guicolorpickerctrl){ } /// /// Sets the current position of the selector) +/// /// public void GuiColorPickerCtrl_setSelectorPos(string guicolorpickerctrl, Point2I newPos){ @@ -9786,6 +14039,7 @@ public void GuiColorPickerCtrl_setSelectorPos(string guicolorpickerctrl, Point2 } /// /// Forces update of pick color) +/// /// public void GuiColorPickerCtrl_updateColor(string guicolorpickerctrl){ @@ -9798,14 +14052,9 @@ public void GuiColorPickerCtrl_updateColor(string guicolorpickerctrl){ /// public class GuiControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiControlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public RectI GuiControl_getBounds(string guicontrol){ @@ -9814,6 +14063,7 @@ public RectI GuiControl_getBounds(string guicontrol){ } /// /// ) +/// /// public string GuiControl_getValue(string guicontrol){ @@ -9822,6 +14072,7 @@ public string GuiControl_getValue(string guicontrol){ } /// /// ) +/// /// public bool GuiControl_isActive(string guicontrol){ @@ -9830,6 +14081,7 @@ public bool GuiControl_isActive(string guicontrol){ } /// /// (bool isFirst)) +/// /// public void GuiControl_makeFirstResponder(string guicontrol, bool isFirst){ @@ -9837,7 +14089,9 @@ public void GuiControl_makeFirstResponder(string guicontrol, bool isFirst){ m_ts.fn_GuiControl_makeFirstResponder(guicontrol, isFirst); } /// -/// Set the width and height of the control. @hide ) +/// Set the width and height of the control. +/// @hide ) +/// /// public void GuiControl_setExtent(string guicontrol, Point2F ext){ @@ -9845,7 +14099,13 @@ public void GuiControl_setExtent(string guicontrol, Point2F ext){ m_ts.fn_GuiControl_setExtent(guicontrol, ext.AsString()); } /// -/// Add the given control as a child to this control. This is synonymous to calling SimGroup::addObject. @param control The control to add as a child. @note The control will retain its current position and size. @see SimGroup::addObject @ref GuiControl_Hierarchy ) +/// Add the given control as a child to this control. +/// This is synonymous to calling SimGroup::addObject. +/// @param control The control to add as a child. +/// @note The control will retain its current position and size. +/// @see SimGroup::addObject +/// @ref GuiControl_Hierarchy ) +/// /// public void addGuiControl(string guicontrol, string control){ @@ -9854,6 +14114,7 @@ public void addGuiControl(string guicontrol, string control){ } /// /// Returns if the control's background color can be changed in the game or not. ) +/// /// public bool canChangeContextBackColor(string guicontrol){ @@ -9862,6 +14123,7 @@ public bool canChangeContextBackColor(string guicontrol){ } /// /// Returns if the control's fill color can be changed in the game or not. ) +/// /// public bool canChangeContextFillColor(string guicontrol){ @@ -9870,6 +14132,7 @@ public bool canChangeContextFillColor(string guicontrol){ } /// /// Returns if the control's font color can be changed in the game or not. ) +/// /// public bool canChangeContextFontColor(string guicontrol){ @@ -9878,6 +14141,7 @@ public bool canChangeContextFontColor(string guicontrol){ } /// /// Returns if the control's font size can be changed in the game or not. ) +/// /// public bool canChangeContextFontSize(string guicontrol){ @@ -9886,6 +14150,7 @@ public bool canChangeContextFontSize(string guicontrol){ } /// /// Returns if the control's window settings can be changed in the game or not. ) +/// /// public bool canShowContextWindowSettings(string guicontrol){ @@ -9893,7 +14158,9 @@ public bool canShowContextWindowSettings(string guicontrol){ return m_ts.fnGuiControl_canShowContextWindowSettings(guicontrol); } /// -/// Clear this control from being the first responder in its hierarchy chain. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Clear this control from being the first responder in its hierarchy chain. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void clearFirstResponder(string guicontrol, bool ignored = false){ @@ -9901,7 +14168,10 @@ public void clearFirstResponder(string guicontrol, bool ignored = false){ m_ts.fnGuiControl_clearFirstResponder(guicontrol, ignored); } /// -/// Test whether the given control is a direct or indirect child to this control. @param control The potential child control. @return True if the given control is a direct or indirect child to this control. ) +/// Test whether the given control is a direct or indirect child to this control. +/// @param control The potential child control. +/// @return True if the given control is a direct or indirect child to this control. ) +/// /// public bool controlIsChild(string guicontrol, string control){ @@ -9909,7 +14179,10 @@ public bool controlIsChild(string guicontrol, string control){ return m_ts.fnGuiControl_controlIsChild(guicontrol, control); } /// -/// Test whether the given control is a sibling of this control. @param control The potential sibling control. @return True if the given control is a sibling of this control. ) +/// Test whether the given control is a sibling of this control. +/// @param control The potential sibling control. +/// @return True if the given control is a sibling of this control. ) +/// /// public bool controlIsSibling(string guicontrol, string control){ @@ -9917,7 +14190,14 @@ public bool controlIsSibling(string guicontrol, string control){ return m_ts.fnGuiControl_controlIsSibling(guicontrol, control); } /// -/// Find the topmost child control located at the given coordinates. @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. @param x The X coordinate in the control's own coordinate space. @param y The Y coordinate in the control's own coordinate space. @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. @see GuiControlProfile::modal @see findHitControls ) +/// Find the topmost child control located at the given coordinates. +/// @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. +/// @param x The X coordinate in the control's own coordinate space. +/// @param y The Y coordinate in the control's own coordinate space. +/// @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. +/// @see GuiControlProfile::modal +/// @see findHitControls ) +/// /// public string findHitControl(string guicontrol, int x, int y){ @@ -9925,7 +14205,20 @@ public string findHitControl(string guicontrol, int x, int y){ return m_ts.fnGuiControl_findHitControl(guicontrol, x, y); } /// -/// Find all visible child controls that intersect with the given rectangle. @note Invisible child controls will not be included in the search. @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. @param width The width of the search rectangle in pixels. @param height The height of the search rectangle in pixels. @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. @tsexample // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) %ctrl.setLocked( true ); @endtsexample @see findHitControl ) +/// Find all visible child controls that intersect with the given rectangle. +/// @note Invisible child controls will not be included in the search. +/// @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param width The width of the search rectangle in pixels. +/// @param height The height of the search rectangle in pixels. +/// @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. +/// @tsexample +/// // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. +/// foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) +/// %ctrl.setLocked( true ); +/// @endtsexample +/// @see findHitControl ) +/// /// public string findHitControls(string guicontrol, int x, int y, int width, int height){ @@ -9934,6 +14227,7 @@ public string findHitControls(string guicontrol, int x, int y, int width, int h } /// /// Get the alpha fade time for the object. ) +/// /// public int getAlphaFadeTime(string guicontrol){ @@ -9942,6 +14236,7 @@ public int getAlphaFadeTime(string guicontrol){ } /// /// Get the alpha for the object. ) +/// /// public float getAlphaValue(string guicontrol){ @@ -9949,7 +14244,10 @@ public float getAlphaValue(string guicontrol){ return m_ts.fnGuiControl_getAlphaValue(guicontrol); } /// -/// Get the aspect ratio of the control's extents. @return The width of the control divided by its height. @see getExtent ) +/// Get the aspect ratio of the control's extents. +/// @return The width of the control divided by its height. +/// @see getExtent ) +/// /// public float getAspect(string guicontrol){ @@ -9957,7 +14255,9 @@ public float getAspect(string guicontrol){ return m_ts.fnGuiControl_getAspect(guicontrol); } /// -/// Get the coordinate of the control's center point relative to its parent. @return The coordinate of the control's center point in parent-relative coordinates. ) +/// Get the coordinate of the control's center point relative to its parent. +/// @return The coordinate of the control's center point in parent-relative coordinates. ) +/// /// public Point2I getCenter(string guicontrol){ @@ -9966,6 +14266,7 @@ public Point2I getCenter(string guicontrol){ } /// /// Sets the font size of a control. ) +/// /// public int getControlFontSize(string guicontrol){ @@ -9974,6 +14275,7 @@ public int getControlFontSize(string guicontrol){ } /// /// Returns if the control is locked or not. ) +/// /// public bool getControlLock(string guicontrol){ @@ -9982,6 +14284,7 @@ public bool getControlLock(string guicontrol){ } /// /// Returns the filename of the texture of the control. ) +/// /// public string getControlTextureFile(string guicontrol){ @@ -9989,7 +14292,9 @@ public string getControlTextureFile(string guicontrol){ return m_ts.fnGuiControl_getControlTextureFile(guicontrol); } /// -/// Get the width and height of the control. @return A point structure containing the width of the control in x and the height in y. ) +/// Get the width and height of the control. +/// @return A point structure containing the width of the control in x and the height in y. ) +/// /// public Point2I getExtent(string guicontrol){ @@ -9997,7 +14302,13 @@ public Point2I getExtent(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getExtent(guicontrol)); } /// -/// Get the first responder set on this GuiControl tree. @return The first responder set on the control's subtree. @see isFirstResponder @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Get the first responder set on this GuiControl tree. +/// @return The first responder set on the control's subtree. +/// @see isFirstResponder +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public string getFirstResponder(string guicontrol){ @@ -10005,7 +14316,9 @@ public string getFirstResponder(string guicontrol){ return m_ts.fnGuiControl_getFirstResponder(guicontrol); } /// -/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. @Return the center coordinate of the control in root-relative coordinates. ) +/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. +/// @Return the center coordinate of the control in root-relative coordinates. ) +/// /// public Point2I getGlobalCenter(string guicontrol){ @@ -10013,7 +14326,9 @@ public Point2I getGlobalCenter(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getGlobalCenter(guicontrol)); } /// -/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. @return The control's current position in root-relative coordinates. ) +/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @return The control's current position in root-relative coordinates. ) +/// /// public Point2I getGlobalPosition(string guicontrol){ @@ -10021,7 +14336,10 @@ public Point2I getGlobalPosition(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getGlobalPosition(guicontrol)); } /// -/// Get the maximum allowed size of the control. @return The maximum size to which the control can be shrunk. @see maxExtent ) +/// Get the maximum allowed size of the control. +/// @return The maximum size to which the control can be shrunk. +/// @see maxExtent ) +/// /// public Point2I getMaxExtent(string guicontrol){ @@ -10029,7 +14347,10 @@ public Point2I getMaxExtent(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getMaxExtent(guicontrol)); } /// -/// Get the minimum allowed size of the control. @return The minimum size to which the control can be shrunk. @see minExtent ) +/// Get the minimum allowed size of the control. +/// @return The minimum size to which the control can be shrunk. +/// @see minExtent ) +/// /// public Point2I getMinExtent(string guicontrol){ @@ -10038,6 +14359,7 @@ public Point2I getMinExtent(string guicontrol){ } /// /// Get the mouse over alpha for the object. ) +/// /// public float getMouseOverAlphaValue(string guicontrol){ @@ -10045,7 +14367,9 @@ public float getMouseOverAlphaValue(string guicontrol){ return m_ts.fnGuiControl_getMouseOverAlphaValue(guicontrol); } /// -/// Get the immediate parent control of the control. @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// Get the immediate parent control of the control. +/// @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// /// public string getParent(string guicontrol){ @@ -10053,7 +14377,9 @@ public string getParent(string guicontrol){ return m_ts.fnGuiControl_getParent(guicontrol); } /// -/// Get the control's current position relative to its parent. @return The coordinate of the control in its parent's coordinate space. ) +/// Get the control's current position relative to its parent. +/// @return The coordinate of the control in its parent's coordinate space. ) +/// /// public Point2I getPosition(string guicontrol){ @@ -10061,7 +14387,10 @@ public Point2I getPosition(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getPosition(guicontrol)); } /// -/// Get the canvas on which the control is placed. @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. @see GuiControl_Hierarchy ) +/// Get the canvas on which the control is placed. +/// @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. +/// @see GuiControl_Hierarchy ) +/// /// public string getRoot(string guicontrol){ @@ -10070,6 +14399,7 @@ public string getRoot(string guicontrol){ } /// /// Get root control ) +/// /// public string getRootControl(string guicontrol){ @@ -10077,7 +14407,11 @@ public string getRootControl(string guicontrol){ return m_ts.fnGuiControl_getRootControl(guicontrol); } /// -/// Test whether the control is currently awake. If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. @return True if the control is awake. @ref GuiControl_Waking ) +/// Test whether the control is currently awake. +/// If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. +/// @return True if the control is awake. +/// @ref GuiControl_Waking ) +/// /// public bool isAwake(string guicontrol){ @@ -10086,6 +14420,7 @@ public bool isAwake(string guicontrol){ } /// /// Returns if the control's alpha value can be changed in the game or not. ) +/// /// public bool isContextAlphaEnabled(string guicontrol){ @@ -10094,6 +14429,7 @@ public bool isContextAlphaEnabled(string guicontrol){ } /// /// Returns if the control's alpha fade value can be changed in the game or not. ) +/// /// public bool isContextAlphaFadeEnabled(string guicontrol){ @@ -10102,6 +14438,7 @@ public bool isContextAlphaFadeEnabled(string guicontrol){ } /// /// Returns if the control can be locked in the game or not. ) +/// /// public bool isContextLockable(string guicontrol){ @@ -10110,6 +14447,7 @@ public bool isContextLockable(string guicontrol){ } /// /// Returns if the control's mouse-over alpha value can be changed in the game or not. ) +/// /// public bool isContextMouseOverAlphaEnabled(string guicontrol){ @@ -10118,6 +14456,7 @@ public bool isContextMouseOverAlphaEnabled(string guicontrol){ } /// /// Returns if the control can be moved in the game or not. ) +/// /// public bool isContextMovable(string guicontrol){ @@ -10125,7 +14464,12 @@ public bool isContextMovable(string guicontrol){ return m_ts.fnGuiControl_isContextMovable(guicontrol); } /// -/// Test whether the control is the current first responder. @return True if the control is the current first responder. @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Test whether the control is the current first responder. +/// @return True if the control is the current first responder. +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public bool isFirstResponder(string guicontrol){ @@ -10133,7 +14477,9 @@ public bool isFirstResponder(string guicontrol){ return m_ts.fnGuiControl_isFirstResponder(guicontrol); } /// -/// Indicates if the mouse is locked in this control. @return True if the mouse is currently locked. ) +/// Indicates if the mouse is locked in this control. +/// @return True if the mouse is currently locked. ) +/// /// public bool isMouseLocked(string guicontrol){ @@ -10141,7 +14487,12 @@ public bool isMouseLocked(string guicontrol){ return m_ts.fnGuiControl_isMouseLocked(guicontrol); } /// -/// Test whether the control is currently set to be visible. @return True if the control is currently set to be visible. @note This method does not tell anything about whether the control is actually visible to the user at the moment. @ref GuiControl_VisibleActive ) +/// Test whether the control is currently set to be visible. +/// @return True if the control is currently set to be visible. +/// @note This method does not tell anything about whether the control is actually visible to +/// the user at the moment. +/// @ref GuiControl_VisibleActive ) +/// /// public bool isVisible(string guicontrol){ @@ -10149,7 +14500,13 @@ public bool isVisible(string guicontrol){ return m_ts.fnGuiControl_isVisible(guicontrol); } /// -/// Test whether the given point lies within the rectangle of the control. @param x X coordinate of the point in parent-relative coordinates. @param y Y coordinate of the point in parent-relative coordinates. @return True if the point is within the control, false if not. @see getExtent @see getPosition ) +/// Test whether the given point lies within the rectangle of the control. +/// @param x X coordinate of the point in parent-relative coordinates. +/// @param y Y coordinate of the point in parent-relative coordinates. +/// @return True if the point is within the control, false if not. +/// @see getExtent +/// @see getPosition ) +/// /// public bool pointInControl(string guicontrol, int x, int y){ @@ -10166,7 +14523,9 @@ public void refresh(string guicontrol){ m_ts.fnGuiControl_refresh(guicontrol); } /// -/// Removes the plus cursor. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Removes the plus cursor. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void resetCur(string guicontrol){ @@ -10174,7 +14533,13 @@ public void resetCur(string guicontrol){ m_ts.fnGuiControl_resetCur(guicontrol); } /// -/// Resize and reposition the control using the give coordinates and dimensions. Child controls will resize according to their layout behaviors. @param x The new X coordinate of the control in its parent's coordinate space. @param y The new Y coordinate of the control in its parent's coordinate space. @param width The new width to which the control should be resized. @param height The new height to which the control should be resized. ) +/// Resize and reposition the control using the give coordinates and dimensions. Child controls +/// will resize according to their layout behaviors. +/// @param x The new X coordinate of the control in its parent's coordinate space. +/// @param y The new Y coordinate of the control in its parent's coordinate space. +/// @param width The new width to which the control should be resized. +/// @param height The new height to which the control should be resized. ) +/// /// public void resize(string guicontrol, int x, int y, int width, int height){ @@ -10183,6 +14548,7 @@ public void resize(string guicontrol, int x, int y, int width, int height){ } /// /// ) +/// /// public void setActive(string guicontrol, bool state = true){ @@ -10190,7 +14556,9 @@ public void setActive(string guicontrol, bool state = true){ m_ts.fnGuiControl_setActive(guicontrol, state); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void setAlphaFadeTime(string guicontrol, int fadeTime = 1000){ @@ -10198,7 +14566,9 @@ public void setAlphaFadeTime(string guicontrol, int fadeTime = 1000){ m_ts.fnGuiControl_setAlphaFadeTime(guicontrol, fadeTime); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void setAlphaValue(string guicontrol, float alpha = 1){ @@ -10206,7 +14576,10 @@ public void setAlphaValue(string guicontrol, float alpha = 1){ m_ts.fnGuiControl_setAlphaValue(guicontrol, alpha); } /// -/// Set the control's position by its center point. @param x The X coordinate of the new center point of the control relative to the control's parent. @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// Set the control's position by its center point. +/// @param x The X coordinate of the new center point of the control relative to the control's parent. +/// @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// /// public void setCenter(string guicontrol, int x, int y){ @@ -10215,6 +14588,7 @@ public void setCenter(string guicontrol, int x, int y){ } /// /// Displays the option to set the alpha of the control in the game when true. ) +/// /// public void setContextAlpha(string guicontrol, bool alpha){ @@ -10223,6 +14597,7 @@ public void setContextAlpha(string guicontrol, bool alpha){ } /// /// Displays the option to set the alpha fade value of the control in the game when true. ) +/// /// public void setContextAlphaFade(string guicontrol, bool fade){ @@ -10231,6 +14606,7 @@ public void setContextAlphaFade(string guicontrol, bool fade){ } /// /// Displays the option to set the background color of the control in the game when true. ) +/// /// public void setContextBackColor(string guicontrol, bool backColor){ @@ -10239,6 +14615,7 @@ public void setContextBackColor(string guicontrol, bool backColor){ } /// /// Displays the option to set the fill color of the control in the game when true. ) +/// /// public void setContextFillColor(string guicontrol, bool fillColor){ @@ -10247,6 +14624,7 @@ public void setContextFillColor(string guicontrol, bool fillColor){ } /// /// Displays the option to set the font color of the control in the game when true. ) +/// /// public void setContextFontColor(string guicontrol, bool fontColor){ @@ -10255,6 +14633,7 @@ public void setContextFontColor(string guicontrol, bool fontColor){ } /// /// Displays the option to set the font size of the control in the game when true. ) +/// /// public void setContextFontSize(string guicontrol, bool fontSize){ @@ -10263,6 +14642,7 @@ public void setContextFontSize(string guicontrol, bool fontSize){ } /// /// Displays the option to lock the control in the game when true. ) +/// /// public void setContextLockControl(string guicontrol, bool lockx){ @@ -10271,6 +14651,7 @@ public void setContextLockControl(string guicontrol, bool lockx){ } /// /// Displays the option to set the mouse-over alpha of the control in the game when true. ) +/// /// public void setContextMouseOverAlpha(string guicontrol, bool mouseOver){ @@ -10279,6 +14660,7 @@ public void setContextMouseOverAlpha(string guicontrol, bool mouseOver){ } /// /// Displays the option to move the control in the game when true. ) +/// /// public void setContextMoveControl(string guicontrol, bool move){ @@ -10287,6 +14669,7 @@ public void setContextMoveControl(string guicontrol, bool move){ } /// /// Set control background color. ) +/// /// public void setControlBackgroundColor(string guicontrol, ColorI color){ @@ -10295,6 +14678,7 @@ public void setControlBackgroundColor(string guicontrol, ColorI color){ } /// /// Set control fill color. ) +/// /// public void setControlFillColor(string guicontrol, ColorI color){ @@ -10303,6 +14687,7 @@ public void setControlFillColor(string guicontrol, ColorI color){ } /// /// Set control font color. ) +/// /// public void setControlFontColor(string guicontrol, ColorI color){ @@ -10311,6 +14696,7 @@ public void setControlFontColor(string guicontrol, ColorI color){ } /// /// Sets the font size of a control. ) +/// /// public void setControlFontSize(string guicontrol, int fontSize){ @@ -10319,6 +14705,7 @@ public void setControlFontSize(string guicontrol, int fontSize){ } /// /// Lock the control. ) +/// /// public void setControlLock(string guicontrol, bool lockedx){ @@ -10327,6 +14714,7 @@ public void setControlLock(string guicontrol, bool lockedx){ } /// /// Set control texture. ) +/// /// public void setControlTexture(string guicontrol, string fileName){ @@ -10334,7 +14722,9 @@ public void setControlTexture(string guicontrol, string fileName){ m_ts.fnGuiControl_setControlTexture(guicontrol, fileName); } /// -/// Sets the cursor as a plus. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Sets the cursor as a plus. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void setCur(string guicontrol){ @@ -10342,7 +14732,12 @@ public void setCur(string guicontrol){ m_ts.fnGuiControl_setCur(guicontrol); } /// -/// Make this control the current first responder. @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. @see GuiControlProfile::canKeyFocus @see isFirstResponder @ref GuiControl_FirstResponders ) +/// Make this control the current first responder. +/// @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. +/// @see GuiControlProfile::canKeyFocus +/// @see isFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public void setFirstResponder(string guicontrol){ @@ -10350,7 +14745,9 @@ public void setFirstResponder(string guicontrol){ m_ts.fnGuiControl_setFirstResponder(guicontrol); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void setMouseOverAlphaValue(string guicontrol, float alpha = 1){ @@ -10358,7 +14755,10 @@ public void setMouseOverAlphaValue(string guicontrol, float alpha = 1){ m_ts.fnGuiControl_setMouseOverAlphaValue(guicontrol, alpha); } /// -/// Position the control in the local space of the parent control. @param x The new X coordinate of the control relative to its parent's upper left corner. @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// Position the control in the local space of the parent control. +/// @param x The new X coordinate of the control relative to its parent's upper left corner. +/// @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// /// public void setPosition(string guicontrol, int x, int y){ @@ -10366,7 +14766,10 @@ public void setPosition(string guicontrol, int x, int y){ m_ts.fnGuiControl_setPosition(guicontrol, x, y); } /// -/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. @param x The new X coordinate of the control relative to the root's upper left corner. @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @param x The new X coordinate of the control relative to the root's upper left corner. +/// @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// /// public void setPositionGlobal(string guicontrol, int x, int y){ @@ -10374,7 +14777,11 @@ public void setPositionGlobal(string guicontrol, int x, int y){ m_ts.fnGuiControl_setPositionGlobal(guicontrol, x, y); } /// -/// Set the control profile for the control to use. The profile used by a control determines a great part of its behavior and appearance. @param profile The new profile the control should use. @ref GuiControl_Profiles ) +/// Set the control profile for the control to use. +/// The profile used by a control determines a great part of its behavior and appearance. +/// @param profile The new profile the control should use. +/// @ref GuiControl_Profiles ) +/// /// public void setProfile(string guicontrol, string profile){ @@ -10383,6 +14790,7 @@ public void setProfile(string guicontrol, string profile){ } /// /// Displays the option to set the window settings of the control in the game when true. ) +/// /// public void setShowContextWindowSettings(string guicontrol, bool lockx){ @@ -10390,7 +14798,9 @@ public void setShowContextWindowSettings(string guicontrol, bool lockx){ m_ts.fnGuiControl_setShowContextWindowSettings(guicontrol, lockx); } /// -/// Set the value associated with the control. @param value The new value for the control. ) +/// Set the value associated with the control. +/// @param value The new value for the control. ) +/// /// public void setValue(string guicontrol, string value){ @@ -10398,7 +14808,10 @@ public void setValue(string guicontrol, string value){ m_ts.fnGuiControl_setValue(guicontrol, value); } /// -/// Set whether the control is visible or not. @param state The new visiblity flag state for the control. @ref GuiControl_VisibleActive ) +/// Set whether the control is visible or not. +/// @param state The new visiblity flag state for the control. +/// @ref GuiControl_VisibleActive ) +/// /// public void setVisible(string guicontrol, bool state = true){ @@ -10407,6 +14820,7 @@ public void setVisible(string guicontrol, bool state = true){ } /// /// Returns true if the control is transparent. ) +/// /// public bool transparentControlCheck(string guicontrol){ @@ -10419,14 +14833,9 @@ public bool transparentControlCheck(string guicontrol){ /// public class GuiControlProfileObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiControlProfileObject(ref Omni ts){m_ts = ts;} /// /// ( pString ) ) +/// /// public int GuiControlProfile_getStringWidth(string guicontrolprofile, string pString){ @@ -10439,14 +14848,9 @@ public int GuiControlProfile_getStringWidth(string guicontrolprofile, string pS /// public class GuiConvexEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiConvexEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void GuiConvexEditorCtrl_dropSelectionAtScreenCenter(string guiconvexeditorctrl){ @@ -10455,6 +14859,7 @@ public void GuiConvexEditorCtrl_dropSelectionAtScreenCenter(string guiconvexedi } /// /// ) +/// /// public void GuiConvexEditorCtrl_handleDelete(string guiconvexeditorctrl){ @@ -10463,6 +14868,7 @@ public void GuiConvexEditorCtrl_handleDelete(string guiconvexeditorctrl){ } /// /// ) +/// /// public void GuiConvexEditorCtrl_handleDeselect(string guiconvexeditorctrl){ @@ -10471,6 +14877,7 @@ public void GuiConvexEditorCtrl_handleDeselect(string guiconvexeditorctrl){ } /// /// ) +/// /// public int GuiConvexEditorCtrl_hasSelection(string guiconvexeditorctrl){ @@ -10479,6 +14886,7 @@ public int GuiConvexEditorCtrl_hasSelection(string guiconvexeditorctrl){ } /// /// ) +/// /// public void GuiConvexEditorCtrl_hollowSelection(string guiconvexeditorctrl){ @@ -10487,6 +14895,7 @@ public void GuiConvexEditorCtrl_hollowSelection(string guiconvexeditorctrl){ } /// /// ) +/// /// public void GuiConvexEditorCtrl_recenterSelection(string guiconvexeditorctrl){ @@ -10495,6 +14904,7 @@ public void GuiConvexEditorCtrl_recenterSelection(string guiconvexeditorctrl){ } /// /// ( ConvexShape ) ) +/// /// public void GuiConvexEditorCtrl_selectConvex(string guiconvexeditorctrl, string convex){ @@ -10503,6 +14913,7 @@ public void GuiConvexEditorCtrl_selectConvex(string guiconvexeditorctrl, string } /// /// ) +/// /// public void GuiConvexEditorCtrl_splitSelectedFace(string guiconvexeditorctrl){ @@ -10515,14 +14926,9 @@ public void GuiConvexEditorCtrl_splitSelectedFace(string guiconvexeditorctrl){ /// public class GuiDecalEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiDecalEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// deleteSelectedDecalDatablock( String datablock ) ) +/// /// public void GuiDecalEditorCtrl_deleteDecalDatablock(string guidecaleditorctrl, string datablock){ @@ -10531,6 +14937,7 @@ public void GuiDecalEditorCtrl_deleteDecalDatablock(string guidecaleditorctrl, } /// /// deleteSelectedDecal() ) +/// /// public void GuiDecalEditorCtrl_deleteSelectedDecal(string guidecaleditorctrl){ @@ -10539,6 +14946,7 @@ public void GuiDecalEditorCtrl_deleteSelectedDecal(string guidecaleditorctrl){ } /// /// editDecalDetails( S32 )() ) +/// /// public void GuiDecalEditorCtrl_editDecalDetails(string guidecaleditorctrl, uint id, Point3F pos, Point3F tan, float size){ @@ -10547,6 +14955,7 @@ public void GuiDecalEditorCtrl_editDecalDetails(string guidecaleditorctrl, uint } /// /// getDecalCount() ) +/// /// public int GuiDecalEditorCtrl_getDecalCount(string guidecaleditorctrl){ @@ -10555,6 +14964,7 @@ public int GuiDecalEditorCtrl_getDecalCount(string guidecaleditorctrl){ } /// /// getDecalLookupName( S32 )() ) +/// /// public string GuiDecalEditorCtrl_getDecalLookupName(string guidecaleditorctrl, uint id){ @@ -10563,6 +14973,7 @@ public string GuiDecalEditorCtrl_getDecalLookupName(string guidecaleditorctrl, } /// /// getDecalTransform() ) +/// /// public string GuiDecalEditorCtrl_getDecalTransform(string guidecaleditorctrl, uint id){ @@ -10571,6 +14982,7 @@ public string GuiDecalEditorCtrl_getDecalTransform(string guidecaleditorctrl, u } /// /// getMode() ) +/// /// public string GuiDecalEditorCtrl_getMode(string guidecaleditorctrl){ @@ -10579,6 +14991,7 @@ public string GuiDecalEditorCtrl_getMode(string guidecaleditorctrl){ } /// /// ) +/// /// public int GuiDecalEditorCtrl_getSelectionCount(string guidecaleditorctrl){ @@ -10587,6 +15000,7 @@ public int GuiDecalEditorCtrl_getSelectionCount(string guidecaleditorctrl){ } /// /// ) +/// /// public void GuiDecalEditorCtrl_retargetDecalDatablock(string guidecaleditorctrl, string dbFrom, string dbTo){ @@ -10595,6 +15009,7 @@ public void GuiDecalEditorCtrl_retargetDecalDatablock(string guidecaleditorctrl } /// /// selectDecal( S32 )() ) +/// /// public void GuiDecalEditorCtrl_selectDecal(string guidecaleditorctrl, uint id){ @@ -10603,6 +15018,7 @@ public void GuiDecalEditorCtrl_selectDecal(string guidecaleditorctrl, uint id){ } /// /// setMode( String mode )() ) +/// /// public void GuiDecalEditorCtrl_setMode(string guidecaleditorctrl, string newMode){ @@ -10615,14 +15031,10 @@ public void GuiDecalEditorCtrl_setMode(string guidecaleditorctrl, string newMod /// public class GuiDirectoryFileListCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiDirectoryFileListCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the currently selected filename. @return The filename of the currently selected file ) +/// Get the currently selected filename. +/// @return The filename of the currently selected file ) +/// /// public string getSelectedFile(string guidirectoryfilelistctrl){ @@ -10630,7 +15042,9 @@ public string getSelectedFile(string guidirectoryfilelistctrl){ return m_ts.fnGuiDirectoryFileListCtrl_getSelectedFile(guidirectoryfilelistctrl); } /// -/// Get the list of selected files. @return A space separated list of selected files ) +/// Get the list of selected files. +/// @return A space separated list of selected files ) +/// /// public string getSelectedFiles(string guidirectoryfilelistctrl){ @@ -10639,6 +15053,7 @@ public string getSelectedFiles(string guidirectoryfilelistctrl){ } /// /// Update the file list. ) +/// /// public void reload(string guidirectoryfilelistctrl){ @@ -10646,7 +15061,9 @@ public void reload(string guidirectoryfilelistctrl){ m_ts.fnGuiDirectoryFileListCtrl_reload(guidirectoryfilelistctrl); } /// -/// Set the file filter. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the file filter. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public void setFilter(string guidirectoryfilelistctrl, string filter){ @@ -10654,7 +15071,10 @@ public void setFilter(string guidirectoryfilelistctrl, string filter){ m_ts.fnGuiDirectoryFileListCtrl_setFilter(guidirectoryfilelistctrl, filter); } /// -/// Set the search path and file filter. @param path Path in game directory from which to list files. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the search path and file filter. +/// @param path Path in game directory from which to list files. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public bool setPath(string guidirectoryfilelistctrl, string path, string filter){ @@ -10667,14 +15087,11 @@ public bool setPath(string guidirectoryfilelistctrl, string path, string filter /// public class GuiDragAndDropControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiDragAndDropControlObject(ref Omni ts){m_ts = ts;} /// -/// Start the drag operation. @param x X coordinate for the mouse pointer offset which the drag control should position itself. @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// Start the drag operation. +/// @param x X coordinate for the mouse pointer offset which the drag control should position itself. +/// @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// /// public void startDragging(string guidraganddropcontrol, int x = 0, int y = 0){ @@ -10687,14 +15104,9 @@ public void startDragging(string guidraganddropcontrol, int x = 0, int y = 0){ /// public class GuiDynamicCtrlArrayControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiDynamicCtrlArrayControlObject(ref Omni ts){m_ts = ts;} /// /// Recalculates the position and size of this control and all its children. ) +/// /// public void refresh(string guidynamicctrlarraycontrol){ @@ -10707,14 +15119,9 @@ public void refresh(string guidynamicctrlarraycontrol){ /// public class GuiEditCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiEditCtrlObject(ref Omni ts){m_ts = ts;} /// /// (GuiControl ctrl)) +/// /// public void GuiEditCtrl_addNewCtrl(string guieditctrl, string ctrl){ @@ -10723,6 +15130,7 @@ public void GuiEditCtrl_addNewCtrl(string guieditctrl, string ctrl){ } /// /// selects a control.) +/// /// public void GuiEditCtrl_addSelection(string guieditctrl, int id){ @@ -10731,6 +15139,7 @@ public void GuiEditCtrl_addSelection(string guieditctrl, int id){ } /// /// ) +/// /// public void GuiEditCtrl_bringToFront(string guieditctrl){ @@ -10739,6 +15148,7 @@ public void GuiEditCtrl_bringToFront(string guieditctrl){ } /// /// ( [ int axis ] ) - Clear all currently set guide lines. ) +/// /// public void GuiEditCtrl_clearGuides(string guieditctrl, int axis = -1){ @@ -10747,6 +15157,7 @@ public void GuiEditCtrl_clearGuides(string guieditctrl, int axis = -1){ } /// /// Clear selected controls list.) +/// /// public void GuiEditCtrl_clearSelection(string guieditctrl){ @@ -10755,6 +15166,7 @@ public void GuiEditCtrl_clearSelection(string guieditctrl){ } /// /// () - Delete the selected controls.) +/// /// public void GuiEditCtrl_deleteSelection(string guieditctrl){ @@ -10763,6 +15175,7 @@ public void GuiEditCtrl_deleteSelection(string guieditctrl){ } /// /// ( bool width=true, bool height=true ) - Fit selected controls into their parents. ) +/// /// public void GuiEditCtrl_fitIntoParents(string guieditctrl, bool width = true, bool height = true){ @@ -10771,6 +15184,7 @@ public void GuiEditCtrl_fitIntoParents(string guieditctrl, bool width = true, b } /// /// () - Return the toplevel control edited inside the GUI editor. ) +/// /// public int GuiEditCtrl_getContentControl(string guieditctrl){ @@ -10779,6 +15193,7 @@ public int GuiEditCtrl_getContentControl(string guieditctrl){ } /// /// Returns the set to which new controls will be added) +/// /// public int GuiEditCtrl_getCurrentAddSet(string guieditctrl){ @@ -10787,6 +15202,7 @@ public int GuiEditCtrl_getCurrentAddSet(string guieditctrl){ } /// /// () - Return the current mouse mode. ) +/// /// public string GuiEditCtrl_getMouseMode(string guieditctrl){ @@ -10795,6 +15211,7 @@ public string GuiEditCtrl_getMouseMode(string guieditctrl){ } /// /// () - Return the number of controls currently selected. ) +/// /// public int GuiEditCtrl_getNumSelected(string guieditctrl){ @@ -10803,6 +15220,7 @@ public int GuiEditCtrl_getNumSelected(string guieditctrl){ } /// /// () - Returns global bounds of current selection as vector 'x y width height'. ) +/// /// public string GuiEditCtrl_getSelectionGlobalBounds(string guieditctrl){ @@ -10811,6 +15229,7 @@ public string GuiEditCtrl_getSelectionGlobalBounds(string guieditctrl){ } /// /// (int mode) ) +/// /// public void GuiEditCtrl_justify(string guieditctrl, uint mode){ @@ -10819,6 +15238,7 @@ public void GuiEditCtrl_justify(string guieditctrl, uint mode){ } /// /// ( string fileName=null ) - Load selection from file or clipboard.) +/// /// public void GuiEditCtrl_loadSelection(string guieditctrl, string filename = null ){ if (filename== null) {filename = null;} @@ -10828,6 +15248,7 @@ public void GuiEditCtrl_loadSelection(string guieditctrl, string filename = nul } /// /// Move all controls in the selection by (dx,dy) pixels.) +/// /// public void GuiEditCtrl_moveSelection(string guieditctrl, Point2I pos){ @@ -10836,6 +15257,7 @@ public void GuiEditCtrl_moveSelection(string guieditctrl, Point2I pos){ } /// /// ) +/// /// public void GuiEditCtrl_pushToBack(string guieditctrl){ @@ -10844,6 +15266,7 @@ public void GuiEditCtrl_pushToBack(string guieditctrl){ } /// /// ( GuiControl ctrl [, int axis ] ) - Read the guides from the given control. ) +/// /// public void GuiEditCtrl_readGuides(string guieditctrl, string ctrl, int axis = -1){ @@ -10852,6 +15275,7 @@ public void GuiEditCtrl_readGuides(string guieditctrl, string ctrl, int axis = } /// /// deselects a control.) +/// /// public void GuiEditCtrl_removeSelection(string guieditctrl, int id){ @@ -10860,6 +15284,7 @@ public void GuiEditCtrl_removeSelection(string guieditctrl, int id){ } /// /// ( string fileName=null ) - Save selection to file or clipboard.) +/// /// public void GuiEditCtrl_saveSelection(string guieditctrl, string filename = null ){ if (filename== null) {filename = null;} @@ -10869,6 +15294,7 @@ public void GuiEditCtrl_saveSelection(string guieditctrl, string filename = nul } /// /// (GuiControl ctrl)) +/// /// public void GuiEditCtrl_select(string guieditctrl, string ctrl){ @@ -10877,6 +15303,7 @@ public void GuiEditCtrl_select(string guieditctrl, string ctrl){ } /// /// ()) +/// /// public void GuiEditCtrl_selectAll(string guieditctrl){ @@ -10885,6 +15312,7 @@ public void GuiEditCtrl_selectAll(string guieditctrl){ } /// /// ( bool addToSelection=false ) - Select children of currently selected controls. ) +/// /// public void GuiEditCtrl_selectChildren(string guieditctrl, bool addToSelection = false){ @@ -10893,6 +15321,7 @@ public void GuiEditCtrl_selectChildren(string guieditctrl, bool addToSelection } /// /// ( bool addToSelection=false ) - Select parents of currently selected controls. ) +/// /// public void GuiEditCtrl_selectParents(string guieditctrl, bool addToSelection = false){ @@ -10901,6 +15330,7 @@ public void GuiEditCtrl_selectParents(string guieditctrl, bool addToSelection = } /// /// ( GuiControl ctrl ) - Set the toplevel control to edit in the GUI editor. ) +/// /// public void GuiEditCtrl_setContentControl(string guieditctrl, string ctrl){ @@ -10909,6 +15339,7 @@ public void GuiEditCtrl_setContentControl(string guieditctrl, string ctrl){ } /// /// (GuiControl ctrl)) +/// /// public void GuiEditCtrl_setCurrentAddSet(string guieditctrl, string addSet){ @@ -10917,6 +15348,7 @@ public void GuiEditCtrl_setCurrentAddSet(string guieditctrl, string addSet){ } /// /// GuiEditCtrl.setSnapToGrid(gridsize)) +/// /// public void GuiEditCtrl_setSnapToGrid(string guieditctrl, uint gridsize){ @@ -10925,6 +15357,7 @@ public void GuiEditCtrl_setSnapToGrid(string guieditctrl, uint gridsize){ } /// /// Toggle activation.) +/// /// public void GuiEditCtrl_toggle(string guieditctrl){ @@ -10933,6 +15366,7 @@ public void GuiEditCtrl_toggle(string guieditctrl){ } /// /// ( GuiControl ctrl [, int axis ] ) - Write the guides to the given control. ) +/// /// public void GuiEditCtrl_writeGuides(string guieditctrl, string ctrl, int axis = -1){ @@ -10941,6 +15375,7 @@ public void GuiEditCtrl_writeGuides(string guieditctrl, string ctrl, int axis = } /// /// Gets the set of GUI controls currently selected in the editor. ) +/// /// public string getSelection(string guieditctrl){ @@ -10949,6 +15384,7 @@ public string getSelection(string guieditctrl){ } /// /// Gets the GUI controls(s) that are currently in the trash.) +/// /// public string getTrash(string guieditctrl){ @@ -10961,14 +15397,9 @@ public string getTrash(string guieditctrl){ /// public class GuiFileTreeCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiFileTreeCtrlObject(ref Omni ts){m_ts = ts;} /// /// getSelectedPath() - returns the currently selected path in the tree) +/// /// public string GuiFileTreeCtrl_getSelectedPath(string guifiletreectrl){ @@ -10977,6 +15408,7 @@ public string GuiFileTreeCtrl_getSelectedPath(string guifiletreectrl){ } /// /// () - Reread the directory tree hierarchy. ) +/// /// public void GuiFileTreeCtrl_reload(string guifiletreectrl){ @@ -10985,6 +15417,7 @@ public void GuiFileTreeCtrl_reload(string guifiletreectrl){ } /// /// setSelectedPath(path) - expands the tree to the specified path) +/// /// public bool GuiFileTreeCtrl_setSelectedPath(string guifiletreectrl, string path){ @@ -10997,14 +15430,10 @@ public bool GuiFileTreeCtrl_setSelectedPath(string guifiletreectrl, string path /// public class GuiFilterCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiFilterCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Return a tuple containing all the values in the filter. @internal) +/// Return a tuple containing all the values in the filter. +/// @internal) +/// /// public string GuiFilterCtrl_getValue(string guifilterctrl){ @@ -11012,7 +15441,9 @@ public string GuiFilterCtrl_getValue(string guifilterctrl){ return m_ts.fn_GuiFilterCtrl_getValue(guifilterctrl); } /// -/// Reset the filtering. @internal) +/// Reset the filtering. +/// @internal) +/// /// public void GuiFilterCtrl_identity(string guifilterctrl){ @@ -11020,7 +15451,10 @@ public void GuiFilterCtrl_identity(string guifilterctrl){ m_ts.fn_GuiFilterCtrl_identity(guifilterctrl); } /// -/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) Reset the filter to use the specified points, spread equidistantly across the domain. @internal) +/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) +/// Reset the filter to use the specified points, spread equidistantly across the domain. +/// @internal) +/// /// public void setValue(string guifilterctrl, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -11033,14 +15467,10 @@ public void setValue(string guifilterctrl, string a2= "", string a3= "", string /// public class GuiFormCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiFormCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the ID of this form's menu. @return The ID of the form menu ) +/// Get the ID of this form's menu. +/// @return The ID of the form menu ) +/// /// public int getMenuID(string guiformctrl){ @@ -11048,7 +15478,9 @@ public int getMenuID(string guiformctrl){ return m_ts.fnGuiFormCtrl_getMenuID(guiformctrl); } /// -/// Sets the title of the form. @param caption Form caption ) +/// Sets the title of the form. +/// @param caption Form caption ) +/// /// public void setCaption(string guiformctrl, string caption){ @@ -11061,14 +15493,9 @@ public void setCaption(string guiformctrl, string caption){ /// public class GuiFrameSetCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiFrameSetCtrlObject(ref Omni ts){m_ts = ts;} /// /// Add a new column. ) +/// /// public void addColumn(string guiframesetctrl){ @@ -11077,6 +15504,7 @@ public void addColumn(string guiframesetctrl){ } /// /// Add a new row. ) +/// /// public void addRow(string guiframesetctrl){ @@ -11084,7 +15512,11 @@ public void addRow(string guiframesetctrl){ m_ts.fnGuiFrameSetCtrl_addRow(guiframesetctrl); } /// -/// dynamic ), Override the i>borderEnable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderEnable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void frameBorder(string guiframesetctrl, int index, string state = "dynamic"){ @@ -11092,7 +15524,12 @@ public void frameBorder(string guiframesetctrl, int index, string state = "dyna m_ts.fnGuiFrameSetCtrl_frameBorder(guiframesetctrl, index, state); } /// -/// Set the minimum width and height for the frame. It will not be possible for the user to resize the frame smaller than this. @param index Index of the frame to modify @param width Minimum width in pixels @param height Minimum height in pixels ) +/// Set the minimum width and height for the frame. It will not be possible +/// for the user to resize the frame smaller than this. +/// @param index Index of the frame to modify +/// @param width Minimum width in pixels +/// @param height Minimum height in pixels ) +/// /// public void frameMinExtent(string guiframesetctrl, int index, int width, int height){ @@ -11100,7 +15537,11 @@ public void frameMinExtent(string guiframesetctrl, int index, int width, int he m_ts.fnGuiFrameSetCtrl_frameMinExtent(guiframesetctrl, index, width, height); } /// -/// dynamic ), Override the i>borderMovable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderMovable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void frameMovable(string guiframesetctrl, int index, string state = "dynamic"){ @@ -11108,7 +15549,11 @@ public void frameMovable(string guiframesetctrl, int index, string state = "dyn m_ts.fnGuiFrameSetCtrl_frameMovable(guiframesetctrl, index, state); } /// -/// Set the padding for this frame. Padding introduces blank space on the inside edge of the frame. @param index Index of the frame to modify @param padding Frame top, bottom, left, and right padding ) +/// Set the padding for this frame. Padding introduces blank space on the inside +/// edge of the frame. +/// @param index Index of the frame to modify +/// @param padding Frame top, bottom, left, and right padding ) +/// /// public void framePadding(string guiframesetctrl, int index, RectSpacingI padding){ @@ -11116,7 +15561,9 @@ public void framePadding(string guiframesetctrl, int index, RectSpacingI paddin m_ts.fnGuiFrameSetCtrl_framePadding(guiframesetctrl, index, padding.AsString()); } /// -/// Get the number of columns. @return The number of columns ) +/// Get the number of columns. +/// @return The number of columns ) +/// /// public int getColumnCount(string guiframesetctrl){ @@ -11124,7 +15571,10 @@ public int getColumnCount(string guiframesetctrl){ return m_ts.fnGuiFrameSetCtrl_getColumnCount(guiframesetctrl); } /// -/// Get the horizontal offset of a column. @param index Index of the column to query @return Column offset in pixels ) +/// Get the horizontal offset of a column. +/// @param index Index of the column to query +/// @return Column offset in pixels ) +/// /// public int getColumnOffset(string guiframesetctrl, int index){ @@ -11132,7 +15582,9 @@ public int getColumnOffset(string guiframesetctrl, int index){ return m_ts.fnGuiFrameSetCtrl_getColumnOffset(guiframesetctrl, index); } /// -/// Get the padding for this frame. @param index Index of the frame to query ) +/// Get the padding for this frame. +/// @param index Index of the frame to query ) +/// /// public RectSpacingI getFramePadding(string guiframesetctrl, int index){ @@ -11140,7 +15592,9 @@ public RectSpacingI getFramePadding(string guiframesetctrl, int index){ return new RectSpacingI ( m_ts.fnGuiFrameSetCtrl_getFramePadding(guiframesetctrl, index)); } /// -/// Get the number of rows. @return The number of rows ) +/// Get the number of rows. +/// @return The number of rows ) +/// /// public int getRowCount(string guiframesetctrl){ @@ -11148,7 +15602,10 @@ public int getRowCount(string guiframesetctrl){ return m_ts.fnGuiFrameSetCtrl_getRowCount(guiframesetctrl); } /// -/// Get the vertical offset of a row. @param index Index of the row to query @return Row offset in pixels ) +/// Get the vertical offset of a row. +/// @param index Index of the row to query +/// @return Row offset in pixels ) +/// /// public int getRowOffset(string guiframesetctrl, int index){ @@ -11157,6 +15614,7 @@ public int getRowOffset(string guiframesetctrl, int index){ } /// /// Remove the last (rightmost) column. ) +/// /// public void removeColumn(string guiframesetctrl){ @@ -11165,6 +15623,7 @@ public void removeColumn(string guiframesetctrl){ } /// /// Remove the last (bottom) row. ) +/// /// public void removeRow(string guiframesetctrl){ @@ -11172,7 +15631,12 @@ public void removeRow(string guiframesetctrl){ m_ts.fnGuiFrameSetCtrl_removeRow(guiframesetctrl); } /// -/// Set the horizontal offset of a column. Note that column offsets must always be in increasing order, and therefore this offset must be between the offsets of the colunns either side. @param index Index of the column to modify @param offset New column offset ) +/// Set the horizontal offset of a column. +/// Note that column offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the colunns either side. +/// @param index Index of the column to modify +/// @param offset New column offset ) +/// /// public void setColumnOffset(string guiframesetctrl, int index, int offset){ @@ -11180,7 +15644,12 @@ public void setColumnOffset(string guiframesetctrl, int index, int offset){ m_ts.fnGuiFrameSetCtrl_setColumnOffset(guiframesetctrl, index, offset); } /// -/// Set the vertical offset of a row. Note that row offsets must always be in increasing order, and therefore this offset must be between the offsets of the rows either side. @param index Index of the row to modify @param offset New row offset ) +/// Set the vertical offset of a row. +/// Note that row offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the rows either side. +/// @param index Index of the row to modify +/// @param offset New row offset ) +/// /// public void setRowOffset(string guiframesetctrl, int index, int offset){ @@ -11189,6 +15658,7 @@ public void setRowOffset(string guiframesetctrl, int index, int offset){ } /// /// Recalculates child control sizes. ) +/// /// public void updateSizes(string guiframesetctrl){ @@ -11201,14 +15671,9 @@ public void updateSizes(string guiframesetctrl){ /// public class GuiGameListMenuCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiGameListMenuCtrlObject(ref Omni ts){m_ts = ts;} /// /// Activates the current row. The script callback of the current row will be called (if it has one). ) +/// /// public void activateRow(string guigamelistmenuctrl){ @@ -11216,7 +15681,14 @@ public void activateRow(string guigamelistmenuctrl){ m_ts.fnGuiGameListMenuCtrl_activateRow(guigamelistmenuctrl); } /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param useHighlightIcon [optional] Does this row use the highlight icon?. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param useHighlightIcon [optional] Does this row use the highlight icon?. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void addRow(string guigamelistmenuctrl, string label, string callback, int icon = -1, int yPad = 0, bool useHighlightIcon = true, bool enabled = true){ @@ -11224,7 +15696,9 @@ public void addRow(string guigamelistmenuctrl, string label, string callback, i m_ts.fnGuiGameListMenuCtrl_addRow(guigamelistmenuctrl, label, callback, icon, yPad, useHighlightIcon, enabled); } /// -/// Gets the number of rows on the control. @return (int) The number of rows on the control. ) +/// Gets the number of rows on the control. +/// @return (int) The number of rows on the control. ) +/// /// public int getRowCount(string guigamelistmenuctrl){ @@ -11232,7 +15706,10 @@ public int getRowCount(string guigamelistmenuctrl){ return m_ts.fnGuiGameListMenuCtrl_getRowCount(guigamelistmenuctrl); } /// -/// Gets the label displayed on the specified row. @param row Index of the row to get the label of. @return The label for the row. ) +/// Gets the label displayed on the specified row. +/// @param row Index of the row to get the label of. +/// @return The label for the row. ) +/// /// public string getRowLabel(string guigamelistmenuctrl, int row){ @@ -11240,7 +15717,9 @@ public string getRowLabel(string guigamelistmenuctrl, int row){ return m_ts.fnGuiGameListMenuCtrl_getRowLabel(guigamelistmenuctrl, row); } /// -/// Gets the index of the currently selected row. @return Index of the selected row. ) +/// Gets the index of the currently selected row. +/// @return Index of the selected row. ) +/// /// public int getSelectedRow(string guigamelistmenuctrl){ @@ -11248,7 +15727,10 @@ public int getSelectedRow(string guigamelistmenuctrl){ return m_ts.fnGuiGameListMenuCtrl_getSelectedRow(guigamelistmenuctrl); } /// -/// Determines if the specified row is enabled or disabled. @param row The row to set the enabled status of. @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// Determines if the specified row is enabled or disabled. +/// @param row The row to set the enabled status of. +/// @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// /// public bool isRowEnabled(string guigamelistmenuctrl, int row){ @@ -11256,7 +15738,10 @@ public bool isRowEnabled(string guigamelistmenuctrl, int row){ return m_ts.fnGuiGameListMenuCtrl_isRowEnabled(guigamelistmenuctrl, row); } /// -/// Sets a row's enabled status according to the given parameters. @param row The index to check for validity. @param enabled Indicate true to enable the row or false to disable it. ) +/// Sets a row's enabled status according to the given parameters. +/// @param row The index to check for validity. +/// @param enabled Indicate true to enable the row or false to disable it. ) +/// /// public void setRowEnabled(string guigamelistmenuctrl, int row, bool enabled){ @@ -11264,7 +15749,10 @@ public void setRowEnabled(string guigamelistmenuctrl, int row, bool enabled){ m_ts.fnGuiGameListMenuCtrl_setRowEnabled(guigamelistmenuctrl, row, enabled); } /// -/// Sets the label on the given row. @param row Index of the row to set the label on. @param label Text to set as the label of the row. ) +/// Sets the label on the given row. +/// @param row Index of the row to set the label on. +/// @param label Text to set as the label of the row. ) +/// /// public void setRowLabel(string guigamelistmenuctrl, int row, string label){ @@ -11272,7 +15760,9 @@ public void setRowLabel(string guigamelistmenuctrl, int row, string label){ m_ts.fnGuiGameListMenuCtrl_setRowLabel(guigamelistmenuctrl, row, label); } /// -/// Sets the selected row. Only rows that are enabled can be selected. @param row Index of the row to set as selected. ) +/// Sets the selected row. Only rows that are enabled can be selected. +/// @param row Index of the row to set as selected. ) +/// /// public void setSelected(string guigamelistmenuctrl, int row){ @@ -11285,14 +15775,16 @@ public void setSelected(string guigamelistmenuctrl, int row){ /// public class GuiGameListOptionsCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiGameListOptionsCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param options A tab separated list of options. @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param options A tab separated list of options. +/// @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void addRow(string guigamelistoptionsctrl, string label, string options, bool wrapOptions, string callback, int icon = -1, int yPad = 0, bool enabled = true){ @@ -11300,7 +15792,10 @@ public void addRow(string guigamelistoptionsctrl, string label, string options, m_ts.fnGuiGameListOptionsCtrl_addRow(guigamelistoptionsctrl, label, options, wrapOptions, callback, icon, yPad, enabled); } /// -/// Gets the text for the currently selected option of the given row. @param row Index of the row to get the option from. @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// Gets the text for the currently selected option of the given row. +/// @param row Index of the row to get the option from. +/// @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// /// public string getCurrentOption(string guigamelistoptionsctrl, int row){ @@ -11308,7 +15803,11 @@ public string getCurrentOption(string guigamelistoptionsctrl, int row){ return m_ts.fnGuiGameListOptionsCtrl_getCurrentOption(guigamelistoptionsctrl, row); } /// -/// Set the row's current option to the one specified @param row Index of the row to set an option on. @param option The option to be made active. @return True if the row contained the option and was set, false otherwise. ) +/// Set the row's current option to the one specified +/// @param row Index of the row to set an option on. +/// @param option The option to be made active. +/// @return True if the row contained the option and was set, false otherwise. ) +/// /// public bool selectOption(string guigamelistoptionsctrl, int row, string option){ @@ -11316,7 +15815,10 @@ public bool selectOption(string guigamelistoptionsctrl, int row, string option) return m_ts.fnGuiGameListOptionsCtrl_selectOption(guigamelistoptionsctrl, row, option); } /// -/// Sets the list of options on the given row. @param row Index of the row to set options on. @param optionsList A tab separated list of options for the control. ) +/// Sets the list of options on the given row. +/// @param row Index of the row to set options on. +/// @param optionsList A tab separated list of options for the control. ) +/// /// public void setOptions(string guigamelistoptionsctrl, int row, string optionsList){ @@ -11329,14 +15831,9 @@ public void setOptions(string guigamelistoptionsctrl, int row, string optionsLi /// public class GuiGradientCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiGradientCtrlObject(ref Omni ts){m_ts = ts;} /// /// Get color value) +/// /// public ColorF GuiGradientCtrl_getColor(string guigradientctrl, int idx){ @@ -11345,6 +15842,7 @@ public ColorF GuiGradientCtrl_getColor(string guigradientctrl, int idx){ } /// /// Get color count) +/// /// public int GuiGradientCtrl_getColorCount(string guigradientctrl){ @@ -11357,14 +15855,17 @@ public int GuiGradientCtrl_getColorCount(string guigradientctrl){ /// public class GuiGraphCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiGraphCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Sets up the given plotting curve to automatically plot the value of the @a variable with a frequency of @a updateFrequency. @param plotId Index of the plotting curve. Must be 0=plotId6. @param variable Name of the global variable. @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). @tsexample // Plot FPS counter at 1 second intervals. %graph.addAutoPlot( 0, \"fps::real\", 1000 ); @endtsexample ) +/// Sets up the given plotting curve to automatically plot the value of the @a variable with a +/// frequency of @a updateFrequency. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param variable Name of the global variable. +/// @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). +/// @tsexample +/// // Plot FPS counter at 1 second intervals. +/// %graph.addAutoPlot( 0, \"fps::real\", 1000 ); +/// @endtsexample ) +/// /// public void addAutoPlot(string guigraphctrl, int plotId, string variable, int updateFrequency){ @@ -11372,7 +15873,13 @@ public void addAutoPlot(string guigraphctrl, int plotId, string variable, int u m_ts.fnGuiGraphCtrl_addAutoPlot(guigraphctrl, plotId, variable, updateFrequency); } /// -/// Add a data point to the plot's curve. @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. @param value Value of the data point to add to the curve. @note Data values are added to the @b left end of the plotting curve. @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If this limit is exceeded, data points on the right end of the curve are culled. ) +/// Add a data point to the plot's curve. +/// @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. +/// @param value Value of the data point to add to the curve. +/// @note Data values are added to the @b left end of the plotting curve. +/// @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If +/// this limit is exceeded, data points on the right end of the curve are culled. ) +/// /// public void addDatum(string guigraphctrl, int plotId, float value){ @@ -11380,7 +15887,11 @@ public void addDatum(string guigraphctrl, int plotId, float value){ m_ts.fnGuiGraphCtrl_addDatum(guigraphctrl, plotId, value); } /// -/// Get a data point on the given plotting curve. @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. @param index Index of the data point on the curve. @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// Get a data point on the given plotting curve. +/// @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. +/// @param index Index of the data point on the curve. +/// @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// /// public float getDatum(string guigraphctrl, int plotId, int index){ @@ -11388,7 +15899,9 @@ public float getDatum(string guigraphctrl, int plotId, int index){ return m_ts.fnGuiGraphCtrl_getDatum(guigraphctrl, plotId, index); } /// -/// Stop automatic variable plotting for the given curve. @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// Stop automatic variable plotting for the given curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// /// public void removeAutoPlot(string guigraphctrl, int plotId){ @@ -11396,7 +15909,11 @@ public void removeAutoPlot(string guigraphctrl, int plotId){ m_ts.fnGuiGraphCtrl_removeAutoPlot(guigraphctrl, plotId); } /// -/// Change the charting type of the given plotting curve. @param plotId Index of the plotting curve. Must be 0=plotId6. @param graphType Charting type to use for the curve. @note Instead of calling this method, you can directly assign to #plotType. ) +/// Change the charting type of the given plotting curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param graphType Charting type to use for the curve. +/// @note Instead of calling this method, you can directly assign to #plotType. ) +/// /// public void setGraphType(string guigraphctrl, int plotId, TypeGuiGraphType graphType){ @@ -11409,14 +15926,18 @@ public void setGraphType(string guigraphctrl, int plotId, TypeGuiGraphType grap /// public class GuiIconButtonCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiIconButtonCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Set the bitmap to use for the button portion of this control. @param buttonFilename Filename for the image @tsexample // Define the button filename %buttonFilename = \"pearlButton\"; // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); @endtsexample @see GuiControl @see GuiButtonCtrl) +/// @brief Set the bitmap to use for the button portion of this control. +/// @param buttonFilename Filename for the image +/// @tsexample +/// // Define the button filename +/// %buttonFilename = \"pearlButton\"; +/// // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap +/// %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); +/// @endtsexample +/// @see GuiControl +/// @see GuiButtonCtrl) +/// /// public void setBitmap(string guiiconbuttonctrl, string buttonFilename){ @@ -11429,14 +15950,10 @@ public void setBitmap(string guiiconbuttonctrl, string buttonFilename){ /// public class GuiIdleCamFadeBitmapCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiIdleCamFadeBitmapCtrlObject(ref Omni ts){m_ts = ts;} /// -/// () @internal) +/// () +/// @internal) +/// /// public void GuiIdleCamFadeBitmapCtrl_fadeIn(string guiidlecamfadebitmapctrl){ @@ -11444,7 +15961,9 @@ public void GuiIdleCamFadeBitmapCtrl_fadeIn(string guiidlecamfadebitmapctrl){ m_ts.fn_GuiIdleCamFadeBitmapCtrl_fadeIn(guiidlecamfadebitmapctrl); } /// -/// () @internal) +/// () +/// @internal) +/// /// public void GuiIdleCamFadeBitmapCtrl_fadeOut(string guiidlecamfadebitmapctrl){ @@ -11457,14 +15976,15 @@ public void GuiIdleCamFadeBitmapCtrl_fadeOut(string guiidlecamfadebitmapctrl){ /// public class GuiImageListObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiImageListObject(ref Omni ts){m_ts = ts;} /// -/// @brief Clears the imagelist @tsexample // Inform the GuiImageList control to clear itself. %isFinished = %thisGuiImageList.clear(); @endtsexample @return Returns true when finished. @see SimObject) +/// @brief Clears the imagelist +/// @tsexample +/// // Inform the GuiImageList control to clear itself. +/// %isFinished = %thisGuiImageList.clear(); +/// @endtsexample +/// @return Returns true when finished. +/// @see SimObject) +/// /// public bool clear(string guiimagelist){ @@ -11472,7 +15992,14 @@ public bool clear(string guiimagelist){ return m_ts.fnGuiImageList_clear(guiimagelist); } /// -/// @brief Gets the number of images in the list. @tsexample // Request the number of images from the GuiImageList control. %imageCount = %thisGuiImageList.count(); @endtsexample @return Number of images in the control. @see SimObject) +/// @brief Gets the number of images in the list. +/// @tsexample +/// // Request the number of images from the GuiImageList control. +/// %imageCount = %thisGuiImageList.count(); +/// @endtsexample +/// @return Number of images in the control. +/// @see SimObject) +/// /// public int count(string guiimagelist){ @@ -11480,7 +16007,17 @@ public int count(string guiimagelist){ return m_ts.fnGuiImageList_count(guiimagelist); } /// -/// @brief Get a path to the texture at the specified index. @param index Index of the image in the list. @tsexample // Define the image index/n %index = \"5\"; // Request the image path location from the control. %imagePath = %thisGuiImageList.getImage(%index); @endtsexample @return File path to the image map for the specified index. @see SimObject) +/// @brief Get a path to the texture at the specified index. +/// @param index Index of the image in the list. +/// @tsexample +/// // Define the image index/n +/// %index = \"5\"; +/// // Request the image path location from the control. +/// %imagePath = %thisGuiImageList.getImage(%index); +/// @endtsexample +/// @return File path to the image map for the specified index. +/// @see SimObject) +/// /// public string getImage(string guiimagelist, int index){ @@ -11488,7 +16025,17 @@ public string getImage(string guiimagelist, int index){ return m_ts.fnGuiImageList_getImage(guiimagelist, index); } /// -/// @brief Retrieves the imageindex of a specified texture in the list. @param imagePath Imagemap including filepath of image to search for @tsexample // Define the imagemap to search for %imagePath = \"./game/client/data/images/thisImage\"; // Request the index entry for the defined imagemap %imageIndex = %thisGuiImageList.getIndex(%imagePath); @endtsexample @return Index of the imagemap matching the defined image path. @see SimObject) +/// @brief Retrieves the imageindex of a specified texture in the list. +/// @param imagePath Imagemap including filepath of image to search for +/// @tsexample +/// // Define the imagemap to search for +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the index entry for the defined imagemap +/// %imageIndex = %thisGuiImageList.getIndex(%imagePath); +/// @endtsexample +/// @return Index of the imagemap matching the defined image path. +/// @see SimObject) +/// /// public int getIndex(string guiimagelist, string imagePath){ @@ -11496,7 +16043,17 @@ public int getIndex(string guiimagelist, string imagePath){ return m_ts.fnGuiImageList_getIndex(guiimagelist, imagePath); } /// -/// @brief Insert an image into imagelist- returns the image index or -1 for failure. @param imagePath Imagemap, with path, to add to the list. @tsexample // Define the imagemap to add to the list %imagePath = \"./game/client/data/images/thisImage\"; // Request the GuiImageList control to add the defined image to its list. %imageIndex = %thisGuiImageList.insert(%imagePath); @endtsexample @return The index of the newly inserted imagemap, or -1 if the insertion failed. @see SimObject) +/// @brief Insert an image into imagelist- returns the image index or -1 for failure. +/// @param imagePath Imagemap, with path, to add to the list. +/// @tsexample +/// // Define the imagemap to add to the list +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the GuiImageList control to add the defined image to its list. +/// %imageIndex = %thisGuiImageList.insert(%imagePath); +/// @endtsexample +/// @return The index of the newly inserted imagemap, or -1 if the insertion failed. +/// @see SimObject) +/// /// public int insert(string guiimagelist, string imagePath){ @@ -11504,7 +16061,17 @@ public int insert(string guiimagelist, string imagePath){ return m_ts.fnGuiImageList_insert(guiimagelist, imagePath); } /// -/// @brief Removes an image from the list by index. @param index Image index to remove. @tsexample // Define the image index. %imageIndex = \"4\"; // Inform the GuiImageList control to remove the image at the defined index. %wasSuccessful = %thisGuiImageList.remove(%imageIndex); @endtsexample @return True if the operation was successful, false if it was not. @see SimObject) +/// @brief Removes an image from the list by index. +/// @param index Image index to remove. +/// @tsexample +/// // Define the image index. +/// %imageIndex = \"4\"; +/// // Inform the GuiImageList control to remove the image at the defined index. +/// %wasSuccessful = %thisGuiImageList.remove(%imageIndex); +/// @endtsexample +/// @return True if the operation was successful, false if it was not. +/// @see SimObject) +/// /// public bool remove(string guiimagelist, int index){ @@ -11517,14 +16084,9 @@ public bool remove(string guiimagelist, int index){ /// public class GuiInspectorObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorObject(ref Omni ts){m_ts = ts;} /// /// ( id object, (bool autoSync = true) ) - Add the object to the list of objects being inspected. ) +/// /// public void GuiInspector_addInspect(string guiinspector, string className, bool autoSync = true){ @@ -11533,6 +16095,7 @@ public void GuiInspector_addInspect(string guiinspector, string className, bool } /// /// apply() - Force application of inspected object's attributes ) +/// /// public void GuiInspector_apply(string guiinspector){ @@ -11541,6 +16104,7 @@ public void GuiInspector_apply(string guiinspector){ } /// /// getInspectObject( int index=0 ) - Returns currently inspected object ) +/// /// public string GuiInspector_getInspectObject(string guiinspector, uint index = 0){ @@ -11549,6 +16113,7 @@ public string GuiInspector_getInspectObject(string guiinspector, uint index = 0 } /// /// () - Return the number of objects currently being inspected. ) +/// /// public int GuiInspector_getNumInspectObjects(string guiinspector){ @@ -11557,6 +16122,7 @@ public int GuiInspector_getNumInspectObjects(string guiinspector){ } /// /// Inspect(Object)) +/// /// public void GuiInspector_inspect(string guiinspector, string className){ @@ -11565,6 +16131,7 @@ public void GuiInspector_inspect(string guiinspector, string className){ } /// /// Reinspect the currently selected object. ) +/// /// public void GuiInspector_refresh(string guiinspector){ @@ -11573,6 +16140,7 @@ public void GuiInspector_refresh(string guiinspector){ } /// /// ( id object ) - Remove the object from the list of objects being inspected. ) +/// /// public void GuiInspector_removeInspect(string guiinspector, string obj){ @@ -11581,6 +16149,7 @@ public void GuiInspector_removeInspect(string guiinspector, string obj){ } /// /// setName(NewObjectName)) +/// /// public void GuiInspector_setName(string guiinspector, string newObjectName){ @@ -11589,6 +16158,7 @@ public void GuiInspector_setName(string guiinspector, string newObjectName){ } /// /// setObjectField( fieldname, data ) - Set a named fields value on the inspected object if it exists. This triggers all the usual callbacks that would occur if the field had been changed through the gui. ) +/// /// public void GuiInspector_setObjectField(string guiinspector, string fieldname, string data){ @@ -11601,14 +16171,9 @@ public void GuiInspector_setObjectField(string guiinspector, string fieldname, /// public class GuiInspectorDynamicFieldObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorDynamicFieldObject(ref Omni ts){m_ts = ts;} /// /// field.renameField(newDynamicFieldName); ) +/// /// public void GuiInspectorDynamicField_renameField(string guiinspectordynamicfield, string newDynamicFieldName){ @@ -11621,14 +16186,9 @@ public void GuiInspectorDynamicField_renameField(string guiinspectordynamicfiel /// public class GuiInspectorDynamicGroupObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorDynamicGroupObject(ref Omni ts){m_ts = ts;} /// /// obj.addDynamicField(); ) +/// /// public void GuiInspectorDynamicGroup_addDynamicField(string guiinspectordynamicgroup){ @@ -11637,6 +16197,7 @@ public void GuiInspectorDynamicGroup_addDynamicField(string guiinspectordynamic } /// /// Refreshes the dynamic fields in the inspector.) +/// /// public bool GuiInspectorDynamicGroup_inspectGroup(string guiinspectordynamicgroup){ @@ -11645,6 +16206,7 @@ public bool GuiInspectorDynamicGroup_inspectGroup(string guiinspectordynamicgro } /// /// ) +/// /// public void GuiInspectorDynamicGroup_removeDynamicField(string guiinspectordynamicgroup){ @@ -11657,14 +16219,9 @@ public void GuiInspectorDynamicGroup_removeDynamicField(string guiinspectordyna /// public class GuiInspectorFieldObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorFieldObject(ref Omni ts){m_ts = ts;} /// /// , true), ( string newValue, bool callbacks=true ) - Set the field's value. Suppress callbacks for undo if callbacks=false. ) +/// /// public void GuiInspectorField_apply(string guiinspectorfield, string newValue = "", bool callbacks = true){ @@ -11673,6 +16230,7 @@ public void GuiInspectorField_apply(string guiinspectorfield, string newValue = } /// /// () - Set field value without recording undo (same as 'apply( value, false )'). ) +/// /// public void GuiInspectorField_applyWithoutUndo(string guiinspectorfield, string data){ @@ -11681,6 +16239,7 @@ public void GuiInspectorField_applyWithoutUndo(string guiinspectorfield, string } /// /// () - Return the value currently displayed on the field. ) +/// /// public string GuiInspectorField_getData(string guiinspectorfield){ @@ -11689,6 +16248,7 @@ public string GuiInspectorField_getData(string guiinspectorfield){ } /// /// () - Return the name of the field edited by this inspector field. ) +/// /// public string GuiInspectorField_getInspectedFieldName(string guiinspectorfield){ @@ -11697,6 +16257,7 @@ public string GuiInspectorField_getInspectedFieldName(string guiinspectorfield) } /// /// () - Return the type of the field edited by this inspector field. ) +/// /// public string GuiInspectorField_getInspectedFieldType(string guiinspectorfield){ @@ -11705,6 +16266,7 @@ public string GuiInspectorField_getInspectedFieldType(string guiinspectorfield) } /// /// () - Return the GuiInspector to which this field belongs. ) +/// /// public int GuiInspectorField_getInspector(string guiinspectorfield){ @@ -11713,6 +16275,7 @@ public int GuiInspectorField_getInspector(string guiinspectorfield){ } /// /// () - Reset to default value. ) +/// /// public void GuiInspectorField_reset(string guiinspectorfield){ @@ -11725,14 +16288,9 @@ public void GuiInspectorField_reset(string guiinspectorfield){ /// public class GuiInspectorTypeBitMask32Object { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorTypeBitMask32Object(ref Omni ts){m_ts = ts;} /// /// ( GuiInspectorTypeBitMask32, applyBit, void, 2,2, apply(); ) +/// /// public void applyBit(string guiinspectortypebitmask32= ""){ @@ -11745,14 +16303,9 @@ public void applyBit(string guiinspectortypebitmask32= ""){ /// public class GuiInspectorTypeFileNameObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorTypeFileNameObject(ref Omni ts){m_ts = ts;} /// /// ( GuiInspectorTypeFileName, apply, void, 3,3, apply(newValue); ) +/// /// public void apply(string guiinspectortypefilename, string a2= ""){ @@ -11765,14 +16318,18 @@ public void apply(string guiinspectortypefilename, string a2= ""){ /// public class GuiListBoxCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiListBoxCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Checks if there is an item with the exact text of what is passed in, and if so the item is removed from the list and adds that item's data to the filtered list. @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. @tsexample // Define the itemName that we wish to add to the filtered item list. %itemName = \"This Item Name\"; // Add the item name to the filtered item list. %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); @endtsexample @see GuiControl) +/// @brief Checks if there is an item with the exact text of what is passed in, and if so +/// the item is removed from the list and adds that item's data to the filtered list. +/// @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. +/// @tsexample +/// // Define the itemName that we wish to add to the filtered item list. +/// %itemName = \"This Item Name\"; +/// // Add the item name to the filtered item list. +/// %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void addFilteredItem(string guilistboxctrl, string newItem){ @@ -11780,7 +16337,22 @@ public void addFilteredItem(string guilistboxctrl, string newItem){ m_ts.fnGuiListBoxCtrl_addFilteredItem(guilistboxctrl, newItem); } /// -/// ), @brief Adds an item to the end of the list with an optional color. @param newItem New item to add to the list. @param color Optional color parameter to add to the new item. @tsexample // Define the item to add to the list. %newItem = \"Gideon's Blue Coat\"; // Define the optional color for the new list item. %color = \"0.0 0.0 1.0\"; // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. %thisGuiListBoxCtrl.addItem(%newItem,%color); @endtsexample @return If not void, return value and description @see GuiControl @hide) +/// ), +/// @brief Adds an item to the end of the list with an optional color. +/// @param newItem New item to add to the list. +/// @param color Optional color parameter to add to the new item. +/// @tsexample +/// // Define the item to add to the list. +/// %newItem = \"Gideon's Blue Coat\"; +/// // Define the optional color for the new list item. +/// %color = \"0.0 0.0 1.0\"; +/// // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. +/// %thisGuiListBoxCtrl.addItem(%newItem,%color); +/// @endtsexample +/// @return If not void, return value and description +/// @see GuiControl +/// @hide) +/// /// public int addItem(string guilistboxctrl, string newItem, string color = ""){ @@ -11788,7 +16360,16 @@ public int addItem(string guilistboxctrl, string newItem, string color = ""){ return m_ts.fnGuiListBoxCtrl_addItem(guilistboxctrl, newItem, color); } /// -/// @brief Removes any custom coloring from an item at the defined index id in the list. @param index Index id for the item to clear any custom color from. @tsexample // Define the index id %index = \"4\"; // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry %thisGuiListBoxCtrl.clearItemColor(%index); @endtsexample @see GuiControl) +/// @brief Removes any custom coloring from an item at the defined index id in the list. +/// @param index Index id for the item to clear any custom color from. +/// @tsexample +/// // Define the index id +/// %index = \"4\"; +/// // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry +/// %thisGuiListBoxCtrl.clearItemColor(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearItemColor(string guilistboxctrl, int index){ @@ -11796,7 +16377,13 @@ public void clearItemColor(string guilistboxctrl, int index){ m_ts.fnGuiListBoxCtrl_clearItemColor(guilistboxctrl, index); } /// -/// @brief Clears all the items in the listbox. @tsexample // Inform the GuiListBoxCtrl object to clear all items from its list. %thisGuiListBoxCtrl.clearItems(); @endtsexample @see GuiControl) +/// @brief Clears all the items in the listbox. +/// @tsexample +/// // Inform the GuiListBoxCtrl object to clear all items from its list. +/// %thisGuiListBoxCtrl.clearItems(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearItems(string guilistboxctrl){ @@ -11804,7 +16391,14 @@ public void clearItems(string guilistboxctrl){ m_ts.fnGuiListBoxCtrl_clearItems(guilistboxctrl); } /// -/// @brief Sets all currently selected items to unselected. Detailed description @tsexample // Inform the GuiListBoxCtrl object to set all of its items to unselected./n %thisGuiListBoxCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Sets all currently selected items to unselected. +/// Detailed description +/// @tsexample +/// // Inform the GuiListBoxCtrl object to set all of its items to unselected./n +/// %thisGuiListBoxCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearSelection(string guilistboxctrl){ @@ -11812,7 +16406,16 @@ public void clearSelection(string guilistboxctrl){ m_ts.fnGuiListBoxCtrl_clearSelection(guilistboxctrl); } /// -/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. @param itemIndex Index id location to remove the item from. @tsexample // Define the index id we want to remove from the list %itemIndex = \"8\"; // Inform the GuiListBoxCtrl object to remove the item at the defined index id. %thisGuiListBoxCtrl.deleteItem(%itemIndex); @endtsexample @see References) +/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. +/// @param itemIndex Index id location to remove the item from. +/// @tsexample +/// // Define the index id we want to remove from the list +/// %itemIndex = \"8\"; +/// // Inform the GuiListBoxCtrl object to remove the item at the defined index id. +/// %thisGuiListBoxCtrl.deleteItem(%itemIndex); +/// @endtsexample +/// @see References) +/// /// public void deleteItem(string guilistboxctrl, int itemIndex){ @@ -11820,7 +16423,13 @@ public void deleteItem(string guilistboxctrl, int itemIndex){ m_ts.fnGuiListBoxCtrl_deleteItem(guilistboxctrl, itemIndex); } /// -/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. @tsexample \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet %thisGuiListBox.doMirror(); @endtsexample @see GuiCore) +/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. +/// @tsexample +/// \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet +/// %thisGuiListBox.doMirror(); +/// @endtsexample +/// @see GuiCore) +/// /// public void doMirror(string guilistboxctrl){ @@ -11828,7 +16437,20 @@ public void doMirror(string guilistboxctrl){ m_ts.fnGuiListBoxCtrl_doMirror(guilistboxctrl); } /// -/// @brief Returns index of item with matching text or -1 if none found. @param findText Text in the list to find. @param isCaseSensitive If true, the search will be case sensitive. @tsexample // Define the text we wish to find in the list. %findText = \"Hickory Smoked Gideon\"/n/n // Define if this is a case sensitive search or not. %isCaseSensitive = \"false\"; // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); @endtsexample @return Index id of item with matching text or -1 if none found. @see GuiControl) +/// @brief Returns index of item with matching text or -1 if none found. +/// @param findText Text in the list to find. +/// @param isCaseSensitive If true, the search will be case sensitive. +/// @tsexample +/// // Define the text we wish to find in the list. +/// %findText = \"Hickory Smoked Gideon\"/n/n +/// // Define if this is a case sensitive search or not. +/// %isCaseSensitive = \"false\"; +/// // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. +/// %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); +/// @endtsexample +/// @return Index id of item with matching text or -1 if none found. +/// @see GuiControl) +/// /// public int findItemText(string guilistboxctrl, string findText, bool bCaseSensitive = false){ @@ -11836,7 +16458,14 @@ public int findItemText(string guilistboxctrl, string findText, bool bCaseSensi return m_ts.fnGuiListBoxCtrl_findItemText(guilistboxctrl, findText, bCaseSensitive); } /// -/// @brief Returns the number of items in the list. @tsexample // Request the number of items in the list of the GuiListBoxCtrl object. %listItemCount = %thisGuiListBoxCtrl.getItemCount(); @endtsexample @return The number of items in the list. @see GuiControl) +/// @brief Returns the number of items in the list. +/// @tsexample +/// // Request the number of items in the list of the GuiListBoxCtrl object. +/// %listItemCount = %thisGuiListBoxCtrl.getItemCount(); +/// @endtsexample +/// @return The number of items in the list. +/// @see GuiControl) +/// /// public int getItemCount(string guilistboxctrl){ @@ -11844,7 +16473,17 @@ public int getItemCount(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getItemCount(guilistboxctrl); } /// -/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. @param index Index id to request the associated item from. @tsexample // Define the index id %index = \"12\"; // Request the item from the GuiListBoxCtrl object %object = %thisGuiListBoxCtrl.getItemObject(%index); @endtsexample @return The object associated with the item in the list. @see References) +/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. +/// @param index Index id to request the associated item from. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Request the item from the GuiListBoxCtrl object +/// %object = %thisGuiListBoxCtrl.getItemObject(%index); +/// @endtsexample +/// @return The object associated with the item in the list. +/// @see References) +/// /// public string getItemObject(string guilistboxctrl, int index){ @@ -11852,7 +16491,17 @@ public string getItemObject(string guilistboxctrl, int index){ return m_ts.fnGuiListBoxCtrl_getItemObject(guilistboxctrl, index); } /// -/// @brief Returns the text of the item at the specified index. @param index Index id to return the item text from. @tsexample // Define the index id entry to request the text from %index = \"12\"; // Request the item id text from the GuiListBoxCtrl object. %text = %thisGuiListBoxCtrl.getItemText(%index); @endtsexample @return The text of the requested index id. @see GuiControl) +/// @brief Returns the text of the item at the specified index. +/// @param index Index id to return the item text from. +/// @tsexample +/// // Define the index id entry to request the text from +/// %index = \"12\"; +/// // Request the item id text from the GuiListBoxCtrl object. +/// %text = %thisGuiListBoxCtrl.getItemText(%index); +/// @endtsexample +/// @return The text of the requested index id. +/// @see GuiControl) +/// /// public string getItemText(string guilistboxctrl, int index){ @@ -11860,7 +16509,14 @@ public string getItemText(string guilistboxctrl, int index){ return m_ts.fnGuiListBoxCtrl_getItemText(guilistboxctrl, index); } /// -/// @brief Request the item index for the item that was last clicked. @tsexample // Request the item index for the last clicked item in the list %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); @endtsexample @return Index id for the last clicked item in the list. @see GuiControl) +/// @brief Request the item index for the item that was last clicked. +/// @tsexample +/// // Request the item index for the last clicked item in the list +/// %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); +/// @endtsexample +/// @return Index id for the last clicked item in the list. +/// @see GuiControl) +/// /// public int getLastClickItem(string guilistboxctrl){ @@ -11868,7 +16524,14 @@ public int getLastClickItem(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getLastClickItem(guilistboxctrl); } /// -/// @brief Returns the number of items currently selected. @tsexample // Request the number of currently selected items %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); @endtsexample @return Number of currently selected items. @see GuiControl) +/// @brief Returns the number of items currently selected. +/// @tsexample +/// // Request the number of currently selected items +/// %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); +/// @endtsexample +/// @return Number of currently selected items. +/// @see GuiControl) +/// /// public int getSelCount(string guilistboxctrl){ @@ -11876,7 +16539,14 @@ public int getSelCount(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getSelCount(guilistboxctrl); } /// -/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. @tsexample // Request the index id of the currently selected item %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); @endtsexample @return The selected items index or -1 if none selected. @see GuiControl) +/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. +/// @tsexample +/// // Request the index id of the currently selected item +/// %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); +/// @endtsexample +/// @return The selected items index or -1 if none selected. +/// @see GuiControl) +/// /// public int getSelectedItem(string guilistboxctrl){ @@ -11884,7 +16554,14 @@ public int getSelectedItem(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getSelectedItem(guilistboxctrl); } /// -/// @brief Returns a space delimited list of the selected items indexes in the list. @tsexample // Request a space delimited list of the items in the GuiListBoxCtrl object. %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); @endtsexample @return Space delimited list of the selected items indexes in the list @see GuiControl) +/// @brief Returns a space delimited list of the selected items indexes in the list. +/// @tsexample +/// // Request a space delimited list of the items in the GuiListBoxCtrl object. +/// %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); +/// @endtsexample +/// @return Space delimited list of the selected items indexes in the list +/// @see GuiControl) +/// /// public string getSelectedItems(string guilistboxctrl){ @@ -11892,7 +16569,20 @@ public string getSelectedItems(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getSelectedItems(guilistboxctrl); } /// -/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. @param text Text item to add. @param index Index id to insert the list item text at. @tsexample // Define the text to insert %text = \"Secret Agent Gideon\"; // Define the index entry to insert the text at %index = \"14\"; // In form the GuiListBoxCtrl object to insert the text at the defined index. %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); @endtsexample @return If successful will return the index id assigned. If unsuccessful, will return -1. @see GuiControl) +/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. +/// @param text Text item to add. +/// @param index Index id to insert the list item text at. +/// @tsexample +/// // Define the text to insert +/// %text = \"Secret Agent Gideon\"; +/// // Define the index entry to insert the text at +/// %index = \"14\"; +/// // In form the GuiListBoxCtrl object to insert the text at the defined index. +/// %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); +/// @endtsexample +/// @return If successful will return the index id assigned. If unsuccessful, will return -1. +/// @see GuiControl) +/// /// public void insertItem(string guilistboxctrl, string text, int index){ @@ -11900,7 +16590,16 @@ public void insertItem(string guilistboxctrl, string text, int index){ m_ts.fnGuiListBoxCtrl_insertItem(guilistboxctrl, text, index); } /// -/// @brief Removes an item of the entered name from the filtered items list. @param itemName Name of the item to remove from the filtered list. @tsexample // Define the itemName that you wish to remove. %itemName = \"This Item Name\"; // Remove the itemName from the GuiListBoxCtrl %thisGuiListBoxCtrl.removeFilteredItem(%itemName); @endtsexample @see GuiControl) +/// @brief Removes an item of the entered name from the filtered items list. +/// @param itemName Name of the item to remove from the filtered list. +/// @tsexample +/// // Define the itemName that you wish to remove. +/// %itemName = \"This Item Name\"; +/// // Remove the itemName from the GuiListBoxCtrl +/// %thisGuiListBoxCtrl.removeFilteredItem(%itemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void removeFilteredItem(string guilistboxctrl, string itemName){ @@ -11908,7 +16607,16 @@ public void removeFilteredItem(string guilistboxctrl, string itemName){ m_ts.fnGuiListBoxCtrl_removeFilteredItem(guilistboxctrl, itemName); } /// -/// @brief Sets the currently selected item at the specified index. @param indexId Index Id to set selected. @tsexample // Define the index id that we wish to select. %selectId = \"4\"; // Inform the GuiListBoxCtrl object to set the requested index as selected. %thisGuiListBoxCtrl.setCurSel(%selectId); @endtsexample @see GuiControl) +/// @brief Sets the currently selected item at the specified index. +/// @param indexId Index Id to set selected. +/// @tsexample +/// // Define the index id that we wish to select. +/// %selectId = \"4\"; +/// // Inform the GuiListBoxCtrl object to set the requested index as selected. +/// %thisGuiListBoxCtrl.setCurSel(%selectId); +/// @endtsexample +/// @see GuiControl) +/// /// public void setCurSel(string guilistboxctrl, int indexId){ @@ -11916,7 +16624,19 @@ public void setCurSel(string guilistboxctrl, int indexId){ m_ts.fnGuiListBoxCtrl_setCurSel(guilistboxctrl, indexId); } /// -/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list @param indexStart Index Id to start selection. @param indexStop Index Id to end selection. @tsexample // Set start id %indexStart = \"3\"; // Set end id %indexEnd = \"6\"; // Request the GuiListBoxCtrl object to select the defined range. %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); @endtsexample @see GuiControl) +/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list +/// @param indexStart Index Id to start selection. +/// @param indexStop Index Id to end selection. +/// @tsexample +/// // Set start id +/// %indexStart = \"3\"; +/// // Set end id +/// %indexEnd = \"6\"; +/// // Request the GuiListBoxCtrl object to select the defined range. +/// %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); +/// @endtsexample +/// @see GuiControl) +/// /// public void setCurSelRange(string guilistboxctrl, int indexStart, int indexStop = 999999){ @@ -11924,7 +16644,19 @@ public void setCurSelRange(string guilistboxctrl, int indexStart, int indexStop m_ts.fnGuiListBoxCtrl_setCurSelRange(guilistboxctrl, indexStart, indexStop); } /// -/// @brief Sets the color of a single list entry at the specified index id. @param index Index id to modify the color of in the list. @param color Color value to set the list entry to. @tsexample // Define the index id value %index = \"5\"; // Define the color value %color = \"1.0 0.0 0.0\"; // Inform the GuiListBoxCtrl object to change the color of the requested index %thisGuiListBoxCtrl.setItemColor(%index,%color); @endtsexample @see GuiControl) +/// @brief Sets the color of a single list entry at the specified index id. +/// @param index Index id to modify the color of in the list. +/// @param color Color value to set the list entry to. +/// @tsexample +/// // Define the index id value +/// %index = \"5\"; +/// // Define the color value +/// %color = \"1.0 0.0 0.0\"; +/// // Inform the GuiListBoxCtrl object to change the color of the requested index +/// %thisGuiListBoxCtrl.setItemColor(%index,%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void setItemColor(string guilistboxctrl, int index, ColorF color){ @@ -11932,7 +16664,19 @@ public void setItemColor(string guilistboxctrl, int index, ColorF color){ m_ts.fnGuiListBoxCtrl_setItemColor(guilistboxctrl, index, color.AsString()); } /// -/// @brief Sets the items text at the specified index. @param index Index id to set the item text at. @param newtext Text to change the list item at index id to. @tsexample // Define the index id/n %index = \"12\"; // Define the text to set the list item to %newtext = \"Gideon's Fancy Goggles\"; // Inform the GuiListBoxCtrl object to change the text at the requested index %thisGuiListBoxCtrl.setItemText(%index,%newText); @endtsexample @see GuiControl) +/// @brief Sets the items text at the specified index. +/// @param index Index id to set the item text at. +/// @param newtext Text to change the list item at index id to. +/// @tsexample +/// // Define the index id/n +/// %index = \"12\"; +/// // Define the text to set the list item to +/// %newtext = \"Gideon's Fancy Goggles\"; +/// // Inform the GuiListBoxCtrl object to change the text at the requested index +/// %thisGuiListBoxCtrl.setItemText(%index,%newText); +/// @endtsexample +/// @see GuiControl) +/// /// public void setItemText(string guilistboxctrl, int index, string newtext){ @@ -11940,7 +16684,19 @@ public void setItemText(string guilistboxctrl, int index, string newtext){ m_ts.fnGuiListBoxCtrl_setItemText(guilistboxctrl, index, newtext); } /// -/// @brief Set the tooltip text to display for the given list item. @param index Index id to change the tooltip text @param text Text for the tooltip. @tsexample // Define the index id %index = \"12\"; // Define the tooltip text %tooltip = \"Gideon's goggles can see through space and time.\" // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); @endtsexample @see GuiControl) +/// @brief Set the tooltip text to display for the given list item. +/// @param index Index id to change the tooltip text +/// @param text Text for the tooltip. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Define the tooltip text +/// %tooltip = \"Gideon's goggles can see through space and time.\" +/// // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id +/// %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); +/// @endtsexample +/// @see GuiControl) +/// /// public void setItemTooltip(string guilistboxctrl, int index, string text){ @@ -11948,7 +16704,16 @@ public void setItemTooltip(string guilistboxctrl, int index, string text){ m_ts.fnGuiListBoxCtrl_setItemTooltip(guilistboxctrl, index, text); } /// -/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. @param allowMultSelections Boolean variable to set the use of multiple selections or not. @tsexample // Define the multiple selection use state. %allowMultSelections = \"true\"; // Set the allow multiple selection state on the GuiListBoxCtrl object. %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); @endtsexample @see GuiControl) +/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. +/// @param allowMultSelections Boolean variable to set the use of multiple selections or not. +/// @tsexample +/// // Define the multiple selection use state. +/// %allowMultSelections = \"true\"; +/// // Set the allow multiple selection state on the GuiListBoxCtrl object. +/// %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); +/// @endtsexample +/// @see GuiControl) +/// /// public void setMultipleSelection(string guilistboxctrl, bool allowMultSelections){ @@ -11956,7 +16721,20 @@ public void setMultipleSelection(string guilistboxctrl, bool allowMultSelection m_ts.fnGuiListBoxCtrl_setMultipleSelection(guilistboxctrl, allowMultSelections); } /// -/// @brief Sets the item at the index specified to selected or not. Detailed description @param index Item index to set selected or unselected. @param setSelected Boolean selection state to set the requested item index. @tsexample // Define the index %index = \"5\"; // Define the selection state %selected = \"true\" // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. %thisGuiListBoxCtrl.setSelected(%index,%selected); @endtsexample @see GuiControl) +/// @brief Sets the item at the index specified to selected or not. +/// Detailed description +/// @param index Item index to set selected or unselected. +/// @param setSelected Boolean selection state to set the requested item index. +/// @tsexample +/// // Define the index +/// %index = \"5\"; +/// // Define the selection state +/// %selected = \"true\" +/// // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. +/// %thisGuiListBoxCtrl.setSelected(%index,%selected); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSelected(string guilistboxctrl, int index, bool setSelected = true){ @@ -11969,14 +16747,10 @@ public void setSelected(string guilistboxctrl, int index, bool setSelected = tr /// public class GuiMaterialCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMaterialCtrlObject(ref Omni ts){m_ts = ts;} /// -/// ( string materialName ) Set the material to be displayed in the control. ) +/// ( string materialName ) +/// Set the material to be displayed in the control. ) +/// /// public bool GuiMaterialCtrl_setMaterial(string guimaterialctrl, string materialName){ @@ -11989,14 +16763,9 @@ public bool GuiMaterialCtrl_setMaterial(string guimaterialctrl, string material /// public class GuiMaterialPreviewObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMaterialPreviewObject(ref Omni ts){m_ts = ts;} /// /// Deletes the preview model.) +/// /// public void deleteModel(string guimaterialpreview){ @@ -12005,6 +16774,7 @@ public void deleteModel(string guimaterialpreview){ } /// /// Resets the viewport to default zoom, pan, rotate and lighting.) +/// /// public void reset(string guimaterialpreview){ @@ -12013,6 +16783,7 @@ public void reset(string guimaterialpreview){ } /// /// Sets the color of the ambient light in the scene.) +/// /// public void setAmbientLightColor(string guimaterialpreview, ColorF color){ @@ -12021,6 +16792,7 @@ public void setAmbientLightColor(string guimaterialpreview, ColorF color){ } /// /// Sets the color of the light in the scene.) +/// /// public void setLightColor(string guimaterialpreview, ColorF color){ @@ -12028,7 +16800,9 @@ public void setLightColor(string guimaterialpreview, ColorF color){ m_ts.fnGuiMaterialPreview_setLightColor(guimaterialpreview, color.AsString()); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display.) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display.) +/// /// public void setModel(string guimaterialpreview, string shapeName){ @@ -12036,7 +16810,10 @@ public void setModel(string guimaterialpreview, string shapeName){ m_ts.fnGuiMaterialPreview_setModel(guimaterialpreview, shapeName); } /// -/// Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. @param distance The distance to set the orbit to (will be clamped).) +/// Sets the distance at which the camera orbits the object. Clamped to the +/// acceptable range defined in the class by min and max orbit distances. +/// @param distance The distance to set the orbit to (will be clamped).) +/// /// public void setOrbitDistance(string guimaterialpreview, float distance){ @@ -12049,14 +16826,20 @@ public void setOrbitDistance(string guimaterialpreview, float distance){ /// public class GuiMenuBarObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMenuBarObject(ref Omni ts){m_ts = ts;} /// -/// @brief Adds a new menu to the menu bar. @param menuText Text to display for the new menu item. @param menuId ID for the new menu item. @tsexample // Define the menu text %menuText = \"New Menu\"; // Define the menu ID. %menuId = \"2\"; // Inform the GuiMenuBar control to add the new menu %thisGuiMenuBar.addMenu(%menuText,%menuId); @endtsexample @see GuiTickCtrl) +/// @brief Adds a new menu to the menu bar. +/// @param menuText Text to display for the new menu item. +/// @param menuId ID for the new menu item. +/// @tsexample +/// // Define the menu text +/// %menuText = \"New Menu\"; +/// // Define the menu ID. +/// %menuId = \"2\"; +/// // Inform the GuiMenuBar control to add the new menu +/// %thisGuiMenuBar.addMenu(%menuText,%menuId); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void addMenu(string guimenubar, string menuText, int menuId){ @@ -12064,7 +16847,29 @@ public void addMenu(string guimenubar, string menuText, int menuId){ m_ts.fnGuiMenuBar_addMenu(guimenubar, menuText, menuId); } /// -/// ,,0,,-1), @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menu Menu name or menu Id to add the new item to. @param menuItemText Text for the new menu item. @param menuItemId Id for the new menu item. @param accelerator Accelerator key for the new menu item. @param checkGroup Check group to include this menu item in. @tsexample // Define the menu we wish to add the item to %targetMenu = \"New Menu\"; or %menu = \"4\"; // Define the text for the new menu item %menuItemText = \"Menu Item\"; // Define the id for the new menu item %menuItemId = \"3\"; // Set the accelerator key to toggle this menu item with %accelerator = \"n\"; // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. %checkGroup = \"4\"; // Inform the GuiMenuBar control to add the new menu item with the defined fields %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); @endtsexample @see GuiTickCtrl) +/// ,,0,,-1), +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menu Menu name or menu Id to add the new item to. +/// @param menuItemText Text for the new menu item. +/// @param menuItemId Id for the new menu item. +/// @param accelerator Accelerator key for the new menu item. +/// @param checkGroup Check group to include this menu item in. +/// @tsexample +/// // Define the menu we wish to add the item to +/// %targetMenu = \"New Menu\"; or %menu = \"4\"; +/// // Define the text for the new menu item +/// %menuItemText = \"Menu Item\"; +/// // Define the id for the new menu item +/// %menuItemId = \"3\"; +/// // Set the accelerator key to toggle this menu item with +/// %accelerator = \"n\"; +/// // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. +/// %checkGroup = \"4\"; +/// // Inform the GuiMenuBar control to add the new menu item with the defined fields +/// %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void addMenuItem(string guimenubar, string targetMenu = "", string menuItemText = "", int menuItemId = 0, string accelerator = "", int checkGroup = -1){ @@ -12072,7 +16877,31 @@ public void addMenuItem(string guimenubar, string targetMenu = "", string menuI m_ts.fnGuiMenuBar_addMenuItem(guimenubar, targetMenu, menuItemText, menuItemId, accelerator, checkGroup); } /// -/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for the new submenu @param submenuItemId Id for the new submenu @param accelerator Accelerator key for the new submenu @param checkGroup Which check group the new submenu should be in, or -1 for none. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"New Submenu Item\"; // Define the id for the new submenu %submenuItemId = \"4\"; // Define the accelerator key for the new submenu %accelerator = \"n\"; // Define the checkgroup for the new submenu %checkgroup = \"7\"; // Request the GuiMenuBar control to add the new submenu with the defined information %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); @endtsexample @see GuiTickCtrl) +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for the new submenu +/// @param submenuItemId Id for the new submenu +/// @param accelerator Accelerator key for the new submenu +/// @param checkGroup Which check group the new submenu should be in, or -1 for none. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"New Submenu Item\"; +/// // Define the id for the new submenu +/// %submenuItemId = \"4\"; +/// // Define the accelerator key for the new submenu +/// %accelerator = \"n\"; +/// // Define the checkgroup for the new submenu +/// %checkgroup = \"7\"; +/// // Request the GuiMenuBar control to add the new submenu with the defined information +/// %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void addSubmenuItem(string guimenubar, string menuTarget, string menuItem, string submenuItemText, int submenuItemId, string accelerator, int checkGroup){ @@ -12080,7 +16909,16 @@ public void addSubmenuItem(string guimenubar, string menuTarget, string menuIte m_ts.fnGuiMenuBar_addSubmenuItem(guimenubar, menuTarget, menuItem, submenuItemText, submenuItemId, accelerator, checkGroup); } /// -/// @brief Removes all the menu items from the specified menu. @param menuTarget Menu to remove all items from @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar control to clear all menu items from the defined menu %thisGuiMenuBar.clearMenuItems(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes all the menu items from the specified menu. +/// @param menuTarget Menu to remove all items from +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar control to clear all menu items from the defined menu +/// %thisGuiMenuBar.clearMenuItems(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void clearMenuItems(string guimenubar, string menuTarget){ @@ -12088,7 +16926,13 @@ public void clearMenuItems(string guimenubar, string menuTarget){ m_ts.fnGuiMenuBar_clearMenuItems(guimenubar, menuTarget); } /// -/// @brief Clears all the menus from the menu bar. @tsexample // Inform the GuiMenuBar control to clear all menus from itself. %thisGuiMenuBar.clearMenus(); @endtsexample @see GuiTickCtrl) +/// @brief Clears all the menus from the menu bar. +/// @tsexample +/// // Inform the GuiMenuBar control to clear all menus from itself. +/// %thisGuiMenuBar.clearMenus(); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void clearMenus(string guimenubar, int param1, int param2){ @@ -12096,7 +16940,19 @@ public void clearMenus(string guimenubar, int param1, int param2){ m_ts.fnGuiMenuBar_clearMenus(guimenubar, param1, param2); } /// -/// @brief Removes all the menu items from the specified submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Inform the GuiMenuBar to remove all submenu items from the defined menu item %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); @endtsexample @see GuiControl) +/// @brief Removes all the menu items from the specified submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Inform the GuiMenuBar to remove all submenu items from the defined menu item +/// %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearSubmenuItems(string guimenubar, string menuTarget, string menuItem){ @@ -12104,7 +16960,16 @@ public void clearSubmenuItems(string guimenubar, string menuTarget, string menu m_ts.fnGuiMenuBar_clearSubmenuItems(guimenubar, menuTarget, menuItem); } /// -/// @brief Removes the specified menu from the menu bar. @param menuTarget Menu to remove from the menu bar @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar to remove the defined menu from the menu bar %thisGuiMenuBar.removeMenu(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu from the menu bar. +/// @param menuTarget Menu to remove from the menu bar +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar to remove the defined menu from the menu bar +/// %thisGuiMenuBar.removeMenu(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void removeMenu(string guimenubar, string menuTarget){ @@ -12112,7 +16977,19 @@ public void removeMenu(string guimenubar, string menuTarget){ m_ts.fnGuiMenuBar_removeMenu(guimenubar, menuTarget); } /// -/// @brief Removes the specified menu item from the menu. @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Request the GuiMenuBar control to remove the define menu item %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu item from the menu. +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Request the GuiMenuBar control to remove the define menu item +/// %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void removeMenuItem(string guimenubar, string menuTarget, string menuItemTarget){ @@ -12120,7 +16997,16 @@ public void removeMenuItem(string guimenubar, string menuTarget, string menuIte m_ts.fnGuiMenuBar_removeMenuItem(guimenubar, menuTarget, menuItemTarget); } /// -/// @brief Sets the menu bitmap index for the check mark image. @param bitmapIndex Bitmap index for the check mark image. @tsexample // Define the bitmap index %bitmapIndex = \"2\"; // Inform the GuiMenuBar control of the proper bitmap index for the check mark image %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu bitmap index for the check mark image. +/// @param bitmapIndex Bitmap index for the check mark image. +/// @tsexample +/// // Define the bitmap index +/// %bitmapIndex = \"2\"; +/// // Inform the GuiMenuBar control of the proper bitmap index for the check mark image +/// %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setCheckmarkBitmapIndex(string guimenubar, int bitmapindex){ @@ -12128,7 +17014,25 @@ public void setCheckmarkBitmapIndex(string guimenubar, int bitmapindex){ m_ts.fnGuiMenuBar_setCheckmarkBitmapIndex(guimenubar, bitmapindex); } /// -/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. @param menuTarget Menu to affect @param bitmapindex Bitmap index to set for the menu @param bitmaponly If true, only the bitmap will be rendered @param drawborder If true, a border will be drawn around the menu. @tsexample // Define the menuTarget to affect %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Set the bitmap index %bitmapIndex = \"5\"; // Set if we are only to render the bitmap or not %bitmaponly = \"true\"; // Set if we are rendering a border or not %drawborder = \"true\"; // Inform the GuiMenuBar of the bitmap and rendering changes %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); @endtsexample @see GuiTickCtrl) +/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. +/// @param menuTarget Menu to affect +/// @param bitmapindex Bitmap index to set for the menu +/// @param bitmaponly If true, only the bitmap will be rendered +/// @param drawborder If true, a border will be drawn around the menu. +/// @tsexample +/// // Define the menuTarget to affect +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Set the bitmap index +/// %bitmapIndex = \"5\"; +/// // Set if we are only to render the bitmap or not +/// %bitmaponly = \"true\"; +/// // Set if we are rendering a border or not +/// %drawborder = \"true\"; +/// // Inform the GuiMenuBar of the bitmap and rendering changes +/// %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuBitmapIndex(string guimenubar, string menuTarget, int bitmapindex, bool bitmaponly, bool drawborder){ @@ -12136,7 +17040,22 @@ public void setMenuBitmapIndex(string guimenubar, string menuTarget, int bitmap m_ts.fnGuiMenuBar_setMenuBitmapIndex(guimenubar, menuTarget, bitmapindex, bitmaponly, drawborder); } /// -/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. @param menuTarget Menu to affect the menuItem in @param menuItem Menu item to affect @param bitmapIndex Bitmap index to set the menu item to @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem\" %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the bitmapIndex %bitmapIndex = \"6\"; // Inform the GuiMenuBar control to set the menu item to the defined bitmap %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. +/// @param menuTarget Menu to affect the menuItem in +/// @param menuItem Menu item to affect +/// @param bitmapIndex Bitmap index to set the menu item to +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem\" +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the bitmapIndex +/// %bitmapIndex = \"6\"; +/// // Inform the GuiMenuBar control to set the menu item to the defined bitmap +/// %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemBitmap(string guimenubar, string menuTarget, string menuItemTarget, int bitmapIndex){ @@ -12144,7 +17063,18 @@ public void setMenuItemBitmap(string guimenubar, string menuTarget, string menu m_ts.fnGuiMenuBar_setMenuItemBitmap(guimenubar, menuTarget, menuItemTarget, bitmapIndex); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to work in @param menuItem Menu item to affect @param checked Whether we are setting it to checked or not @tsexample @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in +/// the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to work in +/// @param menuItem Menu item to affect +/// @param checked Whether we are setting it to checked or not +/// @tsexample +/// +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void setMenuItemChecked(string guimenubar, string menuTarget, string menuItemTarget, bool checkedx){ @@ -12152,7 +17082,24 @@ public void setMenuItemChecked(string guimenubar, string menuTarget, string men m_ts.fnGuiMenuBar_setMenuItemChecked(guimenubar, menuTarget, menuItemTarget, checkedx); } /// -/// @brief sets the menu item to enabled or disabled based on the enable parameter. The specified menu and menu item can either be text or ids. Detailed description @param menuTarget Menu to work in @param menuItemTarget The menu item inside of the menu to enable or disable @param enabled Boolean enable / disable value. @tsexample // Define the menu %menu = \"New Menu\"; or %menu = \"4\"; // Define the menu item %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the enabled state %enabled = \"true\"; // Inform the GuiMenuBar control to set the enabled state of the requested menu item %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); @endtsexample @see GuiTickCtrl) +/// @brief sets the menu item to enabled or disabled based on the enable parameter. +/// The specified menu and menu item can either be text or ids. +/// Detailed description +/// @param menuTarget Menu to work in +/// @param menuItemTarget The menu item inside of the menu to enable or disable +/// @param enabled Boolean enable / disable value. +/// @tsexample +/// // Define the menu +/// %menu = \"New Menu\"; or %menu = \"4\"; +/// // Define the menu item +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the enabled state +/// %enabled = \"true\"; +/// // Inform the GuiMenuBar control to set the enabled state of the requested menu item +/// %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemEnable(string guimenubar, string menuTarget, string menuItemTarget, bool enabled){ @@ -12160,7 +17107,22 @@ public void setMenuItemEnable(string guimenubar, string menuTarget, string menu m_ts.fnGuiMenuBar_setMenuItemEnable(guimenubar, menuTarget, menuItemTarget, enabled); } /// -/// @brief Sets the given menu item to be a submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param isSubmenu Whether or not the menuItem will become a subMenu or not @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define whether or not the Menu Item is a sub menu or not %isSubmenu = \"true\"; // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); @endtsexample @see GuiTickCtrl) +/// @brief Sets the given menu item to be a submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param isSubmenu Whether or not the menuItem will become a subMenu or not +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define whether or not the Menu Item is a sub menu or not +/// %isSubmenu = \"true\"; +/// // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. +/// %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemSubmenuState(string guimenubar, string menuTarget, string menuItem, bool isSubmenu){ @@ -12168,7 +17130,22 @@ public void setMenuItemSubmenuState(string guimenubar, string menuTarget, strin m_ts.fnGuiMenuBar_setMenuItemSubmenuState(guimenubar, menuTarget, menuItem, isSubmenu); } /// -/// @brief Sets the text of the specified menu item to the new string. @param menuTarget Menu to affect @param menuItem Menu item in the menu to change the text at @param newMenuItemText New menu text @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the new text for the menu item %newMenuItemText = \"Very New Menu Item\"; // Inform the GuiMenuBar control to change the defined menu item with the new text %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu item to the new string. +/// @param menuTarget Menu to affect +/// @param menuItem Menu item in the menu to change the text at +/// @param newMenuItemText New menu text +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the new text for the menu item +/// %newMenuItemText = \"Very New Menu Item\"; +/// // Inform the GuiMenuBar control to change the defined menu item with the new text +/// %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemText(string guimenubar, string menuTarget, string menuItemTarget, string newMenuItemText){ @@ -12176,7 +17153,23 @@ public void setMenuItemText(string guimenubar, string menuTarget, string menuIt m_ts.fnGuiMenuBar_setMenuItemText(guimenubar, menuTarget, menuItemTarget, newMenuItemText); } /// -/// @brief Brief Description. Detailed description @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @param isVisible Visible state to set the menu item to. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the visibility state %isVisible = \"true\"; // Inform the GuiMenuBarControl of the visibility state of the defined menu item %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); @endtsexample @see GuiTickCtrl) +/// @brief Brief Description. +/// Detailed description +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @param isVisible Visible state to set the menu item to. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the visibility state +/// %isVisible = \"true\"; +/// // Inform the GuiMenuBarControl of the visibility state of the defined menu item +/// %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemVisible(string guimenubar, string menuTarget, string menuItemTarget, bool isVisible){ @@ -12184,7 +17177,23 @@ public void setMenuItemVisible(string guimenubar, string menuTarget, string men m_ts.fnGuiMenuBar_setMenuItemVisible(guimenubar, menuTarget, menuItemTarget, isVisible); } /// -/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. Detailed description @param horizontalMargin Number of pixels on the left and right side of a menu's text. @param verticalMargin Number of pixels on the top and bottom of a menu's text. @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. @tsexample // Define the horizontalMargin %horizontalMargin = \"5\"; // Define the verticalMargin %verticalMargin = \"5\"; // Define the bitmapToTextSpacing %bitmapToTextSpacing = \"12\"; // Inform the GuiMenuBar control to set its margins based on the defined values. %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. +/// Detailed description +/// @param horizontalMargin Number of pixels on the left and right side of a menu's text. +/// @param verticalMargin Number of pixels on the top and bottom of a menu's text. +/// @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. +/// @tsexample +/// // Define the horizontalMargin +/// %horizontalMargin = \"5\"; +/// // Define the verticalMargin +/// %verticalMargin = \"5\"; +/// // Define the bitmapToTextSpacing +/// %bitmapToTextSpacing = \"12\"; +/// // Inform the GuiMenuBar control to set its margins based on the defined values. +/// %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuMargins(string guimenubar, int horizontalMargin, int verticalMargin, int bitmapToTextSpacing){ @@ -12192,7 +17201,19 @@ public void setMenuMargins(string guimenubar, int horizontalMargin, int vertica m_ts.fnGuiMenuBar_setMenuMargins(guimenubar, horizontalMargin, verticalMargin, bitmapToTextSpacing); } /// -/// @brief Sets the text of the specified menu to the new string. @param menuTarget Menu to affect @param newMenuText New menu text @tsexample // Define the menu to affect %menu = \"New Menu\"; or %menu = \"3\"; // Define the text to change the menu to %newMenuText = \"Still a New Menu\"; // Inform the GuiMenuBar control to change the defined menu to the defined text %thisGuiMenuBar.setMenuText(%menu,%newMenuText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu to the new string. +/// @param menuTarget Menu to affect +/// @param newMenuText New menu text +/// @tsexample +/// // Define the menu to affect +/// %menu = \"New Menu\"; or %menu = \"3\"; +/// // Define the text to change the menu to +/// %newMenuText = \"Still a New Menu\"; +/// // Inform the GuiMenuBar control to change the defined menu to the defined text +/// %thisGuiMenuBar.setMenuText(%menu,%newMenuText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuText(string guimenubar, string menuTarget, string newMenuText){ @@ -12200,7 +17221,19 @@ public void setMenuText(string guimenubar, string menuTarget, string newMenuTex m_ts.fnGuiMenuBar_setMenuText(guimenubar, menuTarget, newMenuText); } /// -/// @brief Sets the whether or not to display the specified menu. @param menuTarget Menu item to affect @param visible Whether the menu item will be visible or not @tsexample // Define the menu to work with %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define if the menu should be visible or not %visible = \"true\"; // Inform the GuiMenuBar control of the new visibility state for the defined menu %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); @endtsexample @see GuiTickCtrl) +/// @brief Sets the whether or not to display the specified menu. +/// @param menuTarget Menu item to affect +/// @param visible Whether the menu item will be visible or not +/// @tsexample +/// // Define the menu to work with +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define if the menu should be visible or not +/// %visible = \"true\"; +/// // Inform the GuiMenuBar control of the new visibility state for the defined menu +/// %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuVisible(string guimenubar, string menuTarget, bool visible){ @@ -12208,7 +17241,28 @@ public void setMenuVisible(string guimenubar, string menuTarget, bool visible){ m_ts.fnGuiMenuBar_setMenuVisible(guimenubar, menuTarget, visible); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for submenu @param checked Whether or not this submenu item will be checked. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"Submenu Item\"; // Define if this submenu item should be checked or not %checked = \"true\"; // Inform the GuiMenuBar control to set the checked state of the defined submenu item %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the +/// bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for submenu +/// @param checked Whether or not this submenu item will be checked. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"Submenu Item\"; +/// // Define if this submenu item should be checked or not +/// %checked = \"true\"; +/// // Inform the GuiMenuBar control to set the checked state of the defined submenu item +/// %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void setSubmenuItemChecked(string guimenubar, string menuTarget, string menuItemTarget, string submenuItemText, bool checkedx){ @@ -12221,14 +17275,9 @@ public void setSubmenuItemChecked(string guimenubar, string menuTarget, string /// public class GuiMeshRoadEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMeshRoadEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// deleteNode() ) +/// /// public void GuiMeshRoadEditorCtrl_deleteNode(string guimeshroadeditorctrl){ @@ -12237,6 +17286,7 @@ public void GuiMeshRoadEditorCtrl_deleteNode(string guimeshroadeditorctrl){ } /// /// ) +/// /// public string GuiMeshRoadEditorCtrl_getMode(string guimeshroadeditorctrl){ @@ -12245,6 +17295,7 @@ public string GuiMeshRoadEditorCtrl_getMode(string guimeshroadeditorctrl){ } /// /// ) +/// /// public float GuiMeshRoadEditorCtrl_getNodeDepth(string guimeshroadeditorctrl){ @@ -12253,6 +17304,7 @@ public float GuiMeshRoadEditorCtrl_getNodeDepth(string guimeshroadeditorctrl){ } /// /// ) +/// /// public Point3F GuiMeshRoadEditorCtrl_getNodeNormal(string guimeshroadeditorctrl){ @@ -12261,6 +17313,7 @@ public Point3F GuiMeshRoadEditorCtrl_getNodeNormal(string guimeshroadeditorctrl } /// /// ) +/// /// public Point3F GuiMeshRoadEditorCtrl_getNodePosition(string guimeshroadeditorctrl){ @@ -12269,6 +17322,7 @@ public Point3F GuiMeshRoadEditorCtrl_getNodePosition(string guimeshroadeditorct } /// /// ) +/// /// public float GuiMeshRoadEditorCtrl_getNodeWidth(string guimeshroadeditorctrl){ @@ -12277,6 +17331,7 @@ public float GuiMeshRoadEditorCtrl_getNodeWidth(string guimeshroadeditorctrl){ } /// /// ) +/// /// public int GuiMeshRoadEditorCtrl_getSelectedRoad(string guimeshroadeditorctrl){ @@ -12285,6 +17340,7 @@ public int GuiMeshRoadEditorCtrl_getSelectedRoad(string guimeshroadeditorctrl){ } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_matchTerrainToRoad(string guimeshroadeditorctrl){ @@ -12293,6 +17349,7 @@ public void GuiMeshRoadEditorCtrl_matchTerrainToRoad(string guimeshroadeditorct } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_regenerate(string guimeshroadeditorctrl){ @@ -12301,6 +17358,7 @@ public void GuiMeshRoadEditorCtrl_regenerate(string guimeshroadeditorctrl){ } /// /// setMode( String mode ) ) +/// /// public void GuiMeshRoadEditorCtrl_setMode(string guimeshroadeditorctrl, string mode){ @@ -12309,6 +17367,7 @@ public void GuiMeshRoadEditorCtrl_setMode(string guimeshroadeditorctrl, string } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_setNodeDepth(string guimeshroadeditorctrl, float depth){ @@ -12317,6 +17376,7 @@ public void GuiMeshRoadEditorCtrl_setNodeDepth(string guimeshroadeditorctrl, fl } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_setNodeNormal(string guimeshroadeditorctrl, Point3F normal){ @@ -12325,6 +17385,7 @@ public void GuiMeshRoadEditorCtrl_setNodeNormal(string guimeshroadeditorctrl, P } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_setNodePosition(string guimeshroadeditorctrl, Point3F pos){ @@ -12333,6 +17394,7 @@ public void GuiMeshRoadEditorCtrl_setNodePosition(string guimeshroadeditorctrl, } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_setNodeWidth(string guimeshroadeditorctrl, float width){ @@ -12341,6 +17403,7 @@ public void GuiMeshRoadEditorCtrl_setNodeWidth(string guimeshroadeditorctrl, fl } /// /// ), ) +/// /// public void GuiMeshRoadEditorCtrl_setSelectedRoad(string guimeshroadeditorctrl, string objName = ""){ @@ -12353,14 +17416,21 @@ public void GuiMeshRoadEditorCtrl_setSelectedRoad(string guimeshroadeditorctrl, /// public class GuiMessageVectorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMessageVectorCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Push a line onto the back of the list. @param item The GUI element being pushed into the control @tsexample // All messages are stored in this HudMessageVector, the actual // MainChatHud only displays the contents of this vector. new MessageVector(HudMessageVector); // Attach the MessageVector to the chat control chatHud.attach(HudMessageVector); @endtsexample @return Value) +/// @brief Push a line onto the back of the list. +/// +/// @param item The GUI element being pushed into the control +/// +/// @tsexample +/// // All messages are stored in this HudMessageVector, the actual +/// // MainChatHud only displays the contents of this vector. +/// new MessageVector(HudMessageVector); +/// // Attach the MessageVector to the chat control +/// chatHud.attach(HudMessageVector); +/// @endtsexample +/// +/// @return Value) +/// /// public bool attach(string guimessagevectorctrl, string item){ @@ -12368,7 +17438,18 @@ public bool attach(string guimessagevectorctrl, string item){ return m_ts.fnGuiMessageVectorCtrl_attach(guimessagevectorctrl, item); } /// -/// @brief Stop listing messages from the MessageVector previously attached to, if any. Detailed description @param param Description @tsexample // Deatch the MessageVector from HudMessageVector // HudMessageVector will no longer render the text chatHud.detach(); @endtsexample) +/// @brief Stop listing messages from the MessageVector previously attached to, if any. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Deatch the MessageVector from HudMessageVector +/// // HudMessageVector will no longer render the text +/// chatHud.detach(); +/// @endtsexample) +/// /// public void detach(string guimessagevectorctrl){ @@ -12381,14 +17462,9 @@ public void detach(string guimessagevectorctrl){ /// public class GuiMissionAreaCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMissionAreaCtrlObject(ref Omni ts){m_ts = ts;} /// /// @brief Set the MissionArea to edit.) +/// /// public void setMissionArea(string guimissionareactrl, string area){ @@ -12397,6 +17473,7 @@ public void setMissionArea(string guimissionareactrl, string area){ } /// /// @brief Update the terrain bitmap.) +/// /// public void updateTerrain(string guimissionareactrl){ @@ -12409,14 +17486,9 @@ public void updateTerrain(string guimissionareactrl){ /// public class GuiMissionAreaEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMissionAreaEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public string GuiMissionAreaEditorCtrl_getSelectedMissionArea(string guimissionareaeditorctrl){ @@ -12425,6 +17497,7 @@ public string GuiMissionAreaEditorCtrl_getSelectedMissionArea(string guimission } /// /// ), ) +/// /// public void GuiMissionAreaEditorCtrl_setSelectedMissionArea(string guimissionareaeditorctrl, string missionAreaName = ""){ @@ -12437,14 +17510,20 @@ public void GuiMissionAreaEditorCtrl_setSelectedMissionArea(string guimissionar /// public class GuiMLTextCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMLTextCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Appends the text in the control with additional text. Also . @param text New text to append to the existing text. @param reformat If true, the control will also be visually reset (defaults to true). @tsexample // Define new text to add %text = \"New Text to Add\"; // Set reformat boolean %reformat = \"true\"; // Inform the control to add the new text %thisGuiMLTextCtrl.addText(%text,%reformat); @endtsexample @see GuiControl) +/// @brief Appends the text in the control with additional text. Also . +/// @param text New text to append to the existing text. +/// @param reformat If true, the control will also be visually reset (defaults to true). +/// @tsexample +/// // Define new text to add +/// %text = \"New Text to Add\"; +/// // Set reformat boolean +/// %reformat = \"true\"; +/// // Inform the control to add the new text +/// %thisGuiMLTextCtrl.addText(%text,%reformat); +/// @endtsexample +/// @see GuiControl) +/// /// public void addText(string guimltextctrl, string text, bool reformat = true){ @@ -12452,7 +17531,17 @@ public void addText(string guimltextctrl, string text, bool reformat = true){ m_ts.fnGuiMLTextCtrl_addText(guimltextctrl, text, reformat); } /// -/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. @tsexample // Define new text to add %newText = \"BACON!\"; // Add the new text to the control %thisGuiMLTextCtrl.addText(%newText); // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. %thisGuiMLTextCtrl.forceReflow(); @endtsexample @see GuiControl) +/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. +/// @tsexample +/// // Define new text to add +/// %newText = \"BACON!\"; +/// // Add the new text to the control +/// %thisGuiMLTextCtrl.addText(%newText); +/// // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. +/// %thisGuiMLTextCtrl.forceReflow(); +/// @endtsexample +/// @see GuiControl) +/// /// public void forceReflow(string guimltextctrl){ @@ -12460,7 +17549,14 @@ public void forceReflow(string guimltextctrl){ m_ts.fnGuiMLTextCtrl_forceReflow(guimltextctrl); } /// -/// @brief Returns the text from the control, including TorqueML characters. @tsexample // Get the text displayed in the control %controlText = %thisGuiMLTextCtrl.getText(); @endtsexample @return Text string displayed in the control, including any TorqueML characters. @see GuiControl) +/// @brief Returns the text from the control, including TorqueML characters. +/// @tsexample +/// // Get the text displayed in the control +/// %controlText = %thisGuiMLTextCtrl.getText(); +/// @endtsexample +/// @return Text string displayed in the control, including any TorqueML characters. +/// @see GuiControl) +/// /// public string getText(string guimltextctrl){ @@ -12468,7 +17564,13 @@ public string getText(string guimltextctrl){ return m_ts.fnGuiMLTextCtrl_getText(guimltextctrl); } /// -/// @brief Scroll to the bottom of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its bottom %thisGuiMLTextCtrl.scrollToBottom(); @endtsexample @see GuiControl) +/// @brief Scroll to the bottom of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its bottom +/// %thisGuiMLTextCtrl.scrollToBottom(); +/// @endtsexample +/// @see GuiControl) +/// /// public void scrollToBottom(string guimltextctrl){ @@ -12476,7 +17578,17 @@ public void scrollToBottom(string guimltextctrl){ m_ts.fnGuiMLTextCtrl_scrollToBottom(guimltextctrl); } /// -/// @brief Scroll down to a specified tag. Detailed description @param tagID TagID to scroll the control to @tsexample // Define the TagID we want to scroll the control to %tagId = \"4\"; // Inform the GuiMLTextCtrl to scroll to the defined TagID %thisGuiMLTextCtrl.scrollToTag(%tagId); @endtsexample @see GuiControl) +/// @brief Scroll down to a specified tag. +/// Detailed description +/// @param tagID TagID to scroll the control to +/// @tsexample +/// // Define the TagID we want to scroll the control to +/// %tagId = \"4\"; +/// // Inform the GuiMLTextCtrl to scroll to the defined TagID +/// %thisGuiMLTextCtrl.scrollToTag(%tagId); +/// @endtsexample +/// @see GuiControl) +/// /// public void scrollToTag(string guimltextctrl, int tagID){ @@ -12484,7 +17596,13 @@ public void scrollToTag(string guimltextctrl, int tagID){ m_ts.fnGuiMLTextCtrl_scrollToTag(guimltextctrl, tagID); } /// -/// @brief Scroll to the top of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its top %thisGuiMLTextCtrl.scrollToTop(); @endtsexample @see GuiControl) +/// @brief Scroll to the top of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its top +/// %thisGuiMLTextCtrl.scrollToTop(); +/// @endtsexample +/// @see GuiControl) +/// /// public void scrollToTop(string guimltextctrl, int param1, int param2){ @@ -12492,7 +17610,16 @@ public void scrollToTop(string guimltextctrl, int param1, int param2){ m_ts.fnGuiMLTextCtrl_scrollToTop(guimltextctrl, param1, param2); } /// -/// @brief Sets the alpha value of the control. @param alphaVal n - 1.0 floating value for the alpha @tsexample // Define the alphe value %alphaVal = \"0.5\"; // Inform the control to update its alpha value. %thisGuiMLTextCtrl.setAlpha(%alphaVal); @endtsexample @see GuiControl) +/// @brief Sets the alpha value of the control. +/// @param alphaVal n - 1.0 floating value for the alpha +/// @tsexample +/// // Define the alphe value +/// %alphaVal = \"0.5\"; +/// // Inform the control to update its alpha value. +/// %thisGuiMLTextCtrl.setAlpha(%alphaVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void setAlpha(string guimltextctrl, float alphaVal){ @@ -12500,7 +17627,17 @@ public void setAlpha(string guimltextctrl, float alphaVal){ m_ts.fnGuiMLTextCtrl_setAlpha(guimltextctrl, alphaVal); } /// -/// @brief Change the text cursor's position to a new defined offset within the text in the control. @param newPos Offset to place cursor. @tsexample // Define cursor offset position %position = \"23\"; // Inform the GuiMLTextCtrl object to move the cursor to the new position. %thisGuiMLTextCtrl.setCursorPosition(%position); @endtsexample @return Returns true if the cursor position moved, or false if the position was not changed. @see GuiControl) +/// @brief Change the text cursor's position to a new defined offset within the text in the control. +/// @param newPos Offset to place cursor. +/// @tsexample +/// // Define cursor offset position +/// %position = \"23\"; +/// // Inform the GuiMLTextCtrl object to move the cursor to the new position. +/// %thisGuiMLTextCtrl.setCursorPosition(%position); +/// @endtsexample +/// @return Returns true if the cursor position moved, or false if the position was not changed. +/// @see GuiControl) +/// /// public bool setCursorPosition(string guimltextctrl, int newPos){ @@ -12508,7 +17645,16 @@ public bool setCursorPosition(string guimltextctrl, int newPos){ return m_ts.fnGuiMLTextCtrl_setCursorPosition(guimltextctrl, newPos); } /// -/// @brief Set the text contained in the control. @param text The text to display in the control. @tsexample // Define the text to display %text = \"Nifty Control Text\"; // Set the text displayed within the control %thisGuiMLTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Set the text contained in the control. +/// @param text The text to display in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Nifty Control Text\"; +/// // Set the text displayed within the control +/// %thisGuiMLTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void setText(string guimltextctrl, string text){ @@ -12521,12 +17667,6 @@ public void setText(string guimltextctrl, string text){ /// public class GuiNavEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiNavEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) /// @@ -12623,14 +17763,15 @@ public void spawnPlayer(string guinaveditorctrl){ /// public class GuiObjectViewObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiObjectViewObject(ref Omni ts){m_ts = ts;} /// -/// @brief Return the current multiplier for camera zooming and rotation. @tsexample // Request the current camera zooming and rotation multiplier value %multiplier = %thisGuiObjectView.getCameraSpeed(); @endtsexample @return Camera zooming / rotation multiplier value. @see GuiControl) +/// @brief Return the current multiplier for camera zooming and rotation. +/// @tsexample +/// // Request the current camera zooming and rotation multiplier value +/// %multiplier = %thisGuiObjectView.getCameraSpeed(); +/// @endtsexample +/// @return Camera zooming / rotation multiplier value. +/// @see GuiControl) +/// /// public float getCameraSpeed(string guiobjectview){ @@ -12638,7 +17779,14 @@ public float getCameraSpeed(string guiobjectview){ return m_ts.fnGuiObjectView_getCameraSpeed(guiobjectview); } /// -/// @brief Return the model displayed in this view. @tsexample // Request the displayed model name from the GuiObjectView object. %modelName = %thisGuiObjectView.getModel(); @endtsexample @return Name of the displayed model. @see GuiControl) +/// @brief Return the model displayed in this view. +/// @tsexample +/// // Request the displayed model name from the GuiObjectView object. +/// %modelName = %thisGuiObjectView.getModel(); +/// @endtsexample +/// @return Name of the displayed model. +/// @see GuiControl) +/// /// public string getModel(string guiobjectview){ @@ -12646,7 +17794,14 @@ public string getModel(string guiobjectview){ return m_ts.fnGuiObjectView_getModel(guiobjectview); } /// -/// @brief Return the name of the mounted model. @tsexample // Request the name of the mounted model from the GuiObjectView object %mountedModelName = %thisGuiObjectView.getMountedModel(); @endtsexample @return Name of the mounted model. @see GuiControl) +/// @brief Return the name of the mounted model. +/// @tsexample +/// // Request the name of the mounted model from the GuiObjectView object +/// %mountedModelName = %thisGuiObjectView.getMountedModel(); +/// @endtsexample +/// @return Name of the mounted model. +/// @see GuiControl) +/// /// public string getMountedModel(string guiobjectview){ @@ -12654,7 +17809,14 @@ public string getMountedModel(string guiobjectview){ return m_ts.fnGuiObjectView_getMountedModel(guiobjectview); } /// -/// @brief Return the name of skin used on the mounted model. @tsexample // Request the skin name from the model mounted on to the main model in the control %mountModelSkin = %thisGuiObjectView.getMountSkin(); @endtsexample @return Name of the skin used on the mounted model. @see GuiControl) +/// @brief Return the name of skin used on the mounted model. +/// @tsexample +/// // Request the skin name from the model mounted on to the main model in the control +/// %mountModelSkin = %thisGuiObjectView.getMountSkin(); +/// @endtsexample +/// @return Name of the skin used on the mounted model. +/// @see GuiControl) +/// /// public string getMountSkin(string guiobjectview, int param1, int param2){ @@ -12662,7 +17824,14 @@ public string getMountSkin(string guiobjectview, int param1, int param2){ return m_ts.fnGuiObjectView_getMountSkin(guiobjectview, param1, param2); } /// -/// @brief Return the current distance at which the camera orbits the object. @tsexample // Request the current orbit distance %orbitDistance = %thisGuiObjectView.getOrbitDistance(); @endtsexample @return The distance at which the camera orbits the object. @see GuiControl) +/// @brief Return the current distance at which the camera orbits the object. +/// @tsexample +/// // Request the current orbit distance +/// %orbitDistance = %thisGuiObjectView.getOrbitDistance(); +/// @endtsexample +/// @return The distance at which the camera orbits the object. +/// @see GuiControl) +/// /// public float getOrbitDistance(string guiobjectview){ @@ -12670,7 +17839,14 @@ public float getOrbitDistance(string guiobjectview){ return m_ts.fnGuiObjectView_getOrbitDistance(guiobjectview); } /// -/// @brief Return the name of skin used on the primary model. @tsexample // Request the name of the skin used on the primary model in the control %skinName = %thisGuiObjectView.getSkin(); @endtsexample @return Name of the skin used on the primary model. @see GuiControl) +/// @brief Return the name of skin used on the primary model. +/// @tsexample +/// // Request the name of the skin used on the primary model in the control +/// %skinName = %thisGuiObjectView.getSkin(); +/// @endtsexample +/// @return Name of the skin used on the primary model. +/// @see GuiControl) +/// /// public string getSkin(string guiobjectview){ @@ -12678,7 +17854,16 @@ public string getSkin(string guiobjectview){ return m_ts.fnGuiObjectView_getSkin(guiobjectview); } /// -/// @brief Sets the multiplier for the camera rotation and zoom speed. @param factor Multiplier for camera rotation and zoom speed. @tsexample // Set the factor value %factor = \"0.75\"; // Inform the GuiObjectView object to set the camera speed. %thisGuiObjectView.setCameraSpeed(%factor); @endtsexample @see GuiControl) +/// @brief Sets the multiplier for the camera rotation and zoom speed. +/// @param factor Multiplier for camera rotation and zoom speed. +/// @tsexample +/// // Set the factor value +/// %factor = \"0.75\"; +/// // Inform the GuiObjectView object to set the camera speed. +/// %thisGuiObjectView.setCameraSpeed(%factor); +/// @endtsexample +/// @see GuiControl) +/// /// public void setCameraSpeed(string guiobjectview, float factor){ @@ -12686,7 +17871,16 @@ public void setCameraSpeed(string guiobjectview, float factor){ m_ts.fnGuiObjectView_setCameraSpeed(guiobjectview, factor); } /// -/// @brief Set the light ambient color on the sun object used to render the model. @param color Ambient color of sunlight. @tsexample // Define the sun ambient color value %color = \"1.0 0.4 0.6\"; // Inform the GuiObjectView object to set the sun ambient color to the requested value %thisGuiObjectView.setLightAmbient(%color); @endtsexample @see GuiControl) +/// @brief Set the light ambient color on the sun object used to render the model. +/// @param color Ambient color of sunlight. +/// @tsexample +/// // Define the sun ambient color value +/// %color = \"1.0 0.4 0.6\"; +/// // Inform the GuiObjectView object to set the sun ambient color to the requested value +/// %thisGuiObjectView.setLightAmbient(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void setLightAmbient(string guiobjectview, ColorF color){ @@ -12694,7 +17888,16 @@ public void setLightAmbient(string guiobjectview, ColorF color){ m_ts.fnGuiObjectView_setLightAmbient(guiobjectview, color.AsString()); } /// -/// @brief Set the light color on the sun object used to render the model. @param color Color of sunlight. @tsexample // Set the color value for the sun %color = \"1.0 0.4 0.5\"; // Inform the GuiObjectView object to change the sun color to the defined value %thisGuiObjectView.setLightColor(%color); @endtsexample @see GuiControl) +/// @brief Set the light color on the sun object used to render the model. +/// @param color Color of sunlight. +/// @tsexample +/// // Set the color value for the sun +/// %color = \"1.0 0.4 0.5\"; +/// // Inform the GuiObjectView object to change the sun color to the defined value +/// %thisGuiObjectView.setLightColor(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void setLightColor(string guiobjectview, ColorF color){ @@ -12702,7 +17905,16 @@ public void setLightColor(string guiobjectview, ColorF color){ m_ts.fnGuiObjectView_setLightColor(guiobjectview, color.AsString()); } /// -/// @brief Set the light direction from which to light the model. @param direction XYZ direction from which the light will shine on the model @tsexample // Set the light direction %direction = \"1.0 0.2 0.4\" // Inform the GuiObjectView object to change the light direction to the defined value %thisGuiObjectView.setLightDirection(%direction); @endtsexample @see GuiControl) +/// @brief Set the light direction from which to light the model. +/// @param direction XYZ direction from which the light will shine on the model +/// @tsexample +/// // Set the light direction +/// %direction = \"1.0 0.2 0.4\" +/// // Inform the GuiObjectView object to change the light direction to the defined value +/// %thisGuiObjectView.setLightDirection(%direction); +/// @endtsexample +/// @see GuiControl) +/// /// public void setLightDirection(string guiobjectview, Point3F direction){ @@ -12710,7 +17922,16 @@ public void setLightDirection(string guiobjectview, Point3F direction){ m_ts.fnGuiObjectView_setLightDirection(guiobjectview, direction.AsString()); } /// -/// @brief Sets the model to be displayed in this control. @param shapeName Name of the model to display. @tsexample // Define the model we want to display %shapeName = \"gideon.dts\"; // Tell the GuiObjectView object to display the defined model %thisGuiObjectView.setModel(%shapeName); @endtsexample @see GuiControl) +/// @brief Sets the model to be displayed in this control. +/// @param shapeName Name of the model to display. +/// @tsexample +/// // Define the model we want to display +/// %shapeName = \"gideon.dts\"; +/// // Tell the GuiObjectView object to display the defined model +/// %thisGuiObjectView.setModel(%shapeName); +/// @endtsexample +/// @see GuiControl) +/// /// public void setModel(string guiobjectview, string shapeName){ @@ -12718,7 +17939,22 @@ public void setModel(string guiobjectview, string shapeName){ m_ts.fnGuiObjectView_setModel(guiobjectview, shapeName); } /// -/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. Detailed description @param shapeName Name of the model to mount. @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. @tsexample // Set the shapeName to mount %shapeName = \"GideonGlasses.dts\" // Set the mount node of the primary model in the control to mount the new shape at %mountNodeIndexOrName = \"3\"; //OR: %mountNodeIndexOrName = \"Face\"; // Inform the GuiObjectView object to mount the shape at the specified node. %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); @endtsexample @see GuiControl) +/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. +/// Detailed description +/// @param shapeName Name of the model to mount. +/// @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. +/// @tsexample +/// // Set the shapeName to mount +/// %shapeName = \"GideonGlasses.dts\" +/// // Set the mount node of the primary model in the control to mount the new shape at +/// %mountNodeIndexOrName = \"3\"; +/// //OR: +/// %mountNodeIndexOrName = \"Face\"; +/// // Inform the GuiObjectView object to mount the shape at the specified node. +/// %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); +/// @endtsexample +/// @see GuiControl) +/// /// public void setMount(string guiobjectview, string shapeName, string mountNodeIndexOrName){ @@ -12726,7 +17962,16 @@ public void setMount(string guiobjectview, string shapeName, string mountNodeIn m_ts.fnGuiObjectView_setMount(guiobjectview, shapeName, mountNodeIndexOrName); } /// -/// @brief Sets the model to be mounted on the primary model. @param shapeName Name of the model to mount. @tsexample // Define the model name to mount %modelToMount = \"GideonGlasses.dts\"; // Inform the GuiObjectView object to mount the defined model to the existing model in the control %thisGuiObjectView.setMountedModel(%modelToMount); @endtsexample @see GuiControl) +/// @brief Sets the model to be mounted on the primary model. +/// @param shapeName Name of the model to mount. +/// @tsexample +/// // Define the model name to mount +/// %modelToMount = \"GideonGlasses.dts\"; +/// // Inform the GuiObjectView object to mount the defined model to the existing model in the control +/// %thisGuiObjectView.setMountedModel(%modelToMount); +/// @endtsexample +/// @see GuiControl) +/// /// public void setMountedModel(string guiobjectview, string shapeName){ @@ -12734,7 +17979,16 @@ public void setMountedModel(string guiobjectview, string shapeName){ m_ts.fnGuiObjectView_setMountedModel(guiobjectview, shapeName); } /// -/// @brief Sets the skin to use on the mounted model. @param skinName Name of the skin to set on the model mounted to the main model in the control @tsexample // Define the name of the skin %skinName = \"BronzeGlasses\"; // Inform the GuiObjectView Control of the skin to use on the mounted model %thisGuiObjectViewCtrl.setMountSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the mounted model. +/// @param skinName Name of the skin to set on the model mounted to the main model in the control +/// @tsexample +/// // Define the name of the skin +/// %skinName = \"BronzeGlasses\"; +/// // Inform the GuiObjectView Control of the skin to use on the mounted model +/// %thisGuiObjectViewCtrl.setMountSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void setMountSkin(string guiobjectview, string skinName){ @@ -12742,7 +17996,17 @@ public void setMountSkin(string guiobjectview, string skinName){ m_ts.fnGuiObjectView_setMountSkin(guiobjectview, skinName); } /// -/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. Detailed description @param distance The distance to set the orbit to (will be clamped). @tsexample // Define the orbit distance value %orbitDistance = \"1.5\"; // Inform the GuiObjectView object to set the orbit distance to the defined value %thisGuiObjectView.setOrbitDistance(%orbitDistance); @endtsexample @see GuiControl) +/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. +/// Detailed description +/// @param distance The distance to set the orbit to (will be clamped). +/// @tsexample +/// // Define the orbit distance value +/// %orbitDistance = \"1.5\"; +/// // Inform the GuiObjectView object to set the orbit distance to the defined value +/// %thisGuiObjectView.setOrbitDistance(%orbitDistance); +/// @endtsexample +/// @see GuiControl) +/// /// public void setOrbitDistance(string guiobjectview, float distance){ @@ -12750,7 +18014,18 @@ public void setOrbitDistance(string guiobjectview, float distance){ m_ts.fnGuiObjectView_setOrbitDistance(guiobjectview, distance); } /// -/// @brief Sets the animation to play for the viewed object. @param indexOrName The index or name of the animation to play. @tsexample // Set the animation index value, or animation sequence name. %indexVal = \"3\"; //OR: %indexVal = \"idle\"; // Inform the GuiObjectView object to set the animation sequence of the object in the control. %thisGuiObjectVew.setSeq(%indexVal); @endtsexample @see GuiControl) +/// @brief Sets the animation to play for the viewed object. +/// @param indexOrName The index or name of the animation to play. +/// @tsexample +/// // Set the animation index value, or animation sequence name. +/// %indexVal = \"3\"; +/// //OR: +/// %indexVal = \"idle\"; +/// // Inform the GuiObjectView object to set the animation sequence of the object in the control. +/// %thisGuiObjectVew.setSeq(%indexVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSeq(string guiobjectview, string indexOrName){ @@ -12758,7 +18033,16 @@ public void setSeq(string guiobjectview, string indexOrName){ m_ts.fnGuiObjectView_setSeq(guiobjectview, indexOrName); } /// -/// @brief Sets the skin to use on the model being displayed. @param skinName Name of the skin to use. @tsexample // Define the skin we want to apply to the main model in the control %skinName = \"disco_gideon\"; // Inform the GuiObjectView control to update the skin the to defined skin %thisGuiObjectView.setSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the model being displayed. +/// @param skinName Name of the skin to use. +/// @tsexample +/// // Define the skin we want to apply to the main model in the control +/// %skinName = \"disco_gideon\"; +/// // Inform the GuiObjectView control to update the skin the to defined skin +/// %thisGuiObjectView.setSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSkin(string guiobjectview, string skinName){ @@ -12771,14 +18055,10 @@ public void setSkin(string guiobjectview, string skinName){ /// public class GuiPaneControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiPaneControlObject(ref Omni ts){m_ts = ts;} /// -/// Collapse or un-collapse the control. @param collapse True to collapse the control, false to un-collapse it ) +/// Collapse or un-collapse the control. +/// @param collapse True to collapse the control, false to un-collapse it ) +/// /// public void setCollapsed(string guipanecontrol, bool collapse){ @@ -12791,14 +18071,11 @@ public void setCollapsed(string guipanecontrol, bool collapse){ /// public class GuiParticleGraphCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiParticleGraphCtrlObject(ref Omni ts){m_ts = ts;} /// -/// (int plotID, float x, float y, bool setAdded = true;) Add a data point to the given plot. @return) +/// (int plotID, float x, float y, bool setAdded = true;) +/// Add a data point to the given plot. +/// @return) +/// /// public string GuiParticleGraphCtrl_addPlotPoint(string guiparticlegraphctrl, int plotID, float x, float y, bool setAdded = true){ @@ -12806,7 +18083,13 @@ public string GuiParticleGraphCtrl_addPlotPoint(string guiparticlegraphctrl, in return m_ts.fn_GuiParticleGraphCtrl_addPlotPoint(guiparticlegraphctrl, plotID, x, y, setAdded); } /// -/// (int plotID, int i, float x, float y) Change a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Change a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public string GuiParticleGraphCtrl_changePlotPoint(string guiparticlegraphctrl, int plotID, int i, float x, float y){ @@ -12814,7 +18097,10 @@ public string GuiParticleGraphCtrl_changePlotPoint(string guiparticlegraphctrl, return m_ts.fn_GuiParticleGraphCtrl_changePlotPoint(guiparticlegraphctrl, plotID, i, x, y); } /// -/// () Clear all of the graphs. @return No return value) +/// () +/// Clear all of the graphs. +/// @return No return value) +/// /// public void GuiParticleGraphCtrl_clearAllGraphs(string guiparticlegraphctrl){ @@ -12822,7 +18108,10 @@ public void GuiParticleGraphCtrl_clearAllGraphs(string guiparticlegraphctrl){ m_ts.fn_GuiParticleGraphCtrl_clearAllGraphs(guiparticlegraphctrl); } /// -/// (int plotID) Clear the graph of the given plot. @return No return value) +/// (int plotID) +/// Clear the graph of the given plot. +/// @return No return value) +/// /// public void GuiParticleGraphCtrl_clearGraph(string guiparticlegraphctrl, int plotID){ @@ -12830,7 +18119,10 @@ public void GuiParticleGraphCtrl_clearGraph(string guiparticlegraphctrl, int pl m_ts.fn_GuiParticleGraphCtrl_clearGraph(guiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the color of the graph passed. @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// (int plotID) +/// Get the color of the graph passed. +/// @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// /// public string GuiParticleGraphCtrl_getGraphColor(string guiparticlegraphctrl, int plotID){ @@ -12838,7 +18130,10 @@ public string GuiParticleGraphCtrl_getGraphColor(string guiparticlegraphctrl, i return m_ts.fn_GuiParticleGraphCtrl_getGraphColor(guiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the maximum values of the graph ranges. @return Returns the maximum of the range formatted as \"x-max y-max\") +/// (int plotID) +/// Get the maximum values of the graph ranges. +/// @return Returns the maximum of the range formatted as \"x-max y-max\") +/// /// public string GuiParticleGraphCtrl_getGraphMax(string guiparticlegraphctrl, int plotID){ @@ -12846,7 +18141,10 @@ public string GuiParticleGraphCtrl_getGraphMax(string guiparticlegraphctrl, int return m_ts.fn_GuiParticleGraphCtrl_getGraphMax(guiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the minimum values of the graph ranges. @return Returns the minimum of the range formatted as \"x-min y-min\") +/// (int plotID) +/// Get the minimum values of the graph ranges. +/// @return Returns the minimum of the range formatted as \"x-min y-min\") +/// /// public string GuiParticleGraphCtrl_getGraphMin(string guiparticlegraphctrl, int plotID){ @@ -12854,7 +18152,10 @@ public string GuiParticleGraphCtrl_getGraphMin(string guiparticlegraphctrl, int return m_ts.fn_GuiParticleGraphCtrl_getGraphMin(guiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the name of the graph passed. @return Returns the name of the plot) +/// (int plotID) +/// Get the name of the graph passed. +/// @return Returns the name of the plot) +/// /// public string GuiParticleGraphCtrl_getGraphName(string guiparticlegraphctrl, int plotID){ @@ -12862,7 +18163,12 @@ public string GuiParticleGraphCtrl_getGraphName(string guiparticlegraphctrl, in return m_ts.fn_GuiParticleGraphCtrl_getGraphName(guiparticlegraphctrl, plotID); } /// -/// (int plotID, float x, float y) Gets the index of the point passed on the plotID passed (graph ID). @param plotID The plot you wish to check. @param x,y The coordinates of the point to get. @return Returns the index of the point.) +/// (int plotID, float x, float y) +/// Gets the index of the point passed on the plotID passed (graph ID). +/// @param plotID The plot you wish to check. +/// @param x,y The coordinates of the point to get. +/// @return Returns the index of the point.) +/// /// public string GuiParticleGraphCtrl_getPlotIndex(string guiparticlegraphctrl, int plotID, float x, float y){ @@ -12870,7 +18176,10 @@ public string GuiParticleGraphCtrl_getPlotIndex(string guiparticlegraphctrl, in return m_ts.fn_GuiParticleGraphCtrl_getPlotIndex(guiparticlegraphctrl, plotID, x, y); } /// -/// (int plotID, int samples) Get a data point from the plot specified, samples from the start of the graph. @return The data point ID) +/// (int plotID, int samples) +/// Get a data point from the plot specified, samples from the start of the graph. +/// @return The data point ID) +/// /// public string GuiParticleGraphCtrl_getPlotPoint(string guiparticlegraphctrl, int plotID, int samples){ @@ -12878,7 +18187,10 @@ public string GuiParticleGraphCtrl_getPlotPoint(string guiparticlegraphctrl, in return m_ts.fn_GuiParticleGraphCtrl_getPlotPoint(guiparticlegraphctrl, plotID, samples); } /// -/// () Gets the selected Plot (a.k.a. graph). @return The plot's ID.) +/// () +/// Gets the selected Plot (a.k.a. graph). +/// @return The plot's ID.) +/// /// public string GuiParticleGraphCtrl_getSelectedPlot(string guiparticlegraphctrl){ @@ -12886,7 +18198,10 @@ public string GuiParticleGraphCtrl_getSelectedPlot(string guiparticlegraphctrl) return m_ts.fn_GuiParticleGraphCtrl_getSelectedPlot(guiparticlegraphctrl); } /// -/// () Gets the selected Point on the Plot (a.k.a. graph). @return The last selected point ID) +/// () +/// Gets the selected Point on the Plot (a.k.a. graph). +/// @return The last selected point ID) +/// /// public string GuiParticleGraphCtrl_getSelectedPoint(string guiparticlegraphctrl){ @@ -12894,7 +18209,13 @@ public string GuiParticleGraphCtrl_getSelectedPoint(string guiparticlegraphctrl return m_ts.fn_GuiParticleGraphCtrl_getSelectedPoint(guiparticlegraphctrl); } /// -/// (int plotID, int i, float x, float y) Insert a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Insert a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_insertPlotPoint(string guiparticlegraphctrl, int plotID, int i, float x, float y){ @@ -12902,7 +18223,9 @@ public void GuiParticleGraphCtrl_insertPlotPoint(string guiparticlegraphctrl, i m_ts.fn_GuiParticleGraphCtrl_insertPlotPoint(guiparticlegraphctrl, plotID, i, x, y); } /// -/// (int plotID, int samples) @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// (int plotID, int samples) +/// @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// /// public string GuiParticleGraphCtrl_isExistingPoint(string guiparticlegraphctrl, int plotID, int samples){ @@ -12910,7 +18233,10 @@ public string GuiParticleGraphCtrl_isExistingPoint(string guiparticlegraphctrl, return m_ts.fn_GuiParticleGraphCtrl_isExistingPoint(guiparticlegraphctrl, plotID, samples); } /// -/// () This will reset the currently selected point to nothing. @return No return value.) +/// () +/// This will reset the currently selected point to nothing. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_resetSelectedPoint(string guiparticlegraphctrl){ @@ -12918,7 +18244,11 @@ public void GuiParticleGraphCtrl_resetSelectedPoint(string guiparticlegraphctrl m_ts.fn_GuiParticleGraphCtrl_resetSelectedPoint(guiparticlegraphctrl); } /// -/// (bool autoMax) Set whether the max will automatically be set when adding points (ie if you add a value over the current max, the max is increased to that value). @return No return value.) +/// (bool autoMax) +/// Set whether the max will automatically be set when adding points +/// (ie if you add a value over the current max, the max is increased to that value). +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setAutoGraphMax(string guiparticlegraphctrl, bool autoMax){ @@ -12926,7 +18256,10 @@ public void GuiParticleGraphCtrl_setAutoGraphMax(string guiparticlegraphctrl, b m_ts.fn_GuiParticleGraphCtrl_setAutoGraphMax(guiparticlegraphctrl, autoMax); } /// -/// (bool autoRemove) Set whether or not a point should be deleted when you drag another one over it. @return No return value.) +/// (bool autoRemove) +/// Set whether or not a point should be deleted when you drag another one over it. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setAutoRemove(string guiparticlegraphctrl, bool autoRemove){ @@ -12934,7 +18267,10 @@ public void GuiParticleGraphCtrl_setAutoRemove(string guiparticlegraphctrl, boo m_ts.fn_GuiParticleGraphCtrl_setAutoRemove(guiparticlegraphctrl, autoRemove); } /// -/// (int plotID, bool isHidden) Set whether the graph number passed is hidden or not. @return No return value.) +/// (int plotID, bool isHidden) +/// Set whether the graph number passed is hidden or not. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setGraphHidden(string guiparticlegraphctrl, int plotID, bool isHidden){ @@ -12942,7 +18278,12 @@ public void GuiParticleGraphCtrl_setGraphHidden(string guiparticlegraphctrl, in m_ts.fn_GuiParticleGraphCtrl_setGraphHidden(guiparticlegraphctrl, plotID, isHidden); } /// -/// (int plotID, float maxX, float maxY) Set the max values of the graph of plotID. @param plotID The plot to modify @param maxX,maxY The maximum bound of the value range. @return No return value.) +/// (int plotID, float maxX, float maxY) +/// Set the max values of the graph of plotID. +/// @param plotID The plot to modify +/// @param maxX,maxY The maximum bound of the value range. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setGraphMax(string guiparticlegraphctrl, int plotID, float maxX, float maxY){ @@ -12950,7 +18291,12 @@ public void GuiParticleGraphCtrl_setGraphMax(string guiparticlegraphctrl, int p m_ts.fn_GuiParticleGraphCtrl_setGraphMax(guiparticlegraphctrl, plotID, maxX, maxY); } /// -/// (int plotID, float maxX) Set the max X value of the graph of plotID. @param plotID The plot to modify. @param maxX The maximum x value. @return No return Value.) +/// (int plotID, float maxX) +/// Set the max X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxX The maximum x value. +/// @return No return Value.) +/// /// public void GuiParticleGraphCtrl_setGraphMaxX(string guiparticlegraphctrl, int plotID, float maxX){ @@ -12958,7 +18304,12 @@ public void GuiParticleGraphCtrl_setGraphMaxX(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphMaxX(guiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float maxY) Set the max Y value of the graph of plotID. @param plotID The plot to modify. @param maxY The maximum y value. @return No return Value.) +/// (int plotID, float maxY) +/// Set the max Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxY The maximum y value. +/// @return No return Value.) +/// /// public void GuiParticleGraphCtrl_setGraphMaxY(string guiparticlegraphctrl, int plotID, float maxX){ @@ -12966,7 +18317,12 @@ public void GuiParticleGraphCtrl_setGraphMaxY(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphMaxY(guiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float minX, float minY) Set the min values of the graph of plotID. @param plotID The plot to modify @param minX,minY The minimum bound of the value range. @return No return value.) +/// (int plotID, float minX, float minY) +/// Set the min values of the graph of plotID. +/// @param plotID The plot to modify +/// @param minX,minY The minimum bound of the value range. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setGraphMin(string guiparticlegraphctrl, int plotID, float minX, float minY){ @@ -12974,7 +18330,12 @@ public void GuiParticleGraphCtrl_setGraphMin(string guiparticlegraphctrl, int p m_ts.fn_GuiParticleGraphCtrl_setGraphMin(guiparticlegraphctrl, plotID, minX, minY); } /// -/// (int plotID, float minX) Set the min X value of the graph of plotID. @param plotID The plot to modify. @param minX The minimum x value. @return No return Value.) +/// (int plotID, float minX) +/// Set the min X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minX The minimum x value. +/// @return No return Value.) +/// /// public void GuiParticleGraphCtrl_setGraphMinX(string guiparticlegraphctrl, int plotID, float minX){ @@ -12982,7 +18343,12 @@ public void GuiParticleGraphCtrl_setGraphMinX(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphMinX(guiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, float minY) Set the min Y value of the graph of plotID. @param plotID The plot to modify. @param minY The minimum y value. @return No return Value.) +/// (int plotID, float minY) +/// Set the min Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minY The minimum y value. +/// @return No return Value.) +/// /// public void GuiParticleGraphCtrl_setGraphMinY(string guiparticlegraphctrl, int plotID, float minX){ @@ -12990,7 +18356,12 @@ public void GuiParticleGraphCtrl_setGraphMinY(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphMinY(guiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, string graphName) Set the name of the given plot. @param plotID The plot to modify. @param graphName The name to set on the plot. @return No return value.) +/// (int plotID, string graphName) +/// Set the name of the given plot. +/// @param plotID The plot to modify. +/// @param graphName The name to set on the plot. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setGraphName(string guiparticlegraphctrl, int plotID, string graphName){ @@ -12998,7 +18369,10 @@ public void GuiParticleGraphCtrl_setGraphName(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphName(guiparticlegraphctrl, plotID, graphName); } /// -/// (bool clamped) Set whether the x position of the selected graph point should be clamped @return No return value.) +/// (bool clamped) +/// Set whether the x position of the selected graph point should be clamped +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setPointXMovementClamped(string guiparticlegraphctrl, bool autoRemove){ @@ -13006,7 +18380,10 @@ public void GuiParticleGraphCtrl_setPointXMovementClamped(string guiparticlegra m_ts.fn_GuiParticleGraphCtrl_setPointXMovementClamped(guiparticlegraphctrl, autoRemove); } /// -/// (bool renderAll) Set whether or not a position should be rendered on every point or just the last selected. @return No return value.) +/// (bool renderAll) +/// Set whether or not a position should be rendered on every point or just the last selected. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setRenderAll(string guiparticlegraphctrl, bool autoRemove){ @@ -13014,7 +18391,10 @@ public void GuiParticleGraphCtrl_setRenderAll(string guiparticlegraphctrl, bool m_ts.fn_GuiParticleGraphCtrl_setRenderAll(guiparticlegraphctrl, autoRemove); } /// -/// (bool renderGraphTooltip) Set whether or not to render the graph tooltip. @return No return value.) +/// (bool renderGraphTooltip) +/// Set whether or not to render the graph tooltip. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setRenderGraphTooltip(string guiparticlegraphctrl, bool autoRemove){ @@ -13022,7 +18402,10 @@ public void GuiParticleGraphCtrl_setRenderGraphTooltip(string guiparticlegraphc m_ts.fn_GuiParticleGraphCtrl_setRenderGraphTooltip(guiparticlegraphctrl, autoRemove); } /// -/// (int plotID) Set the selected plot (a.k.a. graph). @return No return value ) +/// (int plotID) +/// Set the selected plot (a.k.a. graph). +/// @return No return value ) +/// /// public void GuiParticleGraphCtrl_setSelectedPlot(string guiparticlegraphctrl, int plotID){ @@ -13030,7 +18413,10 @@ public void GuiParticleGraphCtrl_setSelectedPlot(string guiparticlegraphctrl, i m_ts.fn_GuiParticleGraphCtrl_setSelectedPlot(guiparticlegraphctrl, plotID); } /// -/// (int point) Set the selected point on the graph. @return No return value) +/// (int point) +/// Set the selected point on the graph. +/// @return No return value) +/// /// public void GuiParticleGraphCtrl_setSelectedPoint(string guiparticlegraphctrl, int point){ @@ -13043,14 +18429,9 @@ public void GuiParticleGraphCtrl_setSelectedPoint(string guiparticlegraphctrl, /// public class GuiPopUpMenuCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiPopUpMenuCtrlObject(ref Omni ts){m_ts = ts;} /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void GuiPopUpMenuCtrl_add(string guipopupmenuctrl, string name = "", int idNum = -1, uint scheme = 0){ @@ -13059,6 +18440,7 @@ public void GuiPopUpMenuCtrl_add(string guipopupmenuctrl, string name = "", int } /// /// (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void GuiPopUpMenuCtrl_addScheme(string guipopupmenuctrl, uint id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL){ @@ -13067,6 +18449,7 @@ public void GuiPopUpMenuCtrl_addScheme(string guipopupmenuctrl, uint id, ColorI } /// /// ( int id, string text ) ) +/// /// public void GuiPopUpMenuCtrl_changeTextById(string guipopupmenuctrl, int id, string text){ @@ -13075,6 +18458,7 @@ public void GuiPopUpMenuCtrl_changeTextById(string guipopupmenuctrl, int id, st } /// /// Clear the popup list.) +/// /// public void GuiPopUpMenuCtrl_clear(string guipopupmenuctrl){ @@ -13083,6 +18467,7 @@ public void GuiPopUpMenuCtrl_clear(string guipopupmenuctrl){ } /// /// (S32 entry)) +/// /// public void GuiPopUpMenuCtrl_clearEntry(string guipopupmenuctrl, int entry){ @@ -13090,7 +18475,9 @@ public void GuiPopUpMenuCtrl_clearEntry(string guipopupmenuctrl, int entry){ m_ts.fn_GuiPopUpMenuCtrl_clearEntry(guipopupmenuctrl, entry); } /// -/// (string text) Returns the position of the first entry containing the specified text.) +/// (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int GuiPopUpMenuCtrl_findText(string guipopupmenuctrl, string text){ @@ -13099,6 +18486,7 @@ public int GuiPopUpMenuCtrl_findText(string guipopupmenuctrl, string text){ } /// /// ) +/// /// public void GuiPopUpMenuCtrl_forceClose(string guipopupmenuctrl){ @@ -13107,6 +18495,7 @@ public void GuiPopUpMenuCtrl_forceClose(string guipopupmenuctrl){ } /// /// ) +/// /// public void GuiPopUpMenuCtrl_forceOnAction(string guipopupmenuctrl){ @@ -13115,6 +18504,7 @@ public void GuiPopUpMenuCtrl_forceOnAction(string guipopupmenuctrl){ } /// /// ) +/// /// public int GuiPopUpMenuCtrl_getSelected(string guipopupmenuctrl){ @@ -13123,6 +18513,7 @@ public int GuiPopUpMenuCtrl_getSelected(string guipopupmenuctrl){ } /// /// ) +/// /// public string GuiPopUpMenuCtrl_getText(string guipopupmenuctrl){ @@ -13131,6 +18522,7 @@ public string GuiPopUpMenuCtrl_getText(string guipopupmenuctrl){ } /// /// (int id)) +/// /// public string GuiPopUpMenuCtrl_getTextById(string guipopupmenuctrl, int id){ @@ -13139,6 +18531,7 @@ public string GuiPopUpMenuCtrl_getTextById(string guipopupmenuctrl, int id){ } /// /// (bool doReplaceText)) +/// /// public void GuiPopUpMenuCtrl_replaceText(string guipopupmenuctrl, bool doReplaceText){ @@ -13146,7 +18539,11 @@ public void GuiPopUpMenuCtrl_replaceText(string guipopupmenuctrl, bool doReplac m_ts.fn_GuiPopUpMenuCtrl_replaceText(guipopupmenuctrl, doReplaceText); } /// -/// (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void GuiPopUpMenuCtrl_setEnumContent(string guipopupmenuctrl, string className, string enumName){ @@ -13155,6 +18552,7 @@ public void GuiPopUpMenuCtrl_setEnumContent(string guipopupmenuctrl, string cla } /// /// ([scriptCallback=true])) +/// /// public void GuiPopUpMenuCtrl_setFirstSelected(string guipopupmenuctrl, bool scriptCallback = true){ @@ -13163,6 +18561,7 @@ public void GuiPopUpMenuCtrl_setFirstSelected(string guipopupmenuctrl, bool scr } /// /// ) +/// /// public void GuiPopUpMenuCtrl_setNoneSelected(string guipopupmenuctrl){ @@ -13171,6 +18570,7 @@ public void GuiPopUpMenuCtrl_setNoneSelected(string guipopupmenuctrl){ } /// /// (int id, [scriptCallback=true])) +/// /// public void GuiPopUpMenuCtrl_setSelected(string guipopupmenuctrl, int id, bool scriptCallback = true){ @@ -13179,6 +18579,7 @@ public void GuiPopUpMenuCtrl_setSelected(string guipopupmenuctrl, int id, bool } /// /// Get the size of the menu - the number of entries in it.) +/// /// public int GuiPopUpMenuCtrl_size(string guipopupmenuctrl){ @@ -13187,6 +18588,7 @@ public int GuiPopUpMenuCtrl_size(string guipopupmenuctrl){ } /// /// Sort the list alphabetically.) +/// /// public void GuiPopUpMenuCtrl_sort(string guipopupmenuctrl){ @@ -13195,6 +18597,7 @@ public void GuiPopUpMenuCtrl_sort(string guipopupmenuctrl){ } /// /// Sort the list by ID.) +/// /// public void GuiPopUpMenuCtrl_sortID(string guipopupmenuctrl){ @@ -13207,14 +18610,9 @@ public void GuiPopUpMenuCtrl_sortID(string guipopupmenuctrl){ /// public class GuiPopUpMenuCtrlExObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiPopUpMenuCtrlExObject(ref Omni ts){m_ts = ts;} /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void GuiPopUpMenuCtrlEx_add(string guipopupmenuctrlex, string name = "", int idNum = -1, uint scheme = 0){ @@ -13223,6 +18621,7 @@ public void GuiPopUpMenuCtrlEx_add(string guipopupmenuctrlex, string name = "", } /// /// (S32 entry)) +/// /// public void GuiPopUpMenuCtrlEx_clearEntry(string guipopupmenuctrlex, int entry){ @@ -13230,7 +18629,11 @@ public void GuiPopUpMenuCtrlEx_clearEntry(string guipopupmenuctrlex, int entry) m_ts.fn_GuiPopUpMenuCtrlEx_clearEntry(guipopupmenuctrlex, entry); } /// -/// (string text) Returns the id of the first entry containing the specified text or -1 if not found. @param text String value used for the query @return Numerical ID of entry containing the text.) +/// (string text) +/// Returns the id of the first entry containing the specified text or -1 if not found. +/// @param text String value used for the query +/// @return Numerical ID of entry containing the text.) +/// /// public int GuiPopUpMenuCtrlEx_findText(string guipopupmenuctrlex, string text){ @@ -13238,7 +18641,10 @@ public int GuiPopUpMenuCtrlEx_findText(string guipopupmenuctrlex, string text){ return m_ts.fn_GuiPopUpMenuCtrlEx_findText(guipopupmenuctrlex, text); } /// -/// @brief Get color of an entry's box @param id ID number of entry to query @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// @brief Get color of an entry's box +/// @param id ID number of entry to query +/// @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// /// public ColorI GuiPopUpMenuCtrlEx_getColorById(string guipopupmenuctrlex, int id){ @@ -13246,7 +18652,9 @@ public ColorI GuiPopUpMenuCtrlEx_getColorById(string guipopupmenuctrlex, int id return new ColorI ( m_ts.fn_GuiPopUpMenuCtrlEx_getColorById(guipopupmenuctrlex, id)); } /// -/// @brief Flag that causes each new text addition to replace the current entry @param True to turn on replacing, false to disable it) +/// @brief Flag that causes each new text addition to replace the current entry +/// @param True to turn on replacing, false to disable it) +/// /// public void GuiPopUpMenuCtrlEx_replaceText(string guipopupmenuctrlex, int boolVal){ @@ -13254,7 +18662,12 @@ public void GuiPopUpMenuCtrlEx_replaceText(string guipopupmenuctrlex, int boolV m_ts.fn_GuiPopUpMenuCtrlEx_replaceText(guipopupmenuctrlex, boolVal); } /// -/// @brief This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away. @param class Name of the class containing the enum @param enum Name of the enum value to acces) +/// @brief This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away. +/// @param class Name of the class containing the enum +/// @param enum Name of the enum value to acces) +/// /// public void GuiPopUpMenuCtrlEx_setEnumContent(string guipopupmenuctrlex, string className, string enumName){ @@ -13262,7 +18675,9 @@ public void GuiPopUpMenuCtrlEx_setEnumContent(string guipopupmenuctrlex, string m_ts.fn_GuiPopUpMenuCtrlEx_setEnumContent(guipopupmenuctrlex, className, enumName); } /// -/// ([scriptCallback=true]) @hide) +/// ([scriptCallback=true]) +/// @hide) +/// /// public void GuiPopUpMenuCtrlEx_setFirstSelected(string guipopupmenuctrlex, bool scriptCallback = true){ @@ -13270,7 +18685,9 @@ public void GuiPopUpMenuCtrlEx_setFirstSelected(string guipopupmenuctrlex, bool m_ts.fn_GuiPopUpMenuCtrlEx_setFirstSelected(guipopupmenuctrlex, scriptCallback); } /// -/// (int id, [scriptCallback=true]) @hide) +/// (int id, [scriptCallback=true]) +/// @hide) +/// /// public void GuiPopUpMenuCtrlEx_setSelected(string guipopupmenuctrlex, int id, bool scriptCallback = true){ @@ -13278,7 +18695,9 @@ public void GuiPopUpMenuCtrlEx_setSelected(string guipopupmenuctrlex, int id, b m_ts.fn_GuiPopUpMenuCtrlEx_setSelected(guipopupmenuctrlex, id, scriptCallback); } /// -/// @brief Get the size of the menu @return Number of entries in the menu) +/// @brief Get the size of the menu +/// @return Number of entries in the menu) +/// /// public int GuiPopUpMenuCtrlEx_size(string guipopupmenuctrlex){ @@ -13286,7 +18705,12 @@ public int GuiPopUpMenuCtrlEx_size(string guipopupmenuctrlex){ return m_ts.fn_GuiPopUpMenuCtrlEx_size(guipopupmenuctrlex); } /// -/// @brief Add a category to the list. Acts as a separator between entries, allowing for sub-lists @param text Name of the new category) +/// @brief Add a category to the list. +/// +/// Acts as a separator between entries, allowing for sub-lists +/// +/// @param text Name of the new category) +/// /// public void addCategory(string guipopupmenuctrlex, string text){ @@ -13294,7 +18718,12 @@ public void addCategory(string guipopupmenuctrlex, string text){ m_ts.fnGuiPopUpMenuCtrlEx_addCategory(guipopupmenuctrlex, text); } /// -/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. @param id Numerical id associated with this scheme @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. +/// @param id Numerical id associated with this scheme +/// @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// /// public void addScheme(string guipopupmenuctrlex, int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL){ @@ -13303,6 +18732,7 @@ public void addScheme(string guipopupmenuctrlex, int id, ColorI fontColor, Colo } /// /// @brief Clear the popup list.) +/// /// public void clear(string guipopupmenuctrlex){ @@ -13311,6 +18741,7 @@ public void clear(string guipopupmenuctrlex){ } /// /// @brief Manually force this control to collapse and close.) +/// /// public void forceClose(string guipopupmenuctrlex){ @@ -13319,6 +18750,7 @@ public void forceClose(string guipopupmenuctrlex){ } /// /// @brief Manually for the onAction function, which updates everything in this control.) +/// /// public void forceOnAction(string guipopupmenuctrlex){ @@ -13326,7 +18758,9 @@ public void forceOnAction(string guipopupmenuctrlex){ m_ts.fnGuiPopUpMenuCtrlEx_forceOnAction(guipopupmenuctrlex); } /// -/// @brief Get the current selection of the menu. @return Returns the ID of the currently selected entry) +/// @brief Get the current selection of the menu. +/// @return Returns the ID of the currently selected entry) +/// /// public int getSelected(string guipopupmenuctrlex){ @@ -13334,7 +18768,19 @@ public int getSelected(string guipopupmenuctrlex){ return m_ts.fnGuiPopUpMenuCtrlEx_getSelected(guipopupmenuctrlex); } /// -/// @brief Get the. Detailed description @param param Description @tsexample // Comment code(); @endtsexample @return Returns current text in string format) +/// @brief Get the. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Comment +/// code(); +/// @endtsexample +/// +/// @return Returns current text in string format) +/// /// public string getText(string guipopupmenuctrlex){ @@ -13342,7 +18788,10 @@ public string getText(string guipopupmenuctrlex){ return m_ts.fnGuiPopUpMenuCtrlEx_getText(guipopupmenuctrlex); } /// -/// @brief Get the text of an entry based on an ID. @param id The ID assigned to the entry being queried @return String contained by the specified entry, NULL if empty or bad ID) +/// @brief Get the text of an entry based on an ID. +/// @param id The ID assigned to the entry being queried +/// @return String contained by the specified entry, NULL if empty or bad ID) +/// /// public string getTextById(string guipopupmenuctrlex, int id){ @@ -13351,6 +18800,7 @@ public string getTextById(string guipopupmenuctrlex, int id){ } /// /// @brief Clears selection in the menu.) +/// /// public void setNoneSelected(string guipopupmenuctrlex, int param){ @@ -13358,7 +18808,9 @@ public void setNoneSelected(string guipopupmenuctrlex, int param){ m_ts.fnGuiPopUpMenuCtrlEx_setNoneSelected(guipopupmenuctrlex, param); } /// -/// @brief Set the current text to a specified value. @param text String containing new text to set) +/// @brief Set the current text to a specified value. +/// @param text String containing new text to set) +/// /// public void setText(string guipopupmenuctrlex, string text){ @@ -13367,6 +18819,7 @@ public void setText(string guipopupmenuctrlex, string text){ } /// /// @brief Sort the list alphabetically.) +/// /// public void sort(string guipopupmenuctrlex){ @@ -13375,6 +18828,7 @@ public void sort(string guipopupmenuctrlex){ } /// /// @brief Sort the list by ID.) +/// /// public void sortID(string guipopupmenuctrlex){ @@ -13387,14 +18841,12 @@ public void sortID(string guipopupmenuctrlex){ /// public class GuiProgressBitmapCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiProgressBitmapCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Set the bitmap to use for rendering the progress bar. @param filename ~Path to the bitmap file. @note Directly assign to #bitmap rather than using this method. @see GuiProgressBitmapCtrl::setBitmap ) +/// Set the bitmap to use for rendering the progress bar. +/// @param filename ~Path to the bitmap file. +/// @note Directly assign to #bitmap rather than using this method. +/// @see GuiProgressBitmapCtrl::setBitmap ) +/// /// public void setBitmap(string guiprogressbitmapctrl, string filename){ @@ -13407,14 +18859,9 @@ public void setBitmap(string guiprogressbitmapctrl, string filename){ /// public class GuiRiverEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiRiverEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// deleteNode() ) +/// /// public void GuiRiverEditorCtrl_deleteNode(string guirivereditorctrl){ @@ -13423,6 +18870,7 @@ public void GuiRiverEditorCtrl_deleteNode(string guirivereditorctrl){ } /// /// ) +/// /// public string GuiRiverEditorCtrl_getMode(string guirivereditorctrl){ @@ -13431,6 +18879,7 @@ public string GuiRiverEditorCtrl_getMode(string guirivereditorctrl){ } /// /// ) +/// /// public float GuiRiverEditorCtrl_getNodeDepth(string guirivereditorctrl){ @@ -13439,6 +18888,7 @@ public float GuiRiverEditorCtrl_getNodeDepth(string guirivereditorctrl){ } /// /// ) +/// /// public Point3F GuiRiverEditorCtrl_getNodeNormal(string guirivereditorctrl){ @@ -13447,6 +18897,7 @@ public Point3F GuiRiverEditorCtrl_getNodeNormal(string guirivereditorctrl){ } /// /// ) +/// /// public Point3F GuiRiverEditorCtrl_getNodePosition(string guirivereditorctrl){ @@ -13455,6 +18906,7 @@ public Point3F GuiRiverEditorCtrl_getNodePosition(string guirivereditorctrl){ } /// /// ) +/// /// public float GuiRiverEditorCtrl_getNodeWidth(string guirivereditorctrl){ @@ -13463,6 +18915,7 @@ public float GuiRiverEditorCtrl_getNodeWidth(string guirivereditorctrl){ } /// /// ) +/// /// public int GuiRiverEditorCtrl_getSelectedRiver(string guirivereditorctrl){ @@ -13471,6 +18924,7 @@ public int GuiRiverEditorCtrl_getSelectedRiver(string guirivereditorctrl){ } /// /// ) +/// /// public void GuiRiverEditorCtrl_regenerate(string guirivereditorctrl){ @@ -13479,6 +18933,7 @@ public void GuiRiverEditorCtrl_regenerate(string guirivereditorctrl){ } /// /// setMode( String mode ) ) +/// /// public void GuiRiverEditorCtrl_setMode(string guirivereditorctrl, string mode){ @@ -13487,6 +18942,7 @@ public void GuiRiverEditorCtrl_setMode(string guirivereditorctrl, string mode){ } /// /// ) +/// /// public void GuiRiverEditorCtrl_setNodeDepth(string guirivereditorctrl, float depth){ @@ -13495,6 +18951,7 @@ public void GuiRiverEditorCtrl_setNodeDepth(string guirivereditorctrl, float de } /// /// ) +/// /// public void GuiRiverEditorCtrl_setNodeNormal(string guirivereditorctrl, Point3F normal){ @@ -13503,6 +18960,7 @@ public void GuiRiverEditorCtrl_setNodeNormal(string guirivereditorctrl, Point3F } /// /// ) +/// /// public void GuiRiverEditorCtrl_setNodePosition(string guirivereditorctrl, Point3F pos){ @@ -13511,6 +18969,7 @@ public void GuiRiverEditorCtrl_setNodePosition(string guirivereditorctrl, Point } /// /// ) +/// /// public void GuiRiverEditorCtrl_setNodeWidth(string guirivereditorctrl, float width){ @@ -13519,6 +18978,7 @@ public void GuiRiverEditorCtrl_setNodeWidth(string guirivereditorctrl, float wi } /// /// ), ) +/// /// public void GuiRiverEditorCtrl_setSelectedRiver(string guirivereditorctrl, string objName = ""){ @@ -13531,14 +18991,9 @@ public void GuiRiverEditorCtrl_setSelectedRiver(string guirivereditorctrl, stri /// public class GuiRoadEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiRoadEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// deleteNode() ) +/// /// public void GuiRoadEditorCtrl_deleteNode(string guiroadeditorctrl){ @@ -13547,6 +19002,7 @@ public void GuiRoadEditorCtrl_deleteNode(string guiroadeditorctrl){ } /// /// ) +/// /// public void GuiRoadEditorCtrl_deleteRoad(string guiroadeditorctrl){ @@ -13555,6 +19011,7 @@ public void GuiRoadEditorCtrl_deleteRoad(string guiroadeditorctrl){ } /// /// ) +/// /// public string GuiRoadEditorCtrl_getMode(string guiroadeditorctrl){ @@ -13563,6 +19020,7 @@ public string GuiRoadEditorCtrl_getMode(string guiroadeditorctrl){ } /// /// ) +/// /// public Point3F GuiRoadEditorCtrl_getNodePosition(string guiroadeditorctrl){ @@ -13571,6 +19029,7 @@ public Point3F GuiRoadEditorCtrl_getNodePosition(string guiroadeditorctrl){ } /// /// ) +/// /// public float GuiRoadEditorCtrl_getNodeWidth(string guiroadeditorctrl){ @@ -13579,6 +19038,7 @@ public float GuiRoadEditorCtrl_getNodeWidth(string guiroadeditorctrl){ } /// /// ) +/// /// public int GuiRoadEditorCtrl_getSelectedNode(string guiroadeditorctrl){ @@ -13587,6 +19047,7 @@ public int GuiRoadEditorCtrl_getSelectedNode(string guiroadeditorctrl){ } /// /// ) +/// /// public int GuiRoadEditorCtrl_getSelectedRoad(string guiroadeditorctrl){ @@ -13595,6 +19056,7 @@ public int GuiRoadEditorCtrl_getSelectedRoad(string guiroadeditorctrl){ } /// /// setMode( String mode ) ) +/// /// public void GuiRoadEditorCtrl_setMode(string guiroadeditorctrl, string mode){ @@ -13603,6 +19065,7 @@ public void GuiRoadEditorCtrl_setMode(string guiroadeditorctrl, string mode){ } /// /// ) +/// /// public void GuiRoadEditorCtrl_setNodePosition(string guiroadeditorctrl, Point3F pos){ @@ -13611,6 +19074,7 @@ public void GuiRoadEditorCtrl_setNodePosition(string guiroadeditorctrl, Point3F } /// /// ) +/// /// public void GuiRoadEditorCtrl_setNodeWidth(string guiroadeditorctrl, float width){ @@ -13619,6 +19083,7 @@ public void GuiRoadEditorCtrl_setNodeWidth(string guiroadeditorctrl, float widt } /// /// ), ) +/// /// public void GuiRoadEditorCtrl_setSelectedRoad(string guiroadeditorctrl, string pathRoad = ""){ @@ -13631,14 +19096,10 @@ public void GuiRoadEditorCtrl_setSelectedRoad(string guiroadeditorctrl, string /// public class GuiRolloutCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiRolloutCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. +/// @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// /// public void collapse(string guirolloutctrl){ @@ -13646,7 +19107,9 @@ public void collapse(string guirolloutctrl){ m_ts.fnGuiRolloutCtrl_collapse(guirolloutctrl); } /// -/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. +/// @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// /// public void expand(string guirolloutctrl){ @@ -13655,6 +19118,7 @@ public void expand(string guirolloutctrl){ } /// /// Instantly collapse the rollout without animation. To smoothly slide the rollout to collapsed state, use collapse(). ) +/// /// public void instantCollapse(string guirolloutctrl){ @@ -13663,6 +19127,7 @@ public void instantCollapse(string guirolloutctrl){ } /// /// Instantly expand the rollout without animation. To smoothly slide the rollout to expanded state, use expand(). ) +/// /// public void instantExpand(string guirolloutctrl){ @@ -13670,7 +19135,9 @@ public void instantExpand(string guirolloutctrl){ m_ts.fnGuiRolloutCtrl_instantExpand(guirolloutctrl); } /// -/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. @return True if the rollout is expanded, false if not. ) +/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. +/// @return True if the rollout is expanded, false if not. ) +/// /// public bool isExpanded(string guirolloutctrl){ @@ -13678,7 +19145,9 @@ public bool isExpanded(string guirolloutctrl){ return m_ts.fnGuiRolloutCtrl_isExpanded(guirolloutctrl); } /// -/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of the rollout size. ) +/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of +/// the rollout size. ) +/// /// public void sizeToContents(string guirolloutctrl){ @@ -13686,7 +19155,9 @@ public void sizeToContents(string guirolloutctrl){ m_ts.fnGuiRolloutCtrl_sizeToContents(guirolloutctrl); } /// -/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. ) +/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. ) +/// /// public void toggleCollapse(string guirolloutctrl){ @@ -13694,7 +19165,11 @@ public void toggleCollapse(string guirolloutctrl){ m_ts.fnGuiRolloutCtrl_toggleCollapse(guirolloutctrl); } /// -/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will smoothly slide into the opposite state. ) +/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. +/// @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will +/// smoothly slide into the opposite state. ) +/// /// public void toggleExpanded(string guirolloutctrl, bool instantly = false){ @@ -13707,14 +19182,9 @@ public void toggleExpanded(string guirolloutctrl, bool instantly = false){ /// public class GuiScrollCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiScrollCtrlObject(ref Omni ts){m_ts = ts;} /// /// Refresh sizing and positioning of child controls. ) +/// /// public void computeSizes(string guiscrollctrl){ @@ -13722,7 +19192,9 @@ public void computeSizes(string guiscrollctrl){ m_ts.fnGuiScrollCtrl_computeSizes(guiscrollctrl); } /// -/// Get the current coordinates of the scrolled content. @return The current position of the scrolled content. ) +/// Get the current coordinates of the scrolled content. +/// @return The current position of the scrolled content. ) +/// /// public Point2I getScrollPosition(string guiscrollctrl){ @@ -13730,7 +19202,9 @@ public Point2I getScrollPosition(string guiscrollctrl){ return new Point2I ( m_ts.fnGuiScrollCtrl_getScrollPosition(guiscrollctrl)); } /// -/// Get the current X coordinate of the scrolled content. @return The current X coordinate of the scrolled content. ) +/// Get the current X coordinate of the scrolled content. +/// @return The current X coordinate of the scrolled content. ) +/// /// public int getScrollPositionX(string guiscrollctrl){ @@ -13738,7 +19212,9 @@ public int getScrollPositionX(string guiscrollctrl){ return m_ts.fnGuiScrollCtrl_getScrollPositionX(guiscrollctrl); } /// -/// Get the current Y coordinate of the scrolled content. @return The current Y coordinate of the scrolled content. ) +/// Get the current Y coordinate of the scrolled content. +/// @return The current Y coordinate of the scrolled content. ) +/// /// public int getScrollPositionY(string guiscrollctrl){ @@ -13747,6 +19223,7 @@ public int getScrollPositionY(string guiscrollctrl){ } /// /// Scroll all the way to the bottom of the vertical scrollbar and the left of the horizontal bar. ) +/// /// public void scrollToBottom(string guiscrollctrl){ @@ -13754,7 +19231,9 @@ public void scrollToBottom(string guiscrollctrl){ m_ts.fnGuiScrollCtrl_scrollToBottom(guiscrollctrl); } /// -/// Scroll the control so that the given child @a control is visible. @param control A child control. ) +/// Scroll the control so that the given child @a control is visible. +/// @param control A child control. ) +/// /// public void scrollToObject(string guiscrollctrl, string control){ @@ -13763,6 +19242,7 @@ public void scrollToObject(string guiscrollctrl, string control){ } /// /// Scroll all the way to the top of the vertical and left of the horizontal scrollbar. ) +/// /// public void scrollToTop(string guiscrollctrl){ @@ -13770,7 +19250,10 @@ public void scrollToTop(string guiscrollctrl){ m_ts.fnGuiScrollCtrl_scrollToTop(guiscrollctrl); } /// -/// Set the position of the scrolled content. @param x Position on X axis. @param y Position on y axis. ) +/// Set the position of the scrolled content. +/// @param x Position on X axis. +/// @param y Position on y axis. ) +/// /// public void setScrollPosition(string guiscrollctrl, int x, int y){ @@ -13783,14 +19266,9 @@ public void setScrollPosition(string guiscrollctrl, int x, int y){ /// public class GuiShapeEdPreviewObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiShapeEdPreviewObject(ref Omni ts){m_ts = ts;} /// /// Add a new thread (initially without any sequence set) ) +/// /// public void addThread(string guishapeedpreview){ @@ -13798,7 +19276,9 @@ public void addThread(string guishapeedpreview){ m_ts.fnGuiShapeEdPreview_addThread(guishapeedpreview); } /// -/// Compute the bounding box of the shape using the current detail and node transforms @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// Compute the bounding box of the shape using the current detail and node transforms +/// @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// /// public Box3F computeShapeBounds(string guishapeedpreview){ @@ -13806,7 +19286,11 @@ public Box3F computeShapeBounds(string guishapeedpreview){ return new Box3F ( m_ts.fnGuiShapeEdPreview_computeShapeBounds(guishapeedpreview)); } /// -/// Export the current shape and all mounted objects to COLLADA (.dae). Note that animation is not exported, and all geometry is combined into a single mesh. @param path Destination filename ) +/// Export the current shape and all mounted objects to COLLADA (.dae). +/// Note that animation is not exported, and all geometry is combined into a +/// single mesh. +/// @param path Destination filename ) +/// /// public void exportToCollada(string guishapeedpreview, string path){ @@ -13815,6 +19299,7 @@ public void exportToCollada(string guishapeedpreview, string path){ } /// /// Adjust the camera position and zoom to fit the shape within the view. ) +/// /// public void fitToShape(string guishapeedpreview){ @@ -13823,6 +19308,7 @@ public void fitToShape(string guishapeedpreview){ } /// /// Return whether the named object is currently hidden ) +/// /// public bool getMeshHidden(string guishapeedpreview, string name){ @@ -13830,7 +19316,10 @@ public bool getMeshHidden(string guishapeedpreview, string name){ return m_ts.fnGuiShapeEdPreview_getMeshHidden(guishapeedpreview, name); } /// -/// Get the playback direction of the sequence playing on this mounted shape @param slot mounted shape slot @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// Get the playback direction of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// /// public float getMountThreadDir(string guishapeedpreview, int slot){ @@ -13838,7 +19327,10 @@ public float getMountThreadDir(string guishapeedpreview, int slot){ return m_ts.fnGuiShapeEdPreview_getMountThreadDir(guishapeedpreview, slot); } /// -/// Get the playback position of the sequence playing on this mounted shape @param slot mounted shape slot @return playback position of the sequence (0-1) ) +/// Get the playback position of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return playback position of the sequence (0-1) ) +/// /// public float getMountThreadPos(string guishapeedpreview, int slot){ @@ -13846,7 +19338,10 @@ public float getMountThreadPos(string guishapeedpreview, int slot){ return m_ts.fnGuiShapeEdPreview_getMountThreadPos(guishapeedpreview, slot); } /// -/// Get the name of the sequence playing on this mounted shape @param slot mounted shape slot @return name of the sequence (if any) ) +/// Get the name of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return name of the sequence (if any) ) +/// /// public string getMountThreadSequence(string guishapeedpreview, int slot){ @@ -13854,7 +19349,9 @@ public string getMountThreadSequence(string guishapeedpreview, int slot){ return m_ts.fnGuiShapeEdPreview_getMountThreadSequence(guishapeedpreview, slot); } /// -/// Get the number of threads @return the number of threads ) +/// Get the number of threads +/// @return the number of threads ) +/// /// public int getThreadCount(string guishapeedpreview){ @@ -13863,6 +19360,7 @@ public int getThreadCount(string guishapeedpreview){ } /// /// Get the name of the sequence assigned to the active thread ) +/// /// public string getThreadSequence(string guishapeedpreview){ @@ -13870,7 +19368,12 @@ public string getThreadSequence(string guishapeedpreview){ return m_ts.fnGuiShapeEdPreview_getThreadSequence(guishapeedpreview); } /// -/// Mount a shape onto the main shape at the specified node @param shapePath path to the shape to mount @param nodeName name of the node on the main shape to mount to @param type type of mounting to use (Object, Image or Wheel) @param slot mount slot ) +/// Mount a shape onto the main shape at the specified node +/// @param shapePath path to the shape to mount +/// @param nodeName name of the node on the main shape to mount to +/// @param type type of mounting to use (Object, Image or Wheel) +/// @param slot mount slot ) +/// /// public bool mountShape(string guishapeedpreview, string shapePath, string nodeName, string type, int slot){ @@ -13879,6 +19382,7 @@ public bool mountShape(string guishapeedpreview, string shapePath, string nodeN } /// /// Refresh the shape (used when the shape meshes or nodes have been added or removed) ) +/// /// public void refreshShape(string guishapeedpreview){ @@ -13887,6 +19391,7 @@ public void refreshShape(string guishapeedpreview){ } /// /// Refreshes thread sequences (in case of removed/renamed sequences ) +/// /// public void refreshThreadSequences(string guishapeedpreview){ @@ -13894,7 +19399,9 @@ public void refreshThreadSequences(string guishapeedpreview){ m_ts.fnGuiShapeEdPreview_refreshThreadSequences(guishapeedpreview); } /// -/// Removes the specifed thread @param slot index of the thread to remove ) +/// Removes the specifed thread +/// @param slot index of the thread to remove ) +/// /// public void removeThread(string guishapeedpreview, int slot){ @@ -13903,6 +19410,7 @@ public void removeThread(string guishapeedpreview, int slot){ } /// /// Show or hide all objects in the shape ) +/// /// public void setAllMeshesHidden(string guishapeedpreview, bool hidden){ @@ -13911,6 +19419,7 @@ public void setAllMeshesHidden(string guishapeedpreview, bool hidden){ } /// /// Show or hide the named object in the shape ) +/// /// public void setMeshHidden(string guishapeedpreview, string name, bool hidden){ @@ -13918,7 +19427,10 @@ public void setMeshHidden(string guishapeedpreview, string name, bool hidden){ m_ts.fnGuiShapeEdPreview_setMeshHidden(guishapeedpreview, name, hidden); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display. @return True if the model was loaded successfully, false otherwise. ) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display. +/// @return True if the model was loaded successfully, false otherwise. ) +/// /// public bool setModel(string guishapeedpreview, string shapePath){ @@ -13926,7 +19438,10 @@ public bool setModel(string guishapeedpreview, string shapePath){ return m_ts.fnGuiShapeEdPreview_setModel(guishapeedpreview, shapePath); } /// -/// Set the node a shape is mounted to. @param slot mounted shape slot @param nodename name of the node to mount to ) +/// Set the node a shape is mounted to. +/// @param slot mounted shape slot +/// @param nodename name of the node to mount to ) +/// /// public void setMountNode(string guishapeedpreview, int slot, string nodeName){ @@ -13934,7 +19449,10 @@ public void setMountNode(string guishapeedpreview, int slot, string nodeName){ m_ts.fnGuiShapeEdPreview_setMountNode(guishapeedpreview, slot, nodeName); } /// -/// Set the playback direction of the shape mounted in the specified slot @param slot mounted shape slot @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// Set the playback direction of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// /// public void setMountThreadDir(string guishapeedpreview, int slot, float dir){ @@ -13942,7 +19460,10 @@ public void setMountThreadDir(string guishapeedpreview, int slot, float dir){ m_ts.fnGuiShapeEdPreview_setMountThreadDir(guishapeedpreview, slot, dir); } /// -/// Set the sequence position of the shape mounted in the specified slot @param slot mounted shape slot @param pos sequence position (0-1) ) +/// Set the sequence position of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param pos sequence position (0-1) ) +/// /// public void setMountThreadPos(string guishapeedpreview, int slot, float pos){ @@ -13950,7 +19471,10 @@ public void setMountThreadPos(string guishapeedpreview, int slot, float pos){ m_ts.fnGuiShapeEdPreview_setMountThreadPos(guishapeedpreview, slot, pos); } /// -/// Set the sequence to play for the shape mounted in the specified slot @param slot mounted shape slot @param name name of the sequence to play ) +/// Set the sequence to play for the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param name name of the sequence to play ) +/// /// public void setMountThreadSequence(string guishapeedpreview, int slot, string name){ @@ -13958,7 +19482,9 @@ public void setMountThreadSequence(string guishapeedpreview, int slot, string n m_ts.fnGuiShapeEdPreview_setMountThreadSequence(guishapeedpreview, slot, name); } /// -/// Set the camera orbit position @param pos Position in the form \"x y z\" ) +/// Set the camera orbit position +/// @param pos Position in the form \"x y z\" ) +/// /// public void setOrbitPos(string guishapeedpreview, Point3F pos){ @@ -13966,7 +19492,12 @@ public void setOrbitPos(string guishapeedpreview, Point3F pos){ m_ts.fnGuiShapeEdPreview_setOrbitPos(guishapeedpreview, pos.AsString()); } /// -/// Sets the sequence to play for the active thread. @param name name of the sequence to play @param duration transition duration (0 for no transition) @param pos position in the new sequence to transition to @param play if true, the new sequence will play during the transition ) +/// Sets the sequence to play for the active thread. +/// @param name name of the sequence to play +/// @param duration transition duration (0 for no transition) +/// @param pos position in the new sequence to transition to +/// @param play if true, the new sequence will play during the transition ) +/// /// public void setThreadSequence(string guishapeedpreview, string name, float duration = 0, float pos = 0, bool play = false){ @@ -13974,7 +19505,9 @@ public void setThreadSequence(string guishapeedpreview, string name, float dura m_ts.fnGuiShapeEdPreview_setThreadSequence(guishapeedpreview, name, duration, pos, play); } /// -/// Set the time scale of all threads @param scale new time scale value ) +/// Set the time scale of all threads +/// @param scale new time scale value ) +/// /// public void setTimeScale(string guishapeedpreview, float scale){ @@ -13983,6 +19516,7 @@ public void setTimeScale(string guishapeedpreview, float scale){ } /// /// Unmount all shapes ) +/// /// public void unmountAll(string guishapeedpreview){ @@ -13990,7 +19524,9 @@ public void unmountAll(string guishapeedpreview){ m_ts.fnGuiShapeEdPreview_unmountAll(guishapeedpreview); } /// -/// Unmount the shape in the specified slot @param slot mounted shape slot ) +/// Unmount the shape in the specified slot +/// @param slot mounted shape slot ) +/// /// public void unmountShape(string guishapeedpreview, int slot){ @@ -13999,6 +19535,7 @@ public void unmountShape(string guishapeedpreview, int slot){ } /// /// Refresh the shape node transforms (used when a node transform has been modified externally) ) +/// /// public void updateNodeTransforms(string guishapeedpreview){ @@ -14011,14 +19548,10 @@ public void updateNodeTransforms(string guishapeedpreview){ /// public class GuiSliderCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiSliderCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the current value of the slider based on the position of the thumb. @return Slider position (from range.x to range.y). ) +/// Get the current value of the slider based on the position of the thumb. +/// @return Slider position (from range.x to range.y). ) +/// /// public float getValue(string guisliderctrl){ @@ -14026,7 +19559,10 @@ public float getValue(string guisliderctrl){ return m_ts.fnGuiSliderCtrl_getValue(guisliderctrl); } /// -/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful for scrubbing type sliders where the slider position is sync'd to a changing value. When the user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful +/// for scrubbing type sliders where the slider position is sync'd to a changing value. When the +/// user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// /// public bool isThumbBeingDragged(string guisliderctrl){ @@ -14034,7 +19570,10 @@ public bool isThumbBeingDragged(string guisliderctrl){ return m_ts.fnGuiSliderCtrl_isThumbBeingDragged(guisliderctrl); } /// -/// Set position of the thumb on the slider. @param pos New slider position (from range.x to range.y) @param doCallback If true, the altCommand callback will be invoked ) +/// Set position of the thumb on the slider. +/// @param pos New slider position (from range.x to range.y) +/// @param doCallback If true, the altCommand callback will be invoked ) +/// /// public void setValue(string guisliderctrl, float pos, bool doCallback = false){ @@ -14047,14 +19586,15 @@ public void setValue(string guisliderctrl, float pos, bool doCallback = false){ /// public class GuiStackControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiStackControlObject(ref Omni ts){m_ts = ts;} /// -/// Prevents control from restacking - useful when adding or removing child controls @param freeze True to freeze the control, false to unfreeze it @tsexample %stackCtrl.freeze(true); // add controls to stack %stackCtrl.freeze(false); @endtsexample ) +/// Prevents control from restacking - useful when adding or removing child controls +/// @param freeze True to freeze the control, false to unfreeze it +/// @tsexample +/// %stackCtrl.freeze(true); +/// // add controls to stack +/// %stackCtrl.freeze(false); +/// @endtsexample ) +/// /// public void freeze(string guistackcontrol, bool freeze){ @@ -14063,6 +19603,7 @@ public void freeze(string guistackcontrol, bool freeze){ } /// /// Return whether or not this control is frozen ) +/// /// public bool isFrozen(string guistackcontrol){ @@ -14071,6 +19612,7 @@ public bool isFrozen(string guistackcontrol){ } /// /// Restack the child controls. ) +/// /// public void updateStack(string guistackcontrol){ @@ -14083,14 +19625,12 @@ public void updateStack(string guistackcontrol){ /// public class GuiSwatchButtonCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiSwatchButtonCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Set the color of the swatch control. @param newColor The new color string given to the swatch control in float format \"r g b a\". @note It's also important to note that when setColor is called causes the control's altCommand field to be executed. ) +/// Set the color of the swatch control. +/// @param newColor The new color string given to the swatch control in float format \"r g b a\". +/// @note It's also important to note that when setColor is called causes +/// the control's altCommand field to be executed. ) +/// /// public void setColor(string guiswatchbuttonctrl, string newColor){ @@ -14103,14 +19643,11 @@ public void setColor(string guiswatchbuttonctrl, string newColor){ /// public class GuiTabBookCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTabBookCtrlObject(ref Omni ts){m_ts = ts;} /// -/// ), Add a new tab page to the control. @param title Title text for the tab page header. ) +/// ), +/// Add a new tab page to the control. +/// @param title Title text for the tab page header. ) +/// /// public void addPage(string guitabbookctrl, string title = ""){ @@ -14118,7 +19655,9 @@ public void addPage(string guitabbookctrl, string title = ""){ m_ts.fnGuiTabBookCtrl_addPage(guitabbookctrl, title); } /// -/// Get the index of the currently selected tab page. @return Index of the selected tab page or -1 if no tab page is selected. ) +/// Get the index of the currently selected tab page. +/// @return Index of the selected tab page or -1 if no tab page is selected. ) +/// /// public int getSelectedPage(string guitabbookctrl){ @@ -14126,7 +19665,9 @@ public int getSelectedPage(string guitabbookctrl){ return m_ts.fnGuiTabBookCtrl_getSelectedPage(guitabbookctrl); } /// -/// Set the selected tab page. @param index Index of the tab page. ) +/// Set the selected tab page. +/// @param index Index of the tab page. ) +/// /// public void selectPage(string guitabbookctrl, int index){ @@ -14139,12 +19680,6 @@ public void selectPage(string guitabbookctrl, int index){ /// public class GuiTableControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTableControlObject(ref Omni ts){m_ts = ts;} /// /// ) /// @@ -14227,14 +19762,9 @@ public void setSelectedRow(string guitablecontrol, int rowNum){ /// public class GuiTabPageCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTabPageCtrlObject(ref Omni ts){m_ts = ts;} /// /// Select this page in its tab book. ) +/// /// public void select(string guitabpagectrl){ @@ -14247,14 +19777,9 @@ public void select(string guitabpagectrl){ /// public class GuiTerrPreviewCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTerrPreviewCtrlObject(ref Omni ts){m_ts = ts;} /// /// Return a Point2F containing the position of the origin.) +/// /// public Point2F GuiTerrPreviewCtrl_getOrigin(string guiterrpreviewctrl){ @@ -14263,6 +19788,7 @@ public Point2F GuiTerrPreviewCtrl_getOrigin(string guiterrpreviewctrl){ } /// /// Return a Point2F representing the position of the root.) +/// /// public Point2F GuiTerrPreviewCtrl_getRoot(string guiterrpreviewctrl){ @@ -14271,6 +19797,7 @@ public Point2F GuiTerrPreviewCtrl_getRoot(string guiterrpreviewctrl){ } /// /// Returns a 4-tuple containing: root_x root_y origin_x origin_y) +/// /// public string GuiTerrPreviewCtrl_getValue(string guiterrpreviewctrl){ @@ -14279,6 +19806,7 @@ public string GuiTerrPreviewCtrl_getValue(string guiterrpreviewctrl){ } /// /// Reset the view of the terrain.) +/// /// public void GuiTerrPreviewCtrl_reset(string guiterrpreviewctrl){ @@ -14286,7 +19814,9 @@ public void GuiTerrPreviewCtrl_reset(string guiterrpreviewctrl){ m_ts.fn_GuiTerrPreviewCtrl_reset(guiterrpreviewctrl); } /// -/// (float x, float y) Set the origin of the view.) +/// (float x, float y) +/// Set the origin of the view.) +/// /// public void GuiTerrPreviewCtrl_setOrigin(string guiterrpreviewctrl, Point2F pos){ @@ -14295,6 +19825,7 @@ public void GuiTerrPreviewCtrl_setOrigin(string guiterrpreviewctrl, Point2F pos } /// /// Add the origin to the root and reset the origin.) +/// /// public void GuiTerrPreviewCtrl_setRoot(string guiterrpreviewctrl){ @@ -14302,7 +19833,9 @@ public void GuiTerrPreviewCtrl_setRoot(string guiterrpreviewctrl){ m_ts.fn_GuiTerrPreviewCtrl_setRoot(guiterrpreviewctrl); } /// -/// Accepts a 4-tuple in the same form as getValue returns. @see GuiTerrPreviewCtrl::getValue()) +/// Accepts a 4-tuple in the same form as getValue returns. +/// @see GuiTerrPreviewCtrl::getValue()) +/// /// public void GuiTerrPreviewCtrl_setValue(string guiterrpreviewctrl, string tuple){ @@ -14315,14 +19848,17 @@ public void GuiTerrPreviewCtrl_setValue(string guiterrpreviewctrl, string tuple /// public class GuiTextCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTextCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Sets the text in the control. @param text Text to display in the control. @tsexample // Set the text to show in the control %text = \"Gideon - Destroyer of World\"; // Inform the GuiTextCtrl control to change its text to the defined value %thisGuiTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to display in the control. +/// @tsexample +/// // Set the text to show in the control +/// %text = \"Gideon - Destroyer of World\"; +/// // Inform the GuiTextCtrl control to change its text to the defined value +/// %thisGuiTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void setText(string guitextctrl, string text){ @@ -14330,7 +19866,15 @@ public void setText(string guitextctrl, string text){ m_ts.fnGuiTextCtrl_setText(guitextctrl, text); } /// -/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. @param textID Name of variable text should be mapped to @tsexample // Inform the GuiTextCtrl control of the textID to use %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); @endtsexample @see GuiControl @see Localization) +/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. +/// @param textID Name of variable text should be mapped to +/// @tsexample +/// // Inform the GuiTextCtrl control of the textID to use +/// %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); +/// @endtsexample +/// @see GuiControl +/// @see Localization) +/// /// public void setTextID(string guitextctrl, string textID){ @@ -14343,14 +19887,9 @@ public void setTextID(string guitextctrl, string textID){ /// public class GuiTextEditCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTextEditCtrlObject(ref Omni ts){m_ts = ts;} /// /// textEditCtrl.selectText( %startBlock, %endBlock ) ) +/// /// public void GuiTextEditCtrl_selectText(string guitexteditctrl, int startBlock, int endBlock){ @@ -14358,7 +19897,13 @@ public void GuiTextEditCtrl_selectText(string guitexteditctrl, int startBlock, m_ts.fn_GuiTextEditCtrl_selectText(guitexteditctrl, startBlock, endBlock); } /// -/// @brief Unselects all selected text in the control. @tsexample // Inform the control to unselect all of its selected text %thisGuiTextEditCtrl.clearSelectedText(); @endtsexample @see GuiControl) +/// @brief Unselects all selected text in the control. +/// @tsexample +/// // Inform the control to unselect all of its selected text +/// %thisGuiTextEditCtrl.clearSelectedText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearSelectedText(string guitexteditctrl){ @@ -14366,7 +19911,13 @@ public void clearSelectedText(string guitexteditctrl){ m_ts.fnGuiTextEditCtrl_clearSelectedText(guitexteditctrl); } /// -/// @brief Force a validation to occur. @tsexample // Inform the control to force a validation of its text. %thisGuiTextEditCtrl.forceValidateText(); @endtsexample @see GuiControl) +/// @brief Force a validation to occur. +/// @tsexample +/// // Inform the control to force a validation of its text. +/// %thisGuiTextEditCtrl.forceValidateText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void forceValidateText(string guitexteditctrl){ @@ -14374,7 +19925,14 @@ public void forceValidateText(string guitexteditctrl){ m_ts.fnGuiTextEditCtrl_forceValidateText(guitexteditctrl); } /// -/// @brief Returns the current position of the text cursor in the control. @tsexample // Acquire the cursor position in the control %position = %thisGuiTextEditCtrl.getCursorPost(); @endtsexample @return Text cursor position within the control. @see GuiControl) +/// @brief Returns the current position of the text cursor in the control. +/// @tsexample +/// // Acquire the cursor position in the control +/// %position = %thisGuiTextEditCtrl.getCursorPost(); +/// @endtsexample +/// @return Text cursor position within the control. +/// @see GuiControl) +/// /// public int getCursorPos(string guitexteditctrl){ @@ -14382,7 +19940,14 @@ public int getCursorPos(string guitexteditctrl){ return m_ts.fnGuiTextEditCtrl_getCursorPos(guitexteditctrl); } /// -/// @brief Acquires the current text displayed in this control. @tsexample // Acquire the value of the text control. %text = %thisGuiTextEditCtrl.getText(); @endtsexample @return The current text within the control. @see GuiControl) +/// @brief Acquires the current text displayed in this control. +/// @tsexample +/// // Acquire the value of the text control. +/// %text = %thisGuiTextEditCtrl.getText(); +/// @endtsexample +/// @return The current text within the control. +/// @see GuiControl) +/// /// public string getText(string guitexteditctrl){ @@ -14390,7 +19955,14 @@ public string getText(string guitexteditctrl){ return m_ts.fnGuiTextEditCtrl_getText(guitexteditctrl); } /// -/// @brief Checks to see if all text in the control has been selected. @tsexample // Check to see if all text has been selected or not. %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); @endtsexample @return True if all text in the control is selected, otherwise false. @see GuiControl) +/// @brief Checks to see if all text in the control has been selected. +/// @tsexample +/// // Check to see if all text has been selected or not. +/// %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); +/// @endtsexample +/// @return True if all text in the control is selected, otherwise false. +/// @see GuiControl) +/// /// public bool isAllTextSelected(string guitexteditctrl){ @@ -14398,7 +19970,13 @@ public bool isAllTextSelected(string guitexteditctrl){ return m_ts.fnGuiTextEditCtrl_isAllTextSelected(guitexteditctrl); } /// -/// @brief Selects all text within the control. @tsexample // Inform the control to select all of its text. %thisGuiTextEditCtrl.selectAllText(); @endtsexample @see GuiControl) +/// @brief Selects all text within the control. +/// @tsexample +/// // Inform the control to select all of its text. +/// %thisGuiTextEditCtrl.selectAllText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void selectAllText(string guitexteditctrl){ @@ -14406,7 +19984,16 @@ public void selectAllText(string guitexteditctrl){ m_ts.fnGuiTextEditCtrl_selectAllText(guitexteditctrl); } /// -/// @brief Sets the text cursor at the defined position within the control. @param position Text position to set the text cursor. @tsexample // Define the cursor position %position = \"12\"; // Inform the GuiTextEditCtrl control to place the text cursor at the defined position %thisGuiTextEditCtrl.setCursorPos(%position); @endtsexample @see GuiControl) +/// @brief Sets the text cursor at the defined position within the control. +/// @param position Text position to set the text cursor. +/// @tsexample +/// // Define the cursor position +/// %position = \"12\"; +/// // Inform the GuiTextEditCtrl control to place the text cursor at the defined position +/// %thisGuiTextEditCtrl.setCursorPos(%position); +/// @endtsexample +/// @see GuiControl) +/// /// public void setCursorPos(string guitexteditctrl, int position){ @@ -14414,7 +20001,16 @@ public void setCursorPos(string guitexteditctrl, int position){ m_ts.fnGuiTextEditCtrl_setCursorPos(guitexteditctrl, position); } /// -/// @brief Sets the text in the control. @param text Text to place in the control. @tsexample // Define the text to display %text = \"Text!\" // Inform the GuiTextEditCtrl to display the defined text %thisGuiTextEditCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to place in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Text!\" +/// // Inform the GuiTextEditCtrl to display the defined text +/// %thisGuiTextEditCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void setText(string guitexteditctrl, string text){ @@ -14427,14 +20023,26 @@ public void setText(string guitexteditctrl, string text){ /// public class GuiTextListCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTextListCtrlObject(ref Omni ts){m_ts = ts;} /// -/// ,-1), @brief Adds a new row at end of the list with the defined id and text. If index is used, then the new row is inserted at the row location of 'index'. @param id Id of the new row. @param text Text to display at the new row. @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. @tsexample // Define the id %id = \"4\"; // Define the text to display %text = \"Display Text\" // Define the index (optional) %index = \"2\" // Inform the GuiTextListCtrl control to add the new row with the defined information. %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); @endtsexample @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. @see References) +/// ,-1), +/// @brief Adds a new row at end of the list with the defined id and text. +/// If index is used, then the new row is inserted at the row location of 'index'. +/// @param id Id of the new row. +/// @param text Text to display at the new row. +/// @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text to display +/// %text = \"Display Text\" +/// // Define the index (optional) +/// %index = \"2\" +/// // Inform the GuiTextListCtrl control to add the new row with the defined information. +/// %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); +/// @endtsexample +/// @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. +/// @see References) +/// /// public int addRow(string guitextlistctrl, int id = 0, string text = "", int index = -1){ @@ -14442,7 +20050,13 @@ public int addRow(string guitextlistctrl, int id = 0, string text = "", int ind return m_ts.fnGuiTextListCtrl_addRow(guitextlistctrl, id, text, index); } /// -/// @brief Clear the list. @tsexample // Inform the GuiTextListCtrl control to clear its contents %thisGuiTextListCtrl.clear(); @endtsexample @see GuiControl) +/// @brief Clear the list. +/// @tsexample +/// // Inform the GuiTextListCtrl control to clear its contents +/// %thisGuiTextListCtrl.clear(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clear(string guitextlistctrl){ @@ -14450,7 +20064,13 @@ public void clear(string guitextlistctrl){ m_ts.fnGuiTextListCtrl_clear(guitextlistctrl); } /// -/// @brief Set the selection to nothing. @tsexample // Deselect anything that is currently selected %thisGuiTextListCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Set the selection to nothing. +/// @tsexample +/// // Deselect anything that is currently selected +/// %thisGuiTextListCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearSelection(string guitextlistctrl){ @@ -14459,6 +20079,7 @@ public void clearSelection(string guitextlistctrl){ } /// /// ) +/// /// public int findColumnTextIndex(string guitextlistctrl, int columnId, string columnText){ @@ -14466,7 +20087,17 @@ public int findColumnTextIndex(string guitextlistctrl, int columnId, string col return m_ts.fnGuiTextListCtrl_findColumnTextIndex(guitextlistctrl, columnId, columnText); } /// -/// @brief Find needle in the list, and return the row number it was found in. @param needle Text to find in the list. @tsexample // Define the text to find in the list %needle = \"Text To Find\"; // Request the row number that contains the defined text to find %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); @endtsexample @return Row number that the defined text was found in, @see GuiControl) +/// @brief Find needle in the list, and return the row number it was found in. +/// @param needle Text to find in the list. +/// @tsexample +/// // Define the text to find in the list +/// %needle = \"Text To Find\"; +/// // Request the row number that contains the defined text to find +/// %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); +/// @endtsexample +/// @return Row number that the defined text was found in, +/// @see GuiControl) +/// /// public int findTextIndex(string guitextlistctrl, string needle){ @@ -14474,7 +20105,17 @@ public int findTextIndex(string guitextlistctrl, string needle){ return m_ts.fnGuiTextListCtrl_findTextIndex(guitextlistctrl, needle); } /// -/// @brief Get the row ID for an index. @param index Index to get the RowID at @tsexample // Define the index %index = \"3\"; // Request the row ID at the defined index %rowId = %thisGuiTextListCtrl.getRowId(%index); @endtsexample @return RowId at the defined index. @see GuiControl) +/// @brief Get the row ID for an index. +/// @param index Index to get the RowID at +/// @tsexample +/// // Define the index +/// %index = \"3\"; +/// // Request the row ID at the defined index +/// %rowId = %thisGuiTextListCtrl.getRowId(%index); +/// @endtsexample +/// @return RowId at the defined index. +/// @see GuiControl) +/// /// public int getRowId(string guitextlistctrl, int index){ @@ -14482,7 +20123,16 @@ public int getRowId(string guitextlistctrl, int index){ return m_ts.fnGuiTextListCtrl_getRowId(guitextlistctrl, index); } /// -/// @brief Get the row number for a specified id. @param id Id to get the row number at @tsexample // Define the id %id = \"4\"; // Request the row number from the GuiTextListCtrl control at the defined id. %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); @endtsexample @see GuiControl) +/// @brief Get the row number for a specified id. +/// @param id Id to get the row number at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Request the row number from the GuiTextListCtrl control at the defined id. +/// %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public int getRowNumById(string guitextlistctrl, int id){ @@ -14490,7 +20140,17 @@ public int getRowNumById(string guitextlistctrl, int id){ return m_ts.fnGuiTextListCtrl_getRowNumById(guitextlistctrl, id); } /// -/// @brief Get the text of the row with the specified index. @param index Row index to acquire the text at. @tsexample // Define the row index %index = \"5\"; // Request the text from the row at the defined index %rowText = %thisGuiTextListCtrl.getRowText(%index); @endtsexample @return Text at the defined row index. @see GuiControl) +/// @brief Get the text of the row with the specified index. +/// @param index Row index to acquire the text at. +/// @tsexample +/// // Define the row index +/// %index = \"5\"; +/// // Request the text from the row at the defined index +/// %rowText = %thisGuiTextListCtrl.getRowText(%index); +/// @endtsexample +/// @return Text at the defined row index. +/// @see GuiControl) +/// /// public string getRowText(string guitextlistctrl, int index){ @@ -14498,7 +20158,16 @@ public string getRowText(string guitextlistctrl, int index){ return m_ts.fnGuiTextListCtrl_getRowText(guitextlistctrl, index); } /// -/// @brief Get the text of a row with the specified id. @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to return the text at the defined row id %rowText = %thisGuiTextListCtrl.getRowTextById(%id); @endtsexample @return Row text at the requested row id. @see GuiControl) +/// @brief Get the text of a row with the specified id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to return the text at the defined row id +/// %rowText = %thisGuiTextListCtrl.getRowTextById(%id); +/// @endtsexample +/// @return Row text at the requested row id. +/// @see GuiControl) +/// /// public string getRowTextById(string guitextlistctrl, int id){ @@ -14506,7 +20175,14 @@ public string getRowTextById(string guitextlistctrl, int id){ return m_ts.fnGuiTextListCtrl_getRowTextById(guitextlistctrl, id); } /// -/// @brief Get the ID of the currently selected item. @tsexample // Acquire the ID of the selected item in the list. %id = %thisGuiTextListCtrl.getSelectedId(); @endtsexample @return The id of the selected item in the list. @see GuiControl) +/// @brief Get the ID of the currently selected item. +/// @tsexample +/// // Acquire the ID of the selected item in the list. +/// %id = %thisGuiTextListCtrl.getSelectedId(); +/// @endtsexample +/// @return The id of the selected item in the list. +/// @see GuiControl) +/// /// public int getSelectedId(string guitextlistctrl){ @@ -14514,7 +20190,14 @@ public int getSelectedId(string guitextlistctrl){ return m_ts.fnGuiTextListCtrl_getSelectedId(guitextlistctrl); } /// -/// @brief Returns the selected row index (not the row ID). @tsexample // Acquire the selected row index %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); @endtsexample @return Index of the selected row @see GuiControl) +/// @brief Returns the selected row index (not the row ID). +/// @tsexample +/// // Acquire the selected row index +/// %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); +/// @endtsexample +/// @return Index of the selected row +/// @see GuiControl) +/// /// public int getSelectedRow(string guitextlistctrl){ @@ -14522,7 +20205,17 @@ public int getSelectedRow(string guitextlistctrl){ return m_ts.fnGuiTextListCtrl_getSelectedRow(guitextlistctrl); } /// -/// @brief Check if the specified row is currently active or not. @param rowNum Row number to check the active state. @tsexample // Define the row number %rowNum = \"5\"; // Request the active state of the defined row number from the GuiTextListCtrl control. %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); @endtsexample @return Active state of the defined row number. @see GuiControl) +/// @brief Check if the specified row is currently active or not. +/// @param rowNum Row number to check the active state. +/// @tsexample +/// // Define the row number +/// %rowNum = \"5\"; +/// // Request the active state of the defined row number from the GuiTextListCtrl control. +/// %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); +/// @endtsexample +/// @return Active state of the defined row number. +/// @see GuiControl) +/// /// public bool isRowActive(string guitextlistctrl, int rowNum){ @@ -14530,7 +20223,16 @@ public bool isRowActive(string guitextlistctrl, int rowNum){ return m_ts.fnGuiTextListCtrl_isRowActive(guitextlistctrl, rowNum); } /// -/// @brief Remove a row from the table, based on its index. @param index Row index to remove from the list. @tsexample // Define the row index %index = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined row index %thisGuiTextListCtrl.removeRow(%index); @endtsexample @see GuiControl) +/// @brief Remove a row from the table, based on its index. +/// @param index Row index to remove from the list. +/// @tsexample +/// // Define the row index +/// %index = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined row index +/// %thisGuiTextListCtrl.removeRow(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void removeRow(string guitextlistctrl, int index){ @@ -14538,7 +20240,16 @@ public void removeRow(string guitextlistctrl, int index){ m_ts.fnGuiTextListCtrl_removeRow(guitextlistctrl, index); } /// -/// @brief Remove row with the specified id. @param id Id to remove the row entry at @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined id %thisGuiTextListCtrl.removeRowById(%id); @endtsexample @see GuiControl) +/// @brief Remove row with the specified id. +/// @param id Id to remove the row entry at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined id +/// %thisGuiTextListCtrl.removeRowById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void removeRowById(string guitextlistctrl, int id){ @@ -14546,7 +20257,14 @@ public void removeRowById(string guitextlistctrl, int id){ m_ts.fnGuiTextListCtrl_removeRowById(guitextlistctrl, id); } /// -/// @brief Get the number of rows. @tsexample // Get the number of rows in the list %rowCount = %thisGuiTextListCtrl.rowCount(); @endtsexample @return Number of rows in the list. @see GuiControl) +/// @brief Get the number of rows. +/// @tsexample +/// // Get the number of rows in the list +/// %rowCount = %thisGuiTextListCtrl.rowCount(); +/// @endtsexample +/// @return Number of rows in the list. +/// @see GuiControl) +/// /// public int rowCount(string guitextlistctrl){ @@ -14554,7 +20272,16 @@ public int rowCount(string guitextlistctrl){ return m_ts.fnGuiTextListCtrl_rowCount(guitextlistctrl); } /// -/// @brief Scroll so the specified row is visible @param rowNum Row number to make visible @tsexample // Define the row number to make visible %rowNum = \"4\"; // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. %thisGuiTextListCtrl.scrollVisible(%rowNum); @endtsexample @see GuiControl) +/// @brief Scroll so the specified row is visible +/// @param rowNum Row number to make visible +/// @tsexample +/// // Define the row number to make visible +/// %rowNum = \"4\"; +/// // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. +/// %thisGuiTextListCtrl.scrollVisible(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void scrollVisible(string guitextlistctrl, int rowNum){ @@ -14562,7 +20289,19 @@ public void scrollVisible(string guitextlistctrl, int rowNum){ m_ts.fnGuiTextListCtrl_scrollVisible(guitextlistctrl, rowNum); } /// -/// @brief Mark a specified row as active/not. @param rowNum Row number to change the active state. @param active Boolean active state to set the row number. @tsexample // Define the row number %rowNum = \"4\"; // Define the boolean active state %active = \"true\"; // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. %thisGuiTextListCtrl.setRowActive(%rowNum,%active); @endtsexample @see GuiControl) +/// @brief Mark a specified row as active/not. +/// @param rowNum Row number to change the active state. +/// @param active Boolean active state to set the row number. +/// @tsexample +/// // Define the row number +/// %rowNum = \"4\"; +/// // Define the boolean active state +/// %active = \"true\"; +/// // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. +/// %thisGuiTextListCtrl.setRowActive(%rowNum,%active); +/// @endtsexample +/// @see GuiControl) +/// /// public void setRowActive(string guitextlistctrl, int rowNum, bool active){ @@ -14570,7 +20309,19 @@ public void setRowActive(string guitextlistctrl, int rowNum, bool active){ m_ts.fnGuiTextListCtrl_setRowActive(guitextlistctrl, rowNum, active); } /// -/// @brief Sets the text at the defined id. @param id Id to change. @param text Text to use at the Id. @tsexample // Define the id %id = \"4\"; // Define the text %text = \"Text To Display\"; // Inform the GuiTextListCtrl control to display the defined text at the defined id %thisGuiTextListCtrl.setRowById(%id,%text); @endtsexample @see GuiControl) +/// @brief Sets the text at the defined id. +/// @param id Id to change. +/// @param text Text to use at the Id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text +/// %text = \"Text To Display\"; +/// // Inform the GuiTextListCtrl control to display the defined text at the defined id +/// %thisGuiTextListCtrl.setRowById(%id,%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void setRowById(string guitextlistctrl, int id, string text){ @@ -14578,7 +20329,16 @@ public void setRowById(string guitextlistctrl, int id, string text){ m_ts.fnGuiTextListCtrl_setRowById(guitextlistctrl, id, text); } /// -/// @brief Finds the specified entry by id, then marks its row as selected. @param id Entry within the text list to make selected. @tsexample // Define the id %id = \"5\"; // Inform the GuiTextListCtrl control to set the defined id entry as selected %thisGuiTextListCtrl.setSelectedById(%id); @endtsexample @see GuiControl) +/// @brief Finds the specified entry by id, then marks its row as selected. +/// @param id Entry within the text list to make selected. +/// @tsexample +/// // Define the id +/// %id = \"5\"; +/// // Inform the GuiTextListCtrl control to set the defined id entry as selected +/// %thisGuiTextListCtrl.setSelectedById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSelectedById(string guitextlistctrl, int id){ @@ -14586,7 +20346,15 @@ public void setSelectedById(string guitextlistctrl, int id){ m_ts.fnGuiTextListCtrl_setSelectedById(guitextlistctrl, id); } /// -/// @briefSelects the specified row. @param rowNum Row number to set selected. @tsexample // Define the row number to set selected %rowNum = \"4\"; %guiTextListCtrl.setSelectedRow(%rowNum); @endtsexample @see GuiControl) +/// @briefSelects the specified row. +/// @param rowNum Row number to set selected. +/// @tsexample +/// // Define the row number to set selected +/// %rowNum = \"4\"; +/// %guiTextListCtrl.setSelectedRow(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSelectedRow(string guitextlistctrl, int rowNum){ @@ -14594,7 +20362,19 @@ public void setSelectedRow(string guitextlistctrl, int rowNum){ m_ts.fnGuiTextListCtrl_setSelectedRow(guitextlistctrl, rowNum); } /// -/// @brief Performs a standard (alphabetical) sort on the values in the specified column. @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sort(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Performs a standard (alphabetical) sort on the values in the specified column. +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sort(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void sort(string guitextlistctrl, int columnId, bool increasing = true){ @@ -14602,7 +20382,20 @@ public void sort(string guitextlistctrl, int columnId, bool increasing = true){ m_ts.fnGuiTextListCtrl_sort(guitextlistctrl, columnId, increasing); } /// -/// @brief Perform a numerical sort on the values in the specified column. Detailed description @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sortNumerical(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Perform a numerical sort on the values in the specified column. +/// Detailed description +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sortNumerical(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void sortNumerical(string guitextlistctrl, int columnID, bool increasing = true){ @@ -14615,14 +20408,10 @@ public void sortNumerical(string guitextlistctrl, int columnID, bool increasing /// public class GuiTheoraCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTheoraCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the current playback time. @return The elapsed playback time in seconds. ) +/// Get the current playback time. +/// @return The elapsed playback time in seconds. ) +/// /// public float getCurrentTime(string guitheoractrl){ @@ -14630,7 +20419,9 @@ public float getCurrentTime(string guitheoractrl){ return m_ts.fnGuiTheoraCtrl_getCurrentTime(guitheoractrl); } /// -/// Test whether the video has finished playing. @return True if the video has finished playing, false otherwise. ) +/// Test whether the video has finished playing. +/// @return True if the video has finished playing, false otherwise. ) +/// /// public bool isPlaybackDone(string guitheoractrl){ @@ -14638,7 +20429,9 @@ public bool isPlaybackDone(string guitheoractrl){ return m_ts.fnGuiTheoraCtrl_isPlaybackDone(guitheoractrl); } /// -/// Pause playback of the video. If the video is not currently playing, the call is ignored. While stopped, the control displays the last frame. ) +/// Pause playback of the video. If the video is not currently playing, the call is ignored. +/// While stopped, the control displays the last frame. ) +/// /// public void pause(string guitheoractrl){ @@ -14647,6 +20440,7 @@ public void pause(string guitheoractrl){ } /// /// Start playing the video. If the video is already playing, the call is ignored. ) +/// /// public void play(string guitheoractrl){ @@ -14654,7 +20448,10 @@ public void play(string guitheoractrl){ m_ts.fnGuiTheoraCtrl_play(guitheoractrl); } /// -/// Set the video file to play. If a video is already playing, playback is stopped and the new video file is loaded. @param filename The video file to load. ) +/// Set the video file to play. If a video is already playing, playback is stopped and +/// the new video file is loaded. +/// @param filename The video file to load. ) +/// /// public void setFile(string guitheoractrl, string filename){ @@ -14662,7 +20459,9 @@ public void setFile(string guitheoractrl, string filename){ m_ts.fnGuiTheoraCtrl_setFile(guitheoractrl, filename); } /// -/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. While stopped, the control renders empty with just the background color. ) +/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. +/// While stopped, the control renders empty with just the background color. ) +/// /// public void stop(string guitheoractrl){ @@ -14675,14 +20474,9 @@ public void stop(string guitheoractrl){ /// public class GuiTickCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTickCtrlObject(ref Omni ts){m_ts = ts;} /// /// ( [tick = true] ) - This will set this object to either be processing ticks or not ) +/// /// public void GuiTickCtrl_setProcessTicks(string guitickctrl, bool tick = true){ @@ -14695,14 +20489,9 @@ public void GuiTickCtrl_setProcessTicks(string guitickctrl, bool tick = true){ /// public class GuiToolboxButtonCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiToolboxButtonCtrlObject(ref Omni ts){m_ts = ts;} /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void GuiToolboxButtonCtrl_setHoverBitmap(string guitoolboxbuttonctrl, string name){ @@ -14711,6 +20500,7 @@ public void GuiToolboxButtonCtrl_setHoverBitmap(string guitoolboxbuttonctrl, st } /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void GuiToolboxButtonCtrl_setLoweredBitmap(string guitoolboxbuttonctrl, string name){ @@ -14719,6 +20509,7 @@ public void GuiToolboxButtonCtrl_setLoweredBitmap(string guitoolboxbuttonctrl, } /// /// ( filepath name ) sets the bitmap that shows when the button is active) +/// /// public void GuiToolboxButtonCtrl_setNormalBitmap(string guitoolboxbuttonctrl, string name){ @@ -14731,14 +20522,9 @@ public void GuiToolboxButtonCtrl_setNormalBitmap(string guitoolboxbuttonctrl, s /// public class GuiTreeViewCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTreeViewCtrlObject(ref Omni ts){m_ts = ts;} /// /// addChildSelectionByValue(TreeItemId parent, value)) +/// /// public void GuiTreeViewCtrl_addChildSelectionByValue(string guitreeviewctrl, int id, string tableEntry){ @@ -14747,6 +20533,7 @@ public void GuiTreeViewCtrl_addChildSelectionByValue(string guitreeviewctrl, in } /// /// (builds an icon table)) +/// /// public bool GuiTreeViewCtrl_buildIconTable(string guitreeviewctrl, string icons){ @@ -14755,6 +20542,7 @@ public bool GuiTreeViewCtrl_buildIconTable(string guitreeviewctrl, string icons } /// /// Build the visible tree) +/// /// public void GuiTreeViewCtrl_buildVisibleTree(string guitreeviewctrl, bool forceFullUpdate = false){ @@ -14763,6 +20551,7 @@ public void GuiTreeViewCtrl_buildVisibleTree(string guitreeviewctrl, bool force } /// /// For internal use. ) +/// /// public void GuiTreeViewCtrl_cancelRename(string guitreeviewctrl){ @@ -14771,6 +20560,7 @@ public void GuiTreeViewCtrl_cancelRename(string guitreeviewctrl){ } /// /// () - empty tree) +/// /// public void GuiTreeViewCtrl_clear(string guitreeviewctrl){ @@ -14779,6 +20569,7 @@ public void GuiTreeViewCtrl_clear(string guitreeviewctrl){ } /// /// (TreeItemId item, string newText, string newValue)) +/// /// public bool GuiTreeViewCtrl_editItem(string guitreeviewctrl, int item, string newText, string newValue){ @@ -14787,6 +20578,7 @@ public bool GuiTreeViewCtrl_editItem(string guitreeviewctrl, int item, string n } /// /// (TreeItemId item, bool expand=true)) +/// /// public bool GuiTreeViewCtrl_expandItem(string guitreeviewctrl, int id, bool expand = true){ @@ -14795,6 +20587,7 @@ public bool GuiTreeViewCtrl_expandItem(string guitreeviewctrl, int id, bool exp } /// /// (find item by object id and returns the mId)) +/// /// public int GuiTreeViewCtrl_findItemByObjectId(string guitreeviewctrl, int itemId){ @@ -14803,6 +20596,7 @@ public int GuiTreeViewCtrl_findItemByObjectId(string guitreeviewctrl, int itemI } /// /// (TreeItemId item)) +/// /// public int GuiTreeViewCtrl_getChild(string guitreeviewctrl, int itemId){ @@ -14811,6 +20605,7 @@ public int GuiTreeViewCtrl_getChild(string guitreeviewctrl, int itemId){ } /// /// Get id for root item.) +/// /// public int GuiTreeViewCtrl_getFirstRootItem(string guitreeviewctrl){ @@ -14819,6 +20614,7 @@ public int GuiTreeViewCtrl_getFirstRootItem(string guitreeviewctrl){ } /// /// ) +/// /// public int GuiTreeViewCtrl_getItemCount(string guitreeviewctrl){ @@ -14827,6 +20623,7 @@ public int GuiTreeViewCtrl_getItemCount(string guitreeviewctrl){ } /// /// (TreeItemId item)) +/// /// public string GuiTreeViewCtrl_getItemText(string guitreeviewctrl, int index){ @@ -14835,6 +20632,7 @@ public string GuiTreeViewCtrl_getItemText(string guitreeviewctrl, int index){ } /// /// (TreeItemId item)) +/// /// public string GuiTreeViewCtrl_getItemValue(string guitreeviewctrl, int itemId){ @@ -14843,6 +20641,7 @@ public string GuiTreeViewCtrl_getItemValue(string guitreeviewctrl, int itemId){ } /// /// (TreeItemId item)) +/// /// public int GuiTreeViewCtrl_getNextSibling(string guitreeviewctrl, int itemId){ @@ -14851,6 +20650,7 @@ public int GuiTreeViewCtrl_getNextSibling(string guitreeviewctrl, int itemId){ } /// /// (TreeItemId item)) +/// /// public int GuiTreeViewCtrl_getParentItem(string guitreeviewctrl, int itemId){ @@ -14859,6 +20659,7 @@ public int GuiTreeViewCtrl_getParentItem(string guitreeviewctrl, int itemId){ } /// /// (TreeItemId item)) +/// /// public int GuiTreeViewCtrl_getPrevSibling(string guitreeviewctrl, int itemId){ @@ -14867,6 +20668,7 @@ public int GuiTreeViewCtrl_getPrevSibling(string guitreeviewctrl, int itemId){ } /// /// ( int index=0 ) - Return the selected item at the given index.) +/// /// public int GuiTreeViewCtrl_getSelectedItem(string guitreeviewctrl, int index = 0){ @@ -14875,6 +20677,7 @@ public int GuiTreeViewCtrl_getSelectedItem(string guitreeviewctrl, int index = } /// /// returns a space seperated list of mulitple item ids) +/// /// public string GuiTreeViewCtrl_getSelectedItemList(string guitreeviewctrl){ @@ -14883,6 +20686,7 @@ public string GuiTreeViewCtrl_getSelectedItemList(string guitreeviewctrl){ } /// /// ) +/// /// public int GuiTreeViewCtrl_getSelectedItemsCount(string guitreeviewctrl){ @@ -14891,6 +20695,7 @@ public int GuiTreeViewCtrl_getSelectedItemsCount(string guitreeviewctrl){ } /// /// ( int index=0 ) - Return the currently selected SimObject at the given index in inspector mode or -1) +/// /// public int GuiTreeViewCtrl_getSelectedObject(string guitreeviewctrl, int index = 0){ @@ -14899,6 +20704,7 @@ public int GuiTreeViewCtrl_getSelectedObject(string guitreeviewctrl, int index } /// /// Returns a space sperated list of all selected object ids.) +/// /// public string GuiTreeViewCtrl_getSelectedObjectList(string guitreeviewctrl){ @@ -14907,6 +20713,7 @@ public string GuiTreeViewCtrl_getSelectedObjectList(string guitreeviewctrl){ } /// /// (TreeItemId item,Delimiter=none) gets the text from the current node to the root, concatenating at each branch upward, with a specified delimiter optionally) +/// /// public string GuiTreeViewCtrl_getTextToRoot(string guitreeviewctrl, int itemId, string delimiter){ @@ -14915,6 +20722,7 @@ public string GuiTreeViewCtrl_getTextToRoot(string guitreeviewctrl, int itemId, } /// /// ( int id ) - Returns true if the given item contains child items. ) +/// /// public bool GuiTreeViewCtrl_isParentItem(string guitreeviewctrl, int id){ @@ -14923,6 +20731,7 @@ public bool GuiTreeViewCtrl_isParentItem(string guitreeviewctrl, int id){ } /// /// (TreeItemId item, bool mark=true)) +/// /// public bool GuiTreeViewCtrl_markItem(string guitreeviewctrl, int id, bool mark = true){ @@ -14931,6 +20740,7 @@ public bool GuiTreeViewCtrl_markItem(string guitreeviewctrl, int id, bool mark } /// /// (TreeItemId item)) +/// /// public void GuiTreeViewCtrl_moveItemDown(string guitreeviewctrl, int index){ @@ -14939,6 +20749,7 @@ public void GuiTreeViewCtrl_moveItemDown(string guitreeviewctrl, int index){ } /// /// (TreeItemId item)) +/// /// public void GuiTreeViewCtrl_moveItemUp(string guitreeviewctrl, int index){ @@ -14947,6 +20758,7 @@ public void GuiTreeViewCtrl_moveItemUp(string guitreeviewctrl, int index){ } /// /// For internal use. ) +/// /// public void GuiTreeViewCtrl_onRenameValidate(string guitreeviewctrl){ @@ -14955,6 +20767,7 @@ public void GuiTreeViewCtrl_onRenameValidate(string guitreeviewctrl){ } /// /// (SimSet obj, bool okToEdit=true) Set the root of the tree view to the specified object, or to the root set.) +/// /// public void GuiTreeViewCtrl_open(string guitreeviewctrl, string objName, bool okToEdit = true){ @@ -14963,6 +20776,7 @@ public void GuiTreeViewCtrl_open(string guitreeviewctrl, string objName, bool o } /// /// removeAllChildren(TreeItemId parent)) +/// /// public void GuiTreeViewCtrl_removeAllChildren(string guitreeviewctrl, int itemId){ @@ -14971,6 +20785,7 @@ public void GuiTreeViewCtrl_removeAllChildren(string guitreeviewctrl, int itemI } /// /// removeChildSelectionByValue(TreeItemId parent, value)) +/// /// public void GuiTreeViewCtrl_removeChildSelectionByValue(string guitreeviewctrl, int id, string tableEntry){ @@ -14979,6 +20794,7 @@ public void GuiTreeViewCtrl_removeChildSelectionByValue(string guitreeviewctrl, } /// /// (TreeItemId item)) +/// /// public bool GuiTreeViewCtrl_removeItem(string guitreeviewctrl, int itemId){ @@ -14987,6 +20803,7 @@ public bool GuiTreeViewCtrl_removeItem(string guitreeviewctrl, int itemId){ } /// /// (deselects an item)) +/// /// public void GuiTreeViewCtrl_removeSelection(string guitreeviewctrl, int id){ @@ -14995,6 +20812,7 @@ public void GuiTreeViewCtrl_removeSelection(string guitreeviewctrl, int id){ } /// /// (TreeItemId item)) +/// /// public void GuiTreeViewCtrl_scrollVisible(string guitreeviewctrl, int itemId){ @@ -15003,6 +20821,7 @@ public void GuiTreeViewCtrl_scrollVisible(string guitreeviewctrl, int itemId){ } /// /// (show item by object id. returns true if sucessful.)) +/// /// public int GuiTreeViewCtrl_scrollVisibleByObjectId(string guitreeviewctrl, int itemId){ @@ -15011,6 +20830,7 @@ public int GuiTreeViewCtrl_scrollVisibleByObjectId(string guitreeviewctrl, int } /// /// (TreeItemId item, bool select=true)) +/// /// public bool GuiTreeViewCtrl_selectItem(string guitreeviewctrl, int id, bool select = true){ @@ -15019,6 +20839,7 @@ public bool GuiTreeViewCtrl_selectItem(string guitreeviewctrl, int id, bool sel } /// /// ( bool value=true ) - Enable/disable debug output. ) +/// /// public void GuiTreeViewCtrl_setDebug(string guitreeviewctrl, bool value = true){ @@ -15027,6 +20848,7 @@ public void GuiTreeViewCtrl_setDebug(string guitreeviewctrl, bool value = true) } /// /// ( int id, int normalImage, int expandedImage ) - Sets the normal and expanded images to show for the given item. ) +/// /// public void GuiTreeViewCtrl_setItemImages(string guitreeviewctrl, int id, sbyte normalImage, sbyte expandedImage){ @@ -15035,6 +20857,7 @@ public void GuiTreeViewCtrl_setItemImages(string guitreeviewctrl, int id, sbyte } /// /// ( int id, string text ) - Set the tooltip to show for the given item. ) +/// /// public void GuiTreeViewCtrl_setItemTooltip(string guitreeviewctrl, int id, string text){ @@ -15043,6 +20866,7 @@ public void GuiTreeViewCtrl_setItemTooltip(string guitreeviewctrl, int id, stri } /// /// ( TreeItemId id ) - Show the rename text field for the given item (only one at a time). ) +/// /// public void GuiTreeViewCtrl_showItemRenameCtrl(string guitreeviewctrl, int id){ @@ -15051,6 +20875,7 @@ public void GuiTreeViewCtrl_showItemRenameCtrl(string guitreeviewctrl, int id){ } /// /// ( int parent, bool traverseHierarchy=false, bool parentsFirst=false, bool caseSensitive=true ) - Sorts all items of the given parent (or root). With 'hierarchy', traverses hierarchy. ) +/// /// public void GuiTreeViewCtrl_sort(string guitreeviewctrl, int parent = 0, bool traverseHierarchy = false, bool parentsFirst = false, bool caseSensitive = true){ @@ -15058,7 +20883,12 @@ public void GuiTreeViewCtrl_sort(string guitreeviewctrl, int parent = 0, bool t m_ts.fn_GuiTreeViewCtrl_sort(guitreeviewctrl, parent, traverseHierarchy, parentsFirst, caseSensitive); } /// -/// Add an item/object to the current selection. @param id ID of item/object to add to the selection. @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, the control will defer refreshing the tree and wait until addSelection() is called with this parameter set to true. ) +/// Add an item/object to the current selection. +/// @param id ID of item/object to add to the selection. +/// @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, +/// the control will defer refreshing the tree and wait until addSelection() is called with this parameter set +/// to true. ) +/// /// public void addSelection(string guitreeviewctrl, int id, bool isLastSelection = true){ @@ -15066,7 +20896,10 @@ public void addSelection(string guitreeviewctrl, int id, bool isLastSelection = m_ts.fnGuiTreeViewCtrl_addSelection(guitreeviewctrl, id, isLastSelection); } /// -/// Clear the current item filtering pattern. @see setFilterText @see getFilterText ) +/// Clear the current item filtering pattern. +/// @see setFilterText +/// @see getFilterText ) +/// /// public void clearFilterText(string guitreeviewctrl){ @@ -15075,6 +20908,7 @@ public void clearFilterText(string guitreeviewctrl){ } /// /// Unselect all currently selected items. ) +/// /// public void clearSelection(string guitreeviewctrl){ @@ -15083,6 +20917,7 @@ public void clearSelection(string guitreeviewctrl){ } /// /// Delete all items/objects in the current selection. ) +/// /// public void deleteSelection(string guitreeviewctrl){ @@ -15090,7 +20925,12 @@ public void deleteSelection(string guitreeviewctrl){ m_ts.fnGuiTreeViewCtrl_deleteSelection(guitreeviewctrl); } /// -/// Get the child item of the given parent item whose text matches @a childName. @param parentId Item ID of the parent in which to look for the child. @param childName Text of the child item to find. @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. @note This method does not recurse, i.e. it only looks for direct children. ) +/// Get the child item of the given parent item whose text matches @a childName. +/// @param parentId Item ID of the parent in which to look for the child. +/// @param childName Text of the child item to find. +/// @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. +/// @note This method does not recurse, i.e. it only looks for direct children. ) +/// /// public int findChildItemByName(string guitreeviewctrl, int parentId, string childName){ @@ -15098,7 +20938,10 @@ public int findChildItemByName(string guitreeviewctrl, int parentId, string chi return m_ts.fnGuiTreeViewCtrl_findChildItemByName(guitreeviewctrl, parentId, childName); } /// -/// Get the ID of the item whose text matches the given @a text. @param text Item text to match. @return ID of the item or -1 if no item matches the given text. ) +/// Get the ID of the item whose text matches the given @a text. +/// @param text Item text to match. +/// @return ID of the item or -1 if no item matches the given text. ) +/// /// public int findItemByName(string guitreeviewctrl, string text){ @@ -15106,7 +20949,10 @@ public int findItemByName(string guitreeviewctrl, string text){ return m_ts.fnGuiTreeViewCtrl_findItemByName(guitreeviewctrl, text); } /// -/// Get the ID of the item whose value matches @a value. @param value Value text to match. @return ID of the item or -1 if no item has the given value. ) +/// Get the ID of the item whose value matches @a value. +/// @param value Value text to match. +/// @return ID of the item or -1 if no item has the given value. ) +/// /// public int findItemByValue(string guitreeviewctrl, string value){ @@ -15114,7 +20960,12 @@ public int findItemByValue(string guitreeviewctrl, string value){ return m_ts.fnGuiTreeViewCtrl_findItemByValue(guitreeviewctrl, value); } /// -/// Get the current filter expression. Only tree items whose text matches this expression are displayed. By default, the expression is empty and all items are shown. @return The current filter pattern or an empty string if no filter pattern is currently active. @see setFilterText @see clearFilterText ) +/// Get the current filter expression. Only tree items whose text matches this expression +/// are displayed. By default, the expression is empty and all items are shown. +/// @return The current filter pattern or an empty string if no filter pattern is currently active. +/// @see setFilterText +/// @see clearFilterText ) +/// /// public string getFilterText(string guitreeviewctrl){ @@ -15122,7 +20973,9 @@ public string getFilterText(string guitreeviewctrl){ return m_ts.fnGuiTreeViewCtrl_getFilterText(guitreeviewctrl); } /// -/// Call SimObject::setHidden( @a state ) on all objects in the current selection. @param state Visibility state to set objects in selection to. ) +/// Call SimObject::setHidden( @a state ) on all objects in the current selection. +/// @param state Visibility state to set objects in selection to. ) +/// /// public void hideSelection(string guitreeviewctrl, bool state = true){ @@ -15130,7 +20983,16 @@ public void hideSelection(string guitreeviewctrl, bool state = true){ m_ts.fnGuiTreeViewCtrl_hideSelection(guitreeviewctrl, state); } /// -/// , , 0, 0 ), Add a new item to the tree. @param parentId Item ID of parent to which to add the item as a child. 0 is root item. @param text Text to display on the item in the tree. @param value Behind-the-scenes value of the item. @param icon @param normalImage @param expandedImage @return The ID of the newly added item. ) +/// , , 0, 0 ), +/// Add a new item to the tree. +/// @param parentId Item ID of parent to which to add the item as a child. 0 is root item. +/// @param text Text to display on the item in the tree. +/// @param value Behind-the-scenes value of the item. +/// @param icon +/// @param normalImage +/// @param expandedImage +/// @return The ID of the newly added item. ) +/// /// public int insertItem(string guitreeviewctrl, int parentId, string text, string value = "", string icon = "", int normalImage = 0, int expandedImage = 0){ @@ -15139,6 +21001,7 @@ public int insertItem(string guitreeviewctrl, int parentId, string text, string } /// /// Inserts object as a child to the given parent. ) +/// /// public int insertObject(string guitreeviewctrl, int parentId, string obj, bool OKToEdit = false){ @@ -15146,7 +21009,10 @@ public int insertObject(string guitreeviewctrl, int parentId, string obj, bool return m_ts.fnGuiTreeViewCtrl_insertObject(guitreeviewctrl, parentId, obj, OKToEdit); } /// -/// Check whether the given item is currently selected in the tree. @param id Item/object ID. @return True if the given item/object is currently selected in the tree. ) +/// Check whether the given item is currently selected in the tree. +/// @param id Item/object ID. +/// @return True if the given item/object is currently selected in the tree. ) +/// /// public bool isItemSelected(string guitreeviewctrl, int id){ @@ -15154,7 +21020,10 @@ public bool isItemSelected(string guitreeviewctrl, int id){ return m_ts.fnGuiTreeViewCtrl_isItemSelected(guitreeviewctrl, id); } /// -/// Set whether the current selection can be changed by the user or not. @param lock If true, the current selection is frozen and cannot be changed. If false, the selection may be modified. ) +/// Set whether the current selection can be changed by the user or not. +/// @param lock If true, the current selection is frozen and cannot be changed. If false, +/// the selection may be modified. ) +/// /// public void lockSelection(string guitreeviewctrl, bool lockx = true){ @@ -15162,7 +21031,12 @@ public void lockSelection(string guitreeviewctrl, bool lockx = true){ m_ts.fnGuiTreeViewCtrl_lockSelection(guitreeviewctrl, lockx); } /// -/// Set the pattern by which to filter items in the tree. Only items in the tree whose text matches this pattern are displayed. @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. @see getFilterText @see clearFilterText ) +/// Set the pattern by which to filter items in the tree. Only items in the tree whose text +/// matches this pattern are displayed. +/// @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. +/// @see getFilterText +/// @see clearFilterText ) +/// /// public void setFilterText(string guitreeviewctrl, string pattern){ @@ -15171,6 +21045,7 @@ public void setFilterText(string guitreeviewctrl, string pattern){ } /// /// Toggle the hidden state of all objects in the current selection. ) +/// /// public void toggleHideSelection(string guitreeviewctrl){ @@ -15179,6 +21054,7 @@ public void toggleHideSelection(string guitreeviewctrl){ } /// /// Toggle the locked state of all objects in the current selection. ) +/// /// public void toggleLockSelection(string guitreeviewctrl){ @@ -15191,14 +21067,11 @@ public void toggleLockSelection(string guitreeviewctrl){ /// public class GuiTSCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTSCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. @param radius Radius in world-space units which should fit in the view. @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. +/// @param radius Radius in world-space units which should fit in the view. +/// @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// /// public float calculateViewDistance(string guitsctrl, float radius){ @@ -15207,6 +21080,7 @@ public float calculateViewDistance(string guitsctrl, float radius){ } /// /// ) +/// /// public string getClickVector(string guitsctrl, Point2I mousePoint){ @@ -15215,6 +21089,7 @@ public string getClickVector(string guitsctrl, Point2I mousePoint){ } /// /// ) +/// /// public string getWorldPosition(string guitsctrl, Point2I mousePoint){ @@ -15222,7 +21097,9 @@ public string getWorldPosition(string guitsctrl, Point2I mousePoint){ return m_ts.fnGuiTSCtrl_getWorldPosition(guitsctrl, mousePoint.AsString()); } /// -/// Get the ratio between world-space units and pixels. @return The amount of world-space units covered by the extent of a single pixel. ) +/// Get the ratio between world-space units and pixels. +/// @return The amount of world-space units covered by the extent of a single pixel. ) +/// /// public Point2F getWorldToScreenScale(string guitsctrl){ @@ -15230,7 +21107,10 @@ public Point2F getWorldToScreenScale(string guitsctrl){ return new Point2F ( m_ts.fnGuiTSCtrl_getWorldToScreenScale(guitsctrl)); } /// -/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. @param worldPosition The world-space position to transform to screen-space. @return The ) +/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. +/// @param worldPosition The world-space position to transform to screen-space. +/// @return The ) +/// /// public Point3F project(string guitsctrl, Point3F worldPosition){ @@ -15238,7 +21118,11 @@ public Point3F project(string guitsctrl, Point3F worldPosition){ return new Point3F ( m_ts.fnGuiTSCtrl_project(guitsctrl, worldPosition.AsString())); } /// -/// Transform 3D screen-space coordinates (x, y, depth) to world space. This method can be, for example, used to find the world-space position relating to the current mouse cursor position. @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. @return The world-space position corresponding to the given screen-space coordinates. ) +/// Transform 3D screen-space coordinates (x, y, depth) to world space. +/// This method can be, for example, used to find the world-space position relating to the current mouse cursor position. +/// @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. +/// @return The world-space position corresponding to the given screen-space coordinates. ) +/// /// public Point3F unproject(string guitsctrl, Point3F screenPosition){ @@ -15251,14 +21135,9 @@ public Point3F unproject(string guitsctrl, Point3F screenPosition){ /// public class GuiVariableInspectorObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiVariableInspectorObject(ref Omni ts){m_ts = ts;} /// /// loadVars( searchString ) ) +/// /// public void GuiVariableInspector_loadVars(string guivariableinspector, string searchString){ @@ -15271,14 +21150,9 @@ public void GuiVariableInspector_loadVars(string guivariableinspector, string s /// public class GuiWindowCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiWindowCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void attachTo(string guiwindowctrl, string window){ @@ -15287,6 +21161,7 @@ public void attachTo(string guiwindowctrl, string window){ } /// /// Puts the guiwindow back on the main canvas. ) +/// /// public void ClosePopOut(string guiwindowctrl){ @@ -15295,6 +21170,7 @@ public void ClosePopOut(string guiwindowctrl){ } /// /// Returns the title of the window. ) +/// /// public string getWindowTitle(string guiwindowctrl){ @@ -15303,6 +21179,7 @@ public string getWindowTitle(string guiwindowctrl){ } /// /// Returns if the title can be set or not. ) +/// /// public bool isTitleSet(string guiwindowctrl){ @@ -15311,6 +21188,7 @@ public bool isTitleSet(string guiwindowctrl){ } /// /// Puts the guiwindow on a new canvas. ) +/// /// public void OpenPopOut(string guiwindowctrl){ @@ -15319,6 +21197,7 @@ public void OpenPopOut(string guiwindowctrl){ } /// /// Bring the window to the front. ) +/// /// public void selectWindow(string guiwindowctrl){ @@ -15327,6 +21206,7 @@ public void selectWindow(string guiwindowctrl){ } /// /// Set the window's collapsing state. ) +/// /// public void setCollapseGroup(string guiwindowctrl, bool state){ @@ -15335,6 +21215,7 @@ public void setCollapseGroup(string guiwindowctrl, bool state){ } /// /// Displays the option to set the title of the window. ) +/// /// public void setContextTitle(string guiwindowctrl, bool title){ @@ -15343,6 +21224,7 @@ public void setContextTitle(string guiwindowctrl, bool title){ } /// /// Sets the title of the window. ) +/// /// public void setWindowTitle(string guiwindowctrl, string title){ @@ -15351,6 +21233,7 @@ public void setWindowTitle(string guiwindowctrl, string title){ } /// /// Toggle the window collapsing. ) +/// /// public void toggleCollapseGroup(string guiwindowctrl){ @@ -15363,14 +21246,29 @@ public void toggleCollapseGroup(string guiwindowctrl){ /// public class HTTPObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public HTTPObjectObject(ref Omni ts){m_ts = ts;} /// -/// ), @brief Send a GET command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Send the GET command to the server %httpObj.get(%url,%URI,%query); @endtsexample ) +/// ), +/// @brief Send a GET command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Send the GET command to the server +/// %httpObj.get(%url,%URI,%query); +/// @endtsexample +/// ) +/// /// public void get(string httpobject, string Address, string requirstURI, string query = ""){ @@ -15378,7 +21276,31 @@ public void get(string httpobject, string Address, string requirstURI, string q m_ts.fnHTTPObject_get(httpobject, Address, requirstURI, query); } /// -/// @brief Send POST command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. @param post Submission data to be processed. @note The post() method is currently non-functional. @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Specify the submission data. %post = \"\"; // Send the POST command to the server %httpObj.POST(%url,%URI,%query,%post); @endtsexample ) +/// @brief Send POST command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// @param post Submission data to be processed. +/// +/// @note The post() method is currently non-functional. +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Specify the submission data. +/// %post = \"\"; +/// // Send the POST command to the server +/// %httpObj.POST(%url,%URI,%query,%post); +/// @endtsexample +/// ) +/// /// public void post(string httpobject, string Address, string requirstURI, string query, string post){ @@ -15391,14 +21313,16 @@ public void post(string httpobject, string Address, string requirstURI, string /// public class ItemObject { -private Omni m_ts; - /// - /// - /// - /// -public ItemObject(ref Omni ts){m_ts = ts;} /// -/// @brief Get the normal of the surface on which the object is stuck. @return Returns The XYZ normal from where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the normal of the surface on which the object is stuck. +/// @return Returns The XYZ normal from where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string getLastStickyNormal(string item){ @@ -15406,7 +21330,15 @@ public string getLastStickyNormal(string item){ return m_ts.fnItem_getLastStickyNormal(item); } /// -/// @brief Get the position on the surface on which this Item is stuck. @return Returns The XYZ position of where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the position on the surface on which this Item is stuck. +/// @return Returns The XYZ position of where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string getLastStickyPos(string item){ @@ -15414,7 +21346,14 @@ public string getLastStickyPos(string item){ return m_ts.fnItem_getLastStickyPos(item); } /// -/// @brief Is the object at rest (ie, no longer moving)? @return True if the object is at rest, false if it is not. @tsexample // Query the item on if it is or is not at rest. %isAtRest = %item.isAtRest(); @endtsexample ) +/// @brief Is the object at rest (ie, no longer moving)? +/// @return True if the object is at rest, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not at rest. +/// %isAtRest = %item.isAtRest(); +/// @endtsexample +/// ) +/// /// public bool isAtRest(string item){ @@ -15422,7 +21361,15 @@ public bool isAtRest(string item){ return m_ts.fnItem_isAtRest(item); } /// -/// @brief Is the object still rotating? @return True if the object is still rotating, false if it is not. @tsexample // Query the item on if it is or is not rotating. %isRotating = %itemData.isRotating(); @endtsexample @see rotate ) +/// @brief Is the object still rotating? +/// @return True if the object is still rotating, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not rotating. +/// %isRotating = %itemData.isRotating(); +/// @endtsexample +/// @see rotate +/// ) +/// /// public bool isRotating(string item){ @@ -15430,7 +21377,15 @@ public bool isRotating(string item){ return m_ts.fnItem_isRotating(item); } /// -/// @brief Is the object static (ie, non-movable)? @return True if the object is static, false if it is not. @tsexample // Query the item on if it is or is not static. %isStatic = %itemData.isStatic(); @endtsexample @see static ) +/// @brief Is the object static (ie, non-movable)? +/// @return True if the object is static, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not static. +/// %isStatic = %itemData.isStatic(); +/// @endtsexample +/// @see static +/// ) +/// /// public bool isStatic(string item){ @@ -15438,7 +21393,23 @@ public bool isStatic(string item){ return m_ts.fnItem_isStatic(item); } /// -/// @brief Temporarily disable collisions against a specific ShapeBase object. This is useful to prevent a player from immediately picking up an Item they have just thrown. Only one object may be on the timeout list at a time. The timeout is defined as 15 ticks. @param objectID ShapeBase object ID to disable collisions against. @return Returns true if the ShapeBase object requested could be found, false if it could not. @tsexample // Set the ShapeBase Object ID to disable collisions against %ignoreColObj = %player.getID(); // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. %item.setCollisionTimeout(%ignoreColObj); @endtsexample ) +/// @brief Temporarily disable collisions against a specific ShapeBase object. +/// +/// This is useful to prevent a player from immediately picking up an Item they have +/// just thrown. Only one object may be on the timeout list at a time. The timeout is +/// defined as 15 ticks. +/// +/// @param objectID ShapeBase object ID to disable collisions against. +/// @return Returns true if the ShapeBase object requested could be found, false if it could not. +/// +/// @tsexample +/// // Set the ShapeBase Object ID to disable collisions against +/// %ignoreColObj = %player.getID(); +/// // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. +/// %item.setCollisionTimeout(%ignoreColObj); +/// @endtsexample +/// ) +/// /// public bool setCollisionTimeout(string item, int ignoreColObj){ @@ -15451,14 +21422,15 @@ public bool setCollisionTimeout(string item, int ignoreColObj){ /// public class LangTableObject { -private Omni m_ts; - /// - /// - /// - /// -public LangTableObject(ref Omni ts){m_ts = ts;} /// -/// , ), (string filename, [string languageName]) @brief Adds a language to the table @param filename Name and path to the language file @param languageName Optional name to assign to the new language entry @return True If file was successfully found and language created ) +/// , ), +/// (string filename, [string languageName]) +/// @brief Adds a language to the table +/// @param filename Name and path to the language file +/// @param languageName Optional name to assign to the new language entry +/// @return True If file was successfully found and language created +/// ) +/// /// public int LangTable_addLanguage(string langtable, string filename = "", string languageName = ""){ @@ -15466,7 +21438,10 @@ public int LangTable_addLanguage(string langtable, string filename = "", string return m_ts.fn_LangTable_addLanguage(langtable, filename, languageName); } /// -/// () @brief Get the ID of the current language table @return Numerical ID of the current language table) +/// () +/// @brief Get the ID of the current language table +/// @return Numerical ID of the current language table) +/// /// public int LangTable_getCurrentLanguage(string langtable){ @@ -15474,7 +21449,11 @@ public int LangTable_getCurrentLanguage(string langtable){ return m_ts.fn_LangTable_getCurrentLanguage(langtable); } /// -/// (int language) @brief Return the readable name of the language table @param language Numerical ID of the language table to access @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// (int language) +/// @brief Return the readable name of the language table +/// @param language Numerical ID of the language table to access +/// @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// /// public string LangTable_getLangName(string langtable, int langId){ @@ -15482,7 +21461,10 @@ public string LangTable_getLangName(string langtable, int langId){ return m_ts.fn_LangTable_getLangName(langtable, langId); } /// -/// () @brief Used to find out how many languages are in the table @return Size of the vector containing the languages, numerical) +/// () +/// @brief Used to find out how many languages are in the table +/// @return Size of the vector containing the languages, numerical) +/// /// public int LangTable_getNumLang(string langtable){ @@ -15490,7 +21472,13 @@ public int LangTable_getNumLang(string langtable){ return m_ts.fn_LangTable_getNumLang(langtable); } /// -/// (string filename) @brief Grabs a string from the specified table If an invalid is passed, the function will attempt to to grab from the default table @param filename Name of the language table to access @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// (string filename) +/// @brief Grabs a string from the specified table +/// If an invalid is passed, the function will attempt to +/// to grab from the default table +/// @param filename Name of the language table to access +/// @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// /// public string LangTable_getString(string langtable, uint id){ @@ -15498,7 +21486,10 @@ public string LangTable_getString(string langtable, uint id){ return m_ts.fn_LangTable_getString(langtable, id); } /// -/// (int language) @brief Sets the current language table for grabbing text @param language ID of the table) +/// (int language) +/// @brief Sets the current language table for grabbing text +/// @param language ID of the table) +/// /// public void LangTable_setCurrentLanguage(string langtable, int langId){ @@ -15506,7 +21497,10 @@ public void LangTable_setCurrentLanguage(string langtable, int langId){ m_ts.fn_LangTable_setCurrentLanguage(langtable, langId); } /// -/// (int language) @brief Sets the default language table @param language ID of the table) +/// (int language) +/// @brief Sets the default language table +/// @param language ID of the table) +/// /// public void LangTable_setDefaultLanguage(string langtable, int langId){ @@ -15519,14 +21513,9 @@ public void LangTable_setDefaultLanguage(string langtable, int langId){ /// public class LevelInfoObject { -private Omni m_ts; - /// - /// - /// - /// -public LevelInfoObject(ref Omni ts){m_ts = ts;} /// /// ( LevelInfo, setNearClip, void, 3, 3, ( F32 nearClip )) +/// /// public void setNearClip(string levelinfo, string a2= ""){ @@ -15539,14 +21528,9 @@ public void setNearClip(string levelinfo, string a2= ""){ /// public class LightBaseObject { -private Omni m_ts; - /// - /// - /// - /// -public LightBaseObject(ref Omni ts){m_ts = ts;} /// /// Stops the light animation. ) +/// /// public void LightBase_pauseAnimation(string lightbase){ @@ -15554,7 +21538,11 @@ public void LightBase_pauseAnimation(string lightbase){ m_ts.fn_LightBase_pauseAnimation(lightbase); } /// -/// ), ( [LightAnimData anim] )\t Plays a light animation on the light. If no LightAnimData is passed the existing one is played. @hide) +/// ), ( [LightAnimData anim] )\t +/// Plays a light animation on the light. If no LightAnimData is passed the +/// existing one is played. +/// @hide) +/// /// public void LightBase_playAnimation(string lightbase, string anim = ""){ @@ -15562,7 +21550,19 @@ public void LightBase_playAnimation(string lightbase, string anim = ""){ m_ts.fn_LightBase_playAnimation(lightbase, anim); } /// -/// @brief Toggles the light on and off @param state Turns the light on (true) or off (false) @tsexample // Disable the light CrystalLight.setLightEnabled(false); // Renable the light CrystalLight.setLightEnabled(true); @endtsexample) +/// @brief Toggles the light on and off +/// +/// @param state Turns the light on (true) or off (false) +/// +/// @tsexample +/// // Disable the light +/// CrystalLight.setLightEnabled(false); +/// // Renable the light +/// CrystalLight.setLightEnabled(true); +/// +/// @endtsexample +/// ) +/// /// public void setLightEnabled(string lightbase, bool state){ @@ -15575,14 +21575,23 @@ public void setLightEnabled(string lightbase, bool state){ /// public class LightDescriptionObject { -private Omni m_ts; - /// - /// - /// - /// -public LightDescriptionObject(ref Omni ts){m_ts = ts;} /// -/// @brief Force an inspectPostApply call for the benefit of tweaking via the console Normally this functionality is only exposed to objects via the World Editor, once changes have been made. Exposing apply to script allows you to make changes to it on the fly without the World Editor. @note This is intended for debugging and tweaking, not for game play @tsexample // Change a property of the light description RocketLauncherLightDesc.brightness = 10; // Make it so RocketLauncherLightDesc.apply(); @endtsexample) +/// @brief Force an inspectPostApply call for the benefit of tweaking via the console +/// +/// Normally this functionality is only exposed to objects via the World Editor, once changes have been made. +/// Exposing apply to script allows you to make changes to it on the fly without the World Editor. +/// +/// @note This is intended for debugging and tweaking, not for game play +/// +/// @tsexample +/// // Change a property of the light description +/// RocketLauncherLightDesc.brightness = 10; +/// // Make it so +/// RocketLauncherLightDesc.apply(); +/// +/// @endtsexample +/// ) +/// /// public void apply(string lightdescription){ @@ -15595,14 +21604,11 @@ public void apply(string lightdescription){ /// public class LightFlareDataObject { -private Omni m_ts; - /// - /// - /// - /// -public LightFlareDataObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply +/// ) +/// /// public void apply(string lightflaredata){ @@ -15615,14 +21621,10 @@ public void apply(string lightflaredata){ /// public class LightningObject { -private Omni m_ts; - /// - /// - /// - /// -public LightningObject(ref Omni ts){m_ts = ts;} /// -/// Creates a LightningStrikeEvent which strikes a specific object. @note This method is currently unimplemented. ) +/// Creates a LightningStrikeEvent which strikes a specific object. +/// @note This method is currently unimplemented. ) +/// /// public void strikeObject(string lightning, string pSB){ @@ -15630,7 +21632,13 @@ public void strikeObject(string lightning, string pSB){ m_ts.fnLightning_strikeObject(lightning, pSB); } /// -/// Creates a LightningStrikeEvent which attempts to strike and damage a random object in range of the Lightning object. @tsexample // Generate a damaging lightning strike effect on all clients %lightning.strikeRandomPoint(); @endtsexample ) +/// Creates a LightningStrikeEvent which attempts to strike and damage a random +/// object in range of the Lightning object. +/// @tsexample +/// // Generate a damaging lightning strike effect on all clients +/// %lightning.strikeRandomPoint(); +/// @endtsexample ) +/// /// public void strikeRandomPoint(string lightning){ @@ -15638,7 +21646,14 @@ public void strikeRandomPoint(string lightning){ m_ts.fnLightning_strikeRandomPoint(lightning); } /// -/// @brief Creates a LightningStrikeEvent that triggers harmless lightning bolts on all clients. No objects will be damaged by these bolts. @tsexample // Generate a harmless lightning strike effect on all clients %lightning.warningFlashes(); @endtsexample ) +/// @brief Creates a LightningStrikeEvent that triggers harmless lightning +/// bolts on all clients. +/// No objects will be damaged by these bolts. +/// @tsexample +/// // Generate a harmless lightning strike effect on all clients +/// %lightning.warningFlashes(); +/// @endtsexample ) +/// /// public void warningFlashes(string lightning){ @@ -15651,14 +21666,9 @@ public void warningFlashes(string lightning){ /// public class MaterialObject { -private Omni m_ts; - /// - /// - /// - /// -public MaterialObject(ref Omni ts){m_ts = ts;} /// /// Dumps a formatted list of the currently allocated material instances for this material to the console. ) +/// /// public void Material_dumpInstances(string material){ @@ -15667,6 +21677,7 @@ public void Material_dumpInstances(string material){ } /// /// Flushes all material instances that use this material. ) +/// /// public void Material_flush(string material){ @@ -15675,6 +21686,7 @@ public void Material_flush(string material){ } /// /// ) +/// /// public string Material_getAnimFlags(string material, uint id){ @@ -15683,6 +21695,7 @@ public string Material_getAnimFlags(string material, uint id){ } /// /// Get filename of material) +/// /// public string Material_getFilename(string material){ @@ -15691,6 +21704,7 @@ public string Material_getFilename(string material){ } /// /// Returns true if this Material was automatically generated by MaterialList::mapMaterials() ) +/// /// public bool Material_isAutoGenerated(string material){ @@ -15699,6 +21713,7 @@ public bool Material_isAutoGenerated(string material){ } /// /// Reloads all material instances that use this material. ) +/// /// public void Material_reload(string material){ @@ -15707,6 +21722,7 @@ public void Material_reload(string material){ } /// /// setAutoGenerated(bool isAutoGenerated): Set whether or not the Material is autogenerated. ) +/// /// public void Material_setAutoGenerated(string material, bool isAutoGenerated){ @@ -15719,14 +21735,9 @@ public void Material_setAutoGenerated(string material, bool isAutoGenerated){ /// public class MECreateUndoActionObject { -private Omni m_ts; - /// - /// - /// - /// -public MECreateUndoActionObject(ref Omni ts){m_ts = ts;} /// /// ( SimObject obj )) +/// /// public void MECreateUndoAction_addObject(string mecreateundoaction, string obj){ @@ -15739,14 +21750,9 @@ public void MECreateUndoAction_addObject(string mecreateundoaction, string obj) /// public class MEDeleteUndoActionObject { -private Omni m_ts; - /// - /// - /// - /// -public MEDeleteUndoActionObject(ref Omni ts){m_ts = ts;} /// /// ( SimObject obj )) +/// /// public void MEDeleteUndoAction_deleteObject(string medeleteundoaction, string obj){ @@ -15759,14 +21765,9 @@ public void MEDeleteUndoAction_deleteObject(string medeleteundoaction, string o /// public class MenuBarObject { -private Omni m_ts; - /// - /// - /// - /// -public MenuBarObject(ref Omni ts){m_ts = ts;} /// /// (GuiCanvas, pos)) +/// /// public void MenuBar_attachToCanvas(string menubar, string canvas, int pos){ @@ -15775,6 +21776,7 @@ public void MenuBar_attachToCanvas(string menubar, string canvas, int pos){ } /// /// (object, pos) insert object at position) +/// /// public void MenuBar_insert(string menubar, string pObject, int pos){ @@ -15783,6 +21785,7 @@ public void MenuBar_insert(string menubar, string pObject, int pos){ } /// /// ()) +/// /// public void MenuBar_removeFromCanvas(string menubar){ @@ -15795,14 +21798,12 @@ public void MenuBar_removeFromCanvas(string menubar){ /// public class MeshRoadObject { -private Omni m_ts; - /// - /// - /// - /// -public MeshRoadObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void postApply(string meshroad){ @@ -15810,7 +21811,10 @@ public void postApply(string meshroad){ m_ts.fnMeshRoad_postApply(meshroad); } /// -/// Intended as a helper to developers and editor scripts. Force MeshRoad to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force MeshRoad to recreate its geometry. +/// ) +/// /// public void regenerate(string meshroad){ @@ -15818,7 +21822,10 @@ public void regenerate(string meshroad){ m_ts.fnMeshRoad_regenerate(meshroad); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void setNodeDepth(string meshroad, int idx, float meters){ @@ -15831,14 +21838,9 @@ public void setNodeDepth(string meshroad, int idx, float meters){ /// public class MessageObject { -private Omni m_ts; - /// - /// - /// - /// -public MessageObject(ref Omni ts){m_ts = ts;} /// /// () Increment the reference count for this message) +/// /// public void Message_addReference(string message){ @@ -15847,6 +21849,7 @@ public void Message_addReference(string message){ } /// /// () Decrement the reference count for this message) +/// /// public void Message_freeReference(string message){ @@ -15855,6 +21858,7 @@ public void Message_freeReference(string message){ } /// /// () Get message type (script class name or C++ class name if no script defined class)) +/// /// public string Message_getType(string message){ @@ -15867,14 +21871,11 @@ public string Message_getType(string message){ /// public class MessageVectorObject { -private Omni m_ts; - /// - /// - /// - /// -public MessageVectorObject(ref Omni ts){m_ts = ts;} /// -/// ), (string filename, string header=NULL) Dump the message vector to a file, optionally prefixing a header. @hide) +/// ), (string filename, string header=NULL) +/// Dump the message vector to a file, optionally prefixing a header. +/// @hide) +/// /// public void MessageVector_dump(string messagevector, string filename, string header = ""){ @@ -15882,7 +21883,11 @@ public void MessageVector_dump(string messagevector, string filename, string he m_ts.fn_MessageVector_dump(messagevector, filename, header); } /// -/// Clear all messages in the vector @tsexample HudMessageVector.clear(); @endtsexample) +/// Clear all messages in the vector +/// @tsexample +/// HudMessageVector.clear(); +/// @endtsexample) +/// /// public void clear(string messagevector){ @@ -15890,7 +21895,14 @@ public void clear(string messagevector){ m_ts.fnMessageVector_clear(messagevector); } /// -/// Delete the line at the specified position. @param deletePos Position in the vector containing the line to be deleted @tsexample // Delete the first line (index 0) in the vector... HudMessageVector.deleteLine(0); @endtsexample @return False if deletePos is greater than the number of lines in the current vector) +/// Delete the line at the specified position. +/// @param deletePos Position in the vector containing the line to be deleted +/// @tsexample +/// // Delete the first line (index 0) in the vector... +/// HudMessageVector.deleteLine(0); +/// @endtsexample +/// @return False if deletePos is greater than the number of lines in the current vector) +/// /// public bool deleteLine(string messagevector, int deletePos){ @@ -15898,7 +21910,15 @@ public bool deleteLine(string messagevector, int deletePos){ return m_ts.fnMessageVector_deleteLine(messagevector, deletePos); } /// -/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate a line of text tagged with the value \"1\", then delete it. %taggedLine = HudMessageVector.getLineIndexByTag(1); HudMessageVector.deleteLine(%taggedLine); @endtsexample @return Line with matching tag, other wise -1) +/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate a line of text tagged with the value \"1\", then delete it. +/// %taggedLine = HudMessageVector.getLineIndexByTag(1); +/// HudMessageVector.deleteLine(%taggedLine); +/// @endtsexample +/// @return Line with matching tag, other wise -1) +/// /// public int getLineIndexByTag(string messagevector, int tag){ @@ -15906,7 +21926,20 @@ public int getLineIndexByTag(string messagevector, int tag){ return m_ts.fnMessageVector_getLineIndexByTag(messagevector, tag); } /// -/// Get the tag of a specified line. @param pos Position in vector to grab tag from @tsexample // Remove all lines that do not have a tag value of 1. while( HudMessageVector.getNumLines()) { %tag = HudMessageVector.getLineTag(1); if(%tag != 1) %tag.delete(); HudMessageVector.popFrontLine(); } @endtsexample @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// Get the tag of a specified line. +/// @param pos Position in vector to grab tag from +/// @tsexample +/// // Remove all lines that do not have a tag value of 1. +/// while( HudMessageVector.getNumLines()) +/// { +/// %tag = HudMessageVector.getLineTag(1); +/// if(%tag != 1) +/// %tag.delete(); +/// HudMessageVector.popFrontLine(); +/// } +/// @endtsexample +/// @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// /// public int getLineTag(string messagevector, int pos){ @@ -15914,7 +21947,15 @@ public int getLineTag(string messagevector, int pos){ return m_ts.fnMessageVector_getLineTag(messagevector, pos); } /// -/// Get the text at a specified line. @param pos Position in vector to grab text from @tsexample // Print a line of text at position 1. %text = HudMessageVector.getLineText(1); echo(%text); @endtsexample @return Text at specified line, if the position is greater than the number of lines return \"\") +/// Get the text at a specified line. +/// @param pos Position in vector to grab text from +/// @tsexample +/// // Print a line of text at position 1. +/// %text = HudMessageVector.getLineText(1); +/// echo(%text); +/// @endtsexample +/// @return Text at specified line, if the position is greater than the number of lines return \"\") +/// /// public string getLineText(string messagevector, int pos){ @@ -15922,7 +21963,15 @@ public string getLineText(string messagevector, int pos){ return m_ts.fnMessageVector_getLineText(messagevector, pos); } /// -/// Scan through the lines in the vector, returning the first line that has a matching tag. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate text in the vector tagged with the value \"1\", then print it %taggedText = HudMessageVector.getLineTextByTag(1); echo(%taggedText); @endtsexample @return Text from a line with matching tag, other wise \"\") +/// Scan through the lines in the vector, returning the first line that has a matching tag. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate text in the vector tagged with the value \"1\", then print it +/// %taggedText = HudMessageVector.getLineTextByTag(1); +/// echo(%taggedText); +/// @endtsexample +/// @return Text from a line with matching tag, other wise \"\") +/// /// public string getLineTextByTag(string messagevector, int tag){ @@ -15930,7 +21979,13 @@ public string getLineTextByTag(string messagevector, int tag){ return m_ts.fnMessageVector_getLineTextByTag(messagevector, tag); } /// -/// Get the number of lines in the vector. @tsexample // Find out how many lines have been stored in HudMessageVector %chatLines = HudMessageVector.getNumLines(); echo(%chatLines); @endtsexample) +/// Get the number of lines in the vector. +/// @tsexample +/// // Find out how many lines have been stored in HudMessageVector +/// %chatLines = HudMessageVector.getNumLines(); +/// echo(%chatLines); +/// @endtsexample) +/// /// public int getNumLines(string messagevector){ @@ -15938,7 +21993,15 @@ public int getNumLines(string messagevector){ return m_ts.fnMessageVector_getNumLines(messagevector); } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.insertLine(1, \"Hello World\", 0); @endtsexample @return False if insertPos is greater than the number of lines in the current vector) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.insertLine(1, \"Hello World\", 0); +/// @endtsexample +/// @return False if insertPos is greater than the number of lines in the current vector) +/// /// public bool insertLine(string messagevector, int insertPos, string msg, int tag){ @@ -15946,7 +22009,12 @@ public bool insertLine(string messagevector, int insertPos, string msg, int tag return m_ts.fnMessageVector_insertLine(messagevector, insertPos, msg, tag); } /// -/// Pop a line from the back of the list; destroys the line. @tsexample HudMessageVector.popBackLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the back of the list; destroys the line. +/// @tsexample +/// HudMessageVector.popBackLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool popBackLine(string messagevector){ @@ -15954,7 +22022,12 @@ public bool popBackLine(string messagevector){ return m_ts.fnMessageVector_popBackLine(messagevector); } /// -/// Pop a line from the front of the vector, destroying the line. @tsexample HudMessageVector.popFrontLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the front of the vector, destroying the line. +/// @tsexample +/// HudMessageVector.popFrontLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool popFrontLine(string messagevector){ @@ -15962,7 +22035,14 @@ public bool popFrontLine(string messagevector){ return m_ts.fnMessageVector_popFrontLine(messagevector); } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushBackLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushBackLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void pushBackLine(string messagevector, string msg, int tag){ @@ -15970,7 +22050,14 @@ public void pushBackLine(string messagevector, string msg, int tag){ m_ts.fnMessageVector_pushBackLine(messagevector, msg, tag); } /// -/// Push a line onto the front of the vector. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushFrontLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the front of the vector. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushFrontLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void pushFrontLine(string messagevector, string msg, int tag){ @@ -15983,14 +22070,9 @@ public void pushFrontLine(string messagevector, string msg, int tag){ /// public class MissionAreaObject { -private Omni m_ts; - /// - /// - /// - /// -public MissionAreaObject(ref Omni ts){m_ts = ts;} /// /// Returns 4 fields: starting x, starting y, extents x, extents y.) +/// /// public string getArea(string missionarea){ @@ -15998,7 +22080,11 @@ public string getArea(string missionarea){ return m_ts.fnMissionArea_getArea(missionarea); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void postApply(string missionarea){ @@ -16006,7 +22092,14 @@ public void postApply(string missionarea){ m_ts.fnMissionArea_postApply(missionarea); } /// -/// @brief - Defines the size of the MissionArea param x Starting X coordinate position for MissionArea param y Starting Y coordinate position for MissionArea param width New width of the MissionArea param height New height of the MissionArea @note Only the server object may be set. ) +/// @brief - Defines the size of the MissionArea +/// param x Starting X coordinate position for MissionArea +/// param y Starting Y coordinate position for MissionArea +/// param width New width of the MissionArea +/// param height New height of the MissionArea +/// @note Only the server object may be set. +/// ) +/// /// public void setArea(string missionarea, int x, int y, int width, int height){ @@ -16019,12 +22112,6 @@ public void setArea(string missionarea, int x, int y, int width, int height){ /// public class NavMeshObject { -private Omni m_ts; - /// - /// - /// - /// -public NavMeshObject(ref Omni ts){m_ts = ts;} /// /// Add a link to this NavMesh between two points. /// ) @@ -16185,12 +22272,6 @@ public void setLinkFlags(string navmesh, uint id, uint flags){ /// public class NavPathObject { -private Omni m_ts; - /// - /// - /// - /// -public NavPathObject(ref Omni ts){m_ts = ts;} /// /// @brief Get a specified node along the path.) /// @@ -16260,14 +22341,16 @@ public int size(string navpath){ /// public class NetConnectionObject { -private Omni m_ts; - /// - /// - /// - /// -public NetConnectionObject(ref Omni ts){m_ts = ts;} /// -/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. This method is normally only called when a NetConnection class is first constructed. It need only be manually called if the global variables that set the packet rate or size have changed. @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize have been changed since a NetConnection has been created, this method must be called on all connections for them to follow the new rates or size.) +/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. +/// +/// This method is normally only called when a NetConnection class is first constructed. It need +/// only be manually called if the global variables that set the packet rate or size have changed. +/// +/// @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize +/// have been changed since a NetConnection has been created, this method must be called on +/// all connections for them to follow the new rates or size.) +/// /// public void checkMaxRate(string netconnection){ @@ -16275,7 +22358,27 @@ public void checkMaxRate(string netconnection){ m_ts.fnNetConnection_checkMaxRate(netconnection); } /// -/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that motion spline paths have not been transmitted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see transmitPaths() @see Path) +/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that motion spline paths have not been transmitted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see transmitPaths() +/// @see Path) +/// /// public void clearPaths(string netconnection){ @@ -16283,7 +22386,23 @@ public void clearPaths(string netconnection){ m_ts.fnNetConnection_clearPaths(netconnection); } /// -/// @brief Connects to the remote address. Attempts to connect with another NetConnection on the given address. Typically once connected, a game's information is passed along from the server to the client, followed by the player entering the game world. The actual procedure is dependent on the NetConnection subclass that is used. i.e. GameConnection. @param remoteAddress The address to connect to in the form of IP:address>:port although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also substitue the word i>broadcast/i> for the address to broadcast the connect request over the local subnet. @see NetConnection::connectLocal() to connect to a server running within the same process as the client. ) +/// @brief Connects to the remote address. +/// +/// Attempts to connect with another NetConnection on the given address. Typically once +/// connected, a game's information is passed along from the server to the client, followed +/// by the player entering the game world. The actual procedure is dependent on +/// the NetConnection subclass that is used. i.e. GameConnection. +/// +/// @param remoteAddress The address to connect to in the form of IP:address>:port +/// although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form +/// of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also +/// substitue the word i>broadcast/i> for the address to broadcast the connect request over +/// the local subnet. +/// +/// @see NetConnection::connectLocal() to connect to a server running within the same process +/// as the client. +/// ) +/// /// public void connect(string netconnection, string remoteAddress){ @@ -16291,7 +22410,13 @@ public void connect(string netconnection, string remoteAddress){ m_ts.fnNetConnection_connect(netconnection, remoteAddress); } /// -/// @brief Connects with the server that is running within the same process as the client. @returns An error text message upon failure, or an empty string when successful. @see See @ref local_connections for a description of local connections and their use. See NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// @brief Connects with the server that is running within the same process as the client. +/// +/// @returns An error text message upon failure, or an empty string when successful. +/// +/// @see See @ref local_connections for a description of local connections and their use. See +/// NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// /// public string connectLocal(string netconnection){ @@ -16299,7 +22424,13 @@ public string connectLocal(string netconnection){ return m_ts.fnNetConnection_connectLocal(netconnection); } /// -/// @brief Returns the far end network address for the connection. The address will be in one of the following forms: - b>IP:Broadcast:port>/b> for broadcast type addresses - b>IP:address>:port>/b> for IP addresses - b>local/b> when connected locally (server and client running in same process) +/// @brief Returns the far end network address for the connection. +/// +/// The address will be in one of the following forms: +/// - b>IP:Broadcast:port>/b> for broadcast type addresses +/// - b>IP:address>:port>/b> for IP addresses +/// - b>local/b> when connected locally (server and client running in same process) +/// /// public string getAddress(string netconnection){ @@ -16307,7 +22438,16 @@ public string getAddress(string netconnection){ return m_ts.fnNetConnection_getAddress(netconnection); } /// -/// @brief On server or client, convert a real id to the ghost id for this connection. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server or client to discover an object's ghost ID based on its real SimObject ID. @param realID The real SimObject ID of the object. @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On server or client, convert a real id to the ghost id for this connection. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server or client to discover an object's ghost ID based on its real SimObject ID. +/// +/// @param realID The real SimObject ID of the object. +/// @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int getGhostID(string netconnection, int realID){ @@ -16325,7 +22465,10 @@ public int GetGhostIndex(string netconnection, string obj){ return m_ts.fnNetConnection_GetGhostIndex(netconnection, obj); } /// -/// @brief Provides the number of active ghosts on the connection. @returns The number of active ghosts. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Provides the number of active ghosts on the connection. +/// @returns The number of active ghosts. +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int getGhostsActive(string netconnection){ @@ -16333,7 +22476,10 @@ public int getGhostsActive(string netconnection){ return m_ts.fnNetConnection_getGhostsActive(netconnection); } /// -/// @brief Returns the percentage of packets lost per tick. @note This method is not yet hooked up.) +/// @brief Returns the percentage of packets lost per tick. +/// +/// @note This method is not yet hooked up.) +/// /// public int getPacketLoss(string netconnection){ @@ -16341,7 +22487,12 @@ public int getPacketLoss(string netconnection){ return m_ts.fnNetConnection_getPacketLoss(netconnection); } /// -/// @brief Returns the average round trip time (in ms) for the connection. The round trip time is recalculated every time a notify packet is received. Notify packets are used to information the connection that the far end successfully received the sent packet.) +/// @brief Returns the average round trip time (in ms) for the connection. +/// +/// The round trip time is recalculated every time a notify packet is received. Notify +/// packets are used to information the connection that the far end successfully received +/// the sent packet.) +/// /// public int getPing(string netconnection){ @@ -16359,7 +22510,21 @@ public int ResolveGhost(string netconnection, int ghostIndex){ return m_ts.fnNetConnection_ResolveGhost(netconnection, ghostIndex); } /// -/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the client to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = ServerConnection.resolveGhostID( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the client to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = ServerConnection.resolveGhostID( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int resolveGhostID(string netconnection, int ghostID){ @@ -16367,7 +22532,21 @@ public int resolveGhostID(string netconnection, int ghostID){ return m_ts.fnNetConnection_resolveGhostID(netconnection, ghostID); } /// -/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = %client.resolveObjectFromGhostIndex( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = %client.resolveObjectFromGhostIndex( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int resolveObjectFromGhostIndex(string netconnection, int ghostID){ @@ -16375,7 +22554,12 @@ public int resolveObjectFromGhostIndex(string netconnection, int ghostID){ return m_ts.fnNetConnection_resolveObjectFromGhostIndex(netconnection, ghostID); } /// -/// @brief Simulate network issues on the connection for testing. @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute integer, measured in ms.) +/// @brief Simulate network issues on the connection for testing. +/// +/// @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) +/// @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute +/// integer, measured in ms.) +/// /// public void setSimulatedNetParams(string netconnection, float packetLoss, int delay){ @@ -16383,7 +22567,44 @@ public void setSimulatedNetParams(string netconnection, float packetLoss, int d m_ts.fnNetConnection_setSimulatedNetParams(netconnection, packetLoss, delay); } /// -/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. The server transmits all spline motion paths that are within the mission (Path) separate from other objects. This is due to the potentially large number of nodes within each path, which may saturate a packet sent to the client. By managing this step separately, Torque has finer control over how packets are organised vs. doing it during the ghosting stage. Internally a PathManager is used to track all paths defined within a mission on the server, and each one is transmitted using a PathManagerEvent. The client side collects these events and builds the given paths within its own PathManager. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. When a mission is ended, all paths need to be cleared from their respective path managers. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mission paths (SimPath), this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see clearPaths() @see Path) +/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. +/// +/// The server transmits all spline motion paths that are within the mission (Path) separate from +/// other objects. This is due to the potentially large number of nodes within each path, which may +/// saturate a packet sent to the client. By managing this step separately, Torque has finer control +/// over how packets are organised vs. doing it during the ghosting stage. +/// +/// Internally a PathManager is used to track all paths defined within a mission on the server, and each +/// one is transmitted using a PathManagerEvent. The client side collects these events and builds the +/// given paths within its own PathManager. This is typically done during the standard mission start +/// phase 2 when following Torque's example mission startup sequence. +/// +/// When a mission is ended, all paths need to be cleared from their respective path managers. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mission paths (SimPath), this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see clearPaths() +/// @see Path) +/// /// public void transmitPaths(string netconnection){ @@ -16396,14 +22617,13 @@ public void transmitPaths(string netconnection){ /// public class NetObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public NetObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Undo the effects of a scopeToClient() call. @param client The connection to remove this object's scoping from @see scopeToClient()) +/// @brief Undo the effects of a scopeToClient() call. +/// +/// @param client The connection to remove this object's scoping from +/// +/// @see scopeToClient()) +/// /// public void clearScopeToClient(string netobject, string client){ @@ -16411,7 +22631,22 @@ public void clearScopeToClient(string netobject, string client){ m_ts.fnNetObject_clearScopeToClient(netobject, client); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. @returns the SimObject ID of the client object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %clientObject = %node.getClientObject(); if(isObject(%clientObject) %clientObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns the SimObject ID of the client object. +/// +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %clientObject = %node.getClientObject(); +/// if(isObject(%clientObject) +/// %clientObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int getClientObject(string netobject){ @@ -16419,7 +22654,14 @@ public int getClientObject(string netobject){ return m_ts.fnNetObject_getClientObject(netobject); } /// -/// @brief Get the ghost index of this object from the server. @returns The ghost ID of this NetObject on the server @tsexample %ghostID = LocalClientConnection.getGhostId( %serverObject ); @endtsexample) +/// @brief Get the ghost index of this object from the server. +/// +/// @returns The ghost ID of this NetObject on the server +/// +/// @tsexample +/// %ghostID = LocalClientConnection.getGhostId( %serverObject ); +/// @endtsexample) +/// /// public int getGhostID(string netobject){ @@ -16427,7 +22669,21 @@ public int getGhostID(string netobject){ return m_ts.fnNetObject_getGhostID(netobject); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. @returns The SimObject ID of the server object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %serverObject = %node.getServerObject(); if(isObject(%serverObject) %serverObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns The SimObject ID of the server object. +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %serverObject = %node.getServerObject(); +/// if(isObject(%serverObject) +/// %serverObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int getServerObject(string netobject){ @@ -16435,7 +22691,9 @@ public int getServerObject(string netobject){ return m_ts.fnNetObject_getServerObject(netobject); } /// -/// @brief Called to check if an object resides on the clientside. @return True if the object resides on the client, false otherwise.) +/// @brief Called to check if an object resides on the clientside. +/// @return True if the object resides on the client, false otherwise.) +/// /// public bool isClientObject(string netobject){ @@ -16443,7 +22701,9 @@ public bool isClientObject(string netobject){ return m_ts.fnNetObject_isClientObject(netobject); } /// -/// @brief Checks if an object resides on the server. @return True if the object resides on the server, false otherwise.) +/// @brief Checks if an object resides on the server. +/// @return True if the object resides on the server, false otherwise.) +/// /// public bool isServerObject(string netobject){ @@ -16451,7 +22711,29 @@ public bool isServerObject(string netobject){ return m_ts.fnNetObject_isServerObject(netobject); } /// -/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. @param client The connection this object will always be scoped to @tsexample // Called to create new cameras in TorqueScript // %this - The active GameConnection // %spawnPoint - The spawn point location where we creat the camera function GameConnection::spawnCamera(%this, %spawnPoint) { // If this connection's camera exists if(isObject(%this.camera)) { // Add it to the mission group to be cleaned up later MissionCleanup.add( %this.camera ); // Force it to scope to the client side %this.camera.scopeToClient(%this); } } @endtsexample @see clearScopeToClient()) +/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. +/// +/// @param client The connection this object will always be scoped to +/// +/// @tsexample +/// // Called to create new cameras in TorqueScript +/// // %this - The active GameConnection +/// // %spawnPoint - The spawn point location where we creat the camera +/// function GameConnection::spawnCamera(%this, %spawnPoint) +/// { +/// // If this connection's camera exists +/// if(isObject(%this.camera)) +/// { +/// // Add it to the mission group to be cleaned up later +/// MissionCleanup.add( %this.camera ); +/// // Force it to scope to the client side +/// %this.camera.scopeToClient(%this); +/// } +/// } +/// @endtsexample +/// +/// @see clearScopeToClient()) +/// /// public void scopeToClient(string netobject, string client){ @@ -16459,7 +22741,12 @@ public void scopeToClient(string netobject, string client){ m_ts.fnNetObject_scopeToClient(netobject, client); } /// -/// @brief Always scope this object on all connections. The object is marked as ScopeAlways and is immediately ghosted to all active connections. This function has no effect if the object is not marked as Ghostable.) +/// @brief Always scope this object on all connections. +/// +/// The object is marked as ScopeAlways and is immediately ghosted to +/// all active connections. This function has no effect if the object +/// is not marked as Ghostable.) +/// /// public void setScopeAlways(string netobject){ @@ -16472,14 +22759,17 @@ public void setScopeAlways(string netobject){ /// public class ParticleDataObject { -private Omni m_ts; - /// - /// - /// - /// -public ParticleDataObject(ref Omni ts){m_ts = ts;} /// -/// Reloads this particle. @tsexample // Get the editor's current particle %particle = PE_ParticleEditor.currParticle // Change a particle value %particle.setFieldValue( %propertyField, %value ); // Reload it %particle.reload(); @endtsexample ) +/// Reloads this particle. +/// @tsexample +/// // Get the editor's current particle +/// %particle = PE_ParticleEditor.currParticle +/// // Change a particle value +/// %particle.setFieldValue( %propertyField, %value ); +/// // Reload it +/// %particle.reload(); +/// @endtsexample ) +/// /// public void reload(string particledata){ @@ -16492,14 +22782,17 @@ public void reload(string particledata){ /// public class ParticleEmitterDataObject { -private Omni m_ts; - /// - /// - /// - /// -public ParticleEmitterDataObject(ref Omni ts){m_ts = ts;} /// -/// Reloads the ParticleData datablocks and other fields used by this emitter. @tsexample // Get the editor's current particle emitter %emitter = PE_EmitterEditor.currEmitter // Change a field value %emitter.setFieldValue( %propertyField, %value ); // Reload this emitter %emitter.reload(); @endtsexample) +/// Reloads the ParticleData datablocks and other fields used by this emitter. +/// @tsexample +/// // Get the editor's current particle emitter +/// %emitter = PE_EmitterEditor.currEmitter +/// // Change a field value +/// %emitter.setFieldValue( %propertyField, %value ); +/// // Reload this emitter +/// %emitter.reload(); +/// @endtsexample) +/// /// public void reload(string particleemitterdata){ @@ -16512,14 +22805,10 @@ public void reload(string particleemitterdata){ /// public class ParticleEmitterNodeObject { -private Omni m_ts; - /// - /// - /// - /// -public ParticleEmitterNodeObject(ref Omni ts){m_ts = ts;} /// -/// Turns the emitter on or off. @param active New emitter state ) +/// Turns the emitter on or off. +/// @param active New emitter state ) +/// /// public void setActive(string particleemitternode, bool active){ @@ -16527,7 +22816,13 @@ public void setActive(string particleemitternode, bool active){ m_ts.fnParticleEmitterNode_setActive(particleemitternode, active); } /// -/// Assigns the datablock for this emitter node. @param emitterDatablock ParticleEmitterData datablock to assign @tsexample // Assign a new emitter datablock %emitter.setEmitterDatablock( %emitterDatablock ); @endtsexample ) +/// Assigns the datablock for this emitter node. +/// @param emitterDatablock ParticleEmitterData datablock to assign +/// @tsexample +/// // Assign a new emitter datablock +/// %emitter.setEmitterDatablock( %emitterDatablock ); +/// @endtsexample ) +/// /// public void setEmitterDataBlock(string particleemitternode, string emitterDatablock = null ){ if (emitterDatablock== null) {emitterDatablock = null;} @@ -16541,14 +22836,13 @@ public void setEmitterDataBlock(string particleemitternode, string emitterDatab /// public class PathCameraObject { -private Omni m_ts; - /// - /// - /// - /// -public PathCameraObject(ref Omni ts){m_ts = ts;} /// -/// Removes the knot at the front of the camera's path. @tsexample // Remove the first knot in the camera's path. %pathCamera.popFront(); @endtsexample) +/// Removes the knot at the front of the camera's path. +/// @tsexample +/// // Remove the first knot in the camera's path. +/// %pathCamera.popFront(); +/// @endtsexample) +/// /// public void popFront(string pathcamera){ @@ -16556,7 +22850,25 @@ public void popFront(string pathcamera){ m_ts.fnPathCamera_popFront(pathcamera); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the back of its path %pathCamera.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the back of its path +/// %pathCamera.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void pushBack(string pathcamera, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -16564,7 +22876,25 @@ public void pushBack(string pathcamera, TransformF transform, float speed = 1.0 m_ts.fnPathCamera_pushBack(pathcamera, transform.AsString(), speed, type, path); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the front of its path %pathCamera.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the front of its path +/// %pathCamera.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void pushFront(string pathcamera, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -16572,7 +22902,20 @@ public void pushFront(string pathcamera, TransformF transform, float speed = 1. m_ts.fnPathCamera_pushFront(pathcamera, transform.AsString(), speed, type, path); } /// -/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. What specifically occurs is a new knot is created from the camera's current transform. Then the current path is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement state is set to Forward. The camera is now ready for a new path to be defined. @param speed Speed for the camera to move along its path after being reset. @tsexample //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. %speed = \"0.50\"; // Inform the path camera to start a new path at // the camera's current position, and set the new // path's speed value. %pathCamera.reset(%speed); @endtsexample) +/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. +/// What specifically occurs is a new knot is created from the camera's current transform. Then the current path +/// is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement +/// state is set to Forward. The camera is now ready for a new path to be defined. +/// @param speed Speed for the camera to move along its path after being reset. +/// @tsexample +/// //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. +/// %speed = \"0.50\"; +/// // Inform the path camera to start a new path at +/// // the camera's current position, and set the new +/// // path's speed value. +/// %pathCamera.reset(%speed); +/// @endtsexample) +/// /// public void reset(string pathcamera, float speed = 1.0f){ @@ -16580,7 +22923,15 @@ public void reset(string pathcamera, float speed = 1.0f){ m_ts.fnPathCamera_reset(pathcamera, speed); } /// -/// Set the current position of the camera along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. @tsexample // Set the camera on a position along its path from 0.0 - 1.0. %position = \"0.35\"; // Force the pathCamera to its new position along the path. %pathCamera.setPosition(%position); @endtsexample) +/// Set the current position of the camera along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. +/// @tsexample +/// // Set the camera on a position along its path from 0.0 - 1.0. +/// %position = \"0.35\"; +/// // Force the pathCamera to its new position along the path. +/// %pathCamera.setPosition(%position); +/// @endtsexample) +/// /// public void setPosition(string pathcamera, float position = 0.0f){ @@ -16588,7 +22939,17 @@ public void setPosition(string pathcamera, float position = 0.0f){ m_ts.fnPathCamera_setPosition(pathcamera, position); } /// -/// forward), Set the movement state for this path camera. @param newState New movement state type for this camera. Forward, Backward or Stop. @tsexample // Set the state type (forward, backward, stop). // In this example, the camera will travel from the first node // to the last node (or target if given with setTarget()) %state = \"forward\"; // Inform the pathCamera to change its movement state to the defined value. %pathCamera.setState(%state); @endtsexample) +/// forward), Set the movement state for this path camera. +/// @param newState New movement state type for this camera. Forward, Backward or Stop. +/// @tsexample +/// // Set the state type (forward, backward, stop). +/// // In this example, the camera will travel from the first node +/// // to the last node (or target if given with setTarget()) +/// %state = \"forward\"; +/// // Inform the pathCamera to change its movement state to the defined value. +/// %pathCamera.setState(%state); +/// @endtsexample) +/// /// public void setState(string pathcamera, string newState = "forward"){ @@ -16596,7 +22957,18 @@ public void setState(string pathcamera, string newState = "forward"){ m_ts.fnPathCamera_setState(pathcamera, newState); } /// -/// @brief Set the movement target for this camera along its path. The camera will attempt to move along the path to the given target in the direction provided by setState() (the default is forwards). Once the camera moves past this target it will come to a stop, and the target state will be cleared. @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. @tsexample // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. %position = \"0.50\"; // Inform the pathCamera of the new target position it will move to. %pathCamera.setTarget(%position); @endtsexample) +/// @brief Set the movement target for this camera along its path. +/// The camera will attempt to move along the path to the given target in the direction provided +/// by setState() (the default is forwards). Once the camera moves past this target it will come +/// to a stop, and the target state will be cleared. +/// @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. +/// @tsexample +/// // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. +/// %position = \"0.50\"; +/// // Inform the pathCamera of the new target position it will move to. +/// %pathCamera.setTarget(%position); +/// @endtsexample) +/// /// public void setTarget(string pathcamera, float position = 1.0f){ @@ -16609,14 +22981,10 @@ public void setTarget(string pathcamera, float position = 1.0f){ /// public class PersistenceManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public PersistenceManagerObject(ref Omni ts){m_ts = ts;} /// -/// () Clears all the tracked objects without saving them. ) +/// () +/// Clears all the tracked objects without saving them. ) +/// /// public void PersistenceManager_clearAll(string persistencemanager){ @@ -16624,7 +22992,9 @@ public void PersistenceManager_clearAll(string persistencemanager){ m_ts.fn_PersistenceManager_clearAll(persistencemanager); } /// -/// ( fileName ) Delete all of the objects that are created from the given file. ) +/// ( fileName ) +/// Delete all of the objects that are created from the given file. ) +/// /// public void PersistenceManager_deleteObjectsFromFile(string persistencemanager, string fileName){ @@ -16632,7 +23002,9 @@ public void PersistenceManager_deleteObjectsFromFile(string persistencemanager, m_ts.fn_PersistenceManager_deleteObjectsFromFile(persistencemanager, fileName); } /// -/// ( index ) Returns the ith dirty object. ) +/// ( index ) +/// Returns the ith dirty object. ) +/// /// public int PersistenceManager_getDirtyObject(string persistencemanager, int index){ @@ -16640,7 +23012,9 @@ public int PersistenceManager_getDirtyObject(string persistencemanager, int ind return m_ts.fn_PersistenceManager_getDirtyObject(persistencemanager, index); } /// -/// () Returns the number of dirty objects. ) +/// () +/// Returns the number of dirty objects. ) +/// /// public int PersistenceManager_getDirtyObjectCount(string persistencemanager){ @@ -16648,7 +23022,9 @@ public int PersistenceManager_getDirtyObjectCount(string persistencemanager){ return m_ts.fn_PersistenceManager_getDirtyObjectCount(persistencemanager); } /// -/// () Returns true if the manager has dirty objects to save. ) +/// () +/// Returns true if the manager has dirty objects to save. ) +/// /// public bool PersistenceManager_hasDirty(string persistencemanager){ @@ -16656,7 +23032,9 @@ public bool PersistenceManager_hasDirty(string persistencemanager){ return m_ts.fn_PersistenceManager_hasDirty(persistencemanager); } /// -/// (SimObject object) Returns true if the SimObject is on the dirty list.) +/// (SimObject object) +/// Returns true if the SimObject is on the dirty list.) +/// /// public bool PersistenceManager_isDirty(string persistencemanager, string objName){ @@ -16664,7 +23042,9 @@ public bool PersistenceManager_isDirty(string persistencemanager, string objNam return m_ts.fn_PersistenceManager_isDirty(persistencemanager, objName); } /// -/// () Prints the dirty list to the console.) +/// () +/// Prints the dirty list to the console.) +/// /// public void PersistenceManager_listDirty(string persistencemanager){ @@ -16672,7 +23052,9 @@ public void PersistenceManager_listDirty(string persistencemanager){ m_ts.fn_PersistenceManager_listDirty(persistencemanager); } /// -/// (SimObject object) Remove a SimObject from the dirty list.) +/// (SimObject object) +/// Remove a SimObject from the dirty list.) +/// /// public void PersistenceManager_removeDirty(string persistencemanager, string objName){ @@ -16680,7 +23062,9 @@ public void PersistenceManager_removeDirty(string persistencemanager, string ob m_ts.fn_PersistenceManager_removeDirty(persistencemanager, objName); } /// -/// (SimObject object, string fieldName) Remove a specific field from an object declaration.) +/// (SimObject object, string fieldName) +/// Remove a specific field from an object declaration.) +/// /// public void PersistenceManager_removeField(string persistencemanager, string objName, string fieldName){ @@ -16688,7 +23072,10 @@ public void PersistenceManager_removeField(string persistencemanager, string ob m_ts.fn_PersistenceManager_removeField(persistencemanager, objName, fieldName); } /// -/// ) , (SimObject object, [filename]) Remove an existing SimObject from a file (can optionally specify a different file than \ the one it was created in.) +/// ) , (SimObject object, [filename]) +/// Remove an existing SimObject from a file (can optionally specify a different file than \ +/// the one it was created in.) +/// /// public void PersistenceManager_removeObjectFromFile(string persistencemanager, string objName, string filename = ""){ @@ -16696,7 +23083,9 @@ public void PersistenceManager_removeObjectFromFile(string persistencemanager, m_ts.fn_PersistenceManager_removeObjectFromFile(persistencemanager, objName, filename); } /// -/// () Saves all of the SimObject's on the dirty list to their respective files.) +/// () +/// Saves all of the SimObject's on the dirty list to their respective files.) +/// /// public bool PersistenceManager_saveDirty(string persistencemanager){ @@ -16704,7 +23093,9 @@ public bool PersistenceManager_saveDirty(string persistencemanager){ return m_ts.fn_PersistenceManager_saveDirty(persistencemanager); } /// -/// (SimObject object) Save a dirty SimObject to it's file.) +/// (SimObject object) +/// Save a dirty SimObject to it's file.) +/// /// public bool PersistenceManager_saveDirtyObject(string persistencemanager, string objName){ @@ -16712,7 +23103,9 @@ public bool PersistenceManager_saveDirtyObject(string persistencemanager, strin return m_ts.fn_PersistenceManager_saveDirtyObject(persistencemanager, objName); } /// -/// ), (SimObject object, [filename]) Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// ), (SimObject object, [filename]) +/// Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// /// public void PersistenceManager_setDirty(string persistencemanager, string objName, string fileName = ""){ @@ -16725,14 +23118,15 @@ public void PersistenceManager_setDirty(string persistencemanager, string objNa /// public class PhysicalZoneObject { -private Omni m_ts; - /// - /// - /// - /// -public PhysicalZoneObject(ref Omni ts){m_ts = ts;} /// -/// Activate the physical zone's effects. @tsexample // Activate effects for a specific physical zone. %thisPhysicalZone.activate(); @endtsexample @ingroup Datablocks ) +/// Activate the physical zone's effects. +/// @tsexample +/// // Activate effects for a specific physical zone. +/// %thisPhysicalZone.activate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void activate(string physicalzone){ @@ -16740,7 +23134,14 @@ public void activate(string physicalzone){ m_ts.fnPhysicalZone_activate(physicalzone); } /// -/// Deactivate the physical zone's effects. @tsexample // Deactivate effects for a specific physical zone. %thisPhysicalZone.deactivate(); @endtsexample @ingroup Datablocks ) +/// Deactivate the physical zone's effects. +/// @tsexample +/// // Deactivate effects for a specific physical zone. +/// %thisPhysicalZone.deactivate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void deactivate(string physicalzone){ @@ -16753,14 +23154,12 @@ public void deactivate(string physicalzone){ /// public class PhysicsDebrisDataObject { -private Omni m_ts; - /// - /// - /// - /// -public PhysicsDebrisDataObject(ref Omni ts){m_ts = ts;} /// -/// @brief Loads some information to have readily available at simulation time. Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. This function should be used while a level is loading in order to shorten the amount of time to create a PhysicsDebris in game.) +/// @brief Loads some information to have readily available at simulation time. +/// Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. +/// This function should be used while a level is loading in order to shorten +/// the amount of time to create a PhysicsDebris in game.) +/// /// public void PhysicsDebrisData_preload(string physicsdebrisdata){ @@ -16773,14 +23172,15 @@ public void PhysicsDebrisData_preload(string physicsdebrisdata){ /// public class PhysicsForceObject { -private Omni m_ts; - /// - /// - /// - /// -public PhysicsForceObject(ref Omni ts){m_ts = ts;} /// -/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. Performs a physics ray cast of the provided length and direction. The %PhysicsForce will attach itself to the first dynamic PhysicsBody the ray collides with. On every tick, the attached body will be attracted towards the position of the %PhysicsForce. A %PhysicsForce can only be attached to one body at a time. @note To determine if an %attach was successful, check isAttached() immediately after calling this function.n) +/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. +/// Performs a physics ray cast of the provided length and direction. The %PhysicsForce +/// will attach itself to the first dynamic PhysicsBody the ray collides with. +/// On every tick, the attached body will be attracted towards the position of the %PhysicsForce. +/// A %PhysicsForce can only be attached to one body at a time. +/// @note To determine if an %attach was successful, check isAttached() immediately after +/// calling this function.n) +/// /// public void attach(string physicsforce, Point3F start, Point3F direction, float maxDist){ @@ -16788,7 +23188,11 @@ public void attach(string physicsforce, Point3F start, Point3F direction, float m_ts.fnPhysicsForce_attach(physicsforce, start.AsString(), direction.AsString(), maxDist); } /// -/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. @param force Optional force to apply to the attached PhysicsBody before detaching. @note Has no effect if the %PhysicsForce is not attached to anything.) +/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. +/// @param force Optional force to apply to the attached PhysicsBody +/// before detaching. +/// @note Has no effect if the %PhysicsForce is not attached to anything.) +/// /// public void detach(string physicsforce, Point3F force = null ){ if (force== null) {force = new Point3F(0.0f, 0.0f, 0.0f);} @@ -16797,7 +23201,9 @@ public void detach(string physicsforce, Point3F force = null ){ m_ts.fnPhysicsForce_detach(physicsforce, force.AsString()); } /// -/// @brief Returns true if the %PhysicsForce is currently attached to an object. @see PhysicsForce::attach()) +/// @brief Returns true if the %PhysicsForce is currently attached to an object. +/// @see PhysicsForce::attach()) +/// /// public bool isAttached(string physicsforce){ @@ -16810,14 +23216,13 @@ public bool isAttached(string physicsforce){ /// public class PhysicsShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public PhysicsShapeObject(ref Omni ts){m_ts = ts;} /// -/// @brief Disables rendering and physical simulation. Calling destroy() will also spawn any explosions, debris, and/or destroyedShape defined for it, as well as remove it from the scene graph. Destroyed objects are only created on the server. Ghosting will later update the client. @note This does not actually delete the PhysicsShape. ) +/// @brief Disables rendering and physical simulation. +/// Calling destroy() will also spawn any explosions, debris, and/or destroyedShape +/// defined for it, as well as remove it from the scene graph. +/// Destroyed objects are only created on the server. Ghosting will later update the client. +/// @note This does not actually delete the PhysicsShape. ) +/// /// public void destroy(string physicsshape){ @@ -16826,6 +23231,7 @@ public void destroy(string physicsshape){ } /// /// @brief Returns if a PhysicsShape has been destroyed or not. ) +/// /// public bool isDestroyed(string physicsshape){ @@ -16833,7 +23239,11 @@ public bool isDestroyed(string physicsshape){ return m_ts.fnPhysicsShape_isDestroyed(physicsshape); } /// -/// @brief Restores the shape to its state before being destroyed. Re-enables rendering and physical simulation on the object and adds it to the client's scene graph. Has no effect if the shape is not destroyed.) +/// @brief Restores the shape to its state before being destroyed. +/// Re-enables rendering and physical simulation on the object and +/// adds it to the client's scene graph. +/// Has no effect if the shape is not destroyed.) +/// /// public void restore(string physicsshape){ @@ -16846,14 +23256,20 @@ public void restore(string physicsshape){ /// public class PlayerObject { -private Omni m_ts; - /// - /// - /// - /// -public PlayerObject(ref Omni ts){m_ts = ts;} /// -/// @brief Allow all poses a chance to occur. This method resets any poses that have manually been blocked from occuring. This includes the regular pose states such as sprinting, crouch, being prone and swimming. It also includes being able to jump and jet jump. While this is allowing these poses to occur it doesn't mean that they all can due to other conditions. We're just not manually blocking them from being allowed. @see allowJumping() @see allowJetJumping() @see allowSprinting() @see allowCrouching() @see allowProne() @see allowSwimming() ) +/// @brief Allow all poses a chance to occur. +/// This method resets any poses that have manually been blocked from occuring. +/// This includes the regular pose states such as sprinting, crouch, being prone +/// and swimming. It also includes being able to jump and jet jump. While this +/// is allowing these poses to occur it doesn't mean that they all can due to other +/// conditions. We're just not manually blocking them from being allowed. +/// @see allowJumping() +/// @see allowJetJumping() +/// @see allowSprinting() +/// @see allowCrouching() +/// @see allowProne() +/// @see allowSwimming() ) +/// /// public void allowAllPoses(string player){ @@ -16861,7 +23277,13 @@ public void allowAllPoses(string player){ m_ts.fnPlayer_allowAllPoses(player); } /// -/// @brief Set if the Player is allowed to crouch. The default is to allow crouching unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow crouching at any time. @param state Set to true to allow crouching, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to crouch. +/// The default is to allow crouching unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow crouching +/// at any time. +/// @param state Set to true to allow crouching, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowCrouching(string player, bool state){ @@ -16869,7 +23291,13 @@ public void allowCrouching(string player, bool state){ m_ts.fnPlayer_allowCrouching(player, state); } /// -/// @brief Set if the Player is allowed to jet jump. The default is to allow jet jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jet jumping at any time. @param state Set to true to allow jet jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jet jump. +/// The default is to allow jet jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jet jumping +/// at any time. +/// @param state Set to true to allow jet jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowJetJumping(string player, bool state){ @@ -16877,7 +23305,13 @@ public void allowJetJumping(string player, bool state){ m_ts.fnPlayer_allowJetJumping(player, state); } /// -/// @brief Set if the Player is allowed to jump. The default is to allow jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jumping at any time. @param state Set to true to allow jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jump. +/// The default is to allow jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jumping +/// at any time. +/// @param state Set to true to allow jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowJumping(string player, bool state){ @@ -16885,7 +23319,13 @@ public void allowJumping(string player, bool state){ m_ts.fnPlayer_allowJumping(player, state); } /// -/// @brief Set if the Player is allowed to go prone. The default is to allow being prone unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow going prone at any time. @param state Set to true to allow being prone, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to go prone. +/// The default is to allow being prone unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow going prone +/// at any time. +/// @param state Set to true to allow being prone, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowProne(string player, bool state){ @@ -16893,7 +23333,13 @@ public void allowProne(string player, bool state){ m_ts.fnPlayer_allowProne(player, state); } /// -/// @brief Set if the Player is allowed to sprint. The default is to allow sprinting unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow sprinting at any time. @param state Set to true to allow sprinting, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to sprint. +/// The default is to allow sprinting unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow sprinting +/// at any time. +/// @param state Set to true to allow sprinting, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowSprinting(string player, bool state){ @@ -16901,7 +23347,13 @@ public void allowSprinting(string player, bool state){ m_ts.fnPlayer_allowSprinting(player, state); } /// -/// @brief Set if the Player is allowed to swim. The default is to allow swimming unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow swimming at any time. @param state Set to true to allow swimming, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to swim. +/// The default is to allow swimming unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow swimming +/// at any time. +/// @param state Set to true to allow swimming, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowSwimming(string player, bool state){ @@ -16909,7 +23361,21 @@ public void allowSwimming(string player, bool state){ m_ts.fnPlayer_allowSwimming(player, state); } /// -/// @brief Check if it is safe to dismount at this position. Internally this method casts a ray from oldPos to pos to determine if it hits the terrain, an interior object, a water object, another player, a static shape, a vehicle (exluding the one currently mounted), or physical zone. If this ray is in the clear, then the player's bounding box is also checked for a collision at the pos position. If this displaced bounding box is also in the clear, then checkDismountPoint() returns true. @param oldPos The player's current position @param pos The dismount position to check @return True if the dismount position is clear, false if not @note The player must be already mounted for this method to not assert.) +/// @brief Check if it is safe to dismount at this position. +/// +/// Internally this method casts a ray from oldPos to pos to determine if it hits the +/// terrain, an interior object, a water object, another player, a static shape, +/// a vehicle (exluding the one currently mounted), or physical zone. If this ray +/// is in the clear, then the player's bounding box is also checked for a collision at +/// the pos position. If this displaced bounding box is also in the clear, then +/// checkDismountPoint() returns true. +/// +/// @param oldPos The player's current position +/// @param pos The dismount position to check +/// @return True if the dismount position is clear, false if not +/// +/// @note The player must be already mounted for this method to not assert.) +/// /// public bool checkDismountPoint(string player, Point3F oldPos, Point3F pos){ @@ -16917,7 +23383,23 @@ public bool checkDismountPoint(string player, Point3F oldPos, Point3F pos){ return m_ts.fnPlayer_checkDismountPoint(player, oldPos.AsString(), pos.AsString()); } /// -/// @brief Clears the player's current control object. Returns control to the player. This internally calls Player::setControlObject(0). @tsexample %player.clearControlObject(); echo(%player.getControlObject()); //-- Returns 0, player assumes control %player.setControlObject(%vehicle); echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. @endtsexample @note If the player does not have a control object, the player will receive all moves from its GameConnection. If you're looking to remove control from the player itself (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer control to another object, such as a camera. @see setControlObject() @see getControlObject() @see GameConnection::setControlObject()) +/// @brief Clears the player's current control object. +/// Returns control to the player. This internally calls +/// Player::setControlObject(0). +/// @tsexample +/// %player.clearControlObject(); +/// echo(%player.getControlObject()); //-- Returns 0, player assumes control +/// %player.setControlObject(%vehicle); +/// echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. +/// @endtsexample +/// @note If the player does not have a control object, the player will receive all moves +/// from its GameConnection. If you're looking to remove control from the player itself +/// (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer +/// control to another object, such as a camera. +/// @see setControlObject() +/// @see getControlObject() +/// @see GameConnection::setControlObject()) +/// /// public void clearControlObject(string player){ @@ -16925,7 +23407,12 @@ public void clearControlObject(string player){ m_ts.fnPlayer_clearControlObject(player); } /// -/// @brief Get the current object we are controlling. @return ID of the ShapeBase object we control, or 0 if not controlling an object. @see setControlObject() @see clearControlObject()) +/// @brief Get the current object we are controlling. +/// @return ID of the ShapeBase object we control, or 0 if not controlling an +/// object. +/// @see setControlObject() +/// @see clearControlObject()) +/// /// public int getControlObject(string player){ @@ -16933,7 +23420,59 @@ public int getControlObject(string player){ return m_ts.fnPlayer_getControlObject(player); } /// -/// @brief Get the named damage location and modifier for a given world position. the Player object can simulate different hit locations based on a pre-defined set of PlayerData defined percentages. These hit percentages divide up the Player's bounding box into different regions. The diagram below demonstrates how the various PlayerData properties split up the bounding volume: img src=\"images/player_damageloc.png\"> While you may pass in any world position and getDamageLocation() will provide a best-fit location, you should be aware that this can produce some interesting results. For example, any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even if the world position is high in the sky. Therefore it may be wise to keep the passed in point to somewhere on the surface of, or within, the Player's bounding volume. @note This method will not return an accurate location when the player is prone or swimming. @param pos A world position for which to retrieve a body region on this player. @return a string containing two words (space separated strings), where the first is a location and the second is a modifier. Posible locations:ul> li>head/li> li>torso/li> li>legs/li>/ul> Head modifiers:ul> li>left_back/li> li>middle_back/li> li>right_back/li> li>left_middle/li> li>middle_middle/li> li>right_middle/li> li>left_front/li> li>middle_front/li> li>right_front/li>/ul> Legs/Torso modifiers:ul> li>front_left/li> li>front_right/li> li>back_left/li> li>back_right/li>/ul> @see PlayerData::boxHeadPercentage @see PlayerData::boxHeadFrontPercentage @see PlayerData::boxHeadBackPercentage @see PlayerData::boxHeadLeftPercentage @see PlayerData::boxHeadRightPercentage @see PlayerData::boxTorsoPercentage ) +/// @brief Get the named damage location and modifier for a given world position. +/// +/// the Player object can simulate different hit locations based on a pre-defined set +/// of PlayerData defined percentages. These hit percentages divide up the Player's +/// bounding box into different regions. The diagram below demonstrates how the various +/// PlayerData properties split up the bounding volume: +/// +/// img src=\"images/player_damageloc.png\"> +/// +/// While you may pass in any world position and getDamageLocation() will provide a best-fit +/// location, you should be aware that this can produce some interesting results. For example, +/// any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even +/// if the world position is high in the sky. Therefore it may be wise to keep the passed in point +/// to somewhere on the surface of, or within, the Player's bounding volume. +/// +/// @note This method will not return an accurate location when the player is +/// prone or swimming. +/// +/// @param pos A world position for which to retrieve a body region on this player. +/// +/// @return a string containing two words (space separated strings), where the +/// first is a location and the second is a modifier. +/// +/// Posible locations:ul> +/// li>head/li> +/// li>torso/li> +/// li>legs/li>/ul> +/// +/// Head modifiers:ul> +/// li>left_back/li> +/// li>middle_back/li> +/// li>right_back/li> +/// li>left_middle/li> +/// li>middle_middle/li> +/// li>right_middle/li> +/// li>left_front/li> +/// li>middle_front/li> +/// li>right_front/li>/ul> +/// +/// Legs/Torso modifiers:ul> +/// li>front_left/li> +/// li>front_right/li> +/// li>back_left/li> +/// li>back_right/li>/ul> +/// +/// @see PlayerData::boxHeadPercentage +/// @see PlayerData::boxHeadFrontPercentage +/// @see PlayerData::boxHeadBackPercentage +/// @see PlayerData::boxHeadLeftPercentage +/// @see PlayerData::boxHeadRightPercentage +/// @see PlayerData::boxTorsoPercentage +/// ) +/// /// public string getDamageLocation(string player, Point3F pos){ @@ -16941,7 +23480,9 @@ public string getDamageLocation(string player, Point3F pos){ return m_ts.fnPlayer_getDamageLocation(player, pos.AsString()); } /// -/// @brief Get the number of death animations available to this player. Death animations are assumed to be named death1-N using consecutive indices. ) +/// @brief Get the number of death animations available to this player. +/// Death animations are assumed to be named death1-N using consecutive indices. ) +/// /// public int getNumDeathAnimations(string player){ @@ -16949,7 +23490,17 @@ public int getNumDeathAnimations(string player){ return m_ts.fnPlayer_getNumDeathAnimations(player); } /// -/// @brief Get the name of the player's current pose. The pose is one of the following:ul> li>Stand - Standard movement pose./li> li>Sprint - Sprinting pose./li> li>Crouch - Crouch pose./li> li>Prone - Prone pose./li> li>Swim - Swimming pose./li>/ul> @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// @brief Get the name of the player's current pose. +/// +/// The pose is one of the following:ul> +/// li>Stand - Standard movement pose./li> +/// li>Sprint - Sprinting pose./li> +/// li>Crouch - Crouch pose./li> +/// li>Prone - Prone pose./li> +/// li>Swim - Swimming pose./li>/ul> +/// +/// @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// /// public string getPose(string player){ @@ -16957,7 +23508,16 @@ public string getPose(string player){ return m_ts.fnPlayer_getPose(player); } /// -/// @brief Get the name of the player's current state. The state is one of the following:ul> li>Dead - The Player is dead./li> li>Mounted - The Player is mounted to an object such as a vehicle./li> li>Move - The Player is free to move. The usual state./li> li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// @brief Get the name of the player's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The Player is dead./li> +/// li>Mounted - The Player is mounted to an object such as a vehicle./li> +/// li>Move - The Player is free to move. The usual state./li> +/// li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// /// public string getState(string player){ @@ -16965,7 +23525,58 @@ public string getState(string player){ return m_ts.fnPlayer_getState(player); } /// -/// @brief Set the main action sequence to play for this player. @param name Name of the action sequence to set @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). When set to true no callback is made. @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's spine nodes to animate. @return True if succesful, false if failed @note The spine nodes for the Player's shape are named as follows:ul> li>Bip01 Pelvis/li> li>Bip01 Spine/li> li>Bip01 Spine1/li> li>Bip01 Spine2/li> li>Bip01 Neck/li> li>Bip01 Head/li>/ul> You cannot use setActionThread() to have the Player play one of the motion determined action animation sequences. These sequences are chosen based on how the Player moves and the Player's current pose. The names of these sequences are:ul> li>root/li> li>run/li> li>side/li> li>side_right/li> li>crouch_root/li> li>crouch_forward/li> li>crouch_backward/li> li>crouch_side/li> li>crouch_right/li> li>prone_root/li> li>prone_forward/li> li>prone_backward/li> li>swim_root/li> li>swim_forward/li> li>swim_backward/li> li>swim_left/li> li>swim_right/li> li>fall/li> li>jump/li> li>standjump/li> li>land/li> li>jet/li>/ul> If the player moves in any direction then the animation sequence set using this method will be cancelled and the chosen mation-based sequence will take over. This makes great for times when the Player cannot move, such as when mounted, or when it doesn't matter if the action sequence changes, such as waving and saluting. @tsexample // Place the player in a sitting position after being mounted %player.setActionThread( \"sitting\", true, true ); @endtsexample) +/// @brief Set the main action sequence to play for this player. +/// @param name Name of the action sequence to set +/// @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). +/// When set to true no callback is made. +/// @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's +/// spine nodes to animate. +/// @return True if succesful, false if failed +/// +/// @note The spine nodes for the Player's shape are named as follows:ul> +/// li>Bip01 Pelvis/li> +/// li>Bip01 Spine/li> +/// li>Bip01 Spine1/li> +/// li>Bip01 Spine2/li> +/// li>Bip01 Neck/li> +/// li>Bip01 Head/li>/ul> +/// +/// You cannot use setActionThread() to have the Player play one of the motion +/// determined action animation sequences. These sequences are chosen based on how +/// the Player moves and the Player's current pose. The names of these sequences are:ul> +/// li>root/li> +/// li>run/li> +/// li>side/li> +/// li>side_right/li> +/// li>crouch_root/li> +/// li>crouch_forward/li> +/// li>crouch_backward/li> +/// li>crouch_side/li> +/// li>crouch_right/li> +/// li>prone_root/li> +/// li>prone_forward/li> +/// li>prone_backward/li> +/// li>swim_root/li> +/// li>swim_forward/li> +/// li>swim_backward/li> +/// li>swim_left/li> +/// li>swim_right/li> +/// li>fall/li> +/// li>jump/li> +/// li>standjump/li> +/// li>land/li> +/// li>jet/li>/ul> +/// +/// If the player moves in any direction then the animation sequence set using this +/// method will be cancelled and the chosen mation-based sequence will take over. This makes +/// great for times when the Player cannot move, such as when mounted, or when it doesn't matter +/// if the action sequence changes, such as waving and saluting. +/// +/// @tsexample +/// // Place the player in a sitting position after being mounted +/// %player.setActionThread( \"sitting\", true, true ); +/// @endtsexample) +/// /// public bool setActionThread(string player, string name, bool hold = false, bool fsp = true){ @@ -16973,7 +23584,12 @@ public bool setActionThread(string player, string name, bool hold = false, bool return m_ts.fnPlayer_setActionThread(player, name, hold, fsp); } /// -/// @brief Set the sequence that controls the player's arms (dynamically adjusted to match look direction). @param name Name of the sequence to play on the player's arms. @return true if successful, false if failed. @note By default the 'look' sequence is used, if available.) +/// @brief Set the sequence that controls the player's arms (dynamically adjusted +/// to match look direction). +/// @param name Name of the sequence to play on the player's arms. +/// @return true if successful, false if failed. +/// @note By default the 'look' sequence is used, if available.) +/// /// public bool setArmThread(string player, string name){ @@ -16981,7 +23597,23 @@ public bool setArmThread(string player, string name){ return m_ts.fnPlayer_setArmThread(player, name); } /// -/// @brief Set the object to be controlled by this player It is possible to have the moves sent to the Player object from the GameConnection to be passed along to another object. This happens, for example when a player is mounted to a vehicle. The move commands pass through the Player and on to the vehicle (while the player remains stationary within the vehicle). With setControlObject() you can have the Player pass along its moves to any object. One possible use is for a player to move a remote controlled vehicle. In this case the player does not mount the vehicle directly, but still wants to be able to control it. @param obj Object to control with this player @return True if the object is valid, false if not @see getControlObject() @see clearControlObject() @see GameConnection::setControlObject()) +/// @brief Set the object to be controlled by this player +/// +/// It is possible to have the moves sent to the Player object from the +/// GameConnection to be passed along to another object. This happens, for example +/// when a player is mounted to a vehicle. The move commands pass through the Player +/// and on to the vehicle (while the player remains stationary within the vehicle). +/// With setControlObject() you can have the Player pass along its moves to any object. +/// One possible use is for a player to move a remote controlled vehicle. In this case +/// the player does not mount the vehicle directly, but still wants to be able to control it. +/// +/// @param obj Object to control with this player +/// @return True if the object is valid, false if not +/// +/// @see getControlObject() +/// @see clearControlObject() +/// @see GameConnection::setControlObject()) +/// /// public bool setControlObject(string player, string obj){ @@ -16994,14 +23626,9 @@ public bool setControlObject(string player, string obj){ /// public class PopupMenuObject { -private Omni m_ts; - /// - /// - /// - /// -public PopupMenuObject(ref Omni ts){m_ts = ts;} /// /// (GuiCanvas, pos, title)) +/// /// public void PopupMenu_attachToMenuBar(string popupmenu, string canvasName, int pos, string title){ @@ -17010,6 +23637,7 @@ public void PopupMenu_attachToMenuBar(string popupmenu, string canvasName, int } /// /// (pos, checked)) +/// /// public void PopupMenu_checkItem(string popupmenu, int pos, bool checkedx){ @@ -17018,6 +23646,7 @@ public void PopupMenu_checkItem(string popupmenu, int pos, bool checkedx){ } /// /// (firstPos, lastPos, checkPos)) +/// /// public void PopupMenu_checkRadioItem(string popupmenu, int firstPos, int lastPos, int checkPos){ @@ -17026,6 +23655,7 @@ public void PopupMenu_checkRadioItem(string popupmenu, int firstPos, int lastPo } /// /// (pos, enabled)) +/// /// public void PopupMenu_enableItem(string popupmenu, int pos, bool enabled){ @@ -17034,6 +23664,7 @@ public void PopupMenu_enableItem(string popupmenu, int pos, bool enabled){ } /// /// ()) +/// /// public int PopupMenu_getItemCount(string popupmenu){ @@ -17042,6 +23673,7 @@ public int PopupMenu_getItemCount(string popupmenu){ } /// /// , ), (pos[, title][, accelerator])) +/// /// public int PopupMenu_insertItem(string popupmenu, int pos, string title = "", string accelerator = ""){ @@ -17050,6 +23682,7 @@ public int PopupMenu_insertItem(string popupmenu, int pos, string title = "", s } /// /// (pos, title, subMenu)) +/// /// public int PopupMenu_insertSubMenu(string popupmenu, int pos, string title, string subMenu){ @@ -17058,6 +23691,7 @@ public int PopupMenu_insertSubMenu(string popupmenu, int pos, string title, str } /// /// (pos)) +/// /// public bool PopupMenu_isItemChecked(string popupmenu, int pos){ @@ -17066,6 +23700,7 @@ public bool PopupMenu_isItemChecked(string popupmenu, int pos){ } /// /// ()) +/// /// public void PopupMenu_removeFromMenuBar(string popupmenu){ @@ -17074,6 +23709,7 @@ public void PopupMenu_removeFromMenuBar(string popupmenu){ } /// /// (pos)) +/// /// public void PopupMenu_removeItem(string popupmenu, int pos){ @@ -17082,6 +23718,7 @@ public void PopupMenu_removeItem(string popupmenu, int pos){ } /// /// ), (pos, title[, accelerator])) +/// /// public bool PopupMenu_setItem(string popupmenu, int pos, string title, string accelerator = ""){ @@ -17090,6 +23727,7 @@ public bool PopupMenu_setItem(string popupmenu, int pos, string title, string a } /// /// (Canvas,[x, y])) +/// /// public void PopupMenu_showPopup(string popupmenu, string canvasName, int x = -1, int y = -1){ @@ -17102,14 +23740,10 @@ public void PopupMenu_showPopup(string popupmenu, string canvasName, int x = -1 /// public class PortalObject { -private Omni m_ts; - /// - /// - /// - /// -public PortalObject(ref Omni ts){m_ts = ts;} /// -/// Test whether the portal connects interior zones to the outdoor zone. @return True if the portal is an exterior portal. ) +/// Test whether the portal connects interior zones to the outdoor zone. +/// @return True if the portal is an exterior portal. ) +/// /// public bool isExteriorPortal(string portal){ @@ -17117,7 +23751,9 @@ public bool isExteriorPortal(string portal){ return m_ts.fnPortal_isExteriorPortal(portal); } /// -/// Test whether the portal connects interior zones only. @return True if the portal is an interior portal. ) +/// Test whether the portal connects interior zones only. +/// @return True if the portal is an interior portal. ) +/// /// public bool isInteriorPortal(string portal){ @@ -17130,14 +23766,9 @@ public bool isInteriorPortal(string portal){ /// public class PostEffectObject { -private Omni m_ts; - /// - /// - /// - /// -public PostEffectObject(ref Omni ts){m_ts = ts;} /// /// Remove all shader macros. ) +/// /// public void clearShaderMacros(string posteffect){ @@ -17146,6 +23777,7 @@ public void clearShaderMacros(string posteffect){ } /// /// Disables the effect. ) +/// /// public void disable(string posteffect){ @@ -17153,7 +23785,9 @@ public void disable(string posteffect){ m_ts.fnPostEffect_disable(posteffect); } /// -/// Dumps this PostEffect shader's disassembly to a temporary text file. @return Full path to the dumped file or an empty string if failed. ) +/// Dumps this PostEffect shader's disassembly to a temporary text file. +/// @return Full path to the dumped file or an empty string if failed. ) +/// /// public string dumpShaderDisassembly(string posteffect){ @@ -17162,6 +23796,7 @@ public string dumpShaderDisassembly(string posteffect){ } /// /// Enables the effect. ) +/// /// public void enable(string posteffect){ @@ -17170,6 +23805,7 @@ public void enable(string posteffect){ } /// /// @return Width over height of the backbuffer. ) +/// /// public float getAspectRatio(string posteffect){ @@ -17178,6 +23814,7 @@ public float getAspectRatio(string posteffect){ } /// /// @return True if the effect is enabled. ) +/// /// public bool isEnabled(string posteffect){ @@ -17186,6 +23823,7 @@ public bool isEnabled(string posteffect){ } /// /// Reloads the effect shader and textures. ) +/// /// public void reload(string posteffect){ @@ -17193,7 +23831,9 @@ public void reload(string posteffect){ m_ts.fnPostEffect_reload(posteffect); } /// -/// Remove a shader macro. This will usually be called within the preProcess callback. @param key Macro to remove. ) +/// Remove a shader macro. This will usually be called within the preProcess callback. +/// @param key Macro to remove. ) +/// /// public void removeShaderMacro(string posteffect, string key){ @@ -17201,7 +23841,23 @@ public void removeShaderMacro(string posteffect, string key){ m_ts.fnPostEffect_removeShaderMacro(posteffect, key); } /// -/// Sets the value of a uniform defined in the shader. This will usually be called within the setShaderConsts callback. Array type constants are not supported. @param name Name of the constanst, prefixed with '$'. @param value Value to set, space seperate values with more than one element. @tsexample function MyPfx::setShaderConsts( %this ) { // example float4 uniform %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); // example float1 uniform %this.setShaderConst( \"$strength\", \"3.0\" ); // example integer uniform %this.setShaderConst( \"$loops\", \"5\" ); } @endtsexample ) +/// Sets the value of a uniform defined in the shader. This will usually +/// be called within the setShaderConsts callback. Array type constants are +/// not supported. +/// @param name Name of the constanst, prefixed with '$'. +/// @param value Value to set, space seperate values with more than one element. +/// @tsexample +/// function MyPfx::setShaderConsts( %this ) +/// { +/// // example float4 uniform +/// %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); +/// // example float1 uniform +/// %this.setShaderConst( \"$strength\", \"3.0\" ); +/// // example integer uniform +/// %this.setShaderConst( \"$loops\", \"5\" ); +/// } +/// @endtsexample ) +/// /// public void setShaderConst(string posteffect, string name, string value){ @@ -17209,7 +23865,23 @@ public void setShaderConst(string posteffect, string name, string value){ m_ts.fnPostEffect_setShaderConst(posteffect, name, value); } /// -/// ), Adds a macro to the effect's shader or sets an existing one's value. This will usually be called within the onAdd or preProcess callback. @param key lval of the macro. @param value rval of the macro, or may be empty. @tsexample function MyPfx::onAdd( %this ) { %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); // In the shader looks like... // #define NUM_SAMPLES 10 // #define HIGH_QUALITY_MODE } @endtsexample ) +/// ), +/// Adds a macro to the effect's shader or sets an existing one's value. +/// This will usually be called within the onAdd or preProcess callback. +/// @param key lval of the macro. +/// @param value rval of the macro, or may be empty. +/// @tsexample +/// function MyPfx::onAdd( %this ) +/// { +/// %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); +/// %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); +/// +/// // In the shader looks like... +/// // #define NUM_SAMPLES 10 +/// // #define HIGH_QUALITY_MODE +/// } +/// @endtsexample ) +/// /// public void setShaderMacro(string posteffect, string key, string value = ""){ @@ -17217,7 +23889,12 @@ public void setShaderMacro(string posteffect, string key, string value = ""){ m_ts.fnPostEffect_setShaderMacro(posteffect, key, value); } /// -/// This is used to set the texture file and load the texture on a running effect. If the texture file is not different from the current file nothing is changed. If the texture cannot be found a null texture is assigned. @param index The texture stage index. @param filePath The file name of the texture to set. ) +/// This is used to set the texture file and load the texture on a running effect. +/// If the texture file is not different from the current file nothing is changed. If +/// the texture cannot be found a null texture is assigned. +/// @param index The texture stage index. +/// @param filePath The file name of the texture to set. ) +/// /// public void setTexture(string posteffect, int index, string filePath){ @@ -17225,7 +23902,9 @@ public void setTexture(string posteffect, int index, string filePath){ m_ts.fnPostEffect_setTexture(posteffect, index, filePath); } /// -/// Toggles the effect between enabled / disabled. @return True if effect is enabled. ) +/// Toggles the effect between enabled / disabled. +/// @return True if effect is enabled. ) +/// /// public bool toggle(string posteffect){ @@ -17238,14 +23917,21 @@ public bool toggle(string posteffect){ /// public class PrecipitationObject { -private Omni m_ts; - /// - /// - /// - /// -public PrecipitationObject(ref Omni ts){m_ts = ts;} /// -/// Smoothly change the maximum number of drops in the effect (from current value to #numDrops * @a percentage). This method can be used to simulate a storm building or fading in intensity as the number of drops in the Precipitation box changes. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @param seconds Length of time (in seconds) over which to increase the drops percentage value. Set to 0 to change instantly. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %seconds = 5.0; // The length of time over which to make the change. %precipitation.modifyStorm( %percentage, %seconds ); @endtsexample ) +/// Smoothly change the maximum number of drops in the effect (from current +/// value to #numDrops * @a percentage). +/// This method can be used to simulate a storm building or fading in intensity +/// as the number of drops in the Precipitation box changes. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @param seconds Length of time (in seconds) over which to increase the drops +/// percentage value. Set to 0 to change instantly. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.modifyStorm( %percentage, %seconds ); +/// @endtsexample ) +/// /// public void modifyStorm(string precipitation, float percentage = 1.0f, float seconds = 5.0f){ @@ -17253,7 +23939,17 @@ public void modifyStorm(string precipitation, float percentage = 1.0f, float se m_ts.fnPrecipitation_modifyStorm(precipitation, percentage, seconds); } /// -/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. The change occurs instantly (use modifyStorm() to change the number of drops over a period of time. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %precipitation.setPercentage( %percentage ); @endtsexample @see modifyStorm ) +/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. +/// The change occurs instantly (use modifyStorm() to change the number of drops +/// over a period of time. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %precipitation.setPercentage( %percentage ); +/// @endtsexample +/// @see modifyStorm ) +/// /// public void setPercentage(string precipitation, float percentage = 1.0f){ @@ -17261,7 +23957,18 @@ public void setPercentage(string precipitation, float percentage = 1.0f){ m_ts.fnPrecipitation_setPercentage(precipitation, percentage); } /// -/// Smoothly change the turbulence parameters over a period of time. @param max New #maxTurbulence value. Set to 0 to disable turbulence. @param speed New #turbulenceSpeed value. @param seconds Length of time (in seconds) over which to interpolate the turbulence settings. Set to 0 to change instantly. @tsexample %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. %speed = 5.0; // The new speed of the turbulance effect. %seconds = 5.0; // The length of time over which to make the change. %precipitation.setTurbulence( %turbulence, %speed, %seconds ); @endtsexample ) +/// Smoothly change the turbulence parameters over a period of time. +/// @param max New #maxTurbulence value. Set to 0 to disable turbulence. +/// @param speed New #turbulenceSpeed value. +/// @param seconds Length of time (in seconds) over which to interpolate the +/// turbulence settings. Set to 0 to change instantly. +/// @tsexample +/// %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. +/// %speed = 5.0; // The new speed of the turbulance effect. +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.setTurbulence( %turbulence, %speed, %seconds ); +/// @endtsexample ) +/// /// public void setTurbulence(string precipitation, float max = 1.0f, float speed = 5.0f, float seconds = 5.0f){ @@ -17274,14 +23981,20 @@ public void setTurbulence(string precipitation, float max = 1.0f, float speed = /// public class ProjectileObject { -private Omni m_ts; - /// - /// - /// - /// -public ProjectileObject(ref Omni ts){m_ts = ts;} /// -/// @brief Updates the projectile's positional and collision information. This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. Also responsible for applying gravity, determining collisions, triggering explosions, emitting trail particles, and calculating bounces if necessary. @param seconds Amount of time, in seconds since the simulation's start, to advance. @tsexample // Tell the projectile to process a simulation event, and provide the amount of time // that has passed since the simulation began. %seconds = 2.0; %projectile.presimulate(%seconds); @endtsexample @note This function is not called if the SimObject::hidden is true.) +/// @brief Updates the projectile's positional and collision information. +/// This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. +/// Also responsible for applying gravity, determining collisions, triggering explosions, +/// emitting trail particles, and calculating bounces if necessary. +/// @param seconds Amount of time, in seconds since the simulation's start, to advance. +/// @tsexample +/// // Tell the projectile to process a simulation event, and provide the amount of time +/// // that has passed since the simulation began. +/// %seconds = 2.0; +/// %projectile.presimulate(%seconds); +/// @endtsexample +/// @note This function is not called if the SimObject::hidden is true.) +/// /// public void presimulate(string projectile, float seconds = 1.0f){ @@ -17294,14 +24007,9 @@ public void presimulate(string projectile, float seconds = 1.0f){ /// public class ProximityMineObject { -private Omni m_ts; - /// - /// - /// - /// -public ProximityMineObject(ref Omni ts){m_ts = ts;} /// /// @brief Manually cause the mine to explode.) +/// /// public void explode(string proximitymine){ @@ -17314,12 +24022,6 @@ public void explode(string proximitymine){ /// public class ReadXMLObject { -private Omni m_ts; - /// - /// - /// - /// -public ReadXMLObject(ref Omni ts){m_ts = ts;} /// /// readXMLObj.readFile();) /// @@ -17335,14 +24037,9 @@ public bool ReadXML_readFile(string readxml){ /// public class RenderBinManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public RenderBinManagerObject(ref Omni ts){m_ts = ts;} /// /// Returns the bin type string. ) +/// /// public string getBinType(string renderbinmanager){ @@ -17355,14 +24052,9 @@ public string getBinType(string renderbinmanager){ /// public class RenderMeshExampleObject { -private Omni m_ts; - /// - /// - /// - /// -public RenderMeshExampleObject(ref Omni ts){m_ts = ts;} /// /// A utility method for forcing a network update.) +/// /// public void postApply(string rendermeshexample){ @@ -17375,14 +24067,9 @@ public void postApply(string rendermeshexample){ /// public class RenderPassManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public RenderPassManagerObject(ref Omni ts){m_ts = ts;} /// /// Add as a render bin manager to the pass. ) +/// /// public void addManager(string renderpassmanager, string renderBin){ @@ -17391,6 +24078,7 @@ public void addManager(string renderpassmanager, string renderBin){ } /// /// Returns the render bin manager at the index or null if the index is out of range. ) +/// /// public string getManager(string renderpassmanager, int index){ @@ -17399,6 +24087,7 @@ public string getManager(string renderpassmanager, int index){ } /// /// Returns the total number of bin managers. ) +/// /// public int getManagerCount(string renderpassmanager){ @@ -17407,6 +24096,7 @@ public int getManagerCount(string renderpassmanager){ } /// /// Removes a render bin manager. ) +/// /// public void removeManager(string renderpassmanager, string renderBin){ @@ -17419,14 +24109,9 @@ public void removeManager(string renderpassmanager, string renderBin){ /// public class RenderPassStateTokenObject { -private Omni m_ts; - /// - /// - /// - /// -public RenderPassStateTokenObject(ref Omni ts){m_ts = ts;} /// /// @brief Disables the token.) +/// /// public void disable(string renderpassstatetoken){ @@ -17435,6 +24120,7 @@ public void disable(string renderpassstatetoken){ } /// /// @brief Enables the token. ) +/// /// public void enable(string renderpassstatetoken){ @@ -17443,6 +24129,7 @@ public void enable(string renderpassstatetoken){ } /// /// @brief Toggles the token from enabled to disabled or vice versa. ) +/// /// public void toggle(string renderpassstatetoken){ @@ -17455,14 +24142,9 @@ public void toggle(string renderpassstatetoken){ /// public class RigidShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public RigidShapeObject(ref Omni ts){m_ts = ts;} /// /// @brief Forces the client to jump to the RigidShape's transform rather then warp to it.) +/// /// public void forceClientTransform(string rigidshape){ @@ -17470,7 +24152,16 @@ public void forceClientTransform(string rigidshape){ m_ts.fnRigidShape_forceClientTransform(rigidshape); } /// -/// @brief Enables or disables the physics simulation on the RigidShape object. @param isFrozen Boolean frozen state to set the object. @tsexample // Define the frozen state. %isFrozen = \"true\"; // Inform the object of the defined frozen state %thisRigidShape.freezeSim(%isFrozen); @endtsexample @see ShapeBaseData) +/// @brief Enables or disables the physics simulation on the RigidShape object. +/// @param isFrozen Boolean frozen state to set the object. +/// @tsexample +/// // Define the frozen state. +/// %isFrozen = \"true\"; +/// // Inform the object of the defined frozen state +/// %thisRigidShape.freezeSim(%isFrozen); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void freezeSim(string rigidshape, bool isFrozen){ @@ -17478,7 +24169,13 @@ public void freezeSim(string rigidshape, bool isFrozen){ m_ts.fnRigidShape_freezeSim(rigidshape, isFrozen); } /// -/// @brief Clears physic forces from the shape and sets it at rest. @tsexample // Inform the RigidShape object to reset. %thisRigidShape.reset(); @endtsexample @see ShapeBaseData) +/// @brief Clears physic forces from the shape and sets it at rest. +/// @tsexample +/// // Inform the RigidShape object to reset. +/// %thisRigidShape.reset(); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void reset(string rigidshape){ @@ -17491,14 +24188,11 @@ public void reset(string rigidshape){ /// public class RiverObject { -private Omni m_ts; - /// - /// - /// - /// -public RiverObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force River to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force River to recreate its geometry. +/// ) +/// /// public void regenerate(string river){ @@ -17506,7 +24200,10 @@ public void regenerate(string river){ m_ts.fnRiver_regenerate(river); } /// -/// Intended as a helper to developers and editor scripts. BatchSize is not currently used. ) +/// Intended as a helper to developers and editor scripts. +/// BatchSize is not currently used. +/// ) +/// /// public void setBatchSize(string river, float meters){ @@ -17514,7 +24211,10 @@ public void setBatchSize(string river, float meters){ m_ts.fnRiver_setBatchSize(river, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SubdivideLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SubdivideLength field. +/// ) +/// /// public void setMaxDivisionSize(string river, float meters){ @@ -17522,7 +24222,10 @@ public void setMaxDivisionSize(string river, float meters){ m_ts.fnRiver_setMaxDivisionSize(river, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SegmentLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SegmentLength field. +/// ) +/// /// public void setMetersPerSegment(string river, float meters){ @@ -17530,7 +24233,10 @@ public void setMetersPerSegment(string river, float meters){ m_ts.fnRiver_setMetersPerSegment(river, meters); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void setNodeDepth(string river, int idx, float meters){ @@ -17543,14 +24249,10 @@ public void setNodeDepth(string river, int idx, float meters){ /// public class ScatterSkyObject { -private Omni m_ts; - /// - /// - /// - /// -public ScatterSkyObject(ref Omni ts){m_ts = ts;} /// -/// Apply a full network update of all fields to all clients. ) +/// Apply a full network update of all fields to all clients. +/// ) +/// /// public void applyChanges(string scattersky){ @@ -17563,14 +24265,11 @@ public void applyChanges(string scattersky){ /// public class SceneObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public SceneObjectObject(ref Omni ts){m_ts = ts;} /// -/// Get Euler rotation of this object. @return the orientation of the object in the form of rotations around the X, Y and Z axes in degrees. ) +/// Get Euler rotation of this object. +/// @return the orientation of the object in the form of rotations around the +/// X, Y and Z axes in degrees. ) +/// /// public Point3F getEulerRotation(string sceneobject){ @@ -17578,7 +24277,10 @@ public Point3F getEulerRotation(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getEulerRotation(sceneobject)); } /// -/// Get the direction this object is facing. @return a vector indicating the direction this object is facing. @note This is the object's y axis. ) +/// Get the direction this object is facing. +/// @return a vector indicating the direction this object is facing. +/// @note This is the object's y axis. ) +/// /// public Point3F getForwardVector(string sceneobject){ @@ -17586,7 +24288,9 @@ public Point3F getForwardVector(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getForwardVector(sceneobject)); } /// -/// Get the object's inverse transform. @return the inverse transform of the object ) +/// Get the object's inverse transform. +/// @return the inverse transform of the object ) +/// /// public TransformF getInverseTransform(string sceneobject){ @@ -17594,7 +24298,10 @@ public TransformF getInverseTransform(string sceneobject){ return new TransformF ( m_ts.fnSceneObject_getInverseTransform(sceneobject)); } /// -/// Get the object mounted at a particular slot. @param slot mount slot index to query @return ID of the object mounted in the slot, or 0 if no object. ) +/// Get the object mounted at a particular slot. +/// @param slot mount slot index to query +/// @return ID of the object mounted in the slot, or 0 if no object. ) +/// /// public int getMountedObject(string sceneobject, int slot){ @@ -17602,7 +24309,9 @@ public int getMountedObject(string sceneobject, int slot){ return m_ts.fnSceneObject_getMountedObject(sceneobject, slot); } /// -/// Get the number of objects mounted to us. @return the number of mounted objects. ) +/// Get the number of objects mounted to us. +/// @return the number of mounted objects. ) +/// /// public int getMountedObjectCount(string sceneobject){ @@ -17610,7 +24319,10 @@ public int getMountedObjectCount(string sceneobject){ return m_ts.fnSceneObject_getMountedObjectCount(sceneobject); } /// -/// @brief Get the mount node index of the object mounted at our given slot. @param slot mount slot index to query @return index of the mount node used by the object mounted in this slot. ) +/// @brief Get the mount node index of the object mounted at our given slot. +/// @param slot mount slot index to query +/// @return index of the mount node used by the object mounted in this slot. ) +/// /// public int getMountedObjectNode(string sceneobject, int slot){ @@ -17618,7 +24330,10 @@ public int getMountedObjectNode(string sceneobject, int slot){ return m_ts.fnSceneObject_getMountedObjectNode(sceneobject, slot); } /// -/// @brief Get the object mounted at our given node index. @param node mount node index to query @return ID of the first object mounted at the node, or 0 if none found. ) +/// @brief Get the object mounted at our given node index. +/// @param node mount node index to query +/// @return ID of the first object mounted at the node, or 0 if none found. ) +/// /// public int getMountNodeObject(string sceneobject, int node){ @@ -17626,7 +24341,10 @@ public int getMountNodeObject(string sceneobject, int node){ return m_ts.fnSceneObject_getMountNodeObject(sceneobject, node); } /// -/// Get the object's bounding box (relative to the object's origin). @return six fields, two Point3Fs, containing the min and max points of the objectbox. ) +/// Get the object's bounding box (relative to the object's origin). +/// @return six fields, two Point3Fs, containing the min and max points of the +/// objectbox. ) +/// /// public Box3F getObjectBox(string sceneobject){ @@ -17634,7 +24352,9 @@ public Box3F getObjectBox(string sceneobject){ return new Box3F ( m_ts.fnSceneObject_getObjectBox(sceneobject)); } /// -/// @brief Get the object we are mounted to. @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// @brief Get the object we are mounted to. +/// @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// /// public int getObjectMount(string sceneobject){ @@ -17642,7 +24362,9 @@ public int getObjectMount(string sceneobject){ return m_ts.fnSceneObject_getObjectMount(sceneobject); } /// -/// Get the object's world position. @return the current world position of the object ) +/// Get the object's world position. +/// @return the current world position of the object ) +/// /// public Point3F getPosition(string sceneobject){ @@ -17650,7 +24372,10 @@ public Point3F getPosition(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getPosition(sceneobject)); } /// -/// Get the right vector of the object. @return a vector indicating the right direction of this object. @note This is the object's x axis. ) +/// Get the right vector of the object. +/// @return a vector indicating the right direction of this object. +/// @note This is the object's x axis. ) +/// /// public Point3F getRightVector(string sceneobject){ @@ -17658,7 +24383,9 @@ public Point3F getRightVector(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getRightVector(sceneobject)); } /// -/// Get the object's scale. @return object scale as a Point3F ) +/// Get the object's scale. +/// @return object scale as a Point3F ) +/// /// public Point3F getScale(string sceneobject){ @@ -17666,7 +24393,9 @@ public Point3F getScale(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getScale(sceneobject)); } /// -/// Get the object's transform. @return the current transform of the object ) +/// Get the object's transform. +/// @return the current transform of the object ) +/// /// public TransformF getTransform(string sceneobject){ @@ -17674,7 +24403,9 @@ public TransformF getTransform(string sceneobject){ return new TransformF ( m_ts.fnSceneObject_getTransform(sceneobject)); } /// -/// Return the type mask for this object. @return The numeric type mask for the object. ) +/// Return the type mask for this object. +/// @return The numeric type mask for the object. ) +/// /// public int getType(string sceneobject){ @@ -17682,7 +24413,10 @@ public int getType(string sceneobject){ return m_ts.fnSceneObject_getType(sceneobject); } /// -/// Get the up vector of the object. @return a vector indicating the up direction of this object. @note This is the object's z axis. ) +/// Get the up vector of the object. +/// @return a vector indicating the up direction of this object. +/// @note This is the object's z axis. ) +/// /// public Point3F getUpVector(string sceneobject){ @@ -17690,7 +24424,10 @@ public Point3F getUpVector(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getUpVector(sceneobject)); } /// -/// Get the object's world bounding box. @return six fields, two Point3Fs, containing the min and max points of the worldbox. ) +/// Get the object's world bounding box. +/// @return six fields, two Point3Fs, containing the min and max points of the +/// worldbox. ) +/// /// public Box3F getWorldBox(string sceneobject){ @@ -17698,7 +24435,9 @@ public Box3F getWorldBox(string sceneobject){ return new Box3F ( m_ts.fnSceneObject_getWorldBox(sceneobject)); } /// -/// Get the center of the object's world bounding box. @return the center of the world bounding box for this object. ) +/// Get the center of the object's world bounding box. +/// @return the center of the world bounding box for this object. ) +/// /// public Point3F getWorldBoxCenter(string sceneobject){ @@ -17706,7 +24445,11 @@ public Point3F getWorldBoxCenter(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getWorldBoxCenter(sceneobject)); } /// -/// Check if this object has a global bounds set. If global bounds are set to be true, then the object is assumed to have an infinitely large bounding box for collision and rendering purposes. @return true if the object has a global bounds. ) +/// Check if this object has a global bounds set. +/// If global bounds are set to be true, then the object is assumed to have an +/// infinitely large bounding box for collision and rendering purposes. +/// @return true if the object has a global bounds. ) +/// /// public bool isGlobalBounds(string sceneobject){ @@ -17714,7 +24457,9 @@ public bool isGlobalBounds(string sceneobject){ return m_ts.fnSceneObject_isGlobalBounds(sceneobject); } /// -/// @brief Check if we are mounted to another object. @return true if mounted to another object, false if not mounted. ) +/// @brief Check if we are mounted to another object. +/// @return true if mounted to another object, false if not mounted. ) +/// /// public bool isMounted(string sceneobject){ @@ -17722,7 +24467,13 @@ public bool isMounted(string sceneobject){ return m_ts.fnSceneObject_isMounted(sceneobject); } /// -/// @brief Mount objB to this object at the desired slot with optional transform. @param objB Object to mount onto us @param slot Mount slot ID @param txfm (optional) mount offset transform @return true if successful, false if failed (objB is not valid) ) +/// @brief Mount objB to this object at the desired slot with optional transform. +/// +/// @param objB Object to mount onto us +/// @param slot Mount slot ID +/// @param txfm (optional) mount offset transform +/// @return true if successful, false if failed (objB is not valid) ) +/// /// public bool mountObject(string sceneobject, string objB, int slot, TransformF txfm = null ){ if (txfm== null) {txfm = new TransformF("0.000000,0.000000,0.000000,1.000000,0.000000,0.000000,0.000000");} @@ -17731,7 +24482,9 @@ public bool mountObject(string sceneobject, string objB, int slot, TransformF t return m_ts.fnSceneObject_mountObject(sceneobject, objB, slot, txfm.AsString()); } /// -/// Set the object's scale. @param scale object scale to set ) +/// Set the object's scale. +/// @param scale object scale to set ) +/// /// public void setScale(string sceneobject, Point3F scale){ @@ -17739,7 +24492,9 @@ public void setScale(string sceneobject, Point3F scale){ m_ts.fnSceneObject_setScale(sceneobject, scale.AsString()); } /// -/// Set the object's transform (orientation and position). @param txfm object transform to set ) +/// Set the object's transform (orientation and position). +/// @param txfm object transform to set ) +/// /// public void setTransform(string sceneobject, TransformF txfm){ @@ -17747,7 +24502,9 @@ public void setTransform(string sceneobject, TransformF txfm){ m_ts.fnSceneObject_setTransform(sceneobject, txfm.AsString()); } /// -/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool TickCounterAdd(string sceneobject, string countername, uint interval){ @@ -17755,7 +24512,9 @@ public bool TickCounterAdd(string sceneobject, string countername, uint interva return m_ts.fnSceneObject_TickCounterAdd(sceneobject, countername, interval); } /// -/// @brief returns the interval for a counter. @return true if successful, false if failed ) +/// @brief returns the interval for a counter. +/// @return true if successful, false if failed ) +/// /// public uint TickCounterGetInterval(string sceneobject, string countername){ @@ -17763,7 +24522,9 @@ public uint TickCounterGetInterval(string sceneobject, string countername){ return m_ts.fnSceneObject_TickCounterGetInterval(sceneobject, countername); } /// -/// @brief Checks to see if the counter exists. @return true if successful, false if failed ) +/// @brief Checks to see if the counter exists. +/// @return true if successful, false if failed ) +/// /// public bool TickCounterHas(string sceneobject, string countername){ @@ -17771,7 +24532,9 @@ public bool TickCounterHas(string sceneobject, string countername){ return m_ts.fnSceneObject_TickCounterHas(sceneobject, countername); } /// -/// @brief Removes a counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Removes a counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool TickCounterRemove(string sceneobject, string countername){ @@ -17779,7 +24542,9 @@ public bool TickCounterRemove(string sceneobject, string countername){ return m_ts.fnSceneObject_TickCounterRemove(sceneobject, countername); } /// -/// @brief resets the current count for a counter. @return true if successful, false if failed ) +/// @brief resets the current count for a counter. +/// @return true if successful, false if failed ) +/// /// public void TickCounterReset(string sceneobject, string countername){ @@ -17787,7 +24552,8 @@ public void TickCounterReset(string sceneobject, string countername){ m_ts.fnSceneObject_TickCounterReset(sceneobject, countername); } /// -/// @brief Clears all counters from the object.) +/// @brief Clears all counters from the object.) +/// /// public void TickCountersClear(string sceneobject){ @@ -17795,7 +24561,9 @@ public void TickCountersClear(string sceneobject){ m_ts.fnSceneObject_TickCountersClear(sceneobject); } /// -/// @brief Adds a new counter to be tracked via ticks. ) +/// @brief Adds a new counter to be tracked via ticks. +/// ) +/// /// public void TickCounterSuspend(string sceneobject, string countername, bool suspend){ @@ -17804,6 +24572,7 @@ public void TickCounterSuspend(string sceneobject, string countername, bool sus } /// /// Unmount us from the currently mounted object if any. ) +/// /// public void unmount(string sceneobject){ @@ -17811,7 +24580,11 @@ public void unmount(string sceneobject){ m_ts.fnSceneObject_unmount(sceneobject); } /// -/// @brief Unmount an object from ourselves. @param target object to unmount @return true if successful, false if failed ) +/// @brief Unmount an object from ourselves. +/// +/// @param target object to unmount +/// @return true if successful, false if failed ) +/// /// public bool unmountObject(string sceneobject, string target){ @@ -17824,14 +24597,13 @@ public bool unmountObject(string sceneobject, string target){ /// public class ScriptTickObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public ScriptTickObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Is this object wanting to receive tick notifications. If this object is set to receive tick notifications then its onInterpolateTick() and onProcessTick() callbacks are called. @return True if object wants tick notifications ) +/// @brief Is this object wanting to receive tick notifications. +/// +/// If this object is set to receive tick notifications then its onInterpolateTick() and +/// onProcessTick() callbacks are called. +/// @return True if object wants tick notifications ) +/// /// public bool isProcessingTicks(string scripttickobject){ @@ -17839,7 +24611,10 @@ public bool isProcessingTicks(string scripttickobject){ return m_ts.fnScriptTickObject_isProcessingTicks(scripttickobject); } /// -/// @brief Sets this object as either tick processing or not. @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// @brief Sets this object as either tick processing or not. +/// +/// @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// /// public void setProcessTicks(string scripttickobject, bool tick){ @@ -17852,14 +24627,9 @@ public void setProcessTicks(string scripttickobject, bool tick){ /// public class SettingsObject { -private Omni m_ts; - /// - /// - /// - /// -public SettingsObject(ref Omni ts){m_ts = ts;} /// /// settingObj.beginGroup(groupName, fromStart = false);) +/// /// public void Settings_beginGroup(string settings, string groupName, bool includeDefaults = false){ @@ -17868,6 +24638,7 @@ public void Settings_beginGroup(string settings, string groupName, bool include } /// /// settingObj.clearGroups();) +/// /// public void Settings_clearGroups(string settings){ @@ -17876,6 +24647,7 @@ public void Settings_clearGroups(string settings){ } /// /// settingObj.endGroup();) +/// /// public void Settings_endGroup(string settings){ @@ -17884,6 +24656,7 @@ public void Settings_endGroup(string settings){ } /// /// , false, false), settingObj.findFirstValue();) +/// /// public string Settings_findFirstValue(string settings, string pattern = "", bool deepSearch = false, bool includeDefaults = false){ @@ -17892,6 +24665,7 @@ public string Settings_findFirstValue(string settings, string pattern = "", boo } /// /// settingObj.findNextValue();) +/// /// public string Settings_findNextValue(string settings){ @@ -17900,6 +24674,7 @@ public string Settings_findNextValue(string settings){ } /// /// settingObj.getCurrentGroups();) +/// /// public string Settings_getCurrentGroups(string settings){ @@ -17908,6 +24683,7 @@ public string Settings_getCurrentGroups(string settings){ } /// /// %success = settingObj.read();) +/// /// public bool Settings_read(string settings){ @@ -17916,6 +24692,7 @@ public bool Settings_read(string settings){ } /// /// settingObj.remove(settingName, includeDefaults = false);) +/// /// public void Settings_remove(string settings, string settingName, bool includeDefaults = false){ @@ -17924,6 +24701,7 @@ public void Settings_remove(string settings, string settingName, bool includeDe } /// /// settingObj.setDefaultValue(settingName, value);) +/// /// public void Settings_setDefaultValue(string settings, string settingName, string value){ @@ -17932,6 +24710,7 @@ public void Settings_setDefaultValue(string settings, string settingName, strin } /// /// ), settingObj.setValue(settingName, value);) +/// /// public void Settings_setValue(string settings, string settingName, string value = ""){ @@ -17940,6 +24719,7 @@ public void Settings_setValue(string settings, string settingName, string value } /// /// ), settingObj.value(settingName, defaultValue);) +/// /// public string Settings_value(string settings, string settingName, string defaultValue = ""){ @@ -17948,6 +24728,7 @@ public string Settings_value(string settings, string settingName, string defaul } /// /// (Settings, write, bool, 2, 2, %success = settingObj.write();) +/// /// public bool write(string settings= ""){ @@ -17960,14 +24741,11 @@ public bool write(string settings= ""){ /// public class SFXControllerObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXControllerObject(ref Omni ts){m_ts = ts;} /// -/// Get the index of the playlist slot currently processed by the controller. @return The slot index currently being played. @see SFXPlayList ) +/// Get the index of the playlist slot currently processed by the controller. +/// @return The slot index currently being played. +/// @see SFXPlayList ) +/// /// public int getCurrentSlot(string sfxcontroller){ @@ -17975,7 +24753,9 @@ public int getCurrentSlot(string sfxcontroller){ return m_ts.fnSFXController_getCurrentSlot(sfxcontroller); } /// -/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. @param index Index of the playlist slot. ) +/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. +/// @param index Index of the playlist slot. ) +/// /// public void setCurrentSlot(string sfxcontroller, int index){ @@ -17988,14 +24768,12 @@ public void setCurrentSlot(string sfxcontroller, int index){ /// public class SFXEmitterObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXEmitterObject(ref Omni ts){m_ts = ts;} /// -/// Get the sound source object from the emitter. @return The sound source used by the emitter or null. @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts actually hold on to %SFXSources. ) +/// Get the sound source object from the emitter. +/// @return The sound source used by the emitter or null. +/// @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts +/// actually hold on to %SFXSources. ) +/// /// public string getSource(string sfxemitter){ @@ -18003,7 +24781,9 @@ public string getSource(string sfxemitter){ return m_ts.fnSFXEmitter_getSource(sfxemitter); } /// -/// Manually start playback of the emitter's sound. If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// Manually start playback of the emitter's sound. +/// If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// /// public void play(string sfxemitter){ @@ -18011,7 +24791,9 @@ public void play(string sfxemitter){ m_ts.fnSFXEmitter_play(sfxemitter); } /// -/// Manually stop playback of the emitter's sound. If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// Manually stop playback of the emitter's sound. +/// If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// /// public void stop(string sfxemitter){ @@ -18024,14 +24806,10 @@ public void stop(string sfxemitter){ /// public class SFXParameterObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXParameterObject(ref Omni ts){m_ts = ts;} /// -/// Get the name of the parameter. @return The paramete name. ) +/// Get the name of the parameter. +/// @return The paramete name. ) +/// /// public string getParameterName(string sfxparameter){ @@ -18039,7 +24817,9 @@ public string getParameterName(string sfxparameter){ return m_ts.fnSFXParameter_getParameterName(sfxparameter); } /// -/// Reset the parameter's value to its default. @see SFXParameter::defaultValue ) +/// Reset the parameter's value to its default. +/// @see SFXParameter::defaultValue ) +/// /// public void reset(string sfxparameter){ @@ -18052,14 +24832,10 @@ public void reset(string sfxparameter){ /// public class SFXProfileObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXProfileObject(ref Omni ts){m_ts = ts;} /// -/// Return the length of the sound data in seconds. @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// Return the length of the sound data in seconds. +/// @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// /// public float getSoundDuration(string sfxprofile){ @@ -18072,14 +24848,11 @@ public float getSoundDuration(string sfxprofile){ /// public class SFXSoundObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXSoundObject(ref Omni ts){m_ts = ts;} /// -/// Get the total play time (in seconds) of the sound data attached to the sound. @return @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// Get the total play time (in seconds) of the sound data attached to the sound. +/// @return +/// @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// /// public float getDuration(string sfxsound){ @@ -18087,7 +24860,9 @@ public float getDuration(string sfxsound){ return m_ts.fnSFXSound_getDuration(sfxsound); } /// -/// Get the current playback position in seconds. @return The current play cursor offset. ) +/// Get the current playback position in seconds. +/// @return The current play cursor offset. ) +/// /// public float getPosition(string sfxsound){ @@ -18095,7 +24870,12 @@ public float getPosition(string sfxsound){ return m_ts.fnSFXSound_getPosition(sfxsound); } /// -/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. For streamed sounds, this will be false during playback when the stream queue for the sound is starved and waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to return false. @return True if the sound is ready for playback. ) +/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. +/// For streamed sounds, this will be false during playback when the stream queue for the sound is starved and +/// waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to +/// return false. +/// @return True if the sound is ready for playback. ) +/// /// public bool isReady(string sfxsound){ @@ -18103,7 +24883,11 @@ public bool isReady(string sfxsound){ return m_ts.fnSFXSound_isReady(sfxsound); } /// -/// Set the current playback position in seconds. If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, playback will resume at the given position when play() is called. @param position The new position of the play cursor (in seconds). ) +/// Set the current playback position in seconds. +/// If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, +/// playback will resume at the given position when play() is called. +/// @param position The new position of the play cursor (in seconds). ) +/// /// public void setPosition(string sfxsound, float position){ @@ -18116,14 +24900,12 @@ public void setPosition(string sfxsound, float position){ /// public class SFXSourceObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXSourceObject(ref Omni ts){m_ts = ts;} /// -/// ), ( vector position [, vector direction ] ) Set the position and orientation of a 3D sound source. @hide ) +/// ), +/// ( vector position [, vector direction ] ) +/// Set the position and orientation of a 3D sound source. +/// @hide ) +/// /// public void SFXSource_setTransform(string sfxsource, string position, string direction = ""){ @@ -18131,7 +24913,32 @@ public void SFXSource_setTransform(string sfxsource, string position, string di m_ts.fn_SFXSource_setTransform(sfxsource, position, direction); } /// -/// Add a notification marker called @a name at @a pos seconds of playback. @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there may be a delay between the play cursor actually passing the position and the callback being triggered. @note For looped sounds, the marker will trigger on each iteration. @tsexample // Create a new source. $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); // Assign a class to the source. $source.class = \"BackgroundMusic\"; // Add a playback marker at one minute into playback. $source.addMarker( \"first\", 60 ); // Define the callback function. This function will be called when the playback position passes the one minute mark. function BackgroundMusic::onMarkerPassed( %this, %markerName ) { if( %markerName $= \"first\" ) echo( \"Playback has passed the 60 seconds mark.\" ); } // Play the sound. $source.play(); @endtsexample ) +/// Add a notification marker called @a name at @a pos seconds of playback. +/// @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. +/// @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there +/// may be a delay between the play cursor actually passing the position and the callback being triggered. +/// @note For looped sounds, the marker will trigger on each iteration. +/// @tsexample +/// // Create a new source. +/// $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); +/// +/// // Assign a class to the source. +/// $source.class = \"BackgroundMusic\"; +/// +/// // Add a playback marker at one minute into playback. +/// $source.addMarker( \"first\", 60 ); +/// +/// // Define the callback function. This function will be called when the playback position passes the one minute mark. +/// function BackgroundMusic::onMarkerPassed( %this, %markerName ) +/// { +/// if( %markerName $= \"first\" ) +/// echo( \"Playback has passed the 60 seconds mark.\" ); +/// } +/// +/// // Play the sound. +/// $source.play(); +/// @endtsexample ) +/// /// public void addMarker(string sfxsource, string name, float pos){ @@ -18139,7 +24946,11 @@ public void addMarker(string sfxsource, string name, float pos){ m_ts.fnSFXSource_addMarker(sfxsource, name, pos); } /// -/// Attach @a parameter to the source, Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter will also trigger an initial read-out of the parameter's current value. @param parameter The parameter to attach to the source. ) +/// Attach @a parameter to the source, +/// Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter +/// will also trigger an initial read-out of the parameter's current value. +/// @param parameter The parameter to attach to the source. ) +/// /// public void addParameter(string sfxsource, string parameter){ @@ -18147,7 +24958,12 @@ public void addParameter(string sfxsource, string parameter){ m_ts.fnSFXSource_addParameter(sfxsource, parameter); } /// -/// Get the final effective volume level of the source. This method returns the volume level as it is after source group volume modulation, fades, and distance-based volume attenuation have been applied to the base volume level. @return The effective volume of the source. @ref SFXSource_volume ) +/// Get the final effective volume level of the source. +/// This method returns the volume level as it is after source group volume modulation, fades, and distance-based +/// volume attenuation have been applied to the base volume level. +/// @return The effective volume of the source. +/// @ref SFXSource_volume ) +/// /// public float getAttenuatedVolume(string sfxsource){ @@ -18155,7 +24971,12 @@ public float getAttenuatedVolume(string sfxsource){ return m_ts.fnSFXSource_getAttenuatedVolume(sfxsource); } /// -/// Get the fade-in time set on the source. This will initially be SFXDescription::fadeInTime. @return The fade-in time set on the source in seconds. @see SFXDescription::fadeInTime @ref SFXSource_fades ) +/// Get the fade-in time set on the source. +/// This will initially be SFXDescription::fadeInTime. +/// @return The fade-in time set on the source in seconds. +/// @see SFXDescription::fadeInTime +/// @ref SFXSource_fades ) +/// /// public float getFadeInTime(string sfxsource){ @@ -18163,7 +24984,12 @@ public float getFadeInTime(string sfxsource){ return m_ts.fnSFXSource_getFadeInTime(sfxsource); } /// -/// Get the fade-out time set on the source. This will initially be SFXDescription::fadeOutTime. @return The fade-out time set on the source in seconds. @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Get the fade-out time set on the source. +/// This will initially be SFXDescription::fadeOutTime. +/// @return The fade-out time set on the source in seconds. +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public float getFadeOutTime(string sfxsource){ @@ -18171,7 +24997,17 @@ public float getFadeOutTime(string sfxsource){ return m_ts.fnSFXSource_getFadeOutTime(sfxsource); } /// -/// Get the parameter at the given index. @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). @return The parameter at the given @a index or null if @a index is out of range. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameterCount ) +/// Get the parameter at the given index. +/// @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). +/// @return The parameter at the given @a index or null if @a index is out of range. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameterCount ) +/// /// public string getParameter(string sfxsource, int index){ @@ -18179,7 +25015,17 @@ public string getParameter(string sfxsource, int index){ return m_ts.fnSFXSource_getParameter(sfxsource, index); } /// -/// Get the number of SFXParameters that are attached to the source. @return The number of parameters attached to the source. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameter @see addParameter ) +/// Get the number of SFXParameters that are attached to the source. +/// @return The number of parameters attached to the source. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameter +/// @see addParameter ) +/// /// public int getParameterCount(string sfxsource){ @@ -18187,7 +25033,12 @@ public int getParameterCount(string sfxsource){ return m_ts.fnSFXSource_getParameterCount(sfxsource); } /// -/// Get the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @return The current pitch scale factor of the source. @see setPitch @see SFXDescription::pitch ) +/// Get the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @return The current pitch scale factor of the source. +/// @see setPitch +/// @see SFXDescription::pitch ) +/// /// public float getPitch(string sfxsource){ @@ -18195,7 +25046,9 @@ public float getPitch(string sfxsource){ return m_ts.fnSFXSource_getPitch(sfxsource); } /// -/// Get the current playback status. @return Te current playback status ) +/// Get the current playback status. +/// @return Te current playback status ) +/// /// public TypeSFXStatus getStatus(string sfxsource){ @@ -18203,7 +25056,14 @@ public TypeSFXStatus getStatus(string sfxsource){ return (TypeSFXStatus)( m_ts.fnSFXSource_getStatus(sfxsource)); } /// -/// Get the current base volume level of the source. This is not the final effective volume that the source is playing at but rather the starting volume level before source group modulation, fades, or distance-based volume attenuation are applied. @return The current base volume level. @see setVolume @see SFXDescription::volume @ref SFXSource_volume ) +/// Get the current base volume level of the source. +/// This is not the final effective volume that the source is playing at but rather the starting +/// volume level before source group modulation, fades, or distance-based volume attenuation are applied. +/// @return The current base volume level. +/// @see setVolume +/// @see SFXDescription::volume +/// @ref SFXSource_volume ) +/// /// public float getVolume(string sfxsource){ @@ -18211,7 +25071,12 @@ public float getVolume(string sfxsource){ return m_ts.fnSFXSource_getVolume(sfxsource); } /// -/// Test whether the source is currently paused. @return True if the source is in paused state, false otherwise. @see pause @see getStatus @see SFXStatus ) +/// Test whether the source is currently paused. +/// @return True if the source is in paused state, false otherwise. +/// @see pause +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool isPaused(string sfxsource){ @@ -18219,7 +25084,12 @@ public bool isPaused(string sfxsource){ return m_ts.fnSFXSource_isPaused(sfxsource); } /// -/// Test whether the source is currently playing. @return True if the source is in playing state, false otherwise. @see play @see getStatus @see SFXStatus ) +/// Test whether the source is currently playing. +/// @return True if the source is in playing state, false otherwise. +/// @see play +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool isPlaying(string sfxsource){ @@ -18227,7 +25097,12 @@ public bool isPlaying(string sfxsource){ return m_ts.fnSFXSource_isPlaying(sfxsource); } /// -/// Test whether the source is currently stopped. @return True if the source is in stopped state, false otherwise. @see stop @see getStatus @see SFXStatus ) +/// Test whether the source is currently stopped. +/// @return True if the source is in stopped state, false otherwise. +/// @see stop +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool isStopped(string sfxsource){ @@ -18235,7 +25110,13 @@ public bool isStopped(string sfxsource){ return m_ts.fnSFXSource_isStopped(sfxsource); } /// -/// Pause playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately to paused state but will rather remain in playing state until the fade-out time has expired.. ) +/// Pause playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately to paused state but will +/// rather remain in playing state until the fade-out time has expired.. ) +/// /// public void pause(string sfxsource, float fadeOutTime = -1.0f){ @@ -18243,7 +25124,13 @@ public void pause(string sfxsource, float fadeOutTime = -1.0f){ m_ts.fnSFXSource_pause(sfxsource, fadeOutTime); } /// -/// Start playback of the source. If the sound data for the source has not yet been fully loaded, there will be a delay after calling play and playback will start after the data has become available. @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime set in the source's associated description is used. Pass 0 to disable a fade-in effect that may be configured on the description. ) +/// Start playback of the source. +/// If the sound data for the source has not yet been fully loaded, there will be a delay after calling +/// play and playback will start after the data has become available. +/// @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime +/// set in the source's associated description is used. Pass 0 to disable a fade-in effect that may +/// be configured on the description. ) +/// /// public void play(string sfxsource, float fadeInTime = -1.0f){ @@ -18251,7 +25138,11 @@ public void play(string sfxsource, float fadeInTime = -1.0f){ m_ts.fnSFXSource_play(sfxsource, fadeInTime); } /// -/// Detach @a parameter from the source. Once detached, the source will no longer react to value changes of the given @a parameter. If the parameter is not attached to the source, the method will do nothing. @param parameter The parameter to detach from the source. ) +/// Detach @a parameter from the source. +/// Once detached, the source will no longer react to value changes of the given @a parameter. +/// If the parameter is not attached to the source, the method will do nothing. +/// @param parameter The parameter to detach from the source. ) +/// /// public void removeParameter(string sfxsource, string parameter){ @@ -18259,7 +25150,12 @@ public void removeParameter(string sfxsource, string parameter){ m_ts.fnSFXSource_removeParameter(sfxsource, parameter); } /// -/// Set up the 3D volume cone for the source. @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. @note This method has no effect on the source if the source is not 3D. ) +/// Set up the 3D volume cone for the source. +/// @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. +/// @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. +/// @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. +/// @note This method has no effect on the source if the source is not 3D. ) +/// /// public void setCone(string sfxsource, float innerAngle, float outerAngle, float outsideVolume){ @@ -18267,7 +25163,13 @@ public void setCone(string sfxsource, float innerAngle, float outerAngle, float m_ts.fnSFXSource_setCone(sfxsource, innerAngle, outerAngle, outsideVolume); } /// -/// Set the fade time parameters of the source. @param fadeInTime The new fade-in time in seconds. @param fadeOutTime The new fade-out time in seconds. @see SFXDescription::fadeInTime @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Set the fade time parameters of the source. +/// @param fadeInTime The new fade-in time in seconds. +/// @param fadeOutTime The new fade-out time in seconds. +/// @see SFXDescription::fadeInTime +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public void setFadeTimes(string sfxsource, float fadeInTime, float fadeOutTime){ @@ -18275,7 +25177,12 @@ public void setFadeTimes(string sfxsource, float fadeInTime, float fadeOutTime) m_ts.fnSFXSource_setFadeTimes(sfxsource, fadeInTime, fadeOutTime); } /// -/// Set the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @param pitch The new pitch scale factor. @see getPitch @see SFXDescription::pitch ) +/// Set the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @param pitch The new pitch scale factor. +/// @see getPitch +/// @see SFXDescription::pitch ) +/// /// public void setPitch(string sfxsource, float pitch){ @@ -18283,7 +25190,13 @@ public void setPitch(string sfxsource, float pitch){ m_ts.fnSFXSource_setPitch(sfxsource, pitch); } /// -/// Set the base volume level for the source. This volume will be the starting point for source group volume modulation, fades, and distance-based volume attenuation. @param volume The new base volume level for the source. Must be 0>=volume=1. @see getVolume @ref SFXSource_volume ) +/// Set the base volume level for the source. +/// This volume will be the starting point for source group volume modulation, fades, and distance-based +/// volume attenuation. +/// @param volume The new base volume level for the source. Must be 0>=volume=1. +/// @see getVolume +/// @ref SFXSource_volume ) +/// /// public void setVolume(string sfxsource, float volume){ @@ -18291,7 +25204,13 @@ public void setVolume(string sfxsource, float volume){ m_ts.fnSFXSource_setVolume(sfxsource, volume); } /// -/// Stop playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but will rather remain in playing state until the fade-out time has expired. ) +/// Stop playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but +/// will rather remain in playing state until the fade-out time has expired. ) +/// /// public void stop(string sfxsource, float fadeOutTime = -1.0f){ @@ -18304,14 +25223,12 @@ public void stop(string sfxsource, float fadeOutTime = -1.0f){ /// public class SFXStateObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXStateObject(ref Omni ts){m_ts = ts;} /// -/// Increase the activation count on the state. If the state isn't already active and it is not disabled, the state will be activated. @see isActive @see deactivate ) +/// Increase the activation count on the state. +/// If the state isn't already active and it is not disabled, the state will be activated. +/// @see isActive +/// @see deactivate ) +/// /// public void activate(string sfxstate){ @@ -18319,7 +25236,11 @@ public void activate(string sfxstate){ m_ts.fnSFXState_activate(sfxstate); } /// -/// Decrease the activation count on the state. If the count reaches zero and the state was not disabled, the state will be deactivated. @see isActive @see activate ) +/// Decrease the activation count on the state. +/// If the count reaches zero and the state was not disabled, the state will be deactivated. +/// @see isActive +/// @see activate ) +/// /// public void deactivate(string sfxstate){ @@ -18327,7 +25248,10 @@ public void deactivate(string sfxstate){ m_ts.fnSFXState_deactivate(sfxstate); } /// -/// Increase the disabling count of the state. If the state is currently active, it will be deactivated. @see isDisabled ) +/// Increase the disabling count of the state. +/// If the state is currently active, it will be deactivated. +/// @see isDisabled ) +/// /// public void disable(string sfxstate){ @@ -18335,7 +25259,11 @@ public void disable(string sfxstate){ m_ts.fnSFXState_disable(sfxstate); } /// -/// Decrease the disabling count of the state. If the disabling count reaches zero while the activation count is still non-zero, the state will be reactivated again. @see isDisabled ) +/// Decrease the disabling count of the state. +/// If the disabling count reaches zero while the activation count is still non-zero, +/// the state will be reactivated again. +/// @see isDisabled ) +/// /// public void enable(string sfxstate){ @@ -18343,7 +25271,11 @@ public void enable(string sfxstate){ m_ts.fnSFXState_enable(sfxstate); } /// -/// Test whether the state is currently active. This is true when the activation count is >0 and the disabling count is =0. @return True if the state is currently active. @see activate ) +/// Test whether the state is currently active. +/// This is true when the activation count is >0 and the disabling count is =0. +/// @return True if the state is currently active. +/// @see activate ) +/// /// public bool isActive(string sfxstate){ @@ -18351,7 +25283,11 @@ public bool isActive(string sfxstate){ return m_ts.fnSFXState_isActive(sfxstate); } /// -/// Test whether the state is currently disabled. This is true when the disabling count of the state is non-zero. @return True if the state is disabled. @see disable ) +/// Test whether the state is currently disabled. +/// This is true when the disabling count of the state is non-zero. +/// @return True if the state is disabled. +/// @see disable ) +/// /// public bool isDisabled(string sfxstate){ @@ -18364,14 +25300,14 @@ public bool isDisabled(string sfxstate){ /// public class ShaderDataObject { -private Omni m_ts; - /// - /// - /// - /// -public ShaderDataObject(ref Omni ts){m_ts = ts;} /// -/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. @tsexample // Rebuild the shader instances from ShaderData CloudLayerShader CloudLayerShader.reload(); @endtsexample) +/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. +/// +/// @tsexample +/// // Rebuild the shader instances from ShaderData CloudLayerShader +/// CloudLayerShader.reload(); +/// @endtsexample) +/// /// public void reload(string shaderdata){ @@ -18384,14 +25320,11 @@ public void reload(string shaderdata){ /// public class ShapeBaseObject { -private Omni m_ts; - /// - /// - /// - /// -public ShapeBaseObject(ref Omni ts){m_ts = ts;} /// -/// @brief Increment the current damage level by the specified amount. @param amount value to add to current damage level ) +/// @brief Increment the current damage level by the specified amount. +/// +/// @param amount value to add to current damage level ) +/// /// public void applyDamage(string shapebase, float amount){ @@ -18399,7 +25332,12 @@ public void applyDamage(string shapebase, float amount){ m_ts.fnShapeBase_applyDamage(shapebase, amount); } /// -/// @brief Apply an impulse to the object. @param pos world position of the impulse @param vec impulse momentum (velocity * mass) @return true ) +/// @brief Apply an impulse to the object. +/// +/// @param pos world position of the impulse +/// @param vec impulse momentum (velocity * mass) +/// @return true ) +/// /// public bool applyImpulse(string shapebase, Point3F pos, Point3F vec){ @@ -18407,7 +25345,13 @@ public bool applyImpulse(string shapebase, Point3F pos, Point3F vec){ return m_ts.fnShapeBase_applyImpulse(shapebase, pos.AsString(), vec.AsString()); } /// -/// @brief Repair damage by the specified amount. Note that the damage level is only reduced by repairRate per tick, so it may take several ticks for the total repair to complete. @param amount total repair value (subtracted from damage level over time) ) +/// @brief Repair damage by the specified amount. +/// +/// Note that the damage level is only reduced by repairRate per tick, so it may +/// take several ticks for the total repair to complete. +/// +/// @param amount total repair value (subtracted from damage level over time) ) +/// /// public void applyRepair(string shapebase, float amount){ @@ -18416,6 +25360,7 @@ public void applyRepair(string shapebase, float amount){ } /// /// @brief Explodes an object into pieces.) +/// /// public void blowUp(string shapebase){ @@ -18423,7 +25368,11 @@ public void blowUp(string shapebase){ m_ts.fnShapeBase_blowUp(shapebase); } /// -/// @brief Check if this object can cloak. @return true @note Not implemented as it always returns true.) +/// @brief Check if this object can cloak. +/// @return true +/// +/// @note Not implemented as it always returns true.) +/// /// public bool canCloak(string shapebase){ @@ -18431,7 +25380,24 @@ public bool canCloak(string shapebase){ return m_ts.fnShapeBase_canCloak(shapebase); } /// -/// @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void changeMaterial(string shapebase, string mapTo, string oldMat, string newMat){ @@ -18439,7 +25405,13 @@ public void changeMaterial(string shapebase, string mapTo, string oldMat, strin m_ts.fnShapeBase_changeMaterial(shapebase, mapTo, oldMat, newMat); } /// -/// @brief Destroy an animation thread, which prevents it from playing. @param slot thread slot to destroy @return true if successful, false if failed @see playThread ) +/// @brief Destroy an animation thread, which prevents it from playing. +/// +/// @param slot thread slot to destroy +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool destroyThread(string shapebase, int slot){ @@ -18447,7 +25419,10 @@ public bool destroyThread(string shapebase, int slot){ return m_ts.fnShapeBase_destroyThread(shapebase, slot); } /// -/// @brief Print a list of visible and hidden meshes in the shape to the console for debugging purposes. @note Only in a SHIPPING build.) +/// @brief Print a list of visible and hidden meshes in the shape to the console +/// for debugging purposes. +/// @note Only in a SHIPPING build.) +/// /// public void dumpMeshVisibility(string shapebase){ @@ -18455,7 +25430,12 @@ public void dumpMeshVisibility(string shapebase){ m_ts.fnShapeBase_dumpMeshVisibility(shapebase); } /// -/// @brief Get the position at which the AI should stand to repair things. If the shape defines a node called \"AIRepairNode\", this method will return the current world position of that node, otherwise \"0 0 0\". @return the AI repair position ) +/// @brief Get the position at which the AI should stand to repair things. +/// +/// If the shape defines a node called \"AIRepairNode\", this method will +/// return the current world position of that node, otherwise \"0 0 0\". +/// @return the AI repair position ) +/// /// public Point3F getAIRepairPoint(string shapebase){ @@ -18463,7 +25443,10 @@ public Point3F getAIRepairPoint(string shapebase){ return new Point3F ( m_ts.fnShapeBase_getAIRepairPoint(shapebase)); } /// -/// @brief Returns the vertical field of view in degrees for this object if used as a camera. @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// @brief Returns the vertical field of view in degrees for this object if used as a camera. +/// +/// @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// /// public float getCameraFov(string shapebase){ @@ -18471,7 +25454,15 @@ public float getCameraFov(string shapebase){ return m_ts.fnShapeBase_getCameraFov(shapebase); } /// -/// @brief Get the client (if any) that controls this object. The controlling client is the one that will send moves to us to act on. @return the ID of the controlling GameConnection, or 0 if this object is not controlled by any client. @see GameConnection) +/// @brief Get the client (if any) that controls this object. +/// +/// The controlling client is the one that will send moves to us to act on. +/// +/// @return the ID of the controlling GameConnection, or 0 if this object is not +/// controlled by any client. +/// +/// @see GameConnection) +/// /// public int getControllingClient(string shapebase){ @@ -18479,7 +25470,11 @@ public int getControllingClient(string shapebase){ return m_ts.fnShapeBase_getControllingClient(shapebase); } /// -/// @brief Get the object (if any) that controls this object. @return the ID of the controlling ShapeBase object, or 0 if this object is not controlled by another object. ) +/// @brief Get the object (if any) that controls this object. +/// +/// @return the ID of the controlling ShapeBase object, or 0 if this object is +/// not controlled by another object. ) +/// /// public int getControllingObject(string shapebase){ @@ -18487,7 +25482,12 @@ public int getControllingObject(string shapebase){ return m_ts.fnShapeBase_getControllingObject(shapebase); } /// -/// @brief Get the damage flash level. @return flash level @see setDamageFlash ) +/// @brief Get the damage flash level. +/// +/// @return flash level +/// +/// @see setDamageFlash ) +/// /// public float getDamageFlash(string shapebase){ @@ -18495,7 +25495,12 @@ public float getDamageFlash(string shapebase){ return m_ts.fnShapeBase_getDamageFlash(shapebase); } /// -/// @brief Get the object's current damage level. @return damage level @see setDamageLevel()) +/// @brief Get the object's current damage level. +/// +/// @return damage level +/// +/// @see setDamageLevel()) +/// /// public float getDamageLevel(string shapebase){ @@ -18503,7 +25508,12 @@ public float getDamageLevel(string shapebase){ return m_ts.fnShapeBase_getDamageLevel(shapebase); } /// -/// @brief Get the object's current damage level as a percentage of maxDamage. @return damageLevel / datablock.maxDamage @see setDamageLevel()) +/// @brief Get the object's current damage level as a percentage of maxDamage. +/// +/// @return damageLevel / datablock.maxDamage +/// +/// @see setDamageLevel()) +/// /// public float getDamagePercent(string shapebase){ @@ -18511,7 +25521,12 @@ public float getDamagePercent(string shapebase){ return m_ts.fnShapeBase_getDamagePercent(shapebase); } /// -/// @brief Get the object's damage state. @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" @see setDamageState()) +/// @brief Get the object's damage state. +/// +/// @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// +/// @see setDamageState()) +/// /// public string getDamageState(string shapebase){ @@ -18519,7 +25534,10 @@ public string getDamageState(string shapebase){ return m_ts.fnShapeBase_getDamageState(shapebase); } /// -/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. @return Default FOV ) +/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. +/// +/// @return Default FOV ) +/// /// public float getDefaultCameraFov(string shapebase){ @@ -18527,7 +25545,12 @@ public float getDefaultCameraFov(string shapebase){ return m_ts.fnShapeBase_getDefaultCameraFov(shapebase); } /// -/// @brief Get the object's current energy level. @return energy level @see setEnergyLevel()) +/// @brief Get the object's current energy level. +/// +/// @return energy level +/// +/// @see setEnergyLevel()) +/// /// public float getEnergyLevel(string shapebase){ @@ -18535,7 +25558,11 @@ public float getEnergyLevel(string shapebase){ return m_ts.fnShapeBase_getEnergyLevel(shapebase); } /// -/// @brief Get the object's current energy level as a percentage of maxEnergy. @return energyLevel / datablock.maxEnergy @see setEnergyLevel()) +/// @brief Get the object's current energy level as a percentage of maxEnergy. +/// @return energyLevel / datablock.maxEnergy +/// +/// @see setEnergyLevel()) +/// /// public float getEnergyPercent(string shapebase){ @@ -18543,7 +25570,17 @@ public float getEnergyPercent(string shapebase){ return m_ts.fnShapeBase_getEnergyPercent(shapebase); } /// -/// @brief Get the position of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current world position, otherwise it will return the object's current world position. @return the eye position for this object @see getEyeVector @see getEyeTransform ) +/// @brief Get the position of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current world position, otherwise it will return the object's current +/// world position. +/// +/// @return the eye position for this object +/// +/// @see getEyeVector +/// @see getEyeTransform ) +/// /// public Point3F getEyePoint(string shapebase){ @@ -18551,7 +25588,17 @@ public Point3F getEyePoint(string shapebase){ return new Point3F ( m_ts.fnShapeBase_getEyePoint(shapebase)); } /// -/// @brief Get the 'eye' transform for this object. If the object model has a node called 'eye', this method will return that node's current transform, otherwise it will return the object's current transform. @return the eye transform for this object @see getEyeVector @see getEyePoint ) +/// @brief Get the 'eye' transform for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current transform, otherwise it will return the object's current +/// transform. +/// +/// @return the eye transform for this object +/// +/// @see getEyeVector +/// @see getEyePoint ) +/// /// public TransformF getEyeTransform(string shapebase){ @@ -18559,7 +25606,17 @@ public TransformF getEyeTransform(string shapebase){ return new TransformF ( m_ts.fnShapeBase_getEyeTransform(shapebase)); } /// -/// @brief Get the forward direction of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current forward direction vector, otherwise it will return the object's current forward direction vector. @return the eye vector for this object @see getEyePoint @see getEyeTransform ) +/// @brief Get the forward direction of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current forward direction vector, otherwise it will return the +/// object's current forward direction vector. +/// +/// @return the eye vector for this object +/// +/// @see getEyePoint +/// @see getEyeTransform ) +/// /// public Point3F getEyeVector(string shapebase){ @@ -18567,7 +25624,11 @@ public Point3F getEyeVector(string shapebase){ return new Point3F ( m_ts.fnShapeBase_getEyeVector(shapebase)); } /// -/// @brief Get the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current alt trigger state ) +/// @brief Get the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current alt trigger state ) +/// /// public bool getImageAltTrigger(string shapebase, int slot){ @@ -18575,7 +25636,11 @@ public bool getImageAltTrigger(string shapebase, int slot){ return m_ts.fnShapeBase_getImageAltTrigger(shapebase, slot); } /// -/// @brief Get the ammo state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current ammo state ) +/// @brief Get the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current ammo state ) +/// /// public bool getImageAmmo(string shapebase, int slot){ @@ -18583,7 +25648,12 @@ public bool getImageAmmo(string shapebase, int slot){ return m_ts.fnShapeBase_getImageAmmo(shapebase, slot); } /// -/// @brief Get the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to query @param trigger Generic trigger number @return the Image's current generic trigger state ) +/// @brief Get the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @param trigger Generic trigger number +/// @return the Image's current generic trigger state ) +/// /// public bool getImageGenericTrigger(string shapebase, int slot, int trigger){ @@ -18591,7 +25661,11 @@ public bool getImageGenericTrigger(string shapebase, int slot, int trigger){ return m_ts.fnShapeBase_getImageGenericTrigger(shapebase, slot, trigger); } /// -/// @brief Get the loaded state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current loaded state ) +/// @brief Get the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current loaded state ) +/// /// public bool getImageLoaded(string shapebase, int slot){ @@ -18599,7 +25673,11 @@ public bool getImageLoaded(string shapebase, int slot){ return m_ts.fnShapeBase_getImageLoaded(shapebase, slot); } /// -/// @brief Get the script animation prefix of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current script animation prefix ) +/// @brief Get the script animation prefix of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current script animation prefix ) +/// /// public string getImageScriptAnimPrefix(string shapebase, int slot){ @@ -18607,7 +25685,12 @@ public string getImageScriptAnimPrefix(string shapebase, int slot){ return m_ts.fnShapeBase_getImageScriptAnimPrefix(shapebase, slot); } /// -/// @brief Get the skin tag ID for the Image mounted in the specified slot. @param slot Image slot to query @return the skinTag value passed to mountImage when the image was mounted ) +/// @brief Get the skin tag ID for the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the skinTag value passed to mountImage when the image was +/// mounted ) +/// /// public int getImageSkinTag(string shapebase, int slot){ @@ -18615,7 +25698,11 @@ public int getImageSkinTag(string shapebase, int slot){ return m_ts.fnShapeBase_getImageSkinTag(shapebase, slot); } /// -/// @brief Get the name of the current state of the Image in the specified slot. @param slot Image slot to query @return name of the current Image state, or \"Error\" if slot is invalid ) +/// @brief Get the name of the current state of the Image in the specified slot. +/// +/// @param slot Image slot to query +/// @return name of the current Image state, or \"Error\" if slot is invalid ) +/// /// public string getImageState(string shapebase, int slot){ @@ -18623,7 +25710,11 @@ public string getImageState(string shapebase, int slot){ return m_ts.fnShapeBase_getImageState(shapebase, slot); } /// -/// @brief Get the target state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current target state ) +/// @brief Get the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current target state ) +/// /// public bool getImageTarget(string shapebase, int slot){ @@ -18631,7 +25722,11 @@ public bool getImageTarget(string shapebase, int slot){ return m_ts.fnShapeBase_getImageTarget(shapebase, slot); } /// -/// @brief Get the trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current trigger state ) +/// @brief Get the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current trigger state ) +/// /// public bool getImageTrigger(string shapebase, int slot){ @@ -18639,7 +25734,19 @@ public bool getImageTrigger(string shapebase, int slot){ return m_ts.fnShapeBase_getImageTrigger(shapebase, slot); } /// -/// @brief Get the world position this object is looking at. Casts a ray from the eye and returns information about what the ray hits. @param distance maximum distance of the raycast @param typeMask typeMask of objects to include for raycast collision testing @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit @tsexample %lookat = %obj.getLookAtPoint(); echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); @endtsexample ) +/// @brief Get the world position this object is looking at. +/// +/// Casts a ray from the eye and returns information about what the ray hits. +/// +/// @param distance maximum distance of the raycast +/// @param typeMask typeMask of objects to include for raycast collision testing +/// @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit +/// +/// @tsexample +/// %lookat = %obj.getLookAtPoint(); +/// echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); +/// @endtsexample ) +/// /// public string getLookAtPoint(string shapebase, float distance = 2000, uint typeMask = 0xFFFFFFFF){ @@ -18647,7 +25754,9 @@ public string getLookAtPoint(string shapebase, float distance = 2000, uint type return m_ts.fnShapeBase_getLookAtPoint(shapebase, distance, typeMask); } /// -/// Get the object's maxDamage level. @return datablock.maxDamage) +/// Get the object's maxDamage level. +/// @return datablock.maxDamage) +/// /// public float getMaxDamage(string shapebase){ @@ -18655,7 +25764,10 @@ public float getMaxDamage(string shapebase){ return m_ts.fnShapeBase_getMaxDamage(shapebase); } /// -/// @brief Get the model filename used by this shape. @return the shape filename ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename ) +/// /// public string getModelFile(string shapebase){ @@ -18663,7 +25775,12 @@ public string getModelFile(string shapebase){ return m_ts.fnShapeBase_getModelFile(shapebase); } /// -/// @brief Get the Image mounted in the specified slot. @param slot Image slot to query @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 if no Image is mounted there. ) +/// @brief Get the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 +/// if no Image is mounted there. ) +/// /// public int getMountedImage(string shapebase, int slot){ @@ -18671,7 +25788,13 @@ public int getMountedImage(string shapebase, int slot){ return m_ts.fnShapeBase_getMountedImage(shapebase, slot); } /// -/// @brief Get the first slot the given datablock is mounted to on this object. @param image ShapeBaseImageData datablock to query @return index of the first slot the Image is mounted in, or -1 if the Image is not mounted in any slot on this object. ) +/// @brief Get the first slot the given datablock is mounted to on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return index of the first slot the Image is mounted in, or -1 if the Image +/// is not mounted in any slot on this object. ) +/// +/// /// public int getMountSlot(string shapebase, string image){ @@ -18679,7 +25802,15 @@ public int getMountSlot(string shapebase, string image){ return m_ts.fnShapeBase_getMountSlot(shapebase, image); } /// -/// @brief Get the muzzle position of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle position is the position of that node in world space. If no such node is specified, the slot's mount node is used instead. @param slot Image slot to query @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// @brief Get the muzzle position of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// position is the position of that node in world space. If no such node +/// is specified, the slot's mount node is used instead. +/// +/// @param slot Image slot to query +/// @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// /// public Point3F getMuzzlePoint(string shapebase, int slot){ @@ -18687,7 +25818,20 @@ public Point3F getMuzzlePoint(string shapebase, int slot){ return new Point3F ( m_ts.fnShapeBase_getMuzzlePoint(shapebase, slot)); } /// -/// @brief Get the muzzle vector of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle vector is the forward direction vector of that node's transform in world space. If no such node is specified, the slot's mount node is used instead. If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) is set in the Image, the muzzle vector is computed to point at whatever object is right in front of the object's 'eye' node. @param slot Image slot to query @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// @brief Get the muzzle vector of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// vector is the forward direction vector of that node's transform in world +/// space. If no such node is specified, the slot's mount node is used +/// instead. +/// +/// If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) +/// is set in the Image, the muzzle vector is computed to point at whatever +/// object is right in front of the object's 'eye' node. +/// +/// @param slot Image slot to query +/// @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// /// public Point3F getMuzzleVector(string shapebase, int slot){ @@ -18695,7 +25839,20 @@ public Point3F getMuzzleVector(string shapebase, int slot){ return new Point3F ( m_ts.fnShapeBase_getMuzzleVector(shapebase, slot)); } /// -/// @brief Get the Image that will be mounted next in the specified slot. Calling mountImage when an Image is already mounted does one of two things: ol>li>Mount the new Image immediately, the old Image is discarded and whatever state it was in is ignored./li> li>If the current Image state does not allow Image changes, the new Image is marked as pending, and will not be mounted until the current state completes. eg. if the user changes weapons, you may wish to ensure that the current weapon firing state plays to completion first./li>/ol> This command retrieves the ID of the pending Image (2nd case above). @param slot Image slot to query @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// @brief Get the Image that will be mounted next in the specified slot. +/// +/// Calling mountImage when an Image is already mounted does one of two things: +/// ol>li>Mount the new Image immediately, the old Image is discarded and +/// whatever state it was in is ignored./li> +/// li>If the current Image state does not allow Image changes, the new +/// Image is marked as pending, and will not be mounted until the current +/// state completes. eg. if the user changes weapons, you may wish to ensure +/// that the current weapon firing state plays to completion first./li>/ol> +/// This command retrieves the ID of the pending Image (2nd case above). +/// +/// @param slot Image slot to query +/// @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// /// public int getPendingImage(string shapebase, int slot){ @@ -18703,7 +25860,12 @@ public int getPendingImage(string shapebase, int slot){ return m_ts.fnShapeBase_getPendingImage(shapebase, slot); } /// -/// @brief Get the current recharge rate. @return the recharge rate (per tick) @see setRechargeRate()) +/// @brief Get the current recharge rate. +/// +/// @return the recharge rate (per tick) +/// +/// @see setRechargeRate()) +/// /// public float getRechargeRate(string shapebase){ @@ -18711,7 +25873,12 @@ public float getRechargeRate(string shapebase){ return m_ts.fnShapeBase_getRechargeRate(shapebase); } /// -/// @brief Get the per-tick repair amount. @return the current value to be subtracted from damage level each tick @see setRepairRate ) +/// @brief Get the per-tick repair amount. +/// +/// @return the current value to be subtracted from damage level each tick +/// +/// @see setRepairRate ) +/// /// public float getRepairRate(string shapebase){ @@ -18719,7 +25886,15 @@ public float getRepairRate(string shapebase){ return m_ts.fnShapeBase_getRepairRate(shapebase); } /// -/// @brief Get the name of the shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @return the name of the shape @see setShapeName()) +/// @brief Get the name of the shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @return the name of the shape +/// +/// @see setShapeName()) +/// /// public string getShapeName(string shapebase){ @@ -18727,7 +25902,13 @@ public string getShapeName(string shapebase){ return m_ts.fnShapeBase_getShapeName(shapebase); } /// -/// @brief Get the name of the skin applied to this shape. @return the name of the skin @see skin @see setSkinName()) +/// @brief Get the name of the skin applied to this shape. +/// +/// @return the name of the skin +/// +/// @see skin +/// @see setSkinName()) +/// /// public string getSkinName(string shapebase){ @@ -18735,7 +25916,11 @@ public string getSkinName(string shapebase){ return m_ts.fnShapeBase_getSkinName(shapebase); } /// -/// @brief Get the world transform of the specified mount slot. @param slot Image slot to query @return the mount transform ) +/// @brief Get the world transform of the specified mount slot. +/// +/// @param slot Image slot to query +/// @return the mount transform ) +/// /// public TransformF getSlotTransform(string shapebase, int slot){ @@ -18743,7 +25928,12 @@ public TransformF getSlotTransform(string shapebase, int slot){ return new TransformF ( m_ts.fnShapeBase_getSlotTransform(shapebase, slot)); } /// -/// @brief Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// @brief Get the number of materials in the shape. +/// +/// @return the number of materials in the shape. +/// +/// @see getTargetName()) +/// /// public int getTargetCount(string shapebase){ @@ -18751,7 +25941,13 @@ public int getTargetCount(string shapebase){ return m_ts.fnShapeBase_getTargetCount(shapebase); } /// -/// @brief Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// @brief Get the name of the indexed shape material. +/// +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// +/// @see getTargetCount()) +/// /// public string getTargetName(string shapebase, int index){ @@ -18759,7 +25955,10 @@ public string getTargetName(string shapebase, int index){ return m_ts.fnShapeBase_getTargetName(shapebase, index); } /// -/// @brief Get the object's current velocity. @return the current velocity ) +/// @brief Get the object's current velocity. +/// +/// @return the current velocity ) +/// /// public Point3F getVelocity(string shapebase){ @@ -18767,7 +25966,12 @@ public Point3F getVelocity(string shapebase){ return new Point3F ( m_ts.fnShapeBase_getVelocity(shapebase)); } /// -/// @brief Get the white-out level. @return white-out level @see setWhiteOut ) +/// @brief Get the white-out level. +/// +/// @return white-out level +/// +/// @see setWhiteOut ) +/// /// public float getWhiteOut(string shapebase){ @@ -18775,7 +25979,12 @@ public float getWhiteOut(string shapebase){ return m_ts.fnShapeBase_getWhiteOut(shapebase); } /// -/// @brief Check if the given state exists on the mounted Image. @param slot Image slot to query @param state Image state to check for @return true if the Image has the requested state defined. ) +/// @brief Check if the given state exists on the mounted Image. +/// +/// @param slot Image slot to query +/// @param state Image state to check for +/// @return true if the Image has the requested state defined. ) +/// /// public bool hasImageState(string shapebase, int slot, string state){ @@ -18783,7 +25992,12 @@ public bool hasImageState(string shapebase, int slot, string state){ return m_ts.fnShapeBase_hasImageState(shapebase, slot, state); } /// -/// @brief Check if this object is cloaked. @return true if cloaked, false if not @see setCloaked()) +/// @brief Check if this object is cloaked. +/// +/// @return true if cloaked, false if not +/// +/// @see setCloaked()) +/// /// public bool isCloaked(string shapebase){ @@ -18791,7 +26005,13 @@ public bool isCloaked(string shapebase){ return m_ts.fnShapeBase_isCloaked(shapebase); } /// -/// @brief Check if the object is in the Destroyed damage state. @return true if damage state is \"Destroyed\", false if not @see isDisabled() @see isEnabled()) +/// @brief Check if the object is in the Destroyed damage state. +/// +/// @return true if damage state is \"Destroyed\", false if not +/// +/// @see isDisabled() +/// @see isEnabled()) +/// /// public bool isDestroyed(string shapebase){ @@ -18799,7 +26019,13 @@ public bool isDestroyed(string shapebase){ return m_ts.fnShapeBase_isDestroyed(shapebase); } /// -/// @brief Check if the object is in the Disabled or Destroyed damage state. @return true if damage state is not \"Enabled\", false if it is @see isDestroyed() @see isEnabled()) +/// @brief Check if the object is in the Disabled or Destroyed damage state. +/// +/// @return true if damage state is not \"Enabled\", false if it is +/// +/// @see isDestroyed() +/// @see isEnabled()) +/// /// public bool isDisabled(string shapebase){ @@ -18807,7 +26033,13 @@ public bool isDisabled(string shapebase){ return m_ts.fnShapeBase_isDisabled(shapebase); } /// -/// @brief Check if the object is in the Enabled damage state. @return true if damage state is \"Enabled\", false if not @see isDestroyed() @see isDisabled()) +/// @brief Check if the object is in the Enabled damage state. +/// +/// @return true if damage state is \"Enabled\", false if not +/// +/// @see isDestroyed() +/// @see isDisabled()) +/// /// public bool isEnabled(string shapebase){ @@ -18815,7 +26047,9 @@ public bool isEnabled(string shapebase){ return m_ts.fnShapeBase_isEnabled(shapebase); } /// -/// Check if the object is hidden. @return true if the object is hidden, false if visible. ) +/// Check if the object is hidden. +/// @return true if the object is hidden, false if visible. ) +/// /// public bool isHidden(string shapebase){ @@ -18823,7 +26057,11 @@ public bool isHidden(string shapebase){ return m_ts.fnShapeBase_isHidden(shapebase); } /// -/// @brief Check if the current Image state is firing. @param slot Image slot to query @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// @brief Check if the current Image state is firing. +/// +/// @param slot Image slot to query +/// @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// /// public bool isImageFiring(string shapebase, int slot){ @@ -18831,7 +26069,11 @@ public bool isImageFiring(string shapebase, int slot){ return m_ts.fnShapeBase_isImageFiring(shapebase, slot); } /// -/// @brief Check if the given datablock is mounted to any slot on this object. @param image ShapeBaseImageData datablock to query @return true if the Image is mounted to any slot, false otherwise. ) +/// @brief Check if the given datablock is mounted to any slot on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return true if the Image is mounted to any slot, false otherwise. ) +/// /// public bool isImageMounted(string shapebase, string image){ @@ -18839,7 +26081,26 @@ public bool isImageMounted(string shapebase, string image){ return m_ts.fnShapeBase_isImageMounted(shapebase, image); } /// -/// ), @brief Mount a new Image. @param image the Image to mount @param slot Image slot to mount into (valid range is 0 - 3) @param loaded initial loaded state for the Image @param skinTag tagged string to reskin the mounted Image @return true if successful, false if failed @tsexample %player.mountImage( PistolImage, 1 ); %player.mountImage( CrossbowImage, 0, false ); %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); @endtsexample @see unmountImage() @see getMountedImage() @see getPendingImage() @see isImageMounted()) +/// ), +/// @brief Mount a new Image. +/// +/// @param image the Image to mount +/// @param slot Image slot to mount into (valid range is 0 - 3) +/// @param loaded initial loaded state for the Image +/// @param skinTag tagged string to reskin the mounted Image +/// @return true if successful, false if failed +/// +/// @tsexample +/// %player.mountImage( PistolImage, 1 ); +/// %player.mountImage( CrossbowImage, 0, false ); +/// %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); +/// @endtsexample +/// +/// @see unmountImage() +/// @see getMountedImage() +/// @see getPendingImage() +/// @see isImageMounted()) +/// /// public bool mountImage(string shapebase, string image, int slot, bool loaded = true, string skinTag = ""){ @@ -18847,7 +26108,15 @@ public bool mountImage(string shapebase, string image, int slot, bool loaded = return m_ts.fnShapeBase_mountImage(shapebase, image, slot, loaded, skinTag); } /// -/// @brief Pause an animation thread. If restarted using playThread, the animation will resume from the paused position. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Pause an animation thread. +/// +/// If restarted using playThread, the animation +/// will resume from the paused position. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool pauseThread(string shapebase, int slot){ @@ -18855,7 +26124,13 @@ public bool pauseThread(string shapebase, int slot){ return m_ts.fnShapeBase_pauseThread(shapebase, slot); } /// -/// @brief Attach a sound to this shape and start playing it. @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play @return true if the sound was attached successfully, false if failed @see stopAudio()) +/// @brief Attach a sound to this shape and start playing it. +/// +/// @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play +/// @return true if the sound was attached successfully, false if failed +/// +/// @see stopAudio()) +/// /// public bool playAudio(string shapebase, int slot, string track){ @@ -18863,7 +26138,28 @@ public bool playAudio(string shapebase, int slot, string track){ return m_ts.fnShapeBase_playAudio(shapebase, slot, track); } /// -/// ), @brief Start a new animation thread, or restart one that has been paused or stopped. @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not specified, the paused or stopped thread in this slot will be resumed. @return true if successful, false if failed @tsexample %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed %obj.pauseThread( 0 ); // Pause the sequence %obj.playThread( 0 ); // Resume playback %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 @endtsexample @see pauseThread() @see stopThread() @see setThreadDir() @see setThreadTimeScale() @see destroyThread()) +/// ), +/// @brief Start a new animation thread, or restart one that has been paused or +/// stopped. +/// +/// @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not +/// specified, the paused or stopped thread in this slot will be resumed. +/// @return true if successful, false if failed +/// +/// @tsexample +/// %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 +/// %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed +/// %obj.pauseThread( 0 ); // Pause the sequence +/// %obj.playThread( 0 ); // Resume playback +/// %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 +/// @endtsexample +/// +/// @see pauseThread() +/// @see stopThread() +/// @see setThreadDir() +/// @see setThreadTimeScale() +/// @see destroyThread()) +/// /// public bool playThread(string shapebase, int slot, string name = ""){ @@ -18871,7 +26167,13 @@ public bool playThread(string shapebase, int slot, string name = ""){ return m_ts.fnShapeBase_playThread(shapebase, slot, name); } /// -/// @brief Set the hidden state on all the shape meshes. This allows you to hide all meshes in the shape, for example, and then only enable a few. @param hide new hidden state for all meshes ) +/// @brief Set the hidden state on all the shape meshes. +/// +/// This allows you to hide all meshes in the shape, for example, and then only +/// enable a few. +/// +/// @param hide new hidden state for all meshes ) +/// /// public void setAllMeshesHidden(string shapebase, bool hide){ @@ -18879,7 +26181,10 @@ public void setAllMeshesHidden(string shapebase, bool hide){ m_ts.fnShapeBase_setAllMeshesHidden(shapebase, hide); } /// -/// @brief Set the vertical field of view in degrees for this object if used as a camera. @param fov new FOV value ) +/// @brief Set the vertical field of view in degrees for this object if used as a camera. +/// +/// @param fov new FOV value ) +/// /// public void setCameraFov(string shapebase, float fov){ @@ -18887,7 +26192,14 @@ public void setCameraFov(string shapebase, float fov){ m_ts.fnShapeBase_setCameraFov(shapebase, fov); } /// -/// @brief Set the cloaked state of this object. When an object is cloaked it is not rendered. @param cloak true to cloak the object, false to uncloak @see isCloaked()) +/// @brief Set the cloaked state of this object. +/// +/// When an object is cloaked it is not rendered. +/// +/// @param cloak true to cloak the object, false to uncloak +/// +/// @see isCloaked()) +/// /// public void setCloaked(string shapebase, bool cloak){ @@ -18895,7 +26207,17 @@ public void setCloaked(string shapebase, bool cloak){ m_ts.fnShapeBase_setCloaked(shapebase, cloak); } /// -/// @brief Set the damage flash level. Damage flash may be used as a postfx effect to flash the screen when the client is damaged. @note Relies on the flash postFx. @param level flash level (0-1) @see getDamageFlash()) +/// @brief Set the damage flash level. +/// +/// Damage flash may be used as a postfx effect to flash the screen when the +/// client is damaged. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getDamageFlash()) +/// /// public void setDamageFlash(string shapebase, float level){ @@ -18903,7 +26225,13 @@ public void setDamageFlash(string shapebase, float level){ m_ts.fnShapeBase_setDamageFlash(shapebase, level); } /// -/// @brief Set the object's current damage level. @param level new damage level @see getDamageLevel() @see getDamagePercent()) +/// @brief Set the object's current damage level. +/// +/// @param level new damage level +/// +/// @see getDamageLevel() +/// @see getDamagePercent()) +/// /// public void setDamageLevel(string shapebase, float level){ @@ -18911,7 +26239,13 @@ public void setDamageLevel(string shapebase, float level){ m_ts.fnShapeBase_setDamageLevel(shapebase, level); } /// -/// @brief Set the object's damage state. @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" @return true if successful, false if failed @see getDamageState()) +/// @brief Set the object's damage state. +/// +/// @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// @return true if successful, false if failed +/// +/// @see getDamageState()) +/// /// public bool setDamageState(string shapebase, string state){ @@ -18919,7 +26253,17 @@ public bool setDamageState(string shapebase, string state){ return m_ts.fnShapeBase_setDamageState(shapebase, state); } /// -/// @brief Set the damage direction vector. Currently this is only used to initialise the explosion if this object is blown up. @param vec damage direction vector @tsexample %obj.setDamageVector( \"0 0 1\" ); @endtsexample ) +/// @brief Set the damage direction vector. +/// +/// Currently this is only used to initialise the explosion if this object +/// is blown up. +/// +/// @param vec damage direction vector +/// +/// @tsexample +/// %obj.setDamageVector( \"0 0 1\" ); +/// @endtsexample ) +/// /// public void setDamageVector(string shapebase, Point3F vec){ @@ -18927,7 +26271,13 @@ public void setDamageVector(string shapebase, Point3F vec){ m_ts.fnShapeBase_setDamageVector(shapebase, vec.AsString()); } /// -/// @brief Set this object's current energy level. @param level new energy level @see getEnergyLevel() @see getEnergyPercent()) +/// @brief Set this object's current energy level. +/// +/// @param level new energy level +/// +/// @see getEnergyLevel() +/// @see getEnergyPercent()) +/// /// public void setEnergyLevel(string shapebase, float level){ @@ -18935,7 +26285,10 @@ public void setEnergyLevel(string shapebase, float level){ m_ts.fnShapeBase_setEnergyLevel(shapebase, level); } /// -/// @brief Add or remove this object from the scene. When removed from the scene, the object will not be processed or rendered. @param show False to hide the object, true to re-show it ) +/// @brief Add or remove this object from the scene. +/// When removed from the scene, the object will not be processed or rendered. +/// @param show False to hide the object, true to re-show it ) +/// /// public void setHidden(string shapebase, bool show){ @@ -18943,7 +26296,12 @@ public void setHidden(string shapebase, bool show){ m_ts.fnShapeBase_setHidden(shapebase, show); } /// -/// @brief Set the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new alt trigger state for the Image @return the Image's new alt trigger state ) +/// @brief Set the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new alt trigger state for the Image +/// @return the Image's new alt trigger state ) +/// /// public bool setImageAltTrigger(string shapebase, int slot, bool state){ @@ -18951,7 +26309,12 @@ public bool setImageAltTrigger(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageAltTrigger(shapebase, slot, state); } /// -/// @brief Set the ammo state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new ammo state for the Image @return the Image's new ammo state ) +/// @brief Set the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new ammo state for the Image +/// @return the Image's new ammo state ) +/// /// public bool setImageAmmo(string shapebase, int slot, bool state){ @@ -18959,7 +26322,13 @@ public bool setImageAmmo(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageAmmo(shapebase, slot, state); } /// -/// @brief Set the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param trigger Generic trigger number @param state new generic trigger state for the Image @return the Image's new generic trigger state or -1 if there was a problem. ) +/// @brief Set the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param trigger Generic trigger number +/// @param state new generic trigger state for the Image +/// @return the Image's new generic trigger state or -1 if there was a problem. ) +/// /// public int setImageGenericTrigger(string shapebase, int slot, int trigger, bool state){ @@ -18967,7 +26336,12 @@ public int setImageGenericTrigger(string shapebase, int slot, int trigger, bool return m_ts.fnShapeBase_setImageGenericTrigger(shapebase, slot, trigger, state); } /// -/// @brief Set the loaded state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new loaded state for the Image @return the Image's new loaded state ) +/// @brief Set the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new loaded state for the Image +/// @return the Image's new loaded state ) +/// /// public bool setImageLoaded(string shapebase, int slot, bool state){ @@ -18975,7 +26349,13 @@ public bool setImageLoaded(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageLoaded(shapebase, slot, state); } /// -/// @brief Set the script animation prefix for the Image mounted in the specified slot. This is used to further modify the prefix used when deciding which animation sequence to play while this image is mounted. @param slot Image slot to modify @param prefix The prefix applied to the image ) +/// @brief Set the script animation prefix for the Image mounted in the specified slot. +/// This is used to further modify the prefix used when deciding which animation sequence to +/// play while this image is mounted. +/// +/// @param slot Image slot to modify +/// @param prefix The prefix applied to the image ) +/// /// public void setImageScriptAnimPrefix(string shapebase, int slot, string prefix){ @@ -18983,7 +26363,12 @@ public void setImageScriptAnimPrefix(string shapebase, int slot, string prefix) m_ts.fnShapeBase_setImageScriptAnimPrefix(shapebase, slot, prefix); } /// -/// @brief Set the target state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new target state for the Image @return the Image's new target state ) +/// @brief Set the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new target state for the Image +/// @return the Image's new target state ) +/// /// public bool setImageTarget(string shapebase, int slot, bool state){ @@ -18991,7 +26376,12 @@ public bool setImageTarget(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageTarget(shapebase, slot, state); } /// -/// @brief Set the trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new trigger state for the Image @return the Image's new trigger state ) +/// @brief Set the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new trigger state for the Image +/// @return the Image's new trigger state ) +/// /// public bool setImageTrigger(string shapebase, int slot, bool state){ @@ -18999,15 +26389,11 @@ public bool setImageTrigger(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageTrigger(shapebase, slot, state); } /// -/// @brief Setup the invincible effect. This effect is used for HUD feedback to the user that they are invincible. @note Currently not implemented @param time duration in seconds for the invincible effect @param speed speed at which the invincible effect progresses ) -/// -public void setInvincibleMode(string shapebase, float time, float speed){ - - -m_ts.fnShapeBase_setInvincibleMode(shapebase, time, speed); -} -/// -/// @brief Set the hidden state on the named shape mesh. @param name name of the mesh to hide/show @param hide new hidden state for the mesh ) +/// @brief Set the hidden state on the named shape mesh. +/// +/// @param name name of the mesh to hide/show +/// @param hide new hidden state for the mesh ) +/// /// public void setMeshHidden(string shapebase, string name, bool hide){ @@ -19015,7 +26401,15 @@ public void setMeshHidden(string shapebase, string name, bool hide){ m_ts.fnShapeBase_setMeshHidden(shapebase, name, hide); } /// -/// @brief Set the recharge rate. The recharge rate is added to the object's current energy level each tick, up to the maxEnergy level set in the ShapeBaseData datablock. @param rate the recharge rate (per tick) @see getRechargeRate()) +/// @brief Set the recharge rate. +/// +/// The recharge rate is added to the object's current energy level each tick, +/// up to the maxEnergy level set in the ShapeBaseData datablock. +/// +/// @param rate the recharge rate (per tick) +/// +/// @see getRechargeRate()) +/// /// public void setRechargeRate(string shapebase, float rate){ @@ -19023,7 +26417,17 @@ public void setRechargeRate(string shapebase, float rate){ m_ts.fnShapeBase_setRechargeRate(shapebase, rate); } /// -/// @brief Set amount to repair damage by each tick. Note that this value is separate to the repairRate field in ShapeBaseData. This value will be subtracted from the damage level each tick, whereas the ShapeBaseData field limits how much of the applyRepair value is subtracted each tick. Both repair types can be active at the same time. @param rate value to subtract from damage level each tick (must be > 0) @see getRepairRate()) +/// @brief Set amount to repair damage by each tick. +/// +/// Note that this value is separate to the repairRate field in ShapeBaseData. +/// This value will be subtracted from the damage level each tick, whereas the +/// ShapeBaseData field limits how much of the applyRepair value is subtracted +/// each tick. Both repair types can be active at the same time. +/// +/// @param rate value to subtract from damage level each tick (must be > 0) +/// +/// @see getRepairRate()) +/// /// public void setRepairRate(string shapebase, float rate){ @@ -19031,7 +26435,15 @@ public void setRepairRate(string shapebase, float rate){ m_ts.fnShapeBase_setRepairRate(shapebase, rate); } /// -/// @brief Set the name of this shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @param name new name for the shape @see getShapeName()) +/// @brief Set the name of this shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @param name new name for the shape +/// +/// @see getShapeName()) +/// /// public void setShapeName(string shapebase, string name){ @@ -19039,7 +26451,16 @@ public void setShapeName(string shapebase, string name){ m_ts.fnShapeBase_setShapeName(shapebase, name); } /// -/// @brief Apply a new skin to this shape. 'Skinning' the shape effectively renames the material targets, allowing different materials to be used on different instances of the same model. @param name name of the skin to apply @see skin @see getSkinName()) +/// @brief Apply a new skin to this shape. +/// +/// 'Skinning' the shape effectively renames the material targets, allowing +/// different materials to be used on different instances of the same model. +/// +/// @param name name of the skin to apply +/// +/// @see skin +/// @see getSkinName()) +/// /// public void setSkinName(string shapebase, string name){ @@ -19047,7 +26468,14 @@ public void setSkinName(string shapebase, string name){ m_ts.fnShapeBase_setSkinName(shapebase, name); } /// -/// @brief Set the playback direction of an animation thread. @param slot thread slot to modify @param fwd true to play the animation forwards, false to play backwards @return true if successful, false if failed @see playThread() ) +/// @brief Set the playback direction of an animation thread. +/// +/// @param slot thread slot to modify +/// @param fwd true to play the animation forwards, false to play backwards +/// @return true if successful, false if failed +/// +/// @see playThread() ) +/// /// public bool setThreadDir(string shapebase, int slot, bool fwd){ @@ -19055,7 +26483,14 @@ public bool setThreadDir(string shapebase, int slot, bool fwd){ return m_ts.fnShapeBase_setThreadDir(shapebase, slot, fwd); } /// -/// @brief Set the position within an animation thread. @param slot thread slot to modify @param pos position within thread @return true if successful, false if failed @see playThread ) +/// @brief Set the position within an animation thread. +/// +/// @param slot thread slot to modify +/// @param pos position within thread +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool setThreadPosition(string shapebase, int slot, float pos){ @@ -19063,7 +26498,14 @@ public bool setThreadPosition(string shapebase, int slot, float pos){ return m_ts.fnShapeBase_setThreadPosition(shapebase, slot, pos); } /// -/// @brief Set the playback time scale of an animation thread. @param slot thread slot to modify @param scale new thread time scale (1=normal speed, 0.5=half speed etc) @return true if successful, false if failed @see playThread ) +/// @brief Set the playback time scale of an animation thread. +/// +/// @param slot thread slot to modify +/// @param scale new thread time scale (1=normal speed, 0.5=half speed etc) +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool setThreadTimeScale(string shapebase, int slot, float scale){ @@ -19071,7 +26513,11 @@ public bool setThreadTimeScale(string shapebase, int slot, float scale){ return m_ts.fnShapeBase_setThreadTimeScale(shapebase, slot, scale); } /// -/// @brief Set the object's velocity. @param vel new velocity for the object @return true ) +/// @brief Set the object's velocity. +/// +/// @param vel new velocity for the object +/// @return true ) +/// /// public bool setVelocity(string shapebase, Point3F vel){ @@ -19079,7 +26525,17 @@ public bool setVelocity(string shapebase, Point3F vel){ return m_ts.fnShapeBase_setVelocity(shapebase, vel.AsString()); } /// -/// @brief Set the white-out level. White-out may be used as a postfx effect to brighten the screen in response to a game event. @note Relies on the flash postFx. @param level flash level (0-1) @see getWhiteOut()) +/// @brief Set the white-out level. +/// +/// White-out may be used as a postfx effect to brighten the screen in response +/// to a game event. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getWhiteOut()) +/// /// public void setWhiteOut(string shapebase, float level){ @@ -19087,7 +26543,21 @@ public void setWhiteOut(string shapebase, float level){ m_ts.fnShapeBase_setWhiteOut(shapebase, level); } /// -/// @brief Fade the object in or out without removing it from the scene. A faded out object is still in the scene and can still be collided with, so if you want to disable collisions for this shape after it fades out use setHidden to temporarily remove this shape from the scene. @note Items have the ability to light their surroundings. When an Item with an active light is fading out, the light it emits is correspondingly reduced until it goes out. Likewise, when the item fades in, the light is turned-up till it reaches it's normal brightntess. @param time duration of the fade effect in ms @param delay delay in ms before the fade effect begins @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// @brief Fade the object in or out without removing it from the scene. +/// +/// A faded out object is still in the scene and can still be collided with, +/// so if you want to disable collisions for this shape after it fades out +/// use setHidden to temporarily remove this shape from the scene. +/// +/// @note Items have the ability to light their surroundings. When an Item with +/// an active light is fading out, the light it emits is correspondingly +/// reduced until it goes out. Likewise, when the item fades in, the light is +/// turned-up till it reaches it's normal brightntess. +/// +/// @param time duration of the fade effect in ms +/// @param delay delay in ms before the fade effect begins +/// @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// /// public void startFade(string shapebase, int time, int delay, bool fadeOut){ @@ -19095,7 +26565,13 @@ public void startFade(string shapebase, int time, int delay, bool fadeOut){ m_ts.fnShapeBase_startFade(shapebase, time, delay, fadeOut); } /// -/// @brief Stop a sound started with playAudio. @param slot audio slot index (started with playAudio) @return true if the sound was stopped successfully, false if failed @see playAudio()) +/// @brief Stop a sound started with playAudio. +/// +/// @param slot audio slot index (started with playAudio) +/// @return true if the sound was stopped successfully, false if failed +/// +/// @see playAudio()) +/// /// public bool stopAudio(string shapebase, int slot){ @@ -19103,7 +26579,15 @@ public bool stopAudio(string shapebase, int slot){ return m_ts.fnShapeBase_stopAudio(shapebase, slot); } /// -/// @brief Stop an animation thread. If restarted using playThread, the animation will start from the beginning again. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Stop an animation thread. +/// +/// If restarted using playThread, the animation +/// will start from the beginning again. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool stopThread(string shapebase, int slot){ @@ -19111,7 +26595,13 @@ public bool stopThread(string shapebase, int slot){ return m_ts.fnShapeBase_stopThread(shapebase, slot); } /// -/// @brief Unmount the mounted Image in the specified slot. @param slot Image slot to unmount @return true if successful, false if failed @see mountImage()) +/// @brief Unmount the mounted Image in the specified slot. +/// +/// @param slot Image slot to unmount +/// @return true if successful, false if failed +/// +/// @see mountImage()) +/// /// public bool unmountImage(string shapebase, int slot){ @@ -19124,14 +26614,18 @@ public bool unmountImage(string shapebase, int slot){ /// public class ShapeBaseDataObject { -private Omni m_ts; - /// - /// - /// - /// -public ShapeBaseDataObject(ref Omni ts){m_ts = ts;} /// -/// @brief Check if there is the space at the given transform is free to spawn into. The shape's bounding box volume is used to check for collisions at the given world transform. Only interior and static objects are checked for collision. @param txfm Deploy transform to check @return True if the space is free, false if there is already something in the way. @note This is a server side only check, and is not actually limited to spawning.) +/// @brief Check if there is the space at the given transform is free to spawn into. +/// +/// The shape's bounding box volume is used to check for collisions at the given world +/// transform. Only interior and static objects are checked for collision. +/// +/// @param txfm Deploy transform to check +/// @return True if the space is free, false if there is already something in +/// the way. +/// +/// @note This is a server side only check, and is not actually limited to spawning.) +/// /// public bool checkDeployPos(string shapebasedata, TransformF txfm){ @@ -19139,7 +26633,11 @@ public bool checkDeployPos(string shapebasedata, TransformF txfm){ return m_ts.fnShapeBaseData_checkDeployPos(shapebasedata, txfm.AsString()); } /// -/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). @param pos Desired transform position @param normal Vector of desired direction @return The deploy transform ) +/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). +/// @param pos Desired transform position +/// @param normal Vector of desired direction +/// @return The deploy transform ) +/// /// public TransformF getDeployTransform(string shapebasedata, Point3F pos, Point3F normal){ @@ -19152,14 +26650,11 @@ public TransformF getDeployTransform(string shapebasedata, Point3F pos, Point3F /// public class SimComponentObject { -private Omni m_ts; - /// - /// - /// - /// -public SimComponentObject(ref Omni ts){m_ts = ts;} /// -/// (idx) Get the component corresponding to the given index. @param idx An integer index value corresponding to the desired component. @return The id of the component at the given index as an integer) +/// (idx) Get the component corresponding to the given index. +/// @param idx An integer index value corresponding to the desired component. +/// @return The id of the component at the given index as an integer) +/// /// public int SimComponent_getComponent(string simcomponent, int idx){ @@ -19167,7 +26662,9 @@ public int SimComponent_getComponent(string simcomponent, int idx){ return m_ts.fn_SimComponent_getComponent(simcomponent, idx); } /// -/// () Get the current component count @return The number of components in the list as an integer) +/// () Get the current component count +/// @return The number of components in the list as an integer) +/// /// public int SimComponent_getComponentCount(string simcomponent){ @@ -19175,7 +26672,9 @@ public int SimComponent_getComponentCount(string simcomponent){ return m_ts.fn_SimComponent_getComponentCount(simcomponent); } /// -/// () Check whether SimComponent is currently a template @return true if is a template and false if not) +/// () Check whether SimComponent is currently a template +/// @return true if is a template and false if not) +/// /// public bool SimComponent_getIsTemplate(string simcomponent){ @@ -19183,7 +26682,9 @@ public bool SimComponent_getIsTemplate(string simcomponent){ return m_ts.fn_SimComponent_getIsTemplate(simcomponent); } /// -/// () Check whether SimComponent is currently enabled @return true if enabled and false if not) +/// () Check whether SimComponent is currently enabled +/// @return true if enabled and false if not) +/// /// public bool SimComponent_isEnabled(string simcomponent){ @@ -19191,7 +26692,10 @@ public bool SimComponent_isEnabled(string simcomponent){ return m_ts.fn_SimComponent_isEnabled(simcomponent); } /// -/// (enabled) Sets or unsets the enabled flag @param enabled Boolean value @return No return value) +/// (enabled) Sets or unsets the enabled flag +/// @param enabled Boolean value +/// @return No return value) +/// /// public void SimComponent_setEnabled(string simcomponent, bool enabled){ @@ -19199,7 +26703,10 @@ public void SimComponent_setEnabled(string simcomponent, bool enabled){ m_ts.fn_SimComponent_setEnabled(simcomponent, enabled); } /// -/// (template) Sets or unsets the template flag @param template Boolean value @return No return value) +/// (template) Sets or unsets the template flag +/// @param template Boolean value +/// @return No return value) +/// /// public void SimComponent_setIsTemplate(string simcomponent, bool templateFlag){ @@ -19207,7 +26714,11 @@ public void SimComponent_setIsTemplate(string simcomponent, bool templateFlag){ m_ts.fn_SimComponent_setIsTemplate(simcomponent, templateFlag); } /// -/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); Adds additional components to current list. @param Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); +/// Adds additional components to current list. +/// @param Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool addComponents(string simcomponent, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= "", string a21= "", string a22= "", string a23= "", string a24= "", string a25= "", string a26= "", string a27= "", string a28= "", string a29= "", string a30= "", string a31= "", string a32= "", string a33= "", string a34= "", string a35= "", string a36= "", string a37= "", string a38= "", string a39= "", string a40= "", string a41= "", string a42= "", string a43= "", string a44= "", string a45= "", string a46= "", string a47= "", string a48= "", string a49= "", string a50= "", string a51= "", string a52= "", string a53= "", string a54= "", string a55= "", string a56= "", string a57= "", string a58= "", string a59= "", string a60= "", string a61= "", string a62= "", string a63= ""){ @@ -19215,7 +26726,11 @@ public bool addComponents(string simcomponent, string a2= "", string a3= "", st return m_ts.fnSimComponent_addComponents(simcomponent, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41, a42, a43, a44, a45, a46, a47, a48, a49, a50, a51, a52, a53, a54, a55, a56, a57, a58, a59, a60, a61, a62, a63); } /// -/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); Removes components by name from current list. @param objNamex Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); +/// Removes components by name from current list. +/// @param objNamex Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool removeComponents(string simcomponent, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= "", string a21= "", string a22= "", string a23= "", string a24= "", string a25= "", string a26= "", string a27= "", string a28= "", string a29= "", string a30= "", string a31= "", string a32= "", string a33= "", string a34= "", string a35= "", string a36= "", string a37= "", string a38= "", string a39= "", string a40= "", string a41= "", string a42= "", string a43= "", string a44= "", string a45= "", string a46= "", string a47= "", string a48= "", string a49= "", string a50= "", string a51= "", string a52= "", string a53= "", string a54= "", string a55= "", string a56= "", string a57= "", string a58= "", string a59= "", string a60= "", string a61= "", string a62= "", string a63= ""){ @@ -19228,14 +26743,9 @@ public bool removeComponents(string simcomponent, string a2= "", string a3= "", /// public class SimDataBlockObject { -private Omni m_ts; - /// - /// - /// - /// -public SimDataBlockObject(ref Omni ts){m_ts = ts;} /// /// Reload the datablock. This can only be used with a local client configuration. ) +/// /// public void SimDataBlock_reloadOnLocalClient(string simdatablock){ @@ -19248,12 +26758,6 @@ public void SimDataBlock_reloadOnLocalClient(string simdatablock){ /// public class SimObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public SimObjectObject(ref Omni ts){m_ts = ts;} /// /// Copy fields from another object onto this one. The objects must /// be of same type. Everything from the object will overwrite what's @@ -19871,14 +27375,9 @@ public void signal(string simobject, string a2= "", string a3= ""){ /// public class SimPersistSetObject { -private Omni m_ts; - /// - /// - /// - /// -public SimPersistSetObject(ref Omni ts){m_ts = ts;} /// /// () - Try to bind unresolved persistent IDs in the set. ) +/// /// public void SimPersistSet_resolvePersistentIds(string simpersistset){ @@ -19891,14 +27390,33 @@ public void SimPersistSet_resolvePersistentIds(string simpersistset){ /// public class SimpleNetObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public SimpleNetObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Sets the internal message variable. SimpleNetObject is set up to automatically transmit this new message to all connected clients. It will appear in the clients' console. @param msg The new message to send @tsexample // On the server, create a new SimpleNetObject. This is a ghost always // object so it will be immediately ghosted to all connected clients. $s = new SimpleNetObject(); // All connected clients will see the following in their console: // // Got message: Hello World! // Now again on the server, change the message. This will cause it to // be sent to all connected clients. $s.setMessage(\"A new message from me!\"); // All connected clients will now see in their console: // // Go message: A new message from me! @endtsexample ) +/// @brief Sets the internal message variable. +/// +/// SimpleNetObject is set up to automatically transmit this new message to +/// all connected clients. It will appear in the clients' console. +/// +/// @param msg The new message to send +/// +/// @tsexample +/// // On the server, create a new SimpleNetObject. This is a ghost always +/// // object so it will be immediately ghosted to all connected clients. +/// $s = new SimpleNetObject(); +/// +/// // All connected clients will see the following in their console: +/// // +/// // Got message: Hello World! +/// +/// // Now again on the server, change the message. This will cause it to +/// // be sent to all connected clients. +/// $s.setMessage(\"A new message from me!\"); +/// +/// // All connected clients will now see in their console: +/// // +/// // Go message: A new message from me! +/// @endtsexample +/// ) +/// /// public void setMessage(string simplenetobject, string msg){ @@ -19911,14 +27429,9 @@ public void setMessage(string simplenetobject, string msg){ /// public class SimResponseCurveObject { -private Omni m_ts; - /// - /// - /// - /// -public SimResponseCurveObject(ref Omni ts){m_ts = ts;} /// /// addPoint( F32 value, F32 time ) ) +/// /// public void SimResponseCurve_addPoint(string simresponsecurve, float value, float time){ @@ -19927,6 +27440,7 @@ public void SimResponseCurve_addPoint(string simresponsecurve, float value, flo } /// /// clear() ) +/// /// public void SimResponseCurve_clear(string simresponsecurve){ @@ -19935,6 +27449,7 @@ public void SimResponseCurve_clear(string simresponsecurve){ } /// /// getValue( F32 time ) ) +/// /// public float SimResponseCurve_getValue(string simresponsecurve, float time){ @@ -19947,14 +27462,9 @@ public float SimResponseCurve_getValue(string simresponsecurve, float time){ /// public class SimSetObject { -private Omni m_ts; - /// - /// - /// - /// -public SimSetObject(ref Omni ts){m_ts = ts;} /// /// () Delete all objects in the set. ) +/// /// public void SimSet_deleteAllObjects(string simset){ @@ -19962,7 +27472,9 @@ public void SimSet_deleteAllObjects(string simset){ m_ts.fn_SimSet_deleteAllObjects(simset); } /// -/// () Get the number of direct and indirect child objects contained in the set. @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// () Get the number of direct and indirect child objects contained in the set. +/// @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// /// public int SimSet_getFullCount(string simset){ @@ -19970,7 +27482,9 @@ public int SimSet_getFullCount(string simset){ return m_ts.fn_SimSet_getFullCount(simset); } /// -/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. +/// @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// /// public void SimSet_sort(string simset, string callbackFunction){ @@ -19978,7 +27492,10 @@ public void SimSet_sort(string simset, string callbackFunction){ m_ts.fn_SimSet_sort(simset, callbackFunction); } /// -/// Test whether the given object may be added to the set. @param obj The object to test for potential membership. @return True if the object may be added to the set, false otherwise. ) +/// Test whether the given object may be added to the set. +/// @param obj The object to test for potential membership. +/// @return True if the object may be added to the set, false otherwise. ) +/// /// public bool acceptsAsChild(string simset, string obj){ @@ -19986,7 +27503,10 @@ public bool acceptsAsChild(string simset, string obj){ return m_ts.fnSimSet_acceptsAsChild(simset, obj); } /// -/// ( SimSet, add, void, 3, 0, ( SimObject objects... ) Add the given objects to the set. @param objects The objects to add to the set. ) +/// ( SimSet, add, void, 3, 0, +/// ( SimObject objects... ) Add the given objects to the set. +/// @param objects The objects to add to the set. ) +/// /// public void add(string simset, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -19994,7 +27514,9 @@ public void add(string simset, string a2= "", string a3= "", string a4= "", str m_ts.fnSimSet_add(simset, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// Make the given object the first object in the set. @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// Make the given object the first object in the set. +/// @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// /// public void bringToFront(string simset, string obj){ @@ -20002,7 +27524,13 @@ public void bringToFront(string simset, string obj){ m_ts.fnSimSet_bringToFront(simset, obj); } /// -/// ( SimSet, callOnChildren, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method recurses into all SimSets that are children to the set. @see callOnChildrenNoRecurse ) +/// ( SimSet, callOnChildren, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method recurses into all SimSets that are children to the set. +/// @see callOnChildrenNoRecurse ) +/// /// public void callOnChildren(string simset, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -20010,7 +27538,13 @@ public void callOnChildren(string simset, string a2= "", string a3= "", string m_ts.fnSimSet_callOnChildren(simset, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method does not recurse into child SimSets. @see callOnChildren ) +/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method does not recurse into child SimSets. +/// @see callOnChildren ) +/// /// public void callOnChildrenNoRecurse(string simset, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -20019,6 +27553,7 @@ public void callOnChildrenNoRecurse(string simset, string a2= "", string a3= "" } /// /// Remove all objects from the set. ) +/// /// public void clear(string simset){ @@ -20026,7 +27561,11 @@ public void clear(string simset){ m_ts.fnSimSet_clear(simset); } /// -/// Find an object in the set by its internal name. @param internalName The internal name of the object to look for. @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. @return The object with the given internal name or 0 if no match was found. ) +/// Find an object in the set by its internal name. +/// @param internalName The internal name of the object to look for. +/// @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. +/// @return The object with the given internal name or 0 if no match was found. ) +/// /// public string findObjectByInternalName(string simset, string internalName, bool searchChildren = false){ @@ -20034,7 +27573,9 @@ public string findObjectByInternalName(string simset, string internalName, bool return m_ts.fnSimSet_findObjectByInternalName(simset, internalName, searchChildren); } /// -/// Get the number of objects contained in the set. @return The number of objects contained in the set. ) +/// Get the number of objects contained in the set. +/// @return The number of objects contained in the set. ) +/// /// public int getCount(string simset){ @@ -20042,7 +27583,10 @@ public int getCount(string simset){ return m_ts.fnSimSet_getCount(simset); } /// -/// Get the object at the given index. @param index The object index. @return The object at the given index or -1 if index is out of range. ) +/// Get the object at the given index. +/// @param index The object index. +/// @return The object at the given index or -1 if index is out of range. ) +/// /// public string getObject(string simset, uint index){ @@ -20050,7 +27594,10 @@ public string getObject(string simset, uint index){ return m_ts.fnSimSet_getObject(simset, index); } /// -/// Return the index of the given object in this set. @param obj The object for which to return the index. Must be contained in the set. @return The index of the object or -1 if the object is not contained in the set. ) +/// Return the index of the given object in this set. +/// @param obj The object for which to return the index. Must be contained in the set. +/// @return The index of the object or -1 if the object is not contained in the set. ) +/// /// public int getObjectIndex(string simset, string obj){ @@ -20058,7 +27605,9 @@ public int getObjectIndex(string simset, string obj){ return m_ts.fnSimSet_getObjectIndex(simset, obj); } /// -/// Return a random object from the set. @return A randomly selected object from the set or -1 if the set is empty. ) +/// Return a random object from the set. +/// @return A randomly selected object from the set or -1 if the set is empty. ) +/// /// public string getRandom(string simset){ @@ -20066,7 +27615,10 @@ public string getRandom(string simset){ return m_ts.fnSimSet_getRandom(simset); } /// -/// Test whether the given object belongs to the set. @param obj The object. @return True if the object is contained in the set; false otherwise. ) +/// Test whether the given object belongs to the set. +/// @param obj The object. +/// @return True if the object is contained in the set; false otherwise. ) +/// /// public bool isMember(string simset, string obj){ @@ -20075,6 +27627,7 @@ public bool isMember(string simset, string obj){ } /// /// Dump a list of all objects contained in the set to the console. ) +/// /// public void listObjects(string simset){ @@ -20082,7 +27635,9 @@ public void listObjects(string simset){ m_ts.fnSimSet_listObjects(simset); } /// -/// Make the given object the last object in the set. @param obj The object to bring to the last position. Must be contained in the set. ) +/// Make the given object the last object in the set. +/// @param obj The object to bring to the last position. Must be contained in the set. ) +/// /// public void pushToBack(string simset, string obj){ @@ -20090,7 +27645,10 @@ public void pushToBack(string simset, string obj){ m_ts.fnSimSet_pushToBack(simset, obj); } /// -/// ( SimSet, remove, void, 3, 0, ( SimObject objects... ) Remove the given objects from the set. @param objects The objects to remove from the set. ) +/// ( SimSet, remove, void, 3, 0, +/// ( SimObject objects... ) Remove the given objects from the set. +/// @param objects The objects to remove from the set. ) +/// /// public void remove(string simset, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -20098,7 +27656,10 @@ public void remove(string simset, string a2= "", string a3= "", string a4= "", m_ts.fnSimSet_remove(simset, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// Make sure child1 is ordered right before child2 in the set. @param child1 The first child. The object must already be contained in the set. @param child2 The second child. The object must already be contained in the set. ) +/// Make sure child1 is ordered right before child2 in the set. +/// @param child1 The first child. The object must already be contained in the set. +/// @param child2 The second child. The object must already be contained in the set. ) +/// /// public void reorderChild(string simset, string child1, string child2){ @@ -20111,14 +27672,13 @@ public void reorderChild(string simset, string child1, string child2){ /// public class SimXMLDocumentObject { -private Omni m_ts; - /// - /// - /// - /// -public SimXMLDocumentObject(ref Omni ts){m_ts = ts;} /// -/// (string attributeName) @brief Get float attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of a float. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get float attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of a float. +/// @deprecated Use attribute().) +/// /// public float SimXMLDocument_attributeF32(string simxmldocument, string attributeName){ @@ -20126,7 +27686,12 @@ public float SimXMLDocument_attributeF32(string simxmldocument, string attribut return m_ts.fn_SimXMLDocument_attributeF32(simxmldocument, attributeName); } /// -/// (string attributeName) @brief Get int attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of an integer. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get int attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of an integer. +/// @deprecated Use attribute().) +/// /// public int SimXMLDocument_attributeS32(string simxmldocument, string attributeName){ @@ -20134,7 +27699,24 @@ public int SimXMLDocument_attributeS32(string simxmldocument, string attributeN return m_ts.fn_SimXMLDocument_attributeS32(simxmldocument, attributeName); } /// -/// @brief Add the given comment as a child of the document. @param comment String containing the comment. @tsexample // Create a new XML document with a header, a comment and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addComment(\"This is a test comment\"); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // !--This is a test comment--> // NewElement /> @endtsexample @see readComment()) +/// @brief Add the given comment as a child of the document. +/// @param comment String containing the comment. +/// +/// @tsexample +/// // Create a new XML document with a header, a comment and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addComment(\"This is a test comment\"); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // !--This is a test comment--> +/// // NewElement /> +/// @endtsexample +/// +/// @see readComment()) +/// /// public void addComment(string simxmldocument, string comment){ @@ -20142,7 +27724,34 @@ public void addComment(string simxmldocument, string comment){ m_ts.fnSimXMLDocument_addComment(simxmldocument, comment); } /// -/// @brief Add the given text as a child of current Element. Use getData() to retrieve any text from the current Element. addData() and addText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added data. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addData(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getData() @see addText() @see getText() @see removeText()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getData() to retrieve any text from the current Element. +/// +/// addData() and addText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added data. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addData(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public void addData(string simxmldocument, string text){ @@ -20150,7 +27759,24 @@ public void addData(string simxmldocument, string text){ m_ts.fnSimXMLDocument_addData(simxmldocument, text); } /// -/// @brief Add a XML header to a document. Sometimes called a declaration, you typically add a standard header to the document before adding any elements. SimXMLDocument always produces the following header: ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> @tsexample // Create a new XML document with just a header and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement /> @endtsexample) +/// @brief Add a XML header to a document. +/// +/// Sometimes called a declaration, you typically add a standard header to +/// the document before adding any elements. SimXMLDocument always produces +/// the following header: +/// ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// +/// @tsexample +/// // Create a new XML document with just a header and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement /> +/// @endtsexample) +/// /// public void addHeader(string simxmldocument){ @@ -20158,7 +27784,17 @@ public void addHeader(string simxmldocument){ m_ts.fnSimXMLDocument_addHeader(simxmldocument); } /// -/// @brief Create a new element with the given name as child of current Element's parent and push it onto the Element stack making it the current one. @note This differs from pushNewElement() in that it adds the new Element to the current Element's parent (or document if there is no parent Element). This makes the new Element a sibling of the current one. @param name XML tag for the new Element. @see pushNewElement()) +/// @brief Create a new element with the given name as child of current Element's +/// parent and push it onto the Element stack making it the current one. +/// +/// @note This differs from pushNewElement() in that it adds the new Element to the +/// current Element's parent (or document if there is no parent Element). This makes +/// the new Element a sibling of the current one. +/// +/// @param name XML tag for the new Element. +/// +/// @see pushNewElement()) +/// /// public void addNewElement(string simxmldocument, string name){ @@ -20166,7 +27802,33 @@ public void addNewElement(string simxmldocument, string name){ m_ts.fnSimXMLDocument_addNewElement(simxmldocument, name); } /// -/// @brief Add the given text as a child of current Element. Use getText() to retrieve any text from the current Element and removeText() to clear any text. addText() and addData() may be used interchangeably. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added text. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addText(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getText() @see removeText() @see addData() @see getData()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getText() to retrieve any text from the current Element and removeText() +/// to clear any text. +/// +/// addText() and addData() may be used interchangeably. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added text. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addText(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public void addText(string simxmldocument, string text){ @@ -20174,7 +27836,10 @@ public void addText(string simxmldocument, string text){ m_ts.fnSimXMLDocument_addText(simxmldocument, text); } /// -/// @brief Get a string attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The attribute string if found. Otherwise returns an empty string.) +/// @brief Get a string attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The attribute string if found. Otherwise returns an empty string.) +/// /// public string attribute(string simxmldocument, string attributeName){ @@ -20182,7 +27847,10 @@ public string attribute(string simxmldocument, string attributeName){ return m_ts.fnSimXMLDocument_attribute(simxmldocument, attributeName); } /// -/// @brief Tests if the requested attribute exists. @param attributeName Name of attribute being queried for. @return True if the attribute exists.) +/// @brief Tests if the requested attribute exists. +/// @param attributeName Name of attribute being queried for. +/// @return True if the attribute exists.) +/// /// public bool attributeExists(string simxmldocument, string attributeName){ @@ -20190,7 +27858,12 @@ public bool attributeExists(string simxmldocument, string attributeName){ return m_ts.fnSimXMLDocument_attributeExists(simxmldocument, attributeName); } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using reset() @see reset()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using reset() +/// +/// @see reset()) +/// /// public void clear(string simxmldocument){ @@ -20199,6 +27872,7 @@ public void clear(string simxmldocument){ } /// /// @brief Clear the last error description.) +/// /// public void clearError(string simxmldocument){ @@ -20206,7 +27880,10 @@ public void clearError(string simxmldocument){ m_ts.fnSimXMLDocument_clearError(simxmldocument); } /// -/// @brief Get the Element's value if it exists. Usually returns the text from the Element. @return The value from the Element, or an empty string if none is found.) +/// @brief Get the Element's value if it exists. +/// Usually returns the text from the Element. +/// @return The value from the Element, or an empty string if none is found.) +/// /// public string elementValue(string simxmldocument){ @@ -20214,7 +27891,12 @@ public string elementValue(string simxmldocument){ return m_ts.fnSimXMLDocument_elementValue(simxmldocument); } /// -/// @brief Obtain the name of the current Element's first attribute. @return String containing the first attribute's name, or an empty string if none is found. @see nextAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Obtain the name of the current Element's first attribute. +/// @return String containing the first attribute's name, or an empty string if none is found. +/// @see nextAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string firstAttribute(string simxmldocument){ @@ -20222,7 +27904,39 @@ public string firstAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_firstAttribute(simxmldocument); } /// -/// @brief Gets the text from the current Element. Use addData() to add text to the current Element. getData() and getText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some data/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's data ('Some data' in this example) // into 'result' %result = %x.getData(); echo( %result ); @endtsexample @see addData() @see addText() @see getText() @see removeText()) +/// @brief Gets the text from the current Element. +/// +/// Use addData() to add text to the current Element. +/// +/// getData() and getText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some data/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's data ('Some data' in this example) +/// // into 'result' +/// %result = %x.getData(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public string getData(string simxmldocument){ @@ -20230,7 +27944,9 @@ public string getData(string simxmldocument){ return m_ts.fnSimXMLDocument_getData(simxmldocument); } /// -/// @brief Get last error description. @return A string of the last error message.) +/// @brief Get last error description. +/// @return A string of the last error message.) +/// /// public string getErrorDesc(string simxmldocument){ @@ -20238,7 +27954,38 @@ public string getErrorDesc(string simxmldocument){ return m_ts.fnSimXMLDocument_getErrorDesc(simxmldocument); } /// -/// @brief Gets the text from the current Element. Use addText() to add text to the current Element and removeText() to clear any text. getText() and getData() may be used interchangeably. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample @see addText() @see removeText() @see addData() @see getData()) +/// @brief Gets the text from the current Element. +/// +/// Use addText() to add text to the current Element and removeText() +/// to clear any text. +/// +/// getText() and getData() may be used interchangeably. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public string getText(string simxmldocument){ @@ -20246,7 +27993,12 @@ public string getText(string simxmldocument){ return m_ts.fnSimXMLDocument_getText(simxmldocument); } /// -/// @brief Obtain the name of the current Element's last attribute. @return String containing the last attribute's name, or an empty string if none is found. @see prevAttribute() @see firstAttribute() @see lastAttribute()) +/// @brief Obtain the name of the current Element's last attribute. +/// @return String containing the last attribute's name, or an empty string if none is found. +/// @see prevAttribute() +/// @see firstAttribute() +/// @see lastAttribute()) +/// /// public string lastAttribute(string simxmldocument){ @@ -20254,7 +28006,11 @@ public string lastAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_lastAttribute(simxmldocument); } /// -/// @brief Load in given filename and prepare it for use. @note Clears the current document's contents. @param fileName Name and path of XML document @return True if the file was loaded successfully.) +/// @brief Load in given filename and prepare it for use. +/// @note Clears the current document's contents. +/// @param fileName Name and path of XML document +/// @return True if the file was loaded successfully.) +/// /// public bool loadFile(string simxmldocument, string fileName){ @@ -20262,7 +28018,12 @@ public bool loadFile(string simxmldocument, string fileName){ return m_ts.fnSimXMLDocument_loadFile(simxmldocument, fileName); } /// -/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). @return String containing the next attribute's name, or an empty string if none is found. @see firstAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). +/// @return String containing the next attribute's name, or an empty string if none is found. +/// @see firstAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string nextAttribute(string simxmldocument){ @@ -20270,7 +28031,10 @@ public string nextAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_nextAttribute(simxmldocument); } /// -/// @brief Put the next sibling Element with the given name on the stack, making it the current one. @param name String containing name of the next sibling. @return True if the Element was found and made the current one.) +/// @brief Put the next sibling Element with the given name on the stack, making it the current one. +/// @param name String containing name of the next sibling. +/// @return True if the Element was found and made the current one.) +/// /// public bool nextSiblingElement(string simxmldocument, string name){ @@ -20278,7 +28042,10 @@ public bool nextSiblingElement(string simxmldocument, string name){ return m_ts.fnSimXMLDocument_nextSiblingElement(simxmldocument, name); } /// -/// @brief Create a document from a XML string. @note Clears the current document's contents. @param xmlString Valid XML to parse and store as a document.) +/// @brief Create a document from a XML string. +/// @note Clears the current document's contents. +/// @param xmlString Valid XML to parse and store as a document.) +/// /// public void parse(string simxmldocument, string xmlString){ @@ -20287,6 +28054,7 @@ public void parse(string simxmldocument, string xmlString){ } /// /// @brief Pop the last Element off the stack.) +/// /// public void popElement(string simxmldocument){ @@ -20294,7 +28062,12 @@ public void popElement(string simxmldocument){ m_ts.fnSimXMLDocument_popElement(simxmldocument); } /// -/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). @return String containing the previous attribute's name, or an empty string if none is found. @see lastAttribute() @see firstAttribute() @see nextAttribute()) +/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). +/// @return String containing the previous attribute's name, or an empty string if none is found. +/// @see lastAttribute() +/// @see firstAttribute() +/// @see nextAttribute()) +/// /// public string prevAttribute(string simxmldocument){ @@ -20302,7 +28075,10 @@ public string prevAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_prevAttribute(simxmldocument); } /// -/// @brief Push the child Element at the given index onto the stack, making it the current one. @param index Numerical index of Element being pushed. @return True if the Element was found and made the current one.) +/// @brief Push the child Element at the given index onto the stack, making it the current one. +/// @param index Numerical index of Element being pushed. +/// @return True if the Element was found and made the current one.) +/// /// public bool pushChildElement(string simxmldocument, int index){ @@ -20310,7 +28086,29 @@ public bool pushChildElement(string simxmldocument, int index){ return m_ts.fnSimXMLDocument_pushChildElement(simxmldocument, index); } /// -/// @brief Push the first child Element with the given name onto the stack, making it the current Element. @param name String containing name of the child Element. @return True if the Element was found and made the current one. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample) +/// @brief Push the first child Element with the given name onto the stack, making it the current Element. +/// +/// @param name String containing name of the child Element. +/// @return True if the Element was found and made the current one. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample) +/// /// public bool pushFirstChildElement(string simxmldocument, string name){ @@ -20318,7 +28116,16 @@ public bool pushFirstChildElement(string simxmldocument, string name){ return m_ts.fnSimXMLDocument_pushFirstChildElement(simxmldocument, name); } /// -/// @brief Create a new element with the given name as child of current Element and push it onto the Element stack making it the current one. @note This differs from addNewElement() in that it adds the new Element as a child of the current Element (or a child of the document if no Element exists). @param name XML tag for the new Element. @see addNewElement()) +/// @brief Create a new element with the given name as child of current Element +/// and push it onto the Element stack making it the current one. +/// +/// @note This differs from addNewElement() in that it adds the new Element as a +/// child of the current Element (or a child of the document if no Element exists). +/// +/// @param name XML tag for the new Element. +/// +/// @see addNewElement()) +/// /// public void pushNewElement(string simxmldocument, string name){ @@ -20326,7 +28133,18 @@ public void pushNewElement(string simxmldocument, string name){ m_ts.fnSimXMLDocument_pushNewElement(simxmldocument, name); } /// -/// Gives the comment at the specified index, if any. Unlike addComment() that only works at the document level, readComment() may read comments from the document or any child Element. The current Element (or document if no Elements have been pushed to the stack) is the parent for any comments, and the provided index is the number of comments in to read back. @param index Comment index number to query from the current Element stack @return String containing the comment, or an empty string if no comment is found. @see addComment()) +/// Gives the comment at the specified index, if any. +/// +/// Unlike addComment() that only works at the document level, readComment() may read +/// comments from the document or any child Element. The current Element (or document +/// if no Elements have been pushed to the stack) is the parent for any comments, and the +/// provided index is the number of comments in to read back. +/// +/// @param index Comment index number to query from the current Element stack +/// @return String containing the comment, or an empty string if no comment is found. +/// +/// @see addComment()) +/// /// public string readComment(string simxmldocument, int index){ @@ -20334,7 +28152,18 @@ public string readComment(string simxmldocument, int index){ return m_ts.fnSimXMLDocument_readComment(simxmldocument, index); } /// -/// @brief Remove any text on the current Element. Use getText() to retrieve any text from the current Element and addText() to add text to the current Element. As getData() and addData() are equivalent to getText() and addText(), removeText() will also remove any data from the current Element. @see addText() @see getText() @see addData() @see getData()) +/// @brief Remove any text on the current Element. +/// +/// Use getText() to retrieve any text from the current Element and addText() +/// to add text to the current Element. As getData() and addData() are equivalent +/// to getText() and addText(), removeText() will also remove any data from the +/// current Element. +/// +/// @see addText() +/// @see getText() +/// @see addData() +/// @see getData()) +/// /// public void removeText(string simxmldocument){ @@ -20342,7 +28171,12 @@ public void removeText(string simxmldocument){ m_ts.fnSimXMLDocument_removeText(simxmldocument); } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using clear() @see clear()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using clear() +/// +/// @see clear()) +/// /// public void reset(string simxmldocument){ @@ -20350,7 +28184,10 @@ public void reset(string simxmldocument){ m_ts.fnSimXMLDocument_reset(simxmldocument); } /// -/// @brief Save document to the given file name. @param fileName Path and name of XML file to save to. @return True if the file was successfully saved.) +/// @brief Save document to the given file name. +/// @param fileName Path and name of XML file to save to. +/// @return True if the file was successfully saved.) +/// /// public bool saveFile(string simxmldocument, string fileName){ @@ -20358,7 +28195,10 @@ public bool saveFile(string simxmldocument, string fileName){ return m_ts.fnSimXMLDocument_saveFile(simxmldocument, fileName); } /// -/// @brief Set the attribute of the current Element on the stack to the given value. @param attributeName Name of attribute being changed @param value New value to assign to the attribute) +/// @brief Set the attribute of the current Element on the stack to the given value. +/// @param attributeName Name of attribute being changed +/// @param value New value to assign to the attribute) +/// /// public void setAttribute(string simxmldocument, string attributeName, string value){ @@ -20366,7 +28206,9 @@ public void setAttribute(string simxmldocument, string attributeName, string va m_ts.fnSimXMLDocument_setAttribute(simxmldocument, attributeName, value); } /// -/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. @param objectID ID of SimObject being copied.) +/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. +/// @param objectID ID of SimObject being copied.) +/// /// public void setObjectAttributes(string simxmldocument, string objectID){ @@ -20379,14 +28221,9 @@ public void setObjectAttributes(string simxmldocument, string objectID){ /// public class SkyBoxObject { -private Omni m_ts; - /// - /// - /// - /// -public SkyBoxObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void SkyBox_postApply(string skybox){ @@ -20399,14 +28236,12 @@ public void SkyBox_postApply(string skybox){ /// public class SpawnSphereObject { -private Omni m_ts; - /// - /// - /// - /// -public SpawnSphereObject(ref Omni ts){m_ts = ts;} /// -/// ([string additionalProps]) Spawns the object based on the SpawnSphere's class, datablock, properties, and script settings. Allows you to pass in extra properties. @hide ) +/// ([string additionalProps]) Spawns the object based on the SpawnSphere's +/// class, datablock, properties, and script settings. Allows you to pass in +/// extra properties. +/// @hide ) +/// /// public int SpawnSphere_spawnObject(string spawnsphere, string additionalProps){ @@ -20419,14 +28254,9 @@ public int SpawnSphere_spawnObject(string spawnsphere, string additionalProps){ /// public class StaticShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public StaticShapeObject(ref Omni ts){m_ts = ts;} /// /// @internal) +/// /// public bool StaticShape_getPoweredState(string staticshape){ @@ -20434,7 +28264,9 @@ public bool StaticShape_getPoweredState(string staticshape){ return m_ts.fn_StaticShape_getPoweredState(staticshape); } /// -/// (bool isPowered) @internal) +/// (bool isPowered) +/// @internal) +/// /// public void StaticShape_setPoweredState(string staticshape, bool isPowered){ @@ -20447,14 +28279,11 @@ public void StaticShape_setPoweredState(string staticshape, bool isPowered){ /// public class StreamObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public StreamObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Copy from another StreamObject into this StreamObject @param other The StreamObject to copy from. @return True if the copy was successful.) +/// @brief Copy from another StreamObject into this StreamObject +/// @param other The StreamObject to copy from. +/// @return True if the copy was successful.) +/// /// public bool copyFrom(string streamobject, string other){ @@ -20462,7 +28291,36 @@ public bool copyFrom(string streamobject, string other){ return m_ts.fnStreamObject_copyFrom(streamobject, other); } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains two lines of text repeated: // Hello World // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Get the position of the stream %position = %fsObject.getPosition(); // Print the current position // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline echo(%position); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see setPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains two lines of text repeated: +/// // Hello World +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Get the position of the stream +/// %position = %fsObject.getPosition(); +/// // Print the current position +/// // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline +/// echo(%position); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see setPosition()) +/// /// public int getPosition(string streamobject){ @@ -20470,7 +28328,36 @@ public int getPosition(string streamobject){ return m_ts.fnStreamObject_getPosition(streamobject); } /// -/// @brief Gets a printable string form of the stream's status @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing status constant, one of the following: OK - Stream is active and no file errors IOError - Something went wrong during read or writing the stream EOS - End of Stream reached (mostly for reads) IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn Closed - Tried to operate on a closed stream (or detached filter) UnknownError - Catch all for an error of some kind Invalid - Entire stream is invalid) +/// @brief Gets a printable string form of the stream's status +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing status constant, one of the following: +/// +/// OK - Stream is active and no file errors +/// +/// IOError - Something went wrong during read or writing the stream +/// +/// EOS - End of Stream reached (mostly for reads) +/// +/// IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn +/// +/// Closed - Tried to operate on a closed stream (or detached filter) +/// +/// UnknownError - Catch all for an error of some kind +/// +/// Invalid - Entire stream is invalid) +/// /// public string getStatus(string streamobject){ @@ -20478,7 +28365,30 @@ public string getStatus(string streamobject){ return m_ts.fnStreamObject_getStatus(streamobject); } /// -/// @brief Gets the size of the stream The size is dependent on the type of stream being used. If it is a file stream, returned value will be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject.open(\"./test.txt\", \"read\"); // Found out how large the file stream is // Then print it to the console // Should be 22 %streamSize = %fsObject.getStreamSize(); echo(%streamSize); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Size of stream, in bytes) +/// @brief Gets the size of the stream +/// +/// The size is dependent on the type of stream being used. If it is a file stream, returned value will +/// be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Found out how large the file stream is +/// // Then print it to the console +/// // Should be 22 +/// %streamSize = %fsObject.getStreamSize(); +/// echo(%streamSize); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Size of stream, in bytes) +/// /// public int getStreamSize(string streamobject){ @@ -20486,7 +28396,32 @@ public int getStreamSize(string streamobject){ return m_ts.fnStreamObject_getStreamSize(streamobject); } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOS. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOF() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOS()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOS. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOF() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOS()) +/// /// public bool isEOF(string streamobject){ @@ -20494,7 +28429,32 @@ public bool isEOF(string streamobject){ return m_ts.fnStreamObject_isEOF(streamobject); } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOF. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOS() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOF()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOF. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOS() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOF()) +/// /// public bool isEOS(string streamobject){ @@ -20502,7 +28462,30 @@ public bool isEOS(string streamobject){ return m_ts.fnStreamObject_isEOS(streamobject); } /// -/// @brief Read a line from the stream. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file stream object for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject = new FileStreamObject(); %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Print the line we just read echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing the line of data that was just read @see writeLine()) +/// @brief Read a line from the stream. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file stream object for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject = new FileStreamObject(); +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Print the line we just read +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing the line of data that was just read +/// +/// @see writeLine()) +/// /// public string readLine(string streamobject){ @@ -20510,7 +28493,15 @@ public string readLine(string streamobject){ return m_ts.fnStreamObject_readLine(streamobject); } /// -/// @brief Read in a string up to the given maximum number of characters. @param maxLength The maximum number of characters to read in. @return The string that was read from the stream. @see writeLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string up to the given maximum number of characters. +/// @param maxLength The maximum number of characters to read in. +/// @return The string that was read from the stream. +/// @see writeLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string readLongString(string streamobject, int maxLength){ @@ -20518,7 +28509,14 @@ public string readLongString(string streamobject, int maxLength){ return m_ts.fnStreamObject_readLongString(streamobject, maxLength); } /// -/// @brief Read a string up to a maximum of 256 characters @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read a string up to a maximum of 256 characters +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string readString(string streamobject){ @@ -20526,7 +28524,16 @@ public string readString(string streamobject){ return m_ts.fnStreamObject_readString(streamobject); } /// -/// @brief Read in a string and place it on the string table. @param caseSensitive If false then case will not be taken into account when attempting to match the read in string with what is already in the string table. @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string and place it on the string table. +/// @param caseSensitive If false then case will not be taken into account when attempting +/// to match the read in string with what is already in the string table. +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string readSTString(string streamobject, bool caseSensitive = false){ @@ -20534,7 +28541,35 @@ public string readSTString(string streamobject, bool caseSensitive = false){ return m_ts.fnStreamObject_readSTString(streamobject, caseSensitive); } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // 11111111111 // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Skip ahead by 12, which will bypass the first line entirely %fsObject.setPosition(12); // Read in the next line %line = %fsObject.readLine(); // Print the line just read in, should be \"Hello World\" echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see getPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // 11111111111 +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Skip ahead by 12, which will bypass the first line entirely +/// %fsObject.setPosition(12); +/// // Read in the next line +/// %line = %fsObject.readLine(); +/// // Print the line just read in, should be \"Hello World\" +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see getPosition()) +/// /// public bool setPosition(string streamobject, int newPosition){ @@ -20542,7 +28577,29 @@ public bool setPosition(string streamobject, int newPosition){ return m_ts.fnStreamObject_setPosition(streamobject, newPosition); } /// -/// @brief Write a line to the stream, if it was opened for writing. There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param line The data we are writing out to file. @tsexample // Create a file stream %fsObject = new FileStreamObject(); // Open the file for writing // If it does not exist, it is created. If it does exist, the file is cleared %fsObject.open(\"./test.txt\", \"write\"); // Write a line to the file %fsObject.writeLine(\"Hello World\"); // Write another line to the file %fsObject.writeLine(\"Documentation Rocks!\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see readLine()) +/// @brief Write a line to the stream, if it was opened for writing. +/// +/// There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param line The data we are writing out to file. +/// +/// @tsexample +/// // Create a file stream +/// %fsObject = new FileStreamObject(); +/// // Open the file for writing +/// // If it does not exist, it is created. If it does exist, the file is cleared +/// %fsObject.open(\"./test.txt\", \"write\"); +/// // Write a line to the file +/// %fsObject.writeLine(\"Hello World\"); +/// // Write another line to the file +/// %fsObject.writeLine(\"Documentation Rocks!\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see readLine()) +/// /// public void writeLine(string streamobject, string line){ @@ -20550,7 +28607,15 @@ public void writeLine(string streamobject, string line){ m_ts.fnStreamObject_writeLine(streamobject, line); } /// -/// @brief Write out a string up to the maximum number of characters. @param maxLength The maximum number of characters that will be written. @param string The string to write out to the stream. @see readLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string up to the maximum number of characters. +/// @param maxLength The maximum number of characters that will be written. +/// @param string The string to write out to the stream. +/// @see readLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void writeLongString(string streamobject, int maxLength, string stringx){ @@ -20558,7 +28623,16 @@ public void writeLongString(string streamobject, int maxLength, string stringx) m_ts.fnStreamObject_writeLongString(streamobject, maxLength, stringx); } /// -/// @brief Write out a string with a default maximum length of 256 characters. @param string The string to write out to the stream @param maxLength The maximum string length to write out with a default of 256 characters. This value should not be larger than 256 as it is written to the stream as a single byte. @see readString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string with a default maximum length of 256 characters. +/// @param string The string to write out to the stream +/// @param maxLength The maximum string length to write out with a default of 256 characters. This +/// value should not be larger than 256 as it is written to the stream as a single byte. +/// @see readString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void writeString(string streamobject, string stringx, int maxLength = 256){ @@ -20571,14 +28645,9 @@ public void writeString(string streamobject, string stringx, int maxLength = 25 /// public class SunObject { -private Omni m_ts; - /// - /// - /// - /// -public SunObject(ref Omni ts){m_ts = ts;} /// /// animate( F32 duration, F32 startAzimuth, F32 endAzimuth, F32 startElevation, F32 endElevation )) +/// /// public void Sun_animate(string sun, float duration, float startAzimuth, float endAzimuth, float startElevation, float endElevation){ @@ -20587,6 +28656,7 @@ public void Sun_animate(string sun, float duration, float startAzimuth, float e } /// /// ) +/// /// public void Sun_apply(string sun){ @@ -20599,14 +28669,19 @@ public void Sun_apply(string sun){ /// public class TCPObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public TCPObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Connect to the given address. @param address Server address (including port) to connect to. @tsexample // Set the address. %address = \"www.garagegames.com:80\"; // Inform this TCPObject to connect to the specified address. %thisTCPObj.connect(%address); @endtsexample) +/// @brief Connect to the given address. +/// +/// @param address Server address (including port) to connect to. +/// +/// @tsexample +/// // Set the address. +/// %address = \"www.garagegames.com:80\"; +/// +/// // Inform this TCPObject to connect to the specified address. +/// %thisTCPObj.connect(%address); +/// @endtsexample) +/// /// public void connect(string tcpobject, string address){ @@ -20614,7 +28689,13 @@ public void connect(string tcpobject, string address){ m_ts.fnTCPObject_connect(tcpobject, address); } /// -/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. @tsexample // Inform this TCPObject to disconnect from anything it is currently connected to. %thisTCPObj.disconnect(); @endtsexample) +/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. +/// +/// @tsexample +/// // Inform this TCPObject to disconnect from anything it is currently connected to. +/// %thisTCPObj.disconnect(); +/// @endtsexample) +/// /// public void disconnect(string tcpobject){ @@ -20622,15 +28703,58 @@ public void disconnect(string tcpobject){ m_ts.fnTCPObject_disconnect(tcpobject); } /// -/// @brief Start listening on the specified port for connections. This method starts a listener which looks for incoming TCP connections to a port. You must overload the onConnectionRequest callback to create a new TCPObject to read, write, or reject the new connection. @param port Port for this TCPObject to start listening for connections on. @tsexample // Create a listener on port 8080. new TCPObject( TCPListener ); TCPListener.listen( 8080 ); function TCPListener::onConnectionRequest( %this, %address, %id ) { // Create a new object to manage the connection. new TCPObject( TCPClient, %id ); } function TCPClient::onLine( %this, %line ) { // Print the line of text from client. echo( %line ); } @endtsexample) +/// @brief Start listening on the specified port for connections. +/// +/// This method starts a listener which looks for incoming TCP connections to a port. +/// You must overload the onConnectionRequest callback to create a new TCPObject to +/// read, write, or reject the new connection. +/// +/// @param port Port for this TCPObject to start listening for connections on. +/// +/// @tsexample +/// +/// // Create a listener on port 8080. +/// new TCPObject( TCPListener ); +/// TCPListener.listen( 8080 ); +/// +/// function TCPListener::onConnectionRequest( %this, %address, %id ) +/// { +/// // Create a new object to manage the connection. +/// new TCPObject( TCPClient, %id ); +/// } +/// +/// function TCPClient::onLine( %this, %line ) +/// { +/// // Print the line of text from client. +/// echo( %line ); +/// } +/// +/// @endtsexample) +/// /// -public void listen(string tcpobject, int port){ +public void listen(string tcpobject, uint port){ m_ts.fnTCPObject_listen(tcpobject, port); } /// -/// @brief Transmits the data string to the connected computer. This method is used to send text data to the connected computer regardless if we initiated the connection using connect(), or listening to a port using listen(). @param data The data string to send. @tsexample // Set the command data %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" // Send the command to the connected server. %thisTCPObj.send(%data); @endtsexample) +/// @brief Transmits the data string to the connected computer. +/// +/// This method is used to send text data to the connected computer regardless if we initiated the +/// connection using connect(), or listening to a port using listen(). +/// +/// @param data The data string to send. +/// +/// @tsexample +/// // Set the command data +/// %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; +/// %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; +/// %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" +/// +/// // Send the command to the connected server. +/// %thisTCPObj.send(%data); +/// @endtsexample) +/// /// public void send(string tcpobject, string data){ @@ -20643,14 +28767,9 @@ public void send(string tcpobject, string data){ /// public class TerrainBlockObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainBlockObject(ref Omni ts){m_ts = ts;} /// /// png), (string filename, [string format]) - export the terrain block's heightmap to a bitmap file (default: png) ) +/// /// public bool TerrainBlock_exportHeightMap(string terrainblock, string fileNameStr, string format = "png"){ @@ -20659,6 +28778,7 @@ public bool TerrainBlock_exportHeightMap(string terrainblock, string fileNameSt } /// /// png), (string filePrefix, [string format]) - export the terrain block's layer maps to bitmap files (default: png) ) +/// /// public bool TerrainBlock_exportLayerMaps(string terrainblock, string filePrefixStr, string format = "png"){ @@ -20666,7 +28786,12 @@ public bool TerrainBlock_exportLayerMaps(string terrainblock, string filePrefix return m_ts.fn_TerrainBlock_exportLayerMaps(terrainblock, filePrefixStr, format); } /// -/// @brief Saves the terrain block's terrain file to the specified file name. @param fileName Name and path of file to save terrain data to. @return True if file save was successful, false otherwise) +/// @brief Saves the terrain block's terrain file to the specified file name. +/// +/// @param fileName Name and path of file to save terrain data to. +/// +/// @return True if file save was successful, false otherwise) +/// /// public bool save(string terrainblock, string fileName){ @@ -20679,14 +28804,10 @@ public bool save(string terrainblock, string fileName){ /// public class TerrainEditorObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainEditorObject(ref Omni ts){m_ts = ts;} /// -/// ( string matName ) Adds a new material. ) +/// ( string matName ) +/// Adds a new material. ) +/// /// public int TerrainEditor_addMaterial(string terraineditor, string matName){ @@ -20695,6 +28816,7 @@ public int TerrainEditor_addMaterial(string terraineditor, string matName){ } /// /// ), (TerrainBlock terrain)) +/// /// public void TerrainEditor_attachTerrain(string terraineditor, string terrain = ""){ @@ -20702,15 +28824,17 @@ public void TerrainEditor_attachTerrain(string terraineditor, string terrain = m_ts.fn_TerrainEditor_attachTerrain(terraineditor, terrain); } /// -/// (float minHeight, float maxHeight, float minSlope, float maxSlope)) +/// (F32 minHeight, F32 maxHeight, F32 minSlope, F32 maxSlope , F32 coverage)) +/// /// -public void TerrainEditor_autoMaterialLayer(string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope){ +public void TerrainEditor_autoMaterialLayer(string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope, float coverage){ -m_ts.fn_TerrainEditor_autoMaterialLayer(terraineditor, minHeight, maxHeight, minSlope, maxSlope); +m_ts.fn_TerrainEditor_autoMaterialLayer(terraineditor, minHeight, maxHeight, minSlope, maxSlope, coverage); } /// /// ) +/// /// public void TerrainEditor_clearSelection(string terraineditor){ @@ -20719,6 +28843,7 @@ public void TerrainEditor_clearSelection(string terraineditor){ } /// /// (int num)) +/// /// public string TerrainEditor_getActionName(string terraineditor, uint index){ @@ -20727,6 +28852,7 @@ public string TerrainEditor_getActionName(string terraineditor, uint index){ } /// /// ) +/// /// public int TerrainEditor_getActiveTerrain(string terraineditor){ @@ -20735,6 +28861,7 @@ public int TerrainEditor_getActiveTerrain(string terraineditor){ } /// /// Returns a Point2I.) +/// /// public string TerrainEditor_getBrushPos(string terraineditor){ @@ -20743,6 +28870,7 @@ public string TerrainEditor_getBrushPos(string terraineditor){ } /// /// ()) +/// /// public float TerrainEditor_getBrushPressure(string terraineditor){ @@ -20751,6 +28879,7 @@ public float TerrainEditor_getBrushPressure(string terraineditor){ } /// /// ()) +/// /// public string TerrainEditor_getBrushSize(string terraineditor){ @@ -20759,6 +28888,7 @@ public string TerrainEditor_getBrushSize(string terraineditor){ } /// /// ()) +/// /// public float TerrainEditor_getBrushSoftness(string terraineditor){ @@ -20767,6 +28897,7 @@ public float TerrainEditor_getBrushSoftness(string terraineditor){ } /// /// ()) +/// /// public string TerrainEditor_getBrushType(string terraineditor){ @@ -20775,6 +28906,7 @@ public string TerrainEditor_getBrushType(string terraineditor){ } /// /// ) +/// /// public string TerrainEditor_getCurrentAction(string terraineditor){ @@ -20783,6 +28915,7 @@ public string TerrainEditor_getCurrentAction(string terraineditor){ } /// /// Returns the current material count. ) +/// /// public int TerrainEditor_getMaterialCount(string terraineditor){ @@ -20791,6 +28924,7 @@ public int TerrainEditor_getMaterialCount(string terraineditor){ } /// /// ( string name ) - Returns the index of the material with the given name or -1. ) +/// /// public int TerrainEditor_getMaterialIndex(string terraineditor, string name){ @@ -20799,6 +28933,7 @@ public int TerrainEditor_getMaterialIndex(string terraineditor, string name){ } /// /// ( int index ) - Returns the name of the material at the given index. ) +/// /// public string TerrainEditor_getMaterialName(string terraineditor, int index){ @@ -20807,6 +28942,7 @@ public string TerrainEditor_getMaterialName(string terraineditor, int index){ } /// /// () gets the list of current terrain materials.) +/// /// public string TerrainEditor_getMaterials(string terraineditor){ @@ -20815,6 +28951,7 @@ public string TerrainEditor_getMaterials(string terraineditor){ } /// /// ) +/// /// public int TerrainEditor_getNumActions(string terraineditor){ @@ -20823,6 +28960,7 @@ public int TerrainEditor_getNumActions(string terraineditor){ } /// /// ) +/// /// public int TerrainEditor_getNumTextures(string terraineditor){ @@ -20831,6 +28969,7 @@ public int TerrainEditor_getNumTextures(string terraineditor){ } /// /// ) +/// /// public float TerrainEditor_getSlopeLimitMaxAngle(string terraineditor){ @@ -20839,6 +28978,7 @@ public float TerrainEditor_getSlopeLimitMaxAngle(string terraineditor){ } /// /// ) +/// /// public float TerrainEditor_getSlopeLimitMinAngle(string terraineditor){ @@ -20847,6 +28987,7 @@ public float TerrainEditor_getSlopeLimitMinAngle(string terraineditor){ } /// /// (S32 index)) +/// /// public int TerrainEditor_getTerrainBlock(string terraineditor, int index){ @@ -20855,6 +28996,7 @@ public int TerrainEditor_getTerrainBlock(string terraineditor, int index){ } /// /// ()) +/// /// public int TerrainEditor_getTerrainBlockCount(string terraineditor){ @@ -20863,6 +29005,7 @@ public int TerrainEditor_getTerrainBlockCount(string terraineditor){ } /// /// () gets the list of current terrain materials for all terrain blocks.) +/// /// public string TerrainEditor_getTerrainBlocksMaterialList(string terraineditor){ @@ -20870,7 +29013,12 @@ public string TerrainEditor_getTerrainBlocksMaterialList(string terraineditor){ return m_ts.fn_TerrainEditor_getTerrainBlocksMaterialList(terraineditor); } /// -/// , , ), (x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found).) +/// , , ), +/// (x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found).) +/// /// public int TerrainEditor_getTerrainUnderWorldPoint(string terraineditor, string ptOrX = "", string Y = "", string Z = ""){ @@ -20879,6 +29027,7 @@ public int TerrainEditor_getTerrainUnderWorldPoint(string terraineditor, string } /// /// ) +/// /// public void TerrainEditor_markEmptySquares(string terraineditor){ @@ -20887,6 +29036,7 @@ public void TerrainEditor_markEmptySquares(string terraineditor){ } /// /// ) +/// /// public void TerrainEditor_mirrorTerrain(string terraineditor, int mirrorIndex){ @@ -20895,6 +29045,7 @@ public void TerrainEditor_mirrorTerrain(string terraineditor, int mirrorIndex){ } /// /// ), (string action=NULL)) +/// /// public void TerrainEditor_processAction(string terraineditor, string action = ""){ @@ -20903,6 +29054,7 @@ public void TerrainEditor_processAction(string terraineditor, string action = " } /// /// ( int index ) - Remove the material at the given index. ) +/// /// public void TerrainEditor_removeMaterial(string terraineditor, int index){ @@ -20910,7 +29062,9 @@ public void TerrainEditor_removeMaterial(string terraineditor, int index){ m_ts.fn_TerrainEditor_removeMaterial(terraineditor, index); } /// -/// ( int index, int order ) - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// ( int index, int order ) +/// - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// /// public void TerrainEditor_reorderMaterial(string terraineditor, int index, int orderPos){ @@ -20919,6 +29073,7 @@ public void TerrainEditor_reorderMaterial(string terraineditor, int index, int } /// /// (bool clear)) +/// /// public void TerrainEditor_resetSelWeights(string terraineditor, bool clear){ @@ -20927,6 +29082,7 @@ public void TerrainEditor_resetSelWeights(string terraineditor, bool clear){ } /// /// (string action_name)) +/// /// public void TerrainEditor_setAction(string terraineditor, string action_name){ @@ -20935,6 +29091,7 @@ public void TerrainEditor_setAction(string terraineditor, string action_name){ } /// /// Location) +/// /// public void TerrainEditor_setBrushPos(string terraineditor, Point2I pos){ @@ -20943,6 +29100,7 @@ public void TerrainEditor_setBrushPos(string terraineditor, Point2I pos){ } /// /// (float pressure)) +/// /// public void TerrainEditor_setBrushPressure(string terraineditor, float pressure){ @@ -20951,6 +29109,7 @@ public void TerrainEditor_setBrushPressure(string terraineditor, float pressure } /// /// (int w [, int h])) +/// /// public void TerrainEditor_setBrushSize(string terraineditor, int w, int h = 0){ @@ -20959,6 +29118,7 @@ public void TerrainEditor_setBrushSize(string terraineditor, int w, int h = 0){ } /// /// (float softness)) +/// /// public void TerrainEditor_setBrushSoftness(string terraineditor, float softness){ @@ -20966,7 +29126,9 @@ public void TerrainEditor_setBrushSoftness(string terraineditor, float softness m_ts.fn_TerrainEditor_setBrushSoftness(terraineditor, softness); } /// -/// (string type) One of box, ellipse, selection.) +/// (string type) +/// One of box, ellipse, selection.) +/// /// public void TerrainEditor_setBrushType(string terraineditor, string type){ @@ -20975,6 +29137,7 @@ public void TerrainEditor_setBrushType(string terraineditor, string type){ } /// /// ) +/// /// public float TerrainEditor_setSlopeLimitMaxAngle(string terraineditor, float angle){ @@ -20983,6 +29146,7 @@ public float TerrainEditor_setSlopeLimitMaxAngle(string terraineditor, float an } /// /// ) +/// /// public float TerrainEditor_setSlopeLimitMinAngle(string terraineditor, float angle){ @@ -20991,6 +29155,7 @@ public float TerrainEditor_setSlopeLimitMinAngle(string terraineditor, float an } /// /// (bool overlayEnable) - sets the terraformer current heightmap to draw as an overlay over the current terrain.) +/// /// public void TerrainEditor_setTerraformOverlay(string terraineditor, bool overlayEnable){ @@ -20998,7 +29163,9 @@ public void TerrainEditor_setTerraformOverlay(string terraineditor, bool overla m_ts.fn_TerrainEditor_setTerraformOverlay(terraineditor, overlayEnable); } /// -/// ( int index, string matName ) Changes the material name at the index. ) +/// ( int index, string matName ) +/// Changes the material name at the index. ) +/// /// public bool TerrainEditor_updateMaterial(string terraineditor, uint index, string matName){ @@ -21011,14 +29178,9 @@ public bool TerrainEditor_updateMaterial(string terraineditor, uint index, stri /// public class TerrainSmoothActionObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainSmoothActionObject(ref Omni ts){m_ts = ts;} /// /// ( TerrainBlock obj, F32 factor, U32 steps )) +/// /// public void TerrainSmoothAction_smooth(string terrainsmoothaction, string terrain, float factor, uint steps){ @@ -21031,14 +29193,9 @@ public void TerrainSmoothAction_smooth(string terrainsmoothaction, string terra /// public class TerrainSolderEdgesActionObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainSolderEdgesActionObject(ref Omni ts){m_ts = ts;} /// /// () ) +/// /// public void TerrainSolderEdgesAction_solder(string terrainsolderedgesaction){ @@ -21051,14 +29208,9 @@ public void TerrainSolderEdgesAction_solder(string terrainsolderedgesaction){ /// public class TheoraTextureObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public TheoraTextureObjectObject(ref Omni ts){m_ts = ts;} /// /// Pause playback of the video. ) +/// /// public void TheoraTextureObject_pause(string theoratextureobject){ @@ -21067,6 +29219,7 @@ public void TheoraTextureObject_pause(string theoratextureobject){ } /// /// Start playback of the video. ) +/// /// public void TheoraTextureObject_play(string theoratextureobject){ @@ -21075,6 +29228,7 @@ public void TheoraTextureObject_play(string theoratextureobject){ } /// /// Stop playback of the video. ) +/// /// public void TheoraTextureObject_stop(string theoratextureobject){ @@ -21087,14 +29241,9 @@ public void TheoraTextureObject_stop(string theoratextureobject){ /// public class TimeOfDayObject { -private Omni m_ts; - /// - /// - /// - /// -public TimeOfDayObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void addTimeOfDayEvent(string timeofday, float elevation, string identifier){ @@ -21103,6 +29252,7 @@ public void addTimeOfDayEvent(string timeofday, float elevation, string identif } /// /// ) +/// /// public void animate(string timeofday, float elevation, float degreesPerSecond){ @@ -21111,6 +29261,7 @@ public void animate(string timeofday, float elevation, float degreesPerSecond){ } /// /// ) +/// /// public void setDayLength(string timeofday, float seconds){ @@ -21119,6 +29270,7 @@ public void setDayLength(string timeofday, float seconds){ } /// /// ) +/// /// public void setPlay(string timeofday, bool enabled){ @@ -21127,6 +29279,7 @@ public void setPlay(string timeofday, bool enabled){ } /// /// ) +/// /// public void setTimeOfDay(string timeofday, float time){ @@ -21139,14 +29292,10 @@ public void setTimeOfDay(string timeofday, float time){ /// public class TriggerObject { -private Omni m_ts; - /// - /// - /// - /// -public TriggerObject(ref Omni ts){m_ts = ts;} /// -/// @brief Get the number of objects that are within the Trigger's bounds. @see getObject()) +/// @brief Get the number of objects that are within the Trigger's bounds. +/// @see getObject()) +/// /// public int getNumObjects(string trigger){ @@ -21154,7 +29303,11 @@ public int getNumObjects(string trigger){ return m_ts.fnTrigger_getNumObjects(trigger); } /// -/// @brief Retrieve the requested object that is within the Trigger's bounds. @param index Index of the object to get (range is 0 to getNumObjects()-1) @returns The SimObjectID of the object, or -1 if the requested index is invalid. @see getNumObjects()) +/// @brief Retrieve the requested object that is within the Trigger's bounds. +/// @param index Index of the object to get (range is 0 to getNumObjects()-1) +/// @returns The SimObjectID of the object, or -1 if the requested index is invalid. +/// @see getNumObjects()) +/// /// public int getObject(string trigger, int index){ @@ -21167,14 +29320,12 @@ public int getObject(string trigger, int index){ /// public class TSAttachableObject { -private Omni m_ts; - /// - /// - /// - /// -public TSAttachableObject(ref Omni ts){m_ts = ts;} /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool attachObject(string tsattachable, string obj){ @@ -21182,7 +29333,14 @@ public bool attachObject(string tsattachable, string obj){ return m_ts.fnTSAttachable_attachObject(tsattachable, obj); } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void detachAll(string tsattachable){ @@ -21190,7 +29348,11 @@ public void detachAll(string tsattachable){ m_ts.fnTSAttachable_detachAll(tsattachable); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool detachObject(string tsattachable, string obj){ @@ -21199,6 +29361,7 @@ public bool detachObject(string tsattachable, string obj){ } /// /// Returns the attachment at the passed index value.) +/// /// public string getAttachment(string tsattachable, int index = 0){ @@ -21207,6 +29370,7 @@ public string getAttachment(string tsattachable, int index = 0){ } /// /// Returns the number of objects that are currently attached.) +/// /// public int getNumAttachments(string tsattachable){ @@ -21219,14 +29383,26 @@ public int getNumAttachments(string tsattachable){ /// public class TSDynamicObject { -private Omni m_ts; - /// - /// - /// - /// -public TSDynamicObject(ref Omni ts){m_ts = ts;} /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void changeMaterial(string tsdynamic, string mapTo = "", string oldMat = null , string newMat = null ){ if (oldMat== null) {oldMat = null;} @@ -21236,7 +29412,15 @@ public void changeMaterial(string tsdynamic, string mapTo = "", string oldMat = m_ts.fnTSDynamic_changeMaterial(tsdynamic, mapTo, oldMat, newMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string getModelFile(string tsdynamic){ @@ -21244,7 +29428,10 @@ public string getModelFile(string tsdynamic){ return m_ts.fnTSDynamic_getModelFile(tsdynamic); } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int getTargetCount(string tsdynamic){ @@ -21252,7 +29439,11 @@ public int getTargetCount(string tsdynamic){ return m_ts.fnTSDynamic_getTargetCount(tsdynamic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string getTargetName(string tsdynamic, int index = 0){ @@ -21265,14 +29456,9 @@ public string getTargetName(string tsdynamic, int index = 0){ /// public class TSPathShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public TSPathShapeObject(ref Omni ts){m_ts = ts;} /// /// Returns the looping state for the shape.) +/// /// public bool getLooping(string tspathshape){ @@ -21281,6 +29467,7 @@ public bool getLooping(string tspathshape){ } /// /// Returns the number of nodes on the shape's path.) +/// /// public int getNodeCount(string tspathshape){ @@ -21289,6 +29476,7 @@ public int getNodeCount(string tspathshape){ } /// /// Get the current position of the shape along the path (0.0 - lastNode - 1).) +/// /// public float getPathPosition(string tspathshape){ @@ -21296,7 +29484,12 @@ public float getPathPosition(string tspathshape){ return m_ts.fnTSPathShape_getPathPosition(tspathshape); } /// -/// Removes the knot at the front of the shape's path. @tsexample // Remove the first knot in the shape's path. %pathShape.popFront(); @endtsexample) +/// Removes the knot at the front of the shape's path. +/// @tsexample +/// // Remove the first knot in the shape's path. +/// %pathShape.popFront(); +/// @endtsexample) +/// /// public void popFront(string tspathshape){ @@ -21304,7 +29497,25 @@ public void popFront(string tspathshape){ m_ts.fnTSPathShape_popFront(tspathshape); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the back of its path %pathShape.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the back of its path +/// %pathShape.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void pushBack(string tspathshape, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -21312,7 +29523,25 @@ public void pushBack(string tspathshape, TransformF transform, float speed = 1. m_ts.fnTSPathShape_pushBack(tspathshape, transform.AsString(), speed, type, path); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the front of its path %pathShape.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the front of its path +/// %pathShape.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void pushFront(string tspathshape, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -21320,7 +29549,13 @@ public void pushFront(string tspathshape, TransformF transform, float speed = 1 m_ts.fnTSPathShape_pushFront(tspathshape, transform.AsString(), speed, type, path); } /// -/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. When makeFirstKnot is true a new knot is created and pushed onto the path. @param speed Speed for the first knot if created. @param makeFirstKnot Initialize a new path with the current shape transform. @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. +/// The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. +/// When makeFirstKnot is true a new knot is created and pushed onto the path. +/// @param speed Speed for the first knot if created. +/// @param makeFirstKnot Initialize a new path with the current shape transform. +/// @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// /// public void reset(string tspathshape, float speed = 1.0f, bool makeFirstKnot = true, bool initFromPath = true){ @@ -21328,7 +29563,9 @@ public void reset(string tspathshape, float speed = 1.0f, bool makeFirstKnot = m_ts.fnTSPathShape_reset(tspathshape, speed, makeFirstKnot, initFromPath); } /// -/// Sets whether the path should loop or stop at the last node. @param isLooping New loop flag true/false.) +/// Sets whether the path should loop or stop at the last node. +/// @param isLooping New loop flag true/false.) +/// /// public void setLooping(string tspathshape, bool isLooping = true){ @@ -21336,7 +29573,9 @@ public void setLooping(string tspathshape, bool isLooping = true){ m_ts.fnTSPathShape_setLooping(tspathshape, isLooping); } /// -/// Set the movement state for this shape. @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// Set the movement state for this shape. +/// @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// /// public void setMoveState(string tspathshape, TypePathShapeState newState = null ){ if (newState== null) {newState = TypePathShapeState.Forward;} @@ -21345,7 +29584,9 @@ public void setMoveState(string tspathshape, TypePathShapeState newState = null m_ts.fnTSPathShape_setMoveState(tspathshape, (int)newState ); } /// -/// Set the current position of the shape along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// Set the current position of the shape along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// /// public void setPathPosition(string tspathshape, float position = 0.0f){ @@ -21353,7 +29594,13 @@ public void setPathPosition(string tspathshape, float position = 0.0f){ m_ts.fnTSPathShape_setPathPosition(tspathshape, position); } /// -/// @brief Set the movement target for this shape along its path. The shape will attempt to move along the path to the given target without going past the loop node. Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target state will be cleared. @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the shape to move to along its path.) +/// @brief Set the movement target for this shape along its path. +/// The shape will attempt to move along the path to the given target without going past the loop node. +/// Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target +/// state will be cleared. +/// @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the +/// shape to move to along its path.) +/// /// public void setTarget(string tspathshape, float position = 1.0f){ @@ -21366,14 +29613,33 @@ public void setTarget(string tspathshape, float position = 1.0f){ /// public class TSShapeConstructorObject { -private Omni m_ts; - /// - /// - /// - /// -public TSShapeConstructorObject(ref Omni ts){m_ts = ts;} /// -/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls may optionally be converted to boxes, spheres and/or capsules based on their volume. @param size size for this detail level @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, 26-dop, convex hulls. See the Shape Editor documentation for more details about these types. @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the whole shape), or the name of an object in the shape @param depth maximum split recursion depth (hulls only) @param merge volume % threshold used to merge hulls together (hulls only) @param concavity volume % threshold used to detect concavity (hulls only) @param maxVerts maximum number of vertices per hull (hulls only) @param boxMaxError max % volume difference for a hull to be converted to a box (hulls only) @param sphereMaxError max % volume difference for a hull to be converted to a sphere (hulls only) @param capsuleMaxError max % volume difference for a hull to be converted to a capsule (hulls only) @return true if successful, false otherwise @tsexample %this.addCollisionDetail( -1, \"box\", \"bounds\" ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); @endtsexample ) +/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls +/// may optionally be converted to boxes, spheres and/or capsules based on their +/// volume. +/// @param size size for this detail level +/// @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, +/// 26-dop, convex hulls. See the Shape Editor documentation for more details +/// about these types. +/// @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the +/// whole shape), or the name of an object in the shape +/// @param depth maximum split recursion depth (hulls only) +/// @param merge volume % threshold used to merge hulls together (hulls only) +/// @param concavity volume % threshold used to detect concavity (hulls only) +/// @param maxVerts maximum number of vertices per hull (hulls only) +/// @param boxMaxError max % volume difference for a hull to be converted to a +/// box (hulls only) +/// @param sphereMaxError max % volume difference for a hull to be converted to +/// a sphere (hulls only) +/// @param capsuleMaxError max % volume difference for a hull to be converted to +/// a capsule (hulls only) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addCollisionDetail( -1, \"box\", \"bounds\" ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); +/// @endtsexample ) +/// /// public bool addCollisionDetail(string tsshapeconstructor, int size, string type, string target, int depth = 4, float merge = 30, float concavity = 30, int maxVerts = 32, float boxMaxError = 0, float sphereMaxError = 0, float capsuleMaxError = 0){ @@ -21381,7 +29647,35 @@ public bool addCollisionDetail(string tsshapeconstructor, int size, string type return m_ts.fnTSShapeConstructor_addCollisionDetail(tsshapeconstructor, size, type, target, depth, merge, concavity, maxVerts, boxMaxError, sphereMaxError, capsuleMaxError); } /// -/// Add (or edit) an imposter detail level to the shape. If the shape already contains an imposter detail level, this command will simply change the imposter settings @param size size of the imposter detail level @param equatorSteps defines the number of snapshots to take around the equator. Imagine the object being rotated around the vertical axis, then a snapshot taken at regularly spaced intervals. @param polarSteps defines the number of snapshots taken between the poles (top and bottom), at each equator step. eg. At each equator snapshot, snapshots are taken at regular intervals between the poles. @param dl the detail level to use when generating the snapshots. Note that this is an array index rather than a detail size. So if an object has detail sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots using detail size 150. @param dim defines the size of the imposter images in pixels. The larger the number, the more detailed the billboard will be. @param includePoles flag indicating whether to include the \"pole\" snapshots. ie. the views from the top and bottom of the object. @param polar_angle if pole snapshots are active (@a includePoles is true), this parameter defines the camera angle (in degrees) within which to render the pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot taken at the pole (looking directly down or up at the object) will be rendered when the camera is within 25 degrees of the pole. @return true if successful, false otherwise @tsexample %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level @endtsexample ) +/// Add (or edit) an imposter detail level to the shape. +/// If the shape already contains an imposter detail level, this command will +/// simply change the imposter settings +/// @param size size of the imposter detail level +/// @param equatorSteps defines the number of snapshots to take around the +/// equator. Imagine the object being rotated around the vertical axis, then +/// a snapshot taken at regularly spaced intervals. +/// @param polarSteps defines the number of snapshots taken between the poles +/// (top and bottom), at each equator step. eg. At each equator snapshot, +/// snapshots are taken at regular intervals between the poles. +/// @param dl the detail level to use when generating the snapshots. Note that +/// this is an array index rather than a detail size. So if an object has detail +/// sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots +/// using detail size 150. +/// @param dim defines the size of the imposter images in pixels. The larger the +/// number, the more detailed the billboard will be. +/// @param includePoles flag indicating whether to include the \"pole\" snapshots. +/// ie. the views from the top and bottom of the object. +/// @param polar_angle if pole snapshots are active (@a includePoles is true), this +/// parameter defines the camera angle (in degrees) within which to render the +/// pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot +/// taken at the pole (looking directly down or up at the object) will be rendered +/// when the camera is within 25 degrees of the pole. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); +/// %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level +/// @endtsexample ) +/// /// public int addImposter(string tsshapeconstructor, int size, int equatorSteps, int polarSteps, int dl, int dim, bool includePoles, float polarAngle){ @@ -21389,7 +29683,21 @@ public int addImposter(string tsshapeconstructor, int size, int equatorSteps, i return m_ts.fnTSShapeConstructor_addImposter(tsshapeconstructor, size, equatorSteps, polarSteps, dl, dim, includePoles, polarAngle); } /// -/// Add geometry from another DTS or DAE shape file into this shape. Any materials required by the source mesh are also copied into this shape.br> @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param srcShape name of a shape file (DTS or DAE) that contains the mesh @param srcMesh the full name (object name + detail size) of the mesh to copy from the DTS/DAE file into this shape/li> @return true if successful, false otherwise @tsexample %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); @endtsexample ) +/// Add geometry from another DTS or DAE shape file into this shape. +/// Any materials required by the source mesh are also copied into this shape.br> +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param srcShape name of a shape file (DTS or DAE) that contains the mesh +/// @param srcMesh the full name (object name + detail size) of the mesh to +/// copy from the DTS/DAE file into this shape/li> +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); +/// %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); +/// @endtsexample ) +/// /// public bool addMesh(string tsshapeconstructor, string meshName, string srcShape, string srcMesh){ @@ -21397,7 +29705,21 @@ public bool addMesh(string tsshapeconstructor, string meshName, string srcShape return m_ts.fnTSShapeConstructor_addMesh(tsshapeconstructor, meshName, srcShape, srcMesh); } /// -/// Add a new node. @param name name for the new node (must not already exist) @param parentName name of an existing node to be the parent of the new node. If empty (\"\"), the new node will be at the root level of the node hierarchy. @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); @endtsexample ) +/// Add a new node. +/// @param name name for the new node (must not already exist) +/// @param parentName name of an existing node to be the parent of the new node. +/// If empty (\"\"), the new node will be at the root level of the node hierarchy. +/// @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); +/// %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); +/// %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool addNode(string tsshapeconstructor, string name, string parentName, TransformF txfm = null , bool isWorld = false){ if (txfm== null) {txfm = new TransformF(0,0,0,0,0,1,0);} @@ -21406,7 +29728,29 @@ public bool addNode(string tsshapeconstructor, string name, string parentName, return m_ts.fnTSShapeConstructor_addNode(tsshapeconstructor, name, parentName, txfm.AsString(), isWorld); } /// -/// Add a new mesh primitive to the shape. @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param type one of: \"box\", \"sphere\", \"capsule\" @param params mesh primitive parameters: ul> li>for box: \"size_x size_y size_z\"/li> li>for sphere: \"radius\"/li> li>for capsule: \"height radius\"/li> /ul> /ul> @param txfm local transform offset from the node for this mesh @param nodeName name of the node to attach the new mesh to (will change the object's node if adding a new mesh to an existing object) @return true if successful, false otherwise @tsexample %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); @endtsexample ) +/// Add a new mesh primitive to the shape. +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param type one of: \"box\", \"sphere\", \"capsule\" +/// @param params mesh primitive parameters: +/// ul> +/// li>for box: \"size_x size_y size_z\"/li> +/// li>for sphere: \"radius\"/li> +/// li>for capsule: \"height radius\"/li> +/// /ul> +/// /ul> +/// @param txfm local transform offset from the node for this mesh +/// @param nodeName name of the node to attach the new mesh to (will change the +/// object's node if adding a new mesh to an existing object) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); +/// %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); +/// %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); +/// @endtsexample ) +/// /// public bool addPrimitive(string tsshapeconstructor, string meshName, string type, string paramsx, TransformF txfm, string nodeName){ @@ -21414,7 +29758,34 @@ public bool addPrimitive(string tsshapeconstructor, string meshName, string typ return m_ts.fnTSShapeConstructor_addPrimitive(tsshapeconstructor, meshName, type, paramsx, txfm.AsString(), nodeName); } /// -/// Add a new sequence to the shape. @param source the name of an existing sequence, or the name of a DTS or DAE shape or DSQ sequence file. When the shape file contains more than one sequence, the desired sequence can be specified by appending the name to the end of the shape file. eg. \"myShape.dts run\" would select the \"run\" sequence from the \"myShape.dts\" file. @param name name of the new sequence @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose rotation to the target shape root pose. @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose position to the target shape root pose. @return true if successful, false otherwise @tsexample %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); %this.addSequence( \"./myPlayer.dae run\", \"run\" ); %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end @endtsexample ) +/// Add a new sequence to the shape. +/// @param source the name of an existing sequence, or the name of a DTS or DAE +/// shape or DSQ sequence file. When the shape file contains more than one +/// sequence, the desired sequence can be specified by appending the name to the +/// end of the shape file. eg. \"myShape.dts run\" would select the \"run\" +/// sequence from the \"myShape.dts\" file. +/// @param name name of the new sequence +/// @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. +/// @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. +/// @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose rotation to the target shape root pose. +/// @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose position to the target shape root pose. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); +/// %this.addSequence( \"./myPlayer.dae run\", \"run\" ); +/// %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end +/// %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 +/// %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end +/// @endtsexample ) +/// /// public bool addSequence(string tsshapeconstructor, string source, string name, int start = 0, int end = -1, bool padRot = true, bool padTrans = false){ @@ -21422,7 +29793,16 @@ public bool addSequence(string tsshapeconstructor, string source, string name, return m_ts.fnTSShapeConstructor_addSequence(tsshapeconstructor, source, name, start, end, padRot, padTrans); } /// -/// Add a new trigger to the sequence. @param name name of the sequence to modify @param keyframe keyframe of the new trigger @param state of the new trigger @return true if successful, false otherwise @tsexample %this.addTrigger( \"walk\", 3, 1 ); %this.addTrigger( \"walk\", 5, -1 ); @endtsexample ) +/// Add a new trigger to the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the new trigger +/// @param state of the new trigger +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addTrigger( \"walk\", 3, 1 ); +/// %this.addTrigger( \"walk\", 5, -1 ); +/// @endtsexample ) +/// /// public bool addTrigger(string tsshapeconstructor, string name, int keyframe, int state){ @@ -21430,7 +29810,14 @@ public bool addTrigger(string tsshapeconstructor, string name, int keyframe, in return m_ts.fnTSShapeConstructor_addTrigger(tsshapeconstructor, name, keyframe, state); } /// -/// Dump the shape hierarchy to the console or to a file. Useful for reviewing the result of a series of construction commands. @param filename Destination filename. If not specified, dump to console. @tsexample %this.dumpShape(); // dump to console %this.dumpShape( \"./dump.txt\" ); // dump to file @endtsexample ) +/// Dump the shape hierarchy to the console or to a file. Useful for reviewing +/// the result of a series of construction commands. +/// @param filename Destination filename. If not specified, dump to console. +/// @tsexample +/// %this.dumpShape(); // dump to console +/// %this.dumpShape( \"./dump.txt\" ); // dump to file +/// @endtsexample ) +/// /// public void dumpShape(string tsshapeconstructor, string filename = ""){ @@ -21438,7 +29825,9 @@ public void dumpShape(string tsshapeconstructor, string filename = ""){ m_ts.fnTSShapeConstructor_dumpShape(tsshapeconstructor, filename); } /// -/// Get the bounding box for the shape. @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// Get the bounding box for the shape. +/// @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// /// public Box3F getBounds(string tsshapeconstructor){ @@ -21446,7 +29835,9 @@ public Box3F getBounds(string tsshapeconstructor){ return new Box3F ( m_ts.fnTSShapeConstructor_getBounds(tsshapeconstructor)); } /// -/// Get the total number of detail levels in the shape. @return the number of detail levels in the shape ) +/// Get the total number of detail levels in the shape. +/// @return the number of detail levels in the shape ) +/// /// public int getDetailLevelCount(string tsshapeconstructor){ @@ -21454,7 +29845,15 @@ public int getDetailLevelCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getDetailLevelCount(tsshapeconstructor); } /// -/// Get the index of the detail level with a given size. @param size size of the detail level to lookup @return index of the detail level with the desired size, or -1 if no such detail exists @tsexample if ( %this.getDetailLevelSize( 32 ) == -1 ) echo( \"Error: This shape does not have a detail level at size 32\" ); @endtsexample ) +/// Get the index of the detail level with a given size. +/// @param size size of the detail level to lookup +/// @return index of the detail level with the desired size, or -1 if no such +/// detail exists +/// @tsexample +/// if ( %this.getDetailLevelSize( 32 ) == -1 ) +/// echo( \"Error: This shape does not have a detail level at size 32\" ); +/// @endtsexample ) +/// /// public int getDetailLevelIndex(string tsshapeconstructor, int size){ @@ -21462,7 +29861,16 @@ public int getDetailLevelIndex(string tsshapeconstructor, int size){ return m_ts.fnTSShapeConstructor_getDetailLevelIndex(tsshapeconstructor, size); } /// -/// Get the name of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level name @tsexample // print the names of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getDetailLevelName( %i ) ); @endtsexample ) +/// Get the name of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level name +/// @tsexample +/// // print the names of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getDetailLevelName( %i ) ); +/// @endtsexample ) +/// /// public string getDetailLevelName(string tsshapeconstructor, int index){ @@ -21470,7 +29878,16 @@ public string getDetailLevelName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getDetailLevelName(tsshapeconstructor, index); } /// -/// Get the size of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level size @tsexample // print the sizes of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); @endtsexample ) +/// Get the size of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level size +/// @tsexample +/// // print the sizes of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); +/// @endtsexample ) +/// /// public int getDetailLevelSize(string tsshapeconstructor, int index){ @@ -21478,7 +29895,10 @@ public int getDetailLevelSize(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getDetailLevelSize(tsshapeconstructor, index); } /// -/// Get the index of the imposter (auto-billboard) detail level (if any). @return imposter detail level index, or -1 if the shape does not use imposters. ) +/// Get the index of the imposter (auto-billboard) detail level (if any). +/// @return imposter detail level index, or -1 if the shape does not use +/// imposters. ) +/// /// public int getImposterDetailLevel(string tsshapeconstructor){ @@ -21486,7 +29906,26 @@ public int getImposterDetailLevel(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getImposterDetailLevel(tsshapeconstructor); } /// -/// Get the settings used to generate imposters for the indexed detail level. @param index index of the detail level to query (does not need to be an imposter detail level @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: dl> dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> dt>eqSteps/dt>dd>number of steps around the equator/dd> dt>pSteps/dt>dd>number of steps between the poles/dd> dt>dl/dt>dd>index of the detail level used to generate imposters/dd> dt>dim/dt>dd>size (in pixels) of each imposter image/dd> dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> dt>angle/dt>dd>angle at which to display pole images/dd> /dl> @tsexample // print the imposter detail level settings %index = %this.getImposterDetailLevel(); if ( %index != -1 ) echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); @endtsexample ) +/// Get the settings used to generate imposters for the indexed detail level. +/// @param index index of the detail level to query (does not need to be an +/// imposter detail level +/// @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: +/// dl> +/// dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> +/// dt>eqSteps/dt>dd>number of steps around the equator/dd> +/// dt>pSteps/dt>dd>number of steps between the poles/dd> +/// dt>dl/dt>dd>index of the detail level used to generate imposters/dd> +/// dt>dim/dt>dd>size (in pixels) of each imposter image/dd> +/// dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> +/// dt>angle/dt>dd>angle at which to display pole images/dd> +/// /dl> +/// @tsexample +/// // print the imposter detail level settings +/// %index = %this.getImposterDetailLevel(); +/// if ( %index != -1 ) +/// echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); +/// @endtsexample ) +/// /// public string getImposterSettings(string tsshapeconstructor, int index){ @@ -21494,7 +29933,13 @@ public string getImposterSettings(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getImposterSettings(tsshapeconstructor, index); } /// -/// Get the number of meshes (detail levels) for the specified object. @param name name of the object to query @return the number of meshes for this object. @tsexample %count = %this.getMeshCount( \"SimpleShape\" ); @endtsexample ) +/// Get the number of meshes (detail levels) for the specified object. +/// @param name name of the object to query +/// @return the number of meshes for this object. +/// @tsexample +/// %count = %this.getMeshCount( \"SimpleShape\" ); +/// @endtsexample ) +/// /// public int getMeshCount(string tsshapeconstructor, string name){ @@ -21502,7 +29947,14 @@ public int getMeshCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getMeshCount(tsshapeconstructor, name); } /// -/// Get the name of the material attached to a mesh. Note that only the first material used by the mesh is returned. @param name full name (object name + detail size) of the mesh to query @return name of the material attached to the mesh (suitable for use with the Material mapTo field) @tsexample echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the name of the material attached to a mesh. Note that only the first +/// material used by the mesh is returned. +/// @param name full name (object name + detail size) of the mesh to query +/// @return name of the material attached to the mesh (suitable for use with the Material mapTo field) +/// @tsexample +/// echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string getMeshMaterial(string tsshapeconstructor, string name){ @@ -21510,7 +29962,22 @@ public string getMeshMaterial(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getMeshMaterial(tsshapeconstructor, name); } /// -/// Get the name of the indexed mesh (detail level) for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh name. @tsexample // print the names of all meshes in the shape %objCount = %this.getObjectCount(); for ( %i = 0; %i %objCount; %i++ ) { %objName = %this.getObjectName( %i ); %meshCount = %this.getMeshCount( %objName ); for ( %j = 0; %j %meshCount; %j++ ) echo( %this.getMeshName( %objName, %j ) ); } @endtsexample ) +/// Get the name of the indexed mesh (detail level) for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh name. +/// @tsexample +/// // print the names of all meshes in the shape +/// %objCount = %this.getObjectCount(); +/// for ( %i = 0; %i %objCount; %i++ ) +/// { +/// %objName = %this.getObjectName( %i ); +/// %meshCount = %this.getMeshCount( %objName ); +/// for ( %j = 0; %j %meshCount; %j++ ) +/// echo( %this.getMeshName( %objName, %j ) ); +/// } +/// @endtsexample ) +/// /// public string getMeshName(string tsshapeconstructor, string name, int index){ @@ -21518,7 +29985,18 @@ public string getMeshName(string tsshapeconstructor, string name, int index){ return m_ts.fnTSShapeConstructor_getMeshName(tsshapeconstructor, name, index); } /// -/// Get the detail level size of the indexed mesh for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh detail level size. @tsexample // print sizes for all detail levels of this object %objName = \"trunk\"; %count = %this.getMeshCount( %objName ); for ( %i = 0; %i %count; %i++ ) echo( %this.getMeshSize( %objName, %i ) ); @endtsexample ) +/// Get the detail level size of the indexed mesh for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh detail level size. +/// @tsexample +/// // print sizes for all detail levels of this object +/// %objName = \"trunk\"; +/// %count = %this.getMeshCount( %objName ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getMeshSize( %objName, %i ) ); +/// @endtsexample ) +/// /// public int getMeshSize(string tsshapeconstructor, string name, int index){ @@ -21526,7 +30004,16 @@ public int getMeshSize(string tsshapeconstructor, string name, int index){ return m_ts.fnTSShapeConstructor_getMeshSize(tsshapeconstructor, name, index); } /// -/// Get the display type of the mesh. @param name name of the mesh to query @return the string returned is one of: dl>dt>normal/dt>dd>a normal 3D mesh/dd> dt>billboard/dt>dd>a mesh that always faces the camera/dd> dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> @tsexample echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the display type of the mesh. +/// @param name name of the mesh to query +/// @return the string returned is one of: +/// dl>dt>normal/dt>dd>a normal 3D mesh/dd> +/// dt>billboard/dt>dd>a mesh that always faces the camera/dd> +/// dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> +/// @tsexample +/// echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string getMeshType(string tsshapeconstructor, string name){ @@ -21534,7 +30021,13 @@ public string getMeshType(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getMeshType(tsshapeconstructor, name); } /// -/// Get the number of children of this node. @param name name of the node to query. @return the number of child nodes. @tsexample %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the number of children of this node. +/// @param name name of the node to query. +/// @return the number of child nodes. +/// @tsexample +/// %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int getNodeChildCount(string tsshapeconstructor, string name){ @@ -21542,7 +30035,32 @@ public int getNodeChildCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeChildCount(tsshapeconstructor, name); } /// -/// Get the name of the indexed child node. @param name name of the parent node to query. @param index index of the child node (valid range is 0 - getNodeChildName()-1). @return the name of the indexed child node. @tsexample function dumpNode( %shape, %name, %indent ) { echo( %indent @ %name ); %count = %shape.getNodeChildCount( %name ); for ( %i = 0; %i %count; %i++ ) dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); } function dumpShape( %shape ) { // recursively dump node hierarchy %count = %shape.getNodeCount(); for ( %i = 0; %i %count; %i++ ) { // dump top level nodes %name = %shape.getNodeName( %i ); if ( %shape.getNodeParentName( %name ) $= ) dumpNode( %shape, %name, \"\" ); } } @endtsexample ) +/// Get the name of the indexed child node. +/// @param name name of the parent node to query. +/// @param index index of the child node (valid range is 0 - getNodeChildName()-1). +/// @return the name of the indexed child node. +/// @tsexample +/// function dumpNode( %shape, %name, %indent ) +/// { +/// echo( %indent @ %name ); +/// %count = %shape.getNodeChildCount( %name ); +/// for ( %i = 0; %i %count; %i++ ) +/// dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); +/// } +/// function dumpShape( %shape ) +/// { +/// // recursively dump node hierarchy +/// %count = %shape.getNodeCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// { +/// // dump top level nodes +/// %name = %shape.getNodeName( %i ); +/// if ( %shape.getNodeParentName( %name ) $= ) +/// dumpNode( %shape, %name, \"\" ); +/// } +/// } +/// @endtsexample ) +/// /// public string getNodeChildName(string tsshapeconstructor, string name, int index){ @@ -21550,7 +30068,12 @@ public string getNodeChildName(string tsshapeconstructor, string name, int inde return m_ts.fnTSShapeConstructor_getNodeChildName(tsshapeconstructor, name, index); } /// -/// Get the total number of nodes in the shape. @return the number of nodes in the shape. @tsexample %count = %this.getNodeCount(); @endtsexample ) +/// Get the total number of nodes in the shape. +/// @return the number of nodes in the shape. +/// @tsexample +/// %count = %this.getNodeCount(); +/// @endtsexample ) +/// /// public int getNodeCount(string tsshapeconstructor){ @@ -21558,7 +30081,14 @@ public int getNodeCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getNodeCount(tsshapeconstructor); } /// -/// Get the index of the node. @param name name of the node to lookup. @return the index of the named node, or -1 if no such node exists. @tsexample // get the index of Bip01 Pelvis node in the shape %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the index of the node. +/// @param name name of the node to lookup. +/// @return the index of the named node, or -1 if no such node exists. +/// @tsexample +/// // get the index of Bip01 Pelvis node in the shape +/// %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int getNodeIndex(string tsshapeconstructor, string name){ @@ -21566,7 +30096,16 @@ public int getNodeIndex(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeIndex(tsshapeconstructor, name); } /// -/// Get the name of the indexed node. @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). @return the name of the indexed node, or \"\" if no such node exists. @tsexample // print the names of all the nodes in the shape %count = %this.getNodeCount(); for (%i = 0; %i %count; %i++) echo(%i SPC %this.getNodeName(%i)); @endtsexample ) +/// Get the name of the indexed node. +/// @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). +/// @return the name of the indexed node, or \"\" if no such node exists. +/// @tsexample +/// // print the names of all the nodes in the shape +/// %count = %this.getNodeCount(); +/// for (%i = 0; %i %count; %i++) +/// echo(%i SPC %this.getNodeName(%i)); +/// @endtsexample ) +/// /// public string getNodeName(string tsshapeconstructor, int index){ @@ -21574,7 +30113,13 @@ public string getNodeName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getNodeName(tsshapeconstructor, index); } /// -/// Get the number of geometry objects attached to this node. @param name name of the node to query. @return the number of attached objects. @tsexample %count = %this.getNodeObjectCount( \"Bip01 Head\" ); @endtsexample ) +/// Get the number of geometry objects attached to this node. +/// @param name name of the node to query. +/// @return the number of attached objects. +/// @tsexample +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// @endtsexample ) +/// /// public int getNodeObjectCount(string tsshapeconstructor, string name){ @@ -21582,7 +30127,17 @@ public int getNodeObjectCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeObjectCount(tsshapeconstructor, name); } /// -/// Get the name of the indexed object. @param name name of the node to query. @param index index of the object (valid range is 0 - getNodeObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects attached to the node %count = %this.getNodeObjectCount( \"Bip01 Head\" ); for ( %i = 0; %i %count; %i++ ) echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param name name of the node to query. +/// @param index index of the object (valid range is 0 - getNodeObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects attached to the node +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); +/// @endtsexample ) +/// /// public string getNodeObjectName(string tsshapeconstructor, string name, int index){ @@ -21590,7 +30145,14 @@ public string getNodeObjectName(string tsshapeconstructor, string name, int ind return m_ts.fnTSShapeConstructor_getNodeObjectName(tsshapeconstructor, name, index); } /// -/// Get the name of the node's parent. If the node has no parent (ie. it is at the root level), return an empty string. @param name name of the node to query. @return the name of the node's parent, or \"\" if the node is at the root level @tsexample echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); @endtsexample ) +/// Get the name of the node's parent. If the node has no parent (ie. it is at +/// the root level), return an empty string. +/// @param name name of the node to query. +/// @return the name of the node's parent, or \"\" if the node is at the root level +/// @tsexample +/// echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); +/// @endtsexample ) +/// /// public string getNodeParentName(string tsshapeconstructor, string name){ @@ -21598,7 +30160,16 @@ public string getNodeParentName(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeParentName(tsshapeconstructor, name); } /// -/// Get the base (ie. not animated) transform of a node. @param name name of the node to query. @param isWorld true to get the global transform, false (or omitted) to get the local-to-parent transform. @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". @tsexample %ret = %this.getNodeTransform( \"mount0\" ); %this.setNodeTransform( \"mount4\", %ret ); @endtsexample ) +/// Get the base (ie. not animated) transform of a node. +/// @param name name of the node to query. +/// @param isWorld true to get the global transform, false (or omitted) to get +/// the local-to-parent transform. +/// @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". +/// @tsexample +/// %ret = %this.getNodeTransform( \"mount0\" ); +/// %this.setNodeTransform( \"mount4\", %ret ); +/// @endtsexample ) +/// /// public TransformF getNodeTransform(string tsshapeconstructor, string name, bool isWorld = false){ @@ -21606,7 +30177,12 @@ public TransformF getNodeTransform(string tsshapeconstructor, string name, bool return new TransformF ( m_ts.fnTSShapeConstructor_getNodeTransform(tsshapeconstructor, name, isWorld)); } /// -/// Get the total number of objects in the shape. @return the number of objects in the shape. @tsexample %count = %this.getObjectCount(); @endtsexample ) +/// Get the total number of objects in the shape. +/// @return the number of objects in the shape. +/// @tsexample +/// %count = %this.getObjectCount(); +/// @endtsexample ) +/// /// public int getObjectCount(string tsshapeconstructor){ @@ -21614,7 +30190,13 @@ public int getObjectCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getObjectCount(tsshapeconstructor); } /// -/// Get the index of the first object with the given name. @param name name of the object to get. @return the index of the named object. @tsexample %index = %this.getObjectIndex( \"Head\" ); @endtsexample ) +/// Get the index of the first object with the given name. +/// @param name name of the object to get. +/// @return the index of the named object. +/// @tsexample +/// %index = %this.getObjectIndex( \"Head\" ); +/// @endtsexample ) +/// /// public int getObjectIndex(string tsshapeconstructor, string name){ @@ -21622,7 +30204,16 @@ public int getObjectIndex(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getObjectIndex(tsshapeconstructor, name); } /// -/// Get the name of the indexed object. @param index index of the object to get (valid range is 0 - getObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects in the shape %count = %this.getObjectCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getObjectName( %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param index index of the object to get (valid range is 0 - getObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getObjectName( %i ) ); +/// @endtsexample ) +/// /// public string getObjectName(string tsshapeconstructor, int index){ @@ -21630,7 +30221,14 @@ public string getObjectName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getObjectName(tsshapeconstructor, index); } /// -/// Get the name of the node this object is attached to. @param name name of the object to get. @return the name of the attached node, or an empty string if this object is not attached to a node (usually the case for skinned meshes). @tsexample echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); @endtsexample ) +/// Get the name of the node this object is attached to. +/// @param name name of the object to get. +/// @return the name of the attached node, or an empty string if this +/// object is not attached to a node (usually the case for skinned meshes). +/// @tsexample +/// echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); +/// @endtsexample ) +/// /// public string getObjectNode(string tsshapeconstructor, string name){ @@ -21638,7 +30236,24 @@ public string getObjectNode(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getObjectNode(tsshapeconstructor, name); } /// -/// Get information about blended sequences. @param name name of the sequence to query @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: dl> dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference frame (empty for blend sequences embedded in DTS files)/dd> dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences embedded in DTS files)/dd> /dl> @note Note that only sequences set to be blends using the setSequenceBlend command will contain the blendSeq and blendFrame information. @tsexample %blendData = %this.getSequenceBlend( \"look\" ); if ( getField( %blendData, 0 ) ) echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); @endtsexample ) +/// Get information about blended sequences. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: +/// dl> +/// dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> +/// dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference +/// frame (empty for blend sequences embedded in DTS files)/dd> +/// dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences +/// embedded in DTS files)/dd> +/// /dl> +/// @note Note that only sequences set to be blends using the setSequenceBlend +/// command will contain the blendSeq and blendFrame information. +/// @tsexample +/// %blendData = %this.getSequenceBlend( \"look\" ); +/// if ( getField( %blendData, 0 ) ) +/// echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); +/// @endtsexample ) +/// /// public string getSequenceBlend(string tsshapeconstructor, string name){ @@ -21646,7 +30261,9 @@ public string getSequenceBlend(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceBlend(tsshapeconstructor, name); } /// -/// Get the total number of sequences in the shape. @return the number of sequences in the shape ) +/// Get the total number of sequences in the shape. +/// @return the number of sequences in the shape ) +/// /// public int getSequenceCount(string tsshapeconstructor){ @@ -21654,7 +30271,14 @@ public int getSequenceCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getSequenceCount(tsshapeconstructor); } /// -/// Check if this sequence is cyclic (looping). @param name name of the sequence to query @return true if this sequence is cyclic, false if not @tsexample if ( !%this.getSequenceCyclic( \"ambient\" ) ) error( \"ambient sequence is not cyclic!\" ); @endtsexample ) +/// Check if this sequence is cyclic (looping). +/// @param name name of the sequence to query +/// @return true if this sequence is cyclic, false if not +/// @tsexample +/// if ( !%this.getSequenceCyclic( \"ambient\" ) ) +/// error( \"ambient sequence is not cyclic!\" ); +/// @endtsexample ) +/// /// public bool getSequenceCyclic(string tsshapeconstructor, string name){ @@ -21662,7 +30286,13 @@ public bool getSequenceCyclic(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceCyclic(tsshapeconstructor, name); } /// -/// Get the number of keyframes in the sequence. @param name name of the sequence to query @return number of keyframes in the sequence @tsexample echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); @endtsexample ) +/// Get the number of keyframes in the sequence. +/// @param name name of the sequence to query +/// @return number of keyframes in the sequence +/// @tsexample +/// echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); +/// @endtsexample ) +/// /// public int getSequenceFrameCount(string tsshapeconstructor, string name){ @@ -21670,7 +30300,16 @@ public int getSequenceFrameCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceFrameCount(tsshapeconstructor, name); } /// -/// Get the ground speed of the sequence. @note Note that only the first 2 ground frames of the sequence are examined; the speed is assumed to be constant throughout the sequence. @param name name of the sequence to query @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" @tsexample %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); echo( \"Run moves at \" @ %speed @ \" units per frame\" ); @endtsexample ) +/// Get the ground speed of the sequence. +/// @note Note that only the first 2 ground frames of the sequence are +/// examined; the speed is assumed to be constant throughout the sequence. +/// @param name name of the sequence to query +/// @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" +/// @tsexample +/// %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); +/// echo( \"Run moves at \" @ %speed @ \" units per frame\" ); +/// @endtsexample ) +/// /// public string getSequenceGroundSpeed(string tsshapeconstructor, string name){ @@ -21678,7 +30317,15 @@ public string getSequenceGroundSpeed(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceGroundSpeed(tsshapeconstructor, name); } /// -/// Find the index of the sequence with the given name. @param name name of the sequence to lookup @return index of the sequence with matching name, or -1 if not found @tsexample // Check if a given sequence exists in the shape if ( %this.getSequenceIndex( \"walk\" ) == -1 ) echo( \"Could not find 'walk' sequence\" ); @endtsexample ) +/// Find the index of the sequence with the given name. +/// @param name name of the sequence to lookup +/// @return index of the sequence with matching name, or -1 if not found +/// @tsexample +/// // Check if a given sequence exists in the shape +/// if ( %this.getSequenceIndex( \"walk\" ) == -1 ) +/// echo( \"Could not find 'walk' sequence\" ); +/// @endtsexample ) +/// /// public int getSequenceIndex(string tsshapeconstructor, string name){ @@ -21686,7 +30333,16 @@ public int getSequenceIndex(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceIndex(tsshapeconstructor, name); } /// -/// Get the name of the indexed sequence. @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) @return the name of the sequence @tsexample // print the name of all sequences in the shape %count = %this.getSequenceCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getSequenceName( %i ) ); @endtsexample ) +/// Get the name of the indexed sequence. +/// @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) +/// @return the name of the sequence +/// @tsexample +/// // print the name of all sequences in the shape +/// %count = %this.getSequenceCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getSequenceName( %i ) ); +/// @endtsexample ) +/// /// public string getSequenceName(string tsshapeconstructor, int index){ @@ -21694,7 +30350,10 @@ public string getSequenceName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getSequenceName(tsshapeconstructor, index); } /// -/// Get the priority setting of the sequence. @param name name of the sequence to query @return priority value of the sequence ) +/// Get the priority setting of the sequence. +/// @param name name of the sequence to query +/// @return priority value of the sequence ) +/// /// public float getSequencePriority(string tsshapeconstructor, string name){ @@ -21702,7 +30361,24 @@ public float getSequencePriority(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequencePriority(tsshapeconstructor, name); } /// -/// Get information about where the sequence data came from. For example, whether it was loaded from an external DSQ file. @param name name of the sequence to query @return TAB delimited string of the form: \"from reserved start end total\", where: dl> dt>from/dt>dd>the source of the animation data, such as the path to a DSQ file, or the name of an existing sequence in the shape. This field will be empty for sequences already embedded in the DTS or DAE file./dd> dt>reserved/dt>dd>reserved value/dd> dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> dt>total/dt>dd>the total number of frames in the source sequence/dd> /dl> @tsexample // print the source for the walk animation echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); @endtsexample ) +/// Get information about where the sequence data came from. +/// For example, whether it was loaded from an external DSQ file. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"from reserved start end total\", where: +/// dl> +/// dt>from/dt>dd>the source of the animation data, such as the path to +/// a DSQ file, or the name of an existing sequence in the shape. This field +/// will be empty for sequences already embedded in the DTS or DAE file./dd> +/// dt>reserved/dt>dd>reserved value/dd> +/// dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> +/// dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> +/// dt>total/dt>dd>the total number of frames in the source sequence/dd> +/// /dl> +/// @tsexample +/// // print the source for the walk animation +/// echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); +/// @endtsexample ) +/// /// public string getSequenceSource(string tsshapeconstructor, string name){ @@ -21710,7 +30386,12 @@ public string getSequenceSource(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceSource(tsshapeconstructor, name); } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @tsexample %count = %this.getTargetCount(); @endtsexample ) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @tsexample +/// %count = %this.getTargetCount(); +/// @endtsexample ) +/// /// public int getTargetCount(string tsshapeconstructor){ @@ -21718,7 +30399,15 @@ public int getTargetCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getTargetCount(tsshapeconstructor); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @tsexample %count = %this.getTargetCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); @endtsexample ) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @tsexample +/// %count = %this.getTargetCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); +/// @endtsexample ) +/// /// public string getTargetName(string tsshapeconstructor, int index){ @@ -21726,7 +30415,17 @@ public string getTargetName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getTargetName(tsshapeconstructor, index); } /// -/// Get information about the indexed trigger @param name name of the sequence to query @param index index of the trigger (valid range is 0 - getTriggerCount()-1) @return string of the form \"frame state\" @tsexample // print all triggers in the sequence %count = %this.getTriggerCount( \"back\" ); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getTrigger( \"back\", %i ) ); @endtsexample ) +/// Get information about the indexed trigger +/// @param name name of the sequence to query +/// @param index index of the trigger (valid range is 0 - getTriggerCount()-1) +/// @return string of the form \"frame state\" +/// @tsexample +/// // print all triggers in the sequence +/// %count = %this.getTriggerCount( \"back\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getTrigger( \"back\", %i ) ); +/// @endtsexample ) +/// /// public string getTrigger(string tsshapeconstructor, string name, int index){ @@ -21734,7 +30433,10 @@ public string getTrigger(string tsshapeconstructor, string name, int index){ return m_ts.fnTSShapeConstructor_getTrigger(tsshapeconstructor, name, index); } /// -/// Get the number of triggers in the specified sequence. @param name name of the sequence to query @return number of triggers in the sequence ) +/// Get the number of triggers in the specified sequence. +/// @param name name of the sequence to query +/// @return number of triggers in the sequence ) +/// /// public int getTriggerCount(string tsshapeconstructor, string name){ @@ -21742,7 +30444,9 @@ public int getTriggerCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getTriggerCount(tsshapeconstructor, name); } /// -/// Notify game objects that this shape file has changed, allowing them to update internal data if needed. ) +/// Notify game objects that this shape file has changed, allowing them to update +/// internal data if needed. ) +/// /// public void notifyShapeChanged(string tsshapeconstructor){ @@ -21750,7 +30454,13 @@ public void notifyShapeChanged(string tsshapeconstructor){ m_ts.fnTSShapeConstructor_notifyShapeChanged(tsshapeconstructor); } /// -/// Remove the detail level (including all meshes in the detail level) @param size size of the detail level to remove @return true if successful, false otherwise @tsexample %this.removeDetailLevel( 2 ); @endtsexample ) +/// Remove the detail level (including all meshes in the detail level) +/// @param size size of the detail level to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeDetailLevel( 2 ); +/// @endtsexample ) +/// /// public bool removeDetailLevel(string tsshapeconstructor, int index){ @@ -21758,7 +30468,9 @@ public bool removeDetailLevel(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_removeDetailLevel(tsshapeconstructor, index); } /// -/// () Remove the imposter detail level (if any) from the shape. @return true if successful, false otherwise ) +/// () Remove the imposter detail level (if any) from the shape. +/// @return true if successful, false otherwise ) +/// /// public bool removeImposter(string tsshapeconstructor){ @@ -21766,7 +30478,14 @@ public bool removeImposter(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_removeImposter(tsshapeconstructor); } /// -/// Remove a mesh from the shape. If all geometry is removed from an object, the object is also removed. @param name full name (object name + detail size) of the mesh to remove @return true if successful, false otherwise @tsexample %this.removeMesh( \"SimpleShape128\" ); @endtsexample ) +/// Remove a mesh from the shape. +/// If all geometry is removed from an object, the object is also removed. +/// @param name full name (object name + detail size) of the mesh to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeMesh( \"SimpleShape128\" ); +/// @endtsexample ) +/// /// public bool removeMesh(string tsshapeconstructor, string name){ @@ -21774,7 +30493,16 @@ public bool removeMesh(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeMesh(tsshapeconstructor, name); } /// -/// Remove a node from the shape. The named node is removed from the shape, including from any sequences that use the node. Child nodes and objects attached to the node are re-assigned to the node's parent. @param name name of the node to remove. @return true if successful, false otherwise. @tsexample %this.removeNode( \"Nose\" ); @endtsexample ) +/// Remove a node from the shape. +/// The named node is removed from the shape, including from any sequences that +/// use the node. Child nodes and objects attached to the node are re-assigned +/// to the node's parent. +/// @param name name of the node to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.removeNode( \"Nose\" ); +/// @endtsexample ) +/// /// public bool removeNode(string tsshapeconstructor, string name){ @@ -21782,7 +30510,16 @@ public bool removeNode(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeNode(tsshapeconstructor, name); } /// -/// Remove an object (including all meshes for that object) from the shape. @param name name of the object to remove. @return true if successful, false otherwise. @tsexample // clear all objects in the shape %count = %this.getObjectCount(); for ( %i = %count-1; %i >= 0; %i-- ) %this.removeObject( %this.getObjectName(%i) ); @endtsexample ) +/// Remove an object (including all meshes for that object) from the shape. +/// @param name name of the object to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// // clear all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = %count-1; %i >= 0; %i-- ) +/// %this.removeObject( %this.getObjectName(%i) ); +/// @endtsexample ) +/// /// public bool removeObject(string tsshapeconstructor, string name){ @@ -21790,7 +30527,10 @@ public bool removeObject(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeObject(tsshapeconstructor, name); } /// -/// Remove the sequence from the shape. @param name name of the sequence to remove @return true if successful, false otherwise ) +/// Remove the sequence from the shape. +/// @param name name of the sequence to remove +/// @return true if successful, false otherwise ) +/// /// public bool removeSequence(string tsshapeconstructor, string name){ @@ -21798,7 +30538,15 @@ public bool removeSequence(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeSequence(tsshapeconstructor, name); } /// -/// Remove a trigger from the sequence. @param name name of the sequence to modify @param keyframe keyframe of the trigger to remove @param state of the trigger to remove @return true if successful, false otherwise @tsexample %this.removeTrigger( \"walk\", 3, 1 ); @endtsexample ) +/// Remove a trigger from the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the trigger to remove +/// @param state of the trigger to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeTrigger( \"walk\", 3, 1 ); +/// @endtsexample ) +/// /// public bool removeTrigger(string tsshapeconstructor, string name, int keyframe, int state){ @@ -21806,7 +30554,16 @@ public bool removeTrigger(string tsshapeconstructor, string name, int keyframe, return m_ts.fnTSShapeConstructor_removeTrigger(tsshapeconstructor, name, keyframe, state); } /// -/// Rename a detail level. @note Note that detail level names must be unique, so this command will fail if there is already a detail level with the desired name @param oldName current name of the detail level @param newName new name of the detail level @return true if successful, false otherwise @tsexample %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); @endtsexample ) +/// Rename a detail level. +/// @note Note that detail level names must be unique, so this command will +/// fail if there is already a detail level with the desired name +/// @param oldName current name of the detail level +/// @param newName new name of the detail level +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); +/// @endtsexample ) +/// /// public bool renameDetailLevel(string tsshapeconstructor, string oldName, string newName){ @@ -21814,7 +30571,16 @@ public bool renameDetailLevel(string tsshapeconstructor, string oldName, string return m_ts.fnTSShapeConstructor_renameDetailLevel(tsshapeconstructor, oldName, newName); } /// -/// Rename a node. @note Note that node names must be unique, so this command will fail if there is already a node with the desired name @param oldName current name of the node @param newName new name of the node @return true if successful, false otherwise @tsexample %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); @endtsexample ) +/// Rename a node. +/// @note Note that node names must be unique, so this command will fail if +/// there is already a node with the desired name +/// @param oldName current name of the node +/// @param newName new name of the node +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); +/// @endtsexample ) +/// /// public bool renameNode(string tsshapeconstructor, string oldName, string newName){ @@ -21822,7 +30588,16 @@ public bool renameNode(string tsshapeconstructor, string oldName, string newNam return m_ts.fnTSShapeConstructor_renameNode(tsshapeconstructor, oldName, newName); } /// -/// Rename an object. @note Note that object names must be unique, so this command will fail if there is already an object with the desired name @param oldName current name of the object @param newName new name of the object @return true if successful, false otherwise @tsexample %this.renameObject( \"MyBox\", \"Box\" ); @endtsexample ) +/// Rename an object. +/// @note Note that object names must be unique, so this command will fail if +/// there is already an object with the desired name +/// @param oldName current name of the object +/// @param newName new name of the object +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameObject( \"MyBox\", \"Box\" ); +/// @endtsexample ) +/// /// public bool renameObject(string tsshapeconstructor, string oldName, string newName){ @@ -21830,7 +30605,16 @@ public bool renameObject(string tsshapeconstructor, string oldName, string newN return m_ts.fnTSShapeConstructor_renameObject(tsshapeconstructor, oldName, newName); } /// -/// Rename a sequence. @note Note that sequence names must be unique, so this command will fail if there is already a sequence with the desired name @param oldName current name of the sequence @param newName new name of the sequence @return true if successful, false otherwise @tsexample %this.renameSequence( \"walking\", \"walk\" ); @endtsexample ) +/// Rename a sequence. +/// @note Note that sequence names must be unique, so this command will fail +/// if there is already a sequence with the desired name +/// @param oldName current name of the sequence +/// @param newName new name of the sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameSequence( \"walking\", \"walk\" ); +/// @endtsexample ) +/// /// public bool renameSequence(string tsshapeconstructor, string oldName, string newName){ @@ -21838,7 +30622,12 @@ public bool renameSequence(string tsshapeconstructor, string oldName, string ne return m_ts.fnTSShapeConstructor_renameSequence(tsshapeconstructor, oldName, newName); } /// -/// Save the shape (with all current changes) to a new DTS file. @param filename Destination filename. @tsexample %this.saveShape( \"./myShape.dts\" ); @endtsexample ) +/// Save the shape (with all current changes) to a new DTS file. +/// @param filename Destination filename. +/// @tsexample +/// %this.saveShape( \"./myShape.dts\" ); +/// @endtsexample ) +/// /// public void saveShape(string tsshapeconstructor, string filename){ @@ -21846,7 +30635,10 @@ public void saveShape(string tsshapeconstructor, string filename){ m_ts.fnTSShapeConstructor_saveShape(tsshapeconstructor, filename); } /// -/// Set the shape bounds to the given bounding box. @param Bounding box \"minX minY minZ maxX maxY maxZ\" @return true if successful, false otherwise ) +/// Set the shape bounds to the given bounding box. +/// @param Bounding box \"minX minY minZ maxX maxY maxZ\" +/// @return true if successful, false otherwise ) +/// /// public bool setBounds(string tsshapeconstructor, Box3F bbox){ @@ -21854,7 +30646,16 @@ public bool setBounds(string tsshapeconstructor, Box3F bbox){ return m_ts.fnTSShapeConstructor_setBounds(tsshapeconstructor, bbox.AsString()); } /// -/// Change the size of a detail level. @note Note that detail levels are always sorted in decreasing size order, so this command may cause detail level indices to change. @param index index of the detail level to modify @param newSize new size for the detail level @return new index for this detail level @tsexample %this.setDetailLevelSize( 2, 256 ); @endtsexample ) +/// Change the size of a detail level. +/// @note Note that detail levels are always sorted in decreasing size order, +/// so this command may cause detail level indices to change. +/// @param index index of the detail level to modify +/// @param newSize new size for the detail level +/// @return new index for this detail level +/// @tsexample +/// %this.setDetailLevelSize( 2, 256 ); +/// @endtsexample ) +/// /// public int setDetailLevelSize(string tsshapeconstructor, int index, int newSize){ @@ -21862,7 +30663,17 @@ public int setDetailLevelSize(string tsshapeconstructor, int index, int newSize return m_ts.fnTSShapeConstructor_setDetailLevelSize(tsshapeconstructor, index, newSize); } /// -/// Set the name of the material attached to the mesh. @param meshName full name (object name + detail size) of the mesh to modify @param matName name of the material to attach. This could be the base name of the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a Material object already defined in script. @return true if successful, false otherwise @tsexample // set the mesh material %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); @endtsexample ) +/// Set the name of the material attached to the mesh. +/// @param meshName full name (object name + detail size) of the mesh to modify +/// @param matName name of the material to attach. This could be the base name of +/// the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a +/// Material object already defined in script. +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh material +/// %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); +/// @endtsexample ) +/// /// public bool setMeshMaterial(string tsshapeconstructor, string meshName, string matName){ @@ -21870,7 +30681,14 @@ public bool setMeshMaterial(string tsshapeconstructor, string meshName, string return m_ts.fnTSShapeConstructor_setMeshMaterial(tsshapeconstructor, meshName, matName); } /// -/// Change the detail level size of the named mesh. @param name full name (object name + current size ) of the mesh to modify @param size new detail level size @return true if successful, false otherwise. @tsexample %this.setMeshSize( \"SimpleShape128\", 64 ); @endtsexample ) +/// Change the detail level size of the named mesh. +/// @param name full name (object name + current size ) of the mesh to modify +/// @param size new detail level size +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.setMeshSize( \"SimpleShape128\", 64 ); +/// @endtsexample ) +/// /// public bool setMeshSize(string tsshapeconstructor, string name, int size){ @@ -21878,7 +30696,15 @@ public bool setMeshSize(string tsshapeconstructor, string name, int size){ return m_ts.fnTSShapeConstructor_setMeshSize(tsshapeconstructor, name, size); } /// -/// Set the display type for the mesh. @param name full name (object name + detail size) of the mesh to modify @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" @return true if successful, false otherwise @tsexample // set the mesh to be a billboard %this.setMeshType( \"SimpleShape64\", \"billboard\" ); @endtsexample ) +/// Set the display type for the mesh. +/// @param name full name (object name + detail size) of the mesh to modify +/// @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh to be a billboard +/// %this.setMeshType( \"SimpleShape64\", \"billboard\" ); +/// @endtsexample ) +/// /// public bool setMeshType(string tsshapeconstructor, string name, string type){ @@ -21886,7 +30712,14 @@ public bool setMeshType(string tsshapeconstructor, string name, string type){ return m_ts.fnTSShapeConstructor_setMeshType(tsshapeconstructor, name, type); } /// -/// Set the parent of a node. @param name name of the node to modify @param parentName name of the parent node to set (use \"\" to move the node to the root level) @return true if successful, false if failed @tsexample %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); @endtsexample ) +/// Set the parent of a node. +/// @param name name of the node to modify +/// @param parentName name of the parent node to set (use \"\" to move the node to the root level) +/// @return true if successful, false if failed +/// @tsexample +/// %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); +/// @endtsexample ) +/// /// public bool setNodeParent(string tsshapeconstructor, string name, string parentName){ @@ -21894,7 +30727,20 @@ public bool setNodeParent(string tsshapeconstructor, string name, string parent return m_ts.fnTSShapeConstructor_setNodeParent(tsshapeconstructor, name, parentName); } /// -/// Set the base transform of a node. That is, the transform of the node when in the root (not-animated) pose. @param name name of the node to modify @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); @endtsexample ) +/// Set the base transform of a node. That is, the transform of the node when +/// in the root (not-animated) pose. +/// @param name name of the node to modify +/// @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); +/// %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); +/// %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool setNodeTransform(string tsshapeconstructor, string name, TransformF txfm, bool isWorld = false){ @@ -21902,7 +30748,16 @@ public bool setNodeTransform(string tsshapeconstructor, string name, TransformF return m_ts.fnTSShapeConstructor_setNodeTransform(tsshapeconstructor, name, txfm.AsString(), isWorld); } /// -/// Set the node an object is attached to. When the shape is rendered, the object geometry is rendered at the node's current transform. @param objName name of the object to modify @param nodeName name of the node to attach the object to @return true if successful, false otherwise @tsexample %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); @endtsexample ) +/// Set the node an object is attached to. +/// When the shape is rendered, the object geometry is rendered at the node's +/// current transform. +/// @param objName name of the object to modify +/// @param nodeName name of the node to attach the object to +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); +/// @endtsexample ) +/// /// public bool setObjectNode(string tsshapeconstructor, string objName, string nodeName){ @@ -21910,7 +30765,19 @@ public bool setObjectNode(string tsshapeconstructor, string objName, string nod return m_ts.fnTSShapeConstructor_setObjectNode(tsshapeconstructor, objName, nodeName); } /// -/// Mark a sequence as a blend or non-blend. A blend sequence is one that will be added on top of any other playing sequences. This is done by storing the animated node transforms relative to a reference frame, rather than as absolute transforms. @param name name of the sequence to modify @param blend true to make the sequence a blend, false for a non-blend @param blendSeq the name of the sequence that contains the blend reference frame @param blendFrame the reference frame in the blendSeq sequence @return true if successful, false otherwise @tsexample %this.setSequenceBlend( \"look\", true, \"root\", 0 ); @endtsexample ) +/// Mark a sequence as a blend or non-blend. +/// A blend sequence is one that will be added on top of any other playing +/// sequences. This is done by storing the animated node transforms relative +/// to a reference frame, rather than as absolute transforms. +/// @param name name of the sequence to modify +/// @param blend true to make the sequence a blend, false for a non-blend +/// @param blendSeq the name of the sequence that contains the blend reference frame +/// @param blendFrame the reference frame in the blendSeq sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceBlend( \"look\", true, \"root\", 0 ); +/// @endtsexample ) +/// /// public bool setSequenceBlend(string tsshapeconstructor, string name, bool blend, string blendSeq, int blendFrame){ @@ -21918,7 +30785,15 @@ public bool setSequenceBlend(string tsshapeconstructor, string name, bool blend return m_ts.fnTSShapeConstructor_setSequenceBlend(tsshapeconstructor, name, blend, blendSeq, blendFrame); } /// -/// Mark a sequence as cyclic or non-cyclic. @param name name of the sequence to modify @param cyclic true to make the sequence cyclic, false for non-cyclic @return true if successful, false otherwise @tsexample %this.setSequenceCyclic( \"ambient\", true ); %this.setSequenceCyclic( \"shoot\", false ); @endtsexample ) +/// Mark a sequence as cyclic or non-cyclic. +/// @param name name of the sequence to modify +/// @param cyclic true to make the sequence cyclic, false for non-cyclic +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceCyclic( \"ambient\", true ); +/// %this.setSequenceCyclic( \"shoot\", false ); +/// @endtsexample ) +/// /// public bool setSequenceCyclic(string tsshapeconstructor, string name, bool cyclic){ @@ -21926,7 +30801,22 @@ public bool setSequenceCyclic(string tsshapeconstructor, string name, bool cycl return m_ts.fnTSShapeConstructor_setSequenceCyclic(tsshapeconstructor, name, cyclic); } /// -/// Set the translation and rotation ground speed of the sequence. The ground speed of the sequence is set by generating ground transform keyframes. The ground translational and rotational speed is assumed to be constant for the duration of the sequence. Existing ground frames for the sequence (if any) will be replaced. @param name name of the sequence to modify @param transSpeed translational speed (trans.x trans.y trans.z) in Torque units per frame @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in radians per frame. Default is \"0 0 0\" @return true if successful, false otherwise @tsexample %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); @endtsexample ) +/// Set the translation and rotation ground speed of the sequence. +/// The ground speed of the sequence is set by generating ground transform +/// keyframes. The ground translational and rotational speed is assumed to +/// be constant for the duration of the sequence. Existing ground frames for +/// the sequence (if any) will be replaced. +/// @param name name of the sequence to modify +/// @param transSpeed translational speed (trans.x trans.y trans.z) in +/// Torque units per frame +/// @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in +/// radians per frame. Default is \"0 0 0\" +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); +/// %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); +/// @endtsexample ) +/// /// public bool setSequenceGroundSpeed(string tsshapeconstructor, string name, Point3F transSpeed, Point3F rotSpeed = null ){ if (rotSpeed== null) {rotSpeed = new Point3F(0.0f, 0.0f, 0.0f);} @@ -21935,7 +30825,11 @@ public bool setSequenceGroundSpeed(string tsshapeconstructor, string name, Poin return m_ts.fnTSShapeConstructor_setSequenceGroundSpeed(tsshapeconstructor, name, transSpeed.AsString(), rotSpeed.AsString()); } /// -/// Set the sequence priority. @param name name of the sequence to modify @param priority new priority value @return true if successful, false otherwise ) +/// Set the sequence priority. +/// @param name name of the sequence to modify +/// @param priority new priority value +/// @return true if successful, false otherwise ) +/// /// public bool setSequencePriority(string tsshapeconstructor, string name, float priority){ @@ -21943,7 +30837,10 @@ public bool setSequencePriority(string tsshapeconstructor, string name, float p return m_ts.fnTSShapeConstructor_setSequencePriority(tsshapeconstructor, name, priority); } /// -/// Write the current change set to a TSShapeConstructor script file. The name of the script file is the same as the model, but with .cs extension. eg. myShape.cs for myShape.dts or myShape.dae. ) +/// Write the current change set to a TSShapeConstructor script file. The +/// name of the script file is the same as the model, but with .cs extension. +/// eg. myShape.cs for myShape.dts or myShape.dae. ) +/// /// public void writeChangeSet(string tsshapeconstructor){ @@ -21956,14 +30853,26 @@ public void writeChangeSet(string tsshapeconstructor){ /// public class TSStaticObject { -private Omni m_ts; - /// - /// - /// - /// -public TSStaticObject(ref Omni ts){m_ts = ts;} /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void changeMaterial(string tsstatic, string mapTo = "", string oldMat = null , string newMat = null ){ if (oldMat== null) {oldMat = null;} @@ -21973,7 +30882,15 @@ public void changeMaterial(string tsstatic, string mapTo = "", string oldMat = m_ts.fnTSStatic_changeMaterial(tsstatic, mapTo, oldMat, newMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string getModelFile(string tsstatic){ @@ -21981,7 +30898,10 @@ public string getModelFile(string tsstatic){ return m_ts.fnTSStatic_getModelFile(tsstatic); } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int getTargetCount(string tsstatic){ @@ -21989,7 +30909,11 @@ public int getTargetCount(string tsstatic){ return m_ts.fnTSStatic_getTargetCount(tsstatic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string getTargetName(string tsstatic, int index = 0){ @@ -22002,14 +30926,10 @@ public string getTargetName(string tsstatic, int index = 0){ /// public class TurretShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public TurretShapeObject(ref Omni ts){m_ts = ts;} /// -/// @brief Does the turret respawn after it has been destroyed. @returns True if the turret respawns.) +/// @brief Does the turret respawn after it has been destroyed. +/// @returns True if the turret respawns.) +/// /// public bool doRespawn(string turretshape){ @@ -22017,7 +30937,9 @@ public bool doRespawn(string turretshape){ return m_ts.fnTurretShape_doRespawn(turretshape); } /// -/// @brief Get if the turret is allowed to fire through moves. @return True if the turret is allowed to fire through moves. ) +/// @brief Get if the turret is allowed to fire through moves. +/// @return True if the turret is allowed to fire through moves. ) +/// /// public bool getAllowManualFire(string turretshape){ @@ -22025,7 +30947,9 @@ public bool getAllowManualFire(string turretshape){ return m_ts.fnTurretShape_getAllowManualFire(turretshape); } /// -/// @brief Get if the turret is allowed to rotate through moves. @return True if the turret is allowed to rotate through moves. ) +/// @brief Get if the turret is allowed to rotate through moves. +/// @return True if the turret is allowed to rotate through moves. ) +/// /// public bool getAllowManualRotation(string turretshape){ @@ -22033,7 +30957,15 @@ public bool getAllowManualRotation(string turretshape){ return m_ts.fnTurretShape_getAllowManualRotation(turretshape); } /// -/// @brief Get the name of the turret's current state. The state is one of the following:ul> li>Dead - The TurretShape is destroyed./li> li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> li>Ready - The TurretShape is free to move. The usual state./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// @brief Get the name of the turret's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The TurretShape is destroyed./li> +/// li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> +/// li>Ready - The TurretShape is free to move. The usual state./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// /// public string getState(string turretshape){ @@ -22041,7 +30973,10 @@ public string getState(string turretshape){ return m_ts.fnTurretShape_getState(turretshape); } /// -/// @brief Get Euler rotation of this turret's heading and pitch nodes. @return the orientation of the turret's heading and pitch nodes in the form of rotations around the X, Y and Z axes in degrees. ) +/// @brief Get Euler rotation of this turret's heading and pitch nodes. +/// @return the orientation of the turret's heading and pitch nodes in the +/// form of rotations around the X, Y and Z axes in degrees. ) +/// /// public Point3F getTurretEulerRotation(string turretshape){ @@ -22049,7 +30984,9 @@ public Point3F getTurretEulerRotation(string turretshape){ return new Point3F ( m_ts.fnTurretShape_getTurretEulerRotation(turretshape)); } /// -/// @brief Set if the turret is allowed to fire through moves. @param allow If true then the turret may be fired through moves.) +/// @brief Set if the turret is allowed to fire through moves. +/// @param allow If true then the turret may be fired through moves.) +/// /// public void setAllowManualFire(string turretshape, bool allow){ @@ -22057,7 +30994,9 @@ public void setAllowManualFire(string turretshape, bool allow){ m_ts.fnTurretShape_setAllowManualFire(turretshape, allow); } /// -/// @brief Set if the turret is allowed to rotate through moves. @param allow If true then the turret may be rotated through moves.) +/// @brief Set if the turret is allowed to rotate through moves. +/// @param allow If true then the turret may be rotated through moves.) +/// /// public void setAllowManualRotation(string turretshape, bool allow){ @@ -22065,7 +31004,10 @@ public void setAllowManualRotation(string turretshape, bool allow){ m_ts.fnTurretShape_setAllowManualRotation(turretshape, allow); } /// -/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. @param rot The rotation in degrees. The pitch is the X component and the heading is the Z component. The Y component is ignored.) +/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. +/// @param rot The rotation in degrees. The pitch is the X component and the +/// heading is the Z component. The Y component is ignored.) +/// /// public void setTurretEulerRotation(string turretshape, Point3F rot){ @@ -22078,14 +31020,9 @@ public void setTurretEulerRotation(string turretshape, Point3F rot){ /// public class UndoActionObject { -private Omni m_ts; - /// - /// - /// - /// -public UndoActionObject(ref Omni ts){m_ts = ts;} /// /// ), action.addToManager([undoManager])) +/// /// public void UndoAction_addToManager(string undoaction, string undoManager = ""){ @@ -22094,6 +31031,7 @@ public void UndoAction_addToManager(string undoaction, string undoManager = "") } /// /// () - Reo action contained in undo. ) +/// /// public void UndoAction_redo(string undoaction){ @@ -22102,6 +31040,7 @@ public void UndoAction_redo(string undoaction){ } /// /// () - Undo action contained in undo. ) +/// /// public void UndoAction_undo(string undoaction){ @@ -22114,14 +31053,9 @@ public void UndoAction_undo(string undoaction){ /// public class UndoManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public UndoManagerObject(ref Omni ts){m_ts = ts;} /// /// Clears the undo manager.) +/// /// public void UndoManager_clearAll(string undomanager){ @@ -22130,6 +31064,7 @@ public void UndoManager_clearAll(string undomanager){ } /// /// UndoManager.getNextRedoName();) +/// /// public string UndoManager_getNextRedoName(string undomanager){ @@ -22138,6 +31073,7 @@ public string UndoManager_getNextRedoName(string undomanager){ } /// /// UndoManager.getNextUndoName();) +/// /// public string UndoManager_getNextUndoName(string undomanager){ @@ -22146,6 +31082,7 @@ public string UndoManager_getNextUndoName(string undomanager){ } /// /// (index)) +/// /// public int UndoManager_getRedoAction(string undomanager, int index){ @@ -22154,6 +31091,7 @@ public int UndoManager_getRedoAction(string undomanager, int index){ } /// /// ) +/// /// public int UndoManager_getRedoCount(string undomanager){ @@ -22162,6 +31100,7 @@ public int UndoManager_getRedoCount(string undomanager){ } /// /// (index)) +/// /// public string UndoManager_getRedoName(string undomanager, int index){ @@ -22170,6 +31109,7 @@ public string UndoManager_getRedoName(string undomanager, int index){ } /// /// (index)) +/// /// public int UndoManager_getUndoAction(string undomanager, int index){ @@ -22178,6 +31118,7 @@ public int UndoManager_getUndoAction(string undomanager, int index){ } /// /// ) +/// /// public int UndoManager_getUndoCount(string undomanager){ @@ -22186,6 +31127,7 @@ public int UndoManager_getUndoCount(string undomanager){ } /// /// (index)) +/// /// public string UndoManager_getUndoName(string undomanager, int index){ @@ -22194,6 +31136,7 @@ public string UndoManager_getUndoName(string undomanager, int index){ } /// /// ( bool discard=false ) - Pop the current CompoundUndoAction off the stack. ) +/// /// public void UndoManager_popCompound(string undomanager, bool discard = false){ @@ -22202,6 +31145,7 @@ public void UndoManager_popCompound(string undomanager, bool discard = false){ } /// /// \"\"), ( string name=\"\" ) - Push a CompoundUndoAction onto the compound stack for assembly. ) +/// /// public string UndoManager_pushCompound(string undomanager, string name = "\"\""){ @@ -22210,6 +31154,7 @@ public string UndoManager_pushCompound(string undomanager, string name = "\"\"" } /// /// UndoManager.redo();) +/// /// public void UndoManager_redo(string undomanager){ @@ -22218,6 +31163,7 @@ public void UndoManager_redo(string undomanager){ } /// /// UndoManager.undo();) +/// /// public void UndoManager_undo(string undomanager){ @@ -22230,12 +31176,6 @@ public void UndoManager_undo(string undomanager){ /// public class VolumetricFogObject { -private Omni m_ts; - /// - /// - /// - /// -public VolumetricFogObject(ref Omni ts){m_ts = ts;} /// /// @brief Changes the color of the fog. /// @params new_color the new fog color (rgb 0-255, a is ignored.) @@ -22284,14 +31224,12 @@ public void SetFogModulation(string volumetricfog, float new_strenght, Point2F /// public class WalkableShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public WalkableShapeObject(ref Omni ts){m_ts = ts;} /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool attachObject(string walkableshape, string obj){ @@ -22299,7 +31237,14 @@ public bool attachObject(string walkableshape, string obj){ return m_ts.fnWalkableShape_attachObject(walkableshape, obj); } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void detachAll(string walkableshape){ @@ -22307,7 +31252,11 @@ public void detachAll(string walkableshape){ m_ts.fnWalkableShape_detachAll(walkableshape); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool detachObject(string walkableshape, string obj){ @@ -22316,6 +31265,7 @@ public bool detachObject(string walkableshape, string obj){ } /// /// Returns the attachment at the passed index value.) +/// /// public string getAttachment(string walkableshape, int index = 0){ @@ -22324,6 +31274,7 @@ public string getAttachment(string walkableshape, int index = 0){ } /// /// Returns the number of objects that are currently attached.) +/// /// public int getNumAttachments(string walkableshape){ @@ -22336,14 +31287,10 @@ public int getNumAttachments(string walkableshape){ /// public class WheeledVehicleObject { -private Omni m_ts; - /// - /// - /// - /// -public WheeledVehicleObject(ref Omni ts){m_ts = ts;} /// -/// @brief Get the number of wheels on this vehicle. @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// @brief Get the number of wheels on this vehicle. +/// @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// /// public int getWheelCount(string wheeledvehicle){ @@ -22351,7 +31298,13 @@ public int getWheelCount(string wheeledvehicle){ return m_ts.fnWheeledVehicle_getWheelCount(wheeledvehicle); } /// -/// @brief Set whether the wheel is powered (has torque applied from the engine). A rear wheel drive car for example would set the front wheels to false, and the rear wheels to true. @param wheel index of the wheel to set (hub node #) @param powered flag indicating whether to power the wheel or not @return true if successful, false if failed ) +/// @brief Set whether the wheel is powered (has torque applied from the engine). +/// A rear wheel drive car for example would set the front wheels to false, +/// and the rear wheels to true. +/// @param wheel index of the wheel to set (hub node #) +/// @param powered flag indicating whether to power the wheel or not +/// @return true if successful, false if failed ) +/// /// public bool setWheelPowered(string wheeledvehicle, int wheel, bool powered){ @@ -22359,7 +31312,14 @@ public bool setWheelPowered(string wheeledvehicle, int wheel, bool powered){ return m_ts.fnWheeledVehicle_setWheelPowered(wheeledvehicle, wheel, powered); } /// -/// @brief Set the WheeledVehicleSpring datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param spring WheeledVehicleSpring datablock @return true if successful, false if failed @tsexample %obj.setWheelSpring( 0, FrontSpring ); @endtsexample ) +/// @brief Set the WheeledVehicleSpring datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param spring WheeledVehicleSpring datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelSpring( 0, FrontSpring ); +/// @endtsexample ) +/// /// public bool setWheelSpring(string wheeledvehicle, int wheel, string spring){ @@ -22367,7 +31327,16 @@ public bool setWheelSpring(string wheeledvehicle, int wheel, string spring){ return m_ts.fnWheeledVehicle_setWheelSpring(wheeledvehicle, wheel, spring); } /// -/// @brief Set how much the wheel is affected by steering. The steering factor controls how much the wheel is rotated by the vehicle steering. For example, most cars would have their front wheels set to 1.0, and their rear wheels set to 0 since only the front wheels should turn. Negative values will turn the wheel in the opposite direction to the steering angle. @param wheel index of the wheel to set (hub node #) @param steering steering factor from -1 (full inverse) to 1 (full) @return true if successful, false if failed ) +/// @brief Set how much the wheel is affected by steering. +/// The steering factor controls how much the wheel is rotated by the vehicle +/// steering. For example, most cars would have their front wheels set to 1.0, +/// and their rear wheels set to 0 since only the front wheels should turn. +/// Negative values will turn the wheel in the opposite direction to the steering +/// angle. +/// @param wheel index of the wheel to set (hub node #) +/// @param steering steering factor from -1 (full inverse) to 1 (full) +/// @return true if successful, false if failed ) +/// /// public bool setWheelSteering(string wheeledvehicle, int wheel, float steering){ @@ -22375,7 +31344,14 @@ public bool setWheelSteering(string wheeledvehicle, int wheel, float steering){ return m_ts.fnWheeledVehicle_setWheelSteering(wheeledvehicle, wheel, steering); } /// -/// @brief Set the WheeledVehicleTire datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param tire WheeledVehicleTire datablock @return true if successful, false if failed @tsexample %obj.setWheelTire( 0, FrontTire ); @endtsexample ) +/// @brief Set the WheeledVehicleTire datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param tire WheeledVehicleTire datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelTire( 0, FrontTire ); +/// @endtsexample ) +/// /// public bool setWheelTire(string wheeledvehicle, int wheel, string tire){ @@ -22388,14 +31364,9 @@ public bool setWheelTire(string wheeledvehicle, int wheel, string tire){ /// public class WorldEditorObject { -private Omni m_ts; - /// - /// - /// - /// -public WorldEditorObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void WorldEditor_addUndoState(string worldeditor){ @@ -22403,7 +31374,9 @@ public void WorldEditor_addUndoState(string worldeditor){ m_ts.fn_WorldEditor_addUndoState(worldeditor); } /// -/// (int axis) Align all selected objects along the given axis.) +/// (int axis) +/// Align all selected objects along the given axis.) +/// /// public void WorldEditor_alignByAxis(string worldeditor, int boundsAxis){ @@ -22411,7 +31384,9 @@ public void WorldEditor_alignByAxis(string worldeditor, int boundsAxis){ m_ts.fn_WorldEditor_alignByAxis(worldeditor, boundsAxis); } /// -/// (int boundsAxis) Align all selected objects against the given bounds axis.) +/// (int boundsAxis) +/// Align all selected objects against the given bounds axis.) +/// /// public void WorldEditor_alignByBounds(string worldeditor, int boundsAxis){ @@ -22420,6 +31395,7 @@ public void WorldEditor_alignByBounds(string worldeditor, int boundsAxis){ } /// /// ) +/// /// public bool WorldEditor_canPasteSelection(string worldeditor){ @@ -22428,6 +31404,7 @@ public bool WorldEditor_canPasteSelection(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_clearIgnoreList(string worldeditor){ @@ -22436,6 +31413,7 @@ public void WorldEditor_clearIgnoreList(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_clearSelection(string worldeditor){ @@ -22444,6 +31422,7 @@ public void WorldEditor_clearSelection(string worldeditor){ } /// /// ( String path ) - Export the combined geometry of all selected objects to the specified path in collada format. ) +/// /// public void WorldEditor_colladaExportSelection(string worldeditor, string path){ @@ -22452,6 +31431,7 @@ public void WorldEditor_colladaExportSelection(string worldeditor, string path) } /// /// ) +/// /// public void WorldEditor_copySelection(string worldeditor){ @@ -22460,6 +31440,7 @@ public void WorldEditor_copySelection(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_cutSelection(string worldeditor){ @@ -22468,6 +31449,7 @@ public void WorldEditor_cutSelection(string worldeditor){ } /// /// ( bool skipUndo = false )) +/// /// public void WorldEditor_dropSelection(string worldeditor, bool skipUndo = false){ @@ -22476,6 +31458,7 @@ public void WorldEditor_dropSelection(string worldeditor, bool skipUndo = false } /// /// () - Replace selected Prefab objects with a SimGroup containing all children objects defined in the .prefab. ) +/// /// public void WorldEditor_explodeSelectedPrefab(string worldeditor){ @@ -22484,6 +31467,7 @@ public void WorldEditor_explodeSelectedPrefab(string worldeditor){ } /// /// () - Return the currently active WorldEditorSelection object. ) +/// /// public int WorldEditor_getActiveSelection(string worldeditor){ @@ -22492,6 +31476,7 @@ public int WorldEditor_getActiveSelection(string worldeditor){ } /// /// (int index)) +/// /// public int WorldEditor_getSelectedObject(string worldeditor, int index){ @@ -22500,6 +31485,7 @@ public int WorldEditor_getSelectedObject(string worldeditor, int index){ } /// /// ) +/// /// public string WorldEditor_getSelectionCentroid(string worldeditor){ @@ -22508,6 +31494,7 @@ public string WorldEditor_getSelectionCentroid(string worldeditor){ } /// /// ) +/// /// public Point3F WorldEditor_getSelectionExtent(string worldeditor){ @@ -22516,6 +31503,7 @@ public Point3F WorldEditor_getSelectionExtent(string worldeditor){ } /// /// ) +/// /// public float WorldEditor_getSelectionRadius(string worldeditor){ @@ -22524,6 +31512,7 @@ public float WorldEditor_getSelectionRadius(string worldeditor){ } /// /// () - Return the number of objects currently selected in the editor.) +/// /// public int WorldEditor_getSelectionSize(string worldeditor){ @@ -22531,7 +31520,9 @@ public int WorldEditor_getSelectionSize(string worldeditor){ return m_ts.fn_WorldEditor_getSelectionSize(worldeditor); } /// -/// getSoftSnap() Is soft snapping always on?) +/// getSoftSnap() +/// Is soft snapping always on?) +/// /// public bool WorldEditor_getSoftSnap(string worldeditor){ @@ -22539,7 +31530,9 @@ public bool WorldEditor_getSoftSnap(string worldeditor){ return m_ts.fn_WorldEditor_getSoftSnap(worldeditor); } /// -/// getSoftSnapBackfaceTolerance() The fraction of the soft snap radius that backfaces may be included.) +/// getSoftSnapBackfaceTolerance() +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public float WorldEditor_getSoftSnapBackfaceTolerance(string worldeditor){ @@ -22547,7 +31540,9 @@ public float WorldEditor_getSoftSnapBackfaceTolerance(string worldeditor){ return m_ts.fn_WorldEditor_getSoftSnapBackfaceTolerance(worldeditor); } /// -/// getSoftSnapSize() Get the absolute size to trigger a soft snap.) +/// getSoftSnapSize() +/// Get the absolute size to trigger a soft snap.) +/// /// public float WorldEditor_getSoftSnapSize(string worldeditor){ @@ -22556,6 +31551,7 @@ public float WorldEditor_getSoftSnapSize(string worldeditor){ } /// /// (Object obj, bool hide)) +/// /// public void WorldEditor_hideObject(string worldeditor, string obj, bool hide){ @@ -22564,6 +31560,7 @@ public void WorldEditor_hideObject(string worldeditor, string obj, bool hide){ } /// /// (bool hide)) +/// /// public void WorldEditor_hideSelection(string worldeditor, bool hide){ @@ -22572,6 +31569,7 @@ public void WorldEditor_hideSelection(string worldeditor, bool hide){ } /// /// ) +/// /// public void WorldEditor_invalidateSelectionCentroid(string worldeditor){ @@ -22580,6 +31578,7 @@ public void WorldEditor_invalidateSelectionCentroid(string worldeditor){ } /// /// (bool lock)) +/// /// public void WorldEditor_lockSelection(string worldeditor, bool lockx){ @@ -22588,6 +31587,7 @@ public void WorldEditor_lockSelection(string worldeditor, bool lockx){ } /// /// ( string filename ) - Save selected objects to a .prefab file and replace them in the level with a Prefab object. ) +/// /// public void WorldEditor_makeSelectionPrefab(string worldeditor, string filename){ @@ -22596,6 +31596,7 @@ public void WorldEditor_makeSelectionPrefab(string worldeditor, string filename } /// /// ( Object A, Object B ) ) +/// /// public void WorldEditor_mountRelative(string worldeditor, string objA, string objB){ @@ -22604,6 +31605,7 @@ public void WorldEditor_mountRelative(string worldeditor, string objA, string o } /// /// ) +/// /// public void WorldEditor_pasteSelection(string worldeditor){ @@ -22612,6 +31614,7 @@ public void WorldEditor_pasteSelection(string worldeditor){ } /// /// ( int objID )) +/// /// public void WorldEditor_redirectConsole(string worldeditor, int objID){ @@ -22620,6 +31623,7 @@ public void WorldEditor_redirectConsole(string worldeditor, int objID){ } /// /// ) +/// /// public void WorldEditor_resetSelectedRotation(string worldeditor){ @@ -22628,6 +31632,7 @@ public void WorldEditor_resetSelectedRotation(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_resetSelectedScale(string worldeditor){ @@ -22636,6 +31641,7 @@ public void WorldEditor_resetSelectedScale(string worldeditor){ } /// /// (SimObject obj)) +/// /// public void WorldEditor_selectObject(string worldeditor, string objName){ @@ -22644,6 +31650,7 @@ public void WorldEditor_selectObject(string worldeditor, string objName){ } /// /// ( id set ) - Set the currently active WorldEditorSelection object. ) +/// /// public void WorldEditor_setActiveSelection(string worldeditor, string selection){ @@ -22651,7 +31658,9 @@ public void WorldEditor_setActiveSelection(string worldeditor, string selection m_ts.fn_WorldEditor_setActiveSelection(worldeditor, selection); } /// -/// setSoftSnap(bool) Allow soft snapping all of the time.) +/// setSoftSnap(bool) +/// Allow soft snapping all of the time.) +/// /// public void WorldEditor_setSoftSnap(string worldeditor, bool enable){ @@ -22659,7 +31668,9 @@ public void WorldEditor_setSoftSnap(string worldeditor, bool enable){ m_ts.fn_WorldEditor_setSoftSnap(worldeditor, enable); } /// -/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) The fraction of the soft snap radius that backfaces may be included.) +/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public void WorldEditor_setSoftSnapBackfaceTolerance(string worldeditor, float range){ @@ -22667,7 +31678,9 @@ public void WorldEditor_setSoftSnapBackfaceTolerance(string worldeditor, float m_ts.fn_WorldEditor_setSoftSnapBackfaceTolerance(worldeditor, range); } /// -/// setSoftSnapSize(F32) Set the absolute size to trigger a soft snap.) +/// setSoftSnapSize(F32) +/// Set the absolute size to trigger a soft snap.) +/// /// public void WorldEditor_setSoftSnapSize(string worldeditor, float size){ @@ -22675,7 +31688,9 @@ public void WorldEditor_setSoftSnapSize(string worldeditor, float size){ m_ts.fn_WorldEditor_setSoftSnapSize(worldeditor, size); } /// -/// softSnapDebugRender(bool) Toggle soft snapping debug rendering.) +/// softSnapDebugRender(bool) +/// Toggle soft snapping debug rendering.) +/// /// public void WorldEditor_softSnapDebugRender(string worldeditor, bool enable){ @@ -22683,7 +31698,9 @@ public void WorldEditor_softSnapDebugRender(string worldeditor, bool enable){ m_ts.fn_WorldEditor_softSnapDebugRender(worldeditor, enable); } /// -/// softSnapRender(bool) Render the soft snapping bounds.) +/// softSnapRender(bool) +/// Render the soft snapping bounds.) +/// /// public void WorldEditor_softSnapRender(string worldeditor, bool enable){ @@ -22691,7 +31708,9 @@ public void WorldEditor_softSnapRender(string worldeditor, bool enable){ m_ts.fn_WorldEditor_softSnapRender(worldeditor, enable); } /// -/// softSnapRenderTriangle(bool) Render the soft snapped triangle.) +/// softSnapRenderTriangle(bool) +/// Render the soft snapped triangle.) +/// /// public void WorldEditor_softSnapRenderTriangle(string worldeditor, bool enable){ @@ -22699,7 +31718,9 @@ public void WorldEditor_softSnapRenderTriangle(string worldeditor, bool enable) m_ts.fn_WorldEditor_softSnapRenderTriangle(worldeditor, enable); } /// -/// softSnapSizeByBounds(bool) Use selection bounds size as soft snap bounds.) +/// softSnapSizeByBounds(bool) +/// Use selection bounds size as soft snap bounds.) +/// /// public void WorldEditor_softSnapSizeByBounds(string worldeditor, bool enable){ @@ -22707,7 +31728,9 @@ public void WorldEditor_softSnapSizeByBounds(string worldeditor, bool enable){ m_ts.fn_WorldEditor_softSnapSizeByBounds(worldeditor, enable); } /// -/// transformSelection(...) Transform selection by given parameters.) +/// transformSelection(...) +/// Transform selection by given parameters.) +/// /// public void WorldEditor_transformSelection(string worldeditor, bool position, Point3F point, bool relativePos, bool rotate, Point3F rotation, bool relativeRot, bool rotLocal, int scaleType, Point3F scale, bool sRelative, bool sLocal){ @@ -22716,6 +31739,7 @@ public void WorldEditor_transformSelection(string worldeditor, bool position, P } /// /// (SimObject obj)) +/// /// public void WorldEditor_unselectObject(string worldeditor, string objName){ @@ -22724,6 +31748,7 @@ public void WorldEditor_unselectObject(string worldeditor, string objName){ } /// /// Create a ConvexShape from the given polyhedral object. ) +/// /// public string createConvexShapeFrom(string worldeditor, string polyObject){ @@ -22732,6 +31757,7 @@ public string createConvexShapeFrom(string worldeditor, string polyObject){ } /// /// Grab the geometry from @a geometryProvider, create a @a className object, and assign it the extracted geometry. ) +/// /// public string createPolyhedralObject(string worldeditor, string className, string geometryProvider){ @@ -22740,6 +31766,7 @@ public string createPolyhedralObject(string worldeditor, string className, stri } /// /// Get the soft snap alignment. ) +/// /// public TypeWorldEditorAlignmentType getSoftSnapAlignment(string worldeditor){ @@ -22748,6 +31775,7 @@ public TypeWorldEditorAlignmentType getSoftSnapAlignment(string worldeditor){ } /// /// Get the terrain snap alignment. ) +/// /// public TypeWorldEditorAlignmentType getTerrainSnapAlignment(string worldeditor){ @@ -22756,6 +31784,7 @@ public TypeWorldEditorAlignmentType getTerrainSnapAlignment(string worldeditor) } /// /// ( WorldEditor, ignoreObjClass, void, 3, 0, (string class_name, ...)) +/// /// public void ignoreObjClass(string worldeditor, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -22764,6 +31793,7 @@ public void ignoreObjClass(string worldeditor, string a2= "", string a3= "", st } /// /// Set the soft snap alignment. ) +/// /// public void setSoftSnapAlignment(string worldeditor, TypeWorldEditorAlignmentType type){ @@ -22772,6 +31802,7 @@ public void setSoftSnapAlignment(string worldeditor, TypeWorldEditorAlignmentTy } /// /// Set the terrain snap alignment. ) +/// /// public void setTerrainSnapAlignment(string worldeditor, TypeWorldEditorAlignmentType alignment){ @@ -22784,14 +31815,9 @@ public void setTerrainSnapAlignment(string worldeditor, TypeWorldEditorAlignmen /// public class WorldEditorSelectionObject { -private Omni m_ts; - /// - /// - /// - /// -public WorldEditorSelectionObject(ref Omni ts){m_ts = ts;} /// /// ( WorldEditorSelection, containsGlobalBounds, bool, 2, 2, () - True if an object with global bounds is contained in the selection. ) +/// /// public bool containsGlobalBounds(string worldeditorselection= ""){ @@ -22800,6 +31826,7 @@ public bool containsGlobalBounds(string worldeditorselection= ""){ } /// /// ( WorldEditorSelection, getBoxCentroid, const char*, 2, 2, () - Return the center of the bounding box around the selection. ) +/// /// public string getBoxCentroid(string worldeditorselection= ""){ @@ -22808,6 +31835,7 @@ public string getBoxCentroid(string worldeditorselection= ""){ } /// /// ( WorldEditorSelection, getCentroid, const char*, 2, 2, () - Return the median of all object positions in the selection. ) +/// /// public string getCentroid(string worldeditorselection= ""){ @@ -22816,6 +31844,7 @@ public string getCentroid(string worldeditorselection= ""){ } /// /// ( WorldEditorSelection, offset, void, 3, 4, ( vector delta, float gridSnap=0 ) - Move all objects in the selection by the given delta. ) +/// /// public void offset(string worldeditorselection, string a2= "", string a3= ""){ @@ -22824,6 +31853,7 @@ public void offset(string worldeditorselection, string a2= "", string a3= ""){ } /// /// ( WorldEditorSelection, subtract, void, 3, 3, ( SimSet ) - Remove all objects in the given set from this selection. ) +/// /// public void subtract(string worldeditorselection, string a2= ""){ @@ -22832,6 +31862,7 @@ public void subtract(string worldeditorselection, string a2= ""){ } /// /// ( WorldEditorSelection, union, void, 3, 3, ( SimSet set ) - Add all objects in the given set to this selection. ) +/// /// public void union(string worldeditorselection, string a2= ""){ @@ -22844,14 +31875,15 @@ public void union(string worldeditorselection, string a2= ""){ /// public class ZipObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public ZipObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Add a file to the zip archive @param filename The path and name of the file to add to the zip archive. @param pathInZip The path and name to be given to the file within the zip archive. @param replace If a file already exists within the zip archive at the same location as this new file, this parameter indicates if it should be replaced. By default, it will be replaced. @return True if the file was successfully added to the zip archive.) +/// @brief Add a file to the zip archive +/// +/// @param filename The path and name of the file to add to the zip archive. +/// @param pathInZip The path and name to be given to the file within the zip archive. +/// @param replace If a file already exists within the zip archive at the same location as this +/// new file, this parameter indicates if it should be replaced. By default, it will be replaced. +/// @return True if the file was successfully added to the zip archive.) +/// /// public bool addFile(string zipobject, string filename, string pathInZip, bool replace = true){ @@ -22859,7 +31891,9 @@ public bool addFile(string zipobject, string filename, string pathInZip, bool r return m_ts.fnZipObject_addFile(zipobject, filename, pathInZip, replace); } /// -/// @brief Close an already opened zip archive. @see openArchive()) +/// @brief Close an already opened zip archive. +/// @see openArchive()) +/// /// public void closeArchive(string zipobject){ @@ -22867,7 +31901,11 @@ public void closeArchive(string zipobject){ m_ts.fnZipObject_closeArchive(zipobject); } /// -/// @brief Close a previously opened file within the zip archive. @param stream The StreamObject of a previously opened file within the zip archive. @see openFileForRead() @see openFileForWrite()) +/// @brief Close a previously opened file within the zip archive. +/// @param stream The StreamObject of a previously opened file within the zip archive. +/// @see openFileForRead() +/// @see openFileForWrite()) +/// /// public void closeFile(string zipobject, string stream){ @@ -22875,7 +31913,19 @@ public void closeFile(string zipobject, string stream){ m_ts.fnZipObject_closeFile(zipobject, stream); } /// -/// @brief Deleted the given file from the zip archive @param pathInZip The path and name of the file to be deleted from the zip archive. @return True of the file was successfully deleted. @note Files that have been deleted from the archive will still show up with a getFileEntryCount() until you close the archive. If you need to have the file count up to date with only valid files within the archive, you could close and then open the archive again. @see getFileEntryCount() @see closeArchive() @see openArchive()) +/// @brief Deleted the given file from the zip archive +/// @param pathInZip The path and name of the file to be deleted from the zip archive. +/// @return True of the file was successfully deleted. +/// +/// @note Files that have been deleted from the archive will still show up with a +/// getFileEntryCount() until you close the archive. If you need to have the file +/// count up to date with only valid files within the archive, you could close and then +/// open the archive again. +/// +/// @see getFileEntryCount() +/// @see closeArchive() +/// @see openArchive()) +/// /// public bool deleteFile(string zipobject, string pathInZip){ @@ -22883,7 +31933,11 @@ public bool deleteFile(string zipobject, string pathInZip){ return m_ts.fnZipObject_deleteFile(zipobject, pathInZip); } /// -/// @brief Extact a file from the zip archive and save it to the requested location. @param pathInZip The path and name of the file to be extracted within the zip archive. @param filename The path and name to give the extracted file. @return True if the file was successfully extracted.) +/// @brief Extact a file from the zip archive and save it to the requested location. +/// @param pathInZip The path and name of the file to be extracted within the zip archive. +/// @param filename The path and name to give the extracted file. +/// @return True if the file was successfully extracted.) +/// /// public bool extractFile(string zipobject, string pathInZip, string filename){ @@ -22891,7 +31945,22 @@ public bool extractFile(string zipobject, string pathInZip, string filename){ return m_ts.fnZipObject_extractFile(zipobject, pathInZip, filename); } /// -/// @brief Get information on the requested file within the zip archive. This methods provides five different pieces of information for the requested file: ul>li>filename - The path and name of the file within the zip archive/li> li>uncompressed size/li> li>compressed size/li> li>compression method/li> li>CRC32/li>/ul> Use getFileEntryCount() to obtain the total number of files within the archive. @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. @see getFileEntryCount()) +/// @brief Get information on the requested file within the zip archive. +/// +/// This methods provides five different pieces of information for the requested file: +/// ul>li>filename - The path and name of the file within the zip archive/li> +/// li>uncompressed size/li> +/// li>compressed size/li> +/// li>compression method/li> +/// li>CRC32/li>/ul> +/// +/// Use getFileEntryCount() to obtain the total number of files within the archive. +/// +/// @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. +/// @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. +/// +/// @see getFileEntryCount()) +/// /// public string getFileEntry(string zipobject, int index){ @@ -22899,7 +31968,20 @@ public string getFileEntry(string zipobject, int index){ return m_ts.fnZipObject_getFileEntry(zipobject, index); } /// -/// @brief Get the number of files within the zip archive. Use getFileEntry() to retrive information on each file within the archive. @return The number of files within the zip archive. @note The returned count will include any files that have been deleted from the archive using deleteFile(). To clear out all deleted files, you could close and then open the archive again. @see getFileEntry() @see closeArchive() @see openArchive()) +/// @brief Get the number of files within the zip archive. +/// +/// Use getFileEntry() to retrive information on each file within the archive. +/// +/// @return The number of files within the zip archive. +/// +/// @note The returned count will include any files that have been deleted from +/// the archive using deleteFile(). To clear out all deleted files, you could +/// close and then open the archive again. +/// +/// @see getFileEntry() +/// @see closeArchive() +/// @see openArchive()) +/// /// public int getFileEntryCount(string zipobject){ @@ -22907,7 +31989,23 @@ public int getFileEntryCount(string zipobject){ return m_ts.fnZipObject_getFileEntryCount(zipobject); } /// -/// read ), @brief Open a zip archive for manipulation. Once a zip archive is opened use the various ZipObject methods for working with the files within the archive. Be sure to close the archive when you are done with it. @param filename The path and file name of the zip archive to open. @param accessMode One of read, write or readwrite @return True is the archive was successfully opened. @note If you wish to make any changes to the archive, be sure to open it with a write or readwrite access mode. @see closeArchive()) +/// read ), +/// @brief Open a zip archive for manipulation. +/// +/// Once a zip archive is opened use the various ZipObject methods for +/// working with the files within the archive. Be sure to close the archive when +/// you are done with it. +/// +/// @param filename The path and file name of the zip archive to open. +/// @param accessMode One of read, write or readwrite +/// +/// @return True is the archive was successfully opened. +/// +/// @note If you wish to make any changes to the archive, be sure to open it +/// with a write or readwrite access mode. +/// +/// @see closeArchive()) +/// /// public bool openArchive(string zipobject, string filename, string accessMode = "read"){ @@ -22915,7 +32013,18 @@ public bool openArchive(string zipobject, string filename, string accessMode = return m_ts.fnZipObject_openArchive(zipobject, filename, accessMode); } /// -/// @brief Open a file within the zip archive for reading. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for reading. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string openFileForRead(string zipobject, string filename){ @@ -22923,7 +32032,18 @@ public string openFileForRead(string zipobject, string filename){ return m_ts.fnZipObject_openFileForRead(zipobject, filename); } /// -/// @brief Open a file within the zip archive for writing to. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for writing to. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string openFileForWrite(string zipobject, string filename){ @@ -22936,14 +32056,12 @@ public string openFileForWrite(string zipobject, string filename){ /// public class ZoneObject { -private Omni m_ts; - /// - /// - /// - /// -public ZoneObject(ref Omni ts){m_ts = ts;} /// -/// Dump a list of all objects assigned to the zone to the console as well as a list of all connected zone spaces. @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of objects are updated on demand, the zone contents can be outdated. ) +/// Dump a list of all objects assigned to the zone to the console as well as a list +/// of all connected zone spaces. +/// @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of +/// objects are updated on demand, the zone contents can be outdated. ) +/// /// public void dumpZoneState(string zone, bool updateFirst = true){ @@ -22951,7 +32069,9 @@ public void dumpZoneState(string zone, bool updateFirst = true){ m_ts.fnZone_dumpZoneState(zone, updateFirst); } /// -/// Get the unique numeric ID of the zone in its scene. @return The ID of the zone. ) +/// Get the unique numeric ID of the zone in its scene. +/// @return The ID of the zone. ) +/// /// public int getZoneId(string zone){ diff --git a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/ModelBase.cs b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/ModelBase.cs index f52ea1bf..ae729213 100644 --- a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/ModelBase.cs +++ b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Classes/ModelBase.cs @@ -48,8 +48,6 @@ namespace WinterLeaf.Engine.Classes [TypeConverter(typeof (TypeConverterGeneric))] public class ModelBase : pInvokes, IConvertible { - public static readonly pInvokes omni = new pInvokes(); - public static ulong Objectcount = 0; public ModelBase() diff --git a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs index 0564d352..f7930249 100644 --- a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs +++ b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs @@ -5960,7 +5960,7 @@ public object this[string key] public static readonly TypeGuiStackingType Vertical = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeVert,"Vertical","Stack children vertically by setting their Y position"); public static readonly TypeGuiStackingType Horizontal = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeHoriz,"Horizontal","Stack children horizontall by setting their X position"); - public static readonly TypeGuiStackingType Dynamic = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeDyn,"Dynamic","Automatically switch between Vertical and Horizontal stacking. Vertical stacking is chosen when the stack control is taller than it is wide, horizontal stacking is chosen when the stack control is wider than it is tall. "); + public static readonly TypeGuiStackingType Dynamic = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeDyn,"Dynamic","Automatically switch between Vertical and Horizontal stacking. Vertical stacking is chosen when the stack control is taller than it is wide, horizontal stacking is chosen when the stack control is wider than it is tall. "); }; /// @@ -7896,29 +7896,29 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXChannel Volume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVolume,"Volume","Channel controls volume level of attached sound sources. n @see SFXDescription::volume "); - public static readonly TypeSFXChannel Pitch = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPitch,"Pitch","Channel controls pitch of attached sound sources. n @see SFXDescription::pitch "); - public static readonly TypeSFXChannel Priority = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPriority,"Priority","Channel controls virtualizaton priority level of attached sound sources. n @see SFXDescription::priority "); - public static readonly TypeSFXChannel PositionX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionX,"PositionX","Channel controls X coordinate of 3D sound position of attached sources. "); - public static readonly TypeSFXChannel PositionY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionY,"PositionY","Channel controls Y coordinate of 3D sound position of attached sources. "); - public static readonly TypeSFXChannel PositionZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionZ,"PositionZ","Channel controls Z coordinate of 3D sound position of attached sources. "); - public static readonly TypeSFXChannel RotationX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationX,"RotationX","Channel controls X rotation (in degrees) of 3D sound orientation of attached sources. "); - public static readonly TypeSFXChannel RotationY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationY,"RotationY","Channel controls Y rotation (in degrees) of 3D sound orientation of attached sources. "); - public static readonly TypeSFXChannel RotationZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationZ,"RotationZ","Channel controls Z rotation (in degrees) of 3D sound orientation of attached sources. "); - public static readonly TypeSFXChannel VelocityX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityX,"VelocityX","Channel controls X coordinate of 3D sound velocity vector of attached sources. "); - public static readonly TypeSFXChannel VelocityY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityY,"VelocityY","Channel controls Y coordinate of 3D sound velocity vector of attached sources. "); - public static readonly TypeSFXChannel VelocityZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityZ,"VelocityZ","Channel controls Z coordinate of 3D sound velocity vector of attached sources. "); - public static readonly TypeSFXChannel ReferenceDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMinDistance,"ReferenceDistance","Channel controls reference distance of 3D sound of attached sources. n @see SFXDescription::referenceDistance "); - public static readonly TypeSFXChannel MaxDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMaxDistance,"MaxDistance","Channel controls max volume attenuation distance of 3D sound of attached sources. n @see SFXDescription::maxDistance "); - public static readonly TypeSFXChannel ConeInsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeInsideAngle,"ConeInsideAngle","Channel controls angle (in degrees) of 3D sound inner volume cone of attached sources. n @see SFXDescription::coneInsideAngle "); - public static readonly TypeSFXChannel ConeOutsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideAngle,"ConeOutsideAngle","Channel controls angle (in degrees) of 3D sound outer volume cone of attached sources. n @see SFXDescription::coneOutsideAngle "); - public static readonly TypeSFXChannel ConeOutsideVolume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideVolume,"ConeOutsideVolume","Channel controls volume outside of 3D sound outer cone of attached sources. n @see SFXDescription::coneOutsideVolume "); - public static readonly TypeSFXChannel Cursor = new TypeSFXChannel((int)R__SFXChannel.SFXChannelCursor,"Cursor","Channel controls playback cursor of attached sound sources. n n @note Be aware that different types of sound sources interpret play cursor positions differently or do not actually have play cursors (these sources will ignore the channel). "); - public static readonly TypeSFXChannel Status = new TypeSFXChannel((int)R__SFXChannel.SFXChannelStatus,"Status","Channel controls playback status of attached sound sources. n n The channel's value is rounded down to the nearest integer and interpreted in the following way: n - 1: Play n - 2: Stop n - 3: Pause n n "); - public static readonly TypeSFXChannel User0 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser0,"User0","Channel available for custom use. By default ignored by sources. n n @note For FMOD Designer event sources (SFXFMODEventSource), this channel is used for event parameters defined in FMOD Designer and should not be used otherwise. n n @see SFXSource::onParameterValueChange "); - public static readonly TypeSFXChannel User1 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser1,"User1","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); - public static readonly TypeSFXChannel User2 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser2,"User2","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); - public static readonly TypeSFXChannel User3 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser3,"User3","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel Volume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVolume,"Volume","Channel controls volume level of attached sound sources. n @see SFXDescription::volume "); + public static readonly TypeSFXChannel Pitch = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPitch,"Pitch","Channel controls pitch of attached sound sources. n @see SFXDescription::pitch "); + public static readonly TypeSFXChannel Priority = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPriority,"Priority","Channel controls virtualizaton priority level of attached sound sources. n @see SFXDescription::priority "); + public static readonly TypeSFXChannel PositionX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionX,"PositionX"," Channel controls X coordinate of 3D sound position of attached sources. "); + public static readonly TypeSFXChannel PositionY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionY,"PositionY"," Channel controls Y coordinate of 3D sound position of attached sources. "); + public static readonly TypeSFXChannel PositionZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionZ,"PositionZ"," Channel controls Z coordinate of 3D sound position of attached sources. "); + public static readonly TypeSFXChannel RotationX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationX,"RotationX"," Channel controls X rotation (in degrees) of 3D sound orientation of attached sources. "); + public static readonly TypeSFXChannel RotationY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationY,"RotationY"," Channel controls Y rotation (in degrees) of 3D sound orientation of attached sources. "); + public static readonly TypeSFXChannel RotationZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationZ,"RotationZ"," Channel controls Z rotation (in degrees) of 3D sound orientation of attached sources. "); + public static readonly TypeSFXChannel VelocityX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityX,"VelocityX"," Channel controls X coordinate of 3D sound velocity vector of attached sources. "); + public static readonly TypeSFXChannel VelocityY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityY,"VelocityY"," Channel controls Y coordinate of 3D sound velocity vector of attached sources. "); + public static readonly TypeSFXChannel VelocityZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityZ,"VelocityZ"," Channel controls Z coordinate of 3D sound velocity vector of attached sources. "); + public static readonly TypeSFXChannel ReferenceDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMinDistance,"ReferenceDistance","Channel controls reference distance of 3D sound of attached sources. n @see SFXDescription::referenceDistance "); + public static readonly TypeSFXChannel MaxDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMaxDistance,"MaxDistance","Channel controls max volume attenuation distance of 3D sound of attached sources. n @see SFXDescription::maxDistance "); + public static readonly TypeSFXChannel ConeInsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeInsideAngle,"ConeInsideAngle","Channel controls angle (in degrees) of 3D sound inner volume cone of attached sources. n @see SFXDescription::coneInsideAngle "); + public static readonly TypeSFXChannel ConeOutsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideAngle,"ConeOutsideAngle","Channel controls angle (in degrees) of 3D sound outer volume cone of attached sources. n @see SFXDescription::coneOutsideAngle "); + public static readonly TypeSFXChannel ConeOutsideVolume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideVolume,"ConeOutsideVolume","Channel controls volume outside of 3D sound outer cone of attached sources. n @see SFXDescription::coneOutsideVolume "); + public static readonly TypeSFXChannel Cursor = new TypeSFXChannel((int)R__SFXChannel.SFXChannelCursor,"Cursor","Channel controls playback cursor of attached sound sources. n n @note Be aware that different types of sound sources interpret play cursor positions differently or do not actually have play cursors (these sources will ignore the channel). "); + public static readonly TypeSFXChannel Status = new TypeSFXChannel((int)R__SFXChannel.SFXChannelStatus,"Status","Channel controls playback status of attached sound sources. n n The channel's value is rounded down to the nearest integer and interpreted in the following way: n - 1: Play n - 2: Stop n - 3: Pause n n "); + public static readonly TypeSFXChannel User0 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser0,"User0","Channel available for custom use. By default ignored by sources. n n @note For FMOD Designer event sources (SFXFMODEventSource), this channel is used for event parameters defined in FMOD Designer and should not be used otherwise. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel User1 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser1,"User1","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel User2 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser2,"User2","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel User3 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser3,"User3","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); }; /// @@ -7993,8 +7993,8 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXDistanceModel Linear = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLinear,"Linear","Volume attenuates linearly from the references distance onwards to max distance where it reaches zero. "); - public static readonly TypeSFXDistanceModel Logarithmic = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLogarithmic,"Logarithmic","Volume attenuates logarithmically starting from the reference distance and halving every reference distance step from there on. Attenuation stops at max distance but volume won't reach zero. "); + public static readonly TypeSFXDistanceModel Linear = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLinear,"Linear"," Volume attenuates linearly from the references distance onwards to max distance where it reaches zero. "); + public static readonly TypeSFXDistanceModel Logarithmic = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLogarithmic,"Logarithmic","Volume attenuates logarithmically starting from the reference distance and halving every reference distance step from there on. Attenuation stops at max distance but volume won't reach zero. "); }; /// @@ -8069,8 +8069,8 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListLoopMode All = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_All,"All","Loop over all slots, i.e. jump from last to first slot after all slots have played. "); - public static readonly TypeSFXPlayListLoopMode Single = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_Single,"Single","Loop infinitely over the current slot. Only useful in combination with either states or manual playlist control. "); + public static readonly TypeSFXPlayListLoopMode All = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_All,"All"," Loop over all slots, i.e. jump from last to first slot after all slots have played. "); + public static readonly TypeSFXPlayListLoopMode Single = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_Single,"Single"," Loop infinitely over the current slot. Only useful in combination with either states or manual playlist control. "); }; /// @@ -8145,9 +8145,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListRandomMode NotRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_NotRandom,"NotRandom","Play slots in sequential order. No randomization. "); - public static readonly TypeSFXPlayListRandomMode StrictRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_StrictRandom,"StrictRandom","Play a strictly random selection of slots. n n In this mode, a set of numSlotsToPlay random numbers between 0 and numSlotsToPlay-1 (inclusive), i.e. in the range of valid slot indices, is generated and playlist slots are played back in the order of this list. This allows the same slot to occur multiple times in a list and, consequentially, allows for other slots to not appear at all in a given slot ordering. "); - public static readonly TypeSFXPlayListRandomMode OrderedRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_OrderedRandom,"OrderedRandom","Play all slots in the list in a random order. n n In this mode, the @c numSlotsToPlay slots from the list with valid tracks assigned are put into a random order and played. This guarantees that each slots is played exactly once albeit at a random position in the total ordering. "); + public static readonly TypeSFXPlayListRandomMode NotRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_NotRandom,"NotRandom"," Play slots in sequential order. No randomization. "); + public static readonly TypeSFXPlayListRandomMode StrictRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_StrictRandom,"StrictRandom","Play a strictly random selection of slots. n n In this mode, a set of numSlotsToPlay random numbers between 0 and numSlotsToPlay-1 (inclusive), i.e. in the range of valid slot indices, is generated and playlist slots are played back in the order of this list. This allows the same slot to occur multiple times in a list and, consequentially, allows for other slots to not appear at all in a given slot ordering. "); + public static readonly TypeSFXPlayListRandomMode OrderedRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_OrderedRandom,"OrderedRandom","Play all slots in the list in a random order. n n In this mode, the @c numSlotsToPlay slots from the list with valid tracks assigned are put into a random order and played. This guarantees that each slots is played exactly once albeit at a random position in the total ordering. "); }; /// @@ -8222,11 +8222,11 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListReplayMode IgnorePlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_IgnorePlaying,"IgnorePlaying","Ignore any sources that may already be playing on the slot and just create a new source. "); - public static readonly TypeSFXPlayListReplayMode RestartPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_RestartPlaying,"RestartPlaying","Restart all sources that was last created for the slot. "); - public static readonly TypeSFXPlayListReplayMode KeepPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_KeepPlaying,"KeepPlaying","Keep playing the current source(s) as if the source started last on the slot was created in this cycle. For this, the sources associated with the slot are brought to the top of the play stack. "); - public static readonly TypeSFXPlayListReplayMode StartNew = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_StartNew,"StartNew","Stop all sources currently playing on the slot and then create a new source. "); - public static readonly TypeSFXPlayListReplayMode SkipIfPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_SkipIfPlaying,"SkipIfPlaying","If there are sources already playing on the slot, skip the play stage. "); + public static readonly TypeSFXPlayListReplayMode IgnorePlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_IgnorePlaying,"IgnorePlaying"," Ignore any sources that may already be playing on the slot and just create a new source. "); + public static readonly TypeSFXPlayListReplayMode RestartPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_RestartPlaying,"RestartPlaying"," Restart all sources that was last created for the slot. "); + public static readonly TypeSFXPlayListReplayMode KeepPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_KeepPlaying,"KeepPlaying","Keep playing the current source(s) as if the source started last on the slot was created in this cycle. For this, the sources associated with the slot are brought to the top of the play stack. "); + public static readonly TypeSFXPlayListReplayMode StartNew = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_StartNew,"StartNew"," Stop all sources currently playing on the slot and then create a new source. "); + public static readonly TypeSFXPlayListReplayMode SkipIfPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_SkipIfPlaying,"SkipIfPlaying"," If there are sources already playing on the slot, skip the play stage. "); }; /// @@ -8301,9 +8301,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListStateMode StopWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_StopInactive,"StopWhenDeactivated","Stop the sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. "); - public static readonly TypeSFXPlayListStateMode PauseWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_PauseInactive,"PauseWhenDeactivated","Pause all sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. n n When the slot's state is reactivated again, the sources will resume playback. "); - public static readonly TypeSFXPlayListStateMode IgnoreWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_IgnoreInactive,"IgnoreWhenDeactivated","Ignore when a state changes to a setting incompatible with the slot's state setting and just keep playing sources attached to the slot. "); + public static readonly TypeSFXPlayListStateMode StopWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_StopInactive,"StopWhenDeactivated","Stop the sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. "); + public static readonly TypeSFXPlayListStateMode PauseWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_PauseInactive,"PauseWhenDeactivated","Pause all sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. n n When the slot's state is reactivated again, the sources will resume playback. "); + public static readonly TypeSFXPlayListStateMode IgnoreWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_IgnoreInactive,"IgnoreWhenDeactivated","Ignore when a state changes to a setting incompatible with the slot's state setting and just keep playing sources attached to the slot. "); }; /// @@ -8378,11 +8378,11 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListTransitionMode None = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_None,"None","No transition. Immediately move on to processing the slot or immediately move on to the next slot. "); - public static readonly TypeSFXPlayListTransitionMode Wait = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Wait,"Wait","Wait for the sound source spawned last by this playlist to finish playing. Then proceed. "); - public static readonly TypeSFXPlayListTransitionMode WaitAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_WaitAll,"WaitAll","Wait for all sound sources currently spawned by the playlist to finish playing. Then proceed. "); - public static readonly TypeSFXPlayListTransitionMode Stop = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Stop,"Stop","Stop the sound source spawned last by this playlist. Then proceed. "); - public static readonly TypeSFXPlayListTransitionMode StopAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_StopAll,"StopAll","Stop all sound sources spawned by the playlist. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode None = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_None,"None"," No transition. Immediately move on to processing the slot or immediately move on to the next slot. "); + public static readonly TypeSFXPlayListTransitionMode Wait = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Wait,"Wait"," Wait for the sound source spawned last by this playlist to finish playing. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode WaitAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_WaitAll,"WaitAll"," Wait for all sound sources currently spawned by the playlist to finish playing. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode Stop = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Stop,"Stop"," Stop the sound source spawned last by this playlist. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode StopAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_StopAll,"StopAll"," Stop all sound sources spawned by the playlist. Then proceed. "); }; /// @@ -8457,9 +8457,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXStatus Playing = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPlaying,"Playing","The source is currently playing. "); - public static readonly TypeSFXStatus Stopped = new TypeSFXStatus((int)R__SFXStatus.SFXStatusStopped,"Stopped","Playback of the source is stopped. When transitioning to Playing state, playback will start at the beginning of the source. "); - public static readonly TypeSFXStatus Paused = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPaused,"Paused","Playback of the source is paused. Resuming playback will play from the current playback position. "); + public static readonly TypeSFXStatus Playing = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPlaying,"Playing"," The source is currently playing. "); + public static readonly TypeSFXStatus Stopped = new TypeSFXStatus((int)R__SFXStatus.SFXStatusStopped,"Stopped","Playback of the source is stopped. When transitioning to Playing state, playback will start at the beginning of the source. "); + public static readonly TypeSFXStatus Paused = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPaused,"Paused"," Playback of the source is paused. Resuming playback will play from the current playback position. "); }; /// @@ -8534,9 +8534,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeShadowFilterMode None = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_None,"None","@brief Simple point sampled filtering. n This is the fastest and lowest quality mode. "); - public static readonly TypeShadowFilterMode SoftShadow = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadow,"SoftShadow","@brief A variable tap rotated poisson disk soft shadow filter. n It performs 4 taps to classify the point as in shadow, out of shadow, or along a shadow edge. Samples on the edge get an additional 8 taps to soften them. "); - public static readonly TypeShadowFilterMode SoftShadowHighQuality = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadowHighQuality,"SoftShadowHighQuality","@brief A 12 tap rotated poisson disk soft shadow filter. n It performs all the taps for every point without any early rejection. "); + public static readonly TypeShadowFilterMode None = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_None,"None","@brief Simple point sampled filtering. n This is the fastest and lowest quality mode. "); + public static readonly TypeShadowFilterMode SoftShadow = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadow,"SoftShadow","@brief A variable tap rotated poisson disk soft shadow filter. n It performs 4 taps to classify the point as in shadow, out of shadow, or along a shadow edge. Samples on the edge get an additional 8 taps to soften them. "); + public static readonly TypeShadowFilterMode SoftShadowHighQuality = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadowHighQuality,"SoftShadowHighQuality","@brief A 12 tap rotated poisson disk soft shadow filter. n It performs all the taps for every point without any early rejection. "); }; /// diff --git a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Omni.Auto.cs b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Omni.Auto.cs index 127ae127..c3616d92 100644 --- a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Omni.Auto.cs +++ b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Omni.Auto.cs @@ -10,7 +10,12 @@ sealed public partial class Omni { /// -/// (aiConnect, S32 , 2, 20, (...) @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. @returns The newly created AIConnection @see GameConnection for parameter information @ingroup AI) +/// (aiConnect, S32 , 2, 20, (...) +/// @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. +/// @returns The newly created AIConnection +/// @see GameConnection for parameter information +/// @ingroup AI) +/// /// public int fn__aiConnect (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -78,7 +83,37 @@ public int fn__aiConnect (string a1, string a2, string a3, string a4, string a5, return SafeNativeMethods.mwle_fn__aiConnect(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( buildTaggedString, const char*, 2, 11, (string format, ...) @brief Build a string using the specified tagged string format. This function takes an already tagged string (passed in as a tagged string ID) and one or more additional strings. If the tagged string contains argument tags that range from %%1 through %%9, then each additional string will be substituted into the tagged string. The final (non-tagged) combined string will be returned. The maximum length of the tagged string plus any inserted additional strings is 511 characters. @param format A tagged string ID that contains zero or more argument tags, in the form of %%1 through %%9. @param ... A variable number of arguments that are insterted into the tagged string based on the argument tags within the format string. @returns An ordinary string that is a combination of the original tagged string with any additional strings passed in inserted in place of each argument tag. @tsexample // Create a tagged string with argument tags %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); // Some point later, combine the tagged string with some other string %string = buildTaggedString(%taggedStringID, %playerName); echo(%string); @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// ( buildTaggedString, const char*, 2, 11, (string format, ...) +/// @brief Build a string using the specified tagged string format. +/// +/// This function takes an already tagged string (passed in as a tagged string ID) and one +/// or more additional strings. If the tagged string contains argument tags that range from +/// %%1 through %%9, then each additional string will be substituted into the tagged string. +/// The final (non-tagged) combined string will be returned. The maximum length of the tagged +/// string plus any inserted additional strings is 511 characters. +/// +/// @param format A tagged string ID that contains zero or more argument tags, in the form of +/// %%1 through %%9. +/// @param ... A variable number of arguments that are insterted into the tagged string +/// based on the argument tags within the format string. +/// +/// @returns An ordinary string that is a combination of the original tagged string with any additional +/// strings passed in inserted in place of each argument tag. +/// +/// @tsexample +/// // Create a tagged string with argument tags +/// %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); +/// +/// // Some point later, combine the tagged string with some other string +/// %string = buildTaggedString(%taggedStringID, %playerName); +/// echo(%string); +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string fn__buildTaggedString (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10) @@ -122,7 +157,21 @@ public string fn__buildTaggedString (string a1, string a2, string a3, string a4, } /// -/// ( call, const char *, 2, 0, ( string functionName, string args... ) Apply the given arguments to the specified global function and return the result of the call. @param functionName The name of the function to call. This function must be in the global namespace, i.e. you cannot call a function in a namespace through #call. Use eval() for that. @return The result of the function call. @tsexample function myFunction( %arg ) { return ( %arg SPC \"World!\" ); } echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. @endtsexample @ingroup Scripting ) +/// ( call, const char *, 2, 0, ( string functionName, string args... ) +/// Apply the given arguments to the specified global function and return the result of the call. +/// @param functionName The name of the function to call. This function must be in the global namespace, i.e. +/// you cannot call a function in a namespace through #call. Use eval() for that. +/// @return The result of the function call. +/// @tsexample +/// function myFunction( %arg ) +/// { +/// return ( %arg SPC \"World!\" ); +/// } +/// +/// echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. +/// @endtsexample +/// @ingroup Scripting ) +/// /// public string fn__call (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -193,7 +242,37 @@ public string fn__call (string a1, string a2, string a3, string a4, string a5, s } /// -/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) @brief Send a command from the server to the client @param client The numeric ID of a client GameConnection @param func Name of the client function being called @param ... Various parameters being passed to client command @tsexample // Set up the client command. Needs to be executed on the client, such as // within scripts/client/client.cs // Update the Ammo Counter with current ammo, if not any then hide the counter. function clientCmdSetAmmoAmountHud(%amount) { if (!%amount) AmmoAmount.setVisible(false); else { AmmoAmount.setVisible(true); AmmoAmount.setText(\"Ammo: \"@%amount); } } // Call it from a server function. Needs to be executed on the server, //such as within scripts/server/game.cs function GameConnection::setAmmoAmountHud(%client, %amount) { commandToClient(%client, 'SetAmmoAmountHud', %amount); } @endtsexample @ingroup Networking) +/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) +/// @brief Send a command from the server to the client +/// +/// @param client The numeric ID of a client GameConnection +/// @param func Name of the client function being called +/// @param ... Various parameters being passed to client command +/// +/// @tsexample +/// // Set up the client command. Needs to be executed on the client, such as +/// // within scripts/client/client.cs +/// // Update the Ammo Counter with current ammo, if not any then hide the counter. +/// function clientCmdSetAmmoAmountHud(%amount) +/// { +/// if (!%amount) +/// AmmoAmount.setVisible(false); +/// else +/// { +/// AmmoAmount.setVisible(true); +/// AmmoAmount.setText(\"Ammo: \"@%amount); +/// } +/// } +/// // Call it from a server function. Needs to be executed on the server, +/// //such as within scripts/server/game.cs +/// function GameConnection::setAmmoAmountHud(%client, %amount) +/// { +/// commandToClient(%client, 'SetAmmoAmountHud', %amount); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void fn__commandToClient (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21) @@ -267,7 +346,42 @@ public void fn__commandToClient (string a1, string a2, string a3, string a4, str SafeNativeMethods.mwle_fn__commandToClient(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19, sba20, sba21); } /// -/// ( commandToServer, void, 2, 21, (string func, ...) @brief Send a command to the server. @param func Name of the server command being called @param ... Various parameters being passed to server command @tsexample // Create a standard function. Needs to be executed on the client, such // as within scripts/client/default.bind.cs function toggleCamera(%val) { // If key was down, call a server command named 'ToggleCamera' if (%val) commandToServer('ToggleCamera'); } // Server command being called from above. Needs to be executed on the // server, such as within scripts/server/commands.cs function serverCmdToggleCamera(%client) { if (%client.getControlObject() == %client.player) { %client.camera.setVelocity(\"0 0 0\"); %control = %client.camera; } else { %client.player.setVelocity(\"0 0 0\"); %control = %client.player; } %client.setControlObject(%control); clientCmdSyncEditorGui(); } @endtsexample @ingroup Networking) +/// ( commandToServer, void, 2, 21, (string func, ...) +/// @brief Send a command to the server. +/// +/// @param func Name of the server command being called +/// @param ... Various parameters being passed to server command +/// +/// @tsexample +/// // Create a standard function. Needs to be executed on the client, such +/// // as within scripts/client/default.bind.cs +/// function toggleCamera(%val) +/// { +/// // If key was down, call a server command named 'ToggleCamera' +/// if (%val) +/// commandToServer('ToggleCamera'); +/// } +/// // Server command being called from above. Needs to be executed on the +/// // server, such as within scripts/server/commands.cs +/// function serverCmdToggleCamera(%client) +/// { +/// if (%client.getControlObject() == %client.player) +/// { +/// %client.camera.setVelocity(\"0 0 0\"); +/// %control = %client.camera; +/// } +/// else +/// { +/// %client.player.setVelocity(\"0 0 0\"); +/// %control = %client.player; +/// } +/// %client.setControlObject(%control); +/// clientCmdSyncEditorGui(); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void fn__commandToServer (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20) @@ -338,7 +452,13 @@ public void fn__commandToServer (string a1, string a2, string a3, string a4, str SafeNativeMethods.mwle_fn__commandToServer(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19, sba20); } /// -/// ( echo, void, 2, 0, ( string message... ) @brief Logs a message to the console. Concatenates all given arguments to a single string and prints the string to the console. A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( echo, void, 2, 0, ( string message... ) +/// @brief Logs a message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console. +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void fn__echo (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -406,7 +526,14 @@ public void fn__echo (string a1, string a2, string a3, string a4, string a5, str SafeNativeMethods.mwle_fn__echo(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( error, void, 2, 0, ( string message... ) @brief Logs an error message to the console. Concatenates all given arguments to a single string and prints the string to the console as an error message (in the in-game console, these will show up using a red font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( error, void, 2, 0, ( string message... ) +/// @brief Logs an error message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as an error +/// message (in the in-game console, these will show up using a red font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void fn__error (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -474,7 +601,15 @@ public void fn__error (string a1, string a2, string a3, string a4, string a5, st SafeNativeMethods.mwle_fn__error(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) @brief Manually execute a special script file that contains game or editor preferences @param relativeFileName Name and path to file from project folder @param noCalls Deprecated @param journalScript Deprecated @return True if script was successfully executed @note Appears to be useless in Torque 3D, should be deprecated @ingroup Scripting) +/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) +/// @brief Manually execute a special script file that contains game or editor preferences +/// @param relativeFileName Name and path to file from project folder +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if script was successfully executed +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @ingroup Scripting) +/// /// public bool fn__execPrefs (string a1, string a2, string a3) @@ -494,7 +629,12 @@ public bool fn__execPrefs (string a1, string a2, string a3) return SafeNativeMethods.mwle_fn__execPrefs(sba1, sba2, sba3)>=1; } /// -/// (expandFilename, const char*, 2, 2, (string filename) @brief Grabs the full path of a specified file @param filename Name of the local file to locate @return String containing the full filepath on disk @ingroup FileSystem) +/// (expandFilename, const char*, 2, 2, (string filename) +/// @brief Grabs the full path of a specified file +/// @param filename Name of the local file to locate +/// @return String containing the full filepath on disk +/// @ingroup FileSystem) +/// /// public string fn__expandFilename (string a1) @@ -511,7 +651,11 @@ public string fn__expandFilename (string a1) } /// -/// (expandOldFilename, const char*, 2, 2, (string filename) @brief Retrofits a filepath that uses old Torque style @return String containing filepath with new formatting @ingroup FileSystem) +/// (expandOldFilename, const char*, 2, 2, (string filename) +/// @brief Retrofits a filepath that uses old Torque style +/// @return String containing filepath with new formatting +/// @ingroup FileSystem) +/// /// public string fn__expandOldFilename (string a1) @@ -528,7 +672,110 @@ public string fn__expandOldFilename (string a1) } /// -/// ( mathInit, void, 1, 10, ( ... ) @brief Install the math library with specified extensions. Possible parameters are: - 'DETECT' Autodetect math lib settings. - 'C' Enable the C math routines. C routines are always enabled. - 'FPU' Enable floating point unit routines. - 'MMX' Enable MMX math routines. - '3DNOW' Enable 3dNow! math routines. - 'SSE' Enable SSE math routines. @ingroup Math) +/// ( getStockColorCount, S32, 1, 1, () - Gets a count of available stock colors. +/// @return A count of available stock colors. ) +/// +/// + +public int fn__getStockColorCount () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorCount'"); + + +return SafeNativeMethods.mwle_fn__getStockColorCount(); +} +/// +/// ( getStockColorF, const char*, 2, 2, (stockColorName) - Gets a floating-point-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// + +public string fn__getStockColorF (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorF'" + string.Format("\"{0}\" ",a1)); +var returnbuff = new StringBuilder(16384); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +SafeNativeMethods.mwle_fn__getStockColorF(sba1, returnbuff); +return returnbuff.ToString(); + +} +/// +/// ( getStockColorI, const char*, 2, 2, (stockColorName) - Gets a byte-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// + +public string fn__getStockColorI (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorI'" + string.Format("\"{0}\" ",a1)); +var returnbuff = new StringBuilder(16384); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +SafeNativeMethods.mwle_fn__getStockColorI(sba1, returnbuff); +return returnbuff.ToString(); + +} +/// +/// ( getStockColorName, const char*, 2, 2, (stockColorIndex) - Gets the stock color name at the specified index. +/// @param stockColorIndex The zero-based index of the stock color name to retrieve. +/// @return The stock color name at the specified index or nothing if the string is invalid. ) +/// +/// + +public string fn__getStockColorName (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorName'" + string.Format("\"{0}\" ",a1)); +var returnbuff = new StringBuilder(16384); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +SafeNativeMethods.mwle_fn__getStockColorName(sba1, returnbuff); +return returnbuff.ToString(); + +} +/// +/// ( isStockColor, bool, 2, 2, (stockColorName) - Gets whether the specified name is a stock color or not. +/// @param stockColorName - The stock color name to test for. +/// @return Whether the specified name is a stock color or not. ) +/// +/// + +public bool fn__isStockColor (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__isStockColor'" + string.Format("\"{0}\" ",a1)); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +return SafeNativeMethods.mwle_fn__isStockColor(sba1)>=1; +} +/// +/// ( mathInit, void, 1, 10, ( ... ) +/// @brief Install the math library with specified extensions. +/// Possible parameters are: +/// - 'DETECT' Autodetect math lib settings. +/// - 'C' Enable the C math routines. C routines are always enabled. +/// - 'FPU' Enable floating point unit routines. +/// - 'MMX' Enable MMX math routines. +/// - '3DNOW' Enable 3dNow! math routines. +/// - 'SSE' Enable SSE math routines. +/// @ingroup Math) +/// +/// +/// /// public void fn__mathInit (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9) @@ -566,7 +813,12 @@ public void fn__mathInit (string a1, string a2, string a3, string a4, string a5, SafeNativeMethods.mwle_fn__mathInit(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9); } /// -/// (resourceDump, void, 1, 1, () @brief List the currently managed resources Currently used by editors only, internal @ingroup Editors @internal) +/// (resourceDump, void, 1, 1, () +/// @brief List the currently managed resources +/// Currently used by editors only, internal +/// @ingroup Editors +/// @internal) +/// /// public void fn__resourceDump () @@ -579,6 +831,7 @@ public void fn__resourceDump () } /// /// (schedule, S32, 4, 0, schedule(time, refobject|0, command, arg1...argN>)) +/// /// public int fn__schedule (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -647,6 +900,7 @@ public int fn__schedule (string a1, string a2, string a3, string a4, string a5, } /// /// (TestFunction2Args, const char *, 3, 3, testFunction(arg1, arg2)) +/// /// public string fn__TestFunction2Args (string a1, string a2) @@ -666,7 +920,14 @@ public string fn__TestFunction2Args (string a1, string a2) } /// -/// ( warn, void, 2, 0, ( string message... ) @brief Logs a warning message to the console. Concatenates all given arguments to a single string and prints the string to the console as a warning message (in the in-game console, these will show up using a turquoise font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( warn, void, 2, 0, ( string message... ) +/// @brief Logs a warning message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as a warning +/// message (in the in-game console, these will show up using a turquoise font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void fn__warn (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -734,7 +995,11 @@ public void fn__warn (string a1, string a2, string a3, string a4, string a5, str SafeNativeMethods.mwle_fn__warn(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// () @brief Activates DirectInput. Also activates any connected joysticks. @ingroup Input) +/// () +/// @brief Activates DirectInput. +/// Also activates any connected joysticks. +/// @ingroup Input) +/// /// public void fn_activateDirectInput () @@ -764,7 +1029,28 @@ public void fn_activatePackage (string packageName) SafeNativeMethods.mwle_fn_activatePackage(sbpackageName); } /// -/// @brief Add a string to the bad word filter The bad word filter is a table containing words which will not be displayed in chat windows. Instead, a designated replacement string will be displayed. There are already a number of bad words automatically defined. @param badWord Exact text of the word to restrict. @return True if word was successfully added, false if the word or a subset of it already exists in the table @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Returns true, word was successfully added addBadWord(%badWord); // Returns false, word has already been added addBadWord(\"Foobar\"); @endtsexample @ingroup Game) +/// @brief Add a string to the bad word filter +/// +/// The bad word filter is a table containing words which will not be +/// displayed in chat windows. Instead, a designated replacement string will be displayed. +/// There are already a number of bad words automatically defined. +/// +/// @param badWord Exact text of the word to restrict. +/// @return True if word was successfully added, false if the word or a subset of it already exists in the table +/// +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Returns true, word was successfully added +/// addBadWord(%badWord); +/// // Returns false, word has already been added +/// addBadWord(\"Foobar\"); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool fn_addBadWord (string badWord) @@ -778,7 +1064,13 @@ public bool fn_addBadWord (string badWord) return SafeNativeMethods.mwle_fn_addBadWord(sbbadWord)>=1; } /// -/// Adds a global shader macro which will be merged with the script defined macros on every shader. The macro will replace the value of an existing macro of the same name. For the new macro to take effect all the shaders in the system need to be reloaded. @see resetLightManager, removeGlobalShaderMacro @ingroup Rendering ) +/// Adds a global shader macro which will be merged with the script defined +/// macros on every shader. The macro will replace the value of an existing +/// macro of the same name. For the new macro to take effect all the shaders +/// in the system need to be reloaded. +/// @see resetLightManager, removeGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void fn_addGlobalShaderMacro (string name, string value) @@ -795,7 +1087,14 @@ public void fn_addGlobalShaderMacro (string name, string value) SafeNativeMethods.mwle_fn_addGlobalShaderMacro(sbname, sbvalue); } /// -/// (string texName, string matName) @brief Maps the given texture to the given material. Generates a console warning before overwriting. Material maps are used by terrain and interiors for triggering effects when an object moves onto a terrain block or interior surface using the associated texture. @ingroup Materials) +/// (string texName, string matName) +/// @brief Maps the given texture to the given material. +/// Generates a console warning before overwriting. +/// Material maps are used by terrain and interiors for triggering +/// effects when an object moves onto a terrain +/// block or interior surface using the associated texture. +/// @ingroup Materials) +/// /// public void fn_addMaterialMapping (string texName, string matName) @@ -812,7 +1111,19 @@ public void fn_addMaterialMapping (string texName, string matName) SafeNativeMethods.mwle_fn_addMaterialMapping(sbtexName, sbmatName); } /// -/// ), @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, so tagging the same string (excluding case differences) will be ignored as a duplicated tag. @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string @see \\ref syntaxDataTypes under Tagged %Strings @see removeTaggedString() @see getTaggedString() @ingroup Networking) +/// ), +/// @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable +/// +/// @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, +/// so tagging the same string (excluding case differences) will be ignored as a duplicated tag. +/// +/// @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see removeTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string fn_addTaggedString (string str) @@ -830,6 +1141,7 @@ public string fn_addTaggedString (string str) } /// /// ), 'playerName'[, 'AIClassType'] );) +/// /// public int fn_aiAddPlayer (string name, string ns) @@ -847,6 +1159,7 @@ public int fn_aiAddPlayer (string name, string ns) } /// /// ai.getAimLocation(); ) +/// /// public string fn_AIClient_getAimLocation (string aiclient) @@ -864,6 +1177,7 @@ public string fn_AIClient_getAimLocation (string aiclient) } /// /// ai.getLocation(); ) +/// /// public string fn_AIClient_getLocation (string aiclient) @@ -881,6 +1195,7 @@ public string fn_AIClient_getLocation (string aiclient) } /// /// ai.getMoveDestination(); ) +/// /// public string fn_AIClient_getMoveDestination (string aiclient) @@ -898,6 +1213,7 @@ public string fn_AIClient_getMoveDestination (string aiclient) } /// /// ai.getTargetObject(); ) +/// /// public int fn_AIClient_getTargetObject (string aiclient) @@ -912,6 +1228,7 @@ public int fn_AIClient_getTargetObject (string aiclient) } /// /// ai.missionCycleCleanup(); ) +/// /// public void fn_AIClient_missionCycleCleanup (string aiclient) @@ -926,6 +1243,7 @@ public void fn_AIClient_missionCycleCleanup (string aiclient) } /// /// ai.move(); ) +/// /// public void fn_AIClient_move (string aiclient) @@ -940,6 +1258,7 @@ public void fn_AIClient_move (string aiclient) } /// /// ai.moveForward(); ) +/// /// public void fn_AIClient_moveForward (string aiclient) @@ -954,6 +1273,7 @@ public void fn_AIClient_moveForward (string aiclient) } /// /// ai.setAimLocation( x y z ); ) +/// /// public void fn_AIClient_setAimLocation (string aiclient, string v) @@ -971,6 +1291,7 @@ public void fn_AIClient_setAimLocation (string aiclient, string v) } /// /// ai.setMoveDestination( x y z ); ) +/// /// public void fn_AIClient_setMoveDestination (string aiclient, string v) @@ -988,6 +1309,7 @@ public void fn_AIClient_setMoveDestination (string aiclient, string v) } /// /// ai.setMoveSpeed( float ); ) +/// /// public void fn_AIClient_setMoveSpeed (string aiclient, float speed) @@ -1002,6 +1324,7 @@ public void fn_AIClient_setMoveSpeed (string aiclient, float speed) } /// /// ai.setTargetObject( obj ); ) +/// /// public void fn_AIClient_setTargetObject (string aiclient, string objName) @@ -1019,6 +1342,7 @@ public void fn_AIClient_setTargetObject (string aiclient, string objName) } /// /// ai.stop(); ) +/// /// public void fn_AIClient_stop (string aiclient) @@ -1033,6 +1357,7 @@ public void fn_AIClient_stop (string aiclient) } /// /// ) +/// /// public string fn_AIConnection_getAddress (string aiconnection) @@ -1049,7 +1374,9 @@ public string fn_AIConnection_getAddress (string aiconnection) } /// -/// getFreeLook() Is freelook on for the current move?) +/// getFreeLook() +/// Is freelook on for the current move?) +/// /// public bool fn_AIConnection_getFreeLook (string aiconnection) @@ -1063,7 +1390,11 @@ public bool fn_AIConnection_getFreeLook (string aiconnection) return SafeNativeMethods.mwle_fn_AIConnection_getFreeLook(sbaiconnection)>=1; } /// -/// (string field) Get the given field of a move. @param field One of {'x','y','z','yaw','pitch','roll'} @returns The requested field on the current move.) +/// (string field) +/// Get the given field of a move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @returns The requested field on the current move.) +/// /// public float fn_AIConnection_getMove (string aiconnection, string field) @@ -1080,7 +1411,9 @@ public float fn_AIConnection_getMove (string aiconnection, string field) return SafeNativeMethods.mwle_fn_AIConnection_getMove(sbaiconnection, sbfield); } /// -/// (int trigger) Is the given trigger set?) +/// (int trigger) +/// Is the given trigger set?) +/// /// public bool fn_AIConnection_getTrigger (string aiconnection, int idx) @@ -1094,7 +1427,9 @@ public bool fn_AIConnection_getTrigger (string aiconnection, int idx) return SafeNativeMethods.mwle_fn_AIConnection_getTrigger(sbaiconnection, idx)>=1; } /// -/// (bool isFreeLook) Enable/disable freelook on the current move.) +/// (bool isFreeLook) +/// Enable/disable freelook on the current move.) +/// /// public void fn_AIConnection_setFreeLook (string aiconnection, bool isFreeLook) @@ -1108,7 +1443,11 @@ public void fn_AIConnection_setFreeLook (string aiconnection, bool isFreeLook) SafeNativeMethods.mwle_fn_AIConnection_setFreeLook(sbaiconnection, isFreeLook); } /// -/// (string field, float value) Set a field on the current move. @param field One of {'x','y','z','yaw','pitch','roll'} @param value Value to set field to.) +/// (string field, float value) +/// Set a field on the current move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @param value Value to set field to.) +/// /// public void fn_AIConnection_setMove (string aiconnection, string field, float value) @@ -1125,7 +1464,9 @@ public void fn_AIConnection_setMove (string aiconnection, string field, float va SafeNativeMethods.mwle_fn_AIConnection_setMove(sbaiconnection, sbfield, value); } /// -/// (int trigger, bool set) Set a trigger.) +/// (int trigger, bool set) +/// Set a trigger.) +/// /// public void fn_AIConnection_setTrigger (string aiconnection, int idx, bool set) @@ -1139,7 +1480,10 @@ public void fn_AIConnection_setTrigger (string aiconnection, int idx, bool set) SafeNativeMethods.mwle_fn_AIConnection_setTrigger(sbaiconnection, idx, set); } /// -/// ( GameBase obj, [Point3F offset] ) Sets the bot's target object. Optionally set an offset from target location. @hide) +/// ( GameBase obj, [Point3F offset] ) +/// Sets the bot's target object. Optionally set an offset from target location. +/// @hide) +/// /// public void fn_AIPlayer_setAimObject (string aiplayer, string objName, string offset) @@ -1159,7 +1503,13 @@ public void fn_AIPlayer_setAimObject (string aiplayer, string objName, string of SafeNativeMethods.mwle_fn_AIPlayer_setAimObject(sbaiplayer, sbobjName, sboffset); } /// -/// allowConnections(bool allow) @brief Sets whether or not the global NetInterface allows connections from remote hosts. @param allow Set to true to allow remote connections. @ingroup Networking) +/// allowConnections(bool allow) +/// @brief Sets whether or not the global NetInterface allows connections from remote hosts. +/// +/// @param allow Set to true to allow remote connections. +/// +/// @ingroup Networking) +/// /// public void fn_allowConnections (bool allow) @@ -1186,7 +1536,16 @@ public void fn_backtrace () SafeNativeMethods.mwle_fn_backtrace(); } /// -/// CSV), (location, [backend]) - @brief Takes a string informing the backend where to store sample data and optionally a name of the specific logging backend to use. The default is the CSV backend. In most cases, the logging store will be a file name. @tsexample beginSampling( \"mysamples.csv\" ); @endtsexample @ingroup Rendering) +/// CSV), (location, [backend]) - +/// @brief Takes a string informing the backend where to store +/// sample data and optionally a name of the specific logging +/// backend to use. The default is the CSV backend. In most +/// cases, the logging store will be a file name. +/// @tsexample +/// beginSampling( \"mysamples.csv\" ); +/// @endtsexample +/// @ingroup Rendering) +/// /// public void fn_beginSampling (string location, string backend) @@ -1203,7 +1562,26 @@ public void fn_beginSampling (string location, string backend) SafeNativeMethods.mwle_fn_beginSampling(sblocation, sbbackend); } /// -/// @brief Calculates how much an explosion effects a specific object. Use this to determine how much damage to apply to objects based on their distance from the explosion's center point, and whether the explosion is blocked by other objects. @param pos Center position of the explosion. @param id Id of the object of which to check coverage. @param covMask Mask of object types that may block the explosion. @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) @tsexample // Get the position of the explosion. %position = %explosion.getPosition(); // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType // Acquire the damage value from 0.0f - 1.0f. %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); // Apply damage to object %sceneObject.applyDamage( %coverage * 20 ); @endtsexample @ingroup FX) +/// @brief Calculates how much an explosion effects a specific object. +/// Use this to determine how much damage to apply to objects based on their +/// distance from the explosion's center point, and whether the explosion is +/// blocked by other objects. +/// @param pos Center position of the explosion. +/// @param id Id of the object of which to check coverage. +/// @param covMask Mask of object types that may block the explosion. +/// @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) +/// @tsexample +/// // Get the position of the explosion. +/// %position = %explosion.getPosition(); +/// // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. +/// %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType +/// // Acquire the damage value from 0.0f - 1.0f. +/// %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); +/// // Apply damage to object +/// %sceneObject.applyDamage( %coverage * 20 ); +/// @endtsexample +/// @ingroup FX) +/// /// public float fn_calcExplosionCoverage (string pos, int id, uint covMask) @@ -1218,6 +1596,7 @@ public float fn_calcExplosionCoverage (string pos, int id, uint covMask) } /// /// cancel(eventId)) +/// /// public void fn_cancel (int eventId) @@ -1229,6 +1608,7 @@ public void fn_cancel (int eventId) } /// /// cancelAll(objectId): cancel pending events on the specified object. Events will be automatically cancelled if object is deleted.) +/// /// public void fn_cancelAll (string objectId) @@ -1243,6 +1623,7 @@ public void fn_cancelAll (string objectId) } /// /// cancelServerQuery(...); ) +/// /// public void fn_cancelServerQuery () @@ -1254,7 +1635,9 @@ public void fn_cancelServerQuery () SafeNativeMethods.mwle_fn_cancelServerQuery(); } /// -/// Release the unused pooled textures in texture manager freeing up video memory. @ingroup GFX ) +/// Release the unused pooled textures in texture manager freeing up video memory. +/// @ingroup GFX ) +/// /// public void fn_cleanupTexturePool () @@ -1267,6 +1650,7 @@ public void fn_cleanupTexturePool () } /// /// ) +/// /// public void fn_clearClientPaths () @@ -1278,7 +1662,11 @@ public void fn_clearClientPaths () SafeNativeMethods.mwle_fn_clearClientPaths(); } /// -/// Clears the flagged state on all allocated GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// Clears the flagged state on all allocated GFX resources. +/// See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// /// public void fn_clearGFXResourceFlags () @@ -1291,6 +1679,7 @@ public void fn_clearGFXResourceFlags () } /// /// ) +/// /// public void fn_clearServerPaths () @@ -1302,7 +1691,25 @@ public void fn_clearServerPaths () SafeNativeMethods.mwle_fn_clearServerPaths(); } /// -/// () @brief Closes the current network port @ingroup Networking) +/// () +/// Returns all pop'd out windows to the main canvas. +/// ) +/// +/// + +public void fn_CloseAllPopOuts () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_CloseAllPopOuts'"); + + +SafeNativeMethods.mwle_fn_CloseAllPopOuts(); +} +/// +/// () +/// @brief Closes the current network port +/// @ingroup Networking) +/// /// public void fn_closeNetPort () @@ -1314,7 +1721,42 @@ public void fn_closeNetPort () SafeNativeMethods.mwle_fn_closeNetPort(); } /// -/// Replace all escape sequences in @a text with their respective character codes. This function replaces all escape sequences (\\\, \\\\t, etc) in the given string with the respective characters they represent. The primary use of this function is for converting strings from their literal form into their compiled/translated form, as is normally done by the TorqueScript compiler. @param text A string. @return A duplicate of @a text with all escape sequences replaced by their respective character codes. @tsexample // Print: // // str // ing // // to the console. Note how the backslash in the string must be escaped here // in order to prevent the TorqueScript compiler from collapsing the escape // sequence in the resulting string. echo( collapseEscape( \"str\ing\" ) ); @endtsexample @see expandEscape @ingroup Strings ) +/// Close our startup splash window. +/// @note This is currently only implemented on Windows. +/// @ingroup Platform ) +/// +/// + +public void fn_closeSplashWindow () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_closeSplashWindow'"); + + +SafeNativeMethods.mwle_fn_closeSplashWindow(); +} +/// +/// Replace all escape sequences in @a text with their respective character codes. +/// This function replaces all escape sequences (\\\, \\\\t, etc) in the given string +/// with the respective characters they represent. +/// The primary use of this function is for converting strings from their literal form into +/// their compiled/translated form, as is normally done by the TorqueScript compiler. +/// @param text A string. +/// @return A duplicate of @a text with all escape sequences replaced by their respective character codes. +/// @tsexample +/// // Print: +/// // +/// // str +/// // ing +/// // +/// // to the console. Note how the backslash in the string must be escaped here +/// // in order to prevent the TorqueScript compiler from collapsing the escape +/// // sequence in the resulting string. +/// echo( collapseEscape( \"str\ing\" ) ); +/// @endtsexample +/// @see expandEscape +/// @ingroup Strings ) +/// /// public string fn_collapseEscape (string text) @@ -1331,7 +1773,20 @@ public string fn_collapseEscape (string text) } /// -/// Compile a file to bytecode. This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file in the current DSO path mirrorring the path of @a fileName. @param fileName Path to the file to compile to bytecode. @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not generate write compiled code to DSO files. @return True if the file was successfully compiled, false if not. @note The definitions contained in the given file will not be made available and no code will actually be executed. Use exec() for that. @see getDSOPath @see exec @ingroup Scripting ) +/// Compile a file to bytecode. +/// This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, +/// if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file +/// in the current DSO path mirrorring the path of @a fileName. +/// @param fileName Path to the file to compile to bytecode. +/// @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not +/// generate write compiled code to DSO files. +/// @return True if the file was successfully compiled, false if not. +/// @note The definitions contained in the given file will not be made available and no code will actually +/// be executed. Use exec() for that. +/// @see getDSOPath +/// @see exec +/// @ingroup Scripting ) +/// /// public bool fn_compile (string fileName, bool overrideNoDSO) @@ -1346,6 +1801,7 @@ public bool fn_compile (string fileName, bool overrideNoDSO) } /// /// addAction( UndoAction ) ) +/// /// public void fn_CompoundUndoAction_addAction (string compoundundoaction, string objName) @@ -1363,6 +1819,7 @@ public void fn_CompoundUndoAction_addAction (string compoundundoaction, string o } /// /// Exports console definition XML representation ) +/// /// public string fn_consoleExportXML () @@ -1377,7 +1834,22 @@ public string fn_consoleExportXML () } /// -/// () Attaches the logger to the console and begins writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Attaches the logger to the console and begins writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool fn_ConsoleLogger_attach (string consolelogger) @@ -1391,7 +1863,22 @@ public bool fn_ConsoleLogger_attach (string consolelogger) return SafeNativeMethods.mwle_fn_ConsoleLogger_attach(sbconsolelogger)>=1; } /// -/// () Detaches the logger from the console and stops writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Detaches the logger from the console and stops writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool fn_ConsoleLogger_detach (string consolelogger) @@ -1405,7 +1892,21 @@ public bool fn_ConsoleLogger_detach (string consolelogger) return SafeNativeMethods.mwle_fn_ConsoleLogger_detach(sbconsolelogger)>=1; } /// -/// @brief See if any objects of the given types are present in box of given extent. @note Extent parameter is last since only one radius is often needed. If one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, if you need to use the client container, you'll need to set all of the radius parameters. Fortunately, this function is mostly used on the server. @param mask Indicates the type of objects we are checking against. @param center Center of box. @param xRadius Search radius in the x-axis. See note above. @param yRadius Search radius in the y-axis. See note above. @param zRadius Search radius in the z-axis. See note above. @param useClientContainer Optionally indicates the search should be within the client container. @return true if the box is empty, false if any object is found. @ingroup Game) +/// @brief See if any objects of the given types are present in box of given extent. +/// @note Extent parameter is last since only one radius is often needed. If +/// one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, +/// if you need to use the client container, you'll need to set all of the radius parameters. +/// Fortunately, this function is mostly used on the server. +/// @param mask Indicates the type of objects we are checking against. +/// @param center Center of box. +/// @param xRadius Search radius in the x-axis. See note above. +/// @param yRadius Search radius in the y-axis. See note above. +/// @param zRadius Search radius in the z-axis. See note above. +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return true if the box is empty, false if any object is found. +/// @ingroup Game) +/// /// public bool fn_containerBoxEmpty (uint mask, string center, float xRadius, float yRadius, float zRadius, bool useClientContainer) @@ -1419,7 +1920,13 @@ public bool fn_containerBoxEmpty (uint mask, string center, float xRadius, float return SafeNativeMethods.mwle_fn_containerBoxEmpty(mask, sbcenter, xRadius, yRadius, zRadius, useClientContainer)>=1; } /// -/// (int mask, Point3F point, float x, float y, float z) @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more results using containerFindNext(). @see containerFindNext @ingroup Game) +/// (int mask, Point3F point, float x, float y, float z) +/// @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. +/// @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more +/// results using containerFindNext(). +/// @see containerFindNext +/// @ingroup Game) +/// /// public string fn_containerFindFirst (uint typeMask, string origin, string size) @@ -1439,7 +1946,13 @@ public string fn_containerFindFirst (uint typeMask, string origin, string size) } /// -/// () @brief Get more results from a previous call to containerFindFirst(). @note You must call containerFindFirst() to begin the search. @returns The next object found, or an empty string if nothing else was found. @see containerFindFirst() @ingroup Game) +/// () +/// @brief Get more results from a previous call to containerFindFirst(). +/// @note You must call containerFindFirst() to begin the search. +/// @returns The next object found, or an empty string if nothing else was found. +/// @see containerFindFirst() +/// @ingroup Game) +/// /// public string fn_containerFindNext () @@ -1454,7 +1967,26 @@ public string fn_containerFindNext () } /// -/// @brief Cast a ray from start to end, checking for collision against items matching mask. If pExempt is specified, then it is temporarily excluded from collision checks (For instance, you might want to exclude the player if said player was firing a weapon.) @param start An XYZ vector containing the tail position of the ray. @param end An XYZ vector containing the head position of the ray @param mask A bitmask corresponding to the type of objects to check for @param pExempt An optional ID for a single object that ignored for this raycast @param useClientContainer Optionally indicates the search should be within the client container. @returns A string containing either null, if nothing was struck, or these fields: ul>li>The ID of the object that was struck./li> li>The x, y, z position that it was struck./li> li>The x, y, z of the normal of the face that was struck./li> li>The distance between the start point and the position we hit./li>/ul> @ingroup Game) +/// @brief Cast a ray from start to end, checking for collision against items matching mask. +/// +/// If pExempt is specified, then it is temporarily excluded from collision checks (For +/// instance, you might want to exclude the player if said player was firing a weapon.) +/// +/// @param start An XYZ vector containing the tail position of the ray. +/// @param end An XYZ vector containing the head position of the ray +/// @param mask A bitmask corresponding to the type of objects to check for +/// @param pExempt An optional ID for a single object that ignored for this raycast +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @returns A string containing either null, if nothing was struck, or these fields: +/// ul>li>The ID of the object that was struck./li> +/// li>The x, y, z position that it was struck./li> +/// li>The x, y, z of the normal of the face that was struck./li> +/// li>The distance between the start point and the position we hit./li>/ul> +/// +/// @ingroup Game) +/// /// public string fn_containerRayCast (string start, string end, uint mask, string pExempt, bool useClientContainer) @@ -1477,7 +2009,17 @@ public string fn_containerRayCast (string start, string end, uint mask, string p } /// -/// @brief Get distance of the center of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the center of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get distance of the center of the current item from the center of the +/// current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the center of the current object to the center of +/// the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float fn_containerSearchCurrDist (bool useClientContainer) @@ -1488,7 +2030,17 @@ public float fn_containerSearchCurrDist (bool useClientContainer) return SafeNativeMethods.mwle_fn_containerSearchCurrDist(useClientContainer); } /// -/// @brief Get the distance of the closest point of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the closest point of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get the distance of the closest point of the current item from the center +/// of the current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the closest point of the current object to the +/// center of the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float fn_containerSearchCurrRadiusDist (bool useClientContainer) @@ -1499,7 +2051,29 @@ public float fn_containerSearchCurrRadiusDist (bool useClientContainer) return SafeNativeMethods.mwle_fn_containerSearchCurrRadiusDist(useClientContainer); } /// -/// @brief Get next item from a search started with initContainerRadiusSearch() or initContainerTypeSearch(). @param useClientContainer Optionally indicates the search should be within the client container. @return the next object found in the search, or null if no more @tsexample // print the names of all nearby ShapeBase derived objects %position = %obj.getPosition; %radius = 20; %mask = $TypeMasks::ShapeBaseObjectType; initContainerRadiusSearch( %position, %radius, %mask ); while ( (%targetObject = containerSearchNext()) != 0 ) { echo( \"Found: \" @ %targetObject.getName() ); } @endtsexample @see initContainerRadiusSearch() @see initContainerTypeSearch() @ingroup Game) +/// @brief Get next item from a search started with initContainerRadiusSearch() or +/// initContainerTypeSearch(). +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return the next object found in the search, or null if no more +/// +/// @tsexample +/// // print the names of all nearby ShapeBase derived objects +/// %position = %obj.getPosition; +/// %radius = 20; +/// %mask = $TypeMasks::ShapeBaseObjectType; +/// initContainerRadiusSearch( %position, %radius, %mask ); +/// while ( (%targetObject = containerSearchNext()) != 0 ) +/// { +/// echo( \"Found: \" @ %targetObject.getName() ); +/// } +/// @endtsexample +/// +/// @see initContainerRadiusSearch() +/// @see initContainerTypeSearch() +/// @ingroup Game) +/// /// public string fn_containerSearchNext (bool useClientContainer) @@ -1513,7 +2087,40 @@ public string fn_containerSearchNext (bool useClientContainer) } /// -/// @brief Checks to see if text is a bad word The text is considered to be a bad word if it has been added to the bad word filter. @param text Text to scan for bad words @return True if the text has bad word(s), false if it is clean @see addBadWord() @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Add a banned word to the bad word filter addBadWord(%badWord); // Create the base string, can come from anywhere like user chat %userText = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // If the text contains a bad word, filter it before printing // Otherwise print the original text if(containsBadWords(%userText)) { // Filter the string %filteredText = filterString(%userText, %replacementChars); // Print filtered text echo(%filteredText); } else echo(%userText); @endtsexample @ingroup Game) +/// @brief Checks to see if text is a bad word +/// +/// The text is considered to be a bad word if it has been added to the bad word filter. +/// +/// @param text Text to scan for bad words +/// @return True if the text has bad word(s), false if it is clean +/// +/// @see addBadWord() +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Add a banned word to the bad word filter +/// addBadWord(%badWord); +/// // Create the base string, can come from anywhere like user chat +/// %userText = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // If the text contains a bad word, filter it before printing +/// // Otherwise print the original text +/// if(containsBadWords(%userText)) +/// { +/// // Filter the string +/// %filteredText = filterString(%userText, %replacementChars); +/// // Print filtered text +/// echo(%filteredText); +/// } +/// else +/// echo(%userText); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool fn_containsBadWords (string text) @@ -1527,7 +2134,11 @@ public bool fn_containsBadWords (string text) return SafeNativeMethods.mwle_fn_containsBadWords(sbtext)>=1; } /// -/// Count the number of bits that are set in the given 32 bit integer. @param v An integer value. @return The number of bits that are set in @a v. @ingroup Utilities ) +/// Count the number of bits that are set in the given 32 bit integer. +/// @param v An integer value. +/// @return The number of bits that are set in @a v. +/// @ingroup Utilities ) +/// /// public int fn_countBits (int v) @@ -1538,7 +2149,14 @@ public int fn_countBits (int v) return SafeNativeMethods.mwle_fn_countBits(v); } /// -/// @brief Create the given directory or the path leading to the given filename. If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components of the path will be created. @param path The path to create. @note Only present in a Tools build of Torque. @ingroup FileSystem ) +/// @brief Create the given directory or the path leading to the given filename. +/// If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, +/// does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components +/// of the path will be created. +/// @param path The path to create. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem ) +/// /// public bool fn_createPath (string path) @@ -1553,6 +2171,7 @@ public bool fn_createPath (string path) } /// /// (string group, string name, string value)) +/// /// public int fn_CreatorTree_addGroup (string creatortree, int group, string name, string value) @@ -1573,6 +2192,7 @@ public int fn_CreatorTree_addGroup (string creatortree, int group, string name, } /// /// (Node group, string name, string value)) +/// /// public int fn_CreatorTree_addItem (string creatortree, int group, string name, string value) @@ -1593,6 +2213,7 @@ public int fn_CreatorTree_addItem (string creatortree, int group, string name, s } /// /// Clear the tree.) +/// /// public void fn_CreatorTree_clear (string creatortree) @@ -1607,6 +2228,7 @@ public void fn_CreatorTree_clear (string creatortree) } /// /// (string world, string type, string filename)) +/// /// public bool fn_CreatorTree_fileNameMatch (string creatortree, string world, string type, string filename) @@ -1630,6 +2252,7 @@ public bool fn_CreatorTree_fileNameMatch (string creatortree, string world, stri } /// /// (Node item)) +/// /// public string fn_CreatorTree_getName (string creatortree, string item) @@ -1650,6 +2273,7 @@ public string fn_CreatorTree_getName (string creatortree, string item) } /// /// (Node n)) +/// /// public int fn_CreatorTree_getParent (string creatortree, int nodeValue) @@ -1664,6 +2288,7 @@ public int fn_CreatorTree_getParent (string creatortree, int nodeValue) } /// /// Return a handle to the currently selected item.) +/// /// public int fn_CreatorTree_getSelected (string creatortree) @@ -1678,6 +2303,7 @@ public int fn_CreatorTree_getSelected (string creatortree) } /// /// (Node n)) +/// /// public string fn_CreatorTree_getValue (string creatortree, int nodeValue) @@ -1695,6 +2321,7 @@ public string fn_CreatorTree_getValue (string creatortree, int nodeValue) } /// /// (Group g)) +/// /// public bool fn_CreatorTree_isGroup (string creatortree, string group) @@ -1711,7 +2338,10 @@ public bool fn_CreatorTree_isGroup (string creatortree, string group) return SafeNativeMethods.mwle_fn_CreatorTree_isGroup(sbcreatortree, sbgroup)>=1; } /// -/// () Forcibly disconnects any attached script debugging client. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Forcibly disconnects any attached script debugging client. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void fn_dbgDisconnect () @@ -1723,7 +2353,9 @@ public void fn_dbgDisconnect () SafeNativeMethods.mwle_fn_dbgDisconnect(); } /// -/// () Clear all break points in the current file.) +/// () +/// Clear all break points in the current file.) +/// /// public void fn_DbgFileView_clearBreakPositions (string dbgfileview) @@ -1737,7 +2369,10 @@ public void fn_DbgFileView_clearBreakPositions (string dbgfileview) SafeNativeMethods.mwle_fn_DbgFileView_clearBreakPositions(sbdbgfileview); } /// -/// (string findThis) Find the specified string in the currently viewed file and scroll it into view.) +/// (string findThis) +/// Find the specified string in the currently viewed file and +/// scroll it into view.) +/// /// public bool fn_DbgFileView_findString (string dbgfileview, string findThis) @@ -1754,7 +2389,11 @@ public bool fn_DbgFileView_findString (string dbgfileview, string findThis) return SafeNativeMethods.mwle_fn_DbgFileView_findString(sbdbgfileview, sbfindThis)>=1; } /// -/// () Get the currently executing file and line, if any. @returns A string containing the file, a tab, and then the line number. Use getField() with this.) +/// () +/// Get the currently executing file and line, if any. +/// @returns A string containing the file, a tab, and then the line number. +/// Use getField() with this.) +/// /// public string fn_DbgFileView_getCurrentLine (string dbgfileview) @@ -1771,7 +2410,10 @@ public string fn_DbgFileView_getCurrentLine (string dbgfileview) } /// -/// (string filename) Open a file for viewing. @note This loads the file from the local system.) +/// (string filename) +/// Open a file for viewing. +/// @note This loads the file from the local system.) +/// /// public bool fn_DbgFileView_open (string dbgfileview, string filename) @@ -1788,7 +2430,9 @@ public bool fn_DbgFileView_open (string dbgfileview, string filename) return SafeNativeMethods.mwle_fn_DbgFileView_open(sbdbgfileview, sbfilename)>=1; } /// -/// (int line) Remove a breakpoint from the specified line.) +/// (int line) +/// Remove a breakpoint from the specified line.) +/// /// public void fn_DbgFileView_removeBreak (string dbgfileview, uint line) @@ -1802,7 +2446,9 @@ public void fn_DbgFileView_removeBreak (string dbgfileview, uint line) SafeNativeMethods.mwle_fn_DbgFileView_removeBreak(sbdbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void fn_DbgFileView_setBreak (string dbgfileview, uint line) @@ -1816,7 +2462,9 @@ public void fn_DbgFileView_setBreak (string dbgfileview, uint line) SafeNativeMethods.mwle_fn_DbgFileView_setBreak(sbdbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void fn_DbgFileView_setBreakPosition (string dbgfileview, uint line) @@ -1830,7 +2478,9 @@ public void fn_DbgFileView_setBreakPosition (string dbgfileview, uint line) SafeNativeMethods.mwle_fn_DbgFileView_setBreakPosition(sbdbgfileview, line); } /// -/// (int line, bool selected) Set the current highlighted line.) +/// (int line, bool selected) +/// Set the current highlighted line.) +/// /// public void fn_DbgFileView_setCurrentLine (string dbgfileview, int line, bool selected) @@ -1844,7 +2494,10 @@ public void fn_DbgFileView_setCurrentLine (string dbgfileview, int line, bool se SafeNativeMethods.mwle_fn_DbgFileView_setCurrentLine(sbdbgfileview, line, selected); } /// -/// () Returns true if a script debugging client is connected else return false. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Returns true if a script debugging client is connected else return false. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public bool fn_dbgIsConnected () @@ -1856,7 +2509,11 @@ public bool fn_dbgIsConnected () return SafeNativeMethods.mwle_fn_dbgIsConnected()>=1; } /// -/// ( int port, string password, bool waitForClient ) Open a debug server port on the specified port, requiring the specified password, and optionally waiting for the debug client to connect. @internal Primarily used for Torsion and other debugging tools) +/// ( int port, string password, bool waitForClient ) +/// Open a debug server port on the specified port, requiring the specified password, +/// and optionally waiting for the debug client to connect. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void fn_dbgSetParameters (int port, string password, bool waitForClient) @@ -1870,7 +2527,11 @@ public void fn_dbgSetParameters (int port, string password, bool waitForClient) SafeNativeMethods.mwle_fn_dbgSetParameters(port, sbpassword, waitForClient); } /// -/// () @brief Disables DirectInput. Also deactivates any connected joysticks. @ingroup Input ) +/// () +/// @brief Disables DirectInput. +/// Also deactivates any connected joysticks. +/// @ingroup Input ) +/// /// public void fn_deactivateDirectInput () @@ -1901,7 +2562,12 @@ public void fn_deactivatePackage (string packageName) SafeNativeMethods.mwle_fn_deactivatePackage(sbpackageName); } /// -/// Drops the engine into the native C++ debugger. This function triggers a debug break and drops the process into the IDE's debugger. If the process is not running with a debugger attached it will generate a runtime error on most platforms. @note This function is not available in shipping builds. @ingroup Debugging ) +/// Drops the engine into the native C++ debugger. +/// This function triggers a debug break and drops the process into the IDE's debugger. If the process is not +/// running with a debugger attached it will generate a runtime error on most platforms. +/// @note This function is not available in shipping builds. +/// @ingroup Debugging ) +/// /// public void fn_debug () @@ -1913,7 +2579,10 @@ public void fn_debug () SafeNativeMethods.mwle_fn_debug(); } /// -/// @brief Dumps all current EngineObject instances to the console. @note This function is only available in debug builds. @ingroup Debugging ) +/// @brief Dumps all current EngineObject instances to the console. +/// @note This function is only available in debug builds. +/// @ingroup Debugging ) +/// /// public void fn_debugDumpAllObjects () @@ -1947,7 +2616,15 @@ public void fn_debugEnumInstances (string className, string functionName) SafeNativeMethods.mwle_fn_debugEnumInstances(sbclassName, sbfunctionName); } /// -/// @brief Logs the value of the given variable to the console. Prints a string of the form \"variableName> = variable value>\" to the console. @param variableName Name of the local or global variable to print. @tsexample %var = 1; debugv( \"%var\" ); // Prints \"%var = 1\" @endtsexample @ingroup Debugging ) +/// @brief Logs the value of the given variable to the console. +/// Prints a string of the form \"variableName> = variable value>\" to the console. +/// @param variableName Name of the local or global variable to print. +/// @tsexample +/// %var = 1; +/// debugv( \"%var\" ); // Prints \"%var = 1\" +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void fn_debugv (string variableName) @@ -1961,7 +2638,26 @@ public void fn_debugv (string variableName) SafeNativeMethods.mwle_fn_debugv(sbvariableName); } /// -/// Adds a new decal to the decal manager. @param position World position for the decal. @param normal Decal normal vector (if the decal was a tire lying flat on a surface, this is the vector pointing in the direction of the axle). @param rot Angle (in radians) to rotate this decal around its normal vector. @param scale Scale factor applied to the decal. @param decalData DecalData datablock to use for the new decal. @param isImmortal Whether or not this decal is immortal. If immortal, it does not expire automatically and must be removed explicitly. @return Returns the ID of the new Decal object or -1 on failure. @tsexample // Specify the decal position %position = \"1.0 1.0 1.0\"; // Specify the up vector %normal = \"0.0 0.0 1.0\"; // Add the new decal. %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); @endtsexample @ingroup Decals ) +/// Adds a new decal to the decal manager. +/// @param position World position for the decal. +/// @param normal Decal normal vector (if the decal was a tire lying flat on a +/// surface, this is the vector pointing in the direction of the axle). +/// @param rot Angle (in radians) to rotate this decal around its normal vector. +/// @param scale Scale factor applied to the decal. +/// @param decalData DecalData datablock to use for the new decal. +/// @param isImmortal Whether or not this decal is immortal. If immortal, it +/// does not expire automatically and must be removed explicitly. +/// @return Returns the ID of the new Decal object or -1 on failure. +/// @tsexample +/// // Specify the decal position +/// %position = \"1.0 1.0 1.0\"; +/// // Specify the up vector +/// %normal = \"0.0 0.0 1.0\"; +/// // Add the new decal. +/// %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public int fn_decalManagerAddDecal (string position, string normal, float rot, float scale, string decalData, bool isImmortal) @@ -1981,7 +2677,13 @@ public int fn_decalManagerAddDecal (string position, string normal, float rot, f return SafeNativeMethods.mwle_fn_decalManagerAddDecal(sbposition, sbnormal, rot, scale, sbdecalData, isImmortal); } /// -/// Removes all decals currently loaded in the decal manager. @tsexample // Tell the decal manager to remove all existing decals. decalManagerClear(); @endtsexample @ingroup Decals ) +/// Removes all decals currently loaded in the decal manager. +/// @tsexample +/// // Tell the decal manager to remove all existing decals. +/// decalManagerClear(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void fn_decalManagerClear () @@ -1993,7 +2695,15 @@ public void fn_decalManagerClear () SafeNativeMethods.mwle_fn_decalManagerClear(); } /// -/// Returns whether the decal manager has unsaved modifications. @return True if the decal manager has unsaved modifications, false if everything has been saved. @tsexample // Ask the decal manager if it has unsaved modifications. %hasUnsavedModifications = decalManagerDirty(); @endtsexample @ingroup Decals ) +/// Returns whether the decal manager has unsaved modifications. +/// @return True if the decal manager has unsaved modifications, false if +/// everything has been saved. +/// @tsexample +/// // Ask the decal manager if it has unsaved modifications. +/// %hasUnsavedModifications = decalManagerDirty(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool fn_decalManagerDirty () @@ -2005,7 +2715,18 @@ public bool fn_decalManagerDirty () return SafeNativeMethods.mwle_fn_decalManagerDirty()>=1; } /// -/// Clears existing decals and replaces them with decals loaded from the specified file. @param fileName Filename to load the decals from. @return True if the decal manager was able to load the requested file, false if it could not. @tsexample // Set the filename to load the decals from. %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to load the decals from the entered filename. decalManagerLoad( %fileName ); @endtsexample @ingroup Decals ) +/// Clears existing decals and replaces them with decals loaded from the specified file. +/// @param fileName Filename to load the decals from. +/// @return True if the decal manager was able to load the requested file, +/// false if it could not. +/// @tsexample +/// // Set the filename to load the decals from. +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to load the decals from the entered filename. +/// decalManagerLoad( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool fn_decalManagerLoad (string fileName) @@ -2019,7 +2740,17 @@ public bool fn_decalManagerLoad (string fileName) return SafeNativeMethods.mwle_fn_decalManagerLoad(sbfileName)>=1; } /// -/// Remove specified decal from the scene. @param decalID ID of the decal to remove. @return Returns true if successful, false if decal ID not found. @tsexample // Specify a decal ID to be removed %decalID = 1; // Tell the decal manager to remove the specified decal ID. decalManagerRemoveDecal( %decalId ) @endtsexample @ingroup Decals ) +/// Remove specified decal from the scene. +/// @param decalID ID of the decal to remove. +/// @return Returns true if successful, false if decal ID not found. +/// @tsexample +/// // Specify a decal ID to be removed +/// %decalID = 1; +/// // Tell the decal manager to remove the specified decal ID. +/// decalManagerRemoveDecal( %decalId ) +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool fn_decalManagerRemoveDecal (int decalID) @@ -2030,7 +2761,18 @@ public bool fn_decalManagerRemoveDecal (int decalID) return SafeNativeMethods.mwle_fn_decalManagerRemoveDecal(decalID)>=1; } /// -/// ), Saves the decals for the active mission in the entered filename. @param decalSaveFile Filename to save the decals to. @tsexample // Set the filename to save the decals in. If no filename is set, then the // decals will default to activeMissionName>.mis.decals %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to save the decals for the active mission. decalManagerSave( %fileName ); @endtsexample @ingroup Decals ) +/// ), +/// Saves the decals for the active mission in the entered filename. +/// @param decalSaveFile Filename to save the decals to. +/// @tsexample +/// // Set the filename to save the decals in. If no filename is set, then the +/// // decals will default to activeMissionName>.mis.decals +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to save the decals for the active mission. +/// decalManagerSave( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void fn_decalManagerSave (string decalSaveFile) @@ -2044,7 +2786,10 @@ public void fn_decalManagerSave (string decalSaveFile) SafeNativeMethods.mwle_fn_decalManagerSave(sbdecalSaveFile); } /// -/// Delete all the datablocks we've downloaded. This is usually done in preparation of downloading a new set of datablocks, such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// Delete all the datablocks we've downloaded. +/// This is usually done in preparation of downloading a new set of datablocks, +/// such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// /// public void fn_deleteDataBlocks () @@ -2056,7 +2801,11 @@ public void fn_deleteDataBlocks () SafeNativeMethods.mwle_fn_deleteDataBlocks(); } /// -/// @brief Deletes the given @a file. @param file %Path of the file to delete. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Deletes the given @a file. +/// @param file %Path of the file to delete. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_deleteFile (string file) @@ -2070,7 +2819,17 @@ public bool fn_deleteFile (string file) return SafeNativeMethods.mwle_fn_deleteFile(sbfile)>=1; } /// -/// Undefine all global variables matching the given name @a pattern. @param pattern A global variable name pattern. Must begin with '$'. @tsexample // Define a global variable in the \"My\" namespace. $My::Variable = \"value\"; // Undefine all variable in the \"My\" namespace. deleteVariables( \"$My::*\" ); @endtsexample @see strIsMatchExpr @ingroup Scripting ) +/// Undefine all global variables matching the given name @a pattern. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @tsexample +/// // Define a global variable in the \"My\" namespace. +/// $My::Variable = \"value\"; +/// // Undefine all variable in the \"My\" namespace. +/// deleteVariables( \"$My::*\" ); +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Scripting ) +/// /// public void fn_deleteVariables (string pattern) @@ -2084,7 +2843,22 @@ public void fn_deleteVariables (string pattern) SafeNativeMethods.mwle_fn_deleteVariables(sbpattern); } /// -/// @brief Dumps a description of GFX resources to a file or the console. @param resourceTypes A space seperated list of resource types or an empty string for all resources. @param filePath A file to dump the list to or an empty string to write to the console. @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. @note The resource types can be one or more of the following: - texture - texture target - window target - vertex buffers - primitive buffers - fences - cubemaps - shaders - stateblocks @ingroup GFX ) +/// @brief Dumps a description of GFX resources to a file or the console. +/// @param resourceTypes A space seperated list of resource types or an empty string for all resources. +/// @param filePath A file to dump the list to or an empty string to write to the console. +/// @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. +/// @note The resource types can be one or more of the following: +/// - texture +/// - texture target +/// - window target +/// - vertex buffers +/// - primitive buffers +/// - fences +/// - cubemaps +/// - shaders +/// - stateblocks +/// @ingroup GFX ) +/// /// public void fn_describeGFXResources (string resourceTypes, string filePath, bool unflaggedOnly) @@ -2101,7 +2875,10 @@ public void fn_describeGFXResources (string resourceTypes, string filePath, bool SafeNativeMethods.mwle_fn_describeGFXResources(sbresourceTypes, sbfilePath, unflaggedOnly); } /// -/// Dumps a description of all state blocks. @param filePath A file to dump the state blocks to or an empty string to write to the console. @ingroup GFX ) +/// Dumps a description of all state blocks. +/// @param filePath A file to dump the state blocks to or an empty string to write to the console. +/// @ingroup GFX ) +/// /// public void fn_describeGFXStateBlocks (string filePath) @@ -2115,7 +2892,26 @@ public void fn_describeGFXStateBlocks (string filePath) SafeNativeMethods.mwle_fn_describeGFXStateBlocks(sbfilePath); } /// -/// @brief Returns the string from a tag string. Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. Use getTaggedString() to convert a tagged string ID back into a regular string at any time. @tsexample // From scripts/client/message.cs function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) { onChatMessage(detag(%msgString), %voice, %pitch); } @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see getTag() @see getTaggedString() @ingroup Networking) +/// @brief Returns the string from a tag string. +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. Use getTaggedString() +/// to convert a tagged string ID back into a regular string at any time. +/// +/// @tsexample +/// // From scripts/client/message.cs +/// function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) +/// { +/// onChatMessage(detag(%msgString), %voice, %pitch); +/// } +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see getTag() +/// @see getTaggedString() +/// +/// @ingroup Networking) +/// /// public string fn_detag (string str) @@ -2132,7 +2928,11 @@ public string fn_detag (string str) } /// -/// () @brief Disables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Disables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public void fn_disableJoystick () @@ -2144,7 +2944,10 @@ public void fn_disableJoystick () SafeNativeMethods.mwle_fn_disableJoystick(); } /// -/// () @brief Disables XInput for Xbox 360 controllers. @ingroup Input) +/// () +/// @brief Disables XInput for Xbox 360 controllers. +/// @ingroup Input) +/// /// public void fn_disableXInput () @@ -2156,7 +2959,15 @@ public void fn_disableXInput () SafeNativeMethods.mwle_fn_disableXInput(); } /// -/// ), (string queueName, string message, string data) @brief Dispatch a message to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @param data Data for message @return True for success, false for failure @see dispatchMessageObject @ingroup Messaging) +/// ), (string queueName, string message, string data) +/// @brief Dispatch a message to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @param data Data for message +/// @return True for success, false for failure +/// @see dispatchMessageObject +/// @ingroup Messaging) +/// /// public bool fn_dispatchMessage (string queueName, string message, string data) @@ -2176,7 +2987,14 @@ public bool fn_dispatchMessage (string queueName, string message, string data) return SafeNativeMethods.mwle_fn_dispatchMessage(sbqueueName, sbmessage, sbdata)>=1; } /// -/// , ), (string queueName, string message) @brief Dispatch a message object to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @return true for success, false for failure @see dispatchMessage @ingroup Messaging) +/// , ), (string queueName, string message) +/// @brief Dispatch a message object to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @return true for success, false for failure +/// @see dispatchMessage +/// @ingroup Messaging) +/// /// public bool fn_dispatchMessageObject (string queueName, string message) @@ -2193,7 +3011,12 @@ public bool fn_dispatchMessageObject (string queueName, string message) return SafeNativeMethods.mwle_fn_dispatchMessageObject(sbqueueName, sbmessage)>=1; } /// -/// art/gui/splash.bmp), Display a startup splash window suitable for showing while the engine still starts up. @note This is currently only implemented on Windows. @return True if the splash window could be successfully initialized. @ingroup Platform ) +/// art/gui/splash.bmp), +/// Display a startup splash window suitable for showing while the engine still starts up. +/// @note This is currently only implemented on Windows. +/// @return True if the splash window could be successfully initialized. +/// @ingroup Platform ) +/// /// public bool fn_displaySplashWindow (string path) @@ -2207,7 +3030,12 @@ public bool fn_displaySplashWindow (string path) return SafeNativeMethods.mwle_fn_displaySplashWindow(sbpath)>=1; } /// -/// (bool enabled) @brief Enables logging of the connection protocols When enabled a lot of network debugging information is sent to the console. @param enabled True to enable, false to disable @ingroup Networking) +/// (bool enabled) +/// @brief Enables logging of the connection protocols +/// When enabled a lot of network debugging information is sent to the console. +/// @param enabled True to enable, false to disable +/// @ingroup Networking) +/// /// public void fn_DNetSetLogging (bool enabled) @@ -2484,7 +3312,11 @@ public string fn_dnt_testcase_9 (string chr) } /// -/// @brief Dumps all declared console classes to the console. @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console classes to the console. +/// @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. +/// @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void fn_dumpConsoleClasses (bool dumpScript, bool dumpEngine) @@ -2495,7 +3327,11 @@ public void fn_dumpConsoleClasses (bool dumpScript, bool dumpEngine) SafeNativeMethods.mwle_fn_dumpConsoleClasses(dumpScript, dumpEngine); } /// -/// @brief Dumps all declared console functions to the console. @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console functions to the console. +/// @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. +/// @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void fn_dumpConsoleFunctions (bool dumpScript, bool dumpEngine) @@ -2506,7 +3342,11 @@ public void fn_dumpConsoleFunctions (bool dumpScript, bool dumpEngine) SafeNativeMethods.mwle_fn_dumpConsoleFunctions(dumpScript, dumpEngine); } /// -/// Dumps the engine scripting documentation to the specified file overwriting any existing content. @param outputFile The relative or absolute output file path and name. @return Returns true if successful. @ingroup Console) +/// Dumps the engine scripting documentation to the specified file overwriting any existing content. +/// @param outputFile The relative or absolute output file path and name. +/// @return Returns true if successful. +/// @ingroup Console) +/// /// public bool fn_dumpEngineDocs (string outputFile) @@ -2520,7 +3360,10 @@ public bool fn_dumpEngineDocs (string outputFile) return SafeNativeMethods.mwle_fn_dumpEngineDocs(sboutputFile)>=1; } /// -/// Dumps to the console a full description of all cached fonts, along with info on the codepoints each contains. @ingroup Font ) +/// Dumps to the console a full description of all cached fonts, along with +/// info on the codepoints each contains. +/// @ingroup Font ) +/// /// public void fn_dumpFontCacheStatus () @@ -2532,7 +3375,9 @@ public void fn_dumpFontCacheStatus () SafeNativeMethods.mwle_fn_dumpFontCacheStatus(); } /// -/// @brief Dumps a formatted list of currently allocated material instances to the console. @ingroup Materials) +/// @brief Dumps a formatted list of currently allocated material instances to the console. +/// @ingroup Materials) +/// /// public void fn_dumpMaterialInstances () @@ -2544,7 +3389,14 @@ public void fn_dumpMaterialInstances () SafeNativeMethods.mwle_fn_dumpMaterialInstances(); } /// -/// @brief Dumps network statistics for each class to the console. The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. The i>num/i> value is the total number of events collected. @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. @ingroup Networking ) +/// @brief Dumps network statistics for each class to the console. +/// +/// The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. +/// The i>num/i> value is the total number of events collected. +/// +/// @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. +/// @ingroup Networking ) +/// /// public void fn_dumpNetStats () @@ -2556,7 +3408,13 @@ public void fn_dumpNetStats () SafeNativeMethods.mwle_fn_dumpNetStats(); } /// -/// @brief Dump the current contents of the networked string table to the console. The results are returned in three columns. The first column is the network string ID. The second column is the string itself. The third column is the reference count to the network string. @note This function is available only in debug builds. @ingroup Networking ) +/// @brief Dump the current contents of the networked string table to the console. +/// The results are returned in three columns. The first column is the network string ID. +/// The second column is the string itself. The third column is the reference count to the +/// network string. +/// @note This function is available only in debug builds. +/// @ingroup Networking ) +/// /// public void fn_dumpNetStringTable () @@ -2569,6 +3427,7 @@ public void fn_dumpNetStringTable () } /// /// Dumps all ProcessObjects in ServerProcessList and ClientProcessList to the console. ) +/// /// public void fn_dumpProcessList (bool allow) @@ -2579,7 +3438,10 @@ public void fn_dumpProcessList (bool allow) SafeNativeMethods.mwle_fn_dumpProcessList(allow); } /// -/// Creates a 64x64 normal map texture filled with noise. The texture is saved to randNormTex.png in the location of the game executable. @ingroup GFX) +/// Creates a 64x64 normal map texture filled with noise. The texture is saved +/// to randNormTex.png in the location of the game executable. +/// @ingroup GFX) +/// /// public void fn_dumpRandomNormalMap () @@ -2604,7 +3466,11 @@ public void fn_dumpSoCount () SafeNativeMethods.mwle_fn_dumpSoCount(); } /// -/// () @brief Dumps information about String memory usage @ingroup Debugging @ingroup Strings) +/// () +/// @brief Dumps information about String memory usage +/// @ingroup Debugging +/// @ingroup Strings) +/// /// public void fn_dumpStringMemStats () @@ -2616,19 +3482,10 @@ public void fn_dumpStringMemStats () SafeNativeMethods.mwle_fn_dumpStringMemStats(); } /// -/// ) -/// - -public void fn_dumpStringTableSize () -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_dumpStringTableSize'"); - - -SafeNativeMethods.mwle_fn_dumpStringTableSize(); -} -/// -/// Dumps a list of all active texture objects to the console. @note This function is only available in debug builds. @ingroup GFX ) +/// Dumps a list of all active texture objects to the console. +/// @note This function is only available in debug builds. +/// @ingroup GFX ) +/// /// public void fn_dumpTextureObjects () @@ -2640,7 +3497,15 @@ public void fn_dumpTextureObjects () SafeNativeMethods.mwle_fn_dumpTextureObjects(); } /// -/// Copy the specified old font to a new name. The new copy will not have a platform font backing it, and so will never have characters added to it. But this is useful for making copies of fonts to add postprocessing effects to via exportCachedFont. @param oldFontName The name of the font face to copy. @param oldFontSize The size of the font to copy. @param newFontName The name of the new font face. @ingroup Font ) +/// Copy the specified old font to a new name. The new copy will not have a +/// platform font backing it, and so will never have characters added to it. +/// But this is useful for making copies of fonts to add postprocessing effects +/// to via exportCachedFont. +/// @param oldFontName The name of the font face to copy. +/// @param oldFontSize The size of the font to copy. +/// @param newFontName The name of the new font face. +/// @ingroup Font ) +/// /// public void fn_duplicateCachedFont (string oldFontName, int oldFontSize, string newFontName) @@ -2657,7 +3522,10 @@ public void fn_duplicateCachedFont (string oldFontName, int oldFontSize, string SafeNativeMethods.mwle_fn_duplicateCachedFont(sboldFontName, oldFontSize, sbnewFontName); } /// -/// () @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. @ingroup Input) +/// () +/// @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. +/// @ingroup Input) +/// /// public void fn_echoInputState () @@ -2670,6 +3538,7 @@ public void fn_echoInputState () } /// /// Perform the onEditorDisabled callback on all SimObjects and set gEditingMission false ) +/// /// public void fn_EditManager_editorDisabled (string editmanager) @@ -2684,6 +3553,7 @@ public void fn_EditManager_editorDisabled (string editmanager) } /// /// Perform the onEditorEnabled callback on all SimObjects and set gEditingMission true ) +/// /// public void fn_EditManager_editorEnabled (string editmanager) @@ -2698,6 +3568,7 @@ public void fn_EditManager_editorEnabled (string editmanager) } /// /// (int slot)) +/// /// public void fn_EditManager_gotoBookmark (string editmanager, int val) @@ -2712,6 +3583,7 @@ public void fn_EditManager_gotoBookmark (string editmanager, int val) } /// /// Return the value of gEditingMission. ) +/// /// public bool fn_EditManager_isEditorEnabled (string editmanager) @@ -2726,6 +3598,7 @@ public bool fn_EditManager_isEditorEnabled (string editmanager) } /// /// (int slot)) +/// /// public void fn_EditManager_setBookmark (string editmanager, int val) @@ -2739,7 +3612,11 @@ public void fn_EditManager_setBookmark (string editmanager, int val) SafeNativeMethods.mwle_fn_EditManager_setBookmark(sbeditmanager, val); } /// -/// () @brief Enables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Enables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public bool fn_enableJoystick () @@ -2751,7 +3628,11 @@ public bool fn_enableJoystick () return SafeNativeMethods.mwle_fn_enableJoystick()>=1; } /// -/// (pattern, [state]) - @brief Enable sampling for all keys that match the given name pattern. Slashes are treated as separators. @ingroup Rendering) +/// (pattern, [state]) - +/// @brief Enable sampling for all keys that match the given name +/// pattern. Slashes are treated as separators. +/// @ingroup Rendering) +/// /// public void fn_enableSamples (string pattern, bool state) @@ -2766,6 +3647,7 @@ public void fn_enableSamples (string pattern, bool state) } /// /// enableWinConsole(bool);) +/// /// public void fn_enableWinConsole (bool flag) @@ -2776,7 +3658,12 @@ public void fn_enableWinConsole (bool flag) SafeNativeMethods.mwle_fn_enableWinConsole(flag); } /// -/// () @brief Enables XInput for Xbox 360 controllers. @note XInput is enabled by default. Disable to use an Xbox 360 Controller as a joystick device. @ingroup Input) +/// () +/// @brief Enables XInput for Xbox 360 controllers. +/// @note XInput is enabled by default. Disable to use an Xbox 360 +/// Controller as a joystick device. +/// @ingroup Input) +/// /// public bool fn_enableXInput () @@ -2788,7 +3675,18 @@ public bool fn_enableXInput () return SafeNativeMethods.mwle_fn_enableXInput()>=1; } /// -/// @brief Test whether the given string ends with the given suffix. @param str The string to test. @param suffix The potential suffix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. @tsexample startsWith( \"TEST123\", \"123\" ) // Returns true. @endtsexample @see startsWith @ingroup Strings ) +/// @brief Test whether the given string ends with the given suffix. +/// @param str The string to test. +/// @param suffix The potential suffix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"123\" ) // Returns true. +/// @endtsexample +/// @see startsWith +/// @ingroup Strings ) +/// /// public bool fn_endsWith (string str, string suffix, bool caseSensitive) @@ -2805,7 +3703,16 @@ public bool fn_endsWith (string str, string suffix, bool caseSensitive) return SafeNativeMethods.mwle_fn_endsWith(sbstr, sbsuffix, caseSensitive)>=1; } /// -/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from a COLLADA file and store it in a GuiTreeView control. This function is used by the COLLADA import gui to show a preview of the scene contents prior to import, and is probably not much use for anything else. @param shapePath COLLADA filename @param ctrl GuiTreeView control to add elements to @return true if successful, false otherwise @ingroup Editors @internal) +/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from +/// a COLLADA file and store it in a GuiTreeView control. This function is +/// used by the COLLADA import gui to show a preview of the scene contents +/// prior to import, and is probably not much use for anything else. +/// @param shapePath COLLADA filename +/// @param ctrl GuiTreeView control to add elements to +/// @return true if successful, false otherwise +/// @ingroup Editors +/// @internal) +/// /// public bool fn_enumColladaForImport (string shapePath, string ctrl) @@ -2822,7 +3729,14 @@ public bool fn_enumColladaForImport (string shapePath, string ctrl) return SafeNativeMethods.mwle_fn_enumColladaForImport(sbshapePath, sbctrl)>=1; } /// -/// ), @brief Returns a list of classes that derive from the named class. If the named class is omitted this dumps all the classes. @param className The optional base class name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// ), +/// @brief Returns a list of classes that derive from the named class. +/// If the named class is omitted this dumps all the classes. +/// @param className The optional base class name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string fn_enumerateConsoleClasses (string className) @@ -2839,7 +3753,12 @@ public string fn_enumerateConsoleClasses (string className) } /// -/// @brief Provide a list of classes that belong to the given category. @param category The category name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// @brief Provide a list of classes that belong to the given category. +/// @param category The category name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string fn_enumerateConsoleClassesByCategory (string category) @@ -2857,6 +3776,7 @@ public string fn_enumerateConsoleClassesByCategory (string category) } /// /// eval(consoleString) ) +/// /// public string fn_eval (string consoleString) @@ -2873,7 +3793,9 @@ public string fn_eval (string consoleString) } /// -/// () Print all registered events to the console. ) +/// () +/// Print all registered events to the console. ) +/// /// public void fn_EventManager_dumpEvents (string eventmanager) @@ -2887,7 +3809,10 @@ public void fn_EventManager_dumpEvents (string eventmanager) SafeNativeMethods.mwle_fn_EventManager_dumpEvents(sbeventmanager); } /// -/// ), ( String event ) Print all subscribers to an event to the console. @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// ), ( String event ) +/// Print all subscribers to an event to the console. +/// @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// /// public void fn_EventManager_dumpSubscribers (string eventmanager, string listenerName) @@ -2904,7 +3829,11 @@ public void fn_EventManager_dumpSubscribers (string eventmanager, string listene SafeNativeMethods.mwle_fn_EventManager_dumpSubscribers(sbeventmanager, sblistenerName); } /// -/// ( String event ) Check if an event is registered or not. @param event The event to check. @return Whether or not the event exists. ) +/// ( String event ) +/// Check if an event is registered or not. +/// @param event The event to check. +/// @return Whether or not the event exists. ) +/// /// public bool fn_EventManager_isRegisteredEvent (string eventmanager, string evt) @@ -2921,7 +3850,12 @@ public bool fn_EventManager_isRegisteredEvent (string eventmanager, string evt) return SafeNativeMethods.mwle_fn_EventManager_isRegisteredEvent(sbeventmanager, sbevt)>=1; } /// -/// ), ( String event, String data ) ~Trigger an event. @param event The event to trigger. @param data The data associated with the event. @return Whether or not the event was dispatched successfully. ) +/// ), ( String event, String data ) +/// ~Trigger an event. +/// @param event The event to trigger. +/// @param data The data associated with the event. +/// @return Whether or not the event was dispatched successfully. ) +/// /// public bool fn_EventManager_postEvent (string eventmanager, string evt, string data) @@ -2941,7 +3875,11 @@ public bool fn_EventManager_postEvent (string eventmanager, string evt, string d return SafeNativeMethods.mwle_fn_EventManager_postEvent(sbeventmanager, sbevt, sbdata)>=1; } /// -/// ( String event ) Register an event with the event manager. @param event The event to register. @return Whether or not the event was registered successfully. ) +/// ( String event ) +/// Register an event with the event manager. +/// @param event The event to register. +/// @return Whether or not the event was registered successfully. ) +/// /// public bool fn_EventManager_registerEvent (string eventmanager, string evt) @@ -2958,7 +3896,11 @@ public bool fn_EventManager_registerEvent (string eventmanager, string evt) return SafeNativeMethods.mwle_fn_EventManager_registerEvent(sbeventmanager, sbevt)>=1; } /// -/// ( SimObject listener, String event ) Remove a listener from an event. @param listener The listener to remove. @param event The event to be removed from.) +/// ( SimObject listener, String event ) +/// Remove a listener from an event. +/// @param listener The listener to remove. +/// @param event The event to be removed from.) +/// /// public void fn_EventManager_remove (string eventmanager, string listenerName, string evt) @@ -2978,7 +3920,10 @@ public void fn_EventManager_remove (string eventmanager, string listenerName, st SafeNativeMethods.mwle_fn_EventManager_remove(sbeventmanager, sblistenerName, sbevt); } /// -/// ( SimObject listener ) Remove a listener from all events. @param listener The listener to remove.) +/// ( SimObject listener ) +/// Remove a listener from all events. +/// @param listener The listener to remove.) +/// /// public void fn_EventManager_removeAll (string eventmanager, string listenerName) @@ -2995,7 +3940,13 @@ public void fn_EventManager_removeAll (string eventmanager, string listenerName) SafeNativeMethods.mwle_fn_EventManager_removeAll(sbeventmanager, sblistenerName); } /// -/// ), ( SimObject listener, String event, String callback ) Subscribe a listener to an event. @param listener The listener to subscribe. @param event The event to subscribe to. @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. @return Whether or not the subscription was successful. ) +/// ), ( SimObject listener, String event, String callback ) +/// Subscribe a listener to an event. +/// @param listener The listener to subscribe. +/// @param event The event to subscribe to. +/// @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. +/// @return Whether or not the subscription was successful. ) +/// /// public bool fn_EventManager_subscribe (string eventmanager, string listenerName, string evt, string callback) @@ -3018,7 +3969,10 @@ public bool fn_EventManager_subscribe (string eventmanager, string listenerName, return SafeNativeMethods.mwle_fn_EventManager_subscribe(sbeventmanager, sblistenerName, sbevt, sbcallback)>=1; } /// -/// ( String event ) Remove an event from the EventManager. @param event The event to remove. ) +/// ( String event ) +/// Remove an event from the EventManager. +/// @param event The event to remove. ) +/// /// public void fn_EventManager_unregisterEvent (string eventmanager, string evt) @@ -3035,7 +3989,17 @@ public void fn_EventManager_unregisterEvent (string eventmanager, string evt) SafeNativeMethods.mwle_fn_EventManager_unregisterEvent(sbeventmanager, sbevt); } /// -/// @brief Used to exclude/prevent all other instances using the same identifier specified @note Not used on OSX, Xbox, or in Win debug builds @param appIdentifier Name of the app set up for exclusive use. @return False if another app is running that specified the same appIdentifier @ingroup Platform @ingroup GuiCore) +/// @brief Used to exclude/prevent all other instances using the same identifier specified +/// +/// @note Not used on OSX, Xbox, or in Win debug builds +/// +/// @param appIdentifier Name of the app set up for exclusive use. +/// +/// @return False if another app is running that specified the same appIdentifier +/// +/// @ingroup Platform +/// @ingroup GuiCore) +/// /// public bool fn_excludeOtherInstance (string appIdentifer) @@ -3049,7 +4013,19 @@ public bool fn_excludeOtherInstance (string appIdentifer) return SafeNativeMethods.mwle_fn_excludeOtherInstance(sbappIdentifer)>=1; } /// -/// Execute the given script file. @param fileName Path to the file to execute @param noCalls Deprecated @param journalScript Deprecated @return True if the script was successfully executed, false if not. @tsexample // Execute the init.cs script file found in the same directory as the current script file. exec( \"./init.cs\" ); @endtsexample @see compile @see eval @ingroup Scripting ) +/// Execute the given script file. +/// @param fileName Path to the file to execute +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if the script was successfully executed, false if not. +/// @tsexample +/// // Execute the init.cs script file found in the same directory as the current script file. +/// exec( \"./init.cs\" ); +/// @endtsexample +/// @see compile +/// @see eval +/// @ingroup Scripting ) +/// /// public bool fn_exec (string fileName, bool noCalls, bool journalScript) @@ -3063,7 +4039,20 @@ public bool fn_exec (string fileName, bool noCalls, bool journalScript) return SafeNativeMethods.mwle_fn_exec(sbfileName, noCalls, journalScript)>=1; } /// -/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their respective escape sequences. All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). The primary use of this function is for converting strings suitable for being passed as string literals to the TorqueScript compiler. @param text A string @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective escape sequences. @tsxample expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". @endtsxample @see collapseEscape @ingroup Strings) +/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their +/// respective escape sequences. +/// All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). +/// The primary use of this function is for converting strings suitable for being passed as string literals +/// to the TorqueScript compiler. +/// @param text A string +/// @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective +/// escape sequences. +/// @tsxample +/// expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". +/// @endtsxample +/// @see collapseEscape +/// @ingroup Strings) +/// /// public string fn_expandEscape (string text) @@ -3080,7 +4069,23 @@ public string fn_expandEscape (string text) } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void fn_export (string pattern, string filename, bool append) @@ -3097,7 +4102,17 @@ public void fn_export (string pattern, string filename, bool append) SafeNativeMethods.mwle_fn_export(sbpattern, sbfilename, append); } /// -/// Export specified font to the specified filename as a PNG. The image can then be processed in Photoshop or another tool and reimported using importCachedFont. Characters in the font are exported as one long strip. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the output PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Export specified font to the specified filename as a PNG. The +/// image can then be processed in Photoshop or another tool and +/// reimported using importCachedFont. Characters in the font are +/// exported as one long strip. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the output PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void fn_exportCachedFont (string faceName, int fontSize, string fileName, int padding, int kerning) @@ -3114,7 +4129,10 @@ public void fn_exportCachedFont (string faceName, int fontSize, string fileName, SafeNativeMethods.mwle_fn_exportCachedFont(sbfaceName, fontSize, sbfileName, padding, kerning); } /// -/// Create a XML document containing a dump of the entire exported engine API. @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. @ingroup Console ) +/// Create a XML document containing a dump of the entire exported engine API. +/// @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. +/// @ingroup Console ) +/// /// public string fn_exportEngineAPIToXML () @@ -3129,7 +4147,23 @@ public string fn_exportEngineAPIToXML () } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void fn_exportToSettings (string pattern, string filename, bool append) @@ -3146,7 +4180,11 @@ public void fn_exportToSettings (string pattern, string filename, bool append) SafeNativeMethods.mwle_fn_exportToSettings(sbpattern, sbfilename, append); } /// -/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ @param simObject Object to copy static-fields from. @param fieldList fields to filter static-fields against. @return No return value.) +/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ +/// @param simObject Object to copy static-fields from. +/// @param fieldList fields to filter static-fields against. +/// @return No return value.) +/// /// public void fn_FieldBrushObject_copyFields (string fieldbrushobject, string simObjName, string pFieldList) @@ -3166,7 +4204,10 @@ public void fn_FieldBrushObject_copyFields (string fieldbrushobject, string simO SafeNativeMethods.mwle_fn_FieldBrushObject_copyFields(sbfieldbrushobject, sbsimObjName, sbpFieldList); } /// -/// (simObject) Paste copied static-fields to selected object./ @param simObject Object to paste static-fields to. @return No return value.) +/// (simObject) Paste copied static-fields to selected object./ +/// @param simObject Object to paste static-fields to. +/// @return No return value.) +/// /// public void fn_FieldBrushObject_pasteFields (string fieldbrushobject, string simObjName) @@ -3183,7 +4224,11 @@ public void fn_FieldBrushObject_pasteFields (string fieldbrushobject, string sim SafeNativeMethods.mwle_fn_FieldBrushObject_pasteFields(sbfieldbrushobject, sbsimObjName); } /// -/// ), (simObject, [groupList]) Query available static-fields for selected object./ @param simObject Object to query static-fields on. @param groupList groups to filter static-fields against. @return Space-seperated static-field list.) +/// ), (simObject, [groupList]) Query available static-fields for selected object./ +/// @param simObject Object to query static-fields on. +/// @param groupList groups to filter static-fields against. +/// @return Space-seperated static-field list.) +/// /// public string fn_FieldBrushObject_queryFields (string fieldbrushobject, string simObjName, string groupList) @@ -3206,7 +4251,10 @@ public string fn_FieldBrushObject_queryFields (string fieldbrushobject, string s } /// -/// (simObject) Query available static-field groups for selected object./ @param simObject Object to query static-field groups on. @return Space-seperated static-field group list.) +/// (simObject) Query available static-field groups for selected object./ +/// @param simObject Object to query static-field groups on. +/// @return Space-seperated static-field group list.) +/// /// public string fn_FieldBrushObject_queryGroups (string fieldbrushobject, string simObjName) @@ -3226,7 +4274,12 @@ public string fn_FieldBrushObject_queryGroups (string fieldbrushobject, string s } /// -/// @brief Get the base of a file name (removes extension) @param fileName Name and path of file to check @return String containing the file name, minus extension @ingroup FileSystem) +/// @brief Get the base of a file name (removes extension and path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus extension and path +/// @ingroup FileSystem) +/// /// public string fn_fileBase (string fileName) @@ -3243,7 +4296,12 @@ public string fn_fileBase (string fileName) } /// -/// @brief Returns a platform specific formatted string with the creation time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the creation time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fn_fileCreatedTime (string fileName) @@ -3260,7 +4318,13 @@ public string fn_fileCreatedTime (string fileName) } /// -/// @brief Delete a file from the hard drive @param path Name and path of the file to delete @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. @return True if file was successfully deleted @ingroup FileSystem) +/// @brief Delete a file from the hard drive +/// +/// @param path Name and path of the file to delete +/// @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. +/// @return True if file was successfully deleted +/// @ingroup FileSystem) +/// /// public bool fn_fileDelete (string path) @@ -3274,7 +4338,12 @@ public bool fn_fileDelete (string path) return SafeNativeMethods.mwle_fn_fileDelete(sbpath)>=1; } /// -/// @brief Get the extension of a file @param fileName Name and path of file @return String containing the extension, such as \".exe\" or \".cs\" @ingroup FileSystem) +/// @brief Get the extension of a file +/// +/// @param fileName Name and path of file +/// @return String containing the extension, such as \".exe\" or \".cs\" +/// @ingroup FileSystem) +/// /// public string fn_fileExt (string fileName) @@ -3291,7 +4360,12 @@ public string fn_fileExt (string fileName) } /// -/// @brief Returns a platform specific formatted string with the last modified time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the last modified time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fn_fileModifiedTime (string fileName) @@ -3308,7 +4382,12 @@ public string fn_fileModifiedTime (string fileName) } /// -/// @brief Get the file name of a file (removes extension and path) @param fileName Name and path of file to check @return String containing the file name, minus extension and path @ingroup FileSystem) +/// @brief Get only the file name of a path and file name string (removes path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus the path +/// @ingroup FileSystem) +/// /// public string fn_fileName (string fileName) @@ -3325,7 +4404,9 @@ public string fn_fileName (string fileName) } /// -/// ), FileObject.writeObject(SimObject, object prepend) @hide) +/// ), FileObject.writeObject(SimObject, object prepend) +/// @hide) +/// /// public void fn_FileObject_writeObject (string fileobject, string simName, string objName) @@ -3345,7 +4426,12 @@ public void fn_FileObject_writeObject (string fileobject, string simName, string SafeNativeMethods.mwle_fn_FileObject_writeObject(sbfileobject, sbsimName, sbobjName); } /// -/// @brief Get the path of a file (removes name and extension) @param fileName Name and path of file to check @return String containing the path, minus name and extension @ingroup FileSystem) +/// @brief Get the path of a file (removes name and extension) +/// +/// @param fileName Name and path of file to check +/// @return String containing the path, minus name and extension +/// @ingroup FileSystem) +/// /// public string fn_filePath (string fileName) @@ -3362,7 +4448,13 @@ public string fn_filePath (string fileName) } /// -/// @brief Determines the size of a file on disk @param fileName Name and path of the file to check @return Returns filesize in KB, or -1 if no file @ingroup FileSystem) +/// @brief Determines the size of a file on disk +/// +/// @param fileName Name and path of the file to check +/// @return Returns filesize in KB, or -1 if no file +/// +/// @ingroup FileSystem) +/// /// public int fn_fileSize (string fileName) @@ -3376,7 +4468,30 @@ public int fn_fileSize (string fileName) return SafeNativeMethods.mwle_fn_fileSize(sbfileName); } /// -/// @brief Replaces the characters in a string with designated text Uses the bad word filter to determine which characters within the string will be replaced. @param baseString The original string to filter. @param replacementChars A string containing letters you wish to swap in the baseString. @return The new scrambled string @see addBadWord() @see containsBadWords() @tsexample // Create the base string, can come from anywhere %baseString = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // Filter the string %newString = filterString(%baseString, %replacementChars); // Print the new string to console echo(%newString); @endtsexample @ingroup Game) +/// @brief Replaces the characters in a string with designated text +/// +/// Uses the bad word filter to determine which characters within the string will be replaced. +/// +/// @param baseString The original string to filter. +/// @param replacementChars A string containing letters you wish to swap in the baseString. +/// @return The new scrambled string +/// +/// @see addBadWord() +/// @see containsBadWords() +/// +/// @tsexample +/// // Create the base string, can come from anywhere +/// %baseString = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // Filter the string +/// %newString = filterString(%baseString, %replacementChars); +/// // Print the new string to console +/// echo(%newString); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public string fn_filterString (string baseString, string replacementChars) @@ -3396,7 +4511,34 @@ public string fn_filterString (string baseString, string replacementChars) } /// -/// @brief Returns the first file in the directory system matching the given pattern. Use the corresponding findNextFile() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCount(). This function differs from findFirstFileMultiExpr() in that it supports a single search pattern being passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return The path of the first file matched by the search or an empty string if no matching file could be found. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findNextFile() @see getFileCount() @see findFirstFileMultiExpr() @ingroup FileSearches ) +/// @brief Returns the first file in the directory system matching the given pattern. +/// +/// Use the corresponding findNextFile() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCount(). +/// +/// This function differs from findFirstFileMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. +/// @return The path of the first file matched by the search or an empty string if no matching file could be found. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findNextFile() +/// @see getFileCount() +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches ) +/// /// public string fn_findFirstFile (string pattern, bool recurse) @@ -3413,7 +4555,42 @@ public string fn_findFirstFile (string pattern, bool recurse) } /// -/// @brief Returns the first file in the directory system matching the given patterns. Use the corresponding findNextFileMultiExpr() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCountMultiExpr(). This function differs from findFirstFile() in that it supports multiple search patterns to be passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename patterns. @return String of the first matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findNextFileMultiExpr() @see getFileCountMultiExpr() @see findFirstFile() @ingroup FileSearches) +/// @brief Returns the first file in the directory system matching the given patterns. +/// +/// Use the corresponding findNextFileMultiExpr() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCountMultiExpr(). +/// +/// This function differs from findFirstFile() in that it supports multiple search patterns +/// to be passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename patterns. +/// @return String of the first matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findNextFileMultiExpr() +/// @see getFileCountMultiExpr() +/// @see findFirstFile() +/// @ingroup FileSearches) +/// /// public string fn_findFirstFileMultiExpr (string pattern, bool recurse) @@ -3430,7 +4607,22 @@ public string fn_findFirstFileMultiExpr (string pattern, bool recurse) } /// -/// ), @brief Returns the next file matching a search begun in findFirstFile(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return The path of the next filename matched by the search or an empty string if no more files match. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findFirstFile() @ingroup FileSearches ) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFile(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return The path of the next filename matched by the search or an empty string if no more files match. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @ingroup FileSearches ) +/// /// public string fn_findNextFile (string pattern) @@ -3447,7 +4639,28 @@ public string fn_findNextFile (string pattern) } /// -/// ), @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return String of the next matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findFirstFileMultiExpr() @ingroup FileSearches) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return String of the next matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches) +/// /// public string fn_findNextFileMultiExpr (string pattern) @@ -3464,7 +4677,16 @@ public string fn_findNextFileMultiExpr (string pattern) } /// -/// Return the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return The word at index 0 in @a text or \"\" if @a text is empty. @note This is equal to @tsexample_nopar getWord( text, 0 ) @endtsexample @see getWord @ingroup FieldManip ) +/// Return the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return The word at index 0 in @a text or \"\" if @a text is empty. +/// @note This is equal to +/// @tsexample_nopar +/// getWord( text, 0 ) +/// @endtsexample +/// @see getWord +/// @ingroup FieldManip ) +/// /// public string fn_firstWord (string text) @@ -3481,7 +4703,13 @@ public string fn_firstWord (string text) } /// -/// @brief Flags all currently allocated GFX resources. Used for resource allocation and leak tracking by flagging current resources then dumping a list of unflagged resources at some later point in execution. @ingroup GFX @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// @brief Flags all currently allocated GFX resources. +/// Used for resource allocation and leak tracking by flagging +/// current resources then dumping a list of unflagged resources +/// at some later point in execution. +/// @ingroup GFX +/// @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void fn_flagCurrentGFXResources () @@ -3493,7 +4721,9 @@ public void fn_flagCurrentGFXResources () SafeNativeMethods.mwle_fn_flagCurrentGFXResources(); } /// -/// Releases all textures and resurrects the texture manager. @ingroup GFX ) +/// Releases all textures and resurrects the texture manager. +/// @ingroup GFX ) +/// /// public void fn_flushTextureCache () @@ -3506,6 +4736,7 @@ public void fn_flushTextureCache () } /// /// () ) +/// /// public void fn_Forest_clear (string forest) @@ -3520,6 +4751,7 @@ public void fn_Forest_clear (string forest) } /// /// ()) +/// /// public bool fn_Forest_isDirty (string forest) @@ -3534,6 +4766,7 @@ public bool fn_Forest_isDirty (string forest) } /// /// ()) +/// /// public void fn_Forest_regenCells (string forest) @@ -3547,7 +4780,8 @@ public void fn_Forest_regenCells (string forest) SafeNativeMethods.mwle_fn_Forest_regenCells(sbforest); } /// -/// ), saveDataFile( [path] ) ) +/// saveDataFile( [path] ) ) +/// /// public void fn_Forest_saveDataFile (string forest, string path) @@ -3565,6 +4799,7 @@ public void fn_Forest_saveDataFile (string forest, string path) } /// /// ( ForestItemData obj ) ) +/// /// public bool fn_ForestBrush_containsItemData (string forestbrush, string obj) @@ -3582,6 +4817,7 @@ public bool fn_ForestBrush_containsItemData (string forestbrush, string obj) } /// /// ) +/// /// public void fn_ForestBrushTool_collectElements (string forestbrushtool) @@ -3596,6 +4832,7 @@ public void fn_ForestBrushTool_collectElements (string forestbrushtool) } /// /// ( ForestItemData obj ) ) +/// /// public void fn_ForestEditorCtrl_deleteMeshSafe (string foresteditorctrl, string obj) @@ -3613,6 +4850,7 @@ public void fn_ForestEditorCtrl_deleteMeshSafe (string foresteditorctrl, string } /// /// () ) +/// /// public int fn_ForestEditorCtrl_getActiveTool (string foresteditorctrl) @@ -3627,6 +4865,7 @@ public int fn_ForestEditorCtrl_getActiveTool (string foresteditorctrl) } /// /// ) +/// /// public bool fn_ForestEditorCtrl_isDirty (string foresteditorctrl) @@ -3641,6 +4880,7 @@ public bool fn_ForestEditorCtrl_isDirty (string foresteditorctrl) } /// /// ( ForestTool tool ) ) +/// /// public void fn_ForestEditorCtrl_setActiveTool (string foresteditorctrl, string toolName) @@ -3658,6 +4898,7 @@ public void fn_ForestEditorCtrl_setActiveTool (string foresteditorctrl, string t } /// /// () ) +/// /// public void fn_ForestEditorCtrl_updateActiveForest (string foresteditorctrl) @@ -3672,6 +4913,7 @@ public void fn_ForestEditorCtrl_updateActiveForest (string foresteditorctrl) } /// /// ) +/// /// public void fn_ForestSelectionTool_clearSelection (string forestselectiontool) @@ -3686,6 +4928,7 @@ public void fn_ForestSelectionTool_clearSelection (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_copySelection (string forestselectiontool) @@ -3700,6 +4943,7 @@ public void fn_ForestSelectionTool_copySelection (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_cutSelection (string forestselectiontool) @@ -3714,6 +4958,7 @@ public void fn_ForestSelectionTool_cutSelection (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_deleteSelection (string forestselectiontool) @@ -3728,6 +4973,7 @@ public void fn_ForestSelectionTool_deleteSelection (string forestselectiontool) } /// /// ) +/// /// public int fn_ForestSelectionTool_getSelectionCount (string forestselectiontool) @@ -3742,6 +4988,7 @@ public int fn_ForestSelectionTool_getSelectionCount (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_pasteSelection (string forestselectiontool) @@ -3755,7 +5002,9 @@ public void fn_ForestSelectionTool_pasteSelection (string forestselectiontool) SafeNativeMethods.mwle_fn_ForestSelectionTool_pasteSelection(sbforestselectiontool); } /// -/// Returns the count of active DDSs files in memory. @ingroup Rendering ) +/// Returns the count of active DDSs files in memory. +/// @ingroup Rendering ) +/// /// public int fn_getActiveDDSFiles () @@ -3767,7 +5016,9 @@ public int fn_getActiveDDSFiles () return SafeNativeMethods.mwle_fn_getActiveDDSFiles(); } /// -/// Returns the active light manager name. @ingroup Lighting ) +/// Returns the active light manager name. +/// @ingroup Lighting ) +/// /// public string fn_getActiveLightManager () @@ -3782,7 +5033,9 @@ public string fn_getActiveLightManager () } /// -/// Get the version of the application build, as a string. @ingroup Debugging) +/// Get the version of the application build, as a string. +/// @ingroup Debugging) +/// /// public int fn_getAppVersionNumber () @@ -3794,7 +5047,9 @@ public int fn_getAppVersionNumber () return SafeNativeMethods.mwle_fn_getAppVersionNumber(); } /// -/// Get the version of the aplication build, as a human readable string. @ingroup Debugging) +/// Get the version of the aplication build, as a human readable string. +/// @ingroup Debugging) +/// /// public string fn_getAppVersionString () @@ -3809,7 +5064,9 @@ public string fn_getAppVersionString () } /// -/// Returns the best texture format for storage of HDR data for the active device. @ingroup GFX ) +/// Returns the best texture format for storage of HDR data for the active device. +/// @ingroup GFX ) +/// /// public int fn_getBestHDRFormat () @@ -3821,7 +5078,10 @@ public int fn_getBestHDRFormat () return SafeNativeMethods.mwle_fn_getBestHDRFormat(); } /// -/// Returns image info in the following format: width TAB height TAB bytesPerPixel. It will return an empty string if the file is not found. @ingroup Rendering ) +/// Returns image info in the following format: width TAB height TAB bytesPerPixel. +/// It will return an empty string if the file is not found. +/// @ingroup Rendering ) +/// /// public string fn_getBitmapInfo (string filename) @@ -3838,7 +5098,11 @@ public string fn_getBitmapInfo (string filename) } /// -/// Get the center point of an axis-aligned box. @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" @return Center of the box. @ingroup Math) +/// Get the center point of an axis-aligned box. +/// @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" +/// @return Center of the box. +/// @ingroup Math) +/// /// public string fn_getBoxCenter (string box) @@ -3855,7 +5119,9 @@ public string fn_getBoxCenter (string box) } /// -/// Get the type of build, \"Debug\" or \"Release\". @ingroup Debugging) +/// Get the type of build, \"Debug\" or \"Release\". +/// @ingroup Debugging) +/// /// public string fn_getBuildString () @@ -3870,7 +5136,10 @@ public string fn_getBuildString () } /// -/// @brief Returns the category of the given class. @param className The name of the class. @ingroup Console) +/// @brief Returns the category of the given class. +/// @param className The name of the class. +/// @ingroup Console) +/// /// public string fn_getCategoryOfClass (string className) @@ -3905,7 +5174,9 @@ public string fn_getClipboard () } /// -/// Get the time of compilation. @ingroup Debugging) +/// Get the time of compilation. +/// @ingroup Debugging) +/// /// public string fn_getCompileTimeString () @@ -3920,7 +5191,11 @@ public string fn_getCompileTimeString () } /// -/// () @brief Gets the primary LangTable used by the game @return ID of the core LangTable @ingroup Localization) +/// () +/// @brief Gets the primary LangTable used by the game +/// @return ID of the core LangTable +/// @ingroup Localization) +/// /// public int fn_getCoreLangTable () @@ -3932,7 +5207,10 @@ public int fn_getCoreLangTable () return SafeNativeMethods.mwle_fn_getCoreLangTable(); } /// -/// @brief Returns the current %ActionMap. @see ActionMap @ingroup Input) +/// @brief Returns the current %ActionMap. +/// @see ActionMap +/// @ingroup Input) +/// /// public string fn_getCurrentActionMap () @@ -3947,7 +5225,12 @@ public string fn_getCurrentActionMap () } /// -/// @brief Return the current working directory. @return The absolute path of the current working directory. @note Only present in a Tools build of Torque. @see getWorkingDirectory() @ingroup FileSystem) +/// @brief Return the current working directory. +/// @return The absolute path of the current working directory. +/// @note Only present in a Tools build of Torque. +/// @see getWorkingDirectory() +/// @ingroup FileSystem) +/// /// public string fn_getCurrentDirectory () @@ -3962,7 +5245,11 @@ public string fn_getCurrentDirectory () } /// -/// @brief Returns the description string for the named class. @param className The name of the class. @return The class description in string format. @ingroup Console) +/// @brief Returns the description string for the named class. +/// @param className The name of the class. +/// @return The class description in string format. +/// @ingroup Console) +/// /// public string fn_getDescriptionOfClass (string className) @@ -3980,6 +5267,7 @@ public string fn_getDescriptionOfClass (string className) } /// /// Returns the width, height, and bitdepth of the screen/desktop.@ingroup GFX ) +/// /// public string fn_getDesktopResolution () @@ -3994,7 +5282,14 @@ public string fn_getDesktopResolution () } /// -/// @brief Gathers a list of directories starting at the given path. @param path String containing the path of the directory @param depth Depth of search, as in how many subdirectories to parse through @return Tab delimited string containing list of directories found during search, \"\" if no files were found @ingroup FileSystem) +/// @brief Gathers a list of directories starting at the given path. +/// +/// @param path String containing the path of the directory +/// @param depth Depth of search, as in how many subdirectories to parse through +/// @return Tab delimited string containing list of directories found during search, \"\" if no files were found +/// +/// @ingroup FileSystem) +/// /// public string fn_getDirectoryList (string path, int depth) @@ -4011,7 +5306,9 @@ public string fn_getDirectoryList (string path, int depth) } /// -/// Get the string describing the active GFX device. @ingroup GFX ) +/// Get the string describing the active GFX device. +/// @ingroup GFX ) +/// /// public string fn_getDisplayDeviceInformation () @@ -4026,7 +5323,9 @@ public string fn_getDisplayDeviceInformation () } /// -/// Returns a tab-seperated string of the detected devices across all adapters. @ingroup GFX ) +/// Returns a tab-seperated string of the detected devices across all adapters. +/// @ingroup GFX ) +/// /// public string fn_getDisplayDeviceList () @@ -4041,7 +5340,15 @@ public string fn_getDisplayDeviceList () } /// -/// Get the absolute path to the file in which the compiled code for the given script file will be stored. @param scriptFileName %Path to the .cs script file. @return The absolute path to the .dso file for the given script file. @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded from the current paths. @see compile @see getPrefsPath @ingroup Scripting ) +/// Get the absolute path to the file in which the compiled code for the given script file will be stored. +/// @param scriptFileName %Path to the .cs script file. +/// @return The absolute path to the .dso file for the given script file. +/// @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded +/// from the current paths. +/// @see compile +/// @see getPrefsPath +/// @ingroup Scripting ) +/// /// public string fn_getDSOPath (string scriptFileName) @@ -4058,7 +5365,9 @@ public string fn_getDSOPath (string scriptFileName) } /// -/// Get the name of the engine product that this is running from, as a string. @ingroup Debugging) +/// Get the name of the engine product that this is running from, as a string. +/// @ingroup Debugging) +/// /// public string fn_getEngineName () @@ -4074,6 +5383,7 @@ public string fn_getEngineName () } /// /// getEventTimeLeft(scheduleId) Get the time left in ms until this event will trigger.) +/// /// public int fn_getEventTimeLeft (int scheduleId) @@ -4084,7 +5394,11 @@ public int fn_getEventTimeLeft (int scheduleId) return SafeNativeMethods.mwle_fn_getEventTimeLeft(scheduleId); } /// -/// @brief Gets the name of the game's executable @return String containing this game's executable name @ingroup FileSystem) +/// @brief Gets the name of the game's executable +/// +/// @return String containing this game's executable name +/// @ingroup FileSystem) +/// /// public string fn_getExecutableName () @@ -4099,7 +5413,9 @@ public string fn_getExecutableName () } /// -/// Gets the clients far clipping. ) +/// Gets the clients far clipping. +/// ) +/// /// public float fn_getFarClippingDistance () @@ -4111,7 +5427,20 @@ public float fn_getFarClippingDistance () return SafeNativeMethods.mwle_fn_getFarClippingDistance(); } /// -/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to extract. @return The field at the given index or \"\" if the index is out of range. @tsexample getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getFields @see getFieldCount @see getWord @see getRecord @ingroup FieldManip ) +/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to extract. +/// @return The field at the given index or \"\" if the index is out of range. +/// @tsexample +/// getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getFields +/// @see getFieldCount +/// @see getWord +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string fn_getField (string text, int index) @@ -4128,7 +5457,16 @@ public string fn_getField (string text, int index) } /// -/// Return the number of newline and/or tab separated fields in @a text. @param text A list of fields separated by newlines and/or tabs. @return The number of newline and/or tab sepearated elements in @a text. @tsexample getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of newline and/or tab separated fields in @a text. +/// @param text A list of fields separated by newlines and/or tabs. +/// @return The number of newline and/or tab sepearated elements in @a text. +/// @tsexample +/// getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int fn_getFieldCount (string text) @@ -4142,7 +5480,23 @@ public int fn_getFieldCount (string text) return SafeNativeMethods.mwle_fn_getFieldCount(sbtext); } /// -/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param startIndex The zero-based index of the first field to extract from @a text. @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of fields from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" @endtsexample @see getField @see getFieldCount @see getWords @see getRecords @ingroup FieldManip ) +/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param startIndex The zero-based index of the first field to extract from @a text. +/// @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of fields from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see getFieldCount +/// @see getWords +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string fn_getFields (string text, int startIndex, int endIndex) @@ -4159,7 +5513,29 @@ public string fn_getFields (string text, int startIndex, int endIndex) } /// -/// @brief Returns the number of files in the directory tree that match the given patterns This function differs from getFileCountMultiExpr() in that it supports a single search pattern being passed in. If you're interested in a list of files that match the given pattern and not just the number of files, use findFirstFile() and findNextFile(). @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern counting files in subdirectories. @return Number of files located using the pattern @tsexample // Count the number of .cs files in a subdirectory and its subdirectories. getFileCount( \"subdirectory/*.cs\" ); @endtsexample @see findFirstFile() @see findNextFile() @see getFileCountMultiExpr() @ingroup FileSearches ) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// This function differs from getFileCountMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// If you're interested in a list of files that match the given pattern and not just +/// the number of files, use findFirstFile() and findNextFile(). +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern +/// counting files in subdirectories. +/// @return Number of files located using the pattern +/// +/// @tsexample +/// // Count the number of .cs files in a subdirectory and its subdirectories. +/// getFileCount( \"subdirectory/*.cs\" ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @see findNextFile() +/// @see getFileCountMultiExpr() +/// @ingroup FileSearches ) +/// /// public int fn_getFileCount (string pattern, bool recurse) @@ -4173,7 +5549,27 @@ public int fn_getFileCount (string pattern, bool recurse) return SafeNativeMethods.mwle_fn_getFileCount(sbpattern, recurse); } /// -/// @brief Returns the number of files in the directory tree that match the given patterns If you're interested in a list of files that match the given patterns and not just the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return Number of files located using the patterns @tsexample // Count all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); @endtsexample @see findFirstFileMultiExpr() @see findNextFileMultiExpr() @ingroup FileSearches) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// If you're interested in a list of files that match the given patterns and not just +/// the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename pattern. +/// @return Number of files located using the patterns +/// +/// @tsexample +/// // Count all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @see findNextFileMultiExpr() +/// @ingroup FileSearches) +/// /// public int fn_getFileCountMultiExpr (string pattern, bool recurse) @@ -4187,7 +5583,14 @@ public int fn_getFileCountMultiExpr (string pattern, bool recurse) return SafeNativeMethods.mwle_fn_getFileCountMultiExpr(sbpattern, recurse); } /// -/// @brief Provides the CRC checksum of the given file. @param fileName The path to the file. @return The calculated CRC checksum of the file, or -1 if the file could not be found. @ingroup FileSystem) +/// @brief Provides the CRC checksum of the given file. +/// +/// @param fileName The path to the file. +/// @return The calculated CRC checksum of the file, or -1 if the file +/// could not be found. +/// +/// @ingroup FileSystem) +/// /// public int fn_getFileCRC (string fileName) @@ -4199,9 +5602,44 @@ public int fn_getFileCRC (string fileName) sbfileName = new StringBuilder(fileName, 1024); return SafeNativeMethods.mwle_fn_getFileCRC(sbfileName); +} +/// +/// Returns a list of supported shape format extensions separated by tabs. +/// Example output: *.dsq TAB *.dae TAB) +/// +/// + +public string fn_getFormatExtensions () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_getFormatExtensions'"); + +var returnbuff = new StringBuilder(16384); + +SafeNativeMethods.mwle_fn_getFormatExtensions(returnbuff); +return returnbuff.ToString(); + +} +/// +/// Returns a list of supported shape formats in filter form. +/// Example output: DSQ Files|*.dsq|COLLADA Files|*.dae|) +/// +/// + +public string fn_getFormatFilters () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_getFormatFilters'"); + +var returnbuff = new StringBuilder(16384); + +SafeNativeMethods.mwle_fn_getFormatFilters(returnbuff); +return returnbuff.ToString(); + } /// /// @brief .) +/// /// public string fn_getFrustumOffset () @@ -4216,7 +5654,12 @@ public string fn_getFrustumOffset () } /// -/// (string funcName) @brief Provides the name of the package the function belongs to @param funcName String containing name of the function @return The name of the function's package @ingroup Packages) +/// (string funcName) +/// @brief Provides the name of the package the function belongs to +/// @param funcName String containing name of the function +/// @return The name of the function's package +/// @ingroup Packages) +/// /// public string fn_getFunctionPackage (string funcName) @@ -4234,6 +5677,7 @@ public string fn_getFunctionPackage (string funcName) } /// /// getJoystickAxes( instance )) +/// /// public string fn_getJoystickAxes (uint deviceID) @@ -4247,7 +5691,9 @@ public string fn_getJoystickAxes (uint deviceID) } /// -/// Returns a tab seperated list of light manager names. @ingroup Lighting ) +/// Returns a tab seperated list of light manager names. +/// @ingroup Lighting ) +/// /// public string fn_getLightManagerNames () @@ -4262,7 +5708,13 @@ public string fn_getLightManagerNames () } /// -/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. This directory will usually contain all the game assets and, in a user-side game installation, will usually be read-only. @return The path to the main game assets. @ingroup FileSystem) +/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. +/// +/// This directory will usually contain all the game assets and, in a user-side game installation, will usually be +/// read-only. +/// @return The path to the main game assets. +/// @ingroup FileSystem) +/// /// public string fn_getMainDotCsDir () @@ -4278,6 +5730,7 @@ public string fn_getMainDotCsDir () } /// /// @hide) +/// /// public string fn_getMapEntry (string texName) @@ -4294,7 +5747,12 @@ public string fn_getMapEntry (string texName) } /// -/// (string texName) @brief Returns the name of the material mapped to this texture. If no materials are found, an empty string is returned. @param texName Name of the texture @ingroup Materials) +/// (string texName) +/// @brief Returns the name of the material mapped to this texture. +/// If no materials are found, an empty string is returned. +/// @param texName Name of the texture +/// @ingroup Materials) +/// /// public string fn_getMaterialMapping (string texName) @@ -4311,7 +5769,12 @@ public string fn_getMaterialMapping (string texName) } /// -/// Calculate the greater of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The greater value of the two specified values. @ingroup Math ) +/// Calculate the greater of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The greater value of the two specified values. +/// @ingroup Math ) +/// /// public float fn_getMax (float v1, float v2) @@ -4323,6 +5786,7 @@ public float fn_getMax (float v1, float v2) } /// /// getMaxFrameAllocation(); ) +/// /// public int fn_getMaxFrameAllocation () @@ -4334,7 +5798,13 @@ public int fn_getMaxFrameAllocation () return SafeNativeMethods.mwle_fn_getMaxFrameAllocation(); } /// -/// (string namespace, string method) @brief Provides the name of the package the method belongs to @param namespace Class or namespace, such as Player @param method Name of the funciton to search for @return The name of the method's package @ingroup Packages) +/// (string namespace, string method) +/// @brief Provides the name of the package the method belongs to +/// @param namespace Class or namespace, such as Player +/// @param method Name of the funciton to search for +/// @return The name of the method's package +/// @ingroup Packages) +/// /// public string fn_getMethodPackage (string nameSpace, string method) @@ -4354,7 +5824,12 @@ public string fn_getMethodPackage (string nameSpace, string method) } /// -/// Calculate the lesser of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The lesser value of the two specified values. @ingroup Math ) +/// Calculate the lesser of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The lesser value of the two specified values. +/// @ingroup Math ) +/// /// public float fn_getMin (float v1, float v2) @@ -4365,7 +5840,9 @@ public float fn_getMin (float v1, float v2) return SafeNativeMethods.mwle_fn_getMin(v1, v2); } /// -/// Get the MissionArea object, if any. @ingroup enviroMisc) +/// Get the MissionArea object, if any. +/// @ingroup enviroMisc) +/// /// public string fn_getMissionAreaServerObject () @@ -4380,7 +5857,12 @@ public string fn_getMissionAreaServerObject () } /// -/// (string path) @brief Attempts to extract a mod directory from path. Returns empty string on failure. @param File path of mod folder @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated @internal) +/// (string path) +/// @brief Attempts to extract a mod directory from path. Returns empty string on failure. +/// @param File path of mod folder +/// @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated +/// @internal) +/// /// public string fn_getModNameFromPath (string path) @@ -4427,7 +5909,9 @@ public string fn_getPackageList () } /// -/// Returns the pixel shader version for the active device. @ingroup GFX ) +/// Returns the pixel shader version for the active device. +/// @ingroup GFX ) +/// /// public float fn_getPixelShaderVersion () @@ -4439,7 +5923,10 @@ public float fn_getPixelShaderVersion () return SafeNativeMethods.mwle_fn_getPixelShaderVersion(); } /// -/// ([relativeFileName]) @note Appears to be useless in Torque 3D, should be deprecated @internal) +/// ([relativeFileName]) +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @internal) +/// /// public string fn_getPrefsPath (string relativeFileName) @@ -4456,7 +5943,19 @@ public string fn_getPrefsPath (string relativeFileName) } /// -/// ( int a, int b ) @brief Returns a random number based on parameters passed in.. If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will return an integer between the specified numbers. @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. @param b Upper bound on the random number. The random number will be = @a b. @return A pseudo-random integer between @a a and @a b, between 0 and a, or a float between 0.0 and 1.1 depending on usage. @note All parameters are optional. @see setRandomSeed @ingroup Random ) +/// ( int a, int b ) +/// @brief Returns a random number based on parameters passed in.. +/// If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one +/// parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will +/// return an integer between the specified numbers. +/// @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. +/// @param b Upper bound on the random number. The random number will be = @a b. +/// @return A pseudo-random integer between @a a and @a b, between 0 and a, or a +/// float between 0.0 and 1.1 depending on usage. +/// @note All parameters are optional. +/// @see setRandomSeed +/// @ingroup Random ) +/// /// public float fn_getRandom (int a, int b) @@ -4467,7 +5966,10 @@ public float fn_getRandom (int a, int b) return SafeNativeMethods.mwle_fn_getRandom(a, b); } /// -/// Get the current seed used by the random number generator. @return The current random number generator seed value. @ingroup Random ) +/// Get the current seed used by the random number generator. +/// @return The current random number generator seed value. +/// @ingroup Random ) +/// /// public int fn_getRandomSeed () @@ -4479,7 +5981,11 @@ public int fn_getRandomSeed () return SafeNativeMethods.mwle_fn_getRandomSeed(); } /// -/// () @brief Return the current real time in milliseconds. Real time is platform defined; typically time since the computer booted. @ingroup Platform) +/// () +/// @brief Return the current real time in milliseconds. +/// Real time is platform defined; typically time since the computer booted. +/// @ingroup Platform) +/// /// public int fn_getRealTime () @@ -4491,7 +5997,20 @@ public int fn_getRealTime () return SafeNativeMethods.mwle_fn_getRealTime(); } /// -/// Extract the record at the given @a index in the newline-separated list in @a text. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to extract. @return The record at the given index or \"\" if @a index is out of range. @tsexample getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getRecords @see getRecordCount @see getWord @see getField @ingroup FieldManip ) +/// Extract the record at the given @a index in the newline-separated list in @a text. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to extract. +/// @return The record at the given index or \"\" if @a index is out of range. +/// @tsexample +/// getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getRecords +/// @see getRecordCount +/// @see getWord +/// @see getField +/// @ingroup FieldManip ) +/// /// public string fn_getRecord (string text, int index) @@ -4508,7 +6027,16 @@ public string fn_getRecord (string text, int index) } /// -/// Return the number of newline-separated records in @a text. @param text A list of records separated by newlines. @return The number of newline-sepearated elements in @a text. @tsexample getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getFieldCount @ingroup FieldManip ) +/// Return the number of newline-separated records in @a text. +/// @param text A list of records separated by newlines. +/// @return The number of newline-sepearated elements in @a text. +/// @tsexample +/// getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getFieldCount +/// @ingroup FieldManip ) +/// /// public int fn_getRecordCount (string text) @@ -4522,7 +6050,23 @@ public int fn_getRecordCount (string text) return SafeNativeMethods.mwle_fn_getRecordCount(sbtext); } /// -/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param startIndex The zero-based index of the first record to extract from @a text. @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of records from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" @endtsexample @see getRecord @see getRecordCount @see getWords @see getFields @ingroup FieldManip ) +/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param startIndex The zero-based index of the first record to extract from @a text. +/// @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of records from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see getRecordCount +/// @see getWords +/// @see getFields +/// @ingroup FieldManip ) +/// /// public string fn_getRecords (string text, int startIndex, int endIndex) @@ -4540,6 +6084,7 @@ public string fn_getRecords (string text, int startIndex, int endIndex) } /// /// getScheduleDuration(%scheduleId); ) +/// /// public int fn_getScheduleDuration (int scheduleId) @@ -4551,6 +6096,7 @@ public int fn_getScheduleDuration (int scheduleId) } /// /// getServerCount(...); ) +/// /// public int fn_getServerCount () @@ -4562,7 +6108,11 @@ public int fn_getServerCount () return SafeNativeMethods.mwle_fn_getServerCount(); } /// -/// () Return the current sim time in milliseconds. @brief Sim time is time since the game started. @ingroup Platform) +/// () +/// Return the current sim time in milliseconds. +/// @brief Sim time is time since the game started. +/// @ingroup Platform) +/// /// public int fn_getSimTime () @@ -4574,7 +6124,19 @@ public int fn_getSimTime () return SafeNativeMethods.mwle_fn_getSimTime(); } /// -/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source string length). @param str The string from which to extract a substring. @param start The offset at which to start copying out characters. @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end of the input string are copied. @return A string that contains the given portion of the input string. @tsexample getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". @endtsexample @ingroup Strings ) +/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str +/// (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source +/// string length). +/// @param str The string from which to extract a substring. +/// @param start The offset at which to start copying out characters. +/// @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end +/// of the input string are copied. +/// @return A string that contains the given portion of the input string. +/// @tsexample +/// getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_getSubStr (string str, int start, int numChars) @@ -4591,7 +6153,20 @@ public string fn_getSubStr (string str, int start, int numChars) } /// -/// ( string textTagString ) @brief Extracts the tag from a tagged string Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. @param textTagString The tagged string to extract. @returns The tag ID of the string. @see \\ref syntaxDataTypes under Tagged %Strings @see detag() @ingroup Networking) +/// ( string textTagString ) +/// @brief Extracts the tag from a tagged string +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. +/// +/// @param textTagString The tagged string to extract. +/// +/// @returns The tag ID of the string. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see detag() +/// @ingroup Networking) +/// /// public string fn_getTag (string textTagString) @@ -4608,7 +6183,22 @@ public string fn_getTag (string textTagString) } /// -/// ), @brief Use the getTaggedString function to convert a tag to a string. This is not the same as detag() which can only be used within the context of a function that receives a tag. This function can be used any time and anywhere to convert a tag to a string. @param tag A numeric tag ID. @returns The string as found in the Net String table. @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see removeTaggedString() @ingroup Networking) +/// ), +/// @brief Use the getTaggedString function to convert a tag to a string. +/// +/// This is not the same as detag() which can only be used within the context +/// of a function that receives a tag. This function can be used any time and +/// anywhere to convert a tag to a string. +/// +/// @param tag A numeric tag ID. +/// +/// @returns The string as found in the Net String table. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see removeTaggedString() +/// @ingroup Networking) +/// /// public string fn_getTaggedString (string tag) @@ -4625,7 +6215,16 @@ public string fn_getTaggedString (string tag) } /// -/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example @note This can be useful to adhering to OS standards and practices, but not really used in Torque 3D right now. @note Be very careful when getting into OS level File I/O. @return String containing path to OS temp directory @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example +/// @note This can be useful to adhering to OS standards and practices, +/// but not really used in Torque 3D right now. +/// @note Be very careful when getting into OS level File I/O. +/// @return String containing path to OS temp directory +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string fn_getTemporaryDirectory () @@ -4640,7 +6239,14 @@ public string fn_getTemporaryDirectory () } /// -/// @brief Creates a name and extension for a potential temporary file This does not create the actual file. It simply creates a random name for a file that does not exist. @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Creates a name and extension for a potential temporary file +/// This does not create the actual file. It simply creates a random name +/// for a file that does not exist. +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string fn_getTemporaryFileName () @@ -4655,7 +6261,11 @@ public string fn_getTemporaryFileName () } /// -/// (Point2 pos) - gets the terrain height at the specified position. @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point2 pos) - gets the terrain height at the specified position. +/// @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float fn_getTerrainHeight (string pos) @@ -4669,7 +6279,12 @@ public float fn_getTerrainHeight (string pos) return SafeNativeMethods.mwle_fn_getTerrainHeight(sbpos); } /// -/// (Point3F pos) - gets the terrain height at the specified position. @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) @note This function is useful if you simply want to grab the terrain height underneath an object. @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point3F pos) - gets the terrain height at the specified position. +/// @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) +/// @note This function is useful if you simply want to grab the terrain height underneath an object. +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float fn_getTerrainHeightBelowPosition (string pos) @@ -4683,7 +6298,12 @@ public float fn_getTerrainHeightBelowPosition (string pos) return SafeNativeMethods.mwle_fn_getTerrainHeightBelowPosition(sbpos); } /// -/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found). @hide) +/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found). +/// @hide) +/// /// public int fn_getTerrainUnderWorldPoint (string position) @@ -4697,7 +6317,9 @@ public int fn_getTerrainUnderWorldPoint (string position) return SafeNativeMethods.mwle_fn_getTerrainUnderWorldPoint(sbposition); } /// -/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB @ingroup GFX ) +/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB +/// @ingroup GFX ) +/// /// public string fn_getTextureProfileStats () @@ -4713,6 +6335,7 @@ public string fn_getTextureProfileStats () } /// /// getTimeSinceStart(%scheduleId); ) +/// /// public int fn_getTimeSinceStart (int scheduleId) @@ -4723,7 +6346,15 @@ public int fn_getTimeSinceStart (int scheduleId) return SafeNativeMethods.mwle_fn_getTimeSinceStart(scheduleId); } /// -/// Get the numeric suffix of the given input string. @param str The string from which to read out the numeric suffix. @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. @tsexample getTrailingNumber( \"test123\" ) // Returns '123'. @endtsexample @see stripTrailingNumber @ingroup Strings ) +/// Get the numeric suffix of the given input string. +/// @param str The string from which to read out the numeric suffix. +/// @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. +/// @tsexample +/// getTrailingNumber( \"test123\" ) // Returns '123'. +/// @endtsexample +/// @see stripTrailingNumber +/// @ingroup Strings ) +/// /// public int fn_getTrailingNumber (string str) @@ -4737,7 +6368,12 @@ public int fn_getTrailingNumber (string str) return SafeNativeMethods.mwle_fn_getTrailingNumber(sbstr); } /// -/// ( String baseName, SimSet set, bool searchChildren ) @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName, SimSet set, bool searchChildren ) +/// @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string fn_getUniqueInternalName (string baseName, string setString, bool searchChildren) @@ -4757,7 +6393,13 @@ public string fn_getUniqueInternalName (string baseName, string setString, bool } /// -/// ( String baseName ) @brief Returns a unique unused SimObject name based on a given base name. @baseName Name to conver to a unique string if another instance exists @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName ) +/// @brief Returns a unique unused SimObject name based on a given base name. +/// @baseName Name to conver to a unique string if another instance exists +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string fn_getUniqueName (string baseName) @@ -4775,6 +6417,7 @@ public string fn_getUniqueName (string baseName) } /// /// getUserDataDirectory()) +/// /// public string fn_getUserDataDirectory () @@ -4790,6 +6433,7 @@ public string fn_getUserDataDirectory () } /// /// getUserHomeDirectory()) +/// /// public string fn_getUserHomeDirectory () @@ -4804,7 +6448,12 @@ public string fn_getUserHomeDirectory () } /// -/// (string varName) @brief Returns the value of the named variable or an empty string if not found. @varName Name of the variable to search for @return Value contained by varName, \"\" if the variable does not exist @ingroup Scripting) +/// (string varName) +/// @brief Returns the value of the named variable or an empty string if not found. +/// @varName Name of the variable to search for +/// @return Value contained by varName, \"\" if the variable does not exist +/// @ingroup Scripting) +/// /// public string fn_getVariable (string varName) @@ -4821,7 +6470,9 @@ public string fn_getVariable (string varName) } /// -/// Get the version of the engine build, as a string. @ingroup Debugging) +/// Get the version of the engine build, as a string. +/// @ingroup Debugging) +/// /// public int fn_getVersionNumber () @@ -4833,7 +6484,9 @@ public int fn_getVersionNumber () return SafeNativeMethods.mwle_fn_getVersionNumber(); } /// -/// Get the version of the engine build, as a human readable string. @ingroup Debugging) +/// Get the version of the engine build, as a human readable string. +/// @ingroup Debugging) +/// /// public string fn_getVersionString () @@ -4848,7 +6501,12 @@ public string fn_getVersionString () } /// -/// Test whether Torque is running in web-deployment mode. In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not be able to enter fullscreen exclusive mode). @return True if Torque is running in web-deployment mode. @ingroup Platform ) +/// Test whether Torque is running in web-deployment mode. +/// In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not +/// be able to enter fullscreen exclusive mode). +/// @return True if Torque is running in web-deployment mode. +/// @ingroup Platform ) +/// /// public bool fn_getWebDeployment () @@ -4860,7 +6518,20 @@ public bool fn_getWebDeployment () return SafeNativeMethods.mwle_fn_getWebDeployment()>=1; } /// -/// Extract the word at the given @a index in the whitespace-separated list in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to extract. @return The word at the given index or \"\" if the index is out of range. @tsexample getWord( \"a b c\", 1 ) // Returns \"b\" @endtsexample @see getWords @see getWordCount @see getField @see getRecord @ingroup FieldManip ) +/// Extract the word at the given @a index in the whitespace-separated list in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to extract. +/// @return The word at the given index or \"\" if the index is out of range. +/// @tsexample +/// getWord( \"a b c\", 1 ) // Returns \"b\" +/// @endtsexample +/// @see getWords +/// @see getWordCount +/// @see getField +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string fn_getWord (string text, int index) @@ -4877,7 +6548,17 @@ public string fn_getWord (string text, int index) } /// -/// Return the number of whitespace-separated words in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @return The number of whitespace-separated words in @a text. @tsexample getWordCount( \"a b c d e\" ) // Returns 5 @endtsexample @see getFieldCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of whitespace-separated words in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @return The number of whitespace-separated words in @a text. +/// @tsexample +/// getWordCount( \"a b c d e\" ) // Returns 5 +/// @endtsexample +/// @see getFieldCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int fn_getWordCount (string text) @@ -4891,7 +6572,23 @@ public int fn_getWordCount (string text) return SafeNativeMethods.mwle_fn_getWordCount(sbtext); } /// -/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param startIndex The zero-based index of the first word to extract from @a text. @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of words from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" @endtsexample @see getWord @see getWordCount @see getFields @see getRecords @ingroup FieldManip ) +/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param startIndex The zero-based index of the first word to extract from @a text. +/// @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of words from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" +/// @endtsexample +/// @see getWord +/// @see getWordCount +/// @see getFields +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string fn_getWords (string text, int startIndex, int endIndex) @@ -4908,7 +6605,11 @@ public string fn_getWords (string text, int startIndex, int endIndex) } /// -/// @brief Reports the current directory @return String containing full file path of working directory @ingroup FileSystem) +/// @brief Reports the current directory +/// +/// @return String containing full file path of working directory +/// @ingroup FileSystem) +/// /// public string fn_getWorkingDirectory () @@ -4923,7 +6624,25 @@ public string fn_getWorkingDirectory () } /// -/// ( int controllerID, string property, bool currentD ) @brief Queries the current state of a connected Xbox 360 controller. XInput Properties: - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. - XI_START, XI_BACK - The Start and Back buttons. - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. @param controllerID Zero-based index of the controller to return information about. @param property Name of input action being queried, such as \"XI_THUMBLX\". @param current True checks current device in action. @return Button queried - 1 if the button is pressed, 0 if it's not. @return Thumbstick queried - Int representing displacement from rest position. @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. @ingroup Input) +/// ( int controllerID, string property, bool currentD ) +/// @brief Queries the current state of a connected Xbox 360 controller. +/// XInput Properties: +/// - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. +/// - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. +/// - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. +/// - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. +/// - XI_START, XI_BACK - The Start and Back buttons. +/// - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. +/// - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. +/// - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. +/// @param controllerID Zero-based index of the controller to return information about. +/// @param property Name of input action being queried, such as \"XI_THUMBLX\". +/// @param current True checks current device in action. +/// @return Button queried - 1 if the button is pressed, 0 if it's not. +/// @return Thumbstick queried - Int representing displacement from rest position. +/// @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. +/// @ingroup Input) +/// /// public int fn_getXInputState (int controllerID, string properties, bool current) @@ -4937,7 +6656,15 @@ public int fn_getXInputState (int controllerID, string properties, bool current) return SafeNativeMethods.mwle_fn_getXInputState(controllerID, sbproperties, current); } /// -/// Open the given URL or file in the user's web browser. @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then the function checks whether the address refers to a file or directory and if so, prepends \"file://\" to @a adress; if the file check fails, \"http://\" is prepended to @a address. @tsexample gotoWebPage( \"http://www.garagegames.com\" ); @endtsexample @ingroup Platform ) +/// Open the given URL or file in the user's web browser. +/// @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then +/// the function checks whether the address refers to a file or directory and if so, prepends \"file://\" +/// to @a adress; if the file check fails, \"http://\" is prepended to @a address. +/// @tsexample +/// gotoWebPage( \"http://www.garagegames.com\" ); +/// @endtsexample +/// @ingroup Platform ) +/// /// public void fn_gotoWebPage (string address) @@ -4951,7 +6678,9 @@ public void fn_gotoWebPage (string address) SafeNativeMethods.mwle_fn_gotoWebPage(sbaddress); } /// -/// ( String filename | String filename, bool resize ) Assign an image to the control. @hide ) +/// ( String filename | String filename, bool resize ) Assign an image to the control. +/// @hide ) +/// /// public void fn_GuiBitmapCtrl_setBitmap (string guibitmapctrl, string fileRoot, bool resize) @@ -4969,6 +6698,7 @@ public void fn_GuiBitmapCtrl_setBitmap (string guibitmapctrl, string fileRoot, b } /// /// () - Is this canvas currently fullscreen? ) +/// /// public bool fn_GuiCanvas_isFullscreen (string guicanvas) @@ -4983,6 +6713,7 @@ public bool fn_GuiCanvas_isFullscreen (string guicanvas) } /// /// () ) +/// /// public bool fn_GuiCanvas_isMaximized (string guicanvas) @@ -4997,6 +6728,7 @@ public bool fn_GuiCanvas_isMaximized (string guicanvas) } /// /// () ) +/// /// public bool fn_GuiCanvas_isMinimized (string guicanvas) @@ -5011,6 +6743,7 @@ public bool fn_GuiCanvas_isMinimized (string guicanvas) } /// /// () - maximize this canvas' window. ) +/// /// public void fn_GuiCanvas_maximizeWindow (string guicanvas) @@ -5025,6 +6758,7 @@ public void fn_GuiCanvas_maximizeWindow (string guicanvas) } /// /// () - minimize this canvas' window. ) +/// /// public void fn_GuiCanvas_minimizeWindow (string guicanvas) @@ -5038,7 +6772,9 @@ public void fn_GuiCanvas_minimizeWindow (string guicanvas) SafeNativeMethods.mwle_fn_GuiCanvas_minimizeWindow(sbguicanvas); } /// -/// (GuiControl ctrl=NULL) @hide) +/// (GuiControl ctrl=NULL) +/// @hide) +/// /// public void fn_GuiCanvas_popDialog (string guicanvas, string gui) @@ -5055,7 +6791,9 @@ public void fn_GuiCanvas_popDialog (string guicanvas, string gui) SafeNativeMethods.mwle_fn_GuiCanvas_popDialog(sbguicanvas, sbgui); } /// -/// (int layer) @hide) +/// (int layer) +/// @hide) +/// /// public void fn_GuiCanvas_popLayer (string guicanvas, int layer) @@ -5069,7 +6807,9 @@ public void fn_GuiCanvas_popLayer (string guicanvas, int layer) SafeNativeMethods.mwle_fn_GuiCanvas_popLayer(sbguicanvas, layer); } /// -/// (GuiControl ctrl, int layer=0, bool center=false) @hide) +/// (GuiControl ctrl, int layer=0, bool center=false) +/// @hide) +/// /// public void fn_GuiCanvas_pushDialog (string guicanvas, string ctrlName, int layer, bool center) @@ -5087,6 +6827,7 @@ public void fn_GuiCanvas_pushDialog (string guicanvas, string ctrlName, int laye } /// /// () - restore this canvas' window. ) +/// /// public void fn_GuiCanvas_restoreWindow (string guicanvas) @@ -5100,7 +6841,9 @@ public void fn_GuiCanvas_restoreWindow (string guicanvas) SafeNativeMethods.mwle_fn_GuiCanvas_restoreWindow(sbguicanvas); } /// -/// (Point2I pos) @hide) +/// (Point2I pos) +/// @hide) +/// /// public void fn_GuiCanvas_setCursorPos (string guicanvas, string pos) @@ -5118,6 +6861,7 @@ public void fn_GuiCanvas_setCursorPos (string guicanvas, string pos) } /// /// () - Claim OS input focus for this canvas' window.) +/// /// public void fn_GuiCanvas_setFocus (string guicanvas) @@ -5131,7 +6875,15 @@ public void fn_GuiCanvas_setFocus (string guicanvas) SafeNativeMethods.mwle_fn_GuiCanvas_setFocus(sbguicanvas); } /// -/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. \\param width The screen width to set. \\param height The screen height to set. \\param fullscreen Specify true to run fullscreen or false to run in a window \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) +/// Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. +/// \\param width The screen width to set. +/// \\param height The screen height to set. +/// \\param fullscreen Specify true to run fullscreen or false to run in a window +/// \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. +/// \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window +/// \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// /// public void fn_GuiCanvas_setVideoMode (string guicanvas, uint width, uint height, bool fullscreen, uint bitDepth, uint refreshRate, uint antialiasLevel) @@ -5146,6 +6898,7 @@ public void fn_GuiCanvas_setVideoMode (string guicanvas, uint width, uint height } /// /// Gets the current position of the selector) +/// /// public string fn_GuiColorPickerCtrl_getSelectorPos (string guicolorpickerctrl) @@ -5163,6 +6916,7 @@ public string fn_GuiColorPickerCtrl_getSelectorPos (string guicolorpickerctrl) } /// /// Sets the current position of the selector) +/// /// public void fn_GuiColorPickerCtrl_setSelectorPos (string guicolorpickerctrl, string newPos) @@ -5180,6 +6934,7 @@ public void fn_GuiColorPickerCtrl_setSelectorPos (string guicolorpickerctrl, str } /// /// Forces update of pick color) +/// /// public void fn_GuiColorPickerCtrl_updateColor (string guicolorpickerctrl) @@ -5194,6 +6949,7 @@ public void fn_GuiColorPickerCtrl_updateColor (string guicolorpickerctrl) } /// /// ) +/// /// public string fn_GuiControl_getBounds (string guicontrol) @@ -5211,6 +6967,7 @@ public string fn_GuiControl_getBounds (string guicontrol) } /// /// ) +/// /// public string fn_GuiControl_getValue (string guicontrol) @@ -5228,6 +6985,7 @@ public string fn_GuiControl_getValue (string guicontrol) } /// /// ) +/// /// public bool fn_GuiControl_isActive (string guicontrol) @@ -5242,6 +7000,7 @@ public bool fn_GuiControl_isActive (string guicontrol) } /// /// (bool isFirst)) +/// /// public void fn_GuiControl_makeFirstResponder (string guicontrol, bool isFirst) @@ -5255,7 +7014,9 @@ public void fn_GuiControl_makeFirstResponder (string guicontrol, bool isFirst) SafeNativeMethods.mwle_fn_GuiControl_makeFirstResponder(sbguicontrol, isFirst); } /// -/// Set the width and height of the control. @hide ) +/// Set the width and height of the control. +/// @hide ) +/// /// public void fn_GuiControl_setExtent (string guicontrol, string ext) @@ -5273,6 +7034,7 @@ public void fn_GuiControl_setExtent (string guicontrol, string ext) } /// /// ( pString ) ) +/// /// public int fn_GuiControlProfile_getStringWidth (string guicontrolprofile, string pString) @@ -5290,6 +7052,7 @@ public int fn_GuiControlProfile_getStringWidth (string guicontrolprofile, string } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_dropSelectionAtScreenCenter (string guiconvexeditorctrl) @@ -5304,6 +7067,7 @@ public void fn_GuiConvexEditorCtrl_dropSelectionAtScreenCenter (string guiconvex } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_handleDelete (string guiconvexeditorctrl) @@ -5318,6 +7082,7 @@ public void fn_GuiConvexEditorCtrl_handleDelete (string guiconvexeditorctrl) } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_handleDeselect (string guiconvexeditorctrl) @@ -5332,6 +7097,7 @@ public void fn_GuiConvexEditorCtrl_handleDeselect (string guiconvexeditorctrl) } /// /// ) +/// /// public int fn_GuiConvexEditorCtrl_hasSelection (string guiconvexeditorctrl) @@ -5346,6 +7112,7 @@ public int fn_GuiConvexEditorCtrl_hasSelection (string guiconvexeditorctrl) } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_hollowSelection (string guiconvexeditorctrl) @@ -5360,6 +7127,7 @@ public void fn_GuiConvexEditorCtrl_hollowSelection (string guiconvexeditorctrl) } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_recenterSelection (string guiconvexeditorctrl) @@ -5374,6 +7142,7 @@ public void fn_GuiConvexEditorCtrl_recenterSelection (string guiconvexeditorctrl } /// /// ( ConvexShape ) ) +/// /// public void fn_GuiConvexEditorCtrl_selectConvex (string guiconvexeditorctrl, string convex) @@ -5391,6 +7160,7 @@ public void fn_GuiConvexEditorCtrl_selectConvex (string guiconvexeditorctrl, str } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_splitSelectedFace (string guiconvexeditorctrl) @@ -5405,6 +7175,7 @@ public void fn_GuiConvexEditorCtrl_splitSelectedFace (string guiconvexeditorctrl } /// /// deleteSelectedDecalDatablock( String datablock ) ) +/// /// public void fn_GuiDecalEditorCtrl_deleteDecalDatablock (string guidecaleditorctrl, string datablock) @@ -5422,6 +7193,7 @@ public void fn_GuiDecalEditorCtrl_deleteDecalDatablock (string guidecaleditorctr } /// /// deleteSelectedDecal() ) +/// /// public void fn_GuiDecalEditorCtrl_deleteSelectedDecal (string guidecaleditorctrl) @@ -5436,6 +7208,7 @@ public void fn_GuiDecalEditorCtrl_deleteSelectedDecal (string guidecaleditorctrl } /// /// editDecalDetails( S32 )() ) +/// /// public void fn_GuiDecalEditorCtrl_editDecalDetails (string guidecaleditorctrl, uint id, string pos, string tan, float size) @@ -5456,6 +7229,7 @@ public void fn_GuiDecalEditorCtrl_editDecalDetails (string guidecaleditorctrl, u } /// /// getDecalCount() ) +/// /// public int fn_GuiDecalEditorCtrl_getDecalCount (string guidecaleditorctrl) @@ -5470,6 +7244,7 @@ public int fn_GuiDecalEditorCtrl_getDecalCount (string guidecaleditorctrl) } /// /// getDecalLookupName( S32 )() ) +/// /// public string fn_GuiDecalEditorCtrl_getDecalLookupName (string guidecaleditorctrl, uint id) @@ -5487,6 +7262,7 @@ public string fn_GuiDecalEditorCtrl_getDecalLookupName (string guidecaleditorctr } /// /// getDecalTransform() ) +/// /// public string fn_GuiDecalEditorCtrl_getDecalTransform (string guidecaleditorctrl, uint id) @@ -5504,6 +7280,7 @@ public string fn_GuiDecalEditorCtrl_getDecalTransform (string guidecaleditorctrl } /// /// getMode() ) +/// /// public string fn_GuiDecalEditorCtrl_getMode (string guidecaleditorctrl) @@ -5521,6 +7298,7 @@ public string fn_GuiDecalEditorCtrl_getMode (string guidecaleditorctrl) } /// /// ) +/// /// public int fn_GuiDecalEditorCtrl_getSelectionCount (string guidecaleditorctrl) @@ -5535,6 +7313,7 @@ public int fn_GuiDecalEditorCtrl_getSelectionCount (string guidecaleditorctrl) } /// /// ) +/// /// public void fn_GuiDecalEditorCtrl_retargetDecalDatablock (string guidecaleditorctrl, string dbFrom, string dbTo) @@ -5555,6 +7334,7 @@ public void fn_GuiDecalEditorCtrl_retargetDecalDatablock (string guidecaleditorc } /// /// selectDecal( S32 )() ) +/// /// public void fn_GuiDecalEditorCtrl_selectDecal (string guidecaleditorctrl, uint id) @@ -5569,6 +7349,7 @@ public void fn_GuiDecalEditorCtrl_selectDecal (string guidecaleditorctrl, uint i } /// /// setMode( String mode )() ) +/// /// public void fn_GuiDecalEditorCtrl_setMode (string guidecaleditorctrl, string newMode) @@ -5586,6 +7367,7 @@ public void fn_GuiDecalEditorCtrl_setMode (string guidecaleditorctrl, string new } /// /// (GuiControl ctrl)) +/// /// public void fn_GuiEditCtrl_addNewCtrl (string guieditctrl, string ctrl) @@ -5603,6 +7385,7 @@ public void fn_GuiEditCtrl_addNewCtrl (string guieditctrl, string ctrl) } /// /// selects a control.) +/// /// public void fn_GuiEditCtrl_addSelection (string guieditctrl, int id) @@ -5617,6 +7400,7 @@ public void fn_GuiEditCtrl_addSelection (string guieditctrl, int id) } /// /// ) +/// /// public void fn_GuiEditCtrl_bringToFront (string guieditctrl) @@ -5631,6 +7415,7 @@ public void fn_GuiEditCtrl_bringToFront (string guieditctrl) } /// /// ( [ int axis ] ) - Clear all currently set guide lines. ) +/// /// public void fn_GuiEditCtrl_clearGuides (string guieditctrl, int axis) @@ -5645,6 +7430,7 @@ public void fn_GuiEditCtrl_clearGuides (string guieditctrl, int axis) } /// /// Clear selected controls list.) +/// /// public void fn_GuiEditCtrl_clearSelection (string guieditctrl) @@ -5659,6 +7445,7 @@ public void fn_GuiEditCtrl_clearSelection (string guieditctrl) } /// /// () - Delete the selected controls.) +/// /// public void fn_GuiEditCtrl_deleteSelection (string guieditctrl) @@ -5673,6 +7460,7 @@ public void fn_GuiEditCtrl_deleteSelection (string guieditctrl) } /// /// ( bool width=true, bool height=true ) - Fit selected controls into their parents. ) +/// /// public void fn_GuiEditCtrl_fitIntoParents (string guieditctrl, bool width, bool height) @@ -5687,6 +7475,7 @@ public void fn_GuiEditCtrl_fitIntoParents (string guieditctrl, bool width, bool } /// /// () - Return the toplevel control edited inside the GUI editor. ) +/// /// public int fn_GuiEditCtrl_getContentControl (string guieditctrl) @@ -5701,6 +7490,7 @@ public int fn_GuiEditCtrl_getContentControl (string guieditctrl) } /// /// Returns the set to which new controls will be added) +/// /// public int fn_GuiEditCtrl_getCurrentAddSet (string guieditctrl) @@ -5715,6 +7505,7 @@ public int fn_GuiEditCtrl_getCurrentAddSet (string guieditctrl) } /// /// () - Return the current mouse mode. ) +/// /// public string fn_GuiEditCtrl_getMouseMode (string guieditctrl) @@ -5732,6 +7523,7 @@ public string fn_GuiEditCtrl_getMouseMode (string guieditctrl) } /// /// () - Return the number of controls currently selected. ) +/// /// public int fn_GuiEditCtrl_getNumSelected (string guieditctrl) @@ -5746,6 +7538,7 @@ public int fn_GuiEditCtrl_getNumSelected (string guieditctrl) } /// /// () - Returns global bounds of current selection as vector 'x y width height'. ) +/// /// public string fn_GuiEditCtrl_getSelectionGlobalBounds (string guieditctrl) @@ -5763,6 +7556,7 @@ public string fn_GuiEditCtrl_getSelectionGlobalBounds (string guieditctrl) } /// /// (int mode) ) +/// /// public void fn_GuiEditCtrl_justify (string guieditctrl, uint mode) @@ -5777,6 +7571,7 @@ public void fn_GuiEditCtrl_justify (string guieditctrl, uint mode) } /// /// ( string fileName=null ) - Load selection from file or clipboard.) +/// /// public void fn_GuiEditCtrl_loadSelection (string guieditctrl, string filename) @@ -5794,6 +7589,7 @@ public void fn_GuiEditCtrl_loadSelection (string guieditctrl, string filename) } /// /// Move all controls in the selection by (dx,dy) pixels.) +/// /// public void fn_GuiEditCtrl_moveSelection (string guieditctrl, string pos) @@ -5811,6 +7607,7 @@ public void fn_GuiEditCtrl_moveSelection (string guieditctrl, string pos) } /// /// ) +/// /// public void fn_GuiEditCtrl_pushToBack (string guieditctrl) @@ -5825,6 +7622,7 @@ public void fn_GuiEditCtrl_pushToBack (string guieditctrl) } /// /// ( GuiControl ctrl [, int axis ] ) - Read the guides from the given control. ) +/// /// public void fn_GuiEditCtrl_readGuides (string guieditctrl, string ctrl, int axis) @@ -5842,6 +7640,7 @@ public void fn_GuiEditCtrl_readGuides (string guieditctrl, string ctrl, int axis } /// /// deselects a control.) +/// /// public void fn_GuiEditCtrl_removeSelection (string guieditctrl, int id) @@ -5856,6 +7655,7 @@ public void fn_GuiEditCtrl_removeSelection (string guieditctrl, int id) } /// /// ( string fileName=null ) - Save selection to file or clipboard.) +/// /// public void fn_GuiEditCtrl_saveSelection (string guieditctrl, string filename) @@ -5873,6 +7673,7 @@ public void fn_GuiEditCtrl_saveSelection (string guieditctrl, string filename) } /// /// (GuiControl ctrl)) +/// /// public void fn_GuiEditCtrl_select (string guieditctrl, string ctrl) @@ -5890,6 +7691,7 @@ public void fn_GuiEditCtrl_select (string guieditctrl, string ctrl) } /// /// ()) +/// /// public void fn_GuiEditCtrl_selectAll (string guieditctrl) @@ -5904,6 +7706,7 @@ public void fn_GuiEditCtrl_selectAll (string guieditctrl) } /// /// ( bool addToSelection=false ) - Select children of currently selected controls. ) +/// /// public void fn_GuiEditCtrl_selectChildren (string guieditctrl, bool addToSelection) @@ -5918,6 +7721,7 @@ public void fn_GuiEditCtrl_selectChildren (string guieditctrl, bool addToSelecti } /// /// ( bool addToSelection=false ) - Select parents of currently selected controls. ) +/// /// public void fn_GuiEditCtrl_selectParents (string guieditctrl, bool addToSelection) @@ -5932,6 +7736,7 @@ public void fn_GuiEditCtrl_selectParents (string guieditctrl, bool addToSelectio } /// /// ( GuiControl ctrl ) - Set the toplevel control to edit in the GUI editor. ) +/// /// public void fn_GuiEditCtrl_setContentControl (string guieditctrl, string ctrl) @@ -5949,6 +7754,7 @@ public void fn_GuiEditCtrl_setContentControl (string guieditctrl, string ctrl) } /// /// (GuiControl ctrl)) +/// /// public void fn_GuiEditCtrl_setCurrentAddSet (string guieditctrl, string addSet) @@ -5966,6 +7772,7 @@ public void fn_GuiEditCtrl_setCurrentAddSet (string guieditctrl, string addSet) } /// /// GuiEditCtrl.setSnapToGrid(gridsize)) +/// /// public void fn_GuiEditCtrl_setSnapToGrid (string guieditctrl, uint gridsize) @@ -5980,6 +7787,7 @@ public void fn_GuiEditCtrl_setSnapToGrid (string guieditctrl, uint gridsize) } /// /// Toggle activation.) +/// /// public void fn_GuiEditCtrl_toggle (string guieditctrl) @@ -5994,6 +7802,7 @@ public void fn_GuiEditCtrl_toggle (string guieditctrl) } /// /// ( GuiControl ctrl [, int axis ] ) - Write the guides to the given control. ) +/// /// public void fn_GuiEditCtrl_writeGuides (string guieditctrl, string ctrl, int axis) @@ -6011,6 +7820,7 @@ public void fn_GuiEditCtrl_writeGuides (string guieditctrl, string ctrl, int axi } /// /// getSelectedPath() - returns the currently selected path in the tree) +/// /// public string fn_GuiFileTreeCtrl_getSelectedPath (string guifiletreectrl) @@ -6028,6 +7838,7 @@ public string fn_GuiFileTreeCtrl_getSelectedPath (string guifiletreectrl) } /// /// () - Reread the directory tree hierarchy. ) +/// /// public void fn_GuiFileTreeCtrl_reload (string guifiletreectrl) @@ -6042,6 +7853,7 @@ public void fn_GuiFileTreeCtrl_reload (string guifiletreectrl) } /// /// setSelectedPath(path) - expands the tree to the specified path) +/// /// public bool fn_GuiFileTreeCtrl_setSelectedPath (string guifiletreectrl, string path) @@ -6058,7 +7870,9 @@ public bool fn_GuiFileTreeCtrl_setSelectedPath (string guifiletreectrl, string p return SafeNativeMethods.mwle_fn_GuiFileTreeCtrl_setSelectedPath(sbguifiletreectrl, sbpath)>=1; } /// -/// Return a tuple containing all the values in the filter. @internal) +/// Return a tuple containing all the values in the filter. +/// @internal) +/// /// public string fn_GuiFilterCtrl_getValue (string guifilterctrl) @@ -6075,7 +7889,9 @@ public string fn_GuiFilterCtrl_getValue (string guifilterctrl) } /// -/// Reset the filtering. @internal) +/// Reset the filtering. +/// @internal) +/// /// public void fn_GuiFilterCtrl_identity (string guifilterctrl) @@ -6090,6 +7906,7 @@ public void fn_GuiFilterCtrl_identity (string guifilterctrl) } /// /// Get color value) +/// /// public string fn_GuiGradientCtrl_getColor (string guigradientctrl, int idx) @@ -6107,6 +7924,7 @@ public string fn_GuiGradientCtrl_getColor (string guigradientctrl, int idx) } /// /// Get color count) +/// /// public int fn_GuiGradientCtrl_getColorCount (string guigradientctrl) @@ -6120,7 +7938,9 @@ public int fn_GuiGradientCtrl_getColorCount (string guigradientctrl) return SafeNativeMethods.mwle_fn_GuiGradientCtrl_getColorCount(sbguigradientctrl); } /// -/// () @internal) +/// () +/// @internal) +/// /// public void fn_GuiIdleCamFadeBitmapCtrl_fadeIn (string guiidlecamfadebitmapctrl) @@ -6134,7 +7954,9 @@ public void fn_GuiIdleCamFadeBitmapCtrl_fadeIn (string guiidlecamfadebitmapctrl) SafeNativeMethods.mwle_fn_GuiIdleCamFadeBitmapCtrl_fadeIn(sbguiidlecamfadebitmapctrl); } /// -/// () @internal) +/// () +/// @internal) +/// /// public void fn_GuiIdleCamFadeBitmapCtrl_fadeOut (string guiidlecamfadebitmapctrl) @@ -6149,6 +7971,7 @@ public void fn_GuiIdleCamFadeBitmapCtrl_fadeOut (string guiidlecamfadebitmapctrl } /// /// ( id object, (bool autoSync = true) ) - Add the object to the list of objects being inspected. ) +/// /// public void fn_GuiInspector_addInspect (string guiinspector, string className, bool autoSync) @@ -6166,6 +7989,7 @@ public void fn_GuiInspector_addInspect (string guiinspector, string className, b } /// /// apply() - Force application of inspected object's attributes ) +/// /// public void fn_GuiInspector_apply (string guiinspector) @@ -6180,6 +8004,7 @@ public void fn_GuiInspector_apply (string guiinspector) } /// /// getInspectObject( int index=0 ) - Returns currently inspected object ) +/// /// public string fn_GuiInspector_getInspectObject (string guiinspector, uint index) @@ -6197,6 +8022,7 @@ public string fn_GuiInspector_getInspectObject (string guiinspector, uint index) } /// /// () - Return the number of objects currently being inspected. ) +/// /// public int fn_GuiInspector_getNumInspectObjects (string guiinspector) @@ -6211,6 +8037,7 @@ public int fn_GuiInspector_getNumInspectObjects (string guiinspector) } /// /// Inspect(Object)) +/// /// public void fn_GuiInspector_inspect (string guiinspector, string className) @@ -6228,6 +8055,7 @@ public void fn_GuiInspector_inspect (string guiinspector, string className) } /// /// Reinspect the currently selected object. ) +/// /// public void fn_GuiInspector_refresh (string guiinspector) @@ -6242,6 +8070,7 @@ public void fn_GuiInspector_refresh (string guiinspector) } /// /// ( id object ) - Remove the object from the list of objects being inspected. ) +/// /// public void fn_GuiInspector_removeInspect (string guiinspector, string obj) @@ -6259,6 +8088,7 @@ public void fn_GuiInspector_removeInspect (string guiinspector, string obj) } /// /// setName(NewObjectName)) +/// /// public void fn_GuiInspector_setName (string guiinspector, string newObjectName) @@ -6276,6 +8106,7 @@ public void fn_GuiInspector_setName (string guiinspector, string newObjectName) } /// /// setObjectField( fieldname, data ) - Set a named fields value on the inspected object if it exists. This triggers all the usual callbacks that would occur if the field had been changed through the gui. ) +/// /// public void fn_GuiInspector_setObjectField (string guiinspector, string fieldname, string data) @@ -6296,6 +8127,7 @@ public void fn_GuiInspector_setObjectField (string guiinspector, string fieldnam } /// /// field.renameField(newDynamicFieldName); ) +/// /// public void fn_GuiInspectorDynamicField_renameField (string guiinspectordynamicfield, string newDynamicFieldName) @@ -6313,6 +8145,7 @@ public void fn_GuiInspectorDynamicField_renameField (string guiinspectordynamicf } /// /// obj.addDynamicField(); ) +/// /// public void fn_GuiInspectorDynamicGroup_addDynamicField (string guiinspectordynamicgroup) @@ -6327,6 +8160,7 @@ public void fn_GuiInspectorDynamicGroup_addDynamicField (string guiinspectordyna } /// /// Refreshes the dynamic fields in the inspector.) +/// /// public bool fn_GuiInspectorDynamicGroup_inspectGroup (string guiinspectordynamicgroup) @@ -6341,6 +8175,7 @@ public bool fn_GuiInspectorDynamicGroup_inspectGroup (string guiinspectordynamic } /// /// ) +/// /// public void fn_GuiInspectorDynamicGroup_removeDynamicField (string guiinspectordynamicgroup) @@ -6355,6 +8190,7 @@ public void fn_GuiInspectorDynamicGroup_removeDynamicField (string guiinspectord } /// /// , true), ( string newValue, bool callbacks=true ) - Set the field's value. Suppress callbacks for undo if callbacks=false. ) +/// /// public void fn_GuiInspectorField_apply (string guiinspectorfield, string newValue, bool callbacks) @@ -6372,6 +8208,7 @@ public void fn_GuiInspectorField_apply (string guiinspectorfield, string newValu } /// /// () - Set field value without recording undo (same as 'apply( value, false )'). ) +/// /// public void fn_GuiInspectorField_applyWithoutUndo (string guiinspectorfield, string data) @@ -6389,6 +8226,7 @@ public void fn_GuiInspectorField_applyWithoutUndo (string guiinspectorfield, str } /// /// () - Return the value currently displayed on the field. ) +/// /// public string fn_GuiInspectorField_getData (string guiinspectorfield) @@ -6406,6 +8244,7 @@ public string fn_GuiInspectorField_getData (string guiinspectorfield) } /// /// () - Return the name of the field edited by this inspector field. ) +/// /// public string fn_GuiInspectorField_getInspectedFieldName (string guiinspectorfield) @@ -6423,6 +8262,7 @@ public string fn_GuiInspectorField_getInspectedFieldName (string guiinspectorfie } /// /// () - Return the type of the field edited by this inspector field. ) +/// /// public string fn_GuiInspectorField_getInspectedFieldType (string guiinspectorfield) @@ -6440,6 +8280,7 @@ public string fn_GuiInspectorField_getInspectedFieldType (string guiinspectorfie } /// /// () - Return the GuiInspector to which this field belongs. ) +/// /// public int fn_GuiInspectorField_getInspector (string guiinspectorfield) @@ -6454,6 +8295,7 @@ public int fn_GuiInspectorField_getInspector (string guiinspectorfield) } /// /// () - Reset to default value. ) +/// /// public void fn_GuiInspectorField_reset (string guiinspectorfield) @@ -6467,7 +8309,9 @@ public void fn_GuiInspectorField_reset (string guiinspectorfield) SafeNativeMethods.mwle_fn_GuiInspectorField_reset(sbguiinspectorfield); } /// -/// ( string materialName ) Set the material to be displayed in the control. ) +/// ( string materialName ) +/// Set the material to be displayed in the control. ) +/// /// public bool fn_GuiMaterialCtrl_setMaterial (string guimaterialctrl, string materialName) @@ -6485,6 +8329,7 @@ public bool fn_GuiMaterialCtrl_setMaterial (string guimaterialctrl, string mater } /// /// deleteNode() ) +/// /// public void fn_GuiMeshRoadEditorCtrl_deleteNode (string guimeshroadeditorctrl) @@ -6499,6 +8344,7 @@ public void fn_GuiMeshRoadEditorCtrl_deleteNode (string guimeshroadeditorctrl) } /// /// ) +/// /// public string fn_GuiMeshRoadEditorCtrl_getMode (string guimeshroadeditorctrl) @@ -6516,6 +8362,7 @@ public string fn_GuiMeshRoadEditorCtrl_getMode (string guimeshroadeditorctrl) } /// /// ) +/// /// public float fn_GuiMeshRoadEditorCtrl_getNodeDepth (string guimeshroadeditorctrl) @@ -6530,6 +8377,7 @@ public float fn_GuiMeshRoadEditorCtrl_getNodeDepth (string guimeshroadeditorctrl } /// /// ) +/// /// public string fn_GuiMeshRoadEditorCtrl_getNodeNormal (string guimeshroadeditorctrl) @@ -6547,6 +8395,7 @@ public string fn_GuiMeshRoadEditorCtrl_getNodeNormal (string guimeshroadeditorct } /// /// ) +/// /// public string fn_GuiMeshRoadEditorCtrl_getNodePosition (string guimeshroadeditorctrl) @@ -6564,6 +8413,7 @@ public string fn_GuiMeshRoadEditorCtrl_getNodePosition (string guimeshroadeditor } /// /// ) +/// /// public float fn_GuiMeshRoadEditorCtrl_getNodeWidth (string guimeshroadeditorctrl) @@ -6578,6 +8428,7 @@ public float fn_GuiMeshRoadEditorCtrl_getNodeWidth (string guimeshroadeditorctrl } /// /// ) +/// /// public int fn_GuiMeshRoadEditorCtrl_getSelectedRoad (string guimeshroadeditorctrl) @@ -6592,6 +8443,7 @@ public int fn_GuiMeshRoadEditorCtrl_getSelectedRoad (string guimeshroadeditorctr } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_matchTerrainToRoad (string guimeshroadeditorctrl) @@ -6606,6 +8458,7 @@ public void fn_GuiMeshRoadEditorCtrl_matchTerrainToRoad (string guimeshroadedito } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_regenerate (string guimeshroadeditorctrl) @@ -6620,6 +8473,7 @@ public void fn_GuiMeshRoadEditorCtrl_regenerate (string guimeshroadeditorctrl) } /// /// setMode( String mode ) ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setMode (string guimeshroadeditorctrl, string mode) @@ -6637,6 +8491,7 @@ public void fn_GuiMeshRoadEditorCtrl_setMode (string guimeshroadeditorctrl, stri } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodeDepth (string guimeshroadeditorctrl, float depth) @@ -6651,6 +8506,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodeDepth (string guimeshroadeditorctrl, } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodeNormal (string guimeshroadeditorctrl, string normal) @@ -6668,6 +8524,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodeNormal (string guimeshroadeditorctrl } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodePosition (string guimeshroadeditorctrl, string pos) @@ -6685,6 +8542,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodePosition (string guimeshroadeditorct } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodeWidth (string guimeshroadeditorctrl, float width) @@ -6699,6 +8557,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodeWidth (string guimeshroadeditorctrl, } /// /// ), ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setSelectedRoad (string guimeshroadeditorctrl, string objName) @@ -6716,6 +8575,7 @@ public void fn_GuiMeshRoadEditorCtrl_setSelectedRoad (string guimeshroadeditorct } /// /// ) +/// /// public string fn_GuiMissionAreaEditorCtrl_getSelectedMissionArea (string guimissionareaeditorctrl) @@ -6733,6 +8593,7 @@ public string fn_GuiMissionAreaEditorCtrl_getSelectedMissionArea (string guimiss } /// /// ), ) +/// /// public void fn_GuiMissionAreaEditorCtrl_setSelectedMissionArea (string guimissionareaeditorctrl, string missionAreaName) @@ -6785,7 +8646,10 @@ public void fn_GuiNavEditorCtrl_setMode (string guinaveditorctrl, string newMode SafeNativeMethods.mwle_fn_GuiNavEditorCtrl_setMode(sbguinaveditorctrl, sbnewMode); } /// -/// (int plotID, float x, float y, bool setAdded = true;) Add a data point to the given plot. @return) +/// (int plotID, float x, float y, bool setAdded = true;) +/// Add a data point to the given plot. +/// @return) +/// /// public string fn_GuiParticleGraphCtrl_addPlotPoint (string guiparticlegraphctrl, int plotID, float x, float y, bool setAdded) @@ -6802,7 +8666,13 @@ public string fn_GuiParticleGraphCtrl_addPlotPoint (string guiparticlegraphctrl, } /// -/// (int plotID, int i, float x, float y) Change a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Change a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public string fn_GuiParticleGraphCtrl_changePlotPoint (string guiparticlegraphctrl, int plotID, int i, float x, float y) @@ -6819,7 +8689,10 @@ public string fn_GuiParticleGraphCtrl_changePlotPoint (string guiparticlegraphct } /// -/// () Clear all of the graphs. @return No return value) +/// () +/// Clear all of the graphs. +/// @return No return value) +/// /// public void fn_GuiParticleGraphCtrl_clearAllGraphs (string guiparticlegraphctrl) @@ -6833,7 +8706,10 @@ public void fn_GuiParticleGraphCtrl_clearAllGraphs (string guiparticlegraphctrl) SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_clearAllGraphs(sbguiparticlegraphctrl); } /// -/// (int plotID) Clear the graph of the given plot. @return No return value) +/// (int plotID) +/// Clear the graph of the given plot. +/// @return No return value) +/// /// public void fn_GuiParticleGraphCtrl_clearGraph (string guiparticlegraphctrl, int plotID) @@ -6847,7 +8723,10 @@ public void fn_GuiParticleGraphCtrl_clearGraph (string guiparticlegraphctrl, int SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_clearGraph(sbguiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the color of the graph passed. @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// (int plotID) +/// Get the color of the graph passed. +/// @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// /// public string fn_GuiParticleGraphCtrl_getGraphColor (string guiparticlegraphctrl, int plotID) @@ -6864,7 +8743,10 @@ public string fn_GuiParticleGraphCtrl_getGraphColor (string guiparticlegraphctrl } /// -/// (int plotID) Get the maximum values of the graph ranges. @return Returns the maximum of the range formatted as \"x-max y-max\") +/// (int plotID) +/// Get the maximum values of the graph ranges. +/// @return Returns the maximum of the range formatted as \"x-max y-max\") +/// /// public string fn_GuiParticleGraphCtrl_getGraphMax (string guiparticlegraphctrl, int plotID) @@ -6881,7 +8763,10 @@ public string fn_GuiParticleGraphCtrl_getGraphMax (string guiparticlegraphctrl, } /// -/// (int plotID) Get the minimum values of the graph ranges. @return Returns the minimum of the range formatted as \"x-min y-min\") +/// (int plotID) +/// Get the minimum values of the graph ranges. +/// @return Returns the minimum of the range formatted as \"x-min y-min\") +/// /// public string fn_GuiParticleGraphCtrl_getGraphMin (string guiparticlegraphctrl, int plotID) @@ -6898,7 +8783,10 @@ public string fn_GuiParticleGraphCtrl_getGraphMin (string guiparticlegraphctrl, } /// -/// (int plotID) Get the name of the graph passed. @return Returns the name of the plot) +/// (int plotID) +/// Get the name of the graph passed. +/// @return Returns the name of the plot) +/// /// public string fn_GuiParticleGraphCtrl_getGraphName (string guiparticlegraphctrl, int plotID) @@ -6915,7 +8803,12 @@ public string fn_GuiParticleGraphCtrl_getGraphName (string guiparticlegraphctrl, } /// -/// (int plotID, float x, float y) Gets the index of the point passed on the plotID passed (graph ID). @param plotID The plot you wish to check. @param x,y The coordinates of the point to get. @return Returns the index of the point.) +/// (int plotID, float x, float y) +/// Gets the index of the point passed on the plotID passed (graph ID). +/// @param plotID The plot you wish to check. +/// @param x,y The coordinates of the point to get. +/// @return Returns the index of the point.) +/// /// public string fn_GuiParticleGraphCtrl_getPlotIndex (string guiparticlegraphctrl, int plotID, float x, float y) @@ -6932,7 +8825,10 @@ public string fn_GuiParticleGraphCtrl_getPlotIndex (string guiparticlegraphctrl, } /// -/// (int plotID, int samples) Get a data point from the plot specified, samples from the start of the graph. @return The data point ID) +/// (int plotID, int samples) +/// Get a data point from the plot specified, samples from the start of the graph. +/// @return The data point ID) +/// /// public string fn_GuiParticleGraphCtrl_getPlotPoint (string guiparticlegraphctrl, int plotID, int samples) @@ -6949,7 +8845,10 @@ public string fn_GuiParticleGraphCtrl_getPlotPoint (string guiparticlegraphctrl, } /// -/// () Gets the selected Plot (a.k.a. graph). @return The plot's ID.) +/// () +/// Gets the selected Plot (a.k.a. graph). +/// @return The plot's ID.) +/// /// public string fn_GuiParticleGraphCtrl_getSelectedPlot (string guiparticlegraphctrl) @@ -6966,7 +8865,10 @@ public string fn_GuiParticleGraphCtrl_getSelectedPlot (string guiparticlegraphct } /// -/// () Gets the selected Point on the Plot (a.k.a. graph). @return The last selected point ID) +/// () +/// Gets the selected Point on the Plot (a.k.a. graph). +/// @return The last selected point ID) +/// /// public string fn_GuiParticleGraphCtrl_getSelectedPoint (string guiparticlegraphctrl) @@ -6983,7 +8885,13 @@ public string fn_GuiParticleGraphCtrl_getSelectedPoint (string guiparticlegraphc } /// -/// (int plotID, int i, float x, float y) Insert a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Insert a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_insertPlotPoint (string guiparticlegraphctrl, int plotID, int i, float x, float y) @@ -6997,7 +8905,9 @@ public void fn_GuiParticleGraphCtrl_insertPlotPoint (string guiparticlegraphctrl SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_insertPlotPoint(sbguiparticlegraphctrl, plotID, i, x, y); } /// -/// (int plotID, int samples) @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// (int plotID, int samples) +/// @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// /// public string fn_GuiParticleGraphCtrl_isExistingPoint (string guiparticlegraphctrl, int plotID, int samples) @@ -7014,7 +8924,10 @@ public string fn_GuiParticleGraphCtrl_isExistingPoint (string guiparticlegraphct } /// -/// () This will reset the currently selected point to nothing. @return No return value.) +/// () +/// This will reset the currently selected point to nothing. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_resetSelectedPoint (string guiparticlegraphctrl) @@ -7028,7 +8941,11 @@ public void fn_GuiParticleGraphCtrl_resetSelectedPoint (string guiparticlegraphc SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_resetSelectedPoint(sbguiparticlegraphctrl); } /// -/// (bool autoMax) Set whether the max will automatically be set when adding points (ie if you add a value over the current max, the max is increased to that value). @return No return value.) +/// (bool autoMax) +/// Set whether the max will automatically be set when adding points +/// (ie if you add a value over the current max, the max is increased to that value). +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setAutoGraphMax (string guiparticlegraphctrl, bool autoMax) @@ -7042,7 +8959,10 @@ public void fn_GuiParticleGraphCtrl_setAutoGraphMax (string guiparticlegraphctrl SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setAutoGraphMax(sbguiparticlegraphctrl, autoMax); } /// -/// (bool autoRemove) Set whether or not a point should be deleted when you drag another one over it. @return No return value.) +/// (bool autoRemove) +/// Set whether or not a point should be deleted when you drag another one over it. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setAutoRemove (string guiparticlegraphctrl, bool autoRemove) @@ -7056,7 +8976,10 @@ public void fn_GuiParticleGraphCtrl_setAutoRemove (string guiparticlegraphctrl, SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setAutoRemove(sbguiparticlegraphctrl, autoRemove); } /// -/// (int plotID, bool isHidden) Set whether the graph number passed is hidden or not. @return No return value.) +/// (int plotID, bool isHidden) +/// Set whether the graph number passed is hidden or not. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphHidden (string guiparticlegraphctrl, int plotID, bool isHidden) @@ -7070,7 +8993,12 @@ public void fn_GuiParticleGraphCtrl_setGraphHidden (string guiparticlegraphctrl, SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphHidden(sbguiparticlegraphctrl, plotID, isHidden); } /// -/// (int plotID, float maxX, float maxY) Set the max values of the graph of plotID. @param plotID The plot to modify @param maxX,maxY The maximum bound of the value range. @return No return value.) +/// (int plotID, float maxX, float maxY) +/// Set the max values of the graph of plotID. +/// @param plotID The plot to modify +/// @param maxX,maxY The maximum bound of the value range. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMax (string guiparticlegraphctrl, int plotID, float maxX, float maxY) @@ -7084,7 +9012,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMax (string guiparticlegraphctrl, in SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMax(sbguiparticlegraphctrl, plotID, maxX, maxY); } /// -/// (int plotID, float maxX) Set the max X value of the graph of plotID. @param plotID The plot to modify. @param maxX The maximum x value. @return No return Value.) +/// (int plotID, float maxX) +/// Set the max X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxX The maximum x value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMaxX (string guiparticlegraphctrl, int plotID, float maxX) @@ -7098,7 +9031,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMaxX (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMaxX(sbguiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float maxY) Set the max Y value of the graph of plotID. @param plotID The plot to modify. @param maxY The maximum y value. @return No return Value.) +/// (int plotID, float maxY) +/// Set the max Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxY The maximum y value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMaxY (string guiparticlegraphctrl, int plotID, float maxX) @@ -7112,7 +9050,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMaxY (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMaxY(sbguiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float minX, float minY) Set the min values of the graph of plotID. @param plotID The plot to modify @param minX,minY The minimum bound of the value range. @return No return value.) +/// (int plotID, float minX, float minY) +/// Set the min values of the graph of plotID. +/// @param plotID The plot to modify +/// @param minX,minY The minimum bound of the value range. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMin (string guiparticlegraphctrl, int plotID, float minX, float minY) @@ -7126,7 +9069,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMin (string guiparticlegraphctrl, in SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMin(sbguiparticlegraphctrl, plotID, minX, minY); } /// -/// (int plotID, float minX) Set the min X value of the graph of plotID. @param plotID The plot to modify. @param minX The minimum x value. @return No return Value.) +/// (int plotID, float minX) +/// Set the min X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minX The minimum x value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMinX (string guiparticlegraphctrl, int plotID, float minX) @@ -7140,7 +9088,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMinX (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMinX(sbguiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, float minY) Set the min Y value of the graph of plotID. @param plotID The plot to modify. @param minY The minimum y value. @return No return Value.) +/// (int plotID, float minY) +/// Set the min Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minY The minimum y value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMinY (string guiparticlegraphctrl, int plotID, float minX) @@ -7154,7 +9107,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMinY (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMinY(sbguiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, string graphName) Set the name of the given plot. @param plotID The plot to modify. @param graphName The name to set on the plot. @return No return value.) +/// (int plotID, string graphName) +/// Set the name of the given plot. +/// @param plotID The plot to modify. +/// @param graphName The name to set on the plot. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphName (string guiparticlegraphctrl, int plotID, string graphName) @@ -7171,7 +9129,10 @@ public void fn_GuiParticleGraphCtrl_setGraphName (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphName(sbguiparticlegraphctrl, plotID, sbgraphName); } /// -/// (bool clamped) Set whether the x position of the selected graph point should be clamped @return No return value.) +/// (bool clamped) +/// Set whether the x position of the selected graph point should be clamped +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setPointXMovementClamped (string guiparticlegraphctrl, bool autoRemove) @@ -7185,7 +9146,10 @@ public void fn_GuiParticleGraphCtrl_setPointXMovementClamped (string guiparticle SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setPointXMovementClamped(sbguiparticlegraphctrl, autoRemove); } /// -/// (bool renderAll) Set whether or not a position should be rendered on every point or just the last selected. @return No return value.) +/// (bool renderAll) +/// Set whether or not a position should be rendered on every point or just the last selected. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setRenderAll (string guiparticlegraphctrl, bool autoRemove) @@ -7199,7 +9163,10 @@ public void fn_GuiParticleGraphCtrl_setRenderAll (string guiparticlegraphctrl, b SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setRenderAll(sbguiparticlegraphctrl, autoRemove); } /// -/// (bool renderGraphTooltip) Set whether or not to render the graph tooltip. @return No return value.) +/// (bool renderGraphTooltip) +/// Set whether or not to render the graph tooltip. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setRenderGraphTooltip (string guiparticlegraphctrl, bool autoRemove) @@ -7213,7 +9180,10 @@ public void fn_GuiParticleGraphCtrl_setRenderGraphTooltip (string guiparticlegra SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setRenderGraphTooltip(sbguiparticlegraphctrl, autoRemove); } /// -/// (int plotID) Set the selected plot (a.k.a. graph). @return No return value ) +/// (int plotID) +/// Set the selected plot (a.k.a. graph). +/// @return No return value ) +/// /// public void fn_GuiParticleGraphCtrl_setSelectedPlot (string guiparticlegraphctrl, int plotID) @@ -7227,7 +9197,10 @@ public void fn_GuiParticleGraphCtrl_setSelectedPlot (string guiparticlegraphctrl SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setSelectedPlot(sbguiparticlegraphctrl, plotID); } /// -/// (int point) Set the selected point on the graph. @return No return value) +/// (int point) +/// Set the selected point on the graph. +/// @return No return value) +/// /// public void fn_GuiParticleGraphCtrl_setSelectedPoint (string guiparticlegraphctrl, int point) @@ -7242,6 +9215,7 @@ public void fn_GuiParticleGraphCtrl_setSelectedPoint (string guiparticlegraphctr } /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void fn_GuiPopUpMenuCtrl_add (string guipopupmenuctrl, string name, int idNum, uint scheme) @@ -7259,6 +9233,7 @@ public void fn_GuiPopUpMenuCtrl_add (string guipopupmenuctrl, string name, int i } /// /// (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void fn_GuiPopUpMenuCtrl_addScheme (string guipopupmenuctrl, uint id, string fontColor, string fontColorHL, string fontColorSEL) @@ -7282,6 +9257,7 @@ public void fn_GuiPopUpMenuCtrl_addScheme (string guipopupmenuctrl, uint id, str } /// /// ( int id, string text ) ) +/// /// public void fn_GuiPopUpMenuCtrl_changeTextById (string guipopupmenuctrl, int id, string text) @@ -7299,6 +9275,7 @@ public void fn_GuiPopUpMenuCtrl_changeTextById (string guipopupmenuctrl, int id, } /// /// Clear the popup list.) +/// /// public void fn_GuiPopUpMenuCtrl_clear (string guipopupmenuctrl) @@ -7313,6 +9290,7 @@ public void fn_GuiPopUpMenuCtrl_clear (string guipopupmenuctrl) } /// /// (S32 entry)) +/// /// public void fn_GuiPopUpMenuCtrl_clearEntry (string guipopupmenuctrl, int entry) @@ -7326,7 +9304,9 @@ public void fn_GuiPopUpMenuCtrl_clearEntry (string guipopupmenuctrl, int entry) SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrl_clearEntry(sbguipopupmenuctrl, entry); } /// -/// (string text) Returns the position of the first entry containing the specified text.) +/// (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int fn_GuiPopUpMenuCtrl_findText (string guipopupmenuctrl, string text) @@ -7344,6 +9324,7 @@ public int fn_GuiPopUpMenuCtrl_findText (string guipopupmenuctrl, string text) } /// /// ) +/// /// public void fn_GuiPopUpMenuCtrl_forceClose (string guipopupmenuctrl) @@ -7358,6 +9339,7 @@ public void fn_GuiPopUpMenuCtrl_forceClose (string guipopupmenuctrl) } /// /// ) +/// /// public void fn_GuiPopUpMenuCtrl_forceOnAction (string guipopupmenuctrl) @@ -7372,6 +9354,7 @@ public void fn_GuiPopUpMenuCtrl_forceOnAction (string guipopupmenuctrl) } /// /// ) +/// /// public int fn_GuiPopUpMenuCtrl_getSelected (string guipopupmenuctrl) @@ -7386,6 +9369,7 @@ public int fn_GuiPopUpMenuCtrl_getSelected (string guipopupmenuctrl) } /// /// ) +/// /// public string fn_GuiPopUpMenuCtrl_getText (string guipopupmenuctrl) @@ -7403,6 +9387,7 @@ public string fn_GuiPopUpMenuCtrl_getText (string guipopupmenuctrl) } /// /// (int id)) +/// /// public string fn_GuiPopUpMenuCtrl_getTextById (string guipopupmenuctrl, int id) @@ -7420,6 +9405,7 @@ public string fn_GuiPopUpMenuCtrl_getTextById (string guipopupmenuctrl, int id) } /// /// (bool doReplaceText)) +/// /// public void fn_GuiPopUpMenuCtrl_replaceText (string guipopupmenuctrl, bool doReplaceText) @@ -7433,7 +9419,11 @@ public void fn_GuiPopUpMenuCtrl_replaceText (string guipopupmenuctrl, bool doRep SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrl_replaceText(sbguipopupmenuctrl, doReplaceText); } /// -/// (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void fn_GuiPopUpMenuCtrl_setEnumContent (string guipopupmenuctrl, string className, string enumName) @@ -7454,6 +9444,7 @@ public void fn_GuiPopUpMenuCtrl_setEnumContent (string guipopupmenuctrl, string } /// /// ([scriptCallback=true])) +/// /// public void fn_GuiPopUpMenuCtrl_setFirstSelected (string guipopupmenuctrl, bool scriptCallback) @@ -7468,6 +9459,7 @@ public void fn_GuiPopUpMenuCtrl_setFirstSelected (string guipopupmenuctrl, bool } /// /// ) +/// /// public void fn_GuiPopUpMenuCtrl_setNoneSelected (string guipopupmenuctrl) @@ -7482,6 +9474,7 @@ public void fn_GuiPopUpMenuCtrl_setNoneSelected (string guipopupmenuctrl) } /// /// (int id, [scriptCallback=true])) +/// /// public void fn_GuiPopUpMenuCtrl_setSelected (string guipopupmenuctrl, int id, bool scriptCallback) @@ -7496,6 +9489,7 @@ public void fn_GuiPopUpMenuCtrl_setSelected (string guipopupmenuctrl, int id, bo } /// /// Get the size of the menu - the number of entries in it.) +/// /// public int fn_GuiPopUpMenuCtrl_size (string guipopupmenuctrl) @@ -7510,6 +9504,7 @@ public int fn_GuiPopUpMenuCtrl_size (string guipopupmenuctrl) } /// /// Sort the list alphabetically.) +/// /// public void fn_GuiPopUpMenuCtrl_sort (string guipopupmenuctrl) @@ -7524,6 +9519,7 @@ public void fn_GuiPopUpMenuCtrl_sort (string guipopupmenuctrl) } /// /// Sort the list by ID.) +/// /// public void fn_GuiPopUpMenuCtrl_sortID (string guipopupmenuctrl) @@ -7538,6 +9534,7 @@ public void fn_GuiPopUpMenuCtrl_sortID (string guipopupmenuctrl) } /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void fn_GuiPopUpMenuCtrlEx_add (string guipopupmenuctrlex, string name, int idNum, uint scheme) @@ -7555,6 +9552,7 @@ public void fn_GuiPopUpMenuCtrlEx_add (string guipopupmenuctrlex, string name, i } /// /// (S32 entry)) +/// /// public void fn_GuiPopUpMenuCtrlEx_clearEntry (string guipopupmenuctrlex, int entry) @@ -7568,7 +9566,11 @@ public void fn_GuiPopUpMenuCtrlEx_clearEntry (string guipopupmenuctrlex, int ent SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_clearEntry(sbguipopupmenuctrlex, entry); } /// -/// (string text) Returns the id of the first entry containing the specified text or -1 if not found. @param text String value used for the query @return Numerical ID of entry containing the text.) +/// (string text) +/// Returns the id of the first entry containing the specified text or -1 if not found. +/// @param text String value used for the query +/// @return Numerical ID of entry containing the text.) +/// /// public int fn_GuiPopUpMenuCtrlEx_findText (string guipopupmenuctrlex, string text) @@ -7585,7 +9587,10 @@ public int fn_GuiPopUpMenuCtrlEx_findText (string guipopupmenuctrlex, string tex return SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_findText(sbguipopupmenuctrlex, sbtext); } /// -/// @brief Get color of an entry's box @param id ID number of entry to query @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// @brief Get color of an entry's box +/// @param id ID number of entry to query +/// @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// /// public string fn_GuiPopUpMenuCtrlEx_getColorById (string guipopupmenuctrlex, int id) @@ -7602,7 +9607,9 @@ public string fn_GuiPopUpMenuCtrlEx_getColorById (string guipopupmenuctrlex, int } /// -/// @brief Flag that causes each new text addition to replace the current entry @param True to turn on replacing, false to disable it) +/// @brief Flag that causes each new text addition to replace the current entry +/// @param True to turn on replacing, false to disable it) +/// /// public void fn_GuiPopUpMenuCtrlEx_replaceText (string guipopupmenuctrlex, int boolVal) @@ -7616,7 +9623,12 @@ public void fn_GuiPopUpMenuCtrlEx_replaceText (string guipopupmenuctrlex, int bo SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_replaceText(sbguipopupmenuctrlex, boolVal); } /// -/// @brief This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away. @param class Name of the class containing the enum @param enum Name of the enum value to acces) +/// @brief This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away. +/// @param class Name of the class containing the enum +/// @param enum Name of the enum value to acces) +/// /// public void fn_GuiPopUpMenuCtrlEx_setEnumContent (string guipopupmenuctrlex, string className, string enumName) @@ -7636,7 +9648,9 @@ public void fn_GuiPopUpMenuCtrlEx_setEnumContent (string guipopupmenuctrlex, str SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_setEnumContent(sbguipopupmenuctrlex, sbclassName, sbenumName); } /// -/// ([scriptCallback=true]) @hide) +/// ([scriptCallback=true]) +/// @hide) +/// /// public void fn_GuiPopUpMenuCtrlEx_setFirstSelected (string guipopupmenuctrlex, bool scriptCallback) @@ -7650,7 +9664,9 @@ public void fn_GuiPopUpMenuCtrlEx_setFirstSelected (string guipopupmenuctrlex, b SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_setFirstSelected(sbguipopupmenuctrlex, scriptCallback); } /// -/// (int id, [scriptCallback=true]) @hide) +/// (int id, [scriptCallback=true]) +/// @hide) +/// /// public void fn_GuiPopUpMenuCtrlEx_setSelected (string guipopupmenuctrlex, int id, bool scriptCallback) @@ -7664,7 +9680,9 @@ public void fn_GuiPopUpMenuCtrlEx_setSelected (string guipopupmenuctrlex, int id SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_setSelected(sbguipopupmenuctrlex, id, scriptCallback); } /// -/// @brief Get the size of the menu @return Number of entries in the menu) +/// @brief Get the size of the menu +/// @return Number of entries in the menu) +/// /// public int fn_GuiPopUpMenuCtrlEx_size (string guipopupmenuctrlex) @@ -7679,6 +9697,7 @@ public int fn_GuiPopUpMenuCtrlEx_size (string guipopupmenuctrlex) } /// /// deleteNode() ) +/// /// public void fn_GuiRiverEditorCtrl_deleteNode (string guirivereditorctrl) @@ -7693,6 +9712,7 @@ public void fn_GuiRiverEditorCtrl_deleteNode (string guirivereditorctrl) } /// /// ) +/// /// public string fn_GuiRiverEditorCtrl_getMode (string guirivereditorctrl) @@ -7710,6 +9730,7 @@ public string fn_GuiRiverEditorCtrl_getMode (string guirivereditorctrl) } /// /// ) +/// /// public float fn_GuiRiverEditorCtrl_getNodeDepth (string guirivereditorctrl) @@ -7724,6 +9745,7 @@ public float fn_GuiRiverEditorCtrl_getNodeDepth (string guirivereditorctrl) } /// /// ) +/// /// public string fn_GuiRiverEditorCtrl_getNodeNormal (string guirivereditorctrl) @@ -7741,6 +9763,7 @@ public string fn_GuiRiverEditorCtrl_getNodeNormal (string guirivereditorctrl) } /// /// ) +/// /// public string fn_GuiRiverEditorCtrl_getNodePosition (string guirivereditorctrl) @@ -7758,6 +9781,7 @@ public string fn_GuiRiverEditorCtrl_getNodePosition (string guirivereditorctrl) } /// /// ) +/// /// public float fn_GuiRiverEditorCtrl_getNodeWidth (string guirivereditorctrl) @@ -7772,6 +9796,7 @@ public float fn_GuiRiverEditorCtrl_getNodeWidth (string guirivereditorctrl) } /// /// ) +/// /// public int fn_GuiRiverEditorCtrl_getSelectedRiver (string guirivereditorctrl) @@ -7786,6 +9811,7 @@ public int fn_GuiRiverEditorCtrl_getSelectedRiver (string guirivereditorctrl) } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_regenerate (string guirivereditorctrl) @@ -7800,6 +9826,7 @@ public void fn_GuiRiverEditorCtrl_regenerate (string guirivereditorctrl) } /// /// setMode( String mode ) ) +/// /// public void fn_GuiRiverEditorCtrl_setMode (string guirivereditorctrl, string mode) @@ -7817,6 +9844,7 @@ public void fn_GuiRiverEditorCtrl_setMode (string guirivereditorctrl, string mod } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodeDepth (string guirivereditorctrl, float depth) @@ -7831,6 +9859,7 @@ public void fn_GuiRiverEditorCtrl_setNodeDepth (string guirivereditorctrl, float } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodeNormal (string guirivereditorctrl, string normal) @@ -7848,6 +9877,7 @@ public void fn_GuiRiverEditorCtrl_setNodeNormal (string guirivereditorctrl, stri } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodePosition (string guirivereditorctrl, string pos) @@ -7865,6 +9895,7 @@ public void fn_GuiRiverEditorCtrl_setNodePosition (string guirivereditorctrl, st } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodeWidth (string guirivereditorctrl, float width) @@ -7879,6 +9910,7 @@ public void fn_GuiRiverEditorCtrl_setNodeWidth (string guirivereditorctrl, float } /// /// ), ) +/// /// public void fn_GuiRiverEditorCtrl_setSelectedRiver (string guirivereditorctrl, string objName) @@ -7896,6 +9928,7 @@ public void fn_GuiRiverEditorCtrl_setSelectedRiver (string guirivereditorctrl, s } /// /// deleteNode() ) +/// /// public void fn_GuiRoadEditorCtrl_deleteNode (string guiroadeditorctrl) @@ -7910,6 +9943,7 @@ public void fn_GuiRoadEditorCtrl_deleteNode (string guiroadeditorctrl) } /// /// ) +/// /// public void fn_GuiRoadEditorCtrl_deleteRoad (string guiroadeditorctrl) @@ -7924,6 +9958,7 @@ public void fn_GuiRoadEditorCtrl_deleteRoad (string guiroadeditorctrl) } /// /// ) +/// /// public string fn_GuiRoadEditorCtrl_getMode (string guiroadeditorctrl) @@ -7941,6 +9976,7 @@ public string fn_GuiRoadEditorCtrl_getMode (string guiroadeditorctrl) } /// /// ) +/// /// public string fn_GuiRoadEditorCtrl_getNodePosition (string guiroadeditorctrl) @@ -7958,6 +9994,7 @@ public string fn_GuiRoadEditorCtrl_getNodePosition (string guiroadeditorctrl) } /// /// ) +/// /// public float fn_GuiRoadEditorCtrl_getNodeWidth (string guiroadeditorctrl) @@ -7972,6 +10009,7 @@ public float fn_GuiRoadEditorCtrl_getNodeWidth (string guiroadeditorctrl) } /// /// ) +/// /// public int fn_GuiRoadEditorCtrl_getSelectedNode (string guiroadeditorctrl) @@ -7986,6 +10024,7 @@ public int fn_GuiRoadEditorCtrl_getSelectedNode (string guiroadeditorctrl) } /// /// ) +/// /// public int fn_GuiRoadEditorCtrl_getSelectedRoad (string guiroadeditorctrl) @@ -8000,6 +10039,7 @@ public int fn_GuiRoadEditorCtrl_getSelectedRoad (string guiroadeditorctrl) } /// /// setMode( String mode ) ) +/// /// public void fn_GuiRoadEditorCtrl_setMode (string guiroadeditorctrl, string mode) @@ -8017,6 +10057,7 @@ public void fn_GuiRoadEditorCtrl_setMode (string guiroadeditorctrl, string mode) } /// /// ) +/// /// public void fn_GuiRoadEditorCtrl_setNodePosition (string guiroadeditorctrl, string pos) @@ -8034,6 +10075,7 @@ public void fn_GuiRoadEditorCtrl_setNodePosition (string guiroadeditorctrl, stri } /// /// ) +/// /// public void fn_GuiRoadEditorCtrl_setNodeWidth (string guiroadeditorctrl, float width) @@ -8048,6 +10090,7 @@ public void fn_GuiRoadEditorCtrl_setNodeWidth (string guiroadeditorctrl, float w } /// /// ), ) +/// /// public void fn_GuiRoadEditorCtrl_setSelectedRoad (string guiroadeditorctrl, string pathRoad) @@ -8065,6 +10108,7 @@ public void fn_GuiRoadEditorCtrl_setSelectedRoad (string guiroadeditorctrl, stri } /// /// Return a Point2F containing the position of the origin.) +/// /// public string fn_GuiTerrPreviewCtrl_getOrigin (string guiterrpreviewctrl) @@ -8082,6 +10126,7 @@ public string fn_GuiTerrPreviewCtrl_getOrigin (string guiterrpreviewctrl) } /// /// Return a Point2F representing the position of the root.) +/// /// public string fn_GuiTerrPreviewCtrl_getRoot (string guiterrpreviewctrl) @@ -8099,6 +10144,7 @@ public string fn_GuiTerrPreviewCtrl_getRoot (string guiterrpreviewctrl) } /// /// Returns a 4-tuple containing: root_x root_y origin_x origin_y) +/// /// public string fn_GuiTerrPreviewCtrl_getValue (string guiterrpreviewctrl) @@ -8116,6 +10162,7 @@ public string fn_GuiTerrPreviewCtrl_getValue (string guiterrpreviewctrl) } /// /// Reset the view of the terrain.) +/// /// public void fn_GuiTerrPreviewCtrl_reset (string guiterrpreviewctrl) @@ -8129,7 +10176,9 @@ public void fn_GuiTerrPreviewCtrl_reset (string guiterrpreviewctrl) SafeNativeMethods.mwle_fn_GuiTerrPreviewCtrl_reset(sbguiterrpreviewctrl); } /// -/// (float x, float y) Set the origin of the view.) +/// (float x, float y) +/// Set the origin of the view.) +/// /// public void fn_GuiTerrPreviewCtrl_setOrigin (string guiterrpreviewctrl, string pos) @@ -8147,6 +10196,7 @@ public void fn_GuiTerrPreviewCtrl_setOrigin (string guiterrpreviewctrl, string p } /// /// Add the origin to the root and reset the origin.) +/// /// public void fn_GuiTerrPreviewCtrl_setRoot (string guiterrpreviewctrl) @@ -8160,7 +10210,9 @@ public void fn_GuiTerrPreviewCtrl_setRoot (string guiterrpreviewctrl) SafeNativeMethods.mwle_fn_GuiTerrPreviewCtrl_setRoot(sbguiterrpreviewctrl); } /// -/// Accepts a 4-tuple in the same form as getValue returns. @see GuiTerrPreviewCtrl::getValue()) +/// Accepts a 4-tuple in the same form as getValue returns. +/// @see GuiTerrPreviewCtrl::getValue()) +/// /// public void fn_GuiTerrPreviewCtrl_setValue (string guiterrpreviewctrl, string tuple) @@ -8178,6 +10230,7 @@ public void fn_GuiTerrPreviewCtrl_setValue (string guiterrpreviewctrl, string tu } /// /// textEditCtrl.selectText( %startBlock, %endBlock ) ) +/// /// public void fn_GuiTextEditCtrl_selectText (string guitexteditctrl, int startBlock, int endBlock) @@ -8192,6 +10245,7 @@ public void fn_GuiTextEditCtrl_selectText (string guitexteditctrl, int startBloc } /// /// ( [tick = true] ) - This will set this object to either be processing ticks or not ) +/// /// public void fn_GuiTickCtrl_setProcessTicks (string guitickctrl, bool tick) @@ -8206,6 +10260,7 @@ public void fn_GuiTickCtrl_setProcessTicks (string guitickctrl, bool tick) } /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void fn_GuiToolboxButtonCtrl_setHoverBitmap (string guitoolboxbuttonctrl, string name) @@ -8223,6 +10278,7 @@ public void fn_GuiToolboxButtonCtrl_setHoverBitmap (string guitoolboxbuttonctrl, } /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void fn_GuiToolboxButtonCtrl_setLoweredBitmap (string guitoolboxbuttonctrl, string name) @@ -8240,6 +10296,7 @@ public void fn_GuiToolboxButtonCtrl_setLoweredBitmap (string guitoolboxbuttonctr } /// /// ( filepath name ) sets the bitmap that shows when the button is active) +/// /// public void fn_GuiToolboxButtonCtrl_setNormalBitmap (string guitoolboxbuttonctrl, string name) @@ -8257,6 +10314,7 @@ public void fn_GuiToolboxButtonCtrl_setNormalBitmap (string guitoolboxbuttonctrl } /// /// addChildSelectionByValue(TreeItemId parent, value)) +/// /// public void fn_GuiTreeViewCtrl_addChildSelectionByValue (string guitreeviewctrl, int id, string tableEntry) @@ -8274,6 +10332,7 @@ public void fn_GuiTreeViewCtrl_addChildSelectionByValue (string guitreeviewctrl, } /// /// (builds an icon table)) +/// /// public bool fn_GuiTreeViewCtrl_buildIconTable (string guitreeviewctrl, string icons) @@ -8291,6 +10350,7 @@ public bool fn_GuiTreeViewCtrl_buildIconTable (string guitreeviewctrl, string ic } /// /// Build the visible tree) +/// /// public void fn_GuiTreeViewCtrl_buildVisibleTree (string guitreeviewctrl, bool forceFullUpdate) @@ -8305,6 +10365,7 @@ public void fn_GuiTreeViewCtrl_buildVisibleTree (string guitreeviewctrl, bool fo } /// /// For internal use. ) +/// /// public void fn_GuiTreeViewCtrl_cancelRename (string guitreeviewctrl) @@ -8319,6 +10380,7 @@ public void fn_GuiTreeViewCtrl_cancelRename (string guitreeviewctrl) } /// /// () - empty tree) +/// /// public void fn_GuiTreeViewCtrl_clear (string guitreeviewctrl) @@ -8333,6 +10395,7 @@ public void fn_GuiTreeViewCtrl_clear (string guitreeviewctrl) } /// /// (TreeItemId item, string newText, string newValue)) +/// /// public bool fn_GuiTreeViewCtrl_editItem (string guitreeviewctrl, int item, string newText, string newValue) @@ -8353,6 +10416,7 @@ public bool fn_GuiTreeViewCtrl_editItem (string guitreeviewctrl, int item, strin } /// /// (TreeItemId item, bool expand=true)) +/// /// public bool fn_GuiTreeViewCtrl_expandItem (string guitreeviewctrl, int id, bool expand) @@ -8367,6 +10431,7 @@ public bool fn_GuiTreeViewCtrl_expandItem (string guitreeviewctrl, int id, bool } /// /// (find item by object id and returns the mId)) +/// /// public int fn_GuiTreeViewCtrl_findItemByObjectId (string guitreeviewctrl, int itemId) @@ -8381,6 +10446,7 @@ public int fn_GuiTreeViewCtrl_findItemByObjectId (string guitreeviewctrl, int it } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getChild (string guitreeviewctrl, int itemId) @@ -8395,6 +10461,7 @@ public int fn_GuiTreeViewCtrl_getChild (string guitreeviewctrl, int itemId) } /// /// Get id for root item.) +/// /// public int fn_GuiTreeViewCtrl_getFirstRootItem (string guitreeviewctrl) @@ -8409,6 +10476,7 @@ public int fn_GuiTreeViewCtrl_getFirstRootItem (string guitreeviewctrl) } /// /// ) +/// /// public int fn_GuiTreeViewCtrl_getItemCount (string guitreeviewctrl) @@ -8423,6 +10491,7 @@ public int fn_GuiTreeViewCtrl_getItemCount (string guitreeviewctrl) } /// /// (TreeItemId item)) +/// /// public string fn_GuiTreeViewCtrl_getItemText (string guitreeviewctrl, int index) @@ -8440,6 +10509,7 @@ public string fn_GuiTreeViewCtrl_getItemText (string guitreeviewctrl, int index) } /// /// (TreeItemId item)) +/// /// public string fn_GuiTreeViewCtrl_getItemValue (string guitreeviewctrl, int itemId) @@ -8457,6 +10527,7 @@ public string fn_GuiTreeViewCtrl_getItemValue (string guitreeviewctrl, int itemI } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getNextSibling (string guitreeviewctrl, int itemId) @@ -8471,6 +10542,7 @@ public int fn_GuiTreeViewCtrl_getNextSibling (string guitreeviewctrl, int itemId } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getParentItem (string guitreeviewctrl, int itemId) @@ -8485,6 +10557,7 @@ public int fn_GuiTreeViewCtrl_getParentItem (string guitreeviewctrl, int itemId) } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getPrevSibling (string guitreeviewctrl, int itemId) @@ -8499,6 +10572,7 @@ public int fn_GuiTreeViewCtrl_getPrevSibling (string guitreeviewctrl, int itemId } /// /// ( int index=0 ) - Return the selected item at the given index.) +/// /// public int fn_GuiTreeViewCtrl_getSelectedItem (string guitreeviewctrl, int index) @@ -8513,6 +10587,7 @@ public int fn_GuiTreeViewCtrl_getSelectedItem (string guitreeviewctrl, int index } /// /// returns a space seperated list of mulitple item ids) +/// /// public string fn_GuiTreeViewCtrl_getSelectedItemList (string guitreeviewctrl) @@ -8530,6 +10605,7 @@ public string fn_GuiTreeViewCtrl_getSelectedItemList (string guitreeviewctrl) } /// /// ) +/// /// public int fn_GuiTreeViewCtrl_getSelectedItemsCount (string guitreeviewctrl) @@ -8544,6 +10620,7 @@ public int fn_GuiTreeViewCtrl_getSelectedItemsCount (string guitreeviewctrl) } /// /// ( int index=0 ) - Return the currently selected SimObject at the given index in inspector mode or -1) +/// /// public int fn_GuiTreeViewCtrl_getSelectedObject (string guitreeviewctrl, int index) @@ -8558,6 +10635,7 @@ public int fn_GuiTreeViewCtrl_getSelectedObject (string guitreeviewctrl, int ind } /// /// Returns a space sperated list of all selected object ids.) +/// /// public string fn_GuiTreeViewCtrl_getSelectedObjectList (string guitreeviewctrl) @@ -8575,6 +10653,7 @@ public string fn_GuiTreeViewCtrl_getSelectedObjectList (string guitreeviewctrl) } /// /// (TreeItemId item,Delimiter=none) gets the text from the current node to the root, concatenating at each branch upward, with a specified delimiter optionally) +/// /// public string fn_GuiTreeViewCtrl_getTextToRoot (string guitreeviewctrl, int itemId, string delimiter) @@ -8595,6 +10674,7 @@ public string fn_GuiTreeViewCtrl_getTextToRoot (string guitreeviewctrl, int item } /// /// ( int id ) - Returns true if the given item contains child items. ) +/// /// public bool fn_GuiTreeViewCtrl_isParentItem (string guitreeviewctrl, int id) @@ -8609,6 +10689,7 @@ public bool fn_GuiTreeViewCtrl_isParentItem (string guitreeviewctrl, int id) } /// /// (TreeItemId item, bool mark=true)) +/// /// public bool fn_GuiTreeViewCtrl_markItem (string guitreeviewctrl, int id, bool mark) @@ -8623,6 +10704,7 @@ public bool fn_GuiTreeViewCtrl_markItem (string guitreeviewctrl, int id, bool ma } /// /// (TreeItemId item)) +/// /// public void fn_GuiTreeViewCtrl_moveItemDown (string guitreeviewctrl, int index) @@ -8637,6 +10719,7 @@ public void fn_GuiTreeViewCtrl_moveItemDown (string guitreeviewctrl, int index) } /// /// (TreeItemId item)) +/// /// public void fn_GuiTreeViewCtrl_moveItemUp (string guitreeviewctrl, int index) @@ -8651,6 +10734,7 @@ public void fn_GuiTreeViewCtrl_moveItemUp (string guitreeviewctrl, int index) } /// /// For internal use. ) +/// /// public void fn_GuiTreeViewCtrl_onRenameValidate (string guitreeviewctrl) @@ -8665,6 +10749,7 @@ public void fn_GuiTreeViewCtrl_onRenameValidate (string guitreeviewctrl) } /// /// (SimSet obj, bool okToEdit=true) Set the root of the tree view to the specified object, or to the root set.) +/// /// public void fn_GuiTreeViewCtrl_open (string guitreeviewctrl, string objName, bool okToEdit) @@ -8682,6 +10767,7 @@ public void fn_GuiTreeViewCtrl_open (string guitreeviewctrl, string objName, boo } /// /// removeAllChildren(TreeItemId parent)) +/// /// public void fn_GuiTreeViewCtrl_removeAllChildren (string guitreeviewctrl, int itemId) @@ -8696,6 +10782,7 @@ public void fn_GuiTreeViewCtrl_removeAllChildren (string guitreeviewctrl, int it } /// /// removeChildSelectionByValue(TreeItemId parent, value)) +/// /// public void fn_GuiTreeViewCtrl_removeChildSelectionByValue (string guitreeviewctrl, int id, string tableEntry) @@ -8713,6 +10800,7 @@ public void fn_GuiTreeViewCtrl_removeChildSelectionByValue (string guitreeviewct } /// /// (TreeItemId item)) +/// /// public bool fn_GuiTreeViewCtrl_removeItem (string guitreeviewctrl, int itemId) @@ -8727,6 +10815,7 @@ public bool fn_GuiTreeViewCtrl_removeItem (string guitreeviewctrl, int itemId) } /// /// (deselects an item)) +/// /// public void fn_GuiTreeViewCtrl_removeSelection (string guitreeviewctrl, int id) @@ -8741,6 +10830,7 @@ public void fn_GuiTreeViewCtrl_removeSelection (string guitreeviewctrl, int id) } /// /// (TreeItemId item)) +/// /// public void fn_GuiTreeViewCtrl_scrollVisible (string guitreeviewctrl, int itemId) @@ -8755,6 +10845,7 @@ public void fn_GuiTreeViewCtrl_scrollVisible (string guitreeviewctrl, int itemId } /// /// (show item by object id. returns true if sucessful.)) +/// /// public int fn_GuiTreeViewCtrl_scrollVisibleByObjectId (string guitreeviewctrl, int itemId) @@ -8769,6 +10860,7 @@ public int fn_GuiTreeViewCtrl_scrollVisibleByObjectId (string guitreeviewctrl, i } /// /// (TreeItemId item, bool select=true)) +/// /// public bool fn_GuiTreeViewCtrl_selectItem (string guitreeviewctrl, int id, bool select) @@ -8783,6 +10875,7 @@ public bool fn_GuiTreeViewCtrl_selectItem (string guitreeviewctrl, int id, bool } /// /// ( bool value=true ) - Enable/disable debug output. ) +/// /// public void fn_GuiTreeViewCtrl_setDebug (string guitreeviewctrl, bool value) @@ -8797,6 +10890,7 @@ public void fn_GuiTreeViewCtrl_setDebug (string guitreeviewctrl, bool value) } /// /// ( int id, int normalImage, int expandedImage ) - Sets the normal and expanded images to show for the given item. ) +/// /// public void fn_GuiTreeViewCtrl_setItemImages (string guitreeviewctrl, int id, sbyte normalImage, sbyte expandedImage) @@ -8811,6 +10905,7 @@ public void fn_GuiTreeViewCtrl_setItemImages (string guitreeviewctrl, int id, sb } /// /// ( int id, string text ) - Set the tooltip to show for the given item. ) +/// /// public void fn_GuiTreeViewCtrl_setItemTooltip (string guitreeviewctrl, int id, string text) @@ -8828,6 +10923,7 @@ public void fn_GuiTreeViewCtrl_setItemTooltip (string guitreeviewctrl, int id, s } /// /// ( TreeItemId id ) - Show the rename text field for the given item (only one at a time). ) +/// /// public void fn_GuiTreeViewCtrl_showItemRenameCtrl (string guitreeviewctrl, int id) @@ -8842,6 +10938,7 @@ public void fn_GuiTreeViewCtrl_showItemRenameCtrl (string guitreeviewctrl, int i } /// /// ( int parent, bool traverseHierarchy=false, bool parentsFirst=false, bool caseSensitive=true ) - Sorts all items of the given parent (or root). With 'hierarchy', traverses hierarchy. ) +/// /// public void fn_GuiTreeViewCtrl_sort (string guitreeviewctrl, int parent, bool traverseHierarchy, bool parentsFirst, bool caseSensitive) @@ -8856,6 +10953,7 @@ public void fn_GuiTreeViewCtrl_sort (string guitreeviewctrl, int parent, bool tr } /// /// loadVars( searchString ) ) +/// /// public void fn_GuiVariableInspector_loadVars (string guivariableinspector, string searchString) @@ -8872,7 +10970,15 @@ public void fn_GuiVariableInspector_loadVars (string guivariableinspector, strin SafeNativeMethods.mwle_fn_GuiVariableInspector_loadVars(sbguivariableinspector, sbsearchString); } /// -/// Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the input PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Import an image strip from exportCachedFont. Call with the +/// same parameters you called exportCachedFont. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the input PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void fn_importCachedFont (string faceName, int fontSize, string fileName, int padding, int kerning) @@ -8889,7 +10995,17 @@ public void fn_importCachedFont (string faceName, int fontSize, string fileName, SafeNativeMethods.mwle_fn_importCachedFont(sbfaceName, fontSize, sbfileName, padding, kerning); } /// -/// @brief Start a search for items at the given position and within the given radius, filtering by mask. @param pos Center position for the search @param radius Search radius @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for items at the given position and within the given radius, filtering by mask. +/// +/// @param pos Center position for the search +/// @param radius Search radius +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void fn_initContainerRadiusSearch (string pos, float radius, uint mask, bool useClientContainer) @@ -8903,7 +11019,15 @@ public void fn_initContainerRadiusSearch (string pos, float radius, uint mask, b SafeNativeMethods.mwle_fn_initContainerRadiusSearch(sbpos, radius, mask, useClientContainer); } /// -/// @brief Start a search for all items of the types specified by the bitset mask. @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for all items of the types specified by the bitset mask. +/// +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void fn_initContainerTypeSearch (uint mask, bool useClientContainer) @@ -8914,7 +11038,10 @@ public void fn_initContainerTypeSearch (uint mask, bool useClientContainer) SafeNativeMethods.mwle_fn_initContainerTypeSearch(mask, useClientContainer); } /// -/// () @brief Initializes variables that track device and vendor information/IDs @ingroup Rendering) +/// () +/// @brief Initializes variables that track device and vendor information/IDs +/// @ingroup Rendering) +/// /// public void fn_initDisplayDeviceInfo () @@ -8926,7 +11053,14 @@ public void fn_initDisplayDeviceInfo () SafeNativeMethods.mwle_fn_initDisplayDeviceInfo(); } /// -/// Test whether the character at the given position is an alpha-numeric character. Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. @see isspace @ingroup Strings ) +/// Test whether the character at the given position is an alpha-numeric character. +/// Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. +/// @see isspace +/// @ingroup Strings ) +/// /// public bool fn_isalnum (string str, int index) @@ -8940,7 +11074,9 @@ public bool fn_isalnum (string str, int index) return SafeNativeMethods.mwle_fn_isalnum(sbstr, index)>=1; } /// -/// @brief Returns true if the passed identifier is the name of a declared class. @ingroup Console) +/// @brief Returns true if the passed identifier is the name of a declared class. +/// @ingroup Console) +/// /// public bool fn_isClass (string identifier) @@ -8954,7 +11090,10 @@ public bool fn_isClass (string identifier) return SafeNativeMethods.mwle_fn_isClass(sbidentifier)>=1; } /// -/// () Returns true if the calling script is a tools script. @hide) +/// () +/// Returns true if the calling script is a tools script. +/// @hide) +/// /// public bool fn_isCurrentScriptToolScript () @@ -8966,7 +11105,10 @@ public bool fn_isCurrentScriptToolScript () return SafeNativeMethods.mwle_fn_isCurrentScriptToolScript()>=1; } /// -/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. @return True if this is a debug build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. +/// @return True if this is a debug build; false otherwise. +/// @ingroup Platform ) +/// /// public bool fn_isDebugBuild () @@ -8978,7 +11120,15 @@ public bool fn_isDebugBuild () return SafeNativeMethods.mwle_fn_isDebugBuild()>=1; } /// -/// ) , (string varName) @brief Determines if a variable exists and contains a value @param varName Name of the variable to search for @return True if the variable was defined in script, false if not @tsexample isDefined( \"$myVar\" ); @endtsexample @ingroup Scripting) +/// ) , (string varName) +/// @brief Determines if a variable exists and contains a value +/// @param varName Name of the variable to search for +/// @return True if the variable was defined in script, false if not +/// @tsexample +/// isDefined( \"$myVar\" ); +/// @endtsexample +/// @ingroup Scripting) +/// /// public bool fn_isDefined (string varName, string varValue) @@ -8996,6 +11146,7 @@ public bool fn_isDefined (string varName, string varValue) } /// /// ) +/// /// public bool fn_isDemo () @@ -9007,7 +11158,15 @@ public bool fn_isDemo () return SafeNativeMethods.mwle_fn_isDemo()>=1; } /// -/// @brief Determines if a specified directory exists or not @param directory String containing path in the form of \"foo/bar\" @return Returns true if the directory was found. @note Do not include a trailing slash '/'. @ingroup FileSystem) +/// @brief Determines if a specified directory exists or not +/// +/// @param directory String containing path in the form of \"foo/bar\" +/// @return Returns true if the directory was found. +/// +/// @note Do not include a trailing slash '/'. +/// +/// @ingroup FileSystem) +/// /// public bool fn_IsDirectory (string directory) @@ -9022,6 +11181,7 @@ public bool fn_IsDirectory (string directory) } /// /// isEventPending(%scheduleId);) +/// /// public bool fn_isEventPending (int scheduleId) @@ -9032,7 +11192,13 @@ public bool fn_isEventPending (int scheduleId) return SafeNativeMethods.mwle_fn_isEventPending(scheduleId)>=1; } /// -/// @brief Determines if the specified file exists or not @param fileName The path to the file. @return Returns true if the file was found. @ingroup FileSystem) +/// @brief Determines if the specified file exists or not +/// +/// @param fileName The path to the file. +/// @return Returns true if the file was found. +/// +/// @ingroup FileSystem) +/// /// public bool fn_isFile (string fileName) @@ -9046,7 +11212,12 @@ public bool fn_isFile (string fileName) return SafeNativeMethods.mwle_fn_isFile(sbfileName)>=1; } /// -/// (string funcName) @brief Determines if a function exists or not @param funcName String containing name of the function @return True if the function exists, false if not @ingroup Scripting) +/// (string funcName) +/// @brief Determines if a function exists or not +/// @param funcName String containing name of the function +/// @return True if the function exists, false if not +/// @ingroup Scripting) +/// /// public bool fn_isFunction (string funcName) @@ -9061,6 +11232,7 @@ public bool fn_isFunction (string funcName) } /// /// isJoystickDetected()) +/// /// public bool fn_isJoystickDetected () @@ -9072,7 +11244,11 @@ public bool fn_isJoystickDetected () return SafeNativeMethods.mwle_fn_isJoystickDetected()>=1; } /// -/// () @brief Queries input manager to see if a joystick is enabled @return 1 if a joystick exists and is enabled, 0 if it's not. @ingroup Input) +/// () +/// @brief Queries input manager to see if a joystick is enabled +/// @return 1 if a joystick exists and is enabled, 0 if it's not. +/// @ingroup Input) +/// /// public bool fn_isJoystickEnabled () @@ -9085,6 +11261,7 @@ public bool fn_isJoystickEnabled () } /// /// isKoreanBuild()) +/// /// public bool fn_isKoreanBuild () @@ -9096,7 +11273,12 @@ public bool fn_isKoreanBuild () return SafeNativeMethods.mwle_fn_isKoreanBuild()>=1; } /// -/// @brief Returns true if the class is derived from the super class. If either class doesn't exist this returns false. @param className The class name. @param superClassName The super class to look for. @ingroup Console) +/// @brief Returns true if the class is derived from the super class. +/// If either class doesn't exist this returns false. +/// @param className The class name. +/// @param superClassName The super class to look for. +/// @ingroup Console) +/// /// public bool fn_isMemberOfClass (string className, string superClassName) @@ -9113,7 +11295,13 @@ public bool fn_isMemberOfClass (string className, string superClassName) return SafeNativeMethods.mwle_fn_isMemberOfClass(sbclassName, sbsuperClassName)>=1; } /// -/// (string namespace, string method) @brief Determines if a class/namespace method exists @param namespace Class or namespace, such as Player @param method Name of the function to search for @return True if the method exists, false if not @ingroup Scripting) +/// (string namespace, string method) +/// @brief Determines if a class/namespace method exists +/// @param namespace Class or namespace, such as Player +/// @param method Name of the function to search for +/// @return True if the method exists, false if not +/// @ingroup Scripting) +/// /// public bool fn_isMethod (string nameSpace, string method) @@ -9131,6 +11319,7 @@ public bool fn_isMethod (string nameSpace, string method) } /// /// isObject(object)) +/// /// public bool fn_isObject (string objectName) @@ -9160,7 +11349,11 @@ public bool fn_isPackage (string identifier) return SafeNativeMethods.mwle_fn_isPackage(sbidentifier)>=1; } /// -/// (string queueName) @brief Determines if a dispatcher queue exists @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Determines if a dispatcher queue exists +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public bool fn_isQueueRegistered (string queueName) @@ -9174,7 +11367,10 @@ public bool fn_isQueueRegistered (string queueName) return SafeNativeMethods.mwle_fn_isQueueRegistered(sbqueueName)>=1; } /// -/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. @return True if this is a shipping build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. +/// @return True if this is a shipping build; false otherwise. +/// @ingroup Platform ) +/// /// public bool fn_isShippingBuild () @@ -9186,7 +11382,14 @@ public bool fn_isShippingBuild () return SafeNativeMethods.mwle_fn_isShippingBuild()>=1; } /// -/// Test whether the character at the given position is a whitespace character. Characters such as tab, space, or newline are considered whitespace. @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is a whitespace character; false otherwise. @see isalnum @ingroup Strings ) +/// Test whether the character at the given position is a whitespace character. +/// Characters such as tab, space, or newline are considered whitespace. +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is a whitespace character; false otherwise. +/// @see isalnum +/// @ingroup Strings ) +/// /// public bool fn_isspace (string str, int index) @@ -9200,7 +11403,10 @@ public bool fn_isspace (string str, int index) return SafeNativeMethods.mwle_fn_isspace(sbstr, index)>=1; } /// -/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. @return True if this is a tool build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. +/// @return True if this is a tool build; false otherwise. +/// @ingroup Platform ) +/// /// public bool fn_isToolBuild () @@ -9212,7 +11418,12 @@ public bool fn_isToolBuild () return SafeNativeMethods.mwle_fn_isToolBuild()>=1; } /// -/// ( string name ) @brief Return true if the given name makes for a valid object name. @param name Name of object @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character @ingroup Console) +/// ( string name ) +/// @brief Return true if the given name makes for a valid object name. +/// @param name Name of object +/// @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character +/// @ingroup Console) +/// /// public bool fn_isValidObjectName (string name) @@ -9227,6 +11438,7 @@ public bool fn_isValidObjectName (string name) } /// /// ) +/// /// public bool fn_isWebDemo () @@ -9238,7 +11450,13 @@ public bool fn_isWebDemo () return SafeNativeMethods.mwle_fn_isWebDemo()>=1; } /// -/// @brief Determines if a file name can be written to using File I/O @param fileName Name and path of file to check @return Returns true if the file can be written to. @ingroup FileSystem) +/// @brief Determines if a file name can be written to using File I/O +/// +/// @param fileName Name and path of file to check +/// @return Returns true if the file can be written to. +/// +/// @ingroup FileSystem) +/// /// public bool fn_isWriteableFileName (string fileName) @@ -9252,7 +11470,13 @@ public bool fn_isWriteableFileName (string fileName) return SafeNativeMethods.mwle_fn_isWriteableFileName(sbfileName)>=1; } /// -/// ( int controllerID ) @brief Checks to see if an Xbox 360 controller is connected @param controllerID Zero-based index of the controller to check. @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput hasn't been initialized. @ingroup Input) +/// ( int controllerID ) +/// @brief Checks to see if an Xbox 360 controller is connected +/// @param controllerID Zero-based index of the controller to check. +/// @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput +/// hasn't been initialized. +/// @ingroup Input) +/// /// public bool fn_isXInputConnected (int controllerID) @@ -9263,7 +11487,14 @@ public bool fn_isXInputConnected (int controllerID) return SafeNativeMethods.mwle_fn_isXInputConnected(controllerID)>=1; } /// -/// , ), (string filename, [string languageName]) @brief Adds a language to the table @param filename Name and path to the language file @param languageName Optional name to assign to the new language entry @return True If file was successfully found and language created ) +/// , ), +/// (string filename, [string languageName]) +/// @brief Adds a language to the table +/// @param filename Name and path to the language file +/// @param languageName Optional name to assign to the new language entry +/// @return True If file was successfully found and language created +/// ) +/// /// public int fn_LangTable_addLanguage (string langtable, string filename, string languageName) @@ -9283,7 +11514,10 @@ public int fn_LangTable_addLanguage (string langtable, string filename, string l return SafeNativeMethods.mwle_fn_LangTable_addLanguage(sblangtable, sbfilename, sblanguageName); } /// -/// () @brief Get the ID of the current language table @return Numerical ID of the current language table) +/// () +/// @brief Get the ID of the current language table +/// @return Numerical ID of the current language table) +/// /// public int fn_LangTable_getCurrentLanguage (string langtable) @@ -9297,7 +11531,11 @@ public int fn_LangTable_getCurrentLanguage (string langtable) return SafeNativeMethods.mwle_fn_LangTable_getCurrentLanguage(sblangtable); } /// -/// (int language) @brief Return the readable name of the language table @param language Numerical ID of the language table to access @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// (int language) +/// @brief Return the readable name of the language table +/// @param language Numerical ID of the language table to access +/// @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// /// public string fn_LangTable_getLangName (string langtable, int langId) @@ -9314,7 +11552,10 @@ public string fn_LangTable_getLangName (string langtable, int langId) } /// -/// () @brief Used to find out how many languages are in the table @return Size of the vector containing the languages, numerical) +/// () +/// @brief Used to find out how many languages are in the table +/// @return Size of the vector containing the languages, numerical) +/// /// public int fn_LangTable_getNumLang (string langtable) @@ -9328,7 +11569,13 @@ public int fn_LangTable_getNumLang (string langtable) return SafeNativeMethods.mwle_fn_LangTable_getNumLang(sblangtable); } /// -/// (string filename) @brief Grabs a string from the specified table If an invalid is passed, the function will attempt to to grab from the default table @param filename Name of the language table to access @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// (string filename) +/// @brief Grabs a string from the specified table +/// If an invalid is passed, the function will attempt to +/// to grab from the default table +/// @param filename Name of the language table to access +/// @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// /// public string fn_LangTable_getString (string langtable, uint id) @@ -9345,7 +11592,10 @@ public string fn_LangTable_getString (string langtable, uint id) } /// -/// (int language) @brief Sets the current language table for grabbing text @param language ID of the table) +/// (int language) +/// @brief Sets the current language table for grabbing text +/// @param language ID of the table) +/// /// public void fn_LangTable_setCurrentLanguage (string langtable, int langId) @@ -9359,7 +11609,10 @@ public void fn_LangTable_setCurrentLanguage (string langtable, int langId) SafeNativeMethods.mwle_fn_LangTable_setCurrentLanguage(sblangtable, langId); } /// -/// (int language) @brief Sets the default language table @param language ID of the table) +/// (int language) +/// @brief Sets the default language table +/// @param language ID of the table) +/// /// public void fn_LangTable_setDefaultLanguage (string langtable, int langId) @@ -9374,6 +11627,7 @@ public void fn_LangTable_setDefaultLanguage (string langtable, int langId) } /// /// Stops the light animation. ) +/// /// public void fn_LightBase_pauseAnimation (string lightbase) @@ -9387,7 +11641,11 @@ public void fn_LightBase_pauseAnimation (string lightbase) SafeNativeMethods.mwle_fn_LightBase_pauseAnimation(sblightbase); } /// -/// ), ( [LightAnimData anim] )\t Plays a light animation on the light. If no LightAnimData is passed the existing one is played. @hide) +/// ), ( [LightAnimData anim] )\t +/// Plays a light animation on the light. If no LightAnimData is passed the +/// existing one is played. +/// @hide) +/// /// public void fn_LightBase_playAnimation (string lightbase, string anim) @@ -9404,7 +11662,15 @@ public void fn_LightBase_playAnimation (string lightbase, string anim) SafeNativeMethods.mwle_fn_LightBase_playAnimation(sblightbase, sbanim); } /// -/// Will generate static lighting for the scene if supported by the active light manager. If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps will be regenerated only if the lighting cache files can be written. @param completeCallbackFn The name of the function to execute when the lighting is complete. @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". @return Returns true if the scene lighting process was started. @ingroup Lighting ) +/// Will generate static lighting for the scene if supported by the active light manager. +/// If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether +/// lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps +/// will be regenerated only if the lighting cache files can be written. +/// @param completeCallbackFn The name of the function to execute when the lighting is complete. +/// @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". +/// @return Returns true if the scene lighting process was started. +/// @ingroup Lighting ) +/// /// public bool fn_lightScene (string completeCallbackFn, string mode) @@ -9421,7 +11687,10 @@ public bool fn_lightScene (string completeCallbackFn, string mode) return SafeNativeMethods.mwle_fn_lightScene(sbcompleteCallbackFn, sbmode)>=1; } /// -/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void fn_listGFXResources (bool unflaggedOnly) @@ -9432,7 +11701,29 @@ public void fn_listGFXResources (bool unflaggedOnly) SafeNativeMethods.mwle_fn_listGFXResources(unflaggedOnly); } /// -/// , ), (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) Load all light instances from a COLLADA (.dae) file and add to the scene. @param filename COLLADA filename to load lights from @param parentGroup (optional) name of an existing simgroup to add the new lights to (defaults to MissionGroup) @param baseObject (optional) name of an object to use as the origin (useful if you are loading the lights for a collada scene and have moved or rotated the geometry) @return true if successful, false otherwise @tsexample // load the lights in room.dae loadColladaLights( \"art/shapes/collada/room.dae\" ); // load the lights in room.dae and add them to the RoomLights group loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); // load the lights in room.dae and use the transform of the \"Room\" object as the origin loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); @endtsexample @note Currently for editor use only @ingroup Editors @internal) +/// , ), +/// (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) +/// Load all light instances from a COLLADA (.dae) file and add to the scene. +/// @param filename COLLADA filename to load lights from +/// @param parentGroup (optional) name of an existing simgroup to add the new +/// lights to (defaults to MissionGroup) +/// @param baseObject (optional) name of an object to use as the origin (useful +/// if you are loading the lights for a collada scene and have moved or rotated +/// the geometry) +/// @return true if successful, false otherwise +/// @tsexample +/// // load the lights in room.dae +/// loadColladaLights( \"art/shapes/collada/room.dae\" ); +/// // load the lights in room.dae and add them to the RoomLights group +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); +/// // load the lights in room.dae and use the transform of the \"Room\" +/// object as the origin +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); +/// @endtsexample +/// @note Currently for editor use only +/// @ingroup Editors +/// @internal) +/// /// public bool fn_loadColladaLights (string filename, string parentGroup, string baseObject) @@ -9452,7 +11743,10 @@ public bool fn_loadColladaLights (string filename, string parentGroup, string ba return SafeNativeMethods.mwle_fn_loadColladaLights(sbfilename, sbparentGroup, sbbaseObject)>=1; } /// -/// @brief Loads a serialized object from a file. @param Name and path to text file containing the object @ingroup Console) +/// @brief Loads a serialized object from a file. +/// @param Name and path to text file containing the object +/// @ingroup Console) +/// /// public string fn_loadObject (string filename) @@ -9469,7 +11763,11 @@ public string fn_loadObject (string filename) } /// -/// (bool isLocked) @brief Lock or unlock the mouse to the window. When true, prevents the mouse from leaving the bounds of the game window. @ingroup Input) +/// (bool isLocked) +/// @brief Lock or unlock the mouse to the window. +/// When true, prevents the mouse from leaving the bounds of the game window. +/// @ingroup Input) +/// /// public void fn_lockMouse (bool isLocked) @@ -9534,7 +11832,16 @@ public void fn_logWarning (string message) SafeNativeMethods.mwle_fn_logWarning(sbmessage); } /// -/// Remove leading whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. @tsexample ltrim( \" string \" ); // Returns \"string \". @endtsexample @see rtrim @see trim @ingroup Strings ) +/// Remove leading whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. +/// @tsexample +/// ltrim( \" string \" ); // Returns \"string \". +/// @endtsexample +/// @see rtrim +/// @see trim +/// @ingroup Strings ) +/// /// public string fn_ltrim (string str) @@ -9551,7 +11858,10 @@ public string fn_ltrim (string str) } /// -/// Return the value of 2*PI (full-circle in radians). @returns The value of 2*PI. @ingroup Math ) +/// Return the value of 2*PI (full-circle in radians). +/// @returns The value of 2*PI. +/// @ingroup Math ) +/// /// public float fn_m2Pi () @@ -9563,7 +11873,11 @@ public float fn_m2Pi () return SafeNativeMethods.mwle_fn_m2Pi(); } /// -/// Calculate absolute value of specified value. @param v Input Value. @returns Absolute value of specified value. @ingroup Math ) +/// Calculate absolute value of specified value. +/// @param v Input Value. +/// @returns Absolute value of specified value. +/// @ingroup Math ) +/// /// public float fn_mAbs (float v) @@ -9574,7 +11888,11 @@ public float fn_mAbs (float v) return SafeNativeMethods.mwle_fn_mAbs(v); } /// -/// Calculate the arc-cosine of v. @param v Input Value (in radians). @returns The arc-cosine of the input value. @ingroup Math ) +/// Calculate the arc-cosine of v. +/// @param v Input Value (in radians). +/// @returns The arc-cosine of the input value. +/// @ingroup Math ) +/// /// public float fn_mAcos (float v) @@ -9585,7 +11903,15 @@ public float fn_mAcos (float v) return SafeNativeMethods.mwle_fn_mAcos(v); } /// -/// ), @brief Converts a relative file path to a full path For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" @param path Name of file or path to check @param cwd Optional current working directory from which to build the full path. @return String containing non-relative directory of path @ingroup FileSystem) +/// ), +/// @brief Converts a relative file path to a full path +/// +/// For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" +/// @param path Name of file or path to check +/// @param cwd Optional current working directory from which to build the full path. +/// @return String containing non-relative directory of path +/// @ingroup FileSystem) +/// /// public string fn_makeFullPath (string path, string cwd) @@ -9605,7 +11931,16 @@ public string fn_makeFullPath (string path, string cwd) } /// -/// ), @brief Turns a full or local path to a relative one For example, \"./game/art\" becomes \"game/art\" @param path Full path (may include a file) to convert @param to Optional base path used for the conversion. If not supplied the current working directory is used. @returns String containing relative path @ingroup FileSystem) +/// ), +/// @brief Turns a full or local path to a relative one +/// +/// For example, \"./game/art\" becomes \"game/art\" +/// @param path Full path (may include a file) to convert +/// @param to Optional base path used for the conversion. If not supplied the current +/// working directory is used. +/// @returns String containing relative path +/// @ingroup FileSystem) +/// /// public string fn_makeRelativePath (string path, string to) @@ -9625,7 +11960,11 @@ public string fn_makeRelativePath (string path, string to) } /// -/// Calculate the arc-sine of v. @param v Input Value (in radians). @returns The arc-sine of the input value. @ingroup Math ) +/// Calculate the arc-sine of v. +/// @param v Input Value (in radians). +/// @returns The arc-sine of the input value. +/// @ingroup Math ) +/// /// public float fn_mAsin (float v) @@ -9636,7 +11975,12 @@ public float fn_mAsin (float v) return SafeNativeMethods.mwle_fn_mAsin(v); } /// -/// Calculate the arc-tangent (slope) of a line defined by rise and run. @param rise of line. @param run of line. @returns The arc-tangent (slope) of a line defined by rise and run. @ingroup Math ) +/// Calculate the arc-tangent (slope) of a line defined by rise and run. +/// @param rise of line. +/// @param run of line. +/// @returns The arc-tangent (slope) of a line defined by rise and run. +/// @ingroup Math ) +/// /// public float fn_mAtan (float rise, float run) @@ -9648,6 +11992,7 @@ public float fn_mAtan (float rise, float run) } /// /// Dumps a formatted list of the currently allocated material instances for this material to the console. ) +/// /// public void fn_Material_dumpInstances (string material) @@ -9662,6 +12007,7 @@ public void fn_Material_dumpInstances (string material) } /// /// Flushes all material instances that use this material. ) +/// /// public void fn_Material_flush (string material) @@ -9676,6 +12022,7 @@ public void fn_Material_flush (string material) } /// /// ) +/// /// public string fn_Material_getAnimFlags (string material, uint id) @@ -9693,6 +12040,7 @@ public string fn_Material_getAnimFlags (string material, uint id) } /// /// Get filename of material) +/// /// public string fn_Material_getFilename (string material) @@ -9710,6 +12058,7 @@ public string fn_Material_getFilename (string material) } /// /// Returns true if this Material was automatically generated by MaterialList::mapMaterials() ) +/// /// public bool fn_Material_isAutoGenerated (string material) @@ -9724,6 +12073,7 @@ public bool fn_Material_isAutoGenerated (string material) } /// /// Reloads all material instances that use this material. ) +/// /// public void fn_Material_reload (string material) @@ -9738,6 +12088,7 @@ public void fn_Material_reload (string material) } /// /// setAutoGenerated(bool isAutoGenerated): Set whether or not the Material is autogenerated. ) +/// /// public void fn_Material_setAutoGenerated (string material, bool isAutoGenerated) @@ -9751,7 +12102,12 @@ public void fn_Material_setAutoGenerated (string material, bool isAutoGenerated) SafeNativeMethods.mwle_fn_Material_setAutoGenerated(sbmaterial, isAutoGenerated); } /// -/// Create a transform from the given translation and orientation. @param position The translation vector for the transform. @param orientation The axis and rotation that orients the transform. @return A transform based on the given position and orientation. @ingroup Matrices ) +/// Create a transform from the given translation and orientation. +/// @param position The translation vector for the transform. +/// @param orientation The axis and rotation that orients the transform. +/// @return A transform based on the given position and orientation. +/// @ingroup Matrices ) +/// /// public string fn_MatrixCreate (string position, string orientation) @@ -9771,7 +12127,11 @@ public string fn_MatrixCreate (string position, string orientation) } /// -/// @Create a matrix from the given rotations. @param Vector3F X, Y, and Z rotation in *radians*. @return A transform based on the given orientation. @ingroup Matrices ) +/// @Create a matrix from the given rotations. +/// @param Vector3F X, Y, and Z rotation in *radians*. +/// @return A transform based on the given orientation. +/// @ingroup Matrices ) +/// /// public string fn_MatrixCreateFromEuler (string angles) @@ -9788,7 +12148,13 @@ public string fn_MatrixCreateFromEuler (string angles) } /// -/// @brief Multiply the given point by the given transform assuming that w=1. This function will multiply the given vector such that translation with take effect. @param transform A transform. @param point A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the given point by the given transform assuming that w=1. +/// This function will multiply the given vector such that translation with take effect. +/// @param transform A transform. +/// @param point A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public string fn_MatrixMulPoint (string transform, string point) @@ -9808,7 +12174,12 @@ public string fn_MatrixMulPoint (string transform, string point) } /// -/// @brief Multiply the two matrices. @param left First transform. @param right Right transform. @return Concatenation of the two transforms. @ingroup Matrices ) +/// @brief Multiply the two matrices. +/// @param left First transform. +/// @param right Right transform. +/// @return Concatenation of the two transforms. +/// @ingroup Matrices ) +/// /// public string fn_MatrixMultiply (string left, string right) @@ -9828,7 +12199,14 @@ public string fn_MatrixMultiply (string left, string right) } /// -/// @brief Multiply the vector by the transform assuming that w=0. This function will multiply the given vector by the given transform such that translation will not affect the vector. @param transform A transform. @param vector A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the vector by the transform assuming that w=0. +/// This function will multiply the given vector by the given transform such that translation will +/// not affect the vector. +/// @param transform A transform. +/// @param vector A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public string fn_MatrixMulVector (string transform, string vector) @@ -9848,7 +12226,11 @@ public string fn_MatrixMulVector (string transform, string vector) } /// -/// Round v up to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v up to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int fn_mCeil (float v) @@ -9859,7 +12241,13 @@ public int fn_mCeil (float v) return SafeNativeMethods.mwle_fn_mCeil(v); } /// -/// Clamp the specified value between two bounds. @param v Input value. @param min Minimum Bound. @param max Maximum Bound. @returns The specified value clamped to the specified bounds. @ingroup Math ) +/// Clamp the specified value between two bounds. +/// @param v Input value. +/// @param min Minimum Bound. +/// @param max Maximum Bound. +/// @returns The specified value clamped to the specified bounds. +/// @ingroup Math ) +/// /// public float fn_mClamp (float v, float min, float max) @@ -9870,7 +12258,11 @@ public float fn_mClamp (float v, float min, float max) return SafeNativeMethods.mwle_fn_mClamp(v, min, max); } /// -/// Calculate the cosine of v. @param v Input Value (in radians). @returns The cosine of the input value. @ingroup Math ) +/// Calculate the cosine of v. +/// @param v Input Value (in radians). +/// @returns The cosine of the input value. +/// @ingroup Math ) +/// /// public float fn_mCos (float v) @@ -9881,7 +12273,11 @@ public float fn_mCos (float v) return SafeNativeMethods.mwle_fn_mCos(v); } /// -/// Convert specified degrees into radians. @param degrees Input Value (in degrees). @returns The specified degrees value converted to radians. @ingroup Math ) +/// Convert specified degrees into radians. +/// @param degrees Input Value (in degrees). +/// @returns The specified degrees value converted to radians. +/// @ingroup Math ) +/// /// public float fn_mDegToRad (float degrees) @@ -9893,6 +12289,7 @@ public float fn_mDegToRad (float degrees) } /// /// ( SimObject obj )) +/// /// public void fn_MECreateUndoAction_addObject (string mecreateundoaction, string obj) @@ -9910,6 +12307,7 @@ public void fn_MECreateUndoAction_addObject (string mecreateundoaction, string o } /// /// ( SimObject obj )) +/// /// public void fn_MEDeleteUndoAction_deleteObject (string medeleteundoaction, string obj) @@ -9927,6 +12325,7 @@ public void fn_MEDeleteUndoAction_deleteObject (string medeleteundoaction, strin } /// /// (GuiCanvas, pos)) +/// /// public void fn_MenuBar_attachToCanvas (string menubar, string canvas, int pos) @@ -9944,6 +12343,7 @@ public void fn_MenuBar_attachToCanvas (string menubar, string canvas, int pos) } /// /// (object, pos) insert object at position) +/// /// public void fn_MenuBar_insert (string menubar, string pObject, int pos) @@ -9961,6 +12361,7 @@ public void fn_MenuBar_insert (string menubar, string pObject, int pos) } /// /// ()) +/// /// public void fn_MenuBar_removeFromCanvas (string menubar) @@ -9975,6 +12376,7 @@ public void fn_MenuBar_removeFromCanvas (string menubar) } /// /// () Increment the reference count for this message) +/// /// public void fn_Message_addReference (string message) @@ -9989,6 +12391,7 @@ public void fn_Message_addReference (string message) } /// /// () Decrement the reference count for this message) +/// /// public void fn_Message_freeReference (string message) @@ -10003,6 +12406,7 @@ public void fn_Message_freeReference (string message) } /// /// () Get message type (script class name or C++ class name if no script defined class)) +/// /// public string fn_Message_getType (string message) @@ -10019,7 +12423,16 @@ public string fn_Message_getType (string message) } /// -/// Display a modal message box using the platform's native message box implementation. @param title The title to display on the message box window. @param message The text message to display in the box. @param buttons Which buttons to put on the message box. @param icons Which icon to show next to the message. @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. @tsexample messageBox( \"Error\", \"\" ); @endtsexample @ingroup Platform ) +/// Display a modal message box using the platform's native message box implementation. +/// @param title The title to display on the message box window. +/// @param message The text message to display in the box. +/// @param buttons Which buttons to put on the message box. +/// @param icons Which icon to show next to the message. +/// @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. +/// @tsexample +/// messageBox( \"Error\", \"\" ); @endtsexample +/// @ingroup Platform ) +/// /// public int fn_messageBox (string title, string message, int buttons, int icons) @@ -10036,7 +12449,10 @@ public int fn_messageBox (string title, string message, int buttons, int icons) return SafeNativeMethods.mwle_fn_messageBox(sbtitle, sbmessage, buttons, icons); } /// -/// ), (string filename, string header=NULL) Dump the message vector to a file, optionally prefixing a header. @hide) +/// ), (string filename, string header=NULL) +/// Dump the message vector to a file, optionally prefixing a header. +/// @hide) +/// /// public void fn_MessageVector_dump (string messagevector, string filename, string header) @@ -10056,7 +12472,12 @@ public void fn_MessageVector_dump (string messagevector, string filename, string SafeNativeMethods.mwle_fn_MessageVector_dump(sbmessagevector, sbfilename, sbheader); } /// -/// Formats the specified number to the given number of decimal places. @param v Number to format. @param precision Number of decimal places to format to (1-9). @returns Number formatted to the specified number of decimal places. @ingroup Math ) +/// Formats the specified number to the given number of decimal places. +/// @param v Number to format. +/// @param precision Number of decimal places to format to (1-9). +/// @returns Number formatted to the specified number of decimal places. +/// @ingroup Math ) +/// /// public string fn_mFloatLength (float v, uint precision) @@ -10070,7 +12491,11 @@ public string fn_mFloatLength (float v, uint precision) } /// -/// Round v down to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v down to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int fn_mFloor (float v) @@ -10081,7 +12506,12 @@ public int fn_mFloor (float v) return SafeNativeMethods.mwle_fn_mFloor(v); } /// -/// Calculate the remainder of v/d. @param v Input Value. @param d Divisor Value. @returns The remainder of v/d. @ingroup Math ) +/// Calculate the remainder of v/d. +/// @param v Input Value. +/// @param d Divisor Value. +/// @returns The remainder of v/d. +/// @ingroup Math ) +/// /// public float fn_mFMod (float v, float d) @@ -10092,7 +12522,11 @@ public float fn_mFMod (float v, float d) return SafeNativeMethods.mwle_fn_mFMod(v, d); } /// -/// Returns whether the value is an exact power of two. @param v Input value. @returns Whether the specified value is an exact power of two. @ingroup Math ) +/// Returns whether the value is an exact power of two. +/// @param v Input value. +/// @returns Whether the specified value is an exact power of two. +/// @ingroup Math ) +/// /// public bool fn_mIsPow2 (int v) @@ -10103,7 +12537,13 @@ public bool fn_mIsPow2 (int v) return SafeNativeMethods.mwle_fn_mIsPow2(v)>=1; } /// -/// Calculate linearly interpolated value between two specified numbers using specified normalized time. @param v1 Interpolate From Input value. @param v2 Interpolate To Input value. @param time Normalized time used to interpolate values (0-1). @returns The interpolated value between the two specified values at normalized time t. @ingroup Math ) +/// Calculate linearly interpolated value between two specified numbers using specified normalized time. +/// @param v1 Interpolate From Input value. +/// @param v2 Interpolate To Input value. +/// @param time Normalized time used to interpolate values (0-1). +/// @returns The interpolated value between the two specified values at normalized time t. +/// @ingroup Math ) +/// /// public float fn_mLerp (float v1, float v2, float time) @@ -10114,7 +12554,11 @@ public float fn_mLerp (float v1, float v2, float time) return SafeNativeMethods.mwle_fn_mLerp(v1, v2, time); } /// -/// Calculate the natural logarithm of v. @param v Input Value. @returns The natural logarithm of the input value. @ingroup Math ) +/// Calculate the natural logarithm of v. +/// @param v Input Value. +/// @returns The natural logarithm of the input value. +/// @ingroup Math ) +/// /// public float fn_mLog (float v) @@ -10125,7 +12569,10 @@ public float fn_mLog (float v) return SafeNativeMethods.mwle_fn_mLog(v); } /// -/// Return the value of PI (half-circle in radians). @returns The value of PI. @ingroup Math ) +/// Return the value of PI (half-circle in radians). +/// @returns The value of PI. +/// @ingroup Math ) +/// /// public float fn_mPi () @@ -10137,7 +12584,12 @@ public float fn_mPi () return SafeNativeMethods.mwle_fn_mPi(); } /// -/// Calculate b raised to the p-th power. @param v Input Value. @param p Power to raise value by. @returns v raised to the p-th power. @ingroup Math ) +/// Calculate b raised to the p-th power. +/// @param v Input Value. +/// @param p Power to raise value by. +/// @returns v raised to the p-th power. +/// @ingroup Math ) +/// /// public float fn_mPow (float v, float p) @@ -10148,7 +12600,11 @@ public float fn_mPow (float v, float p) return SafeNativeMethods.mwle_fn_mPow(v, p); } /// -/// Convert specified radians into degrees. @param radians Input Value (in radians). @returns The specified radians value converted to degrees. @ingroup Math ) +/// Convert specified radians into degrees. +/// @param radians Input Value (in radians). +/// @returns The specified radians value converted to degrees. +/// @ingroup Math ) +/// /// public float fn_mRadToDeg (float radians) @@ -10159,7 +12615,12 @@ public float fn_mRadToDeg (float radians) return SafeNativeMethods.mwle_fn_mRadToDeg(radians); } /// -/// Round v to the nth decimal place or the nearest whole number by default. @param v Value to roundn @param n Number of decimal places to round to, 0 by defaultn @return The rounded value as a S32. @ingroup Math ) +/// Round v to the nth decimal place or the nearest whole number by default. +/// @param v Value to roundn +/// @param n Number of decimal places to round to, 0 by defaultn +/// @return The rounded value as a S32. +/// @ingroup Math ) +/// /// public float fn_mRound (float v, int n) @@ -10170,7 +12631,11 @@ public float fn_mRound (float v, int n) return SafeNativeMethods.mwle_fn_mRound(v, n); } /// -/// Clamp the specified value between 0 and 1 (inclusive). @param v Input value. @returns The specified value clamped between 0 and 1 (inclusive). @ingroup Math ) +/// Clamp the specified value between 0 and 1 (inclusive). +/// @param v Input value. +/// @returns The specified value clamped between 0 and 1 (inclusive). +/// @ingroup Math ) +/// /// public float fn_mSaturate (float v) @@ -10181,7 +12646,11 @@ public float fn_mSaturate (float v) return SafeNativeMethods.mwle_fn_mSaturate(v); } /// -/// Calculate the sine of v. @param v Input Value (in radians). @returns The sine of the input value. @ingroup Math ) +/// Calculate the sine of v. +/// @param v Input Value (in radians). +/// @returns The sine of the input value. +/// @ingroup Math ) +/// /// public float fn_mSin (float v) @@ -10192,7 +12661,15 @@ public float fn_mSin (float v) return SafeNativeMethods.mwle_fn_mSin(v); } /// -/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. @ingroup Math ) +/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions +/// (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. +/// @ingroup Math ) +/// /// public string fn_mSolveCubic (float a, float b, float c, float d) @@ -10206,7 +12683,14 @@ public string fn_mSolveCubic (float a, float b, float c, float d) } /// -/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. @ingroup Math ) +/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions +/// (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. +/// @ingroup Math ) +/// /// public string fn_mSolveQuadratic (float a, float b, float c) @@ -10220,7 +12704,16 @@ public string fn_mSolveQuadratic (float a, float b, float c) } /// -/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @param e Fifth Coefficient. @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. @ingroup Math ) +/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @param e Fifth Coefficient. +/// @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions +/// (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. +/// @ingroup Math ) +/// /// public string fn_mSolveQuartic (float a, float b, float c, float d, float e) @@ -10234,7 +12727,11 @@ public string fn_mSolveQuartic (float a, float b, float c, float d, float e) } /// -/// Calculate the square-root of v. @param v Input Value. @returns The square-root of the input value. @ingroup Math ) +/// Calculate the square-root of v. +/// @param v Input Value. +/// @returns The square-root of the input value. +/// @ingroup Math ) +/// /// public float fn_mSqrt (float v) @@ -10245,7 +12742,11 @@ public float fn_mSqrt (float v) return SafeNativeMethods.mwle_fn_mSqrt(v); } /// -/// Calculate the tangent of v. @param v Input Value (in radians). @returns The tangent of the input value. @ingroup Math ) +/// Calculate the tangent of v. +/// @param v Input Value (in radians). +/// @returns The tangent of the input value. +/// @ingroup Math ) +/// /// public float fn_mTan (float v) @@ -10257,6 +12758,7 @@ public float fn_mTan (float v) } /// /// nameToID(object)) +/// /// public int fn_nameToID (string objectName) @@ -10270,17 +12772,44 @@ public int fn_nameToID (string objectName) return SafeNativeMethods.mwle_fn_nameToID(sbobjectName); } /// -/// ( string str, string token, string delimiters ) Tokenize a string using a set of delimiting characters. This function first skips all leading charaters in @a str that are contained in @a delimiters. From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str until the function returns \"\". @param str A string. @param token The name of the variable in which to store the current token. This variable is set in the scope in which nextToken is called. @param delimiters A string of characters. Each character is considered a delimiter. @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. @tsexample // Prints: // a // b // c %str = \"a b c\"; while ( %str !$= \"\" ) { // First time, stores \"a\" in the variable %token and sets %str to \"b c\". %str = nextToken( %str, \"token\", \" \" ); echo( %token ); } @endtsexample @ingroup Strings ) +/// ( string str, string token, string delimiters ) +/// Tokenize a string using a set of delimiting characters. +/// This function first skips all leading charaters in @a str that are contained in @a delimiters. +/// From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters +/// from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it +/// skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. +/// To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str +/// until the function returns \"\". +/// @param str A string. +/// @param token The name of the variable in which to store the current token. This variable is set in the +/// scope in which nextToken is called. +/// @param delimiters A string of characters. Each character is considered a delimiter. +/// @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. +/// @tsexample +/// // Prints: +/// // a +/// // b +/// // c +/// %str = \"a b c\"; +/// while ( %str !$= \"\" ) +/// { +/// // First time, stores \"a\" in the variable %token and sets %str to \"b c\". +/// %str = nextToken( %str, \"token\", \" \" ); +/// echo( %token ); +/// } +/// @endtsexample +/// @ingroup Strings ) +/// /// -public string fn_nextToken (string str, string token, string delim) +public string fn_nextToken (string str1, string token, string delim) { if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_nextToken'" + string.Format("\"{0}\" \"{1}\" \"{2}\" ",str,token,delim)); +System.Console.WriteLine("----------------->Extern Call 'fn_nextToken'" + string.Format("\"{0}\" \"{1}\" \"{2}\" ",str1,token,delim)); var returnbuff = new StringBuilder(16384); -StringBuilder sbstr = null; -if (str != null) - sbstr = new StringBuilder(str, 1024); +StringBuilder sbstr1 = null; +if (str1 != null) + sbstr1 = new StringBuilder(str1, 1024); StringBuilder sbtoken = null; if (token != null) sbtoken = new StringBuilder(token, 1024); @@ -10288,12 +12817,17 @@ public string fn_nextToken (string str, string token, string delim) if (delim != null) sbdelim = new StringBuilder(delim, 1024); -SafeNativeMethods.mwle_fn_nextToken(sbstr, sbtoken, sbdelim, returnbuff); +SafeNativeMethods.mwle_fn_nextToken(sbstr1, sbtoken, sbdelim, returnbuff); return returnbuff.ToString(); } /// -/// @brief Open the given @a file through the system. This will usually open the file in its associated application. @param file %Path of the file to open. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given @a file through the system. This will usually open the file in its +/// associated application. +/// @param file %Path of the file to open. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void fn_openFile (string file) @@ -10307,7 +12841,11 @@ public void fn_openFile (string file) SafeNativeMethods.mwle_fn_openFile(sbfile); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void fn_openFolder (string path) @@ -10321,7 +12859,13 @@ public void fn_openFolder (string path) SafeNativeMethods.mwle_fn_openFolder(sbpath); } /// -/// @brief Combines two separate strings containing a file path and file name together into a single string @param path String containing file path @param file String containing file name @return String containing concatenated file name and path @ingroup FileSystem) +/// @brief Combines two separate strings containing a file path and file name together into a single string +/// +/// @param path String containing file path +/// @param file String containing file name +/// @return String containing concatenated file name and path +/// @ingroup FileSystem) +/// /// public string fn_pathConcat (string path, string file) @@ -10341,7 +12885,14 @@ public string fn_pathConcat (string path, string file) } /// -/// @brief Copy a file to a new location. @param fromFile %Path of the file to copy. @param toFile %Path where to copy @a fromFile to. @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. @return True if the file was successfully copied, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Copy a file to a new location. +/// @param fromFile %Path of the file to copy. +/// @param toFile %Path where to copy @a fromFile to. +/// @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. +/// @return True if the file was successfully copied, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_pathCopy (string fromFile, string toFile, bool noOverwrite) @@ -10358,7 +12909,23 @@ public bool fn_pathCopy (string fromFile, string toFile, bool noOverwrite) return SafeNativeMethods.mwle_fn_pathCopy(sbfromFile, sbtoFile, noOverwrite)>=1; } /// -/// @brief Load all Path information from the mission. This function is usually called from the loadMissionStage2() server-side function after the mission file has loaded. Internally it places all Paths into the server's PathManager. From this point the Paths are ready for transmission to the clients. @tsexample // Inform the engine to load all Path information from the mission. pathOnMissionLoadDone(); @endtsexample @see NetConnection::transmitPaths() @see NetConnection::clearPaths() @see Path @ingroup Networking) +/// @brief Load all Path information from the mission. +/// +/// This function is usually called from the loadMissionStage2() server-side function +/// after the mission file has loaded. Internally it places all Paths into the server's +/// PathManager. From this point the Paths are ready for transmission to the clients. +/// +/// @tsexample +/// // Inform the engine to load all Path information from the mission. +/// pathOnMissionLoadDone(); +/// @endtsexample +/// +/// @see NetConnection::transmitPaths() +/// @see NetConnection::clearPaths() +/// @see Path +/// +/// @ingroup Networking) +/// /// public void fn_pathOnMissionLoadDone () @@ -10370,7 +12937,9 @@ public void fn_pathOnMissionLoadDone () SafeNativeMethods.mwle_fn_pathOnMissionLoadDone(); } /// -/// () Clears all the tracked objects without saving them. ) +/// () +/// Clears all the tracked objects without saving them. ) +/// /// public void fn_PersistenceManager_clearAll (string persistencemanager) @@ -10384,7 +12953,9 @@ public void fn_PersistenceManager_clearAll (string persistencemanager) SafeNativeMethods.mwle_fn_PersistenceManager_clearAll(sbpersistencemanager); } /// -/// ( fileName ) Delete all of the objects that are created from the given file. ) +/// ( fileName ) +/// Delete all of the objects that are created from the given file. ) +/// /// public void fn_PersistenceManager_deleteObjectsFromFile (string persistencemanager, string fileName) @@ -10401,7 +12972,9 @@ public void fn_PersistenceManager_deleteObjectsFromFile (string persistencemanag SafeNativeMethods.mwle_fn_PersistenceManager_deleteObjectsFromFile(sbpersistencemanager, sbfileName); } /// -/// ( index ) Returns the ith dirty object. ) +/// ( index ) +/// Returns the ith dirty object. ) +/// /// public int fn_PersistenceManager_getDirtyObject (string persistencemanager, int index) @@ -10415,7 +12988,9 @@ public int fn_PersistenceManager_getDirtyObject (string persistencemanager, int return SafeNativeMethods.mwle_fn_PersistenceManager_getDirtyObject(sbpersistencemanager, index); } /// -/// () Returns the number of dirty objects. ) +/// () +/// Returns the number of dirty objects. ) +/// /// public int fn_PersistenceManager_getDirtyObjectCount (string persistencemanager) @@ -10429,7 +13004,9 @@ public int fn_PersistenceManager_getDirtyObjectCount (string persistencemanager) return SafeNativeMethods.mwle_fn_PersistenceManager_getDirtyObjectCount(sbpersistencemanager); } /// -/// () Returns true if the manager has dirty objects to save. ) +/// () +/// Returns true if the manager has dirty objects to save. ) +/// /// public bool fn_PersistenceManager_hasDirty (string persistencemanager) @@ -10443,7 +13020,9 @@ public bool fn_PersistenceManager_hasDirty (string persistencemanager) return SafeNativeMethods.mwle_fn_PersistenceManager_hasDirty(sbpersistencemanager)>=1; } /// -/// (SimObject object) Returns true if the SimObject is on the dirty list.) +/// (SimObject object) +/// Returns true if the SimObject is on the dirty list.) +/// /// public bool fn_PersistenceManager_isDirty (string persistencemanager, string objName) @@ -10460,7 +13039,9 @@ public bool fn_PersistenceManager_isDirty (string persistencemanager, string obj return SafeNativeMethods.mwle_fn_PersistenceManager_isDirty(sbpersistencemanager, sbobjName)>=1; } /// -/// () Prints the dirty list to the console.) +/// () +/// Prints the dirty list to the console.) +/// /// public void fn_PersistenceManager_listDirty (string persistencemanager) @@ -10474,7 +13055,9 @@ public void fn_PersistenceManager_listDirty (string persistencemanager) SafeNativeMethods.mwle_fn_PersistenceManager_listDirty(sbpersistencemanager); } /// -/// (SimObject object) Remove a SimObject from the dirty list.) +/// (SimObject object) +/// Remove a SimObject from the dirty list.) +/// /// public void fn_PersistenceManager_removeDirty (string persistencemanager, string objName) @@ -10491,7 +13074,9 @@ public void fn_PersistenceManager_removeDirty (string persistencemanager, string SafeNativeMethods.mwle_fn_PersistenceManager_removeDirty(sbpersistencemanager, sbobjName); } /// -/// (SimObject object, string fieldName) Remove a specific field from an object declaration.) +/// (SimObject object, string fieldName) +/// Remove a specific field from an object declaration.) +/// /// public void fn_PersistenceManager_removeField (string persistencemanager, string objName, string fieldName) @@ -10511,7 +13096,10 @@ public void fn_PersistenceManager_removeField (string persistencemanager, string SafeNativeMethods.mwle_fn_PersistenceManager_removeField(sbpersistencemanager, sbobjName, sbfieldName); } /// -/// ) , (SimObject object, [filename]) Remove an existing SimObject from a file (can optionally specify a different file than \ the one it was created in.) +/// ) , (SimObject object, [filename]) +/// Remove an existing SimObject from a file (can optionally specify a different file than \ +/// the one it was created in.) +/// /// public void fn_PersistenceManager_removeObjectFromFile (string persistencemanager, string objName, string filename) @@ -10531,7 +13119,9 @@ public void fn_PersistenceManager_removeObjectFromFile (string persistencemanage SafeNativeMethods.mwle_fn_PersistenceManager_removeObjectFromFile(sbpersistencemanager, sbobjName, sbfilename); } /// -/// () Saves all of the SimObject's on the dirty list to their respective files.) +/// () +/// Saves all of the SimObject's on the dirty list to their respective files.) +/// /// public bool fn_PersistenceManager_saveDirty (string persistencemanager) @@ -10545,7 +13135,9 @@ public bool fn_PersistenceManager_saveDirty (string persistencemanager) return SafeNativeMethods.mwle_fn_PersistenceManager_saveDirty(sbpersistencemanager)>=1; } /// -/// (SimObject object) Save a dirty SimObject to it's file.) +/// (SimObject object) +/// Save a dirty SimObject to it's file.) +/// /// public bool fn_PersistenceManager_saveDirtyObject (string persistencemanager, string objName) @@ -10562,7 +13154,9 @@ public bool fn_PersistenceManager_saveDirtyObject (string persistencemanager, st return SafeNativeMethods.mwle_fn_PersistenceManager_saveDirtyObject(sbpersistencemanager, sbobjName)>=1; } /// -/// ), (SimObject object, [filename]) Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// ), (SimObject object, [filename]) +/// Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// /// public void fn_PersistenceManager_setDirty (string persistencemanager, string objName, string fileName) @@ -10582,7 +13176,11 @@ public void fn_PersistenceManager_setDirty (string persistencemanager, string ob SafeNativeMethods.mwle_fn_PersistenceManager_setDirty(sbpersistencemanager, sbobjName, sbfileName); } /// -/// @brief Loads some information to have readily available at simulation time. Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. This function should be used while a level is loading in order to shorten the amount of time to create a PhysicsDebris in game.) +/// @brief Loads some information to have readily available at simulation time. +/// Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. +/// This function should be used while a level is loading in order to shorten +/// the amount of time to create a PhysicsDebris in game.) +/// /// public void fn_PhysicsDebrisData_preload (string physicsdebrisdata) @@ -10597,6 +13195,7 @@ public void fn_PhysicsDebrisData_preload (string physicsdebrisdata) } /// /// physicsDebugDraw( bool enable )) +/// /// public void fn_physicsDebugDraw (bool enable) @@ -10608,6 +13207,7 @@ public void fn_physicsDebugDraw (bool enable) } /// /// physicsDestroy()) +/// /// public void fn_physicsDestroy () @@ -10620,6 +13220,7 @@ public void fn_physicsDestroy () } /// /// physicsDestroyWorld( String worldName )) +/// /// public void fn_physicsDestroyWorld (string worldName) @@ -10634,6 +13235,7 @@ public void fn_physicsDestroyWorld (string worldName) } /// /// physicsGetTimeScale()) +/// /// public float fn_physicsGetTimeScale () @@ -10646,6 +13248,7 @@ public float fn_physicsGetTimeScale () } /// /// ), physicsInit( [string library] )) +/// /// public bool fn_physicsInit (string library) @@ -10660,6 +13263,7 @@ public bool fn_physicsInit (string library) } /// /// physicsInitWorld( String worldName )) +/// /// public bool fn_physicsInitWorld (string worldName) @@ -10673,7 +13277,10 @@ public bool fn_physicsInitWorld (string worldName) return SafeNativeMethods.mwle_fn_physicsInitWorld(sbworldName)>=1; } /// -/// physicsPluginPresent() @brief Returns true if a physics plugin exists and is initialized. @ingroup Physics ) +/// physicsPluginPresent() +/// @brief Returns true if a physics plugin exists and is initialized. +/// @ingroup Physics ) +/// /// public bool fn_physicsPluginPresent () @@ -10686,6 +13293,7 @@ public bool fn_physicsPluginPresent () } /// /// physicsRestoreState()) +/// /// public void fn_physicsRestoreState () @@ -10698,6 +13306,7 @@ public void fn_physicsRestoreState () } /// /// physicsSetTimeScale( F32 scale )) +/// /// public void fn_physicsSetTimeScale (float scale) @@ -10709,6 +13318,7 @@ public void fn_physicsSetTimeScale (float scale) } /// /// physicsStopSimulation( String worldName )) +/// /// public bool fn_physicsSimulationEnabled () @@ -10721,6 +13331,7 @@ public bool fn_physicsSimulationEnabled () } /// /// physicsStartSimulation( String worldName )) +/// /// public void fn_physicsStartSimulation (string worldName) @@ -10735,6 +13346,7 @@ public void fn_physicsStartSimulation (string worldName) } /// /// physicsStopSimulation( String worldName )) +/// /// public void fn_physicsStopSimulation (string worldName) @@ -10749,6 +13361,7 @@ public void fn_physicsStopSimulation (string worldName) } /// /// physicsStoreState()) +/// /// public void fn_physicsStoreState () @@ -10760,7 +13373,11 @@ public void fn_physicsStoreState () SafeNativeMethods.mwle_fn_physicsStoreState(); } /// -/// (string filename) @brief Begin playback of a journal from a specified field. @param filename Name and path of file journal file @ingroup Platform) +/// (string filename) +/// @brief Begin playback of a journal from a specified field. +/// @param filename Name and path of file journal file +/// @ingroup Platform) +/// /// public void fn_playJournal (string filename) @@ -10774,7 +13391,10 @@ public void fn_playJournal (string filename) SafeNativeMethods.mwle_fn_playJournal(sbfilename); } /// -/// THEORA, 30.0f, Point2I::Zero ), Load a journal file and capture it video. @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Load a journal file and capture it video. +/// @ingroup Rendering ) +/// /// public void fn_playJournalToVideo (string journalFile, string videoFile, string encoder, float framerate, string resolution) @@ -10797,7 +13417,12 @@ public void fn_playJournalToVideo (string journalFile, string videoFile, string SafeNativeMethods.mwle_fn_playJournalToVideo(sbjournalFile, sbvideoFile, sbencoder, framerate, sbresolution); } /// -/// () @brief Pop and restore the last setting of $instantGroup off the stack. @note Currently only used for editors @ingroup Editors @internal) +/// () +/// @brief Pop and restore the last setting of $instantGroup off the stack. +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void fn_popInstantGroup () @@ -10809,7 +13434,12 @@ public void fn_popInstantGroup () SafeNativeMethods.mwle_fn_popInstantGroup(); } /// -/// Populate the font cache for all fonts with Unicode code points in the specified range. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for all fonts with Unicode code points in the specified range. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void fn_populateAllFontCacheRange (uint rangeStart, uint rangeEnd) @@ -10820,7 +13450,9 @@ public void fn_populateAllFontCacheRange (uint rangeStart, uint rangeEnd) SafeNativeMethods.mwle_fn_populateAllFontCacheRange(rangeStart, rangeEnd); } /// -/// Populate the font cache for all fonts with characters from the specified string. @ingroup Font ) +/// Populate the font cache for all fonts with characters from the specified string. +/// @ingroup Font ) +/// /// public void fn_populateAllFontCacheString (string stringx) @@ -10834,7 +13466,14 @@ public void fn_populateAllFontCacheString (string stringx) SafeNativeMethods.mwle_fn_populateAllFontCacheString(sbstringx); } /// -/// Populate the font cache for the specified font with Unicode code points in the specified range. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for the specified font with Unicode code points in the specified range. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void fn_populateFontCacheRange (string faceName, int fontSize, uint rangeStart, uint rangeEnd) @@ -10848,7 +13487,12 @@ public void fn_populateFontCacheRange (string faceName, int fontSize, uint range SafeNativeMethods.mwle_fn_populateFontCacheRange(sbfaceName, fontSize, rangeStart, rangeEnd); } /// -/// Populate the font cache for the specified font with characters from the specified string. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param string The string to populate. @ingroup Font ) +/// Populate the font cache for the specified font with characters from the specified string. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param string The string to populate. +/// @ingroup Font ) +/// /// public void fn_populateFontCacheString (string faceName, int fontSize, string stringx) @@ -10866,6 +13510,7 @@ public void fn_populateFontCacheString (string faceName, int fontSize, string st } /// /// (GuiCanvas, pos, title)) +/// /// public void fn_PopupMenu_attachToMenuBar (string popupmenu, string canvasName, int pos, string title) @@ -10886,6 +13531,7 @@ public void fn_PopupMenu_attachToMenuBar (string popupmenu, string canvasName, i } /// /// (pos, checked)) +/// /// public void fn_PopupMenu_checkItem (string popupmenu, int pos, bool checkedx) @@ -10900,6 +13546,7 @@ public void fn_PopupMenu_checkItem (string popupmenu, int pos, bool checkedx) } /// /// (firstPos, lastPos, checkPos)) +/// /// public void fn_PopupMenu_checkRadioItem (string popupmenu, int firstPos, int lastPos, int checkPos) @@ -10914,6 +13561,7 @@ public void fn_PopupMenu_checkRadioItem (string popupmenu, int firstPos, int las } /// /// (pos, enabled)) +/// /// public void fn_PopupMenu_enableItem (string popupmenu, int pos, bool enabled) @@ -10928,6 +13576,7 @@ public void fn_PopupMenu_enableItem (string popupmenu, int pos, bool enabled) } /// /// ()) +/// /// public int fn_PopupMenu_getItemCount (string popupmenu) @@ -10942,6 +13591,7 @@ public int fn_PopupMenu_getItemCount (string popupmenu) } /// /// , ), (pos[, title][, accelerator])) +/// /// public int fn_PopupMenu_insertItem (string popupmenu, int pos, string title, string accelerator) @@ -10962,6 +13612,7 @@ public int fn_PopupMenu_insertItem (string popupmenu, int pos, string title, str } /// /// (pos, title, subMenu)) +/// /// public int fn_PopupMenu_insertSubMenu (string popupmenu, int pos, string title, string subMenu) @@ -10982,6 +13633,7 @@ public int fn_PopupMenu_insertSubMenu (string popupmenu, int pos, string title, } /// /// (pos)) +/// /// public bool fn_PopupMenu_isItemChecked (string popupmenu, int pos) @@ -10996,6 +13648,7 @@ public bool fn_PopupMenu_isItemChecked (string popupmenu, int pos) } /// /// ()) +/// /// public void fn_PopupMenu_removeFromMenuBar (string popupmenu) @@ -11010,6 +13663,7 @@ public void fn_PopupMenu_removeFromMenuBar (string popupmenu) } /// /// (pos)) +/// /// public void fn_PopupMenu_removeItem (string popupmenu, int pos) @@ -11024,6 +13678,7 @@ public void fn_PopupMenu_removeItem (string popupmenu, int pos) } /// /// ), (pos, title[, accelerator])) +/// /// public bool fn_PopupMenu_setItem (string popupmenu, int pos, string title, string accelerator) @@ -11044,6 +13699,7 @@ public bool fn_PopupMenu_setItem (string popupmenu, int pos, string title, strin } /// /// (Canvas,[x, y])) +/// /// public void fn_PopupMenu_showPopup (string popupmenu, string canvasName, int x, int y) @@ -11060,7 +13716,9 @@ public void fn_PopupMenu_showPopup (string popupmenu, string canvasName, int x, SafeNativeMethods.mwle_fn_PopupMenu_showPopup(sbpopupmenu, sbcanvasName, x, y); } /// -/// Preload all datablocks in client mode. (Server parameter is set to false). This will take some time to complete.) +/// Preload all datablocks in client mode. +/// (Server parameter is set to false). This will take some time to complete.) +/// /// public void fn_preloadClientDataBlocks () @@ -11072,7 +13730,11 @@ public void fn_preloadClientDataBlocks () SafeNativeMethods.mwle_fn_preloadClientDataBlocks(); } /// -/// @brief Dumps current profiling stats to the console window. @note Markers disabled with profilerMarkerEnable() will be skipped over. If the profiler is currently running, it will be disabled. @ingroup Debugging) +/// @brief Dumps current profiling stats to the console window. +/// @note Markers disabled with profilerMarkerEnable() will be skipped over. +/// If the profiler is currently running, it will be disabled. +/// @ingroup Debugging) +/// /// public void fn_profilerDump () @@ -11084,7 +13746,15 @@ public void fn_profilerDump () SafeNativeMethods.mwle_fn_profilerDump(); } /// -/// @brief Dumps current profiling stats to a file. @note If the profiler is currently running, it will be disabled. @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). Will attempt to create the file if it does not already exist. @tsexample profilerDumpToFile( \"C:/Torque/log1.txt\" ); @endtsexample @ingroup Debugging ) +/// @brief Dumps current profiling stats to a file. +/// @note If the profiler is currently running, it will be disabled. +/// @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). +/// Will attempt to create the file if it does not already exist. +/// @tsexample +/// profilerDumpToFile( \"C:/Torque/log1.txt\" ); +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void fn_profilerDumpToFile (string fileName) @@ -11098,7 +13768,14 @@ public void fn_profilerDumpToFile (string fileName) SafeNativeMethods.mwle_fn_profilerDumpToFile(sbfileName); } /// -/// @brief Enables or disables the profiler. Data is only gathered while the profiler is enabled. @note Profiler is not available in shipping builds. T3D has predefined profiling areas surrounded by markers, but you may need to define additional markers (in C++) around areas you wish to profile, by using the PROFILE_START( markerName ); and PROFILE_END(); macros. @ingroup Debugging ) +/// @brief Enables or disables the profiler. +/// Data is only gathered while the profiler is enabled. +/// @note Profiler is not available in shipping builds. +/// T3D has predefined profiling areas surrounded by markers, +/// but you may need to define additional markers (in C++) around areas you wish to profile, +/// by using the PROFILE_START( markerName ); and PROFILE_END(); macros. +/// @ingroup Debugging ) +/// /// public void fn_profilerEnable (bool enable) @@ -11109,7 +13786,13 @@ public void fn_profilerEnable (bool enable) SafeNativeMethods.mwle_fn_profilerEnable(enable); } /// -/// @brief Enable or disable a specific profile. @param enable Optional paramater to enable or disable the profile. @param markerName Name of a specific marker to enable or disable. @note Calling this function will first call profilerReset(), clearing all data from profiler. All profile markers are enabled by default. @ingroup Debugging) +/// @brief Enable or disable a specific profile. +/// @param enable Optional paramater to enable or disable the profile. +/// @param markerName Name of a specific marker to enable or disable. +/// @note Calling this function will first call profilerReset(), clearing all data from profiler. +/// All profile markers are enabled by default. +/// @ingroup Debugging) +/// /// public void fn_profilerMarkerEnable (string markerName, bool enable) @@ -11123,7 +13806,11 @@ public void fn_profilerMarkerEnable (string markerName, bool enable) SafeNativeMethods.mwle_fn_profilerMarkerEnable(sbmarkerName, enable); } /// -/// @brief Resets the profiler, clearing it of all its data. If the profiler is currently running, it will first be disabled. All markers will retain their current enabled/disabled status. @ingroup Debugging ) +/// @brief Resets the profiler, clearing it of all its data. +/// If the profiler is currently running, it will first be disabled. +/// All markers will retain their current enabled/disabled status. +/// @ingroup Debugging ) +/// /// public void fn_profilerReset () @@ -11135,7 +13822,13 @@ public void fn_profilerReset () SafeNativeMethods.mwle_fn_profilerReset(); } /// -/// ) , ([group]) @brief Pushes the current $instantGroup on a stack and sets it to the given value (or clears it). @note Currently only used for editors @ingroup Editors @internal) +/// ) , ([group]) +/// @brief Pushes the current $instantGroup on a stack +/// and sets it to the given value (or clears it). +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void fn_pushInstantGroup (string group) @@ -11150,6 +13843,7 @@ public void fn_pushInstantGroup (string group) } /// /// queryAllServers(...); ) +/// /// public void fn_queryAllServers (uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags) @@ -11167,6 +13861,8 @@ public void fn_queryAllServers (uint lanPort, uint flags, string gameType, strin } /// /// queryLanServers(...); ) +/// +/// /// public void fn_queryLanServers (uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags) @@ -11184,6 +13880,7 @@ public void fn_queryLanServers (uint lanPort, uint flags, string gameType, strin } /// /// queryMasterServer(...); ) +/// /// public void fn_queryMasterServer (uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags) @@ -11201,6 +13898,7 @@ public void fn_queryMasterServer (uint lanPort, uint flags, string gameType, str } /// /// querySingleServer(...); ) +/// /// public void fn_querySingleServer (string addrText, byte flags) @@ -11214,6 +13912,43 @@ public void fn_querySingleServer (string addrText, byte flags) SafeNativeMethods.mwle_fn_querySingleServer(sbaddrText, flags); } /// +/// Shut down the engine and exit its process. +/// This function cleanly uninitializes the engine and then exits back to the system with a process +/// exit status indicating a clean exit. +/// @see quitWithErrorMessage +/// @ingroup Platform ) +/// +/// + +public void fn_quit () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_quit'"); + + +SafeNativeMethods.mwle_fn_quit(); +} +/// +/// Display an error message box showing the given @a message and then shut down the engine and exit its process. +/// This function cleanly uninitialized the engine and then exits back to the system with a process +/// exit status indicating an error. +/// @param message The message to log to the console and show in an error message box. +/// @see quit +/// @ingroup Platform ) +/// +/// + +public void fn_quitWithErrorMessage (string message) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_quitWithErrorMessage'" + string.Format("\"{0}\" ",message)); +StringBuilder sbmessage = null; +if (message != null) + sbmessage = new StringBuilder(message, 1024); + +SafeNativeMethods.mwle_fn_quitWithErrorMessage(sbmessage); +} +/// /// readXMLObj.readFile();) /// /// @@ -11238,7 +13973,10 @@ public void fn_realQuit () SafeNativeMethods.mwle_fn_realQuit(); } /// -/// Close the current Redbook device. @brief Deprecated @internal) +/// Close the current Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookClose () @@ -11250,7 +13988,10 @@ public bool fn_redbookClose () return SafeNativeMethods.mwle_fn_redbookClose()>=1; } /// -/// get the number of redbook devices. @brief Deprecated @internal) +/// get the number of redbook devices. +/// @brief Deprecated +/// @internal) +/// /// public int fn_redbookGetDeviceCount () @@ -11262,7 +14003,10 @@ public int fn_redbookGetDeviceCount () return SafeNativeMethods.mwle_fn_redbookGetDeviceCount(); } /// -/// (int index) Get name of specified Redbook device. @brief Deprecated @internal) +/// (int index) Get name of specified Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public string fn_redbookGetDeviceName (int index) @@ -11276,7 +14020,10 @@ public string fn_redbookGetDeviceName (int index) } /// -/// Get a string explaining the last redbook error. @brief Deprecated @internal) +/// Get a string explaining the last redbook error. +/// @brief Deprecated +/// @internal) +/// /// public string fn_redbookGetLastError () @@ -11291,7 +14038,10 @@ public string fn_redbookGetLastError () } /// -/// Return the number of tracks. @brief Deprecated @internal) +/// Return the number of tracks. +/// @brief Deprecated +/// @internal) +/// /// public int fn_redbookGetTrackCount () @@ -11303,7 +14053,10 @@ public int fn_redbookGetTrackCount () return SafeNativeMethods.mwle_fn_redbookGetTrackCount(); } /// -/// Get the volume. @brief Deprecated @internal) +/// Get the volume. +/// @brief Deprecated +/// @internal) +/// /// public float fn_redbookGetVolume () @@ -11315,7 +14068,10 @@ public float fn_redbookGetVolume () return SafeNativeMethods.mwle_fn_redbookGetVolume(); } /// -/// ), (string device=NULL) @brief Deprecated @internal) +/// ), (string device=NULL) +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookOpen (string device) @@ -11329,7 +14085,10 @@ public bool fn_redbookOpen (string device) return SafeNativeMethods.mwle_fn_redbookOpen(sbdevice)>=1; } /// -/// (int track) Play the selected track. @brief Deprecated @internal) +/// (int track) Play the selected track. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookPlay (int track) @@ -11340,7 +14099,10 @@ public bool fn_redbookPlay (int track) return SafeNativeMethods.mwle_fn_redbookPlay(track)>=1; } /// -/// (float volume) Set playback volume. @brief Deprecated @internal) +/// (float volume) Set playback volume. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookSetVolume (float volume) @@ -11351,7 +14113,10 @@ public bool fn_redbookSetVolume (float volume) return SafeNativeMethods.mwle_fn_redbookSetVolume(volume)>=1; } /// -/// Stop playing. @brief Deprecated @internal) +/// Stop playing. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookStop () @@ -11363,7 +14128,12 @@ public bool fn_redbookStop () return SafeNativeMethods.mwle_fn_redbookStop()>=1; } /// -/// (string queueName, string listener) @brief Registers an event message @param queueName String containing the name of queue to attach listener to @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Registers an event message +/// @param queueName String containing the name of queue to attach listener to +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public bool fn_registerMessageListener (string queueName, string listenerName) @@ -11380,7 +14150,11 @@ public bool fn_registerMessageListener (string queueName, string listenerName) return SafeNativeMethods.mwle_fn_registerMessageListener(sbqueueName, sblistenerName)>=1; } /// -/// (string queueName) @brief Registeres a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Registeres a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void fn_registerMessageQueue (string queueName) @@ -11394,7 +14168,9 @@ public void fn_registerMessageQueue (string queueName) SafeNativeMethods.mwle_fn_registerMessageQueue(sbqueueName); } /// -/// @brief Flushes all procedural shaders and re-initializes all active material instances. @ingroup Materials) +/// @brief Flushes all procedural shaders and re-initializes all active material instances. +/// @ingroup Materials) +/// /// public void fn_reInitMaterials () @@ -11406,7 +14182,15 @@ public void fn_reInitMaterials () SafeNativeMethods.mwle_fn_reInitMaterials(); } /// -/// Force the resource at specified input path to be reloaded @param path Path to the resource to be reloaded @tsexample reloadResource( \"art/shapes/box.dts\" ); @endtsexample @note Currently used by editors only @ingroup Editors @internal) +/// Force the resource at specified input path to be reloaded +/// @param path Path to the resource to be reloaded +/// @tsexample +/// reloadResource( \"art/shapes/box.dts\" ); +/// @endtsexample +/// @note Currently used by editors only +/// @ingroup Editors +/// @internal) +/// /// public void fn_reloadResource (string path) @@ -11420,7 +14204,9 @@ public void fn_reloadResource (string path) SafeNativeMethods.mwle_fn_reloadResource(sbpath); } /// -/// Reload all the textures from disk. @ingroup GFX ) +/// Reload all the textures from disk. +/// @ingroup GFX ) +/// /// public void fn_reloadTextures () @@ -11432,7 +14218,19 @@ public void fn_reloadTextures () SafeNativeMethods.mwle_fn_reloadTextures(); } /// -/// Remove the field in @a text at the given @a index. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field in @a text. @return A new string with the field at the given index removed or the original string if @a index is out of range. @tsexample removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" @endtsexample @see removeWord @see removeRecord @ingroup FieldManip ) +/// Remove the field in @a text at the given @a index. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field in @a text. +/// @return A new string with the field at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string fn_removeField (string text, int index) @@ -11449,7 +14247,10 @@ public string fn_removeField (string text, int index) } /// -/// Removes an existing global macro by name. @see addGlobalShaderMacro @ingroup Rendering ) +/// Removes an existing global macro by name. +/// @see addGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void fn_removeGlobalShaderMacro (string name) @@ -11463,7 +14264,19 @@ public void fn_removeGlobalShaderMacro (string name) SafeNativeMethods.mwle_fn_removeGlobalShaderMacro(sbname); } /// -/// Remove the record in @a text at the given @a index. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record in @a text. @return A new string with the record at the given @a index removed or the original string if @a index is out of range. @tsexample removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" @endtsexample @see removeWord @see removeField @ingroup FieldManip ) +/// Remove the record in @a text at the given @a index. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record in @a text. +/// @return A new string with the record at the given @a index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeField +/// @ingroup FieldManip ) +/// /// public string fn_removeRecord (string text, int index) @@ -11480,7 +14293,15 @@ public string fn_removeRecord (string text, int index) } /// -/// @brief Remove a tagged string from the Net String Table @param tag The tag associated with the string @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// @brief Remove a tagged string from the Net String Table +/// +/// @param tag The tag associated with the string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public void fn_removeTaggedString (int tag) @@ -11491,7 +14312,19 @@ public void fn_removeTaggedString (int tag) SafeNativeMethods.mwle_fn_removeTaggedString(tag); } /// -/// Remove the word in @a text at the given @a index. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word in @a text. @return A new string with the word at the given index removed or the original string if @a index is out of range. @tsexample removeWord( \"a b c d\", 2 ) // Returns \"a b d\" @endtsexample @see removeField @see removeRecord @ingroup FieldManip ) +/// Remove the word in @a text at the given @a index. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word in @a text. +/// @return A new string with the word at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeWord( \"a b c d\", 2 ) // Returns \"a b d\" +/// @endtsexample +/// @see removeField +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string fn_removeWord (string text, int index) @@ -11508,7 +14341,12 @@ public string fn_removeWord (string text, int index) } /// -/// @brief Renames the given @a file. @param from %Path of the file to rename from. @param frome %Path of the file to rename to. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Renames the given @a file. +/// @param from %Path of the file to rename from. +/// @param frome %Path of the file to rename to. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_renameFile (string from, string to) @@ -11525,7 +14363,10 @@ public bool fn_renameFile (string from, string to) return SafeNativeMethods.mwle_fn_renameFile(sbfrom, sbto)>=1; } /// -/// () @brief Reset FPS stats (fps::) @ingroup Game) +/// () +/// @brief Reset FPS stats (fps::) +/// @ingroup Game) +/// /// public void fn_resetFPSTracker () @@ -11537,7 +14378,11 @@ public void fn_resetFPSTracker () SafeNativeMethods.mwle_fn_resetFPSTracker(); } /// -/// @brief Deactivates and then activates the currently active light manager. This causes most shaders to be regenerated and is often used when global rendering changes have occured. @ingroup Lighting ) +/// @brief Deactivates and then activates the currently active light manager. +/// This causes most shaders to be regenerated and is often used when global +/// rendering changes have occured. +/// @ingroup Lighting ) +/// /// public void fn_resetLightManager () @@ -11549,7 +14394,12 @@ public void fn_resetLightManager () SafeNativeMethods.mwle_fn_resetLightManager(); } /// -/// () @brief Rebuilds the XInput section of the InputManager Requests a full refresh of events for all controllers. Useful when called at the beginning of game code after actionMaps are set up to hook up all appropriate events. @ingroup Input) +/// () +/// @brief Rebuilds the XInput section of the InputManager +/// Requests a full refresh of events for all controllers. Useful when called at the beginning +/// of game code after actionMaps are set up to hook up all appropriate events. +/// @ingroup Input) +/// /// public void fn_resetXInput () @@ -11561,7 +14411,16 @@ public void fn_resetXInput () SafeNativeMethods.mwle_fn_resetXInput(); } /// -/// Return all but the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return @a text with the first word removed. @note This is equal to @tsexample_nopar getWords( text, 1 ) @endtsexample @see getWords @ingroup FieldManip ) +/// Return all but the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return @a text with the first word removed. +/// @note This is equal to +/// @tsexample_nopar +/// getWords( text, 1 ) +/// @endtsexample +/// @see getWords +/// @ingroup FieldManip ) +/// /// public string fn_restWords (string text) @@ -11578,7 +14437,16 @@ public string fn_restWords (string text) } /// -/// Remove trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. @tsexample rtrim( \" string \" ); // Returns \" string\". @endtsexample @see ltrim @see trim @ingroup Strings ) +/// Remove trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// rtrim( \" string \" ); // Returns \" string\". +/// @endtsexample +/// @see ltrim +/// @see trim +/// @ingroup Strings ) +/// /// public string fn_rtrim (string str) @@ -11595,7 +14463,18 @@ public string fn_rtrim (string str) } /// -/// (string device, float xRumble, float yRumble) @brief Activates the vibration motors in the specified controller. The controller will constantly at it's xRumble and yRumble intensities until changed or told to stop. Valid inputs for xRumble/yRumble are [0 - 1]. @param device Name of the device to rumble. @param xRumble Intensity to apply to the left motor. @param yRumble Intensity to apply to the right motor. @note in an Xbox 360 controller, the left motor is low-frequency, while the right motor is high-frequency. @ingroup Input) +/// (string device, float xRumble, float yRumble) +/// @brief Activates the vibration motors in the specified controller. +/// The controller will constantly at it's xRumble and yRumble intensities until +/// changed or told to stop. +/// Valid inputs for xRumble/yRumble are [0 - 1]. +/// @param device Name of the device to rumble. +/// @param xRumble Intensity to apply to the left motor. +/// @param yRumble Intensity to apply to the right motor. +/// @note in an Xbox 360 controller, the left motor is low-frequency, +/// while the right motor is high-frequency. +/// @ingroup Input) +/// /// public void fn_rumble (string device, float xRumble, float yRumble) @@ -11609,7 +14488,10 @@ public void fn_rumble (string device, float xRumble, float yRumble) SafeNativeMethods.mwle_fn_rumble(sbdevice, xRumble, yRumble); } /// -/// (string filename) Save the journal to the specified file. @ingroup Platform) +/// (string filename) +/// Save the journal to the specified file. +/// @ingroup Platform) +/// /// public void fn_saveJournal (string filename) @@ -11623,7 +14505,11 @@ public void fn_saveJournal (string filename) SafeNativeMethods.mwle_fn_saveJournal(sbfilename); } /// -/// @brief Serialize the object to a file. @param object The object to serialize. @param filename The file name and path. @ingroup Console) +/// @brief Serialize the object to a file. +/// @param object The object to serialize. +/// @param filename The file name and path. +/// @ingroup Console) +/// /// public bool fn_saveObject (string objectx, string filename) @@ -11640,7 +14526,12 @@ public bool fn_saveObject (string objectx, string filename) return SafeNativeMethods.mwle_fn_saveObject(sbobjectx, sbfilename)>=1; } /// -/// Dump the current zoning states of all zone spaces in the scene to the console. @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states are dumped as is. @note Only valid on the client. @ingroup Game ) +/// Dump the current zoning states of all zone spaces in the scene to the console. +/// @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states +/// are dumped as is. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public void fn_sceneDumpZoneStates (bool updateFirst) @@ -11651,7 +14542,12 @@ public void fn_sceneDumpZoneStates (bool updateFirst) SafeNativeMethods.mwle_fn_sceneDumpZoneStates(updateFirst); } /// -/// Return the SceneObject that contains the given zone. @param zoneId ID of zone. @return A SceneObject or NULL if the given @a zoneId is invalid. @note Only valid on the client. @ingroup Game ) +/// Return the SceneObject that contains the given zone. +/// @param zoneId ID of zone. +/// @return A SceneObject or NULL if the given @a zoneId is invalid. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public string fn_sceneGetZoneOwner (uint zoneId) @@ -11665,7 +14561,13 @@ public string fn_sceneGetZoneOwner (uint zoneId) } /// -/// Takes a screenshot with optional tiling to produce huge screenshots. @param file The output image file path. @param format Either JPEG or PNG. @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. @ingroup GFX ) +/// Takes a screenshot with optional tiling to produce huge screenshots. +/// @param file The output image file path. +/// @param format Either JPEG or PNG. +/// @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. +/// @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. +/// @ingroup GFX ) +/// /// public void fn_screenShot (string file, string format, uint tileCount, float tileOverlap) @@ -11682,7 +14584,11 @@ public void fn_screenShot (string file, string format, uint tileCount, float til SafeNativeMethods.mwle_fn_screenShot(sbfile, sbformat, tileCount, tileOverlap); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void fn_selectFile (string path) @@ -11713,7 +14619,11 @@ public bool fn_setClipboard (string text) return SafeNativeMethods.mwle_fn_setClipboard(sbtext)>=1; } /// -/// (string LangTable) @brief Sets the primary LangTable used by the game @param LangTable ID of the core LangTable @ingroup Localization) +/// (string LangTable) +/// @brief Sets the primary LangTable used by the game +/// @param LangTable ID of the core LangTable +/// @ingroup Localization) +/// /// public void fn_setCoreLangTable (string lgTable) @@ -11727,7 +14637,13 @@ public void fn_setCoreLangTable (string lgTable) SafeNativeMethods.mwle_fn_setCoreLangTable(sblgTable); } /// -/// @brief Set the current working directory. @param path The absolute or relative (to the current working directory) path of the directory which should be made the new working directory. @return True if the working directory was successfully changed to @a path, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Set the current working directory. +/// @param path The absolute or relative (to the current working directory) path of the directory which should be made the new +/// working directory. +/// @return True if the working directory was successfully changed to @a path, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_setCurrentDirectory (string path) @@ -11741,7 +14657,10 @@ public bool fn_setCurrentDirectory (string path) return SafeNativeMethods.mwle_fn_setCurrentDirectory(sbpath)>=1; } /// -/// @brief Set the default FOV for a camera. @param defaultFOV The default field of view in degrees @ingroup CameraSystem) +/// @brief Set the default FOV for a camera. +/// @param defaultFOV The default field of view in degrees +/// @ingroup CameraSystem) +/// /// public void fn_setDefaultFov (float defaultFOV) @@ -11752,7 +14671,9 @@ public void fn_setDefaultFov (float defaultFOV) SafeNativeMethods.mwle_fn_setDefaultFov(defaultFOV); } /// -/// Sets the clients far clipping. ) +/// Sets the clients far clipping. +/// ) +/// /// public void fn_setFarClippingDistance (float dist) @@ -11763,7 +14684,21 @@ public void fn_setFarClippingDistance (float dist) SafeNativeMethods.mwle_fn_setFarClippingDistance(dist); } /// -/// Replace the field in @a text at the given @a index with @a replacement. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to replace. @param replacement The string with which to replace the field. @return A new string with the field at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" @endtsexample @see getField @see setWord @see setRecord @ingroup FieldManip ) +/// Replace the field in @a text at the given @a index with @a replacement. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to replace. +/// @param replacement The string with which to replace the field. +/// @return A new string with the field at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see setWord +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string fn_setField (string text, int index, string replacement) @@ -11798,7 +14733,10 @@ public int fn_SetFogVolumeQuality (uint new_quality) return SafeNativeMethods.mwle_fn_SetFogVolumeQuality(new_quality); } /// -/// @brief Set the FOV of the camera. @param FOV The camera's new FOV in degrees @ingroup CameraSystem) +/// @brief Set the FOV of the camera. +/// @param FOV The camera's new FOV in degrees +/// @ingroup CameraSystem) +/// /// public void fn_setFov (float FOV) @@ -11810,6 +14748,7 @@ public void fn_setFov (float FOV) } /// /// @brief .) +/// /// public void fn_setFrustumOffset (string offset) @@ -11823,7 +14762,10 @@ public void fn_setFrustumOffset (string offset) SafeNativeMethods.mwle_fn_setFrustumOffset(sboffset); } /// -/// Finds and activates the named light manager. @return Returns true if the light manager is found and activated. @ingroup Lighting ) +/// Finds and activates the named light manager. +/// @return Returns true if the light manager is found and activated. +/// @ingroup Lighting ) +/// /// public bool fn_setLightManager (string name) @@ -11837,7 +14779,22 @@ public bool fn_setLightManager (string name) return SafeNativeMethods.mwle_fn_setLightManager(sbname)>=1; } /// -/// @brief Determines how log files are written. Sets the operational mode of the console logging system. @param mode Parameter specifying the logging mode. This can be: - 1: Open and close the console log file for each seperate string of output. This will ensure that all parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. - 2: Keep the log file open and write to it continuously. This will make the system operate faster but if the process crashes, parts of the output may not have been written to disk yet and will be missing from the log. Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been issued to the console system into the newly created log file. @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. @ingroup Logging ) +/// @brief Determines how log files are written. +/// Sets the operational mode of the console logging system. +/// @param mode Parameter specifying the logging mode. This can be: +/// - 1: Open and close the console log file for each seperate string of output. This will ensure that all +/// parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. +/// - 2: Keep the log file open and write to it continuously. This will make the system operate faster but +/// if the process crashes, parts of the output may not have been written to disk yet and will be missing from +/// the log. +/// +/// Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be +/// combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been +/// issued to the console system into the newly created log file. +/// +/// @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. +/// @ingroup Logging ) +/// /// public void fn_setLogMode (int mode) @@ -11848,7 +14805,18 @@ public void fn_setLogMode (int mode) SafeNativeMethods.mwle_fn_setLogMode(mode); } /// -/// (int port, bool bind=true) @brief Set the network port for the game to use. @param port The port to use. @param bind True if bind() should be called on the port. @returns True if the port was successfully opened. This will trigger a windows firewall prompt. If you don't have firewall tunneling tech you can set this to false to avoid the prompt. @ingroup Networking) +/// (int port, bool bind=true) +/// @brief Set the network port for the game to use. +/// +/// @param port The port to use. +/// @param bind True if bind() should be called on the port. +/// +/// @returns True if the port was successfully opened. +/// +/// This will trigger a windows firewall prompt. +/// If you don't have firewall tunneling tech you can set this to false to avoid the prompt. +/// @ingroup Networking) +/// /// public bool fn_setNetPort (int port, bool bind) @@ -11859,7 +14827,15 @@ public bool fn_setNetPort (int port, bool bind) return SafeNativeMethods.mwle_fn_setNetPort(port, bind)>=1; } /// -/// @brief Sets the pixel shader version for the active device. This can be used to force a lower pixel shader version than is supported by the device for testing or performance optimization. @param version The floating point shader version number. @note This will only affect shaders/materials created after the call and should be used before the game begins. @see $pref::Video::forcedPixVersion @ingroup GFX ) +/// @brief Sets the pixel shader version for the active device. +/// This can be used to force a lower pixel shader version than is supported by +/// the device for testing or performance optimization. +/// @param version The floating point shader version number. +/// @note This will only affect shaders/materials created after the call +/// and should be used before the game begins. +/// @see $pref::Video::forcedPixVersion +/// @ingroup GFX ) +/// /// public void fn_setPixelShaderVersion (float version) @@ -11870,7 +14846,13 @@ public void fn_setPixelShaderVersion (float version) SafeNativeMethods.mwle_fn_setPixelShaderVersion(version); } /// -/// Set the current seed for the random number generator. Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to the same sequence of pseudo-random numbers. If -1, the current timestamp will be used as the seed which is a good basis for randomization. @ingroup Random ) +/// Set the current seed for the random number generator. +/// Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). +/// @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to +/// the same sequence of pseudo-random numbers. +/// If -1, the current timestamp will be used as the seed which is a good basis for randomization. +/// @ingroup Random ) +/// /// public void fn_setRandomSeed (int seed) @@ -11881,7 +14863,21 @@ public void fn_setRandomSeed (int seed) SafeNativeMethods.mwle_fn_setRandomSeed(seed); } /// -/// Replace the record in @a text at the given @a index with @a replacement. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to replace. @param replacement The string with which to replace the record. @return A new string with the record at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" @endtsexample @see getRecord @see setWord @see setField @ingroup FieldManip ) +/// Replace the record in @a text at the given @a index with @a replacement. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to replace. +/// @param replacement The string with which to replace the record. +/// @return A new string with the record at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see setWord +/// @see setField +/// @ingroup FieldManip ) +/// /// public string fn_setRecord (string text, int index, string replacement) @@ -11901,7 +14897,9 @@ public string fn_setRecord (string text, int index, string replacement) } /// -/// Set the reflection texture format. @ingroup GFX ) +/// Set the reflection texture format. +/// @ingroup GFX ) +/// /// public void fn_setReflectFormat (int format) @@ -11913,6 +14911,7 @@ public void fn_setReflectFormat (int format) } /// /// setServerInfo(...); ) +/// /// public bool fn_setServerInfo (uint index) @@ -11924,6 +14923,7 @@ public bool fn_setServerInfo (uint index) } /// /// ), string sShadowSystemName) +/// /// public bool fn_setShadowManager (string sShadowSystemName) @@ -11938,6 +14938,7 @@ public bool fn_setShadowManager (string sShadowSystemName) } /// /// ), ) +/// /// public string fn_setShadowVizLight (string name) @@ -11955,6 +14956,7 @@ public string fn_setShadowVizLight (string name) } /// /// settingObj.beginGroup(groupName, fromStart = false);) +/// /// public void fn_Settings_beginGroup (string settings, string groupName, bool includeDefaults) @@ -11972,6 +14974,7 @@ public void fn_Settings_beginGroup (string settings, string groupName, bool incl } /// /// settingObj.clearGroups();) +/// /// public void fn_Settings_clearGroups (string settings) @@ -11986,6 +14989,7 @@ public void fn_Settings_clearGroups (string settings) } /// /// settingObj.endGroup();) +/// /// public void fn_Settings_endGroup (string settings) @@ -12000,6 +15004,7 @@ public void fn_Settings_endGroup (string settings) } /// /// , false, false), settingObj.findFirstValue();) +/// /// public string fn_Settings_findFirstValue (string settings, string pattern, bool deepSearch, bool includeDefaults) @@ -12020,6 +15025,7 @@ public string fn_Settings_findFirstValue (string settings, string pattern, bool } /// /// settingObj.findNextValue();) +/// /// public string fn_Settings_findNextValue (string settings) @@ -12037,6 +15043,7 @@ public string fn_Settings_findNextValue (string settings) } /// /// settingObj.getCurrentGroups();) +/// /// public string fn_Settings_getCurrentGroups (string settings) @@ -12054,6 +15061,7 @@ public string fn_Settings_getCurrentGroups (string settings) } /// /// %success = settingObj.read();) +/// /// public bool fn_Settings_read (string settings) @@ -12068,6 +15076,7 @@ public bool fn_Settings_read (string settings) } /// /// settingObj.remove(settingName, includeDefaults = false);) +/// /// public void fn_Settings_remove (string settings, string settingName, bool includeDefaults) @@ -12085,6 +15094,7 @@ public void fn_Settings_remove (string settings, string settingName, bool includ } /// /// settingObj.setDefaultValue(settingName, value);) +/// /// public void fn_Settings_setDefaultValue (string settings, string settingName, string value) @@ -12105,6 +15115,7 @@ public void fn_Settings_setDefaultValue (string settings, string settingName, st } /// /// ), settingObj.setValue(settingName, value);) +/// /// public void fn_Settings_setValue (string settings, string settingName, string value) @@ -12125,6 +15136,7 @@ public void fn_Settings_setValue (string settings, string settingName, string va } /// /// ), settingObj.value(settingName, defaultValue);) +/// /// public string fn_Settings_value (string settings, string settingName, string defaultValue) @@ -12147,7 +15159,13 @@ public string fn_Settings_value (string settings, string settingName, string def } /// -/// (string varName, string value) @brief Sets the value of the named variable. @param varName Name of the variable to locate @param value New value of the variable @return True if variable was successfully found and set @ingroup Scripting) +/// (string varName, string value) +/// @brief Sets the value of the named variable. +/// @param varName Name of the variable to locate +/// @param value New value of the variable +/// @return True if variable was successfully found and set +/// @ingroup Scripting) +/// /// public void fn_setVariable (string varName, string value) @@ -12164,7 +15182,21 @@ public void fn_setVariable (string varName, string value) SafeNativeMethods.mwle_fn_setVariable(sbvarName, sbvalue); } /// -/// Replace the word in @a text at the given @a index with @a replacement. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to replace. @param replacement The string with which to replace the word. @return A new string with the word at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" @endtsexample @see getWord @see setField @see setRecord @ingroup FieldManip ) +/// Replace the word in @a text at the given @a index with @a replacement. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to replace. +/// @param replacement The string with which to replace the word. +/// @return A new string with the word at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" +/// @endtsexample +/// @see getWord +/// @see setField +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string fn_setWord (string text, int index, string replacement) @@ -12184,7 +15216,12 @@ public string fn_setWord (string text, int index, string replacement) } /// -/// @brief Set the zoom speed of the camera. This affects how quickly the camera changes from one field of view to another. @param speed The camera's zoom speed in ms per 90deg FOV change @ingroup CameraSystem) +/// @brief Set the zoom speed of the camera. +/// This affects how quickly the camera changes from one field of view +/// to another. +/// @param speed The camera's zoom speed in ms per 90deg FOV change +/// @ingroup CameraSystem) +/// /// public void fn_setZoomSpeed (int speed) @@ -12195,7 +15232,25 @@ public void fn_setZoomSpeed (int speed) SafeNativeMethods.mwle_fn_setZoomSpeed(speed); } /// -/// Try to create a new sound device using the given properties. If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, if this function fails, it will not restore the previously active device but rather leave the sound system in an uninitialized state. Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized playback and then resume normal playback once the device has been created. In the core scripts, sound is automatically set up during startup in the sfxStartup() function. @param provider The name of the device provider as returned by sfxGetAvailableDevices(). @param device The name of the device as returned by sfxGetAvailableDevices(). @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. @return True if the initialization was successful, false if not. @note This function must be called before any of the sound playback functions can be used. @see sfxGetAvailableDevices @see sfxGetDeviceInfo @see sfxDeleteDevice @ref SFX_devices @ingroup SFX ) +/// Try to create a new sound device using the given properties. +/// If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, +/// if this function fails, it will not restore the previously active device but rather leave the sound system in an +/// uninitialized state. +/// Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized +/// playback and then resume normal playback once the device has been created. +/// In the core scripts, sound is automatically set up during startup in the sfxStartup() function. +/// @param provider The name of the device provider as returned by sfxGetAvailableDevices(). +/// @param device The name of the device as returned by sfxGetAvailableDevices(). +/// @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. +/// @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. +/// @return True if the initialization was successful, false if not. +/// @note This function must be called before any of the sound playback functions can be used. +/// @see sfxGetAvailableDevices +/// @see sfxGetDeviceInfo +/// @see sfxDeleteDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public bool fn_sfxCreateDevice (string provider, string device, bool useHardware, int maxBuffers) @@ -12212,7 +15267,13 @@ public bool fn_sfxCreateDevice (string provider, string device, bool useHardware return SafeNativeMethods.mwle_fn_sfxCreateDevice(sbprovider, sbdevice, useHardware, maxBuffers)>=1; } /// -/// , , , ), ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) Creates a new paused sound source using a profile or a description and filename. The return value is the source which must be released by delete(). @hide ) +/// , , , ), +/// ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) +/// Creates a new paused sound source using a profile or a description +/// and filename. The return value is the source which must be +/// released by delete(). +/// @hide ) +/// /// public int fn_sfxCreateSource (string SFXType, string filename, string x, string y, string z) @@ -12238,7 +15299,14 @@ public int fn_sfxCreateSource (string SFXType, string filename, string x, string return SafeNativeMethods.mwle_fn_sfxCreateSource(sbSFXType, sbfilename, sbx, sby, sbz); } /// -/// Delete the currently active sound device and release all its resources. SFXSources that are still playing will be transitioned to virtualized playback mode. When creating a new device, they will automatically transition back to normal playback. In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. @see sfxCreateDevice @ref SFX_devices @ingroup SFX ) +/// Delete the currently active sound device and release all its resources. +/// SFXSources that are still playing will be transitioned to virtualized playback mode. +/// When creating a new device, they will automatically transition back to normal playback. +/// In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. +/// @see sfxCreateDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public void fn_sfxDeleteDevice () @@ -12250,7 +15318,11 @@ public void fn_sfxDeleteDevice () SafeNativeMethods.mwle_fn_sfxDeleteDevice(); } /// -/// Mark the given @a source for deletion as soon as it moves into stopped state. This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). @param source A sound source. @ingroup SFX ) +/// Mark the given @a source for deletion as soon as it moves into stopped state. +/// This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). +/// @param source A sound source. +/// @ingroup SFX ) +/// /// public void fn_sfxDeleteWhenStopped (string source) @@ -12264,7 +15336,14 @@ public void fn_sfxDeleteWhenStopped (string source) SafeNativeMethods.mwle_fn_sfxDeleteWhenStopped(sbsource); } /// -/// Dump information about all current SFXSource instances to the console. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @see SFXSource @see sfxDumpSourcesToString @ingroup SFX ) +/// Dump information about all current SFXSource instances to the console. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @see SFXSource +/// @see sfxDumpSourcesToString +/// @ingroup SFX ) +/// /// public void fn_sfxDumpSources (bool includeGroups) @@ -12275,7 +15354,15 @@ public void fn_sfxDumpSources (bool includeGroups) SafeNativeMethods.mwle_fn_sfxDumpSources(includeGroups); } /// -/// Dump information about all current SFXSource instances to a string. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @return A string containing a dump of information about all currently instantiated SFXSources. @see SFXSource @see sfxDumpSources @ingroup SFX ) +/// Dump information about all current SFXSource instances to a string. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @return A string containing a dump of information about all currently instantiated SFXSources. +/// @see SFXSource +/// @see sfxDumpSources +/// @ingroup SFX ) +/// /// public string fn_sfxDumpSourcesToString (bool includeGroups) @@ -12289,7 +15376,19 @@ public string fn_sfxDumpSourcesToString (bool includeGroups) } /// -/// Return a newline-separated list of all active states. @return A list of the form @verbatim stateName1 NL stateName2 NL stateName3 ... @endverbatim where each element is the name of an active state object. @tsexample // Disable all active states. foreach$( %state in sfxGetActiveStates() ) %state.disable(); @endtsexample @ingroup SFX ) +/// Return a newline-separated list of all active states. +/// @return A list of the form +/// @verbatim +/// stateName1 NL stateName2 NL stateName3 ... +/// @endverbatim +/// where each element is the name of an active state object. +/// @tsexample +/// // Disable all active states. +/// foreach$( %state in sfxGetActiveStates() ) +/// %state.disable(); +/// @endtsexample +/// @ingroup SFX ) +/// /// public string fn_sfxGetActiveStates () @@ -12304,7 +15403,29 @@ public string fn_sfxGetActiveStates () } /// -/// Get a list of all available sound devices. The return value will be a newline-separated list of entries where each line describes one available sound device. Each such line will have the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. @return A newline-separated list of information about all available sound devices. @see sfxCreateDevice @see sfxGetDeviceInfo @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @ref SFX_devices @ingroup SFX ) +/// Get a list of all available sound devices. +/// The return value will be a newline-separated list of entries where each line describes one available sound +/// device. Each such line will have the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// @return A newline-separated list of information about all available sound devices. +/// @see sfxCreateDevice +/// @see sfxGetDeviceInfo +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string fn_sfxGetAvailableDevices () @@ -12319,7 +15440,36 @@ public string fn_sfxGetAvailableDevices () } /// -/// Return information about the currently active sound device. The return value is a tab-delimited string of the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. - caps: A bitfield of capability flags. @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. @see sfxCreateDevice @see sfxGetAvailableDevices @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @see $SFX::DEVICE_INFO_CAPS @see $SFX::DEVICE_CAPS_REVERB @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT @see $SFX::DEVICE_CAPS_OCCLUSION @see $SFX::DEVICE_CAPS_DSPEFFECTS @see $SFX::DEVICE_CAPS_MULTILISTENER @see $SFX::DEVICE_CAPS_FMODDESIGNER @ref SFX_devices @ingroup SFX ) +/// Return information about the currently active sound device. +/// The return value is a tab-delimited string of the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// - caps: A bitfield of capability flags. +/// @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. +/// @see sfxCreateDevice +/// @see sfxGetAvailableDevices +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @see $SFX::DEVICE_INFO_CAPS +/// @see $SFX::DEVICE_CAPS_REVERB +/// @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT +/// @see $SFX::DEVICE_CAPS_OCCLUSION +/// @see $SFX::DEVICE_CAPS_DSPEFFECTS +/// @see $SFX::DEVICE_CAPS_MULTILISTENER +/// @see $SFX::DEVICE_CAPS_FMODDESIGNER +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string fn_sfxGetDeviceInfo () @@ -12334,7 +15484,12 @@ public string fn_sfxGetDeviceInfo () } /// -/// Get the falloff curve type currently being applied to 3D sounds. @return The current distance model type. @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the falloff curve type currently being applied to 3D sounds. +/// @return The current distance model type. +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public int fn_sfxGetDistanceModel () @@ -12346,7 +15501,12 @@ public int fn_sfxGetDistanceModel () return SafeNativeMethods.mwle_fn_sfxGetDistanceModel(); } /// -/// Get the current global doppler effect setting. @return The current global doppler effect scale factor (>=0). @see sfxSetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Get the current global doppler effect setting. +/// @return The current global doppler effect scale factor (>=0). +/// @see sfxSetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public float fn_sfxGetDopplerFactor () @@ -12358,7 +15518,14 @@ public float fn_sfxGetDopplerFactor () return SafeNativeMethods.mwle_fn_sfxGetDopplerFactor(); } /// -/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. @return The current scale factor for logarithmic 3D sound falloff curves. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. +/// @return The current scale factor for logarithmic 3D sound falloff curves. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public float fn_sfxGetRolloffFactor () @@ -12370,7 +15537,10 @@ public float fn_sfxGetRolloffFactor () return SafeNativeMethods.mwle_fn_sfxGetRolloffFactor(); } /// -/// , , ), Start playing the given source or create a new source for the given track and play it. @hide ) +/// , , ), +/// Start playing the given source or create a new source for the given track and play it. +/// @hide ) +/// /// public int fn_sfxPlay (string trackName, string pointOrX, string y, string z) @@ -12393,7 +15563,11 @@ public int fn_sfxPlay (string trackName, string pointOrX, string y, string z) return SafeNativeMethods.mwle_fn_sfxPlay(sbtrackName, sbpointOrX, sby, sbz); } /// -/// , , , -1.0f), SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) Create a new play-once source for the given profile or description+filename and start playback of the source. @hide ) +/// , , , -1.0f), +/// SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) +/// Create a new play-once source for the given profile or description+filename and start playback of the source. +/// @hide ) +/// /// public int fn_sfxPlayOnce (string SFXType, string filename, string x, string y, string z, float fadeInTime) @@ -12419,7 +15593,11 @@ public int fn_sfxPlayOnce (string SFXType, string filename, string x, string y, return SafeNativeMethods.mwle_fn_sfxPlayOnce(sbSFXType, sbfilename, sbx, sby, sbz, fadeInTime); } /// -/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. @param model The distance model to use for 3D sound. @note This setting takes effect globally and is applied to all 3D sounds. @ingroup SFX ) +/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. +/// @param model The distance model to use for 3D sound. +/// @note This setting takes effect globally and is applied to all 3D sounds. +/// @ingroup SFX ) +/// /// public void fn_sfxSetDistanceModel (int model) @@ -12430,7 +15608,13 @@ public void fn_sfxSetDistanceModel (int model) SafeNativeMethods.mwle_fn_sfxSetDistanceModel(model); } /// -/// Set the global doppler effect scale factor. @param value The new doppler shift scale factor. @pre @a value must be >= 0. @see sfxGetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Set the global doppler effect scale factor. +/// @param value The new doppler shift scale factor. +/// @pre @a value must be >= 0. +/// @see sfxGetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public void fn_sfxSetDopplerFactor (float value) @@ -12441,7 +15625,16 @@ public void fn_sfxSetDopplerFactor (float value) SafeNativeMethods.mwle_fn_sfxSetDopplerFactor(value); } /// -/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. @param value The new scale factor for logarithmic 3D sound falloff curves. @pre @a value must be > 0. @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. +/// @param value The new scale factor for logarithmic 3D sound falloff curves. +/// @pre @a value must be > 0. +/// @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public void fn_sfxSetRolloffFactor (float value) @@ -12452,7 +15645,11 @@ public void fn_sfxSetRolloffFactor (float value) SafeNativeMethods.mwle_fn_sfxSetRolloffFactor(value); } /// -/// ), ( vector position [, vector direction ] ) Set the position and orientation of a 3D sound source. @hide ) +/// ), +/// ( vector position [, vector direction ] ) +/// Set the position and orientation of a 3D sound source. +/// @hide ) +/// /// public void fn_SFXSource_setTransform (string sfxsource, string position, string direction) @@ -12472,7 +15669,11 @@ public void fn_SFXSource_setTransform (string sfxsource, string position, string SafeNativeMethods.mwle_fn_SFXSource_setTransform(sbsfxsource, sbposition, sbdirection); } /// -/// Stop playback of the given @a source. This is equivalent to calling SFXSource::stop(). @param source The source to put into stopped state. @ingroup SFX ) +/// Stop playback of the given @a source. +/// This is equivalent to calling SFXSource::stop(). +/// @param source The source to put into stopped state. +/// @ingroup SFX ) +/// /// public void fn_sfxStop (string source) @@ -12486,7 +15687,15 @@ public void fn_sfxStop (string source) SafeNativeMethods.mwle_fn_sfxStop(sbsource); } /// -/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. The advantage of this function over directly calling delete() is that it will correctly handle volume fades that may be configured on the source. Whereas calling delete() would immediately stop playback and delete the source, this functionality will wait for the fade-out to play and only then stop the source and delete it. @param source A sound source. @ref SFXSource_fades @ingroup SFX ) +/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. +/// The advantage of this function over directly calling delete() is that it will correctly +/// handle volume fades that may be configured on the source. Whereas calling delete() would immediately +/// stop playback and delete the source, this functionality will wait for the fade-out to play and only then +/// stop the source and delete it. +/// @param source A sound source. +/// @ref SFXSource_fades +/// @ingroup SFX ) +/// /// public void fn_sfxStopAndDelete (string source) @@ -12500,7 +15709,13 @@ public void fn_sfxStopAndDelete (string source) SafeNativeMethods.mwle_fn_sfxStopAndDelete(sbsource); } /// -/// , ), (string executable, string args, string directory) @brief Launches an outside executable or batch file @param executable Name of the executable or batch file @param args Optional list of arguments, in string format, to pass to the executable @param directory Optional string containing path to output or shell @ingroup Platform) +/// , ), (string executable, string args, string directory) +/// @brief Launches an outside executable or batch file +/// @param executable Name of the executable or batch file +/// @param args Optional list of arguments, in string format, to pass to the executable +/// @param directory Optional string containing path to output or shell +/// @ingroup Platform) +/// /// public bool fn_shellExecute (string executable, string args, string directory) @@ -12520,7 +15735,10 @@ public bool fn_shellExecute (string executable, string args, string directory) return SafeNativeMethods.mwle_fn_shellExecute(sbexecutable, sbargs, sbdirectory)>=1; } /// -/// (idx) Get the component corresponding to the given index. @param idx An integer index value corresponding to the desired component. @return The id of the component at the given index as an integer) +/// (idx) Get the component corresponding to the given index. +/// @param idx An integer index value corresponding to the desired component. +/// @return The id of the component at the given index as an integer) +/// /// public int fn_SimComponent_getComponent (string simcomponent, int idx) @@ -12534,7 +15752,9 @@ public int fn_SimComponent_getComponent (string simcomponent, int idx) return SafeNativeMethods.mwle_fn_SimComponent_getComponent(sbsimcomponent, idx); } /// -/// () Get the current component count @return The number of components in the list as an integer) +/// () Get the current component count +/// @return The number of components in the list as an integer) +/// /// public int fn_SimComponent_getComponentCount (string simcomponent) @@ -12548,7 +15768,9 @@ public int fn_SimComponent_getComponentCount (string simcomponent) return SafeNativeMethods.mwle_fn_SimComponent_getComponentCount(sbsimcomponent); } /// -/// () Check whether SimComponent is currently a template @return true if is a template and false if not) +/// () Check whether SimComponent is currently a template +/// @return true if is a template and false if not) +/// /// public bool fn_SimComponent_getIsTemplate (string simcomponent) @@ -12562,7 +15784,9 @@ public bool fn_SimComponent_getIsTemplate (string simcomponent) return SafeNativeMethods.mwle_fn_SimComponent_getIsTemplate(sbsimcomponent)>=1; } /// -/// () Check whether SimComponent is currently enabled @return true if enabled and false if not) +/// () Check whether SimComponent is currently enabled +/// @return true if enabled and false if not) +/// /// public bool fn_SimComponent_isEnabled (string simcomponent) @@ -12576,7 +15800,10 @@ public bool fn_SimComponent_isEnabled (string simcomponent) return SafeNativeMethods.mwle_fn_SimComponent_isEnabled(sbsimcomponent)>=1; } /// -/// (enabled) Sets or unsets the enabled flag @param enabled Boolean value @return No return value) +/// (enabled) Sets or unsets the enabled flag +/// @param enabled Boolean value +/// @return No return value) +/// /// public void fn_SimComponent_setEnabled (string simcomponent, bool enabled) @@ -12590,7 +15817,10 @@ public void fn_SimComponent_setEnabled (string simcomponent, bool enabled) SafeNativeMethods.mwle_fn_SimComponent_setEnabled(sbsimcomponent, enabled); } /// -/// (template) Sets or unsets the template flag @param template Boolean value @return No return value) +/// (template) Sets or unsets the template flag +/// @param template Boolean value +/// @return No return value) +/// /// public void fn_SimComponent_setIsTemplate (string simcomponent, bool templateFlag) @@ -12605,6 +15835,7 @@ public void fn_SimComponent_setIsTemplate (string simcomponent, bool templateFla } /// /// Reload the datablock. This can only be used with a local client configuration. ) +/// /// public void fn_SimDataBlock_reloadOnLocalClient (string simdatablock) @@ -13237,6 +16468,7 @@ public void fn_SimObject_setSuperClassNamespace (string simobject, string name) } /// /// () - Try to bind unresolved persistent IDs in the set. ) +/// /// public void fn_SimPersistSet_resolvePersistentIds (string simpersistset) @@ -13251,6 +16483,7 @@ public void fn_SimPersistSet_resolvePersistentIds (string simpersistset) } /// /// addPoint( F32 value, F32 time ) ) +/// /// public void fn_SimResponseCurve_addPoint (string simresponsecurve, float value, float time) @@ -13265,6 +16498,7 @@ public void fn_SimResponseCurve_addPoint (string simresponsecurve, float value, } /// /// clear() ) +/// /// public void fn_SimResponseCurve_clear (string simresponsecurve) @@ -13279,6 +16513,7 @@ public void fn_SimResponseCurve_clear (string simresponsecurve) } /// /// getValue( F32 time ) ) +/// /// public float fn_SimResponseCurve_getValue (string simresponsecurve, float time) @@ -13293,6 +16528,7 @@ public float fn_SimResponseCurve_getValue (string simresponsecurve, float time) } /// /// () Delete all objects in the set. ) +/// /// public void fn_SimSet_deleteAllObjects (string simset) @@ -13306,7 +16542,9 @@ public void fn_SimSet_deleteAllObjects (string simset) SafeNativeMethods.mwle_fn_SimSet_deleteAllObjects(sbsimset); } /// -/// () Get the number of direct and indirect child objects contained in the set. @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// () Get the number of direct and indirect child objects contained in the set. +/// @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// /// public int fn_SimSet_getFullCount (string simset) @@ -13320,7 +16558,9 @@ public int fn_SimSet_getFullCount (string simset) return SafeNativeMethods.mwle_fn_SimSet_getFullCount(sbsimset); } /// -/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. +/// @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// /// public void fn_SimSet_sort (string simset, string callbackFunction) @@ -13337,7 +16577,12 @@ public void fn_SimSet_sort (string simset, string callbackFunction) SafeNativeMethods.mwle_fn_SimSet_sort(sbsimset, sbcallbackFunction); } /// -/// (string attributeName) @brief Get float attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of a float. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get float attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of a float. +/// @deprecated Use attribute().) +/// /// public float fn_SimXMLDocument_attributeF32 (string simxmldocument, string attributeName) @@ -13354,7 +16599,12 @@ public float fn_SimXMLDocument_attributeF32 (string simxmldocument, string attri return SafeNativeMethods.mwle_fn_SimXMLDocument_attributeF32(sbsimxmldocument, sbattributeName); } /// -/// (string attributeName) @brief Get int attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of an integer. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get int attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of an integer. +/// @deprecated Use attribute().) +/// /// public int fn_SimXMLDocument_attributeS32 (string simxmldocument, string attributeName) @@ -13371,7 +16621,11 @@ public int fn_SimXMLDocument_attributeS32 (string simxmldocument, string attribu return SafeNativeMethods.mwle_fn_SimXMLDocument_attributeS32(sbsimxmldocument, sbattributeName); } /// -/// @brief Determines the memory consumption of a class or object. @param objectOrClass The object or class being measured. @return Returns the total size of an object in bytes. @ingroup Debugging) +/// @brief Determines the memory consumption of a class or object. +/// @param objectOrClass The object or class being measured. +/// @return Returns the total size of an object in bytes. +/// @ingroup Debugging) +/// /// public int fn_sizeof (string objectOrClass) @@ -13386,6 +16640,7 @@ public int fn_sizeof (string objectOrClass) } /// /// ) +/// /// public void fn_SkyBox_postApply (string skybox) @@ -13399,7 +16654,25 @@ public void fn_SkyBox_postApply (string skybox) SafeNativeMethods.mwle_fn_SkyBox_postApply(sbskybox); } /// -/// @brief Prevents mouse movement from being processed In the source, whenever a mouse move event occurs GameTSCtrl::onMouseMove() is called. Whenever snapToggle() is called, it will flag a variable that can prevent this from happening: gSnapLine. This variable is not exposed to script, so you need to call this function to trigger it. @tsexample // Snapping is off by default, so we will toggle // it on first: PlayGui.snapToggle(); // Mouse movement should be disabled // Let's turn it back on PlayGui.snapToggle(); @endtsexample @ingroup GuiGame) +/// @brief Prevents mouse movement from being processed +/// +/// In the source, whenever a mouse move event occurs +/// GameTSCtrl::onMouseMove() is called. Whenever snapToggle() +/// is called, it will flag a variable that can prevent this +/// from happening: gSnapLine. This variable is not exposed to +/// script, so you need to call this function to trigger it. +/// +/// @tsexample +/// // Snapping is off by default, so we will toggle +/// // it on first: +/// PlayGui.snapToggle(); +/// // Mouse movement should be disabled +/// // Let's turn it back on +/// PlayGui.snapToggle(); +/// @endtsexample +/// +/// @ingroup GuiGame) +/// /// public void fn_snapToggle () @@ -13411,7 +16684,9 @@ public void fn_snapToggle () SafeNativeMethods.mwle_fn_snapToggle(); } /// -/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) @hide) +/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) +/// @hide) +/// /// public int fn_spawnObject (string spawnClass, string spawnDataBlock, string spawnName, string spawnProperties, string spawnScript, string modelName) @@ -13440,7 +16715,11 @@ public int fn_spawnObject (string spawnClass, string spawnDataBlock, string spaw return SafeNativeMethods.mwle_fn_spawnObject(sbspawnClass, sbspawnDataBlock, sbspawnName, sbspawnProperties, sbspawnScript, sbmodelName); } /// -/// ([string additionalProps]) Spawns the object based on the SpawnSphere's class, datablock, properties, and script settings. Allows you to pass in extra properties. @hide ) +/// ([string additionalProps]) Spawns the object based on the SpawnSphere's +/// class, datablock, properties, and script settings. Allows you to pass in +/// extra properties. +/// @hide ) +/// /// public int fn_SpawnSphere_spawnObject (string spawnsphere, string additionalProps) @@ -13457,7 +16736,14 @@ public int fn_SpawnSphere_spawnObject (string spawnsphere, string additionalProp return SafeNativeMethods.mwle_fn_SpawnSphere_spawnObject(sbspawnsphere, sbadditionalProps); } /// -/// Activates the shape replicator. @tsexample // Call the function StartClientReplication() @endtsexample @ingroup Foliage ) +/// Activates the shape replicator. +/// @tsexample +/// // Call the function +/// StartClientReplication() +/// @endtsexample +/// @ingroup Foliage +/// ) +/// /// public void fn_StartClientReplication () @@ -13469,7 +16755,11 @@ public void fn_StartClientReplication () SafeNativeMethods.mwle_fn_StartClientReplication(); } /// -/// @brief Start watching resources for file changes Typically this is called during initializeCore(). @see stopFileChangeNotifications() @ingroup FileSystem) +/// @brief Start watching resources for file changes +/// Typically this is called during initializeCore(). +/// @see stopFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void fn_startFileChangeNotifications () @@ -13481,7 +16771,13 @@ public void fn_startFileChangeNotifications () SafeNativeMethods.mwle_fn_startFileChangeNotifications(); } /// -/// Activates the foliage replicator. @tsexample // Call the function StartFoliageReplication(); @endtsexample @ingroup Foliage) +/// Activates the foliage replicator. +/// @tsexample +/// // Call the function +/// StartFoliageReplication(); +/// @endtsexample +/// @ingroup Foliage) +/// /// public void fn_StartFoliageReplication () @@ -13494,6 +16790,7 @@ public void fn_StartFoliageReplication () } /// /// startHeartbeat(...); ) +/// /// public void fn_startHeartbeat () @@ -13506,6 +16803,7 @@ public void fn_startHeartbeat () } /// /// startPrecisionTimer() - Create and start a high resolution platform timer. Returns the timer id. ) +/// /// public int fn_startPrecisionTimer () @@ -13517,7 +16815,18 @@ public int fn_startPrecisionTimer () return SafeNativeMethods.mwle_fn_startPrecisionTimer(); } /// -/// Test whether the given string begins with the given prefix. @param str The string to test. @param prefix The potential prefix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. @tsexample startsWith( \"TEST123\", \"test\" ) // Returns true. @endtsexample @see endsWith @ingroup Strings ) +/// Test whether the given string begins with the given prefix. +/// @param str The string to test. +/// @param prefix The potential prefix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"test\" ) // Returns true. +/// @endtsexample +/// @see endsWith +/// @ingroup Strings ) +/// /// public bool fn_startsWith (string str, string prefix, bool caseSensitive) @@ -13534,7 +16843,11 @@ public bool fn_startsWith (string str, string prefix, bool caseSensitive) return SafeNativeMethods.mwle_fn_startsWith(sbstr, sbprefix, caseSensitive)>=1; } /// -/// THEORA, 30.0f, Point2I::Zero ), Begins a video capture session. @see stopVideoCapture @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Begins a video capture session. +/// @see stopVideoCapture +/// @ingroup Rendering ) +/// /// public void fn_startVideoCapture (string canvas, string filename, string encoder, float framerate, string resolution) @@ -13558,6 +16871,7 @@ public void fn_startVideoCapture (string canvas, string filename, string encoder } /// /// @internal) +/// /// public bool fn_StaticShape_getPoweredState (string staticshape) @@ -13571,7 +16885,9 @@ public bool fn_StaticShape_getPoweredState (string staticshape) return SafeNativeMethods.mwle_fn_StaticShape_getPoweredState(sbstaticshape)>=1; } /// -/// (bool isPowered) @internal) +/// (bool isPowered) +/// @internal) +/// /// public void fn_StaticShape_setPoweredState (string staticshape, bool isPowered) @@ -13585,7 +16901,11 @@ public void fn_StaticShape_setPoweredState (string staticshape, bool isPowered) SafeNativeMethods.mwle_fn_StaticShape_setPoweredState(sbstaticshape, isPowered); } /// -/// @brief Stop watching resources for file changes Typically this is called during shutdownCore(). @see startFileChangeNotifications() @ingroup FileSystem) +/// @brief Stop watching resources for file changes +/// Typically this is called during shutdownCore(). +/// @see startFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void fn_stopFileChangeNotifications () @@ -13598,6 +16918,7 @@ public void fn_stopFileChangeNotifications () } /// /// stopHeartbeat(...); ) +/// /// public void fn_stopHeartbeat () @@ -13610,6 +16931,7 @@ public void fn_stopHeartbeat () } /// /// stopPrecisionTimer( S32 id ) - Stop and destroy timer with the passed id. Returns the elapsed milliseconds. ) +/// /// public int fn_stopPrecisionTimer (int id) @@ -13620,7 +16942,10 @@ public int fn_stopPrecisionTimer (int id) return SafeNativeMethods.mwle_fn_stopPrecisionTimer(id); } /// -/// () @brief Stops the rendering sampler @ingroup Rendering) +/// () +/// @brief Stops the rendering sampler +/// @ingroup Rendering) +/// /// public void fn_stopSampling () @@ -13633,6 +16958,7 @@ public void fn_stopSampling () } /// /// stopServerQuery(...); ) +/// /// public void fn_stopServerQuery () @@ -13644,7 +16970,10 @@ public void fn_stopServerQuery () SafeNativeMethods.mwle_fn_stopServerQuery(); } /// -/// Stops the video capture session. @see startVideoCapture @ingroup Rendering ) +/// Stops the video capture session. +/// @see startVideoCapture +/// @ingroup Rendering ) +/// /// public void fn_stopVideoCapture () @@ -13656,7 +16985,11 @@ public void fn_stopVideoCapture () SafeNativeMethods.mwle_fn_stopVideoCapture(); } /// -/// Return the integer character code value corresponding to the first character in the given string. @param chr a (one-character) string. @return the UTF32 code value for the first character in the given string. @ingroup Strings ) +/// Return the integer character code value corresponding to the first character in the given string. +/// @param chr a (one-character) string. +/// @return the UTF32 code value for the first character in the given string. +/// @ingroup Strings ) +/// /// public int fn_strasc (string chr) @@ -13670,7 +17003,13 @@ public int fn_strasc (string chr) return SafeNativeMethods.mwle_fn_strasc(sbchr); } /// -/// Find the first occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strrchr @ingroup Strings ) +/// Find the first occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strrchr +/// @ingroup Strings ) +/// /// public string fn_strchr (string str, string chr) @@ -13690,7 +17029,16 @@ public string fn_strchr (string str, string chr) } /// -/// Find the first occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strchrpos( \"test\", \"s\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the first occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strchrpos( \"test\", \"s\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strchrpos (string str, string chr, int start) @@ -13707,7 +17055,19 @@ public int fn_strchrpos (string str, string chr, int start) return SafeNativeMethods.mwle_fn_strchrpos(sbstr, sbchr, start); } /// -/// Compares two strings using case-b>sensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >1 otherwise. @tsexample if( strcmp( %var, \"foobar\" ) == 0 ) echo( \"%var is equal to 'foobar'\" ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using case-b>sensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >1 otherwise. +/// @tsexample +/// if( strcmp( %var, \"foobar\" ) == 0 ) +/// echo( \"%var is equal to 'foobar'\" ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int fn_strcmp (string str1, string str2) @@ -13724,7 +17084,16 @@ public int fn_strcmp (string str1, string str2) return SafeNativeMethods.mwle_fn_strcmp(sbstr1, sbstr2); } /// -/// Format the given value as a string using printf-style formatting. @param format A printf-style format string. @param value The value argument matching the given format string. @tsexample // Convert the given integer value to a string in a hex notation. %hex = strformat( \"%x\", %value ); @endtsexample @ingroup Strings @see http://en.wikipedia.org/wiki/Printf ) +/// Format the given value as a string using printf-style formatting. +/// @param format A printf-style format string. +/// @param value The value argument matching the given format string. +/// @tsexample +/// // Convert the given integer value to a string in a hex notation. +/// %hex = strformat( \"%x\", %value ); +/// @endtsexample +/// @ingroup Strings +/// @see http://en.wikipedia.org/wiki/Printf ) +/// /// public string fn_strformat (string format, string value) @@ -13744,7 +17113,19 @@ public string fn_strformat (string format, string value) } /// -/// Compares two strings using case-b>insensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >0 otherwise. @tsexample if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) echo( \"this is always true\" ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using case-b>insensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >0 otherwise. +/// @tsexample +/// if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) +/// echo( \"this is always true\" ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int fn_stricmp (string str1, string str2) @@ -13761,7 +17142,35 @@ public int fn_stricmp (string str1, string str2) return SafeNativeMethods.mwle_fn_stricmp(sbstr1, sbstr2); } /// -/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int fn_strinatcmp (string str1, string str2) @@ -13778,7 +17187,15 @@ public int fn_strinatcmp (string str1, string str2) return SafeNativeMethods.mwle_fn_strinatcmp(sbstr1, sbstr2); } /// -/// Remove all occurrences of characters contained in @a chars from @a str. @param str The string to filter characters out from. @param chars A string of characters to filter out from @a str. @return A version of @a str with all occurrences of characters contained in @a chars filtered out. @tsexample stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". @endtsexample @ingroup Strings ) +/// Remove all occurrences of characters contained in @a chars from @a str. +/// @param str The string to filter characters out from. +/// @param chars A string of characters to filter out from @a str. +/// @return A version of @a str with all occurrences of characters contained in @a chars filtered out. +/// @tsexample +/// stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_stripChars (string str, string chars) @@ -13798,7 +17215,18 @@ public string fn_stripChars (string str, string chars) } /// -/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. @param inString String to strip TorqueML control characters from. @tsexample // Define the string to strip TorqueML control characters from %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; // Request the stripped version of the string %strippedString = StripMLControlChars(%string); @endtsexample @return Version of the inputted string with all TorqueML characters removed. @see References @ingroup GuiCore) +/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. +/// @param inString String to strip TorqueML control characters from. +/// @tsexample +/// // Define the string to strip TorqueML control characters from +/// %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; +/// // Request the stripped version of the string +/// %strippedString = StripMLControlChars(%string); +/// @endtsexample +/// @return Version of the inputted string with all TorqueML characters removed. +/// @see References +/// @ingroup GuiCore) +/// /// public string fn_StripMLControlChars (string inString) @@ -13815,7 +17243,15 @@ public string fn_StripMLControlChars (string inString) } /// -/// Strip a numeric suffix from the given string. @param str The string from which to strip its numeric suffix. @return The string @a str without its number suffix or the original string @a str if it has no such suffix. @tsexample stripTrailingNumber( \"test123\" ) // Returns \"test\". @endtsexample @see getTrailingNumber @ingroup Strings ) +/// Strip a numeric suffix from the given string. +/// @param str The string from which to strip its numeric suffix. +/// @return The string @a str without its number suffix or the original string @a str if it has no such suffix. +/// @tsexample +/// stripTrailingNumber( \"test123\" ) // Returns \"test\". +/// @endtsexample +/// @see getTrailingNumber +/// @ingroup Strings ) +/// /// public string fn_stripTrailingNumber (string str) @@ -13832,7 +17268,19 @@ public string fn_stripTrailingNumber (string str) } /// -/// Match a pattern against a string. @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match any number of characters and '?' to match a single character. @param str The string which should be matched against @a pattern. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches the given @a pattern. @tsexample strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. @endtsexample @see strIsMatchMultipleExpr @ingroup Strings ) +/// Match a pattern against a string. +/// @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match +/// any number of characters and '?' to match a single character. +/// @param str The string which should be matched against @a pattern. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches the given @a pattern. +/// @tsexample +/// strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchMultipleExpr +/// @ingroup Strings ) +/// /// public bool fn_strIsMatchExpr (string pattern, string str, bool caseSensitive) @@ -13849,7 +17297,19 @@ public bool fn_strIsMatchExpr (string pattern, string str, bool caseSensitive) return SafeNativeMethods.mwle_fn_strIsMatchExpr(sbpattern, sbstr, caseSensitive)>=1; } /// -/// Match a multiple patterns against a single string. @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match any number of characters and '?' to match a single character. Each of the patterns is tried in turn. @param str The string which should be matched against @a patterns. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches any of the given @a patterns. @tsexample strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. @endtsexample @see strIsMatchExpr @ingroup Strings ) +/// Match a multiple patterns against a single string. +/// @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match +/// any number of characters and '?' to match a single character. Each of the patterns is tried in turn. +/// @param str The string which should be matched against @a patterns. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches any of the given @a patterns. +/// @tsexample +/// strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Strings ) +/// /// public bool fn_strIsMatchMultipleExpr (string patterns, string str, bool caseSensitive) @@ -13866,7 +17326,12 @@ public bool fn_strIsMatchMultipleExpr (string patterns, string str, bool caseSen return SafeNativeMethods.mwle_fn_strIsMatchMultipleExpr(sbpatterns, sbstr, caseSensitive)>=1; } /// -/// Get the length of the given string in bytes. @note This does b>not/b> return a true character count for strings with multi-byte characters! @param str A string. @return The length of the given string in bytes. @ingroup Strings ) +/// Get the length of the given string in bytes. +/// @note This does b>not/b> return a true character count for strings with multi-byte characters! +/// @param str A string. +/// @return The length of the given string in bytes. +/// @ingroup Strings ) +/// /// public int fn_strlen (string str) @@ -13880,7 +17345,15 @@ public int fn_strlen (string str) return SafeNativeMethods.mwle_fn_strlen(sbstr); } /// -/// Return an all lower-case version of the given string. @param str A string. @return A version of @a str with all characters converted to lower-case. @tsexample strlwr( \"TesT1\" ) // Returns \"test1\" @endtsexample @see strupr @ingroup Strings ) +/// Return an all lower-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to lower-case. +/// @tsexample +/// strlwr( \"TesT1\" ) // Returns \"test1\" +/// @endtsexample +/// @see strupr +/// @ingroup Strings ) +/// /// public string fn_strlwr (string str) @@ -13897,7 +17370,35 @@ public string fn_strlwr (string str) } /// -/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int fn_strnatcmp (string str1, string str2) @@ -13914,7 +17415,15 @@ public int fn_strnatcmp (string str1, string str2) return SafeNativeMethods.mwle_fn_strnatcmp(sbstr1, sbstr2); } /// -/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. @param haystack The string to search. @param needle The string to search for. @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. @tsexample strpos( \"b ab\", \"b\", 1 ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. +/// @param haystack The string to search. +/// @param needle The string to search for. +/// @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. +/// @tsexample +/// strpos( \"b ab\", \"b\", 1 ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strpos (string haystack, string needle, int offset) @@ -13931,7 +17440,13 @@ public int fn_strpos (string haystack, string needle, int offset) return SafeNativeMethods.mwle_fn_strpos(sbhaystack, sbneedle, offset); } /// -/// Find the last occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strchr @ingroup Strings ) +/// Find the last occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strchr +/// @ingroup Strings ) +/// /// public string fn_strrchr (string str, string chr) @@ -13951,7 +17466,16 @@ public string fn_strrchr (string str, string chr) } /// -/// Find the last occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strrchrpos( \"test\", \"t\" ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the last occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strrchrpos( \"test\", \"t\" ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strrchrpos (string str, string chr, int start) @@ -13968,7 +17492,17 @@ public int fn_strrchrpos (string str, string chr, int start) return SafeNativeMethods.mwle_fn_strrchrpos(sbstr, sbchr, start); } /// -/// ), Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. @param str The string to repeat multiple times. @param numTimes The number of times to repeat @a str in the result string. @param delimiter The string to put between each repetition of @a str. @return A string containing @a str repeated @a numTimes times. @tsexample strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". @endtsexample @ingroup Strings ) +/// ), +/// Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. +/// @param str The string to repeat multiple times. +/// @param numTimes The number of times to repeat @a str in the result string. +/// @param delimiter The string to put between each repetition of @a str. +/// @return A string containing @a str repeated @a numTimes times. +/// @tsexample +/// strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_strrepeat (string str, int numTimes, string delimiter) @@ -13988,7 +17522,16 @@ public string fn_strrepeat (string str, int numTimes, string delimiter) } /// -/// Replace all occurrences of @a from in @a source with @a to. @param source The string in which to replace the occurrences of @a from. @param from The string to replace in @a source. @param to The string with which to replace occurrences of @from. @return A string with all occurrences of @a from in @a source replaced by @a to. @tsexample strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". @endtsexample @ingroup Strings ) +/// Replace all occurrences of @a from in @a source with @a to. +/// @param source The string in which to replace the occurrences of @a from. +/// @param from The string to replace in @a source. +/// @param to The string with which to replace occurrences of @from. +/// @return A string with all occurrences of @a from in @a source replaced by @a to. +/// @tsexample +/// strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_strreplace (string source, string from, string to) @@ -14011,7 +17554,15 @@ public string fn_strreplace (string source, string from, string to) } /// -/// Find the start of @a substring in the given @a string searching from left to right. @param string The string to search. @param substring The string to search for. @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. @tsexample strstr( \"abcd\", \"c\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the start of @a substring in the given @a string searching from left to right. +/// @param string The string to search. +/// @param substring The string to search for. +/// @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. +/// @tsexample +/// strstr( \"abcd\", \"c\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strstr (string stringx, string substring) @@ -14029,6 +17580,7 @@ public int fn_strstr (string stringx, string substring) } /// /// strToPlayerName(string); ) +/// /// public string fn_strToPlayerName (string ptr) @@ -14045,7 +17597,15 @@ public string fn_strToPlayerName (string ptr) } /// -/// Return an all upper-case version of the given string. @param str A string. @return A version of @a str with all characters converted to upper-case. @tsexample strupr( \"TesT1\" ) // Returns \"TEST1\" @endtsexample @see strlwr @ingroup Strings ) +/// Return an all upper-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to upper-case. +/// @tsexample +/// strupr( \"TesT1\" ) // Returns \"TEST1\" +/// @endtsexample +/// @see strlwr +/// @ingroup Strings ) +/// /// public string fn_strupr (string str) @@ -14063,6 +17623,7 @@ public string fn_strupr (string str) } /// /// animate( F32 duration, F32 startAzimuth, F32 endAzimuth, F32 startElevation, F32 endElevation )) +/// /// public void fn_Sun_animate (string sun, float duration, float startAzimuth, float endAzimuth, float startElevation, float endElevation) @@ -14077,6 +17638,7 @@ public void fn_Sun_animate (string sun, float duration, float startAzimuth, floa } /// /// ) +/// /// public void fn_Sun_apply (string sun) @@ -14090,7 +17652,13 @@ public void fn_Sun_apply (string sun) SafeNativeMethods.mwle_fn_Sun_apply(sbsun); } /// -/// @brief Initializes and open the telnet console. @param port Port to listen on for console connections (0 will shut down listening). @param consolePass Password for read/write access to console. @param listenPass Password for read access to console. @param remoteEcho [optional] Enable echoing back to the client, off by default. @ingroup Debugging) +/// @brief Initializes and open the telnet console. +/// @param port Port to listen on for console connections (0 will shut down listening). +/// @param consolePass Password for read/write access to console. +/// @param listenPass Password for read access to console. +/// @param remoteEcho [optional] Enable echoing back to the client, off by default. +/// @ingroup Debugging) +/// /// public void fn_telnetSetParameters (int port, string consolePass, string listenPass, bool remoteEcho) @@ -14108,6 +17676,7 @@ public void fn_telnetSetParameters (int port, string consolePass, string listenP } /// /// png), (string filename, [string format]) - export the terrain block's heightmap to a bitmap file (default: png) ) +/// /// public bool fn_TerrainBlock_exportHeightMap (string terrainblock, string fileNameStr, string format) @@ -14128,6 +17697,7 @@ public bool fn_TerrainBlock_exportHeightMap (string terrainblock, string fileNam } /// /// png), (string filePrefix, [string format]) - export the terrain block's layer maps to bitmap files (default: png) ) +/// /// public bool fn_TerrainBlock_exportLayerMaps (string terrainblock, string filePrefixStr, string format) @@ -14147,7 +17717,9 @@ public bool fn_TerrainBlock_exportLayerMaps (string terrainblock, string filePre return SafeNativeMethods.mwle_fn_TerrainBlock_exportLayerMaps(sbterrainblock, sbfilePrefixStr, sbformat)>=1; } /// -/// ( string matName ) Adds a new material. ) +/// ( string matName ) +/// Adds a new material. ) +/// /// public int fn_TerrainEditor_addMaterial (string terraineditor, string matName) @@ -14165,6 +17737,7 @@ public int fn_TerrainEditor_addMaterial (string terraineditor, string matName) } /// /// ), (TerrainBlock terrain)) +/// /// public void fn_TerrainEditor_attachTerrain (string terraineditor, string terrain) @@ -14181,21 +17754,23 @@ public void fn_TerrainEditor_attachTerrain (string terraineditor, string terrain SafeNativeMethods.mwle_fn_TerrainEditor_attachTerrain(sbterraineditor, sbterrain); } /// -/// (float minHeight, float maxHeight, float minSlope, float maxSlope)) +/// (F32 minHeight, F32 maxHeight, F32 minSlope, F32 maxSlope , F32 coverage)) +/// /// -public void fn_TerrainEditor_autoMaterialLayer (string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope) +public void fn_TerrainEditor_autoMaterialLayer (string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope, float coverage) { if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_TerrainEditor_autoMaterialLayer'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" \"{4}\" ",terraineditor,minHeight,maxHeight,minSlope,maxSlope)); +System.Console.WriteLine("----------------->Extern Call 'fn_TerrainEditor_autoMaterialLayer'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" \"{4}\" \"{5}\" ",terraineditor,minHeight,maxHeight,minSlope,maxSlope,coverage)); StringBuilder sbterraineditor = null; if (terraineditor != null) sbterraineditor = new StringBuilder(terraineditor, 1024); -SafeNativeMethods.mwle_fn_TerrainEditor_autoMaterialLayer(sbterraineditor, minHeight, maxHeight, minSlope, maxSlope); +SafeNativeMethods.mwle_fn_TerrainEditor_autoMaterialLayer(sbterraineditor, minHeight, maxHeight, minSlope, maxSlope, coverage); } /// /// ) +/// /// public void fn_TerrainEditor_clearSelection (string terraineditor) @@ -14210,6 +17785,7 @@ public void fn_TerrainEditor_clearSelection (string terraineditor) } /// /// (int num)) +/// /// public string fn_TerrainEditor_getActionName (string terraineditor, uint index) @@ -14227,6 +17803,7 @@ public string fn_TerrainEditor_getActionName (string terraineditor, uint index) } /// /// ) +/// /// public int fn_TerrainEditor_getActiveTerrain (string terraineditor) @@ -14241,6 +17818,7 @@ public int fn_TerrainEditor_getActiveTerrain (string terraineditor) } /// /// Returns a Point2I.) +/// /// public string fn_TerrainEditor_getBrushPos (string terraineditor) @@ -14258,6 +17836,7 @@ public string fn_TerrainEditor_getBrushPos (string terraineditor) } /// /// ()) +/// /// public float fn_TerrainEditor_getBrushPressure (string terraineditor) @@ -14272,6 +17851,7 @@ public float fn_TerrainEditor_getBrushPressure (string terraineditor) } /// /// ()) +/// /// public string fn_TerrainEditor_getBrushSize (string terraineditor) @@ -14289,6 +17869,7 @@ public string fn_TerrainEditor_getBrushSize (string terraineditor) } /// /// ()) +/// /// public float fn_TerrainEditor_getBrushSoftness (string terraineditor) @@ -14303,6 +17884,7 @@ public float fn_TerrainEditor_getBrushSoftness (string terraineditor) } /// /// ()) +/// /// public string fn_TerrainEditor_getBrushType (string terraineditor) @@ -14320,6 +17902,7 @@ public string fn_TerrainEditor_getBrushType (string terraineditor) } /// /// ) +/// /// public string fn_TerrainEditor_getCurrentAction (string terraineditor) @@ -14337,6 +17920,7 @@ public string fn_TerrainEditor_getCurrentAction (string terraineditor) } /// /// Returns the current material count. ) +/// /// public int fn_TerrainEditor_getMaterialCount (string terraineditor) @@ -14351,6 +17935,7 @@ public int fn_TerrainEditor_getMaterialCount (string terraineditor) } /// /// ( string name ) - Returns the index of the material with the given name or -1. ) +/// /// public int fn_TerrainEditor_getMaterialIndex (string terraineditor, string name) @@ -14368,6 +17953,7 @@ public int fn_TerrainEditor_getMaterialIndex (string terraineditor, string name) } /// /// ( int index ) - Returns the name of the material at the given index. ) +/// /// public string fn_TerrainEditor_getMaterialName (string terraineditor, int index) @@ -14385,6 +17971,7 @@ public string fn_TerrainEditor_getMaterialName (string terraineditor, int index) } /// /// () gets the list of current terrain materials.) +/// /// public string fn_TerrainEditor_getMaterials (string terraineditor) @@ -14402,6 +17989,7 @@ public string fn_TerrainEditor_getMaterials (string terraineditor) } /// /// ) +/// /// public int fn_TerrainEditor_getNumActions (string terraineditor) @@ -14416,6 +18004,7 @@ public int fn_TerrainEditor_getNumActions (string terraineditor) } /// /// ) +/// /// public int fn_TerrainEditor_getNumTextures (string terraineditor) @@ -14430,6 +18019,7 @@ public int fn_TerrainEditor_getNumTextures (string terraineditor) } /// /// ) +/// /// public float fn_TerrainEditor_getSlopeLimitMaxAngle (string terraineditor) @@ -14444,6 +18034,7 @@ public float fn_TerrainEditor_getSlopeLimitMaxAngle (string terraineditor) } /// /// ) +/// /// public float fn_TerrainEditor_getSlopeLimitMinAngle (string terraineditor) @@ -14458,6 +18049,7 @@ public float fn_TerrainEditor_getSlopeLimitMinAngle (string terraineditor) } /// /// (S32 index)) +/// /// public int fn_TerrainEditor_getTerrainBlock (string terraineditor, int index) @@ -14472,6 +18064,7 @@ public int fn_TerrainEditor_getTerrainBlock (string terraineditor, int index) } /// /// ()) +/// /// public int fn_TerrainEditor_getTerrainBlockCount (string terraineditor) @@ -14486,6 +18079,7 @@ public int fn_TerrainEditor_getTerrainBlockCount (string terraineditor) } /// /// () gets the list of current terrain materials for all terrain blocks.) +/// /// public string fn_TerrainEditor_getTerrainBlocksMaterialList (string terraineditor) @@ -14502,7 +18096,12 @@ public string fn_TerrainEditor_getTerrainBlocksMaterialList (string terrainedito } /// -/// , , ), (x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found).) +/// , , ), +/// (x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found).) +/// /// public int fn_TerrainEditor_getTerrainUnderWorldPoint (string terraineditor, string ptOrX, string Y, string Z) @@ -14526,6 +18125,7 @@ public int fn_TerrainEditor_getTerrainUnderWorldPoint (string terraineditor, str } /// /// ) +/// /// public void fn_TerrainEditor_markEmptySquares (string terraineditor) @@ -14540,6 +18140,7 @@ public void fn_TerrainEditor_markEmptySquares (string terraineditor) } /// /// ) +/// /// public void fn_TerrainEditor_mirrorTerrain (string terraineditor, int mirrorIndex) @@ -14554,6 +18155,7 @@ public void fn_TerrainEditor_mirrorTerrain (string terraineditor, int mirrorInde } /// /// ), (string action=NULL)) +/// /// public void fn_TerrainEditor_processAction (string terraineditor, string action) @@ -14571,6 +18173,7 @@ public void fn_TerrainEditor_processAction (string terraineditor, string action) } /// /// ( int index ) - Remove the material at the given index. ) +/// /// public void fn_TerrainEditor_removeMaterial (string terraineditor, int index) @@ -14584,7 +18187,9 @@ public void fn_TerrainEditor_removeMaterial (string terraineditor, int index) SafeNativeMethods.mwle_fn_TerrainEditor_removeMaterial(sbterraineditor, index); } /// -/// ( int index, int order ) - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// ( int index, int order ) +/// - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// /// public void fn_TerrainEditor_reorderMaterial (string terraineditor, int index, int orderPos) @@ -14599,6 +18204,7 @@ public void fn_TerrainEditor_reorderMaterial (string terraineditor, int index, i } /// /// (bool clear)) +/// /// public void fn_TerrainEditor_resetSelWeights (string terraineditor, bool clear) @@ -14613,6 +18219,7 @@ public void fn_TerrainEditor_resetSelWeights (string terraineditor, bool clear) } /// /// (string action_name)) +/// /// public void fn_TerrainEditor_setAction (string terraineditor, string action_name) @@ -14630,6 +18237,7 @@ public void fn_TerrainEditor_setAction (string terraineditor, string action_name } /// /// Location) +/// /// public void fn_TerrainEditor_setBrushPos (string terraineditor, string pos) @@ -14647,6 +18255,7 @@ public void fn_TerrainEditor_setBrushPos (string terraineditor, string pos) } /// /// (float pressure)) +/// /// public void fn_TerrainEditor_setBrushPressure (string terraineditor, float pressure) @@ -14661,6 +18270,7 @@ public void fn_TerrainEditor_setBrushPressure (string terraineditor, float press } /// /// (int w [, int h])) +/// /// public void fn_TerrainEditor_setBrushSize (string terraineditor, int w, int h) @@ -14675,6 +18285,7 @@ public void fn_TerrainEditor_setBrushSize (string terraineditor, int w, int h) } /// /// (float softness)) +/// /// public void fn_TerrainEditor_setBrushSoftness (string terraineditor, float softness) @@ -14688,7 +18299,9 @@ public void fn_TerrainEditor_setBrushSoftness (string terraineditor, float softn SafeNativeMethods.mwle_fn_TerrainEditor_setBrushSoftness(sbterraineditor, softness); } /// -/// (string type) One of box, ellipse, selection.) +/// (string type) +/// One of box, ellipse, selection.) +/// /// public void fn_TerrainEditor_setBrushType (string terraineditor, string type) @@ -14706,6 +18319,7 @@ public void fn_TerrainEditor_setBrushType (string terraineditor, string type) } /// /// ) +/// /// public float fn_TerrainEditor_setSlopeLimitMaxAngle (string terraineditor, float angle) @@ -14720,6 +18334,7 @@ public float fn_TerrainEditor_setSlopeLimitMaxAngle (string terraineditor, float } /// /// ) +/// /// public float fn_TerrainEditor_setSlopeLimitMinAngle (string terraineditor, float angle) @@ -14734,6 +18349,7 @@ public float fn_TerrainEditor_setSlopeLimitMinAngle (string terraineditor, float } /// /// (bool overlayEnable) - sets the terraformer current heightmap to draw as an overlay over the current terrain.) +/// /// public void fn_TerrainEditor_setTerraformOverlay (string terraineditor, bool overlayEnable) @@ -14747,7 +18363,9 @@ public void fn_TerrainEditor_setTerraformOverlay (string terraineditor, bool ove SafeNativeMethods.mwle_fn_TerrainEditor_setTerraformOverlay(sbterraineditor, overlayEnable); } /// -/// ( int index, string matName ) Changes the material name at the index. ) +/// ( int index, string matName ) +/// Changes the material name at the index. ) +/// /// public bool fn_TerrainEditor_updateMaterial (string terraineditor, uint index, string matName) @@ -14765,6 +18383,7 @@ public bool fn_TerrainEditor_updateMaterial (string terraineditor, uint index, s } /// /// ( TerrainBlock obj, F32 factor, U32 steps )) +/// /// public void fn_TerrainSmoothAction_smooth (string terrainsmoothaction, string terrain, float factor, uint steps) @@ -14782,6 +18401,7 @@ public void fn_TerrainSmoothAction_smooth (string terrainsmoothaction, string te } /// /// () ) +/// /// public void fn_TerrainSolderEdgesAction_solder (string terrainsolderedgesaction) @@ -14796,6 +18416,7 @@ public void fn_TerrainSolderEdgesAction_solder (string terrainsolderedgesaction) } /// /// testBridge(arg1, arg2, arg3)) +/// /// public string fn_testJavaScriptBridge (string arg1, string arg2, string arg3) @@ -14819,6 +18440,7 @@ public string fn_testJavaScriptBridge (string arg1, string arg2, string arg3) } /// /// Pause playback of the video. ) +/// /// public void fn_TheoraTextureObject_pause (string theoratextureobject) @@ -14833,6 +18455,7 @@ public void fn_TheoraTextureObject_pause (string theoratextureobject) } /// /// Start playback of the video. ) +/// /// public void fn_TheoraTextureObject_play (string theoratextureobject) @@ -14847,6 +18470,7 @@ public void fn_TheoraTextureObject_play (string theoratextureobject) } /// /// Stop playback of the video. ) +/// /// public void fn_TheoraTextureObject_stop (string theoratextureobject) @@ -14860,7 +18484,13 @@ public void fn_TheoraTextureObject_stop (string theoratextureobject) SafeNativeMethods.mwle_fn_TheoraTextureObject_stop(sbtheoratextureobject); } /// -/// Enable or disable tracing in the script code VM. When enabled, the script code runtime will trace the invocation and returns from all functions that are called and log them to the console. This is helpful in observing the flow of the script program. @param enable New setting for script trace execution, on by default. @ingroup Debugging ) +/// Enable or disable tracing in the script code VM. +/// When enabled, the script code runtime will trace the invocation and returns +/// from all functions that are called and log them to the console. This is helpful in +/// observing the flow of the script program. +/// @param enable New setting for script trace execution, on by default. +/// @ingroup Debugging ) +/// /// public void fn_trace (bool enable) @@ -14871,7 +18501,14 @@ public void fn_trace (bool enable) SafeNativeMethods.mwle_fn_trace(enable); } /// -/// Remove leading and trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. @tsexample trim( \" string \" ); // Returns \"string\". @endtsexample @ingroup Strings ) +/// Remove leading and trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// trim( \" string \" ); // Returns \"string\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_trim (string str) @@ -14889,6 +18526,7 @@ public string fn_trim (string str) } /// /// tsUpdateImposterImages( bool forceupdate )) +/// /// public void fn_tsUpdateImposterImages (bool forceUpdate) @@ -14900,6 +18538,7 @@ public void fn_tsUpdateImposterImages (bool forceUpdate) } /// /// ), action.addToManager([undoManager])) +/// /// public void fn_UndoAction_addToManager (string undoaction, string undoManager) @@ -14917,6 +18556,7 @@ public void fn_UndoAction_addToManager (string undoaction, string undoManager) } /// /// () - Reo action contained in undo. ) +/// /// public void fn_UndoAction_redo (string undoaction) @@ -14931,6 +18571,7 @@ public void fn_UndoAction_redo (string undoaction) } /// /// () - Undo action contained in undo. ) +/// /// public void fn_UndoAction_undo (string undoaction) @@ -14945,6 +18586,7 @@ public void fn_UndoAction_undo (string undoaction) } /// /// Clears the undo manager.) +/// /// public void fn_UndoManager_clearAll (string undomanager) @@ -14959,6 +18601,7 @@ public void fn_UndoManager_clearAll (string undomanager) } /// /// UndoManager.getNextRedoName();) +/// /// public string fn_UndoManager_getNextRedoName (string undomanager) @@ -14976,6 +18619,7 @@ public string fn_UndoManager_getNextRedoName (string undomanager) } /// /// UndoManager.getNextUndoName();) +/// /// public string fn_UndoManager_getNextUndoName (string undomanager) @@ -14993,6 +18637,7 @@ public string fn_UndoManager_getNextUndoName (string undomanager) } /// /// (index)) +/// /// public int fn_UndoManager_getRedoAction (string undomanager, int index) @@ -15007,6 +18652,7 @@ public int fn_UndoManager_getRedoAction (string undomanager, int index) } /// /// ) +/// /// public int fn_UndoManager_getRedoCount (string undomanager) @@ -15021,6 +18667,7 @@ public int fn_UndoManager_getRedoCount (string undomanager) } /// /// (index)) +/// /// public string fn_UndoManager_getRedoName (string undomanager, int index) @@ -15038,6 +18685,7 @@ public string fn_UndoManager_getRedoName (string undomanager, int index) } /// /// (index)) +/// /// public int fn_UndoManager_getUndoAction (string undomanager, int index) @@ -15052,6 +18700,7 @@ public int fn_UndoManager_getUndoAction (string undomanager, int index) } /// /// ) +/// /// public int fn_UndoManager_getUndoCount (string undomanager) @@ -15066,6 +18715,7 @@ public int fn_UndoManager_getUndoCount (string undomanager) } /// /// (index)) +/// /// public string fn_UndoManager_getUndoName (string undomanager, int index) @@ -15083,6 +18733,7 @@ public string fn_UndoManager_getUndoName (string undomanager, int index) } /// /// ( bool discard=false ) - Pop the current CompoundUndoAction off the stack. ) +/// /// public void fn_UndoManager_popCompound (string undomanager, bool discard) @@ -15097,6 +18748,7 @@ public void fn_UndoManager_popCompound (string undomanager, bool discard) } /// /// \"\"), ( string name=\"\" ) - Push a CompoundUndoAction onto the compound stack for assembly. ) +/// /// public string fn_UndoManager_pushCompound (string undomanager, string name) @@ -15117,6 +18769,7 @@ public string fn_UndoManager_pushCompound (string undomanager, string name) } /// /// UndoManager.redo();) +/// /// public void fn_UndoManager_redo (string undomanager) @@ -15131,6 +18784,7 @@ public void fn_UndoManager_redo (string undomanager) } /// /// UndoManager.undo();) +/// /// public void fn_UndoManager_undo (string undomanager) @@ -15144,21 +18798,12 @@ public void fn_UndoManager_undo (string undomanager) SafeNativeMethods.mwle_fn_UndoManager_undo(sbundomanager); } /// -/// , false), ([searchString[, bool skipInteractive]]) @brief Run unit tests, or just the tests that prefix match against the searchString. @ingroup Console) -/// - -public void fn_unitTest_runTests (string searchString, bool skip) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_unitTest_runTests'" + string.Format("\"{0}\" \"{1}\" ",searchString,skip)); -StringBuilder sbsearchString = null; -if (searchString != null) - sbsearchString = new StringBuilder(searchString, 1024); - -SafeNativeMethods.mwle_fn_unitTest_runTests(sbsearchString, skip); -} -/// -/// (string queueName, string listener) @brief Unregisters an event message @param queueName String containing the name of queue @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Unregisters an event message +/// @param queueName String containing the name of queue +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public void fn_unregisterMessageListener (string queueName, string listenerName) @@ -15175,7 +18820,11 @@ public void fn_unregisterMessageListener (string queueName, string listenerName) SafeNativeMethods.mwle_fn_unregisterMessageListener(sbqueueName, sblistenerName); } /// -/// (string queueName) @brief Unregisters a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Unregisters a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void fn_unregisterMessageQueue (string queueName) @@ -15189,7 +18838,28 @@ public void fn_unregisterMessageQueue (string queueName) SafeNativeMethods.mwle_fn_unregisterMessageQueue(sbqueueName); } /// -/// Add two vectors. @param a The first vector. @param b The second vector. @return The vector @a a + @a b. @tsexample //----------------------------------------------------------------------------- // // VectorAdd( %a, %b ); // // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a + b = ( ax + bx, ay + by, az + bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; // %r = \"1 1 0\"; %r = VectorAdd( %a, %b ); @endtsexample @ingroup Vectors) +/// Add two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a + @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorAdd( %a, %b ); +/// // +/// // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a + b = ( ax + bx, ay + by, az + bz ) +/// // +/// //----------------------------------------------------------------------------- +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; +/// // %r = \"1 1 0\"; +/// %r = VectorAdd( %a, %b ); +/// @endtsexample +/// @ingroup Vectors) +/// /// public string fn_VectorAdd (string a, string b) @@ -15209,7 +18879,30 @@ public string fn_VectorAdd (string a, string b) } /// -/// Calculcate the cross product of two vectors. @param a The first vector. @param b The second vector. @return The cross product @a x @a b. @tsexample //----------------------------------------------------------------------------- // // VectorCross( %a, %b ); // // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; // %r = \"1 -1 -2\"; %r = VectorCross( %a, %b ); @endtsexample @ingroup Vectors ) +/// Calculcate the cross product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The cross product @a x @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorCross( %a, %b ); +/// // +/// // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; +/// // %r = \"1 -1 -2\"; +/// %r = VectorCross( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorCross (string a, string b) @@ -15229,7 +18922,32 @@ public string fn_VectorCross (string a, string b) } /// -/// Compute the distance between two vectors. @param a The first vector. @param b The second vector. @return The length( @a b - @a a ). @tsexample //----------------------------------------------------------------------------- // // VectorDist( %a, %b ); // // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a -> b = ||( b - a )|| // = ||( bx - ax, by - ay, bz - az )|| // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); // %r = mSqrt( 3 ); %r = VectorDist( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the distance between two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The length( @a b - @a a ). +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDist( %a, %b ); +/// // +/// // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a -> b = ||( b - a )|| +/// // = ||( bx - ax, by - ay, bz - az )|| +/// // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); +/// // %r = mSqrt( 3 ); +/// %r = VectorDist( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float fn_VectorDist (string a, string b) @@ -15246,7 +18964,30 @@ public float fn_VectorDist (string a, string b) return SafeNativeMethods.mwle_fn_VectorDist(sba, sbb); } /// -/// Compute the dot product of two vectors. @param a The first vector. @param b The second vector. @return The dot product @a a * @a b. @tsexample //----------------------------------------------------------------------------- // // VectorDot( %a, %b ); // // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: // // a . b = ( ax * bx + ay * by + az * bz ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; // %r = 2; %r = VectorDot( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the dot product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The dot product @a a * @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDot( %a, %b ); +/// // +/// // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: +/// // +/// // a . b = ( ax * bx + ay * by + az * bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; +/// // %r = 2; +/// %r = VectorDot( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float fn_VectorDot (string a, string b) @@ -15263,7 +19004,29 @@ public float fn_VectorDot (string a, string b) return SafeNativeMethods.mwle_fn_VectorDot(sba, sbb); } /// -/// Calculate the magnitude of the given vector. @param v A vector. @return The length of vector @a v. @tsexample //----------------------------------------------------------------------------- // // VectorLen( %a ); // // The length or magnitude of vector a, (ax, ay, az), is: // // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); // %r = mSqrt( 2 ); // %r = 1.414; %r = VectorLen( %a ); @endtsexample @ingroup Vectors ) +/// Calculate the magnitude of the given vector. +/// @param v A vector. +/// @return The length of vector @a v. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLen( %a ); +/// // +/// // The length or magnitude of vector a, (ax, ay, az), is: +/// // +/// // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// +/// // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); +/// // %r = mSqrt( 2 ); +/// // %r = 1.414; +/// %r = VectorLen( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float fn_VectorLen (string v) @@ -15277,7 +19040,35 @@ public float fn_VectorLen (string v) return SafeNativeMethods.mwle_fn_VectorLen(sbv); } /// -/// Linearly interpolate between two vectors by @a t. @param a Vector to start interpolation from. @param b Vector to interpolate to. @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector between @a a and @a b is returned. @return An interpolated vector between @a a and @a b. @tsexample //----------------------------------------------------------------------------- // // VectorLerp( %a, %b ); // // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is // weighted by the interpolation factor, t, is // // r = a + t * ( b - a ) // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; %v = \"0.25\"; // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; // %r = \"1.25 0.75 0.25\"; %r = VectorLerp( %a, %b ); @endtsexample @ingroup Vectors ) +/// Linearly interpolate between two vectors by @a t. +/// @param a Vector to start interpolation from. +/// @param b Vector to interpolate to. +/// @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector +/// between @a a and @a b is returned. +/// @return An interpolated vector between @a a and @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLerp( %a, %b ); +/// // +/// // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is +/// // weighted by the interpolation factor, t, is +/// // +/// // r = a + t * ( b - a ) +/// // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// %v = \"0.25\"; +/// +/// // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; +/// // %r = \"1.25 0.75 0.25\"; +/// %r = VectorLerp( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorLerp (string a, string b, float t) @@ -15297,7 +19088,30 @@ public string fn_VectorLerp (string a, string b, float t) } /// -/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. @param v The vector to normalize. @return The vector @a v scaled to length 1. @tsexample //----------------------------------------------------------------------------- // // VectorNormalize( %a ); // // The normalized vector a, (ax, ay, az), is: // // a^ = a / ||a|| // = ( ax / ||a||, ay / ||a||, az / ||a|| ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %l = 1.414; // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; // %r = \"0.707 0.707 0\"; %r = VectorNormalize( %a ); @endtsexample @ingroup Vectors ) +/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. +/// @param v The vector to normalize. +/// @return The vector @a v scaled to length 1. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorNormalize( %a ); +/// // +/// // The normalized vector a, (ax, ay, az), is: +/// // +/// // a^ = a / ||a|| +/// // = ( ax / ||a||, ay / ||a||, az / ||a|| ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %l = 1.414; +/// +/// // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; +/// // %r = \"0.707 0.707 0\"; +/// %r = VectorNormalize( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorNormalize (string v) @@ -15314,7 +19128,11 @@ public string fn_VectorNormalize (string v) } /// -/// Create an orthogonal basis from the given vector. @param aaf The vector to create the orthogonal basis from. @return A matrix representing the orthogonal basis. @ingroup Vectors ) +/// Create an orthogonal basis from the given vector. +/// @param aaf The vector to create the orthogonal basis from. +/// @return A matrix representing the orthogonal basis. +/// @ingroup Vectors ) +/// /// public string fn_VectorOrthoBasis (string aa) @@ -15332,6 +19150,7 @@ public string fn_VectorOrthoBasis (string aa) } /// /// (Vector3F, float) rotate a vector in 2d) +/// /// public string fn_VectorRot (string v, float angle) @@ -15348,7 +19167,30 @@ public string fn_VectorRot (string v, float angle) } /// -/// Scales a vector by a scalar. @param a The vector to scale. @param scalar The scale factor. @return The vector @a a * @a scalar. @tsexample //----------------------------------------------------------------------------- // // VectorScale( %a, %v ); // // Scaling vector a, (ax, ay, az), but the scalar, v, is: // // a * v = ( ax * v, ay * v, az * v ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %v = \"2\"; // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; // %r = \"2 2 0\"; %r = VectorScale( %a, %v ); @endtsexample @ingroup Vectors ) +/// Scales a vector by a scalar. +/// @param a The vector to scale. +/// @param scalar The scale factor. +/// @return The vector @a a * @a scalar. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorScale( %a, %v ); +/// // +/// // Scaling vector a, (ax, ay, az), but the scalar, v, is: +/// // +/// // a * v = ( ax * v, ay * v, az * v ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %v = \"2\"; +/// +/// // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; +/// // %r = \"2 2 0\"; +/// %r = VectorScale( %a, %v ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorScale (string a, float scalar) @@ -15365,7 +19207,30 @@ public string fn_VectorScale (string a, float scalar) } /// -/// Subtract two vectors. @param a The first vector. @param b The second vector. @return The vector @a a - @a b. @tsexample //----------------------------------------------------------------------------- // // VectorSub( %a, %b ); // // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a - b = ( ax - bx, ay - by, az - bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; // %r = \"1 -1 0\"; %r = VectorSub( %a, %b ); @endtsexample @ingroup Vectors ) +/// Subtract two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a - @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorSub( %a, %b ); +/// // +/// // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a - b = ( ax - bx, ay - by, az - bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// +/// // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; +/// // %r = \"1 -1 0\"; +/// %r = VectorSub( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorSub (string a, string b) @@ -15410,6 +19275,7 @@ public void fn_WalkaboutUpdateMesh (int meshid, int objid, bool remove) } /// /// ) +/// /// public void fn_WorldEditor_addUndoState (string worldeditor) @@ -15423,7 +19289,9 @@ public void fn_WorldEditor_addUndoState (string worldeditor) SafeNativeMethods.mwle_fn_WorldEditor_addUndoState(sbworldeditor); } /// -/// (int axis) Align all selected objects along the given axis.) +/// (int axis) +/// Align all selected objects along the given axis.) +/// /// public void fn_WorldEditor_alignByAxis (string worldeditor, int boundsAxis) @@ -15437,7 +19305,9 @@ public void fn_WorldEditor_alignByAxis (string worldeditor, int boundsAxis) SafeNativeMethods.mwle_fn_WorldEditor_alignByAxis(sbworldeditor, boundsAxis); } /// -/// (int boundsAxis) Align all selected objects against the given bounds axis.) +/// (int boundsAxis) +/// Align all selected objects against the given bounds axis.) +/// /// public void fn_WorldEditor_alignByBounds (string worldeditor, int boundsAxis) @@ -15452,6 +19322,7 @@ public void fn_WorldEditor_alignByBounds (string worldeditor, int boundsAxis) } /// /// ) +/// /// public bool fn_WorldEditor_canPasteSelection (string worldeditor) @@ -15466,6 +19337,7 @@ public bool fn_WorldEditor_canPasteSelection (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_clearIgnoreList (string worldeditor) @@ -15480,6 +19352,7 @@ public void fn_WorldEditor_clearIgnoreList (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_clearSelection (string worldeditor) @@ -15494,6 +19367,7 @@ public void fn_WorldEditor_clearSelection (string worldeditor) } /// /// ( String path ) - Export the combined geometry of all selected objects to the specified path in collada format. ) +/// /// public void fn_WorldEditor_colladaExportSelection (string worldeditor, string path) @@ -15511,6 +19385,7 @@ public void fn_WorldEditor_colladaExportSelection (string worldeditor, string pa } /// /// ) +/// /// public void fn_WorldEditor_copySelection (string worldeditor) @@ -15525,6 +19400,7 @@ public void fn_WorldEditor_copySelection (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_cutSelection (string worldeditor) @@ -15539,6 +19415,7 @@ public void fn_WorldEditor_cutSelection (string worldeditor) } /// /// ( bool skipUndo = false )) +/// /// public void fn_WorldEditor_dropSelection (string worldeditor, bool skipUndo) @@ -15553,6 +19430,7 @@ public void fn_WorldEditor_dropSelection (string worldeditor, bool skipUndo) } /// /// () - Replace selected Prefab objects with a SimGroup containing all children objects defined in the .prefab. ) +/// /// public void fn_WorldEditor_explodeSelectedPrefab (string worldeditor) @@ -15567,6 +19445,7 @@ public void fn_WorldEditor_explodeSelectedPrefab (string worldeditor) } /// /// () - Return the currently active WorldEditorSelection object. ) +/// /// public int fn_WorldEditor_getActiveSelection (string worldeditor) @@ -15581,6 +19460,7 @@ public int fn_WorldEditor_getActiveSelection (string worldeditor) } /// /// (int index)) +/// /// public int fn_WorldEditor_getSelectedObject (string worldeditor, int index) @@ -15595,6 +19475,7 @@ public int fn_WorldEditor_getSelectedObject (string worldeditor, int index) } /// /// ) +/// /// public string fn_WorldEditor_getSelectionCentroid (string worldeditor) @@ -15612,6 +19493,7 @@ public string fn_WorldEditor_getSelectionCentroid (string worldeditor) } /// /// ) +/// /// public string fn_WorldEditor_getSelectionExtent (string worldeditor) @@ -15629,6 +19511,7 @@ public string fn_WorldEditor_getSelectionExtent (string worldeditor) } /// /// ) +/// /// public float fn_WorldEditor_getSelectionRadius (string worldeditor) @@ -15643,6 +19526,7 @@ public float fn_WorldEditor_getSelectionRadius (string worldeditor) } /// /// () - Return the number of objects currently selected in the editor.) +/// /// public int fn_WorldEditor_getSelectionSize (string worldeditor) @@ -15656,7 +19540,9 @@ public int fn_WorldEditor_getSelectionSize (string worldeditor) return SafeNativeMethods.mwle_fn_WorldEditor_getSelectionSize(sbworldeditor); } /// -/// getSoftSnap() Is soft snapping always on?) +/// getSoftSnap() +/// Is soft snapping always on?) +/// /// public bool fn_WorldEditor_getSoftSnap (string worldeditor) @@ -15670,7 +19556,9 @@ public bool fn_WorldEditor_getSoftSnap (string worldeditor) return SafeNativeMethods.mwle_fn_WorldEditor_getSoftSnap(sbworldeditor)>=1; } /// -/// getSoftSnapBackfaceTolerance() The fraction of the soft snap radius that backfaces may be included.) +/// getSoftSnapBackfaceTolerance() +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public float fn_WorldEditor_getSoftSnapBackfaceTolerance (string worldeditor) @@ -15684,7 +19572,9 @@ public float fn_WorldEditor_getSoftSnapBackfaceTolerance (string worldeditor) return SafeNativeMethods.mwle_fn_WorldEditor_getSoftSnapBackfaceTolerance(sbworldeditor); } /// -/// getSoftSnapSize() Get the absolute size to trigger a soft snap.) +/// getSoftSnapSize() +/// Get the absolute size to trigger a soft snap.) +/// /// public float fn_WorldEditor_getSoftSnapSize (string worldeditor) @@ -15699,6 +19589,7 @@ public float fn_WorldEditor_getSoftSnapSize (string worldeditor) } /// /// (Object obj, bool hide)) +/// /// public void fn_WorldEditor_hideObject (string worldeditor, string obj, bool hide) @@ -15716,6 +19607,7 @@ public void fn_WorldEditor_hideObject (string worldeditor, string obj, bool hide } /// /// (bool hide)) +/// /// public void fn_WorldEditor_hideSelection (string worldeditor, bool hide) @@ -15730,6 +19622,7 @@ public void fn_WorldEditor_hideSelection (string worldeditor, bool hide) } /// /// ) +/// /// public void fn_WorldEditor_invalidateSelectionCentroid (string worldeditor) @@ -15744,6 +19637,7 @@ public void fn_WorldEditor_invalidateSelectionCentroid (string worldeditor) } /// /// (bool lock)) +/// /// public void fn_WorldEditor_lockSelection (string worldeditor, bool lockx) @@ -15758,6 +19652,7 @@ public void fn_WorldEditor_lockSelection (string worldeditor, bool lockx) } /// /// ( string filename ) - Save selected objects to a .prefab file and replace them in the level with a Prefab object. ) +/// /// public void fn_WorldEditor_makeSelectionPrefab (string worldeditor, string filename) @@ -15775,6 +19670,7 @@ public void fn_WorldEditor_makeSelectionPrefab (string worldeditor, string filen } /// /// ( Object A, Object B ) ) +/// /// public void fn_WorldEditor_mountRelative (string worldeditor, string objA, string objB) @@ -15795,6 +19691,7 @@ public void fn_WorldEditor_mountRelative (string worldeditor, string objA, strin } /// /// ) +/// /// public void fn_WorldEditor_pasteSelection (string worldeditor) @@ -15809,6 +19706,7 @@ public void fn_WorldEditor_pasteSelection (string worldeditor) } /// /// ( int objID )) +/// /// public void fn_WorldEditor_redirectConsole (string worldeditor, int objID) @@ -15823,6 +19721,7 @@ public void fn_WorldEditor_redirectConsole (string worldeditor, int objID) } /// /// ) +/// /// public void fn_WorldEditor_resetSelectedRotation (string worldeditor) @@ -15837,6 +19736,7 @@ public void fn_WorldEditor_resetSelectedRotation (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_resetSelectedScale (string worldeditor) @@ -15851,6 +19751,7 @@ public void fn_WorldEditor_resetSelectedScale (string worldeditor) } /// /// (SimObject obj)) +/// /// public void fn_WorldEditor_selectObject (string worldeditor, string objName) @@ -15868,6 +19769,7 @@ public void fn_WorldEditor_selectObject (string worldeditor, string objName) } /// /// ( id set ) - Set the currently active WorldEditorSelection object. ) +/// /// public void fn_WorldEditor_setActiveSelection (string worldeditor, string selection) @@ -15884,7 +19786,9 @@ public void fn_WorldEditor_setActiveSelection (string worldeditor, string select SafeNativeMethods.mwle_fn_WorldEditor_setActiveSelection(sbworldeditor, sbselection); } /// -/// setSoftSnap(bool) Allow soft snapping all of the time.) +/// setSoftSnap(bool) +/// Allow soft snapping all of the time.) +/// /// public void fn_WorldEditor_setSoftSnap (string worldeditor, bool enable) @@ -15898,7 +19802,9 @@ public void fn_WorldEditor_setSoftSnap (string worldeditor, bool enable) SafeNativeMethods.mwle_fn_WorldEditor_setSoftSnap(sbworldeditor, enable); } /// -/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) The fraction of the soft snap radius that backfaces may be included.) +/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public void fn_WorldEditor_setSoftSnapBackfaceTolerance (string worldeditor, float range) @@ -15912,7 +19818,9 @@ public void fn_WorldEditor_setSoftSnapBackfaceTolerance (string worldeditor, flo SafeNativeMethods.mwle_fn_WorldEditor_setSoftSnapBackfaceTolerance(sbworldeditor, range); } /// -/// setSoftSnapSize(F32) Set the absolute size to trigger a soft snap.) +/// setSoftSnapSize(F32) +/// Set the absolute size to trigger a soft snap.) +/// /// public void fn_WorldEditor_setSoftSnapSize (string worldeditor, float size) @@ -15926,7 +19834,9 @@ public void fn_WorldEditor_setSoftSnapSize (string worldeditor, float size) SafeNativeMethods.mwle_fn_WorldEditor_setSoftSnapSize(sbworldeditor, size); } /// -/// softSnapDebugRender(bool) Toggle soft snapping debug rendering.) +/// softSnapDebugRender(bool) +/// Toggle soft snapping debug rendering.) +/// /// public void fn_WorldEditor_softSnapDebugRender (string worldeditor, bool enable) @@ -15940,7 +19850,9 @@ public void fn_WorldEditor_softSnapDebugRender (string worldeditor, bool enable) SafeNativeMethods.mwle_fn_WorldEditor_softSnapDebugRender(sbworldeditor, enable); } /// -/// softSnapRender(bool) Render the soft snapping bounds.) +/// softSnapRender(bool) +/// Render the soft snapping bounds.) +/// /// public void fn_WorldEditor_softSnapRender (string worldeditor, bool enable) @@ -15954,7 +19866,9 @@ public void fn_WorldEditor_softSnapRender (string worldeditor, bool enable) SafeNativeMethods.mwle_fn_WorldEditor_softSnapRender(sbworldeditor, enable); } /// -/// softSnapRenderTriangle(bool) Render the soft snapped triangle.) +/// softSnapRenderTriangle(bool) +/// Render the soft snapped triangle.) +/// /// public void fn_WorldEditor_softSnapRenderTriangle (string worldeditor, bool enable) @@ -15968,7 +19882,9 @@ public void fn_WorldEditor_softSnapRenderTriangle (string worldeditor, bool enab SafeNativeMethods.mwle_fn_WorldEditor_softSnapRenderTriangle(sbworldeditor, enable); } /// -/// softSnapSizeByBounds(bool) Use selection bounds size as soft snap bounds.) +/// softSnapSizeByBounds(bool) +/// Use selection bounds size as soft snap bounds.) +/// /// public void fn_WorldEditor_softSnapSizeByBounds (string worldeditor, bool enable) @@ -15982,7 +19898,9 @@ public void fn_WorldEditor_softSnapSizeByBounds (string worldeditor, bool enable SafeNativeMethods.mwle_fn_WorldEditor_softSnapSizeByBounds(sbworldeditor, enable); } /// -/// transformSelection(...) Transform selection by given parameters.) +/// transformSelection(...) +/// Transform selection by given parameters.) +/// /// public void fn_WorldEditor_transformSelection (string worldeditor, bool position, string point, bool relativePos, bool rotate, string rotation, bool relativeRot, bool rotLocal, int scaleType, string scale, bool sRelative, bool sLocal) @@ -16006,6 +19924,7 @@ public void fn_WorldEditor_transformSelection (string worldeditor, bool position } /// /// (SimObject obj)) +/// /// public void fn_WorldEditor_unselectObject (string worldeditor, string objName) @@ -16022,7 +19941,9 @@ public void fn_WorldEditor_unselectObject (string worldeditor, string objName) SafeNativeMethods.mwle_fn_WorldEditor_unselectObject(sbworldeditor, sbobjName); } /// -/// Force all cached fonts to serialize themselves to the cache. @ingroup Font ) +/// Force all cached fonts to serialize themselves to the cache. +/// @ingroup Font ) +/// /// public void fn_writeFontCache () @@ -16034,7 +19955,9 @@ public void fn_writeFontCache () SafeNativeMethods.mwle_fn_writeFontCache(); } /// -/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) @hide) +/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) +/// @hide) +/// /// public bool fnActionMap_bind (string actionmap, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9) @@ -16072,7 +19995,29 @@ public bool fnActionMap_bind (string actionmap, string a2, string a3, string a4, return SafeNativeMethods.mwle_fnActionMap_bind(sbactionmap, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9)>=1; } /// -/// ), @brief Associates a make command and optional break command to a specified input device action. Must include parenthesis and semicolon in the make and break command strings. @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. @param makeCmd The command to execute when the device/action is made. @param breakCmd [optional] The command to execute when the device or action is unmade. @return True the bind was successful, false if the device was unknown or description failed. @tsexample // Print to the console when the spacebar is pressed function onSpaceDown() { echo(\"Space bar down!\"); } // Print to the console when the spacebar is released function onSpaceUp() { echo(\"Space bar up!\"); } // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); @endtsexample) +/// ), +/// @brief Associates a make command and optional break command to a specified input device action. +/// Must include parenthesis and semicolon in the make and break command strings. +/// @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. +/// @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. +/// @param makeCmd The command to execute when the device/action is made. +/// @param breakCmd [optional] The command to execute when the device or action is unmade. +/// @return True the bind was successful, false if the device was unknown or description failed. +/// @tsexample +/// // Print to the console when the spacebar is pressed +/// function onSpaceDown() +/// { +/// echo(\"Space bar down!\"); +/// } +/// // Print to the console when the spacebar is released +/// function onSpaceUp() +/// { +/// echo(\"Space bar up!\"); +/// } +/// // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events +/// moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); +/// @endtsexample) +/// /// public bool fnActionMap_bindCmd (string actionmap, string device, string action, string makeCmd, string breakCmd) @@ -16098,7 +20043,9 @@ public bool fnActionMap_bindCmd (string actionmap, string device, string action, return SafeNativeMethods.mwle_fnActionMap_bindCmd(sbactionmap, sbdevice, sbaction, sbmakeCmd, sbbreakCmd)>=1; } /// -/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) @hide) +/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) +/// @hide) +/// /// public bool fnActionMap_bindObj (string actionmap, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10) @@ -16139,7 +20086,24 @@ public bool fnActionMap_bindObj (string actionmap, string a2, string a3, string return SafeNativeMethods.mwle_fnActionMap_bindObj(sbactionmap, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10)>=1; } /// -/// @brief Gets the ActionMap binding for the specified command. Use getField() on the return value to get the device and action of the binding. @param command The function to search bindings for. @return The binding against the specified command. Returns an empty string(\"\") if a binding wasn't found. @tsexample // Find what the function \"jump()\" is bound to in moveMap %bind = moveMap.getBinding( \"jump\" ); if ( %bind !$= \"\" ) { // Find out what device is used in the binding %device = getField( %bind, 0 ); // Find out what action (such as a key) is used in the binding %action = getField( %bind, 1 ); } @endtsexample @see getField) +/// @brief Gets the ActionMap binding for the specified command. +/// Use getField() on the return value to get the device and action of the binding. +/// @param command The function to search bindings for. +/// @return The binding against the specified command. Returns an empty string(\"\") +/// if a binding wasn't found. +/// @tsexample +/// // Find what the function \"jump()\" is bound to in moveMap +/// %bind = moveMap.getBinding( \"jump\" ); +/// if ( %bind !$= \"\" ) +/// { +/// // Find out what device is used in the binding +/// %device = getField( %bind, 0 ); +/// // Find out what action (such as a key) is used in the binding +/// %action = getField( %bind, 1 ); +/// } +/// @endtsexample +/// @see getField) +/// /// public string fnActionMap_getBinding (string actionmap, string command) @@ -16159,7 +20123,18 @@ public string fnActionMap_getBinding (string actionmap, string command) } /// -/// @brief Gets ActionMap command for the device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The command against the specified device and action. @tsexample // Find what function is bound to a device\'s action // In this example, \"jump()\" was assigned to the space key in another script %command = moveMap.getCommand(\"keyboard\", \"space\"); // Should print \"jump\" in the console echo(%command) @endtsexample) +/// @brief Gets ActionMap command for the device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The command against the specified device and action. +/// @tsexample +/// // Find what function is bound to a device\'s action +/// // In this example, \"jump()\" was assigned to the space key in another script +/// %command = moveMap.getCommand(\"keyboard\", \"space\"); +/// // Should print \"jump\" in the console +/// echo(%command) +/// @endtsexample) +/// /// public string fnActionMap_getCommand (string actionmap, string device, string action) @@ -16182,7 +20157,15 @@ public string fnActionMap_getCommand (string actionmap, string device, string ac } /// -/// @brief Gets the Dead zone for the specified device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone or an empty string(\"\") if the mapping was not found. @tsexample %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Gets the Dead zone for the specified device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone +/// or an empty string(\"\") if the mapping was not found. +/// @tsexample +/// %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public string fnActionMap_getDeadZone (string actionmap, string device, string action) @@ -16205,7 +20188,14 @@ public string fnActionMap_getDeadZone (string actionmap, string device, string a } /// -/// @brief Get any scaling on the specified device and action. @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return Any scaling applied to the specified device and action. @tsexample %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Get any scaling on the specified device and action. +/// @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return Any scaling applied to the specified device and action. +/// @tsexample +/// %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public float fnActionMap_getScale (string actionmap, string device, string action) @@ -16225,7 +20215,16 @@ public float fnActionMap_getScale (string actionmap, string device, string actio return SafeNativeMethods.mwle_fnActionMap_getScale(sbactionmap, sbdevice, sbaction); } /// -/// @brief Determines if the specified device and action is inverted. Should only be used for scrolling devices or gamepad/joystick axes. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return True if the specified device and action is inverted. @tsexample %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) echo(\"Mouse's xAxis is inverted\"); @endtsexample) +/// @brief Determines if the specified device and action is inverted. +/// Should only be used for scrolling devices or gamepad/joystick axes. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the specified device and action is inverted. +/// @tsexample +/// %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) +/// echo(\"Mouse's xAxis is inverted\"); +/// @endtsexample) +/// /// public bool fnActionMap_isInverted (string actionmap, string device, string action) @@ -16245,7 +20244,14 @@ public bool fnActionMap_isInverted (string actionmap, string device, string acti return SafeNativeMethods.mwle_fnActionMap_isInverted(sbactionmap, sbdevice, sbaction)>=1; } /// -/// @brief Pop the ActionMap off the %ActionMap stack. Deactivates an %ActionMap and removes it from the @ActionMap stack. @tsexample // Deactivate moveMap moveMap.pop(); @endtsexample @see ActionMap) +/// @brief Pop the ActionMap off the %ActionMap stack. +/// Deactivates an %ActionMap and removes it from the @ActionMap stack. +/// @tsexample +/// // Deactivate moveMap +/// moveMap.pop(); +/// @endtsexample +/// @see ActionMap) +/// /// public void fnActionMap_pop (string actionmap) @@ -16259,7 +20265,14 @@ public void fnActionMap_pop (string actionmap) SafeNativeMethods.mwle_fnActionMap_pop(sbactionmap); } /// -/// @brief Push the ActionMap onto the %ActionMap stack. Activates an ActionMap and placees it at the top of the ActionMap stack. @tsexample // Make moveMap the active action map moveMap.push(); @endtsexample @see ActionMap) +/// @brief Push the ActionMap onto the %ActionMap stack. +/// Activates an ActionMap and placees it at the top of the ActionMap stack. +/// @tsexample +/// // Make moveMap the active action map +/// moveMap.push(); +/// @endtsexample +/// @see ActionMap) +/// /// public void fnActionMap_push (string actionmap) @@ -16273,7 +20286,15 @@ public void fnActionMap_push (string actionmap) SafeNativeMethods.mwle_fnActionMap_push(sbactionmap); } /// -/// @brief Saves the ActionMap to a file or dumps it to the console. @param fileName The file path to save the ActionMap to. If a filename is not specified the ActionMap will be dumped to the console. @param append Whether to write the ActionMap at the end of the file or overwrite it. @tsexample // Write out the actionmap into the config.cs file moveMap.save( \"scripts/client/config.cs\" ); @endtsexample) +/// @brief Saves the ActionMap to a file or dumps it to the console. +/// @param fileName The file path to save the ActionMap to. If a filename is not specified +/// the ActionMap will be dumped to the console. +/// @param append Whether to write the ActionMap at the end of the file or overwrite it. +/// @tsexample +/// // Write out the actionmap into the config.cs file +/// moveMap.save( \"scripts/client/config.cs\" ); +/// @endtsexample) +/// /// public void fnActionMap_save (string actionmap, string fileName, bool append) @@ -16290,7 +20311,14 @@ public void fnActionMap_save (string actionmap, string fileName, bool append) SafeNativeMethods.mwle_fnActionMap_save(sbactionmap, sbfileName, append); } /// -/// @brief Removes the binding on an input device and action. @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbind(\"keyboard\", \"space\"); @endtsexample) +/// @brief Removes the binding on an input device and action. +/// @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbind(\"keyboard\", \"space\"); +/// @endtsexample) +/// /// public bool fnActionMap_unbind (string actionmap, string device, string action) @@ -16310,7 +20338,15 @@ public bool fnActionMap_unbind (string actionmap, string device, string action) return SafeNativeMethods.mwle_fnActionMap_unbind(sbactionmap, sbdevice, sbaction)>=1; } /// -/// @brief Remove any object-binding on an input device and action. @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @param obj The object to perform unbind against. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); @endtsexample) +/// @brief Remove any object-binding on an input device and action. +/// @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @param obj The object to perform unbind against. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); +/// @endtsexample) +/// /// public bool fnActionMap_unbindObj (string actionmap, string device, string action, string obj) @@ -16333,7 +20369,8 @@ public bool fnActionMap_unbindObj (string actionmap, string device, string actio return SafeNativeMethods.mwle_fnActionMap_unbindObj(sbactionmap, sbdevice, sbaction, sbobj)>=1; } /// -/// ) +/// ) +/// /// public void fnAIPlayer_AISearchSimSet (string aiplayer, float fOV, float farDist, string ObjToSearch, string result) @@ -16353,7 +20390,53 @@ public void fnAIPlayer_AISearchSimSet (string aiplayer, float fOV, float farDist SafeNativeMethods.mwle_fnAIPlayer_AISearchSimSet(sbaiplayer, fOV, farDist, sbObjToSearch, sbresult); } /// -/// @brief Use this to stop aiming at an object or a point. @see setAimLocation() @see setAimObject()) +/// @brief Check whether an object is within a specified veiw cone. +/// @obj Object to check. (If blank, it will check the current target). +/// @fov view angle in degrees.(Defaults to 45) +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// + +public bool fnAIPlayer_checkInFoV (string aiplayer, string obj, float fov, bool checkEnabled) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnAIPlayer_checkInFoV'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" ",aiplayer,obj,fov,checkEnabled)); +StringBuilder sbaiplayer = null; +if (aiplayer != null) + sbaiplayer = new StringBuilder(aiplayer, 1024); +StringBuilder sbobj = null; +if (obj != null) + sbobj = new StringBuilder(obj, 1024); + +return SafeNativeMethods.mwle_fnAIPlayer_checkInFoV(sbaiplayer, sbobj, fov, checkEnabled)>=1; +} +/// +/// @brief Check whether an object is in line of sight. +/// @obj Object to check. (If blank, it will check the current target). +/// @useMuzzle Use muzzle position. Otherwise use eye position. (defaults to false). +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// + +public bool fnAIPlayer_checkInLos (string aiplayer, string obj, bool useMuzzle, bool checkEnabled) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnAIPlayer_checkInLos'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" ",aiplayer,obj,useMuzzle,checkEnabled)); +StringBuilder sbaiplayer = null; +if (aiplayer != null) + sbaiplayer = new StringBuilder(aiplayer, 1024); +StringBuilder sbobj = null; +if (obj != null) + sbobj = new StringBuilder(obj, 1024); + +return SafeNativeMethods.mwle_fnAIPlayer_checkInLos(sbaiplayer, sbobj, useMuzzle, checkEnabled)>=1; +} +/// +/// @brief Use this to stop aiming at an object or a point. +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public void fnAIPlayer_clearAim (string aiplayer) @@ -16444,7 +20527,18 @@ public void fnAIPlayer_followObject (string aiplayer, uint obj, float radius) SafeNativeMethods.mwle_fnAIPlayer_followObject(sbaiplayer, obj, radius); } /// -/// @brief Returns the point the AIPlayer is aiming at. This will reflect the position set by setAimLocation(), or the position of the object that the bot is now aiming at. If the bot is not aiming at anything, this value will change to whatever point the bot's current line-of-sight intercepts. @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". @see setAimLocation() @see setAimObject()) +/// @brief Returns the point the AIPlayer is aiming at. +/// +/// This will reflect the position set by setAimLocation(), +/// or the position of the object that the bot is now aiming at. +/// If the bot is not aiming at anything, this value will +/// change to whatever point the bot's current line-of-sight intercepts. +/// +/// @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public string fnAIPlayer_getAimLocation (string aiplayer) @@ -16461,7 +20555,13 @@ public string fnAIPlayer_getAimLocation (string aiplayer) } /// -/// @brief Gets the object the AIPlayer is targeting. @return Returns -1 if no object is being aimed at, or the SimObjectID of the object the AIPlayer is aiming at. @see setAimObject()) +/// @brief Gets the object the AIPlayer is targeting. +/// +/// @return Returns -1 if no object is being aimed at, +/// or the SimObjectID of the object the AIPlayer is aiming at. +/// +/// @see setAimObject()) +/// /// public int fnAIPlayer_getAimObject (string aiplayer) @@ -16475,7 +20575,14 @@ public int fnAIPlayer_getAimObject (string aiplayer) return SafeNativeMethods.mwle_fnAIPlayer_getAimObject(sbaiplayer); } /// -/// @brief Get the AIPlayer's current destination. @return Returns a point containing the \"x y z\" position of the AIPlayer's current move destination. If no move destination has yet been set, this returns \"0 0 0\". @see setMoveDestination()) +/// @brief Get the AIPlayer's current destination. +/// +/// @return Returns a point containing the \"x y z\" position +/// of the AIPlayer's current move destination. If no move destination +/// has yet been set, this returns \"0 0 0\". +/// +/// @see setMoveDestination()) +/// /// public string fnAIPlayer_getMoveDestination (string aiplayer) @@ -16492,7 +20599,12 @@ public string fnAIPlayer_getMoveDestination (string aiplayer) } /// -/// @brief Gets the move speed of an AI object. @return A speed multiplier between 0.0 and 1.0. @see setMoveSpeed()) +/// @brief Gets the move speed of an AI object. +/// +/// @return A speed multiplier between 0.0 and 1.0. +/// +/// @see setMoveSpeed()) +/// /// public float fnAIPlayer_getMoveSpeed (string aiplayer) @@ -16579,7 +20691,12 @@ public void fnAIPlayer_repath (string aiplayer) SafeNativeMethods.mwle_fnAIPlayer_repath(sbaiplayer); } /// -/// @brief Tells the AIPlayer to aim at the location provided. @param target An \"x y z\" position in the game world to target. @see getAimLocation()) +/// @brief Tells the AIPlayer to aim at the location provided. +/// +/// @param target An \"x y z\" position in the game world to target. +/// +/// @see getAimLocation()) +/// /// public void fnAIPlayer_setAimLocation (string aiplayer, string target) @@ -16596,7 +20713,18 @@ public void fnAIPlayer_setAimLocation (string aiplayer, string target) SafeNativeMethods.mwle_fnAIPlayer_setAimLocation(sbaiplayer, sbtarget); } /// -/// @brief Tells the AI to move to the location provided @param goal Coordinates in world space representing location to move to. @param slowDown A boolean value. If set to true, the bot will slow down when it gets within 5-meters of its move destination. If false, the bot will stop abruptly when it reaches the move destination. By default, this is true. @note Upon reaching a move destination, the bot will clear its move destination and calls to getMoveDestination will return \"0 0 0\". @see getMoveDestination()) +/// @brief Tells the AI to move to the location provided +/// +/// @param goal Coordinates in world space representing location to move to. +/// @param slowDown A boolean value. If set to true, the bot will slow down +/// when it gets within 5-meters of its move destination. If false, the bot +/// will stop abruptly when it reaches the move destination. By default, this is true. +/// +/// @note Upon reaching a move destination, the bot will clear its move destination and +/// calls to getMoveDestination will return \"0 0 0\". +/// +/// @see getMoveDestination()) +/// /// public void fnAIPlayer_setMoveDestination (string aiplayer, string goal, bool slowDown) @@ -16613,7 +20741,14 @@ public void fnAIPlayer_setMoveDestination (string aiplayer, string goal, bool sl SafeNativeMethods.mwle_fnAIPlayer_setMoveDestination(sbaiplayer, sbgoal, slowDown); } /// -/// @brief Sets the move speed for an AI object. @param speed A speed multiplier between 0.0 and 1.0. This is multiplied by the AIPlayer's base movement rates (as defined in its PlayerData datablock) @see getMoveDestination()) +/// @brief Sets the move speed for an AI object. +/// +/// @param speed A speed multiplier between 0.0 and 1.0. +/// This is multiplied by the AIPlayer's base movement rates (as defined in +/// its PlayerData datablock) +/// +/// @see getMoveDestination()) +/// /// public void fnAIPlayer_setMoveSpeed (string aiplayer, float speed) @@ -16670,6 +20805,7 @@ public bool fnAIPlayer_setPathDestination (string aiplayer, string goal) } /// /// @brief Tells the AIPlayer to stop moving.) +/// /// public void fnAIPlayer_stop (string aiplayer) @@ -16684,6 +20820,7 @@ public void fnAIPlayer_stop (string aiplayer) } /// /// @brief Activate a turret from a deactive state.) +/// /// public void fnAITurretShape_activateTurret (string aiturretshape) @@ -16697,7 +20834,10 @@ public void fnAITurretShape_activateTurret (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_activateTurret(sbaiturretshape); } /// -/// @brief Adds object to the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to ignore.) +/// @brief Adds object to the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to ignore.) +/// /// public void fnAITurretShape_addToIgnoreList (string aiturretshape, string obj) @@ -16715,6 +20855,7 @@ public void fnAITurretShape_addToIgnoreList (string aiturretshape, string obj) } /// /// @brief Deactivate a turret from an active state.) +/// /// public void fnAITurretShape_deactivateTurret (string aiturretshape) @@ -16728,7 +20869,9 @@ public void fnAITurretShape_deactivateTurret (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_deactivateTurret(sbaiturretshape); } /// -/// @brief Get the turret's current target. @returns The object that is the target's current target, or 0 if no target.) +/// @brief Get the turret's current target. +/// @returns The object that is the target's current target, or 0 if no target.) +/// /// public string fnAITurretShape_getTarget (string aiturretshape) @@ -16745,7 +20888,9 @@ public string fnAITurretShape_getTarget (string aiturretshape) } /// -/// @brief Get the turret's defined projectile velocity that helps with target leading. @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// @brief Get the turret's defined projectile velocity that helps with target leading. +/// @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// /// public float fnAITurretShape_getWeaponLeadVelocity (string aiturretshape) @@ -16759,7 +20904,9 @@ public float fnAITurretShape_getWeaponLeadVelocity (string aiturretshape) return SafeNativeMethods.mwle_fnAITurretShape_getWeaponLeadVelocity(sbaiturretshape); } /// -/// @brief Indicates if the turret has a target. @returns True if the turret has a target.) +/// @brief Indicates if the turret has a target. +/// @returns True if the turret has a target.) +/// /// public bool fnAITurretShape_hasTarget (string aiturretshape) @@ -16774,6 +20921,7 @@ public bool fnAITurretShape_hasTarget (string aiturretshape) } /// /// @brief Recenter the turret's weapon.) +/// /// public void fnAITurretShape_recenterTurret (string aiturretshape) @@ -16787,7 +20935,10 @@ public void fnAITurretShape_recenterTurret (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_recenterTurret(sbaiturretshape); } /// -/// @brief Removes object from the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to once again allow for targeting.) +/// @brief Removes object from the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to once again allow for targeting.) +/// /// public void fnAITurretShape_removeFromIgnoreList (string aiturretshape, string obj) @@ -16804,7 +20955,9 @@ public void fnAITurretShape_removeFromIgnoreList (string aiturretshape, string o SafeNativeMethods.mwle_fnAITurretShape_removeFromIgnoreList(sbaiturretshape, sbobj); } /// -/// @brief Resets the turret's target tracking. Only resets the internal target tracking. Does not modify the turret's facing.) +/// @brief Resets the turret's target tracking. +/// Only resets the internal target tracking. Does not modify the turret's facing.) +/// /// public void fnAITurretShape_resetTarget (string aiturretshape) @@ -16818,7 +20971,9 @@ public void fnAITurretShape_resetTarget (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_resetTarget(sbaiturretshape); } /// -/// @brief Set the firing state of the turret's guns. @param fire Set to true to activate all guns. False to deactivate them.) +/// @brief Set the firing state of the turret's guns. +/// @param fire Set to true to activate all guns. False to deactivate them.) +/// /// public void fnAITurretShape_setAllGunsFiring (string aiturretshape, bool fire) @@ -16832,7 +20987,10 @@ public void fnAITurretShape_setAllGunsFiring (string aiturretshape, bool fire) SafeNativeMethods.mwle_fnAITurretShape_setAllGunsFiring(sbaiturretshape, fire); } /// -/// @brief Set the firing state of the given gun slot. @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. @param fire Set to true to activate the gun. False to deactivate it.) +/// @brief Set the firing state of the given gun slot. +/// @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. +/// @param fire Set to true to activate the gun. False to deactivate it.) +/// /// public void fnAITurretShape_setGunSlotFiring (string aiturretshape, int slot, bool fire) @@ -16846,7 +21004,14 @@ public void fnAITurretShape_setGunSlotFiring (string aiturretshape, int slot, bo SafeNativeMethods.mwle_fnAITurretShape_setGunSlotFiring(sbaiturretshape, slot, fire); } /// -/// @brief Set the turret's current state. Normally the turret's state comes from updating the state machine but this method allows you to override this and jump to the requested state immediately. @param newState The name of the new state. @param force Is true then force the full processing of the new state even if it is the same as the current state. If false then only the time out value is reset and the state's script method is called, if any.) +/// @brief Set the turret's current state. +/// Normally the turret's state comes from updating the state machine but this method +/// allows you to override this and jump to the requested state immediately. +/// @param newState The name of the new state. +/// @param force Is true then force the full processing of the new state even if it is the +/// same as the current state. If false then only the time out value is reset and the state's +/// script method is called, if any.) +/// /// public void fnAITurretShape_setTurretState (string aiturretshape, string newState, bool force) @@ -16863,7 +21028,12 @@ public void fnAITurretShape_setTurretState (string aiturretshape, string newStat SafeNativeMethods.mwle_fnAITurretShape_setTurretState(sbaiturretshape, sbnewState, force); } /// -/// @brief Set the turret's projectile velocity to help lead the target. This value normally comes from AITurretShapeData::weaponLeadVelocity but this method allows you to override the datablock value. This can be useful if the turret changes ammunition, uses a different weapon than the default, is damaged, etc. @note Setting this to 0 will disable target leading.) +/// @brief Set the turret's projectile velocity to help lead the target. +/// This value normally comes from AITurretShapeData::weaponLeadVelocity but this method +/// allows you to override the datablock value. This can be useful if the turret changes +/// ammunition, uses a different weapon than the default, is damaged, etc. +/// @note Setting this to 0 will disable target leading.) +/// /// public void fnAITurretShape_setWeaponLeadVelocity (string aiturretshape, float velocity) @@ -16878,6 +21048,7 @@ public void fnAITurretShape_setWeaponLeadVelocity (string aiturretshape, float v } /// /// @brief Begin scanning for a target.) +/// /// public void fnAITurretShape_startScanForTargets (string aiturretshape) @@ -16892,6 +21063,7 @@ public void fnAITurretShape_startScanForTargets (string aiturretshape) } /// /// @brief Have the turret track the current target.) +/// /// public void fnAITurretShape_startTrackingTarget (string aiturretshape) @@ -16905,7 +21077,10 @@ public void fnAITurretShape_startTrackingTarget (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_startTrackingTarget(sbaiturretshape); } /// -/// @brief Stop scanning for targets. @note Only impacts the scanning for new targets. Does not effect a turret's current target lock.) +/// @brief Stop scanning for targets. +/// @note Only impacts the scanning for new targets. Does not effect a turret's current +/// target lock.) +/// /// public void fnAITurretShape_stopScanForTargets (string aiturretshape) @@ -16920,6 +21095,7 @@ public void fnAITurretShape_stopScanForTargets (string aiturretshape) } /// /// @brief Stop the turret from tracking the current target.) +/// /// public void fnAITurretShape_stopTrackingTarget (string aiturretshape) @@ -16933,7 +21109,11 @@ public void fnAITurretShape_stopTrackingTarget (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_stopTrackingTarget(sbaiturretshape); } /// -/// ), Adds a new element to the end of an array (same as push_back()). @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array (same as push_back()). +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void fnArrayObject_add (string arrayobject, string key, string value) @@ -16953,7 +21133,9 @@ public void fnArrayObject_add (string arrayobject, string key, string value) SafeNativeMethods.mwle_fnArrayObject_add(sbarrayobject, sbkey, sbvalue); } /// -/// Appends the target array to the array object. @param target ArrayObject to append to the end of this array ) +/// Appends the target array to the array object. +/// @param target ArrayObject to append to the end of this array ) +/// /// public bool fnArrayObject_append (string arrayobject, string target) @@ -16971,6 +21153,7 @@ public bool fnArrayObject_append (string arrayobject, string target) } /// /// Get the number of elements in the array. ) +/// /// public int fnArrayObject_count (string arrayobject) @@ -16984,7 +21167,9 @@ public int fnArrayObject_count (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_count(sbarrayobject); } /// -/// Get the number of times a particular key is found in the array. @param key Key value to count ) +/// Get the number of times a particular key is found in the array. +/// @param key Key value to count ) +/// /// public int fnArrayObject_countKey (string arrayobject, string key) @@ -17001,7 +21186,9 @@ public int fnArrayObject_countKey (string arrayobject, string key) return SafeNativeMethods.mwle_fnArrayObject_countKey(sbarrayobject, sbkey); } /// -/// Get the number of times a particular value is found in the array. @param value Array element value to count ) +/// Get the number of times a particular value is found in the array. +/// @param value Array element value to count ) +/// /// public int fnArrayObject_countValue (string arrayobject, string value) @@ -17018,7 +21205,9 @@ public int fnArrayObject_countValue (string arrayobject, string value) return SafeNativeMethods.mwle_fnArrayObject_countValue(sbarrayobject, sbvalue); } /// -/// Removes elements with matching keys from array. @param target ArrayObject containing keys to remove from this array ) +/// Removes elements with matching keys from array. +/// @param target ArrayObject containing keys to remove from this array ) +/// /// public bool fnArrayObject_crop (string arrayobject, string target) @@ -17035,7 +21224,9 @@ public bool fnArrayObject_crop (string arrayobject, string target) return SafeNativeMethods.mwle_fnArrayObject_crop(sbarrayobject, sbtarget)>=1; } /// -/// Alters array into an exact duplicate of the target array. @param target ArrayObject to duplicate ) +/// Alters array into an exact duplicate of the target array. +/// @param target ArrayObject to duplicate ) +/// /// public bool fnArrayObject_duplicate (string arrayobject, string target) @@ -17053,6 +21244,7 @@ public bool fnArrayObject_duplicate (string arrayobject, string target) } /// /// Echos the array contents to the console ) +/// /// public void fnArrayObject_echo (string arrayobject) @@ -17067,6 +21259,7 @@ public void fnArrayObject_echo (string arrayobject) } /// /// Emptys all elements from an array ) +/// /// public void fnArrayObject_empty (string arrayobject) @@ -17080,7 +21273,9 @@ public void fnArrayObject_empty (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_empty(sbarrayobject); } /// -/// Removes an element at a specific position from the array. @param index 0-based index of the element to remove ) +/// Removes an element at a specific position from the array. +/// @param index 0-based index of the element to remove ) +/// /// public void fnArrayObject_erase (string arrayobject, int index) @@ -17095,6 +21290,7 @@ public void fnArrayObject_erase (string arrayobject, int index) } /// /// Gets the current pointer index ) +/// /// public int fnArrayObject_getCurrent (string arrayobject) @@ -17108,7 +21304,10 @@ public int fnArrayObject_getCurrent (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_getCurrent(sbarrayobject); } /// -/// Search the array from the current position for the key @param value Array key to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the key +/// @param value Array key to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int fnArrayObject_getIndexFromKey (string arrayobject, string key) @@ -17125,7 +21324,10 @@ public int fnArrayObject_getIndexFromKey (string arrayobject, string key) return SafeNativeMethods.mwle_fnArrayObject_getIndexFromKey(sbarrayobject, sbkey); } /// -/// Search the array from the current position for the element @param value Array value to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the element +/// @param value Array value to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int fnArrayObject_getIndexFromValue (string arrayobject, string value) @@ -17142,7 +21344,11 @@ public int fnArrayObject_getIndexFromValue (string arrayobject, string value) return SafeNativeMethods.mwle_fnArrayObject_getIndexFromValue(sbarrayobject, sbvalue); } /// -/// Get the key of the array element at the submitted index. @param index 0-based index of the array element to get @return The key associated with the array element at the specified index, or \"\" if the index is out of range ) +/// Get the key of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The key associated with the array element at the +/// specified index, or \"\" if the index is out of range ) +/// /// public string fnArrayObject_getKey (string arrayobject, int index) @@ -17159,7 +21365,11 @@ public string fnArrayObject_getKey (string arrayobject, int index) } /// -/// Get the value of the array element at the submitted index. @param index 0-based index of the array element to get @return The value of the array element at the specified index, or \"\" if the index is out of range ) +/// Get the value of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The value of the array element at the specified index, +/// or \"\" if the index is out of range ) +/// /// public string fnArrayObject_getValue (string arrayobject, int index) @@ -17176,7 +21386,13 @@ public string fnArrayObject_getValue (string arrayobject, int index) } /// -/// Adds a new element to a specified position in the array. - @a index = 0 will insert an element at the start of the array (same as push_front()) - @a index = %array.count() will insert an element at the end of the array (same as push_back()) @param key Key for the new element @param value Value for the new element @param index 0-based index at which to insert the new element ) +/// Adds a new element to a specified position in the array. +/// - @a index = 0 will insert an element at the start of the array (same as push_front()) +/// - @a index = %array.count() will insert an element at the end of the array (same as push_back()) +/// @param key Key for the new element +/// @param value Value for the new element +/// @param index 0-based index at which to insert the new element ) +/// /// public void fnArrayObject_insert (string arrayobject, string key, string value, int index) @@ -17196,7 +21412,9 @@ public void fnArrayObject_insert (string arrayobject, string key, string value, SafeNativeMethods.mwle_fnArrayObject_insert(sbarrayobject, sbkey, sbvalue, index); } /// -/// Moves array pointer to start of array @return Returns the new array pointer ) +/// Moves array pointer to start of array +/// @return Returns the new array pointer ) +/// /// public int fnArrayObject_moveFirst (string arrayobject) @@ -17210,7 +21428,9 @@ public int fnArrayObject_moveFirst (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_moveFirst(sbarrayobject); } /// -/// Moves array pointer to end of array @return Returns the new array pointer ) +/// Moves array pointer to end of array +/// @return Returns the new array pointer ) +/// /// public int fnArrayObject_moveLast (string arrayobject) @@ -17224,7 +21444,9 @@ public int fnArrayObject_moveLast (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_moveLast(sbarrayobject); } /// -/// Moves array pointer to next position @return Returns the new array pointer, or -1 if already at the end ) +/// Moves array pointer to next position +/// @return Returns the new array pointer, or -1 if already at the end ) +/// /// public int fnArrayObject_moveNext (string arrayobject) @@ -17238,7 +21460,9 @@ public int fnArrayObject_moveNext (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_moveNext(sbarrayobject); } /// -/// Moves array pointer to prev position @return Returns the new array pointer, or -1 if already at the start ) +/// Moves array pointer to prev position +/// @return Returns the new array pointer, or -1 if already at the start ) +/// /// public int fnArrayObject_movePrev (string arrayobject) @@ -17253,6 +21477,7 @@ public int fnArrayObject_movePrev (string arrayobject) } /// /// Removes the last element from the array ) +/// /// public void fnArrayObject_pop_back (string arrayobject) @@ -17267,6 +21492,7 @@ public void fnArrayObject_pop_back (string arrayobject) } /// /// Removes the first element from the array ) +/// /// public void fnArrayObject_pop_front (string arrayobject) @@ -17280,7 +21506,11 @@ public void fnArrayObject_pop_front (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_pop_front(sbarrayobject); } /// -/// ), Adds a new element to the end of an array. @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array. +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void fnArrayObject_push_back (string arrayobject, string key, string value) @@ -17300,7 +21530,9 @@ public void fnArrayObject_push_back (string arrayobject, string key, string valu SafeNativeMethods.mwle_fnArrayObject_push_back(sbarrayobject, sbkey, sbvalue); } /// -/// ), Adds a new element to the front of an array ) +/// ), +/// Adds a new element to the front of an array ) +/// /// public void fnArrayObject_push_front (string arrayobject, string key, string value) @@ -17320,7 +21552,9 @@ public void fnArrayObject_push_front (string arrayobject, string key, string val SafeNativeMethods.mwle_fnArrayObject_push_front(sbarrayobject, sbkey, sbvalue); } /// -/// Sets the current pointer index. @param index New 0-based pointer index ) +/// Sets the current pointer index. +/// @param index New 0-based pointer index ) +/// /// public void fnArrayObject_setCurrent (string arrayobject, int index) @@ -17334,7 +21568,10 @@ public void fnArrayObject_setCurrent (string arrayobject, int index) SafeNativeMethods.mwle_fnArrayObject_setCurrent(sbarrayobject, index); } /// -/// Set the key at the given index. @param key New key value @param index 0-based index of the array element to update ) +/// Set the key at the given index. +/// @param key New key value +/// @param index 0-based index of the array element to update ) +/// /// public void fnArrayObject_setKey (string arrayobject, string key, int index) @@ -17351,7 +21588,10 @@ public void fnArrayObject_setKey (string arrayobject, string key, int index) SafeNativeMethods.mwle_fnArrayObject_setKey(sbarrayobject, sbkey, index); } /// -/// Set the value at the given index. @param value New array element value @param index 0-based index of the array element to update ) +/// Set the value at the given index. +/// @param value New array element value +/// @param index 0-based index of the array element to update ) +/// /// public void fnArrayObject_setValue (string arrayobject, string value, int index) @@ -17368,7 +21608,9 @@ public void fnArrayObject_setValue (string arrayobject, string value, int index) SafeNativeMethods.mwle_fnArrayObject_setValue(sbarrayobject, sbvalue, index); } /// -/// Alpha sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sort (string arrayobject, bool ascending) @@ -17383,6 +21625,7 @@ public void fnArrayObject_sort (string arrayobject, bool ascending) } /// /// Alpha sorts the array by value in ascending order ) +/// /// public void fnArrayObject_sorta (string arrayobject) @@ -17397,6 +21640,7 @@ public void fnArrayObject_sorta (string arrayobject) } /// /// Alpha sorts the array by value in descending order ) +/// /// public void fnArrayObject_sortd (string arrayobject) @@ -17410,7 +21654,16 @@ public void fnArrayObject_sortd (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_sortd(sbarrayobject); } /// -/// Sorts the array by value in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @tsexample function mySortCallback(%a, %b) { return strcmp( %a.name, %b.name ); } %array.sortf( \"mySortCallback\" ); @endtsexample ) +/// Sorts the array by value in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @tsexample +/// function mySortCallback(%a, %b) +/// { +/// return strcmp( %a.name, %b.name ); +/// } +/// %array.sortf( \"mySortCallback\" ); +/// @endtsexample ) +/// /// public void fnArrayObject_sortf (string arrayobject, string functionName) @@ -17427,7 +21680,10 @@ public void fnArrayObject_sortf (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortf(sbarrayobject, sbfunctionName); } /// -/// Sorts the array by value in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by value in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void fnArrayObject_sortfd (string arrayobject, string functionName) @@ -17444,7 +21700,10 @@ public void fnArrayObject_sortfd (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortfd(sbarrayobject, sbfunctionName); } /// -/// Sorts the array by key in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void fnArrayObject_sortfk (string arrayobject, string functionName) @@ -17461,7 +21720,10 @@ public void fnArrayObject_sortfk (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortfk(sbarrayobject, sbfunctionName); } /// -/// Sorts the array by key in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void fnArrayObject_sortfkd (string arrayobject, string functionName) @@ -17478,7 +21740,9 @@ public void fnArrayObject_sortfkd (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortfkd(sbarrayobject, sbfunctionName); } /// -/// Alpha sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sortk (string arrayobject, bool ascending) @@ -17493,6 +21757,7 @@ public void fnArrayObject_sortk (string arrayobject, bool ascending) } /// /// Alpha sorts the array by key in ascending order ) +/// /// public void fnArrayObject_sortka (string arrayobject) @@ -17507,6 +21772,7 @@ public void fnArrayObject_sortka (string arrayobject) } /// /// Alpha sorts the array by key in descending order ) +/// /// public void fnArrayObject_sortkd (string arrayobject) @@ -17520,7 +21786,9 @@ public void fnArrayObject_sortkd (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_sortkd(sbarrayobject); } /// -/// Numerically sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sortn (string arrayobject, bool ascending) @@ -17535,6 +21803,7 @@ public void fnArrayObject_sortn (string arrayobject, bool ascending) } /// /// Numerically sorts the array by value in ascending order ) +/// /// public void fnArrayObject_sortna (string arrayobject) @@ -17549,6 +21818,7 @@ public void fnArrayObject_sortna (string arrayobject) } /// /// Numerically sorts the array by value in descending order ) +/// /// public void fnArrayObject_sortnd (string arrayobject) @@ -17562,7 +21832,9 @@ public void fnArrayObject_sortnd (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_sortnd(sbarrayobject); } /// -/// Numerically sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sortnk (string arrayobject, bool ascending) @@ -17577,6 +21849,7 @@ public void fnArrayObject_sortnk (string arrayobject, bool ascending) } /// /// Numerical sorts the array by key in ascending order ) +/// /// public void fnArrayObject_sortnka (string arrayobject) @@ -17591,6 +21864,7 @@ public void fnArrayObject_sortnka (string arrayobject) } /// /// Numerical sorts the array by key in descending order ) +/// /// public void fnArrayObject_sortnkd (string arrayobject) @@ -17605,6 +21879,7 @@ public void fnArrayObject_sortnkd (string arrayobject) } /// /// Removes any elements that have duplicated keys (leaving the first instance) ) +/// /// public void fnArrayObject_uniqueKey (string arrayobject) @@ -17619,6 +21894,7 @@ public void fnArrayObject_uniqueKey (string arrayobject) } /// /// Removes any elements that have duplicated values (leaving the first instance) ) +/// /// public void fnArrayObject_uniqueValue (string arrayobject) @@ -17632,7 +21908,10 @@ public void fnArrayObject_uniqueValue (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_uniqueValue(sbarrayobject); } /// -/// Move the camera to fully view the given radius. @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). @param radius The radius to view.) +/// Move the camera to fully view the given radius. +/// @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). +/// @param radius The radius to view.) +/// /// public void fnCamera_autoFitRadius (string camera, float radius) @@ -17646,7 +21925,10 @@ public void fnCamera_autoFitRadius (string camera, float radius) SafeNativeMethods.mwle_fnCamera_autoFitRadius(sbcamera, radius); } /// -/// Get the angular velocity for a Newton mode camera. @returns The angular velocity in the form of \"x y z\". @note Only returns useful results when Camera::newtonRotation is set to true.) +/// Get the angular velocity for a Newton mode camera. +/// @returns The angular velocity in the form of \"x y z\". +/// @note Only returns useful results when Camera::newtonRotation is set to true.) +/// /// public string fnCamera_getAngularVelocity (string camera) @@ -17663,7 +21945,9 @@ public string fnCamera_getAngularVelocity (string camera) } /// -/// Returns the current camera control mode. @see CameraMotionMode) +/// Returns the current camera control mode. +/// @see CameraMotionMode) +/// /// public int fnCamera_getMode (string camera) @@ -17677,7 +21961,10 @@ public int fnCamera_getMode (string camera) return SafeNativeMethods.mwle_fnCamera_getMode(sbcamera); } /// -/// Get the camera's offset from its orbit or tracking point. The offset is added to the camera's position when set to CameraMode::OrbitObject. @returns The offset in the form of \"x y z\".) +/// Get the camera's offset from its orbit or tracking point. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @returns The offset in the form of \"x y z\".) +/// /// public string fnCamera_getOffset (string camera) @@ -17694,7 +21981,9 @@ public string fnCamera_getOffset (string camera) } /// -/// Get the camera's position in the world. @returns The position in the form of \"x y z\".) +/// Get the camera's position in the world. +/// @returns The position in the form of \"x y z\".) +/// /// public string fnCamera_getPosition (string camera) @@ -17711,7 +22000,9 @@ public string fnCamera_getPosition (string camera) } /// -/// Get the camera's Euler rotation in radians. @returns The rotation in radians in the form of \"x y z\".) +/// Get the camera's Euler rotation in radians. +/// @returns The rotation in radians in the form of \"x y z\".) +/// /// public string fnCamera_getRotation (string camera) @@ -17728,7 +22019,10 @@ public string fnCamera_getRotation (string camera) } /// -/// Get the velocity for the camera. @returns The camera's velocity in the form of \"x y z\". @note Only useful when the Camera is in Newton mode.) +/// Get the velocity for the camera. +/// @returns The camera's velocity in the form of \"x y z\". +/// @note Only useful when the Camera is in Newton mode.) +/// /// public string fnCamera_getVelocity (string camera) @@ -17745,7 +22039,9 @@ public string fnCamera_getVelocity (string camera) } /// -/// Is the camera in edit orbit mode? @returns true if the camera is in edit orbit mode.) +/// Is the camera in edit orbit mode? +/// @returns true if the camera is in edit orbit mode.) +/// /// public bool fnCamera_isEditOrbitMode (string camera) @@ -17759,7 +22055,9 @@ public bool fnCamera_isEditOrbitMode (string camera) return SafeNativeMethods.mwle_fnCamera_isEditOrbitMode(sbcamera)>=1; } /// -/// Is this a Newton Fly mode camera with damped rotation? @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// Is this a Newton Fly mode camera with damped rotation? +/// @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// /// public bool fnCamera_isRotationDamped (string camera) @@ -17773,7 +22071,9 @@ public bool fnCamera_isRotationDamped (string camera) return SafeNativeMethods.mwle_fnCamera_isRotationDamped(sbcamera)>=1; } /// -/// Point the camera at the specified position. Does not work in Orbit or Track modes. @param point The position to point the camera at.) +/// Point the camera at the specified position. Does not work in Orbit or Track modes. +/// @param point The position to point the camera at.) +/// /// public void fnCamera_lookAt (string camera, string point) @@ -17790,7 +22090,10 @@ public void fnCamera_lookAt (string camera, string point) SafeNativeMethods.mwle_fnCamera_lookAt(sbcamera, sbpoint); } /// -/// Set the angular drag for a Newton mode camera. @param drag The angular drag applied while the camera is rotating. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular drag for a Newton mode camera. +/// @param drag The angular drag applied while the camera is rotating. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void fnCamera_setAngularDrag (string camera, float drag) @@ -17804,7 +22107,10 @@ public void fnCamera_setAngularDrag (string camera, float drag) SafeNativeMethods.mwle_fnCamera_setAngularDrag(sbcamera, drag); } /// -/// Set the angular force for a Newton mode camera. @param force The angular force applied when attempting to rotate the camera. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular force for a Newton mode camera. +/// @param force The angular force applied when attempting to rotate the camera. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void fnCamera_setAngularForce (string camera, float force) @@ -17818,7 +22124,10 @@ public void fnCamera_setAngularForce (string camera, float force) SafeNativeMethods.mwle_fnCamera_setAngularForce(sbcamera, force); } /// -/// Set the angular velocity for a Newton mode camera. @param velocity The angular velocity infor form of \"x y z\". @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular velocity for a Newton mode camera. +/// @param velocity The angular velocity infor form of \"x y z\". +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void fnCamera_setAngularVelocity (string camera, string velocity) @@ -17835,7 +22144,10 @@ public void fnCamera_setAngularVelocity (string camera, string velocity) SafeNativeMethods.mwle_fnCamera_setAngularVelocity(sbcamera, sbvelocity); } /// -/// Set the Newton mode camera brake multiplier when trigger[1] is active. @param multiplier The brake multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera brake multiplier when trigger[1] is active. +/// @param multiplier The brake multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setBrakeMultiplier (string camera, float multiplier) @@ -17849,7 +22161,10 @@ public void fnCamera_setBrakeMultiplier (string camera, float multiplier) SafeNativeMethods.mwle_fnCamera_setBrakeMultiplier(sbcamera, multiplier); } /// -/// Set the drag for a Newton mode camera. @param drag The drag applied to the camera while moving. @note Only used when Camera is in Newton mode.) +/// Set the drag for a Newton mode camera. +/// @param drag The drag applied to the camera while moving. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setDrag (string camera, float drag) @@ -17863,7 +22178,10 @@ public void fnCamera_setDrag (string camera, float drag) SafeNativeMethods.mwle_fnCamera_setDrag(sbcamera, drag); } /// -/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). @note This method is generally used only within the World Editor and other tools. To orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). +/// @note This method is generally used only within the World Editor and other tools. To +/// orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// /// public void fnCamera_setEditOrbitMode (string camera) @@ -17877,7 +22195,9 @@ public void fnCamera_setEditOrbitMode (string camera) SafeNativeMethods.mwle_fnCamera_setEditOrbitMode(sbcamera); } /// -/// Set the editor camera's orbit point. @param point The point the camera will orbit in the form of \"x y z\".) +/// Set the editor camera's orbit point. +/// @param point The point the camera will orbit in the form of \"x y z\".) +/// /// public void fnCamera_setEditOrbitPoint (string camera, string point) @@ -17894,7 +22214,10 @@ public void fnCamera_setEditOrbitPoint (string camera, string point) SafeNativeMethods.mwle_fnCamera_setEditOrbitPoint(sbcamera, sbpoint); } /// -/// Set the force applied to a Newton mode camera while moving. @param force The force applied to the camera while attempting to move. @note Only used when Camera is in Newton mode.) +/// Set the force applied to a Newton mode camera while moving. +/// @param force The force applied to the camera while attempting to move. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setFlyForce (string camera, float force) @@ -17908,7 +22231,11 @@ public void fnCamera_setFlyForce (string camera, float force) SafeNativeMethods.mwle_fnCamera_setFlyForce(sbcamera, force); } /// -/// Set the camera to fly freely. Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode and Camera::newtonRotation.) +/// Set the camera to fly freely. +/// Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion +/// and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode +/// and Camera::newtonRotation.) +/// /// public void fnCamera_setFlyMode (string camera) @@ -17922,7 +22249,10 @@ public void fnCamera_setFlyMode (string camera) SafeNativeMethods.mwle_fnCamera_setFlyMode(sbcamera); } /// -/// Set the mass for a Newton mode camera. @param mass The mass used during ease-in and ease-out calculations. @note Only used when Camera is in Newton mode.) +/// Set the mass for a Newton mode camera. +/// @param mass The mass used during ease-in and ease-out calculations. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setMass (string camera, float mass) @@ -17936,7 +22266,11 @@ public void fnCamera_setMass (string camera, float mass) SafeNativeMethods.mwle_fnCamera_setMass(sbcamera, mass); } /// -/// Set the camera to fly freely, but with ease-in and ease-out. This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but activates the ease-in and ease-out on the camera's movement. To also activate Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// Set the camera to fly freely, but with ease-in and ease-out. +/// This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but +/// activates the ease-in and ease-out on the camera's movement. To also activate +/// Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// /// public void fnCamera_setNewtonFlyMode (string camera) @@ -17950,7 +22284,10 @@ public void fnCamera_setNewtonFlyMode (string camera) SafeNativeMethods.mwle_fnCamera_setNewtonFlyMode(sbcamera); } /// -/// Set the camera's offset. The offset is added to the camera's position when set to CameraMode::OrbitObject. @param offset The distance to offset the camera by in the form of \"x y z\".) +/// Set the camera's offset. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @param offset The distance to offset the camera by in the form of \"x y z\".) +/// /// public void fnCamera_setOffset (string camera, string offset) @@ -17967,10 +22304,21 @@ public void fnCamera_setOffset (string camera, string offset) SafeNativeMethods.mwle_fnCamera_setOffset(sbcamera, sboffset); } /// -/// Set the camera to orbit around the given object, or if none is given, around the given point. @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitObject() @see Camera::setOrbitPoint()) +/// Set the camera to orbit around the given object, or if none is given, around the given point. +/// @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead +/// @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitObject() +/// @see Camera::setOrbitPoint()) +/// /// -public bool fnCamera_setOrbitMode (string camera, string orbitObject, string orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj, string offset, bool lockedx) +public void fnCamera_setOrbitMode (string camera, string orbitObject, string orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj, string offset, bool lockedx) { if(Debugging) System.Console.WriteLine("----------------->Extern Call 'fnCamera_setOrbitMode'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" \"{4}\" \"{5}\" \"{6}\" \"{7}\" \"{8}\" ",camera,orbitObject,orbitPoint,minDistance,maxDistance,initDistance,ownClientObj,offset,lockedx)); @@ -17987,10 +22335,21 @@ public bool fnCamera_setOrbitMode (string camera, string orbitObject, string orb if (offset != null) sboffset = new StringBuilder(offset, 1024); -return SafeNativeMethods.mwle_fnCamera_setOrbitMode(sbcamera, sborbitObject, sborbitPoint, minDistance, maxDistance, initDistance, ownClientObj, sboffset, lockedx)>=1; +SafeNativeMethods.mwle_fnCamera_setOrbitMode(sbcamera, sborbitObject, sborbitPoint, minDistance, maxDistance, initDistance, ownClientObj, sboffset, lockedx); } /// -/// Set the camera to orbit around a given object. @param orbitObject The object to orbit around. @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @returns false if the given object could not be found. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given object. +/// @param orbitObject The object to orbit around. +/// @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @returns false if the given object could not be found. +/// @see Camera::setOrbitMode()) +/// /// public bool fnCamera_setOrbitObject (string camera, string orbitObject, string rotation, float minDistance, float maxDistance, float initDistance, bool ownClientObject, string offset, bool lockedx) @@ -18013,7 +22372,15 @@ public bool fnCamera_setOrbitObject (string camera, string orbitObject, string r return SafeNativeMethods.mwle_fnCamera_setOrbitObject(sbcamera, sborbitObject, sbrotation, minDistance, maxDistance, initDistance, ownClientObject, sboffset, lockedx)>=1; } /// -/// Set the camera to orbit around a given point. @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given point. +/// @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitMode()) +/// /// public void fnCamera_setOrbitPoint (string camera, string orbitPoint, float minDistance, float maxDistance, float initDistance, string offset, bool lockedx) @@ -18033,7 +22400,10 @@ public void fnCamera_setOrbitPoint (string camera, string orbitPoint, float minD SafeNativeMethods.mwle_fnCamera_setOrbitPoint(sbcamera, sborbitPoint, minDistance, maxDistance, initDistance, sboffset, lockedx); } /// -/// Set the camera's Euler rotation in radians. @param rot The rotation in radians in the form of \"x y z\". @note Rotation around the Y axis is ignored ) +/// Set the camera's Euler rotation in radians. +/// @param rot The rotation in radians in the form of \"x y z\". +/// @note Rotation around the Y axis is ignored ) +/// /// public void fnCamera_setRotation (string camera, string rot) @@ -18050,7 +22420,10 @@ public void fnCamera_setRotation (string camera, string rot) SafeNativeMethods.mwle_fnCamera_setRotation(sbcamera, sbrot); } /// -/// Set the Newton mode camera speed multiplier when trigger[0] is active. @param multiplier The speed multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera speed multiplier when trigger[0] is active. +/// @param multiplier The speed multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setSpeedMultiplier (string camera, float multiplier) @@ -18064,7 +22437,11 @@ public void fnCamera_setSpeedMultiplier (string camera, float multiplier) SafeNativeMethods.mwle_fnCamera_setSpeedMultiplier(sbcamera, multiplier); } /// -/// Set the camera to track a given object. @param trackObject The object to track. @param offset [optional] An offset added to the camera's position. Default is no offset. @returns false if the given object could not be found.) +/// Set the camera to track a given object. +/// @param trackObject The object to track. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @returns false if the given object could not be found.) +/// /// public bool fnCamera_setTrackObject (string camera, string trackObject, string offset) @@ -18084,7 +22461,12 @@ public bool fnCamera_setTrackObject (string camera, string trackObject, string o return SafeNativeMethods.mwle_fnCamera_setTrackObject(sbcamera, sbtrackObject, sboffset)>=1; } /// -/// Set if there is a valid editor camera orbit point. When validPoint is set to false the Camera operates as if it is in Fly mode rather than an Orbit mode. @param validPoint Indicates the validity of the orbit point. @note Only used when Camera is in Edit Orbit Mode.) +/// Set if there is a valid editor camera orbit point. +/// When validPoint is set to false the Camera operates as if it is +/// in Fly mode rather than an Orbit mode. +/// @param validPoint Indicates the validity of the orbit point. +/// @note Only used when Camera is in Edit Orbit Mode.) +/// /// public void fnCamera_setValidEditOrbitPoint (string camera, bool validPoint) @@ -18098,7 +22480,10 @@ public void fnCamera_setValidEditOrbitPoint (string camera, bool validPoint) SafeNativeMethods.mwle_fnCamera_setValidEditOrbitPoint(sbcamera, validPoint); } /// -/// Set the velocity for the camera. @param velocity The camera's velocity in the form of \"x y z\". @note Only affects the Camera when in Newton mode.) +/// Set the velocity for the camera. +/// @param velocity The camera's velocity in the form of \"x y z\". +/// @note Only affects the Camera when in Newton mode.) +/// /// public void fnCamera_setVelocity (string camera, string velocity) @@ -18115,20 +22500,6 @@ public void fnCamera_setVelocity (string camera, string velocity) SafeNativeMethods.mwle_fnCamera_setVelocity(sbcamera, sbvelocity); } /// -/// Change coverage of the cloudlayer.) -/// - -public void fnCloudLayer_ChangeCoverage (string cloudlayer, float newCoverage) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fnCloudLayer_ChangeCoverage'" + string.Format("\"{0}\" \"{1}\" ",cloudlayer,newCoverage)); -StringBuilder sbcloudlayer = null; -if (cloudlayer != null) - sbcloudlayer = new StringBuilder(cloudlayer, 1024); - -SafeNativeMethods.mwle_fnCloudLayer_ChangeCoverage(sbcloudlayer, newCoverage); -} -/// /// @brief Returns true if someone is already using this cover point.) /// /// @@ -18144,7 +22515,9 @@ public bool fnCoverPoint_isOccupied (string coverpoint) return SafeNativeMethods.mwle_fnCoverPoint_isOccupied(sbcoverpoint)>=1; } /// -/// Returns the script filename of where the CubemapData object was defined. This is used by the material editor. ) +/// Returns the script filename of where the CubemapData object was +/// defined. This is used by the material editor. ) +/// /// public string fnCubemapData_getFilename (string cubemapdata) @@ -18162,6 +22535,7 @@ public string fnCubemapData_getFilename (string cubemapdata) } /// /// Update the assigned cubemaps faces. ) +/// /// public void fnCubemapData_updateFaces (string cubemapdata) @@ -18175,7 +22549,26 @@ public void fnCubemapData_updateFaces (string cubemapdata) SafeNativeMethods.mwle_fnCubemapData_updateFaces(sbcubemapdata); } /// -/// 1.0 1.0 1.0, 1.0 0.0 0.0), @brief Manually set this piece of debris at the given position with the given velocity. Usually you do not manually create Debris objects as they are generated through other means, such as an Explosion. This method exists when you do manually create a Debris object and want to have it start moving. @param inputPosition Position to place the debris. @param inputVelocity Velocity to move the debris after it has been placed. @return Always returns true. @tsexample // Define the position %position = \"1.0 1.0 1.0\"; // Define the velocity %velocity = \"1.0 0.0 0.0\"; // Inform the debris object of its new position and velocity %debris.init(%position,%velocity); @endtsexample) +/// 1.0 1.0 1.0, 1.0 0.0 0.0), +/// @brief Manually set this piece of debris at the given position with the given velocity. +/// +/// Usually you do not manually create Debris objects as they are generated through other means, +/// such as an Explosion. This method exists when you do manually create a Debris object and +/// want to have it start moving. +/// +/// @param inputPosition Position to place the debris. +/// @param inputVelocity Velocity to move the debris after it has been placed. +/// @return Always returns true. +/// +/// @tsexample +/// // Define the position +/// %position = \"1.0 1.0 1.0\"; +/// // Define the velocity +/// %velocity = \"1.0 0.0 0.0\"; +/// // Inform the debris object of its new position and velocity +/// %debris.init(%position,%velocity); +/// @endtsexample) +/// /// public bool fnDebris_init (string debris, string inputPosition, string inputVelocity) @@ -18196,6 +22589,7 @@ public bool fnDebris_init (string debris, string inputPosition, string inputVelo } /// /// Draws an axis aligned box primitive within the two 3d points. ) +/// /// public void fnDebugDrawer_drawBox (string debugdrawer, string a, string b, string color) @@ -18219,6 +22613,7 @@ public void fnDebugDrawer_drawBox (string debugdrawer, string a, string b, strin } /// /// Draws a line primitive between two 3d points. ) +/// /// public void fnDebugDrawer_drawLine (string debugdrawer, string a, string b, string color) @@ -18242,6 +22637,7 @@ public void fnDebugDrawer_drawLine (string debugdrawer, string a, string b, stri } /// /// Sets the \"time to live\" (TTL) for the last rendered primitive. ) +/// /// public void fnDebugDrawer_setLastTTL (string debugdrawer, uint ms) @@ -18256,6 +22652,7 @@ public void fnDebugDrawer_setLastTTL (string debugdrawer, uint ms) } /// /// Sets the z buffer reading state for the last rendered primitive. ) +/// /// public void fnDebugDrawer_setLastZTest (string debugdrawer, bool enabled) @@ -18270,6 +22667,7 @@ public void fnDebugDrawer_setLastZTest (string debugdrawer, bool enabled) } /// /// Toggles the rendering of DebugDrawer primitives. ) +/// /// public void fnDebugDrawer_toggleDrawing (string debugdrawer) @@ -18284,6 +22682,7 @@ public void fnDebugDrawer_toggleDrawing (string debugdrawer) } /// /// Toggles freeze mode which keeps the currently rendered primitives from expiring. ) +/// /// public void fnDebugDrawer_toggleFreeze (string debugdrawer) @@ -18297,7 +22696,13 @@ public void fnDebugDrawer_toggleFreeze (string debugdrawer) SafeNativeMethods.mwle_fnDebugDrawer_toggleFreeze(sbdebugdrawer); } /// -/// Recompute the imagemap sub-texture rectangles for this DecalData. @tsexample // Inform the decal object to reload its imagemap and frame data. %decalData.texRows = 4; %decalData.postApply(); @endtsexample) +/// Recompute the imagemap sub-texture rectangles for this DecalData. +/// @tsexample +/// // Inform the decal object to reload its imagemap and frame data. +/// %decalData.texRows = 4; +/// %decalData.postApply(); +/// @endtsexample) +/// /// public void fnDecalData_postApply (string decaldata) @@ -18311,7 +22716,12 @@ public void fnDecalData_postApply (string decaldata) SafeNativeMethods.mwle_fnDecalData_postApply(sbdecaldata); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit the material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// the material and other fields ( not including nodes ) +/// to client objects. +/// ) +/// /// public void fnDecalRoad_postApply (string decalroad) @@ -18325,7 +22735,10 @@ public void fnDecalRoad_postApply (string decalroad) SafeNativeMethods.mwle_fnDecalRoad_postApply(sbdecalroad); } /// -/// Intended as a helper to developers and editor scripts. Force DecalRoad to update it's spline and reclip geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force DecalRoad to update it's spline and reclip geometry. +/// ) +/// /// public void fnDecalRoad_regenerate (string decalroad) @@ -18339,7 +22752,13 @@ public void fnDecalRoad_regenerate (string decalroad) SafeNativeMethods.mwle_fnDecalRoad_regenerate(sbdecalroad); } /// -/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method @param methodName The method's name as a string @param argi Any arguments to pass to the method @return No return value @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method +/// @param methodName The method's name as a string +/// @param argi Any arguments to pass to the method +/// @return No return value +/// @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// +/// /// public void fnDynamicConsoleMethodComponent_callMethod (string dynamicconsolemethodcomponent, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21, string a22, string a23, string a24, string a25, string a26, string a27, string a28, string a29, string a30, string a31, string a32, string a33, string a34, string a35, string a36, string a37, string a38, string a39, string a40, string a41, string a42, string a43, string a44, string a45, string a46, string a47, string a48, string a49, string a50, string a51, string a52, string a53, string a54, string a55, string a56, string a57, string a58, string a59, string a60, string a61, string a62, string a63) @@ -18540,6 +22959,7 @@ public void fnDynamicConsoleMethodComponent_callMethod (string dynamicconsolemet } /// /// ) +/// /// public int fnEditTSCtrl_getDisplayType (string edittsctrl) @@ -18554,6 +22974,7 @@ public int fnEditTSCtrl_getDisplayType (string edittsctrl) } /// /// ) +/// /// public int fnEditTSCtrl_getGizmo (string edittsctrl) @@ -18568,6 +22989,7 @@ public int fnEditTSCtrl_getGizmo (string edittsctrl) } /// /// Return the FOV for orthographic views. ) +/// /// public float fnEditTSCtrl_getOrthoFOV (string edittsctrl) @@ -18582,6 +23004,7 @@ public float fnEditTSCtrl_getOrthoFOV (string edittsctrl) } /// /// ) +/// /// public bool fnEditTSCtrl_isMiddleMouseDown (string edittsctrl) @@ -18596,6 +23019,7 @@ public bool fnEditTSCtrl_isMiddleMouseDown (string edittsctrl) } /// /// ) +/// /// public void fnEditTSCtrl_renderBox (string edittsctrl, string pos, string size) @@ -18616,6 +23040,7 @@ public void fnEditTSCtrl_renderBox (string edittsctrl, string pos, string size) } /// /// ) +/// /// public void fnEditTSCtrl_renderCircle (string edittsctrl, string pos, string normal, float radius, int segments) @@ -18636,6 +23061,7 @@ public void fnEditTSCtrl_renderCircle (string edittsctrl, string pos, string nor } /// /// ) +/// /// public void fnEditTSCtrl_renderLine (string edittsctrl, string start, string end, float lineWidth) @@ -18656,6 +23082,7 @@ public void fnEditTSCtrl_renderLine (string edittsctrl, string start, string end } /// /// ) +/// /// public void fnEditTSCtrl_renderSphere (string edittsctrl, string pos, float radius, int sphereLevel) @@ -18673,6 +23100,7 @@ public void fnEditTSCtrl_renderSphere (string edittsctrl, string pos, float radi } /// /// ) +/// /// public void fnEditTSCtrl_renderTriangle (string edittsctrl, string a, string b, string c) @@ -18696,6 +23124,7 @@ public void fnEditTSCtrl_renderTriangle (string edittsctrl, string a, string b, } /// /// ) +/// /// public void fnEditTSCtrl_setDisplayType (string edittsctrl, int displayType) @@ -18710,6 +23139,7 @@ public void fnEditTSCtrl_setDisplayType (string edittsctrl, int displayType) } /// /// Set the FOV for to use for orthographic views. ) +/// /// public void fnEditTSCtrl_setOrthoFOV (string edittsctrl, float fov) @@ -18723,7 +23153,91 @@ public void fnEditTSCtrl_setOrthoFOV (string edittsctrl, float fov) SafeNativeMethods.mwle_fnEditTSCtrl_setOrthoFOV(sbedittsctrl, fov); } /// -/// @brief Launches the OS file browser After an Execute() call, the chosen file name and path is available in one of two areas. If only a single file selection is permitted, the results will be stored in the @a fileName attribute. If multiple file selection is permitted, the results will be stored in the @a files array. The total number of files in the array will be stored in the @a fileCount attribute. @tsexample // NOTE: This is not he preferred class to use, but this still works // Create the file dialog %baseFileDialog = new FileDialog() { // Allow browsing of all file types filters = \"*.*\"; // No default file defaultFile = ; // Set default path relative to project defaultPath = \"./\"; // Set the title title = \"Durpa\"; // Allow changing of path you are browsing changePath = true; }; // Launch the file dialog %baseFileDialog.Execute(); // Don't forget to cleanup %baseFileDialog.delete(); // A better alternative is to use the // derived classes which are specific to file open and save // Create a dialog dedicated to opening files %openFileDlg = new OpenFileDialog() { // Look for jpg image files // First part is the descriptor|second part is the extension Filters = \"Jepg Files|*.jpg\"; // Allow browsing through other folders ChangePath = true; // Only allow opening of one file at a time MultipleFiles = false; }; // Launch the open file dialog %result = %openFileDlg.Execute(); // Obtain the chosen file name and path if ( %result ) { %seletedFile = %openFileDlg.file; } else { %selectedFile = \"\"; } // Cleanup %openFileDlg.delete(); // Create a dialog dedicated to saving a file %saveFileDlg = new SaveFileDialog() { // Only allow for saving of COLLADA files Filters = \"COLLADA Files (*.dae)|*.dae|\"; // Default save path to where the WorldEditor last saved DefaultPath = $pref::WorldEditor::LastPath; // No default file specified DefaultFile = \"\"; // Do not allow the user to change to a new directory ChangePath = false; // Prompt the user if they are going to overwrite an existing file OverwritePrompt = true; }; // Launch the save file dialog %result = %saveFileDlg.Execute(); // Obtain the file name %selectedFile = \"\"; if ( %result ) %selectedFile = %saveFileDlg.file; // Cleanup %saveFileDlg.delete(); @endtsexample @return True if the file was selected was successfully found (opened) or declared (saved).) +/// @brief Launches the OS file browser +/// +/// After an Execute() call, the chosen file name and path is available in one of two areas. +/// If only a single file selection is permitted, the results will be stored in the @a fileName +/// attribute. +/// +/// If multiple file selection is permitted, the results will be stored in the +/// @a files array. The total number of files in the array will be stored in the +/// @a fileCount attribute. +/// +/// @tsexample +/// // NOTE: This is not he preferred class to use, but this still works +/// // Create the file dialog +/// %baseFileDialog = new FileDialog() +/// { +/// // Allow browsing of all file types +/// filters = \"*.*\"; +/// // No default file +/// defaultFile = ; +/// // Set default path relative to project +/// defaultPath = \"./\"; +/// // Set the title +/// title = \"Durpa\"; +/// // Allow changing of path you are browsing +/// changePath = true; +/// }; +/// // Launch the file dialog +/// %baseFileDialog.Execute(); +/// +/// // Don't forget to cleanup +/// %baseFileDialog.delete(); +/// +/// // A better alternative is to use the +/// // derived classes which are specific to file open and save +/// // Create a dialog dedicated to opening files +/// %openFileDlg = new OpenFileDialog() +/// { +/// // Look for jpg image files +/// // First part is the descriptor|second part is the extension +/// Filters = \"Jepg Files|*.jpg\"; +/// // Allow browsing through other folders +/// ChangePath = true; +/// // Only allow opening of one file at a time +/// MultipleFiles = false; +/// }; +/// // Launch the open file dialog +/// %result = %openFileDlg.Execute(); +/// // Obtain the chosen file name and path +/// if ( %result ) +/// { +/// %seletedFile = %openFileDlg.file; +/// } +/// else +/// { +/// %selectedFile = \"\"; +/// } +/// // Cleanup +/// %openFileDlg.delete(); +/// +/// // Create a dialog dedicated to saving a file +/// %saveFileDlg = new SaveFileDialog() +/// { +/// // Only allow for saving of COLLADA files +/// Filters = \"COLLADA Files (*.dae)|*.dae|\"; +/// // Default save path to where the WorldEditor last saved +/// DefaultPath = $pref::WorldEditor::LastPath; +/// // No default file specified +/// DefaultFile = \"\"; +/// // Do not allow the user to change to a new directory +/// ChangePath = false; +/// // Prompt the user if they are going to overwrite an existing file +/// OverwritePrompt = true; +/// }; +/// // Launch the save file dialog +/// %result = %saveFileDlg.Execute(); +/// // Obtain the file name +/// %selectedFile = \"\"; +/// if ( %result ) +/// %selectedFile = %saveFileDlg.file; +/// // Cleanup +/// %saveFileDlg.delete(); +/// @endtsexample +/// +/// @return True if the file was selected was successfully found (opened) or declared (saved).) +/// /// public bool fnFileDialog_Execute (string filedialog) @@ -18737,7 +23251,32 @@ public bool fnFileDialog_Execute (string filedialog) return SafeNativeMethods.mwle_fnFileDialog_Execute(sbfiledialog)>=1; } /// -/// @brief Close the file. It is EXTREMELY important that you call this function when you are finished reading or writing to a file. Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. Remember: Open, Read/Write, Close, Delete...in that order! @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); // Close the file when finished %fileWrite.close(); // Cleanup the file object %fileWrite.delete(); @endtsexample) +/// @brief Close the file. +/// +/// It is EXTREMELY important that you call this function when you are finished reading or writing to a file. +/// Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. +/// Remember: Open, Read/Write, Close, Delete...in that order! +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// // Close the file when finished +/// %fileWrite.close(); +/// // Cleanup the file object +/// %fileWrite.delete(); +/// @endtsexample) +/// /// public void fnFileObject_close (string fileobject) @@ -18751,7 +23290,25 @@ public void fnFileObject_close (string fileobject) SafeNativeMethods.mwle_fnFileObject_close(sbfileobject); } /// -/// @brief Determines if the parser for this FileObject has reached the end of the file @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Keep reading until we reach the end of the file while( !%fileRead.isEOF() ) { %line = %fileRead.readline(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); @endtsexample @return True if the parser has reached the end of the file, false otherwise) +/// @brief Determines if the parser for this FileObject has reached the end of the file +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Keep reading until we reach the end of the file +/// while( !%fileRead.isEOF() ) +/// { +/// %line = %fileRead.readline(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise) +/// /// public bool fnFileObject_isEOF (string fileobject) @@ -18765,7 +23322,23 @@ public bool fnFileObject_isEOF (string fileobject) return SafeNativeMethods.mwle_fnFileObject_isEOF(sbfileobject)>=1; } /// -/// @brief Open a specified file for writing, adding data to the end of the file There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. @param filename Path, name, and extension of file to append to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created // If it does exist, whatever we write will be added to the end %result = %fileWrite.OpenForAppend(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing, adding data to the end of the file +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), +/// which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. +/// +/// @param filename Path, name, and extension of file to append to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// // If it does exist, whatever we write will be added to the end +/// %result = %fileWrite.OpenForAppend(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool fnFileObject_openForAppend (string fileobject, string filename) @@ -18782,7 +23355,21 @@ public bool fnFileObject_openForAppend (string fileobject, string filename) return SafeNativeMethods.mwle_fnFileObject_openForAppend(sbfileobject, sbfilename)>=1; } /// -/// @brief Open a specified file for reading There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %result = %fileRead.OpenForRead(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for reading +/// +/// There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %result = %fileRead.OpenForRead(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool fnFileObject_openForRead (string fileobject, string filename) @@ -18799,7 +23386,21 @@ public bool fnFileObject_openForRead (string fileobject, string filename) return SafeNativeMethods.mwle_fnFileObject_openForRead(sbfileobject, sbfilename)>=1; } /// -/// @brief Open a specified file for writing There is no limit as to what kind of file you can write. Any format and data is allowable, not just text @param filename Path, name, and extension of file to write to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %result = %fileWrite.OpenForWrite(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text +/// +/// @param filename Path, name, and extension of file to write to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %result = %fileWrite.OpenForWrite(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool fnFileObject_openForWrite (string fileobject, string filename) @@ -18816,7 +23417,31 @@ public bool fnFileObject_openForWrite (string fileobject, string filename) return SafeNativeMethods.mwle_fnFileObject_openForWrite(sbfileobject, sbfilename)>=1; } /// -/// @brief Read a line from the file without moving the stream position. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); @endtsexample @return String containing the line of data that was just peeked) +/// @brief Read a line from the file without moving the stream position. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just peeked) +/// /// public string fnFileObject_peekLine (string fileobject) @@ -18833,7 +23458,24 @@ public string fnFileObject_peekLine (string fileobject) } /// -/// @brief Read a line from file. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Read in the first line %line = %fileRead.readline(); // Print the line we just read echo(%line); @endtsexample @return String containing the line of data that was just read) +/// @brief Read a line from file. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Read in the first line +/// %line = %fileRead.readline(); +/// // Print the line we just read +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just read) +/// /// public string fnFileObject_readLine (string fileobject) @@ -18850,7 +23492,24 @@ public string fnFileObject_readLine (string fileobject) } /// -/// @brief Write a line to the file, if it was opened for writing. There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param text The data we are writing out to file. @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %fileWrite.OpenForWrite(\"./test.txt\"); // Write a line to the text files %fileWrite.writeLine(\"READ. READ CODE. CODE\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Write a line to the file, if it was opened for writing. +/// +/// There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param text The data we are writing out to file. +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %fileWrite.OpenForWrite(\"./test.txt\"); +/// // Write a line to the text files +/// %fileWrite.writeLine(\"READ. READ CODE. CODE\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public void fnFileObject_writeLine (string fileobject, string text) @@ -18867,7 +23526,19 @@ public void fnFileObject_writeLine (string fileobject, string text) SafeNativeMethods.mwle_fnFileObject_writeLine(sbfileobject, sbtext); } /// -/// @brief Close the file. You can no longer read or write to it unless you open it again. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see open()) +/// @brief Close the file. You can no longer read or write to it unless you open it again. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see open()) +/// /// public void fnFileStreamObject_close (string filestreamobject) @@ -18881,7 +23552,34 @@ public void fnFileStreamObject_close (string filestreamobject) SafeNativeMethods.mwle_fnFileStreamObject_close(sbfilestreamobject); } /// -/// @brief Open a file for reading, writing, reading and writing, or appending Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting at the end of the files existing contents. @param filename Name of file to open @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the file was successfully opened, false if something went wrong @see close()) +/// @brief Open a file for reading, writing, reading and writing, or appending +/// +/// Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new +/// file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. +/// +/// \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can +/// move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting +/// at the end of the files existing contents. +/// +/// @param filename Name of file to open +/// @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the file was successfully opened, false if something went wrong +/// +/// @see close()) +/// /// public bool fnFileStreamObject_open (string filestreamobject, string filename, string openMode) @@ -18901,7 +23599,10 @@ public bool fnFileStreamObject_open (string filestreamobject, string filename, s return SafeNativeMethods.mwle_fnFileStreamObject_open(sbfilestreamobject, sbfilename, sbopenMode)>=1; } /// -/// @brief Set whether the vehicle should temporarily use the createHoverHeight specified in the datablock.This can help avoid problems with spawning. @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// @brief Set whether the vehicle should temporarily use the createHoverHeight +/// specified in the datablock.This can help avoid problems with spawning. +/// @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// /// public void fnFlyingVehicle_useCreateHeight (string flyingvehicle, bool enabled) @@ -18916,6 +23617,7 @@ public void fnFlyingVehicle_useCreateHeight (string flyingvehicle, bool enabled) } /// /// .) +/// /// public void fnForest_addItem (string forest, string data, string position, float rotation, float scale) @@ -18936,6 +23638,7 @@ public void fnForest_addItem (string forest, string data, string position, float } /// /// .) +/// /// public void fnForest_addItemWithTransform (string forest, string data, string trans, float scale) @@ -18955,7 +23658,16 @@ public void fnForest_addItemWithTransform (string forest, string data, string tr SafeNativeMethods.mwle_fnForest_addItemWithTransform(sbforest, sbdata, sbtrans, scale); } /// -/// @brief Mounts the wind emitter to another scene object @param objectID Unique ID of the object wind emitter should attach to @tsexample // Wind emitter previously created and named %windEmitter // Going to attach it to the player, making him a walking wind storm %windEmitter.attachToObject(%player); @endtsexample) +/// @brief Mounts the wind emitter to another scene object +/// +/// @param objectID Unique ID of the object wind emitter should attach to +/// +/// @tsexample +/// // Wind emitter previously created and named %windEmitter +/// // Going to attach it to the player, making him a walking wind storm +/// %windEmitter.attachToObject(%player); +/// @endtsexample) +/// /// public void fnForestWindEmitter_attachToObject (string forestwindemitter, uint objectID) @@ -18969,21 +23681,14 @@ public void fnForestWindEmitter_attachToObject (string forestwindemitter, uint o SafeNativeMethods.mwle_fnForestWindEmitter_attachToObject(sbforestwindemitter, objectID); } /// -/// @brief Mounts the wind emitter to another scene object @param ) -/// - -public void fnForestWindEmitter_resetWind (string forestwindemitter, int randomSeed) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fnForestWindEmitter_resetWind'" + string.Format("\"{0}\" \"{1}\" ",forestwindemitter,randomSeed)); -StringBuilder sbforestwindemitter = null; -if (forestwindemitter != null) - sbforestwindemitter = new StringBuilder(forestwindemitter, 1024); - -SafeNativeMethods.mwle_fnForestWindEmitter_resetWind(sbforestwindemitter, randomSeed); -} -/// -/// @brief Apply an impulse to this object as defined by a world position and velocity vector. @param pos impulse world position @param vel impulse velocity (impulse force F = m * v) @return Always true @note Not all objects that derrive from GameBase have this defined.) +/// @brief Apply an impulse to this object as defined by a world position and velocity vector. +/// +/// @param pos impulse world position +/// @param vel impulse velocity (impulse force F = m * v) +/// @return Always true +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public bool fnGameBase_applyImpulse (string gamebase, string pos, string vel) @@ -19003,7 +23708,14 @@ public bool fnGameBase_applyImpulse (string gamebase, string pos, string vel) return SafeNativeMethods.mwle_fnGameBase_applyImpulse(sbgamebase, sbpos, sbvel)>=1; } /// -/// @brief Applies a radial impulse to the object using the given origin and force. @param origin World point of origin of the radial impulse. @param radius The radius of the impulse area. @param magnitude The strength of the impulse. @note Not all objects that derrive from GameBase have this defined.) +/// @brief Applies a radial impulse to the object using the given origin and force. +/// +/// @param origin World point of origin of the radial impulse. +/// @param radius The radius of the impulse area. +/// @param magnitude The strength of the impulse. +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public void fnGameBase_applyRadialImpulse (string gamebase, string origin, float radius, float magnitude) @@ -19020,7 +23732,10 @@ public void fnGameBase_applyRadialImpulse (string gamebase, string origin, float SafeNativeMethods.mwle_fnGameBase_applyRadialImpulse(sbgamebase, sborigin, radius, magnitude); } /// -/// @brief Get the datablock used by this object. @return the datablock this GameBase is using. @see setDataBlock()) +/// @brief Get the datablock used by this object. +/// @return the datablock this GameBase is using. +/// @see setDataBlock()) +/// /// public int fnGameBase_getDataBlock (string gamebase) @@ -19034,7 +23749,11 @@ public int fnGameBase_getDataBlock (string gamebase) return SafeNativeMethods.mwle_fnGameBase_getDataBlock(sbgamebase); } /// -/// @brief Assign this GameBase to use the specified datablock. @param data new datablock to use @return true if successful, false if failed. @see getDataBlock()) +/// @brief Assign this GameBase to use the specified datablock. +/// @param data new datablock to use +/// @return true if successful, false if failed. +/// @see getDataBlock()) +/// /// public bool fnGameBase_setDataBlock (string gamebase, string data) @@ -19051,7 +23770,36 @@ public bool fnGameBase_setDataBlock (string gamebase, string data) return SafeNativeMethods.mwle_fnGameBase_setDataBlock(sbgamebase, sbdata)>=1; } /// -/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. Ghosts represent objects on the server that are in scope for the client. These need to be synchronized with the client in order for the client to see and interact with them. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mod paths, this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. +/// +/// Ghosts represent objects on the server that are in scope for the client. These need +/// to be synchronized with the client in order for the client to see and interact with them. +/// This is typically done during the standard mission start phase 2 when following Torque's +/// example mission startup sequence. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mod paths, this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void fnGameConnection_activateGhosting (string gameconnection) @@ -19065,7 +23813,10 @@ public void fnGameConnection_activateGhosting (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_activateGhosting(sbgameconnection); } /// -/// @brief Sets the size of the chase camera's matrix queue. @note This sets the queue size across all GameConnections. @note This is not currently hooked up.) +/// @brief Sets the size of the chase camera's matrix queue. +/// @note This sets the queue size across all GameConnections. +/// @note This is not currently hooked up.) +/// /// public bool fnGameConnection_chaseCam (string gameconnection, int size) @@ -19079,7 +23830,10 @@ public bool fnGameConnection_chaseCam (string gameconnection, int size) return SafeNativeMethods.mwle_fnGameConnection_chaseCam(sbgameconnection, size)>=1; } /// -/// @brief Clear the connection's camera object reference. @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// @brief Clear the connection's camera object reference. +/// +/// @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// /// public void fnGameConnection_clearCameraObject (string gameconnection) @@ -19093,7 +23847,9 @@ public void fnGameConnection_clearCameraObject (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_clearCameraObject(sbgameconnection); } /// -/// @brief Clear any display device. A display device may define a number of properties that are used during rendering.) +/// @brief Clear any display device. +/// A display device may define a number of properties that are used during rendering.) +/// /// public void fnGameConnection_clearDisplayDevice (string gameconnection) @@ -19107,7 +23863,26 @@ public void fnGameConnection_clearDisplayDevice (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_clearDisplayDevice(sbgameconnection); } /// -/// ), @brief On the server, disconnect a client and pass along an optional reason why. This method performs two operations: it disconnects a client connection from the server, and it deletes the connection object. The optional reason is sent in the disconnect packet and is often displayed to the user so they know why they've been disconnected. @param reason [optional] The reason why the user has been disconnected from the server. @tsexample function kick(%client) { messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); if (!%client.isAIControlled()) BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); %client.delete(\"You have been kicked from this server\"); } @endtsexample) +/// ), +/// @brief On the server, disconnect a client and pass along an optional reason why. +/// +/// This method performs two operations: it disconnects a client connection from the server, +/// and it deletes the connection object. The optional reason is sent in the disconnect packet +/// and is often displayed to the user so they know why they've been disconnected. +/// +/// @param reason [optional] The reason why the user has been disconnected from the server. +/// +/// @tsexample +/// function kick(%client) +/// { +/// messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); +/// +/// if (!%client.isAIControlled()) +/// BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); +/// %client.delete(\"You have been kicked from this server\"); +/// } +/// @endtsexample) +/// /// public void fnGameConnection_delete (string gameconnection, string reason) @@ -19124,7 +23899,10 @@ public void fnGameConnection_delete (string gameconnection, string reason) SafeNativeMethods.mwle_fnGameConnection_delete(sbgameconnection, sbreason); } /// -/// @brief Returns the connection's camera object used when not viewing through the control object. @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// @brief Returns the connection's camera object used when not viewing through the control object. +/// +/// @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// /// public string fnGameConnection_getCameraObject (string gameconnection) @@ -19142,6 +23920,7 @@ public string fnGameConnection_getCameraObject (string gameconnection) } /// /// @brief Returns the default field of view as used by the control object's camera.) +/// /// public float fnGameConnection_getControlCameraDefaultFov (string gameconnection) @@ -19156,6 +23935,7 @@ public float fnGameConnection_getControlCameraDefaultFov (string gameconnection) } /// /// @brief Returns the field of view as used by the control object's camera.) +/// /// public float fnGameConnection_getControlCameraFov (string gameconnection) @@ -19169,7 +23949,12 @@ public float fnGameConnection_getControlCameraFov (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_getControlCameraFov(sbgameconnection); } /// -/// @brief On the server, returns the object that the client is controlling. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @see GameConnection::setControlObject()) +/// @brief On the server, returns the object that the client is controlling. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @see GameConnection::setControlObject()) +/// /// public string fnGameConnection_getControlObject (string gameconnection) @@ -19186,7 +23971,11 @@ public string fnGameConnection_getControlObject (string gameconnection) } /// -/// @brief Get the connection's control scheme absolute rotation property. @return True if the connection's control object should use an absolute rotation control scheme. @see GameConnection::setControlSchemeParameters()) +/// @brief Get the connection's control scheme absolute rotation property. +/// +/// @return True if the connection's control object should use an absolute rotation control scheme. +/// @see GameConnection::setControlSchemeParameters()) +/// /// public bool fnGameConnection_getControlSchemeAbsoluteRotation (string gameconnection) @@ -19200,7 +23989,9 @@ public bool fnGameConnection_getControlSchemeAbsoluteRotation (string gameconnec return SafeNativeMethods.mwle_fnGameConnection_getControlSchemeAbsoluteRotation(sbgameconnection)>=1; } /// -/// @brief On the client, get the control object's damage flash level. @return flash level) +/// @brief On the client, get the control object's damage flash level. +/// @return flash level) +/// /// public float fnGameConnection_getDamageFlash (string gameconnection) @@ -19214,7 +24005,9 @@ public float fnGameConnection_getDamageFlash (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_getDamageFlash(sbgameconnection); } /// -/// @brief On the client, get the control object's white-out level. @return white-out level) +/// @brief On the client, get the control object's white-out level. +/// @return white-out level) +/// /// public float fnGameConnection_getWhiteOut (string gameconnection) @@ -19228,7 +24021,9 @@ public float fnGameConnection_getWhiteOut (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_getWhiteOut(sbgameconnection); } /// -/// @brief Returns true if this connection is AI controlled. @see AIConnection) +/// @brief Returns true if this connection is AI controlled. +/// @see AIConnection) +/// /// public bool fnGameConnection_isAIControlled (string gameconnection) @@ -19242,7 +24037,10 @@ public bool fnGameConnection_isAIControlled (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isAIControlled(sbgameconnection)>=1; } /// -/// @brief Returns true if the object being controlled by the client is making use of a rotation damped camera. @see Camera) +/// @brief Returns true if the object being controlled by the client is making use +/// of a rotation damped camera. +/// @see Camera) +/// /// public bool fnGameConnection_isControlObjectRotDampedCamera (string gameconnection) @@ -19256,7 +24054,10 @@ public bool fnGameConnection_isControlObjectRotDampedCamera (string gameconnecti return SafeNativeMethods.mwle_fnGameConnection_isControlObjectRotDampedCamera(sbgameconnection)>=1; } /// -/// @brief Returns true if a previously recorded demo file is now playing. @see GameConnection::playDemo()) +/// @brief Returns true if a previously recorded demo file is now playing. +/// +/// @see GameConnection::playDemo()) +/// /// public bool fnGameConnection_isDemoPlaying (string gameconnection) @@ -19270,7 +24071,10 @@ public bool fnGameConnection_isDemoPlaying (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isDemoPlaying(sbgameconnection)>=1; } /// -/// @brief Returns true if a demo file is now being recorded. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief Returns true if a demo file is now being recorded. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool fnGameConnection_isDemoRecording (string gameconnection) @@ -19284,7 +24088,11 @@ public bool fnGameConnection_isDemoRecording (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isDemoRecording(sbgameconnection)>=1; } /// -/// @brief Returns true if this connection is in first person mode. @note Transition to first person occurs over time via mCameraPos, so this won't immediately return true after a set.) +/// @brief Returns true if this connection is in first person mode. +/// +/// @note Transition to first person occurs over time via mCameraPos, so this +/// won't immediately return true after a set.) +/// /// public bool fnGameConnection_isFirstPerson (string gameconnection) @@ -19298,7 +24106,9 @@ public bool fnGameConnection_isFirstPerson (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isFirstPerson(sbgameconnection)>=1; } /// -/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. @note The list is sent to the console.) +/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. +/// @note The list is sent to the console.) +/// /// public void fnGameConnection_listClassIDs (string gameconnection) @@ -19313,6 +24123,7 @@ public void fnGameConnection_listClassIDs (string gameconnection) } /// /// ) +/// /// public bool fnGameConnection_LoadDatablocksFromFile (string gameconnection, uint crc) @@ -19326,7 +24137,20 @@ public bool fnGameConnection_LoadDatablocksFromFile (string gameconnection, uint return SafeNativeMethods.mwle_fnGameConnection_LoadDatablocksFromFile(sbgameconnection, crc)>=1; } /// -/// @brief Used on the server to play a 2D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @tsexample function ServerPlay2D(%profile) { // Play the given sound profile on every client. // The sounds will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play2D(%profile); } @endtsexample) +/// @brief Used on the server to play a 2D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// +/// @tsexample +/// function ServerPlay2D(%profile) +/// { +/// // Play the given sound profile on every client. +/// // The sounds will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play2D(%profile); +/// } +/// @endtsexample) +/// /// public bool fnGameConnection_play2D (string gameconnection, string profile) @@ -19343,7 +24167,21 @@ public bool fnGameConnection_play2D (string gameconnection, string profile) return SafeNativeMethods.mwle_fnGameConnection_play2D(sbgameconnection, sbprofile)>=1; } /// -/// @brief Used on the server to play a 3D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". @tsexample function ServerPlay3D(%profile,%transform) { // Play the given sound profile at the given position on every client // The sound will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play3D(%profile,%transform); } @endtsexample) +/// @brief Used on the server to play a 3D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". +/// +/// @tsexample +/// function ServerPlay3D(%profile,%transform) +/// { +/// // Play the given sound profile at the given position on every client +/// // The sound will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play3D(%profile,%transform); +/// } +/// @endtsexample) +/// /// public bool fnGameConnection_play3D (string gameconnection, string profile, string location) @@ -19363,7 +24201,19 @@ public bool fnGameConnection_play3D (string gameconnection, string profile, stri return SafeNativeMethods.mwle_fnGameConnection_play3D(sbgameconnection, sbprofile, sblocation)>=1; } /// -/// @brief On the client, play back a previously recorded game session. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @returns True if the playback was successful. False if there was an issue, such as not being able to open the demo file for playback. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief On the client, play back a previously recorded game session. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @returns True if the playback was successful. False if there was an issue, such as +/// not being able to open the demo file for playback. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool fnGameConnection_playDemo (string gameconnection, string demoFileName) @@ -19380,7 +24230,27 @@ public bool fnGameConnection_playDemo (string gameconnection, string demoFileNam return SafeNativeMethods.mwle_fnGameConnection_playDemo(sbgameconnection, sbdemoFileName)>=1; } /// -/// @brief On the server, resets the connection to indicate that ghosting has been disabled. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that ghosts are no longer being transmitted. On the client end, all ghost information will be deleted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, resets the connection to indicate that ghosting has been disabled. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that ghosts are no longer being transmitted. On the client end, all ghost +/// information will be deleted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void fnGameConnection_resetGhosting (string gameconnection) @@ -19394,7 +24264,11 @@ public void fnGameConnection_resetGhosting (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_resetGhosting(sbgameconnection); } /// -/// @brief On the server, sets the client's 3D display to fade to black. @param doFade Set to true to fade to black, and false to fade from black. @param timeMS Time it takes to perform the fade as measured in ms. @note Not currently hooked up, and is not synchronized over the network.) +/// @brief On the server, sets the client's 3D display to fade to black. +/// @param doFade Set to true to fade to black, and false to fade from black. +/// @param timeMS Time it takes to perform the fade as measured in ms. +/// @note Not currently hooked up, and is not synchronized over the network.) +/// /// public void fnGameConnection_setBlackOut (string gameconnection, bool doFade, int timeMS) @@ -19408,7 +24282,11 @@ public void fnGameConnection_setBlackOut (string gameconnection, bool doFade, in SafeNativeMethods.mwle_fnGameConnection_setBlackOut(sbgameconnection, doFade, timeMS); } /// -/// @brief On the server, set the connection's camera object used when not viewing through the control object. @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// @brief On the server, set the connection's camera object used when not viewing +/// through the control object. +/// +/// @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// /// public bool fnGameConnection_setCameraObject (string gameconnection, string camera) @@ -19425,7 +24303,14 @@ public bool fnGameConnection_setCameraObject (string gameconnection, string came return SafeNativeMethods.mwle_fnGameConnection_setCameraObject(sbgameconnection, sbcamera)>=1; } /// -/// (GameConnection, setConnectArgs, void, 3, 17, (const char* args) @brief On the client, pass along a variable set of parameters to the server. Once the connection is established with the server, the server calls its onConnect() method with the client's passed in parameters as aruments. @see GameConnection::onConnect()) +/// (GameConnection, setConnectArgs, void, 3, 17, +/// (const char* args) @brief On the client, pass along a variable set of parameters to the server. +/// +/// Once the connection is established with the server, the server calls its onConnect() method +/// with the client's passed in parameters as aruments. +/// +/// @see GameConnection::onConnect()) +/// /// public void fnGameConnection_setConnectArgs (string gameconnection, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16) @@ -19484,7 +24369,12 @@ public void fnGameConnection_setConnectArgs (string gameconnection, string a2, s SafeNativeMethods.mwle_fnGameConnection_setConnectArgs(sbgameconnection, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16); } /// -/// @brief On the server, sets the control object's camera's field of view. @param newFOV New field of view (in degrees) to force the control object's camera to use. This value is clamped to be within the range of 1 to 179 degrees. @note When transmitted over the network to the client, the resolution is limited to one degree. Any fraction is dropped.) +/// @brief On the server, sets the control object's camera's field of view. +/// @param newFOV New field of view (in degrees) to force the control object's camera to use. This value +/// is clamped to be within the range of 1 to 179 degrees. +/// @note When transmitted over the network to the client, the resolution is limited to +/// one degree. Any fraction is dropped.) +/// /// public void fnGameConnection_setControlCameraFov (string gameconnection, float newFOV) @@ -19498,7 +24388,12 @@ public void fnGameConnection_setControlCameraFov (string gameconnection, float n SafeNativeMethods.mwle_fnGameConnection_setControlCameraFov(sbgameconnection, newFOV); } /// -/// @brief On the server, sets the object that the client will control. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @param ctrlObj The GameBase object on the server to control.) +/// @brief On the server, sets the object that the client will control. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @param ctrlObj The GameBase object on the server to control.) +/// /// public bool fnGameConnection_setControlObject (string gameconnection, string ctrlObj) @@ -19515,7 +24410,11 @@ public bool fnGameConnection_setControlObject (string gameconnection, string ctr return SafeNativeMethods.mwle_fnGameConnection_setControlObject(sbgameconnection, sbctrlObj)>=1; } /// -/// @brief Set the control scheme that may be used by a connection's control object. @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// @brief Set the control scheme that may be used by a connection's control object. +/// +/// @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. +/// @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// /// public void fnGameConnection_setControlSchemeParameters (string gameconnection, bool absoluteRotation, bool addYawToAbsRot, bool addPitchToAbsRot) @@ -19529,7 +24428,10 @@ public void fnGameConnection_setControlSchemeParameters (string gameconnection, SafeNativeMethods.mwle_fnGameConnection_setControlSchemeParameters(sbgameconnection, absoluteRotation, addYawToAbsRot, addPitchToAbsRot); } /// -/// @brief On the server, sets this connection into or out of first person mode. @param firstPerson Set to true to put the connection into first person mode.) +/// @brief On the server, sets this connection into or out of first person mode. +/// +/// @param firstPerson Set to true to put the connection into first person mode.) +/// /// public void fnGameConnection_setFirstPerson (string gameconnection, bool firstPerson) @@ -19543,7 +24445,16 @@ public void fnGameConnection_setFirstPerson (string gameconnection, bool firstPe SafeNativeMethods.mwle_fnGameConnection_setFirstPerson(sbgameconnection, firstPerson); } /// -/// @brief On the client, set the password that will be passed to the server. On the server, this password is compared with what is stored in $pref::Server::Password. If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, if the passed in client password and the server password do not match, the CHR_PASSWORD error string is sent back to the client and the connection is immediately terminated. This password checking is performed quite early on in the connection request process so as to minimize the impact of multiple failed attempts -- also known as hacking.) +/// @brief On the client, set the password that will be passed to the server. +/// +/// On the server, this password is compared with what is stored in $pref::Server::Password. +/// If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, +/// if the passed in client password and the server password do not match, the CHR_PASSWORD +/// error string is sent back to the client and the connection is immediately terminated. +/// +/// This password checking is performed quite early on in the connection request process so as +/// to minimize the impact of multiple failed attempts -- also known as hacking.) +/// /// public void fnGameConnection_setJoinPassword (string gameconnection, string password) @@ -19560,7 +24471,35 @@ public void fnGameConnection_setJoinPassword (string gameconnection, string pass SafeNativeMethods.mwle_fnGameConnection_setJoinPassword(sbgameconnection, sbpassword); } /// -/// @brief On the server, transmits the mission file's CRC value to the client. Typically, during the standard mission start phase 1, the mission file's CRC value on the server is send to the client. This allows the client to determine if the mission has changed since the last time it downloaded this mission and act appropriately, such as rebuilt cached lightmaps. @param CRC The mission file's CRC value on the server. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample) +/// @brief On the server, transmits the mission file's CRC value to the client. +/// +/// Typically, during the standard mission start phase 1, the mission file's CRC value +/// on the server is send to the client. This allows the client to determine if the mission +/// has changed since the last time it downloaded this mission and act appropriately, such as +/// rebuilt cached lightmaps. +/// +/// @param CRC The mission file's CRC value on the server. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample) +/// /// public void fnGameConnection_setMissionCRC (string gameconnection, int CRC) @@ -19574,7 +24513,18 @@ public void fnGameConnection_setMissionCRC (string gameconnection, int CRC) SafeNativeMethods.mwle_fnGameConnection_setMissionCRC(sbgameconnection, CRC); } /// -/// @brief On the client, starts recording the network connection's traffic to a demo file. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @param fileName The file name to use for the demo recording. @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// @brief On the client, starts recording the network connection's traffic to a demo file. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @param fileName The file name to use for the demo recording. +/// +/// @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// /// public void fnGameConnection_startRecording (string gameconnection, string fileName) @@ -19591,7 +24541,10 @@ public void fnGameConnection_startRecording (string gameconnection, string fileN SafeNativeMethods.mwle_fnGameConnection_startRecording(sbgameconnection, sbfileName); } /// -/// @brief On the client, stops the recording of a connection's network traffic to a file. @see GameConnection::startRecording(), GameConnection::playDemo()) +/// @brief On the client, stops the recording of a connection's network traffic to a file. +/// +/// @see GameConnection::startRecording(), GameConnection::playDemo()) +/// /// public void fnGameConnection_stopRecording (string gameconnection) @@ -19605,7 +24558,44 @@ public void fnGameConnection_stopRecording (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_stopRecording(sbgameconnection); } /// -/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. SimDataBlocks, also known as just datablocks, need to be transmitted to the client prior to the client entering the game world. These represent the static data that most objects in the world reference. This is typically done during the standard mission start phase 1 when following Torque's example mission startup sequence. When the datablocks have all been transmitted, onDataBlocksDone() is called to move the mission start process to the next phase. @param sequence The sequence is common between the server and client and ensures that the client is acting on the most recent mission start process. If an errant network packet (one that was lost but has now been found) is received by the client with an incorrect sequence, it is just ignored. This sequence number is updated on the server every time a mission is loaded. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample @see GameConnection::onDataBlocksDone()) +/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. +/// +/// SimDataBlocks, also known as just datablocks, need to be transmitted to the client +/// prior to the client entering the game world. These represent the static data that +/// most objects in the world reference. This is typically done during the standard +/// mission start phase 1 when following Torque's example mission startup sequence. +/// +/// When the datablocks have all been transmitted, onDataBlocksDone() is called to move +/// the mission start process to the next phase. +/// +/// @param sequence The sequence is common between the server and client and ensures +/// that the client is acting on the most recent mission start process. If an errant +/// network packet (one that was lost but has now been found) is received by the client +/// with an incorrect sequence, it is just ignored. This sequence number is updated on +/// the server every time a mission is loaded. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample +/// +/// @see GameConnection::onDataBlocksDone()) +/// /// public void fnGameConnection_transmitDataBlocks (string gameconnection, int sequence) @@ -19619,7 +24609,11 @@ public void fnGameConnection_transmitDataBlocks (string gameconnection, int sequ SafeNativeMethods.mwle_fnGameConnection_transmitDataBlocks(sbgameconnection, sequence); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields to client objects. +/// ) +/// /// public void fnGroundPlane_postApply (string groundplane) @@ -19634,6 +24628,7 @@ public void fnGroundPlane_postApply (string groundplane) } /// /// ( GuiAutoCompleteCtrl, add, void, 3, 5, (string name, int idNum, int scheme=0)) +/// /// public void fnGuiAutoCompleteCtrl_add (string guiautocompletectrl, string a2, string a3, string a4) @@ -19657,6 +24652,7 @@ public void fnGuiAutoCompleteCtrl_add (string guiautocompletectrl, string a2, st } /// /// ( GuiAutoCompleteCtrl, addScheme, void, 6, 6, (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void fnGuiAutoCompleteCtrl_addScheme (string guiautocompletectrl, string a2, string a3, string a4, string a5) @@ -19683,6 +24679,7 @@ public void fnGuiAutoCompleteCtrl_addScheme (string guiautocompletectrl, string } /// /// ( GuiAutoCompleteCtrl, changeTextById, void, 4, 4, ( int id, string text ) ) +/// /// public void fnGuiAutoCompleteCtrl_changeTextById (string guiautocompletectrl, string a2, string a3) @@ -19703,6 +24700,7 @@ public void fnGuiAutoCompleteCtrl_changeTextById (string guiautocompletectrl, st } /// /// ( GuiAutoCompleteCtrl, clear, void, 2, 2, Clear the popup list.) +/// /// public void fnGuiAutoCompleteCtrl_clear (string guiautocompletectrl) @@ -19717,6 +24715,7 @@ public void fnGuiAutoCompleteCtrl_clear (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, clearEntry, void, 3, 3, (S32 entry)) +/// /// public void fnGuiAutoCompleteCtrl_clearEntry (string guiautocompletectrl, string a2) @@ -19733,7 +24732,9 @@ public void fnGuiAutoCompleteCtrl_clearEntry (string guiautocompletectrl, string SafeNativeMethods.mwle_fnGuiAutoCompleteCtrl_clearEntry(sbguiautocompletectrl, sba2); } /// -/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) Returns the position of the first entry containing the specified text.) +/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int fnGuiAutoCompleteCtrl_findText (string guiautocompletectrl, string a2) @@ -19751,6 +24752,7 @@ public int fnGuiAutoCompleteCtrl_findText (string guiautocompletectrl, string a2 } /// /// ( GuiAutoCompleteCtrl, forceClose, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_forceClose (string guiautocompletectrl) @@ -19765,6 +24767,7 @@ public void fnGuiAutoCompleteCtrl_forceClose (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, forceOnAction, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_forceOnAction (string guiautocompletectrl) @@ -19779,6 +24782,7 @@ public void fnGuiAutoCompleteCtrl_forceOnAction (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, getSelected, S32, 2, 2, ) +/// /// public int fnGuiAutoCompleteCtrl_getSelected (string guiautocompletectrl) @@ -19793,6 +24797,7 @@ public int fnGuiAutoCompleteCtrl_getSelected (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, getText, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_getText (string guiautocompletectrl) @@ -19807,6 +24812,7 @@ public void fnGuiAutoCompleteCtrl_getText (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, getTextById, const char*, 3, 3, (int id)) +/// /// public string fnGuiAutoCompleteCtrl_getTextById (string guiautocompletectrl, string a2) @@ -19827,6 +24833,7 @@ public string fnGuiAutoCompleteCtrl_getTextById (string guiautocompletectrl, str } /// /// ( GuiAutoCompleteCtrl, replaceText, void, 3, 3, (bool doReplaceText)) +/// /// public void fnGuiAutoCompleteCtrl_replaceText (string guiautocompletectrl, string a2) @@ -19843,7 +24850,11 @@ public void fnGuiAutoCompleteCtrl_replaceText (string guiautocompletectrl, strin SafeNativeMethods.mwle_fnGuiAutoCompleteCtrl_replaceText(sbguiautocompletectrl, sba2); } /// -/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void fnGuiAutoCompleteCtrl_setEnumContent (string guiautocompletectrl, string a2, string a3) @@ -19864,6 +24875,7 @@ public void fnGuiAutoCompleteCtrl_setEnumContent (string guiautocompletectrl, st } /// /// ( GuiAutoCompleteCtrl, setFirstSelected, void, 2, 3, ([scriptCallback=true])) +/// /// public void fnGuiAutoCompleteCtrl_setFirstSelected (string guiautocompletectrl, string a2) @@ -19881,6 +24893,7 @@ public void fnGuiAutoCompleteCtrl_setFirstSelected (string guiautocompletectrl, } /// /// ( GuiAutoCompleteCtrl, setNoneSelected, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_setNoneSelected (string guiautocompletectrl) @@ -19895,6 +24908,7 @@ public void fnGuiAutoCompleteCtrl_setNoneSelected (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, setSelected, void, 3, 4, (int id, [scriptCallback=true])) +/// /// public void fnGuiAutoCompleteCtrl_setSelected (string guiautocompletectrl, string a2, string a3) @@ -19915,6 +24929,7 @@ public void fnGuiAutoCompleteCtrl_setSelected (string guiautocompletectrl, strin } /// /// ( GuiAutoCompleteCtrl, size, S32, 2, 2, Get the size of the menu - the number of entries in it.) +/// /// public int fnGuiAutoCompleteCtrl_size (string guiautocompletectrl) @@ -19929,6 +24944,7 @@ public int fnGuiAutoCompleteCtrl_size (string guiautocompletectrl) } /// /// (GuiAutoCompleteCtrl, sort, void, 2, 2, Sort the list alphabetically.) +/// /// public void fnGuiAutoCompleteCtrl_sort (string guiautocompletectrl) @@ -19943,6 +24959,7 @@ public void fnGuiAutoCompleteCtrl_sort (string guiautocompletectrl) } /// /// (GuiAutoCompleteCtrl, sortID, void, 2, 2, Sort the list by ID.) +/// /// public void fnGuiAutoCompleteCtrl_sortID (string guiautocompletectrl) @@ -19957,6 +24974,7 @@ public void fnGuiAutoCompleteCtrl_sortID (string guiautocompletectrl) } /// /// Reset scrolling. ) +/// /// public void fnGuiAutoScrollCtrl_reset (string guiautoscrollctrl) @@ -19970,7 +24988,9 @@ public void fnGuiAutoScrollCtrl_reset (string guiautoscrollctrl) SafeNativeMethods.mwle_fnGuiAutoScrollCtrl_reset(sbguiautoscrollctrl); } /// -/// Set the bitmap to show on the button. @param path Path to the texture file in any of the supported formats. ) +/// Set the bitmap to show on the button. +/// @param path Path to the texture file in any of the supported formats. ) +/// /// public void fnGuiBitmapButtonCtrl_setBitmap (string guibitmapbuttonctrl, string path) @@ -19987,7 +25007,10 @@ public void fnGuiBitmapButtonCtrl_setBitmap (string guibitmapbuttonctrl, string SafeNativeMethods.mwle_fnGuiBitmapButtonCtrl_setBitmap(sbguibitmapbuttonctrl, sbpath); } /// -/// Set the offset of the bitmap within the control. @param x The x-axis offset of the image. @param y The y-axis offset of the image.) +/// Set the offset of the bitmap within the control. +/// @param x The x-axis offset of the image. +/// @param y The y-axis offset of the image.) +/// /// public void fnGuiBitmapCtrl_setValue (string guibitmapctrl, int x, int y) @@ -20001,7 +25024,9 @@ public void fnGuiBitmapCtrl_setValue (string guibitmapctrl, int x, int y) SafeNativeMethods.mwle_fnGuiBitmapCtrl_setValue(sbguibitmapctrl, x, y); } /// -/// Get the text display on the button's label (if any). @return The button's label. ) +/// Get the text display on the button's label (if any). +/// @return The button's label. ) +/// /// public string fnGuiButtonBaseCtrl_getText (string guibuttonbasectrl) @@ -20018,7 +25043,10 @@ public string fnGuiButtonBaseCtrl_getText (string guibuttonbasectrl) } /// -/// Simulate a click on the button. This method will trigger the button's action just as if the button had been pressed by the user. ) +/// Simulate a click on the button. +/// This method will trigger the button's action just as if the button had been pressed by the +/// user. ) +/// /// public void fnGuiButtonBaseCtrl_performClick (string guibuttonbasectrl) @@ -20032,7 +25060,9 @@ public void fnGuiButtonBaseCtrl_performClick (string guibuttonbasectrl) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_performClick(sbguibuttonbasectrl); } /// -/// Reset the mousing state of the button. This method should not generally be called. ) +/// Reset the mousing state of the button. +/// This method should not generally be called. ) +/// /// public void fnGuiButtonBaseCtrl_resetState (string guibuttonbasectrl) @@ -20046,7 +25076,12 @@ public void fnGuiButtonBaseCtrl_resetState (string guibuttonbasectrl) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_resetState(sbguibuttonbasectrl); } /// -/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, toggling a button on will toggle all other radio buttons in its group to off. @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the button. To do that, use performClick(). ) +/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, +/// toggling a button on will toggle all other radio buttons in its group to off. +/// @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. +/// @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the +/// button. To do that, use performClick(). ) +/// /// public void fnGuiButtonBaseCtrl_setStateOn (string guibuttonbasectrl, bool isOn) @@ -20060,7 +25095,12 @@ public void fnGuiButtonBaseCtrl_setStateOn (string guibuttonbasectrl, bool isOn) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_setStateOn(sbguibuttonbasectrl, isOn); } /// -/// Set the text displayed on the button's label. @param text The text to display as the button's text label. @note Not all buttons render text labels. @see getText @see setTextID ) +/// Set the text displayed on the button's label. +/// @param text The text to display as the button's text label. +/// @note Not all buttons render text labels. +/// @see getText +/// @see setTextID ) +/// /// public void fnGuiButtonBaseCtrl_setText (string guibuttonbasectrl, string text) @@ -20077,7 +25117,17 @@ public void fnGuiButtonBaseCtrl_setText (string guibuttonbasectrl, string text) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_setText(sbguibuttonbasectrl, sbtext); } /// -/// Set the text displayed on the button's label using a string from the string table assigned to the control. @param id Name of the variable that contains the integer string ID. Used to look up string in table. @note Not all buttons render text labels. @see setText @see getText @see GuiControl::langTableMod @see LangTable @ref Gui_i18n ) +/// Set the text displayed on the button's label using a string from the string table +/// assigned to the control. +/// @param id Name of the variable that contains the integer string ID. Used to look up +/// string in table. +/// @note Not all buttons render text labels. +/// @see setText +/// @see getText +/// @see GuiControl::langTableMod +/// @see LangTable +/// @ref Gui_i18n ) +/// /// public void fnGuiButtonBaseCtrl_setTextID (string guibuttonbasectrl, string id) @@ -20094,7 +25144,10 @@ public void fnGuiButtonBaseCtrl_setTextID (string guibuttonbasectrl, string id) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_setTextID(sbguibuttonbasectrl, sbid); } /// -/// Translate a coordinate from canvas window-space to screen-space. @param coordinate The coordinate in window-space. @return The given coordinate translated to screen-space. ) +/// Translate a coordinate from canvas window-space to screen-space. +/// @param coordinate The coordinate in window-space. +/// @return The given coordinate translated to screen-space. ) +/// /// public string fnGuiCanvas_clientToScreen (string guicanvas, string coordinate) @@ -20114,7 +25167,11 @@ public string fnGuiCanvas_clientToScreen (string guicanvas, string coordinate) } /// -/// @brief Turns on the mouse off. @tsexample Canvas.cursorOff(); @endtsexample) +/// @brief Turns on the mouse off. +/// @tsexample +/// Canvas.cursorOff(); +/// @endtsexample) +/// /// public void fnGuiCanvas_cursorOff (string guicanvas) @@ -20128,7 +25185,11 @@ public void fnGuiCanvas_cursorOff (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_cursorOff(sbguicanvas); } /// -/// @brief Turns on the mouse cursor. @tsexample Canvas.cursorOn(); @endtsexample) +/// @brief Turns on the mouse cursor. +/// @tsexample +/// Canvas.cursorOn(); +/// @endtsexample) +/// /// public void fnGuiCanvas_cursorOn (string guicanvas) @@ -20142,7 +25203,11 @@ public void fnGuiCanvas_cursorOn (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_cursorOn(sbguicanvas); } /// -/// @brief Find the first monitor index that matches the given name. The actual match algorithm depends on the implementation. @param name The name to search for. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Find the first monitor index that matches the given name. +/// The actual match algorithm depends on the implementation. +/// @param name The name to search for. +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int fnGuiCanvas_findFirstMatchingMonitor (string guicanvas, string name) @@ -20159,7 +25224,14 @@ public int fnGuiCanvas_findFirstMatchingMonitor (string guicanvas, string name) return SafeNativeMethods.mwle_fnGuiCanvas_findFirstMatchingMonitor(sbguicanvas, sbname); } /// -/// @brief Get the GuiControl which is being used as the content. @tsexample Canvas.getContent(); @endtsexample @return ID of current content control) +/// @brief Get the GuiControl which is being used as the content. +/// +/// @tsexample +/// Canvas.getContent(); +/// @endtsexample +/// +/// @return ID of current content control) +/// /// public int fnGuiCanvas_getContent (string guicanvas) @@ -20173,7 +25245,13 @@ public int fnGuiCanvas_getContent (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getContent(sbguicanvas); } /// -/// @brief Get the current position of the cursor. @param param Description @tsexample %cursorPos = Canvas.getCursorPos(); @endtsexample @return Screen coordinates of mouse cursor, in format \"X Y\") +/// @brief Get the current position of the cursor. +/// @param param Description +/// @tsexample +/// %cursorPos = Canvas.getCursorPos(); +/// @endtsexample +/// @return Screen coordinates of mouse cursor, in format \"X Y\") +/// /// public string fnGuiCanvas_getCursorPos (string guicanvas) @@ -20190,7 +25268,14 @@ public string fnGuiCanvas_getCursorPos (string guicanvas) } /// -/// @brief Returns the dimensions of the canvas @tsexample %extent = Canvas.getExtent(); @endtsexample @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// @brief Returns the dimensions of the canvas +/// +/// @tsexample +/// %extent = Canvas.getExtent(); +/// @endtsexample +/// +/// @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// /// public string fnGuiCanvas_getExtent (string guicanvas) @@ -20207,7 +25292,11 @@ public string fnGuiCanvas_getExtent (string guicanvas) } /// -/// @brief Gets information on the specified mode of this device. @param modeId Index of the mode to get data from. @return A video mode string given an adapter and mode index. @see GuiCanvas::getVideoMode()) +/// @brief Gets information on the specified mode of this device. +/// @param modeId Index of the mode to get data from. +/// @return A video mode string given an adapter and mode index. +/// @see GuiCanvas::getVideoMode()) +/// /// public string fnGuiCanvas_getMode (string guicanvas, int modeId) @@ -20224,7 +25313,16 @@ public string fnGuiCanvas_getMode (string guicanvas, int modeId) } /// -/// @brief Gets the number of modes available on this device. @param param Description @tsexample %modeCount = Canvas.getModeCount() @endtsexample @return The number of video modes supported by the device) +/// @brief Gets the number of modes available on this device. +/// +/// @param param Description +/// +/// @tsexample +/// %modeCount = Canvas.getModeCount() +/// @endtsexample +/// +/// @return The number of video modes supported by the device) +/// /// public int fnGuiCanvas_getModeCount (string guicanvas) @@ -20238,7 +25336,10 @@ public int fnGuiCanvas_getModeCount (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getModeCount(sbguicanvas); } /// -/// @brief Gets the number of monitors attached to the system. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Gets the number of monitors attached to the system. +/// +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int fnGuiCanvas_getMonitorCount (string guicanvas) @@ -20252,7 +25353,10 @@ public int fnGuiCanvas_getMonitorCount (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getMonitorCount(sbguicanvas); } /// -/// @brief Gets the name of the requested monitor. @param index The monitor index. @return The name of the requested monitor.) +/// @brief Gets the name of the requested monitor. +/// @param index The monitor index. +/// @return The name of the requested monitor.) +/// /// public string fnGuiCanvas_getMonitorName (string guicanvas, int index) @@ -20269,7 +25373,10 @@ public string fnGuiCanvas_getMonitorName (string guicanvas, int index) } /// -/// @brief Gets the region of the requested monitor. @param index The monitor index. @return The rectangular region of the requested monitor.) +/// @brief Gets the region of the requested monitor. +/// @param index The monitor index. +/// @return The rectangular region of the requested monitor.) +/// /// public string fnGuiCanvas_getMonitorRect (string guicanvas, int index) @@ -20286,7 +25393,13 @@ public string fnGuiCanvas_getMonitorRect (string guicanvas, int index) } /// -/// @brief Gets the gui control under the mouse. @tsexample %underMouse = Canvas.getMouseControl(); @endtsexample @return ID of the gui control, if one was found. NULL otherwise) +/// @brief Gets the gui control under the mouse. +/// @tsexample +/// %underMouse = Canvas.getMouseControl(); +/// @endtsexample +/// +/// @return ID of the gui control, if one was found. NULL otherwise) +/// /// public int fnGuiCanvas_getMouseControl (string guicanvas) @@ -20300,7 +25413,21 @@ public int fnGuiCanvas_getMouseControl (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getMouseControl(sbguicanvas); } /// -/// @brief Gets the current screen mode as a string. The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). You will need to parse out each one for individual use. @tsexample %screenWidth = getWord(Canvas.getVideoMode(), 0); %screenHeight = getWord(Canvas.getVideoMode(), 1); %isFullscreen = getWord(Canvas.getVideoMode(), 2); %bitdepth = getWord(Canvas.getVideoMode(), 3); %refreshRate = getWord(Canvas.getVideoMode(), 4); @endtsexample @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// @brief Gets the current screen mode as a string. +/// +/// The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). +/// You will need to parse out each one for individual use. +/// +/// @tsexample +/// %screenWidth = getWord(Canvas.getVideoMode(), 0); +/// %screenHeight = getWord(Canvas.getVideoMode(), 1); +/// %isFullscreen = getWord(Canvas.getVideoMode(), 2); +/// %bitdepth = getWord(Canvas.getVideoMode(), 3); +/// %refreshRate = getWord(Canvas.getVideoMode(), 4); +/// @endtsexample +/// +/// @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// /// public string fnGuiCanvas_getVideoMode (string guicanvas) @@ -20317,7 +25444,9 @@ public string fnGuiCanvas_getVideoMode (string guicanvas) } /// -/// Get the current position of the platform window associated with the canvas. @return The window position of the canvas in screen-space. ) +/// Get the current position of the platform window associated with the canvas. +/// @return The window position of the canvas in screen-space. ) +/// /// public string fnGuiCanvas_getWindowPosition (string guicanvas) @@ -20334,7 +25463,12 @@ public string fnGuiCanvas_getWindowPosition (string guicanvas) } /// -/// @brief Disable rendering of the cursor. @tsexample Canvas.hideCursor(); @endtsexample) +/// @brief Disable rendering of the cursor. +/// +/// @tsexample +/// Canvas.hideCursor(); +/// @endtsexample) +/// /// public void fnGuiCanvas_hideCursor (string guicanvas) @@ -20348,7 +25482,30 @@ public void fnGuiCanvas_hideCursor (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_hideCursor(sbguicanvas); } /// -/// @brief Determines if mouse cursor is enabled. @tsexample // Is cursor on? if(Canvas.isCursorOn()) echo(\"Canvas cursor is on\"); @endtsexample @return Returns true if the cursor is on.) +/// ( GuiCanvas, hideWindow, void, 2, 2, ) +/// +/// + +public void fnGuiCanvas_hideWindow (string guicanvas) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnGuiCanvas_hideWindow'" + string.Format("\"{0}\" ",guicanvas)); +StringBuilder sbguicanvas = null; +if (guicanvas != null) + sbguicanvas = new StringBuilder(guicanvas, 1024); + +SafeNativeMethods.mwle_fnGuiCanvas_hideWindow(sbguicanvas); +} +/// +/// @brief Determines if mouse cursor is enabled. +/// +/// @tsexample +/// // Is cursor on? +/// if(Canvas.isCursorOn()) +/// echo(\"Canvas cursor is on\"); +/// @endtsexample +/// @return Returns true if the cursor is on.) +/// /// public bool fnGuiCanvas_isCursorOn (string guicanvas) @@ -20362,7 +25519,15 @@ public bool fnGuiCanvas_isCursorOn (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_isCursorOn(sbguicanvas)>=1; } /// -/// @brief Determines if mouse cursor is rendering. @tsexample // Is cursor rendering? if(Canvas.isCursorShown()) echo(\"Canvas cursor is rendering\"); @endtsexample @return Returns true if the cursor is rendering.) +/// @brief Determines if mouse cursor is rendering. +/// +/// @tsexample +/// // Is cursor rendering? +/// if(Canvas.isCursorShown()) +/// echo(\"Canvas cursor is rendering\"); +/// @endtsexample +/// @return Returns true if the cursor is rendering.) +/// /// public bool fnGuiCanvas_isCursorShown (string guicanvas) @@ -20376,7 +25541,14 @@ public bool fnGuiCanvas_isCursorShown (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_isCursorShown(sbguicanvas)>=1; } /// -/// @brief This turns on/off front-buffer rendering. @param enable True if all rendering should be done to the front buffer @tsexample Canvas.renderFront(false); @endtsexample) +/// @brief This turns on/off front-buffer rendering. +/// +/// @param enable True if all rendering should be done to the front buffer +/// +/// @tsexample +/// Canvas.renderFront(false); +/// @endtsexample) +/// /// public void fnGuiCanvas_renderFront (string guicanvas, bool enable) @@ -20390,7 +25562,15 @@ public void fnGuiCanvas_renderFront (string guicanvas, bool enable) SafeNativeMethods.mwle_fnGuiCanvas_renderFront(sbguicanvas, enable); } /// -/// @brief Force canvas to redraw. If the elapsed time is greater than the time since the last paint then the repaint will be skipped. @param elapsedMS The optional elapsed time in milliseconds. @tsexample Canvas.repaint(); @endtsexample) +/// @brief Force canvas to redraw. +/// If the elapsed time is greater than the time since the last paint +/// then the repaint will be skipped. +/// @param elapsedMS The optional elapsed time in milliseconds. +/// +/// @tsexample +/// Canvas.repaint(); +/// @endtsexample) +/// /// public void fnGuiCanvas_repaint (string guicanvas, int elapsedMS) @@ -20404,7 +25584,12 @@ public void fnGuiCanvas_repaint (string guicanvas, int elapsedMS) SafeNativeMethods.mwle_fnGuiCanvas_repaint(sbguicanvas, elapsedMS); } /// -/// @brief Reset the update regions for the canvas. @tsexample Canvas.reset(); @endtsexample) +/// @brief Reset the update regions for the canvas. +/// +/// @tsexample +/// Canvas.reset(); +/// @endtsexample) +/// /// public void fnGuiCanvas_reset (string guicanvas) @@ -20418,7 +25603,10 @@ public void fnGuiCanvas_reset (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_reset(sbguicanvas); } /// -/// Translate a coordinate from screen-space to canvas window-space. @param coordinate The coordinate in screen-space. @return The given coordinate translated to window-space. ) +/// Translate a coordinate from screen-space to canvas window-space. +/// @param coordinate The coordinate in screen-space. +/// @return The given coordinate translated to window-space. ) +/// /// public string fnGuiCanvas_screenToClient (string guicanvas, string coordinate) @@ -20438,7 +25626,14 @@ public string fnGuiCanvas_screenToClient (string guicanvas, string coordinate) } /// -/// @brief Set the content of the canvas to a specified control. @param ctrl ID or name of GuiControl to set content to @tsexample Canvas.setContent(PlayGui); @endtsexample) +/// @brief Set the content of the canvas to a specified control. +/// +/// @param ctrl ID or name of GuiControl to set content to +/// +/// @tsexample +/// Canvas.setContent(PlayGui); +/// @endtsexample) +/// /// public void fnGuiCanvas_setContent (string guicanvas, string ctrl) @@ -20455,7 +25650,14 @@ public void fnGuiCanvas_setContent (string guicanvas, string ctrl) SafeNativeMethods.mwle_fnGuiCanvas_setContent(sbguicanvas, sbctrl); } /// -/// @brief Sets the cursor for the canvas. @param cursor Name of the GuiCursor to use @tsexample Canvas.setCursor(\"DefaultCursor\"); @endtsexample) +/// @brief Sets the cursor for the canvas. +/// +/// @param cursor Name of the GuiCursor to use +/// +/// @tsexample +/// Canvas.setCursor(\"DefaultCursor\"); +/// @endtsexample) +/// /// public void fnGuiCanvas_setCursor (string guicanvas, string cursor) @@ -20473,6 +25675,7 @@ public void fnGuiCanvas_setCursor (string guicanvas, string cursor) } /// /// (bool shown) - Enabled when a context menu/popup menu is shown.) +/// /// public void fnGuiCanvas_setPopupShown (string guicanvas, bool shown) @@ -20486,7 +25689,9 @@ public void fnGuiCanvas_setPopupShown (string guicanvas, bool shown) SafeNativeMethods.mwle_fnGuiCanvas_setPopupShown(sbguicanvas, shown); } /// -/// Set the position of the platform window associated with the canvas. @param position The new position of the window in screen-space. ) +/// Set the position of the platform window associated with the canvas. +/// @param position The new position of the window in screen-space. ) +/// /// public void fnGuiCanvas_setWindowPosition (string guicanvas, string position) @@ -20503,7 +25708,14 @@ public void fnGuiCanvas_setWindowPosition (string guicanvas, string position) SafeNativeMethods.mwle_fnGuiCanvas_setWindowPosition(sbguicanvas, sbposition); } /// -/// @brief Change the title of the OS window. @param newTitle String containing the new name @tsexample Canvas.setWindowTitle(\"Documentation Rocks!\"); @endtsexample) +/// @brief Change the title of the OS window. +/// +/// @param newTitle String containing the new name +/// +/// @tsexample +/// Canvas.setWindowTitle(\"Documentation Rocks!\"); +/// @endtsexample) +/// /// public void fnGuiCanvas_setWindowTitle (string guicanvas, string newTitle) @@ -20520,7 +25732,12 @@ public void fnGuiCanvas_setWindowTitle (string guicanvas, string newTitle) SafeNativeMethods.mwle_fnGuiCanvas_setWindowTitle(sbguicanvas, sbnewTitle); } /// -/// @brief Enable rendering of the cursor. @tsexample Canvas.showCursor(); @endtsexample) +/// @brief Enable rendering of the cursor. +/// +/// @tsexample +/// Canvas.showCursor(); +/// @endtsexample) +/// /// public void fnGuiCanvas_showCursor (string guicanvas) @@ -20534,7 +25751,28 @@ public void fnGuiCanvas_showCursor (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_showCursor(sbguicanvas); } /// -/// @brief toggle canvas from fullscreen to windowed mode or back. @tsexample // If we are in windowed mode, the following will put is in fullscreen Canvas.toggleFullscreen(); @endtsexample) +/// ( GuiCanvas, showWindow, void, 2, 2, ) +/// +/// + +public void fnGuiCanvas_showWindow (string guicanvas) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnGuiCanvas_showWindow'" + string.Format("\"{0}\" ",guicanvas)); +StringBuilder sbguicanvas = null; +if (guicanvas != null) + sbguicanvas = new StringBuilder(guicanvas, 1024); + +SafeNativeMethods.mwle_fnGuiCanvas_showWindow(sbguicanvas); +} +/// +/// @brief toggle canvas from fullscreen to windowed mode or back. +/// +/// @tsexample +/// // If we are in windowed mode, the following will put is in fullscreen +/// Canvas.toggleFullscreen(); +/// @endtsexample) +/// /// public void fnGuiCanvas_toggleFullscreen (string guicanvas) @@ -20548,7 +25786,9 @@ public void fnGuiCanvas_toggleFullscreen (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_toggleFullscreen(sbguicanvas); } /// -/// Test whether the checkbox is currently checked. @return True if the checkbox is currently ticked, false otherwise. ) +/// Test whether the checkbox is currently checked. +/// @return True if the checkbox is currently ticked, false otherwise. ) +/// /// public bool fnGuiCheckBoxCtrl_isStateOn (string guicheckboxctrl) @@ -20562,7 +25802,11 @@ public bool fnGuiCheckBoxCtrl_isStateOn (string guicheckboxctrl) return SafeNativeMethods.mwle_fnGuiCheckBoxCtrl_isStateOn(sbguicheckboxctrl)>=1; } /// -/// Set whether the checkbox is ticked or not. @param newState If true the box will be checked, if false, it will be unchecked. @note This method will @b not trigger the command associated with the control. To toggle the checkbox state as if the user had clicked the control, use performClick(). ) +/// Set whether the checkbox is ticked or not. +/// @param newState If true the box will be checked, if false, it will be unchecked. +/// @note This method will @b not trigger the command associated with the control. To toggle the +/// checkbox state as if the user had clicked the control, use performClick(). ) +/// /// public void fnGuiCheckBoxCtrl_setStateOn (string guicheckboxctrl, bool newState) @@ -20576,7 +25820,12 @@ public void fnGuiCheckBoxCtrl_setStateOn (string guicheckboxctrl, bool newState) SafeNativeMethods.mwle_fnGuiCheckBoxCtrl_setStateOn(sbguicheckboxctrl, newState); } /// -/// @brief Set the image rendered in this control. @param filename The image name you want to set @tsexample ChunkedBitmap.setBitmap(\"images/background.png\"); @endtsexample) +/// @brief Set the image rendered in this control. +/// @param filename The image name you want to set +/// @tsexample +/// ChunkedBitmap.setBitmap(\"images/background.png\"); +/// @endtsexample) +/// /// public void fnGuiChunkedBitmapCtrl_setBitmap (string guichunkedbitmapctrl, string filename) @@ -20593,7 +25842,14 @@ public void fnGuiChunkedBitmapCtrl_setBitmap (string guichunkedbitmapctrl, strin SafeNativeMethods.mwle_fnGuiChunkedBitmapCtrl_setBitmap(sbguichunkedbitmapctrl, sbfilename); } /// -/// Returns the current time, in seconds. @return timeInseconds Current time, in seconds @tsexample // Get the current time from the GuiClockHud control %timeInSeconds = %guiClockHud.getTime(); @endtsexample ) +/// Returns the current time, in seconds. +/// @return timeInseconds Current time, in seconds +/// @tsexample +/// // Get the current time from the GuiClockHud control +/// %timeInSeconds = %guiClockHud.getTime(); +/// @endtsexample +/// ) +/// /// public float fnGuiClockHud_getTime (string guiclockhud) @@ -20607,7 +25863,12 @@ public float fnGuiClockHud_getTime (string guiclockhud) return SafeNativeMethods.mwle_fnGuiClockHud_getTime(sbguiclockhud); } /// -/// @brief Sets a time for a countdown clock. Setting the time like this will cause the clock to count backwards from the specified time. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @see setTime ) +/// @brief Sets a time for a countdown clock. +/// Setting the time like this will cause the clock to count backwards from the specified time. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @see setTime +/// ) +/// /// public void fnGuiClockHud_setReverseTime (string guiclockhud, float timeInSeconds) @@ -20621,7 +25882,16 @@ public void fnGuiClockHud_setReverseTime (string guiclockhud, float timeInSecond SafeNativeMethods.mwle_fnGuiClockHud_setReverseTime(sbguiclockhud, timeInSeconds); } /// -/// Sets the current base time for the clock. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @tsexample // Define the time, in seconds %timeInSeconds = 120; // Change the time on the GuiClockHud control %guiClockHud.setTime(%timeInSeconds); @endtsexample ) +/// Sets the current base time for the clock. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @tsexample +/// // Define the time, in seconds +/// %timeInSeconds = 120; +/// // Change the time on the GuiClockHud control +/// %guiClockHud.setTime(%timeInSeconds); +/// @endtsexample +/// ) +/// /// public void fnGuiClockHud_setTime (string guiclockhud, float timeInSeconds) @@ -20635,7 +25905,13 @@ public void fnGuiClockHud_setTime (string guiclockhud, float timeInSeconds) SafeNativeMethods.mwle_fnGuiClockHud_setTime(sbguiclockhud, timeInSeconds); } /// -/// Add the given control as a child to this control. This is synonymous to calling SimGroup::addObject. @param control The control to add as a child. @note The control will retain its current position and size. @see SimGroup::addObject @ref GuiControl_Hierarchy ) +/// Add the given control as a child to this control. +/// This is synonymous to calling SimGroup::addObject. +/// @param control The control to add as a child. +/// @note The control will retain its current position and size. +/// @see SimGroup::addObject +/// @ref GuiControl_Hierarchy ) +/// /// public void fnGuiControl_addGuiControl (string guicontrol, string control) @@ -20653,6 +25929,7 @@ public void fnGuiControl_addGuiControl (string guicontrol, string control) } /// /// Returns if the control's background color can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextBackColor (string guicontrol) @@ -20667,6 +25944,7 @@ public bool fnGuiControl_canChangeContextBackColor (string guicontrol) } /// /// Returns if the control's fill color can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextFillColor (string guicontrol) @@ -20681,6 +25959,7 @@ public bool fnGuiControl_canChangeContextFillColor (string guicontrol) } /// /// Returns if the control's font color can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextFontColor (string guicontrol) @@ -20695,6 +25974,7 @@ public bool fnGuiControl_canChangeContextFontColor (string guicontrol) } /// /// Returns if the control's font size can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextFontSize (string guicontrol) @@ -20709,6 +25989,7 @@ public bool fnGuiControl_canChangeContextFontSize (string guicontrol) } /// /// Returns if the control's window settings can be changed in the game or not. ) +/// /// public bool fnGuiControl_canShowContextWindowSettings (string guicontrol) @@ -20722,7 +26003,9 @@ public bool fnGuiControl_canShowContextWindowSettings (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_canShowContextWindowSettings(sbguicontrol)>=1; } /// -/// Clear this control from being the first responder in its hierarchy chain. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Clear this control from being the first responder in its hierarchy chain. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void fnGuiControl_clearFirstResponder (string guicontrol, bool ignored) @@ -20736,7 +26019,10 @@ public void fnGuiControl_clearFirstResponder (string guicontrol, bool ignored) SafeNativeMethods.mwle_fnGuiControl_clearFirstResponder(sbguicontrol, ignored); } /// -/// Test whether the given control is a direct or indirect child to this control. @param control The potential child control. @return True if the given control is a direct or indirect child to this control. ) +/// Test whether the given control is a direct or indirect child to this control. +/// @param control The potential child control. +/// @return True if the given control is a direct or indirect child to this control. ) +/// /// public bool fnGuiControl_controlIsChild (string guicontrol, string control) @@ -20753,7 +26039,10 @@ public bool fnGuiControl_controlIsChild (string guicontrol, string control) return SafeNativeMethods.mwle_fnGuiControl_controlIsChild(sbguicontrol, sbcontrol)>=1; } /// -/// Test whether the given control is a sibling of this control. @param control The potential sibling control. @return True if the given control is a sibling of this control. ) +/// Test whether the given control is a sibling of this control. +/// @param control The potential sibling control. +/// @return True if the given control is a sibling of this control. ) +/// /// public bool fnGuiControl_controlIsSibling (string guicontrol, string control) @@ -20770,7 +26059,14 @@ public bool fnGuiControl_controlIsSibling (string guicontrol, string control) return SafeNativeMethods.mwle_fnGuiControl_controlIsSibling(sbguicontrol, sbcontrol)>=1; } /// -/// Find the topmost child control located at the given coordinates. @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. @param x The X coordinate in the control's own coordinate space. @param y The Y coordinate in the control's own coordinate space. @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. @see GuiControlProfile::modal @see findHitControls ) +/// Find the topmost child control located at the given coordinates. +/// @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. +/// @param x The X coordinate in the control's own coordinate space. +/// @param y The Y coordinate in the control's own coordinate space. +/// @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. +/// @see GuiControlProfile::modal +/// @see findHitControls ) +/// /// public string fnGuiControl_findHitControl (string guicontrol, int x, int y) @@ -20787,7 +26083,20 @@ public string fnGuiControl_findHitControl (string guicontrol, int x, int y) } /// -/// Find all visible child controls that intersect with the given rectangle. @note Invisible child controls will not be included in the search. @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. @param width The width of the search rectangle in pixels. @param height The height of the search rectangle in pixels. @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. @tsexample // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) %ctrl.setLocked( true ); @endtsexample @see findHitControl ) +/// Find all visible child controls that intersect with the given rectangle. +/// @note Invisible child controls will not be included in the search. +/// @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param width The width of the search rectangle in pixels. +/// @param height The height of the search rectangle in pixels. +/// @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. +/// @tsexample +/// // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. +/// foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) +/// %ctrl.setLocked( true ); +/// @endtsexample +/// @see findHitControl ) +/// /// public string fnGuiControl_findHitControls (string guicontrol, int x, int y, int width, int height) @@ -20805,6 +26114,7 @@ public string fnGuiControl_findHitControls (string guicontrol, int x, int y, int } /// /// Get the alpha fade time for the object. ) +/// /// public int fnGuiControl_getAlphaFadeTime (string guicontrol) @@ -20819,6 +26129,7 @@ public int fnGuiControl_getAlphaFadeTime (string guicontrol) } /// /// Get the alpha for the object. ) +/// /// public float fnGuiControl_getAlphaValue (string guicontrol) @@ -20832,7 +26143,10 @@ public float fnGuiControl_getAlphaValue (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_getAlphaValue(sbguicontrol); } /// -/// Get the aspect ratio of the control's extents. @return The width of the control divided by its height. @see getExtent ) +/// Get the aspect ratio of the control's extents. +/// @return The width of the control divided by its height. +/// @see getExtent ) +/// /// public float fnGuiControl_getAspect (string guicontrol) @@ -20846,7 +26160,9 @@ public float fnGuiControl_getAspect (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_getAspect(sbguicontrol); } /// -/// Get the coordinate of the control's center point relative to its parent. @return The coordinate of the control's center point in parent-relative coordinates. ) +/// Get the coordinate of the control's center point relative to its parent. +/// @return The coordinate of the control's center point in parent-relative coordinates. ) +/// /// public string fnGuiControl_getCenter (string guicontrol) @@ -20864,6 +26180,7 @@ public string fnGuiControl_getCenter (string guicontrol) } /// /// Sets the font size of a control. ) +/// /// public int fnGuiControl_getControlFontSize (string guicontrol) @@ -20878,6 +26195,7 @@ public int fnGuiControl_getControlFontSize (string guicontrol) } /// /// Returns if the control is locked or not. ) +/// /// public bool fnGuiControl_getControlLock (string guicontrol) @@ -20892,6 +26210,7 @@ public bool fnGuiControl_getControlLock (string guicontrol) } /// /// Returns the filename of the texture of the control. ) +/// /// public string fnGuiControl_getControlTextureFile (string guicontrol) @@ -20908,7 +26227,9 @@ public string fnGuiControl_getControlTextureFile (string guicontrol) } /// -/// Get the width and height of the control. @return A point structure containing the width of the control in x and the height in y. ) +/// Get the width and height of the control. +/// @return A point structure containing the width of the control in x and the height in y. ) +/// /// public string fnGuiControl_getExtent (string guicontrol) @@ -20925,7 +26246,13 @@ public string fnGuiControl_getExtent (string guicontrol) } /// -/// Get the first responder set on this GuiControl tree. @return The first responder set on the control's subtree. @see isFirstResponder @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Get the first responder set on this GuiControl tree. +/// @return The first responder set on the control's subtree. +/// @see isFirstResponder +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public string fnGuiControl_getFirstResponder (string guicontrol) @@ -20942,7 +26269,9 @@ public string fnGuiControl_getFirstResponder (string guicontrol) } /// -/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. @Return the center coordinate of the control in root-relative coordinates. ) +/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. +/// @Return the center coordinate of the control in root-relative coordinates. ) +/// /// public string fnGuiControl_getGlobalCenter (string guicontrol) @@ -20959,7 +26288,9 @@ public string fnGuiControl_getGlobalCenter (string guicontrol) } /// -/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. @return The control's current position in root-relative coordinates. ) +/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @return The control's current position in root-relative coordinates. ) +/// /// public string fnGuiControl_getGlobalPosition (string guicontrol) @@ -20976,7 +26307,10 @@ public string fnGuiControl_getGlobalPosition (string guicontrol) } /// -/// Get the maximum allowed size of the control. @return The maximum size to which the control can be shrunk. @see maxExtent ) +/// Get the maximum allowed size of the control. +/// @return The maximum size to which the control can be shrunk. +/// @see maxExtent ) +/// /// public string fnGuiControl_getMaxExtent (string guicontrol) @@ -20993,7 +26327,10 @@ public string fnGuiControl_getMaxExtent (string guicontrol) } /// -/// Get the minimum allowed size of the control. @return The minimum size to which the control can be shrunk. @see minExtent ) +/// Get the minimum allowed size of the control. +/// @return The minimum size to which the control can be shrunk. +/// @see minExtent ) +/// /// public string fnGuiControl_getMinExtent (string guicontrol) @@ -21011,6 +26348,7 @@ public string fnGuiControl_getMinExtent (string guicontrol) } /// /// Get the mouse over alpha for the object. ) +/// /// public float fnGuiControl_getMouseOverAlphaValue (string guicontrol) @@ -21024,7 +26362,9 @@ public float fnGuiControl_getMouseOverAlphaValue (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_getMouseOverAlphaValue(sbguicontrol); } /// -/// Get the immediate parent control of the control. @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// Get the immediate parent control of the control. +/// @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// /// public string fnGuiControl_getParent (string guicontrol) @@ -21041,7 +26381,9 @@ public string fnGuiControl_getParent (string guicontrol) } /// -/// Get the control's current position relative to its parent. @return The coordinate of the control in its parent's coordinate space. ) +/// Get the control's current position relative to its parent. +/// @return The coordinate of the control in its parent's coordinate space. ) +/// /// public string fnGuiControl_getPosition (string guicontrol) @@ -21058,7 +26400,10 @@ public string fnGuiControl_getPosition (string guicontrol) } /// -/// Get the canvas on which the control is placed. @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. @see GuiControl_Hierarchy ) +/// Get the canvas on which the control is placed. +/// @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. +/// @see GuiControl_Hierarchy ) +/// /// public string fnGuiControl_getRoot (string guicontrol) @@ -21076,6 +26421,7 @@ public string fnGuiControl_getRoot (string guicontrol) } /// /// Get root control ) +/// /// public string fnGuiControl_getRootControl (string guicontrol) @@ -21092,7 +26438,11 @@ public string fnGuiControl_getRootControl (string guicontrol) } /// -/// Test whether the control is currently awake. If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. @return True if the control is awake. @ref GuiControl_Waking ) +/// Test whether the control is currently awake. +/// If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. +/// @return True if the control is awake. +/// @ref GuiControl_Waking ) +/// /// public bool fnGuiControl_isAwake (string guicontrol) @@ -21107,6 +26457,7 @@ public bool fnGuiControl_isAwake (string guicontrol) } /// /// Returns if the control's alpha value can be changed in the game or not. ) +/// /// public bool fnGuiControl_isContextAlphaEnabled (string guicontrol) @@ -21121,6 +26472,7 @@ public bool fnGuiControl_isContextAlphaEnabled (string guicontrol) } /// /// Returns if the control's alpha fade value can be changed in the game or not. ) +/// /// public bool fnGuiControl_isContextAlphaFadeEnabled (string guicontrol) @@ -21135,6 +26487,7 @@ public bool fnGuiControl_isContextAlphaFadeEnabled (string guicontrol) } /// /// Returns if the control can be locked in the game or not. ) +/// /// public bool fnGuiControl_isContextLockable (string guicontrol) @@ -21149,6 +26502,7 @@ public bool fnGuiControl_isContextLockable (string guicontrol) } /// /// Returns if the control's mouse-over alpha value can be changed in the game or not. ) +/// /// public bool fnGuiControl_isContextMouseOverAlphaEnabled (string guicontrol) @@ -21163,6 +26517,7 @@ public bool fnGuiControl_isContextMouseOverAlphaEnabled (string guicontrol) } /// /// Returns if the control can be moved in the game or not. ) +/// /// public bool fnGuiControl_isContextMovable (string guicontrol) @@ -21176,7 +26531,12 @@ public bool fnGuiControl_isContextMovable (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isContextMovable(sbguicontrol)>=1; } /// -/// Test whether the control is the current first responder. @return True if the control is the current first responder. @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Test whether the control is the current first responder. +/// @return True if the control is the current first responder. +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public bool fnGuiControl_isFirstResponder (string guicontrol) @@ -21190,7 +26550,9 @@ public bool fnGuiControl_isFirstResponder (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isFirstResponder(sbguicontrol)>=1; } /// -/// Indicates if the mouse is locked in this control. @return True if the mouse is currently locked. ) +/// Indicates if the mouse is locked in this control. +/// @return True if the mouse is currently locked. ) +/// /// public bool fnGuiControl_isMouseLocked (string guicontrol) @@ -21204,7 +26566,12 @@ public bool fnGuiControl_isMouseLocked (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isMouseLocked(sbguicontrol)>=1; } /// -/// Test whether the control is currently set to be visible. @return True if the control is currently set to be visible. @note This method does not tell anything about whether the control is actually visible to the user at the moment. @ref GuiControl_VisibleActive ) +/// Test whether the control is currently set to be visible. +/// @return True if the control is currently set to be visible. +/// @note This method does not tell anything about whether the control is actually visible to +/// the user at the moment. +/// @ref GuiControl_VisibleActive ) +/// /// public bool fnGuiControl_isVisible (string guicontrol) @@ -21218,7 +26585,13 @@ public bool fnGuiControl_isVisible (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isVisible(sbguicontrol)>=1; } /// -/// Test whether the given point lies within the rectangle of the control. @param x X coordinate of the point in parent-relative coordinates. @param y Y coordinate of the point in parent-relative coordinates. @return True if the point is within the control, false if not. @see getExtent @see getPosition ) +/// Test whether the given point lies within the rectangle of the control. +/// @param x X coordinate of the point in parent-relative coordinates. +/// @param y Y coordinate of the point in parent-relative coordinates. +/// @return True if the point is within the control, false if not. +/// @see getExtent +/// @see getPosition ) +/// /// public bool fnGuiControl_pointInControl (string guicontrol, int x, int y) @@ -21247,7 +26620,9 @@ public void fnGuiControl_refresh (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_refresh(sbguicontrol); } /// -/// Removes the plus cursor. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Removes the plus cursor. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void fnGuiControl_resetCur (string guicontrol) @@ -21261,7 +26636,13 @@ public void fnGuiControl_resetCur (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_resetCur(sbguicontrol); } /// -/// Resize and reposition the control using the give coordinates and dimensions. Child controls will resize according to their layout behaviors. @param x The new X coordinate of the control in its parent's coordinate space. @param y The new Y coordinate of the control in its parent's coordinate space. @param width The new width to which the control should be resized. @param height The new height to which the control should be resized. ) +/// Resize and reposition the control using the give coordinates and dimensions. Child controls +/// will resize according to their layout behaviors. +/// @param x The new X coordinate of the control in its parent's coordinate space. +/// @param y The new Y coordinate of the control in its parent's coordinate space. +/// @param width The new width to which the control should be resized. +/// @param height The new height to which the control should be resized. ) +/// /// public void fnGuiControl_resize (string guicontrol, int x, int y, int width, int height) @@ -21276,6 +26657,7 @@ public void fnGuiControl_resize (string guicontrol, int x, int y, int width, int } /// /// ) +/// /// public void fnGuiControl_setActive (string guicontrol, bool state) @@ -21289,7 +26671,9 @@ public void fnGuiControl_setActive (string guicontrol, bool state) SafeNativeMethods.mwle_fnGuiControl_setActive(sbguicontrol, state); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void fnGuiControl_setAlphaFadeTime (string guicontrol, int fadeTime) @@ -21303,7 +26687,9 @@ public void fnGuiControl_setAlphaFadeTime (string guicontrol, int fadeTime) SafeNativeMethods.mwle_fnGuiControl_setAlphaFadeTime(sbguicontrol, fadeTime); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void fnGuiControl_setAlphaValue (string guicontrol, float alpha) @@ -21317,7 +26703,10 @@ public void fnGuiControl_setAlphaValue (string guicontrol, float alpha) SafeNativeMethods.mwle_fnGuiControl_setAlphaValue(sbguicontrol, alpha); } /// -/// Set the control's position by its center point. @param x The X coordinate of the new center point of the control relative to the control's parent. @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// Set the control's position by its center point. +/// @param x The X coordinate of the new center point of the control relative to the control's parent. +/// @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// /// public void fnGuiControl_setCenter (string guicontrol, int x, int y) @@ -21332,6 +26721,7 @@ public void fnGuiControl_setCenter (string guicontrol, int x, int y) } /// /// Displays the option to set the alpha of the control in the game when true. ) +/// /// public void fnGuiControl_setContextAlpha (string guicontrol, bool alpha) @@ -21346,6 +26736,7 @@ public void fnGuiControl_setContextAlpha (string guicontrol, bool alpha) } /// /// Displays the option to set the alpha fade value of the control in the game when true. ) +/// /// public void fnGuiControl_setContextAlphaFade (string guicontrol, bool fade) @@ -21360,6 +26751,7 @@ public void fnGuiControl_setContextAlphaFade (string guicontrol, bool fade) } /// /// Displays the option to set the background color of the control in the game when true. ) +/// /// public void fnGuiControl_setContextBackColor (string guicontrol, bool backColor) @@ -21374,6 +26766,7 @@ public void fnGuiControl_setContextBackColor (string guicontrol, bool backColor) } /// /// Displays the option to set the fill color of the control in the game when true. ) +/// /// public void fnGuiControl_setContextFillColor (string guicontrol, bool fillColor) @@ -21388,6 +26781,7 @@ public void fnGuiControl_setContextFillColor (string guicontrol, bool fillColor) } /// /// Displays the option to set the font color of the control in the game when true. ) +/// /// public void fnGuiControl_setContextFontColor (string guicontrol, bool fontColor) @@ -21402,6 +26796,7 @@ public void fnGuiControl_setContextFontColor (string guicontrol, bool fontColor) } /// /// Displays the option to set the font size of the control in the game when true. ) +/// /// public void fnGuiControl_setContextFontSize (string guicontrol, bool fontSize) @@ -21416,6 +26811,7 @@ public void fnGuiControl_setContextFontSize (string guicontrol, bool fontSize) } /// /// Displays the option to lock the control in the game when true. ) +/// /// public void fnGuiControl_setContextLockControl (string guicontrol, bool lockx) @@ -21430,6 +26826,7 @@ public void fnGuiControl_setContextLockControl (string guicontrol, bool lockx) } /// /// Displays the option to set the mouse-over alpha of the control in the game when true. ) +/// /// public void fnGuiControl_setContextMouseOverAlpha (string guicontrol, bool mouseOver) @@ -21444,6 +26841,7 @@ public void fnGuiControl_setContextMouseOverAlpha (string guicontrol, bool mouse } /// /// Displays the option to move the control in the game when true. ) +/// /// public void fnGuiControl_setContextMoveControl (string guicontrol, bool move) @@ -21458,6 +26856,7 @@ public void fnGuiControl_setContextMoveControl (string guicontrol, bool move) } /// /// Set control background color. ) +/// /// public void fnGuiControl_setControlBackgroundColor (string guicontrol, string color) @@ -21475,6 +26874,7 @@ public void fnGuiControl_setControlBackgroundColor (string guicontrol, string co } /// /// Set control fill color. ) +/// /// public void fnGuiControl_setControlFillColor (string guicontrol, string color) @@ -21492,6 +26892,7 @@ public void fnGuiControl_setControlFillColor (string guicontrol, string color) } /// /// Set control font color. ) +/// /// public void fnGuiControl_setControlFontColor (string guicontrol, string color) @@ -21509,6 +26910,7 @@ public void fnGuiControl_setControlFontColor (string guicontrol, string color) } /// /// Sets the font size of a control. ) +/// /// public void fnGuiControl_setControlFontSize (string guicontrol, int fontSize) @@ -21523,6 +26925,7 @@ public void fnGuiControl_setControlFontSize (string guicontrol, int fontSize) } /// /// Lock the control. ) +/// /// public void fnGuiControl_setControlLock (string guicontrol, bool lockedx) @@ -21537,6 +26940,7 @@ public void fnGuiControl_setControlLock (string guicontrol, bool lockedx) } /// /// Set control texture. ) +/// /// public void fnGuiControl_setControlTexture (string guicontrol, string fileName) @@ -21553,7 +26957,9 @@ public void fnGuiControl_setControlTexture (string guicontrol, string fileName) SafeNativeMethods.mwle_fnGuiControl_setControlTexture(sbguicontrol, sbfileName); } /// -/// Sets the cursor as a plus. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Sets the cursor as a plus. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void fnGuiControl_setCur (string guicontrol) @@ -21567,7 +26973,12 @@ public void fnGuiControl_setCur (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_setCur(sbguicontrol); } /// -/// Make this control the current first responder. @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. @see GuiControlProfile::canKeyFocus @see isFirstResponder @ref GuiControl_FirstResponders ) +/// Make this control the current first responder. +/// @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. +/// @see GuiControlProfile::canKeyFocus +/// @see isFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public void fnGuiControl_setFirstResponder (string guicontrol) @@ -21581,7 +26992,9 @@ public void fnGuiControl_setFirstResponder (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_setFirstResponder(sbguicontrol); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void fnGuiControl_setMouseOverAlphaValue (string guicontrol, float alpha) @@ -21595,7 +27008,10 @@ public void fnGuiControl_setMouseOverAlphaValue (string guicontrol, float alpha) SafeNativeMethods.mwle_fnGuiControl_setMouseOverAlphaValue(sbguicontrol, alpha); } /// -/// Position the control in the local space of the parent control. @param x The new X coordinate of the control relative to its parent's upper left corner. @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// Position the control in the local space of the parent control. +/// @param x The new X coordinate of the control relative to its parent's upper left corner. +/// @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// /// public void fnGuiControl_setPosition (string guicontrol, int x, int y) @@ -21609,7 +27025,10 @@ public void fnGuiControl_setPosition (string guicontrol, int x, int y) SafeNativeMethods.mwle_fnGuiControl_setPosition(sbguicontrol, x, y); } /// -/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. @param x The new X coordinate of the control relative to the root's upper left corner. @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @param x The new X coordinate of the control relative to the root's upper left corner. +/// @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// /// public void fnGuiControl_setPositionGlobal (string guicontrol, int x, int y) @@ -21623,7 +27042,11 @@ public void fnGuiControl_setPositionGlobal (string guicontrol, int x, int y) SafeNativeMethods.mwle_fnGuiControl_setPositionGlobal(sbguicontrol, x, y); } /// -/// Set the control profile for the control to use. The profile used by a control determines a great part of its behavior and appearance. @param profile The new profile the control should use. @ref GuiControl_Profiles ) +/// Set the control profile for the control to use. +/// The profile used by a control determines a great part of its behavior and appearance. +/// @param profile The new profile the control should use. +/// @ref GuiControl_Profiles ) +/// /// public void fnGuiControl_setProfile (string guicontrol, string profile) @@ -21641,6 +27064,7 @@ public void fnGuiControl_setProfile (string guicontrol, string profile) } /// /// Displays the option to set the window settings of the control in the game when true. ) +/// /// public void fnGuiControl_setShowContextWindowSettings (string guicontrol, bool lockx) @@ -21654,7 +27078,9 @@ public void fnGuiControl_setShowContextWindowSettings (string guicontrol, bool l SafeNativeMethods.mwle_fnGuiControl_setShowContextWindowSettings(sbguicontrol, lockx); } /// -/// Set the value associated with the control. @param value The new value for the control. ) +/// Set the value associated with the control. +/// @param value The new value for the control. ) +/// /// public void fnGuiControl_setValue (string guicontrol, string value) @@ -21671,7 +27097,10 @@ public void fnGuiControl_setValue (string guicontrol, string value) SafeNativeMethods.mwle_fnGuiControl_setValue(sbguicontrol, sbvalue); } /// -/// Set whether the control is visible or not. @param state The new visiblity flag state for the control. @ref GuiControl_VisibleActive ) +/// Set whether the control is visible or not. +/// @param state The new visiblity flag state for the control. +/// @ref GuiControl_VisibleActive ) +/// /// public void fnGuiControl_setVisible (string guicontrol, bool state) @@ -21686,6 +27115,7 @@ public void fnGuiControl_setVisible (string guicontrol, bool state) } /// /// Returns true if the control is transparent. ) +/// /// public bool fnGuiControl_transparentControlCheck (string guicontrol) @@ -21699,7 +27129,9 @@ public bool fnGuiControl_transparentControlCheck (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_transparentControlCheck(sbguicontrol)>=1; } /// -/// Get the currently selected filename. @return The filename of the currently selected file ) +/// Get the currently selected filename. +/// @return The filename of the currently selected file ) +/// /// public string fnGuiDirectoryFileListCtrl_getSelectedFile (string guidirectoryfilelistctrl) @@ -21716,7 +27148,9 @@ public string fnGuiDirectoryFileListCtrl_getSelectedFile (string guidirectoryfil } /// -/// Get the list of selected files. @return A space separated list of selected files ) +/// Get the list of selected files. +/// @return A space separated list of selected files ) +/// /// public string fnGuiDirectoryFileListCtrl_getSelectedFiles (string guidirectoryfilelistctrl) @@ -21734,6 +27168,7 @@ public string fnGuiDirectoryFileListCtrl_getSelectedFiles (string guidirectoryfi } /// /// Update the file list. ) +/// /// public void fnGuiDirectoryFileListCtrl_reload (string guidirectoryfilelistctrl) @@ -21747,7 +27182,9 @@ public void fnGuiDirectoryFileListCtrl_reload (string guidirectoryfilelistctrl) SafeNativeMethods.mwle_fnGuiDirectoryFileListCtrl_reload(sbguidirectoryfilelistctrl); } /// -/// Set the file filter. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the file filter. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public void fnGuiDirectoryFileListCtrl_setFilter (string guidirectoryfilelistctrl, string filter) @@ -21764,7 +27201,10 @@ public void fnGuiDirectoryFileListCtrl_setFilter (string guidirectoryfilelistctr SafeNativeMethods.mwle_fnGuiDirectoryFileListCtrl_setFilter(sbguidirectoryfilelistctrl, sbfilter); } /// -/// Set the search path and file filter. @param path Path in game directory from which to list files. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the search path and file filter. +/// @param path Path in game directory from which to list files. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public bool fnGuiDirectoryFileListCtrl_setPath (string guidirectoryfilelistctrl, string path, string filter) @@ -21784,7 +27224,10 @@ public bool fnGuiDirectoryFileListCtrl_setPath (string guidirectoryfilelistctrl, return SafeNativeMethods.mwle_fnGuiDirectoryFileListCtrl_setPath(sbguidirectoryfilelistctrl, sbpath, sbfilter)>=1; } /// -/// Start the drag operation. @param x X coordinate for the mouse pointer offset which the drag control should position itself. @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// Start the drag operation. +/// @param x X coordinate for the mouse pointer offset which the drag control should position itself. +/// @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// /// public void fnGuiDragAndDropControl_startDragging (string guidraganddropcontrol, int x, int y) @@ -21799,6 +27242,7 @@ public void fnGuiDragAndDropControl_startDragging (string guidraganddropcontrol, } /// /// Recalculates the position and size of this control and all its children. ) +/// /// public void fnGuiDynamicCtrlArrayControl_refresh (string guidynamicctrlarraycontrol) @@ -21813,6 +27257,7 @@ public void fnGuiDynamicCtrlArrayControl_refresh (string guidynamicctrlarraycont } /// /// Gets the set of GUI controls currently selected in the editor. ) +/// /// public string fnGuiEditCtrl_getSelection (string guieditctrl) @@ -21830,6 +27275,7 @@ public string fnGuiEditCtrl_getSelection (string guieditctrl) } /// /// Gets the GUI controls(s) that are currently in the trash.) +/// /// public string fnGuiEditCtrl_getTrash (string guieditctrl) @@ -21846,7 +27292,10 @@ public string fnGuiEditCtrl_getTrash (string guieditctrl) } /// -/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) Reset the filter to use the specified points, spread equidistantly across the domain. @internal) +/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) +/// Reset the filter to use the specified points, spread equidistantly across the domain. +/// @internal) +/// /// public void fnGuiFilterCtrl_setValue (string guifilterctrl, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -21914,15 +27363,11 @@ public void fnGuiFilterCtrl_setValue (string guifilterctrl, string a2, string a3 SafeNativeMethods.mwle_fnGuiFilterCtrl_setValue(sbguifilterctrl, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// Recalculates the position and size of this control and all its children. ) +/// Get the ID of this form's menu. +/// @return The ID of the form menu ) /// /// - -/// -/// Get the ID of this form's menu. @return The ID of the form menu ) -/// - public int fnGuiFormCtrl_getMenuID (string guiformctrl) { if(Debugging) @@ -21934,7 +27379,9 @@ public int fnGuiFormCtrl_getMenuID (string guiformctrl) return SafeNativeMethods.mwle_fnGuiFormCtrl_getMenuID(sbguiformctrl); } /// -/// Sets the title of the form. @param caption Form caption ) +/// Sets the title of the form. +/// @param caption Form caption ) +/// /// public void fnGuiFormCtrl_setCaption (string guiformctrl, string caption) @@ -21952,6 +27399,7 @@ public void fnGuiFormCtrl_setCaption (string guiformctrl, string caption) } /// /// Add a new column. ) +/// /// public void fnGuiFrameSetCtrl_addColumn (string guiframesetctrl) @@ -21966,6 +27414,7 @@ public void fnGuiFrameSetCtrl_addColumn (string guiframesetctrl) } /// /// Add a new row. ) +/// /// public void fnGuiFrameSetCtrl_addRow (string guiframesetctrl) @@ -21979,7 +27428,11 @@ public void fnGuiFrameSetCtrl_addRow (string guiframesetctrl) SafeNativeMethods.mwle_fnGuiFrameSetCtrl_addRow(sbguiframesetctrl); } /// -/// dynamic ), Override the i>borderEnable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderEnable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void fnGuiFrameSetCtrl_frameBorder (string guiframesetctrl, int index, string state) @@ -21996,7 +27449,12 @@ public void fnGuiFrameSetCtrl_frameBorder (string guiframesetctrl, int index, st SafeNativeMethods.mwle_fnGuiFrameSetCtrl_frameBorder(sbguiframesetctrl, index, sbstate); } /// -/// Set the minimum width and height for the frame. It will not be possible for the user to resize the frame smaller than this. @param index Index of the frame to modify @param width Minimum width in pixels @param height Minimum height in pixels ) +/// Set the minimum width and height for the frame. It will not be possible +/// for the user to resize the frame smaller than this. +/// @param index Index of the frame to modify +/// @param width Minimum width in pixels +/// @param height Minimum height in pixels ) +/// /// public void fnGuiFrameSetCtrl_frameMinExtent (string guiframesetctrl, int index, int width, int height) @@ -22010,7 +27468,11 @@ public void fnGuiFrameSetCtrl_frameMinExtent (string guiframesetctrl, int index, SafeNativeMethods.mwle_fnGuiFrameSetCtrl_frameMinExtent(sbguiframesetctrl, index, width, height); } /// -/// dynamic ), Override the i>borderMovable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderMovable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void fnGuiFrameSetCtrl_frameMovable (string guiframesetctrl, int index, string state) @@ -22027,7 +27489,11 @@ public void fnGuiFrameSetCtrl_frameMovable (string guiframesetctrl, int index, s SafeNativeMethods.mwle_fnGuiFrameSetCtrl_frameMovable(sbguiframesetctrl, index, sbstate); } /// -/// Set the padding for this frame. Padding introduces blank space on the inside edge of the frame. @param index Index of the frame to modify @param padding Frame top, bottom, left, and right padding ) +/// Set the padding for this frame. Padding introduces blank space on the inside +/// edge of the frame. +/// @param index Index of the frame to modify +/// @param padding Frame top, bottom, left, and right padding ) +/// /// public void fnGuiFrameSetCtrl_framePadding (string guiframesetctrl, int index, string padding) @@ -22044,7 +27510,9 @@ public void fnGuiFrameSetCtrl_framePadding (string guiframesetctrl, int index, s SafeNativeMethods.mwle_fnGuiFrameSetCtrl_framePadding(sbguiframesetctrl, index, sbpadding); } /// -/// Get the number of columns. @return The number of columns ) +/// Get the number of columns. +/// @return The number of columns ) +/// /// public int fnGuiFrameSetCtrl_getColumnCount (string guiframesetctrl) @@ -22058,7 +27526,10 @@ public int fnGuiFrameSetCtrl_getColumnCount (string guiframesetctrl) return SafeNativeMethods.mwle_fnGuiFrameSetCtrl_getColumnCount(sbguiframesetctrl); } /// -/// Get the horizontal offset of a column. @param index Index of the column to query @return Column offset in pixels ) +/// Get the horizontal offset of a column. +/// @param index Index of the column to query +/// @return Column offset in pixels ) +/// /// public int fnGuiFrameSetCtrl_getColumnOffset (string guiframesetctrl, int index) @@ -22072,7 +27543,9 @@ public int fnGuiFrameSetCtrl_getColumnOffset (string guiframesetctrl, int index) return SafeNativeMethods.mwle_fnGuiFrameSetCtrl_getColumnOffset(sbguiframesetctrl, index); } /// -/// Get the padding for this frame. @param index Index of the frame to query ) +/// Get the padding for this frame. +/// @param index Index of the frame to query ) +/// /// public string fnGuiFrameSetCtrl_getFramePadding (string guiframesetctrl, int index) @@ -22089,7 +27562,9 @@ public string fnGuiFrameSetCtrl_getFramePadding (string guiframesetctrl, int ind } /// -/// Get the number of rows. @return The number of rows ) +/// Get the number of rows. +/// @return The number of rows ) +/// /// public int fnGuiFrameSetCtrl_getRowCount (string guiframesetctrl) @@ -22103,7 +27578,10 @@ public int fnGuiFrameSetCtrl_getRowCount (string guiframesetctrl) return SafeNativeMethods.mwle_fnGuiFrameSetCtrl_getRowCount(sbguiframesetctrl); } /// -/// Get the vertical offset of a row. @param index Index of the row to query @return Row offset in pixels ) +/// Get the vertical offset of a row. +/// @param index Index of the row to query +/// @return Row offset in pixels ) +/// /// public int fnGuiFrameSetCtrl_getRowOffset (string guiframesetctrl, int index) @@ -22118,6 +27596,7 @@ public int fnGuiFrameSetCtrl_getRowOffset (string guiframesetctrl, int index) } /// /// Remove the last (rightmost) column. ) +/// /// public void fnGuiFrameSetCtrl_removeColumn (string guiframesetctrl) @@ -22132,6 +27611,7 @@ public void fnGuiFrameSetCtrl_removeColumn (string guiframesetctrl) } /// /// Remove the last (bottom) row. ) +/// /// public void fnGuiFrameSetCtrl_removeRow (string guiframesetctrl) @@ -22145,7 +27625,12 @@ public void fnGuiFrameSetCtrl_removeRow (string guiframesetctrl) SafeNativeMethods.mwle_fnGuiFrameSetCtrl_removeRow(sbguiframesetctrl); } /// -/// Set the horizontal offset of a column. Note that column offsets must always be in increasing order, and therefore this offset must be between the offsets of the colunns either side. @param index Index of the column to modify @param offset New column offset ) +/// Set the horizontal offset of a column. +/// Note that column offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the colunns either side. +/// @param index Index of the column to modify +/// @param offset New column offset ) +/// /// public void fnGuiFrameSetCtrl_setColumnOffset (string guiframesetctrl, int index, int offset) @@ -22159,7 +27644,12 @@ public void fnGuiFrameSetCtrl_setColumnOffset (string guiframesetctrl, int index SafeNativeMethods.mwle_fnGuiFrameSetCtrl_setColumnOffset(sbguiframesetctrl, index, offset); } /// -/// Set the vertical offset of a row. Note that row offsets must always be in increasing order, and therefore this offset must be between the offsets of the rows either side. @param index Index of the row to modify @param offset New row offset ) +/// Set the vertical offset of a row. +/// Note that row offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the rows either side. +/// @param index Index of the row to modify +/// @param offset New row offset ) +/// /// public void fnGuiFrameSetCtrl_setRowOffset (string guiframesetctrl, int index, int offset) @@ -22174,6 +27664,7 @@ public void fnGuiFrameSetCtrl_setRowOffset (string guiframesetctrl, int index, i } /// /// Recalculates child control sizes. ) +/// /// public void fnGuiFrameSetCtrl_updateSizes (string guiframesetctrl) @@ -22188,6 +27679,7 @@ public void fnGuiFrameSetCtrl_updateSizes (string guiframesetctrl) } /// /// Activates the current row. The script callback of the current row will be called (if it has one). ) +/// /// public void fnGuiGameListMenuCtrl_activateRow (string guigamelistmenuctrl) @@ -22201,7 +27693,14 @@ public void fnGuiGameListMenuCtrl_activateRow (string guigamelistmenuctrl) SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_activateRow(sbguigamelistmenuctrl); } /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param useHighlightIcon [optional] Does this row use the highlight icon?. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param useHighlightIcon [optional] Does this row use the highlight icon?. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void fnGuiGameListMenuCtrl_addRow (string guigamelistmenuctrl, string label, string callback, int icon, int yPad, bool useHighlightIcon, bool enabled) @@ -22221,7 +27720,9 @@ public void fnGuiGameListMenuCtrl_addRow (string guigamelistmenuctrl, string lab SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_addRow(sbguigamelistmenuctrl, sblabel, sbcallback, icon, yPad, useHighlightIcon, enabled); } /// -/// Gets the number of rows on the control. @return (int) The number of rows on the control. ) +/// Gets the number of rows on the control. +/// @return (int) The number of rows on the control. ) +/// /// public int fnGuiGameListMenuCtrl_getRowCount (string guigamelistmenuctrl) @@ -22235,7 +27736,10 @@ public int fnGuiGameListMenuCtrl_getRowCount (string guigamelistmenuctrl) return SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_getRowCount(sbguigamelistmenuctrl); } /// -/// Gets the label displayed on the specified row. @param row Index of the row to get the label of. @return The label for the row. ) +/// Gets the label displayed on the specified row. +/// @param row Index of the row to get the label of. +/// @return The label for the row. ) +/// /// public string fnGuiGameListMenuCtrl_getRowLabel (string guigamelistmenuctrl, int row) @@ -22252,7 +27756,9 @@ public string fnGuiGameListMenuCtrl_getRowLabel (string guigamelistmenuctrl, int } /// -/// Gets the index of the currently selected row. @return Index of the selected row. ) +/// Gets the index of the currently selected row. +/// @return Index of the selected row. ) +/// /// public int fnGuiGameListMenuCtrl_getSelectedRow (string guigamelistmenuctrl) @@ -22266,7 +27772,10 @@ public int fnGuiGameListMenuCtrl_getSelectedRow (string guigamelistmenuctrl) return SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_getSelectedRow(sbguigamelistmenuctrl); } /// -/// Determines if the specified row is enabled or disabled. @param row The row to set the enabled status of. @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// Determines if the specified row is enabled or disabled. +/// @param row The row to set the enabled status of. +/// @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// /// public bool fnGuiGameListMenuCtrl_isRowEnabled (string guigamelistmenuctrl, int row) @@ -22280,7 +27789,10 @@ public bool fnGuiGameListMenuCtrl_isRowEnabled (string guigamelistmenuctrl, int return SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_isRowEnabled(sbguigamelistmenuctrl, row)>=1; } /// -/// Sets a row's enabled status according to the given parameters. @param row The index to check for validity. @param enabled Indicate true to enable the row or false to disable it. ) +/// Sets a row's enabled status according to the given parameters. +/// @param row The index to check for validity. +/// @param enabled Indicate true to enable the row or false to disable it. ) +/// /// public void fnGuiGameListMenuCtrl_setRowEnabled (string guigamelistmenuctrl, int row, bool enabled) @@ -22294,7 +27806,10 @@ public void fnGuiGameListMenuCtrl_setRowEnabled (string guigamelistmenuctrl, int SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_setRowEnabled(sbguigamelistmenuctrl, row, enabled); } /// -/// Sets the label on the given row. @param row Index of the row to set the label on. @param label Text to set as the label of the row. ) +/// Sets the label on the given row. +/// @param row Index of the row to set the label on. +/// @param label Text to set as the label of the row. ) +/// /// public void fnGuiGameListMenuCtrl_setRowLabel (string guigamelistmenuctrl, int row, string label) @@ -22311,7 +27826,9 @@ public void fnGuiGameListMenuCtrl_setRowLabel (string guigamelistmenuctrl, int r SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_setRowLabel(sbguigamelistmenuctrl, row, sblabel); } /// -/// Sets the selected row. Only rows that are enabled can be selected. @param row Index of the row to set as selected. ) +/// Sets the selected row. Only rows that are enabled can be selected. +/// @param row Index of the row to set as selected. ) +/// /// public void fnGuiGameListMenuCtrl_setSelected (string guigamelistmenuctrl, int row) @@ -22325,7 +27842,15 @@ public void fnGuiGameListMenuCtrl_setSelected (string guigamelistmenuctrl, int r SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_setSelected(sbguigamelistmenuctrl, row); } /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param options A tab separated list of options. @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param options A tab separated list of options. +/// @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void fnGuiGameListOptionsCtrl_addRow (string guigamelistoptionsctrl, string label, string options, bool wrapOptions, string callback, int icon, int yPad, bool enabled) @@ -22348,7 +27873,10 @@ public void fnGuiGameListOptionsCtrl_addRow (string guigamelistoptionsctrl, stri SafeNativeMethods.mwle_fnGuiGameListOptionsCtrl_addRow(sbguigamelistoptionsctrl, sblabel, sboptions, wrapOptions, sbcallback, icon, yPad, enabled); } /// -/// Gets the text for the currently selected option of the given row. @param row Index of the row to get the option from. @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// Gets the text for the currently selected option of the given row. +/// @param row Index of the row to get the option from. +/// @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// /// public string fnGuiGameListOptionsCtrl_getCurrentOption (string guigamelistoptionsctrl, int row) @@ -22365,7 +27893,11 @@ public string fnGuiGameListOptionsCtrl_getCurrentOption (string guigamelistoptio } /// -/// Set the row's current option to the one specified @param row Index of the row to set an option on. @param option The option to be made active. @return True if the row contained the option and was set, false otherwise. ) +/// Set the row's current option to the one specified +/// @param row Index of the row to set an option on. +/// @param option The option to be made active. +/// @return True if the row contained the option and was set, false otherwise. ) +/// /// public bool fnGuiGameListOptionsCtrl_selectOption (string guigamelistoptionsctrl, int row, string option) @@ -22382,7 +27914,10 @@ public bool fnGuiGameListOptionsCtrl_selectOption (string guigamelistoptionsctrl return SafeNativeMethods.mwle_fnGuiGameListOptionsCtrl_selectOption(sbguigamelistoptionsctrl, row, sboption)>=1; } /// -/// Sets the list of options on the given row. @param row Index of the row to set options on. @param optionsList A tab separated list of options for the control. ) +/// Sets the list of options on the given row. +/// @param row Index of the row to set options on. +/// @param optionsList A tab separated list of options for the control. ) +/// /// public void fnGuiGameListOptionsCtrl_setOptions (string guigamelistoptionsctrl, int row, string optionsList) @@ -22399,7 +27934,16 @@ public void fnGuiGameListOptionsCtrl_setOptions (string guigamelistoptionsctrl, SafeNativeMethods.mwle_fnGuiGameListOptionsCtrl_setOptions(sbguigamelistoptionsctrl, row, sboptionsList); } /// -/// Sets up the given plotting curve to automatically plot the value of the @a variable with a frequency of @a updateFrequency. @param plotId Index of the plotting curve. Must be 0=plotId6. @param variable Name of the global variable. @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). @tsexample // Plot FPS counter at 1 second intervals. %graph.addAutoPlot( 0, \"fps::real\", 1000 ); @endtsexample ) +/// Sets up the given plotting curve to automatically plot the value of the @a variable with a +/// frequency of @a updateFrequency. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param variable Name of the global variable. +/// @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). +/// @tsexample +/// // Plot FPS counter at 1 second intervals. +/// %graph.addAutoPlot( 0, \"fps::real\", 1000 ); +/// @endtsexample ) +/// /// public void fnGuiGraphCtrl_addAutoPlot (string guigraphctrl, int plotId, string variable, int updateFrequency) @@ -22416,7 +27960,13 @@ public void fnGuiGraphCtrl_addAutoPlot (string guigraphctrl, int plotId, string SafeNativeMethods.mwle_fnGuiGraphCtrl_addAutoPlot(sbguigraphctrl, plotId, sbvariable, updateFrequency); } /// -/// Add a data point to the plot's curve. @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. @param value Value of the data point to add to the curve. @note Data values are added to the @b left end of the plotting curve. @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If this limit is exceeded, data points on the right end of the curve are culled. ) +/// Add a data point to the plot's curve. +/// @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. +/// @param value Value of the data point to add to the curve. +/// @note Data values are added to the @b left end of the plotting curve. +/// @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If +/// this limit is exceeded, data points on the right end of the curve are culled. ) +/// /// public void fnGuiGraphCtrl_addDatum (string guigraphctrl, int plotId, float value) @@ -22430,7 +27980,11 @@ public void fnGuiGraphCtrl_addDatum (string guigraphctrl, int plotId, float valu SafeNativeMethods.mwle_fnGuiGraphCtrl_addDatum(sbguigraphctrl, plotId, value); } /// -/// Get a data point on the given plotting curve. @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. @param index Index of the data point on the curve. @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// Get a data point on the given plotting curve. +/// @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. +/// @param index Index of the data point on the curve. +/// @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// /// public float fnGuiGraphCtrl_getDatum (string guigraphctrl, int plotId, int index) @@ -22444,7 +27998,9 @@ public float fnGuiGraphCtrl_getDatum (string guigraphctrl, int plotId, int index return SafeNativeMethods.mwle_fnGuiGraphCtrl_getDatum(sbguigraphctrl, plotId, index); } /// -/// Stop automatic variable plotting for the given curve. @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// Stop automatic variable plotting for the given curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// /// public void fnGuiGraphCtrl_removeAutoPlot (string guigraphctrl, int plotId) @@ -22458,7 +28014,11 @@ public void fnGuiGraphCtrl_removeAutoPlot (string guigraphctrl, int plotId) SafeNativeMethods.mwle_fnGuiGraphCtrl_removeAutoPlot(sbguigraphctrl, plotId); } /// -/// Change the charting type of the given plotting curve. @param plotId Index of the plotting curve. Must be 0=plotId6. @param graphType Charting type to use for the curve. @note Instead of calling this method, you can directly assign to #plotType. ) +/// Change the charting type of the given plotting curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param graphType Charting type to use for the curve. +/// @note Instead of calling this method, you can directly assign to #plotType. ) +/// /// public void fnGuiGraphCtrl_setGraphType (string guigraphctrl, int plotId, int graphType) @@ -22472,7 +28032,17 @@ public void fnGuiGraphCtrl_setGraphType (string guigraphctrl, int plotId, int gr SafeNativeMethods.mwle_fnGuiGraphCtrl_setGraphType(sbguigraphctrl, plotId, graphType); } /// -/// @brief Set the bitmap to use for the button portion of this control. @param buttonFilename Filename for the image @tsexample // Define the button filename %buttonFilename = \"pearlButton\"; // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); @endtsexample @see GuiControl @see GuiButtonCtrl) +/// @brief Set the bitmap to use for the button portion of this control. +/// @param buttonFilename Filename for the image +/// @tsexample +/// // Define the button filename +/// %buttonFilename = \"pearlButton\"; +/// // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap +/// %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); +/// @endtsexample +/// @see GuiControl +/// @see GuiButtonCtrl) +/// /// public void fnGuiIconButtonCtrl_setBitmap (string guiiconbuttonctrl, string buttonFilename) @@ -22489,7 +28059,14 @@ public void fnGuiIconButtonCtrl_setBitmap (string guiiconbuttonctrl, string butt SafeNativeMethods.mwle_fnGuiIconButtonCtrl_setBitmap(sbguiiconbuttonctrl, sbbuttonFilename); } /// -/// @brief Clears the imagelist @tsexample // Inform the GuiImageList control to clear itself. %isFinished = %thisGuiImageList.clear(); @endtsexample @return Returns true when finished. @see SimObject) +/// @brief Clears the imagelist +/// @tsexample +/// // Inform the GuiImageList control to clear itself. +/// %isFinished = %thisGuiImageList.clear(); +/// @endtsexample +/// @return Returns true when finished. +/// @see SimObject) +/// /// public bool fnGuiImageList_clear (string guiimagelist) @@ -22503,7 +28080,14 @@ public bool fnGuiImageList_clear (string guiimagelist) return SafeNativeMethods.mwle_fnGuiImageList_clear(sbguiimagelist)>=1; } /// -/// @brief Gets the number of images in the list. @tsexample // Request the number of images from the GuiImageList control. %imageCount = %thisGuiImageList.count(); @endtsexample @return Number of images in the control. @see SimObject) +/// @brief Gets the number of images in the list. +/// @tsexample +/// // Request the number of images from the GuiImageList control. +/// %imageCount = %thisGuiImageList.count(); +/// @endtsexample +/// @return Number of images in the control. +/// @see SimObject) +/// /// public int fnGuiImageList_count (string guiimagelist) @@ -22517,7 +28101,17 @@ public int fnGuiImageList_count (string guiimagelist) return SafeNativeMethods.mwle_fnGuiImageList_count(sbguiimagelist); } /// -/// @brief Get a path to the texture at the specified index. @param index Index of the image in the list. @tsexample // Define the image index/n %index = \"5\"; // Request the image path location from the control. %imagePath = %thisGuiImageList.getImage(%index); @endtsexample @return File path to the image map for the specified index. @see SimObject) +/// @brief Get a path to the texture at the specified index. +/// @param index Index of the image in the list. +/// @tsexample +/// // Define the image index/n +/// %index = \"5\"; +/// // Request the image path location from the control. +/// %imagePath = %thisGuiImageList.getImage(%index); +/// @endtsexample +/// @return File path to the image map for the specified index. +/// @see SimObject) +/// /// public string fnGuiImageList_getImage (string guiimagelist, int index) @@ -22534,7 +28128,17 @@ public string fnGuiImageList_getImage (string guiimagelist, int index) } /// -/// @brief Retrieves the imageindex of a specified texture in the list. @param imagePath Imagemap including filepath of image to search for @tsexample // Define the imagemap to search for %imagePath = \"./game/client/data/images/thisImage\"; // Request the index entry for the defined imagemap %imageIndex = %thisGuiImageList.getIndex(%imagePath); @endtsexample @return Index of the imagemap matching the defined image path. @see SimObject) +/// @brief Retrieves the imageindex of a specified texture in the list. +/// @param imagePath Imagemap including filepath of image to search for +/// @tsexample +/// // Define the imagemap to search for +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the index entry for the defined imagemap +/// %imageIndex = %thisGuiImageList.getIndex(%imagePath); +/// @endtsexample +/// @return Index of the imagemap matching the defined image path. +/// @see SimObject) +/// /// public int fnGuiImageList_getIndex (string guiimagelist, string imagePath) @@ -22551,7 +28155,17 @@ public int fnGuiImageList_getIndex (string guiimagelist, string imagePath) return SafeNativeMethods.mwle_fnGuiImageList_getIndex(sbguiimagelist, sbimagePath); } /// -/// @brief Insert an image into imagelist- returns the image index or -1 for failure. @param imagePath Imagemap, with path, to add to the list. @tsexample // Define the imagemap to add to the list %imagePath = \"./game/client/data/images/thisImage\"; // Request the GuiImageList control to add the defined image to its list. %imageIndex = %thisGuiImageList.insert(%imagePath); @endtsexample @return The index of the newly inserted imagemap, or -1 if the insertion failed. @see SimObject) +/// @brief Insert an image into imagelist- returns the image index or -1 for failure. +/// @param imagePath Imagemap, with path, to add to the list. +/// @tsexample +/// // Define the imagemap to add to the list +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the GuiImageList control to add the defined image to its list. +/// %imageIndex = %thisGuiImageList.insert(%imagePath); +/// @endtsexample +/// @return The index of the newly inserted imagemap, or -1 if the insertion failed. +/// @see SimObject) +/// /// public int fnGuiImageList_insert (string guiimagelist, string imagePath) @@ -22568,7 +28182,17 @@ public int fnGuiImageList_insert (string guiimagelist, string imagePath) return SafeNativeMethods.mwle_fnGuiImageList_insert(sbguiimagelist, sbimagePath); } /// -/// @brief Removes an image from the list by index. @param index Image index to remove. @tsexample // Define the image index. %imageIndex = \"4\"; // Inform the GuiImageList control to remove the image at the defined index. %wasSuccessful = %thisGuiImageList.remove(%imageIndex); @endtsexample @return True if the operation was successful, false if it was not. @see SimObject) +/// @brief Removes an image from the list by index. +/// @param index Image index to remove. +/// @tsexample +/// // Define the image index. +/// %imageIndex = \"4\"; +/// // Inform the GuiImageList control to remove the image at the defined index. +/// %wasSuccessful = %thisGuiImageList.remove(%imageIndex); +/// @endtsexample +/// @return True if the operation was successful, false if it was not. +/// @see SimObject) +/// /// public bool fnGuiImageList_remove (string guiimagelist, int index) @@ -22583,6 +28207,7 @@ public bool fnGuiImageList_remove (string guiimagelist, int index) } /// /// ( GuiInspectorTypeBitMask32, applyBit, void, 2,2, apply(); ) +/// /// public void fnGuiInspectorTypeBitMask32_applyBit (string guiinspectortypebitmask32) @@ -22597,6 +28222,7 @@ public void fnGuiInspectorTypeBitMask32_applyBit (string guiinspectortypebitmask } /// /// ( GuiInspectorTypeFileName, apply, void, 3,3, apply(newValue); ) +/// /// public void fnGuiInspectorTypeFileName_apply (string guiinspectortypefilename, string a2) @@ -22613,7 +28239,17 @@ public void fnGuiInspectorTypeFileName_apply (string guiinspectortypefilename, s SafeNativeMethods.mwle_fnGuiInspectorTypeFileName_apply(sbguiinspectortypefilename, sba2); } /// -/// @brief Checks if there is an item with the exact text of what is passed in, and if so the item is removed from the list and adds that item's data to the filtered list. @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. @tsexample // Define the itemName that we wish to add to the filtered item list. %itemName = \"This Item Name\"; // Add the item name to the filtered item list. %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); @endtsexample @see GuiControl) +/// @brief Checks if there is an item with the exact text of what is passed in, and if so +/// the item is removed from the list and adds that item's data to the filtered list. +/// @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. +/// @tsexample +/// // Define the itemName that we wish to add to the filtered item list. +/// %itemName = \"This Item Name\"; +/// // Add the item name to the filtered item list. +/// %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_addFilteredItem (string guilistboxctrl, string newItem) @@ -22630,7 +28266,22 @@ public void fnGuiListBoxCtrl_addFilteredItem (string guilistboxctrl, string newI SafeNativeMethods.mwle_fnGuiListBoxCtrl_addFilteredItem(sbguilistboxctrl, sbnewItem); } /// -/// ), @brief Adds an item to the end of the list with an optional color. @param newItem New item to add to the list. @param color Optional color parameter to add to the new item. @tsexample // Define the item to add to the list. %newItem = \"Gideon's Blue Coat\"; // Define the optional color for the new list item. %color = \"0.0 0.0 1.0\"; // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. %thisGuiListBoxCtrl.addItem(%newItem,%color); @endtsexample @return If not void, return value and description @see GuiControl @hide) +/// ), +/// @brief Adds an item to the end of the list with an optional color. +/// @param newItem New item to add to the list. +/// @param color Optional color parameter to add to the new item. +/// @tsexample +/// // Define the item to add to the list. +/// %newItem = \"Gideon's Blue Coat\"; +/// // Define the optional color for the new list item. +/// %color = \"0.0 0.0 1.0\"; +/// // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. +/// %thisGuiListBoxCtrl.addItem(%newItem,%color); +/// @endtsexample +/// @return If not void, return value and description +/// @see GuiControl +/// @hide) +/// /// public int fnGuiListBoxCtrl_addItem (string guilistboxctrl, string newItem, string color) @@ -22650,7 +28301,16 @@ public int fnGuiListBoxCtrl_addItem (string guilistboxctrl, string newItem, stri return SafeNativeMethods.mwle_fnGuiListBoxCtrl_addItem(sbguilistboxctrl, sbnewItem, sbcolor); } /// -/// @brief Removes any custom coloring from an item at the defined index id in the list. @param index Index id for the item to clear any custom color from. @tsexample // Define the index id %index = \"4\"; // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry %thisGuiListBoxCtrl.clearItemColor(%index); @endtsexample @see GuiControl) +/// @brief Removes any custom coloring from an item at the defined index id in the list. +/// @param index Index id for the item to clear any custom color from. +/// @tsexample +/// // Define the index id +/// %index = \"4\"; +/// // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry +/// %thisGuiListBoxCtrl.clearItemColor(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_clearItemColor (string guilistboxctrl, int index) @@ -22664,7 +28324,13 @@ public void fnGuiListBoxCtrl_clearItemColor (string guilistboxctrl, int index) SafeNativeMethods.mwle_fnGuiListBoxCtrl_clearItemColor(sbguilistboxctrl, index); } /// -/// @brief Clears all the items in the listbox. @tsexample // Inform the GuiListBoxCtrl object to clear all items from its list. %thisGuiListBoxCtrl.clearItems(); @endtsexample @see GuiControl) +/// @brief Clears all the items in the listbox. +/// @tsexample +/// // Inform the GuiListBoxCtrl object to clear all items from its list. +/// %thisGuiListBoxCtrl.clearItems(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_clearItems (string guilistboxctrl) @@ -22678,7 +28344,14 @@ public void fnGuiListBoxCtrl_clearItems (string guilistboxctrl) SafeNativeMethods.mwle_fnGuiListBoxCtrl_clearItems(sbguilistboxctrl); } /// -/// @brief Sets all currently selected items to unselected. Detailed description @tsexample // Inform the GuiListBoxCtrl object to set all of its items to unselected./n %thisGuiListBoxCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Sets all currently selected items to unselected. +/// Detailed description +/// @tsexample +/// // Inform the GuiListBoxCtrl object to set all of its items to unselected./n +/// %thisGuiListBoxCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_clearSelection (string guilistboxctrl) @@ -22692,7 +28365,16 @@ public void fnGuiListBoxCtrl_clearSelection (string guilistboxctrl) SafeNativeMethods.mwle_fnGuiListBoxCtrl_clearSelection(sbguilistboxctrl); } /// -/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. @param itemIndex Index id location to remove the item from. @tsexample // Define the index id we want to remove from the list %itemIndex = \"8\"; // Inform the GuiListBoxCtrl object to remove the item at the defined index id. %thisGuiListBoxCtrl.deleteItem(%itemIndex); @endtsexample @see References) +/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. +/// @param itemIndex Index id location to remove the item from. +/// @tsexample +/// // Define the index id we want to remove from the list +/// %itemIndex = \"8\"; +/// // Inform the GuiListBoxCtrl object to remove the item at the defined index id. +/// %thisGuiListBoxCtrl.deleteItem(%itemIndex); +/// @endtsexample +/// @see References) +/// /// public void fnGuiListBoxCtrl_deleteItem (string guilistboxctrl, int itemIndex) @@ -22706,7 +28388,13 @@ public void fnGuiListBoxCtrl_deleteItem (string guilistboxctrl, int itemIndex) SafeNativeMethods.mwle_fnGuiListBoxCtrl_deleteItem(sbguilistboxctrl, itemIndex); } /// -/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. @tsexample \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet %thisGuiListBox.doMirror(); @endtsexample @see GuiCore) +/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. +/// @tsexample +/// \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet +/// %thisGuiListBox.doMirror(); +/// @endtsexample +/// @see GuiCore) +/// /// public void fnGuiListBoxCtrl_doMirror (string guilistboxctrl) @@ -22720,7 +28408,20 @@ public void fnGuiListBoxCtrl_doMirror (string guilistboxctrl) SafeNativeMethods.mwle_fnGuiListBoxCtrl_doMirror(sbguilistboxctrl); } /// -/// @brief Returns index of item with matching text or -1 if none found. @param findText Text in the list to find. @param isCaseSensitive If true, the search will be case sensitive. @tsexample // Define the text we wish to find in the list. %findText = \"Hickory Smoked Gideon\"/n/n // Define if this is a case sensitive search or not. %isCaseSensitive = \"false\"; // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); @endtsexample @return Index id of item with matching text or -1 if none found. @see GuiControl) +/// @brief Returns index of item with matching text or -1 if none found. +/// @param findText Text in the list to find. +/// @param isCaseSensitive If true, the search will be case sensitive. +/// @tsexample +/// // Define the text we wish to find in the list. +/// %findText = \"Hickory Smoked Gideon\"/n/n +/// // Define if this is a case sensitive search or not. +/// %isCaseSensitive = \"false\"; +/// // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. +/// %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); +/// @endtsexample +/// @return Index id of item with matching text or -1 if none found. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_findItemText (string guilistboxctrl, string findText, bool bCaseSensitive) @@ -22737,7 +28438,14 @@ public int fnGuiListBoxCtrl_findItemText (string guilistboxctrl, string findText return SafeNativeMethods.mwle_fnGuiListBoxCtrl_findItemText(sbguilistboxctrl, sbfindText, bCaseSensitive); } /// -/// @brief Returns the number of items in the list. @tsexample // Request the number of items in the list of the GuiListBoxCtrl object. %listItemCount = %thisGuiListBoxCtrl.getItemCount(); @endtsexample @return The number of items in the list. @see GuiControl) +/// @brief Returns the number of items in the list. +/// @tsexample +/// // Request the number of items in the list of the GuiListBoxCtrl object. +/// %listItemCount = %thisGuiListBoxCtrl.getItemCount(); +/// @endtsexample +/// @return The number of items in the list. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getItemCount (string guilistboxctrl) @@ -22751,7 +28459,17 @@ public int fnGuiListBoxCtrl_getItemCount (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getItemCount(sbguilistboxctrl); } /// -/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. @param index Index id to request the associated item from. @tsexample // Define the index id %index = \"12\"; // Request the item from the GuiListBoxCtrl object %object = %thisGuiListBoxCtrl.getItemObject(%index); @endtsexample @return The object associated with the item in the list. @see References) +/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. +/// @param index Index id to request the associated item from. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Request the item from the GuiListBoxCtrl object +/// %object = %thisGuiListBoxCtrl.getItemObject(%index); +/// @endtsexample +/// @return The object associated with the item in the list. +/// @see References) +/// /// public string fnGuiListBoxCtrl_getItemObject (string guilistboxctrl, int index) @@ -22768,7 +28486,17 @@ public string fnGuiListBoxCtrl_getItemObject (string guilistboxctrl, int index) } /// -/// @brief Returns the text of the item at the specified index. @param index Index id to return the item text from. @tsexample // Define the index id entry to request the text from %index = \"12\"; // Request the item id text from the GuiListBoxCtrl object. %text = %thisGuiListBoxCtrl.getItemText(%index); @endtsexample @return The text of the requested index id. @see GuiControl) +/// @brief Returns the text of the item at the specified index. +/// @param index Index id to return the item text from. +/// @tsexample +/// // Define the index id entry to request the text from +/// %index = \"12\"; +/// // Request the item id text from the GuiListBoxCtrl object. +/// %text = %thisGuiListBoxCtrl.getItemText(%index); +/// @endtsexample +/// @return The text of the requested index id. +/// @see GuiControl) +/// /// public string fnGuiListBoxCtrl_getItemText (string guilistboxctrl, int index) @@ -22785,7 +28513,14 @@ public string fnGuiListBoxCtrl_getItemText (string guilistboxctrl, int index) } /// -/// @brief Request the item index for the item that was last clicked. @tsexample // Request the item index for the last clicked item in the list %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); @endtsexample @return Index id for the last clicked item in the list. @see GuiControl) +/// @brief Request the item index for the item that was last clicked. +/// @tsexample +/// // Request the item index for the last clicked item in the list +/// %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); +/// @endtsexample +/// @return Index id for the last clicked item in the list. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getLastClickItem (string guilistboxctrl) @@ -22799,7 +28534,14 @@ public int fnGuiListBoxCtrl_getLastClickItem (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getLastClickItem(sbguilistboxctrl); } /// -/// @brief Returns the number of items currently selected. @tsexample // Request the number of currently selected items %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); @endtsexample @return Number of currently selected items. @see GuiControl) +/// @brief Returns the number of items currently selected. +/// @tsexample +/// // Request the number of currently selected items +/// %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); +/// @endtsexample +/// @return Number of currently selected items. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getSelCount (string guilistboxctrl) @@ -22813,7 +28555,14 @@ public int fnGuiListBoxCtrl_getSelCount (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getSelCount(sbguilistboxctrl); } /// -/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. @tsexample // Request the index id of the currently selected item %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); @endtsexample @return The selected items index or -1 if none selected. @see GuiControl) +/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. +/// @tsexample +/// // Request the index id of the currently selected item +/// %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); +/// @endtsexample +/// @return The selected items index or -1 if none selected. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getSelectedItem (string guilistboxctrl) @@ -22827,7 +28576,14 @@ public int fnGuiListBoxCtrl_getSelectedItem (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getSelectedItem(sbguilistboxctrl); } /// -/// @brief Returns a space delimited list of the selected items indexes in the list. @tsexample // Request a space delimited list of the items in the GuiListBoxCtrl object. %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); @endtsexample @return Space delimited list of the selected items indexes in the list @see GuiControl) +/// @brief Returns a space delimited list of the selected items indexes in the list. +/// @tsexample +/// // Request a space delimited list of the items in the GuiListBoxCtrl object. +/// %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); +/// @endtsexample +/// @return Space delimited list of the selected items indexes in the list +/// @see GuiControl) +/// /// public string fnGuiListBoxCtrl_getSelectedItems (string guilistboxctrl) @@ -22844,7 +28600,20 @@ public string fnGuiListBoxCtrl_getSelectedItems (string guilistboxctrl) } /// -/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. @param text Text item to add. @param index Index id to insert the list item text at. @tsexample // Define the text to insert %text = \"Secret Agent Gideon\"; // Define the index entry to insert the text at %index = \"14\"; // In form the GuiListBoxCtrl object to insert the text at the defined index. %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); @endtsexample @return If successful will return the index id assigned. If unsuccessful, will return -1. @see GuiControl) +/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. +/// @param text Text item to add. +/// @param index Index id to insert the list item text at. +/// @tsexample +/// // Define the text to insert +/// %text = \"Secret Agent Gideon\"; +/// // Define the index entry to insert the text at +/// %index = \"14\"; +/// // In form the GuiListBoxCtrl object to insert the text at the defined index. +/// %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); +/// @endtsexample +/// @return If successful will return the index id assigned. If unsuccessful, will return -1. +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_insertItem (string guilistboxctrl, string text, int index) @@ -22861,7 +28630,16 @@ public void fnGuiListBoxCtrl_insertItem (string guilistboxctrl, string text, int SafeNativeMethods.mwle_fnGuiListBoxCtrl_insertItem(sbguilistboxctrl, sbtext, index); } /// -/// @brief Removes an item of the entered name from the filtered items list. @param itemName Name of the item to remove from the filtered list. @tsexample // Define the itemName that you wish to remove. %itemName = \"This Item Name\"; // Remove the itemName from the GuiListBoxCtrl %thisGuiListBoxCtrl.removeFilteredItem(%itemName); @endtsexample @see GuiControl) +/// @brief Removes an item of the entered name from the filtered items list. +/// @param itemName Name of the item to remove from the filtered list. +/// @tsexample +/// // Define the itemName that you wish to remove. +/// %itemName = \"This Item Name\"; +/// // Remove the itemName from the GuiListBoxCtrl +/// %thisGuiListBoxCtrl.removeFilteredItem(%itemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_removeFilteredItem (string guilistboxctrl, string itemName) @@ -22878,7 +28656,16 @@ public void fnGuiListBoxCtrl_removeFilteredItem (string guilistboxctrl, string i SafeNativeMethods.mwle_fnGuiListBoxCtrl_removeFilteredItem(sbguilistboxctrl, sbitemName); } /// -/// @brief Sets the currently selected item at the specified index. @param indexId Index Id to set selected. @tsexample // Define the index id that we wish to select. %selectId = \"4\"; // Inform the GuiListBoxCtrl object to set the requested index as selected. %thisGuiListBoxCtrl.setCurSel(%selectId); @endtsexample @see GuiControl) +/// @brief Sets the currently selected item at the specified index. +/// @param indexId Index Id to set selected. +/// @tsexample +/// // Define the index id that we wish to select. +/// %selectId = \"4\"; +/// // Inform the GuiListBoxCtrl object to set the requested index as selected. +/// %thisGuiListBoxCtrl.setCurSel(%selectId); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setCurSel (string guilistboxctrl, int indexId) @@ -22892,7 +28679,19 @@ public void fnGuiListBoxCtrl_setCurSel (string guilistboxctrl, int indexId) SafeNativeMethods.mwle_fnGuiListBoxCtrl_setCurSel(sbguilistboxctrl, indexId); } /// -/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list @param indexStart Index Id to start selection. @param indexStop Index Id to end selection. @tsexample // Set start id %indexStart = \"3\"; // Set end id %indexEnd = \"6\"; // Request the GuiListBoxCtrl object to select the defined range. %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); @endtsexample @see GuiControl) +/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list +/// @param indexStart Index Id to start selection. +/// @param indexStop Index Id to end selection. +/// @tsexample +/// // Set start id +/// %indexStart = \"3\"; +/// // Set end id +/// %indexEnd = \"6\"; +/// // Request the GuiListBoxCtrl object to select the defined range. +/// %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setCurSelRange (string guilistboxctrl, int indexStart, int indexStop) @@ -22906,7 +28705,19 @@ public void fnGuiListBoxCtrl_setCurSelRange (string guilistboxctrl, int indexSta SafeNativeMethods.mwle_fnGuiListBoxCtrl_setCurSelRange(sbguilistboxctrl, indexStart, indexStop); } /// -/// @brief Sets the color of a single list entry at the specified index id. @param index Index id to modify the color of in the list. @param color Color value to set the list entry to. @tsexample // Define the index id value %index = \"5\"; // Define the color value %color = \"1.0 0.0 0.0\"; // Inform the GuiListBoxCtrl object to change the color of the requested index %thisGuiListBoxCtrl.setItemColor(%index,%color); @endtsexample @see GuiControl) +/// @brief Sets the color of a single list entry at the specified index id. +/// @param index Index id to modify the color of in the list. +/// @param color Color value to set the list entry to. +/// @tsexample +/// // Define the index id value +/// %index = \"5\"; +/// // Define the color value +/// %color = \"1.0 0.0 0.0\"; +/// // Inform the GuiListBoxCtrl object to change the color of the requested index +/// %thisGuiListBoxCtrl.setItemColor(%index,%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setItemColor (string guilistboxctrl, int index, string color) @@ -22923,7 +28734,19 @@ public void fnGuiListBoxCtrl_setItemColor (string guilistboxctrl, int index, str SafeNativeMethods.mwle_fnGuiListBoxCtrl_setItemColor(sbguilistboxctrl, index, sbcolor); } /// -/// @brief Sets the items text at the specified index. @param index Index id to set the item text at. @param newtext Text to change the list item at index id to. @tsexample // Define the index id/n %index = \"12\"; // Define the text to set the list item to %newtext = \"Gideon's Fancy Goggles\"; // Inform the GuiListBoxCtrl object to change the text at the requested index %thisGuiListBoxCtrl.setItemText(%index,%newText); @endtsexample @see GuiControl) +/// @brief Sets the items text at the specified index. +/// @param index Index id to set the item text at. +/// @param newtext Text to change the list item at index id to. +/// @tsexample +/// // Define the index id/n +/// %index = \"12\"; +/// // Define the text to set the list item to +/// %newtext = \"Gideon's Fancy Goggles\"; +/// // Inform the GuiListBoxCtrl object to change the text at the requested index +/// %thisGuiListBoxCtrl.setItemText(%index,%newText); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setItemText (string guilistboxctrl, int index, string newtext) @@ -22940,7 +28763,19 @@ public void fnGuiListBoxCtrl_setItemText (string guilistboxctrl, int index, stri SafeNativeMethods.mwle_fnGuiListBoxCtrl_setItemText(sbguilistboxctrl, index, sbnewtext); } /// -/// @brief Set the tooltip text to display for the given list item. @param index Index id to change the tooltip text @param text Text for the tooltip. @tsexample // Define the index id %index = \"12\"; // Define the tooltip text %tooltip = \"Gideon's goggles can see through space and time.\" // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); @endtsexample @see GuiControl) +/// @brief Set the tooltip text to display for the given list item. +/// @param index Index id to change the tooltip text +/// @param text Text for the tooltip. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Define the tooltip text +/// %tooltip = \"Gideon's goggles can see through space and time.\" +/// // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id +/// %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setItemTooltip (string guilistboxctrl, int index, string text) @@ -22957,7 +28792,16 @@ public void fnGuiListBoxCtrl_setItemTooltip (string guilistboxctrl, int index, s SafeNativeMethods.mwle_fnGuiListBoxCtrl_setItemTooltip(sbguilistboxctrl, index, sbtext); } /// -/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. @param allowMultSelections Boolean variable to set the use of multiple selections or not. @tsexample // Define the multiple selection use state. %allowMultSelections = \"true\"; // Set the allow multiple selection state on the GuiListBoxCtrl object. %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); @endtsexample @see GuiControl) +/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. +/// @param allowMultSelections Boolean variable to set the use of multiple selections or not. +/// @tsexample +/// // Define the multiple selection use state. +/// %allowMultSelections = \"true\"; +/// // Set the allow multiple selection state on the GuiListBoxCtrl object. +/// %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setMultipleSelection (string guilistboxctrl, bool allowMultSelections) @@ -22971,7 +28815,20 @@ public void fnGuiListBoxCtrl_setMultipleSelection (string guilistboxctrl, bool a SafeNativeMethods.mwle_fnGuiListBoxCtrl_setMultipleSelection(sbguilistboxctrl, allowMultSelections); } /// -/// @brief Sets the item at the index specified to selected or not. Detailed description @param index Item index to set selected or unselected. @param setSelected Boolean selection state to set the requested item index. @tsexample // Define the index %index = \"5\"; // Define the selection state %selected = \"true\" // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. %thisGuiListBoxCtrl.setSelected(%index,%selected); @endtsexample @see GuiControl) +/// @brief Sets the item at the index specified to selected or not. +/// Detailed description +/// @param index Item index to set selected or unselected. +/// @param setSelected Boolean selection state to set the requested item index. +/// @tsexample +/// // Define the index +/// %index = \"5\"; +/// // Define the selection state +/// %selected = \"true\" +/// // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. +/// %thisGuiListBoxCtrl.setSelected(%index,%selected); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setSelected (string guilistboxctrl, int index, bool setSelected) @@ -22986,6 +28843,7 @@ public void fnGuiListBoxCtrl_setSelected (string guilistboxctrl, int index, bool } /// /// Deletes the preview model.) +/// /// public void fnGuiMaterialPreview_deleteModel (string guimaterialpreview) @@ -23000,6 +28858,7 @@ public void fnGuiMaterialPreview_deleteModel (string guimaterialpreview) } /// /// Resets the viewport to default zoom, pan, rotate and lighting.) +/// /// public void fnGuiMaterialPreview_reset (string guimaterialpreview) @@ -23014,6 +28873,7 @@ public void fnGuiMaterialPreview_reset (string guimaterialpreview) } /// /// Sets the color of the ambient light in the scene.) +/// /// public void fnGuiMaterialPreview_setAmbientLightColor (string guimaterialpreview, string color) @@ -23031,6 +28891,7 @@ public void fnGuiMaterialPreview_setAmbientLightColor (string guimaterialpreview } /// /// Sets the color of the light in the scene.) +/// /// public void fnGuiMaterialPreview_setLightColor (string guimaterialpreview, string color) @@ -23047,7 +28908,9 @@ public void fnGuiMaterialPreview_setLightColor (string guimaterialpreview, strin SafeNativeMethods.mwle_fnGuiMaterialPreview_setLightColor(sbguimaterialpreview, sbcolor); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display.) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display.) +/// /// public void fnGuiMaterialPreview_setModel (string guimaterialpreview, string shapeName) @@ -23064,7 +28927,10 @@ public void fnGuiMaterialPreview_setModel (string guimaterialpreview, string sha SafeNativeMethods.mwle_fnGuiMaterialPreview_setModel(sbguimaterialpreview, sbshapeName); } /// -/// Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. @param distance The distance to set the orbit to (will be clamped).) +/// Sets the distance at which the camera orbits the object. Clamped to the +/// acceptable range defined in the class by min and max orbit distances. +/// @param distance The distance to set the orbit to (will be clamped).) +/// /// public void fnGuiMaterialPreview_setOrbitDistance (string guimaterialpreview, float distance) @@ -23078,7 +28944,19 @@ public void fnGuiMaterialPreview_setOrbitDistance (string guimaterialpreview, fl SafeNativeMethods.mwle_fnGuiMaterialPreview_setOrbitDistance(sbguimaterialpreview, distance); } /// -/// @brief Adds a new menu to the menu bar. @param menuText Text to display for the new menu item. @param menuId ID for the new menu item. @tsexample // Define the menu text %menuText = \"New Menu\"; // Define the menu ID. %menuId = \"2\"; // Inform the GuiMenuBar control to add the new menu %thisGuiMenuBar.addMenu(%menuText,%menuId); @endtsexample @see GuiTickCtrl) +/// @brief Adds a new menu to the menu bar. +/// @param menuText Text to display for the new menu item. +/// @param menuId ID for the new menu item. +/// @tsexample +/// // Define the menu text +/// %menuText = \"New Menu\"; +/// // Define the menu ID. +/// %menuId = \"2\"; +/// // Inform the GuiMenuBar control to add the new menu +/// %thisGuiMenuBar.addMenu(%menuText,%menuId); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_addMenu (string guimenubar, string menuText, int menuId) @@ -23095,7 +28973,29 @@ public void fnGuiMenuBar_addMenu (string guimenubar, string menuText, int menuId SafeNativeMethods.mwle_fnGuiMenuBar_addMenu(sbguimenubar, sbmenuText, menuId); } /// -/// ,,0,,-1), @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menu Menu name or menu Id to add the new item to. @param menuItemText Text for the new menu item. @param menuItemId Id for the new menu item. @param accelerator Accelerator key for the new menu item. @param checkGroup Check group to include this menu item in. @tsexample // Define the menu we wish to add the item to %targetMenu = \"New Menu\"; or %menu = \"4\"; // Define the text for the new menu item %menuItemText = \"Menu Item\"; // Define the id for the new menu item %menuItemId = \"3\"; // Set the accelerator key to toggle this menu item with %accelerator = \"n\"; // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. %checkGroup = \"4\"; // Inform the GuiMenuBar control to add the new menu item with the defined fields %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); @endtsexample @see GuiTickCtrl) +/// ,,0,,-1), +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menu Menu name or menu Id to add the new item to. +/// @param menuItemText Text for the new menu item. +/// @param menuItemId Id for the new menu item. +/// @param accelerator Accelerator key for the new menu item. +/// @param checkGroup Check group to include this menu item in. +/// @tsexample +/// // Define the menu we wish to add the item to +/// %targetMenu = \"New Menu\"; or %menu = \"4\"; +/// // Define the text for the new menu item +/// %menuItemText = \"Menu Item\"; +/// // Define the id for the new menu item +/// %menuItemId = \"3\"; +/// // Set the accelerator key to toggle this menu item with +/// %accelerator = \"n\"; +/// // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. +/// %checkGroup = \"4\"; +/// // Inform the GuiMenuBar control to add the new menu item with the defined fields +/// %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_addMenuItem (string guimenubar, string targetMenu, string menuItemText, int menuItemId, string accelerator, int checkGroup) @@ -23118,7 +29018,31 @@ public void fnGuiMenuBar_addMenuItem (string guimenubar, string targetMenu, stri SafeNativeMethods.mwle_fnGuiMenuBar_addMenuItem(sbguimenubar, sbtargetMenu, sbmenuItemText, menuItemId, sbaccelerator, checkGroup); } /// -/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for the new submenu @param submenuItemId Id for the new submenu @param accelerator Accelerator key for the new submenu @param checkGroup Which check group the new submenu should be in, or -1 for none. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"New Submenu Item\"; // Define the id for the new submenu %submenuItemId = \"4\"; // Define the accelerator key for the new submenu %accelerator = \"n\"; // Define the checkgroup for the new submenu %checkgroup = \"7\"; // Request the GuiMenuBar control to add the new submenu with the defined information %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); @endtsexample @see GuiTickCtrl) +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for the new submenu +/// @param submenuItemId Id for the new submenu +/// @param accelerator Accelerator key for the new submenu +/// @param checkGroup Which check group the new submenu should be in, or -1 for none. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"New Submenu Item\"; +/// // Define the id for the new submenu +/// %submenuItemId = \"4\"; +/// // Define the accelerator key for the new submenu +/// %accelerator = \"n\"; +/// // Define the checkgroup for the new submenu +/// %checkgroup = \"7\"; +/// // Request the GuiMenuBar control to add the new submenu with the defined information +/// %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_addSubmenuItem (string guimenubar, string menuTarget, string menuItem, string submenuItemText, int submenuItemId, string accelerator, int checkGroup) @@ -23144,7 +29068,16 @@ public void fnGuiMenuBar_addSubmenuItem (string guimenubar, string menuTarget, s SafeNativeMethods.mwle_fnGuiMenuBar_addSubmenuItem(sbguimenubar, sbmenuTarget, sbmenuItem, sbsubmenuItemText, submenuItemId, sbaccelerator, checkGroup); } /// -/// @brief Removes all the menu items from the specified menu. @param menuTarget Menu to remove all items from @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar control to clear all menu items from the defined menu %thisGuiMenuBar.clearMenuItems(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes all the menu items from the specified menu. +/// @param menuTarget Menu to remove all items from +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar control to clear all menu items from the defined menu +/// %thisGuiMenuBar.clearMenuItems(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_clearMenuItems (string guimenubar, string menuTarget) @@ -23161,7 +29094,13 @@ public void fnGuiMenuBar_clearMenuItems (string guimenubar, string menuTarget) SafeNativeMethods.mwle_fnGuiMenuBar_clearMenuItems(sbguimenubar, sbmenuTarget); } /// -/// @brief Clears all the menus from the menu bar. @tsexample // Inform the GuiMenuBar control to clear all menus from itself. %thisGuiMenuBar.clearMenus(); @endtsexample @see GuiTickCtrl) +/// @brief Clears all the menus from the menu bar. +/// @tsexample +/// // Inform the GuiMenuBar control to clear all menus from itself. +/// %thisGuiMenuBar.clearMenus(); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_clearMenus (string guimenubar, int param1, int param2) @@ -23175,7 +29114,19 @@ public void fnGuiMenuBar_clearMenus (string guimenubar, int param1, int param2) SafeNativeMethods.mwle_fnGuiMenuBar_clearMenus(sbguimenubar, param1, param2); } /// -/// @brief Removes all the menu items from the specified submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Inform the GuiMenuBar to remove all submenu items from the defined menu item %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); @endtsexample @see GuiControl) +/// @brief Removes all the menu items from the specified submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Inform the GuiMenuBar to remove all submenu items from the defined menu item +/// %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMenuBar_clearSubmenuItems (string guimenubar, string menuTarget, string menuItem) @@ -23195,7 +29146,16 @@ public void fnGuiMenuBar_clearSubmenuItems (string guimenubar, string menuTarget SafeNativeMethods.mwle_fnGuiMenuBar_clearSubmenuItems(sbguimenubar, sbmenuTarget, sbmenuItem); } /// -/// @brief Removes the specified menu from the menu bar. @param menuTarget Menu to remove from the menu bar @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar to remove the defined menu from the menu bar %thisGuiMenuBar.removeMenu(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu from the menu bar. +/// @param menuTarget Menu to remove from the menu bar +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar to remove the defined menu from the menu bar +/// %thisGuiMenuBar.removeMenu(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_removeMenu (string guimenubar, string menuTarget) @@ -23212,7 +29172,19 @@ public void fnGuiMenuBar_removeMenu (string guimenubar, string menuTarget) SafeNativeMethods.mwle_fnGuiMenuBar_removeMenu(sbguimenubar, sbmenuTarget); } /// -/// @brief Removes the specified menu item from the menu. @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Request the GuiMenuBar control to remove the define menu item %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu item from the menu. +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Request the GuiMenuBar control to remove the define menu item +/// %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_removeMenuItem (string guimenubar, string menuTarget, string menuItemTarget) @@ -23232,7 +29204,16 @@ public void fnGuiMenuBar_removeMenuItem (string guimenubar, string menuTarget, s SafeNativeMethods.mwle_fnGuiMenuBar_removeMenuItem(sbguimenubar, sbmenuTarget, sbmenuItemTarget); } /// -/// @brief Sets the menu bitmap index for the check mark image. @param bitmapIndex Bitmap index for the check mark image. @tsexample // Define the bitmap index %bitmapIndex = \"2\"; // Inform the GuiMenuBar control of the proper bitmap index for the check mark image %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu bitmap index for the check mark image. +/// @param bitmapIndex Bitmap index for the check mark image. +/// @tsexample +/// // Define the bitmap index +/// %bitmapIndex = \"2\"; +/// // Inform the GuiMenuBar control of the proper bitmap index for the check mark image +/// %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setCheckmarkBitmapIndex (string guimenubar, int bitmapindex) @@ -23246,7 +29227,25 @@ public void fnGuiMenuBar_setCheckmarkBitmapIndex (string guimenubar, int bitmapi SafeNativeMethods.mwle_fnGuiMenuBar_setCheckmarkBitmapIndex(sbguimenubar, bitmapindex); } /// -/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. @param menuTarget Menu to affect @param bitmapindex Bitmap index to set for the menu @param bitmaponly If true, only the bitmap will be rendered @param drawborder If true, a border will be drawn around the menu. @tsexample // Define the menuTarget to affect %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Set the bitmap index %bitmapIndex = \"5\"; // Set if we are only to render the bitmap or not %bitmaponly = \"true\"; // Set if we are rendering a border or not %drawborder = \"true\"; // Inform the GuiMenuBar of the bitmap and rendering changes %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); @endtsexample @see GuiTickCtrl) +/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. +/// @param menuTarget Menu to affect +/// @param bitmapindex Bitmap index to set for the menu +/// @param bitmaponly If true, only the bitmap will be rendered +/// @param drawborder If true, a border will be drawn around the menu. +/// @tsexample +/// // Define the menuTarget to affect +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Set the bitmap index +/// %bitmapIndex = \"5\"; +/// // Set if we are only to render the bitmap or not +/// %bitmaponly = \"true\"; +/// // Set if we are rendering a border or not +/// %drawborder = \"true\"; +/// // Inform the GuiMenuBar of the bitmap and rendering changes +/// %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuBitmapIndex (string guimenubar, string menuTarget, int bitmapindex, bool bitmaponly, bool drawborder) @@ -23263,7 +29262,22 @@ public void fnGuiMenuBar_setMenuBitmapIndex (string guimenubar, string menuTarge SafeNativeMethods.mwle_fnGuiMenuBar_setMenuBitmapIndex(sbguimenubar, sbmenuTarget, bitmapindex, bitmaponly, drawborder); } /// -/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. @param menuTarget Menu to affect the menuItem in @param menuItem Menu item to affect @param bitmapIndex Bitmap index to set the menu item to @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem\" %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the bitmapIndex %bitmapIndex = \"6\"; // Inform the GuiMenuBar control to set the menu item to the defined bitmap %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. +/// @param menuTarget Menu to affect the menuItem in +/// @param menuItem Menu item to affect +/// @param bitmapIndex Bitmap index to set the menu item to +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem\" +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the bitmapIndex +/// %bitmapIndex = \"6\"; +/// // Inform the GuiMenuBar control to set the menu item to the defined bitmap +/// %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemBitmap (string guimenubar, string menuTarget, string menuItemTarget, int bitmapIndex) @@ -23283,7 +29297,18 @@ public void fnGuiMenuBar_setMenuItemBitmap (string guimenubar, string menuTarget SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemBitmap(sbguimenubar, sbmenuTarget, sbmenuItemTarget, bitmapIndex); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to work in @param menuItem Menu item to affect @param checked Whether we are setting it to checked or not @tsexample @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in +/// the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to work in +/// @param menuItem Menu item to affect +/// @param checked Whether we are setting it to checked or not +/// @tsexample +/// +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void fnGuiMenuBar_setMenuItemChecked (string guimenubar, string menuTarget, string menuItemTarget, bool checkedx) @@ -23303,7 +29328,24 @@ public void fnGuiMenuBar_setMenuItemChecked (string guimenubar, string menuTarge SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemChecked(sbguimenubar, sbmenuTarget, sbmenuItemTarget, checkedx); } /// -/// @brief sets the menu item to enabled or disabled based on the enable parameter. The specified menu and menu item can either be text or ids. Detailed description @param menuTarget Menu to work in @param menuItemTarget The menu item inside of the menu to enable or disable @param enabled Boolean enable / disable value. @tsexample // Define the menu %menu = \"New Menu\"; or %menu = \"4\"; // Define the menu item %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the enabled state %enabled = \"true\"; // Inform the GuiMenuBar control to set the enabled state of the requested menu item %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); @endtsexample @see GuiTickCtrl) +/// @brief sets the menu item to enabled or disabled based on the enable parameter. +/// The specified menu and menu item can either be text or ids. +/// Detailed description +/// @param menuTarget Menu to work in +/// @param menuItemTarget The menu item inside of the menu to enable or disable +/// @param enabled Boolean enable / disable value. +/// @tsexample +/// // Define the menu +/// %menu = \"New Menu\"; or %menu = \"4\"; +/// // Define the menu item +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the enabled state +/// %enabled = \"true\"; +/// // Inform the GuiMenuBar control to set the enabled state of the requested menu item +/// %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemEnable (string guimenubar, string menuTarget, string menuItemTarget, bool enabled) @@ -23323,7 +29365,22 @@ public void fnGuiMenuBar_setMenuItemEnable (string guimenubar, string menuTarget SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemEnable(sbguimenubar, sbmenuTarget, sbmenuItemTarget, enabled); } /// -/// @brief Sets the given menu item to be a submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param isSubmenu Whether or not the menuItem will become a subMenu or not @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define whether or not the Menu Item is a sub menu or not %isSubmenu = \"true\"; // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); @endtsexample @see GuiTickCtrl) +/// @brief Sets the given menu item to be a submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param isSubmenu Whether or not the menuItem will become a subMenu or not +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define whether or not the Menu Item is a sub menu or not +/// %isSubmenu = \"true\"; +/// // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. +/// %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemSubmenuState (string guimenubar, string menuTarget, string menuItem, bool isSubmenu) @@ -23343,7 +29400,22 @@ public void fnGuiMenuBar_setMenuItemSubmenuState (string guimenubar, string menu SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemSubmenuState(sbguimenubar, sbmenuTarget, sbmenuItem, isSubmenu); } /// -/// @brief Sets the text of the specified menu item to the new string. @param menuTarget Menu to affect @param menuItem Menu item in the menu to change the text at @param newMenuItemText New menu text @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the new text for the menu item %newMenuItemText = \"Very New Menu Item\"; // Inform the GuiMenuBar control to change the defined menu item with the new text %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu item to the new string. +/// @param menuTarget Menu to affect +/// @param menuItem Menu item in the menu to change the text at +/// @param newMenuItemText New menu text +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the new text for the menu item +/// %newMenuItemText = \"Very New Menu Item\"; +/// // Inform the GuiMenuBar control to change the defined menu item with the new text +/// %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemText (string guimenubar, string menuTarget, string menuItemTarget, string newMenuItemText) @@ -23366,7 +29438,23 @@ public void fnGuiMenuBar_setMenuItemText (string guimenubar, string menuTarget, SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemText(sbguimenubar, sbmenuTarget, sbmenuItemTarget, sbnewMenuItemText); } /// -/// @brief Brief Description. Detailed description @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @param isVisible Visible state to set the menu item to. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the visibility state %isVisible = \"true\"; // Inform the GuiMenuBarControl of the visibility state of the defined menu item %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); @endtsexample @see GuiTickCtrl) +/// @brief Brief Description. +/// Detailed description +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @param isVisible Visible state to set the menu item to. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the visibility state +/// %isVisible = \"true\"; +/// // Inform the GuiMenuBarControl of the visibility state of the defined menu item +/// %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemVisible (string guimenubar, string menuTarget, string menuItemTarget, bool isVisible) @@ -23386,7 +29474,23 @@ public void fnGuiMenuBar_setMenuItemVisible (string guimenubar, string menuTarge SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemVisible(sbguimenubar, sbmenuTarget, sbmenuItemTarget, isVisible); } /// -/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. Detailed description @param horizontalMargin Number of pixels on the left and right side of a menu's text. @param verticalMargin Number of pixels on the top and bottom of a menu's text. @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. @tsexample // Define the horizontalMargin %horizontalMargin = \"5\"; // Define the verticalMargin %verticalMargin = \"5\"; // Define the bitmapToTextSpacing %bitmapToTextSpacing = \"12\"; // Inform the GuiMenuBar control to set its margins based on the defined values. %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. +/// Detailed description +/// @param horizontalMargin Number of pixels on the left and right side of a menu's text. +/// @param verticalMargin Number of pixels on the top and bottom of a menu's text. +/// @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. +/// @tsexample +/// // Define the horizontalMargin +/// %horizontalMargin = \"5\"; +/// // Define the verticalMargin +/// %verticalMargin = \"5\"; +/// // Define the bitmapToTextSpacing +/// %bitmapToTextSpacing = \"12\"; +/// // Inform the GuiMenuBar control to set its margins based on the defined values. +/// %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuMargins (string guimenubar, int horizontalMargin, int verticalMargin, int bitmapToTextSpacing) @@ -23400,7 +29504,19 @@ public void fnGuiMenuBar_setMenuMargins (string guimenubar, int horizontalMargin SafeNativeMethods.mwle_fnGuiMenuBar_setMenuMargins(sbguimenubar, horizontalMargin, verticalMargin, bitmapToTextSpacing); } /// -/// @brief Sets the text of the specified menu to the new string. @param menuTarget Menu to affect @param newMenuText New menu text @tsexample // Define the menu to affect %menu = \"New Menu\"; or %menu = \"3\"; // Define the text to change the menu to %newMenuText = \"Still a New Menu\"; // Inform the GuiMenuBar control to change the defined menu to the defined text %thisGuiMenuBar.setMenuText(%menu,%newMenuText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu to the new string. +/// @param menuTarget Menu to affect +/// @param newMenuText New menu text +/// @tsexample +/// // Define the menu to affect +/// %menu = \"New Menu\"; or %menu = \"3\"; +/// // Define the text to change the menu to +/// %newMenuText = \"Still a New Menu\"; +/// // Inform the GuiMenuBar control to change the defined menu to the defined text +/// %thisGuiMenuBar.setMenuText(%menu,%newMenuText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuText (string guimenubar, string menuTarget, string newMenuText) @@ -23420,7 +29536,19 @@ public void fnGuiMenuBar_setMenuText (string guimenubar, string menuTarget, stri SafeNativeMethods.mwle_fnGuiMenuBar_setMenuText(sbguimenubar, sbmenuTarget, sbnewMenuText); } /// -/// @brief Sets the whether or not to display the specified menu. @param menuTarget Menu item to affect @param visible Whether the menu item will be visible or not @tsexample // Define the menu to work with %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define if the menu should be visible or not %visible = \"true\"; // Inform the GuiMenuBar control of the new visibility state for the defined menu %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); @endtsexample @see GuiTickCtrl) +/// @brief Sets the whether or not to display the specified menu. +/// @param menuTarget Menu item to affect +/// @param visible Whether the menu item will be visible or not +/// @tsexample +/// // Define the menu to work with +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define if the menu should be visible or not +/// %visible = \"true\"; +/// // Inform the GuiMenuBar control of the new visibility state for the defined menu +/// %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuVisible (string guimenubar, string menuTarget, bool visible) @@ -23437,7 +29565,28 @@ public void fnGuiMenuBar_setMenuVisible (string guimenubar, string menuTarget, b SafeNativeMethods.mwle_fnGuiMenuBar_setMenuVisible(sbguimenubar, sbmenuTarget, visible); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for submenu @param checked Whether or not this submenu item will be checked. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"Submenu Item\"; // Define if this submenu item should be checked or not %checked = \"true\"; // Inform the GuiMenuBar control to set the checked state of the defined submenu item %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the +/// bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for submenu +/// @param checked Whether or not this submenu item will be checked. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"Submenu Item\"; +/// // Define if this submenu item should be checked or not +/// %checked = \"true\"; +/// // Inform the GuiMenuBar control to set the checked state of the defined submenu item +/// %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void fnGuiMenuBar_setSubmenuItemChecked (string guimenubar, string menuTarget, string menuItemTarget, string submenuItemText, bool checkedx) @@ -23460,7 +29609,20 @@ public void fnGuiMenuBar_setSubmenuItemChecked (string guimenubar, string menuTa SafeNativeMethods.mwle_fnGuiMenuBar_setSubmenuItemChecked(sbguimenubar, sbmenuTarget, sbmenuItemTarget, sbsubmenuItemText, checkedx); } /// -/// @brief Push a line onto the back of the list. @param item The GUI element being pushed into the control @tsexample // All messages are stored in this HudMessageVector, the actual // MainChatHud only displays the contents of this vector. new MessageVector(HudMessageVector); // Attach the MessageVector to the chat control chatHud.attach(HudMessageVector); @endtsexample @return Value) +/// @brief Push a line onto the back of the list. +/// +/// @param item The GUI element being pushed into the control +/// +/// @tsexample +/// // All messages are stored in this HudMessageVector, the actual +/// // MainChatHud only displays the contents of this vector. +/// new MessageVector(HudMessageVector); +/// // Attach the MessageVector to the chat control +/// chatHud.attach(HudMessageVector); +/// @endtsexample +/// +/// @return Value) +/// /// public bool fnGuiMessageVectorCtrl_attach (string guimessagevectorctrl, string item) @@ -23477,7 +29639,18 @@ public bool fnGuiMessageVectorCtrl_attach (string guimessagevectorctrl, string i return SafeNativeMethods.mwle_fnGuiMessageVectorCtrl_attach(sbguimessagevectorctrl, sbitem)>=1; } /// -/// @brief Stop listing messages from the MessageVector previously attached to, if any. Detailed description @param param Description @tsexample // Deatch the MessageVector from HudMessageVector // HudMessageVector will no longer render the text chatHud.detach(); @endtsexample) +/// @brief Stop listing messages from the MessageVector previously attached to, if any. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Deatch the MessageVector from HudMessageVector +/// // HudMessageVector will no longer render the text +/// chatHud.detach(); +/// @endtsexample) +/// /// public void fnGuiMessageVectorCtrl_detach (string guimessagevectorctrl) @@ -23492,6 +29665,7 @@ public void fnGuiMessageVectorCtrl_detach (string guimessagevectorctrl) } /// /// @brief Set the MissionArea to edit.) +/// /// public void fnGuiMissionAreaCtrl_setMissionArea (string guimissionareactrl, string area) @@ -23509,6 +29683,7 @@ public void fnGuiMissionAreaCtrl_setMissionArea (string guimissionareactrl, stri } /// /// @brief Update the terrain bitmap.) +/// /// public void fnGuiMissionAreaCtrl_updateTerrain (string guimissionareactrl) @@ -23522,7 +29697,19 @@ public void fnGuiMissionAreaCtrl_updateTerrain (string guimissionareactrl) SafeNativeMethods.mwle_fnGuiMissionAreaCtrl_updateTerrain(sbguimissionareactrl); } /// -/// @brief Appends the text in the control with additional text. Also . @param text New text to append to the existing text. @param reformat If true, the control will also be visually reset (defaults to true). @tsexample // Define new text to add %text = \"New Text to Add\"; // Set reformat boolean %reformat = \"true\"; // Inform the control to add the new text %thisGuiMLTextCtrl.addText(%text,%reformat); @endtsexample @see GuiControl) +/// @brief Appends the text in the control with additional text. Also . +/// @param text New text to append to the existing text. +/// @param reformat If true, the control will also be visually reset (defaults to true). +/// @tsexample +/// // Define new text to add +/// %text = \"New Text to Add\"; +/// // Set reformat boolean +/// %reformat = \"true\"; +/// // Inform the control to add the new text +/// %thisGuiMLTextCtrl.addText(%text,%reformat); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_addText (string guimltextctrl, string text, bool reformat) @@ -23539,7 +29726,17 @@ public void fnGuiMLTextCtrl_addText (string guimltextctrl, string text, bool ref SafeNativeMethods.mwle_fnGuiMLTextCtrl_addText(sbguimltextctrl, sbtext, reformat); } /// -/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. @tsexample // Define new text to add %newText = \"BACON!\"; // Add the new text to the control %thisGuiMLTextCtrl.addText(%newText); // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. %thisGuiMLTextCtrl.forceReflow(); @endtsexample @see GuiControl) +/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. +/// @tsexample +/// // Define new text to add +/// %newText = \"BACON!\"; +/// // Add the new text to the control +/// %thisGuiMLTextCtrl.addText(%newText); +/// // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. +/// %thisGuiMLTextCtrl.forceReflow(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_forceReflow (string guimltextctrl) @@ -23553,7 +29750,14 @@ public void fnGuiMLTextCtrl_forceReflow (string guimltextctrl) SafeNativeMethods.mwle_fnGuiMLTextCtrl_forceReflow(sbguimltextctrl); } /// -/// @brief Returns the text from the control, including TorqueML characters. @tsexample // Get the text displayed in the control %controlText = %thisGuiMLTextCtrl.getText(); @endtsexample @return Text string displayed in the control, including any TorqueML characters. @see GuiControl) +/// @brief Returns the text from the control, including TorqueML characters. +/// @tsexample +/// // Get the text displayed in the control +/// %controlText = %thisGuiMLTextCtrl.getText(); +/// @endtsexample +/// @return Text string displayed in the control, including any TorqueML characters. +/// @see GuiControl) +/// /// public string fnGuiMLTextCtrl_getText (string guimltextctrl) @@ -23570,7 +29774,13 @@ public string fnGuiMLTextCtrl_getText (string guimltextctrl) } /// -/// @brief Scroll to the bottom of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its bottom %thisGuiMLTextCtrl.scrollToBottom(); @endtsexample @see GuiControl) +/// @brief Scroll to the bottom of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its bottom +/// %thisGuiMLTextCtrl.scrollToBottom(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_scrollToBottom (string guimltextctrl) @@ -23584,7 +29794,17 @@ public void fnGuiMLTextCtrl_scrollToBottom (string guimltextctrl) SafeNativeMethods.mwle_fnGuiMLTextCtrl_scrollToBottom(sbguimltextctrl); } /// -/// @brief Scroll down to a specified tag. Detailed description @param tagID TagID to scroll the control to @tsexample // Define the TagID we want to scroll the control to %tagId = \"4\"; // Inform the GuiMLTextCtrl to scroll to the defined TagID %thisGuiMLTextCtrl.scrollToTag(%tagId); @endtsexample @see GuiControl) +/// @brief Scroll down to a specified tag. +/// Detailed description +/// @param tagID TagID to scroll the control to +/// @tsexample +/// // Define the TagID we want to scroll the control to +/// %tagId = \"4\"; +/// // Inform the GuiMLTextCtrl to scroll to the defined TagID +/// %thisGuiMLTextCtrl.scrollToTag(%tagId); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_scrollToTag (string guimltextctrl, int tagID) @@ -23598,7 +29818,13 @@ public void fnGuiMLTextCtrl_scrollToTag (string guimltextctrl, int tagID) SafeNativeMethods.mwle_fnGuiMLTextCtrl_scrollToTag(sbguimltextctrl, tagID); } /// -/// @brief Scroll to the top of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its top %thisGuiMLTextCtrl.scrollToTop(); @endtsexample @see GuiControl) +/// @brief Scroll to the top of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its top +/// %thisGuiMLTextCtrl.scrollToTop(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_scrollToTop (string guimltextctrl, int param1, int param2) @@ -23612,7 +29838,16 @@ public void fnGuiMLTextCtrl_scrollToTop (string guimltextctrl, int param1, int p SafeNativeMethods.mwle_fnGuiMLTextCtrl_scrollToTop(sbguimltextctrl, param1, param2); } /// -/// @brief Sets the alpha value of the control. @param alphaVal n - 1.0 floating value for the alpha @tsexample // Define the alphe value %alphaVal = \"0.5\"; // Inform the control to update its alpha value. %thisGuiMLTextCtrl.setAlpha(%alphaVal); @endtsexample @see GuiControl) +/// @brief Sets the alpha value of the control. +/// @param alphaVal n - 1.0 floating value for the alpha +/// @tsexample +/// // Define the alphe value +/// %alphaVal = \"0.5\"; +/// // Inform the control to update its alpha value. +/// %thisGuiMLTextCtrl.setAlpha(%alphaVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_setAlpha (string guimltextctrl, float alphaVal) @@ -23626,7 +29861,17 @@ public void fnGuiMLTextCtrl_setAlpha (string guimltextctrl, float alphaVal) SafeNativeMethods.mwle_fnGuiMLTextCtrl_setAlpha(sbguimltextctrl, alphaVal); } /// -/// @brief Change the text cursor's position to a new defined offset within the text in the control. @param newPos Offset to place cursor. @tsexample // Define cursor offset position %position = \"23\"; // Inform the GuiMLTextCtrl object to move the cursor to the new position. %thisGuiMLTextCtrl.setCursorPosition(%position); @endtsexample @return Returns true if the cursor position moved, or false if the position was not changed. @see GuiControl) +/// @brief Change the text cursor's position to a new defined offset within the text in the control. +/// @param newPos Offset to place cursor. +/// @tsexample +/// // Define cursor offset position +/// %position = \"23\"; +/// // Inform the GuiMLTextCtrl object to move the cursor to the new position. +/// %thisGuiMLTextCtrl.setCursorPosition(%position); +/// @endtsexample +/// @return Returns true if the cursor position moved, or false if the position was not changed. +/// @see GuiControl) +/// /// public bool fnGuiMLTextCtrl_setCursorPosition (string guimltextctrl, int newPos) @@ -23640,7 +29885,16 @@ public bool fnGuiMLTextCtrl_setCursorPosition (string guimltextctrl, int newPos) return SafeNativeMethods.mwle_fnGuiMLTextCtrl_setCursorPosition(sbguimltextctrl, newPos)>=1; } /// -/// @brief Set the text contained in the control. @param text The text to display in the control. @tsexample // Define the text to display %text = \"Nifty Control Text\"; // Set the text displayed within the control %thisGuiMLTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Set the text contained in the control. +/// @param text The text to display in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Nifty Control Text\"; +/// // Set the text displayed within the control +/// %thisGuiMLTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_setText (string guimltextctrl, string text) @@ -23777,7 +30031,14 @@ public void fnGuiNavEditorCtrl_spawnPlayer (string guinaveditorctrl) SafeNativeMethods.mwle_fnGuiNavEditorCtrl_spawnPlayer(sbguinaveditorctrl); } /// -/// @brief Return the current multiplier for camera zooming and rotation. @tsexample // Request the current camera zooming and rotation multiplier value %multiplier = %thisGuiObjectView.getCameraSpeed(); @endtsexample @return Camera zooming / rotation multiplier value. @see GuiControl) +/// @brief Return the current multiplier for camera zooming and rotation. +/// @tsexample +/// // Request the current camera zooming and rotation multiplier value +/// %multiplier = %thisGuiObjectView.getCameraSpeed(); +/// @endtsexample +/// @return Camera zooming / rotation multiplier value. +/// @see GuiControl) +/// /// public float fnGuiObjectView_getCameraSpeed (string guiobjectview) @@ -23791,7 +30052,14 @@ public float fnGuiObjectView_getCameraSpeed (string guiobjectview) return SafeNativeMethods.mwle_fnGuiObjectView_getCameraSpeed(sbguiobjectview); } /// -/// @brief Return the model displayed in this view. @tsexample // Request the displayed model name from the GuiObjectView object. %modelName = %thisGuiObjectView.getModel(); @endtsexample @return Name of the displayed model. @see GuiControl) +/// @brief Return the model displayed in this view. +/// @tsexample +/// // Request the displayed model name from the GuiObjectView object. +/// %modelName = %thisGuiObjectView.getModel(); +/// @endtsexample +/// @return Name of the displayed model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getModel (string guiobjectview) @@ -23808,7 +30076,14 @@ public string fnGuiObjectView_getModel (string guiobjectview) } /// -/// @brief Return the name of the mounted model. @tsexample // Request the name of the mounted model from the GuiObjectView object %mountedModelName = %thisGuiObjectView.getMountedModel(); @endtsexample @return Name of the mounted model. @see GuiControl) +/// @brief Return the name of the mounted model. +/// @tsexample +/// // Request the name of the mounted model from the GuiObjectView object +/// %mountedModelName = %thisGuiObjectView.getMountedModel(); +/// @endtsexample +/// @return Name of the mounted model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getMountedModel (string guiobjectview) @@ -23825,7 +30100,14 @@ public string fnGuiObjectView_getMountedModel (string guiobjectview) } /// -/// @brief Return the name of skin used on the mounted model. @tsexample // Request the skin name from the model mounted on to the main model in the control %mountModelSkin = %thisGuiObjectView.getMountSkin(); @endtsexample @return Name of the skin used on the mounted model. @see GuiControl) +/// @brief Return the name of skin used on the mounted model. +/// @tsexample +/// // Request the skin name from the model mounted on to the main model in the control +/// %mountModelSkin = %thisGuiObjectView.getMountSkin(); +/// @endtsexample +/// @return Name of the skin used on the mounted model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getMountSkin (string guiobjectview, int param1, int param2) @@ -23842,7 +30124,14 @@ public string fnGuiObjectView_getMountSkin (string guiobjectview, int param1, in } /// -/// @brief Return the current distance at which the camera orbits the object. @tsexample // Request the current orbit distance %orbitDistance = %thisGuiObjectView.getOrbitDistance(); @endtsexample @return The distance at which the camera orbits the object. @see GuiControl) +/// @brief Return the current distance at which the camera orbits the object. +/// @tsexample +/// // Request the current orbit distance +/// %orbitDistance = %thisGuiObjectView.getOrbitDistance(); +/// @endtsexample +/// @return The distance at which the camera orbits the object. +/// @see GuiControl) +/// /// public float fnGuiObjectView_getOrbitDistance (string guiobjectview) @@ -23856,7 +30145,14 @@ public float fnGuiObjectView_getOrbitDistance (string guiobjectview) return SafeNativeMethods.mwle_fnGuiObjectView_getOrbitDistance(sbguiobjectview); } /// -/// @brief Return the name of skin used on the primary model. @tsexample // Request the name of the skin used on the primary model in the control %skinName = %thisGuiObjectView.getSkin(); @endtsexample @return Name of the skin used on the primary model. @see GuiControl) +/// @brief Return the name of skin used on the primary model. +/// @tsexample +/// // Request the name of the skin used on the primary model in the control +/// %skinName = %thisGuiObjectView.getSkin(); +/// @endtsexample +/// @return Name of the skin used on the primary model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getSkin (string guiobjectview) @@ -23873,7 +30169,16 @@ public string fnGuiObjectView_getSkin (string guiobjectview) } /// -/// @brief Sets the multiplier for the camera rotation and zoom speed. @param factor Multiplier for camera rotation and zoom speed. @tsexample // Set the factor value %factor = \"0.75\"; // Inform the GuiObjectView object to set the camera speed. %thisGuiObjectView.setCameraSpeed(%factor); @endtsexample @see GuiControl) +/// @brief Sets the multiplier for the camera rotation and zoom speed. +/// @param factor Multiplier for camera rotation and zoom speed. +/// @tsexample +/// // Set the factor value +/// %factor = \"0.75\"; +/// // Inform the GuiObjectView object to set the camera speed. +/// %thisGuiObjectView.setCameraSpeed(%factor); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setCameraSpeed (string guiobjectview, float factor) @@ -23887,7 +30192,16 @@ public void fnGuiObjectView_setCameraSpeed (string guiobjectview, float factor) SafeNativeMethods.mwle_fnGuiObjectView_setCameraSpeed(sbguiobjectview, factor); } /// -/// @brief Set the light ambient color on the sun object used to render the model. @param color Ambient color of sunlight. @tsexample // Define the sun ambient color value %color = \"1.0 0.4 0.6\"; // Inform the GuiObjectView object to set the sun ambient color to the requested value %thisGuiObjectView.setLightAmbient(%color); @endtsexample @see GuiControl) +/// @brief Set the light ambient color on the sun object used to render the model. +/// @param color Ambient color of sunlight. +/// @tsexample +/// // Define the sun ambient color value +/// %color = \"1.0 0.4 0.6\"; +/// // Inform the GuiObjectView object to set the sun ambient color to the requested value +/// %thisGuiObjectView.setLightAmbient(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setLightAmbient (string guiobjectview, string color) @@ -23904,7 +30218,16 @@ public void fnGuiObjectView_setLightAmbient (string guiobjectview, string color) SafeNativeMethods.mwle_fnGuiObjectView_setLightAmbient(sbguiobjectview, sbcolor); } /// -/// @brief Set the light color on the sun object used to render the model. @param color Color of sunlight. @tsexample // Set the color value for the sun %color = \"1.0 0.4 0.5\"; // Inform the GuiObjectView object to change the sun color to the defined value %thisGuiObjectView.setLightColor(%color); @endtsexample @see GuiControl) +/// @brief Set the light color on the sun object used to render the model. +/// @param color Color of sunlight. +/// @tsexample +/// // Set the color value for the sun +/// %color = \"1.0 0.4 0.5\"; +/// // Inform the GuiObjectView object to change the sun color to the defined value +/// %thisGuiObjectView.setLightColor(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setLightColor (string guiobjectview, string color) @@ -23921,7 +30244,16 @@ public void fnGuiObjectView_setLightColor (string guiobjectview, string color) SafeNativeMethods.mwle_fnGuiObjectView_setLightColor(sbguiobjectview, sbcolor); } /// -/// @brief Set the light direction from which to light the model. @param direction XYZ direction from which the light will shine on the model @tsexample // Set the light direction %direction = \"1.0 0.2 0.4\" // Inform the GuiObjectView object to change the light direction to the defined value %thisGuiObjectView.setLightDirection(%direction); @endtsexample @see GuiControl) +/// @brief Set the light direction from which to light the model. +/// @param direction XYZ direction from which the light will shine on the model +/// @tsexample +/// // Set the light direction +/// %direction = \"1.0 0.2 0.4\" +/// // Inform the GuiObjectView object to change the light direction to the defined value +/// %thisGuiObjectView.setLightDirection(%direction); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setLightDirection (string guiobjectview, string direction) @@ -23938,7 +30270,16 @@ public void fnGuiObjectView_setLightDirection (string guiobjectview, string dire SafeNativeMethods.mwle_fnGuiObjectView_setLightDirection(sbguiobjectview, sbdirection); } /// -/// @brief Sets the model to be displayed in this control. @param shapeName Name of the model to display. @tsexample // Define the model we want to display %shapeName = \"gideon.dts\"; // Tell the GuiObjectView object to display the defined model %thisGuiObjectView.setModel(%shapeName); @endtsexample @see GuiControl) +/// @brief Sets the model to be displayed in this control. +/// @param shapeName Name of the model to display. +/// @tsexample +/// // Define the model we want to display +/// %shapeName = \"gideon.dts\"; +/// // Tell the GuiObjectView object to display the defined model +/// %thisGuiObjectView.setModel(%shapeName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setModel (string guiobjectview, string shapeName) @@ -23955,7 +30296,22 @@ public void fnGuiObjectView_setModel (string guiobjectview, string shapeName) SafeNativeMethods.mwle_fnGuiObjectView_setModel(sbguiobjectview, sbshapeName); } /// -/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. Detailed description @param shapeName Name of the model to mount. @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. @tsexample // Set the shapeName to mount %shapeName = \"GideonGlasses.dts\" // Set the mount node of the primary model in the control to mount the new shape at %mountNodeIndexOrName = \"3\"; //OR: %mountNodeIndexOrName = \"Face\"; // Inform the GuiObjectView object to mount the shape at the specified node. %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); @endtsexample @see GuiControl) +/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. +/// Detailed description +/// @param shapeName Name of the model to mount. +/// @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. +/// @tsexample +/// // Set the shapeName to mount +/// %shapeName = \"GideonGlasses.dts\" +/// // Set the mount node of the primary model in the control to mount the new shape at +/// %mountNodeIndexOrName = \"3\"; +/// //OR: +/// %mountNodeIndexOrName = \"Face\"; +/// // Inform the GuiObjectView object to mount the shape at the specified node. +/// %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setMount (string guiobjectview, string shapeName, string mountNodeIndexOrName) @@ -23975,7 +30331,16 @@ public void fnGuiObjectView_setMount (string guiobjectview, string shapeName, st SafeNativeMethods.mwle_fnGuiObjectView_setMount(sbguiobjectview, sbshapeName, sbmountNodeIndexOrName); } /// -/// @brief Sets the model to be mounted on the primary model. @param shapeName Name of the model to mount. @tsexample // Define the model name to mount %modelToMount = \"GideonGlasses.dts\"; // Inform the GuiObjectView object to mount the defined model to the existing model in the control %thisGuiObjectView.setMountedModel(%modelToMount); @endtsexample @see GuiControl) +/// @brief Sets the model to be mounted on the primary model. +/// @param shapeName Name of the model to mount. +/// @tsexample +/// // Define the model name to mount +/// %modelToMount = \"GideonGlasses.dts\"; +/// // Inform the GuiObjectView object to mount the defined model to the existing model in the control +/// %thisGuiObjectView.setMountedModel(%modelToMount); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setMountedModel (string guiobjectview, string shapeName) @@ -23992,7 +30357,16 @@ public void fnGuiObjectView_setMountedModel (string guiobjectview, string shapeN SafeNativeMethods.mwle_fnGuiObjectView_setMountedModel(sbguiobjectview, sbshapeName); } /// -/// @brief Sets the skin to use on the mounted model. @param skinName Name of the skin to set on the model mounted to the main model in the control @tsexample // Define the name of the skin %skinName = \"BronzeGlasses\"; // Inform the GuiObjectView Control of the skin to use on the mounted model %thisGuiObjectViewCtrl.setMountSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the mounted model. +/// @param skinName Name of the skin to set on the model mounted to the main model in the control +/// @tsexample +/// // Define the name of the skin +/// %skinName = \"BronzeGlasses\"; +/// // Inform the GuiObjectView Control of the skin to use on the mounted model +/// %thisGuiObjectViewCtrl.setMountSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setMountSkin (string guiobjectview, string skinName) @@ -24009,7 +30383,17 @@ public void fnGuiObjectView_setMountSkin (string guiobjectview, string skinName) SafeNativeMethods.mwle_fnGuiObjectView_setMountSkin(sbguiobjectview, sbskinName); } /// -/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. Detailed description @param distance The distance to set the orbit to (will be clamped). @tsexample // Define the orbit distance value %orbitDistance = \"1.5\"; // Inform the GuiObjectView object to set the orbit distance to the defined value %thisGuiObjectView.setOrbitDistance(%orbitDistance); @endtsexample @see GuiControl) +/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. +/// Detailed description +/// @param distance The distance to set the orbit to (will be clamped). +/// @tsexample +/// // Define the orbit distance value +/// %orbitDistance = \"1.5\"; +/// // Inform the GuiObjectView object to set the orbit distance to the defined value +/// %thisGuiObjectView.setOrbitDistance(%orbitDistance); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setOrbitDistance (string guiobjectview, float distance) @@ -24023,7 +30407,18 @@ public void fnGuiObjectView_setOrbitDistance (string guiobjectview, float distan SafeNativeMethods.mwle_fnGuiObjectView_setOrbitDistance(sbguiobjectview, distance); } /// -/// @brief Sets the animation to play for the viewed object. @param indexOrName The index or name of the animation to play. @tsexample // Set the animation index value, or animation sequence name. %indexVal = \"3\"; //OR: %indexVal = \"idle\"; // Inform the GuiObjectView object to set the animation sequence of the object in the control. %thisGuiObjectVew.setSeq(%indexVal); @endtsexample @see GuiControl) +/// @brief Sets the animation to play for the viewed object. +/// @param indexOrName The index or name of the animation to play. +/// @tsexample +/// // Set the animation index value, or animation sequence name. +/// %indexVal = \"3\"; +/// //OR: +/// %indexVal = \"idle\"; +/// // Inform the GuiObjectView object to set the animation sequence of the object in the control. +/// %thisGuiObjectVew.setSeq(%indexVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setSeq (string guiobjectview, string indexOrName) @@ -24040,7 +30435,16 @@ public void fnGuiObjectView_setSeq (string guiobjectview, string indexOrName) SafeNativeMethods.mwle_fnGuiObjectView_setSeq(sbguiobjectview, sbindexOrName); } /// -/// @brief Sets the skin to use on the model being displayed. @param skinName Name of the skin to use. @tsexample // Define the skin we want to apply to the main model in the control %skinName = \"disco_gideon\"; // Inform the GuiObjectView control to update the skin the to defined skin %thisGuiObjectView.setSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the model being displayed. +/// @param skinName Name of the skin to use. +/// @tsexample +/// // Define the skin we want to apply to the main model in the control +/// %skinName = \"disco_gideon\"; +/// // Inform the GuiObjectView control to update the skin the to defined skin +/// %thisGuiObjectView.setSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setSkin (string guiobjectview, string skinName) @@ -24057,7 +30461,9 @@ public void fnGuiObjectView_setSkin (string guiobjectview, string skinName) SafeNativeMethods.mwle_fnGuiObjectView_setSkin(sbguiobjectview, sbskinName); } /// -/// Collapse or un-collapse the control. @param collapse True to collapse the control, false to un-collapse it ) +/// Collapse or un-collapse the control. +/// @param collapse True to collapse the control, false to un-collapse it ) +/// /// public void fnGuiPaneControl_setCollapsed (string guipanecontrol, bool collapse) @@ -24071,7 +30477,12 @@ public void fnGuiPaneControl_setCollapsed (string guipanecontrol, bool collapse) SafeNativeMethods.mwle_fnGuiPaneControl_setCollapsed(sbguipanecontrol, collapse); } /// -/// @brief Add a category to the list. Acts as a separator between entries, allowing for sub-lists @param text Name of the new category) +/// @brief Add a category to the list. +/// +/// Acts as a separator between entries, allowing for sub-lists +/// +/// @param text Name of the new category) +/// /// public void fnGuiPopUpMenuCtrlEx_addCategory (string guipopupmenuctrlex, string text) @@ -24088,7 +30499,12 @@ public void fnGuiPopUpMenuCtrlEx_addCategory (string guipopupmenuctrlex, string SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_addCategory(sbguipopupmenuctrlex, sbtext); } /// -/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. @param id Numerical id associated with this scheme @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. +/// @param id Numerical id associated with this scheme +/// @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// /// public void fnGuiPopUpMenuCtrlEx_addScheme (string guipopupmenuctrlex, int id, string fontColor, string fontColorHL, string fontColorSEL) @@ -24112,6 +30528,7 @@ public void fnGuiPopUpMenuCtrlEx_addScheme (string guipopupmenuctrlex, int id, s } /// /// @brief Clear the popup list.) +/// /// public void fnGuiPopUpMenuCtrlEx_clear (string guipopupmenuctrlex) @@ -24126,6 +30543,7 @@ public void fnGuiPopUpMenuCtrlEx_clear (string guipopupmenuctrlex) } /// /// @brief Manually force this control to collapse and close.) +/// /// public void fnGuiPopUpMenuCtrlEx_forceClose (string guipopupmenuctrlex) @@ -24140,6 +30558,7 @@ public void fnGuiPopUpMenuCtrlEx_forceClose (string guipopupmenuctrlex) } /// /// @brief Manually for the onAction function, which updates everything in this control.) +/// /// public void fnGuiPopUpMenuCtrlEx_forceOnAction (string guipopupmenuctrlex) @@ -24153,7 +30572,9 @@ public void fnGuiPopUpMenuCtrlEx_forceOnAction (string guipopupmenuctrlex) SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_forceOnAction(sbguipopupmenuctrlex); } /// -/// @brief Get the current selection of the menu. @return Returns the ID of the currently selected entry) +/// @brief Get the current selection of the menu. +/// @return Returns the ID of the currently selected entry) +/// /// public int fnGuiPopUpMenuCtrlEx_getSelected (string guipopupmenuctrlex) @@ -24167,7 +30588,19 @@ public int fnGuiPopUpMenuCtrlEx_getSelected (string guipopupmenuctrlex) return SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_getSelected(sbguipopupmenuctrlex); } /// -/// @brief Get the. Detailed description @param param Description @tsexample // Comment code(); @endtsexample @return Returns current text in string format) +/// @brief Get the. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Comment +/// code(); +/// @endtsexample +/// +/// @return Returns current text in string format) +/// /// public string fnGuiPopUpMenuCtrlEx_getText (string guipopupmenuctrlex) @@ -24184,7 +30617,10 @@ public string fnGuiPopUpMenuCtrlEx_getText (string guipopupmenuctrlex) } /// -/// @brief Get the text of an entry based on an ID. @param id The ID assigned to the entry being queried @return String contained by the specified entry, NULL if empty or bad ID) +/// @brief Get the text of an entry based on an ID. +/// @param id The ID assigned to the entry being queried +/// @return String contained by the specified entry, NULL if empty or bad ID) +/// /// public string fnGuiPopUpMenuCtrlEx_getTextById (string guipopupmenuctrlex, int id) @@ -24202,6 +30638,7 @@ public string fnGuiPopUpMenuCtrlEx_getTextById (string guipopupmenuctrlex, int i } /// /// @brief Clears selection in the menu.) +/// /// public void fnGuiPopUpMenuCtrlEx_setNoneSelected (string guipopupmenuctrlex, int param) @@ -24215,7 +30652,9 @@ public void fnGuiPopUpMenuCtrlEx_setNoneSelected (string guipopupmenuctrlex, int SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_setNoneSelected(sbguipopupmenuctrlex, param); } /// -/// @brief Set the current text to a specified value. @param text String containing new text to set) +/// @brief Set the current text to a specified value. +/// @param text String containing new text to set) +/// /// public void fnGuiPopUpMenuCtrlEx_setText (string guipopupmenuctrlex, string text) @@ -24233,6 +30672,7 @@ public void fnGuiPopUpMenuCtrlEx_setText (string guipopupmenuctrlex, string text } /// /// @brief Sort the list alphabetically.) +/// /// public void fnGuiPopUpMenuCtrlEx_sort (string guipopupmenuctrlex) @@ -24247,6 +30687,7 @@ public void fnGuiPopUpMenuCtrlEx_sort (string guipopupmenuctrlex) } /// /// @brief Sort the list by ID.) +/// /// public void fnGuiPopUpMenuCtrlEx_sortID (string guipopupmenuctrlex) @@ -24260,7 +30701,11 @@ public void fnGuiPopUpMenuCtrlEx_sortID (string guipopupmenuctrlex) SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_sortID(sbguipopupmenuctrlex); } /// -/// Set the bitmap to use for rendering the progress bar. @param filename ~Path to the bitmap file. @note Directly assign to #bitmap rather than using this method. @see GuiProgressBitmapCtrl::setBitmap ) +/// Set the bitmap to use for rendering the progress bar. +/// @param filename ~Path to the bitmap file. +/// @note Directly assign to #bitmap rather than using this method. +/// @see GuiProgressBitmapCtrl::setBitmap ) +/// /// public void fnGuiProgressBitmapCtrl_setBitmap (string guiprogressbitmapctrl, string filename) @@ -24277,7 +30722,9 @@ public void fnGuiProgressBitmapCtrl_setBitmap (string guiprogressbitmapctrl, str SafeNativeMethods.mwle_fnGuiProgressBitmapCtrl_setBitmap(sbguiprogressbitmapctrl, sbfilename); } /// -/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. +/// @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// /// public void fnGuiRolloutCtrl_collapse (string guirolloutctrl) @@ -24291,7 +30738,9 @@ public void fnGuiRolloutCtrl_collapse (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_collapse(sbguirolloutctrl); } /// -/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. +/// @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// /// public void fnGuiRolloutCtrl_expand (string guirolloutctrl) @@ -24306,6 +30755,7 @@ public void fnGuiRolloutCtrl_expand (string guirolloutctrl) } /// /// Instantly collapse the rollout without animation. To smoothly slide the rollout to collapsed state, use collapse(). ) +/// /// public void fnGuiRolloutCtrl_instantCollapse (string guirolloutctrl) @@ -24320,6 +30770,7 @@ public void fnGuiRolloutCtrl_instantCollapse (string guirolloutctrl) } /// /// Instantly expand the rollout without animation. To smoothly slide the rollout to expanded state, use expand(). ) +/// /// public void fnGuiRolloutCtrl_instantExpand (string guirolloutctrl) @@ -24333,7 +30784,9 @@ public void fnGuiRolloutCtrl_instantExpand (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_instantExpand(sbguirolloutctrl); } /// -/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. @return True if the rollout is expanded, false if not. ) +/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. +/// @return True if the rollout is expanded, false if not. ) +/// /// public bool fnGuiRolloutCtrl_isExpanded (string guirolloutctrl) @@ -24347,7 +30800,9 @@ public bool fnGuiRolloutCtrl_isExpanded (string guirolloutctrl) return SafeNativeMethods.mwle_fnGuiRolloutCtrl_isExpanded(sbguirolloutctrl)>=1; } /// -/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of the rollout size. ) +/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of +/// the rollout size. ) +/// /// public void fnGuiRolloutCtrl_sizeToContents (string guirolloutctrl) @@ -24361,7 +30816,9 @@ public void fnGuiRolloutCtrl_sizeToContents (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_sizeToContents(sbguirolloutctrl); } /// -/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. ) +/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. ) +/// /// public void fnGuiRolloutCtrl_toggleCollapse (string guirolloutctrl) @@ -24375,7 +30832,11 @@ public void fnGuiRolloutCtrl_toggleCollapse (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_toggleCollapse(sbguirolloutctrl); } /// -/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will smoothly slide into the opposite state. ) +/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. +/// @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will +/// smoothly slide into the opposite state. ) +/// /// public void fnGuiRolloutCtrl_toggleExpanded (string guirolloutctrl, bool instantly) @@ -24390,6 +30851,7 @@ public void fnGuiRolloutCtrl_toggleExpanded (string guirolloutctrl, bool instant } /// /// Refresh sizing and positioning of child controls. ) +/// /// public void fnGuiScrollCtrl_computeSizes (string guiscrollctrl) @@ -24403,7 +30865,9 @@ public void fnGuiScrollCtrl_computeSizes (string guiscrollctrl) SafeNativeMethods.mwle_fnGuiScrollCtrl_computeSizes(sbguiscrollctrl); } /// -/// Get the current coordinates of the scrolled content. @return The current position of the scrolled content. ) +/// Get the current coordinates of the scrolled content. +/// @return The current position of the scrolled content. ) +/// /// public string fnGuiScrollCtrl_getScrollPosition (string guiscrollctrl) @@ -24420,7 +30884,9 @@ public string fnGuiScrollCtrl_getScrollPosition (string guiscrollctrl) } /// -/// Get the current X coordinate of the scrolled content. @return The current X coordinate of the scrolled content. ) +/// Get the current X coordinate of the scrolled content. +/// @return The current X coordinate of the scrolled content. ) +/// /// public int fnGuiScrollCtrl_getScrollPositionX (string guiscrollctrl) @@ -24434,7 +30900,9 @@ public int fnGuiScrollCtrl_getScrollPositionX (string guiscrollctrl) return SafeNativeMethods.mwle_fnGuiScrollCtrl_getScrollPositionX(sbguiscrollctrl); } /// -/// Get the current Y coordinate of the scrolled content. @return The current Y coordinate of the scrolled content. ) +/// Get the current Y coordinate of the scrolled content. +/// @return The current Y coordinate of the scrolled content. ) +/// /// public int fnGuiScrollCtrl_getScrollPositionY (string guiscrollctrl) @@ -24449,6 +30917,7 @@ public int fnGuiScrollCtrl_getScrollPositionY (string guiscrollctrl) } /// /// Scroll all the way to the bottom of the vertical scrollbar and the left of the horizontal bar. ) +/// /// public void fnGuiScrollCtrl_scrollToBottom (string guiscrollctrl) @@ -24462,7 +30931,9 @@ public void fnGuiScrollCtrl_scrollToBottom (string guiscrollctrl) SafeNativeMethods.mwle_fnGuiScrollCtrl_scrollToBottom(sbguiscrollctrl); } /// -/// Scroll the control so that the given child @a control is visible. @param control A child control. ) +/// Scroll the control so that the given child @a control is visible. +/// @param control A child control. ) +/// /// public void fnGuiScrollCtrl_scrollToObject (string guiscrollctrl, string control) @@ -24480,6 +30951,7 @@ public void fnGuiScrollCtrl_scrollToObject (string guiscrollctrl, string control } /// /// Scroll all the way to the top of the vertical and left of the horizontal scrollbar. ) +/// /// public void fnGuiScrollCtrl_scrollToTop (string guiscrollctrl) @@ -24493,7 +30965,10 @@ public void fnGuiScrollCtrl_scrollToTop (string guiscrollctrl) SafeNativeMethods.mwle_fnGuiScrollCtrl_scrollToTop(sbguiscrollctrl); } /// -/// Set the position of the scrolled content. @param x Position on X axis. @param y Position on y axis. ) +/// Set the position of the scrolled content. +/// @param x Position on X axis. +/// @param y Position on y axis. ) +/// /// public void fnGuiScrollCtrl_setScrollPosition (string guiscrollctrl, int x, int y) @@ -24508,6 +30983,7 @@ public void fnGuiScrollCtrl_setScrollPosition (string guiscrollctrl, int x, int } /// /// Add a new thread (initially without any sequence set) ) +/// /// public void fnGuiShapeEdPreview_addThread (string guishapeedpreview) @@ -24521,7 +30997,9 @@ public void fnGuiShapeEdPreview_addThread (string guishapeedpreview) SafeNativeMethods.mwle_fnGuiShapeEdPreview_addThread(sbguishapeedpreview); } /// -/// Compute the bounding box of the shape using the current detail and node transforms @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// Compute the bounding box of the shape using the current detail and node transforms +/// @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// /// public string fnGuiShapeEdPreview_computeShapeBounds (string guishapeedpreview) @@ -24538,7 +31016,11 @@ public string fnGuiShapeEdPreview_computeShapeBounds (string guishapeedpreview) } /// -/// Export the current shape and all mounted objects to COLLADA (.dae). Note that animation is not exported, and all geometry is combined into a single mesh. @param path Destination filename ) +/// Export the current shape and all mounted objects to COLLADA (.dae). +/// Note that animation is not exported, and all geometry is combined into a +/// single mesh. +/// @param path Destination filename ) +/// /// public void fnGuiShapeEdPreview_exportToCollada (string guishapeedpreview, string path) @@ -24556,6 +31038,7 @@ public void fnGuiShapeEdPreview_exportToCollada (string guishapeedpreview, strin } /// /// Adjust the camera position and zoom to fit the shape within the view. ) +/// /// public void fnGuiShapeEdPreview_fitToShape (string guishapeedpreview) @@ -24570,6 +31053,7 @@ public void fnGuiShapeEdPreview_fitToShape (string guishapeedpreview) } /// /// Return whether the named object is currently hidden ) +/// /// public bool fnGuiShapeEdPreview_getMeshHidden (string guishapeedpreview, string name) @@ -24586,7 +31070,10 @@ public bool fnGuiShapeEdPreview_getMeshHidden (string guishapeedpreview, string return SafeNativeMethods.mwle_fnGuiShapeEdPreview_getMeshHidden(sbguishapeedpreview, sbname)>=1; } /// -/// Get the playback direction of the sequence playing on this mounted shape @param slot mounted shape slot @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// Get the playback direction of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// /// public float fnGuiShapeEdPreview_getMountThreadDir (string guishapeedpreview, int slot) @@ -24600,7 +31087,10 @@ public float fnGuiShapeEdPreview_getMountThreadDir (string guishapeedpreview, in return SafeNativeMethods.mwle_fnGuiShapeEdPreview_getMountThreadDir(sbguishapeedpreview, slot); } /// -/// Get the playback position of the sequence playing on this mounted shape @param slot mounted shape slot @return playback position of the sequence (0-1) ) +/// Get the playback position of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return playback position of the sequence (0-1) ) +/// /// public float fnGuiShapeEdPreview_getMountThreadPos (string guishapeedpreview, int slot) @@ -24614,7 +31104,10 @@ public float fnGuiShapeEdPreview_getMountThreadPos (string guishapeedpreview, in return SafeNativeMethods.mwle_fnGuiShapeEdPreview_getMountThreadPos(sbguishapeedpreview, slot); } /// -/// Get the name of the sequence playing on this mounted shape @param slot mounted shape slot @return name of the sequence (if any) ) +/// Get the name of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return name of the sequence (if any) ) +/// /// public string fnGuiShapeEdPreview_getMountThreadSequence (string guishapeedpreview, int slot) @@ -24631,7 +31124,9 @@ public string fnGuiShapeEdPreview_getMountThreadSequence (string guishapeedprevi } /// -/// Get the number of threads @return the number of threads ) +/// Get the number of threads +/// @return the number of threads ) +/// /// public int fnGuiShapeEdPreview_getThreadCount (string guishapeedpreview) @@ -24646,6 +31141,7 @@ public int fnGuiShapeEdPreview_getThreadCount (string guishapeedpreview) } /// /// Get the name of the sequence assigned to the active thread ) +/// /// public string fnGuiShapeEdPreview_getThreadSequence (string guishapeedpreview) @@ -24662,7 +31158,12 @@ public string fnGuiShapeEdPreview_getThreadSequence (string guishapeedpreview) } /// -/// Mount a shape onto the main shape at the specified node @param shapePath path to the shape to mount @param nodeName name of the node on the main shape to mount to @param type type of mounting to use (Object, Image or Wheel) @param slot mount slot ) +/// Mount a shape onto the main shape at the specified node +/// @param shapePath path to the shape to mount +/// @param nodeName name of the node on the main shape to mount to +/// @param type type of mounting to use (Object, Image or Wheel) +/// @param slot mount slot ) +/// /// public bool fnGuiShapeEdPreview_mountShape (string guishapeedpreview, string shapePath, string nodeName, string type, int slot) @@ -24686,6 +31187,7 @@ public bool fnGuiShapeEdPreview_mountShape (string guishapeedpreview, string sha } /// /// Refresh the shape (used when the shape meshes or nodes have been added or removed) ) +/// /// public void fnGuiShapeEdPreview_refreshShape (string guishapeedpreview) @@ -24700,6 +31202,7 @@ public void fnGuiShapeEdPreview_refreshShape (string guishapeedpreview) } /// /// Refreshes thread sequences (in case of removed/renamed sequences ) +/// /// public void fnGuiShapeEdPreview_refreshThreadSequences (string guishapeedpreview) @@ -24713,7 +31216,9 @@ public void fnGuiShapeEdPreview_refreshThreadSequences (string guishapeedpreview SafeNativeMethods.mwle_fnGuiShapeEdPreview_refreshThreadSequences(sbguishapeedpreview); } /// -/// Removes the specifed thread @param slot index of the thread to remove ) +/// Removes the specifed thread +/// @param slot index of the thread to remove ) +/// /// public void fnGuiShapeEdPreview_removeThread (string guishapeedpreview, int slot) @@ -24728,6 +31233,7 @@ public void fnGuiShapeEdPreview_removeThread (string guishapeedpreview, int slot } /// /// Show or hide all objects in the shape ) +/// /// public void fnGuiShapeEdPreview_setAllMeshesHidden (string guishapeedpreview, bool hidden) @@ -24742,6 +31248,7 @@ public void fnGuiShapeEdPreview_setAllMeshesHidden (string guishapeedpreview, bo } /// /// Show or hide the named object in the shape ) +/// /// public void fnGuiShapeEdPreview_setMeshHidden (string guishapeedpreview, string name, bool hidden) @@ -24758,7 +31265,10 @@ public void fnGuiShapeEdPreview_setMeshHidden (string guishapeedpreview, string SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMeshHidden(sbguishapeedpreview, sbname, hidden); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display. @return True if the model was loaded successfully, false otherwise. ) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display. +/// @return True if the model was loaded successfully, false otherwise. ) +/// /// public bool fnGuiShapeEdPreview_setModel (string guishapeedpreview, string shapePath) @@ -24775,7 +31285,10 @@ public bool fnGuiShapeEdPreview_setModel (string guishapeedpreview, string shape return SafeNativeMethods.mwle_fnGuiShapeEdPreview_setModel(sbguishapeedpreview, sbshapePath)>=1; } /// -/// Set the node a shape is mounted to. @param slot mounted shape slot @param nodename name of the node to mount to ) +/// Set the node a shape is mounted to. +/// @param slot mounted shape slot +/// @param nodename name of the node to mount to ) +/// /// public void fnGuiShapeEdPreview_setMountNode (string guishapeedpreview, int slot, string nodeName) @@ -24792,7 +31305,10 @@ public void fnGuiShapeEdPreview_setMountNode (string guishapeedpreview, int slot SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountNode(sbguishapeedpreview, slot, sbnodeName); } /// -/// Set the playback direction of the shape mounted in the specified slot @param slot mounted shape slot @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// Set the playback direction of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// /// public void fnGuiShapeEdPreview_setMountThreadDir (string guishapeedpreview, int slot, float dir) @@ -24806,7 +31322,10 @@ public void fnGuiShapeEdPreview_setMountThreadDir (string guishapeedpreview, int SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountThreadDir(sbguishapeedpreview, slot, dir); } /// -/// Set the sequence position of the shape mounted in the specified slot @param slot mounted shape slot @param pos sequence position (0-1) ) +/// Set the sequence position of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param pos sequence position (0-1) ) +/// /// public void fnGuiShapeEdPreview_setMountThreadPos (string guishapeedpreview, int slot, float pos) @@ -24820,7 +31339,10 @@ public void fnGuiShapeEdPreview_setMountThreadPos (string guishapeedpreview, int SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountThreadPos(sbguishapeedpreview, slot, pos); } /// -/// Set the sequence to play for the shape mounted in the specified slot @param slot mounted shape slot @param name name of the sequence to play ) +/// Set the sequence to play for the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param name name of the sequence to play ) +/// /// public void fnGuiShapeEdPreview_setMountThreadSequence (string guishapeedpreview, int slot, string name) @@ -24837,7 +31359,9 @@ public void fnGuiShapeEdPreview_setMountThreadSequence (string guishapeedpreview SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountThreadSequence(sbguishapeedpreview, slot, sbname); } /// -/// Set the camera orbit position @param pos Position in the form \"x y z\" ) +/// Set the camera orbit position +/// @param pos Position in the form \"x y z\" ) +/// /// public void fnGuiShapeEdPreview_setOrbitPos (string guishapeedpreview, string pos) @@ -24854,7 +31378,12 @@ public void fnGuiShapeEdPreview_setOrbitPos (string guishapeedpreview, string po SafeNativeMethods.mwle_fnGuiShapeEdPreview_setOrbitPos(sbguishapeedpreview, sbpos); } /// -/// Sets the sequence to play for the active thread. @param name name of the sequence to play @param duration transition duration (0 for no transition) @param pos position in the new sequence to transition to @param play if true, the new sequence will play during the transition ) +/// Sets the sequence to play for the active thread. +/// @param name name of the sequence to play +/// @param duration transition duration (0 for no transition) +/// @param pos position in the new sequence to transition to +/// @param play if true, the new sequence will play during the transition ) +/// /// public void fnGuiShapeEdPreview_setThreadSequence (string guishapeedpreview, string name, float duration, float pos, bool play) @@ -24871,7 +31400,9 @@ public void fnGuiShapeEdPreview_setThreadSequence (string guishapeedpreview, str SafeNativeMethods.mwle_fnGuiShapeEdPreview_setThreadSequence(sbguishapeedpreview, sbname, duration, pos, play); } /// -/// Set the time scale of all threads @param scale new time scale value ) +/// Set the time scale of all threads +/// @param scale new time scale value ) +/// /// public void fnGuiShapeEdPreview_setTimeScale (string guishapeedpreview, float scale) @@ -24886,6 +31417,7 @@ public void fnGuiShapeEdPreview_setTimeScale (string guishapeedpreview, float sc } /// /// Unmount all shapes ) +/// /// public void fnGuiShapeEdPreview_unmountAll (string guishapeedpreview) @@ -24899,7 +31431,9 @@ public void fnGuiShapeEdPreview_unmountAll (string guishapeedpreview) SafeNativeMethods.mwle_fnGuiShapeEdPreview_unmountAll(sbguishapeedpreview); } /// -/// Unmount the shape in the specified slot @param slot mounted shape slot ) +/// Unmount the shape in the specified slot +/// @param slot mounted shape slot ) +/// /// public void fnGuiShapeEdPreview_unmountShape (string guishapeedpreview, int slot) @@ -24914,6 +31448,7 @@ public void fnGuiShapeEdPreview_unmountShape (string guishapeedpreview, int slot } /// /// Refresh the shape node transforms (used when a node transform has been modified externally) ) +/// /// public void fnGuiShapeEdPreview_updateNodeTransforms (string guishapeedpreview) @@ -24927,7 +31462,9 @@ public void fnGuiShapeEdPreview_updateNodeTransforms (string guishapeedpreview) SafeNativeMethods.mwle_fnGuiShapeEdPreview_updateNodeTransforms(sbguishapeedpreview); } /// -/// Get the current value of the slider based on the position of the thumb. @return Slider position (from range.x to range.y). ) +/// Get the current value of the slider based on the position of the thumb. +/// @return Slider position (from range.x to range.y). ) +/// /// public float fnGuiSliderCtrl_getValue (string guisliderctrl) @@ -24941,7 +31478,10 @@ public float fnGuiSliderCtrl_getValue (string guisliderctrl) return SafeNativeMethods.mwle_fnGuiSliderCtrl_getValue(sbguisliderctrl); } /// -/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful for scrubbing type sliders where the slider position is sync'd to a changing value. When the user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful +/// for scrubbing type sliders where the slider position is sync'd to a changing value. When the +/// user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// /// public bool fnGuiSliderCtrl_isThumbBeingDragged (string guisliderctrl) @@ -24955,7 +31495,10 @@ public bool fnGuiSliderCtrl_isThumbBeingDragged (string guisliderctrl) return SafeNativeMethods.mwle_fnGuiSliderCtrl_isThumbBeingDragged(sbguisliderctrl)>=1; } /// -/// Set position of the thumb on the slider. @param pos New slider position (from range.x to range.y) @param doCallback If true, the altCommand callback will be invoked ) +/// Set position of the thumb on the slider. +/// @param pos New slider position (from range.x to range.y) +/// @param doCallback If true, the altCommand callback will be invoked ) +/// /// public void fnGuiSliderCtrl_setValue (string guisliderctrl, float pos, bool doCallback) @@ -24969,7 +31512,14 @@ public void fnGuiSliderCtrl_setValue (string guisliderctrl, float pos, bool doCa SafeNativeMethods.mwle_fnGuiSliderCtrl_setValue(sbguisliderctrl, pos, doCallback); } /// -/// Prevents control from restacking - useful when adding or removing child controls @param freeze True to freeze the control, false to unfreeze it @tsexample %stackCtrl.freeze(true); // add controls to stack %stackCtrl.freeze(false); @endtsexample ) +/// Prevents control from restacking - useful when adding or removing child controls +/// @param freeze True to freeze the control, false to unfreeze it +/// @tsexample +/// %stackCtrl.freeze(true); +/// // add controls to stack +/// %stackCtrl.freeze(false); +/// @endtsexample ) +/// /// public void fnGuiStackControl_freeze (string guistackcontrol, bool freeze) @@ -24984,6 +31534,7 @@ public void fnGuiStackControl_freeze (string guistackcontrol, bool freeze) } /// /// Return whether or not this control is frozen ) +/// /// public bool fnGuiStackControl_isFrozen (string guistackcontrol) @@ -24998,6 +31549,7 @@ public bool fnGuiStackControl_isFrozen (string guistackcontrol) } /// /// Restack the child controls. ) +/// /// public void fnGuiStackControl_updateStack (string guistackcontrol) @@ -25011,7 +31563,11 @@ public void fnGuiStackControl_updateStack (string guistackcontrol) SafeNativeMethods.mwle_fnGuiStackControl_updateStack(sbguistackcontrol); } /// -/// Set the color of the swatch control. @param newColor The new color string given to the swatch control in float format \"r g b a\". @note It's also important to note that when setColor is called causes the control's altCommand field to be executed. ) +/// Set the color of the swatch control. +/// @param newColor The new color string given to the swatch control in float format \"r g b a\". +/// @note It's also important to note that when setColor is called causes +/// the control's altCommand field to be executed. ) +/// /// public void fnGuiSwatchButtonCtrl_setColor (string guiswatchbuttonctrl, string newColor) @@ -25028,7 +31584,10 @@ public void fnGuiSwatchButtonCtrl_setColor (string guiswatchbuttonctrl, string n SafeNativeMethods.mwle_fnGuiSwatchButtonCtrl_setColor(sbguiswatchbuttonctrl, sbnewColor); } /// -/// ), Add a new tab page to the control. @param title Title text for the tab page header. ) +/// ), +/// Add a new tab page to the control. +/// @param title Title text for the tab page header. ) +/// /// public void fnGuiTabBookCtrl_addPage (string guitabbookctrl, string title) @@ -25045,7 +31604,9 @@ public void fnGuiTabBookCtrl_addPage (string guitabbookctrl, string title) SafeNativeMethods.mwle_fnGuiTabBookCtrl_addPage(sbguitabbookctrl, sbtitle); } /// -/// Get the index of the currently selected tab page. @return Index of the selected tab page or -1 if no tab page is selected. ) +/// Get the index of the currently selected tab page. +/// @return Index of the selected tab page or -1 if no tab page is selected. ) +/// /// public int fnGuiTabBookCtrl_getSelectedPage (string guitabbookctrl) @@ -25059,7 +31620,9 @@ public int fnGuiTabBookCtrl_getSelectedPage (string guitabbookctrl) return SafeNativeMethods.mwle_fnGuiTabBookCtrl_getSelectedPage(sbguitabbookctrl); } /// -/// Set the selected tab page. @param index Index of the tab page. ) +/// Set the selected tab page. +/// @param index Index of the tab page. ) +/// /// public void fnGuiTabBookCtrl_selectPage (string guitabbookctrl, int index) @@ -25201,6 +31764,7 @@ public void fnGuiTableControl_setSelectedRow (string guitablecontrol, int rowNum } /// /// Select this page in its tab book. ) +/// /// public void fnGuiTabPageCtrl_select (string guitabpagectrl) @@ -25214,7 +31778,16 @@ public void fnGuiTabPageCtrl_select (string guitabpagectrl) SafeNativeMethods.mwle_fnGuiTabPageCtrl_select(sbguitabpagectrl); } /// -/// @brief Sets the text in the control. @param text Text to display in the control. @tsexample // Set the text to show in the control %text = \"Gideon - Destroyer of World\"; // Inform the GuiTextCtrl control to change its text to the defined value %thisGuiTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to display in the control. +/// @tsexample +/// // Set the text to show in the control +/// %text = \"Gideon - Destroyer of World\"; +/// // Inform the GuiTextCtrl control to change its text to the defined value +/// %thisGuiTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextCtrl_setText (string guitextctrl, string text) @@ -25231,7 +31804,15 @@ public void fnGuiTextCtrl_setText (string guitextctrl, string text) SafeNativeMethods.mwle_fnGuiTextCtrl_setText(sbguitextctrl, sbtext); } /// -/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. @param textID Name of variable text should be mapped to @tsexample // Inform the GuiTextCtrl control of the textID to use %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); @endtsexample @see GuiControl @see Localization) +/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. +/// @param textID Name of variable text should be mapped to +/// @tsexample +/// // Inform the GuiTextCtrl control of the textID to use +/// %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); +/// @endtsexample +/// @see GuiControl +/// @see Localization) +/// /// public void fnGuiTextCtrl_setTextID (string guitextctrl, string textID) @@ -25248,7 +31829,13 @@ public void fnGuiTextCtrl_setTextID (string guitextctrl, string textID) SafeNativeMethods.mwle_fnGuiTextCtrl_setTextID(sbguitextctrl, sbtextID); } /// -/// @brief Unselects all selected text in the control. @tsexample // Inform the control to unselect all of its selected text %thisGuiTextEditCtrl.clearSelectedText(); @endtsexample @see GuiControl) +/// @brief Unselects all selected text in the control. +/// @tsexample +/// // Inform the control to unselect all of its selected text +/// %thisGuiTextEditCtrl.clearSelectedText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_clearSelectedText (string guitexteditctrl) @@ -25262,7 +31849,13 @@ public void fnGuiTextEditCtrl_clearSelectedText (string guitexteditctrl) SafeNativeMethods.mwle_fnGuiTextEditCtrl_clearSelectedText(sbguitexteditctrl); } /// -/// @brief Force a validation to occur. @tsexample // Inform the control to force a validation of its text. %thisGuiTextEditCtrl.forceValidateText(); @endtsexample @see GuiControl) +/// @brief Force a validation to occur. +/// @tsexample +/// // Inform the control to force a validation of its text. +/// %thisGuiTextEditCtrl.forceValidateText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_forceValidateText (string guitexteditctrl) @@ -25276,7 +31869,14 @@ public void fnGuiTextEditCtrl_forceValidateText (string guitexteditctrl) SafeNativeMethods.mwle_fnGuiTextEditCtrl_forceValidateText(sbguitexteditctrl); } /// -/// @brief Returns the current position of the text cursor in the control. @tsexample // Acquire the cursor position in the control %position = %thisGuiTextEditCtrl.getCursorPost(); @endtsexample @return Text cursor position within the control. @see GuiControl) +/// @brief Returns the current position of the text cursor in the control. +/// @tsexample +/// // Acquire the cursor position in the control +/// %position = %thisGuiTextEditCtrl.getCursorPost(); +/// @endtsexample +/// @return Text cursor position within the control. +/// @see GuiControl) +/// /// public int fnGuiTextEditCtrl_getCursorPos (string guitexteditctrl) @@ -25290,7 +31890,14 @@ public int fnGuiTextEditCtrl_getCursorPos (string guitexteditctrl) return SafeNativeMethods.mwle_fnGuiTextEditCtrl_getCursorPos(sbguitexteditctrl); } /// -/// @brief Acquires the current text displayed in this control. @tsexample // Acquire the value of the text control. %text = %thisGuiTextEditCtrl.getText(); @endtsexample @return The current text within the control. @see GuiControl) +/// @brief Acquires the current text displayed in this control. +/// @tsexample +/// // Acquire the value of the text control. +/// %text = %thisGuiTextEditCtrl.getText(); +/// @endtsexample +/// @return The current text within the control. +/// @see GuiControl) +/// /// public string fnGuiTextEditCtrl_getText (string guitexteditctrl) @@ -25307,7 +31914,14 @@ public string fnGuiTextEditCtrl_getText (string guitexteditctrl) } /// -/// @brief Checks to see if all text in the control has been selected. @tsexample // Check to see if all text has been selected or not. %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); @endtsexample @return True if all text in the control is selected, otherwise false. @see GuiControl) +/// @brief Checks to see if all text in the control has been selected. +/// @tsexample +/// // Check to see if all text has been selected or not. +/// %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); +/// @endtsexample +/// @return True if all text in the control is selected, otherwise false. +/// @see GuiControl) +/// /// public bool fnGuiTextEditCtrl_isAllTextSelected (string guitexteditctrl) @@ -25321,7 +31935,13 @@ public bool fnGuiTextEditCtrl_isAllTextSelected (string guitexteditctrl) return SafeNativeMethods.mwle_fnGuiTextEditCtrl_isAllTextSelected(sbguitexteditctrl)>=1; } /// -/// @brief Selects all text within the control. @tsexample // Inform the control to select all of its text. %thisGuiTextEditCtrl.selectAllText(); @endtsexample @see GuiControl) +/// @brief Selects all text within the control. +/// @tsexample +/// // Inform the control to select all of its text. +/// %thisGuiTextEditCtrl.selectAllText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_selectAllText (string guitexteditctrl) @@ -25335,7 +31955,16 @@ public void fnGuiTextEditCtrl_selectAllText (string guitexteditctrl) SafeNativeMethods.mwle_fnGuiTextEditCtrl_selectAllText(sbguitexteditctrl); } /// -/// @brief Sets the text cursor at the defined position within the control. @param position Text position to set the text cursor. @tsexample // Define the cursor position %position = \"12\"; // Inform the GuiTextEditCtrl control to place the text cursor at the defined position %thisGuiTextEditCtrl.setCursorPos(%position); @endtsexample @see GuiControl) +/// @brief Sets the text cursor at the defined position within the control. +/// @param position Text position to set the text cursor. +/// @tsexample +/// // Define the cursor position +/// %position = \"12\"; +/// // Inform the GuiTextEditCtrl control to place the text cursor at the defined position +/// %thisGuiTextEditCtrl.setCursorPos(%position); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_setCursorPos (string guitexteditctrl, int position) @@ -25349,7 +31978,16 @@ public void fnGuiTextEditCtrl_setCursorPos (string guitexteditctrl, int position SafeNativeMethods.mwle_fnGuiTextEditCtrl_setCursorPos(sbguitexteditctrl, position); } /// -/// @brief Sets the text in the control. @param text Text to place in the control. @tsexample // Define the text to display %text = \"Text!\" // Inform the GuiTextEditCtrl to display the defined text %thisGuiTextEditCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to place in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Text!\" +/// // Inform the GuiTextEditCtrl to display the defined text +/// %thisGuiTextEditCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_setText (string guitexteditctrl, string text) @@ -25366,7 +32004,25 @@ public void fnGuiTextEditCtrl_setText (string guitexteditctrl, string text) SafeNativeMethods.mwle_fnGuiTextEditCtrl_setText(sbguitexteditctrl, sbtext); } /// -/// ,-1), @brief Adds a new row at end of the list with the defined id and text. If index is used, then the new row is inserted at the row location of 'index'. @param id Id of the new row. @param text Text to display at the new row. @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. @tsexample // Define the id %id = \"4\"; // Define the text to display %text = \"Display Text\" // Define the index (optional) %index = \"2\" // Inform the GuiTextListCtrl control to add the new row with the defined information. %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); @endtsexample @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. @see References) +/// ,-1), +/// @brief Adds a new row at end of the list with the defined id and text. +/// If index is used, then the new row is inserted at the row location of 'index'. +/// @param id Id of the new row. +/// @param text Text to display at the new row. +/// @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text to display +/// %text = \"Display Text\" +/// // Define the index (optional) +/// %index = \"2\" +/// // Inform the GuiTextListCtrl control to add the new row with the defined information. +/// %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); +/// @endtsexample +/// @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. +/// @see References) +/// /// public int fnGuiTextListCtrl_addRow (string guitextlistctrl, int id, string text, int index) @@ -25383,7 +32039,13 @@ public int fnGuiTextListCtrl_addRow (string guitextlistctrl, int id, string text return SafeNativeMethods.mwle_fnGuiTextListCtrl_addRow(sbguitextlistctrl, id, sbtext, index); } /// -/// @brief Clear the list. @tsexample // Inform the GuiTextListCtrl control to clear its contents %thisGuiTextListCtrl.clear(); @endtsexample @see GuiControl) +/// @brief Clear the list. +/// @tsexample +/// // Inform the GuiTextListCtrl control to clear its contents +/// %thisGuiTextListCtrl.clear(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_clear (string guitextlistctrl) @@ -25397,7 +32059,13 @@ public void fnGuiTextListCtrl_clear (string guitextlistctrl) SafeNativeMethods.mwle_fnGuiTextListCtrl_clear(sbguitextlistctrl); } /// -/// @brief Set the selection to nothing. @tsexample // Deselect anything that is currently selected %thisGuiTextListCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Set the selection to nothing. +/// @tsexample +/// // Deselect anything that is currently selected +/// %thisGuiTextListCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_clearSelection (string guitextlistctrl) @@ -25412,6 +32080,7 @@ public void fnGuiTextListCtrl_clearSelection (string guitextlistctrl) } /// /// ) +/// /// public int fnGuiTextListCtrl_findColumnTextIndex (string guitextlistctrl, int columnId, string columnText) @@ -25428,7 +32097,17 @@ public int fnGuiTextListCtrl_findColumnTextIndex (string guitextlistctrl, int co return SafeNativeMethods.mwle_fnGuiTextListCtrl_findColumnTextIndex(sbguitextlistctrl, columnId, sbcolumnText); } /// -/// @brief Find needle in the list, and return the row number it was found in. @param needle Text to find in the list. @tsexample // Define the text to find in the list %needle = \"Text To Find\"; // Request the row number that contains the defined text to find %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); @endtsexample @return Row number that the defined text was found in, @see GuiControl) +/// @brief Find needle in the list, and return the row number it was found in. +/// @param needle Text to find in the list. +/// @tsexample +/// // Define the text to find in the list +/// %needle = \"Text To Find\"; +/// // Request the row number that contains the defined text to find +/// %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); +/// @endtsexample +/// @return Row number that the defined text was found in, +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_findTextIndex (string guitextlistctrl, string needle) @@ -25445,7 +32124,17 @@ public int fnGuiTextListCtrl_findTextIndex (string guitextlistctrl, string needl return SafeNativeMethods.mwle_fnGuiTextListCtrl_findTextIndex(sbguitextlistctrl, sbneedle); } /// -/// @brief Get the row ID for an index. @param index Index to get the RowID at @tsexample // Define the index %index = \"3\"; // Request the row ID at the defined index %rowId = %thisGuiTextListCtrl.getRowId(%index); @endtsexample @return RowId at the defined index. @see GuiControl) +/// @brief Get the row ID for an index. +/// @param index Index to get the RowID at +/// @tsexample +/// // Define the index +/// %index = \"3\"; +/// // Request the row ID at the defined index +/// %rowId = %thisGuiTextListCtrl.getRowId(%index); +/// @endtsexample +/// @return RowId at the defined index. +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getRowId (string guitextlistctrl, int index) @@ -25459,7 +32148,16 @@ public int fnGuiTextListCtrl_getRowId (string guitextlistctrl, int index) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getRowId(sbguitextlistctrl, index); } /// -/// @brief Get the row number for a specified id. @param id Id to get the row number at @tsexample // Define the id %id = \"4\"; // Request the row number from the GuiTextListCtrl control at the defined id. %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); @endtsexample @see GuiControl) +/// @brief Get the row number for a specified id. +/// @param id Id to get the row number at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Request the row number from the GuiTextListCtrl control at the defined id. +/// %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getRowNumById (string guitextlistctrl, int id) @@ -25473,7 +32171,17 @@ public int fnGuiTextListCtrl_getRowNumById (string guitextlistctrl, int id) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getRowNumById(sbguitextlistctrl, id); } /// -/// @brief Get the text of the row with the specified index. @param index Row index to acquire the text at. @tsexample // Define the row index %index = \"5\"; // Request the text from the row at the defined index %rowText = %thisGuiTextListCtrl.getRowText(%index); @endtsexample @return Text at the defined row index. @see GuiControl) +/// @brief Get the text of the row with the specified index. +/// @param index Row index to acquire the text at. +/// @tsexample +/// // Define the row index +/// %index = \"5\"; +/// // Request the text from the row at the defined index +/// %rowText = %thisGuiTextListCtrl.getRowText(%index); +/// @endtsexample +/// @return Text at the defined row index. +/// @see GuiControl) +/// /// public string fnGuiTextListCtrl_getRowText (string guitextlistctrl, int index) @@ -25490,7 +32198,16 @@ public string fnGuiTextListCtrl_getRowText (string guitextlistctrl, int index) } /// -/// @brief Get the text of a row with the specified id. @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to return the text at the defined row id %rowText = %thisGuiTextListCtrl.getRowTextById(%id); @endtsexample @return Row text at the requested row id. @see GuiControl) +/// @brief Get the text of a row with the specified id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to return the text at the defined row id +/// %rowText = %thisGuiTextListCtrl.getRowTextById(%id); +/// @endtsexample +/// @return Row text at the requested row id. +/// @see GuiControl) +/// /// public string fnGuiTextListCtrl_getRowTextById (string guitextlistctrl, int id) @@ -25507,7 +32224,14 @@ public string fnGuiTextListCtrl_getRowTextById (string guitextlistctrl, int id) } /// -/// @brief Get the ID of the currently selected item. @tsexample // Acquire the ID of the selected item in the list. %id = %thisGuiTextListCtrl.getSelectedId(); @endtsexample @return The id of the selected item in the list. @see GuiControl) +/// @brief Get the ID of the currently selected item. +/// @tsexample +/// // Acquire the ID of the selected item in the list. +/// %id = %thisGuiTextListCtrl.getSelectedId(); +/// @endtsexample +/// @return The id of the selected item in the list. +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getSelectedId (string guitextlistctrl) @@ -25521,7 +32245,14 @@ public int fnGuiTextListCtrl_getSelectedId (string guitextlistctrl) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getSelectedId(sbguitextlistctrl); } /// -/// @brief Returns the selected row index (not the row ID). @tsexample // Acquire the selected row index %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); @endtsexample @return Index of the selected row @see GuiControl) +/// @brief Returns the selected row index (not the row ID). +/// @tsexample +/// // Acquire the selected row index +/// %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); +/// @endtsexample +/// @return Index of the selected row +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getSelectedRow (string guitextlistctrl) @@ -25535,7 +32266,17 @@ public int fnGuiTextListCtrl_getSelectedRow (string guitextlistctrl) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getSelectedRow(sbguitextlistctrl); } /// -/// @brief Check if the specified row is currently active or not. @param rowNum Row number to check the active state. @tsexample // Define the row number %rowNum = \"5\"; // Request the active state of the defined row number from the GuiTextListCtrl control. %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); @endtsexample @return Active state of the defined row number. @see GuiControl) +/// @brief Check if the specified row is currently active or not. +/// @param rowNum Row number to check the active state. +/// @tsexample +/// // Define the row number +/// %rowNum = \"5\"; +/// // Request the active state of the defined row number from the GuiTextListCtrl control. +/// %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); +/// @endtsexample +/// @return Active state of the defined row number. +/// @see GuiControl) +/// /// public bool fnGuiTextListCtrl_isRowActive (string guitextlistctrl, int rowNum) @@ -25549,7 +32290,16 @@ public bool fnGuiTextListCtrl_isRowActive (string guitextlistctrl, int rowNum) return SafeNativeMethods.mwle_fnGuiTextListCtrl_isRowActive(sbguitextlistctrl, rowNum)>=1; } /// -/// @brief Remove a row from the table, based on its index. @param index Row index to remove from the list. @tsexample // Define the row index %index = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined row index %thisGuiTextListCtrl.removeRow(%index); @endtsexample @see GuiControl) +/// @brief Remove a row from the table, based on its index. +/// @param index Row index to remove from the list. +/// @tsexample +/// // Define the row index +/// %index = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined row index +/// %thisGuiTextListCtrl.removeRow(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_removeRow (string guitextlistctrl, int index) @@ -25563,7 +32313,16 @@ public void fnGuiTextListCtrl_removeRow (string guitextlistctrl, int index) SafeNativeMethods.mwle_fnGuiTextListCtrl_removeRow(sbguitextlistctrl, index); } /// -/// @brief Remove row with the specified id. @param id Id to remove the row entry at @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined id %thisGuiTextListCtrl.removeRowById(%id); @endtsexample @see GuiControl) +/// @brief Remove row with the specified id. +/// @param id Id to remove the row entry at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined id +/// %thisGuiTextListCtrl.removeRowById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_removeRowById (string guitextlistctrl, int id) @@ -25577,7 +32336,14 @@ public void fnGuiTextListCtrl_removeRowById (string guitextlistctrl, int id) SafeNativeMethods.mwle_fnGuiTextListCtrl_removeRowById(sbguitextlistctrl, id); } /// -/// @brief Get the number of rows. @tsexample // Get the number of rows in the list %rowCount = %thisGuiTextListCtrl.rowCount(); @endtsexample @return Number of rows in the list. @see GuiControl) +/// @brief Get the number of rows. +/// @tsexample +/// // Get the number of rows in the list +/// %rowCount = %thisGuiTextListCtrl.rowCount(); +/// @endtsexample +/// @return Number of rows in the list. +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_rowCount (string guitextlistctrl) @@ -25591,7 +32357,16 @@ public int fnGuiTextListCtrl_rowCount (string guitextlistctrl) return SafeNativeMethods.mwle_fnGuiTextListCtrl_rowCount(sbguitextlistctrl); } /// -/// @brief Scroll so the specified row is visible @param rowNum Row number to make visible @tsexample // Define the row number to make visible %rowNum = \"4\"; // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. %thisGuiTextListCtrl.scrollVisible(%rowNum); @endtsexample @see GuiControl) +/// @brief Scroll so the specified row is visible +/// @param rowNum Row number to make visible +/// @tsexample +/// // Define the row number to make visible +/// %rowNum = \"4\"; +/// // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. +/// %thisGuiTextListCtrl.scrollVisible(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_scrollVisible (string guitextlistctrl, int rowNum) @@ -25605,7 +32380,19 @@ public void fnGuiTextListCtrl_scrollVisible (string guitextlistctrl, int rowNum) SafeNativeMethods.mwle_fnGuiTextListCtrl_scrollVisible(sbguitextlistctrl, rowNum); } /// -/// @brief Mark a specified row as active/not. @param rowNum Row number to change the active state. @param active Boolean active state to set the row number. @tsexample // Define the row number %rowNum = \"4\"; // Define the boolean active state %active = \"true\"; // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. %thisGuiTextListCtrl.setRowActive(%rowNum,%active); @endtsexample @see GuiControl) +/// @brief Mark a specified row as active/not. +/// @param rowNum Row number to change the active state. +/// @param active Boolean active state to set the row number. +/// @tsexample +/// // Define the row number +/// %rowNum = \"4\"; +/// // Define the boolean active state +/// %active = \"true\"; +/// // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. +/// %thisGuiTextListCtrl.setRowActive(%rowNum,%active); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setRowActive (string guitextlistctrl, int rowNum, bool active) @@ -25619,7 +32406,19 @@ public void fnGuiTextListCtrl_setRowActive (string guitextlistctrl, int rowNum, SafeNativeMethods.mwle_fnGuiTextListCtrl_setRowActive(sbguitextlistctrl, rowNum, active); } /// -/// @brief Sets the text at the defined id. @param id Id to change. @param text Text to use at the Id. @tsexample // Define the id %id = \"4\"; // Define the text %text = \"Text To Display\"; // Inform the GuiTextListCtrl control to display the defined text at the defined id %thisGuiTextListCtrl.setRowById(%id,%text); @endtsexample @see GuiControl) +/// @brief Sets the text at the defined id. +/// @param id Id to change. +/// @param text Text to use at the Id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text +/// %text = \"Text To Display\"; +/// // Inform the GuiTextListCtrl control to display the defined text at the defined id +/// %thisGuiTextListCtrl.setRowById(%id,%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setRowById (string guitextlistctrl, int id, string text) @@ -25636,7 +32435,16 @@ public void fnGuiTextListCtrl_setRowById (string guitextlistctrl, int id, string SafeNativeMethods.mwle_fnGuiTextListCtrl_setRowById(sbguitextlistctrl, id, sbtext); } /// -/// @brief Finds the specified entry by id, then marks its row as selected. @param id Entry within the text list to make selected. @tsexample // Define the id %id = \"5\"; // Inform the GuiTextListCtrl control to set the defined id entry as selected %thisGuiTextListCtrl.setSelectedById(%id); @endtsexample @see GuiControl) +/// @brief Finds the specified entry by id, then marks its row as selected. +/// @param id Entry within the text list to make selected. +/// @tsexample +/// // Define the id +/// %id = \"5\"; +/// // Inform the GuiTextListCtrl control to set the defined id entry as selected +/// %thisGuiTextListCtrl.setSelectedById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setSelectedById (string guitextlistctrl, int id) @@ -25650,7 +32458,15 @@ public void fnGuiTextListCtrl_setSelectedById (string guitextlistctrl, int id) SafeNativeMethods.mwle_fnGuiTextListCtrl_setSelectedById(sbguitextlistctrl, id); } /// -/// @briefSelects the specified row. @param rowNum Row number to set selected. @tsexample // Define the row number to set selected %rowNum = \"4\"; %guiTextListCtrl.setSelectedRow(%rowNum); @endtsexample @see GuiControl) +/// @briefSelects the specified row. +/// @param rowNum Row number to set selected. +/// @tsexample +/// // Define the row number to set selected +/// %rowNum = \"4\"; +/// %guiTextListCtrl.setSelectedRow(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setSelectedRow (string guitextlistctrl, int rowNum) @@ -25664,7 +32480,19 @@ public void fnGuiTextListCtrl_setSelectedRow (string guitextlistctrl, int rowNum SafeNativeMethods.mwle_fnGuiTextListCtrl_setSelectedRow(sbguitextlistctrl, rowNum); } /// -/// @brief Performs a standard (alphabetical) sort on the values in the specified column. @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sort(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Performs a standard (alphabetical) sort on the values in the specified column. +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sort(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_sort (string guitextlistctrl, int columnId, bool increasing) @@ -25678,7 +32506,20 @@ public void fnGuiTextListCtrl_sort (string guitextlistctrl, int columnId, bool i SafeNativeMethods.mwle_fnGuiTextListCtrl_sort(sbguitextlistctrl, columnId, increasing); } /// -/// @brief Perform a numerical sort on the values in the specified column. Detailed description @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sortNumerical(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Perform a numerical sort on the values in the specified column. +/// Detailed description +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sortNumerical(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_sortNumerical (string guitextlistctrl, int columnID, bool increasing) @@ -25692,7 +32533,9 @@ public void fnGuiTextListCtrl_sortNumerical (string guitextlistctrl, int columnI SafeNativeMethods.mwle_fnGuiTextListCtrl_sortNumerical(sbguitextlistctrl, columnID, increasing); } /// -/// Get the current playback time. @return The elapsed playback time in seconds. ) +/// Get the current playback time. +/// @return The elapsed playback time in seconds. ) +/// /// public float fnGuiTheoraCtrl_getCurrentTime (string guitheoractrl) @@ -25706,7 +32549,9 @@ public float fnGuiTheoraCtrl_getCurrentTime (string guitheoractrl) return SafeNativeMethods.mwle_fnGuiTheoraCtrl_getCurrentTime(sbguitheoractrl); } /// -/// Test whether the video has finished playing. @return True if the video has finished playing, false otherwise. ) +/// Test whether the video has finished playing. +/// @return True if the video has finished playing, false otherwise. ) +/// /// public bool fnGuiTheoraCtrl_isPlaybackDone (string guitheoractrl) @@ -25720,7 +32565,9 @@ public bool fnGuiTheoraCtrl_isPlaybackDone (string guitheoractrl) return SafeNativeMethods.mwle_fnGuiTheoraCtrl_isPlaybackDone(sbguitheoractrl)>=1; } /// -/// Pause playback of the video. If the video is not currently playing, the call is ignored. While stopped, the control displays the last frame. ) +/// Pause playback of the video. If the video is not currently playing, the call is ignored. +/// While stopped, the control displays the last frame. ) +/// /// public void fnGuiTheoraCtrl_pause (string guitheoractrl) @@ -25735,6 +32582,7 @@ public void fnGuiTheoraCtrl_pause (string guitheoractrl) } /// /// Start playing the video. If the video is already playing, the call is ignored. ) +/// /// public void fnGuiTheoraCtrl_play (string guitheoractrl) @@ -25748,7 +32596,10 @@ public void fnGuiTheoraCtrl_play (string guitheoractrl) SafeNativeMethods.mwle_fnGuiTheoraCtrl_play(sbguitheoractrl); } /// -/// Set the video file to play. If a video is already playing, playback is stopped and the new video file is loaded. @param filename The video file to load. ) +/// Set the video file to play. If a video is already playing, playback is stopped and +/// the new video file is loaded. +/// @param filename The video file to load. ) +/// /// public void fnGuiTheoraCtrl_setFile (string guitheoractrl, string filename) @@ -25765,7 +32616,9 @@ public void fnGuiTheoraCtrl_setFile (string guitheoractrl, string filename) SafeNativeMethods.mwle_fnGuiTheoraCtrl_setFile(sbguitheoractrl, sbfilename); } /// -/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. While stopped, the control renders empty with just the background color. ) +/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. +/// While stopped, the control renders empty with just the background color. ) +/// /// public void fnGuiTheoraCtrl_stop (string guitheoractrl) @@ -25779,7 +32632,12 @@ public void fnGuiTheoraCtrl_stop (string guitheoractrl) SafeNativeMethods.mwle_fnGuiTheoraCtrl_stop(sbguitheoractrl); } /// -/// Add an item/object to the current selection. @param id ID of item/object to add to the selection. @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, the control will defer refreshing the tree and wait until addSelection() is called with this parameter set to true. ) +/// Add an item/object to the current selection. +/// @param id ID of item/object to add to the selection. +/// @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, +/// the control will defer refreshing the tree and wait until addSelection() is called with this parameter set +/// to true. ) +/// /// public void fnGuiTreeViewCtrl_addSelection (string guitreeviewctrl, int id, bool isLastSelection) @@ -25793,7 +32651,10 @@ public void fnGuiTreeViewCtrl_addSelection (string guitreeviewctrl, int id, bool SafeNativeMethods.mwle_fnGuiTreeViewCtrl_addSelection(sbguitreeviewctrl, id, isLastSelection); } /// -/// Clear the current item filtering pattern. @see setFilterText @see getFilterText ) +/// Clear the current item filtering pattern. +/// @see setFilterText +/// @see getFilterText ) +/// /// public void fnGuiTreeViewCtrl_clearFilterText (string guitreeviewctrl) @@ -25808,6 +32669,7 @@ public void fnGuiTreeViewCtrl_clearFilterText (string guitreeviewctrl) } /// /// Unselect all currently selected items. ) +/// /// public void fnGuiTreeViewCtrl_clearSelection (string guitreeviewctrl) @@ -25822,6 +32684,7 @@ public void fnGuiTreeViewCtrl_clearSelection (string guitreeviewctrl) } /// /// Delete all items/objects in the current selection. ) +/// /// public void fnGuiTreeViewCtrl_deleteSelection (string guitreeviewctrl) @@ -25835,7 +32698,12 @@ public void fnGuiTreeViewCtrl_deleteSelection (string guitreeviewctrl) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_deleteSelection(sbguitreeviewctrl); } /// -/// Get the child item of the given parent item whose text matches @a childName. @param parentId Item ID of the parent in which to look for the child. @param childName Text of the child item to find. @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. @note This method does not recurse, i.e. it only looks for direct children. ) +/// Get the child item of the given parent item whose text matches @a childName. +/// @param parentId Item ID of the parent in which to look for the child. +/// @param childName Text of the child item to find. +/// @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. +/// @note This method does not recurse, i.e. it only looks for direct children. ) +/// /// public int fnGuiTreeViewCtrl_findChildItemByName (string guitreeviewctrl, int parentId, string childName) @@ -25852,7 +32720,10 @@ public int fnGuiTreeViewCtrl_findChildItemByName (string guitreeviewctrl, int pa return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_findChildItemByName(sbguitreeviewctrl, parentId, sbchildName); } /// -/// Get the ID of the item whose text matches the given @a text. @param text Item text to match. @return ID of the item or -1 if no item matches the given text. ) +/// Get the ID of the item whose text matches the given @a text. +/// @param text Item text to match. +/// @return ID of the item or -1 if no item matches the given text. ) +/// /// public int fnGuiTreeViewCtrl_findItemByName (string guitreeviewctrl, string text) @@ -25869,7 +32740,10 @@ public int fnGuiTreeViewCtrl_findItemByName (string guitreeviewctrl, string text return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_findItemByName(sbguitreeviewctrl, sbtext); } /// -/// Get the ID of the item whose value matches @a value. @param value Value text to match. @return ID of the item or -1 if no item has the given value. ) +/// Get the ID of the item whose value matches @a value. +/// @param value Value text to match. +/// @return ID of the item or -1 if no item has the given value. ) +/// /// public int fnGuiTreeViewCtrl_findItemByValue (string guitreeviewctrl, string value) @@ -25886,7 +32760,12 @@ public int fnGuiTreeViewCtrl_findItemByValue (string guitreeviewctrl, string val return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_findItemByValue(sbguitreeviewctrl, sbvalue); } /// -/// Get the current filter expression. Only tree items whose text matches this expression are displayed. By default, the expression is empty and all items are shown. @return The current filter pattern or an empty string if no filter pattern is currently active. @see setFilterText @see clearFilterText ) +/// Get the current filter expression. Only tree items whose text matches this expression +/// are displayed. By default, the expression is empty and all items are shown. +/// @return The current filter pattern or an empty string if no filter pattern is currently active. +/// @see setFilterText +/// @see clearFilterText ) +/// /// public string fnGuiTreeViewCtrl_getFilterText (string guitreeviewctrl) @@ -25903,7 +32782,9 @@ public string fnGuiTreeViewCtrl_getFilterText (string guitreeviewctrl) } /// -/// Call SimObject::setHidden( @a state ) on all objects in the current selection. @param state Visibility state to set objects in selection to. ) +/// Call SimObject::setHidden( @a state ) on all objects in the current selection. +/// @param state Visibility state to set objects in selection to. ) +/// /// public void fnGuiTreeViewCtrl_hideSelection (string guitreeviewctrl, bool state) @@ -25917,7 +32798,16 @@ public void fnGuiTreeViewCtrl_hideSelection (string guitreeviewctrl, bool state) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_hideSelection(sbguitreeviewctrl, state); } /// -/// , , 0, 0 ), Add a new item to the tree. @param parentId Item ID of parent to which to add the item as a child. 0 is root item. @param text Text to display on the item in the tree. @param value Behind-the-scenes value of the item. @param icon @param normalImage @param expandedImage @return The ID of the newly added item. ) +/// , , 0, 0 ), +/// Add a new item to the tree. +/// @param parentId Item ID of parent to which to add the item as a child. 0 is root item. +/// @param text Text to display on the item in the tree. +/// @param value Behind-the-scenes value of the item. +/// @param icon +/// @param normalImage +/// @param expandedImage +/// @return The ID of the newly added item. ) +/// /// public int fnGuiTreeViewCtrl_insertItem (string guitreeviewctrl, int parentId, string text, string value, string icon, int normalImage, int expandedImage) @@ -25941,6 +32831,7 @@ public int fnGuiTreeViewCtrl_insertItem (string guitreeviewctrl, int parentId, s } /// /// Inserts object as a child to the given parent. ) +/// /// public int fnGuiTreeViewCtrl_insertObject (string guitreeviewctrl, int parentId, string obj, bool OKToEdit) @@ -25957,7 +32848,10 @@ public int fnGuiTreeViewCtrl_insertObject (string guitreeviewctrl, int parentId, return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_insertObject(sbguitreeviewctrl, parentId, sbobj, OKToEdit); } /// -/// Check whether the given item is currently selected in the tree. @param id Item/object ID. @return True if the given item/object is currently selected in the tree. ) +/// Check whether the given item is currently selected in the tree. +/// @param id Item/object ID. +/// @return True if the given item/object is currently selected in the tree. ) +/// /// public bool fnGuiTreeViewCtrl_isItemSelected (string guitreeviewctrl, int id) @@ -25971,7 +32865,10 @@ public bool fnGuiTreeViewCtrl_isItemSelected (string guitreeviewctrl, int id) return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_isItemSelected(sbguitreeviewctrl, id)>=1; } /// -/// Set whether the current selection can be changed by the user or not. @param lock If true, the current selection is frozen and cannot be changed. If false, the selection may be modified. ) +/// Set whether the current selection can be changed by the user or not. +/// @param lock If true, the current selection is frozen and cannot be changed. If false, +/// the selection may be modified. ) +/// /// public void fnGuiTreeViewCtrl_lockSelection (string guitreeviewctrl, bool lockx) @@ -25985,7 +32882,12 @@ public void fnGuiTreeViewCtrl_lockSelection (string guitreeviewctrl, bool lockx) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_lockSelection(sbguitreeviewctrl, lockx); } /// -/// Set the pattern by which to filter items in the tree. Only items in the tree whose text matches this pattern are displayed. @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. @see getFilterText @see clearFilterText ) +/// Set the pattern by which to filter items in the tree. Only items in the tree whose text +/// matches this pattern are displayed. +/// @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. +/// @see getFilterText +/// @see clearFilterText ) +/// /// public void fnGuiTreeViewCtrl_setFilterText (string guitreeviewctrl, string pattern) @@ -26003,6 +32905,7 @@ public void fnGuiTreeViewCtrl_setFilterText (string guitreeviewctrl, string patt } /// /// Toggle the hidden state of all objects in the current selection. ) +/// /// public void fnGuiTreeViewCtrl_toggleHideSelection (string guitreeviewctrl) @@ -26017,6 +32920,7 @@ public void fnGuiTreeViewCtrl_toggleHideSelection (string guitreeviewctrl) } /// /// Toggle the locked state of all objects in the current selection. ) +/// /// public void fnGuiTreeViewCtrl_toggleLockSelection (string guitreeviewctrl) @@ -26030,7 +32934,10 @@ public void fnGuiTreeViewCtrl_toggleLockSelection (string guitreeviewctrl) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_toggleLockSelection(sbguitreeviewctrl); } /// -/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. @param radius Radius in world-space units which should fit in the view. @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. +/// @param radius Radius in world-space units which should fit in the view. +/// @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// /// public float fnGuiTSCtrl_calculateViewDistance (string guitsctrl, float radius) @@ -26045,6 +32952,7 @@ public float fnGuiTSCtrl_calculateViewDistance (string guitsctrl, float radius) } /// /// ) +/// /// public string fnGuiTSCtrl_getClickVector (string guitsctrl, string mousePoint) @@ -26065,6 +32973,7 @@ public string fnGuiTSCtrl_getClickVector (string guitsctrl, string mousePoint) } /// /// ) +/// /// public string fnGuiTSCtrl_getWorldPosition (string guitsctrl, string mousePoint) @@ -26084,7 +32993,9 @@ public string fnGuiTSCtrl_getWorldPosition (string guitsctrl, string mousePoint) } /// -/// Get the ratio between world-space units and pixels. @return The amount of world-space units covered by the extent of a single pixel. ) +/// Get the ratio between world-space units and pixels. +/// @return The amount of world-space units covered by the extent of a single pixel. ) +/// /// public string fnGuiTSCtrl_getWorldToScreenScale (string guitsctrl) @@ -26101,7 +33012,10 @@ public string fnGuiTSCtrl_getWorldToScreenScale (string guitsctrl) } /// -/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. @param worldPosition The world-space position to transform to screen-space. @return The ) +/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. +/// @param worldPosition The world-space position to transform to screen-space. +/// @return The ) +/// /// public string fnGuiTSCtrl_project (string guitsctrl, string worldPosition) @@ -26121,7 +33035,11 @@ public string fnGuiTSCtrl_project (string guitsctrl, string worldPosition) } /// -/// Transform 3D screen-space coordinates (x, y, depth) to world space. This method can be, for example, used to find the world-space position relating to the current mouse cursor position. @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. @return The world-space position corresponding to the given screen-space coordinates. ) +/// Transform 3D screen-space coordinates (x, y, depth) to world space. +/// This method can be, for example, used to find the world-space position relating to the current mouse cursor position. +/// @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. +/// @return The world-space position corresponding to the given screen-space coordinates. ) +/// /// public string fnGuiTSCtrl_unproject (string guitsctrl, string screenPosition) @@ -26142,6 +33060,7 @@ public string fnGuiTSCtrl_unproject (string guitsctrl, string screenPosition) } /// /// ) +/// /// public void fnGuiWindowCtrl_attachTo (string guiwindowctrl, string window) @@ -26159,6 +33078,7 @@ public void fnGuiWindowCtrl_attachTo (string guiwindowctrl, string window) } /// /// Puts the guiwindow back on the main canvas. ) +/// /// public void fnGuiWindowCtrl_ClosePopOut (string guiwindowctrl) @@ -26173,6 +33093,7 @@ public void fnGuiWindowCtrl_ClosePopOut (string guiwindowctrl) } /// /// Returns the title of the window. ) +/// /// public string fnGuiWindowCtrl_getWindowTitle (string guiwindowctrl) @@ -26190,6 +33111,7 @@ public string fnGuiWindowCtrl_getWindowTitle (string guiwindowctrl) } /// /// Returns if the title can be set or not. ) +/// /// public bool fnGuiWindowCtrl_isTitleSet (string guiwindowctrl) @@ -26204,6 +33126,7 @@ public bool fnGuiWindowCtrl_isTitleSet (string guiwindowctrl) } /// /// Puts the guiwindow on a new canvas. ) +/// /// public void fnGuiWindowCtrl_OpenPopOut (string guiwindowctrl) @@ -26218,6 +33141,7 @@ public void fnGuiWindowCtrl_OpenPopOut (string guiwindowctrl) } /// /// Bring the window to the front. ) +/// /// public void fnGuiWindowCtrl_selectWindow (string guiwindowctrl) @@ -26232,6 +33156,7 @@ public void fnGuiWindowCtrl_selectWindow (string guiwindowctrl) } /// /// Set the window's collapsing state. ) +/// /// public void fnGuiWindowCtrl_setCollapseGroup (string guiwindowctrl, bool state) @@ -26246,6 +33171,7 @@ public void fnGuiWindowCtrl_setCollapseGroup (string guiwindowctrl, bool state) } /// /// Displays the option to set the title of the window. ) +/// /// public void fnGuiWindowCtrl_setContextTitle (string guiwindowctrl, bool title) @@ -26260,6 +33186,7 @@ public void fnGuiWindowCtrl_setContextTitle (string guiwindowctrl, bool title) } /// /// Sets the title of the window. ) +/// /// public void fnGuiWindowCtrl_setWindowTitle (string guiwindowctrl, string title) @@ -26277,6 +33204,7 @@ public void fnGuiWindowCtrl_setWindowTitle (string guiwindowctrl, string title) } /// /// Toggle the window collapsing. ) +/// /// public void fnGuiWindowCtrl_toggleCollapseGroup (string guiwindowctrl) @@ -26290,7 +33218,28 @@ public void fnGuiWindowCtrl_toggleCollapseGroup (string guiwindowctrl) SafeNativeMethods.mwle_fnGuiWindowCtrl_toggleCollapseGroup(sbguiwindowctrl); } /// -/// ), @brief Send a GET command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Send the GET command to the server %httpObj.get(%url,%URI,%query); @endtsexample ) +/// ), +/// @brief Send a GET command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Send the GET command to the server +/// %httpObj.get(%url,%URI,%query); +/// @endtsexample +/// ) +/// /// public void fnHTTPObject_get (string httpobject, string Address, string requirstURI, string query) @@ -26313,7 +33262,31 @@ public void fnHTTPObject_get (string httpobject, string Address, string requirst SafeNativeMethods.mwle_fnHTTPObject_get(sbhttpobject, sbAddress, sbrequirstURI, sbquery); } /// -/// @brief Send POST command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. @param post Submission data to be processed. @note The post() method is currently non-functional. @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Specify the submission data. %post = \"\"; // Send the POST command to the server %httpObj.POST(%url,%URI,%query,%post); @endtsexample ) +/// @brief Send POST command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// @param post Submission data to be processed. +/// +/// @note The post() method is currently non-functional. +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Specify the submission data. +/// %post = \"\"; +/// // Send the POST command to the server +/// %httpObj.POST(%url,%URI,%query,%post); +/// @endtsexample +/// ) +/// /// public void fnHTTPObject_post (string httpobject, string Address, string requirstURI, string query, string post) @@ -26339,7 +33312,15 @@ public void fnHTTPObject_post (string httpobject, string Address, string requirs SafeNativeMethods.mwle_fnHTTPObject_post(sbhttpobject, sbAddress, sbrequirstURI, sbquery, sbpost); } /// -/// @brief Get the normal of the surface on which the object is stuck. @return Returns The XYZ normal from where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the normal of the surface on which the object is stuck. +/// @return Returns The XYZ normal from where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string fnItem_getLastStickyNormal (string item) @@ -26356,7 +33337,15 @@ public string fnItem_getLastStickyNormal (string item) } /// -/// @brief Get the position on the surface on which this Item is stuck. @return Returns The XYZ position of where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the position on the surface on which this Item is stuck. +/// @return Returns The XYZ position of where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string fnItem_getLastStickyPos (string item) @@ -26373,7 +33362,14 @@ public string fnItem_getLastStickyPos (string item) } /// -/// @brief Is the object at rest (ie, no longer moving)? @return True if the object is at rest, false if it is not. @tsexample // Query the item on if it is or is not at rest. %isAtRest = %item.isAtRest(); @endtsexample ) +/// @brief Is the object at rest (ie, no longer moving)? +/// @return True if the object is at rest, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not at rest. +/// %isAtRest = %item.isAtRest(); +/// @endtsexample +/// ) +/// /// public bool fnItem_isAtRest (string item) @@ -26387,7 +33383,15 @@ public bool fnItem_isAtRest (string item) return SafeNativeMethods.mwle_fnItem_isAtRest(sbitem)>=1; } /// -/// @brief Is the object still rotating? @return True if the object is still rotating, false if it is not. @tsexample // Query the item on if it is or is not rotating. %isRotating = %itemData.isRotating(); @endtsexample @see rotate ) +/// @brief Is the object still rotating? +/// @return True if the object is still rotating, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not rotating. +/// %isRotating = %itemData.isRotating(); +/// @endtsexample +/// @see rotate +/// ) +/// /// public bool fnItem_isRotating (string item) @@ -26401,7 +33405,15 @@ public bool fnItem_isRotating (string item) return SafeNativeMethods.mwle_fnItem_isRotating(sbitem)>=1; } /// -/// @brief Is the object static (ie, non-movable)? @return True if the object is static, false if it is not. @tsexample // Query the item on if it is or is not static. %isStatic = %itemData.isStatic(); @endtsexample @see static ) +/// @brief Is the object static (ie, non-movable)? +/// @return True if the object is static, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not static. +/// %isStatic = %itemData.isStatic(); +/// @endtsexample +/// @see static +/// ) +/// /// public bool fnItem_isStatic (string item) @@ -26415,7 +33427,23 @@ public bool fnItem_isStatic (string item) return SafeNativeMethods.mwle_fnItem_isStatic(sbitem)>=1; } /// -/// @brief Temporarily disable collisions against a specific ShapeBase object. This is useful to prevent a player from immediately picking up an Item they have just thrown. Only one object may be on the timeout list at a time. The timeout is defined as 15 ticks. @param objectID ShapeBase object ID to disable collisions against. @return Returns true if the ShapeBase object requested could be found, false if it could not. @tsexample // Set the ShapeBase Object ID to disable collisions against %ignoreColObj = %player.getID(); // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. %item.setCollisionTimeout(%ignoreColObj); @endtsexample ) +/// @brief Temporarily disable collisions against a specific ShapeBase object. +/// +/// This is useful to prevent a player from immediately picking up an Item they have +/// just thrown. Only one object may be on the timeout list at a time. The timeout is +/// defined as 15 ticks. +/// +/// @param objectID ShapeBase object ID to disable collisions against. +/// @return Returns true if the ShapeBase object requested could be found, false if it could not. +/// +/// @tsexample +/// // Set the ShapeBase Object ID to disable collisions against +/// %ignoreColObj = %player.getID(); +/// // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. +/// %item.setCollisionTimeout(%ignoreColObj); +/// @endtsexample +/// ) +/// /// public bool fnItem_setCollisionTimeout (string item, int ignoreColObj) @@ -26430,6 +33458,7 @@ public bool fnItem_setCollisionTimeout (string item, int ignoreColObj) } /// /// ( LevelInfo, setNearClip, void, 3, 3, ( F32 nearClip )) +/// /// public void fnLevelInfo_setNearClip (string levelinfo, string a2) @@ -26446,7 +33475,19 @@ public void fnLevelInfo_setNearClip (string levelinfo, string a2) SafeNativeMethods.mwle_fnLevelInfo_setNearClip(sblevelinfo, sba2); } /// -/// @brief Toggles the light on and off @param state Turns the light on (true) or off (false) @tsexample // Disable the light CrystalLight.setLightEnabled(false); // Renable the light CrystalLight.setLightEnabled(true); @endtsexample) +/// @brief Toggles the light on and off +/// +/// @param state Turns the light on (true) or off (false) +/// +/// @tsexample +/// // Disable the light +/// CrystalLight.setLightEnabled(false); +/// // Renable the light +/// CrystalLight.setLightEnabled(true); +/// +/// @endtsexample +/// ) +/// /// public void fnLightBase_setLightEnabled (string lightbase, bool state) @@ -26460,7 +33501,22 @@ public void fnLightBase_setLightEnabled (string lightbase, bool state) SafeNativeMethods.mwle_fnLightBase_setLightEnabled(sblightbase, state); } /// -/// @brief Force an inspectPostApply call for the benefit of tweaking via the console Normally this functionality is only exposed to objects via the World Editor, once changes have been made. Exposing apply to script allows you to make changes to it on the fly without the World Editor. @note This is intended for debugging and tweaking, not for game play @tsexample // Change a property of the light description RocketLauncherLightDesc.brightness = 10; // Make it so RocketLauncherLightDesc.apply(); @endtsexample) +/// @brief Force an inspectPostApply call for the benefit of tweaking via the console +/// +/// Normally this functionality is only exposed to objects via the World Editor, once changes have been made. +/// Exposing apply to script allows you to make changes to it on the fly without the World Editor. +/// +/// @note This is intended for debugging and tweaking, not for game play +/// +/// @tsexample +/// // Change a property of the light description +/// RocketLauncherLightDesc.brightness = 10; +/// // Make it so +/// RocketLauncherLightDesc.apply(); +/// +/// @endtsexample +/// ) +/// /// public void fnLightDescription_apply (string lightdescription) @@ -26474,7 +33530,10 @@ public void fnLightDescription_apply (string lightdescription) SafeNativeMethods.mwle_fnLightDescription_apply(sblightdescription); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply +/// ) +/// /// public void fnLightFlareData_apply (string lightflaredata) @@ -26488,7 +33547,9 @@ public void fnLightFlareData_apply (string lightflaredata) SafeNativeMethods.mwle_fnLightFlareData_apply(sblightflaredata); } /// -/// Creates a LightningStrikeEvent which strikes a specific object. @note This method is currently unimplemented. ) +/// Creates a LightningStrikeEvent which strikes a specific object. +/// @note This method is currently unimplemented. ) +/// /// public void fnLightning_strikeObject (string lightning, string pSB) @@ -26505,7 +33566,13 @@ public void fnLightning_strikeObject (string lightning, string pSB) SafeNativeMethods.mwle_fnLightning_strikeObject(sblightning, sbpSB); } /// -/// Creates a LightningStrikeEvent which attempts to strike and damage a random object in range of the Lightning object. @tsexample // Generate a damaging lightning strike effect on all clients %lightning.strikeRandomPoint(); @endtsexample ) +/// Creates a LightningStrikeEvent which attempts to strike and damage a random +/// object in range of the Lightning object. +/// @tsexample +/// // Generate a damaging lightning strike effect on all clients +/// %lightning.strikeRandomPoint(); +/// @endtsexample ) +/// /// public void fnLightning_strikeRandomPoint (string lightning) @@ -26519,7 +33586,14 @@ public void fnLightning_strikeRandomPoint (string lightning) SafeNativeMethods.mwle_fnLightning_strikeRandomPoint(sblightning); } /// -/// @brief Creates a LightningStrikeEvent that triggers harmless lightning bolts on all clients. No objects will be damaged by these bolts. @tsexample // Generate a harmless lightning strike effect on all clients %lightning.warningFlashes(); @endtsexample ) +/// @brief Creates a LightningStrikeEvent that triggers harmless lightning +/// bolts on all clients. +/// No objects will be damaged by these bolts. +/// @tsexample +/// // Generate a harmless lightning strike effect on all clients +/// %lightning.warningFlashes(); +/// @endtsexample ) +/// /// public void fnLightning_warningFlashes (string lightning) @@ -26533,7 +33607,11 @@ public void fnLightning_warningFlashes (string lightning) SafeNativeMethods.mwle_fnLightning_warningFlashes(sblightning); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void fnMeshRoad_postApply (string meshroad) @@ -26547,7 +33625,10 @@ public void fnMeshRoad_postApply (string meshroad) SafeNativeMethods.mwle_fnMeshRoad_postApply(sbmeshroad); } /// -/// Intended as a helper to developers and editor scripts. Force MeshRoad to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force MeshRoad to recreate its geometry. +/// ) +/// /// public void fnMeshRoad_regenerate (string meshroad) @@ -26561,7 +33642,10 @@ public void fnMeshRoad_regenerate (string meshroad) SafeNativeMethods.mwle_fnMeshRoad_regenerate(sbmeshroad); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void fnMeshRoad_setNodeDepth (string meshroad, int idx, float meters) @@ -26575,7 +33659,11 @@ public void fnMeshRoad_setNodeDepth (string meshroad, int idx, float meters) SafeNativeMethods.mwle_fnMeshRoad_setNodeDepth(sbmeshroad, idx, meters); } /// -/// Clear all messages in the vector @tsexample HudMessageVector.clear(); @endtsexample) +/// Clear all messages in the vector +/// @tsexample +/// HudMessageVector.clear(); +/// @endtsexample) +/// /// public void fnMessageVector_clear (string messagevector) @@ -26589,7 +33677,14 @@ public void fnMessageVector_clear (string messagevector) SafeNativeMethods.mwle_fnMessageVector_clear(sbmessagevector); } /// -/// Delete the line at the specified position. @param deletePos Position in the vector containing the line to be deleted @tsexample // Delete the first line (index 0) in the vector... HudMessageVector.deleteLine(0); @endtsexample @return False if deletePos is greater than the number of lines in the current vector) +/// Delete the line at the specified position. +/// @param deletePos Position in the vector containing the line to be deleted +/// @tsexample +/// // Delete the first line (index 0) in the vector... +/// HudMessageVector.deleteLine(0); +/// @endtsexample +/// @return False if deletePos is greater than the number of lines in the current vector) +/// /// public bool fnMessageVector_deleteLine (string messagevector, int deletePos) @@ -26603,7 +33698,15 @@ public bool fnMessageVector_deleteLine (string messagevector, int deletePos) return SafeNativeMethods.mwle_fnMessageVector_deleteLine(sbmessagevector, deletePos)>=1; } /// -/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate a line of text tagged with the value \"1\", then delete it. %taggedLine = HudMessageVector.getLineIndexByTag(1); HudMessageVector.deleteLine(%taggedLine); @endtsexample @return Line with matching tag, other wise -1) +/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate a line of text tagged with the value \"1\", then delete it. +/// %taggedLine = HudMessageVector.getLineIndexByTag(1); +/// HudMessageVector.deleteLine(%taggedLine); +/// @endtsexample +/// @return Line with matching tag, other wise -1) +/// /// public int fnMessageVector_getLineIndexByTag (string messagevector, int tag) @@ -26617,7 +33720,20 @@ public int fnMessageVector_getLineIndexByTag (string messagevector, int tag) return SafeNativeMethods.mwle_fnMessageVector_getLineIndexByTag(sbmessagevector, tag); } /// -/// Get the tag of a specified line. @param pos Position in vector to grab tag from @tsexample // Remove all lines that do not have a tag value of 1. while( HudMessageVector.getNumLines()) { %tag = HudMessageVector.getLineTag(1); if(%tag != 1) %tag.delete(); HudMessageVector.popFrontLine(); } @endtsexample @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// Get the tag of a specified line. +/// @param pos Position in vector to grab tag from +/// @tsexample +/// // Remove all lines that do not have a tag value of 1. +/// while( HudMessageVector.getNumLines()) +/// { +/// %tag = HudMessageVector.getLineTag(1); +/// if(%tag != 1) +/// %tag.delete(); +/// HudMessageVector.popFrontLine(); +/// } +/// @endtsexample +/// @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// /// public int fnMessageVector_getLineTag (string messagevector, int pos) @@ -26631,7 +33747,15 @@ public int fnMessageVector_getLineTag (string messagevector, int pos) return SafeNativeMethods.mwle_fnMessageVector_getLineTag(sbmessagevector, pos); } /// -/// Get the text at a specified line. @param pos Position in vector to grab text from @tsexample // Print a line of text at position 1. %text = HudMessageVector.getLineText(1); echo(%text); @endtsexample @return Text at specified line, if the position is greater than the number of lines return \"\") +/// Get the text at a specified line. +/// @param pos Position in vector to grab text from +/// @tsexample +/// // Print a line of text at position 1. +/// %text = HudMessageVector.getLineText(1); +/// echo(%text); +/// @endtsexample +/// @return Text at specified line, if the position is greater than the number of lines return \"\") +/// /// public string fnMessageVector_getLineText (string messagevector, int pos) @@ -26648,7 +33772,15 @@ public string fnMessageVector_getLineText (string messagevector, int pos) } /// -/// Scan through the lines in the vector, returning the first line that has a matching tag. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate text in the vector tagged with the value \"1\", then print it %taggedText = HudMessageVector.getLineTextByTag(1); echo(%taggedText); @endtsexample @return Text from a line with matching tag, other wise \"\") +/// Scan through the lines in the vector, returning the first line that has a matching tag. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate text in the vector tagged with the value \"1\", then print it +/// %taggedText = HudMessageVector.getLineTextByTag(1); +/// echo(%taggedText); +/// @endtsexample +/// @return Text from a line with matching tag, other wise \"\") +/// /// public string fnMessageVector_getLineTextByTag (string messagevector, int tag) @@ -26665,7 +33797,13 @@ public string fnMessageVector_getLineTextByTag (string messagevector, int tag) } /// -/// Get the number of lines in the vector. @tsexample // Find out how many lines have been stored in HudMessageVector %chatLines = HudMessageVector.getNumLines(); echo(%chatLines); @endtsexample) +/// Get the number of lines in the vector. +/// @tsexample +/// // Find out how many lines have been stored in HudMessageVector +/// %chatLines = HudMessageVector.getNumLines(); +/// echo(%chatLines); +/// @endtsexample) +/// /// public int fnMessageVector_getNumLines (string messagevector) @@ -26679,7 +33817,15 @@ public int fnMessageVector_getNumLines (string messagevector) return SafeNativeMethods.mwle_fnMessageVector_getNumLines(sbmessagevector); } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.insertLine(1, \"Hello World\", 0); @endtsexample @return False if insertPos is greater than the number of lines in the current vector) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.insertLine(1, \"Hello World\", 0); +/// @endtsexample +/// @return False if insertPos is greater than the number of lines in the current vector) +/// /// public bool fnMessageVector_insertLine (string messagevector, int insertPos, string msg, int tag) @@ -26696,7 +33842,12 @@ public bool fnMessageVector_insertLine (string messagevector, int insertPos, str return SafeNativeMethods.mwle_fnMessageVector_insertLine(sbmessagevector, insertPos, sbmsg, tag)>=1; } /// -/// Pop a line from the back of the list; destroys the line. @tsexample HudMessageVector.popBackLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the back of the list; destroys the line. +/// @tsexample +/// HudMessageVector.popBackLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool fnMessageVector_popBackLine (string messagevector) @@ -26710,7 +33861,12 @@ public bool fnMessageVector_popBackLine (string messagevector) return SafeNativeMethods.mwle_fnMessageVector_popBackLine(sbmessagevector)>=1; } /// -/// Pop a line from the front of the vector, destroying the line. @tsexample HudMessageVector.popFrontLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the front of the vector, destroying the line. +/// @tsexample +/// HudMessageVector.popFrontLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool fnMessageVector_popFrontLine (string messagevector) @@ -26724,7 +33880,14 @@ public bool fnMessageVector_popFrontLine (string messagevector) return SafeNativeMethods.mwle_fnMessageVector_popFrontLine(sbmessagevector)>=1; } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushBackLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushBackLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void fnMessageVector_pushBackLine (string messagevector, string msg, int tag) @@ -26741,7 +33904,14 @@ public void fnMessageVector_pushBackLine (string messagevector, string msg, int SafeNativeMethods.mwle_fnMessageVector_pushBackLine(sbmessagevector, sbmsg, tag); } /// -/// Push a line onto the front of the vector. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushFrontLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the front of the vector. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushFrontLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void fnMessageVector_pushFrontLine (string messagevector, string msg, int tag) @@ -26759,6 +33929,7 @@ public void fnMessageVector_pushFrontLine (string messagevector, string msg, int } /// /// Returns 4 fields: starting x, starting y, extents x, extents y.) +/// /// public string fnMissionArea_getArea (string missionarea) @@ -26775,7 +33946,11 @@ public string fnMissionArea_getArea (string missionarea) } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void fnMissionArea_postApply (string missionarea) @@ -26789,7 +33964,14 @@ public void fnMissionArea_postApply (string missionarea) SafeNativeMethods.mwle_fnMissionArea_postApply(sbmissionarea); } /// -/// @brief - Defines the size of the MissionArea param x Starting X coordinate position for MissionArea param y Starting Y coordinate position for MissionArea param width New width of the MissionArea param height New height of the MissionArea @note Only the server object may be set. ) +/// @brief - Defines the size of the MissionArea +/// param x Starting X coordinate position for MissionArea +/// param y Starting Y coordinate position for MissionArea +/// param width New width of the MissionArea +/// param height New height of the MissionArea +/// @note Only the server object may be set. +/// ) +/// /// public void fnMissionArea_setArea (string missionarea, int x, int y, int width, int height) @@ -27191,7 +34373,15 @@ public int fnNavPath_size (string navpath) return SafeNativeMethods.mwle_fnNavPath_size(sbnavpath); } /// -/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. This method is normally only called when a NetConnection class is first constructed. It need only be manually called if the global variables that set the packet rate or size have changed. @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize have been changed since a NetConnection has been created, this method must be called on all connections for them to follow the new rates or size.) +/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. +/// +/// This method is normally only called when a NetConnection class is first constructed. It need +/// only be manually called if the global variables that set the packet rate or size have changed. +/// +/// @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize +/// have been changed since a NetConnection has been created, this method must be called on +/// all connections for them to follow the new rates or size.) +/// /// public void fnNetConnection_checkMaxRate (string netconnection) @@ -27205,7 +34395,27 @@ public void fnNetConnection_checkMaxRate (string netconnection) SafeNativeMethods.mwle_fnNetConnection_checkMaxRate(sbnetconnection); } /// -/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that motion spline paths have not been transmitted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see transmitPaths() @see Path) +/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that motion spline paths have not been transmitted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see transmitPaths() +/// @see Path) +/// /// public void fnNetConnection_clearPaths (string netconnection) @@ -27219,7 +34429,23 @@ public void fnNetConnection_clearPaths (string netconnection) SafeNativeMethods.mwle_fnNetConnection_clearPaths(sbnetconnection); } /// -/// @brief Connects to the remote address. Attempts to connect with another NetConnection on the given address. Typically once connected, a game's information is passed along from the server to the client, followed by the player entering the game world. The actual procedure is dependent on the NetConnection subclass that is used. i.e. GameConnection. @param remoteAddress The address to connect to in the form of IP:address>:port although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also substitue the word i>broadcast/i> for the address to broadcast the connect request over the local subnet. @see NetConnection::connectLocal() to connect to a server running within the same process as the client. ) +/// @brief Connects to the remote address. +/// +/// Attempts to connect with another NetConnection on the given address. Typically once +/// connected, a game's information is passed along from the server to the client, followed +/// by the player entering the game world. The actual procedure is dependent on +/// the NetConnection subclass that is used. i.e. GameConnection. +/// +/// @param remoteAddress The address to connect to in the form of IP:address>:port +/// although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form +/// of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also +/// substitue the word i>broadcast/i> for the address to broadcast the connect request over +/// the local subnet. +/// +/// @see NetConnection::connectLocal() to connect to a server running within the same process +/// as the client. +/// ) +/// /// public void fnNetConnection_connect (string netconnection, string remoteAddress) @@ -27236,7 +34462,13 @@ public void fnNetConnection_connect (string netconnection, string remoteAddress) SafeNativeMethods.mwle_fnNetConnection_connect(sbnetconnection, sbremoteAddress); } /// -/// @brief Connects with the server that is running within the same process as the client. @returns An error text message upon failure, or an empty string when successful. @see See @ref local_connections for a description of local connections and their use. See NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// @brief Connects with the server that is running within the same process as the client. +/// +/// @returns An error text message upon failure, or an empty string when successful. +/// +/// @see See @ref local_connections for a description of local connections and their use. See +/// NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// /// public string fnNetConnection_connectLocal (string netconnection) @@ -27253,7 +34485,13 @@ public string fnNetConnection_connectLocal (string netconnection) } /// -/// @brief Returns the far end network address for the connection. The address will be in one of the following forms: - b>IP:Broadcast:port>/b> for broadcast type addresses - b>IP:address>:port>/b> for IP addresses - b>local/b> when connected locally (server and client running in same process) +/// @brief Returns the far end network address for the connection. +/// +/// The address will be in one of the following forms: +/// - b>IP:Broadcast:port>/b> for broadcast type addresses +/// - b>IP:address>:port>/b> for IP addresses +/// - b>local/b> when connected locally (server and client running in same process) +/// /// public string fnNetConnection_getAddress (string netconnection) @@ -27270,7 +34508,16 @@ public string fnNetConnection_getAddress (string netconnection) } /// -/// @brief On server or client, convert a real id to the ghost id for this connection. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server or client to discover an object's ghost ID based on its real SimObject ID. @param realID The real SimObject ID of the object. @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On server or client, convert a real id to the ghost id for this connection. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server or client to discover an object's ghost ID based on its real SimObject ID. +/// +/// @param realID The real SimObject ID of the object. +/// @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_getGhostID (string netconnection, int realID) @@ -27303,7 +34550,10 @@ public int fnNetConnection_GetGhostIndex (string netconnection, string obj) return SafeNativeMethods.mwle_fnNetConnection_GetGhostIndex(sbnetconnection, sbobj); } /// -/// @brief Provides the number of active ghosts on the connection. @returns The number of active ghosts. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Provides the number of active ghosts on the connection. +/// @returns The number of active ghosts. +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_getGhostsActive (string netconnection) @@ -27317,7 +34567,10 @@ public int fnNetConnection_getGhostsActive (string netconnection) return SafeNativeMethods.mwle_fnNetConnection_getGhostsActive(sbnetconnection); } /// -/// @brief Returns the percentage of packets lost per tick. @note This method is not yet hooked up.) +/// @brief Returns the percentage of packets lost per tick. +/// +/// @note This method is not yet hooked up.) +/// /// public int fnNetConnection_getPacketLoss (string netconnection) @@ -27331,7 +34584,12 @@ public int fnNetConnection_getPacketLoss (string netconnection) return SafeNativeMethods.mwle_fnNetConnection_getPacketLoss(sbnetconnection); } /// -/// @brief Returns the average round trip time (in ms) for the connection. The round trip time is recalculated every time a notify packet is received. Notify packets are used to information the connection that the far end successfully received the sent packet.) +/// @brief Returns the average round trip time (in ms) for the connection. +/// +/// The round trip time is recalculated every time a notify packet is received. Notify +/// packets are used to information the connection that the far end successfully received +/// the sent packet.) +/// /// public int fnNetConnection_getPing (string netconnection) @@ -27361,7 +34619,21 @@ public int fnNetConnection_ResolveGhost (string netconnection, int ghostIndex) return SafeNativeMethods.mwle_fnNetConnection_ResolveGhost(sbnetconnection, ghostIndex); } /// -/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the client to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = ServerConnection.resolveGhostID( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the client to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = ServerConnection.resolveGhostID( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_resolveGhostID (string netconnection, int ghostID) @@ -27375,7 +34647,21 @@ public int fnNetConnection_resolveGhostID (string netconnection, int ghostID) return SafeNativeMethods.mwle_fnNetConnection_resolveGhostID(sbnetconnection, ghostID); } /// -/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = %client.resolveObjectFromGhostIndex( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = %client.resolveObjectFromGhostIndex( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_resolveObjectFromGhostIndex (string netconnection, int ghostID) @@ -27389,7 +34675,12 @@ public int fnNetConnection_resolveObjectFromGhostIndex (string netconnection, in return SafeNativeMethods.mwle_fnNetConnection_resolveObjectFromGhostIndex(sbnetconnection, ghostID); } /// -/// @brief Simulate network issues on the connection for testing. @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute integer, measured in ms.) +/// @brief Simulate network issues on the connection for testing. +/// +/// @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) +/// @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute +/// integer, measured in ms.) +/// /// public void fnNetConnection_setSimulatedNetParams (string netconnection, float packetLoss, int delay) @@ -27403,7 +34694,44 @@ public void fnNetConnection_setSimulatedNetParams (string netconnection, float p SafeNativeMethods.mwle_fnNetConnection_setSimulatedNetParams(sbnetconnection, packetLoss, delay); } /// -/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. The server transmits all spline motion paths that are within the mission (Path) separate from other objects. This is due to the potentially large number of nodes within each path, which may saturate a packet sent to the client. By managing this step separately, Torque has finer control over how packets are organised vs. doing it during the ghosting stage. Internally a PathManager is used to track all paths defined within a mission on the server, and each one is transmitted using a PathManagerEvent. The client side collects these events and builds the given paths within its own PathManager. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. When a mission is ended, all paths need to be cleared from their respective path managers. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mission paths (SimPath), this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see clearPaths() @see Path) +/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. +/// +/// The server transmits all spline motion paths that are within the mission (Path) separate from +/// other objects. This is due to the potentially large number of nodes within each path, which may +/// saturate a packet sent to the client. By managing this step separately, Torque has finer control +/// over how packets are organised vs. doing it during the ghosting stage. +/// +/// Internally a PathManager is used to track all paths defined within a mission on the server, and each +/// one is transmitted using a PathManagerEvent. The client side collects these events and builds the +/// given paths within its own PathManager. This is typically done during the standard mission start +/// phase 2 when following Torque's example mission startup sequence. +/// +/// When a mission is ended, all paths need to be cleared from their respective path managers. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mission paths (SimPath), this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see clearPaths() +/// @see Path) +/// /// public void fnNetConnection_transmitPaths (string netconnection) @@ -27417,7 +34745,12 @@ public void fnNetConnection_transmitPaths (string netconnection) SafeNativeMethods.mwle_fnNetConnection_transmitPaths(sbnetconnection); } /// -/// @brief Undo the effects of a scopeToClient() call. @param client The connection to remove this object's scoping from @see scopeToClient()) +/// @brief Undo the effects of a scopeToClient() call. +/// +/// @param client The connection to remove this object's scoping from +/// +/// @see scopeToClient()) +/// /// public void fnNetObject_clearScopeToClient (string netobject, string client) @@ -27434,7 +34767,22 @@ public void fnNetObject_clearScopeToClient (string netobject, string client) SafeNativeMethods.mwle_fnNetObject_clearScopeToClient(sbnetobject, sbclient); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. @returns the SimObject ID of the client object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %clientObject = %node.getClientObject(); if(isObject(%clientObject) %clientObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns the SimObject ID of the client object. +/// +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %clientObject = %node.getClientObject(); +/// if(isObject(%clientObject) +/// %clientObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int fnNetObject_getClientObject (string netobject) @@ -27448,7 +34796,14 @@ public int fnNetObject_getClientObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_getClientObject(sbnetobject); } /// -/// @brief Get the ghost index of this object from the server. @returns The ghost ID of this NetObject on the server @tsexample %ghostID = LocalClientConnection.getGhostId( %serverObject ); @endtsexample) +/// @brief Get the ghost index of this object from the server. +/// +/// @returns The ghost ID of this NetObject on the server +/// +/// @tsexample +/// %ghostID = LocalClientConnection.getGhostId( %serverObject ); +/// @endtsexample) +/// /// public int fnNetObject_getGhostID (string netobject) @@ -27462,7 +34817,21 @@ public int fnNetObject_getGhostID (string netobject) return SafeNativeMethods.mwle_fnNetObject_getGhostID(sbnetobject); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. @returns The SimObject ID of the server object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %serverObject = %node.getServerObject(); if(isObject(%serverObject) %serverObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns The SimObject ID of the server object. +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %serverObject = %node.getServerObject(); +/// if(isObject(%serverObject) +/// %serverObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int fnNetObject_getServerObject (string netobject) @@ -27476,7 +34845,9 @@ public int fnNetObject_getServerObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_getServerObject(sbnetobject); } /// -/// @brief Called to check if an object resides on the clientside. @return True if the object resides on the client, false otherwise.) +/// @brief Called to check if an object resides on the clientside. +/// @return True if the object resides on the client, false otherwise.) +/// /// public bool fnNetObject_isClientObject (string netobject) @@ -27490,7 +34861,9 @@ public bool fnNetObject_isClientObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_isClientObject(sbnetobject)>=1; } /// -/// @brief Checks if an object resides on the server. @return True if the object resides on the server, false otherwise.) +/// @brief Checks if an object resides on the server. +/// @return True if the object resides on the server, false otherwise.) +/// /// public bool fnNetObject_isServerObject (string netobject) @@ -27504,7 +34877,29 @@ public bool fnNetObject_isServerObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_isServerObject(sbnetobject)>=1; } /// -/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. @param client The connection this object will always be scoped to @tsexample // Called to create new cameras in TorqueScript // %this - The active GameConnection // %spawnPoint - The spawn point location where we creat the camera function GameConnection::spawnCamera(%this, %spawnPoint) { // If this connection's camera exists if(isObject(%this.camera)) { // Add it to the mission group to be cleaned up later MissionCleanup.add( %this.camera ); // Force it to scope to the client side %this.camera.scopeToClient(%this); } } @endtsexample @see clearScopeToClient()) +/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. +/// +/// @param client The connection this object will always be scoped to +/// +/// @tsexample +/// // Called to create new cameras in TorqueScript +/// // %this - The active GameConnection +/// // %spawnPoint - The spawn point location where we creat the camera +/// function GameConnection::spawnCamera(%this, %spawnPoint) +/// { +/// // If this connection's camera exists +/// if(isObject(%this.camera)) +/// { +/// // Add it to the mission group to be cleaned up later +/// MissionCleanup.add( %this.camera ); +/// // Force it to scope to the client side +/// %this.camera.scopeToClient(%this); +/// } +/// } +/// @endtsexample +/// +/// @see clearScopeToClient()) +/// /// public void fnNetObject_scopeToClient (string netobject, string client) @@ -27521,7 +34916,12 @@ public void fnNetObject_scopeToClient (string netobject, string client) SafeNativeMethods.mwle_fnNetObject_scopeToClient(sbnetobject, sbclient); } /// -/// @brief Always scope this object on all connections. The object is marked as ScopeAlways and is immediately ghosted to all active connections. This function has no effect if the object is not marked as Ghostable.) +/// @brief Always scope this object on all connections. +/// +/// The object is marked as ScopeAlways and is immediately ghosted to +/// all active connections. This function has no effect if the object +/// is not marked as Ghostable.) +/// /// public void fnNetObject_setScopeAlways (string netobject) @@ -27535,7 +34935,16 @@ public void fnNetObject_setScopeAlways (string netobject) SafeNativeMethods.mwle_fnNetObject_setScopeAlways(sbnetobject); } /// -/// Reloads this particle. @tsexample // Get the editor's current particle %particle = PE_ParticleEditor.currParticle // Change a particle value %particle.setFieldValue( %propertyField, %value ); // Reload it %particle.reload(); @endtsexample ) +/// Reloads this particle. +/// @tsexample +/// // Get the editor's current particle +/// %particle = PE_ParticleEditor.currParticle +/// // Change a particle value +/// %particle.setFieldValue( %propertyField, %value ); +/// // Reload it +/// %particle.reload(); +/// @endtsexample ) +/// /// public void fnParticleData_reload (string particledata) @@ -27549,7 +34958,16 @@ public void fnParticleData_reload (string particledata) SafeNativeMethods.mwle_fnParticleData_reload(sbparticledata); } /// -/// Reloads the ParticleData datablocks and other fields used by this emitter. @tsexample // Get the editor's current particle emitter %emitter = PE_EmitterEditor.currEmitter // Change a field value %emitter.setFieldValue( %propertyField, %value ); // Reload this emitter %emitter.reload(); @endtsexample) +/// Reloads the ParticleData datablocks and other fields used by this emitter. +/// @tsexample +/// // Get the editor's current particle emitter +/// %emitter = PE_EmitterEditor.currEmitter +/// // Change a field value +/// %emitter.setFieldValue( %propertyField, %value ); +/// // Reload this emitter +/// %emitter.reload(); +/// @endtsexample) +/// /// public void fnParticleEmitterData_reload (string particleemitterdata) @@ -27563,7 +34981,9 @@ public void fnParticleEmitterData_reload (string particleemitterdata) SafeNativeMethods.mwle_fnParticleEmitterData_reload(sbparticleemitterdata); } /// -/// Turns the emitter on or off. @param active New emitter state ) +/// Turns the emitter on or off. +/// @param active New emitter state ) +/// /// public void fnParticleEmitterNode_setActive (string particleemitternode, bool active) @@ -27577,7 +34997,13 @@ public void fnParticleEmitterNode_setActive (string particleemitternode, bool ac SafeNativeMethods.mwle_fnParticleEmitterNode_setActive(sbparticleemitternode, active); } /// -/// Assigns the datablock for this emitter node. @param emitterDatablock ParticleEmitterData datablock to assign @tsexample // Assign a new emitter datablock %emitter.setEmitterDatablock( %emitterDatablock ); @endtsexample ) +/// Assigns the datablock for this emitter node. +/// @param emitterDatablock ParticleEmitterData datablock to assign +/// @tsexample +/// // Assign a new emitter datablock +/// %emitter.setEmitterDatablock( %emitterDatablock ); +/// @endtsexample ) +/// /// public void fnParticleEmitterNode_setEmitterDataBlock (string particleemitternode, string emitterDatablock) @@ -27594,7 +35020,12 @@ public void fnParticleEmitterNode_setEmitterDataBlock (string particleemitternod SafeNativeMethods.mwle_fnParticleEmitterNode_setEmitterDataBlock(sbparticleemitternode, sbemitterDatablock); } /// -/// Removes the knot at the front of the camera's path. @tsexample // Remove the first knot in the camera's path. %pathCamera.popFront(); @endtsexample) +/// Removes the knot at the front of the camera's path. +/// @tsexample +/// // Remove the first knot in the camera's path. +/// %pathCamera.popFront(); +/// @endtsexample) +/// /// public void fnPathCamera_popFront (string pathcamera) @@ -27608,7 +35039,25 @@ public void fnPathCamera_popFront (string pathcamera) SafeNativeMethods.mwle_fnPathCamera_popFront(sbpathcamera); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the back of its path %pathCamera.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the back of its path +/// %pathCamera.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void fnPathCamera_pushBack (string pathcamera, string transform, float speed, string type, string path) @@ -27631,7 +35080,25 @@ public void fnPathCamera_pushBack (string pathcamera, string transform, float sp SafeNativeMethods.mwle_fnPathCamera_pushBack(sbpathcamera, sbtransform, speed, sbtype, sbpath); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the front of its path %pathCamera.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the front of its path +/// %pathCamera.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void fnPathCamera_pushFront (string pathcamera, string transform, float speed, string type, string path) @@ -27654,7 +35121,20 @@ public void fnPathCamera_pushFront (string pathcamera, string transform, float s SafeNativeMethods.mwle_fnPathCamera_pushFront(sbpathcamera, sbtransform, speed, sbtype, sbpath); } /// -/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. What specifically occurs is a new knot is created from the camera's current transform. Then the current path is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement state is set to Forward. The camera is now ready for a new path to be defined. @param speed Speed for the camera to move along its path after being reset. @tsexample //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. %speed = \"0.50\"; // Inform the path camera to start a new path at // the camera's current position, and set the new // path's speed value. %pathCamera.reset(%speed); @endtsexample) +/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. +/// What specifically occurs is a new knot is created from the camera's current transform. Then the current path +/// is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement +/// state is set to Forward. The camera is now ready for a new path to be defined. +/// @param speed Speed for the camera to move along its path after being reset. +/// @tsexample +/// //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. +/// %speed = \"0.50\"; +/// // Inform the path camera to start a new path at +/// // the camera's current position, and set the new +/// // path's speed value. +/// %pathCamera.reset(%speed); +/// @endtsexample) +/// /// public void fnPathCamera_reset (string pathcamera, float speed) @@ -27668,7 +35148,15 @@ public void fnPathCamera_reset (string pathcamera, float speed) SafeNativeMethods.mwle_fnPathCamera_reset(sbpathcamera, speed); } /// -/// Set the current position of the camera along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. @tsexample // Set the camera on a position along its path from 0.0 - 1.0. %position = \"0.35\"; // Force the pathCamera to its new position along the path. %pathCamera.setPosition(%position); @endtsexample) +/// Set the current position of the camera along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. +/// @tsexample +/// // Set the camera on a position along its path from 0.0 - 1.0. +/// %position = \"0.35\"; +/// // Force the pathCamera to its new position along the path. +/// %pathCamera.setPosition(%position); +/// @endtsexample) +/// /// public void fnPathCamera_setPosition (string pathcamera, float position) @@ -27682,7 +35170,17 @@ public void fnPathCamera_setPosition (string pathcamera, float position) SafeNativeMethods.mwle_fnPathCamera_setPosition(sbpathcamera, position); } /// -/// forward), Set the movement state for this path camera. @param newState New movement state type for this camera. Forward, Backward or Stop. @tsexample // Set the state type (forward, backward, stop). // In this example, the camera will travel from the first node // to the last node (or target if given with setTarget()) %state = \"forward\"; // Inform the pathCamera to change its movement state to the defined value. %pathCamera.setState(%state); @endtsexample) +/// forward), Set the movement state for this path camera. +/// @param newState New movement state type for this camera. Forward, Backward or Stop. +/// @tsexample +/// // Set the state type (forward, backward, stop). +/// // In this example, the camera will travel from the first node +/// // to the last node (or target if given with setTarget()) +/// %state = \"forward\"; +/// // Inform the pathCamera to change its movement state to the defined value. +/// %pathCamera.setState(%state); +/// @endtsexample) +/// /// public void fnPathCamera_setState (string pathcamera, string newState) @@ -27699,7 +35197,18 @@ public void fnPathCamera_setState (string pathcamera, string newState) SafeNativeMethods.mwle_fnPathCamera_setState(sbpathcamera, sbnewState); } /// -/// @brief Set the movement target for this camera along its path. The camera will attempt to move along the path to the given target in the direction provided by setState() (the default is forwards). Once the camera moves past this target it will come to a stop, and the target state will be cleared. @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. @tsexample // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. %position = \"0.50\"; // Inform the pathCamera of the new target position it will move to. %pathCamera.setTarget(%position); @endtsexample) +/// @brief Set the movement target for this camera along its path. +/// The camera will attempt to move along the path to the given target in the direction provided +/// by setState() (the default is forwards). Once the camera moves past this target it will come +/// to a stop, and the target state will be cleared. +/// @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. +/// @tsexample +/// // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. +/// %position = \"0.50\"; +/// // Inform the pathCamera of the new target position it will move to. +/// %pathCamera.setTarget(%position); +/// @endtsexample) +/// /// public void fnPathCamera_setTarget (string pathcamera, float position) @@ -27713,7 +35222,14 @@ public void fnPathCamera_setTarget (string pathcamera, float position) SafeNativeMethods.mwle_fnPathCamera_setTarget(sbpathcamera, position); } /// -/// Activate the physical zone's effects. @tsexample // Activate effects for a specific physical zone. %thisPhysicalZone.activate(); @endtsexample @ingroup Datablocks ) +/// Activate the physical zone's effects. +/// @tsexample +/// // Activate effects for a specific physical zone. +/// %thisPhysicalZone.activate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void fnPhysicalZone_activate (string physicalzone) @@ -27727,7 +35243,14 @@ public void fnPhysicalZone_activate (string physicalzone) SafeNativeMethods.mwle_fnPhysicalZone_activate(sbphysicalzone); } /// -/// Deactivate the physical zone's effects. @tsexample // Deactivate effects for a specific physical zone. %thisPhysicalZone.deactivate(); @endtsexample @ingroup Datablocks ) +/// Deactivate the physical zone's effects. +/// @tsexample +/// // Deactivate effects for a specific physical zone. +/// %thisPhysicalZone.deactivate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void fnPhysicalZone_deactivate (string physicalzone) @@ -27741,7 +35264,14 @@ public void fnPhysicalZone_deactivate (string physicalzone) SafeNativeMethods.mwle_fnPhysicalZone_deactivate(sbphysicalzone); } /// -/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. Performs a physics ray cast of the provided length and direction. The %PhysicsForce will attach itself to the first dynamic PhysicsBody the ray collides with. On every tick, the attached body will be attracted towards the position of the %PhysicsForce. A %PhysicsForce can only be attached to one body at a time. @note To determine if an %attach was successful, check isAttached() immediately after calling this function.n) +/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. +/// Performs a physics ray cast of the provided length and direction. The %PhysicsForce +/// will attach itself to the first dynamic PhysicsBody the ray collides with. +/// On every tick, the attached body will be attracted towards the position of the %PhysicsForce. +/// A %PhysicsForce can only be attached to one body at a time. +/// @note To determine if an %attach was successful, check isAttached() immediately after +/// calling this function.n) +/// /// public void fnPhysicsForce_attach (string physicsforce, string start, string direction, float maxDist) @@ -27761,7 +35291,11 @@ public void fnPhysicsForce_attach (string physicsforce, string start, string dir SafeNativeMethods.mwle_fnPhysicsForce_attach(sbphysicsforce, sbstart, sbdirection, maxDist); } /// -/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. @param force Optional force to apply to the attached PhysicsBody before detaching. @note Has no effect if the %PhysicsForce is not attached to anything.) +/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. +/// @param force Optional force to apply to the attached PhysicsBody +/// before detaching. +/// @note Has no effect if the %PhysicsForce is not attached to anything.) +/// /// public void fnPhysicsForce_detach (string physicsforce, string force) @@ -27778,7 +35312,9 @@ public void fnPhysicsForce_detach (string physicsforce, string force) SafeNativeMethods.mwle_fnPhysicsForce_detach(sbphysicsforce, sbforce); } /// -/// @brief Returns true if the %PhysicsForce is currently attached to an object. @see PhysicsForce::attach()) +/// @brief Returns true if the %PhysicsForce is currently attached to an object. +/// @see PhysicsForce::attach()) +/// /// public bool fnPhysicsForce_isAttached (string physicsforce) @@ -27792,7 +35328,12 @@ public bool fnPhysicsForce_isAttached (string physicsforce) return SafeNativeMethods.mwle_fnPhysicsForce_isAttached(sbphysicsforce)>=1; } /// -/// @brief Disables rendering and physical simulation. Calling destroy() will also spawn any explosions, debris, and/or destroyedShape defined for it, as well as remove it from the scene graph. Destroyed objects are only created on the server. Ghosting will later update the client. @note This does not actually delete the PhysicsShape. ) +/// @brief Disables rendering and physical simulation. +/// Calling destroy() will also spawn any explosions, debris, and/or destroyedShape +/// defined for it, as well as remove it from the scene graph. +/// Destroyed objects are only created on the server. Ghosting will later update the client. +/// @note This does not actually delete the PhysicsShape. ) +/// /// public void fnPhysicsShape_destroy (string physicsshape) @@ -27807,6 +35348,7 @@ public void fnPhysicsShape_destroy (string physicsshape) } /// /// @brief Returns if a PhysicsShape has been destroyed or not. ) +/// /// public bool fnPhysicsShape_isDestroyed (string physicsshape) @@ -27820,7 +35362,11 @@ public bool fnPhysicsShape_isDestroyed (string physicsshape) return SafeNativeMethods.mwle_fnPhysicsShape_isDestroyed(sbphysicsshape)>=1; } /// -/// @brief Restores the shape to its state before being destroyed. Re-enables rendering and physical simulation on the object and adds it to the client's scene graph. Has no effect if the shape is not destroyed.) +/// @brief Restores the shape to its state before being destroyed. +/// Re-enables rendering and physical simulation on the object and +/// adds it to the client's scene graph. +/// Has no effect if the shape is not destroyed.) +/// /// public void fnPhysicsShape_restore (string physicsshape) @@ -27834,7 +35380,19 @@ public void fnPhysicsShape_restore (string physicsshape) SafeNativeMethods.mwle_fnPhysicsShape_restore(sbphysicsshape); } /// -/// @brief Allow all poses a chance to occur. This method resets any poses that have manually been blocked from occuring. This includes the regular pose states such as sprinting, crouch, being prone and swimming. It also includes being able to jump and jet jump. While this is allowing these poses to occur it doesn't mean that they all can due to other conditions. We're just not manually blocking them from being allowed. @see allowJumping() @see allowJetJumping() @see allowSprinting() @see allowCrouching() @see allowProne() @see allowSwimming() ) +/// @brief Allow all poses a chance to occur. +/// This method resets any poses that have manually been blocked from occuring. +/// This includes the regular pose states such as sprinting, crouch, being prone +/// and swimming. It also includes being able to jump and jet jump. While this +/// is allowing these poses to occur it doesn't mean that they all can due to other +/// conditions. We're just not manually blocking them from being allowed. +/// @see allowJumping() +/// @see allowJetJumping() +/// @see allowSprinting() +/// @see allowCrouching() +/// @see allowProne() +/// @see allowSwimming() ) +/// /// public void fnPlayer_allowAllPoses (string player) @@ -27848,7 +35406,13 @@ public void fnPlayer_allowAllPoses (string player) SafeNativeMethods.mwle_fnPlayer_allowAllPoses(sbplayer); } /// -/// @brief Set if the Player is allowed to crouch. The default is to allow crouching unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow crouching at any time. @param state Set to true to allow crouching, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to crouch. +/// The default is to allow crouching unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow crouching +/// at any time. +/// @param state Set to true to allow crouching, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowCrouching (string player, bool state) @@ -27862,7 +35426,13 @@ public void fnPlayer_allowCrouching (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowCrouching(sbplayer, state); } /// -/// @brief Set if the Player is allowed to jet jump. The default is to allow jet jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jet jumping at any time. @param state Set to true to allow jet jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jet jump. +/// The default is to allow jet jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jet jumping +/// at any time. +/// @param state Set to true to allow jet jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowJetJumping (string player, bool state) @@ -27876,7 +35446,13 @@ public void fnPlayer_allowJetJumping (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowJetJumping(sbplayer, state); } /// -/// @brief Set if the Player is allowed to jump. The default is to allow jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jumping at any time. @param state Set to true to allow jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jump. +/// The default is to allow jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jumping +/// at any time. +/// @param state Set to true to allow jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowJumping (string player, bool state) @@ -27890,7 +35466,13 @@ public void fnPlayer_allowJumping (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowJumping(sbplayer, state); } /// -/// @brief Set if the Player is allowed to go prone. The default is to allow being prone unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow going prone at any time. @param state Set to true to allow being prone, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to go prone. +/// The default is to allow being prone unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow going prone +/// at any time. +/// @param state Set to true to allow being prone, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowProne (string player, bool state) @@ -27904,7 +35486,13 @@ public void fnPlayer_allowProne (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowProne(sbplayer, state); } /// -/// @brief Set if the Player is allowed to sprint. The default is to allow sprinting unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow sprinting at any time. @param state Set to true to allow sprinting, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to sprint. +/// The default is to allow sprinting unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow sprinting +/// at any time. +/// @param state Set to true to allow sprinting, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowSprinting (string player, bool state) @@ -27918,7 +35506,13 @@ public void fnPlayer_allowSprinting (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowSprinting(sbplayer, state); } /// -/// @brief Set if the Player is allowed to swim. The default is to allow swimming unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow swimming at any time. @param state Set to true to allow swimming, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to swim. +/// The default is to allow swimming unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow swimming +/// at any time. +/// @param state Set to true to allow swimming, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowSwimming (string player, bool state) @@ -27932,7 +35526,21 @@ public void fnPlayer_allowSwimming (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowSwimming(sbplayer, state); } /// -/// @brief Check if it is safe to dismount at this position. Internally this method casts a ray from oldPos to pos to determine if it hits the terrain, an interior object, a water object, another player, a static shape, a vehicle (exluding the one currently mounted), or physical zone. If this ray is in the clear, then the player's bounding box is also checked for a collision at the pos position. If this displaced bounding box is also in the clear, then checkDismountPoint() returns true. @param oldPos The player's current position @param pos The dismount position to check @return True if the dismount position is clear, false if not @note The player must be already mounted for this method to not assert.) +/// @brief Check if it is safe to dismount at this position. +/// +/// Internally this method casts a ray from oldPos to pos to determine if it hits the +/// terrain, an interior object, a water object, another player, a static shape, +/// a vehicle (exluding the one currently mounted), or physical zone. If this ray +/// is in the clear, then the player's bounding box is also checked for a collision at +/// the pos position. If this displaced bounding box is also in the clear, then +/// checkDismountPoint() returns true. +/// +/// @param oldPos The player's current position +/// @param pos The dismount position to check +/// @return True if the dismount position is clear, false if not +/// +/// @note The player must be already mounted for this method to not assert.) +/// /// public bool fnPlayer_checkDismountPoint (string player, string oldPos, string pos) @@ -27952,7 +35560,23 @@ public bool fnPlayer_checkDismountPoint (string player, string oldPos, string po return SafeNativeMethods.mwle_fnPlayer_checkDismountPoint(sbplayer, sboldPos, sbpos)>=1; } /// -/// @brief Clears the player's current control object. Returns control to the player. This internally calls Player::setControlObject(0). @tsexample %player.clearControlObject(); echo(%player.getControlObject()); //-- Returns 0, player assumes control %player.setControlObject(%vehicle); echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. @endtsexample @note If the player does not have a control object, the player will receive all moves from its GameConnection. If you're looking to remove control from the player itself (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer control to another object, such as a camera. @see setControlObject() @see getControlObject() @see GameConnection::setControlObject()) +/// @brief Clears the player's current control object. +/// Returns control to the player. This internally calls +/// Player::setControlObject(0). +/// @tsexample +/// %player.clearControlObject(); +/// echo(%player.getControlObject()); //-- Returns 0, player assumes control +/// %player.setControlObject(%vehicle); +/// echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. +/// @endtsexample +/// @note If the player does not have a control object, the player will receive all moves +/// from its GameConnection. If you're looking to remove control from the player itself +/// (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer +/// control to another object, such as a camera. +/// @see setControlObject() +/// @see getControlObject() +/// @see GameConnection::setControlObject()) +/// /// public void fnPlayer_clearControlObject (string player) @@ -27966,7 +35590,12 @@ public void fnPlayer_clearControlObject (string player) SafeNativeMethods.mwle_fnPlayer_clearControlObject(sbplayer); } /// -/// @brief Get the current object we are controlling. @return ID of the ShapeBase object we control, or 0 if not controlling an object. @see setControlObject() @see clearControlObject()) +/// @brief Get the current object we are controlling. +/// @return ID of the ShapeBase object we control, or 0 if not controlling an +/// object. +/// @see setControlObject() +/// @see clearControlObject()) +/// /// public int fnPlayer_getControlObject (string player) @@ -27980,7 +35609,59 @@ public int fnPlayer_getControlObject (string player) return SafeNativeMethods.mwle_fnPlayer_getControlObject(sbplayer); } /// -/// @brief Get the named damage location and modifier for a given world position. the Player object can simulate different hit locations based on a pre-defined set of PlayerData defined percentages. These hit percentages divide up the Player's bounding box into different regions. The diagram below demonstrates how the various PlayerData properties split up the bounding volume: img src=\"images/player_damageloc.png\"> While you may pass in any world position and getDamageLocation() will provide a best-fit location, you should be aware that this can produce some interesting results. For example, any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even if the world position is high in the sky. Therefore it may be wise to keep the passed in point to somewhere on the surface of, or within, the Player's bounding volume. @note This method will not return an accurate location when the player is prone or swimming. @param pos A world position for which to retrieve a body region on this player. @return a string containing two words (space separated strings), where the first is a location and the second is a modifier. Posible locations:ul> li>head/li> li>torso/li> li>legs/li>/ul> Head modifiers:ul> li>left_back/li> li>middle_back/li> li>right_back/li> li>left_middle/li> li>middle_middle/li> li>right_middle/li> li>left_front/li> li>middle_front/li> li>right_front/li>/ul> Legs/Torso modifiers:ul> li>front_left/li> li>front_right/li> li>back_left/li> li>back_right/li>/ul> @see PlayerData::boxHeadPercentage @see PlayerData::boxHeadFrontPercentage @see PlayerData::boxHeadBackPercentage @see PlayerData::boxHeadLeftPercentage @see PlayerData::boxHeadRightPercentage @see PlayerData::boxTorsoPercentage ) +/// @brief Get the named damage location and modifier for a given world position. +/// +/// the Player object can simulate different hit locations based on a pre-defined set +/// of PlayerData defined percentages. These hit percentages divide up the Player's +/// bounding box into different regions. The diagram below demonstrates how the various +/// PlayerData properties split up the bounding volume: +/// +/// img src=\"images/player_damageloc.png\"> +/// +/// While you may pass in any world position and getDamageLocation() will provide a best-fit +/// location, you should be aware that this can produce some interesting results. For example, +/// any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even +/// if the world position is high in the sky. Therefore it may be wise to keep the passed in point +/// to somewhere on the surface of, or within, the Player's bounding volume. +/// +/// @note This method will not return an accurate location when the player is +/// prone or swimming. +/// +/// @param pos A world position for which to retrieve a body region on this player. +/// +/// @return a string containing two words (space separated strings), where the +/// first is a location and the second is a modifier. +/// +/// Posible locations:ul> +/// li>head/li> +/// li>torso/li> +/// li>legs/li>/ul> +/// +/// Head modifiers:ul> +/// li>left_back/li> +/// li>middle_back/li> +/// li>right_back/li> +/// li>left_middle/li> +/// li>middle_middle/li> +/// li>right_middle/li> +/// li>left_front/li> +/// li>middle_front/li> +/// li>right_front/li>/ul> +/// +/// Legs/Torso modifiers:ul> +/// li>front_left/li> +/// li>front_right/li> +/// li>back_left/li> +/// li>back_right/li>/ul> +/// +/// @see PlayerData::boxHeadPercentage +/// @see PlayerData::boxHeadFrontPercentage +/// @see PlayerData::boxHeadBackPercentage +/// @see PlayerData::boxHeadLeftPercentage +/// @see PlayerData::boxHeadRightPercentage +/// @see PlayerData::boxTorsoPercentage +/// ) +/// /// public string fnPlayer_getDamageLocation (string player, string pos) @@ -28000,7 +35681,9 @@ public string fnPlayer_getDamageLocation (string player, string pos) } /// -/// @brief Get the number of death animations available to this player. Death animations are assumed to be named death1-N using consecutive indices. ) +/// @brief Get the number of death animations available to this player. +/// Death animations are assumed to be named death1-N using consecutive indices. ) +/// /// public int fnPlayer_getNumDeathAnimations (string player) @@ -28014,7 +35697,17 @@ public int fnPlayer_getNumDeathAnimations (string player) return SafeNativeMethods.mwle_fnPlayer_getNumDeathAnimations(sbplayer); } /// -/// @brief Get the name of the player's current pose. The pose is one of the following:ul> li>Stand - Standard movement pose./li> li>Sprint - Sprinting pose./li> li>Crouch - Crouch pose./li> li>Prone - Prone pose./li> li>Swim - Swimming pose./li>/ul> @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// @brief Get the name of the player's current pose. +/// +/// The pose is one of the following:ul> +/// li>Stand - Standard movement pose./li> +/// li>Sprint - Sprinting pose./li> +/// li>Crouch - Crouch pose./li> +/// li>Prone - Prone pose./li> +/// li>Swim - Swimming pose./li>/ul> +/// +/// @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// /// public string fnPlayer_getPose (string player) @@ -28031,7 +35724,16 @@ public string fnPlayer_getPose (string player) } /// -/// @brief Get the name of the player's current state. The state is one of the following:ul> li>Dead - The Player is dead./li> li>Mounted - The Player is mounted to an object such as a vehicle./li> li>Move - The Player is free to move. The usual state./li> li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// @brief Get the name of the player's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The Player is dead./li> +/// li>Mounted - The Player is mounted to an object such as a vehicle./li> +/// li>Move - The Player is free to move. The usual state./li> +/// li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// /// public string fnPlayer_getState (string player) @@ -28048,7 +35750,58 @@ public string fnPlayer_getState (string player) } /// -/// @brief Set the main action sequence to play for this player. @param name Name of the action sequence to set @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). When set to true no callback is made. @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's spine nodes to animate. @return True if succesful, false if failed @note The spine nodes for the Player's shape are named as follows:ul> li>Bip01 Pelvis/li> li>Bip01 Spine/li> li>Bip01 Spine1/li> li>Bip01 Spine2/li> li>Bip01 Neck/li> li>Bip01 Head/li>/ul> You cannot use setActionThread() to have the Player play one of the motion determined action animation sequences. These sequences are chosen based on how the Player moves and the Player's current pose. The names of these sequences are:ul> li>root/li> li>run/li> li>side/li> li>side_right/li> li>crouch_root/li> li>crouch_forward/li> li>crouch_backward/li> li>crouch_side/li> li>crouch_right/li> li>prone_root/li> li>prone_forward/li> li>prone_backward/li> li>swim_root/li> li>swim_forward/li> li>swim_backward/li> li>swim_left/li> li>swim_right/li> li>fall/li> li>jump/li> li>standjump/li> li>land/li> li>jet/li>/ul> If the player moves in any direction then the animation sequence set using this method will be cancelled and the chosen mation-based sequence will take over. This makes great for times when the Player cannot move, such as when mounted, or when it doesn't matter if the action sequence changes, such as waving and saluting. @tsexample // Place the player in a sitting position after being mounted %player.setActionThread( \"sitting\", true, true ); @endtsexample) +/// @brief Set the main action sequence to play for this player. +/// @param name Name of the action sequence to set +/// @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). +/// When set to true no callback is made. +/// @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's +/// spine nodes to animate. +/// @return True if succesful, false if failed +/// +/// @note The spine nodes for the Player's shape are named as follows:ul> +/// li>Bip01 Pelvis/li> +/// li>Bip01 Spine/li> +/// li>Bip01 Spine1/li> +/// li>Bip01 Spine2/li> +/// li>Bip01 Neck/li> +/// li>Bip01 Head/li>/ul> +/// +/// You cannot use setActionThread() to have the Player play one of the motion +/// determined action animation sequences. These sequences are chosen based on how +/// the Player moves and the Player's current pose. The names of these sequences are:ul> +/// li>root/li> +/// li>run/li> +/// li>side/li> +/// li>side_right/li> +/// li>crouch_root/li> +/// li>crouch_forward/li> +/// li>crouch_backward/li> +/// li>crouch_side/li> +/// li>crouch_right/li> +/// li>prone_root/li> +/// li>prone_forward/li> +/// li>prone_backward/li> +/// li>swim_root/li> +/// li>swim_forward/li> +/// li>swim_backward/li> +/// li>swim_left/li> +/// li>swim_right/li> +/// li>fall/li> +/// li>jump/li> +/// li>standjump/li> +/// li>land/li> +/// li>jet/li>/ul> +/// +/// If the player moves in any direction then the animation sequence set using this +/// method will be cancelled and the chosen mation-based sequence will take over. This makes +/// great for times when the Player cannot move, such as when mounted, or when it doesn't matter +/// if the action sequence changes, such as waving and saluting. +/// +/// @tsexample +/// // Place the player in a sitting position after being mounted +/// %player.setActionThread( \"sitting\", true, true ); +/// @endtsexample) +/// /// public bool fnPlayer_setActionThread (string player, string name, bool hold, bool fsp) @@ -28065,7 +35818,12 @@ public bool fnPlayer_setActionThread (string player, string name, bool hold, boo return SafeNativeMethods.mwle_fnPlayer_setActionThread(sbplayer, sbname, hold, fsp)>=1; } /// -/// @brief Set the sequence that controls the player's arms (dynamically adjusted to match look direction). @param name Name of the sequence to play on the player's arms. @return true if successful, false if failed. @note By default the 'look' sequence is used, if available.) +/// @brief Set the sequence that controls the player's arms (dynamically adjusted +/// to match look direction). +/// @param name Name of the sequence to play on the player's arms. +/// @return true if successful, false if failed. +/// @note By default the 'look' sequence is used, if available.) +/// /// public bool fnPlayer_setArmThread (string player, string name) @@ -28082,7 +35840,23 @@ public bool fnPlayer_setArmThread (string player, string name) return SafeNativeMethods.mwle_fnPlayer_setArmThread(sbplayer, sbname)>=1; } /// -/// @brief Set the object to be controlled by this player It is possible to have the moves sent to the Player object from the GameConnection to be passed along to another object. This happens, for example when a player is mounted to a vehicle. The move commands pass through the Player and on to the vehicle (while the player remains stationary within the vehicle). With setControlObject() you can have the Player pass along its moves to any object. One possible use is for a player to move a remote controlled vehicle. In this case the player does not mount the vehicle directly, but still wants to be able to control it. @param obj Object to control with this player @return True if the object is valid, false if not @see getControlObject() @see clearControlObject() @see GameConnection::setControlObject()) +/// @brief Set the object to be controlled by this player +/// +/// It is possible to have the moves sent to the Player object from the +/// GameConnection to be passed along to another object. This happens, for example +/// when a player is mounted to a vehicle. The move commands pass through the Player +/// and on to the vehicle (while the player remains stationary within the vehicle). +/// With setControlObject() you can have the Player pass along its moves to any object. +/// One possible use is for a player to move a remote controlled vehicle. In this case +/// the player does not mount the vehicle directly, but still wants to be able to control it. +/// +/// @param obj Object to control with this player +/// @return True if the object is valid, false if not +/// +/// @see getControlObject() +/// @see clearControlObject() +/// @see GameConnection::setControlObject()) +/// /// public bool fnPlayer_setControlObject (string player, string obj) @@ -28099,7 +35873,9 @@ public bool fnPlayer_setControlObject (string player, string obj) return SafeNativeMethods.mwle_fnPlayer_setControlObject(sbplayer, sbobj)>=1; } /// -/// Test whether the portal connects interior zones to the outdoor zone. @return True if the portal is an exterior portal. ) +/// Test whether the portal connects interior zones to the outdoor zone. +/// @return True if the portal is an exterior portal. ) +/// /// public bool fnPortal_isExteriorPortal (string portal) @@ -28113,7 +35889,9 @@ public bool fnPortal_isExteriorPortal (string portal) return SafeNativeMethods.mwle_fnPortal_isExteriorPortal(sbportal)>=1; } /// -/// Test whether the portal connects interior zones only. @return True if the portal is an interior portal. ) +/// Test whether the portal connects interior zones only. +/// @return True if the portal is an interior portal. ) +/// /// public bool fnPortal_isInteriorPortal (string portal) @@ -28128,6 +35906,7 @@ public bool fnPortal_isInteriorPortal (string portal) } /// /// Remove all shader macros. ) +/// /// public void fnPostEffect_clearShaderMacros (string posteffect) @@ -28142,6 +35921,7 @@ public void fnPostEffect_clearShaderMacros (string posteffect) } /// /// Disables the effect. ) +/// /// public void fnPostEffect_disable (string posteffect) @@ -28155,7 +35935,9 @@ public void fnPostEffect_disable (string posteffect) SafeNativeMethods.mwle_fnPostEffect_disable(sbposteffect); } /// -/// Dumps this PostEffect shader's disassembly to a temporary text file. @return Full path to the dumped file or an empty string if failed. ) +/// Dumps this PostEffect shader's disassembly to a temporary text file. +/// @return Full path to the dumped file or an empty string if failed. ) +/// /// public string fnPostEffect_dumpShaderDisassembly (string posteffect) @@ -28173,6 +35955,7 @@ public string fnPostEffect_dumpShaderDisassembly (string posteffect) } /// /// Enables the effect. ) +/// /// public void fnPostEffect_enable (string posteffect) @@ -28187,6 +35970,7 @@ public void fnPostEffect_enable (string posteffect) } /// /// @return Width over height of the backbuffer. ) +/// /// public float fnPostEffect_getAspectRatio (string posteffect) @@ -28201,6 +35985,7 @@ public float fnPostEffect_getAspectRatio (string posteffect) } /// /// @return True if the effect is enabled. ) +/// /// public bool fnPostEffect_isEnabled (string posteffect) @@ -28215,6 +36000,7 @@ public bool fnPostEffect_isEnabled (string posteffect) } /// /// Reloads the effect shader and textures. ) +/// /// public void fnPostEffect_reload (string posteffect) @@ -28228,7 +36014,9 @@ public void fnPostEffect_reload (string posteffect) SafeNativeMethods.mwle_fnPostEffect_reload(sbposteffect); } /// -/// Remove a shader macro. This will usually be called within the preProcess callback. @param key Macro to remove. ) +/// Remove a shader macro. This will usually be called within the preProcess callback. +/// @param key Macro to remove. ) +/// /// public void fnPostEffect_removeShaderMacro (string posteffect, string key) @@ -28245,7 +36033,23 @@ public void fnPostEffect_removeShaderMacro (string posteffect, string key) SafeNativeMethods.mwle_fnPostEffect_removeShaderMacro(sbposteffect, sbkey); } /// -/// Sets the value of a uniform defined in the shader. This will usually be called within the setShaderConsts callback. Array type constants are not supported. @param name Name of the constanst, prefixed with '$'. @param value Value to set, space seperate values with more than one element. @tsexample function MyPfx::setShaderConsts( %this ) { // example float4 uniform %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); // example float1 uniform %this.setShaderConst( \"$strength\", \"3.0\" ); // example integer uniform %this.setShaderConst( \"$loops\", \"5\" ); } @endtsexample ) +/// Sets the value of a uniform defined in the shader. This will usually +/// be called within the setShaderConsts callback. Array type constants are +/// not supported. +/// @param name Name of the constanst, prefixed with '$'. +/// @param value Value to set, space seperate values with more than one element. +/// @tsexample +/// function MyPfx::setShaderConsts( %this ) +/// { +/// // example float4 uniform +/// %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); +/// // example float1 uniform +/// %this.setShaderConst( \"$strength\", \"3.0\" ); +/// // example integer uniform +/// %this.setShaderConst( \"$loops\", \"5\" ); +/// } +/// @endtsexample ) +/// /// public void fnPostEffect_setShaderConst (string posteffect, string name, string value) @@ -28265,7 +36069,23 @@ public void fnPostEffect_setShaderConst (string posteffect, string name, string SafeNativeMethods.mwle_fnPostEffect_setShaderConst(sbposteffect, sbname, sbvalue); } /// -/// ), Adds a macro to the effect's shader or sets an existing one's value. This will usually be called within the onAdd or preProcess callback. @param key lval of the macro. @param value rval of the macro, or may be empty. @tsexample function MyPfx::onAdd( %this ) { %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); // In the shader looks like... // #define NUM_SAMPLES 10 // #define HIGH_QUALITY_MODE } @endtsexample ) +/// ), +/// Adds a macro to the effect's shader or sets an existing one's value. +/// This will usually be called within the onAdd or preProcess callback. +/// @param key lval of the macro. +/// @param value rval of the macro, or may be empty. +/// @tsexample +/// function MyPfx::onAdd( %this ) +/// { +/// %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); +/// %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); +/// +/// // In the shader looks like... +/// // #define NUM_SAMPLES 10 +/// // #define HIGH_QUALITY_MODE +/// } +/// @endtsexample ) +/// /// public void fnPostEffect_setShaderMacro (string posteffect, string key, string value) @@ -28285,7 +36105,12 @@ public void fnPostEffect_setShaderMacro (string posteffect, string key, string v SafeNativeMethods.mwle_fnPostEffect_setShaderMacro(sbposteffect, sbkey, sbvalue); } /// -/// This is used to set the texture file and load the texture on a running effect. If the texture file is not different from the current file nothing is changed. If the texture cannot be found a null texture is assigned. @param index The texture stage index. @param filePath The file name of the texture to set. ) +/// This is used to set the texture file and load the texture on a running effect. +/// If the texture file is not different from the current file nothing is changed. If +/// the texture cannot be found a null texture is assigned. +/// @param index The texture stage index. +/// @param filePath The file name of the texture to set. ) +/// /// public void fnPostEffect_setTexture (string posteffect, int index, string filePath) @@ -28302,7 +36127,9 @@ public void fnPostEffect_setTexture (string posteffect, int index, string filePa SafeNativeMethods.mwle_fnPostEffect_setTexture(sbposteffect, index, sbfilePath); } /// -/// Toggles the effect between enabled / disabled. @return True if effect is enabled. ) +/// Toggles the effect between enabled / disabled. +/// @return True if effect is enabled. ) +/// /// public bool fnPostEffect_toggle (string posteffect) @@ -28316,7 +36143,20 @@ public bool fnPostEffect_toggle (string posteffect) return SafeNativeMethods.mwle_fnPostEffect_toggle(sbposteffect)>=1; } /// -/// Smoothly change the maximum number of drops in the effect (from current value to #numDrops * @a percentage). This method can be used to simulate a storm building or fading in intensity as the number of drops in the Precipitation box changes. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @param seconds Length of time (in seconds) over which to increase the drops percentage value. Set to 0 to change instantly. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %seconds = 5.0; // The length of time over which to make the change. %precipitation.modifyStorm( %percentage, %seconds ); @endtsexample ) +/// Smoothly change the maximum number of drops in the effect (from current +/// value to #numDrops * @a percentage). +/// This method can be used to simulate a storm building or fading in intensity +/// as the number of drops in the Precipitation box changes. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @param seconds Length of time (in seconds) over which to increase the drops +/// percentage value. Set to 0 to change instantly. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.modifyStorm( %percentage, %seconds ); +/// @endtsexample ) +/// /// public void fnPrecipitation_modifyStorm (string precipitation, float percentage, float seconds) @@ -28330,7 +36170,17 @@ public void fnPrecipitation_modifyStorm (string precipitation, float percentage, SafeNativeMethods.mwle_fnPrecipitation_modifyStorm(sbprecipitation, percentage, seconds); } /// -/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. The change occurs instantly (use modifyStorm() to change the number of drops over a period of time. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %precipitation.setPercentage( %percentage ); @endtsexample @see modifyStorm ) +/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. +/// The change occurs instantly (use modifyStorm() to change the number of drops +/// over a period of time. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %precipitation.setPercentage( %percentage ); +/// @endtsexample +/// @see modifyStorm ) +/// /// public void fnPrecipitation_setPercentage (string precipitation, float percentage) @@ -28344,7 +36194,18 @@ public void fnPrecipitation_setPercentage (string precipitation, float percentag SafeNativeMethods.mwle_fnPrecipitation_setPercentage(sbprecipitation, percentage); } /// -/// Smoothly change the turbulence parameters over a period of time. @param max New #maxTurbulence value. Set to 0 to disable turbulence. @param speed New #turbulenceSpeed value. @param seconds Length of time (in seconds) over which to interpolate the turbulence settings. Set to 0 to change instantly. @tsexample %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. %speed = 5.0; // The new speed of the turbulance effect. %seconds = 5.0; // The length of time over which to make the change. %precipitation.setTurbulence( %turbulence, %speed, %seconds ); @endtsexample ) +/// Smoothly change the turbulence parameters over a period of time. +/// @param max New #maxTurbulence value. Set to 0 to disable turbulence. +/// @param speed New #turbulenceSpeed value. +/// @param seconds Length of time (in seconds) over which to interpolate the +/// turbulence settings. Set to 0 to change instantly. +/// @tsexample +/// %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. +/// %speed = 5.0; // The new speed of the turbulance effect. +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.setTurbulence( %turbulence, %speed, %seconds ); +/// @endtsexample ) +/// /// public void fnPrecipitation_setTurbulence (string precipitation, float max, float speed, float seconds) @@ -28358,7 +36219,19 @@ public void fnPrecipitation_setTurbulence (string precipitation, float max, floa SafeNativeMethods.mwle_fnPrecipitation_setTurbulence(sbprecipitation, max, speed, seconds); } /// -/// @brief Updates the projectile's positional and collision information. This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. Also responsible for applying gravity, determining collisions, triggering explosions, emitting trail particles, and calculating bounces if necessary. @param seconds Amount of time, in seconds since the simulation's start, to advance. @tsexample // Tell the projectile to process a simulation event, and provide the amount of time // that has passed since the simulation began. %seconds = 2.0; %projectile.presimulate(%seconds); @endtsexample @note This function is not called if the SimObject::hidden is true.) +/// @brief Updates the projectile's positional and collision information. +/// This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. +/// Also responsible for applying gravity, determining collisions, triggering explosions, +/// emitting trail particles, and calculating bounces if necessary. +/// @param seconds Amount of time, in seconds since the simulation's start, to advance. +/// @tsexample +/// // Tell the projectile to process a simulation event, and provide the amount of time +/// // that has passed since the simulation began. +/// %seconds = 2.0; +/// %projectile.presimulate(%seconds); +/// @endtsexample +/// @note This function is not called if the SimObject::hidden is true.) +/// /// public void fnProjectile_presimulate (string projectile, float seconds) @@ -28373,6 +36246,7 @@ public void fnProjectile_presimulate (string projectile, float seconds) } /// /// @brief Manually cause the mine to explode.) +/// /// public void fnProximityMine_explode (string proximitymine) @@ -28387,6 +36261,7 @@ public void fnProximityMine_explode (string proximitymine) } /// /// Returns the bin type string. ) +/// /// public string fnRenderBinManager_getBinType (string renderbinmanager) @@ -28404,6 +36279,7 @@ public string fnRenderBinManager_getBinType (string renderbinmanager) } /// /// A utility method for forcing a network update.) +/// /// public void fnRenderMeshExample_postApply (string rendermeshexample) @@ -28418,6 +36294,7 @@ public void fnRenderMeshExample_postApply (string rendermeshexample) } /// /// Add as a render bin manager to the pass. ) +/// /// public void fnRenderPassManager_addManager (string renderpassmanager, string renderBin) @@ -28435,6 +36312,7 @@ public void fnRenderPassManager_addManager (string renderpassmanager, string ren } /// /// Returns the render bin manager at the index or null if the index is out of range. ) +/// /// public string fnRenderPassManager_getManager (string renderpassmanager, int index) @@ -28452,6 +36330,7 @@ public string fnRenderPassManager_getManager (string renderpassmanager, int inde } /// /// Returns the total number of bin managers. ) +/// /// public int fnRenderPassManager_getManagerCount (string renderpassmanager) @@ -28466,6 +36345,7 @@ public int fnRenderPassManager_getManagerCount (string renderpassmanager) } /// /// Removes a render bin manager. ) +/// /// public void fnRenderPassManager_removeManager (string renderpassmanager, string renderBin) @@ -28483,6 +36363,7 @@ public void fnRenderPassManager_removeManager (string renderpassmanager, string } /// /// @brief Disables the token.) +/// /// public void fnRenderPassStateToken_disable (string renderpassstatetoken) @@ -28497,6 +36378,7 @@ public void fnRenderPassStateToken_disable (string renderpassstatetoken) } /// /// @brief Enables the token. ) +/// /// public void fnRenderPassStateToken_enable (string renderpassstatetoken) @@ -28511,6 +36393,7 @@ public void fnRenderPassStateToken_enable (string renderpassstatetoken) } /// /// @brief Toggles the token from enabled to disabled or vice versa. ) +/// /// public void fnRenderPassStateToken_toggle (string renderpassstatetoken) @@ -28525,6 +36408,7 @@ public void fnRenderPassStateToken_toggle (string renderpassstatetoken) } /// /// @brief Forces the client to jump to the RigidShape's transform rather then warp to it.) +/// /// public void fnRigidShape_forceClientTransform (string rigidshape) @@ -28538,7 +36422,16 @@ public void fnRigidShape_forceClientTransform (string rigidshape) SafeNativeMethods.mwle_fnRigidShape_forceClientTransform(sbrigidshape); } /// -/// @brief Enables or disables the physics simulation on the RigidShape object. @param isFrozen Boolean frozen state to set the object. @tsexample // Define the frozen state. %isFrozen = \"true\"; // Inform the object of the defined frozen state %thisRigidShape.freezeSim(%isFrozen); @endtsexample @see ShapeBaseData) +/// @brief Enables or disables the physics simulation on the RigidShape object. +/// @param isFrozen Boolean frozen state to set the object. +/// @tsexample +/// // Define the frozen state. +/// %isFrozen = \"true\"; +/// // Inform the object of the defined frozen state +/// %thisRigidShape.freezeSim(%isFrozen); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void fnRigidShape_freezeSim (string rigidshape, bool isFrozen) @@ -28552,7 +36445,13 @@ public void fnRigidShape_freezeSim (string rigidshape, bool isFrozen) SafeNativeMethods.mwle_fnRigidShape_freezeSim(sbrigidshape, isFrozen); } /// -/// @brief Clears physic forces from the shape and sets it at rest. @tsexample // Inform the RigidShape object to reset. %thisRigidShape.reset(); @endtsexample @see ShapeBaseData) +/// @brief Clears physic forces from the shape and sets it at rest. +/// @tsexample +/// // Inform the RigidShape object to reset. +/// %thisRigidShape.reset(); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void fnRigidShape_reset (string rigidshape) @@ -28566,7 +36465,10 @@ public void fnRigidShape_reset (string rigidshape) SafeNativeMethods.mwle_fnRigidShape_reset(sbrigidshape); } /// -/// Intended as a helper to developers and editor scripts. Force River to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force River to recreate its geometry. +/// ) +/// /// public void fnRiver_regenerate (string river) @@ -28580,7 +36482,10 @@ public void fnRiver_regenerate (string river) SafeNativeMethods.mwle_fnRiver_regenerate(sbriver); } /// -/// Intended as a helper to developers and editor scripts. BatchSize is not currently used. ) +/// Intended as a helper to developers and editor scripts. +/// BatchSize is not currently used. +/// ) +/// /// public void fnRiver_setBatchSize (string river, float meters) @@ -28594,7 +36499,10 @@ public void fnRiver_setBatchSize (string river, float meters) SafeNativeMethods.mwle_fnRiver_setBatchSize(sbriver, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SubdivideLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SubdivideLength field. +/// ) +/// /// public void fnRiver_setMaxDivisionSize (string river, float meters) @@ -28608,7 +36516,10 @@ public void fnRiver_setMaxDivisionSize (string river, float meters) SafeNativeMethods.mwle_fnRiver_setMaxDivisionSize(sbriver, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SegmentLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SegmentLength field. +/// ) +/// /// public void fnRiver_setMetersPerSegment (string river, float meters) @@ -28622,7 +36533,10 @@ public void fnRiver_setMetersPerSegment (string river, float meters) SafeNativeMethods.mwle_fnRiver_setMetersPerSegment(sbriver, meters); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void fnRiver_setNodeDepth (string river, int idx, float meters) @@ -28636,7 +36550,9 @@ public void fnRiver_setNodeDepth (string river, int idx, float meters) SafeNativeMethods.mwle_fnRiver_setNodeDepth(sbriver, idx, meters); } /// -/// Apply a full network update of all fields to all clients. ) +/// Apply a full network update of all fields to all clients. +/// ) +/// /// public void fnScatterSky_applyChanges (string scattersky) @@ -28650,7 +36566,10 @@ public void fnScatterSky_applyChanges (string scattersky) SafeNativeMethods.mwle_fnScatterSky_applyChanges(sbscattersky); } /// -/// Get Euler rotation of this object. @return the orientation of the object in the form of rotations around the X, Y and Z axes in degrees. ) +/// Get Euler rotation of this object. +/// @return the orientation of the object in the form of rotations around the +/// X, Y and Z axes in degrees. ) +/// /// public string fnSceneObject_getEulerRotation (string sceneobject) @@ -28667,7 +36586,10 @@ public string fnSceneObject_getEulerRotation (string sceneobject) } /// -/// Get the direction this object is facing. @return a vector indicating the direction this object is facing. @note This is the object's y axis. ) +/// Get the direction this object is facing. +/// @return a vector indicating the direction this object is facing. +/// @note This is the object's y axis. ) +/// /// public string fnSceneObject_getForwardVector (string sceneobject) @@ -28684,7 +36606,9 @@ public string fnSceneObject_getForwardVector (string sceneobject) } /// -/// Get the object's inverse transform. @return the inverse transform of the object ) +/// Get the object's inverse transform. +/// @return the inverse transform of the object ) +/// /// public string fnSceneObject_getInverseTransform (string sceneobject) @@ -28701,7 +36625,10 @@ public string fnSceneObject_getInverseTransform (string sceneobject) } /// -/// Get the object mounted at a particular slot. @param slot mount slot index to query @return ID of the object mounted in the slot, or 0 if no object. ) +/// Get the object mounted at a particular slot. +/// @param slot mount slot index to query +/// @return ID of the object mounted in the slot, or 0 if no object. ) +/// /// public int fnSceneObject_getMountedObject (string sceneobject, int slot) @@ -28715,7 +36642,9 @@ public int fnSceneObject_getMountedObject (string sceneobject, int slot) return SafeNativeMethods.mwle_fnSceneObject_getMountedObject(sbsceneobject, slot); } /// -/// Get the number of objects mounted to us. @return the number of mounted objects. ) +/// Get the number of objects mounted to us. +/// @return the number of mounted objects. ) +/// /// public int fnSceneObject_getMountedObjectCount (string sceneobject) @@ -28729,7 +36658,10 @@ public int fnSceneObject_getMountedObjectCount (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_getMountedObjectCount(sbsceneobject); } /// -/// @brief Get the mount node index of the object mounted at our given slot. @param slot mount slot index to query @return index of the mount node used by the object mounted in this slot. ) +/// @brief Get the mount node index of the object mounted at our given slot. +/// @param slot mount slot index to query +/// @return index of the mount node used by the object mounted in this slot. ) +/// /// public int fnSceneObject_getMountedObjectNode (string sceneobject, int slot) @@ -28743,7 +36675,10 @@ public int fnSceneObject_getMountedObjectNode (string sceneobject, int slot) return SafeNativeMethods.mwle_fnSceneObject_getMountedObjectNode(sbsceneobject, slot); } /// -/// @brief Get the object mounted at our given node index. @param node mount node index to query @return ID of the first object mounted at the node, or 0 if none found. ) +/// @brief Get the object mounted at our given node index. +/// @param node mount node index to query +/// @return ID of the first object mounted at the node, or 0 if none found. ) +/// /// public int fnSceneObject_getMountNodeObject (string sceneobject, int node) @@ -28757,7 +36692,10 @@ public int fnSceneObject_getMountNodeObject (string sceneobject, int node) return SafeNativeMethods.mwle_fnSceneObject_getMountNodeObject(sbsceneobject, node); } /// -/// Get the object's bounding box (relative to the object's origin). @return six fields, two Point3Fs, containing the min and max points of the objectbox. ) +/// Get the object's bounding box (relative to the object's origin). +/// @return six fields, two Point3Fs, containing the min and max points of the +/// objectbox. ) +/// /// public string fnSceneObject_getObjectBox (string sceneobject) @@ -28774,7 +36712,9 @@ public string fnSceneObject_getObjectBox (string sceneobject) } /// -/// @brief Get the object we are mounted to. @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// @brief Get the object we are mounted to. +/// @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// /// public int fnSceneObject_getObjectMount (string sceneobject) @@ -28788,7 +36728,9 @@ public int fnSceneObject_getObjectMount (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_getObjectMount(sbsceneobject); } /// -/// Get the object's world position. @return the current world position of the object ) +/// Get the object's world position. +/// @return the current world position of the object ) +/// /// public string fnSceneObject_getPosition (string sceneobject) @@ -28805,7 +36747,10 @@ public string fnSceneObject_getPosition (string sceneobject) } /// -/// Get the right vector of the object. @return a vector indicating the right direction of this object. @note This is the object's x axis. ) +/// Get the right vector of the object. +/// @return a vector indicating the right direction of this object. +/// @note This is the object's x axis. ) +/// /// public string fnSceneObject_getRightVector (string sceneobject) @@ -28822,7 +36767,9 @@ public string fnSceneObject_getRightVector (string sceneobject) } /// -/// Get the object's scale. @return object scale as a Point3F ) +/// Get the object's scale. +/// @return object scale as a Point3F ) +/// /// public string fnSceneObject_getScale (string sceneobject) @@ -28839,7 +36786,9 @@ public string fnSceneObject_getScale (string sceneobject) } /// -/// Get the object's transform. @return the current transform of the object ) +/// Get the object's transform. +/// @return the current transform of the object ) +/// /// public string fnSceneObject_getTransform (string sceneobject) @@ -28856,7 +36805,9 @@ public string fnSceneObject_getTransform (string sceneobject) } /// -/// Return the type mask for this object. @return The numeric type mask for the object. ) +/// Return the type mask for this object. +/// @return The numeric type mask for the object. ) +/// /// public int fnSceneObject_getType (string sceneobject) @@ -28870,7 +36821,10 @@ public int fnSceneObject_getType (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_getType(sbsceneobject); } /// -/// Get the up vector of the object. @return a vector indicating the up direction of this object. @note This is the object's z axis. ) +/// Get the up vector of the object. +/// @return a vector indicating the up direction of this object. +/// @note This is the object's z axis. ) +/// /// public string fnSceneObject_getUpVector (string sceneobject) @@ -28887,7 +36841,10 @@ public string fnSceneObject_getUpVector (string sceneobject) } /// -/// Get the object's world bounding box. @return six fields, two Point3Fs, containing the min and max points of the worldbox. ) +/// Get the object's world bounding box. +/// @return six fields, two Point3Fs, containing the min and max points of the +/// worldbox. ) +/// /// public string fnSceneObject_getWorldBox (string sceneobject) @@ -28904,7 +36861,9 @@ public string fnSceneObject_getWorldBox (string sceneobject) } /// -/// Get the center of the object's world bounding box. @return the center of the world bounding box for this object. ) +/// Get the center of the object's world bounding box. +/// @return the center of the world bounding box for this object. ) +/// /// public string fnSceneObject_getWorldBoxCenter (string sceneobject) @@ -28921,7 +36880,11 @@ public string fnSceneObject_getWorldBoxCenter (string sceneobject) } /// -/// Check if this object has a global bounds set. If global bounds are set to be true, then the object is assumed to have an infinitely large bounding box for collision and rendering purposes. @return true if the object has a global bounds. ) +/// Check if this object has a global bounds set. +/// If global bounds are set to be true, then the object is assumed to have an +/// infinitely large bounding box for collision and rendering purposes. +/// @return true if the object has a global bounds. ) +/// /// public bool fnSceneObject_isGlobalBounds (string sceneobject) @@ -28935,7 +36898,9 @@ public bool fnSceneObject_isGlobalBounds (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_isGlobalBounds(sbsceneobject)>=1; } /// -/// @brief Check if we are mounted to another object. @return true if mounted to another object, false if not mounted. ) +/// @brief Check if we are mounted to another object. +/// @return true if mounted to another object, false if not mounted. ) +/// /// public bool fnSceneObject_isMounted (string sceneobject) @@ -28949,7 +36914,13 @@ public bool fnSceneObject_isMounted (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_isMounted(sbsceneobject)>=1; } /// -/// @brief Mount objB to this object at the desired slot with optional transform. @param objB Object to mount onto us @param slot Mount slot ID @param txfm (optional) mount offset transform @return true if successful, false if failed (objB is not valid) ) +/// @brief Mount objB to this object at the desired slot with optional transform. +/// +/// @param objB Object to mount onto us +/// @param slot Mount slot ID +/// @param txfm (optional) mount offset transform +/// @return true if successful, false if failed (objB is not valid) ) +/// /// public bool fnSceneObject_mountObject (string sceneobject, string objB, int slot, string txfm) @@ -28969,7 +36940,9 @@ public bool fnSceneObject_mountObject (string sceneobject, string objB, int slot return SafeNativeMethods.mwle_fnSceneObject_mountObject(sbsceneobject, sbobjB, slot, sbtxfm)>=1; } /// -/// Set the object's scale. @param scale object scale to set ) +/// Set the object's scale. +/// @param scale object scale to set ) +/// /// public void fnSceneObject_setScale (string sceneobject, string scale) @@ -28986,7 +36959,9 @@ public void fnSceneObject_setScale (string sceneobject, string scale) SafeNativeMethods.mwle_fnSceneObject_setScale(sbsceneobject, sbscale); } /// -/// Set the object's transform (orientation and position). @param txfm object transform to set ) +/// Set the object's transform (orientation and position). +/// @param txfm object transform to set ) +/// /// public void fnSceneObject_setTransform (string sceneobject, string txfm) @@ -29003,7 +36978,9 @@ public void fnSceneObject_setTransform (string sceneobject, string txfm) SafeNativeMethods.mwle_fnSceneObject_setTransform(sbsceneobject, sbtxfm); } /// -/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_TickCounterAdd (string sceneobject, string countername, uint interval) @@ -29020,7 +36997,9 @@ public bool fnSceneObject_TickCounterAdd (string sceneobject, string countername return SafeNativeMethods.mwle_fnSceneObject_TickCounterAdd(sbsceneobject, sbcountername, interval)>=1; } /// -/// @brief returns the interval for a counter. @return true if successful, false if failed ) +/// @brief returns the interval for a counter. +/// @return true if successful, false if failed ) +/// /// public uint fnSceneObject_TickCounterGetInterval (string sceneobject, string countername) @@ -29037,7 +37016,9 @@ public uint fnSceneObject_TickCounterGetInterval (string sceneobject, string cou return SafeNativeMethods.mwle_fnSceneObject_TickCounterGetInterval(sbsceneobject, sbcountername); } /// -/// @brief Checks to see if the counter exists. @return true if successful, false if failed ) +/// @brief Checks to see if the counter exists. +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_TickCounterHas (string sceneobject, string countername) @@ -29054,7 +37035,9 @@ public bool fnSceneObject_TickCounterHas (string sceneobject, string countername return SafeNativeMethods.mwle_fnSceneObject_TickCounterHas(sbsceneobject, sbcountername)>=1; } /// -/// @brief Removes a counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Removes a counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_TickCounterRemove (string sceneobject, string countername) @@ -29071,7 +37054,9 @@ public bool fnSceneObject_TickCounterRemove (string sceneobject, string countern return SafeNativeMethods.mwle_fnSceneObject_TickCounterRemove(sbsceneobject, sbcountername)>=1; } /// -/// @brief resets the current count for a counter. @return true if successful, false if failed ) +/// @brief resets the current count for a counter. +/// @return true if successful, false if failed ) +/// /// public void fnSceneObject_TickCounterReset (string sceneobject, string countername) @@ -29088,7 +37073,8 @@ public void fnSceneObject_TickCounterReset (string sceneobject, string counterna SafeNativeMethods.mwle_fnSceneObject_TickCounterReset(sbsceneobject, sbcountername); } /// -/// @brief Clears all counters from the object.) +/// @brief Clears all counters from the object.) +/// /// public void fnSceneObject_TickCountersClear (string sceneobject) @@ -29102,7 +37088,9 @@ public void fnSceneObject_TickCountersClear (string sceneobject) SafeNativeMethods.mwle_fnSceneObject_TickCountersClear(sbsceneobject); } /// -/// @brief Adds a new counter to be tracked via ticks. ) +/// @brief Adds a new counter to be tracked via ticks. +/// ) +/// /// public void fnSceneObject_TickCounterSuspend (string sceneobject, string countername, bool suspend) @@ -29120,6 +37108,7 @@ public void fnSceneObject_TickCounterSuspend (string sceneobject, string counter } /// /// Unmount us from the currently mounted object if any. ) +/// /// public void fnSceneObject_unmount (string sceneobject) @@ -29133,7 +37122,11 @@ public void fnSceneObject_unmount (string sceneobject) SafeNativeMethods.mwle_fnSceneObject_unmount(sbsceneobject); } /// -/// @brief Unmount an object from ourselves. @param target object to unmount @return true if successful, false if failed ) +/// @brief Unmount an object from ourselves. +/// +/// @param target object to unmount +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_unmountObject (string sceneobject, string target) @@ -29150,7 +37143,12 @@ public bool fnSceneObject_unmountObject (string sceneobject, string target) return SafeNativeMethods.mwle_fnSceneObject_unmountObject(sbsceneobject, sbtarget)>=1; } /// -/// @brief Is this object wanting to receive tick notifications. If this object is set to receive tick notifications then its onInterpolateTick() and onProcessTick() callbacks are called. @return True if object wants tick notifications ) +/// @brief Is this object wanting to receive tick notifications. +/// +/// If this object is set to receive tick notifications then its onInterpolateTick() and +/// onProcessTick() callbacks are called. +/// @return True if object wants tick notifications ) +/// /// public bool fnScriptTickObject_isProcessingTicks (string scripttickobject) @@ -29164,7 +37162,10 @@ public bool fnScriptTickObject_isProcessingTicks (string scripttickobject) return SafeNativeMethods.mwle_fnScriptTickObject_isProcessingTicks(sbscripttickobject)>=1; } /// -/// @brief Sets this object as either tick processing or not. @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// @brief Sets this object as either tick processing or not. +/// +/// @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// /// public void fnScriptTickObject_setProcessTicks (string scripttickobject, bool tick) @@ -29179,6 +37180,7 @@ public void fnScriptTickObject_setProcessTicks (string scripttickobject, bool ti } /// /// (Settings, write, bool, 2, 2, %success = settingObj.write();) +/// /// public bool fnSettings_write (string settings) @@ -29192,7 +37194,10 @@ public bool fnSettings_write (string settings) return SafeNativeMethods.mwle_fnSettings_write(sbsettings)>=1; } /// -/// Get the index of the playlist slot currently processed by the controller. @return The slot index currently being played. @see SFXPlayList ) +/// Get the index of the playlist slot currently processed by the controller. +/// @return The slot index currently being played. +/// @see SFXPlayList ) +/// /// public int fnSFXController_getCurrentSlot (string sfxcontroller) @@ -29206,7 +37211,9 @@ public int fnSFXController_getCurrentSlot (string sfxcontroller) return SafeNativeMethods.mwle_fnSFXController_getCurrentSlot(sbsfxcontroller); } /// -/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. @param index Index of the playlist slot. ) +/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. +/// @param index Index of the playlist slot. ) +/// /// public void fnSFXController_setCurrentSlot (string sfxcontroller, int index) @@ -29220,7 +37227,11 @@ public void fnSFXController_setCurrentSlot (string sfxcontroller, int index) SafeNativeMethods.mwle_fnSFXController_setCurrentSlot(sbsfxcontroller, index); } /// -/// Get the sound source object from the emitter. @return The sound source used by the emitter or null. @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts actually hold on to %SFXSources. ) +/// Get the sound source object from the emitter. +/// @return The sound source used by the emitter or null. +/// @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts +/// actually hold on to %SFXSources. ) +/// /// public string fnSFXEmitter_getSource (string sfxemitter) @@ -29237,7 +37248,9 @@ public string fnSFXEmitter_getSource (string sfxemitter) } /// -/// Manually start playback of the emitter's sound. If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// Manually start playback of the emitter's sound. +/// If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// /// public void fnSFXEmitter_play (string sfxemitter) @@ -29251,7 +37264,9 @@ public void fnSFXEmitter_play (string sfxemitter) SafeNativeMethods.mwle_fnSFXEmitter_play(sbsfxemitter); } /// -/// Manually stop playback of the emitter's sound. If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// Manually stop playback of the emitter's sound. +/// If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// /// public void fnSFXEmitter_stop (string sfxemitter) @@ -29265,7 +37280,9 @@ public void fnSFXEmitter_stop (string sfxemitter) SafeNativeMethods.mwle_fnSFXEmitter_stop(sbsfxemitter); } /// -/// Get the name of the parameter. @return The paramete name. ) +/// Get the name of the parameter. +/// @return The paramete name. ) +/// /// public string fnSFXParameter_getParameterName (string sfxparameter) @@ -29282,7 +37299,9 @@ public string fnSFXParameter_getParameterName (string sfxparameter) } /// -/// Reset the parameter's value to its default. @see SFXParameter::defaultValue ) +/// Reset the parameter's value to its default. +/// @see SFXParameter::defaultValue ) +/// /// public void fnSFXParameter_reset (string sfxparameter) @@ -29296,7 +37315,9 @@ public void fnSFXParameter_reset (string sfxparameter) SafeNativeMethods.mwle_fnSFXParameter_reset(sbsfxparameter); } /// -/// Return the length of the sound data in seconds. @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// Return the length of the sound data in seconds. +/// @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// /// public float fnSFXProfile_getSoundDuration (string sfxprofile) @@ -29310,7 +37331,10 @@ public float fnSFXProfile_getSoundDuration (string sfxprofile) return SafeNativeMethods.mwle_fnSFXProfile_getSoundDuration(sbsfxprofile); } /// -/// Get the total play time (in seconds) of the sound data attached to the sound. @return @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// Get the total play time (in seconds) of the sound data attached to the sound. +/// @return +/// @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// /// public float fnSFXSound_getDuration (string sfxsound) @@ -29324,7 +37348,9 @@ public float fnSFXSound_getDuration (string sfxsound) return SafeNativeMethods.mwle_fnSFXSound_getDuration(sbsfxsound); } /// -/// Get the current playback position in seconds. @return The current play cursor offset. ) +/// Get the current playback position in seconds. +/// @return The current play cursor offset. ) +/// /// public float fnSFXSound_getPosition (string sfxsound) @@ -29338,7 +37364,12 @@ public float fnSFXSound_getPosition (string sfxsound) return SafeNativeMethods.mwle_fnSFXSound_getPosition(sbsfxsound); } /// -/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. For streamed sounds, this will be false during playback when the stream queue for the sound is starved and waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to return false. @return True if the sound is ready for playback. ) +/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. +/// For streamed sounds, this will be false during playback when the stream queue for the sound is starved and +/// waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to +/// return false. +/// @return True if the sound is ready for playback. ) +/// /// public bool fnSFXSound_isReady (string sfxsound) @@ -29352,7 +37383,11 @@ public bool fnSFXSound_isReady (string sfxsound) return SafeNativeMethods.mwle_fnSFXSound_isReady(sbsfxsound)>=1; } /// -/// Set the current playback position in seconds. If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, playback will resume at the given position when play() is called. @param position The new position of the play cursor (in seconds). ) +/// Set the current playback position in seconds. +/// If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, +/// playback will resume at the given position when play() is called. +/// @param position The new position of the play cursor (in seconds). ) +/// /// public void fnSFXSound_setPosition (string sfxsound, float position) @@ -29366,7 +37401,32 @@ public void fnSFXSound_setPosition (string sfxsound, float position) SafeNativeMethods.mwle_fnSFXSound_setPosition(sbsfxsound, position); } /// -/// Add a notification marker called @a name at @a pos seconds of playback. @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there may be a delay between the play cursor actually passing the position and the callback being triggered. @note For looped sounds, the marker will trigger on each iteration. @tsexample // Create a new source. $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); // Assign a class to the source. $source.class = \"BackgroundMusic\"; // Add a playback marker at one minute into playback. $source.addMarker( \"first\", 60 ); // Define the callback function. This function will be called when the playback position passes the one minute mark. function BackgroundMusic::onMarkerPassed( %this, %markerName ) { if( %markerName $= \"first\" ) echo( \"Playback has passed the 60 seconds mark.\" ); } // Play the sound. $source.play(); @endtsexample ) +/// Add a notification marker called @a name at @a pos seconds of playback. +/// @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. +/// @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there +/// may be a delay between the play cursor actually passing the position and the callback being triggered. +/// @note For looped sounds, the marker will trigger on each iteration. +/// @tsexample +/// // Create a new source. +/// $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); +/// +/// // Assign a class to the source. +/// $source.class = \"BackgroundMusic\"; +/// +/// // Add a playback marker at one minute into playback. +/// $source.addMarker( \"first\", 60 ); +/// +/// // Define the callback function. This function will be called when the playback position passes the one minute mark. +/// function BackgroundMusic::onMarkerPassed( %this, %markerName ) +/// { +/// if( %markerName $= \"first\" ) +/// echo( \"Playback has passed the 60 seconds mark.\" ); +/// } +/// +/// // Play the sound. +/// $source.play(); +/// @endtsexample ) +/// /// public void fnSFXSource_addMarker (string sfxsource, string name, float pos) @@ -29383,7 +37443,11 @@ public void fnSFXSource_addMarker (string sfxsource, string name, float pos) SafeNativeMethods.mwle_fnSFXSource_addMarker(sbsfxsource, sbname, pos); } /// -/// Attach @a parameter to the source, Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter will also trigger an initial read-out of the parameter's current value. @param parameter The parameter to attach to the source. ) +/// Attach @a parameter to the source, +/// Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter +/// will also trigger an initial read-out of the parameter's current value. +/// @param parameter The parameter to attach to the source. ) +/// /// public void fnSFXSource_addParameter (string sfxsource, string parameter) @@ -29400,7 +37464,12 @@ public void fnSFXSource_addParameter (string sfxsource, string parameter) SafeNativeMethods.mwle_fnSFXSource_addParameter(sbsfxsource, sbparameter); } /// -/// Get the final effective volume level of the source. This method returns the volume level as it is after source group volume modulation, fades, and distance-based volume attenuation have been applied to the base volume level. @return The effective volume of the source. @ref SFXSource_volume ) +/// Get the final effective volume level of the source. +/// This method returns the volume level as it is after source group volume modulation, fades, and distance-based +/// volume attenuation have been applied to the base volume level. +/// @return The effective volume of the source. +/// @ref SFXSource_volume ) +/// /// public float fnSFXSource_getAttenuatedVolume (string sfxsource) @@ -29414,7 +37483,12 @@ public float fnSFXSource_getAttenuatedVolume (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getAttenuatedVolume(sbsfxsource); } /// -/// Get the fade-in time set on the source. This will initially be SFXDescription::fadeInTime. @return The fade-in time set on the source in seconds. @see SFXDescription::fadeInTime @ref SFXSource_fades ) +/// Get the fade-in time set on the source. +/// This will initially be SFXDescription::fadeInTime. +/// @return The fade-in time set on the source in seconds. +/// @see SFXDescription::fadeInTime +/// @ref SFXSource_fades ) +/// /// public float fnSFXSource_getFadeInTime (string sfxsource) @@ -29428,7 +37502,12 @@ public float fnSFXSource_getFadeInTime (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getFadeInTime(sbsfxsource); } /// -/// Get the fade-out time set on the source. This will initially be SFXDescription::fadeOutTime. @return The fade-out time set on the source in seconds. @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Get the fade-out time set on the source. +/// This will initially be SFXDescription::fadeOutTime. +/// @return The fade-out time set on the source in seconds. +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public float fnSFXSource_getFadeOutTime (string sfxsource) @@ -29442,7 +37521,17 @@ public float fnSFXSource_getFadeOutTime (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getFadeOutTime(sbsfxsource); } /// -/// Get the parameter at the given index. @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). @return The parameter at the given @a index or null if @a index is out of range. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameterCount ) +/// Get the parameter at the given index. +/// @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). +/// @return The parameter at the given @a index or null if @a index is out of range. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameterCount ) +/// /// public string fnSFXSource_getParameter (string sfxsource, int index) @@ -29459,7 +37548,17 @@ public string fnSFXSource_getParameter (string sfxsource, int index) } /// -/// Get the number of SFXParameters that are attached to the source. @return The number of parameters attached to the source. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameter @see addParameter ) +/// Get the number of SFXParameters that are attached to the source. +/// @return The number of parameters attached to the source. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameter +/// @see addParameter ) +/// /// public int fnSFXSource_getParameterCount (string sfxsource) @@ -29473,7 +37572,12 @@ public int fnSFXSource_getParameterCount (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getParameterCount(sbsfxsource); } /// -/// Get the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @return The current pitch scale factor of the source. @see setPitch @see SFXDescription::pitch ) +/// Get the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @return The current pitch scale factor of the source. +/// @see setPitch +/// @see SFXDescription::pitch ) +/// /// public float fnSFXSource_getPitch (string sfxsource) @@ -29487,7 +37591,9 @@ public float fnSFXSource_getPitch (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getPitch(sbsfxsource); } /// -/// Get the current playback status. @return Te current playback status ) +/// Get the current playback status. +/// @return Te current playback status ) +/// /// public int fnSFXSource_getStatus (string sfxsource) @@ -29501,7 +37607,14 @@ public int fnSFXSource_getStatus (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getStatus(sbsfxsource); } /// -/// Get the current base volume level of the source. This is not the final effective volume that the source is playing at but rather the starting volume level before source group modulation, fades, or distance-based volume attenuation are applied. @return The current base volume level. @see setVolume @see SFXDescription::volume @ref SFXSource_volume ) +/// Get the current base volume level of the source. +/// This is not the final effective volume that the source is playing at but rather the starting +/// volume level before source group modulation, fades, or distance-based volume attenuation are applied. +/// @return The current base volume level. +/// @see setVolume +/// @see SFXDescription::volume +/// @ref SFXSource_volume ) +/// /// public float fnSFXSource_getVolume (string sfxsource) @@ -29515,7 +37628,12 @@ public float fnSFXSource_getVolume (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getVolume(sbsfxsource); } /// -/// Test whether the source is currently paused. @return True if the source is in paused state, false otherwise. @see pause @see getStatus @see SFXStatus ) +/// Test whether the source is currently paused. +/// @return True if the source is in paused state, false otherwise. +/// @see pause +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool fnSFXSource_isPaused (string sfxsource) @@ -29529,7 +37647,12 @@ public bool fnSFXSource_isPaused (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_isPaused(sbsfxsource)>=1; } /// -/// Test whether the source is currently playing. @return True if the source is in playing state, false otherwise. @see play @see getStatus @see SFXStatus ) +/// Test whether the source is currently playing. +/// @return True if the source is in playing state, false otherwise. +/// @see play +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool fnSFXSource_isPlaying (string sfxsource) @@ -29543,7 +37666,12 @@ public bool fnSFXSource_isPlaying (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_isPlaying(sbsfxsource)>=1; } /// -/// Test whether the source is currently stopped. @return True if the source is in stopped state, false otherwise. @see stop @see getStatus @see SFXStatus ) +/// Test whether the source is currently stopped. +/// @return True if the source is in stopped state, false otherwise. +/// @see stop +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool fnSFXSource_isStopped (string sfxsource) @@ -29557,7 +37685,13 @@ public bool fnSFXSource_isStopped (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_isStopped(sbsfxsource)>=1; } /// -/// Pause playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately to paused state but will rather remain in playing state until the fade-out time has expired.. ) +/// Pause playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately to paused state but will +/// rather remain in playing state until the fade-out time has expired.. ) +/// /// public void fnSFXSource_pause (string sfxsource, float fadeOutTime) @@ -29571,7 +37705,13 @@ public void fnSFXSource_pause (string sfxsource, float fadeOutTime) SafeNativeMethods.mwle_fnSFXSource_pause(sbsfxsource, fadeOutTime); } /// -/// Start playback of the source. If the sound data for the source has not yet been fully loaded, there will be a delay after calling play and playback will start after the data has become available. @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime set in the source's associated description is used. Pass 0 to disable a fade-in effect that may be configured on the description. ) +/// Start playback of the source. +/// If the sound data for the source has not yet been fully loaded, there will be a delay after calling +/// play and playback will start after the data has become available. +/// @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime +/// set in the source's associated description is used. Pass 0 to disable a fade-in effect that may +/// be configured on the description. ) +/// /// public void fnSFXSource_play (string sfxsource, float fadeInTime) @@ -29585,7 +37725,11 @@ public void fnSFXSource_play (string sfxsource, float fadeInTime) SafeNativeMethods.mwle_fnSFXSource_play(sbsfxsource, fadeInTime); } /// -/// Detach @a parameter from the source. Once detached, the source will no longer react to value changes of the given @a parameter. If the parameter is not attached to the source, the method will do nothing. @param parameter The parameter to detach from the source. ) +/// Detach @a parameter from the source. +/// Once detached, the source will no longer react to value changes of the given @a parameter. +/// If the parameter is not attached to the source, the method will do nothing. +/// @param parameter The parameter to detach from the source. ) +/// /// public void fnSFXSource_removeParameter (string sfxsource, string parameter) @@ -29602,7 +37746,12 @@ public void fnSFXSource_removeParameter (string sfxsource, string parameter) SafeNativeMethods.mwle_fnSFXSource_removeParameter(sbsfxsource, sbparameter); } /// -/// Set up the 3D volume cone for the source. @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. @note This method has no effect on the source if the source is not 3D. ) +/// Set up the 3D volume cone for the source. +/// @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. +/// @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. +/// @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. +/// @note This method has no effect on the source if the source is not 3D. ) +/// /// public void fnSFXSource_setCone (string sfxsource, float innerAngle, float outerAngle, float outsideVolume) @@ -29616,7 +37765,13 @@ public void fnSFXSource_setCone (string sfxsource, float innerAngle, float outer SafeNativeMethods.mwle_fnSFXSource_setCone(sbsfxsource, innerAngle, outerAngle, outsideVolume); } /// -/// Set the fade time parameters of the source. @param fadeInTime The new fade-in time in seconds. @param fadeOutTime The new fade-out time in seconds. @see SFXDescription::fadeInTime @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Set the fade time parameters of the source. +/// @param fadeInTime The new fade-in time in seconds. +/// @param fadeOutTime The new fade-out time in seconds. +/// @see SFXDescription::fadeInTime +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public void fnSFXSource_setFadeTimes (string sfxsource, float fadeInTime, float fadeOutTime) @@ -29630,7 +37785,12 @@ public void fnSFXSource_setFadeTimes (string sfxsource, float fadeInTime, float SafeNativeMethods.mwle_fnSFXSource_setFadeTimes(sbsfxsource, fadeInTime, fadeOutTime); } /// -/// Set the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @param pitch The new pitch scale factor. @see getPitch @see SFXDescription::pitch ) +/// Set the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @param pitch The new pitch scale factor. +/// @see getPitch +/// @see SFXDescription::pitch ) +/// /// public void fnSFXSource_setPitch (string sfxsource, float pitch) @@ -29644,7 +37804,13 @@ public void fnSFXSource_setPitch (string sfxsource, float pitch) SafeNativeMethods.mwle_fnSFXSource_setPitch(sbsfxsource, pitch); } /// -/// Set the base volume level for the source. This volume will be the starting point for source group volume modulation, fades, and distance-based volume attenuation. @param volume The new base volume level for the source. Must be 0>=volume=1. @see getVolume @ref SFXSource_volume ) +/// Set the base volume level for the source. +/// This volume will be the starting point for source group volume modulation, fades, and distance-based +/// volume attenuation. +/// @param volume The new base volume level for the source. Must be 0>=volume=1. +/// @see getVolume +/// @ref SFXSource_volume ) +/// /// public void fnSFXSource_setVolume (string sfxsource, float volume) @@ -29658,7 +37824,13 @@ public void fnSFXSource_setVolume (string sfxsource, float volume) SafeNativeMethods.mwle_fnSFXSource_setVolume(sbsfxsource, volume); } /// -/// Stop playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but will rather remain in playing state until the fade-out time has expired. ) +/// Stop playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but +/// will rather remain in playing state until the fade-out time has expired. ) +/// /// public void fnSFXSource_stop (string sfxsource, float fadeOutTime) @@ -29672,7 +37844,11 @@ public void fnSFXSource_stop (string sfxsource, float fadeOutTime) SafeNativeMethods.mwle_fnSFXSource_stop(sbsfxsource, fadeOutTime); } /// -/// Increase the activation count on the state. If the state isn't already active and it is not disabled, the state will be activated. @see isActive @see deactivate ) +/// Increase the activation count on the state. +/// If the state isn't already active and it is not disabled, the state will be activated. +/// @see isActive +/// @see deactivate ) +/// /// public void fnSFXState_activate (string sfxstate) @@ -29686,7 +37862,11 @@ public void fnSFXState_activate (string sfxstate) SafeNativeMethods.mwle_fnSFXState_activate(sbsfxstate); } /// -/// Decrease the activation count on the state. If the count reaches zero and the state was not disabled, the state will be deactivated. @see isActive @see activate ) +/// Decrease the activation count on the state. +/// If the count reaches zero and the state was not disabled, the state will be deactivated. +/// @see isActive +/// @see activate ) +/// /// public void fnSFXState_deactivate (string sfxstate) @@ -29700,7 +37880,10 @@ public void fnSFXState_deactivate (string sfxstate) SafeNativeMethods.mwle_fnSFXState_deactivate(sbsfxstate); } /// -/// Increase the disabling count of the state. If the state is currently active, it will be deactivated. @see isDisabled ) +/// Increase the disabling count of the state. +/// If the state is currently active, it will be deactivated. +/// @see isDisabled ) +/// /// public void fnSFXState_disable (string sfxstate) @@ -29714,7 +37897,11 @@ public void fnSFXState_disable (string sfxstate) SafeNativeMethods.mwle_fnSFXState_disable(sbsfxstate); } /// -/// Decrease the disabling count of the state. If the disabling count reaches zero while the activation count is still non-zero, the state will be reactivated again. @see isDisabled ) +/// Decrease the disabling count of the state. +/// If the disabling count reaches zero while the activation count is still non-zero, +/// the state will be reactivated again. +/// @see isDisabled ) +/// /// public void fnSFXState_enable (string sfxstate) @@ -29728,7 +37915,11 @@ public void fnSFXState_enable (string sfxstate) SafeNativeMethods.mwle_fnSFXState_enable(sbsfxstate); } /// -/// Test whether the state is currently active. This is true when the activation count is >0 and the disabling count is =0. @return True if the state is currently active. @see activate ) +/// Test whether the state is currently active. +/// This is true when the activation count is >0 and the disabling count is =0. +/// @return True if the state is currently active. +/// @see activate ) +/// /// public bool fnSFXState_isActive (string sfxstate) @@ -29742,7 +37933,11 @@ public bool fnSFXState_isActive (string sfxstate) return SafeNativeMethods.mwle_fnSFXState_isActive(sbsfxstate)>=1; } /// -/// Test whether the state is currently disabled. This is true when the disabling count of the state is non-zero. @return True if the state is disabled. @see disable ) +/// Test whether the state is currently disabled. +/// This is true when the disabling count of the state is non-zero. +/// @return True if the state is disabled. +/// @see disable ) +/// /// public bool fnSFXState_isDisabled (string sfxstate) @@ -29756,7 +37951,13 @@ public bool fnSFXState_isDisabled (string sfxstate) return SafeNativeMethods.mwle_fnSFXState_isDisabled(sbsfxstate)>=1; } /// -/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. @tsexample // Rebuild the shader instances from ShaderData CloudLayerShader CloudLayerShader.reload(); @endtsexample) +/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. +/// +/// @tsexample +/// // Rebuild the shader instances from ShaderData CloudLayerShader +/// CloudLayerShader.reload(); +/// @endtsexample) +/// /// public void fnShaderData_reload (string shaderdata) @@ -29770,7 +37971,10 @@ public void fnShaderData_reload (string shaderdata) SafeNativeMethods.mwle_fnShaderData_reload(sbshaderdata); } /// -/// @brief Increment the current damage level by the specified amount. @param amount value to add to current damage level ) +/// @brief Increment the current damage level by the specified amount. +/// +/// @param amount value to add to current damage level ) +/// /// public void fnShapeBase_applyDamage (string shapebase, float amount) @@ -29784,7 +37988,12 @@ public void fnShapeBase_applyDamage (string shapebase, float amount) SafeNativeMethods.mwle_fnShapeBase_applyDamage(sbshapebase, amount); } /// -/// @brief Apply an impulse to the object. @param pos world position of the impulse @param vec impulse momentum (velocity * mass) @return true ) +/// @brief Apply an impulse to the object. +/// +/// @param pos world position of the impulse +/// @param vec impulse momentum (velocity * mass) +/// @return true ) +/// /// public bool fnShapeBase_applyImpulse (string shapebase, string pos, string vec) @@ -29804,7 +38013,13 @@ public bool fnShapeBase_applyImpulse (string shapebase, string pos, string vec) return SafeNativeMethods.mwle_fnShapeBase_applyImpulse(sbshapebase, sbpos, sbvec)>=1; } /// -/// @brief Repair damage by the specified amount. Note that the damage level is only reduced by repairRate per tick, so it may take several ticks for the total repair to complete. @param amount total repair value (subtracted from damage level over time) ) +/// @brief Repair damage by the specified amount. +/// +/// Note that the damage level is only reduced by repairRate per tick, so it may +/// take several ticks for the total repair to complete. +/// +/// @param amount total repair value (subtracted from damage level over time) ) +/// /// public void fnShapeBase_applyRepair (string shapebase, float amount) @@ -29819,6 +38034,7 @@ public void fnShapeBase_applyRepair (string shapebase, float amount) } /// /// @brief Explodes an object into pieces.) +/// /// public void fnShapeBase_blowUp (string shapebase) @@ -29832,7 +38048,11 @@ public void fnShapeBase_blowUp (string shapebase) SafeNativeMethods.mwle_fnShapeBase_blowUp(sbshapebase); } /// -/// @brief Check if this object can cloak. @return true @note Not implemented as it always returns true.) +/// @brief Check if this object can cloak. +/// @return true +/// +/// @note Not implemented as it always returns true.) +/// /// public bool fnShapeBase_canCloak (string shapebase) @@ -29846,7 +38066,24 @@ public bool fnShapeBase_canCloak (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_canCloak(sbshapebase)>=1; } /// -/// @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void fnShapeBase_changeMaterial (string shapebase, string mapTo, string oldMat, string newMat) @@ -29869,7 +38106,13 @@ public void fnShapeBase_changeMaterial (string shapebase, string mapTo, string o SafeNativeMethods.mwle_fnShapeBase_changeMaterial(sbshapebase, sbmapTo, sboldMat, sbnewMat); } /// -/// @brief Destroy an animation thread, which prevents it from playing. @param slot thread slot to destroy @return true if successful, false if failed @see playThread ) +/// @brief Destroy an animation thread, which prevents it from playing. +/// +/// @param slot thread slot to destroy +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_destroyThread (string shapebase, int slot) @@ -29883,7 +38126,10 @@ public bool fnShapeBase_destroyThread (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_destroyThread(sbshapebase, slot)>=1; } /// -/// @brief Print a list of visible and hidden meshes in the shape to the console for debugging purposes. @note Only in a SHIPPING build.) +/// @brief Print a list of visible and hidden meshes in the shape to the console +/// for debugging purposes. +/// @note Only in a SHIPPING build.) +/// /// public void fnShapeBase_dumpMeshVisibility (string shapebase) @@ -29897,7 +38143,12 @@ public void fnShapeBase_dumpMeshVisibility (string shapebase) SafeNativeMethods.mwle_fnShapeBase_dumpMeshVisibility(sbshapebase); } /// -/// @brief Get the position at which the AI should stand to repair things. If the shape defines a node called \"AIRepairNode\", this method will return the current world position of that node, otherwise \"0 0 0\". @return the AI repair position ) +/// @brief Get the position at which the AI should stand to repair things. +/// +/// If the shape defines a node called \"AIRepairNode\", this method will +/// return the current world position of that node, otherwise \"0 0 0\". +/// @return the AI repair position ) +/// /// public string fnShapeBase_getAIRepairPoint (string shapebase) @@ -29914,7 +38165,10 @@ public string fnShapeBase_getAIRepairPoint (string shapebase) } /// -/// @brief Returns the vertical field of view in degrees for this object if used as a camera. @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// @brief Returns the vertical field of view in degrees for this object if used as a camera. +/// +/// @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// /// public float fnShapeBase_getCameraFov (string shapebase) @@ -29928,7 +38182,15 @@ public float fnShapeBase_getCameraFov (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getCameraFov(sbshapebase); } /// -/// @brief Get the client (if any) that controls this object. The controlling client is the one that will send moves to us to act on. @return the ID of the controlling GameConnection, or 0 if this object is not controlled by any client. @see GameConnection) +/// @brief Get the client (if any) that controls this object. +/// +/// The controlling client is the one that will send moves to us to act on. +/// +/// @return the ID of the controlling GameConnection, or 0 if this object is not +/// controlled by any client. +/// +/// @see GameConnection) +/// /// public int fnShapeBase_getControllingClient (string shapebase) @@ -29942,7 +38204,11 @@ public int fnShapeBase_getControllingClient (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getControllingClient(sbshapebase); } /// -/// @brief Get the object (if any) that controls this object. @return the ID of the controlling ShapeBase object, or 0 if this object is not controlled by another object. ) +/// @brief Get the object (if any) that controls this object. +/// +/// @return the ID of the controlling ShapeBase object, or 0 if this object is +/// not controlled by another object. ) +/// /// public int fnShapeBase_getControllingObject (string shapebase) @@ -29956,7 +38222,12 @@ public int fnShapeBase_getControllingObject (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getControllingObject(sbshapebase); } /// -/// @brief Get the damage flash level. @return flash level @see setDamageFlash ) +/// @brief Get the damage flash level. +/// +/// @return flash level +/// +/// @see setDamageFlash ) +/// /// public float fnShapeBase_getDamageFlash (string shapebase) @@ -29970,7 +38241,12 @@ public float fnShapeBase_getDamageFlash (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDamageFlash(sbshapebase); } /// -/// @brief Get the object's current damage level. @return damage level @see setDamageLevel()) +/// @brief Get the object's current damage level. +/// +/// @return damage level +/// +/// @see setDamageLevel()) +/// /// public float fnShapeBase_getDamageLevel (string shapebase) @@ -29984,7 +38260,12 @@ public float fnShapeBase_getDamageLevel (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDamageLevel(sbshapebase); } /// -/// @brief Get the object's current damage level as a percentage of maxDamage. @return damageLevel / datablock.maxDamage @see setDamageLevel()) +/// @brief Get the object's current damage level as a percentage of maxDamage. +/// +/// @return damageLevel / datablock.maxDamage +/// +/// @see setDamageLevel()) +/// /// public float fnShapeBase_getDamagePercent (string shapebase) @@ -29998,7 +38279,12 @@ public float fnShapeBase_getDamagePercent (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDamagePercent(sbshapebase); } /// -/// @brief Get the object's damage state. @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" @see setDamageState()) +/// @brief Get the object's damage state. +/// +/// @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// +/// @see setDamageState()) +/// /// public string fnShapeBase_getDamageState (string shapebase) @@ -30015,7 +38301,10 @@ public string fnShapeBase_getDamageState (string shapebase) } /// -/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. @return Default FOV ) +/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. +/// +/// @return Default FOV ) +/// /// public float fnShapeBase_getDefaultCameraFov (string shapebase) @@ -30029,7 +38318,12 @@ public float fnShapeBase_getDefaultCameraFov (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDefaultCameraFov(sbshapebase); } /// -/// @brief Get the object's current energy level. @return energy level @see setEnergyLevel()) +/// @brief Get the object's current energy level. +/// +/// @return energy level +/// +/// @see setEnergyLevel()) +/// /// public float fnShapeBase_getEnergyLevel (string shapebase) @@ -30043,7 +38337,11 @@ public float fnShapeBase_getEnergyLevel (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getEnergyLevel(sbshapebase); } /// -/// @brief Get the object's current energy level as a percentage of maxEnergy. @return energyLevel / datablock.maxEnergy @see setEnergyLevel()) +/// @brief Get the object's current energy level as a percentage of maxEnergy. +/// @return energyLevel / datablock.maxEnergy +/// +/// @see setEnergyLevel()) +/// /// public float fnShapeBase_getEnergyPercent (string shapebase) @@ -30057,7 +38355,17 @@ public float fnShapeBase_getEnergyPercent (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getEnergyPercent(sbshapebase); } /// -/// @brief Get the position of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current world position, otherwise it will return the object's current world position. @return the eye position for this object @see getEyeVector @see getEyeTransform ) +/// @brief Get the position of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current world position, otherwise it will return the object's current +/// world position. +/// +/// @return the eye position for this object +/// +/// @see getEyeVector +/// @see getEyeTransform ) +/// /// public string fnShapeBase_getEyePoint (string shapebase) @@ -30074,7 +38382,17 @@ public string fnShapeBase_getEyePoint (string shapebase) } /// -/// @brief Get the 'eye' transform for this object. If the object model has a node called 'eye', this method will return that node's current transform, otherwise it will return the object's current transform. @return the eye transform for this object @see getEyeVector @see getEyePoint ) +/// @brief Get the 'eye' transform for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current transform, otherwise it will return the object's current +/// transform. +/// +/// @return the eye transform for this object +/// +/// @see getEyeVector +/// @see getEyePoint ) +/// /// public string fnShapeBase_getEyeTransform (string shapebase) @@ -30091,7 +38409,17 @@ public string fnShapeBase_getEyeTransform (string shapebase) } /// -/// @brief Get the forward direction of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current forward direction vector, otherwise it will return the object's current forward direction vector. @return the eye vector for this object @see getEyePoint @see getEyeTransform ) +/// @brief Get the forward direction of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current forward direction vector, otherwise it will return the +/// object's current forward direction vector. +/// +/// @return the eye vector for this object +/// +/// @see getEyePoint +/// @see getEyeTransform ) +/// /// public string fnShapeBase_getEyeVector (string shapebase) @@ -30108,7 +38436,11 @@ public string fnShapeBase_getEyeVector (string shapebase) } /// -/// @brief Get the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current alt trigger state ) +/// @brief Get the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current alt trigger state ) +/// /// public bool fnShapeBase_getImageAltTrigger (string shapebase, int slot) @@ -30122,7 +38454,11 @@ public bool fnShapeBase_getImageAltTrigger (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageAltTrigger(sbshapebase, slot)>=1; } /// -/// @brief Get the ammo state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current ammo state ) +/// @brief Get the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current ammo state ) +/// /// public bool fnShapeBase_getImageAmmo (string shapebase, int slot) @@ -30136,7 +38472,12 @@ public bool fnShapeBase_getImageAmmo (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageAmmo(sbshapebase, slot)>=1; } /// -/// @brief Get the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to query @param trigger Generic trigger number @return the Image's current generic trigger state ) +/// @brief Get the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @param trigger Generic trigger number +/// @return the Image's current generic trigger state ) +/// /// public bool fnShapeBase_getImageGenericTrigger (string shapebase, int slot, int trigger) @@ -30150,7 +38491,11 @@ public bool fnShapeBase_getImageGenericTrigger (string shapebase, int slot, int return SafeNativeMethods.mwle_fnShapeBase_getImageGenericTrigger(sbshapebase, slot, trigger)>=1; } /// -/// @brief Get the loaded state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current loaded state ) +/// @brief Get the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current loaded state ) +/// /// public bool fnShapeBase_getImageLoaded (string shapebase, int slot) @@ -30164,7 +38509,11 @@ public bool fnShapeBase_getImageLoaded (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageLoaded(sbshapebase, slot)>=1; } /// -/// @brief Get the script animation prefix of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current script animation prefix ) +/// @brief Get the script animation prefix of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current script animation prefix ) +/// /// public string fnShapeBase_getImageScriptAnimPrefix (string shapebase, int slot) @@ -30181,7 +38530,12 @@ public string fnShapeBase_getImageScriptAnimPrefix (string shapebase, int slot) } /// -/// @brief Get the skin tag ID for the Image mounted in the specified slot. @param slot Image slot to query @return the skinTag value passed to mountImage when the image was mounted ) +/// @brief Get the skin tag ID for the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the skinTag value passed to mountImage when the image was +/// mounted ) +/// /// public int fnShapeBase_getImageSkinTag (string shapebase, int slot) @@ -30195,7 +38549,11 @@ public int fnShapeBase_getImageSkinTag (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageSkinTag(sbshapebase, slot); } /// -/// @brief Get the name of the current state of the Image in the specified slot. @param slot Image slot to query @return name of the current Image state, or \"Error\" if slot is invalid ) +/// @brief Get the name of the current state of the Image in the specified slot. +/// +/// @param slot Image slot to query +/// @return name of the current Image state, or \"Error\" if slot is invalid ) +/// /// public string fnShapeBase_getImageState (string shapebase, int slot) @@ -30212,7 +38570,11 @@ public string fnShapeBase_getImageState (string shapebase, int slot) } /// -/// @brief Get the target state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current target state ) +/// @brief Get the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current target state ) +/// /// public bool fnShapeBase_getImageTarget (string shapebase, int slot) @@ -30226,7 +38588,11 @@ public bool fnShapeBase_getImageTarget (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageTarget(sbshapebase, slot)>=1; } /// -/// @brief Get the trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current trigger state ) +/// @brief Get the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current trigger state ) +/// /// public bool fnShapeBase_getImageTrigger (string shapebase, int slot) @@ -30240,7 +38606,19 @@ public bool fnShapeBase_getImageTrigger (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageTrigger(sbshapebase, slot)>=1; } /// -/// @brief Get the world position this object is looking at. Casts a ray from the eye and returns information about what the ray hits. @param distance maximum distance of the raycast @param typeMask typeMask of objects to include for raycast collision testing @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit @tsexample %lookat = %obj.getLookAtPoint(); echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); @endtsexample ) +/// @brief Get the world position this object is looking at. +/// +/// Casts a ray from the eye and returns information about what the ray hits. +/// +/// @param distance maximum distance of the raycast +/// @param typeMask typeMask of objects to include for raycast collision testing +/// @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit +/// +/// @tsexample +/// %lookat = %obj.getLookAtPoint(); +/// echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); +/// @endtsexample ) +/// /// public string fnShapeBase_getLookAtPoint (string shapebase, float distance, uint typeMask) @@ -30257,7 +38635,9 @@ public string fnShapeBase_getLookAtPoint (string shapebase, float distance, uint } /// -/// Get the object's maxDamage level. @return datablock.maxDamage) +/// Get the object's maxDamage level. +/// @return datablock.maxDamage) +/// /// public float fnShapeBase_getMaxDamage (string shapebase) @@ -30271,7 +38651,10 @@ public float fnShapeBase_getMaxDamage (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getMaxDamage(sbshapebase); } /// -/// @brief Get the model filename used by this shape. @return the shape filename ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename ) +/// /// public string fnShapeBase_getModelFile (string shapebase) @@ -30288,7 +38671,12 @@ public string fnShapeBase_getModelFile (string shapebase) } /// -/// @brief Get the Image mounted in the specified slot. @param slot Image slot to query @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 if no Image is mounted there. ) +/// @brief Get the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 +/// if no Image is mounted there. ) +/// /// public int fnShapeBase_getMountedImage (string shapebase, int slot) @@ -30302,7 +38690,13 @@ public int fnShapeBase_getMountedImage (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getMountedImage(sbshapebase, slot); } /// -/// @brief Get the first slot the given datablock is mounted to on this object. @param image ShapeBaseImageData datablock to query @return index of the first slot the Image is mounted in, or -1 if the Image is not mounted in any slot on this object. ) +/// @brief Get the first slot the given datablock is mounted to on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return index of the first slot the Image is mounted in, or -1 if the Image +/// is not mounted in any slot on this object. ) +/// +/// /// public int fnShapeBase_getMountSlot (string shapebase, string image) @@ -30319,7 +38713,15 @@ public int fnShapeBase_getMountSlot (string shapebase, string image) return SafeNativeMethods.mwle_fnShapeBase_getMountSlot(sbshapebase, sbimage); } /// -/// @brief Get the muzzle position of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle position is the position of that node in world space. If no such node is specified, the slot's mount node is used instead. @param slot Image slot to query @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// @brief Get the muzzle position of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// position is the position of that node in world space. If no such node +/// is specified, the slot's mount node is used instead. +/// +/// @param slot Image slot to query +/// @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// /// public string fnShapeBase_getMuzzlePoint (string shapebase, int slot) @@ -30336,7 +38738,20 @@ public string fnShapeBase_getMuzzlePoint (string shapebase, int slot) } /// -/// @brief Get the muzzle vector of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle vector is the forward direction vector of that node's transform in world space. If no such node is specified, the slot's mount node is used instead. If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) is set in the Image, the muzzle vector is computed to point at whatever object is right in front of the object's 'eye' node. @param slot Image slot to query @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// @brief Get the muzzle vector of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// vector is the forward direction vector of that node's transform in world +/// space. If no such node is specified, the slot's mount node is used +/// instead. +/// +/// If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) +/// is set in the Image, the muzzle vector is computed to point at whatever +/// object is right in front of the object's 'eye' node. +/// +/// @param slot Image slot to query +/// @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// /// public string fnShapeBase_getMuzzleVector (string shapebase, int slot) @@ -30353,7 +38768,20 @@ public string fnShapeBase_getMuzzleVector (string shapebase, int slot) } /// -/// @brief Get the Image that will be mounted next in the specified slot. Calling mountImage when an Image is already mounted does one of two things: ol>li>Mount the new Image immediately, the old Image is discarded and whatever state it was in is ignored./li> li>If the current Image state does not allow Image changes, the new Image is marked as pending, and will not be mounted until the current state completes. eg. if the user changes weapons, you may wish to ensure that the current weapon firing state plays to completion first./li>/ol> This command retrieves the ID of the pending Image (2nd case above). @param slot Image slot to query @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// @brief Get the Image that will be mounted next in the specified slot. +/// +/// Calling mountImage when an Image is already mounted does one of two things: +/// ol>li>Mount the new Image immediately, the old Image is discarded and +/// whatever state it was in is ignored./li> +/// li>If the current Image state does not allow Image changes, the new +/// Image is marked as pending, and will not be mounted until the current +/// state completes. eg. if the user changes weapons, you may wish to ensure +/// that the current weapon firing state plays to completion first./li>/ol> +/// This command retrieves the ID of the pending Image (2nd case above). +/// +/// @param slot Image slot to query +/// @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// /// public int fnShapeBase_getPendingImage (string shapebase, int slot) @@ -30367,7 +38795,12 @@ public int fnShapeBase_getPendingImage (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getPendingImage(sbshapebase, slot); } /// -/// @brief Get the current recharge rate. @return the recharge rate (per tick) @see setRechargeRate()) +/// @brief Get the current recharge rate. +/// +/// @return the recharge rate (per tick) +/// +/// @see setRechargeRate()) +/// /// public float fnShapeBase_getRechargeRate (string shapebase) @@ -30381,7 +38814,12 @@ public float fnShapeBase_getRechargeRate (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getRechargeRate(sbshapebase); } /// -/// @brief Get the per-tick repair amount. @return the current value to be subtracted from damage level each tick @see setRepairRate ) +/// @brief Get the per-tick repair amount. +/// +/// @return the current value to be subtracted from damage level each tick +/// +/// @see setRepairRate ) +/// /// public float fnShapeBase_getRepairRate (string shapebase) @@ -30395,7 +38833,15 @@ public float fnShapeBase_getRepairRate (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getRepairRate(sbshapebase); } /// -/// @brief Get the name of the shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @return the name of the shape @see setShapeName()) +/// @brief Get the name of the shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @return the name of the shape +/// +/// @see setShapeName()) +/// /// public string fnShapeBase_getShapeName (string shapebase) @@ -30412,7 +38858,13 @@ public string fnShapeBase_getShapeName (string shapebase) } /// -/// @brief Get the name of the skin applied to this shape. @return the name of the skin @see skin @see setSkinName()) +/// @brief Get the name of the skin applied to this shape. +/// +/// @return the name of the skin +/// +/// @see skin +/// @see setSkinName()) +/// /// public string fnShapeBase_getSkinName (string shapebase) @@ -30429,7 +38881,11 @@ public string fnShapeBase_getSkinName (string shapebase) } /// -/// @brief Get the world transform of the specified mount slot. @param slot Image slot to query @return the mount transform ) +/// @brief Get the world transform of the specified mount slot. +/// +/// @param slot Image slot to query +/// @return the mount transform ) +/// /// public string fnShapeBase_getSlotTransform (string shapebase, int slot) @@ -30446,7 +38902,12 @@ public string fnShapeBase_getSlotTransform (string shapebase, int slot) } /// -/// @brief Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// @brief Get the number of materials in the shape. +/// +/// @return the number of materials in the shape. +/// +/// @see getTargetName()) +/// /// public int fnShapeBase_getTargetCount (string shapebase) @@ -30460,7 +38921,13 @@ public int fnShapeBase_getTargetCount (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getTargetCount(sbshapebase); } /// -/// @brief Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// @brief Get the name of the indexed shape material. +/// +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// +/// @see getTargetCount()) +/// /// public string fnShapeBase_getTargetName (string shapebase, int index) @@ -30477,7 +38944,10 @@ public string fnShapeBase_getTargetName (string shapebase, int index) } /// -/// @brief Get the object's current velocity. @return the current velocity ) +/// @brief Get the object's current velocity. +/// +/// @return the current velocity ) +/// /// public string fnShapeBase_getVelocity (string shapebase) @@ -30494,7 +38964,12 @@ public string fnShapeBase_getVelocity (string shapebase) } /// -/// @brief Get the white-out level. @return white-out level @see setWhiteOut ) +/// @brief Get the white-out level. +/// +/// @return white-out level +/// +/// @see setWhiteOut ) +/// /// public float fnShapeBase_getWhiteOut (string shapebase) @@ -30508,7 +38983,12 @@ public float fnShapeBase_getWhiteOut (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getWhiteOut(sbshapebase); } /// -/// @brief Check if the given state exists on the mounted Image. @param slot Image slot to query @param state Image state to check for @return true if the Image has the requested state defined. ) +/// @brief Check if the given state exists on the mounted Image. +/// +/// @param slot Image slot to query +/// @param state Image state to check for +/// @return true if the Image has the requested state defined. ) +/// /// public bool fnShapeBase_hasImageState (string shapebase, int slot, string state) @@ -30525,7 +39005,12 @@ public bool fnShapeBase_hasImageState (string shapebase, int slot, string state) return SafeNativeMethods.mwle_fnShapeBase_hasImageState(sbshapebase, slot, sbstate)>=1; } /// -/// @brief Check if this object is cloaked. @return true if cloaked, false if not @see setCloaked()) +/// @brief Check if this object is cloaked. +/// +/// @return true if cloaked, false if not +/// +/// @see setCloaked()) +/// /// public bool fnShapeBase_isCloaked (string shapebase) @@ -30539,7 +39024,13 @@ public bool fnShapeBase_isCloaked (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isCloaked(sbshapebase)>=1; } /// -/// @brief Check if the object is in the Destroyed damage state. @return true if damage state is \"Destroyed\", false if not @see isDisabled() @see isEnabled()) +/// @brief Check if the object is in the Destroyed damage state. +/// +/// @return true if damage state is \"Destroyed\", false if not +/// +/// @see isDisabled() +/// @see isEnabled()) +/// /// public bool fnShapeBase_isDestroyed (string shapebase) @@ -30553,7 +39044,13 @@ public bool fnShapeBase_isDestroyed (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isDestroyed(sbshapebase)>=1; } /// -/// @brief Check if the object is in the Disabled or Destroyed damage state. @return true if damage state is not \"Enabled\", false if it is @see isDestroyed() @see isEnabled()) +/// @brief Check if the object is in the Disabled or Destroyed damage state. +/// +/// @return true if damage state is not \"Enabled\", false if it is +/// +/// @see isDestroyed() +/// @see isEnabled()) +/// /// public bool fnShapeBase_isDisabled (string shapebase) @@ -30567,7 +39064,13 @@ public bool fnShapeBase_isDisabled (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isDisabled(sbshapebase)>=1; } /// -/// @brief Check if the object is in the Enabled damage state. @return true if damage state is \"Enabled\", false if not @see isDestroyed() @see isDisabled()) +/// @brief Check if the object is in the Enabled damage state. +/// +/// @return true if damage state is \"Enabled\", false if not +/// +/// @see isDestroyed() +/// @see isDisabled()) +/// /// public bool fnShapeBase_isEnabled (string shapebase) @@ -30581,7 +39084,9 @@ public bool fnShapeBase_isEnabled (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isEnabled(sbshapebase)>=1; } /// -/// Check if the object is hidden. @return true if the object is hidden, false if visible. ) +/// Check if the object is hidden. +/// @return true if the object is hidden, false if visible. ) +/// /// public bool fnShapeBase_isHidden (string shapebase) @@ -30595,7 +39100,11 @@ public bool fnShapeBase_isHidden (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isHidden(sbshapebase)>=1; } /// -/// @brief Check if the current Image state is firing. @param slot Image slot to query @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// @brief Check if the current Image state is firing. +/// +/// @param slot Image slot to query +/// @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// /// public bool fnShapeBase_isImageFiring (string shapebase, int slot) @@ -30609,7 +39118,11 @@ public bool fnShapeBase_isImageFiring (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_isImageFiring(sbshapebase, slot)>=1; } /// -/// @brief Check if the given datablock is mounted to any slot on this object. @param image ShapeBaseImageData datablock to query @return true if the Image is mounted to any slot, false otherwise. ) +/// @brief Check if the given datablock is mounted to any slot on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return true if the Image is mounted to any slot, false otherwise. ) +/// /// public bool fnShapeBase_isImageMounted (string shapebase, string image) @@ -30626,7 +39139,26 @@ public bool fnShapeBase_isImageMounted (string shapebase, string image) return SafeNativeMethods.mwle_fnShapeBase_isImageMounted(sbshapebase, sbimage)>=1; } /// -/// ), @brief Mount a new Image. @param image the Image to mount @param slot Image slot to mount into (valid range is 0 - 3) @param loaded initial loaded state for the Image @param skinTag tagged string to reskin the mounted Image @return true if successful, false if failed @tsexample %player.mountImage( PistolImage, 1 ); %player.mountImage( CrossbowImage, 0, false ); %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); @endtsexample @see unmountImage() @see getMountedImage() @see getPendingImage() @see isImageMounted()) +/// ), +/// @brief Mount a new Image. +/// +/// @param image the Image to mount +/// @param slot Image slot to mount into (valid range is 0 - 3) +/// @param loaded initial loaded state for the Image +/// @param skinTag tagged string to reskin the mounted Image +/// @return true if successful, false if failed +/// +/// @tsexample +/// %player.mountImage( PistolImage, 1 ); +/// %player.mountImage( CrossbowImage, 0, false ); +/// %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); +/// @endtsexample +/// +/// @see unmountImage() +/// @see getMountedImage() +/// @see getPendingImage() +/// @see isImageMounted()) +/// /// public bool fnShapeBase_mountImage (string shapebase, string image, int slot, bool loaded, string skinTag) @@ -30646,7 +39178,15 @@ public bool fnShapeBase_mountImage (string shapebase, string image, int slot, bo return SafeNativeMethods.mwle_fnShapeBase_mountImage(sbshapebase, sbimage, slot, loaded, sbskinTag)>=1; } /// -/// @brief Pause an animation thread. If restarted using playThread, the animation will resume from the paused position. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Pause an animation thread. +/// +/// If restarted using playThread, the animation +/// will resume from the paused position. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_pauseThread (string shapebase, int slot) @@ -30660,7 +39200,13 @@ public bool fnShapeBase_pauseThread (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_pauseThread(sbshapebase, slot)>=1; } /// -/// @brief Attach a sound to this shape and start playing it. @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play @return true if the sound was attached successfully, false if failed @see stopAudio()) +/// @brief Attach a sound to this shape and start playing it. +/// +/// @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play +/// @return true if the sound was attached successfully, false if failed +/// +/// @see stopAudio()) +/// /// public bool fnShapeBase_playAudio (string shapebase, int slot, string track) @@ -30677,7 +39223,28 @@ public bool fnShapeBase_playAudio (string shapebase, int slot, string track) return SafeNativeMethods.mwle_fnShapeBase_playAudio(sbshapebase, slot, sbtrack)>=1; } /// -/// ), @brief Start a new animation thread, or restart one that has been paused or stopped. @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not specified, the paused or stopped thread in this slot will be resumed. @return true if successful, false if failed @tsexample %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed %obj.pauseThread( 0 ); // Pause the sequence %obj.playThread( 0 ); // Resume playback %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 @endtsexample @see pauseThread() @see stopThread() @see setThreadDir() @see setThreadTimeScale() @see destroyThread()) +/// ), +/// @brief Start a new animation thread, or restart one that has been paused or +/// stopped. +/// +/// @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not +/// specified, the paused or stopped thread in this slot will be resumed. +/// @return true if successful, false if failed +/// +/// @tsexample +/// %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 +/// %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed +/// %obj.pauseThread( 0 ); // Pause the sequence +/// %obj.playThread( 0 ); // Resume playback +/// %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 +/// @endtsexample +/// +/// @see pauseThread() +/// @see stopThread() +/// @see setThreadDir() +/// @see setThreadTimeScale() +/// @see destroyThread()) +/// /// public bool fnShapeBase_playThread (string shapebase, int slot, string name) @@ -30694,7 +39261,13 @@ public bool fnShapeBase_playThread (string shapebase, int slot, string name) return SafeNativeMethods.mwle_fnShapeBase_playThread(sbshapebase, slot, sbname)>=1; } /// -/// @brief Set the hidden state on all the shape meshes. This allows you to hide all meshes in the shape, for example, and then only enable a few. @param hide new hidden state for all meshes ) +/// @brief Set the hidden state on all the shape meshes. +/// +/// This allows you to hide all meshes in the shape, for example, and then only +/// enable a few. +/// +/// @param hide new hidden state for all meshes ) +/// /// public void fnShapeBase_setAllMeshesHidden (string shapebase, bool hide) @@ -30708,7 +39281,10 @@ public void fnShapeBase_setAllMeshesHidden (string shapebase, bool hide) SafeNativeMethods.mwle_fnShapeBase_setAllMeshesHidden(sbshapebase, hide); } /// -/// @brief Set the vertical field of view in degrees for this object if used as a camera. @param fov new FOV value ) +/// @brief Set the vertical field of view in degrees for this object if used as a camera. +/// +/// @param fov new FOV value ) +/// /// public void fnShapeBase_setCameraFov (string shapebase, float fov) @@ -30722,7 +39298,14 @@ public void fnShapeBase_setCameraFov (string shapebase, float fov) SafeNativeMethods.mwle_fnShapeBase_setCameraFov(sbshapebase, fov); } /// -/// @brief Set the cloaked state of this object. When an object is cloaked it is not rendered. @param cloak true to cloak the object, false to uncloak @see isCloaked()) +/// @brief Set the cloaked state of this object. +/// +/// When an object is cloaked it is not rendered. +/// +/// @param cloak true to cloak the object, false to uncloak +/// +/// @see isCloaked()) +/// /// public void fnShapeBase_setCloaked (string shapebase, bool cloak) @@ -30736,7 +39319,17 @@ public void fnShapeBase_setCloaked (string shapebase, bool cloak) SafeNativeMethods.mwle_fnShapeBase_setCloaked(sbshapebase, cloak); } /// -/// @brief Set the damage flash level. Damage flash may be used as a postfx effect to flash the screen when the client is damaged. @note Relies on the flash postFx. @param level flash level (0-1) @see getDamageFlash()) +/// @brief Set the damage flash level. +/// +/// Damage flash may be used as a postfx effect to flash the screen when the +/// client is damaged. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getDamageFlash()) +/// /// public void fnShapeBase_setDamageFlash (string shapebase, float level) @@ -30750,7 +39343,13 @@ public void fnShapeBase_setDamageFlash (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setDamageFlash(sbshapebase, level); } /// -/// @brief Set the object's current damage level. @param level new damage level @see getDamageLevel() @see getDamagePercent()) +/// @brief Set the object's current damage level. +/// +/// @param level new damage level +/// +/// @see getDamageLevel() +/// @see getDamagePercent()) +/// /// public void fnShapeBase_setDamageLevel (string shapebase, float level) @@ -30764,7 +39363,13 @@ public void fnShapeBase_setDamageLevel (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setDamageLevel(sbshapebase, level); } /// -/// @brief Set the object's damage state. @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" @return true if successful, false if failed @see getDamageState()) +/// @brief Set the object's damage state. +/// +/// @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// @return true if successful, false if failed +/// +/// @see getDamageState()) +/// /// public bool fnShapeBase_setDamageState (string shapebase, string state) @@ -30781,7 +39386,17 @@ public bool fnShapeBase_setDamageState (string shapebase, string state) return SafeNativeMethods.mwle_fnShapeBase_setDamageState(sbshapebase, sbstate)>=1; } /// -/// @brief Set the damage direction vector. Currently this is only used to initialise the explosion if this object is blown up. @param vec damage direction vector @tsexample %obj.setDamageVector( \"0 0 1\" ); @endtsexample ) +/// @brief Set the damage direction vector. +/// +/// Currently this is only used to initialise the explosion if this object +/// is blown up. +/// +/// @param vec damage direction vector +/// +/// @tsexample +/// %obj.setDamageVector( \"0 0 1\" ); +/// @endtsexample ) +/// /// public void fnShapeBase_setDamageVector (string shapebase, string vec) @@ -30798,7 +39413,13 @@ public void fnShapeBase_setDamageVector (string shapebase, string vec) SafeNativeMethods.mwle_fnShapeBase_setDamageVector(sbshapebase, sbvec); } /// -/// @brief Set this object's current energy level. @param level new energy level @see getEnergyLevel() @see getEnergyPercent()) +/// @brief Set this object's current energy level. +/// +/// @param level new energy level +/// +/// @see getEnergyLevel() +/// @see getEnergyPercent()) +/// /// public void fnShapeBase_setEnergyLevel (string shapebase, float level) @@ -30812,7 +39433,10 @@ public void fnShapeBase_setEnergyLevel (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setEnergyLevel(sbshapebase, level); } /// -/// @brief Add or remove this object from the scene. When removed from the scene, the object will not be processed or rendered. @param show False to hide the object, true to re-show it ) +/// @brief Add or remove this object from the scene. +/// When removed from the scene, the object will not be processed or rendered. +/// @param show False to hide the object, true to re-show it ) +/// /// public void fnShapeBase_setHidden (string shapebase, bool show) @@ -30826,7 +39450,12 @@ public void fnShapeBase_setHidden (string shapebase, bool show) SafeNativeMethods.mwle_fnShapeBase_setHidden(sbshapebase, show); } /// -/// @brief Set the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new alt trigger state for the Image @return the Image's new alt trigger state ) +/// @brief Set the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new alt trigger state for the Image +/// @return the Image's new alt trigger state ) +/// /// public bool fnShapeBase_setImageAltTrigger (string shapebase, int slot, bool state) @@ -30840,7 +39469,12 @@ public bool fnShapeBase_setImageAltTrigger (string shapebase, int slot, bool sta return SafeNativeMethods.mwle_fnShapeBase_setImageAltTrigger(sbshapebase, slot, state)>=1; } /// -/// @brief Set the ammo state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new ammo state for the Image @return the Image's new ammo state ) +/// @brief Set the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new ammo state for the Image +/// @return the Image's new ammo state ) +/// /// public bool fnShapeBase_setImageAmmo (string shapebase, int slot, bool state) @@ -30854,7 +39488,13 @@ public bool fnShapeBase_setImageAmmo (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageAmmo(sbshapebase, slot, state)>=1; } /// -/// @brief Set the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param trigger Generic trigger number @param state new generic trigger state for the Image @return the Image's new generic trigger state or -1 if there was a problem. ) +/// @brief Set the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param trigger Generic trigger number +/// @param state new generic trigger state for the Image +/// @return the Image's new generic trigger state or -1 if there was a problem. ) +/// /// public int fnShapeBase_setImageGenericTrigger (string shapebase, int slot, int trigger, bool state) @@ -30868,7 +39508,12 @@ public int fnShapeBase_setImageGenericTrigger (string shapebase, int slot, int t return SafeNativeMethods.mwle_fnShapeBase_setImageGenericTrigger(sbshapebase, slot, trigger, state); } /// -/// @brief Set the loaded state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new loaded state for the Image @return the Image's new loaded state ) +/// @brief Set the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new loaded state for the Image +/// @return the Image's new loaded state ) +/// /// public bool fnShapeBase_setImageLoaded (string shapebase, int slot, bool state) @@ -30882,7 +39527,13 @@ public bool fnShapeBase_setImageLoaded (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageLoaded(sbshapebase, slot, state)>=1; } /// -/// @brief Set the script animation prefix for the Image mounted in the specified slot. This is used to further modify the prefix used when deciding which animation sequence to play while this image is mounted. @param slot Image slot to modify @param prefix The prefix applied to the image ) +/// @brief Set the script animation prefix for the Image mounted in the specified slot. +/// This is used to further modify the prefix used when deciding which animation sequence to +/// play while this image is mounted. +/// +/// @param slot Image slot to modify +/// @param prefix The prefix applied to the image ) +/// /// public void fnShapeBase_setImageScriptAnimPrefix (string shapebase, int slot, string prefix) @@ -30899,7 +39550,12 @@ public void fnShapeBase_setImageScriptAnimPrefix (string shapebase, int slot, st SafeNativeMethods.mwle_fnShapeBase_setImageScriptAnimPrefix(sbshapebase, slot, sbprefix); } /// -/// @brief Set the target state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new target state for the Image @return the Image's new target state ) +/// @brief Set the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new target state for the Image +/// @return the Image's new target state ) +/// /// public bool fnShapeBase_setImageTarget (string shapebase, int slot, bool state) @@ -30913,7 +39569,12 @@ public bool fnShapeBase_setImageTarget (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageTarget(sbshapebase, slot, state)>=1; } /// -/// @brief Set the trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new trigger state for the Image @return the Image's new trigger state ) +/// @brief Set the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new trigger state for the Image +/// @return the Image's new trigger state ) +/// /// public bool fnShapeBase_setImageTrigger (string shapebase, int slot, bool state) @@ -30927,21 +39588,11 @@ public bool fnShapeBase_setImageTrigger (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageTrigger(sbshapebase, slot, state)>=1; } /// -/// @brief Setup the invincible effect. This effect is used for HUD feedback to the user that they are invincible. @note Currently not implemented @param time duration in seconds for the invincible effect @param speed speed at which the invincible effect progresses ) -/// - -public void fnShapeBase_setInvincibleMode (string shapebase, float time, float speed) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fnShapeBase_setInvincibleMode'" + string.Format("\"{0}\" \"{1}\" \"{2}\" ",shapebase,time,speed)); -StringBuilder sbshapebase = null; -if (shapebase != null) - sbshapebase = new StringBuilder(shapebase, 1024); - -SafeNativeMethods.mwle_fnShapeBase_setInvincibleMode(sbshapebase, time, speed); -} -/// -/// @brief Set the hidden state on the named shape mesh. @param name name of the mesh to hide/show @param hide new hidden state for the mesh ) +/// @brief Set the hidden state on the named shape mesh. +/// +/// @param name name of the mesh to hide/show +/// @param hide new hidden state for the mesh ) +/// /// public void fnShapeBase_setMeshHidden (string shapebase, string name, bool hide) @@ -30958,7 +39609,15 @@ public void fnShapeBase_setMeshHidden (string shapebase, string name, bool hide) SafeNativeMethods.mwle_fnShapeBase_setMeshHidden(sbshapebase, sbname, hide); } /// -/// @brief Set the recharge rate. The recharge rate is added to the object's current energy level each tick, up to the maxEnergy level set in the ShapeBaseData datablock. @param rate the recharge rate (per tick) @see getRechargeRate()) +/// @brief Set the recharge rate. +/// +/// The recharge rate is added to the object's current energy level each tick, +/// up to the maxEnergy level set in the ShapeBaseData datablock. +/// +/// @param rate the recharge rate (per tick) +/// +/// @see getRechargeRate()) +/// /// public void fnShapeBase_setRechargeRate (string shapebase, float rate) @@ -30972,7 +39631,17 @@ public void fnShapeBase_setRechargeRate (string shapebase, float rate) SafeNativeMethods.mwle_fnShapeBase_setRechargeRate(sbshapebase, rate); } /// -/// @brief Set amount to repair damage by each tick. Note that this value is separate to the repairRate field in ShapeBaseData. This value will be subtracted from the damage level each tick, whereas the ShapeBaseData field limits how much of the applyRepair value is subtracted each tick. Both repair types can be active at the same time. @param rate value to subtract from damage level each tick (must be > 0) @see getRepairRate()) +/// @brief Set amount to repair damage by each tick. +/// +/// Note that this value is separate to the repairRate field in ShapeBaseData. +/// This value will be subtracted from the damage level each tick, whereas the +/// ShapeBaseData field limits how much of the applyRepair value is subtracted +/// each tick. Both repair types can be active at the same time. +/// +/// @param rate value to subtract from damage level each tick (must be > 0) +/// +/// @see getRepairRate()) +/// /// public void fnShapeBase_setRepairRate (string shapebase, float rate) @@ -30986,7 +39655,15 @@ public void fnShapeBase_setRepairRate (string shapebase, float rate) SafeNativeMethods.mwle_fnShapeBase_setRepairRate(sbshapebase, rate); } /// -/// @brief Set the name of this shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @param name new name for the shape @see getShapeName()) +/// @brief Set the name of this shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @param name new name for the shape +/// +/// @see getShapeName()) +/// /// public void fnShapeBase_setShapeName (string shapebase, string name) @@ -31003,7 +39680,16 @@ public void fnShapeBase_setShapeName (string shapebase, string name) SafeNativeMethods.mwle_fnShapeBase_setShapeName(sbshapebase, sbname); } /// -/// @brief Apply a new skin to this shape. 'Skinning' the shape effectively renames the material targets, allowing different materials to be used on different instances of the same model. @param name name of the skin to apply @see skin @see getSkinName()) +/// @brief Apply a new skin to this shape. +/// +/// 'Skinning' the shape effectively renames the material targets, allowing +/// different materials to be used on different instances of the same model. +/// +/// @param name name of the skin to apply +/// +/// @see skin +/// @see getSkinName()) +/// /// public void fnShapeBase_setSkinName (string shapebase, string name) @@ -31020,7 +39706,14 @@ public void fnShapeBase_setSkinName (string shapebase, string name) SafeNativeMethods.mwle_fnShapeBase_setSkinName(sbshapebase, sbname); } /// -/// @brief Set the playback direction of an animation thread. @param slot thread slot to modify @param fwd true to play the animation forwards, false to play backwards @return true if successful, false if failed @see playThread() ) +/// @brief Set the playback direction of an animation thread. +/// +/// @param slot thread slot to modify +/// @param fwd true to play the animation forwards, false to play backwards +/// @return true if successful, false if failed +/// +/// @see playThread() ) +/// /// public bool fnShapeBase_setThreadDir (string shapebase, int slot, bool fwd) @@ -31034,7 +39727,14 @@ public bool fnShapeBase_setThreadDir (string shapebase, int slot, bool fwd) return SafeNativeMethods.mwle_fnShapeBase_setThreadDir(sbshapebase, slot, fwd)>=1; } /// -/// @brief Set the position within an animation thread. @param slot thread slot to modify @param pos position within thread @return true if successful, false if failed @see playThread ) +/// @brief Set the position within an animation thread. +/// +/// @param slot thread slot to modify +/// @param pos position within thread +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_setThreadPosition (string shapebase, int slot, float pos) @@ -31048,7 +39748,14 @@ public bool fnShapeBase_setThreadPosition (string shapebase, int slot, float pos return SafeNativeMethods.mwle_fnShapeBase_setThreadPosition(sbshapebase, slot, pos)>=1; } /// -/// @brief Set the playback time scale of an animation thread. @param slot thread slot to modify @param scale new thread time scale (1=normal speed, 0.5=half speed etc) @return true if successful, false if failed @see playThread ) +/// @brief Set the playback time scale of an animation thread. +/// +/// @param slot thread slot to modify +/// @param scale new thread time scale (1=normal speed, 0.5=half speed etc) +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_setThreadTimeScale (string shapebase, int slot, float scale) @@ -31062,7 +39769,11 @@ public bool fnShapeBase_setThreadTimeScale (string shapebase, int slot, float sc return SafeNativeMethods.mwle_fnShapeBase_setThreadTimeScale(sbshapebase, slot, scale)>=1; } /// -/// @brief Set the object's velocity. @param vel new velocity for the object @return true ) +/// @brief Set the object's velocity. +/// +/// @param vel new velocity for the object +/// @return true ) +/// /// public bool fnShapeBase_setVelocity (string shapebase, string vel) @@ -31079,7 +39790,17 @@ public bool fnShapeBase_setVelocity (string shapebase, string vel) return SafeNativeMethods.mwle_fnShapeBase_setVelocity(sbshapebase, sbvel)>=1; } /// -/// @brief Set the white-out level. White-out may be used as a postfx effect to brighten the screen in response to a game event. @note Relies on the flash postFx. @param level flash level (0-1) @see getWhiteOut()) +/// @brief Set the white-out level. +/// +/// White-out may be used as a postfx effect to brighten the screen in response +/// to a game event. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getWhiteOut()) +/// /// public void fnShapeBase_setWhiteOut (string shapebase, float level) @@ -31093,7 +39814,21 @@ public void fnShapeBase_setWhiteOut (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setWhiteOut(sbshapebase, level); } /// -/// @brief Fade the object in or out without removing it from the scene. A faded out object is still in the scene and can still be collided with, so if you want to disable collisions for this shape after it fades out use setHidden to temporarily remove this shape from the scene. @note Items have the ability to light their surroundings. When an Item with an active light is fading out, the light it emits is correspondingly reduced until it goes out. Likewise, when the item fades in, the light is turned-up till it reaches it's normal brightntess. @param time duration of the fade effect in ms @param delay delay in ms before the fade effect begins @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// @brief Fade the object in or out without removing it from the scene. +/// +/// A faded out object is still in the scene and can still be collided with, +/// so if you want to disable collisions for this shape after it fades out +/// use setHidden to temporarily remove this shape from the scene. +/// +/// @note Items have the ability to light their surroundings. When an Item with +/// an active light is fading out, the light it emits is correspondingly +/// reduced until it goes out. Likewise, when the item fades in, the light is +/// turned-up till it reaches it's normal brightntess. +/// +/// @param time duration of the fade effect in ms +/// @param delay delay in ms before the fade effect begins +/// @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// /// public void fnShapeBase_startFade (string shapebase, int time, int delay, bool fadeOut) @@ -31107,7 +39842,13 @@ public void fnShapeBase_startFade (string shapebase, int time, int delay, bool f SafeNativeMethods.mwle_fnShapeBase_startFade(sbshapebase, time, delay, fadeOut); } /// -/// @brief Stop a sound started with playAudio. @param slot audio slot index (started with playAudio) @return true if the sound was stopped successfully, false if failed @see playAudio()) +/// @brief Stop a sound started with playAudio. +/// +/// @param slot audio slot index (started with playAudio) +/// @return true if the sound was stopped successfully, false if failed +/// +/// @see playAudio()) +/// /// public bool fnShapeBase_stopAudio (string shapebase, int slot) @@ -31121,7 +39862,15 @@ public bool fnShapeBase_stopAudio (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_stopAudio(sbshapebase, slot)>=1; } /// -/// @brief Stop an animation thread. If restarted using playThread, the animation will start from the beginning again. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Stop an animation thread. +/// +/// If restarted using playThread, the animation +/// will start from the beginning again. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_stopThread (string shapebase, int slot) @@ -31135,7 +39884,13 @@ public bool fnShapeBase_stopThread (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_stopThread(sbshapebase, slot)>=1; } /// -/// @brief Unmount the mounted Image in the specified slot. @param slot Image slot to unmount @return true if successful, false if failed @see mountImage()) +/// @brief Unmount the mounted Image in the specified slot. +/// +/// @param slot Image slot to unmount +/// @return true if successful, false if failed +/// +/// @see mountImage()) +/// /// public bool fnShapeBase_unmountImage (string shapebase, int slot) @@ -31149,7 +39904,17 @@ public bool fnShapeBase_unmountImage (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_unmountImage(sbshapebase, slot)>=1; } /// -/// @brief Check if there is the space at the given transform is free to spawn into. The shape's bounding box volume is used to check for collisions at the given world transform. Only interior and static objects are checked for collision. @param txfm Deploy transform to check @return True if the space is free, false if there is already something in the way. @note This is a server side only check, and is not actually limited to spawning.) +/// @brief Check if there is the space at the given transform is free to spawn into. +/// +/// The shape's bounding box volume is used to check for collisions at the given world +/// transform. Only interior and static objects are checked for collision. +/// +/// @param txfm Deploy transform to check +/// @return True if the space is free, false if there is already something in +/// the way. +/// +/// @note This is a server side only check, and is not actually limited to spawning.) +/// /// public bool fnShapeBaseData_checkDeployPos (string shapebasedata, string txfm) @@ -31166,7 +39931,11 @@ public bool fnShapeBaseData_checkDeployPos (string shapebasedata, string txfm) return SafeNativeMethods.mwle_fnShapeBaseData_checkDeployPos(sbshapebasedata, sbtxfm)>=1; } /// -/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). @param pos Desired transform position @param normal Vector of desired direction @return The deploy transform ) +/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). +/// @param pos Desired transform position +/// @param normal Vector of desired direction +/// @return The deploy transform ) +/// /// public string fnShapeBaseData_getDeployTransform (string shapebasedata, string pos, string normal) @@ -31189,7 +39958,11 @@ public string fnShapeBaseData_getDeployTransform (string shapebasedata, string p } /// -/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); Adds additional components to current list. @param Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); +/// Adds additional components to current list. +/// @param Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool fnSimComponent_addComponents (string simcomponent, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21, string a22, string a23, string a24, string a25, string a26, string a27, string a28, string a29, string a30, string a31, string a32, string a33, string a34, string a35, string a36, string a37, string a38, string a39, string a40, string a41, string a42, string a43, string a44, string a45, string a46, string a47, string a48, string a49, string a50, string a51, string a52, string a53, string a54, string a55, string a56, string a57, string a58, string a59, string a60, string a61, string a62, string a63) @@ -31389,7 +40162,11 @@ public bool fnSimComponent_addComponents (string simcomponent, string a2, string return SafeNativeMethods.mwle_fnSimComponent_addComponents(sbsimcomponent, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19, sba20, sba21, sba22, sba23, sba24, sba25, sba26, sba27, sba28, sba29, sba30, sba31, sba32, sba33, sba34, sba35, sba36, sba37, sba38, sba39, sba40, sba41, sba42, sba43, sba44, sba45, sba46, sba47, sba48, sba49, sba50, sba51, sba52, sba53, sba54, sba55, sba56, sba57, sba58, sba59, sba60, sba61, sba62, sba63)>=1; } /// -/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); Removes components by name from current list. @param objNamex Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); +/// Removes components by name from current list. +/// @param objNamex Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool fnSimComponent_removeComponents (string simcomponent, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21, string a22, string a23, string a24, string a25, string a26, string a27, string a28, string a29, string a30, string a31, string a32, string a33, string a34, string a35, string a36, string a37, string a38, string a39, string a40, string a41, string a42, string a43, string a44, string a45, string a46, string a47, string a48, string a49, string a50, string a51, string a52, string a53, string a54, string a55, string a56, string a57, string a58, string a59, string a60, string a61, string a62, string a63) @@ -32155,7 +40932,32 @@ public void fnSimObject_signal (string simobject, string a2, string a3) SafeNativeMethods.mwle_fnSimObject_signal(sbsimobject, sba2, sba3); } /// -/// @brief Sets the internal message variable. SimpleNetObject is set up to automatically transmit this new message to all connected clients. It will appear in the clients' console. @param msg The new message to send @tsexample // On the server, create a new SimpleNetObject. This is a ghost always // object so it will be immediately ghosted to all connected clients. $s = new SimpleNetObject(); // All connected clients will see the following in their console: // // Got message: Hello World! // Now again on the server, change the message. This will cause it to // be sent to all connected clients. $s.setMessage(\"A new message from me!\"); // All connected clients will now see in their console: // // Go message: A new message from me! @endtsexample ) +/// @brief Sets the internal message variable. +/// +/// SimpleNetObject is set up to automatically transmit this new message to +/// all connected clients. It will appear in the clients' console. +/// +/// @param msg The new message to send +/// +/// @tsexample +/// // On the server, create a new SimpleNetObject. This is a ghost always +/// // object so it will be immediately ghosted to all connected clients. +/// $s = new SimpleNetObject(); +/// +/// // All connected clients will see the following in their console: +/// // +/// // Got message: Hello World! +/// +/// // Now again on the server, change the message. This will cause it to +/// // be sent to all connected clients. +/// $s.setMessage(\"A new message from me!\"); +/// +/// // All connected clients will now see in their console: +/// // +/// // Go message: A new message from me! +/// @endtsexample +/// ) +/// /// public void fnSimpleNetObject_setMessage (string simplenetobject, string msg) @@ -32172,7 +40974,10 @@ public void fnSimpleNetObject_setMessage (string simplenetobject, string msg) SafeNativeMethods.mwle_fnSimpleNetObject_setMessage(sbsimplenetobject, sbmsg); } /// -/// Test whether the given object may be added to the set. @param obj The object to test for potential membership. @return True if the object may be added to the set, false otherwise. ) +/// Test whether the given object may be added to the set. +/// @param obj The object to test for potential membership. +/// @return True if the object may be added to the set, false otherwise. ) +/// /// public bool fnSimSet_acceptsAsChild (string simset, string obj) @@ -32189,7 +40994,10 @@ public bool fnSimSet_acceptsAsChild (string simset, string obj) return SafeNativeMethods.mwle_fnSimSet_acceptsAsChild(sbsimset, sbobj)>=1; } /// -/// ( SimSet, add, void, 3, 0, ( SimObject objects... ) Add the given objects to the set. @param objects The objects to add to the set. ) +/// ( SimSet, add, void, 3, 0, +/// ( SimObject objects... ) Add the given objects to the set. +/// @param objects The objects to add to the set. ) +/// /// public void fnSimSet_add (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32257,7 +41065,9 @@ public void fnSimSet_add (string simset, string a2, string a3, string a4, string SafeNativeMethods.mwle_fnSimSet_add(sbsimset, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// Make the given object the first object in the set. @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// Make the given object the first object in the set. +/// @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// /// public void fnSimSet_bringToFront (string simset, string obj) @@ -32274,7 +41084,13 @@ public void fnSimSet_bringToFront (string simset, string obj) SafeNativeMethods.mwle_fnSimSet_bringToFront(sbsimset, sbobj); } /// -/// ( SimSet, callOnChildren, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method recurses into all SimSets that are children to the set. @see callOnChildrenNoRecurse ) +/// ( SimSet, callOnChildren, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method recurses into all SimSets that are children to the set. +/// @see callOnChildrenNoRecurse ) +/// /// public void fnSimSet_callOnChildren (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32342,7 +41158,13 @@ public void fnSimSet_callOnChildren (string simset, string a2, string a3, string SafeNativeMethods.mwle_fnSimSet_callOnChildren(sbsimset, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method does not recurse into child SimSets. @see callOnChildren ) +/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method does not recurse into child SimSets. +/// @see callOnChildren ) +/// /// public void fnSimSet_callOnChildrenNoRecurse (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32411,6 +41233,7 @@ public void fnSimSet_callOnChildrenNoRecurse (string simset, string a2, string a } /// /// Remove all objects from the set. ) +/// /// public void fnSimSet_clear (string simset) @@ -32424,7 +41247,11 @@ public void fnSimSet_clear (string simset) SafeNativeMethods.mwle_fnSimSet_clear(sbsimset); } /// -/// Find an object in the set by its internal name. @param internalName The internal name of the object to look for. @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. @return The object with the given internal name or 0 if no match was found. ) +/// Find an object in the set by its internal name. +/// @param internalName The internal name of the object to look for. +/// @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. +/// @return The object with the given internal name or 0 if no match was found. ) +/// /// public string fnSimSet_findObjectByInternalName (string simset, string internalName, bool searchChildren) @@ -32444,7 +41271,9 @@ public string fnSimSet_findObjectByInternalName (string simset, string internalN } /// -/// Get the number of objects contained in the set. @return The number of objects contained in the set. ) +/// Get the number of objects contained in the set. +/// @return The number of objects contained in the set. ) +/// /// public int fnSimSet_getCount (string simset) @@ -32458,7 +41287,10 @@ public int fnSimSet_getCount (string simset) return SafeNativeMethods.mwle_fnSimSet_getCount(sbsimset); } /// -/// Get the object at the given index. @param index The object index. @return The object at the given index or -1 if index is out of range. ) +/// Get the object at the given index. +/// @param index The object index. +/// @return The object at the given index or -1 if index is out of range. ) +/// /// public string fnSimSet_getObject (string simset, uint index) @@ -32475,7 +41307,10 @@ public string fnSimSet_getObject (string simset, uint index) } /// -/// Return the index of the given object in this set. @param obj The object for which to return the index. Must be contained in the set. @return The index of the object or -1 if the object is not contained in the set. ) +/// Return the index of the given object in this set. +/// @param obj The object for which to return the index. Must be contained in the set. +/// @return The index of the object or -1 if the object is not contained in the set. ) +/// /// public int fnSimSet_getObjectIndex (string simset, string obj) @@ -32492,7 +41327,9 @@ public int fnSimSet_getObjectIndex (string simset, string obj) return SafeNativeMethods.mwle_fnSimSet_getObjectIndex(sbsimset, sbobj); } /// -/// Return a random object from the set. @return A randomly selected object from the set or -1 if the set is empty. ) +/// Return a random object from the set. +/// @return A randomly selected object from the set or -1 if the set is empty. ) +/// /// public string fnSimSet_getRandom (string simset) @@ -32509,7 +41346,10 @@ public string fnSimSet_getRandom (string simset) } /// -/// Test whether the given object belongs to the set. @param obj The object. @return True if the object is contained in the set; false otherwise. ) +/// Test whether the given object belongs to the set. +/// @param obj The object. +/// @return True if the object is contained in the set; false otherwise. ) +/// /// public bool fnSimSet_isMember (string simset, string obj) @@ -32527,6 +41367,7 @@ public bool fnSimSet_isMember (string simset, string obj) } /// /// Dump a list of all objects contained in the set to the console. ) +/// /// public void fnSimSet_listObjects (string simset) @@ -32540,7 +41381,9 @@ public void fnSimSet_listObjects (string simset) SafeNativeMethods.mwle_fnSimSet_listObjects(sbsimset); } /// -/// Make the given object the last object in the set. @param obj The object to bring to the last position. Must be contained in the set. ) +/// Make the given object the last object in the set. +/// @param obj The object to bring to the last position. Must be contained in the set. ) +/// /// public void fnSimSet_pushToBack (string simset, string obj) @@ -32557,7 +41400,10 @@ public void fnSimSet_pushToBack (string simset, string obj) SafeNativeMethods.mwle_fnSimSet_pushToBack(sbsimset, sbobj); } /// -/// ( SimSet, remove, void, 3, 0, ( SimObject objects... ) Remove the given objects from the set. @param objects The objects to remove from the set. ) +/// ( SimSet, remove, void, 3, 0, +/// ( SimObject objects... ) Remove the given objects from the set. +/// @param objects The objects to remove from the set. ) +/// /// public void fnSimSet_remove (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32625,7 +41471,10 @@ public void fnSimSet_remove (string simset, string a2, string a3, string a4, str SafeNativeMethods.mwle_fnSimSet_remove(sbsimset, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// Make sure child1 is ordered right before child2 in the set. @param child1 The first child. The object must already be contained in the set. @param child2 The second child. The object must already be contained in the set. ) +/// Make sure child1 is ordered right before child2 in the set. +/// @param child1 The first child. The object must already be contained in the set. +/// @param child2 The second child. The object must already be contained in the set. ) +/// /// public void fnSimSet_reorderChild (string simset, string child1, string child2) @@ -32645,7 +41494,24 @@ public void fnSimSet_reorderChild (string simset, string child1, string child2) SafeNativeMethods.mwle_fnSimSet_reorderChild(sbsimset, sbchild1, sbchild2); } /// -/// @brief Add the given comment as a child of the document. @param comment String containing the comment. @tsexample // Create a new XML document with a header, a comment and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addComment(\"This is a test comment\"); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // !--This is a test comment--> // NewElement /> @endtsexample @see readComment()) +/// @brief Add the given comment as a child of the document. +/// @param comment String containing the comment. +/// +/// @tsexample +/// // Create a new XML document with a header, a comment and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addComment(\"This is a test comment\"); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // !--This is a test comment--> +/// // NewElement /> +/// @endtsexample +/// +/// @see readComment()) +/// /// public void fnSimXMLDocument_addComment (string simxmldocument, string comment) @@ -32662,7 +41528,34 @@ public void fnSimXMLDocument_addComment (string simxmldocument, string comment) SafeNativeMethods.mwle_fnSimXMLDocument_addComment(sbsimxmldocument, sbcomment); } /// -/// @brief Add the given text as a child of current Element. Use getData() to retrieve any text from the current Element. addData() and addText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added data. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addData(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getData() @see addText() @see getText() @see removeText()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getData() to retrieve any text from the current Element. +/// +/// addData() and addText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added data. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addData(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public void fnSimXMLDocument_addData (string simxmldocument, string text) @@ -32679,7 +41572,24 @@ public void fnSimXMLDocument_addData (string simxmldocument, string text) SafeNativeMethods.mwle_fnSimXMLDocument_addData(sbsimxmldocument, sbtext); } /// -/// @brief Add a XML header to a document. Sometimes called a declaration, you typically add a standard header to the document before adding any elements. SimXMLDocument always produces the following header: ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> @tsexample // Create a new XML document with just a header and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement /> @endtsexample) +/// @brief Add a XML header to a document. +/// +/// Sometimes called a declaration, you typically add a standard header to +/// the document before adding any elements. SimXMLDocument always produces +/// the following header: +/// ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// +/// @tsexample +/// // Create a new XML document with just a header and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement /> +/// @endtsexample) +/// /// public void fnSimXMLDocument_addHeader (string simxmldocument) @@ -32693,7 +41603,17 @@ public void fnSimXMLDocument_addHeader (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_addHeader(sbsimxmldocument); } /// -/// @brief Create a new element with the given name as child of current Element's parent and push it onto the Element stack making it the current one. @note This differs from pushNewElement() in that it adds the new Element to the current Element's parent (or document if there is no parent Element). This makes the new Element a sibling of the current one. @param name XML tag for the new Element. @see pushNewElement()) +/// @brief Create a new element with the given name as child of current Element's +/// parent and push it onto the Element stack making it the current one. +/// +/// @note This differs from pushNewElement() in that it adds the new Element to the +/// current Element's parent (or document if there is no parent Element). This makes +/// the new Element a sibling of the current one. +/// +/// @param name XML tag for the new Element. +/// +/// @see pushNewElement()) +/// /// public void fnSimXMLDocument_addNewElement (string simxmldocument, string name) @@ -32710,7 +41630,33 @@ public void fnSimXMLDocument_addNewElement (string simxmldocument, string name) SafeNativeMethods.mwle_fnSimXMLDocument_addNewElement(sbsimxmldocument, sbname); } /// -/// @brief Add the given text as a child of current Element. Use getText() to retrieve any text from the current Element and removeText() to clear any text. addText() and addData() may be used interchangeably. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added text. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addText(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getText() @see removeText() @see addData() @see getData()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getText() to retrieve any text from the current Element and removeText() +/// to clear any text. +/// +/// addText() and addData() may be used interchangeably. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added text. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addText(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public void fnSimXMLDocument_addText (string simxmldocument, string text) @@ -32727,7 +41673,10 @@ public void fnSimXMLDocument_addText (string simxmldocument, string text) SafeNativeMethods.mwle_fnSimXMLDocument_addText(sbsimxmldocument, sbtext); } /// -/// @brief Get a string attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The attribute string if found. Otherwise returns an empty string.) +/// @brief Get a string attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The attribute string if found. Otherwise returns an empty string.) +/// /// public string fnSimXMLDocument_attribute (string simxmldocument, string attributeName) @@ -32747,7 +41696,10 @@ public string fnSimXMLDocument_attribute (string simxmldocument, string attribut } /// -/// @brief Tests if the requested attribute exists. @param attributeName Name of attribute being queried for. @return True if the attribute exists.) +/// @brief Tests if the requested attribute exists. +/// @param attributeName Name of attribute being queried for. +/// @return True if the attribute exists.) +/// /// public bool fnSimXMLDocument_attributeExists (string simxmldocument, string attributeName) @@ -32764,7 +41716,12 @@ public bool fnSimXMLDocument_attributeExists (string simxmldocument, string attr return SafeNativeMethods.mwle_fnSimXMLDocument_attributeExists(sbsimxmldocument, sbattributeName)>=1; } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using reset() @see reset()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using reset() +/// +/// @see reset()) +/// /// public void fnSimXMLDocument_clear (string simxmldocument) @@ -32779,6 +41736,7 @@ public void fnSimXMLDocument_clear (string simxmldocument) } /// /// @brief Clear the last error description.) +/// /// public void fnSimXMLDocument_clearError (string simxmldocument) @@ -32792,7 +41750,10 @@ public void fnSimXMLDocument_clearError (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_clearError(sbsimxmldocument); } /// -/// @brief Get the Element's value if it exists. Usually returns the text from the Element. @return The value from the Element, or an empty string if none is found.) +/// @brief Get the Element's value if it exists. +/// Usually returns the text from the Element. +/// @return The value from the Element, or an empty string if none is found.) +/// /// public string fnSimXMLDocument_elementValue (string simxmldocument) @@ -32809,7 +41770,12 @@ public string fnSimXMLDocument_elementValue (string simxmldocument) } /// -/// @brief Obtain the name of the current Element's first attribute. @return String containing the first attribute's name, or an empty string if none is found. @see nextAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Obtain the name of the current Element's first attribute. +/// @return String containing the first attribute's name, or an empty string if none is found. +/// @see nextAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string fnSimXMLDocument_firstAttribute (string simxmldocument) @@ -32826,7 +41792,39 @@ public string fnSimXMLDocument_firstAttribute (string simxmldocument) } /// -/// @brief Gets the text from the current Element. Use addData() to add text to the current Element. getData() and getText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some data/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's data ('Some data' in this example) // into 'result' %result = %x.getData(); echo( %result ); @endtsexample @see addData() @see addText() @see getText() @see removeText()) +/// @brief Gets the text from the current Element. +/// +/// Use addData() to add text to the current Element. +/// +/// getData() and getText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some data/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's data ('Some data' in this example) +/// // into 'result' +/// %result = %x.getData(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public string fnSimXMLDocument_getData (string simxmldocument) @@ -32843,7 +41841,9 @@ public string fnSimXMLDocument_getData (string simxmldocument) } /// -/// @brief Get last error description. @return A string of the last error message.) +/// @brief Get last error description. +/// @return A string of the last error message.) +/// /// public string fnSimXMLDocument_getErrorDesc (string simxmldocument) @@ -32860,7 +41860,38 @@ public string fnSimXMLDocument_getErrorDesc (string simxmldocument) } /// -/// @brief Gets the text from the current Element. Use addText() to add text to the current Element and removeText() to clear any text. getText() and getData() may be used interchangeably. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample @see addText() @see removeText() @see addData() @see getData()) +/// @brief Gets the text from the current Element. +/// +/// Use addText() to add text to the current Element and removeText() +/// to clear any text. +/// +/// getText() and getData() may be used interchangeably. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public string fnSimXMLDocument_getText (string simxmldocument) @@ -32877,7 +41908,12 @@ public string fnSimXMLDocument_getText (string simxmldocument) } /// -/// @brief Obtain the name of the current Element's last attribute. @return String containing the last attribute's name, or an empty string if none is found. @see prevAttribute() @see firstAttribute() @see lastAttribute()) +/// @brief Obtain the name of the current Element's last attribute. +/// @return String containing the last attribute's name, or an empty string if none is found. +/// @see prevAttribute() +/// @see firstAttribute() +/// @see lastAttribute()) +/// /// public string fnSimXMLDocument_lastAttribute (string simxmldocument) @@ -32894,7 +41930,11 @@ public string fnSimXMLDocument_lastAttribute (string simxmldocument) } /// -/// @brief Load in given filename and prepare it for use. @note Clears the current document's contents. @param fileName Name and path of XML document @return True if the file was loaded successfully.) +/// @brief Load in given filename and prepare it for use. +/// @note Clears the current document's contents. +/// @param fileName Name and path of XML document +/// @return True if the file was loaded successfully.) +/// /// public bool fnSimXMLDocument_loadFile (string simxmldocument, string fileName) @@ -32911,7 +41951,12 @@ public bool fnSimXMLDocument_loadFile (string simxmldocument, string fileName) return SafeNativeMethods.mwle_fnSimXMLDocument_loadFile(sbsimxmldocument, sbfileName)>=1; } /// -/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). @return String containing the next attribute's name, or an empty string if none is found. @see firstAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). +/// @return String containing the next attribute's name, or an empty string if none is found. +/// @see firstAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string fnSimXMLDocument_nextAttribute (string simxmldocument) @@ -32928,7 +41973,10 @@ public string fnSimXMLDocument_nextAttribute (string simxmldocument) } /// -/// @brief Put the next sibling Element with the given name on the stack, making it the current one. @param name String containing name of the next sibling. @return True if the Element was found and made the current one.) +/// @brief Put the next sibling Element with the given name on the stack, making it the current one. +/// @param name String containing name of the next sibling. +/// @return True if the Element was found and made the current one.) +/// /// public bool fnSimXMLDocument_nextSiblingElement (string simxmldocument, string name) @@ -32945,7 +41993,10 @@ public bool fnSimXMLDocument_nextSiblingElement (string simxmldocument, string n return SafeNativeMethods.mwle_fnSimXMLDocument_nextSiblingElement(sbsimxmldocument, sbname)>=1; } /// -/// @brief Create a document from a XML string. @note Clears the current document's contents. @param xmlString Valid XML to parse and store as a document.) +/// @brief Create a document from a XML string. +/// @note Clears the current document's contents. +/// @param xmlString Valid XML to parse and store as a document.) +/// /// public void fnSimXMLDocument_parse (string simxmldocument, string xmlString) @@ -32963,6 +42014,7 @@ public void fnSimXMLDocument_parse (string simxmldocument, string xmlString) } /// /// @brief Pop the last Element off the stack.) +/// /// public void fnSimXMLDocument_popElement (string simxmldocument) @@ -32976,7 +42028,12 @@ public void fnSimXMLDocument_popElement (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_popElement(sbsimxmldocument); } /// -/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). @return String containing the previous attribute's name, or an empty string if none is found. @see lastAttribute() @see firstAttribute() @see nextAttribute()) +/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). +/// @return String containing the previous attribute's name, or an empty string if none is found. +/// @see lastAttribute() +/// @see firstAttribute() +/// @see nextAttribute()) +/// /// public string fnSimXMLDocument_prevAttribute (string simxmldocument) @@ -32993,7 +42050,10 @@ public string fnSimXMLDocument_prevAttribute (string simxmldocument) } /// -/// @brief Push the child Element at the given index onto the stack, making it the current one. @param index Numerical index of Element being pushed. @return True if the Element was found and made the current one.) +/// @brief Push the child Element at the given index onto the stack, making it the current one. +/// @param index Numerical index of Element being pushed. +/// @return True if the Element was found and made the current one.) +/// /// public bool fnSimXMLDocument_pushChildElement (string simxmldocument, int index) @@ -33007,7 +42067,29 @@ public bool fnSimXMLDocument_pushChildElement (string simxmldocument, int index) return SafeNativeMethods.mwle_fnSimXMLDocument_pushChildElement(sbsimxmldocument, index)>=1; } /// -/// @brief Push the first child Element with the given name onto the stack, making it the current Element. @param name String containing name of the child Element. @return True if the Element was found and made the current one. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample) +/// @brief Push the first child Element with the given name onto the stack, making it the current Element. +/// +/// @param name String containing name of the child Element. +/// @return True if the Element was found and made the current one. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample) +/// /// public bool fnSimXMLDocument_pushFirstChildElement (string simxmldocument, string name) @@ -33024,7 +42106,16 @@ public bool fnSimXMLDocument_pushFirstChildElement (string simxmldocument, strin return SafeNativeMethods.mwle_fnSimXMLDocument_pushFirstChildElement(sbsimxmldocument, sbname)>=1; } /// -/// @brief Create a new element with the given name as child of current Element and push it onto the Element stack making it the current one. @note This differs from addNewElement() in that it adds the new Element as a child of the current Element (or a child of the document if no Element exists). @param name XML tag for the new Element. @see addNewElement()) +/// @brief Create a new element with the given name as child of current Element +/// and push it onto the Element stack making it the current one. +/// +/// @note This differs from addNewElement() in that it adds the new Element as a +/// child of the current Element (or a child of the document if no Element exists). +/// +/// @param name XML tag for the new Element. +/// +/// @see addNewElement()) +/// /// public void fnSimXMLDocument_pushNewElement (string simxmldocument, string name) @@ -33041,7 +42132,18 @@ public void fnSimXMLDocument_pushNewElement (string simxmldocument, string name) SafeNativeMethods.mwle_fnSimXMLDocument_pushNewElement(sbsimxmldocument, sbname); } /// -/// Gives the comment at the specified index, if any. Unlike addComment() that only works at the document level, readComment() may read comments from the document or any child Element. The current Element (or document if no Elements have been pushed to the stack) is the parent for any comments, and the provided index is the number of comments in to read back. @param index Comment index number to query from the current Element stack @return String containing the comment, or an empty string if no comment is found. @see addComment()) +/// Gives the comment at the specified index, if any. +/// +/// Unlike addComment() that only works at the document level, readComment() may read +/// comments from the document or any child Element. The current Element (or document +/// if no Elements have been pushed to the stack) is the parent for any comments, and the +/// provided index is the number of comments in to read back. +/// +/// @param index Comment index number to query from the current Element stack +/// @return String containing the comment, or an empty string if no comment is found. +/// +/// @see addComment()) +/// /// public string fnSimXMLDocument_readComment (string simxmldocument, int index) @@ -33058,7 +42160,18 @@ public string fnSimXMLDocument_readComment (string simxmldocument, int index) } /// -/// @brief Remove any text on the current Element. Use getText() to retrieve any text from the current Element and addText() to add text to the current Element. As getData() and addData() are equivalent to getText() and addText(), removeText() will also remove any data from the current Element. @see addText() @see getText() @see addData() @see getData()) +/// @brief Remove any text on the current Element. +/// +/// Use getText() to retrieve any text from the current Element and addText() +/// to add text to the current Element. As getData() and addData() are equivalent +/// to getText() and addText(), removeText() will also remove any data from the +/// current Element. +/// +/// @see addText() +/// @see getText() +/// @see addData() +/// @see getData()) +/// /// public void fnSimXMLDocument_removeText (string simxmldocument) @@ -33072,7 +42185,12 @@ public void fnSimXMLDocument_removeText (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_removeText(sbsimxmldocument); } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using clear() @see clear()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using clear() +/// +/// @see clear()) +/// /// public void fnSimXMLDocument_reset (string simxmldocument) @@ -33086,7 +42204,10 @@ public void fnSimXMLDocument_reset (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_reset(sbsimxmldocument); } /// -/// @brief Save document to the given file name. @param fileName Path and name of XML file to save to. @return True if the file was successfully saved.) +/// @brief Save document to the given file name. +/// @param fileName Path and name of XML file to save to. +/// @return True if the file was successfully saved.) +/// /// public bool fnSimXMLDocument_saveFile (string simxmldocument, string fileName) @@ -33103,7 +42224,10 @@ public bool fnSimXMLDocument_saveFile (string simxmldocument, string fileName) return SafeNativeMethods.mwle_fnSimXMLDocument_saveFile(sbsimxmldocument, sbfileName)>=1; } /// -/// @brief Set the attribute of the current Element on the stack to the given value. @param attributeName Name of attribute being changed @param value New value to assign to the attribute) +/// @brief Set the attribute of the current Element on the stack to the given value. +/// @param attributeName Name of attribute being changed +/// @param value New value to assign to the attribute) +/// /// public void fnSimXMLDocument_setAttribute (string simxmldocument, string attributeName, string value) @@ -33123,7 +42247,9 @@ public void fnSimXMLDocument_setAttribute (string simxmldocument, string attribu SafeNativeMethods.mwle_fnSimXMLDocument_setAttribute(sbsimxmldocument, sbattributeName, sbvalue); } /// -/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. @param objectID ID of SimObject being copied.) +/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. +/// @param objectID ID of SimObject being copied.) +/// /// public void fnSimXMLDocument_setObjectAttributes (string simxmldocument, string objectID) @@ -33140,7 +42266,10 @@ public void fnSimXMLDocument_setObjectAttributes (string simxmldocument, string SafeNativeMethods.mwle_fnSimXMLDocument_setObjectAttributes(sbsimxmldocument, sbobjectID); } /// -/// @brief Copy from another StreamObject into this StreamObject @param other The StreamObject to copy from. @return True if the copy was successful.) +/// @brief Copy from another StreamObject into this StreamObject +/// @param other The StreamObject to copy from. +/// @return True if the copy was successful.) +/// /// public bool fnStreamObject_copyFrom (string streamobject, string other) @@ -33157,7 +42286,36 @@ public bool fnStreamObject_copyFrom (string streamobject, string other) return SafeNativeMethods.mwle_fnStreamObject_copyFrom(sbstreamobject, sbother)>=1; } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains two lines of text repeated: // Hello World // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Get the position of the stream %position = %fsObject.getPosition(); // Print the current position // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline echo(%position); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see setPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains two lines of text repeated: +/// // Hello World +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Get the position of the stream +/// %position = %fsObject.getPosition(); +/// // Print the current position +/// // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline +/// echo(%position); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see setPosition()) +/// /// public int fnStreamObject_getPosition (string streamobject) @@ -33171,7 +42329,36 @@ public int fnStreamObject_getPosition (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_getPosition(sbstreamobject); } /// -/// @brief Gets a printable string form of the stream's status @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing status constant, one of the following: OK - Stream is active and no file errors IOError - Something went wrong during read or writing the stream EOS - End of Stream reached (mostly for reads) IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn Closed - Tried to operate on a closed stream (or detached filter) UnknownError - Catch all for an error of some kind Invalid - Entire stream is invalid) +/// @brief Gets a printable string form of the stream's status +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing status constant, one of the following: +/// +/// OK - Stream is active and no file errors +/// +/// IOError - Something went wrong during read or writing the stream +/// +/// EOS - End of Stream reached (mostly for reads) +/// +/// IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn +/// +/// Closed - Tried to operate on a closed stream (or detached filter) +/// +/// UnknownError - Catch all for an error of some kind +/// +/// Invalid - Entire stream is invalid) +/// /// public string fnStreamObject_getStatus (string streamobject) @@ -33188,7 +42375,30 @@ public string fnStreamObject_getStatus (string streamobject) } /// -/// @brief Gets the size of the stream The size is dependent on the type of stream being used. If it is a file stream, returned value will be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject.open(\"./test.txt\", \"read\"); // Found out how large the file stream is // Then print it to the console // Should be 22 %streamSize = %fsObject.getStreamSize(); echo(%streamSize); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Size of stream, in bytes) +/// @brief Gets the size of the stream +/// +/// The size is dependent on the type of stream being used. If it is a file stream, returned value will +/// be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Found out how large the file stream is +/// // Then print it to the console +/// // Should be 22 +/// %streamSize = %fsObject.getStreamSize(); +/// echo(%streamSize); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Size of stream, in bytes) +/// /// public int fnStreamObject_getStreamSize (string streamobject) @@ -33202,7 +42412,32 @@ public int fnStreamObject_getStreamSize (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_getStreamSize(sbstreamobject); } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOS. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOF() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOS()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOS. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOF() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOS()) +/// /// public bool fnStreamObject_isEOF (string streamobject) @@ -33216,7 +42451,32 @@ public bool fnStreamObject_isEOF (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_isEOF(sbstreamobject)>=1; } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOF. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOS() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOF()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOF. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOS() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOF()) +/// /// public bool fnStreamObject_isEOS (string streamobject) @@ -33230,7 +42490,30 @@ public bool fnStreamObject_isEOS (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_isEOS(sbstreamobject)>=1; } /// -/// @brief Read a line from the stream. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file stream object for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject = new FileStreamObject(); %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Print the line we just read echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing the line of data that was just read @see writeLine()) +/// @brief Read a line from the stream. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file stream object for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject = new FileStreamObject(); +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Print the line we just read +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing the line of data that was just read +/// +/// @see writeLine()) +/// /// public string fnStreamObject_readLine (string streamobject) @@ -33247,7 +42530,15 @@ public string fnStreamObject_readLine (string streamobject) } /// -/// @brief Read in a string up to the given maximum number of characters. @param maxLength The maximum number of characters to read in. @return The string that was read from the stream. @see writeLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string up to the given maximum number of characters. +/// @param maxLength The maximum number of characters to read in. +/// @return The string that was read from the stream. +/// @see writeLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string fnStreamObject_readLongString (string streamobject, int maxLength) @@ -33264,7 +42555,14 @@ public string fnStreamObject_readLongString (string streamobject, int maxLength) } /// -/// @brief Read a string up to a maximum of 256 characters @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read a string up to a maximum of 256 characters +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string fnStreamObject_readString (string streamobject) @@ -33281,7 +42579,16 @@ public string fnStreamObject_readString (string streamobject) } /// -/// @brief Read in a string and place it on the string table. @param caseSensitive If false then case will not be taken into account when attempting to match the read in string with what is already in the string table. @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string and place it on the string table. +/// @param caseSensitive If false then case will not be taken into account when attempting +/// to match the read in string with what is already in the string table. +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string fnStreamObject_readSTString (string streamobject, bool caseSensitive) @@ -33298,7 +42605,35 @@ public string fnStreamObject_readSTString (string streamobject, bool caseSensiti } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // 11111111111 // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Skip ahead by 12, which will bypass the first line entirely %fsObject.setPosition(12); // Read in the next line %line = %fsObject.readLine(); // Print the line just read in, should be \"Hello World\" echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see getPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // 11111111111 +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Skip ahead by 12, which will bypass the first line entirely +/// %fsObject.setPosition(12); +/// // Read in the next line +/// %line = %fsObject.readLine(); +/// // Print the line just read in, should be \"Hello World\" +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see getPosition()) +/// /// public bool fnStreamObject_setPosition (string streamobject, int newPosition) @@ -33312,7 +42647,29 @@ public bool fnStreamObject_setPosition (string streamobject, int newPosition) return SafeNativeMethods.mwle_fnStreamObject_setPosition(sbstreamobject, newPosition)>=1; } /// -/// @brief Write a line to the stream, if it was opened for writing. There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param line The data we are writing out to file. @tsexample // Create a file stream %fsObject = new FileStreamObject(); // Open the file for writing // If it does not exist, it is created. If it does exist, the file is cleared %fsObject.open(\"./test.txt\", \"write\"); // Write a line to the file %fsObject.writeLine(\"Hello World\"); // Write another line to the file %fsObject.writeLine(\"Documentation Rocks!\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see readLine()) +/// @brief Write a line to the stream, if it was opened for writing. +/// +/// There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param line The data we are writing out to file. +/// +/// @tsexample +/// // Create a file stream +/// %fsObject = new FileStreamObject(); +/// // Open the file for writing +/// // If it does not exist, it is created. If it does exist, the file is cleared +/// %fsObject.open(\"./test.txt\", \"write\"); +/// // Write a line to the file +/// %fsObject.writeLine(\"Hello World\"); +/// // Write another line to the file +/// %fsObject.writeLine(\"Documentation Rocks!\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see readLine()) +/// /// public void fnStreamObject_writeLine (string streamobject, string line) @@ -33329,7 +42686,15 @@ public void fnStreamObject_writeLine (string streamobject, string line) SafeNativeMethods.mwle_fnStreamObject_writeLine(sbstreamobject, sbline); } /// -/// @brief Write out a string up to the maximum number of characters. @param maxLength The maximum number of characters that will be written. @param string The string to write out to the stream. @see readLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string up to the maximum number of characters. +/// @param maxLength The maximum number of characters that will be written. +/// @param string The string to write out to the stream. +/// @see readLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void fnStreamObject_writeLongString (string streamobject, int maxLength, string stringx) @@ -33346,7 +42711,16 @@ public void fnStreamObject_writeLongString (string streamobject, int maxLength, SafeNativeMethods.mwle_fnStreamObject_writeLongString(sbstreamobject, maxLength, sbstringx); } /// -/// @brief Write out a string with a default maximum length of 256 characters. @param string The string to write out to the stream @param maxLength The maximum string length to write out with a default of 256 characters. This value should not be larger than 256 as it is written to the stream as a single byte. @see readString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string with a default maximum length of 256 characters. +/// @param string The string to write out to the stream +/// @param maxLength The maximum string length to write out with a default of 256 characters. This +/// value should not be larger than 256 as it is written to the stream as a single byte. +/// @see readString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void fnStreamObject_writeString (string streamobject, string stringx, int maxLength) @@ -33363,7 +42737,18 @@ public void fnStreamObject_writeString (string streamobject, string stringx, int SafeNativeMethods.mwle_fnStreamObject_writeString(sbstreamobject, sbstringx, maxLength); } /// -/// @brief Connect to the given address. @param address Server address (including port) to connect to. @tsexample // Set the address. %address = \"www.garagegames.com:80\"; // Inform this TCPObject to connect to the specified address. %thisTCPObj.connect(%address); @endtsexample) +/// @brief Connect to the given address. +/// +/// @param address Server address (including port) to connect to. +/// +/// @tsexample +/// // Set the address. +/// %address = \"www.garagegames.com:80\"; +/// +/// // Inform this TCPObject to connect to the specified address. +/// %thisTCPObj.connect(%address); +/// @endtsexample) +/// /// public void fnTCPObject_connect (string tcpobject, string address) @@ -33380,7 +42765,13 @@ public void fnTCPObject_connect (string tcpobject, string address) SafeNativeMethods.mwle_fnTCPObject_connect(sbtcpobject, sbaddress); } /// -/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. @tsexample // Inform this TCPObject to disconnect from anything it is currently connected to. %thisTCPObj.disconnect(); @endtsexample) +/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. +/// +/// @tsexample +/// // Inform this TCPObject to disconnect from anything it is currently connected to. +/// %thisTCPObj.disconnect(); +/// @endtsexample) +/// /// public void fnTCPObject_disconnect (string tcpobject) @@ -33394,10 +42785,37 @@ public void fnTCPObject_disconnect (string tcpobject) SafeNativeMethods.mwle_fnTCPObject_disconnect(sbtcpobject); } /// -/// @brief Start listening on the specified port for connections. This method starts a listener which looks for incoming TCP connections to a port. You must overload the onConnectionRequest callback to create a new TCPObject to read, write, or reject the new connection. @param port Port for this TCPObject to start listening for connections on. @tsexample // Create a listener on port 8080. new TCPObject( TCPListener ); TCPListener.listen( 8080 ); function TCPListener::onConnectionRequest( %this, %address, %id ) { // Create a new object to manage the connection. new TCPObject( TCPClient, %id ); } function TCPClient::onLine( %this, %line ) { // Print the line of text from client. echo( %line ); } @endtsexample) +/// @brief Start listening on the specified port for connections. +/// +/// This method starts a listener which looks for incoming TCP connections to a port. +/// You must overload the onConnectionRequest callback to create a new TCPObject to +/// read, write, or reject the new connection. +/// +/// @param port Port for this TCPObject to start listening for connections on. +/// +/// @tsexample +/// +/// // Create a listener on port 8080. +/// new TCPObject( TCPListener ); +/// TCPListener.listen( 8080 ); +/// +/// function TCPListener::onConnectionRequest( %this, %address, %id ) +/// { +/// // Create a new object to manage the connection. +/// new TCPObject( TCPClient, %id ); +/// } +/// +/// function TCPClient::onLine( %this, %line ) +/// { +/// // Print the line of text from client. +/// echo( %line ); +/// } +/// +/// @endtsexample) +/// /// -public void fnTCPObject_listen (string tcpobject, int port) +public void fnTCPObject_listen (string tcpobject, uint port) { if(Debugging) System.Console.WriteLine("----------------->Extern Call 'fnTCPObject_listen'" + string.Format("\"{0}\" \"{1}\" ",tcpobject,port)); @@ -33408,7 +42826,23 @@ public void fnTCPObject_listen (string tcpobject, int port) SafeNativeMethods.mwle_fnTCPObject_listen(sbtcpobject, port); } /// -/// @brief Transmits the data string to the connected computer. This method is used to send text data to the connected computer regardless if we initiated the connection using connect(), or listening to a port using listen(). @param data The data string to send. @tsexample // Set the command data %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" // Send the command to the connected server. %thisTCPObj.send(%data); @endtsexample) +/// @brief Transmits the data string to the connected computer. +/// +/// This method is used to send text data to the connected computer regardless if we initiated the +/// connection using connect(), or listening to a port using listen(). +/// +/// @param data The data string to send. +/// +/// @tsexample +/// // Set the command data +/// %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; +/// %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; +/// %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" +/// +/// // Send the command to the connected server. +/// %thisTCPObj.send(%data); +/// @endtsexample) +/// /// public void fnTCPObject_send (string tcpobject, string data) @@ -33425,7 +42859,12 @@ public void fnTCPObject_send (string tcpobject, string data) SafeNativeMethods.mwle_fnTCPObject_send(sbtcpobject, sbdata); } /// -/// @brief Saves the terrain block's terrain file to the specified file name. @param fileName Name and path of file to save terrain data to. @return True if file save was successful, false otherwise) +/// @brief Saves the terrain block's terrain file to the specified file name. +/// +/// @param fileName Name and path of file to save terrain data to. +/// +/// @return True if file save was successful, false otherwise) +/// /// public bool fnTerrainBlock_save (string terrainblock, string fileName) @@ -33443,6 +42882,7 @@ public bool fnTerrainBlock_save (string terrainblock, string fileName) } /// /// ) +/// /// public void fnTimeOfDay_addTimeOfDayEvent (string timeofday, float elevation, string identifier) @@ -33460,6 +42900,7 @@ public void fnTimeOfDay_addTimeOfDayEvent (string timeofday, float elevation, st } /// /// ) +/// /// public void fnTimeOfDay_animate (string timeofday, float elevation, float degreesPerSecond) @@ -33474,6 +42915,7 @@ public void fnTimeOfDay_animate (string timeofday, float elevation, float degree } /// /// ) +/// /// public void fnTimeOfDay_setDayLength (string timeofday, float seconds) @@ -33488,6 +42930,7 @@ public void fnTimeOfDay_setDayLength (string timeofday, float seconds) } /// /// ) +/// /// public void fnTimeOfDay_setPlay (string timeofday, bool enabled) @@ -33502,6 +42945,7 @@ public void fnTimeOfDay_setPlay (string timeofday, bool enabled) } /// /// ) +/// /// public void fnTimeOfDay_setTimeOfDay (string timeofday, float time) @@ -33515,7 +42959,9 @@ public void fnTimeOfDay_setTimeOfDay (string timeofday, float time) SafeNativeMethods.mwle_fnTimeOfDay_setTimeOfDay(sbtimeofday, time); } /// -/// @brief Get the number of objects that are within the Trigger's bounds. @see getObject()) +/// @brief Get the number of objects that are within the Trigger's bounds. +/// @see getObject()) +/// /// public int fnTrigger_getNumObjects (string trigger) @@ -33529,7 +42975,11 @@ public int fnTrigger_getNumObjects (string trigger) return SafeNativeMethods.mwle_fnTrigger_getNumObjects(sbtrigger); } /// -/// @brief Retrieve the requested object that is within the Trigger's bounds. @param index Index of the object to get (range is 0 to getNumObjects()-1) @returns The SimObjectID of the object, or -1 if the requested index is invalid. @see getNumObjects()) +/// @brief Retrieve the requested object that is within the Trigger's bounds. +/// @param index Index of the object to get (range is 0 to getNumObjects()-1) +/// @returns The SimObjectID of the object, or -1 if the requested index is invalid. +/// @see getNumObjects()) +/// /// public int fnTrigger_getObject (string trigger, int index) @@ -33543,7 +42993,11 @@ public int fnTrigger_getObject (string trigger, int index) return SafeNativeMethods.mwle_fnTrigger_getObject(sbtrigger, index); } /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool fnTSAttachable_attachObject (string tsattachable, string obj) @@ -33560,7 +43014,14 @@ public bool fnTSAttachable_attachObject (string tsattachable, string obj) return SafeNativeMethods.mwle_fnTSAttachable_attachObject(sbtsattachable, sbobj)>=1; } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void fnTSAttachable_detachAll (string tsattachable) @@ -33574,7 +43035,11 @@ public void fnTSAttachable_detachAll (string tsattachable) SafeNativeMethods.mwle_fnTSAttachable_detachAll(sbtsattachable); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool fnTSAttachable_detachObject (string tsattachable, string obj) @@ -33592,6 +43057,7 @@ public bool fnTSAttachable_detachObject (string tsattachable, string obj) } /// /// Returns the attachment at the passed index value.) +/// /// public string fnTSAttachable_getAttachment (string tsattachable, int index) @@ -33609,6 +43075,7 @@ public string fnTSAttachable_getAttachment (string tsattachable, int index) } /// /// Returns the number of objects that are currently attached.) +/// /// public int fnTSAttachable_getNumAttachments (string tsattachable) @@ -33622,7 +43089,25 @@ public int fnTSAttachable_getNumAttachments (string tsattachable) return SafeNativeMethods.mwle_fnTSAttachable_getNumAttachments(sbtsattachable); } /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void fnTSDynamic_changeMaterial (string tsdynamic, string mapTo, string oldMat, string newMat) @@ -33645,7 +43130,15 @@ public void fnTSDynamic_changeMaterial (string tsdynamic, string mapTo, string o SafeNativeMethods.mwle_fnTSDynamic_changeMaterial(sbtsdynamic, sbmapTo, sboldMat, sbnewMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string fnTSDynamic_getModelFile (string tsdynamic) @@ -33662,7 +43155,10 @@ public string fnTSDynamic_getModelFile (string tsdynamic) } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int fnTSDynamic_getTargetCount (string tsdynamic) @@ -33676,7 +43172,11 @@ public int fnTSDynamic_getTargetCount (string tsdynamic) return SafeNativeMethods.mwle_fnTSDynamic_getTargetCount(sbtsdynamic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string fnTSDynamic_getTargetName (string tsdynamic, int index) @@ -33694,6 +43194,7 @@ public string fnTSDynamic_getTargetName (string tsdynamic, int index) } /// /// Returns the looping state for the shape.) +/// /// public bool fnTSPathShape_getLooping (string tspathshape) @@ -33708,6 +43209,7 @@ public bool fnTSPathShape_getLooping (string tspathshape) } /// /// Returns the number of nodes on the shape's path.) +/// /// public int fnTSPathShape_getNodeCount (string tspathshape) @@ -33722,6 +43224,7 @@ public int fnTSPathShape_getNodeCount (string tspathshape) } /// /// Get the current position of the shape along the path (0.0 - lastNode - 1).) +/// /// public float fnTSPathShape_getPathPosition (string tspathshape) @@ -33735,7 +43238,12 @@ public float fnTSPathShape_getPathPosition (string tspathshape) return SafeNativeMethods.mwle_fnTSPathShape_getPathPosition(sbtspathshape); } /// -/// Removes the knot at the front of the shape's path. @tsexample // Remove the first knot in the shape's path. %pathShape.popFront(); @endtsexample) +/// Removes the knot at the front of the shape's path. +/// @tsexample +/// // Remove the first knot in the shape's path. +/// %pathShape.popFront(); +/// @endtsexample) +/// /// public void fnTSPathShape_popFront (string tspathshape) @@ -33749,7 +43257,25 @@ public void fnTSPathShape_popFront (string tspathshape) SafeNativeMethods.mwle_fnTSPathShape_popFront(sbtspathshape); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the back of its path %pathShape.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the back of its path +/// %pathShape.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void fnTSPathShape_pushBack (string tspathshape, string transform, float speed, string type, string path) @@ -33772,7 +43298,25 @@ public void fnTSPathShape_pushBack (string tspathshape, string transform, float SafeNativeMethods.mwle_fnTSPathShape_pushBack(sbtspathshape, sbtransform, speed, sbtype, sbpath); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the front of its path %pathShape.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the front of its path +/// %pathShape.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void fnTSPathShape_pushFront (string tspathshape, string transform, float speed, string type, string path) @@ -33795,7 +43339,13 @@ public void fnTSPathShape_pushFront (string tspathshape, string transform, float SafeNativeMethods.mwle_fnTSPathShape_pushFront(sbtspathshape, sbtransform, speed, sbtype, sbpath); } /// -/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. When makeFirstKnot is true a new knot is created and pushed onto the path. @param speed Speed for the first knot if created. @param makeFirstKnot Initialize a new path with the current shape transform. @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. +/// The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. +/// When makeFirstKnot is true a new knot is created and pushed onto the path. +/// @param speed Speed for the first knot if created. +/// @param makeFirstKnot Initialize a new path with the current shape transform. +/// @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// /// public void fnTSPathShape_reset (string tspathshape, float speed, bool makeFirstKnot, bool initFromPath) @@ -33809,7 +43359,9 @@ public void fnTSPathShape_reset (string tspathshape, float speed, bool makeFirst SafeNativeMethods.mwle_fnTSPathShape_reset(sbtspathshape, speed, makeFirstKnot, initFromPath); } /// -/// Sets whether the path should loop or stop at the last node. @param isLooping New loop flag true/false.) +/// Sets whether the path should loop or stop at the last node. +/// @param isLooping New loop flag true/false.) +/// /// public void fnTSPathShape_setLooping (string tspathshape, bool isLooping) @@ -33823,7 +43375,9 @@ public void fnTSPathShape_setLooping (string tspathshape, bool isLooping) SafeNativeMethods.mwle_fnTSPathShape_setLooping(sbtspathshape, isLooping); } /// -/// Set the movement state for this shape. @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// Set the movement state for this shape. +/// @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// /// public void fnTSPathShape_setMoveState (string tspathshape, int newState) @@ -33837,7 +43391,9 @@ public void fnTSPathShape_setMoveState (string tspathshape, int newState) SafeNativeMethods.mwle_fnTSPathShape_setMoveState(sbtspathshape, newState); } /// -/// Set the current position of the shape along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// Set the current position of the shape along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// /// public void fnTSPathShape_setPathPosition (string tspathshape, float position) @@ -33851,7 +43407,13 @@ public void fnTSPathShape_setPathPosition (string tspathshape, float position) SafeNativeMethods.mwle_fnTSPathShape_setPathPosition(sbtspathshape, position); } /// -/// @brief Set the movement target for this shape along its path. The shape will attempt to move along the path to the given target without going past the loop node. Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target state will be cleared. @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the shape to move to along its path.) +/// @brief Set the movement target for this shape along its path. +/// The shape will attempt to move along the path to the given target without going past the loop node. +/// Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target +/// state will be cleared. +/// @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the +/// shape to move to along its path.) +/// /// public void fnTSPathShape_setTarget (string tspathshape, float position) @@ -33865,7 +43427,32 @@ public void fnTSPathShape_setTarget (string tspathshape, float position) SafeNativeMethods.mwle_fnTSPathShape_setTarget(sbtspathshape, position); } /// -/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls may optionally be converted to boxes, spheres and/or capsules based on their volume. @param size size for this detail level @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, 26-dop, convex hulls. See the Shape Editor documentation for more details about these types. @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the whole shape), or the name of an object in the shape @param depth maximum split recursion depth (hulls only) @param merge volume % threshold used to merge hulls together (hulls only) @param concavity volume % threshold used to detect concavity (hulls only) @param maxVerts maximum number of vertices per hull (hulls only) @param boxMaxError max % volume difference for a hull to be converted to a box (hulls only) @param sphereMaxError max % volume difference for a hull to be converted to a sphere (hulls only) @param capsuleMaxError max % volume difference for a hull to be converted to a capsule (hulls only) @return true if successful, false otherwise @tsexample %this.addCollisionDetail( -1, \"box\", \"bounds\" ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); @endtsexample ) +/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls +/// may optionally be converted to boxes, spheres and/or capsules based on their +/// volume. +/// @param size size for this detail level +/// @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, +/// 26-dop, convex hulls. See the Shape Editor documentation for more details +/// about these types. +/// @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the +/// whole shape), or the name of an object in the shape +/// @param depth maximum split recursion depth (hulls only) +/// @param merge volume % threshold used to merge hulls together (hulls only) +/// @param concavity volume % threshold used to detect concavity (hulls only) +/// @param maxVerts maximum number of vertices per hull (hulls only) +/// @param boxMaxError max % volume difference for a hull to be converted to a +/// box (hulls only) +/// @param sphereMaxError max % volume difference for a hull to be converted to +/// a sphere (hulls only) +/// @param capsuleMaxError max % volume difference for a hull to be converted to +/// a capsule (hulls only) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addCollisionDetail( -1, \"box\", \"bounds\" ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addCollisionDetail (string tsshapeconstructor, int size, string type, string target, int depth, float merge, float concavity, int maxVerts, float boxMaxError, float sphereMaxError, float capsuleMaxError) @@ -33885,7 +43472,35 @@ public bool fnTSShapeConstructor_addCollisionDetail (string tsshapeconstructor, return SafeNativeMethods.mwle_fnTSShapeConstructor_addCollisionDetail(sbtsshapeconstructor, size, sbtype, sbtarget, depth, merge, concavity, maxVerts, boxMaxError, sphereMaxError, capsuleMaxError)>=1; } /// -/// Add (or edit) an imposter detail level to the shape. If the shape already contains an imposter detail level, this command will simply change the imposter settings @param size size of the imposter detail level @param equatorSteps defines the number of snapshots to take around the equator. Imagine the object being rotated around the vertical axis, then a snapshot taken at regularly spaced intervals. @param polarSteps defines the number of snapshots taken between the poles (top and bottom), at each equator step. eg. At each equator snapshot, snapshots are taken at regular intervals between the poles. @param dl the detail level to use when generating the snapshots. Note that this is an array index rather than a detail size. So if an object has detail sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots using detail size 150. @param dim defines the size of the imposter images in pixels. The larger the number, the more detailed the billboard will be. @param includePoles flag indicating whether to include the \"pole\" snapshots. ie. the views from the top and bottom of the object. @param polar_angle if pole snapshots are active (@a includePoles is true), this parameter defines the camera angle (in degrees) within which to render the pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot taken at the pole (looking directly down or up at the object) will be rendered when the camera is within 25 degrees of the pole. @return true if successful, false otherwise @tsexample %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level @endtsexample ) +/// Add (or edit) an imposter detail level to the shape. +/// If the shape already contains an imposter detail level, this command will +/// simply change the imposter settings +/// @param size size of the imposter detail level +/// @param equatorSteps defines the number of snapshots to take around the +/// equator. Imagine the object being rotated around the vertical axis, then +/// a snapshot taken at regularly spaced intervals. +/// @param polarSteps defines the number of snapshots taken between the poles +/// (top and bottom), at each equator step. eg. At each equator snapshot, +/// snapshots are taken at regular intervals between the poles. +/// @param dl the detail level to use when generating the snapshots. Note that +/// this is an array index rather than a detail size. So if an object has detail +/// sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots +/// using detail size 150. +/// @param dim defines the size of the imposter images in pixels. The larger the +/// number, the more detailed the billboard will be. +/// @param includePoles flag indicating whether to include the \"pole\" snapshots. +/// ie. the views from the top and bottom of the object. +/// @param polar_angle if pole snapshots are active (@a includePoles is true), this +/// parameter defines the camera angle (in degrees) within which to render the +/// pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot +/// taken at the pole (looking directly down or up at the object) will be rendered +/// when the camera is within 25 degrees of the pole. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); +/// %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_addImposter (string tsshapeconstructor, int size, int equatorSteps, int polarSteps, int dl, int dim, bool includePoles, float polarAngle) @@ -33899,7 +43514,21 @@ public int fnTSShapeConstructor_addImposter (string tsshapeconstructor, int size return SafeNativeMethods.mwle_fnTSShapeConstructor_addImposter(sbtsshapeconstructor, size, equatorSteps, polarSteps, dl, dim, includePoles, polarAngle); } /// -/// Add geometry from another DTS or DAE shape file into this shape. Any materials required by the source mesh are also copied into this shape.br> @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param srcShape name of a shape file (DTS or DAE) that contains the mesh @param srcMesh the full name (object name + detail size) of the mesh to copy from the DTS/DAE file into this shape/li> @return true if successful, false otherwise @tsexample %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); @endtsexample ) +/// Add geometry from another DTS or DAE shape file into this shape. +/// Any materials required by the source mesh are also copied into this shape.br> +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param srcShape name of a shape file (DTS or DAE) that contains the mesh +/// @param srcMesh the full name (object name + detail size) of the mesh to +/// copy from the DTS/DAE file into this shape/li> +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); +/// %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addMesh (string tsshapeconstructor, string meshName, string srcShape, string srcMesh) @@ -33922,7 +43551,21 @@ public bool fnTSShapeConstructor_addMesh (string tsshapeconstructor, string mesh return SafeNativeMethods.mwle_fnTSShapeConstructor_addMesh(sbtsshapeconstructor, sbmeshName, sbsrcShape, sbsrcMesh)>=1; } /// -/// Add a new node. @param name name for the new node (must not already exist) @param parentName name of an existing node to be the parent of the new node. If empty (\"\"), the new node will be at the root level of the node hierarchy. @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); @endtsexample ) +/// Add a new node. +/// @param name name for the new node (must not already exist) +/// @param parentName name of an existing node to be the parent of the new node. +/// If empty (\"\"), the new node will be at the root level of the node hierarchy. +/// @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); +/// %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); +/// %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addNode (string tsshapeconstructor, string name, string parentName, string txfm, bool isWorld) @@ -33945,7 +43588,29 @@ public bool fnTSShapeConstructor_addNode (string tsshapeconstructor, string name return SafeNativeMethods.mwle_fnTSShapeConstructor_addNode(sbtsshapeconstructor, sbname, sbparentName, sbtxfm, isWorld)>=1; } /// -/// Add a new mesh primitive to the shape. @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param type one of: \"box\", \"sphere\", \"capsule\" @param params mesh primitive parameters: ul> li>for box: \"size_x size_y size_z\"/li> li>for sphere: \"radius\"/li> li>for capsule: \"height radius\"/li> /ul> /ul> @param txfm local transform offset from the node for this mesh @param nodeName name of the node to attach the new mesh to (will change the object's node if adding a new mesh to an existing object) @return true if successful, false otherwise @tsexample %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); @endtsexample ) +/// Add a new mesh primitive to the shape. +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param type one of: \"box\", \"sphere\", \"capsule\" +/// @param params mesh primitive parameters: +/// ul> +/// li>for box: \"size_x size_y size_z\"/li> +/// li>for sphere: \"radius\"/li> +/// li>for capsule: \"height radius\"/li> +/// /ul> +/// /ul> +/// @param txfm local transform offset from the node for this mesh +/// @param nodeName name of the node to attach the new mesh to (will change the +/// object's node if adding a new mesh to an existing object) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); +/// %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); +/// %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addPrimitive (string tsshapeconstructor, string meshName, string type, string paramsx, string txfm, string nodeName) @@ -33974,7 +43639,34 @@ public bool fnTSShapeConstructor_addPrimitive (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_addPrimitive(sbtsshapeconstructor, sbmeshName, sbtype, sbparamsx, sbtxfm, sbnodeName)>=1; } /// -/// Add a new sequence to the shape. @param source the name of an existing sequence, or the name of a DTS or DAE shape or DSQ sequence file. When the shape file contains more than one sequence, the desired sequence can be specified by appending the name to the end of the shape file. eg. \"myShape.dts run\" would select the \"run\" sequence from the \"myShape.dts\" file. @param name name of the new sequence @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose rotation to the target shape root pose. @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose position to the target shape root pose. @return true if successful, false otherwise @tsexample %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); %this.addSequence( \"./myPlayer.dae run\", \"run\" ); %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end @endtsexample ) +/// Add a new sequence to the shape. +/// @param source the name of an existing sequence, or the name of a DTS or DAE +/// shape or DSQ sequence file. When the shape file contains more than one +/// sequence, the desired sequence can be specified by appending the name to the +/// end of the shape file. eg. \"myShape.dts run\" would select the \"run\" +/// sequence from the \"myShape.dts\" file. +/// @param name name of the new sequence +/// @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. +/// @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. +/// @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose rotation to the target shape root pose. +/// @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose position to the target shape root pose. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); +/// %this.addSequence( \"./myPlayer.dae run\", \"run\" ); +/// %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end +/// %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 +/// %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addSequence (string tsshapeconstructor, string source, string name, int start, int end, bool padRot, bool padTrans) @@ -33994,7 +43686,16 @@ public bool fnTSShapeConstructor_addSequence (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_addSequence(sbtsshapeconstructor, sbsource, sbname, start, end, padRot, padTrans)>=1; } /// -/// Add a new trigger to the sequence. @param name name of the sequence to modify @param keyframe keyframe of the new trigger @param state of the new trigger @return true if successful, false otherwise @tsexample %this.addTrigger( \"walk\", 3, 1 ); %this.addTrigger( \"walk\", 5, -1 ); @endtsexample ) +/// Add a new trigger to the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the new trigger +/// @param state of the new trigger +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addTrigger( \"walk\", 3, 1 ); +/// %this.addTrigger( \"walk\", 5, -1 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addTrigger (string tsshapeconstructor, string name, int keyframe, int state) @@ -34011,7 +43712,14 @@ public bool fnTSShapeConstructor_addTrigger (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_addTrigger(sbtsshapeconstructor, sbname, keyframe, state)>=1; } /// -/// Dump the shape hierarchy to the console or to a file. Useful for reviewing the result of a series of construction commands. @param filename Destination filename. If not specified, dump to console. @tsexample %this.dumpShape(); // dump to console %this.dumpShape( \"./dump.txt\" ); // dump to file @endtsexample ) +/// Dump the shape hierarchy to the console or to a file. Useful for reviewing +/// the result of a series of construction commands. +/// @param filename Destination filename. If not specified, dump to console. +/// @tsexample +/// %this.dumpShape(); // dump to console +/// %this.dumpShape( \"./dump.txt\" ); // dump to file +/// @endtsexample ) +/// /// public void fnTSShapeConstructor_dumpShape (string tsshapeconstructor, string filename) @@ -34028,7 +43736,9 @@ public void fnTSShapeConstructor_dumpShape (string tsshapeconstructor, string fi SafeNativeMethods.mwle_fnTSShapeConstructor_dumpShape(sbtsshapeconstructor, sbfilename); } /// -/// Get the bounding box for the shape. @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// Get the bounding box for the shape. +/// @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// /// public string fnTSShapeConstructor_getBounds (string tsshapeconstructor) @@ -34045,7 +43755,9 @@ public string fnTSShapeConstructor_getBounds (string tsshapeconstructor) } /// -/// Get the total number of detail levels in the shape. @return the number of detail levels in the shape ) +/// Get the total number of detail levels in the shape. +/// @return the number of detail levels in the shape ) +/// /// public int fnTSShapeConstructor_getDetailLevelCount (string tsshapeconstructor) @@ -34059,7 +43771,15 @@ public int fnTSShapeConstructor_getDetailLevelCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getDetailLevelCount(sbtsshapeconstructor); } /// -/// Get the index of the detail level with a given size. @param size size of the detail level to lookup @return index of the detail level with the desired size, or -1 if no such detail exists @tsexample if ( %this.getDetailLevelSize( 32 ) == -1 ) echo( \"Error: This shape does not have a detail level at size 32\" ); @endtsexample ) +/// Get the index of the detail level with a given size. +/// @param size size of the detail level to lookup +/// @return index of the detail level with the desired size, or -1 if no such +/// detail exists +/// @tsexample +/// if ( %this.getDetailLevelSize( 32 ) == -1 ) +/// echo( \"Error: This shape does not have a detail level at size 32\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getDetailLevelIndex (string tsshapeconstructor, int size) @@ -34073,7 +43793,16 @@ public int fnTSShapeConstructor_getDetailLevelIndex (string tsshapeconstructor, return SafeNativeMethods.mwle_fnTSShapeConstructor_getDetailLevelIndex(sbtsshapeconstructor, size); } /// -/// Get the name of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level name @tsexample // print the names of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getDetailLevelName( %i ) ); @endtsexample ) +/// Get the name of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level name +/// @tsexample +/// // print the names of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getDetailLevelName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getDetailLevelName (string tsshapeconstructor, int index) @@ -34090,7 +43819,16 @@ public string fnTSShapeConstructor_getDetailLevelName (string tsshapeconstructor } /// -/// Get the size of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level size @tsexample // print the sizes of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); @endtsexample ) +/// Get the size of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level size +/// @tsexample +/// // print the sizes of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getDetailLevelSize (string tsshapeconstructor, int index) @@ -34104,7 +43842,10 @@ public int fnTSShapeConstructor_getDetailLevelSize (string tsshapeconstructor, i return SafeNativeMethods.mwle_fnTSShapeConstructor_getDetailLevelSize(sbtsshapeconstructor, index); } /// -/// Get the index of the imposter (auto-billboard) detail level (if any). @return imposter detail level index, or -1 if the shape does not use imposters. ) +/// Get the index of the imposter (auto-billboard) detail level (if any). +/// @return imposter detail level index, or -1 if the shape does not use +/// imposters. ) +/// /// public int fnTSShapeConstructor_getImposterDetailLevel (string tsshapeconstructor) @@ -34118,7 +43859,26 @@ public int fnTSShapeConstructor_getImposterDetailLevel (string tsshapeconstructo return SafeNativeMethods.mwle_fnTSShapeConstructor_getImposterDetailLevel(sbtsshapeconstructor); } /// -/// Get the settings used to generate imposters for the indexed detail level. @param index index of the detail level to query (does not need to be an imposter detail level @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: dl> dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> dt>eqSteps/dt>dd>number of steps around the equator/dd> dt>pSteps/dt>dd>number of steps between the poles/dd> dt>dl/dt>dd>index of the detail level used to generate imposters/dd> dt>dim/dt>dd>size (in pixels) of each imposter image/dd> dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> dt>angle/dt>dd>angle at which to display pole images/dd> /dl> @tsexample // print the imposter detail level settings %index = %this.getImposterDetailLevel(); if ( %index != -1 ) echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); @endtsexample ) +/// Get the settings used to generate imposters for the indexed detail level. +/// @param index index of the detail level to query (does not need to be an +/// imposter detail level +/// @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: +/// dl> +/// dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> +/// dt>eqSteps/dt>dd>number of steps around the equator/dd> +/// dt>pSteps/dt>dd>number of steps between the poles/dd> +/// dt>dl/dt>dd>index of the detail level used to generate imposters/dd> +/// dt>dim/dt>dd>size (in pixels) of each imposter image/dd> +/// dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> +/// dt>angle/dt>dd>angle at which to display pole images/dd> +/// /dl> +/// @tsexample +/// // print the imposter detail level settings +/// %index = %this.getImposterDetailLevel(); +/// if ( %index != -1 ) +/// echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getImposterSettings (string tsshapeconstructor, int index) @@ -34135,7 +43895,13 @@ public string fnTSShapeConstructor_getImposterSettings (string tsshapeconstructo } /// -/// Get the number of meshes (detail levels) for the specified object. @param name name of the object to query @return the number of meshes for this object. @tsexample %count = %this.getMeshCount( \"SimpleShape\" ); @endtsexample ) +/// Get the number of meshes (detail levels) for the specified object. +/// @param name name of the object to query +/// @return the number of meshes for this object. +/// @tsexample +/// %count = %this.getMeshCount( \"SimpleShape\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getMeshCount (string tsshapeconstructor, string name) @@ -34152,7 +43918,14 @@ public int fnTSShapeConstructor_getMeshCount (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_getMeshCount(sbtsshapeconstructor, sbname); } /// -/// Get the name of the material attached to a mesh. Note that only the first material used by the mesh is returned. @param name full name (object name + detail size) of the mesh to query @return name of the material attached to the mesh (suitable for use with the Material mapTo field) @tsexample echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the name of the material attached to a mesh. Note that only the first +/// material used by the mesh is returned. +/// @param name full name (object name + detail size) of the mesh to query +/// @return name of the material attached to the mesh (suitable for use with the Material mapTo field) +/// @tsexample +/// echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getMeshMaterial (string tsshapeconstructor, string name) @@ -34172,7 +43945,22 @@ public string fnTSShapeConstructor_getMeshMaterial (string tsshapeconstructor, s } /// -/// Get the name of the indexed mesh (detail level) for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh name. @tsexample // print the names of all meshes in the shape %objCount = %this.getObjectCount(); for ( %i = 0; %i %objCount; %i++ ) { %objName = %this.getObjectName( %i ); %meshCount = %this.getMeshCount( %objName ); for ( %j = 0; %j %meshCount; %j++ ) echo( %this.getMeshName( %objName, %j ) ); } @endtsexample ) +/// Get the name of the indexed mesh (detail level) for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh name. +/// @tsexample +/// // print the names of all meshes in the shape +/// %objCount = %this.getObjectCount(); +/// for ( %i = 0; %i %objCount; %i++ ) +/// { +/// %objName = %this.getObjectName( %i ); +/// %meshCount = %this.getMeshCount( %objName ); +/// for ( %j = 0; %j %meshCount; %j++ ) +/// echo( %this.getMeshName( %objName, %j ) ); +/// } +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getMeshName (string tsshapeconstructor, string name, int index) @@ -34192,7 +43980,18 @@ public string fnTSShapeConstructor_getMeshName (string tsshapeconstructor, strin } /// -/// Get the detail level size of the indexed mesh for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh detail level size. @tsexample // print sizes for all detail levels of this object %objName = \"trunk\"; %count = %this.getMeshCount( %objName ); for ( %i = 0; %i %count; %i++ ) echo( %this.getMeshSize( %objName, %i ) ); @endtsexample ) +/// Get the detail level size of the indexed mesh for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh detail level size. +/// @tsexample +/// // print sizes for all detail levels of this object +/// %objName = \"trunk\"; +/// %count = %this.getMeshCount( %objName ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getMeshSize( %objName, %i ) ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getMeshSize (string tsshapeconstructor, string name, int index) @@ -34209,7 +44008,16 @@ public int fnTSShapeConstructor_getMeshSize (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_getMeshSize(sbtsshapeconstructor, sbname, index); } /// -/// Get the display type of the mesh. @param name name of the mesh to query @return the string returned is one of: dl>dt>normal/dt>dd>a normal 3D mesh/dd> dt>billboard/dt>dd>a mesh that always faces the camera/dd> dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> @tsexample echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the display type of the mesh. +/// @param name name of the mesh to query +/// @return the string returned is one of: +/// dl>dt>normal/dt>dd>a normal 3D mesh/dd> +/// dt>billboard/dt>dd>a mesh that always faces the camera/dd> +/// dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> +/// @tsexample +/// echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getMeshType (string tsshapeconstructor, string name) @@ -34229,7 +44037,13 @@ public string fnTSShapeConstructor_getMeshType (string tsshapeconstructor, strin } /// -/// Get the number of children of this node. @param name name of the node to query. @return the number of child nodes. @tsexample %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the number of children of this node. +/// @param name name of the node to query. +/// @return the number of child nodes. +/// @tsexample +/// %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeChildCount (string tsshapeconstructor, string name) @@ -34246,7 +44060,32 @@ public int fnTSShapeConstructor_getNodeChildCount (string tsshapeconstructor, st return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeChildCount(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed child node. @param name name of the parent node to query. @param index index of the child node (valid range is 0 - getNodeChildName()-1). @return the name of the indexed child node. @tsexample function dumpNode( %shape, %name, %indent ) { echo( %indent @ %name ); %count = %shape.getNodeChildCount( %name ); for ( %i = 0; %i %count; %i++ ) dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); } function dumpShape( %shape ) { // recursively dump node hierarchy %count = %shape.getNodeCount(); for ( %i = 0; %i %count; %i++ ) { // dump top level nodes %name = %shape.getNodeName( %i ); if ( %shape.getNodeParentName( %name ) $= ) dumpNode( %shape, %name, \"\" ); } } @endtsexample ) +/// Get the name of the indexed child node. +/// @param name name of the parent node to query. +/// @param index index of the child node (valid range is 0 - getNodeChildName()-1). +/// @return the name of the indexed child node. +/// @tsexample +/// function dumpNode( %shape, %name, %indent ) +/// { +/// echo( %indent @ %name ); +/// %count = %shape.getNodeChildCount( %name ); +/// for ( %i = 0; %i %count; %i++ ) +/// dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); +/// } +/// function dumpShape( %shape ) +/// { +/// // recursively dump node hierarchy +/// %count = %shape.getNodeCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// { +/// // dump top level nodes +/// %name = %shape.getNodeName( %i ); +/// if ( %shape.getNodeParentName( %name ) $= ) +/// dumpNode( %shape, %name, \"\" ); +/// } +/// } +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeChildName (string tsshapeconstructor, string name, int index) @@ -34266,7 +44105,12 @@ public string fnTSShapeConstructor_getNodeChildName (string tsshapeconstructor, } /// -/// Get the total number of nodes in the shape. @return the number of nodes in the shape. @tsexample %count = %this.getNodeCount(); @endtsexample ) +/// Get the total number of nodes in the shape. +/// @return the number of nodes in the shape. +/// @tsexample +/// %count = %this.getNodeCount(); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeCount (string tsshapeconstructor) @@ -34280,7 +44124,14 @@ public int fnTSShapeConstructor_getNodeCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeCount(sbtsshapeconstructor); } /// -/// Get the index of the node. @param name name of the node to lookup. @return the index of the named node, or -1 if no such node exists. @tsexample // get the index of Bip01 Pelvis node in the shape %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the index of the node. +/// @param name name of the node to lookup. +/// @return the index of the named node, or -1 if no such node exists. +/// @tsexample +/// // get the index of Bip01 Pelvis node in the shape +/// %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeIndex (string tsshapeconstructor, string name) @@ -34297,7 +44148,16 @@ public int fnTSShapeConstructor_getNodeIndex (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeIndex(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed node. @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). @return the name of the indexed node, or \"\" if no such node exists. @tsexample // print the names of all the nodes in the shape %count = %this.getNodeCount(); for (%i = 0; %i %count; %i++) echo(%i SPC %this.getNodeName(%i)); @endtsexample ) +/// Get the name of the indexed node. +/// @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). +/// @return the name of the indexed node, or \"\" if no such node exists. +/// @tsexample +/// // print the names of all the nodes in the shape +/// %count = %this.getNodeCount(); +/// for (%i = 0; %i %count; %i++) +/// echo(%i SPC %this.getNodeName(%i)); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeName (string tsshapeconstructor, int index) @@ -34314,7 +44174,13 @@ public string fnTSShapeConstructor_getNodeName (string tsshapeconstructor, int i } /// -/// Get the number of geometry objects attached to this node. @param name name of the node to query. @return the number of attached objects. @tsexample %count = %this.getNodeObjectCount( \"Bip01 Head\" ); @endtsexample ) +/// Get the number of geometry objects attached to this node. +/// @param name name of the node to query. +/// @return the number of attached objects. +/// @tsexample +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeObjectCount (string tsshapeconstructor, string name) @@ -34331,7 +44197,17 @@ public int fnTSShapeConstructor_getNodeObjectCount (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeObjectCount(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed object. @param name name of the node to query. @param index index of the object (valid range is 0 - getNodeObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects attached to the node %count = %this.getNodeObjectCount( \"Bip01 Head\" ); for ( %i = 0; %i %count; %i++ ) echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param name name of the node to query. +/// @param index index of the object (valid range is 0 - getNodeObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects attached to the node +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeObjectName (string tsshapeconstructor, string name, int index) @@ -34351,7 +44227,14 @@ public string fnTSShapeConstructor_getNodeObjectName (string tsshapeconstructor, } /// -/// Get the name of the node's parent. If the node has no parent (ie. it is at the root level), return an empty string. @param name name of the node to query. @return the name of the node's parent, or \"\" if the node is at the root level @tsexample echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); @endtsexample ) +/// Get the name of the node's parent. If the node has no parent (ie. it is at +/// the root level), return an empty string. +/// @param name name of the node to query. +/// @return the name of the node's parent, or \"\" if the node is at the root level +/// @tsexample +/// echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeParentName (string tsshapeconstructor, string name) @@ -34371,7 +44254,16 @@ public string fnTSShapeConstructor_getNodeParentName (string tsshapeconstructor, } /// -/// Get the base (ie. not animated) transform of a node. @param name name of the node to query. @param isWorld true to get the global transform, false (or omitted) to get the local-to-parent transform. @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". @tsexample %ret = %this.getNodeTransform( \"mount0\" ); %this.setNodeTransform( \"mount4\", %ret ); @endtsexample ) +/// Get the base (ie. not animated) transform of a node. +/// @param name name of the node to query. +/// @param isWorld true to get the global transform, false (or omitted) to get +/// the local-to-parent transform. +/// @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". +/// @tsexample +/// %ret = %this.getNodeTransform( \"mount0\" ); +/// %this.setNodeTransform( \"mount4\", %ret ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeTransform (string tsshapeconstructor, string name, bool isWorld) @@ -34391,7 +44283,12 @@ public string fnTSShapeConstructor_getNodeTransform (string tsshapeconstructor, } /// -/// Get the total number of objects in the shape. @return the number of objects in the shape. @tsexample %count = %this.getObjectCount(); @endtsexample ) +/// Get the total number of objects in the shape. +/// @return the number of objects in the shape. +/// @tsexample +/// %count = %this.getObjectCount(); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getObjectCount (string tsshapeconstructor) @@ -34405,7 +44302,13 @@ public int fnTSShapeConstructor_getObjectCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getObjectCount(sbtsshapeconstructor); } /// -/// Get the index of the first object with the given name. @param name name of the object to get. @return the index of the named object. @tsexample %index = %this.getObjectIndex( \"Head\" ); @endtsexample ) +/// Get the index of the first object with the given name. +/// @param name name of the object to get. +/// @return the index of the named object. +/// @tsexample +/// %index = %this.getObjectIndex( \"Head\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getObjectIndex (string tsshapeconstructor, string name) @@ -34422,7 +44325,16 @@ public int fnTSShapeConstructor_getObjectIndex (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_getObjectIndex(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed object. @param index index of the object to get (valid range is 0 - getObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects in the shape %count = %this.getObjectCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getObjectName( %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param index index of the object to get (valid range is 0 - getObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getObjectName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getObjectName (string tsshapeconstructor, int index) @@ -34439,7 +44351,14 @@ public string fnTSShapeConstructor_getObjectName (string tsshapeconstructor, int } /// -/// Get the name of the node this object is attached to. @param name name of the object to get. @return the name of the attached node, or an empty string if this object is not attached to a node (usually the case for skinned meshes). @tsexample echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); @endtsexample ) +/// Get the name of the node this object is attached to. +/// @param name name of the object to get. +/// @return the name of the attached node, or an empty string if this +/// object is not attached to a node (usually the case for skinned meshes). +/// @tsexample +/// echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getObjectNode (string tsshapeconstructor, string name) @@ -34459,7 +44378,24 @@ public string fnTSShapeConstructor_getObjectNode (string tsshapeconstructor, str } /// -/// Get information about blended sequences. @param name name of the sequence to query @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: dl> dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference frame (empty for blend sequences embedded in DTS files)/dd> dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences embedded in DTS files)/dd> /dl> @note Note that only sequences set to be blends using the setSequenceBlend command will contain the blendSeq and blendFrame information. @tsexample %blendData = %this.getSequenceBlend( \"look\" ); if ( getField( %blendData, 0 ) ) echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); @endtsexample ) +/// Get information about blended sequences. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: +/// dl> +/// dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> +/// dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference +/// frame (empty for blend sequences embedded in DTS files)/dd> +/// dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences +/// embedded in DTS files)/dd> +/// /dl> +/// @note Note that only sequences set to be blends using the setSequenceBlend +/// command will contain the blendSeq and blendFrame information. +/// @tsexample +/// %blendData = %this.getSequenceBlend( \"look\" ); +/// if ( getField( %blendData, 0 ) ) +/// echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceBlend (string tsshapeconstructor, string name) @@ -34479,7 +44415,9 @@ public string fnTSShapeConstructor_getSequenceBlend (string tsshapeconstructor, } /// -/// Get the total number of sequences in the shape. @return the number of sequences in the shape ) +/// Get the total number of sequences in the shape. +/// @return the number of sequences in the shape ) +/// /// public int fnTSShapeConstructor_getSequenceCount (string tsshapeconstructor) @@ -34493,7 +44431,14 @@ public int fnTSShapeConstructor_getSequenceCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceCount(sbtsshapeconstructor); } /// -/// Check if this sequence is cyclic (looping). @param name name of the sequence to query @return true if this sequence is cyclic, false if not @tsexample if ( !%this.getSequenceCyclic( \"ambient\" ) ) error( \"ambient sequence is not cyclic!\" ); @endtsexample ) +/// Check if this sequence is cyclic (looping). +/// @param name name of the sequence to query +/// @return true if this sequence is cyclic, false if not +/// @tsexample +/// if ( !%this.getSequenceCyclic( \"ambient\" ) ) +/// error( \"ambient sequence is not cyclic!\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_getSequenceCyclic (string tsshapeconstructor, string name) @@ -34510,7 +44455,13 @@ public bool fnTSShapeConstructor_getSequenceCyclic (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceCyclic(sbtsshapeconstructor, sbname)>=1; } /// -/// Get the number of keyframes in the sequence. @param name name of the sequence to query @return number of keyframes in the sequence @tsexample echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); @endtsexample ) +/// Get the number of keyframes in the sequence. +/// @param name name of the sequence to query +/// @return number of keyframes in the sequence +/// @tsexample +/// echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getSequenceFrameCount (string tsshapeconstructor, string name) @@ -34527,7 +44478,16 @@ public int fnTSShapeConstructor_getSequenceFrameCount (string tsshapeconstructor return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceFrameCount(sbtsshapeconstructor, sbname); } /// -/// Get the ground speed of the sequence. @note Note that only the first 2 ground frames of the sequence are examined; the speed is assumed to be constant throughout the sequence. @param name name of the sequence to query @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" @tsexample %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); echo( \"Run moves at \" @ %speed @ \" units per frame\" ); @endtsexample ) +/// Get the ground speed of the sequence. +/// @note Note that only the first 2 ground frames of the sequence are +/// examined; the speed is assumed to be constant throughout the sequence. +/// @param name name of the sequence to query +/// @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" +/// @tsexample +/// %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); +/// echo( \"Run moves at \" @ %speed @ \" units per frame\" ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceGroundSpeed (string tsshapeconstructor, string name) @@ -34547,7 +44507,15 @@ public string fnTSShapeConstructor_getSequenceGroundSpeed (string tsshapeconstru } /// -/// Find the index of the sequence with the given name. @param name name of the sequence to lookup @return index of the sequence with matching name, or -1 if not found @tsexample // Check if a given sequence exists in the shape if ( %this.getSequenceIndex( \"walk\" ) == -1 ) echo( \"Could not find 'walk' sequence\" ); @endtsexample ) +/// Find the index of the sequence with the given name. +/// @param name name of the sequence to lookup +/// @return index of the sequence with matching name, or -1 if not found +/// @tsexample +/// // Check if a given sequence exists in the shape +/// if ( %this.getSequenceIndex( \"walk\" ) == -1 ) +/// echo( \"Could not find 'walk' sequence\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getSequenceIndex (string tsshapeconstructor, string name) @@ -34564,7 +44532,16 @@ public int fnTSShapeConstructor_getSequenceIndex (string tsshapeconstructor, str return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceIndex(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed sequence. @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) @return the name of the sequence @tsexample // print the name of all sequences in the shape %count = %this.getSequenceCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getSequenceName( %i ) ); @endtsexample ) +/// Get the name of the indexed sequence. +/// @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) +/// @return the name of the sequence +/// @tsexample +/// // print the name of all sequences in the shape +/// %count = %this.getSequenceCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getSequenceName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceName (string tsshapeconstructor, int index) @@ -34581,7 +44558,10 @@ public string fnTSShapeConstructor_getSequenceName (string tsshapeconstructor, i } /// -/// Get the priority setting of the sequence. @param name name of the sequence to query @return priority value of the sequence ) +/// Get the priority setting of the sequence. +/// @param name name of the sequence to query +/// @return priority value of the sequence ) +/// /// public float fnTSShapeConstructor_getSequencePriority (string tsshapeconstructor, string name) @@ -34598,7 +44578,24 @@ public float fnTSShapeConstructor_getSequencePriority (string tsshapeconstructor return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequencePriority(sbtsshapeconstructor, sbname); } /// -/// Get information about where the sequence data came from. For example, whether it was loaded from an external DSQ file. @param name name of the sequence to query @return TAB delimited string of the form: \"from reserved start end total\", where: dl> dt>from/dt>dd>the source of the animation data, such as the path to a DSQ file, or the name of an existing sequence in the shape. This field will be empty for sequences already embedded in the DTS or DAE file./dd> dt>reserved/dt>dd>reserved value/dd> dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> dt>total/dt>dd>the total number of frames in the source sequence/dd> /dl> @tsexample // print the source for the walk animation echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); @endtsexample ) +/// Get information about where the sequence data came from. +/// For example, whether it was loaded from an external DSQ file. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"from reserved start end total\", where: +/// dl> +/// dt>from/dt>dd>the source of the animation data, such as the path to +/// a DSQ file, or the name of an existing sequence in the shape. This field +/// will be empty for sequences already embedded in the DTS or DAE file./dd> +/// dt>reserved/dt>dd>reserved value/dd> +/// dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> +/// dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> +/// dt>total/dt>dd>the total number of frames in the source sequence/dd> +/// /dl> +/// @tsexample +/// // print the source for the walk animation +/// echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceSource (string tsshapeconstructor, string name) @@ -34618,7 +44615,12 @@ public string fnTSShapeConstructor_getSequenceSource (string tsshapeconstructor, } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @tsexample %count = %this.getTargetCount(); @endtsexample ) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @tsexample +/// %count = %this.getTargetCount(); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getTargetCount (string tsshapeconstructor) @@ -34632,7 +44634,15 @@ public int fnTSShapeConstructor_getTargetCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getTargetCount(sbtsshapeconstructor); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @tsexample %count = %this.getTargetCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); @endtsexample ) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @tsexample +/// %count = %this.getTargetCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getTargetName (string tsshapeconstructor, int index) @@ -34649,7 +44659,17 @@ public string fnTSShapeConstructor_getTargetName (string tsshapeconstructor, int } /// -/// Get information about the indexed trigger @param name name of the sequence to query @param index index of the trigger (valid range is 0 - getTriggerCount()-1) @return string of the form \"frame state\" @tsexample // print all triggers in the sequence %count = %this.getTriggerCount( \"back\" ); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getTrigger( \"back\", %i ) ); @endtsexample ) +/// Get information about the indexed trigger +/// @param name name of the sequence to query +/// @param index index of the trigger (valid range is 0 - getTriggerCount()-1) +/// @return string of the form \"frame state\" +/// @tsexample +/// // print all triggers in the sequence +/// %count = %this.getTriggerCount( \"back\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getTrigger( \"back\", %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getTrigger (string tsshapeconstructor, string name, int index) @@ -34669,7 +44689,10 @@ public string fnTSShapeConstructor_getTrigger (string tsshapeconstructor, string } /// -/// Get the number of triggers in the specified sequence. @param name name of the sequence to query @return number of triggers in the sequence ) +/// Get the number of triggers in the specified sequence. +/// @param name name of the sequence to query +/// @return number of triggers in the sequence ) +/// /// public int fnTSShapeConstructor_getTriggerCount (string tsshapeconstructor, string name) @@ -34686,7 +44709,9 @@ public int fnTSShapeConstructor_getTriggerCount (string tsshapeconstructor, stri return SafeNativeMethods.mwle_fnTSShapeConstructor_getTriggerCount(sbtsshapeconstructor, sbname); } /// -/// Notify game objects that this shape file has changed, allowing them to update internal data if needed. ) +/// Notify game objects that this shape file has changed, allowing them to update +/// internal data if needed. ) +/// /// public void fnTSShapeConstructor_notifyShapeChanged (string tsshapeconstructor) @@ -34700,7 +44725,13 @@ public void fnTSShapeConstructor_notifyShapeChanged (string tsshapeconstructor) SafeNativeMethods.mwle_fnTSShapeConstructor_notifyShapeChanged(sbtsshapeconstructor); } /// -/// Remove the detail level (including all meshes in the detail level) @param size size of the detail level to remove @return true if successful, false otherwise @tsexample %this.removeDetailLevel( 2 ); @endtsexample ) +/// Remove the detail level (including all meshes in the detail level) +/// @param size size of the detail level to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeDetailLevel( 2 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeDetailLevel (string tsshapeconstructor, int index) @@ -34714,7 +44745,9 @@ public bool fnTSShapeConstructor_removeDetailLevel (string tsshapeconstructor, i return SafeNativeMethods.mwle_fnTSShapeConstructor_removeDetailLevel(sbtsshapeconstructor, index)>=1; } /// -/// () Remove the imposter detail level (if any) from the shape. @return true if successful, false otherwise ) +/// () Remove the imposter detail level (if any) from the shape. +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_removeImposter (string tsshapeconstructor) @@ -34728,7 +44761,14 @@ public bool fnTSShapeConstructor_removeImposter (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_removeImposter(sbtsshapeconstructor)>=1; } /// -/// Remove a mesh from the shape. If all geometry is removed from an object, the object is also removed. @param name full name (object name + detail size) of the mesh to remove @return true if successful, false otherwise @tsexample %this.removeMesh( \"SimpleShape128\" ); @endtsexample ) +/// Remove a mesh from the shape. +/// If all geometry is removed from an object, the object is also removed. +/// @param name full name (object name + detail size) of the mesh to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeMesh( \"SimpleShape128\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeMesh (string tsshapeconstructor, string name) @@ -34745,7 +44785,16 @@ public bool fnTSShapeConstructor_removeMesh (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_removeMesh(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove a node from the shape. The named node is removed from the shape, including from any sequences that use the node. Child nodes and objects attached to the node are re-assigned to the node's parent. @param name name of the node to remove. @return true if successful, false otherwise. @tsexample %this.removeNode( \"Nose\" ); @endtsexample ) +/// Remove a node from the shape. +/// The named node is removed from the shape, including from any sequences that +/// use the node. Child nodes and objects attached to the node are re-assigned +/// to the node's parent. +/// @param name name of the node to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.removeNode( \"Nose\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeNode (string tsshapeconstructor, string name) @@ -34762,7 +44811,16 @@ public bool fnTSShapeConstructor_removeNode (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_removeNode(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove an object (including all meshes for that object) from the shape. @param name name of the object to remove. @return true if successful, false otherwise. @tsexample // clear all objects in the shape %count = %this.getObjectCount(); for ( %i = %count-1; %i >= 0; %i-- ) %this.removeObject( %this.getObjectName(%i) ); @endtsexample ) +/// Remove an object (including all meshes for that object) from the shape. +/// @param name name of the object to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// // clear all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = %count-1; %i >= 0; %i-- ) +/// %this.removeObject( %this.getObjectName(%i) ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeObject (string tsshapeconstructor, string name) @@ -34779,7 +44837,10 @@ public bool fnTSShapeConstructor_removeObject (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_removeObject(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove the sequence from the shape. @param name name of the sequence to remove @return true if successful, false otherwise ) +/// Remove the sequence from the shape. +/// @param name name of the sequence to remove +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_removeSequence (string tsshapeconstructor, string name) @@ -34796,7 +44857,15 @@ public bool fnTSShapeConstructor_removeSequence (string tsshapeconstructor, stri return SafeNativeMethods.mwle_fnTSShapeConstructor_removeSequence(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove a trigger from the sequence. @param name name of the sequence to modify @param keyframe keyframe of the trigger to remove @param state of the trigger to remove @return true if successful, false otherwise @tsexample %this.removeTrigger( \"walk\", 3, 1 ); @endtsexample ) +/// Remove a trigger from the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the trigger to remove +/// @param state of the trigger to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeTrigger( \"walk\", 3, 1 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeTrigger (string tsshapeconstructor, string name, int keyframe, int state) @@ -34813,7 +44882,16 @@ public bool fnTSShapeConstructor_removeTrigger (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_removeTrigger(sbtsshapeconstructor, sbname, keyframe, state)>=1; } /// -/// Rename a detail level. @note Note that detail level names must be unique, so this command will fail if there is already a detail level with the desired name @param oldName current name of the detail level @param newName new name of the detail level @return true if successful, false otherwise @tsexample %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); @endtsexample ) +/// Rename a detail level. +/// @note Note that detail level names must be unique, so this command will +/// fail if there is already a detail level with the desired name +/// @param oldName current name of the detail level +/// @param newName new name of the detail level +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameDetailLevel (string tsshapeconstructor, string oldName, string newName) @@ -34833,7 +44911,16 @@ public bool fnTSShapeConstructor_renameDetailLevel (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_renameDetailLevel(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Rename a node. @note Note that node names must be unique, so this command will fail if there is already a node with the desired name @param oldName current name of the node @param newName new name of the node @return true if successful, false otherwise @tsexample %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); @endtsexample ) +/// Rename a node. +/// @note Note that node names must be unique, so this command will fail if +/// there is already a node with the desired name +/// @param oldName current name of the node +/// @param newName new name of the node +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameNode (string tsshapeconstructor, string oldName, string newName) @@ -34853,7 +44940,16 @@ public bool fnTSShapeConstructor_renameNode (string tsshapeconstructor, string o return SafeNativeMethods.mwle_fnTSShapeConstructor_renameNode(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Rename an object. @note Note that object names must be unique, so this command will fail if there is already an object with the desired name @param oldName current name of the object @param newName new name of the object @return true if successful, false otherwise @tsexample %this.renameObject( \"MyBox\", \"Box\" ); @endtsexample ) +/// Rename an object. +/// @note Note that object names must be unique, so this command will fail if +/// there is already an object with the desired name +/// @param oldName current name of the object +/// @param newName new name of the object +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameObject( \"MyBox\", \"Box\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameObject (string tsshapeconstructor, string oldName, string newName) @@ -34873,7 +44969,16 @@ public bool fnTSShapeConstructor_renameObject (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_renameObject(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Rename a sequence. @note Note that sequence names must be unique, so this command will fail if there is already a sequence with the desired name @param oldName current name of the sequence @param newName new name of the sequence @return true if successful, false otherwise @tsexample %this.renameSequence( \"walking\", \"walk\" ); @endtsexample ) +/// Rename a sequence. +/// @note Note that sequence names must be unique, so this command will fail +/// if there is already a sequence with the desired name +/// @param oldName current name of the sequence +/// @param newName new name of the sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameSequence( \"walking\", \"walk\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameSequence (string tsshapeconstructor, string oldName, string newName) @@ -34893,7 +44998,12 @@ public bool fnTSShapeConstructor_renameSequence (string tsshapeconstructor, stri return SafeNativeMethods.mwle_fnTSShapeConstructor_renameSequence(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Save the shape (with all current changes) to a new DTS file. @param filename Destination filename. @tsexample %this.saveShape( \"./myShape.dts\" ); @endtsexample ) +/// Save the shape (with all current changes) to a new DTS file. +/// @param filename Destination filename. +/// @tsexample +/// %this.saveShape( \"./myShape.dts\" ); +/// @endtsexample ) +/// /// public void fnTSShapeConstructor_saveShape (string tsshapeconstructor, string filename) @@ -34910,7 +45020,10 @@ public void fnTSShapeConstructor_saveShape (string tsshapeconstructor, string fi SafeNativeMethods.mwle_fnTSShapeConstructor_saveShape(sbtsshapeconstructor, sbfilename); } /// -/// Set the shape bounds to the given bounding box. @param Bounding box \"minX minY minZ maxX maxY maxZ\" @return true if successful, false otherwise ) +/// Set the shape bounds to the given bounding box. +/// @param Bounding box \"minX minY minZ maxX maxY maxZ\" +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_setBounds (string tsshapeconstructor, string bbox) @@ -34927,7 +45040,16 @@ public bool fnTSShapeConstructor_setBounds (string tsshapeconstructor, string bb return SafeNativeMethods.mwle_fnTSShapeConstructor_setBounds(sbtsshapeconstructor, sbbbox)>=1; } /// -/// Change the size of a detail level. @note Note that detail levels are always sorted in decreasing size order, so this command may cause detail level indices to change. @param index index of the detail level to modify @param newSize new size for the detail level @return new index for this detail level @tsexample %this.setDetailLevelSize( 2, 256 ); @endtsexample ) +/// Change the size of a detail level. +/// @note Note that detail levels are always sorted in decreasing size order, +/// so this command may cause detail level indices to change. +/// @param index index of the detail level to modify +/// @param newSize new size for the detail level +/// @return new index for this detail level +/// @tsexample +/// %this.setDetailLevelSize( 2, 256 ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_setDetailLevelSize (string tsshapeconstructor, int index, int newSize) @@ -34941,7 +45063,17 @@ public int fnTSShapeConstructor_setDetailLevelSize (string tsshapeconstructor, i return SafeNativeMethods.mwle_fnTSShapeConstructor_setDetailLevelSize(sbtsshapeconstructor, index, newSize); } /// -/// Set the name of the material attached to the mesh. @param meshName full name (object name + detail size) of the mesh to modify @param matName name of the material to attach. This could be the base name of the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a Material object already defined in script. @return true if successful, false otherwise @tsexample // set the mesh material %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); @endtsexample ) +/// Set the name of the material attached to the mesh. +/// @param meshName full name (object name + detail size) of the mesh to modify +/// @param matName name of the material to attach. This could be the base name of +/// the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a +/// Material object already defined in script. +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh material +/// %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setMeshMaterial (string tsshapeconstructor, string meshName, string matName) @@ -34961,7 +45093,14 @@ public bool fnTSShapeConstructor_setMeshMaterial (string tsshapeconstructor, str return SafeNativeMethods.mwle_fnTSShapeConstructor_setMeshMaterial(sbtsshapeconstructor, sbmeshName, sbmatName)>=1; } /// -/// Change the detail level size of the named mesh. @param name full name (object name + current size ) of the mesh to modify @param size new detail level size @return true if successful, false otherwise. @tsexample %this.setMeshSize( \"SimpleShape128\", 64 ); @endtsexample ) +/// Change the detail level size of the named mesh. +/// @param name full name (object name + current size ) of the mesh to modify +/// @param size new detail level size +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.setMeshSize( \"SimpleShape128\", 64 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setMeshSize (string tsshapeconstructor, string name, int size) @@ -34978,7 +45117,15 @@ public bool fnTSShapeConstructor_setMeshSize (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_setMeshSize(sbtsshapeconstructor, sbname, size)>=1; } /// -/// Set the display type for the mesh. @param name full name (object name + detail size) of the mesh to modify @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" @return true if successful, false otherwise @tsexample // set the mesh to be a billboard %this.setMeshType( \"SimpleShape64\", \"billboard\" ); @endtsexample ) +/// Set the display type for the mesh. +/// @param name full name (object name + detail size) of the mesh to modify +/// @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh to be a billboard +/// %this.setMeshType( \"SimpleShape64\", \"billboard\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setMeshType (string tsshapeconstructor, string name, string type) @@ -34998,7 +45145,14 @@ public bool fnTSShapeConstructor_setMeshType (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_setMeshType(sbtsshapeconstructor, sbname, sbtype)>=1; } /// -/// Set the parent of a node. @param name name of the node to modify @param parentName name of the parent node to set (use \"\" to move the node to the root level) @return true if successful, false if failed @tsexample %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); @endtsexample ) +/// Set the parent of a node. +/// @param name name of the node to modify +/// @param parentName name of the parent node to set (use \"\" to move the node to the root level) +/// @return true if successful, false if failed +/// @tsexample +/// %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setNodeParent (string tsshapeconstructor, string name, string parentName) @@ -35018,7 +45172,20 @@ public bool fnTSShapeConstructor_setNodeParent (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_setNodeParent(sbtsshapeconstructor, sbname, sbparentName)>=1; } /// -/// Set the base transform of a node. That is, the transform of the node when in the root (not-animated) pose. @param name name of the node to modify @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); @endtsexample ) +/// Set the base transform of a node. That is, the transform of the node when +/// in the root (not-animated) pose. +/// @param name name of the node to modify +/// @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); +/// %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); +/// %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setNodeTransform (string tsshapeconstructor, string name, string txfm, bool isWorld) @@ -35038,7 +45205,16 @@ public bool fnTSShapeConstructor_setNodeTransform (string tsshapeconstructor, st return SafeNativeMethods.mwle_fnTSShapeConstructor_setNodeTransform(sbtsshapeconstructor, sbname, sbtxfm, isWorld)>=1; } /// -/// Set the node an object is attached to. When the shape is rendered, the object geometry is rendered at the node's current transform. @param objName name of the object to modify @param nodeName name of the node to attach the object to @return true if successful, false otherwise @tsexample %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); @endtsexample ) +/// Set the node an object is attached to. +/// When the shape is rendered, the object geometry is rendered at the node's +/// current transform. +/// @param objName name of the object to modify +/// @param nodeName name of the node to attach the object to +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setObjectNode (string tsshapeconstructor, string objName, string nodeName) @@ -35058,7 +45234,19 @@ public bool fnTSShapeConstructor_setObjectNode (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_setObjectNode(sbtsshapeconstructor, sbobjName, sbnodeName)>=1; } /// -/// Mark a sequence as a blend or non-blend. A blend sequence is one that will be added on top of any other playing sequences. This is done by storing the animated node transforms relative to a reference frame, rather than as absolute transforms. @param name name of the sequence to modify @param blend true to make the sequence a blend, false for a non-blend @param blendSeq the name of the sequence that contains the blend reference frame @param blendFrame the reference frame in the blendSeq sequence @return true if successful, false otherwise @tsexample %this.setSequenceBlend( \"look\", true, \"root\", 0 ); @endtsexample ) +/// Mark a sequence as a blend or non-blend. +/// A blend sequence is one that will be added on top of any other playing +/// sequences. This is done by storing the animated node transforms relative +/// to a reference frame, rather than as absolute transforms. +/// @param name name of the sequence to modify +/// @param blend true to make the sequence a blend, false for a non-blend +/// @param blendSeq the name of the sequence that contains the blend reference frame +/// @param blendFrame the reference frame in the blendSeq sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceBlend( \"look\", true, \"root\", 0 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setSequenceBlend (string tsshapeconstructor, string name, bool blend, string blendSeq, int blendFrame) @@ -35078,7 +45266,15 @@ public bool fnTSShapeConstructor_setSequenceBlend (string tsshapeconstructor, st return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequenceBlend(sbtsshapeconstructor, sbname, blend, sbblendSeq, blendFrame)>=1; } /// -/// Mark a sequence as cyclic or non-cyclic. @param name name of the sequence to modify @param cyclic true to make the sequence cyclic, false for non-cyclic @return true if successful, false otherwise @tsexample %this.setSequenceCyclic( \"ambient\", true ); %this.setSequenceCyclic( \"shoot\", false ); @endtsexample ) +/// Mark a sequence as cyclic or non-cyclic. +/// @param name name of the sequence to modify +/// @param cyclic true to make the sequence cyclic, false for non-cyclic +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceCyclic( \"ambient\", true ); +/// %this.setSequenceCyclic( \"shoot\", false ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setSequenceCyclic (string tsshapeconstructor, string name, bool cyclic) @@ -35095,7 +45291,22 @@ public bool fnTSShapeConstructor_setSequenceCyclic (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequenceCyclic(sbtsshapeconstructor, sbname, cyclic)>=1; } /// -/// Set the translation and rotation ground speed of the sequence. The ground speed of the sequence is set by generating ground transform keyframes. The ground translational and rotational speed is assumed to be constant for the duration of the sequence. Existing ground frames for the sequence (if any) will be replaced. @param name name of the sequence to modify @param transSpeed translational speed (trans.x trans.y trans.z) in Torque units per frame @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in radians per frame. Default is \"0 0 0\" @return true if successful, false otherwise @tsexample %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); @endtsexample ) +/// Set the translation and rotation ground speed of the sequence. +/// The ground speed of the sequence is set by generating ground transform +/// keyframes. The ground translational and rotational speed is assumed to +/// be constant for the duration of the sequence. Existing ground frames for +/// the sequence (if any) will be replaced. +/// @param name name of the sequence to modify +/// @param transSpeed translational speed (trans.x trans.y trans.z) in +/// Torque units per frame +/// @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in +/// radians per frame. Default is \"0 0 0\" +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); +/// %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setSequenceGroundSpeed (string tsshapeconstructor, string name, string transSpeed, string rotSpeed) @@ -35118,7 +45329,11 @@ public bool fnTSShapeConstructor_setSequenceGroundSpeed (string tsshapeconstruct return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequenceGroundSpeed(sbtsshapeconstructor, sbname, sbtransSpeed, sbrotSpeed)>=1; } /// -/// Set the sequence priority. @param name name of the sequence to modify @param priority new priority value @return true if successful, false otherwise ) +/// Set the sequence priority. +/// @param name name of the sequence to modify +/// @param priority new priority value +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_setSequencePriority (string tsshapeconstructor, string name, float priority) @@ -35135,7 +45350,10 @@ public bool fnTSShapeConstructor_setSequencePriority (string tsshapeconstructor, return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequencePriority(sbtsshapeconstructor, sbname, priority)>=1; } /// -/// Write the current change set to a TSShapeConstructor script file. The name of the script file is the same as the model, but with .cs extension. eg. myShape.cs for myShape.dts or myShape.dae. ) +/// Write the current change set to a TSShapeConstructor script file. The +/// name of the script file is the same as the model, but with .cs extension. +/// eg. myShape.cs for myShape.dts or myShape.dae. ) +/// /// public void fnTSShapeConstructor_writeChangeSet (string tsshapeconstructor) @@ -35149,7 +45367,25 @@ public void fnTSShapeConstructor_writeChangeSet (string tsshapeconstructor) SafeNativeMethods.mwle_fnTSShapeConstructor_writeChangeSet(sbtsshapeconstructor); } /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void fnTSStatic_changeMaterial (string tsstatic, string mapTo, string oldMat, string newMat) @@ -35172,7 +45408,15 @@ public void fnTSStatic_changeMaterial (string tsstatic, string mapTo, string old SafeNativeMethods.mwle_fnTSStatic_changeMaterial(sbtsstatic, sbmapTo, sboldMat, sbnewMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string fnTSStatic_getModelFile (string tsstatic) @@ -35189,7 +45433,10 @@ public string fnTSStatic_getModelFile (string tsstatic) } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int fnTSStatic_getTargetCount (string tsstatic) @@ -35203,7 +45450,11 @@ public int fnTSStatic_getTargetCount (string tsstatic) return SafeNativeMethods.mwle_fnTSStatic_getTargetCount(sbtsstatic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string fnTSStatic_getTargetName (string tsstatic, int index) @@ -35220,7 +45471,9 @@ public string fnTSStatic_getTargetName (string tsstatic, int index) } /// -/// @brief Does the turret respawn after it has been destroyed. @returns True if the turret respawns.) +/// @brief Does the turret respawn after it has been destroyed. +/// @returns True if the turret respawns.) +/// /// public bool fnTurretShape_doRespawn (string turretshape) @@ -35234,7 +45487,9 @@ public bool fnTurretShape_doRespawn (string turretshape) return SafeNativeMethods.mwle_fnTurretShape_doRespawn(sbturretshape)>=1; } /// -/// @brief Get if the turret is allowed to fire through moves. @return True if the turret is allowed to fire through moves. ) +/// @brief Get if the turret is allowed to fire through moves. +/// @return True if the turret is allowed to fire through moves. ) +/// /// public bool fnTurretShape_getAllowManualFire (string turretshape) @@ -35248,7 +45503,9 @@ public bool fnTurretShape_getAllowManualFire (string turretshape) return SafeNativeMethods.mwle_fnTurretShape_getAllowManualFire(sbturretshape)>=1; } /// -/// @brief Get if the turret is allowed to rotate through moves. @return True if the turret is allowed to rotate through moves. ) +/// @brief Get if the turret is allowed to rotate through moves. +/// @return True if the turret is allowed to rotate through moves. ) +/// /// public bool fnTurretShape_getAllowManualRotation (string turretshape) @@ -35262,7 +45519,15 @@ public bool fnTurretShape_getAllowManualRotation (string turretshape) return SafeNativeMethods.mwle_fnTurretShape_getAllowManualRotation(sbturretshape)>=1; } /// -/// @brief Get the name of the turret's current state. The state is one of the following:ul> li>Dead - The TurretShape is destroyed./li> li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> li>Ready - The TurretShape is free to move. The usual state./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// @brief Get the name of the turret's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The TurretShape is destroyed./li> +/// li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> +/// li>Ready - The TurretShape is free to move. The usual state./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// /// public string fnTurretShape_getState (string turretshape) @@ -35279,7 +45544,10 @@ public string fnTurretShape_getState (string turretshape) } /// -/// @brief Get Euler rotation of this turret's heading and pitch nodes. @return the orientation of the turret's heading and pitch nodes in the form of rotations around the X, Y and Z axes in degrees. ) +/// @brief Get Euler rotation of this turret's heading and pitch nodes. +/// @return the orientation of the turret's heading and pitch nodes in the +/// form of rotations around the X, Y and Z axes in degrees. ) +/// /// public string fnTurretShape_getTurretEulerRotation (string turretshape) @@ -35296,7 +45564,9 @@ public string fnTurretShape_getTurretEulerRotation (string turretshape) } /// -/// @brief Set if the turret is allowed to fire through moves. @param allow If true then the turret may be fired through moves.) +/// @brief Set if the turret is allowed to fire through moves. +/// @param allow If true then the turret may be fired through moves.) +/// /// public void fnTurretShape_setAllowManualFire (string turretshape, bool allow) @@ -35310,7 +45580,9 @@ public void fnTurretShape_setAllowManualFire (string turretshape, bool allow) SafeNativeMethods.mwle_fnTurretShape_setAllowManualFire(sbturretshape, allow); } /// -/// @brief Set if the turret is allowed to rotate through moves. @param allow If true then the turret may be rotated through moves.) +/// @brief Set if the turret is allowed to rotate through moves. +/// @param allow If true then the turret may be rotated through moves.) +/// /// public void fnTurretShape_setAllowManualRotation (string turretshape, bool allow) @@ -35324,7 +45596,10 @@ public void fnTurretShape_setAllowManualRotation (string turretshape, bool allow SafeNativeMethods.mwle_fnTurretShape_setAllowManualRotation(sbturretshape, allow); } /// -/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. @param rot The rotation in degrees. The pitch is the X component and the heading is the Z component. The Y component is ignored.) +/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. +/// @param rot The rotation in degrees. The pitch is the X component and the +/// heading is the Z component. The Y component is ignored.) +/// /// public void fnTurretShape_setTurretEulerRotation (string turretshape, string rot) @@ -35419,7 +45694,11 @@ public void fnVolumetricFog_SetFogModulation (string volumetricfog, float new_st SafeNativeMethods.mwle_fnVolumetricFog_SetFogModulation(sbvolumetricfog, new_strenght, sbnew_speed1, sbnew_speed2); } /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool fnWalkableShape_attachObject (string walkableshape, string obj) @@ -35436,7 +45715,14 @@ public bool fnWalkableShape_attachObject (string walkableshape, string obj) return SafeNativeMethods.mwle_fnWalkableShape_attachObject(sbwalkableshape, sbobj)>=1; } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void fnWalkableShape_detachAll (string walkableshape) @@ -35450,7 +45736,11 @@ public void fnWalkableShape_detachAll (string walkableshape) SafeNativeMethods.mwle_fnWalkableShape_detachAll(sbwalkableshape); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool fnWalkableShape_detachObject (string walkableshape, string obj) @@ -35468,6 +45758,7 @@ public bool fnWalkableShape_detachObject (string walkableshape, string obj) } /// /// Returns the attachment at the passed index value.) +/// /// public string fnWalkableShape_getAttachment (string walkableshape, int index) @@ -35485,6 +45776,7 @@ public string fnWalkableShape_getAttachment (string walkableshape, int index) } /// /// Returns the number of objects that are currently attached.) +/// /// public int fnWalkableShape_getNumAttachments (string walkableshape) @@ -35498,7 +45790,9 @@ public int fnWalkableShape_getNumAttachments (string walkableshape) return SafeNativeMethods.mwle_fnWalkableShape_getNumAttachments(sbwalkableshape); } /// -/// @brief Get the number of wheels on this vehicle. @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// @brief Get the number of wheels on this vehicle. +/// @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// /// public int fnWheeledVehicle_getWheelCount (string wheeledvehicle) @@ -35512,7 +45806,13 @@ public int fnWheeledVehicle_getWheelCount (string wheeledvehicle) return SafeNativeMethods.mwle_fnWheeledVehicle_getWheelCount(sbwheeledvehicle); } /// -/// @brief Set whether the wheel is powered (has torque applied from the engine). A rear wheel drive car for example would set the front wheels to false, and the rear wheels to true. @param wheel index of the wheel to set (hub node #) @param powered flag indicating whether to power the wheel or not @return true if successful, false if failed ) +/// @brief Set whether the wheel is powered (has torque applied from the engine). +/// A rear wheel drive car for example would set the front wheels to false, +/// and the rear wheels to true. +/// @param wheel index of the wheel to set (hub node #) +/// @param powered flag indicating whether to power the wheel or not +/// @return true if successful, false if failed ) +/// /// public bool fnWheeledVehicle_setWheelPowered (string wheeledvehicle, int wheel, bool powered) @@ -35526,7 +45826,14 @@ public bool fnWheeledVehicle_setWheelPowered (string wheeledvehicle, int wheel, return SafeNativeMethods.mwle_fnWheeledVehicle_setWheelPowered(sbwheeledvehicle, wheel, powered)>=1; } /// -/// @brief Set the WheeledVehicleSpring datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param spring WheeledVehicleSpring datablock @return true if successful, false if failed @tsexample %obj.setWheelSpring( 0, FrontSpring ); @endtsexample ) +/// @brief Set the WheeledVehicleSpring datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param spring WheeledVehicleSpring datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelSpring( 0, FrontSpring ); +/// @endtsexample ) +/// /// public bool fnWheeledVehicle_setWheelSpring (string wheeledvehicle, int wheel, string spring) @@ -35543,7 +45850,16 @@ public bool fnWheeledVehicle_setWheelSpring (string wheeledvehicle, int wheel, s return SafeNativeMethods.mwle_fnWheeledVehicle_setWheelSpring(sbwheeledvehicle, wheel, sbspring)>=1; } /// -/// @brief Set how much the wheel is affected by steering. The steering factor controls how much the wheel is rotated by the vehicle steering. For example, most cars would have their front wheels set to 1.0, and their rear wheels set to 0 since only the front wheels should turn. Negative values will turn the wheel in the opposite direction to the steering angle. @param wheel index of the wheel to set (hub node #) @param steering steering factor from -1 (full inverse) to 1 (full) @return true if successful, false if failed ) +/// @brief Set how much the wheel is affected by steering. +/// The steering factor controls how much the wheel is rotated by the vehicle +/// steering. For example, most cars would have their front wheels set to 1.0, +/// and their rear wheels set to 0 since only the front wheels should turn. +/// Negative values will turn the wheel in the opposite direction to the steering +/// angle. +/// @param wheel index of the wheel to set (hub node #) +/// @param steering steering factor from -1 (full inverse) to 1 (full) +/// @return true if successful, false if failed ) +/// /// public bool fnWheeledVehicle_setWheelSteering (string wheeledvehicle, int wheel, float steering) @@ -35557,7 +45873,14 @@ public bool fnWheeledVehicle_setWheelSteering (string wheeledvehicle, int wheel, return SafeNativeMethods.mwle_fnWheeledVehicle_setWheelSteering(sbwheeledvehicle, wheel, steering)>=1; } /// -/// @brief Set the WheeledVehicleTire datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param tire WheeledVehicleTire datablock @return true if successful, false if failed @tsexample %obj.setWheelTire( 0, FrontTire ); @endtsexample ) +/// @brief Set the WheeledVehicleTire datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param tire WheeledVehicleTire datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelTire( 0, FrontTire ); +/// @endtsexample ) +/// /// public bool fnWheeledVehicle_setWheelTire (string wheeledvehicle, int wheel, string tire) @@ -35575,6 +45898,7 @@ public bool fnWheeledVehicle_setWheelTire (string wheeledvehicle, int wheel, str } /// /// Create a ConvexShape from the given polyhedral object. ) +/// /// public string fnWorldEditor_createConvexShapeFrom (string worldeditor, string polyObject) @@ -35595,6 +45919,7 @@ public string fnWorldEditor_createConvexShapeFrom (string worldeditor, string po } /// /// Grab the geometry from @a geometryProvider, create a @a className object, and assign it the extracted geometry. ) +/// /// public string fnWorldEditor_createPolyhedralObject (string worldeditor, string className, string geometryProvider) @@ -35618,6 +45943,7 @@ public string fnWorldEditor_createPolyhedralObject (string worldeditor, string c } /// /// Get the soft snap alignment. ) +/// /// public int fnWorldEditor_getSoftSnapAlignment (string worldeditor) @@ -35632,6 +45958,7 @@ public int fnWorldEditor_getSoftSnapAlignment (string worldeditor) } /// /// Get the terrain snap alignment. ) +/// /// public int fnWorldEditor_getTerrainSnapAlignment (string worldeditor) @@ -35646,6 +45973,7 @@ public int fnWorldEditor_getTerrainSnapAlignment (string worldeditor) } /// /// ( WorldEditor, ignoreObjClass, void, 3, 0, (string class_name, ...)) +/// /// public void fnWorldEditor_ignoreObjClass (string worldeditor, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -35714,6 +46042,7 @@ public void fnWorldEditor_ignoreObjClass (string worldeditor, string a2, string } /// /// Set the soft snap alignment. ) +/// /// public void fnWorldEditor_setSoftSnapAlignment (string worldeditor, int type) @@ -35728,6 +46057,7 @@ public void fnWorldEditor_setSoftSnapAlignment (string worldeditor, int type) } /// /// Set the terrain snap alignment. ) +/// /// public void fnWorldEditor_setTerrainSnapAlignment (string worldeditor, int alignment) @@ -35742,6 +46072,7 @@ public void fnWorldEditor_setTerrainSnapAlignment (string worldeditor, int align } /// /// ( WorldEditorSelection, containsGlobalBounds, bool, 2, 2, () - True if an object with global bounds is contained in the selection. ) +/// /// public bool fnWorldEditorSelection_containsGlobalBounds (string worldeditorselection) @@ -35756,6 +46087,7 @@ public bool fnWorldEditorSelection_containsGlobalBounds (string worldeditorselec } /// /// ( WorldEditorSelection, getBoxCentroid, const char*, 2, 2, () - Return the center of the bounding box around the selection. ) +/// /// public string fnWorldEditorSelection_getBoxCentroid (string worldeditorselection) @@ -35773,6 +46105,7 @@ public string fnWorldEditorSelection_getBoxCentroid (string worldeditorselection } /// /// ( WorldEditorSelection, getCentroid, const char*, 2, 2, () - Return the median of all object positions in the selection. ) +/// /// public string fnWorldEditorSelection_getCentroid (string worldeditorselection) @@ -35790,6 +46123,7 @@ public string fnWorldEditorSelection_getCentroid (string worldeditorselection) } /// /// ( WorldEditorSelection, offset, void, 3, 4, ( vector delta, float gridSnap=0 ) - Move all objects in the selection by the given delta. ) +/// /// public void fnWorldEditorSelection_offset (string worldeditorselection, string a2, string a3) @@ -35810,6 +46144,7 @@ public void fnWorldEditorSelection_offset (string worldeditorselection, string a } /// /// ( WorldEditorSelection, subtract, void, 3, 3, ( SimSet ) - Remove all objects in the given set from this selection. ) +/// /// public void fnWorldEditorSelection_subtract (string worldeditorselection, string a2) @@ -35827,6 +46162,7 @@ public void fnWorldEditorSelection_subtract (string worldeditorselection, string } /// /// ( WorldEditorSelection, union, void, 3, 3, ( SimSet set ) - Add all objects in the given set to this selection. ) +/// /// public void fnWorldEditorSelection_union (string worldeditorselection, string a2) @@ -35843,7 +46179,14 @@ public void fnWorldEditorSelection_union (string worldeditorselection, string a2 SafeNativeMethods.mwle_fnWorldEditorSelection_union(sbworldeditorselection, sba2); } /// -/// @brief Add a file to the zip archive @param filename The path and name of the file to add to the zip archive. @param pathInZip The path and name to be given to the file within the zip archive. @param replace If a file already exists within the zip archive at the same location as this new file, this parameter indicates if it should be replaced. By default, it will be replaced. @return True if the file was successfully added to the zip archive.) +/// @brief Add a file to the zip archive +/// +/// @param filename The path and name of the file to add to the zip archive. +/// @param pathInZip The path and name to be given to the file within the zip archive. +/// @param replace If a file already exists within the zip archive at the same location as this +/// new file, this parameter indicates if it should be replaced. By default, it will be replaced. +/// @return True if the file was successfully added to the zip archive.) +/// /// public bool fnZipObject_addFile (string zipobject, string filename, string pathInZip, bool replace) @@ -35863,7 +46206,9 @@ public bool fnZipObject_addFile (string zipobject, string filename, string pathI return SafeNativeMethods.mwle_fnZipObject_addFile(sbzipobject, sbfilename, sbpathInZip, replace)>=1; } /// -/// @brief Close an already opened zip archive. @see openArchive()) +/// @brief Close an already opened zip archive. +/// @see openArchive()) +/// /// public void fnZipObject_closeArchive (string zipobject) @@ -35877,7 +46222,11 @@ public void fnZipObject_closeArchive (string zipobject) SafeNativeMethods.mwle_fnZipObject_closeArchive(sbzipobject); } /// -/// @brief Close a previously opened file within the zip archive. @param stream The StreamObject of a previously opened file within the zip archive. @see openFileForRead() @see openFileForWrite()) +/// @brief Close a previously opened file within the zip archive. +/// @param stream The StreamObject of a previously opened file within the zip archive. +/// @see openFileForRead() +/// @see openFileForWrite()) +/// /// public void fnZipObject_closeFile (string zipobject, string stream) @@ -35894,7 +46243,19 @@ public void fnZipObject_closeFile (string zipobject, string stream) SafeNativeMethods.mwle_fnZipObject_closeFile(sbzipobject, sbstream); } /// -/// @brief Deleted the given file from the zip archive @param pathInZip The path and name of the file to be deleted from the zip archive. @return True of the file was successfully deleted. @note Files that have been deleted from the archive will still show up with a getFileEntryCount() until you close the archive. If you need to have the file count up to date with only valid files within the archive, you could close and then open the archive again. @see getFileEntryCount() @see closeArchive() @see openArchive()) +/// @brief Deleted the given file from the zip archive +/// @param pathInZip The path and name of the file to be deleted from the zip archive. +/// @return True of the file was successfully deleted. +/// +/// @note Files that have been deleted from the archive will still show up with a +/// getFileEntryCount() until you close the archive. If you need to have the file +/// count up to date with only valid files within the archive, you could close and then +/// open the archive again. +/// +/// @see getFileEntryCount() +/// @see closeArchive() +/// @see openArchive()) +/// /// public bool fnZipObject_deleteFile (string zipobject, string pathInZip) @@ -35911,7 +46272,11 @@ public bool fnZipObject_deleteFile (string zipobject, string pathInZip) return SafeNativeMethods.mwle_fnZipObject_deleteFile(sbzipobject, sbpathInZip)>=1; } /// -/// @brief Extact a file from the zip archive and save it to the requested location. @param pathInZip The path and name of the file to be extracted within the zip archive. @param filename The path and name to give the extracted file. @return True if the file was successfully extracted.) +/// @brief Extact a file from the zip archive and save it to the requested location. +/// @param pathInZip The path and name of the file to be extracted within the zip archive. +/// @param filename The path and name to give the extracted file. +/// @return True if the file was successfully extracted.) +/// /// public bool fnZipObject_extractFile (string zipobject, string pathInZip, string filename) @@ -35931,7 +46296,22 @@ public bool fnZipObject_extractFile (string zipobject, string pathInZip, string return SafeNativeMethods.mwle_fnZipObject_extractFile(sbzipobject, sbpathInZip, sbfilename)>=1; } /// -/// @brief Get information on the requested file within the zip archive. This methods provides five different pieces of information for the requested file: ul>li>filename - The path and name of the file within the zip archive/li> li>uncompressed size/li> li>compressed size/li> li>compression method/li> li>CRC32/li>/ul> Use getFileEntryCount() to obtain the total number of files within the archive. @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. @see getFileEntryCount()) +/// @brief Get information on the requested file within the zip archive. +/// +/// This methods provides five different pieces of information for the requested file: +/// ul>li>filename - The path and name of the file within the zip archive/li> +/// li>uncompressed size/li> +/// li>compressed size/li> +/// li>compression method/li> +/// li>CRC32/li>/ul> +/// +/// Use getFileEntryCount() to obtain the total number of files within the archive. +/// +/// @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. +/// @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. +/// +/// @see getFileEntryCount()) +/// /// public string fnZipObject_getFileEntry (string zipobject, int index) @@ -35948,7 +46328,20 @@ public string fnZipObject_getFileEntry (string zipobject, int index) } /// -/// @brief Get the number of files within the zip archive. Use getFileEntry() to retrive information on each file within the archive. @return The number of files within the zip archive. @note The returned count will include any files that have been deleted from the archive using deleteFile(). To clear out all deleted files, you could close and then open the archive again. @see getFileEntry() @see closeArchive() @see openArchive()) +/// @brief Get the number of files within the zip archive. +/// +/// Use getFileEntry() to retrive information on each file within the archive. +/// +/// @return The number of files within the zip archive. +/// +/// @note The returned count will include any files that have been deleted from +/// the archive using deleteFile(). To clear out all deleted files, you could +/// close and then open the archive again. +/// +/// @see getFileEntry() +/// @see closeArchive() +/// @see openArchive()) +/// /// public int fnZipObject_getFileEntryCount (string zipobject) @@ -35962,7 +46355,23 @@ public int fnZipObject_getFileEntryCount (string zipobject) return SafeNativeMethods.mwle_fnZipObject_getFileEntryCount(sbzipobject); } /// -/// read ), @brief Open a zip archive for manipulation. Once a zip archive is opened use the various ZipObject methods for working with the files within the archive. Be sure to close the archive when you are done with it. @param filename The path and file name of the zip archive to open. @param accessMode One of read, write or readwrite @return True is the archive was successfully opened. @note If you wish to make any changes to the archive, be sure to open it with a write or readwrite access mode. @see closeArchive()) +/// read ), +/// @brief Open a zip archive for manipulation. +/// +/// Once a zip archive is opened use the various ZipObject methods for +/// working with the files within the archive. Be sure to close the archive when +/// you are done with it. +/// +/// @param filename The path and file name of the zip archive to open. +/// @param accessMode One of read, write or readwrite +/// +/// @return True is the archive was successfully opened. +/// +/// @note If you wish to make any changes to the archive, be sure to open it +/// with a write or readwrite access mode. +/// +/// @see closeArchive()) +/// /// public bool fnZipObject_openArchive (string zipobject, string filename, string accessMode) @@ -35982,7 +46391,18 @@ public bool fnZipObject_openArchive (string zipobject, string filename, string a return SafeNativeMethods.mwle_fnZipObject_openArchive(sbzipobject, sbfilename, sbaccessMode)>=1; } /// -/// @brief Open a file within the zip archive for reading. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for reading. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string fnZipObject_openFileForRead (string zipobject, string filename) @@ -36002,7 +46422,18 @@ public string fnZipObject_openFileForRead (string zipobject, string filename) } /// -/// @brief Open a file within the zip archive for writing to. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for writing to. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string fnZipObject_openFileForWrite (string zipobject, string filename) @@ -36022,7 +46453,11 @@ public string fnZipObject_openFileForWrite (string zipobject, string filename) } /// -/// Dump a list of all objects assigned to the zone to the console as well as a list of all connected zone spaces. @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of objects are updated on demand, the zone contents can be outdated. ) +/// Dump a list of all objects assigned to the zone to the console as well as a list +/// of all connected zone spaces. +/// @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of +/// objects are updated on demand, the zone contents can be outdated. ) +/// /// public void fnZone_dumpZoneState (string zone, bool updateFirst) @@ -36036,7 +46471,9 @@ public void fnZone_dumpZoneState (string zone, bool updateFirst) SafeNativeMethods.mwle_fnZone_dumpZoneState(sbzone, updateFirst); } /// -/// Get the unique numeric ID of the zone in its scene. @return The ID of the zone. ) +/// Get the unique numeric ID of the zone in its scene. +/// @return The ID of the zone. ) +/// /// public int fnZone_getZoneId (string zone) diff --git a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Omni.cs b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Omni.cs index e884697c..50f2c436 100644 --- a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Omni.cs +++ b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Omni.cs @@ -304,14 +304,14 @@ private void bwr_InitializeTorque(object sender, DoWorkEventArgs e) SafeNativeMethods.SetUpDynamicDLL(_mDll); } catch (Exception err) - { + { LastError = err; _mStop = true; if (_ScriptExtensions_Allow) csFactory.Instance.StopMonitoring(); return; - } + } //create a list of pointers for our parameters List myp = new List {Marshal.StringToCoTaskMemAnsi(Assembly.GetExecutingAssembly().Location)}; //Add the pointer to a managed memory string containing the location of the Assembly. diff --git a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj index c6b4a471..fb20969d 100644 --- a/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj +++ b/Templates/C#-Full-Ded/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj @@ -14,10 +14,14 @@ 512 - SAK - SAK - SAK - SAK + + + + + + + + x86 @@ -193,6 +197,15 @@ + + + + + + + + + @@ -206,5 +219,4 @@ - \ No newline at end of file diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/Audio.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/Audio.cs index 24492ccd..1d94d846 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/Audio.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/Audio.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Interopt; @@ -41,18 +41,16 @@ namespace WinterLeaf.Demo.Full.Models.User.CustomObjects.Utilities { public class Audio { - public static pInvokes tst = new pInvokes(); - public static void AudioServerPlay2D(string profile) { - foreach (GameConnection clientid in tst.ClientGroup) + foreach (GameConnection clientid in pInvokes.ClientGroup) clientid.play2D(profile); } public static void AudioServerPlay3D(string profile, TransformF transform) { - foreach (GameConnection clientid in tst.ClientGroup) + foreach (GameConnection clientid in pInvokes.ClientGroup) clientid.play3D(profile, transform); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/RadiusDamage.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/RadiusDamage.cs index 96a64ed5..52d156c7 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/RadiusDamage.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/RadiusDamage.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using System; using System.Collections.Generic; @@ -45,14 +45,12 @@ namespace WinterLeaf.Demo.Full.Models.User.CustomObjects.Utilities { internal class radiusDamage { - private static pInvokes tst = new pInvokes(); - public static void RadiusDamage(GameBase sourceobject, Point3F position, float radius, float damage, string damageType, float impulse) { // Use the container system to iterate through all the objects // within our explosion radius. We'll apply damage to all ShapeBase // objects. - Dictionary r = tst.console.initContainerRadiusSearch(position, radius, (uint) SceneObjectTypesAsUint.ShapeBaseObjectType); + Dictionary r = pInvokes.console.initContainerRadiusSearch(position, radius, (uint) SceneObjectTypesAsUint.ShapeBaseObjectType); float halfRadius = radius/(float) 2.0; foreach (ShapeBase targetObject in r.Keys) { @@ -63,7 +61,7 @@ public static void RadiusDamage(GameBase sourceobject, Point3F position, float r UInt32 mask = (uint) SceneObjectTypesAsUint.TerrainObjectType | (uint) SceneObjectTypesAsUint.StaticShapeObjectType | (uint) SceneObjectTypesAsUint.VehicleObjectType; - float coverage = tst.Util.calcExplosionCoverage(new Point3F(position), targetObject, mask); + float coverage = pInvokes.Util.calcExplosionCoverage(new Point3F(position), targetObject, mask); if (!coverage.AsBool()) continue; float dist = r[targetObject]; @@ -85,4 +83,4 @@ public static void RadiusDamage(GameBase sourceobject, Point3F position, float r } } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/message.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/message.cs index 3ff4770f..197d10e7 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/message.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/CustomObjects/Utilities/message.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using System; using System.ComponentModel; @@ -51,34 +51,32 @@ internal class message private static int SPAM_PENALTY_PERIOD = 10000; private static string _SPAM_MESSAGE = ""; - private static pInvokes tst = new pInvokes(); - public static string SPAM_MESSAGE { get { if (_SPAM_MESSAGE == "") - _SPAM_MESSAGE = tst.console.ColorEncode(@"\c3FLOOD PROTECTION:\cr You must wait another %1 seconds."); + _SPAM_MESSAGE = pInvokes.console.ColorEncode(@"\c3FLOOD PROTECTION:\cr You must wait another %1 seconds."); return _SPAM_MESSAGE; } } public static void MessageTeam(string team, string msgType, string msgString, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { - foreach (GameConnection clientid in tst.ClientGroup.Where(clientid => ((GameConnection) clientid)["team"] == team)) + foreach (GameConnection clientid in pInvokes.ClientGroup.Where(clientid => ((GameConnection) clientid)["team"] == team)) MessageClient(clientid, msgType, msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); } public static void MessageTeamExcept(GameConnection client, string msgType, string msgString, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { string team = client["team"]; - foreach (GameConnection clientid in tst.ClientGroup.Where(clientid => client["team"] == team && (clientid != client))) + foreach (GameConnection clientid in pInvokes.ClientGroup.Where(clientid => client["team"] == team && (clientid != client))) MessageClient(clientid, msgType, msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); } public static void MessageAllExcept(string client, string team, string msgtype, string msgstring, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { - foreach (GameConnection recipient in tst.ClientGroup.Where(recipient => ((GameConnection) recipient != client) && ((GameConnection) recipient)["team"] != team)) + foreach (GameConnection recipient in pInvokes.ClientGroup.Where(recipient => ((GameConnection) recipient != client) && ((GameConnection) recipient)["team"] != team)) MessageClient(recipient, msgtype, msgstring, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); } @@ -95,13 +93,13 @@ public static void GameConnectionspamReset(GameConnection thisobj) public static bool SpamAlert(GameConnection client) { - if (!tst.bGlobal["$Pref::Server::FloodProtectionEnabled"]) + if (!pInvokes.bGlobal["$Pref::Server::FloodProtectionEnabled"]) return false; if (!client["isSpamming"].AsBool() && client["spamMessageCount"].AsInt() >= SPAM_MESSAGE_THRESHOLD) { - tst.console.error("Client " + client + " is spamming, message count = " + client["spamMessageCount"]); - client["spamProtectStart"] = tst.console.getSimTime().AsString(); + pInvokes.console.error("Client " + client + " is spamming, message count = " + client["spamMessageCount"]); + client["spamProtectStart"] = pInvokes.console.getSimTime().AsString(); client["isSpamming"] = true.AsString(); using (BackgroundWorker bwr_SPAM_PENALTY_PERIOD = new BackgroundWorker()) { @@ -112,7 +110,7 @@ public static bool SpamAlert(GameConnection client) if (client["isSpamming"].AsBool()) { - double wait = Math.Floor((SPAM_PENALTY_PERIOD - (tst.console.getSimTime() - client["spamProtectStart"].AsDouble())/1000)); + double wait = Math.Floor((SPAM_PENALTY_PERIOD - (pInvokes.console.getSimTime() - client["spamProtectStart"].AsDouble())/1000)); MessageClient(client, "", SPAM_MESSAGE, wait.AsString()); return true; } @@ -156,10 +154,10 @@ private static void bwr_SPAM_PENALTY_PERIOD_DoWork(object sender, DoWorkEventArg public static void ChatMessageClient(GameConnection client, GameConnection sender, string voiceTag, string voicePitch, string msgString, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "") { - if (tst.console.isObject(client)) + if (pInvokes.console.isObject(client)) { if (!client["muted[" + sender + "]"].AsBool()) - tst.console.commandToClient(client, "ChatMessage", new string[] {sender, voiceTag, voicePitch, tst.console.addTaggedString(msgString), a1, a2, a3, a4, a5, a6, a7, a8, a9, a10}); + pInvokes.console.commandToClient(client, "ChatMessage", new string[] {sender, voiceTag, voicePitch, pInvokes.console.addTaggedString(msgString), a1, a2, a3, a4, a5, a6, a7, a8, a9, a10}); } } @@ -168,15 +166,15 @@ public static void ChatMessageTeam(GameConnection sender, string team, string ms if ((msgString.Trim().Length == 0) || SpamAlert(sender)) return; - foreach (GameConnection obj in tst.ClientGroup.Where(obj => ((GameConnection) obj)["team"] == sender["team"])) - ChatMessageClient(obj, sender, tst.console.GetVarString(string.Format("{0}.voiceTag", sender)), tst.console.GetVarString(string.Format("{0}.voicePitch", sender)), msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); + foreach (GameConnection obj in pInvokes.ClientGroup.Where(obj => ((GameConnection) obj)["team"] == sender["team"])) + ChatMessageClient(obj, sender, pInvokes.console.GetVarString(string.Format("{0}.voiceTag", sender)), pInvokes.console.GetVarString(string.Format("{0}.voicePitch", sender)), msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); } public static void ChatMessageAll(GameConnection sender, string msgString, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "") { if ((msgString.Trim().Length == 0) || SpamAlert(sender)) return; - foreach (GameConnection obj in tst.ClientGroup) + foreach (GameConnection obj in pInvokes.ClientGroup) { if (sender["team"].AsInt() != 0) ChatMessageClient(obj, sender, sender["voiceTag"], sender["voicePitch"], msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); @@ -191,23 +189,23 @@ public static void ChatMessageAll(GameConnection sender, string msgString, strin public static void MessageClient(GameConnection client, string msgtype, string msgstring, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { - string function = tst.console.addTaggedString("ServerMessage"); + string function = pInvokes.console.addTaggedString("ServerMessage"); string tmsgtype = ""; if (msgtype.Length > 0) - tmsgtype = (byte) msgtype[0] == (byte) 1 ? msgtype : tst.console.addTaggedString(msgtype); + tmsgtype = (byte) msgtype[0] == (byte) 1 ? msgtype : pInvokes.console.addTaggedString(msgtype); string tmsgstring = ""; if (msgstring.Length > 0) - tmsgstring = (byte) msgstring[0] == (byte) 1 ? msgstring : tst.console.addTaggedString(msgstring); - if (tst.console.isObject(client)) - tst.console.commandToClient(client, function, new[] {tmsgtype, tmsgstring, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13}); + tmsgstring = (byte) msgstring[0] == (byte) 1 ? msgstring : pInvokes.console.addTaggedString(msgstring); + if (pInvokes.console.isObject(client)) + pInvokes.console.commandToClient(client, function, new[] {tmsgtype, tmsgstring, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13}); } public static void MessageAll(string msgtype, string msgstring, string a1 = "", string a2 = "", string a3 = "", string a4 = "", string a5 = "", string a6 = "", string a7 = "", string a8 = "", string a9 = "", string a10 = "", string a11 = "", string a12 = "", string a13 = "") { - foreach (GameConnection clientid in tst.ClientGroup) + foreach (GameConnection clientid in pInvokes.ClientGroup) MessageClient(clientid, msgtype, msgstring, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audio.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audio.cs index eace4014..92a81f93 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audio.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audio.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Decorations; @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Audio { public class audio { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { SingletonCreator sc = new SingletonCreator("SFXDescription", "AudioMaster"); @@ -124,16 +122,16 @@ public static void initialize() // Volume channel IDs for backwards-compatibility. - omni.iGlobal["$GuiAudioType"] = 1; // Interface. - omni.iGlobal["$SimAudioType"] = 2; // Game. - omni.iGlobal["$MessageAudioType"] = 3; // Notifications. - omni.iGlobal["$MusicAudioType"] = 4; // Music. + pInvokes.iGlobal["$GuiAudioType"] = 1; // Interface. + pInvokes.iGlobal["$SimAudioType"] = 2; // Game. + pInvokes.iGlobal["$MessageAudioType"] = 3; // Notifications. + pInvokes.iGlobal["$MusicAudioType"] = 4; // Music. - omni.sGlobal["$AudioChannels[0]"] = "AudioChannelDefault"; - omni.sGlobal["$AudioChannels[" + omni.sGlobal["$GuiAudioType"] + "]"] = "AudioChannelGui"; - omni.sGlobal["$AudioChannels[" + omni.sGlobal["$SimAudioType"] + "]"] = "AudioChannelEffects"; - omni.sGlobal["$AudioChannels[" + omni.sGlobal["$MessageAudioType"] + "]"] = "AudioChannelMessages"; - omni.sGlobal["$AudioChannels[" + omni.sGlobal["$MusicAudioType"] + "]"] = "AudioChannelMusic"; + pInvokes.sGlobal["$AudioChannels[0]"] = "AudioChannelDefault"; + pInvokes.sGlobal["$AudioChannels[" + pInvokes.sGlobal["$GuiAudioType"] + "]"] = "AudioChannelGui"; + pInvokes.sGlobal["$AudioChannels[" + pInvokes.sGlobal["$SimAudioType"] + "]"] = "AudioChannelEffects"; + pInvokes.sGlobal["$AudioChannels[" + pInvokes.sGlobal["$MessageAudioType"] + "]"] = "AudioChannelMessages"; + pInvokes.sGlobal["$AudioChannels[" + pInvokes.sGlobal["$MusicAudioType"] + "]"] = "AudioChannelMusic"; sc = new SingletonCreator("SimSet", "SFXPausedSet"); sc.Create(); @@ -141,44 +139,44 @@ public static void initialize() public static void sfxStartup() { - // The console builds should re-detect, by default, so that it plays nicely + // The console builds should re-detect, by default, so that it plays nicely // along side a PC build in the same script directory. - if (omni.console.GetVarString("$platform") == "xenon") + if (pInvokes.console.GetVarString("$platform") == "xenon") { - if (omni.console.GetVarString("$pref::SFX::provider") == "DirectSound" || omni.console.GetVarString("$pref::SFX::provider") == "OpenAL") - omni.console.SetVar("$pref::SFX::provider", ""); - if (omni.console.GetVarString("$pref::SFX::provider") == "") + if (pInvokes.console.GetVarString("$pref::SFX::provider") == "DirectSound" || pInvokes.console.GetVarString("$pref::SFX::provider") == "OpenAL") + pInvokes.console.SetVar("$pref::SFX::provider", ""); + if (pInvokes.console.GetVarString("$pref::SFX::provider") == "") { - omni.console.SetVar("$pref::SFX::autoDetect", 1); - omni.console.warn("Xbox360 is auto-detecting available sound providers..."); - omni.console.warn(" - You may wish to alter this functionality before release (core/scripts/client/audio.cs)"); + pInvokes.console.SetVar("$pref::SFX::autoDetect", 1); + pInvokes.console.warn("Xbox360 is auto-detecting available sound providers..."); + pInvokes.console.warn(" - You may wish to alter this functionality before release (core/scripts/client/audio.cs)"); } } - omni.console.print("sfxStartup..."); + pInvokes.console.print("sfxStartup..."); // If we have a provider set, try initialize a device now. - if (omni.sGlobal["$pref::SFX::provider"] == "") + if (pInvokes.sGlobal["$pref::SFX::provider"] == "") { if (sfxInit()) return; else { // Force auto-detection. - omni.bGlobal["$pref::SFX::autoDetect"] = true; + pInvokes.bGlobal["$pref::SFX::autoDetect"] = true; if (sfxAutodetect()) return; } } else { - omni.bGlobal["$pref::SFX::autoDetect"] = true; + pInvokes.bGlobal["$pref::SFX::autoDetect"] = true; if (sfxAutodetect()) return; } // Failure. - omni.console.error("Failed to initialize device!\n\n"); - omni.sGlobal["$pref::SFX::provider"] = ""; - omni.sGlobal["$pref::SFX::device"] = ""; + pInvokes.console.error("Failed to initialize device!\n\n"); + pInvokes.sGlobal["$pref::SFX::provider"] = ""; + pInvokes.sGlobal["$pref::SFX::device"] = ""; } public static bool sfxInit() @@ -186,62 +184,62 @@ public static bool sfxInit() // This initializes the sound system device from // the defaults in the $pref::SFX:: globals. // If already initialized, shut down the current device first. - if (omni.Util.sfxGetDeviceInfo() != "") + if (pInvokes.Util.sfxGetDeviceInfo() != "") sfxShutdown(); // Start it up! - int maxBuffers = omni.bGlobal["$pref::SFX::useHardware"] ? -1 : omni.iGlobal["$pref::SFX::maxSoftwareBuffers"]; - if (!omni.Util.sfxCreateDevice(omni.sGlobal["$pref::SFX::provider"], omni.sGlobal["$pref::SFX::device"], omni.bGlobal["$pref::SFX::useHardware"], maxBuffers)) + int maxBuffers = pInvokes.bGlobal["$pref::SFX::useHardware"] ? -1 : pInvokes.iGlobal["$pref::SFX::maxSoftwareBuffers"]; + if (!pInvokes.Util.sfxCreateDevice(pInvokes.sGlobal["$pref::SFX::provider"], pInvokes.sGlobal["$pref::SFX::device"], pInvokes.bGlobal["$pref::SFX::useHardware"], maxBuffers)) return false; // This returns a tab seperated string with // the initialized system info. - string info = omni.Util.sfxGetDeviceInfo(); - omni.sGlobal["$pref::SFX::provider"] = omni.Util.getField(info, 0); - omni.sGlobal["$pref::SFX::device"] = omni.Util.getField(info, 1); - omni.sGlobal["$pref::SFX::useHardware"] = omni.Util.getField(info, 2); + string info = pInvokes.Util.sfxGetDeviceInfo(); + pInvokes.sGlobal["$pref::SFX::provider"] = pInvokes.Util.getField(info, 0); + pInvokes.sGlobal["$pref::SFX::device"] = pInvokes.Util.getField(info, 1); + pInvokes.sGlobal["$pref::SFX::useHardware"] = pInvokes.Util.getField(info, 2); - string useHardware = omni.bGlobal["$pref::SFX::useHardware"] ? "Yes" : "No"; - maxBuffers = omni.Util.getField(info, 3).AsInt(); + string useHardware = pInvokes.bGlobal["$pref::SFX::useHardware"] ? "Yes" : "No"; + maxBuffers = pInvokes.Util.getField(info, 3).AsInt(); - omni.console.print(" Provider: " + omni.console.GetVarString("$pref::SFX::provider")); - omni.console.print(" Device: " + omni.console.GetVarString("$pref::SFX::device")); - omni.console.print(" Hardware: " + useHardware); - omni.console.print(" Buffers: " + maxBuffers.AsString()); + pInvokes.console.print(" Provider: " + pInvokes.console.GetVarString("$pref::SFX::provider")); + pInvokes.console.print(" Device: " + pInvokes.console.GetVarString("$pref::SFX::device")); + pInvokes.console.print(" Hardware: " + useHardware); + pInvokes.console.print(" Buffers: " + maxBuffers.AsString()); - if (omni.Util.isDefined("$pref::SFX::distanceModel") && omni.sGlobal["$pref::SFX::distanceModel"] != "") + if (pInvokes.Util.isDefined("$pref::SFX::distanceModel") && pInvokes.sGlobal["$pref::SFX::distanceModel"] != "") { - TypeSFXDistanceModel t = omni.sGlobal["$pref::SFX::distanceModel"]; - omni.Util.sfxSetDistanceModel(t); + TypeSFXDistanceModel t = pInvokes.sGlobal["$pref::SFX::distanceModel"]; + pInvokes.Util.sfxSetDistanceModel(t); } - if (omni.Util.isDefined("$pref::SFX::dopplerFactor")) - omni.Util.sfxSetDopplerFactor(omni.fGlobal["$pref::SFX::dopplerFactor"]); + if (pInvokes.Util.isDefined("$pref::SFX::dopplerFactor")) + pInvokes.Util.sfxSetDopplerFactor(pInvokes.fGlobal["$pref::SFX::dopplerFactor"]); - if (omni.Util.isDefined("$pref::SFX::rolloffFactor") && omni.sGlobal["$pref::SFX::rolloffFactor"] != "") - omni.Util.sfxSetRolloffFactor(omni.fGlobal["$pref::SFX::rolloffFactor"]); + if (pInvokes.Util.isDefined("$pref::SFX::rolloffFactor") && pInvokes.sGlobal["$pref::SFX::rolloffFactor"] != "") + pInvokes.Util.sfxSetRolloffFactor(pInvokes.fGlobal["$pref::SFX::rolloffFactor"]); // Restore master volume. - sfxSetMasterVolume(omni.fGlobal["$pref::SFX::masterVolume"]); + sfxSetMasterVolume(pInvokes.fGlobal["$pref::SFX::masterVolume"]); // Restore channel volumes. for (int channel = 0; channel <= 8; channel++) - sfxSetChannelVolume(((SimSet) channel), omni.fGlobal["$pref::SFX::channelVolume[" + channel.AsString() + "]"]); + sfxSetChannelVolume(((SimSet) channel), pInvokes.fGlobal["$pref::SFX::channelVolume[" + channel.AsString() + "]"]); return true; } // Destroys the current sound system device. public static void sfxShutdown() { - omni.fGlobal["$pref::SFX::masterVolume"] = sfxGetMasterVolume(); + pInvokes.fGlobal["$pref::SFX::masterVolume"] = sfxGetMasterVolume(); for (int channel = 0; channel <= 8; channel++) - omni.sGlobal["$pref::SFX::channelVolume[" + channel.AsString() + "]"] = sfxGetChannelVolume(channel); + pInvokes.sGlobal["$pref::SFX::channelVolume[" + channel.AsString() + "]"] = sfxGetChannelVolume(channel); - // We're assuming here that a null info + // We're assuming here that a null info // string means that no device is loaded. - if (omni.Util.sfxGetDeviceInfo() == "") + if (pInvokes.Util.sfxGetDeviceInfo() == "") return; - omni.Util.sfxDeleteDevice(); + pInvokes.Util.sfxDeleteDevice(); } // Determines which of the two SFX providers is preferable. @@ -272,17 +270,17 @@ public static string sfxCompareProvider(string providerA, string providerB) public static bool sfxAutodetect() { // Get all the available devices. - string devices = omni.Util.sfxGetAvailableDevices(); + string devices = pInvokes.Util.sfxGetAvailableDevices(); // Collect and sort the devices by preferentiality. - int count = omni.Util.getRecordCount(devices); + int count = pInvokes.Util.getRecordCount(devices); ArrayObject deviceTrySequence = new ObjectCreator("ArrayObject").Create().AsString(); for (int i = 0; i < count; i++) { - string info = omni.Util.getRecord(devices, i); - string provider = omni.Util.getField(info, 0); + string info = pInvokes.Util.getRecord(devices, i); + string provider = pInvokes.Util.getField(info, 0); deviceTrySequence.push_back(provider, info); } deviceTrySequence.sortfk("sfxCompareProvider"); @@ -293,23 +291,23 @@ public static bool sfxAutodetect() { string provider = deviceTrySequence.getKey(i); string info = deviceTrySequence.getValue(i); - omni.sGlobal["$pref::SFX::provider"] = provider; - omni.sGlobal["$pref::SFX::device"] = omni.Util.getField(info, 1); - omni.sGlobal["$pref::SFX::useHardware"] = omni.Util.getField(info, 2); + pInvokes.sGlobal["$pref::SFX::provider"] = provider; + pInvokes.sGlobal["$pref::SFX::device"] = pInvokes.Util.getField(info, 1); + pInvokes.sGlobal["$pref::SFX::useHardware"] = pInvokes.Util.getField(info, 2); // By default we've decided to avoid hardware devices as // they are buggy and prone to problems. - omni.bGlobal["$pref::SFX::useHardware"] = false; + pInvokes.bGlobal["$pref::SFX::useHardware"] = false; if (!sfxInit()) continue; - omni.bGlobal["$pref::SFX::autoDetect"] = false; + pInvokes.bGlobal["$pref::SFX::autoDetect"] = false; deviceTrySequence.delete(); return true; } // Found no suitable device. - omni.console.error("sfxAutodetect - Could not initialize a valid SFX device."); - omni.sGlobal["$pref::SFX::provider"] = ""; - omni.sGlobal["$pref::SFX::device"] = ""; - omni.sGlobal["$pref::SFX::useHardware"] = ""; + pInvokes.console.error("sfxAutodetect - Could not initialize a valid SFX device."); + pInvokes.sGlobal["$pref::SFX::provider"] = ""; + pInvokes.sGlobal["$pref::SFX::device"] = ""; + pInvokes.sGlobal["$pref::SFX::useHardware"] = ""; deviceTrySequence.delete(); return false; } @@ -317,7 +315,7 @@ public static bool sfxAutodetect() [ConsoleInteraction(true)] public static SFXSource sfxOldChannelToGroup(string channel) { - return omni.sGlobal["$AudioChannels[" + channel + "]"]; + return pInvokes.sGlobal["$AudioChannels[" + channel + "]"]; } [ConsoleInteraction(true)] @@ -326,9 +324,9 @@ public static string sfxGroupToOldChannel(string group) string id = group.getID().AsString(); for (int i = 0;; i++) { - if (!omni.isGlobal["$AudioChannels[" + i.AsString() + "]"]) + if (!pInvokes.isGlobal["$AudioChannels[" + i.AsString() + "]"]) return "-1"; - else if (omni.sGlobal["$AudioChannels[" + i.AsString() + "]"] == id) + else if (pInvokes.sGlobal["$AudioChannels[" + i.AsString() + "]"] == id) return i.AsString(); } } @@ -371,4 +369,4 @@ public static void sfxSetChannelVolume(SimSet channel, float volume) obj.setVolume(volume); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audioData.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audioData.cs index 2aa851ff..e9574fda 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audioData.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Audio/audioData.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; @@ -42,8 +42,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Audio // before SFXProfile's (the sound itself) when creating new ones public class audioData { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { SingletonCreator sc = new SingletonCreator("SFXDescription", "BulletFireDesc : AudioEffect"); @@ -62,8 +60,8 @@ public static void initialize() sc["pitch"] = 1.4; sc.Create(); - if (omni.Util.isFile("scripts/client/audioData.cs")) - omni.Util.exec("scripts/client/audioData.cs", false, false); + if (pInvokes.Util.isFile("scripts/client/audioData.cs")) + pInvokes.Util.exec("scripts/client/audioData.cs", false, false); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/CenterPrint/centerPrint.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/CenterPrint/centerPrint.cs index eb30afd1..a6ae4231 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/CenterPrint/centerPrint.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/CenterPrint/centerPrint.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Decorations; @@ -42,15 +42,13 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.CenterPrint { public class centerPrint { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.iGlobal["$centerPrintActive"] = 0; - omni.iGlobal["$bottomPrintActive"] = 0; - omni.iGlobal["$CenterPrintSizes[1]"] = 20; - omni.iGlobal["$CenterPrintSizes[2]"] = 36; - omni.iGlobal["$CenterPrintSizes[3]"] = 56; + pInvokes.iGlobal["$centerPrintActive"] = 0; + pInvokes.iGlobal["$bottomPrintActive"] = 0; + pInvokes.iGlobal["$CenterPrintSizes[1]"] = 20; + pInvokes.iGlobal["$CenterPrintSizes[2]"] = 36; + pInvokes.iGlobal["$CenterPrintSizes[3]"] = 56; } [ConsoleInteraction(true)] @@ -58,21 +56,21 @@ public static void clientCmdCenterPrint(string message, string time, string size { GuiBitmapCtrl centerPrintDlg = "centerPrintDlg"; - if (omni.bGlobal["$centerPrintActive"]) + if (pInvokes.bGlobal["$centerPrintActive"]) { if (centerPrintDlg["removePrint"] != "") - omni.Util.cancel(centerPrintDlg["removePrint"].AsInt()); + pInvokes.Util.cancel(centerPrintDlg["removePrint"].AsInt()); } else { centerPrintDlg["visible"] = "1"; - omni.iGlobal["$centerPrintActive"] = 1; + pInvokes.iGlobal["$centerPrintActive"] = 1; } ((GuiMLTextCtrl) "CenterPrintText").setText("" + message); - centerPrintDlg.extent.y = omni.iGlobal["$CenterPrintSizes[" + size + "]"]; + centerPrintDlg.extent.y = pInvokes.iGlobal["$CenterPrintSizes[" + size + "]"]; if (time.AsInt() > 0) - centerPrintDlg["removePrint"] = omni.Util._schedule((time.AsInt()*1000).AsString(), "0", "clientCmdClearCenterPrint").AsString(); + centerPrintDlg["removePrint"] = pInvokes.Util._schedule((time.AsInt()*1000).AsString(), "0", "clientCmdClearCenterPrint").AsString(); } [ConsoleInteraction(true)] @@ -80,20 +78,20 @@ public static void clientCmdBottomPrint(string message, string time, string size { GuiBitmapCtrl bottomPrintDlg = "bottomPrintDlg"; - if (omni.bGlobal["$bottomPrintActive"]) + if (pInvokes.bGlobal["$bottomPrintActive"]) { if (bottomPrintDlg["removePrint"] != "") - omni.Util.cancel(bottomPrintDlg["removePrint"].AsInt()); + pInvokes.Util.cancel(bottomPrintDlg["removePrint"].AsInt()); } else { bottomPrintDlg.setVisible(true); - omni.iGlobal["$bottomPrintActive"] = 1; + pInvokes.iGlobal["$bottomPrintActive"] = 1; } ((GuiMLTextCtrl) "bottomPrintText").setText("" + message); - bottomPrintDlg.extent.y = omni.iGlobal["$CenterPrintSizes[" + size + "]"]; + bottomPrintDlg.extent.y = pInvokes.iGlobal["$CenterPrintSizes[" + size + "]"]; if (time.AsInt() > 0) - bottomPrintDlg["removePrint"] = omni.Util._schedule((time.AsInt()*1000).AsString(), "0", "clientCmdClearbottomPrint").AsString(); + bottomPrintDlg["removePrint"] = pInvokes.Util._schedule((time.AsInt()*1000).AsString(), "0", "clientCmdClearbottomPrint").AsString(); } //Bottom and Center PrintText resize is controled through proxy object printText.cs @@ -101,7 +99,7 @@ public static void clientCmdBottomPrint(string message, string time, string size [ConsoleInteraction(true)] public static void clientCmdClearCenterPrint() { - omni.iGlobal["$centerPrintActive"] = 0; + pInvokes.iGlobal["$centerPrintActive"] = 0; GuiBitmapCtrl CenterPrintDlg = "CenterPrintDlg"; CenterPrintDlg.visible = false; CenterPrintDlg["removePrint"] = ""; @@ -110,10 +108,10 @@ public static void clientCmdClearCenterPrint() [ConsoleInteraction(true)] public static void clientCmdClearBottomPrint() { - omni.iGlobal["$bottomPrintActive"] = 0; + pInvokes.iGlobal["$bottomPrintActive"] = 0; GuiBitmapCtrl BottomPrintDlg = "BottomPrintDlg"; BottomPrintDlg.visible = false; BottomPrintDlg["removePrint"] = ""; } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/GameConnection.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/GameConnection.cs index ede54e40..24cc0915 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/GameConnection.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/GameConnection.cs @@ -56,13 +56,13 @@ public override bool OnFunctionNotFoundCallTorqueScript() public static void initialize() { - omni.Util.eval(@"function disconnect(){_disconnect();}"); + Util.eval(@"function disconnect(){_disconnect();}"); } [ConsoleInteraction(true)] public static void handleConnectionErrorMessage(string msgType, string msgString, string msgError) { - omni.console.SetVar("$ServerConnectionErrorMessage", msgError); + console.SetVar("$ServerConnectionErrorMessage", msgError); } [ConsoleInteraction(true)] @@ -201,7 +201,7 @@ public static void _disconnect() { // We need to stop the client side simulation // else physics resources will not cleanup properly. - omni.Util.physicsStopSimulation("client"); + Util.physicsStopSimulation("client"); // Before we destroy the client physics world // make sure all ServerConnection objects are deleted. @@ -221,13 +221,13 @@ public static void _disconnect() public static void disconnectedCleanup() { // End mission, if it's running. - if (omni.console.GetVarBool("$Client::missionRunning")) + if (console.GetVarBool("$Client::missionRunning")) mission.clientEndMission(); // Disable mission lighting if it's going, this is here // in case we're disconnected while the mission is loading. - omni.bGlobal["$lightingMission"] = false; - omni.bGlobal["$sceneLighting::terminateLighting"] = true; + bGlobal["$lightingMission"] = false; + bGlobal["$sceneLighting::terminateLighting"] = true; // Clear misc script stuff ((MessageVector) "HudMessageVector").clear(); @@ -238,10 +238,10 @@ public static void disconnectedCleanup() centerPrint.clientCmdClearBottomPrint(); centerPrint.clientCmdClearCenterPrint(); - if (omni.console.isObject("MainMenuGui")) + if (console.isObject("MainMenuGui")) ((GuiCanvas) "Canvas").setContent("MainMenuGui"); - omni.Util.physicsDestroyWorld("client"); + Util.physicsDestroyWorld("client"); } } } \ No newline at end of file diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/ChooseLevel/chooseLevelDlg.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/ChooseLevel/chooseLevelDlg.cs index 769a7d41..23105140 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/ChooseLevel/chooseLevelDlg.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/ChooseLevel/chooseLevelDlg.cs @@ -62,13 +62,13 @@ public static void StartLevel(string mission, string hostingType) { GuiTextListCtrl CL_levelList = "CL_levelList"; if (mission == "") - mission = omni.Util.getField(CL_levelList.getRowTextById(CL_levelList.getSelectedId()), 1); + mission = Util.getField(CL_levelList.getRowTextById(CL_levelList.getSelectedId()), 1); string serverType = hostingType; if (serverType == "") { - if (omni.bGlobal["$pref::HostMultiPlayer"]) + if (bGlobal["$pref::HostMultiPlayer"]) serverType = "MultiPlayer"; else serverType = "SinglePlayer"; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Content Browser/ContentBrowserGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Content Browser/ContentBrowserGui.cs index e0122e96..f6850de3 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Content Browser/ContentBrowserGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Content Browser/ContentBrowserGui.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using System.ComponentModel; using WinterLeaf.Demo.Full.Models.User.Extendable; @@ -80,8 +80,6 @@ internal int columnId set { this["columnId"] = value.AsString(); } } - //private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { #region GuiWindowCtrl (ContentBrowserGui) oc_Newobject42 @@ -2301,7 +2299,7 @@ public void loadFilter(string sortFunction, string sortCallback, bool ascending) if (!CBScheduleArray.isObject()) CBScheduleArray = new ObjectCreator("ArrayObject", "CBScheduleArray").Create(); - // if we select another list... delete all schedules that were created by + // if we select another list... delete all schedules that were created by // previous load for (int i = 0; i < CBScheduleArray.count(); i++) Util.cancel(CBScheduleArray.getKey(i).AsInt()); @@ -2506,7 +2504,7 @@ public void loadMaterialDetails(string materialDetails) previewImage = ((SimObject) material["cubemap"])["cubeFace[0]"]; // were going to use a couple of string commands in order to properly - // find out what the img src path is + // find out what the img src path is // **NEW** this needs to be updated with the above, but has some timing issues string materialDiffuse = previewImage; @@ -2759,7 +2757,7 @@ public void createContainer(string name, string contentType, string previewIm { // it may seem goofy why the checkbox can't be instanciated inside the container // reason being its because we need to store the checkbox ctrl in order to make changes - // on it later in the function. + // on it later in the function. #region GuiControl () oc_Newobject6 @@ -3235,7 +3233,7 @@ public override void onSleep() public static int sortArrayAscending(string itemA, string itemB) { ContentBrowserGui ContentBrowserGui = "ContentBrowserGui"; - return omni.Util.strcmp(omni.Util.getField(itemB, ContentBrowserGui.columnId), omni.Util.getField(itemA, ContentBrowserGui.columnId)); + return Util.strcmp(Util.getField(itemB, ContentBrowserGui.columnId), Util.getField(itemA, ContentBrowserGui.columnId)); } [ConsoleInteraction] @@ -3243,7 +3241,7 @@ public static int sortArrayDescending(string itemA, string itemB) { ContentBrowserGui ContentBrowserGui = "ContentBrowserGui"; - return omni.Util.strcmp(omni.Util.getField(itemB, ContentBrowserGui.columnId), omni.Util.getField(itemA, ContentBrowserGui.columnId)); + return Util.strcmp(Util.getField(itemB, ContentBrowserGui.columnId), Util.getField(itemA, ContentBrowserGui.columnId)); } [ConsoleInteraction] @@ -3254,9 +3252,9 @@ public static bool isMainCanvas(GuiCanvas rootCanvas, string screenPos) { string extent1 = rootCanvas.getWindowPosition().AsString() + rootCanvas.getExtent().AsString(); - string finalPos1 = (omni.Util.getWord(extent1, 0).AsInt() + omni.Util.getWord(extent1, 2).AsInt()) + " " + (omni.Util.getWord(extent1, 1).AsInt() + omni.Util.getWord(extent1, 3).AsInt()); + string finalPos1 = (Util.getWord(extent1, 0).AsInt() + Util.getWord(extent1, 2).AsInt()) + " " + (Util.getWord(extent1, 1).AsInt() + Util.getWord(extent1, 3).AsInt()); - if (omni.Util.getWord(screenPos, 0).AsInt() < omni.Util.getWord(extent1, 0).AsInt() || omni.Util.getWord(screenPos, 1).AsInt() < omni.Util.getWord(extent1, 1).AsInt() || omni.Util.getWord(screenPos, 0).AsInt() > omni.Util.getWord(finalPos1, 0).AsInt() || omni.Util.getWord(screenPos, 1).AsInt() > omni.Util.getWord(finalPos1, 1).AsInt()) + if (Util.getWord(screenPos, 0).AsInt() < Util.getWord(extent1, 0).AsInt() || Util.getWord(screenPos, 1).AsInt() < Util.getWord(extent1, 1).AsInt() || Util.getWord(screenPos, 0).AsInt() > Util.getWord(finalPos1, 0).AsInt() || Util.getWord(screenPos, 1).AsInt() > Util.getWord(finalPos1, 1).AsInt()) { //echo("Outside Root"); } @@ -3268,9 +3266,9 @@ public static bool isMainCanvas(GuiCanvas rootCanvas, string screenPos) string extent = Canvas.getWindowPosition().AsString() + Canvas.getExtent().AsString(); - string finalPos = (omni.Util.getWord(extent, 0).AsInt() + omni.Util.getWord(extent, 2).AsInt()) + " " + (omni.Util.getWord(extent, 1).AsInt() + omni.Util.getWord(extent, 3).AsInt()); + string finalPos = (Util.getWord(extent, 0).AsInt() + Util.getWord(extent, 2).AsInt()) + " " + (Util.getWord(extent, 1).AsInt() + Util.getWord(extent, 3).AsInt()); - if (omni.Util.getWord(screenPos, 0).AsInt() < omni.Util.getWord(extent, 0).AsInt() || omni.Util.getWord(screenPos, 1).AsInt() < omni.Util.getWord(extent, 1).AsInt() || omni.Util.getWord(screenPos, 0).AsInt() > omni.Util.getWord(finalPos, 0).AsInt() || omni.Util.getWord(screenPos, 1).AsInt() > omni.Util.getWord(finalPos, 1).AsInt()) + if (Util.getWord(screenPos, 0).AsInt() < Util.getWord(extent, 0).AsInt() || Util.getWord(screenPos, 1).AsInt() < Util.getWord(extent, 1).AsInt() || Util.getWord(screenPos, 0).AsInt() > Util.getWord(finalPos, 0).AsInt() || Util.getWord(screenPos, 1).AsInt() > Util.getWord(finalPos, 1).AsInt()) { //echo("Outside Canvas"); return false; @@ -3285,7 +3283,7 @@ public static bool isMainCanvas(GuiCanvas rootCanvas, string screenPos) #region ProxyObjects Operator Overrides /// - /// + /// /// /// /// @@ -3296,7 +3294,7 @@ public static bool isMainCanvas(GuiCanvas rootCanvas, string screenPos) } /// - /// + /// /// /// public override int GetHashCode() @@ -3305,7 +3303,7 @@ public override int GetHashCode() } /// - /// + /// /// /// /// @@ -3315,7 +3313,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3328,7 +3326,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3338,7 +3336,7 @@ public static implicit operator string(ContentBrowserGui ts) } /// - /// + /// /// /// /// @@ -3349,7 +3347,7 @@ public static implicit operator ContentBrowserGui(string ts) } /// - /// + /// /// /// /// @@ -3359,7 +3357,7 @@ public static implicit operator int(ContentBrowserGui ts) } /// - /// + /// /// /// /// @@ -3369,7 +3367,7 @@ public static implicit operator ContentBrowserGui(int simobjectid) } /// - /// + /// /// /// /// @@ -3379,7 +3377,7 @@ public static implicit operator uint(ContentBrowserGui ts) } /// - /// + /// /// /// public static implicit operator ContentBrowserGui(uint simobjectid) @@ -3432,7 +3430,7 @@ public void selectRow(string item) #region ProxyObjects Operator Overrides /// - /// + /// /// /// /// @@ -3443,7 +3441,7 @@ public void selectRow(string item) } /// - /// + /// /// /// public override int GetHashCode() @@ -3452,7 +3450,7 @@ public override int GetHashCode() } /// - /// + /// /// /// /// @@ -3462,7 +3460,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3475,7 +3473,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3485,7 +3483,7 @@ public static implicit operator string(CBDetailedTable ts) } /// - /// + /// /// /// /// @@ -3496,7 +3494,7 @@ public static implicit operator CBDetailedTable(string ts) } /// - /// + /// /// /// /// @@ -3506,7 +3504,7 @@ public static implicit operator int(CBDetailedTable ts) } /// - /// + /// /// /// /// @@ -3516,7 +3514,7 @@ public static implicit operator CBDetailedTable(int simobjectid) } /// - /// + /// /// /// /// @@ -3526,7 +3524,7 @@ public static implicit operator uint(CBDetailedTable ts) } /// - /// + /// /// /// public static implicit operator CBDetailedTable(uint simobjectid) @@ -3583,7 +3581,7 @@ public override void onDblClick(string fullPath) #region ProxyObjects Operator Overrides /// - /// + /// /// /// /// @@ -3594,7 +3592,7 @@ public override void onDblClick(string fullPath) } /// - /// + /// /// /// public override int GetHashCode() @@ -3603,7 +3601,7 @@ public override int GetHashCode() } /// - /// + /// /// /// /// @@ -3613,7 +3611,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3626,7 +3624,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3636,7 +3634,7 @@ public static implicit operator string(CBLibraryTreeView ts) } /// - /// + /// /// /// /// @@ -3647,7 +3645,7 @@ public static implicit operator CBLibraryTreeView(string ts) } /// - /// + /// /// /// /// @@ -3657,7 +3655,7 @@ public static implicit operator int(CBLibraryTreeView ts) } /// - /// + /// /// /// /// @@ -3667,7 +3665,7 @@ public static implicit operator CBLibraryTreeView(int simobjectid) } /// - /// + /// /// /// /// @@ -3677,7 +3675,7 @@ public static implicit operator uint(CBLibraryTreeView ts) } /// - /// + /// /// /// public static implicit operator CBLibraryTreeView(uint simobjectid) @@ -3702,7 +3700,7 @@ public override void onReturn() #region ProxyObjects Operator Overrides /// - /// + /// /// /// /// @@ -3713,7 +3711,7 @@ public override void onReturn() } /// - /// + /// /// /// public override int GetHashCode() @@ -3722,7 +3720,7 @@ public override int GetHashCode() } /// - /// + /// /// /// /// @@ -3732,7 +3730,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3745,7 +3743,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3755,7 +3753,7 @@ public static implicit operator string(CBSearchAutoCompleteCtrl ts) } /// - /// + /// /// /// /// @@ -3766,7 +3764,7 @@ public static implicit operator CBSearchAutoCompleteCtrl(string ts) } /// - /// + /// /// /// /// @@ -3776,7 +3774,7 @@ public static implicit operator int(CBSearchAutoCompleteCtrl ts) } /// - /// + /// /// /// /// @@ -3786,7 +3784,7 @@ public static implicit operator CBSearchAutoCompleteCtrl(int simobjectid) } /// - /// + /// /// /// /// @@ -3796,7 +3794,7 @@ public static implicit operator uint(CBSearchAutoCompleteCtrl ts) } /// - /// + /// /// /// public static implicit operator CBSearchAutoCompleteCtrl(uint simobjectid) @@ -3832,7 +3830,7 @@ public override bool onSelectItem(string id, string text) #region ProxyObjects Operator Overrides /// - /// + /// /// /// /// @@ -3843,7 +3841,7 @@ public override bool onSelectItem(string id, string text) } /// - /// + /// /// /// public override int GetHashCode() @@ -3852,7 +3850,7 @@ public override int GetHashCode() } /// - /// + /// /// /// /// @@ -3862,7 +3860,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3875,7 +3873,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -3885,7 +3883,7 @@ public static implicit operator string(ContentDropTypeMenu ts) } /// - /// + /// /// /// /// @@ -3896,7 +3894,7 @@ public static implicit operator ContentDropTypeMenu(string ts) } /// - /// + /// /// /// /// @@ -3906,7 +3904,7 @@ public static implicit operator int(ContentDropTypeMenu ts) } /// - /// + /// /// /// /// @@ -3916,7 +3914,7 @@ public static implicit operator ContentDropTypeMenu(int simobjectid) } /// - /// + /// /// /// /// @@ -3926,7 +3924,7 @@ public static implicit operator uint(ContentDropTypeMenu ts) } /// - /// + /// /// /// public static implicit operator ContentDropTypeMenu(uint simobjectid) @@ -3988,7 +3986,7 @@ public override void onMouseUp() SimObject id = ((ColladaImportDlg) "ColladaImportDlg").showDialog(this["path"], altCommand); - //SimObject id = Util.eval(cmd); + //SimObject id = Util.eval(cmd); //%id.setPosition(%posX SPC %posY SPC %posZ); @@ -4009,7 +4007,7 @@ public override void onRightClick() #region ProxyObjects Operator Overrides /// - /// + /// /// /// /// @@ -4020,7 +4018,7 @@ public override void onRightClick() } /// - /// + /// /// /// public override int GetHashCode() @@ -4029,7 +4027,7 @@ public override int GetHashCode() } /// - /// + /// /// /// /// @@ -4039,7 +4037,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -4052,7 +4050,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -4062,7 +4060,7 @@ public static implicit operator string(CreatorShapeIconBtn ts) } /// - /// + /// /// /// /// @@ -4073,7 +4071,7 @@ public static implicit operator CreatorShapeIconBtn(string ts) } /// - /// + /// /// /// /// @@ -4083,7 +4081,7 @@ public static implicit operator int(CreatorShapeIconBtn ts) } /// - /// + /// /// /// /// @@ -4093,7 +4091,7 @@ public static implicit operator CreatorShapeIconBtn(int simobjectid) } /// - /// + /// /// /// /// @@ -4103,7 +4101,7 @@ public static implicit operator uint(CreatorShapeIconBtn ts) } /// - /// + /// /// /// public static implicit operator CreatorShapeIconBtn(uint simobjectid) @@ -4177,7 +4175,7 @@ public override void onMouseUp() #region ProxyObjects Operator Overrides /// - /// + /// /// /// /// @@ -4188,7 +4186,7 @@ public override void onMouseUp() } /// - /// + /// /// /// public override int GetHashCode() @@ -4197,7 +4195,7 @@ public override int GetHashCode() } /// - /// + /// /// /// /// @@ -4207,7 +4205,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -4220,7 +4218,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -4230,7 +4228,7 @@ public static implicit operator string(CreatorStaticIconBtn ts) } /// - /// + /// /// /// /// @@ -4241,7 +4239,7 @@ public static implicit operator CreatorStaticIconBtn(string ts) } /// - /// + /// /// /// /// @@ -4251,7 +4249,7 @@ public static implicit operator int(CreatorStaticIconBtn ts) } /// - /// + /// /// /// /// @@ -4261,7 +4259,7 @@ public static implicit operator CreatorStaticIconBtn(int simobjectid) } /// - /// + /// /// /// /// @@ -4271,7 +4269,7 @@ public static implicit operator uint(CreatorStaticIconBtn ts) } /// - /// + /// /// /// public static implicit operator CreatorStaticIconBtn(uint simobjectid) @@ -4333,7 +4331,7 @@ public override void onMouseUp() Inspector Inspector = "Inspector"; //Inspector.inspect(%object); - //eval( "" @ %object @".Material = " @ %this.toolTip @ ";" ); + //eval( "" @ %object @".Material = " @ %this.toolTip @ ";" ); Inspector.setObjectField("material", this["toolTip"]); Inspector.apply(); Inspector.refresh(); @@ -4345,7 +4343,7 @@ public override void onMouseUp() #region ProxyObjects Operator Overrides /// - /// + /// /// /// /// @@ -4356,7 +4354,7 @@ public override void onMouseUp() } /// - /// + /// /// /// public override int GetHashCode() @@ -4365,7 +4363,7 @@ public override int GetHashCode() } /// - /// + /// /// /// /// @@ -4375,7 +4373,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -4388,7 +4386,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -4398,7 +4396,7 @@ public static implicit operator string(MaterialButton ts) } /// - /// + /// /// /// /// @@ -4409,7 +4407,7 @@ public static implicit operator MaterialButton(string ts) } /// - /// + /// /// /// /// @@ -4419,7 +4417,7 @@ public static implicit operator int(MaterialButton ts) } /// - /// + /// /// /// /// @@ -4429,7 +4427,7 @@ public static implicit operator MaterialButton(int simobjectid) } /// - /// + /// /// /// /// @@ -4439,7 +4437,7 @@ public static implicit operator uint(MaterialButton ts) } /// - /// + /// /// /// public static implicit operator MaterialButton(uint simobjectid) @@ -4464,7 +4462,7 @@ public override void onRightClick() #region ProxyObjects Operator Overrides /// - /// + /// /// /// /// @@ -4475,7 +4473,7 @@ public override void onRightClick() } /// - /// + /// /// /// public override int GetHashCode() @@ -4484,7 +4482,7 @@ public override int GetHashCode() } /// - /// + /// /// /// /// @@ -4494,7 +4492,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -4507,7 +4505,7 @@ public override bool Equals(object obj) } /// - /// + /// /// /// /// @@ -4517,7 +4515,7 @@ public static implicit operator string(ParticleEmitterButton ts) } /// - /// + /// /// /// /// @@ -4528,7 +4526,7 @@ public static implicit operator ParticleEmitterButton(string ts) } /// - /// + /// /// /// /// @@ -4538,7 +4536,7 @@ public static implicit operator int(ParticleEmitterButton ts) } /// - /// + /// /// /// /// @@ -4548,7 +4546,7 @@ public static implicit operator ParticleEmitterButton(int simobjectid) } /// - /// + /// /// /// /// @@ -4558,7 +4556,7 @@ public static implicit operator uint(ParticleEmitterButton ts) } /// - /// + /// /// /// public static implicit operator ParticleEmitterButton(uint simobjectid) @@ -4570,4 +4568,4 @@ public static implicit operator ParticleEmitterButton(uint simobjectid) } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Cursor.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Cursor.cs index 6454548b..483ed2f5 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Cursor.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Cursor.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; @@ -40,11 +40,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui { public class cursor { - public static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - if (omni.sGlobal["$platform"] == "macos") + if (pInvokes.sGlobal["$platform"] == "macos") { ObjectCreator oc = new ObjectCreator("GuiCursor", "DefaultCursor"); @@ -63,4 +61,4 @@ public static void initialize() } } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/JoinServerDlg.giu.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/JoinServerDlg.giu.cs index ad39af60..cf404a6e 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/JoinServerDlg.giu.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/JoinServerDlg.giu.cs @@ -786,7 +786,7 @@ public void update() [ConsoleInteraction] public static void onServerQueryStatus(string status, string msg, string value) { - omni.Util._echo("ServerQuery: " + " " + status + " " + msg + " " + value); + Util._echo("ServerQuery: " + " " + status + " " + msg + " " + value); // Update query status // States: start, update, ping, query, done // value = % (0-1) done for ping and query states diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Message Boxes/messageBox.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Message Boxes/messageBox.cs index 652e7c6a..547376c3 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Message Boxes/messageBox.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/Message Boxes/messageBox.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -47,8 +47,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui { internal class messageBox { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { if ("MessagePopupDlg".isObject()) @@ -68,7 +66,7 @@ public static void initialize() #region exec("./messageBoxOk.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" %guiContent = new GuiControl(MessageBoxOKDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = """ + typeof (MessageBoxOKDlg).FullName + @"""; @@ -135,11 +133,11 @@ public static void initialize() #region exec("./messageBoxYesNo.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" %guiContent = new GuiControl(MessageBoxYesNoDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = """ + typeof (MessageBoxYesNoDlg).FullName + @"""; - + profile = ""GuiOverlayProfile""; horizSizing = ""width""; vertSizing = ""height""; @@ -218,10 +216,10 @@ public static void initialize() #region exec("./messageBoxYesNoCancel.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" %guiContent = new GuiControl(MessageBoxYesNoCancelDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = """ + typeof (MessageBoxYesNoCancelDlg).FullName + @"""; - + canSaveDynamicFields = ""0""; Profile = ""GuiOverlayProfile""; HorizSizing = ""width""; @@ -330,7 +328,7 @@ public static void initialize() #region exec("./messageBoxOKCancel.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" //--- OBJECT WRITE BEGIN --- %guiContent = new GuiControl(MessageBoxOKCancelDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = ""WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui.Message_Boxes.MessageBoxOKCancelDlg""; @@ -374,7 +372,7 @@ public static void initialize() lineSpacing = ""2""; allowColorChars = ""0""; maxChars = ""-1""; - + }; new GuiButtonCtrl() { profile = ""GuiButtonProfile""; @@ -414,7 +412,7 @@ public static void initialize() #region exec("./messageBoxOKCancelDetailsDlg.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" //--- OBJECT WRITE BEGIN --- %guiContent = new GuiControl(MessageBoxOKCancelDetailsDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = ""WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui.Message_Boxes.MessageBoxOKCancelDetailsDlg""; @@ -561,7 +559,7 @@ public static void initialize() #region exec("./messagePopup.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" //--- OBJECT WRITE BEGIN --- %guiContent = new GuiControl(MessagePopupDlg) { profile = ""GuiDefaultProfile""; @@ -615,7 +613,7 @@ public static void initialize() #region exec("./IODropdownDlg.ed.gui"); - omni.console.Eval(@" + pInvokes.console.Eval(@" //--- OBJECT WRITE BEGIN --- %guiContent = new GuiControl(IODropdownDlg) { WLE_OVERRIDE_PROXY_CLASSTYPE = ""WinterLeaf.userObjects.GameCode.Client.Gui.Message_Boxes.IODropdownDlg""; @@ -783,7 +781,7 @@ public static void initialize() #region new SFXDescription(MessageBoxAudioDescription) - omni.console.Eval(@" + pInvokes.console.Eval(@" new SFXDescription(MessageBoxAudioDescription) { volume = 1.0; @@ -814,12 +812,12 @@ public static void messageCallback(GuiControl dlg, string callback) { ((GuiCanvas) "Canvas").popDialog(dlg); if (callback.Trim() != "") - omni.Util.eval(callback); - //omni.console.Eval(callback); + pInvokes.Util.eval(callback); + //pInvokes.console.Eval(callback); } /// - /// The # in the function passed replaced with the output + /// The # in the function passed replaced with the output /// of the preset menu. /// /// @@ -831,7 +829,7 @@ public static void IOCallback(GuiControl dlg, string callback) int id = IODropdownMenu.getSelected(); string text = IODropdownMenu.getTextById(id); callback = callback.Replace("#", text); - omni.console.Eval(callback); + pInvokes.console.Eval(callback); ((GuiCanvas) "Canvas").popDialog(dlg); } @@ -861,7 +859,7 @@ public static void MBSetText(GuiMLTextCtrl text, GuiWindowCtrl frame, string msg frame.canMaximize = false; //TODO - //omni.Util._sfxPlayOnce("messageBoxBeep"); + //pInvokes.Util._sfxPlayOnce("messageBoxBeep"); } [ConsoleInteraction(true)] @@ -984,7 +982,7 @@ public static void MessagePopup(string title, string message, int delay = 0) ((GuiCanvas) "Canvas").pushDialog("MessagePopupDlg"); MBSetText("MessagePopText", "MessagePopFrame", message); if (delay != 0) - omni.Util._schedule(delay.AsString(), "0", "CloseMessagePopup"); + pInvokes.Util._schedule(delay.AsString(), "0", "CloseMessagePopup"); } [ConsoleInteraction(true)] @@ -1030,4 +1028,4 @@ public static void MessageBoxYesNoOld(string title, string message, string yesCa MessageBoxYesNo(title, message, yesCallback, noCallback); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/Misc.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/Misc.cs index 1e022e9d..473be217 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/Misc.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/Misc.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Demo.Full.Models.User.GameCode.Client.Audio; @@ -44,91 +44,89 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui.OptionsDlg { internal class Misc { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.iGlobal["$RemapCount"] = 0; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Forward"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "moveforward"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Backward"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "movebackward"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Strafe Left"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "moveleft"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Strafe Right"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "moveright"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Turn Left"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "turnLeft"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Turn Right"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "turnRight"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Look Up"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "panUp"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Look Down"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "panDown"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Jump"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "jump"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Fire Weapon"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "mouseFire"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Adjust Zoom"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "setZoomFov"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Toggle Zoom"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleZoom"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Free Look"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleFreeLook"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Switch 1st/3rd"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleFirstPerson"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Chat to Everyone"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleMessageHud"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Message Hud PageUp"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "pageMessageHudUp"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Message Hud PageDown"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "pageMessageHudDown"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Resize Message Hud"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "resizeMessageHud"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Show Scores"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "showPlayerList"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Animation - Wave"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "celebrationWave"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Animation - Salute"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "celebrationSalute"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Suicide"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "suicide"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Toggle Camera"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "toggleCamera"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Drop Camera at Player"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "dropCameraAtPlayer"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Drop Player at Camera"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "dropPlayerAtCamera"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; - omni.sGlobal["$RemapName[" + omni.iGlobal["$RemapCount"] + "]"] = "Bring up Options Dialog"; - omni.sGlobal["$RemapCmd[" + omni.iGlobal["$RemapCount"] + "]"] = "bringUpOptions"; - omni.iGlobal["$RemapCount"] = omni.iGlobal["$RemapCount"] + 1; + pInvokes.iGlobal["$RemapCount"] = 0; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Forward"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "moveforward"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Backward"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "movebackward"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Strafe Left"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "moveleft"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Strafe Right"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "moveright"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Turn Left"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "turnLeft"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Turn Right"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "turnRight"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Look Up"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "panUp"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Look Down"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "panDown"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Jump"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "jump"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Fire Weapon"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "mouseFire"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Adjust Zoom"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "setZoomFov"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Toggle Zoom"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleZoom"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Free Look"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleFreeLook"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Switch 1st/3rd"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleFirstPerson"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Chat to Everyone"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleMessageHud"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Message Hud PageUp"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "pageMessageHudUp"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Message Hud PageDown"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "pageMessageHudDown"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Resize Message Hud"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "resizeMessageHud"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Show Scores"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "showPlayerList"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Animation - Wave"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "celebrationWave"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Animation - Salute"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "celebrationSalute"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Suicide"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "suicide"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Toggle Camera"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "toggleCamera"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Drop Camera at Player"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "dropCameraAtPlayer"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Drop Player at Camera"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "dropPlayerAtCamera"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; + pInvokes.sGlobal["$RemapName[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "Bring up Options Dialog"; + pInvokes.sGlobal["$RemapCmd[" + pInvokes.iGlobal["$RemapCount"] + "]"] = "bringUpOptions"; + pInvokes.iGlobal["$RemapCount"] = pInvokes.iGlobal["$RemapCount"] + 1; - omni.iGlobal["$AudioTestHandle"] = 0; + pInvokes.iGlobal["$AudioTestHandle"] = 0; // Description to use for playing the volume test sound. This isn't // played with the description of the channel that has its volume changed // because we know nothing about the playback state of the channel. If it @@ -137,7 +135,7 @@ public static void initialize() ObjectCreator oc = new ObjectCreator("SFXDescription"); oc["sourceGroup"] = "AudioChannelMaster"; - omni.sGlobal["$AudioTestDescription"] = oc.Create().AsString(); + pInvokes.sGlobal["$AudioTestDescription"] = oc.Create().AsString(); } [ConsoleInteraction(true)] @@ -151,38 +149,38 @@ public static void restoreDefaultMappings() [ConsoleInteraction(true)] public static void OptAudioUpdateMasterVolume(float volume) { - if (volume == omni.fGlobal["$pref::SFX::masterVolume"]) + if (volume == pInvokes.fGlobal["$pref::SFX::masterVolume"]) return; audio.sfxSetMasterVolume(volume); - omni.fGlobal["$pref::SFX::masterVolume"] = volume; + pInvokes.fGlobal["$pref::SFX::masterVolume"] = volume; - if (omni.sGlobal["$AudioTestHandle"].isObject()) - omni.iGlobal["$AudioTestHandle"] = omni.Util.sfxPlayOnce("AudioChannel", "art/sound/ui/volumeTest.wav"); + if (pInvokes.sGlobal["$AudioTestHandle"].isObject()) + pInvokes.iGlobal["$AudioTestHandle"] = pInvokes.Util.sfxPlayOnce("AudioChannel", "art/sound/ui/volumeTest.wav"); } [ConsoleInteraction(true)] public static void OptAudioUpdateChannelVolume(SFXDescription description, float volume) { string channel = audio.sfxGroupToOldChannel(description["sourceGroup"]); - if (volume == omni.fGlobal["$pref::SFX::channelVolume[" + channel + "]"]) + if (volume == pInvokes.fGlobal["$pref::SFX::channelVolume[" + channel + "]"]) return; audio.sfxSetChannelVolume(channel, volume); - omni.fGlobal["$pref::SFX::channelVolume[" + channel + "]"] = volume; + pInvokes.fGlobal["$pref::SFX::channelVolume[" + channel + "]"] = volume; - if (omni.sGlobal["$AudioTestHandle"].isObject()) + if (pInvokes.sGlobal["$AudioTestHandle"].isObject()) { - ((SFXDescription) omni.sGlobal["$AudioTestDescription"])["volume"] = volume.AsString(); - omni.fGlobal["$AudioTestHandle"] = omni.Util.sfxPlayOnce(omni.sGlobal["$AudioTestDescription"], "art/sound/ui/volumeTest.wav"); + ((SFXDescription) pInvokes.sGlobal["$AudioTestDescription"])["volume"] = volume.AsString(); + pInvokes.fGlobal["$AudioTestHandle"] = pInvokes.Util.sfxPlayOnce(pInvokes.sGlobal["$AudioTestDescription"], "art/sound/ui/volumeTest.wav"); } } [ConsoleInteraction(true)] public static void OptMouseSetSensitivity(float value) { - omni.fGlobal["$pref::Input::LinkMouseSensitivity"] = value; + pInvokes.fGlobal["$pref::Input::LinkMouseSensitivity"] = value; } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptRemapInputCtrl.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptRemapInputCtrl.cs index c242d021..b316c4b5 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptRemapInputCtrl.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptRemapInputCtrl.cs @@ -126,9 +126,9 @@ public override void onInputEvent(string device, string action, bool state) [ConsoleInteraction(true)] public static int findRemapCmdIndex(string command) { - for (int i = 0; i < omni.iGlobal["$RemapCount"]; i++) + for (int i = 0; i < iGlobal["$RemapCount"]; i++) { - if (command == omni.sGlobal["$RemapCmd[" + i + "]"]) + if (command == sGlobal["$RemapCmd[" + i + "]"]) return i; } return -1; @@ -143,11 +143,11 @@ public static void unbindExtraActions(string command, int count) if (temp == "") return; - count = omni.Util.getFieldCount(temp) - (count*2); + count = Util.getFieldCount(temp) - (count*2); for (int i = 0; i < count; i += 2) { - string device = omni.Util.getField(temp, i + 0); - string action = omni.Util.getField(temp, i + 1); + string device = Util.getField(temp, i + 0); + string action = Util.getField(temp, i + 1); ((ActionMap) "moveMap").unbind(device, action); } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptionsDlg.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptionsDlg.cs index f347a714..47d7c7ab 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptionsDlg.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/OptionsDlg/OptionsDlg.cs @@ -3230,12 +3230,12 @@ public override bool OnFunctionNotFoundCallTorqueScript() [ConsoleInteraction(true)] public static string _makePrettyResString(string resString) { - string width = omni.Util.getWord(resString, omni.iGlobal["$WORD::RES_X"]); - string height = omni.Util.getWord(resString, omni.iGlobal["$WORD::RES_Y"]); + string width = Util.getWord(resString, iGlobal["$WORD::RES_X"]); + string height = Util.getWord(resString, iGlobal["$WORD::RES_Y"]); float aspect = width.AsFloat()/height.AsFloat(); - aspect = (float) Math.Round(aspect, 2); // omni.Util.mRound(aspect * 100.0f) * .01f; + aspect = (float) Math.Round(aspect, 2); // Util.mRound(aspect * 100.0f) * .01f; string newaspect = ""; if (aspect == 1.33f) newaspect = "4:3"; @@ -3519,7 +3519,7 @@ public bool applyGraphics(bool testNeedApply) if (!testNeedApply) _updateApplyState(); - omni.Util.export("$pref::*", "prefs.client.cs", false); + Util.export("$pref::*", "prefs.client.cs", false); return false; } @@ -3565,8 +3565,8 @@ public void doRemap() [ConsoleInteraction(true)] public static string buildFullMapString(int index) { - string name = omni.sGlobal["$RemapName[" + index + "]"]; - string cmd = omni.sGlobal["$RemapCmd[" + index + "]"]; + string name = sGlobal["$RemapName[" + index + "]"]; + string cmd = sGlobal["$RemapCmd[" + index + "]"]; string temp = ((ActionMap) "moveMap").getBinding(cmd); if (temp == "") @@ -3574,13 +3574,13 @@ public static string buildFullMapString(int index) string mapString = ""; - int count = omni.Util.getFieldCount(temp); + int count = Util.getFieldCount(temp); for (int i = 0; i < count; i += 2) { if (mapString != "") mapString = mapString + ", "; - string device = omni.Util.getField(temp, i + 0); - string obj = omni.Util.getField(temp, i + 1); + string device = Util.getField(temp, i + 0); + string obj = Util.getField(temp, i + 1); mapString = mapString + getMapDisplayName(device, obj); } return name + "\t" + mapString; @@ -3595,38 +3595,38 @@ public static string getMapDisplayName(string device, string action) if (device == "keyboard") return action; - else if (omni.Util.strstr(device, "mouse") != -1) + else if (Util.strstr(device, "mouse") != -1) { // Substitute "mouse" for "button" in the action string: - int pos = omni.Util.strstr(action, "button"); + int pos = Util.strstr(action, "button"); if (pos != -1) { - mods = omni.Util.getSubStr(action, 0, pos); - Object = omni.Util.getSubStr(action, pos, 1000); - instance = omni.Util.getSubStr(Object, omni.Util.strlen("button"), 1000); + mods = Util.getSubStr(action, 0, pos); + Object = Util.getSubStr(action, pos, 1000); + instance = Util.getSubStr(Object, Util.strlen("button"), 1000); return mods + "mouse" + (instance.AsInt() + 1); } else - omni.console.error("Mouse input object other than button passed to getDisplayMapName!"); + console.error("Mouse input object other than button passed to getDisplayMapName!"); } - else if (omni.Util.strstr(device, "joystick") != -1) + else if (Util.strstr(device, "joystick") != -1) { - int pos = omni.Util.strstr(action, "button"); + int pos = Util.strstr(action, "button"); if (pos != -1) { - mods = omni.Util.getSubStr(action, 0, pos); - Object = omni.Util.getSubStr(action, pos, 1000); - instance = omni.Util.getSubStr(Object, omni.Util.strlen("button"), 1000); + mods = Util.getSubStr(action, 0, pos); + Object = Util.getSubStr(action, pos, 1000); + instance = Util.getSubStr(Object, Util.strlen("button"), 1000); return mods + "joystick" + (instance.AsInt() + 1); } else { - pos = omni.Util.strstr(action, "pov"); + pos = Util.strstr(action, "pov"); if (pos != -1) { - int wordCount = omni.Util.getWordCount(action); - mods = (wordCount > 1) ? omni.Util.getWords(action, 0, wordCount - 2) + " " : ""; - Object = omni.Util.getWord(action, wordCount - 1); + int wordCount = Util.getWordCount(action); + mods = (wordCount > 1) ? Util.getWords(action, 0, wordCount - 2) + " " : ""; + Object = Util.getWord(action, wordCount - 1); switch (Object) { case "upov": @@ -3661,7 +3661,7 @@ public static string getMapDisplayName(string device, string action) } else - omni.console.error("Unsupported Joystick input object passed to getDisplayMapName!"); + console.error("Unsupported Joystick input object passed to getDisplayMapName!"); } } return "??"; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/PlayerListGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/PlayerListGui.cs index e6a46949..74a66b9d 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/PlayerListGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/PlayerListGui.cs @@ -278,7 +278,7 @@ public static void initialize() public static void HandleClientJoin(string msgType, string msgString, string ClientName, GameConnection clientID, string guid, int score, int kills, int deaths, bool isAI, bool isAdmin, bool isSuperAdmin) { - ((PlayerListGui) "PlayerListGui").update(clientID, omni.Util.detag(ClientName), isSuperAdmin, isAdmin, isAI, score, kills, deaths); + ((PlayerListGui) "PlayerListGui").update(clientID, Util.detag(ClientName), isSuperAdmin, isAdmin, isAI, score, kills, deaths); } public static void HandleClientDrop(string msgType, string msgString, string clientName, GameConnection clientId) @@ -290,7 +290,7 @@ public static void HandleClientScoreChanged(string msgType, string msgString, in { ((PlayerListGui) "PlayerListGui").updateScore(clientId, score, kills, deaths); - omni.console.print(string.Format(" score:{0} kills:{1} deaths: {2}", score, kills, deaths)); + console.print(string.Format(" score:{0} kills:{1} deaths: {2}", score, kills, deaths)); } [ConsoleInteraction(true)] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/loadingGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/loadingGui.cs index 4c705c2c..bdf1fe8f 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/loadingGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/loadingGui.cs @@ -133,7 +133,7 @@ public static void initialize() oc_Newobject1["Visible"] = "1"; oc_Newobject1["tooltipprofile"] = "GuiToolTipProfile"; oc_Newobject1["hovertime"] = "1000"; - oc_Newobject1["bitmap"] = "art/gui/omni.png"; + oc_Newobject1["bitmap"] = "art/gui/pInvokes.png"; oc_Newobject1["wrap"] = "0"; #endregion diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/startupGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/startupGui.cs index bd81f115..6874934b 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/startupGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Gui/startupGui.cs @@ -168,7 +168,7 @@ public override bool OnFunctionNotFoundCallTorqueScript() public static void loadStartup() { // The index of the current splash screen - omni.iGlobal["$StartupIdx"] = 0; + iGlobal["$StartupIdx"] = 0; // A list of the splash screens and logos // to cycle through. Note that they have to // be in consecutive numerical order @@ -176,7 +176,7 @@ public static void loadStartup() if (!"StartupGui".isObject()) return; StartupGui.bitmap0 = "art/gui/background_g"; - StartupGui.logo0 = "art/gui/omni.png"; + StartupGui.logo0 = "art/gui/png"; StartupGui.logoPos0 = new Point2I(178, 251); StartupGui.logoExtent0 = new Point2I(443, 139); // Call the next() function to set our firt diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/GuiCanvas.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/GuiCanvas.cs index fd8b8d81..706beb62 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/GuiCanvas.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/GuiCanvas.cs @@ -70,23 +70,23 @@ public partial class GuiCanvas public static void initialize() { - omni.bGlobal["$cursorControlled"] = true; + bGlobal["$cursorControlled"] = true; ((GuiCanvas) "Canvas").checkCursor(); } [ConsoleInteraction(true)] public new static void showCursor() { - if (omni.bGlobal["$cursorControlled"]) - omni.Util.lockMouse(false); + if (bGlobal["$cursorControlled"]) + Util.lockMouse(false); ((GuiCanvas) "Canvas").cursorOn(); } [ConsoleInteraction(true)] public new static void hideCursor() { - if (omni.bGlobal["$cursorControlled"]) - omni.Util.lockMouse(true); + if (bGlobal["$cursorControlled"]) + Util.lockMouse(true); ((GuiCanvas) "Canvas").cursorOff(); } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Gui/postFXManager.gui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Gui/postFXManager.gui.cs index e1653a94..bebdd649 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Gui/postFXManager.gui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Gui/postFXManager.gui.cs @@ -7633,23 +7633,23 @@ public override bool OnFunctionNotFoundCallTorqueScript() public static void createGui() { - omni.sGlobal["$PostFXManager::defaultPreset"] = "core/scripts/client/postFx/default.postfxpreset.cs"; + sGlobal["$PostFXManager::defaultPreset"] = "core/scripts/client/postFx/default.postfxpreset.cs"; // Used to name the saved files. - omni.sGlobal["$PostFXManager::fileExtension"] = ".postfxpreset.cs"; + sGlobal["$PostFXManager::fileExtension"] = ".postfxpreset.cs"; // The filter string for file open/save dialogs. - omni.sGlobal["$PostFXManager::fileFilter"] = "Post Effect Presets|*.postfxpreset.cs"; + sGlobal["$PostFXManager::fileFilter"] = "Post Effect Presets|*.postfxpreset.cs"; // Enable / disable PostFX when loading presets or just apply the settings? - omni.bGlobal["$PostFXManager::forceEnableFromPresets"] = true; + bGlobal["$PostFXManager::forceEnableFromPresets"] = true; - omni.bGlobal["$PostFXManager::vebose"] = true; + bGlobal["$PostFXManager::vebose"] = true; if (!guicreated) { //until I rip out gui's I need to execute the script. - //omni.Util.exec("core/scripts/client/postFx/postFXManager.gui", false, false); + //Util.exec("core/scripts/client/postFx/postFXManager.gui", false, false); initialize(); guicreated = true; } @@ -8273,10 +8273,10 @@ public void savePresetHandler(string filename) public static void ppOptionsUpdateDOFSettings() { DOFPostEffect mDOFPostEffect = "DOFPostEffect"; - mDOFPostEffect.setFocusParams(omni.fGlobal["$DOFPostFx::BlurMin"], omni.fGlobal["$DOFPostFx::BlurMax"], omni.fGlobal["$DOFPostFx::FocusRangeMin"], omni.fGlobal["$DOFPostFx::FocusRangeMax"], -omni.fGlobal["$DOFPostFx::BlurCurveNear"], omni.fGlobal["$DOFPostFx::BlurCurveFar"]); - mDOFPostEffect.setAutoFocus(omni.bGlobal["$DOFPostFx::EnableAutoFocus"]); + mDOFPostEffect.setFocusParams(fGlobal["$DOFPostFx::BlurMin"], fGlobal["$DOFPostFx::BlurMax"], fGlobal["$DOFPostFx::FocusRangeMin"], fGlobal["$DOFPostFx::FocusRangeMax"], -fGlobal["$DOFPostFx::BlurCurveNear"], fGlobal["$DOFPostFx::BlurCurveFar"]); + mDOFPostEffect.setAutoFocus(bGlobal["$DOFPostFx::EnableAutoFocus"]); mDOFPostEffect.setFocalDist("0"); - if (omni.bGlobal["$PostFXManager::PostFX::EnableDOF"]) + if (bGlobal["$PostFXManager::PostFX::EnableDOF"]) mDOFPostEffect.enable(); else mDOFPostEffect.disable(); @@ -8292,14 +8292,14 @@ public static void ppColorCorrection_selectFile() [ConsoleInteraction(true)] public static void ppColorCorrection_selectFileHandler(string filename) { - if ((filename == "") || !omni.Util.isFile(filename)) + if ((filename == "") || !Util.isFile(filename)) filename = "core/scripts/client/postFx/null_color_ramp.png"; else - filename = omni.Util.makeRelativePath(filename, omni.Util.getMainDotCsDir()); + filename = Util.makeRelativePath(filename, Util.getMainDotCsDir()); Extendable.PostEffect.mColorCorrectionFileName = filename; - //omni.sGlobal["$HDRPostFX::colorCorrectionRamp"] = filename; + //sGlobal["$HDRPostFX::colorCorrectionRamp"] = filename; ((GuiTextEditCtrl) ((postFXManager) "PostFXManager").findObjectByInternalName("ColorCorrectionFileName", true)).text = filename; } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/CausticsPostEffect.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/CausticsPostEffect.cs index 39ca05e6..2a9c88d3 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/CausticsPostEffect.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/CausticsPostEffect.cs @@ -98,8 +98,8 @@ public static void initialize() ts["target"] = "$backBuffer"; ts.Create(); - omni.iGlobal["$CausticsPFX::refTime"] = omni.Util.getSimTime(); - omni.sGlobal["$CausticsPFX::color"] = "1.0 1.0 1.0 1.0"; + iGlobal["$CausticsPFX::refTime"] = Util.getSimTime(); + sGlobal["$CausticsPFX::color"] = "1.0 1.0 1.0 1.0"; } //private static CausticsPostEffect cpf; @@ -109,8 +109,8 @@ public override void setShaderConsts() //cpf.texture[1] = new TypeImageFilename( "core/scripts/client/postFx/textures/caustics_1.png"); //cpf.texture[2] = new TypeImageFilename( "core/scripts/client/postFx/textures/caustics_2.png"); - this.setShaderConst("$refTime", omni.sGlobal["$CausticsPFX::refTime"]); - setShaderConst("$colorize", omni.sGlobal["$CausticsPFX::color"]); + this.setShaderConst("$refTime", sGlobal["$CausticsPFX::refTime"]); + setShaderConst("$colorize", sGlobal["$CausticsPFX::color"]); } } } \ No newline at end of file diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/ChromaticLensPostFX.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/ChromaticLensPostFX.cs index 86d9907e..46e38f94 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/ChromaticLensPostFX.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/ChromaticLensPostFX.cs @@ -50,17 +50,17 @@ public class ChromaticLensPostFX : PostEffect public static void initialize() { - omni.bGlobal["$CAPostFx::enabled"] = false; + bGlobal["$CAPostFx::enabled"] = false; // The lens distortion coefficient. - omni.dGlobal["$CAPostFx::distCoeffecient"] = -0.05; + dGlobal["$CAPostFx::distCoeffecient"] = -0.05; // The cubic distortion value. - omni.dGlobal["$CAPostFx::cubeDistortionFactor"] = -0.1; + dGlobal["$CAPostFx::cubeDistortionFactor"] = -0.1; // The amount and direction of the maxium shift for // the red, green, and blue channels. - omni.sGlobal["$CAPostFx::colorDistortionFactor"] = "0.005 -0.005 0.01"; + sGlobal["$CAPostFx::colorDistortionFactor"] = "0.005 -0.005 0.01"; SingletonCreator ts = new SingletonCreator("GFXStateBlockData", "PFX_DefaultChromaticLensStateBlock"); ts["zDefined"] = true; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/HDRPostEffect.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/HDRPostEffect.cs index ea8f23ed..f4a82c81 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/HDRPostEffect.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/HDRPostEffect.cs @@ -169,54 +169,54 @@ public override void onDisabled() public static void initialize() { // Blends between the scene and the tone mapped scene. - omni.dGlobal["$HDRPostFX::enableToneMapping"] = 1.0; + dGlobal["$HDRPostFX::enableToneMapping"] = 1.0; // The tone mapping middle grey or exposure value used // to adjust the overall "balance" of the image. // // 0.18 is fairly common value. // - omni.dGlobal["$HDRPostFX::keyValue"] = 0.18; + dGlobal["$HDRPostFX::keyValue"] = 0.18; // The minimum luninace value to allow when tone mapping // the scene. Is particularly useful if your scene very // dark or has a black ambient color in places. - omni.dGlobal["$HDRPostFX::minLuminace"] = 0.001; + dGlobal["$HDRPostFX::minLuminace"] = 0.001; // The lowest luminance value which is mapped to white. This // is usually set to the highest visible luminance in your // scene. By setting this to smaller values you get a contrast // enhancement. - omni.dGlobal["$HDRPostFX::whiteCutoff"] = 1.0; + dGlobal["$HDRPostFX::whiteCutoff"] = 1.0; // The rate of adaptation from the previous and new // average scene luminance. - omni.dGlobal["$HDRPostFX::adaptRate"] = 2.0; + dGlobal["$HDRPostFX::adaptRate"] = 2.0; // Blends between the scene and the blue shifted version // of the scene for a cinematic desaturated night effect. - omni.dGlobal["$HDRPostFX::enableBlueShift"] = 0.0; + dGlobal["$HDRPostFX::enableBlueShift"] = 0.0; // The blue shift color value. - omni.sGlobal["$HDRPostFX::blueShiftColor"] = "1.05 0.97 1.27"; + sGlobal["$HDRPostFX::blueShiftColor"] = "1.05 0.97 1.27"; // Blends between the scene and the bloomed scene. - omni.dGlobal["$HDRPostFX::enableBloom"] = 1.0; + dGlobal["$HDRPostFX::enableBloom"] = 1.0; // The threshold luminace value for pixels which are // considered "bright" and need to be bloomed. - omni.dGlobal["$HDRPostFX::brightPassThreshold"] = 1.0; + dGlobal["$HDRPostFX::brightPassThreshold"] = 1.0; // These are used in the gaussian blur of the // bright pass for the bloom effect. - omni.dGlobal["$HDRPostFX::gaussMultiplier"] = 0.3; - omni.dGlobal["$HDRPostFX::gaussMean"] = 0.0; - omni.dGlobal["$HDRPostFX::gaussStdDev"] = 0.8; + dGlobal["$HDRPostFX::gaussMultiplier"] = 0.3; + dGlobal["$HDRPostFX::gaussMean"] = 0.0; + dGlobal["$HDRPostFX::gaussStdDev"] = 0.8; // The 1x255 color correction ramp texture used // by both the HDR shader and the GammaPostFx shader // for doing full screen color correction. - //omni.sGlobal["$HDRPostFX::colorCorrectionRamp"] = "core/scripts/client/postFx/null_color_ramp.png"; + //sGlobal["$HDRPostFX::colorCorrectionRamp"] = "core/scripts/client/postFx/null_color_ramp.png"; mColorCorrectionFileName = "core/scripts/client/postFx/null_color_ramp.png"; SingletonCreator sts = new SingletonCreator("ShaderData", "HDR_BrightPassShader"); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/LightRayPostEffect.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/LightRayPostEffect.cs index ed8b74c5..5307cad1 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/LightRayPostEffect.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/LightRayPostEffect.cs @@ -72,13 +72,13 @@ public override void setShaderConsts() public static void initialize() { - omni.dGlobal["$LightRayPostFX::brightScalar"] = 0.75; - omni.dGlobal["$LightRayPostFX::numSamples"] = 40; - omni.dGlobal["$LightRayPostFX::density"] = 0.94; - omni.dGlobal["$LightRayPostFX::weight"] = 5.65; - omni.dGlobal["$LightRayPostFX::decay"] = 1.0; - omni.dGlobal["$LightRayPostFX::exposure"] = 0.0005; - omni.dGlobal["$LightRayPostFX::resolutionScale"] = 1.0; + dGlobal["$LightRayPostFX::brightScalar"] = 0.75; + dGlobal["$LightRayPostFX::numSamples"] = 40; + dGlobal["$LightRayPostFX::density"] = 0.94; + dGlobal["$LightRayPostFX::weight"] = 5.65; + dGlobal["$LightRayPostFX::decay"] = 1.0; + dGlobal["$LightRayPostFX::exposure"] = 0.0005; + dGlobal["$LightRayPostFX::resolutionScale"] = 1.0; SingletonCreator ts = new SingletonCreator("ShaderData", "LightRayOccludeShader"); ts["DXVertexShaderFile"] = "shaders/common/postFx/postFxV.hlsl"; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/OVRBarrelDistortionMonoPostEffect.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/OVRBarrelDistortionMonoPostEffect.cs index 9a453554..9884054b 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/OVRBarrelDistortionMonoPostEffect.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/OVRBarrelDistortionMonoPostEffect.cs @@ -51,7 +51,7 @@ public override bool OnFunctionNotFoundCallTorqueScript() public static void initialize() { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!Util.isFunction("isOculusVRDeviceActive")) return; SingletonCreator ts = new SingletonCreator("ShaderData", "OVRMonoToStereoShader"); @@ -138,7 +138,7 @@ public static void initialize() public override void setShaderConsts() { - string xOffsets = omni.console.Call("getOVRHMDEyeXOffsets", new string[] {"0"}); + string xOffsets = console.Call("getOVRHMDEyeXOffsets", new string[] {"0"}); setShaderConst("$LensXOffsets", xOffsets); } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/SSAOPostEffect.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/SSAOPostEffect.cs index 108538ce..7ba5eda0 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/SSAOPostEffect.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/PostEffects/Shaders/SSAOPostEffect.cs @@ -122,39 +122,39 @@ public override void onDisabled() public static void initialize() { - omni.dGlobal["$SSAOPostFx::overallStrength"] = 2.0; + dGlobal["$SSAOPostFx::overallStrength"] = 2.0; // TODO: Add small/large param docs. // The small radius SSAO settings. - omni.dGlobal["$SSAOPostFx::sRadius"] = 0.1; - omni.dGlobal["$SSAOPostFx::sStrength"] = 6.0; - omni.dGlobal["$SSAOPostFx::sDepthMin"] = 0.1; - omni.dGlobal["$SSAOPostFx::sDepthMax"] = 1.0; - omni.dGlobal["$SSAOPostFx::sDepthPow"] = 1.0; - omni.dGlobal["$SSAOPostFx::sNormalTol"] = 0.0; - omni.dGlobal["$SSAOPostFx::sNormalPow"] = 1.0; + dGlobal["$SSAOPostFx::sRadius"] = 0.1; + dGlobal["$SSAOPostFx::sStrength"] = 6.0; + dGlobal["$SSAOPostFx::sDepthMin"] = 0.1; + dGlobal["$SSAOPostFx::sDepthMax"] = 1.0; + dGlobal["$SSAOPostFx::sDepthPow"] = 1.0; + dGlobal["$SSAOPostFx::sNormalTol"] = 0.0; + dGlobal["$SSAOPostFx::sNormalPow"] = 1.0; // The large radius SSAO settings. - omni.dGlobal["$SSAOPostFx::lRadius"] = 1.0; - omni.dGlobal["$SSAOPostFx::lStrength"] = 10.0; - omni.dGlobal["$SSAOPostFx::lDepthMin"] = 0.2; - omni.dGlobal["$SSAOPostFx::lDepthMax"] = 2.0; - omni.dGlobal["$SSAOPostFx::lDepthPow"] = 0.2; - omni.dGlobal["$SSAOPostFx::lNormalTol"] = -0.5; - omni.dGlobal["$SSAOPostFx::lNormalPow"] = 2.0; + dGlobal["$SSAOPostFx::lRadius"] = 1.0; + dGlobal["$SSAOPostFx::lStrength"] = 10.0; + dGlobal["$SSAOPostFx::lDepthMin"] = 0.2; + dGlobal["$SSAOPostFx::lDepthMax"] = 2.0; + dGlobal["$SSAOPostFx::lDepthPow"] = 0.2; + dGlobal["$SSAOPostFx::lNormalTol"] = -0.5; + dGlobal["$SSAOPostFx::lNormalPow"] = 2.0; // Valid values: 0, 1, 2 - omni.iGlobal["$SSAOPostFx::quality"] = 0; + iGlobal["$SSAOPostFx::quality"] = 0; // - omni.dGlobal["$SSAOPostFx::blurDepthTol"] = 0.001; + dGlobal["$SSAOPostFx::blurDepthTol"] = 0.001; // - omni.dGlobal["$SSAOPostFx::blurNormalTol"] = 0.95; + dGlobal["$SSAOPostFx::blurNormalTol"] = 0.95; // - omni.sGlobal["$SSAOPostFx::targetScale"] = "0.5 0.5"; + sGlobal["$SSAOPostFx::targetScale"] = "0.5 0.5"; SingletonCreator ts = new SingletonCreator("GFXStateBlockData", "SSAOStateBlock : PFX_DefaultStateBlock"); ts["samplersDefined"] = true; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Recordings/recordings.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Recordings/recordings.cs index 3b82a513..a4fff0fc 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Recordings/recordings.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/Recordings/recordings.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Demo.Full.Models.User.GameCode.Client.Gui; @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Recordings { public class recordings { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void StartSelectedDemo() { @@ -54,7 +52,7 @@ public static void StartSelectedDemo() int sel = RecordingsDlgList.getSelectedId(); string rowText = RecordingsDlgList.getRowTextById(sel); - string file = omni.sGlobal["$currentMod"] + "/recordings/" + omni.Util.getField(rowText, 0) + ".rec"; + string file = pInvokes.sGlobal["$currentMod"] + "/recordings/" + pInvokes.Util.getField(rowText, 0) + ".rec"; GameConnection ServerConnection = new ObjectCreator("GameConnection", "ServerConnection").Create(); ((SimGroup) "RootGroup").add(ServerConnection); @@ -95,14 +93,14 @@ public static void startDemoRecord() if (i < 100) num = "0" + num; - file = omni.sGlobal["$currentMod"] + "/recordings/demo" + num + ".rec"; - if (!omni.Util.isFile(file)) + file = pInvokes.sGlobal["$currentMod"] + "/recordings/demo" + num + ".rec"; + if (!pInvokes.Util.isFile(file)) break; } if (i == 1000) return; - omni.sGlobal["$DemoFileName"] = file; + pInvokes.sGlobal["$DemoFileName"] = file; ((chatHud) "ChatHud").AddLine(@"\c4Recording to file [\c2" + file + @"\cr]."); ServerConnection.call("prepDemoRecord"); ServerConnection.startRecording(file); @@ -110,9 +108,9 @@ public static void startDemoRecord() // make sure start worked if (ServerConnection.isDemoRecording()) { - omni.Util._call("deleteFile", file); + pInvokes.Util._call("deleteFile", file); ((chatHud) "ChatHud").AddLine(@"\c3 *** Failed to record to file [\c2" + file + @"\cr]."); - omni.sGlobal["$DemoFileName"] = ""; + pInvokes.sGlobal["$DemoFileName"] = ""; } } @@ -121,17 +119,17 @@ public static void stopDemoRecord() GameConnection ServerConnection = "ServerConnection"; if (ServerConnection.isDemoRecording()) { - ((chatHud) "ChatHud").AddLine(@"\c4Recording file [\c2" + omni.sGlobal["$DemoFileName"] + @"\cr] finished."); + ((chatHud) "ChatHud").AddLine(@"\c4Recording file [\c2" + pInvokes.sGlobal["$DemoFileName"] + @"\cr] finished."); ServerConnection.stopRecording(); } } public static void demoPlaybackComplete() { - omni.Util._call("disconnect"); + pInvokes.Util._call("disconnect"); // Clean up important client-side stuff, such as the group - // for particle emitters and the decal manager. This doesn't get - // launched during a demo as we short circuit the whole mission + // for particle emitters and the decal manager. This doesn't get + // launched during a demo as we short circuit the whole mission // handling functionality. mission.clientEndMission(); @@ -142,4 +140,4 @@ public static void demoPlaybackComplete() ((GuiCanvas) "canvas").pushDialog("RecordingsDlg"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/art/gui/defaultGameProfiles.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/art/gui/defaultGameProfiles.cs index a1583840..b72c41d0 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/art/gui/defaultGameProfiles.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/art/gui/defaultGameProfiles.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; @@ -40,8 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.art.gui { public class defaultGameProfiles { - private static readonly pInvokes omni = new pInvokes(); - public static void Initialize() { SingletonCreator ts = new SingletonCreator("GuiControlProfile", "ChatHudEditProfile"); @@ -153,4 +151,4 @@ public static void Initialize() ts.Create(); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/canvas.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/canvas.cs index 61257ee5..02bb0f5a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/canvas.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/canvas.cs @@ -58,31 +58,31 @@ public override void onWindowClose() public new static void initialize() { - omni.bGlobal["$canvasCreated"] = false; + bGlobal["$canvasCreated"] = false; } public static void initializeCanvas() { - if (omni.bGlobal["$canvasCreated"]) + if (bGlobal["$canvasCreated"]) { - omni.console.error("Cannot instantiate more than one canvas!"); + console.error("Cannot instantiate more than one canvas!"); return; } - if (!createCanvas(omni.sGlobal["$appName"])) + if (!createCanvas(sGlobal["$appName"])) { - omni.console.error("Canvas creation failed. Shutting down."); + console.error("Canvas creation failed. Shutting down."); Main.Quit(); - //t3d.Util.quit(); + //Util.quit(); } - omni.bGlobal["$canvasCreated"] = true; + bGlobal["$canvasCreated"] = true; } public static bool createCanvas(string windowTitle) { - if (omni.bGlobal["$isDedicated"]) + if (bGlobal["$isDedicated"]) { - omni.console.Call_Classname("GFXInit", "createNullDevice"); + console.Call_Classname("GFXInit", "createNullDevice"); return true; } // Create the Canvas @@ -90,28 +90,28 @@ public static bool createCanvas(string windowTitle) GuiCanvas canvas = new ObjectCreator("GuiCanvas", "Canvas", typeof (canvas)).Create(); if (canvas.isObject()) - canvas.setWindowTitle(omni.Util.getEngineName() + " - " + omni.sGlobal["$appName"]); + canvas.setWindowTitle(Util.getEngineName() + " - " + sGlobal["$appName"]); return true; } [ConsoleInteraction(true)] public static void configureCanvas() { - if (omni.sGlobal["$pref::Video::Canvas::mode"] == "") - omni.sGlobal["$pref::Video::Canvas::mode"] = "1024 768 false 32 60 4"; + if (sGlobal["$pref::Video::Canvas::mode"] == "") + sGlobal["$pref::Video::Canvas::mode"] = "1024 768 false 32 60 4"; - string resolution = omni.sGlobal["$pref::Video::Canvas::mode"]; - float resX = resolution.Split(' ')[omni.iGlobal["$WORD::RES_X"]].AsFloat(); - float resY = resolution.Split(' ')[omni.iGlobal["$WORD::RES_Y"]].AsFloat(); - string fs = resolution.Split(' ')[omni.iGlobal["$WORD::FULLSCREEN"]]; - string bpp = resolution.Split(' ')[omni.iGlobal["$WORD::BITDEPTH"]]; - string rate = resolution.Split(' ')[omni.iGlobal["$WORD::REFRESH"]]; - string fsaa = resolution.Split(' ')[omni.iGlobal["$WORD::AA"]]; + string resolution = sGlobal["$pref::Video::Canvas::mode"]; + float resX = resolution.Split(' ')[iGlobal["$WORD::RES_X"]].AsFloat(); + float resY = resolution.Split(' ')[iGlobal["$WORD::RES_Y"]].AsFloat(); + string fs = resolution.Split(' ')[iGlobal["$WORD::FULLSCREEN"]]; + string bpp = resolution.Split(' ')[iGlobal["$WORD::BITDEPTH"]]; + string rate = resolution.Split(' ')[iGlobal["$WORD::REFRESH"]]; + string fsaa = resolution.Split(' ')[iGlobal["$WORD::AA"]]; - omni.console.print("--------------"); - omni.console.print("Attempting to set resolution to \"" + resolution + "\""); + console.print("--------------"); + console.print("Attempting to set resolution to \"" + resolution + "\""); - Point3F deskRes = omni.Util.getDesktopResolution(); + Point3F deskRes = Util.getDesktopResolution(); float deskResX = deskRes.x; float deskResY = deskRes.y; float deskResBPP = deskRes.z; @@ -126,15 +126,15 @@ public static void configureCanvas() // Windowed mode has to use the same bit depth as the desktop if (resX >= deskResX || resY >= deskResY) { - omni.Util._warn("Warning: The requested windowed resolution is equal to or larger than the current desktop resolution. Attempting to find a better resolution"); + Util._warn("Warning: The requested windowed resolution is equal to or larger than the current desktop resolution. Attempting to find a better resolution"); int resCount = ((GuiCanvas) "Canvas").getModeCount(); for (int i = (resCount - 1); i >= 0; i--) { string testRes = ((GuiCanvas) "Canvas").getMode(i); - float testResX = testRes.Split(' ')[omni.iGlobal["$WORD::RES_X"]].AsFloat(); - float testResY = testRes.Split(' ')[omni.iGlobal["$WORD::RES_Y"]].AsFloat(); - string testBPP = testRes.Split(' ')[omni.iGlobal["$WORD::BITDEPTH"]]; + float testResX = testRes.Split(' ')[iGlobal["$WORD::RES_X"]].AsFloat(); + float testResY = testRes.Split(' ')[iGlobal["$WORD::RES_Y"]].AsFloat(); + string testBPP = testRes.Split(' ')[iGlobal["$WORD::BITDEPTH"]]; if (testBPP.AsInt() != bpp.AsInt()) continue; @@ -145,25 +145,25 @@ public static void configureCanvas() resX = testResX; resY = testResY; - omni.Util._warn("Warning: Switching to \"" + resX + " " + resY + " " + bpp + "\""); + Util._warn("Warning: Switching to \"" + resX + " " + resY + " " + bpp + "\""); break; } } } - omni.sGlobal["$pref::Video::Canvas::mode"] = resX + " " + resY + " " + fs + " " + bpp + " " + rate + " " + fsaa; + sGlobal["$pref::Video::Canvas::mode"] = resX + " " + resY + " " + fs + " " + bpp + " " + rate + " " + fsaa; string fsLabel = "No"; if (fs.AsBool()) fsLabel = "Yes"; - omni.console.print("Accepted Mode: "); - omni.console.print("--Resolution : " + resX + " " + resY); - omni.console.print("--Full Screen : " + fsLabel); - omni.console.print("--Bits Per Pixel : " + bpp); - omni.console.print("--Refresh Rate : " + rate); - omni.console.print("--FSAA Level : " + fsaa); - omni.console.print("--------------"); + console.print("Accepted Mode: "); + console.print("--Resolution : " + resX + " " + resY); + console.print("--Full Screen : " + fsLabel); + console.print("--Bits Per Pixel : " + bpp); + console.print("--Refresh Rate : " + rate); + console.print("--FSAA Level : " + fsaa); + console.print("--------------"); // Actually set the new video mode ((GuiCanvas) "Canvas").setVideoMode((uint) resX, (uint) resY, fs.AsBool(), bpp.AsUint(), rate.AsUint(), fsaa.AsUint()); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/chadHud.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/chadHud.cs index cba10f91..608c8e3f 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/chadHud.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/chadHud.cs @@ -60,13 +60,13 @@ public static void initialize() //----------------------------------------------------------------------------- // chat hud sizes in lines - omni.iGlobal["$outerChatLenY[1]"] = 4; - omni.iGlobal["$outerChatLenY[2]"] = 9; - omni.iGlobal["$outerChatLenY[3]"] = 13; - omni.iGlobal["$LastHudTarget"] = 0; + iGlobal["$outerChatLenY[1]"] = 4; + iGlobal["$outerChatLenY[2]"] = 9; + iGlobal["$outerChatLenY[3]"] = 13; + iGlobal["$LastHudTarget"] = 0; // Only play sound files that are <= 5000ms in length. - omni.iGlobal["$MaxMessageWavLength"] = 5000; + iGlobal["$MaxMessageWavLength"] = 5000; //new MessageVector(HudMessageVector); ObjectCreator oc = new ObjectCreator("MessageVector", "HudMessageVector"); oc.Create(); @@ -186,7 +186,7 @@ public void PageDown() // Returns starting position of wave file indicator. public static int PlayMessageSound(string message, string voice, string pitch) { - int wavstart = omni.Util.strstr(message, "~w"); + int wavstart = Util.strstr(message, "~w"); if (wavstart == -1) return -1; @@ -200,36 +200,36 @@ public static int PlayMessageSound(string message, string voice, string pitch) // would be nice to support checking in each mod path if we // have multiple mods active. - if (omni.Util.strstr(wavFile, ".wav") != wavFile.Length - 4) + if (Util.strstr(wavFile, ".wav") != wavFile.Length - 4) wavFile = wavFile + ".wav"; - wavSource = omni.Util._expandFilename(wavFile); + wavSource = Util._expandFilename(wavFile); if (wavSource.isObject()) { { - int wavLengthMs = omni.console.Call(wavSource, "getDuration").AsInt()*pitch.AsInt(); + int wavLengthMs = console.Call(wavSource, "getDuration").AsInt()*pitch.AsInt(); if (wavLengthMs == 0) - omni.console.error(string.Format("** WAV file \"{0}\" is nonexistent or sound is zero-length **", wavFile)); - else if (wavLengthMs <= omni.console.GetVarInt("$MaxMessageWavLength")) + console.error(string.Format("** WAV file \"{0}\" is nonexistent or sound is zero-length **", wavFile)); + else if (wavLengthMs <= console.GetVarInt("$MaxMessageWavLength")) { - if (omni.console.isObject("$ClientChatHandle[0]")) - omni.sGlobal["$ClientChatHandle[0]"].delete(); + if (console.isObject("$ClientChatHandle[0]")) + sGlobal["$ClientChatHandle[0]"].delete(); - omni.console.SetVar("$ClientChatHandle[0]", wavSource); + console.SetVar("$ClientChatHandle[0]", wavSource); if (pitch.AsInt() != 1) - omni.console.Call("$ClientChatHandle[0]", "setPitch", new[] {pitch}); + console.Call("$ClientChatHandle[0]", "setPitch", new[] {pitch}); - omni.console.Call("$ClientChatHandle[0]", "play"); + console.Call("$ClientChatHandle[0]", "play"); } else - omni.console.error(string.Format("** WAV file \"{0}\" is too long **", wavFile)); + console.error(string.Format("** WAV file \"{0}\" is too long **", wavFile)); } } else - omni.console.error(string.Format("** Unable to load WAV file : \"{0}\" **", wavFile)); + console.error(string.Format("** Unable to load WAV file : \"{0}\" **", wavFile)); return wavstart; } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/client.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/client.cs index 31f395f0..11f22600 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/client.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/client.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -49,44 +49,42 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class client { - private static readonly pInvokes omni = new pInvokes(); - public static void LoadDefaults() { - omni.sGlobal["$pref::Player::Name"] = "Visitor"; - omni.iGlobal["$pref::Player::defaultFov"] = 65; - omni.iGlobal["$pref::Player::zoomSpeed"] = 0; + pInvokes.sGlobal["$pref::Player::Name"] = "Visitor"; + pInvokes.iGlobal["$pref::Player::defaultFov"] = 65; + pInvokes.iGlobal["$pref::Player::zoomSpeed"] = 0; - omni.iGlobal["$pref::Net::LagThreshold"] = 400; - omni.iGlobal["$pref::Net::Port"] = 28000; + pInvokes.iGlobal["$pref::Net::LagThreshold"] = 400; + pInvokes.iGlobal["$pref::Net::Port"] = 28000; - //omni.iGlobal["$pref::Net::PacketRateToClient"] = 32; - //omni.iGlobal["$pref::Net::PacketRateToServer"] = 32; - //omni.iGlobal["$pref::Net::PacketSize"] = 200; + //pInvokes.iGlobal["$pref::Net::PacketRateToClient"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketRateToServer"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketSize"] = 200; - omni.iGlobal["$pref::HudMessageLogSize"] = 40; - omni.iGlobal["$pref::ChatHudLength"] = 1; + pInvokes.iGlobal["$pref::HudMessageLogSize"] = 40; + pInvokes.iGlobal["$pref::ChatHudLength"] = 1; - omni.iGlobal["$pref::Input::LinkMouseSensitivity"] = 1; + pInvokes.iGlobal["$pref::Input::LinkMouseSensitivity"] = 1; // DInput keyboard, mouse, and joystick prefs - omni.iGlobal["$pref::Input::KeyboardEnabled"] = 1; - omni.iGlobal["$pref::Input::MouseEnabled"] = 1; - omni.iGlobal["$pref::Input::JoystickEnabled"] = 0; - omni.dGlobal["$pref::Input::KeyboardTurnSpeed"] = 0.1; + pInvokes.iGlobal["$pref::Input::KeyboardEnabled"] = 1; + pInvokes.iGlobal["$pref::Input::MouseEnabled"] = 1; + pInvokes.iGlobal["$pref::Input::JoystickEnabled"] = 0; + pInvokes.dGlobal["$pref::Input::KeyboardTurnSpeed"] = 0.1; - omni.iGlobal["$sceneLighting::cacheSize"] = 20000; - omni.sGlobal["$sceneLighting::purgeMethod"] = "lastCreated"; - omni.iGlobal["$sceneLighting::cacheLighting"] = 1; + pInvokes.iGlobal["$sceneLighting::cacheSize"] = 20000; + pInvokes.sGlobal["$sceneLighting::purgeMethod"] = "lastCreated"; + pInvokes.iGlobal["$sceneLighting::cacheLighting"] = 1; - omni.sGlobal["$pref::Video::displayDevice"] = "D3D9"; - omni.iGlobal["$pref::Video::disableVerticalSync"] = 1; - omni.sGlobal["$pref::Video::Canvas::mode"] = "1024 768 false 32 60 4"; - //omni.sGlobal["$pref::Video::Canvas_SceneTree::mode"] = "300 480 false 32 60 4"; - //omni.sGlobal["$pref::Video::Canvas_Inspector::mode"] = "500 480 false 32 60 4"; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "D3D9"; + pInvokes.iGlobal["$pref::Video::disableVerticalSync"] = 1; + pInvokes.sGlobal["$pref::Video::Canvas::mode"] = "1024 768 false 32 60 4"; + //pInvokes.sGlobal["$pref::Video::Canvas_SceneTree::mode"] = "300 480 false 32 60 4"; + //pInvokes.sGlobal["$pref::Video::Canvas_Inspector::mode"] = "500 480 false 32 60 4"; - omni.iGlobal["$pref::Video::defaultFenceCount"] = 0; - omni.iGlobal["$pref::Video::screenShotSession"] = 0; - omni.sGlobal["$pref::Video::screenShotFormat"] = "PNG"; + pInvokes.iGlobal["$pref::Video::defaultFenceCount"] = 0; + pInvokes.iGlobal["$pref::Video::screenShotSession"] = 0; + pInvokes.sGlobal["$pref::Video::screenShotFormat"] = "PNG"; // This disables the hardware FSAA/MSAA so that // we depend completely on the FXAA post effect @@ -96,141 +94,141 @@ public static void LoadDefaults() // will fail to initialize when hardware AA is // enabled... so you've been warned. // - omni.bGlobal["$pref::Video::disableHardwareAA"] = true; + pInvokes.bGlobal["$pref::Video::disableHardwareAA"] = true; - omni.bGlobal["$pref::Video::disableNormalmapping"] = false; + pInvokes.bGlobal["$pref::Video::disableNormalmapping"] = false; - omni.bGlobal["$pref::Video::disablePixSpecular"] = false; + pInvokes.bGlobal["$pref::Video::disablePixSpecular"] = false; - omni.bGlobal["$pref::Video::disableCubemapping"] = false; + pInvokes.bGlobal["$pref::Video::disableCubemapping"] = false; - omni.bGlobal["$pref::Video::disableParallaxMapping"] = false; + pInvokes.bGlobal["$pref::Video::disableParallaxMapping"] = false; - omni.dGlobal["$pref::Video::Gamma"] = 1.0; + pInvokes.dGlobal["$pref::Video::Gamma"] = 1.0; - if (omni.sGlobal["$platform"] == "xenon") + if (pInvokes.sGlobal["$platform"] == "xenon") { // Save some fillrate on the X360, and take advantage of the HW scaling - omni.sGlobal["$pref::Video::Resolution"] = "1152 640"; - omni.sGlobal["$pref::Video::Canvas::mode"] = omni.sGlobal["$pref::Video::Resolution"] + " " + "true 32 60 0"; - omni.iGlobal["$pref::Video::fullScreen"] = 1; + pInvokes.sGlobal["$pref::Video::Resolution"] = "1152 640"; + pInvokes.sGlobal["$pref::Video::Canvas::mode"] = pInvokes.sGlobal["$pref::Video::Resolution"] + " " + "true 32 60 0"; + pInvokes.iGlobal["$pref::Video::fullScreen"] = 1; } // This is the path used by ShaderGen to cache procedural // shaders. If left blank ShaderGen will only cache shaders // to memory and not to disk. - omni.sGlobal["$shaderGen::cachePath"] = "shaders/procedural"; + pInvokes.sGlobal["$shaderGen::cachePath"] = "shaders/procedural"; // The perfered light manager to use at startup. If blank // or if the selected one doesn't work on this platfom it // will try the defaults below. - omni.sGlobal["$pref::lightManager"] = ""; + pInvokes.sGlobal["$pref::lightManager"] = ""; // This is the default list of light managers ordered from // most to least desirable for initialization. - omni.sGlobal["$lightManager::defaults"] = "Advanced Lighting\nBasic Lighting"; + pInvokes.sGlobal["$lightManager::defaults"] = "Advanced Lighting\nBasic Lighting"; // A scale to apply to the camera view distance // typically used for tuning performance. - omni.dGlobal["$pref::camera::distanceScale"] = 1.0; + pInvokes.dGlobal["$pref::camera::distanceScale"] = 1.0; // Causes the system to do a one time autodetect // of an SFX provider and device at startup if the // provider is unset. - omni.bGlobal["$pref::SFX::autoDetect"] = true; + pInvokes.bGlobal["$pref::SFX::autoDetect"] = true; // The sound provider to select at startup. Typically - // this is DirectSound, OpenAL, or XACT. There is also - // a special Null provider which acts normally, but + // this is DirectSound, OpenAL, or XACT. There is also + // a special Null provider which acts normally, but // plays no sound. - omni.sGlobal["$pref::SFX::provider"] = ""; + pInvokes.sGlobal["$pref::SFX::provider"] = ""; // The sound device to select from the provider. Each // provider may have several different devices. - omni.sGlobal["$pref::SFX::device"] = "OpenAL"; + pInvokes.sGlobal["$pref::SFX::device"] = "OpenAL"; // If true the device will try to use hardware buffers // and sound mixing. If not it will use software. - omni.bGlobal["$pref::SFX::useHardware"] = false; + pInvokes.bGlobal["$pref::SFX::useHardware"] = false; - // If you have a software device you have a + // If you have a software device you have a // choice of how many software buffers to // allow at any one time. More buffers cost // more CPU time to process and mix. - omni.iGlobal["$pref::SFX::maxSoftwareBuffers"] = 16; + pInvokes.iGlobal["$pref::SFX::maxSoftwareBuffers"] = 16; - // This is the playback frequency for the primary + // This is the playback frequency for the primary // sound buffer used for mixing. Although most - // providers will reformat on the fly, for best + // providers will reformat on the fly, for best // quality and performance match your sound files // to this setting. - omni.iGlobal["$pref::SFX::frequency"] = 44100; + pInvokes.iGlobal["$pref::SFX::frequency"] = 44100; - // This is the playback bitrate for the primary + // This is the playback bitrate for the primary // sound buffer used for mixing. Although most - // providers will reformat on the fly, for best + // providers will reformat on the fly, for best // quality and performance match your sound files // to this setting. - omni.iGlobal["$pref::SFX::bitrate"] = 32; + pInvokes.iGlobal["$pref::SFX::bitrate"] = 32; - // The overall system volume at startup. Note that + // The overall system volume at startup. Note that // you can only scale volume down, volume does not // get louder than 1. - omni.dGlobal["$pref::SFX::masterVolume"] = 0.8; + pInvokes.dGlobal["$pref::SFX::masterVolume"] = 0.8; - // The startup sound channel volumes. These are - // used to control the overall volume of different + // The startup sound channel volumes. These are + // used to control the overall volume of different // classes of sounds. - omni.iGlobal["$pref::SFX::channelVolume1"] = 1; - omni.iGlobal["$pref::SFX::channelVolume2"] = 1; - omni.iGlobal["$pref::SFX::channelVolume3"] = 1; - omni.iGlobal["$pref::SFX::channelVolume4"] = 1; - omni.iGlobal["$pref::SFX::channelVolume5"] = 1; - omni.iGlobal["$pref::SFX::channelVolume6"] = 1; - omni.iGlobal["$pref::SFX::channelVolume7"] = 1; - omni.iGlobal["$pref::SFX::channelVolume8"] = 1; - - omni.sGlobal["$pref::PostEffect::PreferedHDRFormat"] = "GFXFormatR8G8B8A8"; - - // This is an scalar which can be used to reduce the + pInvokes.iGlobal["$pref::SFX::channelVolume1"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume2"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume3"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume4"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume5"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume6"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume7"] = 1; + pInvokes.iGlobal["$pref::SFX::channelVolume8"] = 1; + + pInvokes.sGlobal["$pref::PostEffect::PreferedHDRFormat"] = "GFXFormatR8G8B8A8"; + + // This is an scalar which can be used to reduce the // reflection textures on all objects to save fillrate. - omni.dGlobal["$pref::Reflect::refractTexScale"] = 1.0; + pInvokes.dGlobal["$pref::Reflect::refractTexScale"] = 1.0; // This is the total frame in milliseconds to budget for // reflection rendering. If your CPU bound and have alot // of smaller reflection surfaces try reducing this time. - omni.iGlobal["$pref::Reflect::frameLimitMS"] = 10; + pInvokes.iGlobal["$pref::Reflect::frameLimitMS"] = 10; // Set true to force all water objects to use static cubemap reflections. - omni.bGlobal["$pref::Water::disableTrueReflections"] = false; + pInvokes.bGlobal["$pref::Water::disableTrueReflections"] = false; // A global LOD scalar which can reduce the overall density of placed GroundCover. - omni.dGlobal["$pref::GroundCover::densityScale"] = 1.0; + pInvokes.dGlobal["$pref::GroundCover::densityScale"] = 1.0; // An overall scaler on the lod switching between DTS models. // Smaller numbers makes the lod switch sooner. - omni.dGlobal["$pref::TS::detailAdjust"] = 1.0; - omni.bGlobal["$pref::decalMgr::enabled"] = true; + pInvokes.dGlobal["$pref::TS::detailAdjust"] = 1.0; + pInvokes.bGlobal["$pref::decalMgr::enabled"] = true; // - omni.bGlobal["$pref::Decals::enabled"] = true; + pInvokes.bGlobal["$pref::Decals::enabled"] = true; // - omni.sGlobal["$pref::Decals::lifeTimeScale"] = "1"; + pInvokes.sGlobal["$pref::Decals::lifeTimeScale"] = "1"; // The number of mipmap levels to drop on loaded textures - // to reduce video memory usage. + // to reduce video memory usage. // - // It will skip any textures that have been defined as not + // It will skip any textures that have been defined as not // allowing down scaling. // - omni.iGlobal["$pref::Video::textureReductionLevel"] = 0; + pInvokes.iGlobal["$pref::Video::textureReductionLevel"] = 0; // - omni.dGlobal["$pref::Shadows::textureScalar"] = 1.0; + pInvokes.dGlobal["$pref::Shadows::textureScalar"] = 1.0; // - omni.bGlobal["$pref::Shadows::disable"] = false; + pInvokes.bGlobal["$pref::Shadows::disable"] = false; // Sets the shadow filtering mode. // @@ -238,19 +236,19 @@ public static void LoadDefaults() // // SoftShadow - Does a simple soft shadow // - // SoftShadowHighQuality + // SoftShadowHighQuality // - omni.sGlobal["$pref::Shadows::filterMode"] = "SoftShadow"; + pInvokes.sGlobal["$pref::Shadows::filterMode"] = "SoftShadow"; // - omni.iGlobal["$pref::Video::defaultAnisotropy"] = 0; + pInvokes.iGlobal["$pref::Video::defaultAnisotropy"] = 0; // Radius in meters around the camera that ForestItems are affected by wind. // Note that a very large number with a large number of items is not cheap. - omni.iGlobal["$pref::windEffectRadius"] = 25; + pInvokes.iGlobal["$pref::windEffectRadius"] = 25; // AutoDetect graphics quality levels the next startup. - omni.iGlobal["$pref::Video::autoDetect"] = 1; + pInvokes.iGlobal["$pref::Video::autoDetect"] = 1; //----------------------------------------------------------------------------- // Graphics Quality Groups @@ -426,26 +424,26 @@ public static void LoadDefaults() oc["#4"] = so4; oc.Create(); - omni.bGlobal["$PhysXLogWarnings"] = false; - if (omni.sGlobal["$platform"] != "xenon") + pInvokes.bGlobal["$PhysXLogWarnings"] = false; + if (pInvokes.sGlobal["$platform"] != "xenon") { //Todo Settings - Switch this back when fixed. //Settings.LoadSection("scripts/client/prefs.cs"); - omni.Util.exec("prefs.client.cs", false, false); + pInvokes.Util.exec("prefs.client.cs", false, false); } else - omni.console.print("Not loading client prefs.cs on Xbox360"); + pInvokes.console.print("Not loading client prefs.cs on Xbox360"); } [ConsoleInteraction(true)] public static string GraphicsQualityAutodetect() { - omni.bGlobal["$pref::Video::autoDetect = false;"] = false; + pInvokes.bGlobal["$pref::Video::autoDetect = false;"] = false; - float shaderVer = omni.Util.getPixelShaderVersion(); - bool intel = omni.Util.getDisplayDeviceInformation().ToUpper() == "INTEL"; - string videoMem = omni.console.Call_Classname("GFXCardProfilerAPI", "getVideoMemoryMB"); + float shaderVer = pInvokes.Util.getPixelShaderVersion(); + bool intel = pInvokes.Util.getDisplayDeviceInformation().ToUpper() == "INTEL"; + string videoMem = pInvokes.console.Call_Classname("GFXCardProfilerAPI", "getVideoMemoryMB"); return GraphicsQualityAutodetect_Apply(shaderVer, intel, videoMem); } @@ -529,7 +527,7 @@ public static int serverToClientObject(int serverObject) [ConsoleInteraction(true)] public static void netSimulateLag(int msDelay, int packetLossPercent) { - omni.console.commandToServer("NetSimulateLag", new[] {msDelay.AsString(), packetLossPercent.AsString()}); + pInvokes.console.commandToServer("NetSimulateLag", new[] {msDelay.AsString(), packetLossPercent.AsString()}); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/clientCmd.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/clientCmd.cs index a28b2c25..e4fa8ef8 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/clientCmd.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/clientCmd.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Decorations; @@ -44,7 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class clientCmd { - private static readonly pInvokes omni = new pInvokes(); //----------------------------------------------------------------------------- // Server Admin Commands //----------------------------------------------------------------------------- @@ -52,13 +51,13 @@ public class clientCmd public static void SAD(string password) { if (password.Trim() != "") - omni.console.commandToServer("SAD", new[] {password}); + pInvokes.console.commandToServer("SAD", new[] {password}); } [ConsoleInteraction(true)] public static void SadSetPassword(string password) { - omni.console.commandToServer("SADSetPassword", new[] {password}); + pInvokes.console.commandToServer("SADSetPassword", new[] {password}); } //---------------------------------------------------------------------------- @@ -84,7 +83,7 @@ public static void clientCmdSetDamageDirection(string direction) if (!ctrl.isObject()) return; - omni.Util.cancelAll(ctrl); + pInvokes.Util.cancelAll(ctrl); ctrl.setVisible(true); ctrl.schedule("500", "setVisible", "false"); } @@ -127,11 +126,11 @@ public static void ClientCmdSetAmmoAmountHud(string amount, string amountInClips [ConsoleInteraction(true)] public static void ClientCmdRefreshWeaponHud(string amount, string preview, string ret, string zoomret, string amountInClips) { - amount = omni.Util.detag(amount); - preview = omni.Util.detag(preview); - ret = omni.Util.detag(ret); - zoomret = omni.Util.detag(zoomret); - amountInClips = omni.Util.detag(amountInClips); + amount = pInvokes.Util.detag(amount); + preview = pInvokes.Util.detag(preview); + ret = pInvokes.Util.detag(ret); + zoomret = pInvokes.Util.detag(zoomret); + amountInClips = pInvokes.Util.detag(amountInClips); GuiTextCtrl AmmoAmount = "AmmoAmount"; @@ -180,8 +179,8 @@ public static void ClientCmdtoggleVehicleMapToggle(string toggle) { if (toggle.AsBool()) { - omni.dGlobal["$mvForwardAction"] = 0; //Gamepad vehicle stop - omni.dGlobal["$mvBackwardAction"] = 0; //Gamepad vehicle stop + pInvokes.dGlobal["$mvForwardAction"] = 0; //Gamepad vehicle stop + pInvokes.dGlobal["$mvBackwardAction"] = 0; //Gamepad vehicle stop ((ActionMap) "moveMap").pop(); ((ActionMap) "vehicleMap").push(); } @@ -216,4 +215,4 @@ public static void TurretMountCallback(string turret, string player, bool mounte ((ActionMap) "turretMap").pop(); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/commonMaterialData.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/commonMaterialData.cs index c89d87f9..b100d766 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/commonMaterialData.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/commonMaterialData.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; @@ -40,8 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class commonMaterialData { - private static readonly pInvokes omni = new pInvokes(); - public static void intialize() { //----------------------------------------------------------------------------- @@ -50,11 +48,11 @@ public static void intialize() // handle the "|" operation for combining them together // ie. Scroll | Wave does not work. //----------------------------------------------------------------------------- - omni.iGlobal["$scroll"] = 1; - omni.iGlobal["$rotate"] = 2; - omni.iGlobal["$wave"] = 4; - omni.iGlobal["$scale"] = 8; - omni.iGlobal["$sequence"] = 16; + pInvokes.iGlobal["$scroll"] = 1; + pInvokes.iGlobal["$rotate"] = 2; + pInvokes.iGlobal["$wave"] = 4; + pInvokes.iGlobal["$scale"] = 8; + pInvokes.iGlobal["$sequence"] = 16; // Common stateblock definitions ObjectCreator oc = new ObjectCreator("GFXSamplerStateData", "SamplerClampLinear"); @@ -98,4 +96,4 @@ public static void intialize() oc.Create(); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/core.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/core.cs index fda12218..5ae559e5 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/core.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/core.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -59,11 +59,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class core { - private static readonly pInvokes omni = new pInvokes(); - public static void initializeCore() { - if (omni.bGlobal["$coreInitialized"]) + if (pInvokes.bGlobal["$coreInitialized"]) return; ActionMap GlobalActionMap = "GlobalActionMap"; @@ -76,12 +74,12 @@ public static void initializeCore() audio.initialize(); canvas.initialize(); GuiCanvas.initialize(); - //omni.Util.exec("core/scripts/client/cursor.cs", false, false); - //omni.Util.exec("core/scripts/client/persistenceManagerTest.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/cursor.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/persistenceManagerTest.cs", false, false); // Content. - omni.Util.exec("core/art/gui/profiles.cs", false, false); - //omni.Util.exec("core/scripts/gui/cursors.cs", false, false); + pInvokes.Util.exec("core/art/gui/profiles.cs", false, false); + //pInvokes.Util.exec("core/scripts/gui/cursors.cs", false, false); cursor.initialize(); audioEnviroments.initialize(); @@ -90,38 +88,38 @@ public static void initializeCore() audioAmbiences.initialize(); // Input devices - // omni.Util.exec("core/scripts/client/oculusVR.cs", false, false); + // pInvokes.Util.exec("core/scripts/client/oculusVR.cs", false, false); - omni.Util.setRandomSeed((DateTime.Now.Millisecond + 1)*(DateTime.Now.Second + 1)); + pInvokes.Util.setRandomSeed((DateTime.Now.Millisecond + 1)*(DateTime.Now.Second + 1)); // Set up networking. - omni.Util.setNetPort(0); + pInvokes.Util.setNetPort(0); // Initialize the canvas. canvas.initializeCanvas(); - // Start processing file change events. - omni.Util.startFileChangeNotifications(); + // Start processing file change events. + pInvokes.Util.startFileChangeNotifications(); // Core Guis. - //omni.Util.exec("core/art/gui/console.gui", false, false); + //pInvokes.Util.exec("core/art/gui/console.gui", false, false); ConsoleDlg.initialize(); - //omni.Util.exec("core/art/gui/consoleVarDlg.gui", false, false); + //pInvokes.Util.exec("core/art/gui/consoleVarDlg.gui", false, false); ConsoleVarDlg.initialize(); - omni.Util.exec("core/art/gui/netGraphGui.gui", false, false); + pInvokes.Util.exec("core/art/gui/netGraphGui.gui", false, false); // Gui Helper Scripts. - //omni.Util.exec("core/scripts/gui/help.cs", false, false); + //pInvokes.Util.exec("core/scripts/gui/help.cs", false, false); // Random Scripts. - //omni.Util.exec("core/scripts/client/screenshot.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/screenshot.cs", false, false); screenshot.initialize(); - //omni.Util.exec("core/scripts/client/helperfuncs.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/helperfuncs.cs", false, false); // Client scripts metrics.initialize(); - //omni.Util.exec("core/scripts/client/recordings.cs", false, false); + //pInvokes.Util.exec("core/scripts/client/recordings.cs", false, false); centerPrint.initialize(); loadCoreMaterials(); commonMaterialData.intialize(); @@ -133,7 +131,7 @@ public static void initializeCore() scatterSky.initialize(); clouds.initialize(); - // Initialize all core post effects. + // Initialize all core post effects. postFX.initialize(); postFX.initPostEffects(); @@ -143,9 +141,9 @@ public static void initializeCore() ((GuiCanvas) "Canvas").setCursor("DefaultCursor"); //Need to call this function through the console because loadKeyBindings is part of a packaged used in tools - omni.console.Call("loadKeybindings"); + pInvokes.console.Call("loadKeybindings"); - omni.bGlobal["$coreInitialized"] = true; + pInvokes.bGlobal["$coreInitialized"] = true; } [ConsoleInteraction(true)] @@ -159,12 +157,12 @@ public static void loadCoreMaterials() { if (File.Exists(file.Substring(0, file.Length - 4))) { - omni.Util.exec(file.Substring(startposition, file.Length - 4).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition, file.Length - 4).Replace("\\", "/"), false, false); filesloaded.Add(file.Substring(startposition, file.Length - 4)); } else { - omni.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); filesloaded.Add(file.Substring(startposition)); } } @@ -173,7 +171,7 @@ public static void loadCoreMaterials() foreach (string file in files) { if (!filesloaded.Contains(file.Substring(startposition))) - omni.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); } } @@ -186,7 +184,7 @@ public static void loadCoreMaterials() public static void shutdownCore() { // Stop file change events. - omni.Util.stopFileChangeNotifications(); + pInvokes.Util.stopFileChangeNotifications(); audio.sfxShutdown(); } @@ -197,15 +195,15 @@ public static void shutdownCore() [ConsoleInteraction(true)] public static void dumpKeybindings() { - for (int i = 0; i < omni.iGlobal["$keybindCount"]; i++) + for (int i = 0; i < pInvokes.iGlobal["$keybindCount"]; i++) { - if (omni.sGlobal["$keybindMap[" + i + "]"].isObject()) + if (pInvokes.sGlobal["$keybindMap[" + i + "]"].isObject()) { // Save and delete. - ModelBase t = omni.sGlobal["$keybindMap[" + i + "]"]; + ModelBase t = pInvokes.sGlobal["$keybindMap[" + i + "]"]; Console.WriteLine(t._ID); - omni.console.Call(omni.sGlobal["$keybindMap[" + i + "]"], "save", new[] {omni.Util.getPrefsPath("bind.cs"), i == 0 ? "false" : "true"}); - omni.sGlobal["$keybindMap[" + i + "]"].delete(); + pInvokes.console.Call(pInvokes.sGlobal["$keybindMap[" + i + "]"], "save", new[] {pInvokes.Util.getPrefsPath("bind.cs"), i == 0 ? "false" : "true"}); + pInvokes.sGlobal["$keybindMap[" + i + "]"].delete(); } } } @@ -217,10 +215,10 @@ public static void handleEscape() { if (((GuiCanvas) "Canvas").getContent() == ((ModelBase) "EditorGui")._iID) { - omni.console.Call("EditorGui", "handleEscape"); + pInvokes.console.Call("EditorGui", "handleEscape"); return; } - else if (omni.console.Call("EditorIsDirty").AsBool()) + else if (pInvokes.console.Call("EditorIsDirty").AsBool()) { messageBox.MessageBoxYesNoCancel("Level Modified", "Level has been modified in the Editor. Save?", "EditorDoExitMission(1);", "EditorDoExitMission();", ""); return; @@ -236,15 +234,15 @@ public static void handleEscape() } if (((GameTSCtrl) "PlayGui").isAwake()) - omni.console.Call("escapeFromGame"); + pInvokes.console.Call("escapeFromGame"); } [ConsoleInteraction(true)] public static void reloadCoreMaterials() { - omni.Util.reloadTextures(); + pInvokes.Util.reloadTextures(); loadCoreMaterials(); - omni.Util.reInitMaterials(); + pInvokes.Util.reInitMaterials(); } /// @@ -260,12 +258,12 @@ public static void loadMaterials() { if (File.Exists(file.Substring(0, file.Length - 4))) { - omni.Util.exec(file.Substring(startposition, file.Length - 4).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition, file.Length - 4).Replace("\\", "/"), false, false); filesloaded.Add(file.Substring(startposition, file.Length - 4)); } else { - omni.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); filesloaded.Add(file.Substring(startposition)); } } @@ -274,7 +272,7 @@ public static void loadMaterials() foreach (string file in files) { if (!filesloaded.Contains(file.Substring(startposition))) - omni.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); + pInvokes.Util.exec(file.Substring(startposition).Replace("\\", "/"), false, false); } //in the torquescript version they do yet another pass against files in the path/materialEditor folder which @@ -285,9 +283,9 @@ public static void loadMaterials() [ConsoleInteraction(true)] public static void reloadMaterials() { - omni.Util.reloadTextures(); + pInvokes.Util.reloadTextures(); loadMaterials(); - omni.Util.reInitMaterials(); + pInvokes.Util.reInitMaterials(); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/default.bind.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/default.bind.cs index dafc092a..45a4ef1a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/default.bind.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/default.bind.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -54,8 +54,6 @@ public class defaultBind { public static int movementSpeed = 1; - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { if ("moveMap".isObject()) @@ -112,8 +110,8 @@ public static void initialize() moveMap.bind("gamepad", "triggerr", "gamepadFire"); moveMap.bind("gamepad", "triggerl", "gamepadAltTrigger"); - if (omni.sGlobal["$Player::CurrentFOV"] == "") - omni.iGlobal["$Player::CurrentFOV"] = omni.iGlobal["$pref::Player::DefaultFOV"]/2; + if (pInvokes.sGlobal["$Player::CurrentFOV"] == "") + pInvokes.iGlobal["$Player::CurrentFOV"] = pInvokes.iGlobal["$pref::Player::DefaultFOV"]/2; moveMap.bind("keyboard", "f", "setZoomFOV"); // f for field of view moveMap.bind("keyboard", "z", "toggleZoom"); // z for zoom @@ -237,7 +235,7 @@ public static void initialize() [ConsoleInteraction(true)] public static void escapeFromGame() { - if (omni.sGlobal["$Server::ServerType"] == "SinglePlayer") + if (pInvokes.sGlobal["$Server::ServerType"] == "SinglePlayer") messageBox.MessageBoxYesNo("Exit", "Exit from this Mission?", "disconnect();", ""); else messageBox.MessageBoxYesNo("Disconnect", "Disconnect from the server?", "disconnect();", ""); @@ -263,7 +261,7 @@ public static void doScreenShotHudless(bool val) if (val) { ((GuiCanvas) "Canvas").setContent("HudlessPlayGui"); - omni.Util._schedule("10", "0", "doScreenShot", val.AsString()); + pInvokes.Util._schedule("10", "0", "doScreenShot", val.AsString()); } else ((GuiCanvas) "Canvas").setContent("PlayGui"); @@ -279,27 +277,27 @@ public static void setSpeed(int speed) [ConsoleInteraction(true)] public static void moveleft(int val) { - omni.iGlobal["$mvLeftAction"] = movementSpeed*val; + pInvokes.iGlobal["$mvLeftAction"] = movementSpeed*val; } [ConsoleInteraction(true)] public static void moveright(int val) { //console.SetVar("$mvRightAction", val.AsInt()*movementSpeed); - omni.iGlobal["$mvRightAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvRightAction"] = val*movementSpeed; } [ConsoleInteraction(true)] public static void moveforward(int val) { //console.SetVar("$mvForwardAction", val.AsInt() * movementSpeed); - omni.iGlobal["$mvForwardAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvForwardAction"] = val*movementSpeed; } [ConsoleInteraction(true)] public static void movebackward(int val) { - omni.iGlobal["$mvBackwardAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvBackwardAction"] = val*movementSpeed; //console.SetVar("$mvBackwardAction", val.AsInt() * movementSpeed); } @@ -308,7 +306,7 @@ public static void moveup(int val) { SimObject obj = ((GameConnection) "ServerConnection").getControlObject(); if (obj.isInNamespaceHierarchy("Camera")) - omni.iGlobal["$mvUpAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvUpAction"] = val*movementSpeed; //console.SetVar("$mvUpAction", val.AsInt() * movementSpeed); } @@ -317,14 +315,14 @@ public static void movedown(int val) { SimObject obj = ((GameConnection) "ServerConnection").getControlObject(); if (obj.isInNamespaceHierarchy("Camera")) - omni.iGlobal["$mvDownAction"] = val*movementSpeed; + pInvokes.iGlobal["$mvDownAction"] = val*movementSpeed; //console.SetVar("$mvDownAction", val.AsInt() * movementSpeed); } [ConsoleInteraction(true)] public static void turnLeft(bool val) { - omni.iGlobal["$mvYawRightSpeed"] = val ? omni.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; + pInvokes.iGlobal["$mvYawRightSpeed"] = val ? pInvokes.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; //console.SetVar("$mvYawRightSpeed", val.AsBool() ? console.GetVarInt("$Pref::Input::KeyboardTurnSpeed") : 0); } @@ -332,34 +330,34 @@ public static void turnLeft(bool val) public static void turnRight(bool val) { //console.SetVar("$mvYawLeftSpeed", val.AsBool() ? console.GetVarInt("$Pref::Input::KeyboardTurnSpeed") : 0); - omni.iGlobal["$mvYawLeftSpeed"] = val ? omni.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; + pInvokes.iGlobal["$mvYawLeftSpeed"] = val ? pInvokes.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; } [ConsoleInteraction(true)] public static void panUp(bool val) { - omni.iGlobal["$mvPitchDownSpeed"] = val ? omni.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; + pInvokes.iGlobal["$mvPitchDownSpeed"] = val ? pInvokes.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; //console.SetVar("$mvPitchDownSpeed", val.AsBool() ? console.GetVarInt("$Pref::Input::KeyboardTurnSpeed") : 0); } [ConsoleInteraction(true)] public static void panDown(bool val) { - omni.iGlobal["$mvPitchUpSpeed"] = val ? omni.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; + pInvokes.iGlobal["$mvPitchUpSpeed"] = val ? pInvokes.iGlobal["$Pref::Input::KeyboardTurnSpeed"] : 0; //console.SetVar("$mvPitchUpSpeed", val.AsBool() ? console.GetVarInt("$Pref::Input::KeyboardTurnSpeed") : 0); } [ConsoleInteraction(true)] public static float getMouseAdjustAmount(float val) { - return ((val*(omni.fGlobal["$cameraFov"]/90.0f)*0.01f)*omni.fGlobal["$pref::Input::LinkMouseSensitivity"]); + return ((val*(pInvokes.fGlobal["$cameraFov"]/90.0f)*0.01f)*pInvokes.fGlobal["$pref::Input::LinkMouseSensitivity"]); //return ((val.AsDouble() * (console.GetVarFloat("$cameraFov") / 90.0) * 0.01) * console.GetVarFloat("$pref::Input::LinkMouseSensitivity")).AsString(); } [ConsoleInteraction(true)] public static float getGamepadAdjustAmount(float val) { - return ((val*(omni.fGlobal["$cameraFov"]/90.0f)*0.01f)*10.0f); + return ((val*(pInvokes.fGlobal["$cameraFov"]/90.0f)*0.01f)*10.0f); //return ((val.AsFloat() * (console.GetVarFloat("$cameraFov") / 90) * 0.01) * 10.0).AsString(); } @@ -369,10 +367,10 @@ public static void yaw(float val) float yawAdj = getMouseAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera()) { - yawAdj = omni.Util.mClamp(yawAdj, (-omni.Util.m2Pi() + (float) 0.01), (omni.Util.m2Pi() - (float) 0.01)); + yawAdj = pInvokes.Util.mClamp(yawAdj, (-pInvokes.Util.m2Pi() + (float) 0.01), (pInvokes.Util.m2Pi() - (float) 0.01)); yawAdj *= (float) 0.5; } - omni.fGlobal["$mvYaw"] = omni.fGlobal["$mvYaw"] + yawAdj; + pInvokes.fGlobal["$mvYaw"] = pInvokes.fGlobal["$mvYaw"] + yawAdj; //console.SetVar("$mvYaw", console.GetVarFloat("$mvYaw") + yawAdj); } @@ -382,17 +380,17 @@ public static void pitch(float val) float pitchAdj = getMouseAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera()) { - pitchAdj = omni.Util.mClamp(pitchAdj, (-omni.Util.m2Pi() + (float) 0.01), (omni.Util.m2Pi() - (float) 0.01)); + pitchAdj = pInvokes.Util.mClamp(pitchAdj, (-pInvokes.Util.m2Pi() + (float) 0.01), (pInvokes.Util.m2Pi() - (float) 0.01)); pitchAdj *= (float) 0.5; } - omni.fGlobal["$mvPitch"] = omni.fGlobal["$mvPitch"] + pitchAdj; + pInvokes.fGlobal["$mvPitch"] = pInvokes.fGlobal["$mvPitch"] + pitchAdj; //console.SetVar("$mvPitch", console.GetVarFloat("$mvPitch") + pitchAdj); } [ConsoleInteraction(true)] public static void Jump(string val) { - omni.iGlobal["$mvTriggerCount2"] = omni.iGlobal["$mvTriggerCount2"] + 1; + pInvokes.iGlobal["$mvTriggerCount2"] = pInvokes.iGlobal["$mvTriggerCount2"] + 1; //console.SetVar("$mvTriggerCount2", console.GetVarInt("$mvTriggerCount2") + 1); } @@ -401,15 +399,15 @@ public static void gamePadMoveX(double val) { if (val > 0) { - omni.dGlobal["$mvRightAction"] = val*movementSpeed; - omni.dGlobal["$mvLeftAction"] = 0; + pInvokes.dGlobal["$mvRightAction"] = val*movementSpeed; + pInvokes.dGlobal["$mvLeftAction"] = 0; //console.SetVar("$mvRightAction", (val * movementSpeed).AsString()); //console.SetVar("$mvLeftAction", 0); } else { - omni.dGlobal["$mvRightAction"] = 0; - omni.dGlobal["$mvLeftAction"] = -val*movementSpeed; + pInvokes.dGlobal["$mvRightAction"] = 0; + pInvokes.dGlobal["$mvLeftAction"] = -val*movementSpeed; //console.SetVar("$mvRightAction", 0); //console.SetVar("$mvLeftAction", (-val * movementSpeed).AsString()); } @@ -420,16 +418,16 @@ public static void gamePadMoveY(double val) { if (val > 0) { - omni.dGlobal["$mvForwardAction"] = val*movementSpeed; - omni.dGlobal["$mvBackwardAction"] = 0; + pInvokes.dGlobal["$mvForwardAction"] = val*movementSpeed; + pInvokes.dGlobal["$mvBackwardAction"] = 0; //console.SetVar("$mvForwardAction", val.AsDouble() * movementSpeed); //console.SetVar("$mvBackwardAction", 0); } else { - omni.dGlobal["$mvForwardAction"] = 0; + pInvokes.dGlobal["$mvForwardAction"] = 0; //console.SetVar("$mvForwardAction", 0); - omni.dGlobal["$mvBackwardAction"] = -val*movementSpeed; + pInvokes.dGlobal["$mvBackwardAction"] = -val*movementSpeed; //console.SetVar("$mvBackwardAction", -val.AsDouble() * movementSpeed); } } @@ -440,22 +438,22 @@ public static void gamepadYaw(float val) float yawAdj = getGamepadAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera()) { - yawAdj = omni.Util.mClamp(yawAdj, (float) (-omni.Util.m2Pi() + 0.01), (float) (omni.Util.m2Pi() - 0.01)); + yawAdj = pInvokes.Util.mClamp(yawAdj, (float) (-pInvokes.Util.m2Pi() + 0.01), (float) (pInvokes.Util.m2Pi() - 0.01)); yawAdj *= (float) 0.5; } if (yawAdj > 0) { - omni.fGlobal["$mvYawLeftSpeed"] = yawAdj; - omni.fGlobal["$mvYawRightSpeed"] = 0; + pInvokes.fGlobal["$mvYawLeftSpeed"] = yawAdj; + pInvokes.fGlobal["$mvYawRightSpeed"] = 0; //console.SetVar("$mvYawLeftSpeed", yawAdj); //console.SetVar("$mvYawRightSpeed", 0); } else { - omni.fGlobal["$mvYawLeftSpeed"] = 0; + pInvokes.fGlobal["$mvYawLeftSpeed"] = 0; //console.SetVar("$mvYawLeftSpeed", 0); - omni.fGlobal["$mvYawRightSpeed"] = -yawAdj; + pInvokes.fGlobal["$mvYawRightSpeed"] = -yawAdj; //console.SetVar("$mvYawRightSpeed", -yawAdj); } } @@ -466,20 +464,20 @@ public static void gamepadPitch(float val) float pitchAdj = getGamepadAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera()) { - pitchAdj = omni.Util.mClamp(pitchAdj, (float) (-omni.Util.m2Pi() + 0.01), (float) (omni.Util.m2Pi() - 0.01)); + pitchAdj = pInvokes.Util.mClamp(pitchAdj, (float) (-pInvokes.Util.m2Pi() + 0.01), (float) (pInvokes.Util.m2Pi() - 0.01)); pitchAdj *= (float) 0.5; } if (pitchAdj > 0) { - omni.fGlobal["$mvPitchDownSpeed"] = -pitchAdj; //- and + swap for INVERTED look - omni.fGlobal["$mvPitchUpSpeed"] = 0; + pInvokes.fGlobal["$mvPitchDownSpeed"] = -pitchAdj; //- and + swap for INVERTED look + pInvokes.fGlobal["$mvPitchUpSpeed"] = 0; //console.SetVar("$mvPitchDownSpeed", pitchAdj); //console.SetVar("$mvPitchUpSpeed", 0); } else { - omni.fGlobal["$mvPitchDownSpeed"] = 0; - omni.fGlobal["$mvPitchUpSpeed"] = pitchAdj; //- and + swap for INVERTED look + pInvokes.fGlobal["$mvPitchDownSpeed"] = 0; + pInvokes.fGlobal["$mvPitchUpSpeed"] = pitchAdj; //- and + swap for INVERTED look //console.SetVar("$mvPitchDownSpeed", 0); //console.SetVar("$mvPitchUpSpeed", -pitchAdj); } @@ -488,75 +486,75 @@ public static void gamepadPitch(float val) [ConsoleInteraction(true)] public static void doCrouch(string val) { - omni.iGlobal["$mvTriggerCount3"] += 1; + pInvokes.iGlobal["$mvTriggerCount3"] += 1; //console.SetVar("$mvTriggerCount3", console.GetVarString("$mvTriggerCount3").AsInt() + 1); } [ConsoleInteraction(true)] public static void doSprint(string val) { - omni.iGlobal["$mvTriggerCount5"] += 1; + pInvokes.iGlobal["$mvTriggerCount5"] += 1; //console.SetVar("$mvTriggerCount5", console.GetVarString("$mvTriggerCount5").AsInt() + 1); } [ConsoleInteraction(true)] public static void mouseFire(string val) { - omni.iGlobal["$mvTriggerCount0"] += 1; + pInvokes.iGlobal["$mvTriggerCount0"] += 1; //console.SetVar("$mvTriggerCount0", console.GetVarString("$mvTriggerCount0").AsInt() + 1); } [ConsoleInteraction(true)] public static void altTrigger(string val) { - omni.iGlobal["$mvTriggerCount1"] += 1; + pInvokes.iGlobal["$mvTriggerCount1"] += 1; //console.SetVar("$mvTriggerCount1", console.GetVarString("$mvTriggerCount1").AsInt() + 1); } [ConsoleInteraction(true)] public static void gamepadFire(double val) { - if (val > .1 && !omni.console.GetVarBool("$gamepadFireTriggered")) + if (val > .1 && !pInvokes.console.GetVarBool("$gamepadFireTriggered")) { - omni.bGlobal["$gamepadFireTriggered"] = true; - omni.Util.rumble("gamepad", (float) 0.25, (float) 0.25); //deviceName, Left Motor(low-frequency),Right Motor(high-frequency)//Rumble Start + pInvokes.bGlobal["$gamepadFireTriggered"] = true; + pInvokes.Util.rumble("gamepad", (float) 0.25, (float) 0.25); //deviceName, Left Motor(low-frequency),Right Motor(high-frequency)//Rumble Start //console.SetVar("$gamepadFireTriggered", true); //console.SetVar("$mvTriggerCount0", console.GetVarString("$mvTriggerCount0").AsInt() + 1); } else { - omni.bGlobal["$gamepadFireTriggered"] = false; - omni.Util.rumble("gamepad", 0, 0); + pInvokes.bGlobal["$gamepadFireTriggered"] = false; + pInvokes.Util.rumble("gamepad", 0, 0); //console.SetVar("$gamepadFireTriggered", false); //console.SetVar("$mvTriggerCount0", console.GetVarString("$mvTriggerCount0").AsInt() + 1); } - omni.iGlobal["$mvTriggerCount0"] += 1; + pInvokes.iGlobal["$mvTriggerCount0"] += 1; } [ConsoleInteraction(true)] public static void gamepadAltTrigger(double val) { - if (val > .1 && !omni.bGlobal["$gamepadFireTriggered"]) + if (val > .1 && !pInvokes.bGlobal["$gamepadFireTriggered"]) { - omni.bGlobal["$gamepadAltTriggerTriggered"] = true; + pInvokes.bGlobal["$gamepadAltTriggerTriggered"] = true; // console.SetVar("$gamepadAltTriggerTriggered", true); } else { - omni.bGlobal["$gamepadAltTriggerTriggered"] = false; + pInvokes.bGlobal["$gamepadAltTriggerTriggered"] = false; //console.SetVar("$gamepadAltTriggerTriggered", false); } - omni.iGlobal["$mvTriggerCount1"] += 1; + pInvokes.iGlobal["$mvTriggerCount1"] += 1; //console.SetVar("$mvTriggerCount1", console.GetVarString("$mvTriggerCount1").AsInt() + 1); } [ConsoleInteraction(true)] public static void toggleZoomFOV() { - float cfov = omni.fGlobal["$Player::CurrentFOV"]/(float) 2.0; + float cfov = pInvokes.fGlobal["$Player::CurrentFOV"]/(float) 2.0; - omni.console.SetVar("$Player::CurrentFOV", cfov); - omni.fGlobal["$Player::CurrentFOV"] = cfov; + pInvokes.console.SetVar("$Player::CurrentFOV", cfov); + pInvokes.fGlobal["$Player::CurrentFOV"] = cfov; if (cfov < 5) resetCurrentFOV(); @@ -564,9 +562,9 @@ public static void toggleZoomFOV() if (((GameConnection) "ServerConnection")["zoomed"].AsBool()) //console.GetVarBool("ServerConnection.zoomed")) - omni.console.Call("setFov", new[] {cfov.AsString()}); + pInvokes.console.Call("setFov", new[] {cfov.AsString()}); else - omni.console.Call("setFov", new[] {omni.console.GetVarString("ServerConnection.getControlCameraDefaultFov()")}); + pInvokes.console.Call("setFov", new[] {pInvokes.console.GetVarString("ServerConnection.getControlCameraDefaultFov()")}); } [ConsoleInteraction(true)] @@ -578,15 +576,15 @@ public static void mouseButtonZoom(bool val) [ConsoleInteraction(true)] public static void resetCurrentFOV() { - omni.fGlobal["$Player::CurrentFOV"] = ((GameConnection) "ServerConnection").getControlCameraDefaultFov()/2.0f; + pInvokes.fGlobal["$Player::CurrentFOV"] = ((GameConnection) "ServerConnection").getControlCameraDefaultFov()/2.0f; //console.SetVar("$Player::CurrentFOV", console.GetVarFloat("ServerConnection.getControlCameraDefaultFov") / (float)2.0); } [ConsoleInteraction(true)] public static void turnOffZoom() { - omni.console.SetVar("ServerConnection.zoomed", false); - omni.console.Call("setFov", new[] {((GameConnection) "ServerConnection").getControlCameraDefaultFov().AsString()}); + pInvokes.console.SetVar("ServerConnection.zoomed", false); + pInvokes.console.Call("setFov", new[] {((GameConnection) "ServerConnection").getControlCameraDefaultFov().AsString()}); ((GuiControl) "Reticle").setVisible(true); ((GuiControl) "zoomReticle").setVisible(false); @@ -605,8 +603,8 @@ public static void toggleZoom(bool val) { if (val) { - omni.console.SetVar("ServerConnection.zoomed", true); - omni.console.Call("setFov", new[] {omni.console.GetVarString("$Player::CurrentFOV")}); + pInvokes.console.SetVar("ServerConnection.zoomed", true); + pInvokes.console.Call("setFov", new[] {pInvokes.console.GetVarString("$Player::CurrentFOV")}); ((GuiControl) "Reticle").setVisible(false); ((GuiControl) "zoomReticle").setVisible(true); @@ -625,7 +623,7 @@ public static void toggleZoom(bool val) [ConsoleInteraction(true)] public static void toggleFreeLook(bool val) { - omni.bGlobal["$mvFreeLook"] = val; + pInvokes.bGlobal["$mvFreeLook"] = val; //console.SetVar("$mvFreeLook", val); } @@ -644,51 +642,51 @@ public static void toggleFirstPerson(bool val) public static void toggleCamera(bool val) { if (val) - omni.console.commandToServer("ToggleCamera"); + pInvokes.console.commandToServer("ToggleCamera"); } [ConsoleInteraction(true)] public static void unmountWeapon(bool val) { if (val) - omni.console.commandToServer("unmountWeapon"); + pInvokes.console.commandToServer("unmountWeapon"); } [ConsoleInteraction(true)] public static void throwWeapon(bool val) { if (val) - omni.console.commandToServer("Throw", new[] {"Weapon"}); + pInvokes.console.commandToServer("Throw", new[] {"Weapon"}); } [ConsoleInteraction(true)] public static void tossAmmo(bool val) { if (val) - omni.console.commandToServer("Throw", new[] {"Ammo"}); + pInvokes.console.commandToServer("Throw", new[] {"Ammo"}); } [ConsoleInteraction(true)] public static void nextWeapon(bool val) { if (val) - omni.console.commandToServer("cycleWeapon", new[] {"next"}); + pInvokes.console.commandToServer("cycleWeapon", new[] {"next"}); } [ConsoleInteraction(true)] public static void prevWeapon(bool val) { if (val) - omni.console.commandToServer("cycleWeapon", new[] {"prev"}); + pInvokes.console.commandToServer("cycleWeapon", new[] {"prev"}); } [ConsoleInteraction(true)] public static void mouseWheelWeaponCycle(double val) { if (val < 0) - omni.console.commandToServer("cycleWeapon", new[] {"next"}); + pInvokes.console.commandToServer("cycleWeapon", new[] {"next"}); else if (val > 0) - omni.console.commandToServer("cycleWeapon", new[] {"prev"}); + pInvokes.console.commandToServer("cycleWeapon", new[] {"prev"}); } [ConsoleInteraction(true)] @@ -716,28 +714,28 @@ public static void resizeMessageHud(bool val) public static void startRecordingDemo(bool val) { if (val) - omni.console.Call("StartDemoRecord"); + pInvokes.console.Call("StartDemoRecord"); } [ConsoleInteraction(true)] public static void stopRecordingDemo(bool val) { if (val) - omni.console.Call("StopDemoRecord"); + pInvokes.console.Call("StopDemoRecord"); } [ConsoleInteraction(true)] public static void dropCameraAtPlayer(bool val) { if (val) - omni.console.commandToServer("dropCameraAtPlayer"); + pInvokes.console.commandToServer("dropCameraAtPlayer"); } [ConsoleInteraction(true)] public static void dropPlayerAtCamera(bool val) { if (val) - omni.console.commandToServer("DropPlayerAtCamera"); + pInvokes.console.commandToServer("DropPlayerAtCamera"); } [ConsoleInteraction(true)] @@ -745,7 +743,7 @@ public static void bringUpOptions(bool val) { if (val) { - omni.console.Call("showCursor"); + pInvokes.console.Call("showCursor"); ((GuiCanvas) "Canvas").pushDialog("OptionsDlg"); } } @@ -829,15 +827,15 @@ public static void doProfile(bool val) { if (val) { - omni.console.print("Starting profile session..."); - omni.Util.profilerReset(); - omni.Util.profilerEnable(true); + pInvokes.console.print("Starting profile session..."); + pInvokes.Util.profilerReset(); + pInvokes.Util.profilerEnable(true); } else { - omni.console.print("Ending profile session..."); - omni.Util.profilerDumpToFile("profilerDumpToFile" + omni.console.Call("getSimTime") + ".txt"); - omni.Util.profilerEnable(false); + pInvokes.console.print("Ending profile session..."); + pInvokes.Util.profilerDumpToFile("profilerDumpToFile" + pInvokes.console.Call("getSimTime") + ".txt"); + pInvokes.Util.profilerEnable(false); } } @@ -845,7 +843,7 @@ public static void doProfile(bool val) public static void carjack() { Player player = ((GameConnection) "LocalClientConnection").getControlObject(); - if (omni.console.GetClassName(player) != "Player") + if (pInvokes.console.GetClassName(player) != "Player") return; Point3F eyeVec = player.getEyeVector(); @@ -853,12 +851,12 @@ public static void carjack() Point3F endPos = startPos + eyeVec.vectorScale(1000); - Player target = omni.Util.containerRayCast(startPos, endPos, (uint) SceneObjectTypesAsUint.VehicleObjectType, "", false); + Player target = pInvokes.Util.containerRayCast(startPos, endPos, (uint) SceneObjectTypesAsUint.VehicleObjectType, "", false); if (!target.isObject()) return; int mount = target.getMountNodeObject(0); - if (mount.AsBool() && omni.console.GetClassName(mount.AsString()) == "AIPlayer") - omni.console.commandToServer("carUnmountObj", new[] {mount.AsString()}); + if (mount.AsBool() && pInvokes.console.GetClassName(mount.AsString()) == "AIPlayer") + pInvokes.console.commandToServer("carUnmountObj", new[] {mount.AsString()}); } [ConsoleInteraction(true)] @@ -866,21 +864,21 @@ public static void getOut() { ((ActionMap) "vehicleMap").pop(); ((ActionMap) "moveMap").push(); - omni.console.commandToServer("dismountVehicle"); + pInvokes.console.commandToServer("dismountVehicle"); } [ConsoleInteraction(true)] public static void brakeLights() { - omni.console.commandToServer("toggleBrakeLights"); + pInvokes.console.commandToServer("toggleBrakeLights"); } [ConsoleInteraction(true)] public static void brake(string val) { - omni.console.commandToServer("toggleBrakeLights"); - omni.iGlobal["$mvTriggerCount2"] += 1; + pInvokes.console.commandToServer("toggleBrakeLights"); + pInvokes.iGlobal["$mvTriggerCount2"] += 1; //console.SetVar("$mvTriggerCount2", console.GetVarInt("$mvTriggerCount2") + 1); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/devHelpers.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/devHelpers.cs index 2377cdc2..74209be6 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/devHelpers.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/devHelpers.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Interopt; @@ -39,12 +39,10 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class devHelpers { - private static readonly pInvokes omni = new pInvokes(); - /// Shortcut for typing dbgSetParameters with the default values torsion uses. public static void dbgTorsion() { - omni.console.Call("dbgSetParameters", new string[] {"6060", "password", "false"}); + pInvokes.console.Call("dbgSetParameters", new string[] {"6060", "password", "false"}); } // Reset the input state to a default of all-keys-up. @@ -55,12 +53,12 @@ public static void mvReset() // for ( %i = 0; %i < 6; %i++ ) //setVariable( "mvTriggerCount" @ %i, 0 ); for (int i = 0; i < 6; i++) - omni.iGlobal["mvTriggerCount" + i] = 0; + pInvokes.iGlobal["mvTriggerCount" + i] = 0; - omni.iGlobal["$mvUpAction"] = 0; - omni.iGlobal["$mvDownAction"] = 0; - omni.iGlobal["$mvLeftAction"] = 0; - omni.iGlobal["$mvRightAction"] = 0; + pInvokes.iGlobal["$mvUpAction"] = 0; + pInvokes.iGlobal["$mvDownAction"] = 0; + pInvokes.iGlobal["$mvLeftAction"] = 0; + pInvokes.iGlobal["$mvRightAction"] = 0; } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/game.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/game.cs index 6c20c390..70531f92 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/game.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/game.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Demo.Full.Models.User.GameCode.Client.Audio; @@ -43,8 +43,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class game { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void ClientCmdGameEnd(string endgamepause) { @@ -69,7 +67,7 @@ public static void ClientCmdGameEnd(string endgamepause) ((GuiCanvas) "Canvas").setContent("EndGameGui"); if (endgamepause.AsInt() > 0) - omni.Util._schedule((endgamepause.AsInt()*1000).AsString(), "0", "ShowLoading"); + pInvokes.Util._schedule((endgamepause.AsInt()*1000).AsString(), "0", "ShowLoading"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/init.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/init.cs index ed2e6e11..d9054662 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/init.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/init.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -52,19 +52,17 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class init { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void initClient() { - omni.console.print("\n--------- Initializing " + omni.sGlobal["$appName"] + ": Client Scripts ---------"); + pInvokes.console.print("\n--------- Initializing " + pInvokes.sGlobal["$appName"] + ": Client Scripts ---------"); // Make sure this variable reflects the correct state. - omni.bGlobal["$Server::Dedicated"] = false; + pInvokes.bGlobal["$Server::Dedicated"] = false; // Game information used to query the master server - omni.sGlobal["$Client::GameTypeQuery"] = omni.sGlobal["$appName"]; - omni.sGlobal["$Client::MissionTypeQuery"] = "Any"; + pInvokes.sGlobal["$Client::GameTypeQuery"] = pInvokes.sGlobal["$appName"]; + pInvokes.sGlobal["$Client::MissionTypeQuery"] = "Any"; // These should be game specific GuiProfiles. Custom profiles are saved out // from the Gui Editor. Either of these may override any that already exist. @@ -78,39 +76,39 @@ public static void initClient() canvas.configureCanvas(); // Load up the Game GUIs - //omni.Util.exec("art/gui/PlayGui.gui", false, false); + //pInvokes.Util.exec("art/gui/PlayGui.gui", false, false); playGui.initialize(); - //omni.Util.exec("art/gui/ChatHud.gui", false, false); + //pInvokes.Util.exec("art/gui/ChatHud.gui", false, false); MessageHud.initialize(); - //omni.Util.exec("art/gui/playerList.gui", false, false); + //pInvokes.Util.exec("art/gui/playerList.gui", false, false); PlayerListGui.initializeGui(); - //omni.Util.exec("art/gui/hudlessGui.gui", false, false); + //pInvokes.Util.exec("art/gui/hudlessGui.gui", false, false); hudlessGui.initialize(); // Load up the shell GUIs - //omni.Util.exec("art/gui/mainMenuGui.gui", false, false); + //pInvokes.Util.exec("art/gui/mainMenuGui.gui", false, false); mainMenuGui.initialize(); - //omni.Util.exec("art/gui/joinServerDlg.gui", false, false); + //pInvokes.Util.exec("art/gui/joinServerDlg.gui", false, false); JoinServerDlg.initialize(); - //omni.Util.exec("art/gui/endGameGui.gui", false, false); + //pInvokes.Util.exec("art/gui/endGameGui.gui", false, false); endGameGui.initialize(); - //omni.Util.exec("art/gui/StartupGui.gui", false, false); + //pInvokes.Util.exec("art/gui/StartupGui.gui", false, false); startupGui.initialize(); - //omni.Util.exec("art/gui/chooseLevelDlg.gui", false, false); + //pInvokes.Util.exec("art/gui/chooseLevelDlg.gui", false, false); //chooseLevelDlg.Initialize(); - //omni.Util.exec("art/gui/loadingGui.gui", false, false); + //pInvokes.Util.exec("art/gui/loadingGui.gui", false, false); loadingGui.initialize(); - //omni.Util.exec("art/gui/optionsDlg.gui", false, false); + //pInvokes.Util.exec("art/gui/optionsDlg.gui", false, false); OptionsDlg.initialize(); ToolsDlg.initialize(); @@ -119,13 +117,13 @@ public static void initClient() ContentBrowserGui.initialize(); - //omni.Util.exec("art/gui/remapDlg.gui", false, false); + //pInvokes.Util.exec("art/gui/remapDlg.gui", false, false); RemapDlg.initialize(); // Gui scripts PlayerListGui.initialize(); chatHud.initialize(); - //omni.Util.exec("scripts/gui/optionsDlg.cs", false, false); + //pInvokes.Util.exec("scripts/gui/optionsDlg.cs", false, false); Misc.initialize(); // Client scripts @@ -136,8 +134,8 @@ public static void initClient() // Default player key bindings defaultBind.initialize(); - if (omni.Util.isFile("scripts/client/config.cs")) - omni.Util.exec("scripts/client/config.cs", false, false); + if (pInvokes.Util.isFile("scripts/client/config.cs")) + pInvokes.Util.exec("scripts/client/config.cs", false, false); //string[] files = Directory.GetFiles( System.IO.Path.Combine( AppDomain.CurrentDomain.BaseDirectory,@"art\gui"), "*.png", SearchOption.AllDirectories); //foreach (string file in files) @@ -166,31 +164,31 @@ public static void initClient() // going to connect to a remote server, or host a multi-player // game. - omni.Util.setNetPort(0, false); + pInvokes.Util.setNetPort(0, false); - omni.console.Call("setDefaultFov", new[] {omni.sGlobal["$pref::Player::defaultFov"]}); - omni.console.Call("setZoomSpeed", new[] {omni.sGlobal["$pref::Player::zoomSpeed"]}); + pInvokes.console.Call("setDefaultFov", new[] {pInvokes.sGlobal["$pref::Player::defaultFov"]}); + pInvokes.console.Call("setZoomSpeed", new[] {pInvokes.sGlobal["$pref::Player::zoomSpeed"]}); audioData.initialize(); // Start up the main menu... this is separated out into a // method for easier mod override - if (omni.bGlobal["$startWorldEditor"] || omni.bGlobal["$startGUIEditor"]) + if (pInvokes.bGlobal["$startWorldEditor"] || pInvokes.bGlobal["$startGUIEditor"]) // Editor GUI's will start up in the primary main.cs once // engine is initialized. return; - if (omni.sGlobal["$JoinGameAddress"] != "") + if (pInvokes.sGlobal["$JoinGameAddress"] != "") { loadLoadingGui("loadLoadingGui"); - missionDownload.connect(omni.sGlobal["$JoinGameAddress"]); + missionDownload.connect(pInvokes.sGlobal["$JoinGameAddress"]); } else { // Otherwise go to the splash screen. ((GuiCanvas) "canvas").setCursor("DefaultCursor"); startupGui.loadStartup(); - //omni.console.Call("loadStartup"); + //pInvokes.console.Call("loadStartup"); } } @@ -205,20 +203,20 @@ public static void loadMainMenu() // first check if we have a level file to load - if (omni.sGlobal["$levelToLoad"] != "") + if (pInvokes.sGlobal["$levelToLoad"] != "") { string levelfile = "levels/"; - if (!omni.sGlobal["$levelToLoad"].EndsWith(".mis")) - levelfile += omni.sGlobal["$levelToLoad"] + ".mis"; + if (!pInvokes.sGlobal["$levelToLoad"].EndsWith(".mis")) + levelfile += pInvokes.sGlobal["$levelToLoad"] + ".mis"; else - levelfile += omni.sGlobal["$levelToLoad"]; + levelfile += pInvokes.sGlobal["$levelToLoad"]; // Clear out the $levelToLoad so we don't attempt to load the level again // later on. - omni.sGlobal["$levelToLoad"] = ""; + pInvokes.sGlobal["$levelToLoad"] = ""; - string file = omni.Util.findFirstFile(levelfile, false); + string file = pInvokes.Util.findFirstFile(levelfile, false); if (file != "") server.createAndConnectToLocalServer("SinglePlayer", file); } @@ -238,4 +236,4 @@ public static void loadLoadingGui(string displayText) ((GuiCanvas) "Canvas").repaint(0); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting.cs index 6f97e348..432e86cf 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Interopt; @@ -40,35 +40,33 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class lighting { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void initLightingSystems() { - omni.console.print("\n--------- Initializing Lighting Systems ---------"); + pInvokes.console.print("\n--------- Initializing Lighting Systems ---------"); - omni.console.print("\n--------- Initializing Advanced Lighting ---------"); + pInvokes.console.print("\n--------- Initializing Advanced Lighting ---------"); Lighting.advanced.init.initialize(); - omni.console.print("\n--------- Initializing Basic Lighting ---------"); + pInvokes.console.print("\n--------- Initializing Basic Lighting ---------"); Lighting.basic.init.initialize(); - omni.console.print("\n--------- Initializing ShadowMaps Lighting ---------"); + pInvokes.console.print("\n--------- Initializing ShadowMaps Lighting ---------"); Lighting.shadowMaps.init.initialize(); - omni.console.print("\n--------- Finished Initializing Advanced Lighting ---------"); + pInvokes.console.print("\n--------- Finished Initializing Advanced Lighting ---------"); // Try the perfered one first. - bool success = omni.Util.setLightManager(omni.sGlobal["$pref::lightManager"]); + bool success = pInvokes.Util.setLightManager(pInvokes.sGlobal["$pref::lightManager"]); if (!success) { // The perfered one fell thru... so go thru the default // light managers until we find one that works. - int lmCount = omni.Util.getFieldCount(omni.sGlobal["$lightManager::defaults"]); + int lmCount = pInvokes.Util.getFieldCount(pInvokes.sGlobal["$lightManager::defaults"]); for (int i = 0; i < lmCount; i++) { - string lmName = omni.Util.getField(omni.sGlobal["$lightManager::defaults"], i); - success = omni.Util.setLightManager(lmName); + string lmName = pInvokes.Util.getField(pInvokes.sGlobal["$lightManager::defaults"], i); + success = pInvokes.Util.setLightManager(lmName); if (success) break; } @@ -76,31 +74,31 @@ public static void initLightingSystems() // Did we completely fail to initialize a light manager? if (!success) { - // If we completely failed to initialize a light + // If we completely failed to initialize a light // manager then the 3d scene cannot be rendered. - //t3d.Util.quitWithErrorMessage("Failed to set a light manager!"); + //pInvokes.Util.quitWithErrorMessage("Failed to set a light manager!"); Main.quitWithErrorMessage("Failed to set a light manager!"); } - omni.console.print("\n"); + pInvokes.console.print("\n"); } [ConsoleInteraction(true)] public static void onLightManagerActivate(string lmName) { - omni.sGlobal["$pref::lightManager"] = lmName; - omni.console.print("Using " + lmName); + pInvokes.sGlobal["$pref::lightManager"] = lmName; + pInvokes.console.print("Using " + lmName); string activateNewFn = "onActivate" + lmName.Split(' ')[0] + "LM"; - if (omni.console.isFunction(activateNewFn)) - omni.console.Call(activateNewFn); + if (pInvokes.console.isFunction(activateNewFn)) + pInvokes.console.Call(activateNewFn); } [ConsoleInteraction(true)] public static void onLightManagerDeactivate(string lmName) { string deactivateOldfn = "onDeactivate" + lmName.Split(' ')[0] + "LM"; - if (omni.console.isFunction(deactivateOldfn)) - omni.console.Call(deactivateOldfn); + if (pInvokes.console.isFunction(deactivateOldfn)) + pInvokes.console.Call(deactivateOldfn); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/init.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/init.cs index 9ac6b907..443172ef 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/init.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/init.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Decorations; @@ -41,8 +41,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced { public class init { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { shaders.initialize(); @@ -53,9 +51,9 @@ public static void initialize() [ConsoleInteraction(true)] public static void onActivateAdvancedLM() { - if (omni.sGlobal["$platform"] == "macos") + if (pInvokes.sGlobal["$platform"] == "macos") return; - if (omni.sGlobal["$platform"] == "xenon") + if (pInvokes.sGlobal["$platform"] == "xenon") return; ((RenderFormatToken) "AL_FormatToken").enable(); } @@ -69,7 +67,7 @@ public static void onDeactivateAdvancedLM() [ConsoleInteraction(true)] public static void setAdvancedLighting() { - omni.Util.setLightManager("Advanced Lighting"); + pInvokes.Util.setLightManager("Advanced Lighting"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/lightViz.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/lightViz.cs index 97c0726c..7885247c 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/lightViz.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/lightViz.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Demo.Full.Models.User.GameCode.Client.PostEffects.Shaders; @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced { public class lightViz { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { ObjectCreator tch = new ObjectCreator("GFXStateBlockData", "AL_DepthVisualizeState"); @@ -54,7 +52,7 @@ public static void initialize() tch["zWriteEnable"] = false; tch["samplersDefined"] = true; - tch["samplerStates[0]"] = "SamplerClampPoint"; // depth + tch["samplerStates[0]"] = "SamplerClampPoint"; // depth tch["samplerStates[1]"] = "SamplerClampLinear"; // viz color lookup tch.Create(); @@ -134,7 +132,7 @@ public static void toggleDepthViz(string enabled) { if (enabled == "") { - omni.bGlobal["$AL_DepthVisualizeVar"] = !((PostEffect) "AL_DepthVisualize").isEnabled; + pInvokes.bGlobal["$AL_DepthVisualizeVar"] = !((PostEffect) "AL_DepthVisualize").isEnabled; ((PostEffect) "AL_DepthVisualize").toggle(); } else if (enabled.AsBool()) @@ -148,7 +146,7 @@ public static void toggleNormalsViz(string enabled) { if (enabled == "") { - omni.bGlobal["$AL_NormalsVisualizeVar"] = !((PostEffect) "AL_NormalsVisualize").isEnabled; + pInvokes.bGlobal["$AL_NormalsVisualizeVar"] = !((PostEffect) "AL_NormalsVisualize").isEnabled; ((PostEffect) "AL_NormalsVisualize").toggle(); } else if (enabled.AsBool()) @@ -162,7 +160,7 @@ public static void toggleLightColorViz(string enabled) { if (enabled == "") { - omni.bGlobal["$AL_LightColorVisualizeVar"] = !((PostEffect) "AL_LightColorVisualize").isEnabled; + pInvokes.bGlobal["$AL_LightColorVisualizeVar"] = !((PostEffect) "AL_LightColorVisualize").isEnabled; ((PostEffect) "AL_LightColorVisualize").toggle(); } else if (enabled.AsBool()) @@ -176,7 +174,7 @@ public static void toggleLightSpecularViz(string enabled) { if (enabled == "") { - omni.bGlobal["$AL_LightSpecularVisualizeVar"] = !((PostEffect) "AL_LightSpecularVisualize").isEnabled; + pInvokes.bGlobal["$AL_LightSpecularVisualizeVar"] = !((PostEffect) "AL_LightSpecularVisualize").isEnabled; ((PostEffect) "AL_LightSpecularVisualize").toggle(); } else if (enabled.AsBool()) @@ -185,4 +183,4 @@ public static void toggleLightSpecularViz(string enabled) ((PostEffect) "AL_LightSpecularVisualize").disable(); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shaders.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shaders.cs index a72ad907..3e034dd8 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shaders.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shaders.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; @@ -40,8 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced { public class shaders { - public static readonly pInvokes omni = new pInvokes(); - public static void initialize() { ObjectCreator tch = new ObjectCreator("GFXStateBlockData", "AL_VectorLightState"); @@ -116,7 +114,7 @@ public static void initialize() tch["samplerStates[0]"] = "SamplerClampPoint"; // G-buffer tch["samplerStates[1]"] = "SamplerClampPoint"; // Shadow Map (Do not use linear, these are perspective projections) - tch["samplerStates[2]"] = "SamplerClampLinear"; // Cookie Map + tch["samplerStates[2]"] = "SamplerClampLinear"; // Cookie Map tch["samplerStates[3]"] = "SamplerWrapPoint"; // Random Direction Map tch["cullDefined"] = true; @@ -180,27 +178,27 @@ public static void initialize() tch.Create(); - // This material is used for generating prepass + // This material is used for generating prepass // materials for objects that do not have materials. tch = new ObjectCreator("Material", "AL_DefaultPrePassMaterial"); - // We need something in the first pass else it - // won't create a proper material instance. + // We need something in the first pass else it + // won't create a proper material instance. // // We use color here because some objects may not - // have texture coords in their vertex format... + // have texture coords in their vertex format... // for example like terrain. // tch["diffuseColor[0]"] = "1 1 1 1"; tch.Create(); - // This material is used for generating shadow + // This material is used for generating shadow // materials for objects that do not have materials. tch = new ObjectCreator("Material", "AL_DefaultShadowMaterial"); - // We need something in the first pass else it - // won't create a proper material instance. + // We need something in the first pass else it + // won't create a proper material instance. // // We use color here because some objects may not - // have texture coords in their vertex format... + // have texture coords in their vertex format... // for example like terrain. // tch["diffuseColor[0]"] = "1 1 1 1"; @@ -208,7 +206,7 @@ public static void initialize() // This is here mostly for terrain which uses // this material to create its shadow material. // - // At sunset/sunrise the sun is looking thru + // At sunset/sunrise the sun is looking thru // backsides of the terrain which often are not // closed. By changing the material to be double // sided we avoid holes in the shadowed geometry. @@ -238,4 +236,4 @@ public static void initialize() tch.Create(); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.cs index 743aebc3..62b037d9 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.cs @@ -36,6 +36,7 @@ using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; +using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced @@ -84,13 +85,13 @@ public static void toggleShadowViz() { if (((GuiControl) "AL_ShadowVizOverlayCtrl").isAwake()) { - omni.Util.setShadowVizLight("0"); + pInvokes.Util.setShadowVizLight("0"); ((GuiCanvas) "Canvas").popDialog("AL_ShadowVizOverlayCtrl"); } else { ((GuiCanvas) "Canvas").pushDialog("AL_ShadowVizOverlayCtrl", 100); - _setShadowVizLight(omni.console.Call("EWorldEditor", "getSelectedObject", new[] {"0"}), false); + _setShadowVizLight(pInvokes.console.Call("EWorldEditor", "getSelectedObject", new[] {"0"}), false); } } @@ -110,16 +111,16 @@ public static void _setShadowVizLight(string light, bool force) //todo Got a bug here I think, don't know enough about lighting to debug it at the moment. the sizeAndAspect is always blank. string clientLight = client.serverToClientObject(light.AsInt()).AsString(); //console.Call("serverToClientObject", new string[] { light }); - sizeAndAspect = omni.Util.setShadowVizLight(clientLight); + sizeAndAspect = pInvokes.Util.setShadowVizLight(clientLight); } - omni.console.Call(AL_ShadowVizOverlayCtrl.findObjectByInternalName("MatCtrl", true), "setMaterial", new[] {"AL_ShadowVisualizeMaterial"}); + pInvokes.console.Call(AL_ShadowVizOverlayCtrl.findObjectByInternalName("MatCtrl", true), "setMaterial", new[] {"AL_ShadowVisualizeMaterial"}); string text = "ShadowViz"; if (light.isObject() && sizeAndAspect != "") text = text + ":" + sizeAndAspect.Split(' ')[0] + " x " + sizeAndAspect.Split(' ')[1]; - omni.console.SetVar(AL_ShadowVizOverlayCtrl.findObjectByInternalName("WindowCtrl", true), text); + pInvokes.console.SetVar(AL_ShadowVizOverlayCtrl.findObjectByInternalName("WindowCtrl", true), text); } [ConsoleInteraction(true)] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.gui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.gui.cs index babc4095..2904353c 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.gui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/advanced/shadowViz.gui.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Interopt; @@ -39,11 +39,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.advanced { public partial class shadowViz { - private static readonly pInvokes omni = new pInvokes(); - public static void Initialize_Gui() { - omni.console.Eval(@" + pInvokes.console.Eval(@" %guiContent = new GuiControl(AL_ShadowVizOverlayCtrl) { canSaveDynamicFields = ""0""; isContainer = ""1""; @@ -119,4 +117,4 @@ public static void Initialize_Gui() "); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/basic/init.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/basic/init.cs index ecf219ff..cd8b7caf 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/basic/init.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/lighting/basic/init.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Decorations; @@ -43,13 +43,11 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client.Lighting.basic { public class init { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.console.print("\n--------- Initializing Shadow Filter ---------"); + pInvokes.console.print("\n--------- Initializing Shadow Filter ---------"); shadowFilter.initialize(); - omni.console.print("\n--------- Finished Initializing Shadow Filter ---------"); + pInvokes.console.print("\n--------- Finished Initializing Shadow Filter ---------"); SingletonCreator ts = new SingletonCreator("GFXStateBlockData", "BL_ProjectedShadowSBData"); ts["blendDefined"] = true; @@ -90,7 +88,7 @@ public static void initialize() public static void onActivateBasicLM() { // If HDR is enabled... enable the special format token. - if ((omni.sGlobal["$platform"] == "macos") || ((PostEffect) "HDRPostFx").isEnabledX()) + if ((pInvokes.sGlobal["$platform"] == "macos") || ((PostEffect) "HDRPostFx").isEnabledX()) ((RenderFormatToken) "AL_FormatToken").enable(); // Create render pass for projected shadow. @@ -119,7 +117,7 @@ public static void onDeactivateBasicLM() [ConsoleInteraction(true)] public static void setBasicLighting() { - omni.Util.setLightManager("Basic Lighting"); + pInvokes.Util.setLightManager("Basic Lighting"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/message.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/message.cs index ad646684..84a11fa4 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/message.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/message.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; @@ -49,8 +49,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client // This just invokes onChatMessage, which the mod code must define. public class message { - private static readonly pInvokes omni = new pInvokes(); - // Game event descriptions, which may or may not include text messages, can be // sent using the message* functions in core/scripts/server/message.cs. Those // functions do commandToClient with the tag ServerMessage, which invokes the @@ -61,7 +59,7 @@ public class message [ConsoleInteraction(true)] public static void clientCmdChatMessage(string sender, string voice, string pitch, string msgString, string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10) { - chatHud.OnChatMessage(omni.Util.detag(msgString), voice, pitch); + chatHud.OnChatMessage(pInvokes.Util.detag(msgString), voice, pitch); } // Called by the client to install a callback for a particular type of @@ -73,24 +71,24 @@ public static void clientCmdServerMessage(string msgType, string msgString, stri string funct; int i = 0; - funct = omni.console.GetVarString(@"$MSGCB["""", " + i.AsString() + "]"); + funct = pInvokes.console.GetVarString(@"$MSGCB["""", " + i.AsString() + "]"); while (funct != "") { - omni.console.Call(funct, new[] {msgType, msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10}); + pInvokes.console.Call(funct, new[] {msgType, msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10}); i++; - funct = omni.console.GetVarString(@"$MSGCB["""", " + i.AsString() + "]"); + funct = pInvokes.console.GetVarString(@"$MSGCB["""", " + i.AsString() + "]"); } // Next look for a callback for this particular type of ServerMessage. if (tag == "") return; i = 0; - funct = omni.console.GetVarString(@"$MSGCB[""" + tag + @""", " + i.AsString() + "]"); + funct = pInvokes.console.GetVarString(@"$MSGCB[""" + tag + @""", " + i.AsString() + "]"); while (funct != "") { - omni.console.Call(funct, new[] {msgType, msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10}); + pInvokes.console.Call(funct, new[] {msgType, msgString, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10}); i++; - funct = omni.console.GetVarString(@"$MSGCB[""" + tag + @""", " + i.AsString() + "]"); + funct = pInvokes.console.GetVarString(@"$MSGCB[""" + tag + @""", " + i.AsString() + "]"); } } @@ -101,16 +99,16 @@ public static void clientCmdServerMessage(string msgType, string msgString, stri // This just invokes onServerMessage, which can be overridden by the game //static internal void OnServerMessage(string a, string b = "", string c = "", string d = "", string e = "", string f = "", string g = "", string h = "", string i = "") // { - // omni.console.print("onServerMessage: "); - // if (a != "") omni.console.print(" +- a: " + a); - // if (b != "") omni.console.print(" +- b: " + b); - // if (c != "") omni.console.print(" +- c: " + c); - // if (d != "") omni.console.print(" +- d: " + d); - // if (e != "") omni.console.print(" +- e: " + e); - // if (f != "") omni.console.print(" +- f: " + f); - // if (g != "") omni.console.print(" +- g: " + g); - // if (h != "") omni.console.print(" +- h: " + h); - // if (i != "") omni.console.print(" +- i: " + i); + // pInvokes.console.print("onServerMessage: "); + // if (a != "") pInvokes.console.print(" +- a: " + a); + // if (b != "") pInvokes.console.print(" +- b: " + b); + // if (c != "") pInvokes.console.print(" +- c: " + c); + // if (d != "") pInvokes.console.print(" +- d: " + d); + // if (e != "") pInvokes.console.print(" +- e: " + e); + // if (f != "") pInvokes.console.print(" +- f: " + f); + // if (g != "") pInvokes.console.print(" +- g: " + g); + // if (h != "") pInvokes.console.print(" +- h: " + h); + // if (i != "") pInvokes.console.print(" +- i: " + i); // } [ConsoleInteraction(true)] @@ -121,21 +119,21 @@ public static void addMessageCallback(string msgType, string func) //msgType = msgType.Trim(); string afunc = ""; int i = 0; - afunc = omni.console.GetVarString("$MSGCB[\"" + msgType + "\", " + i.AsString() + "]"); + afunc = pInvokes.console.GetVarString("$MSGCB[\"" + msgType + "\", " + i.AsString() + "]"); while (afunc != "") { if (afunc == func) return; i++; - afunc = omni.console.GetVarString("$MSGCB[\"" + msgType + "\", " + i.AsString() + "]"); + afunc = pInvokes.console.GetVarString("$MSGCB[\"" + msgType + "\", " + i.AsString() + "]"); } - omni.console.SetVar("$MSGCB[\"" + msgType + "\", " + i.AsString() + "]", func); + pInvokes.console.SetVar("$MSGCB[\"" + msgType + "\", " + i.AsString() + "]", func); } [ConsoleInteraction(true)] public static void defaultMessageCallback(string msgType, string msgString, string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10) { - chatHud.OnServerMessage(omni.Util.detag(msgString)); + chatHud.OnServerMessage(pInvokes.Util.detag(msgString)); } public static void initialize() @@ -143,4 +141,4 @@ public static void initialize() addMessageCallback("", "defaultMessageCallback"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/metrics.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/metrics.cs index 01a2a4e7..1a7308fd 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/metrics.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/metrics.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using System.Text; using WinterLeaf.Demo.Full.Models.User.Extendable; @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class metrics { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { //con.error("------------------------>LOADING FRAMEOVERLAYGUI!!!!!!!!!!!!!!!!!!!!!"); @@ -58,16 +56,16 @@ public static string fpsMetricsCallback() { StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | FPS | "); - outtext.Append(omni.sGlobal["$fps::real"] + " max: "); - outtext.Append(omni.sGlobal["$fps::realMax"] + " min: "); - outtext.Append(omni.sGlobal["$fps::realMin"] + " mspf: "); - outtext.Append((1000.0/omni.dGlobal["$fps::real"])); + outtext.Append(pInvokes.sGlobal["$fps::real"] + " max: "); + outtext.Append(pInvokes.sGlobal["$fps::realMax"] + " min: "); + outtext.Append(pInvokes.sGlobal["$fps::realMin"] + " mspf: "); + outtext.Append((1000.0/pInvokes.dGlobal["$fps::real"])); return outtext.ToString(); //return " | FPS | " + - // t3d.sGlobal["$fps::real"] + " max: " + - // t3d.sGlobal["$fps::realMax"] + " min: " + - // t3d.sGlobal["$fps::realMin"] + " mspf: " + - // (1000.0 / t3d.dGlobal["$fps::real"]); + // pInvokes.sGlobal["$fps::real"] + " max: " + + // pInvokes.sGlobal["$fps::realMax"] + " min: " + + // pInvokes.sGlobal["$fps::realMin"] + " mspf: " + + // (1000.0 / pInvokes.dGlobal["$fps::real"]); } [ConsoleInteraction(true)] @@ -76,20 +74,20 @@ public static string gfxMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | GFX |"); outtext.Append(" PolyCount: "); - outtext.Append(omni.sGlobal["$GFXDeviceStatistics::polyCount"]); + outtext.Append(pInvokes.sGlobal["$GFXDeviceStatistics::polyCount"]); outtext.Append(" DrawCalls: "); - outtext.Append(omni.sGlobal["$GFXDeviceStatistics::drawCalls"]); + outtext.Append(pInvokes.sGlobal["$GFXDeviceStatistics::drawCalls"]); outtext.Append(" RTChanges: "); - outtext.Append(omni.sGlobal["$GFXDeviceStatistics::renderTargetChanges"]); + outtext.Append(pInvokes.sGlobal["$GFXDeviceStatistics::renderTargetChanges"]); return outtext.ToString(); - //return " | GFX |" + - // " PolyCount: " + - // t3d.sGlobal["$GFXDeviceStatistics::polyCount"] + - // " DrawCalls: " + - // t3d.sGlobal["$GFXDeviceStatistics::drawCalls"] + - // " RTChanges: " + - // t3d.sGlobal["$GFXDeviceStatistics::renderTargetChanges"]; + //return " | GFX |" + + // " PolyCount: " + + // pInvokes.sGlobal["$GFXDeviceStatistics::polyCount"] + + // " DrawCalls: " + + // pInvokes.sGlobal["$GFXDeviceStatistics::drawCalls"] + + // " RTChanges: " + + // pInvokes.sGlobal["$GFXDeviceStatistics::renderTargetChanges"]; } [ConsoleInteraction(true)] @@ -98,20 +96,20 @@ public static string terrainMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Terrain |"); outtext.Append(" Cells: "); - outtext.Append(omni.sGlobal["$TerrainBlock::cellsRendered"]); + outtext.Append(pInvokes.sGlobal["$TerrainBlock::cellsRendered"]); outtext.Append(" Override Cells: "); - outtext.Append(omni.sGlobal["$TerrainBlock::overrideCells"]); + outtext.Append(pInvokes.sGlobal["$TerrainBlock::overrideCells"]); outtext.Append(" DrawCalls: "); - outtext.Append(omni.sGlobal["$TerrainBlock::drawCalls"]); + outtext.Append(pInvokes.sGlobal["$TerrainBlock::drawCalls"]); return outtext.ToString(); - //return - // " | Terrain |" + - // " Cells: " + - // t3d.sGlobal["$TerrainBlock::cellsRendered"] + - // " Override Cells: " + - // t3d.sGlobal["$TerrainBlock::overrideCells"] + - // " DrawCalls: " + - // t3d.sGlobal["$TerrainBlock::drawCalls"]; + //return + // " | Terrain |" + + // " Cells: " + + // pInvokes.sGlobal["$TerrainBlock::cellsRendered"] + + // " Override Cells: " + + // pInvokes.sGlobal["$TerrainBlock::overrideCells"] + + // " DrawCalls: " + + // pInvokes.sGlobal["$TerrainBlock::drawCalls"]; } [ConsoleInteraction(true)] @@ -120,21 +118,21 @@ public static string netMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Net |"); outtext.Append(" BitsSent: "); - outtext.Append(omni.sGlobal["$Stats::netBitsSent"]); + outtext.Append(pInvokes.sGlobal["$Stats::netBitsSent"]); outtext.Append(" BitsRcvd: "); - outtext.Append(omni.sGlobal["$Stats::netBitsReceived"]); + outtext.Append(pInvokes.sGlobal["$Stats::netBitsReceived"]); outtext.Append(" GhostUpd: "); - outtext.Append(omni.sGlobal["$Stats::netGhostUpdates"]); + outtext.Append(pInvokes.sGlobal["$Stats::netGhostUpdates"]); return outtext.ToString(); - //return - // " | Net |" + - // " BitsSent: " + - // t3d.sGlobal["$Stats::netBitsSent"] + - // " BitsRcvd: " + - // t3d.sGlobal["$Stats::netBitsReceived"] + - // " GhostUpd: " + - // t3d.sGlobal["$Stats::netGhostUpdates"]; + //return + // " | Net |" + + // " BitsSent: " + + // pInvokes.sGlobal["$Stats::netBitsSent"] + + // " BitsRcvd: " + + // pInvokes.sGlobal["$Stats::netBitsReceived"] + + // " GhostUpd: " + + // pInvokes.sGlobal["$Stats::netGhostUpdates"]; } [ConsoleInteraction(true)] @@ -143,25 +141,25 @@ public static string groundCoverMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | GroundCover |"); outtext.Append(" Cells: "); - outtext.Append(omni.sGlobal["$GroundCover::renderedCells"]); + outtext.Append(pInvokes.sGlobal["$GroundCover::renderedCells"]); outtext.Append(" Billboards: "); - outtext.Append(omni.sGlobal["$GroundCover::renderedBillboards"]); + outtext.Append(pInvokes.sGlobal["$GroundCover::renderedBillboards"]); outtext.Append(" Batches: "); - outtext.Append(omni.sGlobal["$GroundCover::renderedBatches"]); + outtext.Append(pInvokes.sGlobal["$GroundCover::renderedBatches"]); outtext.Append(" Shapes: "); - outtext.Append(omni.sGlobal["$GroundCover::renderedShapes"]); + outtext.Append(pInvokes.sGlobal["$GroundCover::renderedShapes"]); return outtext.ToString(); - //return - // " | GroundCover |" + - // " Cells: " + - // t3d.sGlobal["$GroundCover::renderedCells"] + - // " Billboards: " + - // t3d.sGlobal["$GroundCover::renderedBillboards"] + - // " Batches: " + - // t3d.sGlobal["$GroundCover::renderedBatches"] + - // " Shapes: " + - // t3d.sGlobal["$GroundCover::renderedShapes"]; + //return + // " | GroundCover |" + + // " Cells: " + + // pInvokes.sGlobal["$GroundCover::renderedCells"] + + // " Billboards: " + + // pInvokes.sGlobal["$GroundCover::renderedBillboards"] + + // " Batches: " + + // pInvokes.sGlobal["$GroundCover::renderedBatches"] + + // " Shapes: " + + // pInvokes.sGlobal["$GroundCover::renderedShapes"]; } [ConsoleInteraction(true)] @@ -170,73 +168,73 @@ public static string sfxMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | SFX |"); outtext.Append(" Sounds: "); - outtext.Append(omni.sGlobal["$SFX::numSounds"]); + outtext.Append(pInvokes.sGlobal["$SFX::numSounds"]); outtext.Append(" Lists: "); - outtext.Append((omni.iGlobal["$SFX::numSources"] - omni.iGlobal["$SFX::numSounds"] - omni.iGlobal["$SFX::Device::fmodNumEventSource"])); + outtext.Append((pInvokes.iGlobal["$SFX::numSources"] - pInvokes.iGlobal["$SFX::numSounds"] - pInvokes.iGlobal["$SFX::Device::fmodNumEventSource"])); outtext.Append(" Events: "); - outtext.Append(omni.sGlobal["$SFX::fmodNumEventSources"]); + outtext.Append(pInvokes.sGlobal["$SFX::fmodNumEventSources"]); outtext.Append(" Playing: "); - outtext.Append(omni.sGlobal["$SFX::numPlaying"]); + outtext.Append(pInvokes.sGlobal["$SFX::numPlaying"]); outtext.Append(" Culled: "); - outtext.Append(omni.sGlobal["$SFX::numCulled"]); + outtext.Append(pInvokes.sGlobal["$SFX::numCulled"]); outtext.Append(" Voices: "); - outtext.Append(omni.sGlobal["$SFX::numVoices"]); + outtext.Append(pInvokes.sGlobal["$SFX::numVoices"]); outtext.Append(" Buffers: "); - outtext.Append(omni.sGlobal["$SFX::Device::numBuffers"]); + outtext.Append(pInvokes.sGlobal["$SFX::Device::numBuffers"]); outtext.Append(" Memory: "); - outtext.Append((omni.dGlobal["$SFX::Device::numBufferBytes"]/1024.0/1024.0)); + outtext.Append((pInvokes.dGlobal["$SFX::Device::numBufferBytes"]/1024.0/1024.0)); outtext.Append(" MB"); outtext.Append(" Time/S: "); - outtext.Append(omni.sGlobal["$SFX::sourceUpdateTime"]); + outtext.Append(pInvokes.sGlobal["$SFX::sourceUpdateTime"]); outtext.Append(" Time/P: "); - outtext.Append(omni.sGlobal["$SFX::parameterUpdateTime"]); + outtext.Append(pInvokes.sGlobal["$SFX::parameterUpdateTime"]); outtext.Append(" Time/A: "); - outtext.Append(omni.sGlobal["$SFX::ambientUpdateTime"]); + outtext.Append(pInvokes.sGlobal["$SFX::ambientUpdateTime"]); return outtext.ToString(); - //return - // " | SFX |" + - // " Sounds: " + - // t3d.sGlobal["$SFX::numSounds"] + - // " Lists: " + - // (t3d.iGlobal["$SFX::numSources"] - t3d.iGlobal["$SFX::numSounds"] - t3d.iGlobal["$SFX::Device::fmodNumEventSource"]) + - // " Events: " + - // t3d.sGlobal["$SFX::fmodNumEventSources"] + - // " Playing: " + - // t3d.sGlobal["$SFX::numPlaying"] + - // " Culled: " + - // t3d.sGlobal["$SFX::numCulled"] + - // " Voices: " + - // t3d.sGlobal["$SFX::numVoices"] + - // " Buffers: " + - // t3d.sGlobal["$SFX::Device::numBuffers"] + - // " Memory: " + - // (t3d.dGlobal["$SFX::Device::numBufferBytes"] / 1024.0 / 1024.0) + - // " MB" + - // " Time/S: " + - // t3d.sGlobal["$SFX::sourceUpdateTime"] + - // " Time/P: " + - // t3d.sGlobal["$SFX::parameterUpdateTime"] + - // " Time/A: " + - // t3d.sGlobal["$SFX::ambientUpdateTime"]; + //return + // " | SFX |" + + // " Sounds: " + + // pInvokes.sGlobal["$SFX::numSounds"] + + // " Lists: " + + // (pInvokes.iGlobal["$SFX::numSources"] - pInvokes.iGlobal["$SFX::numSounds"] - pInvokes.iGlobal["$SFX::Device::fmodNumEventSource"]) + + // " Events: " + + // pInvokes.sGlobal["$SFX::fmodNumEventSources"] + + // " Playing: " + + // pInvokes.sGlobal["$SFX::numPlaying"] + + // " Culled: " + + // pInvokes.sGlobal["$SFX::numCulled"] + + // " Voices: " + + // pInvokes.sGlobal["$SFX::numVoices"] + + // " Buffers: " + + // pInvokes.sGlobal["$SFX::Device::numBuffers"] + + // " Memory: " + + // (pInvokes.dGlobal["$SFX::Device::numBufferBytes"] / 1024.0 / 1024.0) + + // " MB" + + // " Time/S: " + + // pInvokes.sGlobal["$SFX::sourceUpdateTime"] + + // " Time/P: " + + // pInvokes.sGlobal["$SFX::parameterUpdateTime"] + + // " Time/A: " + + // pInvokes.sGlobal["$SFX::ambientUpdateTime"]; } [ConsoleInteraction(true)] public static string sfxSourcesMetricsCallback() { - return omni.Util.sfxDumpSourcesToString(false); + return pInvokes.Util.sfxDumpSourcesToString(false); } [ConsoleInteraction(true)] public static string sfxStatesMetricsCallback() { - return " | SFXStates |" + omni.sGlobal["sfxGetActiveStates"]; + return " | SFXStates |" + pInvokes.sGlobal["sfxGetActiveStates"]; } [ConsoleInteraction(true)] public static string timeMetricsCallback() { - return " | Time |" + " Sim Time: " + omni.Util.getSimTime() + " Mod: " + (omni.Util.getSimTime()%32); + return " | Time |" + " Sim Time: " + pInvokes.Util.getSimTime() + " Mod: " + (pInvokes.Util.getSimTime()%32); } [ConsoleInteraction(true)] @@ -245,24 +243,24 @@ public static string reflectMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | REFLECT |"); outtext.Append(" Objects: "); - outtext.Append(omni.sGlobal["$Reflect::numObjects"]); + outtext.Append(pInvokes.sGlobal["$Reflect::numObjects"]); outtext.Append(" Visible: "); - outtext.Append(omni.sGlobal["$Reflect::numVisible"]); + outtext.Append(pInvokes.sGlobal["$Reflect::numVisible"]); outtext.Append(" Occluded: "); - outtext.Append(omni.sGlobal["$Reflect::numOccluded"]); + outtext.Append(pInvokes.sGlobal["$Reflect::numOccluded"]); outtext.Append(" Updated: "); - outtext.Append(omni.sGlobal["$Reflect::numUpdated"]); + outtext.Append(pInvokes.sGlobal["$Reflect::numUpdated"]); outtext.Append(" Elapsed: "); - outtext.Append(omni.sGlobal["$Reflect::elapsed"]); + outtext.Append(pInvokes.sGlobal["$Reflect::elapsed"]); outtext.Append("\n"); outtext.Append(" Allocated: "); - outtext.Append(omni.sGlobal["$Reflect::renderTargetsAllocated"]); + outtext.Append(pInvokes.sGlobal["$Reflect::renderTargetsAllocated"]); outtext.Append(" Pooled: "); - outtext.Append(omni.sGlobal["$Reflect::poolSize"]); + outtext.Append(pInvokes.sGlobal["$Reflect::poolSize"]); outtext.Append("\n"); outtext.Append(" "); - string[] textstat = omni.sGlobal["$Reflect::textureStats"].Split(' '); + string[] textstat = pInvokes.sGlobal["$Reflect::textureStats"].Split(' '); if (textstat.GetUpperBound(0) > 0) { @@ -288,39 +286,39 @@ public static string reflectMetricsCallback() } return outtext.ToString(); - //return - // " | REFLECT |" + - // " Objects: " + - // t3d.sGlobal["$Reflect::numObjects"] + - // " Visible: " + - // t3d.sGlobal["$Reflect::numVisible"] + - // " Occluded: " + - // t3d.sGlobal["$Reflect::numOccluded"] + - // " Updated: " + - // t3d.sGlobal["$Reflect::numUpdated"] + - // " Elapsed: " + - // t3d.sGlobal["$Reflect::elapsed"] + - // "\n" + - // " Allocated: " + - // t3d.sGlobal["$Reflect::renderTargetsAllocated"] + - // " Pooled: " + - // t3d.sGlobal["$Reflect::poolSize"] + - // "\n" + - // " " + - // t3d.sGlobal["$Reflect::textureStats"].Split(' ')[1] + - // "\t" + - // " " + - // t3d.sGlobal["$Reflect::textureStats"].Split(' ')[2] + - // "MB" + - // "\t" + - // " " + - // t3d.sGlobal["$Reflect::textureStats"].Split(' ')[0]; + //return + // " | REFLECT |" + + // " Objects: " + + // pInvokes.sGlobal["$Reflect::numObjects"] + + // " Visible: " + + // pInvokes.sGlobal["$Reflect::numVisible"] + + // " Occluded: " + + // pInvokes.sGlobal["$Reflect::numOccluded"] + + // " Updated: " + + // pInvokes.sGlobal["$Reflect::numUpdated"] + + // " Elapsed: " + + // pInvokes.sGlobal["$Reflect::elapsed"] + + // "\n" + + // " Allocated: " + + // pInvokes.sGlobal["$Reflect::renderTargetsAllocated"] + + // " Pooled: " + + // pInvokes.sGlobal["$Reflect::poolSize"] + + // "\n" + + // " " + + // pInvokes.sGlobal["$Reflect::textureStats"].Split(' ')[1] + + // "\t" + + // " " + + // pInvokes.sGlobal["$Reflect::textureStats"].Split(' ')[2] + + // "MB" + + // "\t" + + // " " + + // pInvokes.sGlobal["$Reflect::textureStats"].Split(' ')[0]; } [ConsoleInteraction(true)] public static string decalMetricsCallback() { - return " | DECAL |" + " Batches: " + omni.sGlobal["$Decal::Batches"] + " Buffers: " + omni.sGlobal["$Decal::Buffers"] + " DecalsRendered: " + omni.sGlobal["$Decal::DecalsRendered"]; + return " | DECAL |" + " Batches: " + pInvokes.sGlobal["$Decal::Batches"] + " Buffers: " + pInvokes.sGlobal["$Decal::Buffers"] + " DecalsRendered: " + pInvokes.sGlobal["$Decal::DecalsRendered"]; } [ConsoleInteraction(true)] @@ -329,60 +327,60 @@ public static string renderMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Render |"); outtext.Append(" Int: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Interior"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Interior"]); outtext.Append(" IntDL: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_InteriorDynamicLighting"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_InteriorDynamicLighting"]); outtext.Append(" Mesh: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Mesh"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Mesh"]); outtext.Append(" MeshDL: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_MeshDynamicLighting"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_MeshDynamicLighting"]); outtext.Append(" Shadow: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Shadow"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Shadow"]); outtext.Append(" Sky: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Sky"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Sky"]); outtext.Append(" Obj: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Object"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Object"]); outtext.Append(" ObjT: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_ObjectTranslucent"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_ObjectTranslucent"]); outtext.Append(" Decal: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Decal"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Decal"]); outtext.Append(" Water: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Water"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Water"]); outtext.Append(" Foliage: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Foliage"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Foliage"]); outtext.Append(" Trans: "); - outtext.Append(omni.sGlobal["$RenderMetris::RIT_Translucent"]); + outtext.Append(pInvokes.sGlobal["$RenderMetris::RIT_Translucent"]); outtext.Append(" Custom: "); - outtext.Append(omni.sGlobal["$RenderMetrics::RIT_Custom"]); + outtext.Append(pInvokes.sGlobal["$RenderMetrics::RIT_Custom"]); return outtext.ToString(); - //return - // " | Render |" + - // " Int: " + - // t3d.sGlobal["$RenderMetrics::RIT_Interior"] + - // " IntDL: " + - // t3d.sGlobal["$RenderMetrics::RIT_InteriorDynamicLighting"] + - // " Mesh: " + - // t3d.sGlobal["$RenderMetrics::RIT_Mesh"] + - // " MeshDL: " + - // t3d.sGlobal["$RenderMetrics::RIT_MeshDynamicLighting"] + - // " Shadow: " + - // t3d.sGlobal["$RenderMetrics::RIT_Shadow"] + + //return + // " | Render |" + + // " Int: " + + // pInvokes.sGlobal["$RenderMetrics::RIT_Interior"] + + // " IntDL: " + + // pInvokes.sGlobal["$RenderMetrics::RIT_InteriorDynamicLighting"] + + // " Mesh: " + + // pInvokes.sGlobal["$RenderMetrics::RIT_Mesh"] + + // " MeshDL: " + + // pInvokes.sGlobal["$RenderMetrics::RIT_MeshDynamicLighting"] + + // " Shadow: " + + // pInvokes.sGlobal["$RenderMetrics::RIT_Shadow"] + // " Sky: " + - // t3d.sGlobal["$RenderMetrics::RIT_Sky"] + - // " Obj: " + - // t3d.sGlobal["$RenderMetrics::RIT_Object"] + + // pInvokes.sGlobal["$RenderMetrics::RIT_Sky"] + + // " Obj: " + + // pInvokes.sGlobal["$RenderMetrics::RIT_Object"] + // " ObjT: " + - // t3d.sGlobal["$RenderMetrics::RIT_ObjectTranslucent"] + - // " Decal: " + - // t3d.sGlobal["$RenderMetrics::RIT_Decal"] + - // " Water: " + - // t3d.sGlobal["$RenderMetrics::RIT_Water"] + + // pInvokes.sGlobal["$RenderMetrics::RIT_ObjectTranslucent"] + + // " Decal: " + + // pInvokes.sGlobal["$RenderMetrics::RIT_Decal"] + + // " Water: " + + // pInvokes.sGlobal["$RenderMetrics::RIT_Water"] + // " Foliage: " + - // t3d.sGlobal["$RenderMetrics::RIT_Foliage"] + + // pInvokes.sGlobal["$RenderMetrics::RIT_Foliage"] + // " Trans: " + - // t3d.sGlobal["$RenderMetris::RIT_Translucent"] + - // " Custom: " + - // t3d.sGlobal["$RenderMetrics::RIT_Custom"]; + // pInvokes.sGlobal["$RenderMetris::RIT_Translucent"] + + // " Custom: " + + // pInvokes.sGlobal["$RenderMetrics::RIT_Custom"]; } [ConsoleInteraction(true)] @@ -391,38 +389,38 @@ public static string shadowMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Shadow |"); outtext.Append(" Active: "); - outtext.Append(omni.sGlobal["$ShadowStats::activeMaps"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::activeMaps"]); outtext.Append(" Updated: "); - outtext.Append(omni.sGlobal["$ShadowStats::updatedMaps"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::updatedMaps"]); outtext.Append(" PolyCount: "); - outtext.Append(omni.sGlobal["$ShadowStats::polyCount"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::polyCount"]); outtext.Append(" DrawCalls: "); - outtext.Append(omni.sGlobal["$ShadowStats::drawCalls"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::drawCalls"]); outtext.Append(" RTChanges: "); - outtext.Append(omni.sGlobal["$ShadowStats::rtChanges"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::rtChanges"]); outtext.Append(" PoolTexCount: "); - outtext.Append(omni.sGlobal["$ShadowStats::poolTexCount"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::poolTexCount"]); outtext.Append(" PoolTexMB: "); - outtext.Append(omni.sGlobal["$ShadowStats::poolTexMemory"]); + outtext.Append(pInvokes.sGlobal["$ShadowStats::poolTexMemory"]); outtext.Append("MB"); return outtext.ToString(); - //return - // " | Shadow |" + + //return + // " | Shadow |" + // " Active: " + - // t3d.sGlobal["$ShadowStats::activeMaps"] + + // pInvokes.sGlobal["$ShadowStats::activeMaps"] + // " Updated: " + - // t3d.sGlobal["$ShadowStats::updatedMaps"] + - // " PolyCount: " + - // t3d.sGlobal["$ShadowStats::polyCount"] + - // " DrawCalls: " + - // t3d.sGlobal["$ShadowStats::drawCalls"] + - // " RTChanges: " + - // t3d.sGlobal["$ShadowStats::rtChanges"] + - // " PoolTexCount: " + - // t3d.sGlobal["$ShadowStats::poolTexCount"] + + // pInvokes.sGlobal["$ShadowStats::updatedMaps"] + + // " PolyCount: " + + // pInvokes.sGlobal["$ShadowStats::polyCount"] + + // " DrawCalls: " + + // pInvokes.sGlobal["$ShadowStats::drawCalls"] + + // " RTChanges: " + + // pInvokes.sGlobal["$ShadowStats::rtChanges"] + + // " PoolTexCount: " + + // pInvokes.sGlobal["$ShadowStats::poolTexCount"] + // " PoolTexMB: " + - // t3d.sGlobal["$ShadowStats::poolTexMemory"] + + // pInvokes.sGlobal["$ShadowStats::poolTexMemory"] + // "MB"; } @@ -432,32 +430,32 @@ public static string basicShadowMetricsCallback() StringBuilder outtext = new StringBuilder(1000); outtext.Append(" | Shadow |"); outtext.Append(" Active: "); - outtext.Append(omni.sGlobal["$BasicLightManagerStats::activePlugins"]); + outtext.Append(pInvokes.sGlobal["$BasicLightManagerStats::activePlugins"]); outtext.Append(" Updated: "); - outtext.Append(omni.sGlobal["$BasicLightManagerStats::shadowsUpdated"]); + outtext.Append(pInvokes.sGlobal["$BasicLightManagerStats::shadowsUpdated"]); outtext.Append(" Elapsed Ms: "); - outtext.Append(omni.sGlobal["$BasicLightManagerStats::elapsedUpdateMs"]); + outtext.Append(pInvokes.sGlobal["$BasicLightManagerStats::elapsedUpdateMs"]); return outtext.ToString(); - //return - // " | Shadow |" + - // " Active: " + - // t3d.sGlobal["$BasicLightManagerStats::activePlugins"] + - // " Updated: " + - // t3d.sGlobal["$BasicLightManagerStats::shadowsUpdated"] + - // " Elapsed Ms: " + - // t3d.sGlobal["$BasicLightManagerStats::elapsedUpdateMs"]; + //return + // " | Shadow |" + + // " Active: " + + // pInvokes.sGlobal["$BasicLightManagerStats::activePlugins"] + + // " Updated: " + + // pInvokes.sGlobal["$BasicLightManagerStats::shadowsUpdated"] + + // " Elapsed Ms: " + + // pInvokes.sGlobal["$BasicLightManagerStats::elapsedUpdateMs"]; } [ConsoleInteraction(true)] public static string lightMetricsCallback() { - return " | Deferred Lights |" + " Active: " + omni.sGlobal["$lightMetrics::activeLights"] + " Culled: " + omni.sGlobal["$lightMetrics::culledLights"]; + return " | Deferred Lights |" + " Active: " + pInvokes.sGlobal["$lightMetrics::activeLights"] + " Culled: " + pInvokes.sGlobal["$lightMetrics::culledLights"]; } [ConsoleInteraction(true)] public static string particleMetricsCallback() { - return " | Particles |" + " # Simulated " + omni.sGlobal["$particle::numSimulated"]; + return " | Particles |" + " # Simulated " + pInvokes.sGlobal["$particle::numSimulated"]; } [ConsoleInteraction(true)] @@ -484,15 +482,15 @@ public static string imposterMetricsCallback() StringBuilder sb = new StringBuilder(1000); sb.Append(" | IMPOSTER |"); sb.Append(" Rendered: "); - sb.Append(omni.sGlobal["$ImposterStats::rendered"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::rendered"]); sb.Append(" Batches: "); - sb.Append(omni.sGlobal["$ImposterStats::batches"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::batches"]); sb.Append(" DrawCalls: "); - sb.Append(omni.sGlobal["$ImposterStats::drawCalls"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::drawCalls"]); sb.Append(" Polys: "); - sb.Append(omni.sGlobal["$ImposterStats::polyCount"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::polyCount"]); sb.Append(" RtChanges: "); - sb.Append(omni.sGlobal["$ImposterStats::rtChanges"]); + sb.Append(pInvokes.sGlobal["$ImposterStats::rtChanges"]); return sb.ToString(); } @@ -512,9 +510,9 @@ public static void Metrics(string expr) { string cb = name.Trim() + "MetricsCallback"; //Can't check any more since the function isn't defined in DLL, will need to fix this. - //if (!t3d.console.isFunction(cb)) + //if (!pInvokes.console.isFunction(cb)) // { - // t3d.console.error("metrics - undefined callback: " + cb); + // pInvokes.console.error("metrics - undefined callback: " + cb); // } //else { @@ -537,4 +535,4 @@ public static void Metrics(string expr) ((GuiCanvas) "Canvas").popDialog("FrameOverlayGui"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/mission.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/mission.cs index c61500b9..2dff97e8 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/mission.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/mission.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Demo.Full.Models.User.GameCode.Server; @@ -43,14 +43,12 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class mission { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { // Whether the local client is currently running a mission. - omni.bGlobal["$Client::missionRunning"] = false; + pInvokes.bGlobal["$Client::missionRunning"] = false; // Sequence number for currently running mission. - omni.iGlobal["$Client::missionSeq"] = -1; + pInvokes.iGlobal["$Client::missionSeq"] = -1; } // Called when mission is started. @@ -59,12 +57,12 @@ public static void clientStartMission() { // The client recieves a mission start right before // being dropped into the game. - omni.Util.physicsStartSimulation("client"); + pInvokes.Util.physicsStartSimulation("client"); // Start game audio effects channels. ((SFXSource) "AudioChannelEffects").play(-1); // Create client mission cleanup group. new ObjectCreator("SimGroup", "ClientMissionCleanup").Create(); - omni.bGlobal["$Client::missionRunning"] = true; + pInvokes.bGlobal["$Client::missionRunning"] = true; } // Called when mission is ended (either through disconnect or @@ -73,19 +71,19 @@ public static void clientStartMission() public static void clientEndMission() { // Stop physics simulation on client. - omni.Util.physicsStopSimulation("client"); + pInvokes.Util.physicsStopSimulation("client"); // Stop game audio effects channels. ((SFXSource) "AudioChannelEffects").stop(-1); - omni.console.Call("decalManagerClear"); - // Delete client mission cleanup group. + pInvokes.console.Call("decalManagerClear"); + // Delete client mission cleanup group. ((SimGroup) "ClientMissionCleanup").delete(); - omni.Util.clearClientPaths(); + pInvokes.Util.clearClientPaths(); - omni.bGlobal["$Client::missionRunning"] = false; + pInvokes.bGlobal["$Client::missionRunning"] = false; } //---------------------------------------------------------------------------- @@ -96,38 +94,38 @@ public static void clientCmdMissionStart(string seq) { clientStartMission(); - omni.sGlobal["$Client::missionSeq"] = seq; + pInvokes.sGlobal["$Client::missionSeq"] = seq; } [ConsoleInteraction(true)] public static void clientCmdMissionEnd(string seq) { - if (!omni.bGlobal["$Client::missionRunning"] || omni.sGlobal["$Client::missionSeq"] != seq) + if (!pInvokes.bGlobal["$Client::missionRunning"] || pInvokes.sGlobal["$Client::missionSeq"] != seq) return; clientEndMission(); - omni.iGlobal["$Client::missionSeq"] = -1; + pInvokes.iGlobal["$Client::missionSeq"] = -1; } - /// Expands the name of a mission into the full + /// Expands the name of a mission into the full /// mission path and extension. public static string expandMissionFileName(string missionFile) { // Expand any escapes in it. - missionFile = omni.Util._expandFilename(missionFile); + missionFile = pInvokes.Util._expandFilename(missionFile); string newMission = ""; - if (!omni.Util.isFile(missionFile)) + if (!pInvokes.Util.isFile(missionFile)) { if (!missionFile.Trim().EndsWith(".mis")) newMission = missionFile.Trim() + ".mis"; - if (!omni.Util.isFile(newMission)) + if (!pInvokes.Util.isFile(newMission)) { - newMission = omni.Util._expandFilename("levels/" + newMission); + newMission = pInvokes.Util._expandFilename("levels/" + newMission); - if (!omni.Util.isFile(newMission)) + if (!pInvokes.Util.isFile(newMission)) { - omni.console.warn("The mission file '" + missionFile + "' was not found."); + pInvokes.console.warn("The mission file '" + missionFile + "' was not found."); return ""; } } @@ -160,4 +158,4 @@ public static bool loadLevel(string missionNameOrFile) return server.createAndConnectToLocalServer("SinglePlayer", missionFile); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/missionDownload.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/missionDownload.cs index 9aac3018..e48f6665 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/missionDownload.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/missionDownload.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using System.Collections.Generic; using WinterLeaf.Demo.Full.Models.User.Extendable; @@ -46,17 +46,16 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class missionDownload { - private static readonly pInvokes omni = new pInvokes(); private static List MLoadinfo = new List(); [ConsoleInteraction(true)] public static void clientCmdMissionStartPhase1(string seq, string missionName, string musicTrack, string serverCRC) { GameConnection ServerConnection = "ServerConnection"; - omni.Util._echo("*** New Mission: " + missionName); - omni.Util._echo("*** Phase 1: Download Datablocks & Targets"); + pInvokes.Util._echo("*** New Mission: " + missionName); + pInvokes.Util._echo("*** Phase 1: Download Datablocks & Targets"); onMissionDownloadPhase1(missionName, musicTrack); - omni.sGlobal["$ServerDatablockCacheCRC"] = serverCRC; + pInvokes.sGlobal["$ServerDatablockCacheCRC"] = serverCRC; string name = missionName.Replace(" ", ""); if (name.Contains("/")) @@ -64,15 +63,15 @@ public static void clientCmdMissionStartPhase1(string seq, string missionName, s if (name.Contains(".")) name = name.Split('.')[0]; - omni.sGlobal["$ServerDatablockCacheMissionName"] = "DBCaches/" + name + "DB.db"; + pInvokes.sGlobal["$ServerDatablockCacheMissionName"] = "DBCaches/" + name + "DB.db"; if (ServerConnection.callScript("LoadDatablocksFromFile", new[] {serverCRC}).AsBool()) { - omni.console.print("Loaded Datablocks from file."); + pInvokes.console.print("Loaded Datablocks from file."); clientCmdMissionStartPhase2(seq, missionName, true); } else - omni.console.commandToServer("MissionStartPhase1Ack", new string[] {seq}); + pInvokes.console.commandToServer("MissionStartPhase1Ack", new string[] {seq}); } [ConsoleInteraction(true)] @@ -85,29 +84,29 @@ public static void onDataBlockObjectReceived(string index, string total) public static void clientCmdMissionStartPhase2(string seq, string missionName, bool isLoadedFromFile = false) { onPhase1Complete(); - omni.Util._echo("*** Phase 2: Download Ghost Objects"); + pInvokes.Util._echo("*** Phase 2: Download Ghost Objects"); onMissionDownloadPhase2(); //Push the client past the datablock transmition stage. if (isLoadedFromFile) - omni.console.commandToServer("MissionStartPhase2CacheAck"); + pInvokes.console.commandToServer("MissionStartPhase2CacheAck"); //Start next stage. - omni.console.commandToServer("MissionStartPhase2Ack", new string[] {seq, omni.sGlobal["$pref::Player:PlayerDB"]}); + pInvokes.console.commandToServer("MissionStartPhase2Ack", new string[] {seq, pInvokes.sGlobal["$pref::Player:PlayerDB"]}); } [ConsoleInteraction(true)] public static void onGhostAlwaysStarted(string ghostCount) { - omni.sGlobal["$ghostCount"] = ghostCount; - omni.iGlobal["$ghostsRecvd"] = 0; + pInvokes.sGlobal["$ghostCount"] = ghostCount; + pInvokes.iGlobal["$ghostsRecvd"] = 0; } [ConsoleInteraction(true)] public static void onGhostAlwaysObjectReceived() { - omni.iGlobal["$ghostsRecvd"] = omni.iGlobal["$ghostsRecvd"] + 1; - onPhase2Progress((omni.fGlobal["$ghostsRecvd"]/omni.fGlobal["$ghostCount"]).AsString()); + pInvokes.iGlobal["$ghostsRecvd"] = pInvokes.iGlobal["$ghostsRecvd"] + 1; + onPhase2Progress((pInvokes.fGlobal["$ghostsRecvd"]/pInvokes.fGlobal["$ghostCount"]).AsString()); } // @@ -119,45 +118,45 @@ public static void onGhostAlwaysObjectReceived() public static void clientCmdMissionStartPhase3(string seq, string missionName) { onPhase2Complete(); - omni.Util.StartClientReplication(); - omni.Util.StartFoliageReplication(); + pInvokes.Util.StartClientReplication(); + pInvokes.Util.StartFoliageReplication(); // Load the static mission decals. - omni.console.Call("decalManagerLoad", new string[] {missionName + ".decals"}); + pInvokes.console.Call("decalManagerLoad", new string[] {missionName + ".decals"}); - omni.Util._echo("*** Phase 3: Mission Lighting"); - omni.sGlobal["$MSeq"] = seq; - omni.sGlobal["$Client::MissionFile"] = missionName; + pInvokes.Util._echo("*** Phase 3: Mission Lighting"); + pInvokes.sGlobal["$MSeq"] = seq; + pInvokes.sGlobal["$Client::MissionFile"] = missionName; //Need to light the mission before we are ready. - //The sceneLightingComplete function will complete the handshake + //The sceneLightingComplete function will complete the handshake //once the scene lighting is done. - if (omni.Util.lightScene("sceneLightingComplete", "")) + if (pInvokes.Util.lightScene("sceneLightingComplete", "")) { - omni.Util._echo("Lighting mission...."); - omni.Util._schedule("1", "0", "updateLightingProgress"); + pInvokes.Util._echo("Lighting mission...."); + pInvokes.Util._schedule("1", "0", "updateLightingProgress"); onMissionDownloadPhase3(); - omni.bGlobal["$lightingMission"] = true; + pInvokes.bGlobal["$lightingMission"] = true; } } [ConsoleInteraction(true)] public static void updateLightingProgress() { - onPhase3Progress(omni.sGlobal["$SceneLighting::lightingProgress"]); - if (omni.bGlobal["$lightingMission"]) - omni.iGlobal["$lightingProgressThread"] = omni.Util._schedule("1", "0", "updateLightingProgress"); + onPhase3Progress(pInvokes.sGlobal["$SceneLighting::lightingProgress"]); + if (pInvokes.bGlobal["$lightingMission"]) + pInvokes.iGlobal["$lightingProgressThread"] = pInvokes.Util._schedule("1", "0", "updateLightingProgress"); } [ConsoleInteraction(true)] public static void sceneLightingComplete() { - omni.Util._echo("Mission lighting done"); + pInvokes.Util._echo("Mission lighting done"); onPhase3Complete(); //The is also the end of the mission load cycle. onMissionDownloadComplete(); - omni.console.commandToServer("MissionStartPhase3Ack", new string[] {omni.sGlobal["$MSeq"]}); + pInvokes.console.commandToServer("MissionStartPhase3Ack", new string[] {pInvokes.sGlobal["$MSeq"]}); } // @@ -169,16 +168,16 @@ public static void connect(string server) { GameConnection conn = new ObjectCreator("ServerConnection").Create(); ((SimGroup) "RootGroup").add(conn); - conn.setConnectArgs(omni.sGlobal["$pref::Player::Name"]); - conn.setJoinPassword(omni.sGlobal["$Client::Password"]); + conn.setConnectArgs(pInvokes.sGlobal["$pref::Player::Name"]); + conn.setJoinPassword(pInvokes.sGlobal["$Client::Password"]); conn.connect(server); } public static void onMissionDownloadPhase1(string missionName, string musicTrack) { // Load the post effect presets for this mission. - string path = "levels/" + omni.Util.fileBase(missionName) + omni.sGlobal["$PostFXManager::fileExtension"]; - if (omni.Util.isFile(path)) + string path = "levels/" + pInvokes.Util.fileBase(missionName) + pInvokes.sGlobal["$PostFXManager::fileExtension"]; + if (pInvokes.Util.isFile(path)) ((postFXManager) "postFXManager").loadPresetHandler(path); else ((postFXManager) "postFXManager").settingsApplyDefaultPreset(); @@ -275,7 +274,7 @@ public static void onPhase3Progress(string progress) public static void onPhase3Complete() { - omni.bGlobal["$lightingMission"] = false; + pInvokes.bGlobal["$lightingMission"] = false; if (!"LoadingProgress".isObject()) return; ((GuiTextCtrl) "LoadingProgressTxt").setValue("STARTING MISSION"); @@ -304,7 +303,7 @@ public static void initialize() [ConsoleInteraction(true)] public static void handleLoadInfoMessage(string msgType, string msgString, string mapname) { - omni.console.error("Load info Recieved map " + mapname); + pInvokes.console.error("Load info Recieved map " + mapname); GuiChunkedBitmapCtrl LoadingGui = "LoadingGui"; if (((GuiCanvas) "canvas").getContent() != LoadingGui.getId()) @@ -348,4 +347,4 @@ public static void handleLoadFailedMessage(string msgType, string msgString) messageBox.MessageBoxOK("Mission Load Failed", msgString + "\r\nPress OK to return to the Main Menu", "disconnect();"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/oculusVR.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/oculusVR.cs index 86e2930b..e16bd5ce 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/oculusVR.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/oculusVR.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Decorations; @@ -43,16 +43,14 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class oculusVR { - private static readonly pInvokes omni = new pInvokes(); - // Only load these functions if an Oculus VR device is present [ConsoleInteraction(true)] public static string oculusSensorMetricsCallback() { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return ""; - return " | OVR Sensor 0 |" + " rot: " + omni.Util._call("getOVRSensorEulerRotation", "0"); + return " | OVR Sensor 0 |" + " rot: " + pInvokes.Util._call("getOVRSensorEulerRotation", "0"); } // Call this function from createCanvas() to have the Canvas attach itself @@ -63,9 +61,9 @@ public static string oculusSensorMetricsCallback() [ConsoleInteraction(true)] public static void pointCanvasToOculusVRDisplay() { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - omni.sGlobal["$pref::Video::displayOutputDevice"] = omni.Util._call("getOVRHMDDisplayDeviceName", "0"); + pInvokes.sGlobal["$pref::Video::displayOutputDevice"] = pInvokes.Util._call("getOVRHMDDisplayDeviceName", "0"); } // Call this function from GameConnection::initialControlSet() just before @@ -81,9 +79,9 @@ public static void pointCanvasToOculusVRDisplay() [ConsoleInteraction(true)] public static void enableOculusVRDisplay(GameConnection gameConnection, bool trueStereoRendering) { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - omni.Util._call("setOVRHMDAsGameConnectionDisplayDevice", gameConnection); + pInvokes.Util._call("setOVRHMDAsGameConnectionDisplayDevice", gameConnection); ((GameConnection) "PlayGui")["renderStyle"] = "stereo side by side"; if (trueStereoRendering) @@ -92,7 +90,7 @@ public static void enableOculusVRDisplay(GameConnection gameConnection, bool tru ((PostEffect) "OVRBarrelDistortionMonoPostFX")["isEnabled"] = "true"; // Reset all sensors - omni.Util._call("ovrResetAllSensors"); + pInvokes.Util._call("ovrResetAllSensors"); } // Call this function when ever you wish to turn off the stereo rendering @@ -100,7 +98,7 @@ public static void enableOculusVRDisplay(GameConnection gameConnection, bool tru [ConsoleInteraction(true)] public static void disableOculusVRDisplay(GameConnection gameConnection) { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; gameConnection.clearDisplayDevice(); ((GameConnection) "PlayGui")["renderStyle"] = "standard"; @@ -115,9 +113,9 @@ public static void disableOculusVRDisplay(GameConnection gameConnection) [ConsoleInteraction(true)] public static void setStandardOculusVRControlScheme(GameConnection gameConnection) { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - gameConnection.setControlSchemeParameters(true, true, omni.Util._call("isOVRHMDSimulated", "0").AsBool()); + gameConnection.setControlSchemeParameters(true, true, pInvokes.Util._call("isOVRHMDSimulated", "0").AsBool()); } //----------------------------------------------------------------------------- @@ -130,9 +128,9 @@ public static void setStandardOculusVRControlScheme(GameConnection gameConnectio [ConsoleInteraction(true)] public static void setVideoModeForOculusVRDisplay(string fullscreen) { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - Point2I res = new Point2I(omni.Util._call("getOVRHMDResolution", "0")); + Point2I res = new Point2I(pInvokes.Util._call("getOVRHMDResolution", "0")); ((GuiCanvas) "canvas").setVideoMode((uint) res.x, (uint) res.y, fullscreen.AsBool(), 32, 4); } @@ -141,9 +139,9 @@ public static void setVideoModeForOculusVRDisplay(string fullscreen) [ConsoleInteraction(true)] public static void resetOculusVRSensors() { - if (!omni.Util.isFunction("isOculusVRDeviceActive")) + if (!pInvokes.Util.isFunction("isOculusVRDeviceActive")) return; - omni.Util._call("ovrResetAllSensors"); + pInvokes.Util._call("ovrResetAllSensors"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/postFX.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/postFX.cs index 037f5671..abae8788 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/postFX.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/postFX.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using System.Collections.Generic; using WinterLeaf.Demo.Full.Models.User.GameCode.Client.PostEffects.Gui; @@ -43,8 +43,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class postFX { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { SingletonCreator ts = new SingletonCreator("GFXStateBlockData", "PFX_DefaultStateBlock"); @@ -92,7 +90,7 @@ public static void initPostEffects() postFXManager.createGui(); - omni.Util.exec("core/scripts/client/postFx/default.postfxpreset.cs", false, false); + pInvokes.Util.exec("core/scripts/client/postFx/default.postfxpreset.cs", false, false); } public static void SetPostFXToDefault() @@ -143,4 +141,4 @@ public static void SetPostFXToDefault() //Settings.SetVariables("default.postfxpreset.cs", ValueToLoad); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/screenshot.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/screenshot.cs index ff31161c..0d41d1c8 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/screenshot.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/screenshot.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.Extendable; using WinterLeaf.Engine.Classes.Decorations; @@ -43,11 +43,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class screenshot { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.iGlobal["$screenshotNumber"] = 0; + pInvokes.iGlobal["$screenshotNumber"] = 0; } [ConsoleInteraction(true)] @@ -89,13 +87,13 @@ public static void recordMovie(string movieName, float fps, string encoder) encoder = "THEORA"; string resolution = ((GuiCanvas) "canvas").getVideoMode(); - omni.Util.startVideoCapture("canvas", movieName, encoder, fps, new Point2I(0, 0)); + pInvokes.Util.startVideoCapture("canvas", movieName, encoder, fps, new Point2I(0, 0)); } [ConsoleInteraction(true)] public static void stopMovie() { - omni.Util.stopVideoCapture(); + pInvokes.Util.stopVideoCapture(); } // This is bound in initializeCommon() to take @@ -112,24 +110,24 @@ public static void doScreenShot(int val) [ConsoleInteraction(true)] public static void _screenShot(uint tiles, float overlap = 0f) { - if (omni.sGlobal["$pref::Video::screenShotSession"] == "") - omni.iGlobal["$pref::Video::screenShotSession"] = 0; + if (pInvokes.sGlobal["$pref::Video::screenShotSession"] == "") + pInvokes.iGlobal["$pref::Video::screenShotSession"] = 0; - if (omni.iGlobal["$screenshotNumber"] == 0) - omni.iGlobal["$pref::Video::screenShotSession"]++; + if (pInvokes.iGlobal["$screenshotNumber"] == 0) + pInvokes.iGlobal["$pref::Video::screenShotSession"]++; - if (omni.iGlobal["$pref::Video::screenShotSession"] > 999) - omni.iGlobal["$pref::Video::screenShotSession"] = 1; + if (pInvokes.iGlobal["$pref::Video::screenShotSession"] > 999) + pInvokes.iGlobal["$pref::Video::screenShotSession"] = 1; - string name = "screenshot_" + formatSessionNumber(omni.iGlobal["$pref::Video::screenShotSession"]) + "-" + formatImageNumber(omni.iGlobal["$screenshotNumber"]); - name = omni.Util._expandFilename(name); + string name = "screenshot_" + formatSessionNumber(pInvokes.iGlobal["$pref::Video::screenShotSession"]) + "-" + formatImageNumber(pInvokes.iGlobal["$screenshotNumber"]); + name = pInvokes.Util._expandFilename(name); - omni.iGlobal["$screenshotNumber"]++; + pInvokes.iGlobal["$screenshotNumber"]++; - if ((omni.sGlobal["$pref::Video::screenShotFormat"] == "JPEG") || (omni.sGlobal["$pref::Video::screenShotFormat"] == "JPG")) - omni.Util.screenShot("screenshots\\" + name, "JPEG", tiles, overlap); + if ((pInvokes.sGlobal["$pref::Video::screenShotFormat"] == "JPEG") || (pInvokes.sGlobal["$pref::Video::screenShotFormat"] == "JPG")) + pInvokes.Util.screenShot("screenshots\\" + name, "JPEG", tiles, overlap); else - omni.Util.screenShot("screenshots\\" + name, "PNG", tiles, overlap); + pInvokes.Util.screenShot("screenshots\\" + name, "PNG", tiles, overlap); } // This will close the console and take a large format @@ -145,4 +143,4 @@ public static void tiledScreenShot(uint tiles, float overlap = 0f) _screenShot(tiles, overlap); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/scriptDoc.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/scriptDoc.cs index 7e46abcd..4875bfff 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/scriptDoc.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Client/scriptDoc.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; @@ -41,8 +41,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Client { public class scriptDoc { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void writeOutFunctions() { @@ -51,8 +49,8 @@ public static void writeOutFunctions() dumpConsoleFunctions(); logger.delete(); */ - omni.console.Eval("new ConsoleLogger(logger, \"scriptFunctions.txt\", false);"); - omni.Util.dumpConsoleFunctions(true, true); + pInvokes.console.Eval("new ConsoleLogger(logger, \"scriptFunctions.txt\", false);"); + pInvokes.Util.dumpConsoleFunctions(true, true); "logger".delete(); } @@ -64,9 +62,9 @@ public static void writeOutClasses() dumpConsoleClasses(); logger.delete(); */ - omni.console.Eval("new ConsoleLogger(logger, \"scriptClasses.txt\", false);"); - omni.Util.dumpConsoleClasses(true, true); + pInvokes.console.Eval("new ConsoleLogger(logger, \"scriptClasses.txt\", false);"); + pInvokes.Util.dumpConsoleClasses(true, true); "logger".delete(); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Common/AggregateControl.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Common/AggregateControl.cs index 701976ca..65c222e1 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Common/AggregateControl.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Common/AggregateControl.cs @@ -69,14 +69,14 @@ public static void shareValueSafe(GuiControl source, GuiControl dest) [ConsoleInteraction] public static void shareValueSafeDelay(GuiControl source, GuiControl dest, int delayMS) { - omni.Util._schedule(delayMS.AsString(), "0", "ShareValueSafe", source, dest); + Util._schedule(delayMS.AsString(), "0", "ShareValueSafe", source, dest); } [ConsoleInteraction] public static bool parseMissionGroup(string className, string childGroup = "") { SimGroup currentGroup = ""; - if (omni.Util.getWordCount(childGroup) == 0) + if (Util.getWordCount(childGroup) == 0) currentGroup = "MissionGroup"; else currentGroup = childGroup; @@ -108,9 +108,9 @@ public static string validateDatablockName(string name) // the first character string firstChar = name.Substring(0, 1); // if the character is a number remove it - if (omni.Util.strpos(numbers, firstChar, 0) != -1) + if (Util.strpos(numbers, firstChar, 0) != -1) { - name = omni.Util.getSubStr(name, 1, name.Length - 1); + name = Util.getSubStr(name, 1, name.Length - 1); name = name.Trim(); } else @@ -120,7 +120,7 @@ public static string validateDatablockName(string name) name = name.Replace(" ", ""); // remove any other invalid characters string invalidCharacters = "-+*/%$&§=()[].?\"#,;!~<>|°^{}"; - name = omni.Util.stripChars(name, invalidCharacters); + name = Util.stripChars(name, invalidCharacters); if (name == "") name = "Unnamed"; return name; @@ -132,13 +132,13 @@ public static string validateDatablockName(string name) [ConsoleInteraction] public static int wordPos(string text, string word, int start = 0) { - if (omni.Util.strpos(text, word, 0) == -1) + if (Util.strpos(text, word, 0) == -1) return -1; - int count = omni.Util.getWordCount(text); + int count = Util.getWordCount(text); for (int i = start; i < count; i++) { - if (omni.Util.getWord(text, i) == word) + if (Util.getWord(text, i) == word) return i; } return -1; @@ -150,15 +150,15 @@ public static int wordPos(string text, string word, int start = 0) [ConsoleInteraction] public static int fieldPos(string text, string field, int start = 0) { - if (omni.Util.strpos(text, field, 0) == -1) + if (Util.strpos(text, field, 0) == -1) return -1; - int count = omni.Util.getFieldCount(text); + int count = Util.getFieldCount(text); if (start > count) return -1; for (int i = start; i < count; i++) { - if (omni.Util.getField(text, i) == field) + if (Util.getField(text, i) == field) return i; } return -1; @@ -189,7 +189,7 @@ public static string parseMissionGroupForIds(string className, string childGroup { string classIds = ""; SimGroup currentGroup; - if (omni.Util.getWordCount(childGroup) == 0) + if (Util.getWordCount(childGroup) == 0) currentGroup = "MissionGroup"; else currentGroup = childGroup; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Main.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Main.cs index cf56be55..eb9f6d4c 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Main.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Main.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -56,11 +56,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode /// /// This is a required file, replaces main.cs in the root directory /// - /// + /// public static class Main { - private static readonly pInvokes omni = new pInvokes(); - /// /// Main entry point into the scripts. /// MANDITORY FUNCTION @@ -70,73 +68,73 @@ public static class Main [ConsoleInteraction(true)] public static int main(int argc, string[] argv) { - //t3d.Util._call("enableWinConsole", "true"); - //t3d.sGlobal["$test[1]"] = "test"; - //Console.WriteLine(t3d.sGlobal["$test[1]"]); + //pInvokes.Util._call("enableWinConsole", "true"); + //pInvokes.sGlobal["$test[1]"] = "test"; + //Console.WriteLine(pInvokes.sGlobal["$test[1]"]); - // + // // Set the name of our application - omni.sGlobal["$appName"] = "Full"; + pInvokes.sGlobal["$appName"] = "Full"; // The directory it is run from - omni.sGlobal["$defaultGame"] = "scripts"; + pInvokes.sGlobal["$defaultGame"] = "scripts"; // Set profile directory - omni.sGlobal["$Pref::Video::ProfilePath"] = "core/profile"; + pInvokes.sGlobal["$Pref::Video::ProfilePath"] = "core/profile"; - omni.bGlobal["$displayHelp"] = false; + pInvokes.bGlobal["$displayHelp"] = false; - omni.bGlobal["$isDedicated"] = false; + pInvokes.bGlobal["$isDedicated"] = false; - omni.iGlobal["$dirCount"] = 2; + pInvokes.iGlobal["$dirCount"] = 2; - omni.sGlobal["$userDirs"] = omni.sGlobal["$defaultGame"] + ";art;levels"; + pInvokes.sGlobal["$userDirs"] = pInvokes.sGlobal["$defaultGame"] + ";art;levels"; mainParseArgs(); // load tools scripts if we're a tool build - //if (omni.Util.isToolBuild() && !omni.bGlobal["$isDedicated"]) - // omni.sGlobal["$userDirs"] = "tools;" + omni.sGlobal["$userDirs"]; + //if (pInvokes.Util.isToolBuild() && !pInvokes.bGlobal["$isDedicated"]) + // pInvokes.sGlobal["$userDirs"] = "tools;" + pInvokes.sGlobal["$userDirs"]; // Parse the executable arguments with the standard // function from core/main.cs - if (omni.iGlobal["$dirCount"] == 0) + if (pInvokes.iGlobal["$dirCount"] == 0) { - omni.sGlobal["$userDirs"] = omni.sGlobal["$defaultGame"]; - omni.iGlobal["$dirCount"] = 1; + pInvokes.sGlobal["$userDirs"] = pInvokes.sGlobal["$defaultGame"]; + pInvokes.iGlobal["$dirCount"] = 1; } //----------------------------------------------------------------------------- // Display a splash window immediately to improve app responsiveness before // engine is initialized and main window created - if (!omni.bGlobal["$isDedicated"]) - omni.Util.displaySplashWindow("art/gui/omni.bmp"); + if (!pInvokes.bGlobal["$isDedicated"]) + pInvokes.Util.displaySplashWindow("art/gui/pInvokes.bmp"); - if (!omni.bGlobal["$logModeSpecified"]) + if (!pInvokes.bGlobal["$logModeSpecified"]) { - if (omni.sGlobal["$platform"] != "xbox" && omni.sGlobal["$platform"] != "xenon") - omni.Util.setLogMode(6); + if (pInvokes.sGlobal["$platform"] != "xbox" && pInvokes.sGlobal["$platform"] != "xenon") + pInvokes.Util.setLogMode(6); } - omni.Util.nextToken("$userDirs", "currentMod", ";"); + pInvokes.Util.nextToken("$userDirs", "currentMod", ";"); - omni.console.print("--------- Loading DIRS ---------"); + pInvokes.console.print("--------- Loading DIRS ---------"); /*Ok, so here is the deal. Until the tools are converted to a OMNI toolset we need to allow support of * packages in some way. Since packages require a base function and then override it we needed to * provide the basic torquescript functions for onStart,onExit,parseArgs. Instead of putting any * code into them, we just put a call back to our C# function. - * + * * So for example we defined a torquescript function onStart() it calls onMainStart() and onMainStart is wired via reflections * to the C# function event_onMainStart. Thus we satisfy the requirements of packages, in which the base function * must exist outside of a package to be overriden by a package. Therefore, since the Tools are still all in TorqueScript, * the Tools Package can now override onStart, onExit and parseArgs. - * - * + * + * * Pretty slick.... */ - omni.console.Eval(@" + pInvokes.console.Eval(@" function onStart() { onMainStart(); @@ -157,77 +155,77 @@ function loadKeybindings() GameConnection.initialize(); SetConstantsForReferencingVideoResolutionPreference(); - loadDirs(omni.sGlobal["$userDirs"]); + loadDirs(pInvokes.sGlobal["$userDirs"]); //-----> Load tools here - if (omni.Util.isToolBuild() && !omni.bGlobal["$isDedicated"]) - //omni.sGlobal["$userDirs"] = "tools;" + omni.sGlobal["$userDirs"]; + if (pInvokes.Util.isToolBuild() && !pInvokes.bGlobal["$isDedicated"]) + //pInvokes.sGlobal["$userDirs"] = "tools;" + pInvokes.sGlobal["$userDirs"]; Tools.main.initialize(); //We don't need this no more, no more scripts! - // if (omni.iGlobal["$dirCount"] == 0) + // if (pInvokes.iGlobal["$dirCount"] == 0) // { - // omni.Util._call("enableWinConsole", "true"); - // omni.console.error("Error: Unable to load any specified directories"); + // pInvokes.Util._call("enableWinConsole", "true"); + // pInvokes.console.error("Error: Unable to load any specified directories"); //Main.Quit(); - //t3d.Util.quit(); + //pInvokes.Util.quit(); //} // Parse the command line arguments - omni.console.print("--------- Parsing Arguments ---------"); + pInvokes.console.print("--------- Parsing Arguments ---------"); mainParseArgs(); - if (omni.bGlobal["$displayHelp"]) + if (pInvokes.bGlobal["$displayHelp"]) { - omni.console.Call("enableWinConsole", new[] {"true"}); + pInvokes.console.Call("enableWinConsole", new[] {"true"}); displayHelp(); - //t3d.Util.quit(); + //pInvokes.Util.quit(); Quit(); } else { //due to the Tools, this must be called through the console. - omni.console.Call("onStart"); + pInvokes.console.Call("onStart"); //onStart(); - omni.console.print("Engine initialized..."); + pInvokes.console.print("Engine initialized..."); GuiCanvas canvas1 = "Canvas"; - if (!omni.bGlobal["$isDedicated"]) + if (!pInvokes.bGlobal["$isDedicated"]) { - omni.Util.closeSplashWindow(); + pInvokes.Util.closeSplashWindow(); canvas1.showWindow(); } - if (omni.sGlobal["$platform"] == "xenon") + if (pInvokes.sGlobal["$platform"] == "xenon") { const string mission = "levels//Empty Terrain.mis"; - omni.console.print("Xbox360 Autoloading level: '" + mission + "'"); - string serverType = omni.bGlobal["$pref::HostMultiPlayer"] ? "MultiPlayer" : "SinglePlayer"; + pInvokes.console.print("Xbox360 Autoloading level: '" + mission + "'"); + string serverType = pInvokes.bGlobal["$pref::HostMultiPlayer"] ? "MultiPlayer" : "SinglePlayer"; server.createAndConnectToLocalServer(serverType, mission); } } - for (int i = 1; i < omni.iGlobal["$Game::argc"]; i++) + for (int i = 1; i < pInvokes.iGlobal["$Game::argc"]; i++) { - if (!omni.bGlobal["$argUsed[" + i + "]"]) + if (!pInvokes.bGlobal["$argUsed[" + i + "]"]) { - if (omni.sGlobal["$Game::argv[" + i + "]"].Trim() != "") - omni.console.error("Error: Unknown command line argument: " + omni.sGlobal["$Game::argv[" + i + "]"]); + if (pInvokes.sGlobal["$Game::argv[" + i + "]"].Trim() != "") + pInvokes.console.error("Error: Unknown command line argument: " + pInvokes.sGlobal["$Game::argv[" + i + "]"]); } } GuiCanvas canvas = "Canvas"; - - if (omni.bGlobal["$startWorldEditor"]) + + if (pInvokes.bGlobal["$startWorldEditor"]) { canvas.setCursor("DefaultCursor"); canvas.setContent("EditorChooseLevelGui"); } - else if (omni.bGlobal["$startGUIEditor"]) + else if (pInvokes.bGlobal["$startGUIEditor"]) { canvas.setCursor("DefaultCursor"); canvas.setContent("EditorChooseGUI"); @@ -262,34 +260,34 @@ public static void loadDir(string dir) pushBack("$useDirs", dir, ";"); if (!isScriptFile(dir + "/main.cs")) return; - omni.console.print("Calling " + dir + "/main.cs"); - omni.Util.exec(dir + "/main.cs", false, false); + pInvokes.console.print("Calling " + dir + "/main.cs"); + pInvokes.Util.exec(dir + "/main.cs", false, false); } [ConsoleInteraction(true)] public static void onMainExit() { - if (omni.bGlobal["$Server::Dedicated"]) + if (pInvokes.bGlobal["$Server::Dedicated"]) server.destroyServer(); else - omni.console.Call("disconnect"); + pInvokes.console.Call("disconnect"); - omni.Util.physicsDestroy(); + pInvokes.Util.physicsDestroy(); - omni.console.print("Exporting client prefs"); + pInvokes.console.print("Exporting client prefs"); //Todo Settings - Switch this back when fixed. - omni.Util.export("$pref::*", "prefs.client.cs", false); - //omni.Util.exportToSettings("$pref::*", "scripts/client/prefs.cs", false); - // t3d.Util.exportToSettings("$Pref::*", "scripts/client/prefs1.cs", true); + pInvokes.Util.export("$pref::*", "prefs.client.cs", false); + //pInvokes.Util.exportToSettings("$pref::*", "scripts/client/prefs.cs", false); + // pInvokes.Util.exportToSettings("$Pref::*", "scripts/client/prefs1.cs", true); - omni.console.print("Exporting server prefs"); + pInvokes.console.print("Exporting server prefs"); //Todo Settings - Switch this back when fixed. - omni.Util.export("$Pref::Server::*", "prefs.server.cs", false); - //omni.Util.exportToSettings("$Pref::Server::*", "scripts/server/prefs.cs", false); + pInvokes.Util.export("$Pref::Server::*", "prefs.server.cs", false); + //pInvokes.Util.exportToSettings("$Pref::Server::*", "scripts/server/prefs.cs", false); - omni.console.Call_Classname("BanList", "Export", new[] {"prefs.banlist.cs"}); + pInvokes.console.Call_Classname("BanList", "Export", new[] {"prefs.banlist.cs"}); core.shutdownCore(); @@ -299,7 +297,7 @@ public static void onMainExit() [ConsoleInteraction(true)] public static bool isScriptFile(string path) { - if (omni.Util.isFile(path + ".dso") || omni.Util.isFile(path)) + if (pInvokes.Util.isFile(path + ".dso") || pInvokes.Util.isFile(path)) return true; return false; } @@ -309,16 +307,16 @@ public static void loadDirs(string dirPath) string[] directorypaths = dirPath.Split(';'); for (int i = directorypaths.Count() - 1; i >= 0; i--) { - if (omni.Util.exec(directorypaths[i] + "/main.cs", false, false)) + if (pInvokes.Util.exec(directorypaths[i] + "/main.cs", false, false)) continue; - omni.console.error("Error: Unable to find specified directory: " + directorypaths[i]); - omni.iGlobal["$dirCount"]--; + pInvokes.console.error("Error: Unable to find specified directory: " + directorypaths[i]); + pInvokes.iGlobal["$dirCount"]--; } } public static void displayHelp() { - omni.console.error("Torque Demo command line options:\n" + " -log Logging behavior; see main.cs comments for details\n" + " -game Reset list of mods to only contain \n" + " Works like the -game argument\n" + " -dir Add to list of directories\n" + " -console Open a separate console\n" + " -show Deprecated\n" + " -jSave Record a journal\n" + " -jPlay Play back a journal\n" + " -jDebug Play back a journal and issue an int3 at the end\n" + " -help Display this help message\n"); + pInvokes.console.error("Torque Demo command line options:\n" + " -log Logging behavior; see main.cs comments for details\n" + " -game Reset list of mods to only contain \n" + " Works like the -game argument\n" + " -dir Add to list of directories\n" + " -console Open a separate console\n" + " -show Deprecated\n" + " -jSave Record a journal\n" + " -jPlay Play back a journal\n" + " -jDebug Play back a journal and issue an int3 at the end\n" + " -help Display this help message\n"); } public static string pushFront(string list, string token, string delim) @@ -337,284 +335,284 @@ public static string pushBack(string list, string token, string delim) public static string popFront(string list, string delim) { - return omni.Util.nextToken(list, "", delim); + return pInvokes.Util.nextToken(list, "", delim); } [ConsoleInteraction(true)] public static void mainParseArgs() { - for (int i = 1; i < omni.iGlobal["$Game::argc"]; i++) + for (int i = 1; i < pInvokes.iGlobal["$Game::argc"]; i++) { - string arg = omni.sGlobal["$Game::argv[" + i + "]"]; - string nextArg = omni.sGlobal["$Game::argv[" + (i + 1) + "]"]; - bool hasNextarg = omni.iGlobal["$Game::argc"] - i > 1; - omni.bGlobal["$logModeSpecified"] = false; + string arg = pInvokes.sGlobal["$Game::argv[" + i + "]"]; + string nextArg = pInvokes.sGlobal["$Game::argv[" + (i + 1) + "]"]; + bool hasNextarg = pInvokes.iGlobal["$Game::argc"] - i > 1; + pInvokes.bGlobal["$logModeSpecified"] = false; Console.WriteLine(arg); switch (arg) { case "-log": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { if (nextArg.AsInt() != 0) nextArg += 4; - omni.Util.setLogMode(nextArg.AsInt()); - omni.bGlobal["$logModeSpecified"] = true; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util.setLogMode(nextArg.AsInt()); + pInvokes.bGlobal["$logModeSpecified"] = true; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -log "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -log "); break; case "-console": - omni.console.Call("enableWinConsole", new string[] {"true"}); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.console.Call("enableWinConsole", new string[] {"true"}); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-jSave": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util._echo("Saving event log to journal: '" + nextArg + "."); - omni.Util.saveJournal(nextArg); - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util._echo("Saving event log to journal: '" + nextArg + "."); + pInvokes.Util.saveJournal(nextArg); + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -jSave "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jSave "); break; case "-jPlay": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util.playJournal(nextArg); - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util.playJournal(nextArg); + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -jPlay "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jPlay "); break; case "-jPlayToVideo": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::journalName"] = nextArg; - omni.bGlobal["$VideoCapture::captureFromJournal"] = true; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::journalName"] = nextArg; + pInvokes.bGlobal["$VideoCapture::captureFromJournal"] = true; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -jPlayToVideo "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jPlayToVideo "); break; case "-vidCapFile": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::fileName"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::fileName"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapFile "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapFile "); break; case "-vidCapFPS": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::fps"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::fps"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapFPS "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapFPS "); break; case "-vidCapEncoder": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$VideoCapture::encoder"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$VideoCapture::encoder"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapEncoder "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapEncoder "); break; case "-vidCapWidth": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$videoCapture::width"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$videoCapture::width"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapWidth "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapWidth "); break; case "-vidCapHeight": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$videoCapture::height"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$videoCapture::height"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -vidCapHeight "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -vidCapHeight "); break; case "-jDebug": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util.playJournal(nextArg); - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.Util.playJournal(nextArg); + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -jDebug "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -jDebug "); break; case "-level": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { if (!nextArg.EndsWith(".mis")) { - omni.sGlobal["$levelToLoad"] = nextArg + ".mis"; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$levelToLoad"] = nextArg + ".mis"; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else { - omni.sGlobal["$levelToLoad"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$levelToLoad"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } } else - omni.console.error("Error: Missing Command Line argument. Usage: -level "); + pInvokes.console.error("Error: Missing Command Line argument. Usage: -level "); break; case "-worldeditor": - omni.bGlobal["$startWorldEditor"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$startWorldEditor"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-guieditor": - omni.bGlobal["$startGUIEditor"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$startGUIEditor"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-help": - omni.bGlobal["$displayHelp"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$displayHelp"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-compileAll": - omni.bGlobal["$compileAll"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$compileAll"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-compileTools": - omni.bGlobal["$compileTools"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$compileTools"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-genScript": - omni.bGlobal["$genScript"] = true; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$genScript"] = true; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-fullscreen": - omni.console.Call("setFullScreen", new[] {"true"}); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.console.Call("setFullScreen", new[] {"true"}); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-windowed": - omni.console.Call("setFullScreen", new[] {"false"}); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.console.Call("setFullScreen", new[] {"false"}); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-openGL": - omni.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-directX": - omni.sGlobal["$pref::Video::displayDevice"] = "D3D"; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "D3D"; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-voodoo2": - omni.sGlobal["$pref::Video::displayDevice"] = "Voodoo2"; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = "Voodoo2"; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-autoVideo": - omni.sGlobal["$pref::Video::displayDevice"] = ""; - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.sGlobal["$pref::Video::displayDevice"] = ""; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-prefs": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.Util.exec(nextArg, true, true); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.Util.exec(nextArg, true, true); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; i++; } else - omni.Util._error("Error: Missing Command Line argument. Usage: -prefs "); + pInvokes.Util._error("Error: Missing Command Line argument. Usage: -prefs "); break; case "-dedicated": - omni.bGlobal["$Server::Dedicated"] = true; - omni.bGlobal["$isDedicated"] = true; - omni.console.Call("enableWinConsole", new[] {"true"}); - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.bGlobal["$Server::Dedicated"] = true; + pInvokes.bGlobal["$isDedicated"] = true; + pInvokes.console.Call("enableWinConsole", new[] {"true"}); + pInvokes.iGlobal["$argUsed[" + i + "]"]++; break; case "-mission": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$missionArg"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$missionArg"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.console.error("Error: Missing Command Line argument. Usage: -mission "); + pInvokes.console.error("Error: Missing Command Line argument. Usage: -mission "); break; case "-connect": - omni.iGlobal["$argUsed[" + i + "]"]++; + pInvokes.iGlobal["$argUsed[" + i + "]"]++; if (hasNextarg) { - omni.sGlobal["$JoinGameAddress"] = nextArg; - omni.iGlobal["$argUsed[" + (i + 1) + "]"]++; + pInvokes.sGlobal["$JoinGameAddress"] = nextArg; + pInvokes.iGlobal["$argUsed[" + (i + 1) + "]"]++; i++; } else - omni.console.error("Error: Missing Command Line argument. Usage: -connect "); + pInvokes.console.error("Error: Missing Command Line argument. Usage: -connect "); break; } } - if (omni.bGlobal["$VideoCapture::captureFromJournal"] && (omni.sGlobal["$VideoCapture::journalName"] != "")) + if (pInvokes.bGlobal["$VideoCapture::captureFromJournal"] && (pInvokes.sGlobal["$VideoCapture::journalName"] != "")) { - if (omni.sGlobal["$VideoCapture::fileName"] == "") - omni.sGlobal["$VideoCapture::fileName"] = omni.sGlobal["$VideoCapture::journalName"]; + if (pInvokes.sGlobal["$VideoCapture::fileName"] == "") + pInvokes.sGlobal["$VideoCapture::fileName"] = pInvokes.sGlobal["$VideoCapture::journalName"]; - if (omni.sGlobal["$VideoCapture::encoder"] == "") - omni.sGlobal["$VideoCapture::encoder"] = "THEORA"; + if (pInvokes.sGlobal["$VideoCapture::encoder"] == "") + pInvokes.sGlobal["$VideoCapture::encoder"] = "THEORA"; - if (omni.sGlobal["$VideoCapture::fps"] == "") - omni.sGlobal["$VideoCapture::fps"] = "30"; + if (pInvokes.sGlobal["$VideoCapture::fps"] == "") + pInvokes.sGlobal["$VideoCapture::fps"] = "30"; - if (omni.sGlobal["$videoCapture::width"] == "") - omni.sGlobal["$videoCapture::width"] = "0"; + if (pInvokes.sGlobal["$videoCapture::width"] == "") + pInvokes.sGlobal["$videoCapture::width"] = "0"; - if (omni.sGlobal["$videoCapture::height"] == "") - omni.sGlobal["$videoCapture::height"] = "0"; + if (pInvokes.sGlobal["$videoCapture::height"] == "") + pInvokes.sGlobal["$videoCapture::height"] = "0"; - omni.Util.playJournalToVideo(omni.sGlobal["$VideoCapture::journalName"], omni.sGlobal["$VideoCapture::fileName"], omni.sGlobal["$VideoCapture::encoder"], omni.fGlobal["$VideoCapture::fps"], new Point2I(omni.sGlobal["$videoCapture::width"].AsInt(), omni.sGlobal["$videoCapture::height"].AsInt())); + pInvokes.Util.playJournalToVideo(pInvokes.sGlobal["$VideoCapture::journalName"], pInvokes.sGlobal["$VideoCapture::fileName"], pInvokes.sGlobal["$VideoCapture::encoder"], pInvokes.fGlobal["$VideoCapture::fps"], new Point2I(pInvokes.sGlobal["$videoCapture::width"].AsInt(), pInvokes.sGlobal["$videoCapture::height"].AsInt())); } } public static void SetConstantsForReferencingVideoResolutionPreference() { - omni.iGlobal["$WORD::RES_X"] = 0; - omni.iGlobal["$WORD::RES_Y"] = 1; - omni.iGlobal["$WORD::FULLSCREEN"] = 2; - omni.iGlobal["$WORD::BITDEPTH"] = 3; - omni.iGlobal["$WORD::REFRESH"] = 4; - omni.iGlobal["$WORD::AA"] = 5; + pInvokes.iGlobal["$WORD::RES_X"] = 0; + pInvokes.iGlobal["$WORD::RES_Y"] = 1; + pInvokes.iGlobal["$WORD::FULLSCREEN"] = 2; + pInvokes.iGlobal["$WORD::BITDEPTH"] = 3; + pInvokes.iGlobal["$WORD::REFRESH"] = 4; + pInvokes.iGlobal["$WORD::AA"] = 5; } [ConsoleInteraction(true)] @@ -629,41 +627,41 @@ public static void onMainStart() // Here is where we will do the video device stuff, so it overwrites the defaults // First set the PCI device variables (yes AGP/PCI-E works too) - omni.iGlobal["$isFirstPersonVar"] = 1; + pInvokes.iGlobal["$isFirstPersonVar"] = 1; // Uncomment to enable AdvancedLighting on the Mac (T3D 2009 Beta 3) - omni.bGlobal["$pref::machax::enableAdvancedLighting"] = true; + pInvokes.bGlobal["$pref::machax::enableAdvancedLighting"] = true; // Uncomment to disable ShaderGen, useful when debugging - //omni.bGlobal["$ShaderGen::GenNewShaders"] = false; + //pInvokes.bGlobal["$ShaderGen::GenNewShaders"] = false; // Uncomment to dump disassembly for any shader that is compiled to disk. // These will appear as shadername_dis.txt in the same path as the - // hlsl or glsl shader. - //omni.bGlobal["$gfx::disassembleAllShaders"] = true; + // hlsl or glsl shader. + //pInvokes.bGlobal["$gfx::disassembleAllShaders"] = true; // Uncomment useNVPerfHud to allow you to start up correctly // when you drop your executable onto NVPerfHud - //omni.bGlobal["$Video::useNVPerfHud"] = true; + //pInvokes.bGlobal["$Video::useNVPerfHud"] = true; // Uncomment these to allow you to force your app into using // a specific pixel shader version (0 is for fixed function) - //omni.bGlobal["$pref::Video::forcePixVersion"] = true; - //omni.iGlobal["$pref::Video::forcedPixVersion"] = 0; + //pInvokes.bGlobal["$pref::Video::forcePixVersion"] = true; + //pInvokes.iGlobal["$pref::Video::forcedPixVersion"] = 0; - //if (omni.sGlobal["$platform"] == "macos") - //omni.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; + //if (pInvokes.sGlobal["$platform"] == "macos") + //pInvokes.sGlobal["$pref::Video::displayDevice"] = "OpenGL"; //else - //omni.sGlobal["$pref::Video::displayDevice"] = "D3D9"; + //pInvokes.sGlobal["$pref::Video::displayDevice"] = "D3D9"; core.initializeCore(); - omni.Util._echo(" % - Initialized Core"); + pInvokes.Util._echo(" % - Initialized Core"); #region FPS - omni.console.print("\n--------- Initializing Directory: scripts ---------"); + pInvokes.console.print("\n--------- Initializing Directory: scripts ---------"); // Init the physics plugin. - omni.Util.physicsInit("Bullet"); + pInvokes.Util.physicsInit("Bullet"); // Start up the audio system. audio.sfxStartup(); @@ -675,7 +673,7 @@ public static void onMainStart() server.initServer(); // Start up in either client, or dedicated server mode - if (omni.bGlobal["$Server::Dedicated"]) + if (pInvokes.bGlobal["$Server::Dedicated"]) server.initDedicated(); else init.initClient(); @@ -686,12 +684,12 @@ public static void onMainStart() [ConsoleInteraction(true)] public static void mainloadKeybindings() { - omni.iGlobal["$keybindCount"] = 0; + pInvokes.iGlobal["$keybindCount"] = 0; // Load up the active projects keybinds. - if (omni.Util.isFunction("setupKeybinds")) - omni.console.Call("setupKeybinds"); + if (pInvokes.Util.isFunction("setupKeybinds")) + pInvokes.console.Call("setupKeybinds"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/AI/AI.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/AI/AI.cs index 2aaa6e75..a4fa7b71 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/AI/AI.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/AI/AI.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -55,7 +55,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server.AI public class AI { private static readonly Random r = new Random(); - private static readonly pInvokes omni = new pInvokes(); internal static readonly ConcurrentList m_thoughtqueue = new ConcurrentList(); internal static int _lastcount; private static readonly object _lastcount_lock = new object(); @@ -94,7 +93,7 @@ public static void createAI(int count) if (lastcount > 0) { - omni.console.error("Mobs already spawned"); + pInvokes.console.error("Mobs already spawned"); return; } using (BackgroundWorker bwr_AIThought = new BackgroundWorker()) @@ -134,8 +133,8 @@ public static void deleteAI() for (int i = 0; i < lastcount; i++) { ScriptObject mobholder = "Mob" + i.AsString(); - omni.Util.cancelAll(mobholder); - omni.Util.cancelAll(mobholder["player"]); + pInvokes.Util.cancelAll(mobholder); + pInvokes.Util.cancelAll(mobholder["player"]); mobholder["player"].delete(); mobholder.delete(); } @@ -227,7 +226,7 @@ public static UInt32 Spawn(string name, TransformF spawnpoint) /// public static DemoPlayer SpawnOnPath(string ainame, SimSet path) { - if (!omni.console.isObject(path)) + if (!pInvokes.console.isObject(path)) return null; Marker node = path.getObject((uint) r.Next(0, path.getCount() - 1)); @@ -248,7 +247,7 @@ public static void spawnAI(ScriptObject aiManager) { if (!aiManager.isObject()) { - omni.console.error("Bad aiManager!"); + pInvokes.console.error("Bad aiManager!"); return; } @@ -256,12 +255,12 @@ public static void spawnAI(ScriptObject aiManager) if (aiPlayer == null) { - omni.console.error("UNABLE TO SPAWN MONSTER!@!!!!!a"); + pInvokes.console.error("UNABLE TO SPAWN MONSTER!@!!!!!a"); return; } - if (!omni.console.isObject(aiPlayer)) + if (!pInvokes.console.isObject(aiPlayer)) { - omni.console.error("UNABLE TO SPAWN MONSTER!@!!!!!"); + pInvokes.console.error("UNABLE TO SPAWN MONSTER!@!!!!!"); return; } @@ -370,4 +369,4 @@ public threadparam(int delay, int mobroot) } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/GameConnection.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/GameConnection.cs index cd53a70a..606d4cc3 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/GameConnection.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/GameConnection.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -56,8 +56,6 @@ partial class GameConnection { #region Static Variables - private static readonly pInvokes tst = new pInvokes(); - #endregion #region Overrides @@ -87,7 +85,7 @@ public override void onDrop(string disconnectReason) /// anything else will be sent back as an error to the client. /// All the connect args are passed also to onConnectRequest /// - /// NOTE: Need to fallback to Con::execute() as IMPLEMENT_CALLBACK does not + /// NOTE: Need to fallback to Con::execute() as IMPLEMENT_CALLBACK does not /// support variadic functions. ///todo research this a bit, from what I read this function can take up to 16 params. It's a console execute because of variable args. /// @@ -210,12 +208,12 @@ public virtual int GetDeaths(GameConnection client) public virtual void onLeaveMissionArea() { - message.MessageClient(this, "MsgClientJoin", tst.console.ColorEncode(@"\c2Now leaving the mission area!")); + message.MessageClient(this, "MsgClientJoin", pInvokes.console.ColorEncode(@"\c2Now leaving the mission area!")); } public virtual void onEnterMissionArea() { - message.MessageClient(this, "MsgClientJoin", tst.console.ColorEncode(@"\c2Now entering the mission area!")); + message.MessageClient(this, "MsgClientJoin", pInvokes.console.ColorEncode(@"\c2Now entering the mission area!")); } #endregion @@ -881,4 +879,4 @@ public virtual void onDeath(GameBase sourceobject, GameConnection sourceclient, missionLoad.cycleGame(); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/ShapeBase/ShapeBase.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/ShapeBase/ShapeBase.cs index 811c978d..633e9e98 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/ShapeBase/ShapeBase.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/ShapeBase/ShapeBase.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -49,12 +49,10 @@ namespace WinterLeaf.Demo.Full.Models.User.Extendable { /// - /// + /// /// public partial class ShapeBase { - private static pInvokes tst = new pInvokes(); - public override bool OnFunctionNotFoundCallTorqueScript() { return false; @@ -98,7 +96,7 @@ public virtual void clearDamageDt() if (this["damageSchedule"] == string.Empty) return; - new pInvokes().Util.cancel(this["damageSchedule"].AsInt()); + pInvokes.Util.cancel(this["damageSchedule"].AsInt()); this["damageSchedule"] = string.Empty; } @@ -441,4 +439,4 @@ public virtual void cycleWeapon(string direction) Use(weapon); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs index 3aee0bf1..e4357ae0 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/SoftBodies/SoftBodies.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. //----------------------------------------------------------------------------- // Logicking's Game Factory @@ -46,8 +46,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server.SoftBodies { public class SoftBodies { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { #region SoftBodyData ( PhysFlag ) oc_Newobject1 @@ -91,7 +89,7 @@ public static void initialize() //----------------------------------------------------------------------------- // for Game Mechanics Editor //----------------------------------------------------------------------------- - omni.Util.activatePackage("TemplateFunctions"); + pInvokes.Util.activatePackage("TemplateFunctions"); //TODO FIX //inheritTemplate("PhysFlag", "AbstractRigidBody"); @@ -100,7 +98,7 @@ public static void initialize() //inheritTemplate("PhysSoftSphere", "AbstractRigidBody"); //registerTemplate("PhysSoftSphere", "Physics", "SoftBodyData::create(PhysSoftSphere);"); - omni.Util.deactivatePackage("TemplateFunctions"); + pInvokes.Util.deactivatePackage("TemplateFunctions"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/centerPrint.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/centerPrint.cs index 4002680f..f3fdf28b 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/centerPrint.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/centerPrint.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -47,8 +47,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { public class centerPrint { - public static pInvokes t3d = new pInvokes(); - [ConsoleInteraction(true)] public static void CenterPrintAll(string message, string time, string lines) { @@ -56,8 +54,8 @@ public static void CenterPrintAll(string message, string time, string lines) lines = "1"; foreach (GameConnection client in - t3d.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) - t3d.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); + pInvokes.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) + pInvokes.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] @@ -66,8 +64,8 @@ public static void BottomPrintAll(string message, string time, string lines) if (lines == "" || lines.AsInt() > 3 || lines.AsInt() < 1) lines = "1"; foreach (GameConnection client in - t3d.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) - t3d.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); + pInvokes.ClientGroup.Where(client => !((GameConnection) client).isAIControlled())) + pInvokes.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] @@ -76,7 +74,7 @@ public static void CenterPrint(GameConnection client, string message, string tim if (lines == "" || lines.AsInt() > 3 || lines.AsInt() < 1) lines = "1"; - t3d.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); + pInvokes.console.commandToClient(client, "centerPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] @@ -85,19 +83,19 @@ public static void BottomPrint(GameConnection client, string message, string tim if (lines == "" || lines.AsInt() > 3 || lines.AsInt() < 1) lines = "1"; - t3d.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); + pInvokes.console.commandToClient(client, "bottomPrint", new[] {message, time, lines}); } [ConsoleInteraction(true)] public static void ClearCenterPrint(GameConnection client) { - t3d.console.commandToClient(client, "ClearCenterPrint"); + pInvokes.console.commandToClient(client, "ClearCenterPrint"); } [ConsoleInteraction(true)] public static void ClearBottomPrint(GameConnection client) { - t3d.console.commandToClient(client, "clearBottomPrint"); + pInvokes.console.commandToClient(client, "clearBottomPrint"); } [ConsoleInteraction(true)] @@ -109,10 +107,10 @@ public static void ClearCenterPrintAll() { GameConnection cl = ClientGroup.getObject(i); if (!cl.isAIControlled()) - t3d.console.commandToClient(cl, "ClearCenterPrint"); + pInvokes.console.commandToClient(cl, "ClearCenterPrint"); } - //foreach (uint client in t3d.ClientGroup.Cast().Where(client => !client.isAIControlled())) - // t3d.console.commandToClient(client.AsString(), "ClearCenterPrint"); + //foreach (uint client in pInvokes.ClientGroup.Cast().Where(client => !client.isAIControlled())) + // pInvokes.console.commandToClient(client.AsString(), "ClearCenterPrint"); } [ConsoleInteraction(true)] @@ -124,10 +122,10 @@ public static void ClearBottomPrintAll() { GameConnection cl = ClientGroup.getObject(i); if (!cl.isAIControlled()) - t3d.console.commandToClient(cl, "ClearBottomPrint"); + pInvokes.console.commandToClient(cl, "ClearBottomPrint"); } - //foreach (uint client in t3d.ClientGroup.Cast().Where(client => !client.isAIControlled())) - // t3d.console.commandToClient(client.AsString(), "clearBottomPrint"); + //foreach (uint client in pInvokes.ClientGroup.Cast().Where(client => !client.isAIControlled())) + // pInvokes.console.commandToClient(client.AsString(), "clearBottomPrint"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/commands.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/commands.cs index 8a977ccd..638d9d9a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/commands.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/commands.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -51,7 +51,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { public class commands { - private static readonly pInvokes omni = new pInvokes(); //----------------------------------------------------------------------------- // Misc. server commands avialable to clients //----------------------------------------------------------------------------- @@ -64,7 +63,7 @@ public static void syncEditorGui() { EditorGui EditorGui = "EditorGui"; if (EditorGui.isObject()) - //omni.console.Call("EditorGui", "syncCameraGui"); + //pInvokes.console.Call("EditorGui", "syncCameraGui"); EditorGui.syncCameraGui(); } @@ -113,7 +112,7 @@ public static void serverCmdSetEditorCameraPlayer(GameConnection client) ((Player) client["player"]).setVelocity(new Point3F("0 0 0")); client.setControlObject(client["player"]); client.setFirstPerson(true); - omni.bGlobal["$isFirstPersonVar"] = true; + pInvokes.bGlobal["$isFirstPersonVar"] = true; syncEditorGui(); } @@ -123,7 +122,7 @@ public static void serverCmdSetEditorCameraPlayerThird(GameConnection client) ((Player) client["player"]).setVelocity(new Point3F("0 0 0")); client.setControlObject(client["player"]); client.setFirstPerson(false); - omni.bGlobal["$isFirstPersonVar"] = false; + pInvokes.bGlobal["$isFirstPersonVar"] = false; syncEditorGui(); } @@ -136,7 +135,7 @@ public static void serverCmdDropPlayerAtCamera(GameConnection client) ShapeBase obj = null; obj = player.getObjectMount(); - if (!omni.console.isObject(obj)) + if (!pInvokes.console.isObject(obj)) obj = client["player"]; obj.setTransform(((Extendable.Camera) client["Camera"]).getTransform()); @@ -264,21 +263,21 @@ public static void serverCmdEditorCameraAutoFit(GameConnection client, float rad [ConsoleInteraction(true)] public static void serverCmdSAD(GameConnection client, string password) { - if (password == string.Empty || password != omni.sGlobal["$Pref::Server::AdminPassword"]) + if (password == string.Empty || password != pInvokes.sGlobal["$Pref::Server::AdminPassword"]) return; client["isAdmin"] = true.AsString(); client["isSuperAdmin"] = true.AsString(); - string name = omni.console.getTaggedString(client["playerName"]); + string name = pInvokes.console.getTaggedString(client["playerName"]); - message.MessageAll("MsgAdminForce", omni.console.ColorEncode(string.Format(@"\c2{0} has become Admin by force.", name)), client); + message.MessageAll("MsgAdminForce", pInvokes.console.ColorEncode(string.Format(@"\c2{0} has become Admin by force.", name)), client); } [ConsoleInteraction(true)] public static void serverCmdSADSetPassword(GameConnection client, string password) { if (client["isSuperAdmin"].AsBool()) - omni.sGlobal["$Pref::Server::AdminPassword"] = password; + pInvokes.sGlobal["$Pref::Server::AdminPassword"] = password; } //---------------------------------------------------------------------------- @@ -288,17 +287,17 @@ public static void serverCmdSADSetPassword(GameConnection client, string passwor [ConsoleInteraction(true)] public static void serverCmdTeamMessageSent(GameConnection client, string text) { - if (text.Trim().Length >= omni.iGlobal["$Pref::Server::MaxChatLen"]) - text = text.Substring(0, omni.iGlobal["$Pref::Server::MaxChatLen"]); - message.ChatMessageTeam(client, client["team"], omni.console.ColorEncode(@"\c3%1: %2"), client["playerName"], text); + if (text.Trim().Length >= pInvokes.iGlobal["$Pref::Server::MaxChatLen"]) + text = text.Substring(0, pInvokes.iGlobal["$Pref::Server::MaxChatLen"]); + message.ChatMessageTeam(client, client["team"], pInvokes.console.ColorEncode(@"\c3%1: %2"), client["playerName"], text); } [ConsoleInteraction(true)] public static void ServerCmdMessageSent(GameConnection client, string text) { - if (text.Trim().Length >= omni.iGlobal["$Pref::Server::MaxChatLen"]) - text = text.Substring(0, omni.iGlobal["$Pref::Server::MaxChatLen"]); - message.ChatMessageAll(client, omni.console.ColorEncode(@"\c4%1: %2"), client["playerName"], text); + if (text.Trim().Length >= pInvokes.iGlobal["$Pref::Server::MaxChatLen"]) + text = text.Substring(0, pInvokes.iGlobal["$Pref::Server::MaxChatLen"]); + message.ChatMessageAll(client, pInvokes.console.ColorEncode(@"\c4%1: %2"), client["playerName"], text); } [ConsoleInteraction(true)] @@ -327,10 +326,10 @@ public static void serverCmdThrow(GameConnection client, string data) { Player player = client["player"]; - if (!player.isObject() || (player.getState() == "Dead") || !omni.bGlobal["$Game::Running"]) + if (!player.isObject() || (player.getState() == "Dead") || !pInvokes.bGlobal["$Game::Running"]) return; - SimObject mountedimage = player.getMountedImage(omni.iGlobal["$WeaponSlot"]); + SimObject mountedimage = player.getMountedImage(pInvokes.iGlobal["$WeaponSlot"]); switch (data) { case "Weapon": @@ -369,7 +368,7 @@ public static void serverCmdCycleWeapon(GameConnection client, string direction) [ConsoleInteraction(true)] public static void serverCmdUnmountWeapon(GameConnection client) { - ((Player) client["player"]).unmountImage(omni.iGlobal["$WeaponSlot"]); + ((Player) client["player"]).unmountImage(pInvokes.iGlobal["$WeaponSlot"]); } [ConsoleInteraction(true)] @@ -377,13 +376,13 @@ public static void serverCmdReloadWeapon(GameConnection client) { Player player = client["player"]; - WeaponImage image = player.getMountedImage(omni.iGlobal["$WeaponSlot"]); + WeaponImage image = player.getMountedImage(pInvokes.iGlobal["$WeaponSlot"]); if (player.getInventory(image["ammo"]) == image["ammo.maxInventory"].AsInt()) return; if (image > 0) - image.clearAmmoClip(player, omni.sGlobal["$WeaponSlot"].AsInt()); + image.clearAmmoClip(player, pInvokes.sGlobal["$WeaponSlot"].AsInt()); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/gameDM.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/gameDM.cs index 7454d16b..5f552d0f 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/gameDM.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/gameDM.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using WinterLeaf.Demo.Full.Models.User.CustomObjects.Utilities; using WinterLeaf.Demo.Full.Models.User.Extendable; @@ -43,8 +43,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { internal class gameDM : gameBase { - public static pInvokes omni = new pInvokes(); - //To extend the base game functionality override the functions here. public override void onMissionLoaded() { @@ -83,10 +81,10 @@ public static void sendMsgClientKilled_Default(string msgtype, GameConnection cl if (sourceclient == client) sendMsgClientKilled_Suicide(msgtype, client, sourceclient, damloc); - else if (omni.console.GetVarString(sourceclient["team"]) != string.Empty && sourceclient["team"] != client["team"]) + else if (pInvokes.console.GetVarString(sourceclient["team"]) != string.Empty && sourceclient["team"] != client["team"]) message.MessageAll(msgtype, "%1 killed by %2 - friendly fire!", client["playerName"], sourceclient["playerName"]); else message.MessageAll(msgtype, "%1 gets nailed by %2!", client["playerName"], sourceclient.isObject() ? sourceclient["playerName"] : "a Bot!"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/kickban.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/kickban.cs index e1803d77..d63fba52 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/kickban.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/kickban.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -46,24 +46,22 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { public class kickban { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true)] public static void Kick(GameConnection client) { - message.MessageAll("MsgAdminForce", omni.console.ColorEncode(@"\c2The Admin has kicked %1."), client["playerName"]); + message.MessageAll("MsgAdminForce", pInvokes.console.ColorEncode(@"\c2The Admin has kicked %1."), client["playerName"]); if (!client.isAIControlled()) - omni.console.Call_Classname("BanList", "add", new[] {client["guid"], client.getAddress(), omni.sGlobal["$Pref::Server::KickBanTime"]}); + pInvokes.console.Call_Classname("BanList", "add", new[] {client["guid"], client.getAddress(), pInvokes.sGlobal["$Pref::Server::KickBanTime"]}); client.delete("You have been kicked from this server"); } [ConsoleInteraction(true)] public static void Ban(GameConnection client) { - message.MessageAll("MsgAdminForce", omni.console.ColorEncode(@"\c2The Admin has banned %1."), client["playerName"]); + message.MessageAll("MsgAdminForce", pInvokes.console.ColorEncode(@"\c2The Admin has banned %1."), client["playerName"]); if (!client.isAIControlled()) - omni.console.Call_Classname("BanList", "add", new[] {client["guid"], client.getAddress(), omni.sGlobal["$Pref::Server::BanTime"]}); + pInvokes.console.Call_Classname("BanList", "add", new[] {client["guid"], client.getAddress(), pInvokes.sGlobal["$Pref::Server::BanTime"]}); client.delete("You have been banned from this server"); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/server.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/server.cs index b9f80d1e..401622a6 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/server.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/server.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -48,18 +48,16 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { public class server { - public static pInvokes t3d = new pInvokes(); - public static void LoadDefaults() { // List of master servers to query, each one is tried in order // until one responds - t3d.iGlobal["$Pref::Server::RegionMask"] = 2; - t3d.sGlobal["$pref::Master[0]"] = "2:master.garagegames.com:28002"; + pInvokes.iGlobal["$Pref::Server::RegionMask"] = 2; + pInvokes.sGlobal["$pref::Master[0]"] = "2:master.garagegames.com:28002"; // Information about the server - t3d.sGlobal["$Pref::Server::Name"] = "Torque 3D Server"; - t3d.sGlobal["$Pref::Server::Info"] = "This is a Torque 3D server."; + pInvokes.sGlobal["$Pref::Server::Name"] = "Torque 3D Server"; + pInvokes.sGlobal["$Pref::Server::Info"] = "This is a Torque 3D server."; // The connection error message is transmitted to the client immediatly // on connection, if any further error occures during the connection @@ -67,68 +65,68 @@ public static void LoadDefaults() // message is display. This message should be replaced with information // usefull to the client, such as the url or ftp address of where the // latest version of the game can be obtained. - t3d.sGlobal["$Pref::Server::ConnectionError"] = "You do not have the correct version of the FPS starter kit or " + "the related art needed to play on this server, please contact " + "the server operator for more information."; + pInvokes.sGlobal["$Pref::Server::ConnectionError"] = "You do not have the correct version of the FPS starter kit or " + "the related art needed to play on this server, please contact " + "the server operator for more information."; - // The network port is also defined by the client, this value + // The network port is also defined by the client, this value // overrides pref::net::port for dedicated servers - t3d.iGlobal["$Pref::Server::Port"] = 28000; + pInvokes.iGlobal["$Pref::Server::Port"] = 28000; // If the password is set, clients must provide it in order // to connect to the server - t3d.sGlobal["$Pref::Server::Password"] = string.Empty; + pInvokes.sGlobal["$Pref::Server::Password"] = string.Empty; // Password for admin clients - t3d.sGlobal["$Pref::Server::AdminPassword"] = string.Empty; + pInvokes.sGlobal["$Pref::Server::AdminPassword"] = string.Empty; // Misc server settings. - t3d.iGlobal["$Pref::Server::MaxPlayers"] = 64; - t3d.iGlobal["$Pref::Server::TimeLimit"] = 20; // In minutes - t3d.iGlobal["$Pref::Server::KickBanTime"] = 300; // specified in seconds - t3d.iGlobal["$Pref::Server::BanTime"] = 1800; // specified in seconds - t3d.iGlobal["$Pref::Server::FloodProtectionEnabled"] = 1; - t3d.iGlobal["$Pref::Server::MaxChatLen"] = 120; + pInvokes.iGlobal["$Pref::Server::MaxPlayers"] = 64; + pInvokes.iGlobal["$Pref::Server::TimeLimit"] = 20; // In minutes + pInvokes.iGlobal["$Pref::Server::KickBanTime"] = 300; // specified in seconds + pInvokes.iGlobal["$Pref::Server::BanTime"] = 1800; // specified in seconds + pInvokes.iGlobal["$Pref::Server::FloodProtectionEnabled"] = 1; + pInvokes.iGlobal["$Pref::Server::MaxChatLen"] = 120; - t3d.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"] = typeof (GameConnectionDM).FullName; + pInvokes.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"] = typeof (GameConnectionDM).FullName; //todo Now add your own game specific server preferences as well as any overloaded core defaults here. // Finally load the preferences saved from the last // game execution if they exist. - if (t3d.sGlobal["$platform"] != "xenon") + if (pInvokes.sGlobal["$platform"] != "xenon") { //Todo Settings - Switch this back when fixed. - t3d.Util.exec("prefs.server.cs", false, false); + pInvokes.Util.exec("prefs.server.cs", false, false); //Settings.LoadSection("scripts/server/prefs.cs"); } else - t3d.Util._error("Not loading server prefs.cs on Xbox360"); + pInvokes.Util._error("Not loading server prefs.cs on Xbox360"); } public static void initDedicated() { - t3d.console.Call("enableWinConsole", new[] {"true"}); + pInvokes.console.Call("enableWinConsole", new[] {"true"}); //con.Eval("enableWinConsole(true);"); - t3d.console.print(@"\n--------- Starting Dedicated Server ---------"); + pInvokes.console.print(@"\n--------- Starting Dedicated Server ---------"); // Make sure this variable reflects the correct state. - t3d.bGlobal["$Server::Dedicated"] = true; + pInvokes.bGlobal["$Server::Dedicated"] = true; // The server isn't started unless a mission has been specified. - if (t3d.sGlobal["$missionArg"] != string.Empty) - createServer("MultiPlayer", t3d.sGlobal["$missionArg"]); + if (pInvokes.sGlobal["$missionArg"] != string.Empty) + createServer("MultiPlayer", pInvokes.sGlobal["$missionArg"]); else - t3d.console.print("No mission specified (use -mission filename)"); + pInvokes.console.print("No mission specified (use -mission filename)"); } public static void initServer() { - t3d.console.print("\n--------- Initializing " + t3d.sGlobal["$appName"] + ": Server Scripts ---------"); + pInvokes.console.print("\n--------- Initializing " + pInvokes.sGlobal["$appName"] + ": Server Scripts ---------"); // Server::Status is returned in the Game Info Query and represents the // current status of the server. This string sould be very short. - t3d.sGlobal["$Server::Status"] = "Unknown"; + pInvokes.sGlobal["$Server::Status"] = "Unknown"; // Turn on testing/debug script functions - t3d.bGlobal["$Server::TestCheats"] = false; + pInvokes.bGlobal["$Server::TestCheats"] = false; // Specify where the mission files are. - t3d.sGlobal["$Server::MissionFileSpec"] = "levels/*.mis"; + pInvokes.sGlobal["$Server::MissionFileSpec"] = "levels/*.mis"; // The common module provides the basic server functionality initBaseServer(); @@ -143,16 +141,16 @@ public static void initBaseServer() missionLoad.InitMissionLoad(); game.initGame(); spawn.init(); - t3d.iGlobal["$Camera::movementSpeed"] = 30; + pInvokes.iGlobal["$Camera::movementSpeed"] = 30; Client.CenterPrint.centerPrint.initialize(); } public static void portInit(int port) { int failCount = 0; - while (failCount < 10 && !t3d.Util.setNetPort(port)) + while (failCount < 10 && !pInvokes.Util.setNetPort(port)) { - t3d.console.print("Port init failed on port " + port + " trying next port."); + pInvokes.console.print("Port init failed on port " + port + " trying next port."); port++; failCount++; } @@ -163,8 +161,8 @@ public static void portInit(int port) /// create a local client connection to the server. // /// @return true if successful. - /// - /// + /// + /// /// /// /// @@ -174,12 +172,12 @@ public static bool createAndConnectToLocalServer(string serverType, string level if (!createServer(serverType, level)) return false; - GameConnection conn = new ObjectCreator("GameConnection", "ServerConnection", t3d.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"]).Create(); + GameConnection conn = new ObjectCreator("GameConnection", "ServerConnection", pInvokes.sGlobal["$Pref::Server::Net::ClientGameConnectionModelClass"]).Create(); ((SimGroup) "RootGroup").add(conn); - conn.setConnectArgs(t3d.sGlobal["$pref::Player::Name"]); - conn.setJoinPassword(t3d.sGlobal["$Client::Password"]); + conn.setConnectArgs(pInvokes.sGlobal["$pref::Player::Name"]); + conn.setJoinPassword(pInvokes.sGlobal["$Client::Password"]); if (conn.connectLocal() != string.Empty) { @@ -200,51 +198,51 @@ public static bool createAndConnectToLocalServer(string serverType, string level [ConsoleInteraction(true)] public static bool createServer(string serverType, string level) { - t3d.iGlobal["$Server::Session"]++; + pInvokes.iGlobal["$Server::Session"]++; if (level == string.Empty) { - t3d.console.error("createServer(): level name unspecified"); + pInvokes.console.error("createServer(): level name unspecified"); return false; } - level = t3d.Util.makeRelativePath(level, t3d.Util.getWorkingDirectory()); + level = pInvokes.Util.makeRelativePath(level, pInvokes.Util.getWorkingDirectory()); destroyServer(); - t3d.iGlobal["$missionSequence"] = 0; - t3d.iGlobal["$Server::PlayerCount"] = 0; - t3d.sGlobal["$Server::ServerType"] = serverType; - t3d.sGlobal["$Server::LoadFailMsg"] = string.Empty; - t3d.bGlobal["$Physics::isSinglePlayer"] = true; + pInvokes.iGlobal["$missionSequence"] = 0; + pInvokes.iGlobal["$Server::PlayerCount"] = 0; + pInvokes.sGlobal["$Server::ServerType"] = serverType; + pInvokes.sGlobal["$Server::LoadFailMsg"] = string.Empty; + pInvokes.bGlobal["$Physics::isSinglePlayer"] = true; // Setup for multi-player, the network must have been // initialized before now. if (serverType == "MultiPlayer") { - //t3d.iGlobal["$pref::Net::PacketRateToClient"] = 32; - //t3d.iGlobal["$pref::Net::PacketRateToServer"] = 32; - //t3d.iGlobal["$pref::Net::PacketSize"] = 200; + //pInvokes.iGlobal["$pref::Net::PacketRateToClient"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketRateToServer"] = 32; + //pInvokes.iGlobal["$pref::Net::PacketSize"] = 200; - t3d.bGlobal["$Physics::isSinglePlayer"] = false; - t3d.console.print("Starting multiplayer mode"); + pInvokes.bGlobal["$Physics::isSinglePlayer"] = false; + pInvokes.console.print("Starting multiplayer mode"); // Make sure the network port is set to the correct pref. - portInit(t3d.iGlobal["$Pref::Server::Port"]); + portInit(pInvokes.iGlobal["$Pref::Server::Port"]); - t3d.Util.allowConnections(true); + pInvokes.Util.allowConnections(true); - if (t3d.sGlobal["$pref::Net::DisplayOnMaster"] != "Never") - t3d.Util._schedule("0", "0", "startHeartBeat"); + if (pInvokes.sGlobal["$pref::Net::DisplayOnMaster"] != "Never") + pInvokes.Util._schedule("0", "0", "startHeartBeat"); } // Create the ServerGroup that will persist for the lifetime of the server. new ObjectCreator("SimGroup", "ServerGroup").Create(); - t3d.Util.exec("core/art/datablocks/datablockExec.cs", false, false); + pInvokes.Util.exec("core/art/datablocks/datablockExec.cs", false, false); game.onServerCreated(); - t3d.console.Call("loadMission", new[] {level, "true"}); + pInvokes.console.Call("loadMission", new[] {level, "true"}); return true; } @@ -255,12 +253,12 @@ public static bool createServer(string serverType, string level) [ConsoleInteraction(true)] public static void destroyServer() { - t3d.sGlobal["$Server::ServerType"] = string.Empty; - t3d.Util.allowConnections(false); + pInvokes.sGlobal["$Server::ServerType"] = string.Empty; + pInvokes.Util.allowConnections(false); - t3d.console.Call("stopHeartbeat"); + pInvokes.console.Call("stopHeartbeat"); - t3d.bGlobal["$missionRunning"] = false; + pInvokes.bGlobal["$missionRunning"] = false; // End any running levels @@ -273,24 +271,24 @@ public static void destroyServer() "ServerGroup".delete(); // Delete all the connections: - while (t3d.ClientGroup.Count().AsBool()) - t3d.ClientGroup[0].AsString().delete(); + while (pInvokes.ClientGroup.Count().AsBool()) + pInvokes.ClientGroup[0].AsString().delete(); - t3d.sGlobal["$Server::GuidList"] = string.Empty; + pInvokes.sGlobal["$Server::GuidList"] = string.Empty; // Delete all the data blocks... - t3d.Util.deleteDataBlocks(); + pInvokes.Util.deleteDataBlocks(); // Save any server settings - t3d.console.print("Exporting server prefs..."); + pInvokes.console.print("Exporting server prefs..."); //Todo Settings - Switch this back when fixed. - t3d.Util.export("$Pref::Server::*", "core/scripts/prefs.cs", false); - //t3d.Util.exportToSettings("$Pref::Server::*", "core/scripts/prefs.cs", false); + pInvokes.Util.export("$Pref::Server::*", "core/scripts/prefs.cs", false); + //pInvokes.Util.exportToSettings("$Pref::Server::*", "core/scripts/prefs.cs", false); // Increase the server session number. This is used to make sure we're // working with the server session we think we are. - t3d.iGlobal["$Server::Session"]++; + pInvokes.iGlobal["$Server::Session"]++; } [ConsoleInteraction(true)] @@ -302,15 +300,15 @@ public static string onServerInfoQuery() [ConsoleInteraction(true)] public static void resetServerDefaults() { - t3d.console.print("Resetting server defaults..."); + pInvokes.console.print("Resetting server defaults..."); LoadDefaults(); //Todo Settings - Switch this back when fixed. //Settings.LoadSection("core/scripts/prefs.cs"); - t3d.Util.exec("core/scripts/prefs.cs", false, false); + pInvokes.Util.exec("core/scripts/prefs.cs", false, false); // Reload the current level - missionLoad.loadMission(t3d.sGlobal["$Server::MissionFile"], false); + missionLoad.loadMission(pInvokes.sGlobal["$Server::MissionFile"], false); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/spawn.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/spawn.cs index 0763adf3..ba40aa6a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/spawn.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Server/spawn.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -43,15 +43,13 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Server { public class spawn { - private static readonly pInvokes omni = new pInvokes(); - public static void init() { // Leave $Game::defaultPlayerClass and $Game::defaultPlayerDataBlock as empty strings ("") // to spawn a the $Game::defaultCameraClass as the control object. - omni.sGlobal["$Game::DefaultPlayerClass"] = "Player"; - omni.sGlobal["$Game::DefaultPlayerDataBlock"] = "DefaultPlayerData"; - omni.sGlobal["$Game::DefaultPlayerSpawnGroups"] = "PlayerSpawnPoints"; + pInvokes.sGlobal["$Game::DefaultPlayerClass"] = "Player"; + pInvokes.sGlobal["$Game::DefaultPlayerDataBlock"] = "DefaultPlayerData"; + pInvokes.sGlobal["$Game::DefaultPlayerSpawnGroups"] = "PlayerSpawnPoints"; //----------------------------------------------------------------------------- // What kind of "camera" is spawned is either controlled directly by the @@ -59,9 +57,9 @@ public static void init() // which SimGroups to attempt to select the spawn sphere's from by walking down // the list of SpawnGroups till it finds a valid spawn object. //----------------------------------------------------------------------------- - omni.sGlobal["$Game::DefaultCameraClass"] = "Camera"; - omni.sGlobal["$Game::DefaultCameraDataBlock"] = "Observer"; - omni.sGlobal["$Game::DefaultCameraSpawnGroups"] = "CameraSpawnPoints PlayerSpawnPoints"; + pInvokes.sGlobal["$Game::DefaultCameraClass"] = "Camera"; + pInvokes.sGlobal["$Game::DefaultCameraDataBlock"] = "Observer"; + pInvokes.sGlobal["$Game::DefaultCameraSpawnGroups"] = "CameraSpawnPoints PlayerSpawnPoints"; } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Base/Utils/UndoActionReparentObjects.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Base/Utils/UndoActionReparentObjects.ed.cs index c5318dc1..25e80c8a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Base/Utils/UndoActionReparentObjects.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Base/Utils/UndoActionReparentObjects.ed.cs @@ -56,13 +56,13 @@ public int numObjects [ConsoleInteraction] public string create(string treeView) { - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); ObjectCreator undoObject = new ObjectCreator("UndoScriptAction", "", typeof (UndoActionReparentObjects)); //undoObject["class"] = "UndoActionReparentObjects"; undoObject["numObjects"] = "0"; undoObject["treeView"] = treeView; UndoActionReparentObjects action = undoObject.Create(); - omni.Util.popInstantGroup(); + Util.popInstantGroup(); return action; } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ConvexEditor/gui/CodeBehind/ConvexEditorPlugin.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ConvexEditor/gui/CodeBehind/ConvexEditorPlugin.cs index 6b373a3f..8699954a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ConvexEditor/gui/CodeBehind/ConvexEditorPlugin.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ConvexEditor/gui/CodeBehind/ConvexEditorPlugin.cs @@ -80,7 +80,7 @@ public override void onWorldEditorStartup() // Add ourselves to the ToolsToolbar string tooltip = "Sketch Tool (" + accel + ")"; - EditorGui.addToToolsToolbar("ConvexEditorPlugin", "ConvexEditorPalette", omni.Util._expandFilename("tools/convexEditor/images/convex-editor-btn"), tooltip); + EditorGui.addToToolsToolbar("ConvexEditorPlugin", "ConvexEditorPalette", Util._expandFilename("tools/convexEditor/images/convex-editor-btn"), tooltip); //connect editor windows ((GuiWindowCollapseCtrl) "ConvexEditorOptionsWindow").attachTo("ConvexEditorTreeWindow"); @@ -102,7 +102,7 @@ public override void onWorldEditorStartup() this["popupMenu"] = ConvexActionsMenu; //exec( "./convexEditorSettingsTab.ed.gui" ); - omni.console.Call("ConvexEditorSettingsTab_initialize"); + console.Call("ConvexEditorSettingsTab_initialize"); ESettingsWindow.addTabPage("EConvexEditorSettingsPage"); } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditor.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditor.cs index 9e40f327..d109d77e 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditor.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditor.cs @@ -48,12 +48,10 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.DatablockEditor.gui.Co { public class DatablockEditor { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "DatablockEditor_initialize")] public static void initialize() { - omni.sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"] = "art/datablocks/managedDatablocks.cs"; + pInvokes.sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"] = "art/datablocks/managedDatablocks.cs"; new ObjectCreator("SimSet", "UnlistedDatablocks").Create(); } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditorPlugin.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditorPlugin.cs index 8198819b..351e6e0c 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditorPlugin.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DatablockEditor/gui/CodeBehind/DatablockEditorPlugin.cs @@ -51,8 +51,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.DatablockEditor.gui.Co [TypeConverter(typeof (TypeConverterGeneric))] public class DatablockEditorPlugin : WorldEditorPlugin { - private static readonly pInvokes omni = new pInvokes(); - internal ActionMap map { get { return this["map"]; } @@ -96,7 +94,7 @@ public override void onWorldEditorStartup() // Add ourselves to the ToolsToolbar string tooltip = "Datablock Editor (" + accel + ")"; - EditorGui.addToToolsToolbar("DatablockEditorPlugin", "DatablockEditorPalette", omni.Util._expandFilename("tools/worldEditor/images/toolbar/datablock-editor"), tooltip); + EditorGui.addToToolsToolbar("DatablockEditorPlugin", "DatablockEditorPalette", Util._expandFilename("tools/worldEditor/images/toolbar/datablock-editor"), tooltip); //connect editor windows ((GuiWindowCollapseCtrl) "DatablockEditorInspectorWindow").attachTo("DatablockEditorTreeWindow"); @@ -248,7 +246,7 @@ public void populateTrees() // Populate datablock type tree. - string classList = omni.Util.enumerateConsoleClasses("SimDatablock"); + string classList = Util.enumerateConsoleClasses("SimDatablock"); DatablockEditorTypeTree.clear(); foreach (string datablockClass in classList.Split('\t')) @@ -636,7 +634,7 @@ public void selectDatablock(SimObject datablock, bool add = false, bool dontSync if (numSelected == 1) { string fileName = datablock.getFilename(); - fileNameField.setText(fileName != "" ? fileName : omni.sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"]); + fileNameField.setText(fileName != "" ? fileName : sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"]); } else fileNameField.setText(""); @@ -843,11 +841,11 @@ public void createDatablockFinish(string name, string copySource) else eval = dbType + className + "(" + name + ") { canSaveDynamicFields = \"1\"; };"; - string res = omni.Util.eval(eval); + string res = Util.eval(eval); action["db"] = name.getID().AsString(); action["dbName"] = name; - action["fname"] = omni.sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"]; + action["fname"] = sGlobal["$DATABLOCK_EDITOR_DEFAULT_FILENAME"]; this.submitUndo(action); @@ -881,7 +879,7 @@ public bool canBeClientSideDatablock(string className) // [ConsoleInteraction] public string createUndo(string desc) { - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); ObjectCreator ocf = new ObjectCreator("UndoScriptAction", "", typeof (T)); //ocf["class"] = className; @@ -893,7 +891,7 @@ public string createUndo(string desc) UndoScriptAction action = ocf.Create(); - omni.Util.popInstantGroup(); + Util.popInstantGroup(); return action; } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/gui/CodeBehind/Debugger.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/gui/CodeBehind/Debugger.ed.cs index 0282ef37..e5a5b1b9 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/gui/CodeBehind/Debugger.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/gui/CodeBehind/Debugger.ed.cs @@ -49,7 +49,6 @@ public class Debugger // onLine is invoked whenever the TCP object receives a line from the server. Treat the first // word as a "command" and dispatch to an appropriate handler. //--------------------------------------------------------------------------------------------- - private static readonly pInvokes omni = new pInvokes(); //--------------------------------------------------------------------------------------------- // Various support functions. @@ -68,9 +67,9 @@ public static void DbgWatchDialogAdd() string expr = WatchDialogExpression.getValue(); if (expr != "") { - DebuggerWatchView.setRowById(omni.iGlobal["$DbgWatchSeq"], expr + "\t(unknown)"); - TCPDebugger.send("EVAL " + omni.iGlobal["$DbgWatchSeq"] + " 0 " + expr + "\r\n"); - omni.iGlobal["$DbgWatchSeq"]++; + DebuggerWatchView.setRowById(pInvokes.iGlobal["$DbgWatchSeq"], expr + "\t(unknown)"); + TCPDebugger.send("EVAL " + pInvokes.iGlobal["$DbgWatchSeq"] + " 0 " + expr + "\r\n"); + pInvokes.iGlobal["$DbgWatchSeq"]++; } Canvas.popDialog(DebuggerWatchDlg); } @@ -90,7 +89,7 @@ public static void DbgWatchDialogEdit() if (id >= 0) { string row = DebuggerWatchView.getRowTextById(id); - string expr = omni.Util.getField(row, 0); + string expr = pInvokes.Util.getField(row, 0); string assignment; if (newValue == "") assignment = expr + " = \"\""; @@ -167,7 +166,7 @@ public static void DbgBreakConditionSet() if (id != -1) { string bkp = DebuggerBreakPoints.getRowTextById(id); - DbgSetBreakPoint(omni.Util.getField(bkp, 1), omni.Util.getField(bkp, 0).AsUInt(), clear.AsBool(), passct, condition); + DbgSetBreakPoint(pInvokes.Util.getField(bkp, 1), pInvokes.Util.getField(bkp, 0).AsUInt(), clear.AsBool(), passct, condition); } Canvas.popDialog(DebuggerBreakConditionDlg); @@ -188,10 +187,10 @@ public static void DbgOpenFile(string file, int line, bool selectLine) // Go to the line. DebuggerFileView.setCurrentLine(line, selectLine); // Get the breakpoints for this file. - if (file != omni.sGlobal["$DebuggerFile"]) + if (file != pInvokes.sGlobal["$DebuggerFile"]) { TCPDebugger.send("BREAKLIST " + file + "\r\n"); - omni.sGlobal["$DebuggerFile"] = file; + pInvokes.sGlobal["$DebuggerFile"] = file; } } } @@ -222,7 +221,7 @@ public static void DbgSetBreakPoint(string file, uint line, bool clear, string p if (!clear) { - if (file == omni.sGlobal["$DebuggerFile"]) + if (file == pInvokes.sGlobal["$DebuggerFile"]) DebuggerFileView.setBreak(line); } DebuggerBreakPoints.addBreak(file, line.AsString(), clear, passct, expr); @@ -237,7 +236,7 @@ public static void DbgRemoveBreakPoint(string file, uint line) DebuggerBreakPoints DebuggerBreakPoints = "DebuggerBreakPoints"; TCPDebugger TCPDebugger = "TCPDebugger"; - if (file == omni.sGlobal["$DebuggerFile"]) + if (file == pInvokes.sGlobal["$DebuggerFile"]) DebuggerFileView.removeBreak(line); TCPDebugger.send("BRKCLR " + file + " " + line + "\r\n"); DebuggerBreakPoints.removeBreak(file, line.AsString()); @@ -254,8 +253,8 @@ public static void DbgDeleteSelectedBreak() if (rowNum >= 0) { string breakText = DebuggerBreakPoints.getRowText(rowNum); - string breakLine = omni.Util.getField(breakText, 0); - string breakFile = omni.Util.getField(breakText, 1); + string breakLine = pInvokes.Util.getField(breakText, 0); + string breakFile = pInvokes.Util.getField(breakText, 1); DbgRemoveBreakPoint(breakFile, breakLine.AsUint()); } } @@ -314,7 +313,7 @@ public static void DbgRefreshWatches() { int id = DebuggerWatchView.getRowId(i); string row = DebuggerWatchView.getRowTextById(id); - string expr = omni.Util.getField(row, 0); + string expr = pInvokes.Util.getField(row, 0); TCPDebugger.send("EVAL " + id + " 0 " + expr + "\r\n"); } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/main.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/main.cs index 65ae616d..0ad7ccc0 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/main.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Debugger/main.cs @@ -44,8 +44,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Debugger { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializeDebugger() { @@ -74,8 +72,8 @@ public static void startDebugger() new ObjectCreator("TCPObject", "TCPDebugger", typeof (gui.CodeBehind.Debugger.TCPDebugger)).Create(); // Used to get unique IDs for breakpoints and watch expressions. - omni.iGlobal["$DbgBreakId"] = 0; - omni.iGlobal["$DbgWatchSeq"] = 1; + pInvokes.iGlobal["$DbgBreakId"] = 0; + pInvokes.iGlobal["$DbgWatchSeq"] = 1; // Set up the GUI. gui.CodeBehind.Debugger.DebuggerConsoleView DebuggerConsoleView = "DebuggerConsoleView"; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DecalEditor/main.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DecalEditor/main.cs index c13bb6a5..e3561ad6 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DecalEditor/main.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/DecalEditor/main.cs @@ -44,13 +44,11 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.DecalEditor { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializeDecalEditor() { Omni.self.Print(" % - Initializing Decal Editor"); - omni.sGlobal["$decalDataFile"] = "art/decals/managedDecalData.cs"; + pInvokes.sGlobal["$decalDataFile"] = "art/decals/managedDecalData.cs"; gui.DecalEditorGui.initialize(); // Add ourselves to EditorGui, where all the other tools reside diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/RSSNews/RSSFeedScript.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/RSSNews/RSSFeedScript.ed.cs index cc426f45..dc0cbb18 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/RSSNews/RSSFeedScript.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/RSSNews/RSSFeedScript.ed.cs @@ -46,17 +46,15 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.EditorClasses.RSSNews { public class RSSFeedScript { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "RSSFeedScript_initialize")] public static void initialize() { // RSS ticker configuration: - omni.sGlobal["$RSSFeed::serverName"] = "feeds.garagegames.com"; - omni.iGlobal["$RSSFeed::serverPort"] = 80; - omni.sGlobal["$RSSFeed::serverURL"] = "/product/tgea"; - omni.sGlobal["$RSSFeed::userAgent"] = "TorqueGameEngineAdvances/1.1"; - omni.iGlobal["$RSSFeed::maxNewHeadlines"] = 10; + pInvokes.sGlobal["$RSSFeed::serverName"] = "feeds.garagegames.com"; + pInvokes.iGlobal["$RSSFeed::serverPort"] = 80; + pInvokes.sGlobal["$RSSFeed::serverURL"] = "/product/tgea"; + pInvokes.sGlobal["$RSSFeed::userAgent"] = "TorqueGameEngineAdvances/1.1"; + pInvokes.iGlobal["$RSSFeed::maxNewHeadlines"] = 10; // Load up the helper objects //exec( "./RSSStructs.ed.cs" ); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/fileLoader.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/fileLoader.ed.cs index d844fa9a..dc176ff4 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/fileLoader.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/fileLoader.ed.cs @@ -40,8 +40,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.EditorClasses { public class fileLoader { - public static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void loadDirectory(string path, string type, string dsoType) { @@ -58,7 +56,7 @@ public static void loadDirectory(string path, string type, string dsoType) // First we find all the scripts and compile them if there are any // In the shipping version, this wont find anything. string dsopath; - if (!omni.bGlobal["$Scripts::ignoreDSOs"]) + if (!pInvokes.bGlobal["$Scripts::ignoreDSOs"]) { bool dsoReloc = compileDirectory(cspath, ""); @@ -76,47 +74,47 @@ public static void loadDirectory(string path, string type, string dsoType) dsopath = cspath; //error("Execing Directory " @ %dsopath @ " ..."); - string file = omni.Util.findFirstFile(dsopath, false); + string file = pInvokes.Util.findFirstFile(dsopath, false); while (file != "") { //error(" Found File: " @ %file); // As we cant exec() a .dso directly, we need to strip that part from the filename - int pos = omni.Util.strstr(file, "." + dsoType); + int pos = pInvokes.Util.strstr(file, "." + dsoType); string csfile; if (pos != -1) - csfile = omni.Util.getSubStr(file, 0, pos); + csfile = pInvokes.Util.getSubStr(file, 0, pos); else csfile = file; - omni.Util.exec(csfile, false, false); - file = omni.Util.findNextFile(dsopath); + pInvokes.Util.exec(csfile, false, false); + file = pInvokes.Util.findNextFile(dsopath); } } [ConsoleInteraction] public static bool compileDirectory(string path, string dsoPath) { - string saveDSOPath = omni.sGlobal["$Scripts::OverrideDSOPath"]; - omni.sGlobal["$Scripts::OverrideDSOPath"] = dsoPath; + string saveDSOPath = pInvokes.sGlobal["$Scripts::OverrideDSOPath"]; + pInvokes.sGlobal["$Scripts::OverrideDSOPath"] = dsoPath; bool dsoReloc = false; - string file = omni.Util.findFirstFile(path, false); + string file = pInvokes.Util.findFirstFile(path, false); //error("Compiling Directory " @ %path @ " ..."); while (file != "") { //error(" Found File: " @ %file @ " (" @ getDSOPath(%file) @ ")"); - if (omni.Util.filePath(file) != omni.Util.filePath(omni.Util.getDSOPath(file))) + if (pInvokes.Util.filePath(file) != pInvokes.Util.filePath(pInvokes.Util.getDSOPath(file))) dsoReloc = true; - omni.Util.compile(file, false); - file = omni.Util.findNextFile(path); + pInvokes.Util.compile(file, false); + file = pInvokes.Util.findNextFile(path); } - omni.sGlobal["$Scripts::OverrideDSOPath"] = saveDSOPath; + pInvokes.sGlobal["$Scripts::OverrideDSOPath"] = saveDSOPath; return dsoReloc; } @@ -124,13 +122,13 @@ public static bool compileDirectory(string path, string dsoPath) [ConsoleInteraction] public static void listDirectory(string path) { - string file = omni.Util.findFirstFile(path, false); + string file = pInvokes.Util.findFirstFile(path, false); - omni.Util._echo("Listing Directory " + path + " ..."); + pInvokes.Util._echo("Listing Directory " + path + " ..."); while (file != "") { - omni.Util._echo(" " + file); - file = omni.Util.findNextFile(path); + pInvokes.Util._echo(" " + file); + file = pInvokes.Util.findNextFile(path); } } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/main.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/main.cs index 2cf65ebe..f5d78ce3 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/main.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorClasses/main.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -44,16 +44,14 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.EditorClasses { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializeEditorClasses() { Omni.self.Print(" % - Initializing Tools Base"); - omni.sGlobal["$EditorClassesGroup"] = "EditorClassesCleanup"; + pInvokes.sGlobal["$EditorClassesGroup"] = "EditorClassesCleanup"; - if (!omni.sGlobal["$EditorClassesGroup"].isObject()) - new ObjectCreator("SimGroup", omni.sGlobal["$EditorClassesGroup"]).Create(); + if (!pInvokes.sGlobal["$EditorClassesGroup"].isObject()) + new ObjectCreator("SimGroup", pInvokes.sGlobal["$EditorClassesGroup"]).Create(); RSSFeedScript.initialize(); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorGui.cs index 39160321..fe3d8c1b 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/EditorGui.cs @@ -1779,15 +1779,15 @@ public static void editorPrefsInitialize() EditorSettings.setDefaultValue("dropType", "screenCenter"); EditorSettings.setDefaultValue("undoLimit", "40"); EditorSettings.setDefaultValue("forceLoadDAE", "0"); - EditorSettings.setDefaultValue("displayType", omni.sGlobal["$EditTsCtrl::DisplayTypePerspective"]); + EditorSettings.setDefaultValue("displayType", sGlobal["$EditTsCtrl::DisplayTypePerspective"]); EditorSettings.setDefaultValue("orthoFOV", "50"); EditorSettings.setDefaultValue("orthoShowGrid", "1"); EditorSettings.setDefaultValue("currentEditor", "WorldEditorInspectorPlugin"); EditorSettings.setDefaultValue("newLevelFile", "tools/levels/BlankRoom.mis"); - if (omni.Util.isFile("C:/Program Files/Torsion/Torsion.exe")) + if (Util.isFile("C:/Program Files/Torsion/Torsion.exe")) EditorSettings.setDefaultValue("torsionPath", "C:/Program Files/Torsion/Torsion.exe"); - else if (omni.Util.isFile("C:/Program Files (x86)/Torsion/Torsion.exe")) + else if (Util.isFile("C:/Program Files (x86)/Torsion/Torsion.exe")) EditorSettings.setDefaultValue("torsionPath", "C:/Program Files (x86)/Torsion/Torsion.exe"); else EditorSettings.setDefaultValue("torsionPath", ""); @@ -1932,8 +1932,8 @@ public static void editorPrefsInitialize() [ConsoleInteraction] public static void setDefault(string name, string value) { - if (!omni.Util.isDefined(name)) - omni.Util.eval(name + ' ' + "=" + ' ' + "\"" + value + "\";"); + if (!Util.isDefined(name)) + Util.eval(name + ' ' + "=" + ' ' + "\"" + value + "\";"); } [ConsoleInteraction] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/OpenFileDialog.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/OpenFileDialog.ed.cs index 22b4b9ae..60a5fbdd 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/OpenFileDialog.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/OpenFileDialog.ed.cs @@ -43,8 +43,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Gui { public class OpenFileDialog { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void getLoadFilename(string filespec, string callback, string currentFile) { @@ -67,16 +65,16 @@ public static void getLoadFilename(string filespec, string callback, string curr ofd.Multiselect = false; //FileDialog fd = ofd; - if (omni.Util.filePath(currentFile) != "") - ofd.InitialDirectory = omni.Util.filePath(currentFile); + if (pInvokes.Util.filePath(currentFile) != "") + ofd.InitialDirectory = pInvokes.Util.filePath(currentFile); DialogResult dr = Dialogs.OpenFileDialog(ref ofd); if (dr == DialogResult.OK) { string fileName = Dialogs.GetForwardSlashFile(ofd.FileName); - omni.Util.eval(callback + "(\"" + fileName + "\");"); - omni.sGlobal["$Tools::FileDialogs::LastFilePath"] = omni.Util.filePath(fileName); + pInvokes.Util.eval(callback + "(\"" + fileName + "\");"); + pInvokes.sGlobal["$Tools::FileDialogs::LastFilePath"] = pInvokes.Util.filePath(fileName); } } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/SaveFileDialog.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/SaveFileDialog.ed.cs index 04ee11e5..9d027d13 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/SaveFileDialog.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/SaveFileDialog.ed.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -42,17 +42,15 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Gui { public class SaveFileDialog { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void getSaveFilename(string filespec, string callback, string currentFile, bool overwrite = true) { System.Windows.Forms.SaveFileDialog sfd = new System.Windows.Forms.SaveFileDialog {Filter = filespec, FileName = currentFile, OverwritePrompt = overwrite,}; - if (omni.Util.filePath(currentFile) != "") - sfd.InitialDirectory = omni.Util.filePath(currentFile); + if (pInvokes.Util.filePath(currentFile) != "") + sfd.InitialDirectory = pInvokes.Util.filePath(currentFile); else - sfd.InitialDirectory = omni.Util.getMainDotCsDir(); + sfd.InitialDirectory = pInvokes.Util.getMainDotCsDir(); DialogResult dr = Dialogs.SaveFileDialog(ref sfd); @@ -60,7 +58,7 @@ public static void getSaveFilename(string filespec, string callback, string curr { //string filename = dlg["FileName"]; string filename = Dialogs.GetForwardSlashFile(sfd.FileName); - omni.Util.eval(callback + "(\"" + filename + "\");"); + pInvokes.Util.eval(callback + "(\"" + filename + "\");"); } } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColladaImportDlg.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColladaImportDlg.ed.cs index f76f799e..d8fae074 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColladaImportDlg.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColladaImportDlg.ed.cs @@ -1990,17 +1990,17 @@ public static void updateTSShapeLoadProgress(float progress, string msg) public static void convertColladaModels(string pattern) { // Force loading the COLLADA file (to ensure cached DTS is updated) - omni.bGlobal["$collada::forceLoadDAE"] = true; + bGlobal["$collada::forceLoadDAE"] = true; - string fullPath = omni.Util.findFirstFile("*.dae", false); + string fullPath = Util.findFirstFile("*.dae", false); while (fullPath != "") { // Check if this file is inside the given path - fullPath = omni.Util.makeRelativePath(fullPath, omni.Util.getMainDotCsDir()); - if ((pattern == "") || omni.Util.strIsMatchMultipleExpr(pattern, fullPath, false)) + fullPath = Util.makeRelativePath(fullPath, Util.getMainDotCsDir()); + if ((pattern == "") || Util.strIsMatchMultipleExpr(pattern, fullPath, false)) { // Load the model by creating a temporary TSStatic - omni.Util._echo("Converting " + fullPath + " to DTS..."); + Util._echo("Converting " + fullPath + " to DTS..."); ObjectCreator tempCreator = new ObjectCreator("TSStatic"); tempCreator["shapeName"] = fullPath; tempCreator["collisionType"] = "None"; @@ -2010,10 +2010,10 @@ public static void convertColladaModels(string pattern) temp.delete(); } - fullPath = omni.Util.findNextFile("*.dae"); + fullPath = Util.findNextFile("*.dae"); } - omni.bGlobal["$collada::forceLoadDAE"] = false; + bGlobal["$collada::forceLoadDAE"] = false; } [TypeConverter(typeof (TypeConverterGeneric))] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColorPickerDlg.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColorPickerDlg.ed.cs index c4718ceb..0f979da4 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColorPickerDlg.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ColorPickerDlg.ed.cs @@ -485,30 +485,30 @@ public static void initialize() oc_Newobject25.Create(); - omni.sGlobal["$ColorPickerCallback"] = ""; // Control that we need to update - omni.sGlobal["$ColorPickerCancelCallback"] = ""; - omni.sGlobal["$ColorPickerUpdateCallback"] = ""; - omni.iGlobal["$ColorCallbackType"] = 1; // ColorI + sGlobal["$ColorPickerCallback"] = ""; // Control that we need to update + sGlobal["$ColorPickerCancelCallback"] = ""; + sGlobal["$ColorPickerUpdateCallback"] = ""; + iGlobal["$ColorCallbackType"] = 1; // ColorI } [ConsoleInteraction] public static string ColorFloatToInt(string color) { - string red = omni.Util.getWord(color, 0); - string green = omni.Util.getWord(color, 1); - string blue = omni.Util.getWord(color, 2); - string alpha = omni.Util.getWord(color, 3); + string red = Util.getWord(color, 0); + string green = Util.getWord(color, 1); + string blue = Util.getWord(color, 2); + string alpha = Util.getWord(color, 3); - return omni.Util.mCeil(red.AsFloat()*255).AsString() + " " + omni.Util.mCeil(green.AsFloat()*255).AsString() + " " + omni.Util.mCeil(blue.AsFloat()*255).AsString() + " " + omni.Util.mCeil(alpha.AsFloat()*255).AsString(); + return Util.mCeil(red.AsFloat()*255).AsString() + " " + Util.mCeil(green.AsFloat()*255).AsString() + " " + Util.mCeil(blue.AsFloat()*255).AsString() + " " + Util.mCeil(alpha.AsFloat()*255).AsString(); } [ConsoleInteraction] public static string ColorIntToFloat(string color) { - string red = omni.Util.getWord(color, 0); - string green = omni.Util.getWord(color, 1); - string blue = omni.Util.getWord(color, 2); - string alpha = omni.Util.getWord(color, 3); + string red = Util.getWord(color, 0); + string green = Util.getWord(color, 1); + string blue = Util.getWord(color, 2); + string alpha = Util.getWord(color, 3); return (red.AsFloat()/255).AsString() + " " + (green.AsFloat()/255).AsString() + " " + (blue.AsFloat()/255).AsString() + " " + (alpha.AsFloat()/255).AsString(); } @@ -526,11 +526,11 @@ public static void GetColorI(string currentColor, string callback, string root, GuiTextEditCtrl Channel_A_Val = "Channel_A_Val"; ColorPickerDlg ColorPickerDlg = "ColorPickerDlg"; - omni.bGlobal["$ColorPickerSignal"] = true; - omni.sGlobal["$ColorPickerCallback"] = callback; - omni.sGlobal["$ColorPickerCancelCallback"] = cancelCallback; - omni.sGlobal["$ColorPickerUpdateCallback"] = updateCallback; - omni.iGlobal["$ColorCallbackType"] = 1; // ColorI + bGlobal["$ColorPickerSignal"] = true; + sGlobal["$ColorPickerCallback"] = callback; + sGlobal["$ColorPickerCancelCallback"] = cancelCallback; + sGlobal["$ColorPickerUpdateCallback"] = updateCallback; + iGlobal["$ColorCallbackType"] = 1; // ColorI oldColor.color = ColorIntToFloat(currentColor).AsColorF(); myColor.color = ColorIntToFloat(currentColor).AsColorF(); @@ -542,10 +542,10 @@ public static void GetColorI(string currentColor, string callback, string root, ColorAlphaSelect.range = "0 255".AsPoint2F(); // Set the RGBA displays accordingly - float red = omni.Util.getWord(currentColor, 0).AsFloat()/255; - float green = omni.Util.getWord(currentColor, 1).AsFloat()/255; - float blue = omni.Util.getWord(currentColor, 2).AsFloat()/255; - float alpha = omni.Util.getWord(currentColor, 3).AsFloat(); + float red = Util.getWord(currentColor, 0).AsFloat()/255; + float green = Util.getWord(currentColor, 1).AsFloat()/255; + float blue = Util.getWord(currentColor, 2).AsFloat()/255; + float alpha = Util.getWord(currentColor, 3).AsFloat(); // set the initial range blend to correct color, no alpha needed // this should also set the color blend select right now @@ -574,11 +574,11 @@ public static void GetColorF(string currentColor, string callback, string root, GuiTextEditCtrl Channel_A_Val = "Channel_A_Val"; ColorPickerDlg ColorPickerDlg = "ColorPickerDlg"; - omni.bGlobal["$ColorPickerSignal"] = true; - omni.sGlobal["$ColorPickerCallback"] = callback; - omni.sGlobal["$ColorPickerCancelCallback"] = cancelCallback; - omni.sGlobal["$ColorPickerUpdateCallback"] = updateCallback; - omni.iGlobal["$ColorCallbackType"] = 2; // ColorF + bGlobal["$ColorPickerSignal"] = true; + sGlobal["$ColorPickerCallback"] = callback; + sGlobal["$ColorPickerCancelCallback"] = cancelCallback; + sGlobal["$ColorPickerUpdateCallback"] = updateCallback; + iGlobal["$ColorCallbackType"] = 2; // ColorF oldColor.color = currentColor.AsColorF(); myColor.color = currentColor.AsColorF(); @@ -590,10 +590,10 @@ public static void GetColorF(string currentColor, string callback, string root, ColorAlphaSelect.range = "0 1".AsPoint2F(); // Set the RGBA displays accordingly - string red = omni.Util.getWord(currentColor, 0); - string green = omni.Util.getWord(currentColor, 1); - string blue = omni.Util.getWord(currentColor, 2); - string alpha = omni.Util.getWord(currentColor, 3); + string red = Util.getWord(currentColor, 0); + string green = Util.getWord(currentColor, 1); + string blue = Util.getWord(currentColor, 2); + string alpha = Util.getWord(currentColor, 3); // set the initial range blend to correct color, no alpha needed // this should also set the color blend select right now @@ -622,14 +622,14 @@ public static void setColorInfo() string green = Channel_G_Val.getValue(); string blue = Channel_B_Val.getValue(); - if (omni.iGlobal["$ColorCallbackType"] == 1) + if (iGlobal["$ColorCallbackType"] == 1) { red = (red.AsFloat()/255).AsString(); green = (green.AsFloat()/255).AsString(); blue = (blue.AsFloat()/255).AsString(); } - omni.iGlobal["$ColorPickerSignal"] = 1; + iGlobal["$ColorPickerSignal"] = 1; ColorBlendSelect.baseColor = (red + " " + green + " " + blue + " " + "1.0").AsColorF(); ColorBlendSelect.updateColor(); @@ -642,7 +642,7 @@ public static void DoColorPickerCallback() ColorPickerDlg ColorPickerDlg = "ColorPickerDlg"; GuiSwatchButtonCtrl myColor = "myColor"; - omni.Util.eval(omni.sGlobal["$ColorPickerCallback"] + "(\"" + constructNewColor(myColor.color.AsString(), omni.iGlobal["$ColorCallbackType"]) + "\");"); + Util.eval(sGlobal["$ColorPickerCallback"] + "(\"" + constructNewColor(myColor.color.AsString(), iGlobal["$ColorCallbackType"]) + "\");"); ((GuiCanvas) ColorPickerDlg.getRoot()).popDialog(ColorPickerDlg); } @@ -653,8 +653,8 @@ public static void DoColorPickerCancelCallback() GuiSwatchButtonCtrl oldColor = "oldColor"; ((GuiCanvas) ColorPickerDlg.getRoot()).popDialog(ColorPickerDlg); - if (omni.sGlobal["$ColorPickerCancelCallback"] != "") - omni.Util.eval(omni.sGlobal["$ColorPickerCancelCallback"] + "(\"" + constructNewColor(oldColor.color.AsString(), omni.iGlobal["$ColorCallbackType"]) + "\");"); + if (sGlobal["$ColorPickerCancelCallback"] != "") + Util.eval(sGlobal["$ColorPickerCancelCallback"] + "(\"" + constructNewColor(oldColor.color.AsString(), iGlobal["$ColorCallbackType"]) + "\");"); } [ConsoleInteraction] @@ -662,8 +662,8 @@ public static void DoColorPickerUpdateCallback() { GuiSwatchButtonCtrl myColor = "myColor"; - if (omni.sGlobal["$ColorPickerUpdateCallback"] != "") - omni.Util.eval(omni.sGlobal["$ColorPickerUpdateCallback"] + "(\"" + constructNewColor(myColor.color.AsString(), omni.iGlobal["$ColorCallbackType"]) + "\");"); + if (sGlobal["$ColorPickerUpdateCallback"] != "") + Util.eval(sGlobal["$ColorPickerUpdateCallback"] + "(\"" + constructNewColor(myColor.color.AsString(), iGlobal["$ColorCallbackType"]) + "\");"); } [ConsoleInteraction] @@ -675,17 +675,17 @@ public static void updatePickerBaseColor(bool location) string pickColor; - if (omni.bGlobal["$ColorPickerSignal"] && location) + if (bGlobal["$ColorPickerSignal"] && location) pickColor = ColorRangeSelect.baseColor.AsString(); else pickColor = ColorRangeSelect.pickColor.AsString(); - omni.bGlobal["$ColorPickerSignal"] = true; + bGlobal["$ColorPickerSignal"] = true; - string red = omni.Util.getWord(pickColor, 0); - string green = omni.Util.getWord(pickColor, 1); - string blue = omni.Util.getWord(pickColor, 2); - string alpha = omni.Util.getWord(pickColor, 3); + string red = Util.getWord(pickColor, 0); + string green = Util.getWord(pickColor, 1); + string blue = Util.getWord(pickColor, 2); + string alpha = Util.getWord(pickColor, 3); ColorBlendSelect.baseColor = (red + " " + green + " " + blue + " " + "1.0").AsColorF(); ColorBlendSelect.updateColor(); @@ -704,17 +704,17 @@ public static void updateRGBValues(bool location) string pickColor; //update the color based on where it came from - if (omni.bGlobal["$ColorPickerSignal"] && location) + if (bGlobal["$ColorPickerSignal"] && location) pickColor = ColorBlendSelect.baseColor.AsString(); else pickColor = ColorBlendSelect.pickColor.AsString(); //lets prepare the color - string red = omni.Util.getWord(pickColor, 0); - string green = omni.Util.getWord(pickColor, 1); - string blue = omni.Util.getWord(pickColor, 2); + string red = Util.getWord(pickColor, 0); + string green = Util.getWord(pickColor, 1); + string blue = Util.getWord(pickColor, 2); //the alpha should be grabbed from mycolor - string alpha = omni.Util.getWord(myColor.color.AsString(), 3); + string alpha = Util.getWord(myColor.color.AsString(), 3); // set the color! myColor.color = (red + " " + green + " " + blue + " " + alpha).AsColorF(); @@ -722,17 +722,17 @@ public static void updateRGBValues(bool location) DoColorPickerUpdateCallback(); //update differently depending on type - if (omni.iGlobal["$ColorCallbackType"] == 1) + if (iGlobal["$ColorCallbackType"] == 1) { - red = omni.Util.mCeil(red.AsFloat()*255).AsString(); - blue = omni.Util.mCeil(blue.AsFloat()*255).AsString(); - green = omni.Util.mCeil(green.AsFloat()*255).AsString(); + red = Util.mCeil(red.AsFloat()*255).AsString(); + blue = Util.mCeil(blue.AsFloat()*255).AsString(); + green = Util.mCeil(green.AsFloat()*255).AsString(); } else { - red = omni.Util.mFloatLength(red.AsFloat(), 3); - blue = omni.Util.mFloatLength(blue.AsFloat(), 3); - green = omni.Util.mFloatLength(green.AsFloat(), 3); + red = Util.mFloatLength(red.AsFloat(), 3); + blue = Util.mFloatLength(blue.AsFloat(), 3); + green = Util.mFloatLength(green.AsFloat(), 3); } // changes current color values @@ -740,7 +740,7 @@ public static void updateRGBValues(bool location) Channel_G_Val.setValue(green); Channel_B_Val.setValue(blue); - omni.bGlobal["$ColorPickerSignal"] = false; + bGlobal["$ColorPickerSignal"] = false; } [ConsoleInteraction] @@ -749,12 +749,12 @@ public static void updateColorPickerAlpha(string alphaVal) GuiSwatchButtonCtrl myColor = "myColor"; //lets prepare the color - string red = omni.Util.getWord(myColor.color.AsString(), 0); - string green = omni.Util.getWord(myColor.color.AsString(), 1); - string blue = omni.Util.getWord(myColor.color.AsString(), 2); + string red = Util.getWord(myColor.color.AsString(), 0); + string green = Util.getWord(myColor.color.AsString(), 1); + string blue = Util.getWord(myColor.color.AsString(), 2); string alpha = alphaVal; - if (omni.iGlobal["$ColorCallbackType"] == 1) + if (iGlobal["$ColorCallbackType"] == 1) alpha = (alpha.AsFloat()/255).AsString(); myColor.color = (red + " " + green + " " + blue + " " + alpha).AsColorF(); @@ -765,15 +765,15 @@ public static void updateColorPickerAlpha(string alphaVal) [ConsoleInteraction] public static string constructNewColor(string pickColor, int colorType) { - string red = omni.Util.getWord(pickColor, 0); - string green = omni.Util.getWord(pickColor, 1); - string blue = omni.Util.getWord(pickColor, 2); - string alpha = omni.Util.getWord(pickColor, 3); // Copyright (C) 2013 WinterLeaf Entertainment LLC. + string red = Util.getWord(pickColor, 0); + string green = Util.getWord(pickColor, 1); + string blue = Util.getWord(pickColor, 2); + string alpha = Util.getWord(pickColor, 3); // Copyright (C) 2013 WinterLeaf Entertainment LLC. // Update the text controls to reflect new color //setColorInfo(red, green, blue, alpha); if (colorType == 1) // ColorI - return omni.Util.mCeil(red.AsFloat()*255).AsString() + " " + omni.Util.mCeil(green.AsFloat()*255).AsString() + " " + omni.Util.mCeil(blue.AsFloat()*255).AsString() + " " +/* Copyright (C) 2013 WinterLeaf Entertainment LLC. */ omni.Util.mCeil(alpha.AsFloat()*255).AsString(); + return Util.mCeil(red.AsFloat()*255).AsString() + " " + Util.mCeil(green.AsFloat()*255).AsString() + " " + Util.mCeil(blue.AsFloat()*255).AsString() + " " +/* Copyright (C) 2013 WinterLeaf Entertainment LLC. */ Util.mCeil(alpha.AsFloat()*255).AsString(); else // ColorF return red + " " + green + " " + blue + " " + alpha; } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiEaseEditDlg.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiEaseEditDlg.ed.cs index b788c26b..80539f27 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiEaseEditDlg.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiEaseEditDlg.ed.cs @@ -537,10 +537,10 @@ public void setEase(string ease) GuiTextEditSliderCtrl param2Value = this.FOT("param2Value"); easeView.ease = ease.AsEaseF(); - directionList.setSelected(omni.Util.getWord(ease, 0).AsInt(), false); - typeList.setSelected(omni.Util.getWord(ease, 1).AsInt(), false); - param1Value.setValue(omni.Util.getWord(ease, 2)); - param2Value.setValue(omni.Util.getWord(ease, 3)); + directionList.setSelected(Util.getWord(ease, 0).AsInt(), false); + typeList.setSelected(Util.getWord(ease, 1).AsInt(), false); + param1Value.setValue(Util.getWord(ease, 2)); + param2Value.setValue(Util.getWord(ease, 3)); this.onEaseTypeSet(); } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiObjectInspector.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiObjectInspector.ed.cs index 349fff90..b1e0c582 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiObjectInspector.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/GuiObjectInspector.ed.cs @@ -538,17 +538,17 @@ public static void inspectObject(string objectx) if (!objectx.isObject()) { - omni.Util._error("inspectObject: no object '" + objectx + "'"); + Util._error("inspectObject: no object '" + objectx + "'"); return; } // Create a new object inspector window. //exec( "./guiObjectInspector.ed.gui" ); - GuiObjectInspector guiContent = omni.console.Call("GuiObjectInspector_initialize"); + GuiObjectInspector guiContent = console.Call("GuiObjectInspector_initialize"); if (!guiContent.isObject()) { - omni.Util._error("InspectObject: failed to create GUI from 'guiObjectInspector.ed.gui'"); + Util._error("InspectObject: failed to create GUI from 'guiObjectInspector.ed.gui'"); return; } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MaterialSelector.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MaterialSelector.ed.cs index 2a575425..5b15e027 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MaterialSelector.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MaterialSelector.ed.cs @@ -980,9 +980,9 @@ public static void initialize() oc_Newobject42.Create(); - omni.sGlobal["$Pref::MaterialSelector::CurrentStaticFilter"] = "MaterialFilterAllArray"; - omni.sGlobal["$Pref::MaterialSelector::CurrentFilter"] = ""; //ALL - omni.iGlobal["$Pref::MaterialSelector::ThumbnailCountIndex"] = 0; + sGlobal["$Pref::MaterialSelector::CurrentStaticFilter"] = "MaterialFilterAllArray"; + sGlobal["$Pref::MaterialSelector::CurrentFilter"] = ""; //ALL + iGlobal["$Pref::MaterialSelector::ThumbnailCountIndex"] = 0; new ObjectCreator("PersistenceManager", "MaterialSelectorPerMan").Create(); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MessageBoxSaveChangesDlg.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MessageBoxSaveChangesDlg.cs index 25a1f667..07102f28 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MessageBoxSaveChangesDlg.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/MessageBoxSaveChangesDlg.cs @@ -247,7 +247,7 @@ public static void checkSaveChangesOld(string data, string saveCallback, string // Sanity Check if (MessageBoxSaveChangesDlg.isAwake()) { - omni.Util._warn("Save Changes Dialog already Awake, NOT creating second instance."); + Util._warn("Save Changes Dialog already Awake, NOT creating second instance."); return; } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ScriptEditorDlg.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ScriptEditorDlg.ed.cs index db0ee927..97b6e1eb 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ScriptEditorDlg.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/gui/ScriptEditorDlg.ed.cs @@ -299,7 +299,7 @@ public static void _TextPadOnOk() { string text = textpad.getText(); string command = ScriptEditorDlg["callback"] + "( text );"; - omni.Util.eval(command); + Util.eval(command); } ScriptEditorDlg["callback"] = ""; ((GuiCanvas) ScriptEditorDlg.getRoot()).popDialog(ScriptEditorDlg); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/guiDialogs.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/guiDialogs.cs index 192105cf..01e362dd 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/guiDialogs.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/guiDialogs.cs @@ -40,11 +40,9 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Gui { public class guiDialogs { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - //omni.Util.exec("tools/gui/fileDialogBase.ed.cs",false,false); + //pInvokes.Util.exec("tools/gui/fileDialogBase.ed.cs",false,false); MessageBoxSaveChangesDlg.initialize(); simViewDlg.initialize(); ColorPickerDlg.initialize(); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/profiles.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/profiles.ed.cs index 039118a9..0b21f44a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/profiles.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/Gui/profiles.ed.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -38,15 +38,13 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.Gui { - public class profiles + public class profiles : pInvokes { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { - omni.sGlobal["$Gui::clipboardFile"] = omni.Util._expandFilename("tools/gui/clipboard.gui"); + sGlobal["$Gui::clipboardFile"] = Util._expandFilename("tools/gui/clipboard.gui"); - if (!omni.Util.isObject("ToolsGuiDefaultProfile")) + if (!Util.isObject("ToolsGuiDefaultProfile")) { #region GuiControlProfile (ToolsGuiDefaultProfile) oc_Newobject1 @@ -87,7 +85,7 @@ public static void initialize() oc_Newobject1.Create(); } - if (!omni.Util.isObject("ToolsGuiEditorProfile")) + if (!Util.isObject("ToolsGuiEditorProfile")) { #region GuiControlProfile (ToolsGuiEditorProfile) oc_Newobject2 @@ -128,7 +126,7 @@ public static void initialize() oc_Newobject2.Create(); } - if (!omni.Util.isObject("ToolsGuiSolidDefaultProfile")) + if (!Util.isObject("ToolsGuiSolidDefaultProfile")) { #region GuiControlProfile (ToolsGuiSolidDefaultProfile) oc_Newobject3 @@ -142,7 +140,7 @@ public static void initialize() oc_Newobject3.Create(); } - if (!omni.Util.isObject("ToolsGuiTransparentProfile")) + if (!Util.isObject("ToolsGuiTransparentProfile")) { #region GuiControlProfile (ToolsGuiTransparentProfile) oc_Newobject4 @@ -156,7 +154,7 @@ public static void initialize() oc_Newobject4.Create(); } - if (!omni.Util.isObject("ToolsGuiGroupBorderProfile")) + if (!Util.isObject("ToolsGuiGroupBorderProfile")) { #region GuiControlProfile ( ToolsGuiGroupBorderProfile ) oc_Newobject5 @@ -172,7 +170,7 @@ public static void initialize() oc_Newobject5.Create(); } - if (!omni.Util.isObject("ToolsGuiTabBorderProfile")) + if (!Util.isObject("ToolsGuiTabBorderProfile")) { #region GuiControlProfile ( ToolsGuiTabBorderProfile ) oc_Newobject6 @@ -188,7 +186,7 @@ public static void initialize() oc_Newobject6.Create(); } - if (!omni.Util.isObject("ToolsGuiToolTipProfile")) + if (!Util.isObject("ToolsGuiToolTipProfile")) { #region GuiControlProfile (ToolsGuiToolTipProfile) oc_Newobject7 @@ -205,7 +203,7 @@ public static void initialize() oc_Newobject7.Create(); } - if (!omni.Util.isObject("ToolsGuiModelessDialogProfile")) + if (!Util.isObject("ToolsGuiModelessDialogProfile")) { #region GuiControlProfile ( ToolsGuiModelessDialogProfile ) oc_Newobject8 @@ -218,7 +216,7 @@ public static void initialize() oc_Newobject8.Create(); } - if (!omni.Util.isObject("ToolsGuiFrameSetProfile")) + if (!Util.isObject("ToolsGuiFrameSetProfile")) { #region GuiControlProfile (ToolsGuiFrameSetProfile) oc_Newobject9 @@ -234,7 +232,7 @@ public static void initialize() oc_Newobject9.Create(); } - if (!omni.Util.isObject("ToolsGuiWindowProfile")) + if (!Util.isObject("ToolsGuiWindowProfile")) { #region GuiControlProfile (ToolsGuiWindowProfile) oc_Newobject10 @@ -271,7 +269,7 @@ public static void initialize() oc_Newobject10.Create(); } - if (!omni.Util.isObject("ToolsGuiToolbarWindowProfile")) + if (!Util.isObject("ToolsGuiToolbarWindowProfile")) { #region GuiControlProfile (ToolsGuiToolbarWindowProfile : ToolsGuiWindowProfile) oc_Newobject11 @@ -285,7 +283,7 @@ public static void initialize() oc_Newobject11.Create(); } - if (!omni.Util.isObject("ToolsGuiWindowCollapseProfile")) + if (!Util.isObject("ToolsGuiWindowCollapseProfile")) { #region GuiControlProfile (ToolsGuiWindowCollapseProfile : ToolsGuiWindowProfile) oc_Newobject12 @@ -297,7 +295,7 @@ public static void initialize() oc_Newobject12.Create(); } - if (!omni.Util.isObject("ToolsGuiTextProfile")) + if (!Util.isObject("ToolsGuiTextProfile")) { #region GuiControlProfile (ToolsGuiTextProfile) oc_Newobject13 @@ -326,7 +324,7 @@ public static void initialize() oc_Newobject13.Create(); } - if (!omni.Util.isObject("ToolsGuiTextBoldCenterProfile")) + if (!Util.isObject("ToolsGuiTextBoldCenterProfile")) { #region GuiControlProfile (ToolsGuiTextBoldCenterProfile : ToolsGuiTextProfile) oc_Newobject14 @@ -342,7 +340,7 @@ public static void initialize() oc_Newobject14.Create(); } - if (!omni.Util.isObject("ToolsGuiTextRightProfile")) + if (!Util.isObject("ToolsGuiTextRightProfile")) { #region GuiControlProfile (ToolsGuiTextRightProfile : ToolsGuiTextProfile) oc_Newobject15 @@ -355,7 +353,7 @@ public static void initialize() oc_Newobject15.Create(); } - if (!omni.Util.isObject("ToolsGuiTextCenterProfile")) + if (!Util.isObject("ToolsGuiTextCenterProfile")) { #region GuiControlProfile (ToolsGuiTextCenterProfile : ToolsGuiTextProfile) oc_Newobject16 @@ -368,7 +366,7 @@ public static void initialize() oc_Newobject16.Create(); } - if (!omni.Util.isObject("ToolsGuiInspectorTitleTextProfile")) + if (!Util.isObject("ToolsGuiInspectorTitleTextProfile")) { #region GuiControlProfile (ToolsGuiInspectorTitleTextProfile) oc_Newobject17 @@ -381,7 +379,7 @@ public static void initialize() oc_Newobject17.Create(); } - if (!omni.Util.isObject("ToolsGuiAutoSizeTextProfile")) + if (!Util.isObject("ToolsGuiAutoSizeTextProfile")) { #region GuiControlProfile (ToolsGuiAutoSizeTextProfile) oc_Newobject18 @@ -397,7 +395,7 @@ public static void initialize() oc_Newobject18.Create(); } - if (!omni.Util.isObject("ToolsGuiMLTextProfile")) + if (!Util.isObject("ToolsGuiMLTextProfile")) { #region GuiControlProfile ( ToolsGuiMLTextProfile ) oc_Newobject19 @@ -428,7 +426,7 @@ public static void initialize() oc_Newobject19.Create(); } - if (!omni.Util.isObject("ToolsGuiTextArrayProfile")) + if (!Util.isObject("ToolsGuiTextArrayProfile")) { #region GuiControlProfile ( ToolsGuiTextArrayProfile : ToolsGuiTextProfile ) oc_Newobject20 @@ -447,7 +445,7 @@ public static void initialize() oc_Newobject20.Create(); } - if (!omni.Util.isObject("ToolsGuiTextListProfile")) + if (!Util.isObject("ToolsGuiTextListProfile")) { #region GuiControlProfile ( ToolsGuiTextListProfile : ToolsGuiTextProfile ) oc_Newobject21 @@ -461,7 +459,7 @@ public static void initialize() oc_Newobject21.Create(); } - if (!omni.Util.isObject("ToolsGuiTextEditProfile")) + if (!Util.isObject("ToolsGuiTextEditProfile")) { #region GuiControlProfile ( ToolsGuiTextEditProfile ) oc_Newobject22 @@ -495,7 +493,7 @@ public static void initialize() oc_Newobject22.Create(); } - if (!omni.Util.isObject("ToolsGuiNumericTextEditProfile")) + if (!Util.isObject("ToolsGuiNumericTextEditProfile")) { #region GuiControlProfile ( ToolsGuiNumericTextEditProfile : ToolsGuiTextEditProfile ) oc_Newobject23 @@ -508,7 +506,7 @@ public static void initialize() oc_Newobject23.Create(); } - if (!omni.Util.isObject("ToolsGuiNumericDropSliderTextProfile")) + if (!Util.isObject("ToolsGuiNumericDropSliderTextProfile")) { #region GuiControlProfile ( ToolsGuiNumericDropSliderTextProfile : ToolsGuiTextEditProfile ) oc_Newobject24 @@ -521,7 +519,7 @@ public static void initialize() oc_Newobject24.Create(); } - if (!omni.Util.isObject("ToolsGuiRLProgressBitmapProfile")) + if (!Util.isObject("ToolsGuiRLProgressBitmapProfile")) { #region GuiControlProfile ( ToolsGuiRLProgressBitmapProfile ) oc_Newobject25 @@ -536,7 +534,7 @@ public static void initialize() oc_Newobject25.Create(); } - if (!omni.Util.isObject("ToolsGuiProgressTextProfile")) + if (!Util.isObject("ToolsGuiProgressTextProfile")) { #region GuiControlProfile ( ToolsGuiProgressTextProfile ) oc_Newobject26 @@ -552,7 +550,7 @@ public static void initialize() oc_Newobject26.Create(); } - if (!omni.Util.isObject("ToolsGuiButtonProfile")) + if (!Util.isObject("ToolsGuiButtonProfile")) { #region GuiControlProfile ( ToolsGuiButtonProfile ) oc_Newobject27 @@ -585,7 +583,7 @@ public static void initialize() oc_Newobject27.Create(); } - if (!omni.Util.isObject("ToolsGuiThumbHighlightButtonProfile")) + if (!Util.isObject("ToolsGuiThumbHighlightButtonProfile")) { #region GuiControlProfile ( ToolsGuiThumbHighlightButtonProfile : ToolsGuiButtonProfile ) oc_Newobject28 @@ -598,7 +596,7 @@ public static void initialize() oc_Newobject28.Create(); } - if (!omni.Util.isObject("ToolsGuiIconButtonProfile")) + if (!Util.isObject("ToolsGuiIconButtonProfile")) { #region GuiControlProfile ( ToolsGuiIconButtonProfile ) oc_Newobject29 @@ -620,7 +618,7 @@ public static void initialize() oc_Newobject29.Create(); } - if (!omni.Util.isObject("ToolsGuiIconButtonSmallProfile")) + if (!Util.isObject("ToolsGuiIconButtonSmallProfile")) { #region GuiControlProfile ( ToolsGuiIconButtonSmallProfile : ToolsGuiIconButtonProfile ) oc_Newobject30 @@ -633,7 +631,7 @@ public static void initialize() oc_Newobject30.Create(); } - if (!omni.Util.isObject("ToolsGuiEditorTabPage")) + if (!Util.isObject("ToolsGuiEditorTabPage")) { #region GuiControlProfile (ToolsGuiEditorTabPage) oc_Newobject31 @@ -655,7 +653,7 @@ public static void initialize() oc_Newobject31.Create(); } - if (!omni.Util.isObject("ToolsGuiCheckBoxProfile")) + if (!Util.isObject("ToolsGuiCheckBoxProfile")) { #region GuiControlProfile ( ToolsGuiCheckBoxProfile ) oc_Newobject32 @@ -682,7 +680,7 @@ public static void initialize() oc_Newobject32.Create(); } - if (!omni.Util.isObject("ToolsGuiCheckBoxListProfile")) + if (!Util.isObject("ToolsGuiCheckBoxListProfile")) { #region GuiControlProfile ( ToolsGuiCheckBoxListProfile : ToolsGuiCheckBoxProfile) oc_Newobject33 @@ -696,7 +694,7 @@ public static void initialize() oc_Newobject33.Create(); } - if (!omni.Util.isObject("ToolsGuiCheckBoxListFlipedProfile")) + if (!Util.isObject("ToolsGuiCheckBoxListFlipedProfile")) { #region GuiControlProfile ( ToolsGuiCheckBoxListFlipedProfile : ToolsGuiCheckBoxProfile) oc_Newobject34 @@ -710,7 +708,7 @@ public static void initialize() oc_Newobject34.Create(); } - if (!omni.Util.isObject("ToolsGuiInspectorCheckBoxTitleProfile")) + if (!Util.isObject("ToolsGuiInspectorCheckBoxTitleProfile")) { #region GuiControlProfile ( ToolsGuiInspectorCheckBoxTitleProfile : ToolsGuiCheckBoxProfile ) oc_Newobject35 @@ -725,7 +723,7 @@ public static void initialize() oc_Newobject35.Create(); } - if (!omni.Util.isObject("ToolsGuiRadioProfile")) + if (!Util.isObject("ToolsGuiRadioProfile")) { #region GuiControlProfile ( ToolsGuiRadioProfile ) oc_Newobject36 @@ -747,7 +745,7 @@ public static void initialize() oc_Newobject36.Create(); } - if (!omni.Util.isObject("ToolsGuiScrollProfile")) + if (!Util.isObject("ToolsGuiScrollProfile")) { #region GuiControlProfile ( ToolsGuiScrollProfile ) oc_Newobject37 @@ -768,7 +766,7 @@ public static void initialize() oc_Newobject37.Create(); } - if (!omni.Util.isObject("ToolsGuiOverlayProfile")) + if (!Util.isObject("ToolsGuiOverlayProfile")) { #region GuiControlProfile ( ToolsGuiOverlayProfile ) oc_Newobject00037 @@ -785,7 +783,7 @@ public static void initialize() oc_Newobject00037.Create(); } - if (!omni.Util.isObject("ToolsGuiSliderProfile")) + if (!Util.isObject("ToolsGuiSliderProfile")) { #region GuiControlProfile ( ToolsGuiSliderProfile ) oc_Newobject00038 @@ -798,7 +796,7 @@ public static void initialize() oc_Newobject00038.Create(); } - if (!omni.Util.isObject("ToolsGuiSliderBoxProfile")) + if (!Util.isObject("ToolsGuiSliderBoxProfile")) { #region GuiControlProfile ( ToolsGuiSliderBoxProfile ) oc_Newobject00039 @@ -811,7 +809,7 @@ public static void initialize() oc_Newobject00039.Create(); } - if (!omni.Util.isObject("ToolsGuiPopupMenuItemBorder")) + if (!Util.isObject("ToolsGuiPopupMenuItemBorder")) { #region GuiControlProfile ( ToolsGuiPopupMenuItemBorder ) oc_Newobject38 @@ -842,7 +840,7 @@ public static void initialize() oc_Newobject38.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuEditProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuEditProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuEditProfile ) oc_Newobject39 @@ -873,7 +871,7 @@ public static void initialize() oc_Newobject39.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuDefault")) + if (!Util.isObject("ToolsGuiPopUpMenuDefault")) { #region GuiControlProfile ( ToolsGuiPopUpMenuDefault ) oc_Newobject40 @@ -906,7 +904,7 @@ public static void initialize() oc_Newobject40.Create(); } - if (!omni.Util.isObject("ToolsGuiPopupMenuItemBorder")) + if (!Util.isObject("ToolsGuiPopupMenuItemBorder")) { #region GuiControlProfile ( ToolsGuiPopupMenuItemBorder : ToolsGuiButtonProfile ) oc_Newobject41 @@ -929,7 +927,7 @@ public static void initialize() oc_Newobject41.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuTabProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuTabProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuTabProfile : ToolsGuiDefaultProfile ) oc_Newobject42 @@ -962,7 +960,7 @@ public static void initialize() oc_Newobject42.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuProfile : ToolsGuiPopUpMenuDefault ) oc_Newobject43 @@ -996,7 +994,7 @@ public static void initialize() oc_Newobject43.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuTabProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuTabProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuTabProfile : ToolsGuiPopUpMenuDefault ) oc_Newobject44 @@ -1018,7 +1016,7 @@ public static void initialize() oc_Newobject44.Create(); } - if (!omni.Util.isObject("ToolsGuiPopUpMenuEditProfile")) + if (!Util.isObject("ToolsGuiPopUpMenuEditProfile")) { #region GuiControlProfile ( ToolsGuiPopUpMenuEditProfile : ToolsGuiPopUpMenuDefault ) oc_Newobject45 @@ -1036,7 +1034,7 @@ public static void initialize() oc_Newobject45.Create(); } - if (!omni.Util.isObject("ToolsGuiListBoxProfile")) + if (!Util.isObject("ToolsGuiListBoxProfile")) { #region GuiControlProfile ( ToolsGuiListBoxProfile ) oc_Newobject46 @@ -1050,7 +1048,7 @@ public static void initialize() oc_Newobject46.Create(); } - if (!omni.Util.isObject("ToolsGuiTabBookProfile")) + if (!Util.isObject("ToolsGuiTabBookProfile")) { #region GuiControlProfile ( ToolsGuiTabBookProfile ) oc_Newobject47 @@ -1082,7 +1080,7 @@ public static void initialize() oc_Newobject47.Create(); } - if (!omni.Util.isObject("ToolsGuiTabBookNoBitmapProfile")) + if (!Util.isObject("ToolsGuiTabBookNoBitmapProfile")) { #region GuiControlProfile ( ToolsGuiTabBookNoBitmapProfile : ToolsGuiTabBookProfile ) oc_Newobject48 @@ -1095,7 +1093,7 @@ public static void initialize() oc_Newobject48.Create(); } - if (!omni.Util.isObject("ToolsGuiTabPageProfile")) + if (!Util.isObject("ToolsGuiTabPageProfile")) { #region GuiControlProfile ( ToolsGuiTabPageProfile : ToolsGuiDefaultProfile ) oc_Newobject49 @@ -1113,7 +1111,7 @@ public static void initialize() oc_Newobject49.Create(); } - if (!omni.Util.isObject("ToolsGuiTreeViewProfile")) + if (!Util.isObject("ToolsGuiTreeViewProfile")) { #region GuiControlProfile ( ToolsGuiTreeViewProfile ) oc_Newobject50 @@ -1145,7 +1143,7 @@ public static void initialize() oc_Newobject50.Create(); } - if (!omni.Util.isObject("ToolsGuiTextPadProfile")) + if (!Util.isObject("ToolsGuiTextPadProfile")) { #region GuiControlProfile ( ToolsGuiTextPadProfile ) oc_Newobject51 @@ -1164,7 +1162,7 @@ public static void initialize() oc_Newobject51.Create(); } - if (!omni.Util.isObject("ToolsGuiFormProfile")) + if (!Util.isObject("ToolsGuiFormProfile")) { #region GuiControlProfile ( ToolsGuiFormProfile : ToolsGuiTextProfile ) oc_Newobject52 diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorContentList.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorContentList.ed.cs index 0eb00a9d..b9db1f51 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorContentList.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorContentList.ed.cs @@ -49,11 +49,11 @@ public class GuiEditorContentList : GuiPopUpMenuCtrl [ConsoleInteraction(true, "GuiEditorContentList_initialize")] public static void initialize() { - if (!omni.Util.isDefined("$GuiEditor::GuiFilterList")) + if (!Util.isDefined("$GuiEditor::GuiFilterList")) { /// List of named controls that are filtered out from the /// control list dropdown. - omni.sGlobal["$GuiEditor::GuiFilterList"] = "GuiEditorGui" + '\t' + "AL_ShadowVizOverlayCtrl" + '\t' + "MessageBoxOKDlg" + '\t' + "MessageBoxOKCancelDlg" + '\t' + "MessageBoxOKCancelDetailsDlg" + '\t' + "MessageBoxYesNoDlg" + '\t' + "MessageBoxYesNoCancelDlg" + '\t' + "MessagePopupDlg"; + sGlobal["$GuiEditor::GuiFilterList"] = "GuiEditorGui" + '\t' + "AL_ShadowVizOverlayCtrl" + '\t' + "MessageBoxOKDlg" + '\t' + "MessageBoxOKCancelDlg" + '\t' + "MessageBoxOKCancelDetailsDlg" + '\t' + "MessageBoxYesNoDlg" + '\t' + "MessageBoxYesNoCancelDlg" + '\t' + "MessagePopupDlg"; } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorFileDialog.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorFileDialog.ed.cs index 5ca7a199..164ab130 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorFileDialog.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorFileDialog.ed.cs @@ -54,7 +54,7 @@ public class GuiBuilder : SimObject [ConsoleInteraction(true, "GuiBuilder_initialize")] public static void initialize() { - omni.sGlobal["$GUI::FileSpec"] = "Torque Gui Files (*.gui)|*.gui|All Files (*.*)|*.*"; + sGlobal["$GUI::FileSpec"] = "Torque Gui Files (*.gui)|*.gui|All Files (*.*)|*.*"; } /// GuiBuilder::getSaveName - Open a Native File dialog and retrieve the @@ -69,22 +69,22 @@ public static string GetSaveName(string defaultFileName) if (defaultFileName == "") { string prefix = ""; - if (omni.Util.isFunction("isScriptPathExpando")) + if (Util.isFunction("isScriptPathExpando")) { // if we're editing a game, we want to default to the games dir. // if we're not, then we default to the tools directory or the base. - if (omni.console.Call("isScriptPathExpando", new string[] {"^game"}).AsBool()) + if (console.Call("isScriptPathExpando", new string[] {"^game"}).AsBool()) prefix = "^game/"; - else if (omni.console.Call("isScriptPathExpando", new string[] {"^tools"}).AsBool()) + else if (console.Call("isScriptPathExpando", new string[] {"^tools"}).AsBool()) prefix = "^tools/"; } - defaultFileName = omni.Util._expandFilename(prefix + "gui/untitled.gui"); + defaultFileName = Util._expandFilename(prefix + "gui/untitled.gui"); } else - defaultPath = omni.Util.filePath(defaultFileName); + defaultPath = Util.filePath(defaultFileName); - SaveFileDialog sfd = new SaveFileDialog {Filter = omni.sGlobal["$GUI::FileSpec"], InitialDirectory = omni.Util.makeFullPath(defaultPath, ""), FileName = defaultFileName, OverwritePrompt = true,}; + SaveFileDialog sfd = new SaveFileDialog {Filter = sGlobal["$GUI::FileSpec"], InitialDirectory = Util.makeFullPath(defaultPath, ""), FileName = defaultFileName, OverwritePrompt = true,}; string filename = ""; @@ -93,9 +93,9 @@ public static string GetSaveName(string defaultFileName) if (dr == DialogResult.OK) { filename = Dialogs.GetForwardSlashFile(sfd.FileName); - GuiEditor["LastPath"] = omni.Util.filePath(filename); + GuiEditor["LastPath"] = Util.filePath(filename); //filename = dlg["FileName"]; - if (omni.Util.fileExt(filename) != ".gui") + if (Util.fileExt(filename) != ".gui") filename = filename + ".gui"; } @@ -116,16 +116,16 @@ public string getOpenName(string defaultFileName) GuiEditorGui.GuiEditor GuiEditor = "GuiEditor"; if (defaultFileName == "") - defaultFileName = omni.Util._expandFilename("^game/gui/untitled.gui"); + defaultFileName = Util._expandFilename("^game/gui/untitled.gui"); - OpenFileDialog ofd = new OpenFileDialog {FileName = defaultFileName, InitialDirectory = GuiEditor["LastPath"], Filter = omni.sGlobal["$GUI::FileSpec"], CheckFileExists = true, Multiselect = false}; + OpenFileDialog ofd = new OpenFileDialog {FileName = defaultFileName, InitialDirectory = GuiEditor["LastPath"], Filter = sGlobal["$GUI::FileSpec"], CheckFileExists = true, Multiselect = false}; DialogResult dr = Dialogs.OpenFileDialog(ref ofd); if (dr == DialogResult.OK) { string fileName = Dialogs.GetForwardSlashFile(ofd.FileName); - GuiEditor["LastPath"] = omni.Util.filePath(fileName); + GuiEditor["LastPath"] = Util.filePath(fileName); return fileName; } return ""; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorProfiles.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorProfiles.ed.cs index dce905c6..b3bca594 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorProfiles.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorProfiles.ed.cs @@ -47,13 +47,11 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.GuiEditor.gui.CodeBehi { public class GuiEditorProfiles { - internal static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "GuiEditorProfiles_initialize")] public static void initialize() { - omni.sGlobal["$GUI_EDITOR_DEFAULT_PROFILE_FILENAME"] = "art/gui/customProfiles.cs"; - omni.sGlobal["$GUI_EDITOR_DEFAULT_PROFILE_CATEGORY"] = "Other"; + pInvokes.sGlobal["$GUI_EDITOR_DEFAULT_PROFILE_FILENAME"] = "art/gui/customProfiles.cs"; + pInvokes.sGlobal["$GUI_EDITOR_DEFAULT_PROFILE_CATEGORY"] = "Other"; } //============================================================================================= diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorToolbox.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorToolbox.ed.cs index 90760d2d..4443464d 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorToolbox.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorToolbox.ed.cs @@ -409,7 +409,7 @@ public void startGuiControlDrag(string className) /// Utility function to sort rollouts by their caption. public static int _GuiEditorToolboxSortRollouts(SimObject a, SimObject b) { - return omni.Util.strinatcmp(a["caption"], b["caption"]); + return Util.strinatcmp(a["caption"], b["caption"]); } #region ProxyObjects Operator Overrides diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorUndo.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorUndo.ed.cs index b5931c1c..1d15927a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorUndo.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/CodeBehind/GuiEditorUndo.ed.cs @@ -47,8 +47,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.GuiEditor.gui.CodeBehi { public class GuiEditorUndo { - private static readonly pInvokes omni = new pInvokes(); - [TypeConverter(typeof (TypeConverterGeneric))] public class GenericUndoAction : UndoScriptAction { @@ -60,14 +58,14 @@ public string create() { // The instant group will try to add our // UndoAction if we don't disable it. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); GenericUndoAction act = new ObjectCreator("UndoScriptAction", "", typeof (GenericUndoAction)).Create(); act.actionName = "Edit Objects"; // Restore the instant group. - omni.Util.popInstantGroup(); + Util.popInstantGroup(); return act; } @@ -97,7 +95,7 @@ public void watch(SimObject objectx) this["fieldValues[" + objectx + "," + field + "]"] = objectx.getFieldValue(field, -1); } // clean spurious spaces from the field name list - this["fieldNames[" + objectx + "]"] = omni.Util.trim(this["fieldNames[" + objectx + "]"]); + this["fieldNames[" + objectx + "]"] = pInvokes.Util.trim(this["fieldNames[" + objectx + "]"]); // record that we know this object this["objectIds[" + objectx + "]"] = "1"; this["objectIdList"] = this["objectIdList"] + ' ' + objectx; @@ -128,15 +126,15 @@ public bool learn(SimObject objectx) } // trim - this["newFieldNames[" + objectx + "]"] = omni.Util.trim(this["newFieldNames[" + objectx + "]"]); + this["newFieldNames[" + objectx + "]"] = Util.trim(this["newFieldNames[" + objectx + "]"]); // look for differences //---------------------------------------------------------------------- bool diffs = false; string newFieldNames = this["newFieldNames[" + objectx + "]"]; string oldFieldNames = this["fieldNames[" + objectx + "]"]; - int numNewFields = omni.Util.getWordCount(newFieldNames); - int numOldFields = omni.Util.getWordCount(oldFieldNames); + int numNewFields = Util.getWordCount(newFieldNames); + int numOldFields = Util.getWordCount(oldFieldNames); // compare the old field list to the new field list. // if a field is on the old list that isn't on the new list, // add it to the newNullFields list. @@ -385,7 +383,7 @@ public string create(SimSet set, string root) GuiEditorGui.GuiEditor GuiEditor = "GuiEditor"; // Create action object. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); ObjectCreator undoAct = new ObjectCreator("UndoScriptAction", "", typeof (GuiEditorGroupAction)); undoAct["actionName"] = "Group"; undoAct["count"] = 1; @@ -398,7 +396,7 @@ public string create(SimSet set, string root) undoAct["#object"] = groupCreator; GuiEditorGroupAction action = undoAct.Create(); - omni.Util.popInstantGroup(); + Util.popInstantGroup(); // Add objects from set to group. @@ -810,7 +808,7 @@ public string create(SimSet set, string root) { // Create action object. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); ObjectCreator oc = new ObjectCreator("UndoScriptAction", "", typeof (GuiEditorUngroupAction)); oc["actionName"] = "Ungroup"; @@ -845,7 +843,7 @@ public string create(SimSet set, string root) } } - omni.Util.popInstantGroup(); + Util.popInstantGroup(); action.count = groupCount; return action; @@ -1004,12 +1002,12 @@ public virtual T create(SimSet set, string trash, string treeView, bool clear // The instant group will try to add our // UndoAction if we don't disable it. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); UndoScriptAction act = new ObjectCreator("UndoScriptAction", "", typeof (T)).Create(); // Restore the instant group. - omni.Util.popInstantGroup(); + Util.popInstantGroup(); for (uint i = 0; i < set.getCount(); i++) { diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/EditorChooseGUI.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/EditorChooseGUI.ed.cs index 92e9fd64..4f396847 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/EditorChooseGUI.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/EditorChooseGUI.ed.cs @@ -347,32 +347,32 @@ public static void GE_OpenGUIFile() { GuiCanvas Canvas = "Canvas"; - string openFileName = omni.console.Call_Classname("GuiBuilder", "getOpenName"); + string openFileName = console.Call_Classname("GuiBuilder", "getOpenName"); if (openFileName == "") return; // Make sure the file is valid. - if ((!omni.Util.isFile(openFileName)) && (!omni.Util.isFile(openFileName + ".dso"))) + if ((!Util.isFile(openFileName)) && (!Util.isFile(openFileName + ".dso"))) return; // Allow stomping objects while exec'ing the GUI file as we want to // pull the file's objects even if we have another version of the GUI // already loaded. - string oldRedefineBehavior = omni.sGlobal["$Con::redefineBehavior"]; - omni.sGlobal["$Con::redefineBehavior"] = "replaceExisting"; + string oldRedefineBehavior = sGlobal["$Con::redefineBehavior"]; + sGlobal["$Con::redefineBehavior"] = "replaceExisting"; // Load up the level. - SimObject guiContent = omni.Util.eval(openFileName); + SimObject guiContent = Util.eval(openFileName); - omni.sGlobal["$Con::redefineBehavior"] = oldRedefineBehavior; + sGlobal["$Con::redefineBehavior"] = oldRedefineBehavior; // The level file should have contained a scenegraph, which should now be in the instant // group. And, it should be the only thing in the group. //TODO if (!guiContent.isObject()) { - omni.Util.messageBox(omni.console.Call("getEngineName"), "You have loaded a Gui file that was created before this version. It has been loaded but you must open it manually from the content list dropdown", "Ok", "Information"); + Util.messageBox(console.Call("getEngineName"), "You have loaded a Gui file that was created before this version. It has been loaded but you must open it manually from the content list dropdown", "Ok", "Information"); GuiEditorGui.GuiEditContent(Canvas.getContent().AsString()); return; } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorGui.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorGui.ed.cs index 9a16893a..139fd19e 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorGui.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorGui.ed.cs @@ -2023,14 +2023,14 @@ public static void initialize() oc_Newobject78.Create(); - omni.bGlobal["$InGuiEditor"] = false; - omni.bGlobal["$MLAAFxGuiEditorTemp"] = false; + bGlobal["$InGuiEditor"] = false; + bGlobal["$MLAAFxGuiEditorTemp"] = false; ActionMap GlobalActionMap = "GlobalActionMap"; GlobalActionMap.bind("keyboard", "f10", "toggleGuiEditor"); - omni.Util.eval(@"package GuiEditor_BlockDialogs + Util.eval(@"package GuiEditor_BlockDialogs { function GuiCanvas::pushDialog() {} function GuiCanvas::popDialog() {} @@ -2309,7 +2309,7 @@ public static void GuiEdit(string val) if (val != "") return; - if (!omni.bGlobal["$InGuiEditor"]) + if (!bGlobal["$InGuiEditor"]) { GuiEditContent(Canvas.getContent()); @@ -2317,7 +2317,7 @@ public static void GuiEdit(string val) if (MLAAFx.isObject() && MLAAFx.isEnabled) { MLAAFx.isEnabled = false; - omni.bGlobal["$MLAAFxGuiEditorTemp"] = true; + bGlobal["$MLAAFxGuiEditorTemp"] = true; } } else @@ -2335,7 +2335,7 @@ public static void GuiEditContent(SimObject content) GuiEditor.openForEditing(content); - omni.bGlobal["$InGuiEditor"] = true; + bGlobal["$InGuiEditor"] = true; } [ConsoleInteraction] @@ -2352,7 +2352,7 @@ public static void toggleGuiEditor(bool make) // Cancel the scheduled event to prevent // the level from cycling after it's duration // has elapsed. - omni.Util.cancel(omni.iGlobal["$Game::Schedule"]); + Util.cancel(iGlobal["$Game::Schedule"]); } } @@ -2765,7 +2765,7 @@ public void toggleEdgeSnap() GuiBitmapButtonCtrl GuiEditorEdgeSnapping_btn = "GuiEditorEdgeSnapping_btn"; this.snapToEdges = !this.snapToEdges; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_EDGESNAP_INDEX"], this.snapToEdges); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_EDGESNAP_INDEX"], this.snapToEdges); GuiEditorEdgeSnapping_btn.setStateOn(this.snapToEdges); } @@ -2778,7 +2778,7 @@ public void toggleCenterSnap() GuiBitmapButtonCtrl GuiEditorCenterSnapping_btn = "GuiEditorCenterSnapping_btn"; this.snapToCenters = !this.snapToCenters; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_CENTERSNAP_INDEX"], this.snapToCenters); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_CENTERSNAP_INDEX"], this.snapToCenters); GuiEditorCenterSnapping_btn.setStateOn(this.snapToCenters); } @@ -2790,7 +2790,7 @@ public void toggleFullBoxSelection() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.fullBoxSelection = !this.fullBoxSelection; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("EditMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_FULLBOXSELECT_INDEX"], this.fullBoxSelection); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("EditMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_FULLBOXSELECT_INDEX"], this.fullBoxSelection); } //--------------------------------------------------------------------------------------------- @@ -2801,7 +2801,7 @@ public void toggleDrawGuides() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.drawGuides = !this.drawGuides; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_DRAWGUIDES_INDEX"], this.drawGuides); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_DRAWGUIDES_INDEX"], this.drawGuides); } //--------------------------------------------------------------------------------------------- @@ -2812,7 +2812,7 @@ public void toggleGuideSnap() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.snapToGuides = !this["snapToGuides"].AsBool(); - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_GUIDESNAP_INDEX"], this.snapToGuides); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_GUIDESNAP_INDEX"], this.snapToGuides); } //--------------------------------------------------------------------------------------------- @@ -2823,7 +2823,7 @@ public void toggleControlSnap() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.snapToControls = !this.snapToControls; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_CONTROLSNAP_INDEX"], this.snapToControls); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_CONTROLSNAP_INDEX"], this.snapToControls); } //--------------------------------------------------------------------------------------------- @@ -2834,7 +2834,7 @@ public void toggleCanvasSnap() GuiEditCanvas GuiEditCanvas = "GuiEditCanvas"; this.snapToCanvas = !this.snapToCanvas; - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_CANVASSNAP_INDEX"], this.snapToCanvas); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_CANVASSNAP_INDEX"], this.snapToCanvas); } //--------------------------------------------------------------------------------------------- @@ -2851,7 +2851,7 @@ public void toggleGridSnap() else this.setSnapToGrid(this["snap2GridSize"].AsUint()); - ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(omni.iGlobal["$GUI_EDITOR_MENU_GRIDSNAP_INDEX"], this.snap2Grid); + ((MenuBuilder) GuiEditCanvas.menuBar.FOF("SnapMenu")).checkItem(iGlobal["$GUI_EDITOR_MENU_GRIDSNAP_INDEX"], this.snap2Grid); GuiEditorSnapCheckBox.setStateOn(this.snap2Grid); } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorPrefsDlg.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorPrefsDlg.ed.cs index c13c6f1e..de435108 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorPrefsDlg.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/GuiEditor/gui/GuiEditorPrefsDlg.ed.cs @@ -281,8 +281,8 @@ public static void initialize() oc_Newobject9.Create(); - omni.iGlobal["$GuiEditor::defaultGridSize"] = 8; - omni.iGlobal["$GuiEditor::minGridSize"] = 3; + iGlobal["$GuiEditor::defaultGridSize"] = 8; + iGlobal["$GuiEditor::minGridSize"] = 3; } //----------------------------------------------------------------------------------------- diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/CodeBehind/MeshRoadEditorPlugin.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/CodeBehind/MeshRoadEditorPlugin.cs index 57b0051b..404185b9 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/CodeBehind/MeshRoadEditorPlugin.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/CodeBehind/MeshRoadEditorPlugin.cs @@ -42,6 +42,7 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; +using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.MeshRoadEditor.gui.CodeBehind @@ -95,7 +96,7 @@ public override void onWorldEditorStartup() // Add ourselves to the Editor Settings window //exec( "./meshRoadEditorSettingsTab.gui" ); - omni.console.Call("MeshRoadEditorSettingsTab_initialize"); + pInvokes.console.Call("MeshRoadEditorSettingsTab_initialize"); ESettingsWindow.addTabPage("EMeshRoadEditorSettingsPage"); } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/MeshRoadEditorGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/MeshRoadEditorGui.cs index 3296e983..d074d725 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/MeshRoadEditorGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/MeshRoadEditor/gui/MeshRoadEditorGui.cs @@ -530,18 +530,18 @@ public static void initialize() oc_Newobject21.Create(); - omni.bGlobal["$MeshRoad::wireframe"] = true; - omni.bGlobal["$MeshRoad::showSpline"] = true; - omni.bGlobal["$MeshRoad::showReflectPlane"] = false; - omni.bGlobal["$MeshRoad::showRoad"] = true; - omni.dGlobal["$MeshRoad::breakAngle"] = 3.0; + bGlobal["$MeshRoad::wireframe"] = true; + bGlobal["$MeshRoad::showSpline"] = true; + bGlobal["$MeshRoad::showReflectPlane"] = false; + bGlobal["$MeshRoad::showRoad"] = true; + dGlobal["$MeshRoad::breakAngle"] = 3.0; } [ConsoleInteraction] public override void onWake() { EWorldEditor EWorldEditor = "EWorldEditor"; - omni.bGlobal["$MeshRoad::EditorOpen"] = true; + bGlobal["$MeshRoad::EditorOpen"] = true; int count = EWorldEditor.getSelectionSize(); for (int i = 0; i < count; i++) @@ -561,7 +561,7 @@ public override void onWake() [ConsoleInteraction] public override void onSleep() { - omni.bGlobal["$MeshRoad::EditorOpen"] = false; + bGlobal["$MeshRoad::EditorOpen"] = false; } [ConsoleInteraction] @@ -591,7 +591,7 @@ public override void onRoadSelected(string road) // Update the materialEditorList if (road.isObject()) - omni.sGlobal["$Tools::materialEditorList"] = road; + sGlobal["$Tools::materialEditorList"] = road; else return; @@ -700,7 +700,7 @@ public void onBrowseClicked() if (dr == DialogResult.OK) { string fileName = Dialogs.GetForwardSlashFile(ofd.FileName); - this["lastPath"] = omni.console.Call("filePath", new string[] {fileName}); + this["lastPath"] = console.Call("filePath", new string[] {fileName}); //string filename = dlg["FileName"]; //TODO diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/CreateNewNavMeshDlg.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/CreateNewNavMeshDlg.cs index d56a985f..c357f4b1 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/CreateNewNavMeshDlg.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/CreateNewNavMeshDlg.cs @@ -50,8 +50,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.NavEditor.gui [TypeConverter(typeof (TypeConverterGeneric))] public class CreateNewNavMeshDlg : GuiControl { - private static readonly pInvokes omni = new pInvokes(); - public static void initialize() { ObjectCreator oc_Newobject00011; @@ -432,7 +430,7 @@ public static string MissionBoundsExtents(SimSet group) string wbox = "0 0 0 0 0 0"; if (cls == "SimGroup" || cls == "SimSet" || cls == "Path") wbox = MissionBoundsExtents((SimSet) obj); - else if (obj.GetType() == typeof (SceneObject) && ((SceneObject) obj).getType() == omni.iGlobal["$TypeMasks::StaticObjectType"] && !(((SceneObject) obj).getType() == omni.iGlobal["$TypeMasks::EnvironmentObjectType"])) + else if (obj.GetType() == typeof (SceneObject) && ((SceneObject) obj).getType() == iGlobal["$TypeMasks::StaticObjectType"] && !(((SceneObject) obj).getType() == iGlobal["$TypeMasks::EnvironmentObjectType"])) wbox = ((SceneObject) obj).getWorldBox().AsString(); else continue; @@ -440,14 +438,14 @@ public static string MissionBoundsExtents(SimSet group) // Update min point. for (int j = 0; j < 3; j++) { - if (omni.Util.getWord(box, j).AsInt() > omni.Util.getWord(wbox, j).AsInt()) - box = omni.Util.setWord(box, j, omni.Util.getWord(wbox, j)); + if (Util.getWord(box, j).AsInt() > Util.getWord(wbox, j).AsInt()) + box = Util.setWord(box, j, Util.getWord(wbox, j)); } // Update max point. for (int j = 3; j < 6; j++) { - if (omni.Util.getWord(box, j).AsInt() < omni.Util.getWord(wbox, j).AsInt()) - box = omni.Util.setWord(box, j, omni.Util.getWord(wbox, j)); + if (Util.getWord(box, j).AsInt() < Util.getWord(wbox, j).AsInt()) + box = Util.setWord(box, j, Util.getWord(wbox, j)); } } return box; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/NavEditorGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/NavEditorGui.cs index def6f16d..07c5fce5 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/NavEditorGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/gui/NavEditorGui.cs @@ -50,8 +50,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.NavEditor.gui [TypeConverter(typeof (TypeConverterGeneric))] public class NavEditorGui : GuiNavEditorCtrl { - private static readonly pInvokes omni = new pInvokes(); - public NavMesh selectedObject { get { return this["selectedObject"]; } @@ -1308,13 +1306,13 @@ public static void initialize() oc_Newobject00056.Create(); } - omni.bGlobal["$Nav::EditorOpen"] = false; - omni.bGlobal["$Nav::Editor::renderMesh"] = true; - omni.bGlobal["$Nav::Editor::renderPortals"] = false; - omni.bGlobal["$Nav::Editor::renderBVTree"] = false; - omni.bGlobal["$Nav::Editor::backgroundBuild"] = true; - omni.bGlobal["$Nav::Editor::saveIntermediates"] = false; - omni.bGlobal["$Nav::Editor::playSoundWhenDone"] = false; + bGlobal["$Nav::EditorOpen"] = false; + bGlobal["$Nav::Editor::renderMesh"] = true; + bGlobal["$Nav::Editor::renderPortals"] = false; + bGlobal["$Nav::Editor::renderBVTree"] = false; + bGlobal["$Nav::Editor::backgroundBuild"] = true; + bGlobal["$Nav::Editor::saveIntermediates"] = false; + bGlobal["$Nav::Editor::playSoundWhenDone"] = false; } [ConsoleInteraction] @@ -1493,12 +1491,12 @@ public static void updateLinkData(GuiControl control, int flags) LinkClimbFlag.setActive(true); LinkTeleportFlag.setActive(true); - LinkWalkFlag.setStateOn(flags == omni.iGlobal["$Nav::WalkFlag"]); - LinkJumpFlag.setStateOn(flags == omni.iGlobal["$Nav::JumpFlag"]); - LinkDropFlag.setStateOn(flags == omni.iGlobal["$Nav::DropFlag"]); - LinkLedgeFlag.setStateOn(flags == omni.iGlobal["$Nav::LedgeFlag"]); - LinkClimbFlag.setStateOn(flags == omni.iGlobal["$Nav::ClimbFlag"]); - LinkTeleportFlag.setStateOn(flags == omni.iGlobal["$Nav::TeleportFlag"]); + LinkWalkFlag.setStateOn(flags == iGlobal["$Nav::WalkFlag"]); + LinkJumpFlag.setStateOn(flags == iGlobal["$Nav::JumpFlag"]); + LinkDropFlag.setStateOn(flags == iGlobal["$Nav::DropFlag"]); + LinkLedgeFlag.setStateOn(flags == iGlobal["$Nav::LedgeFlag"]); + LinkClimbFlag.setStateOn(flags == iGlobal["$Nav::ClimbFlag"]); + LinkTeleportFlag.setStateOn(flags == iGlobal["$Nav::TeleportFlag"]); } [ConsoleInteraction] @@ -1511,7 +1509,7 @@ public static int getLinkFlags(GuiControl control) GuiCheckBoxCtrl LinkClimbFlag = control.FOT("LinkClimbFlag"); GuiCheckBoxCtrl LinkTeleportFlag = control.FOT("LinkTeleportFlag"); - return (LinkWalkFlag.isStateOn() ? omni.iGlobal["$Nav::WalkFlag"] : 0) | (LinkJumpFlag.isStateOn() ? omni.iGlobal["$Nav::JumpFlag"] : 0) | (LinkDropFlag.isStateOn() ? omni.iGlobal["$Nav::DropFlag"] : 0) | (LinkLedgeFlag.isStateOn() ? omni.iGlobal["$Nav::LedgeFlag"] : 0) | (LinkClimbFlag.isStateOn() ? omni.iGlobal["$Nav::ClimbFlag"] : 0) | (LinkTeleportFlag.isStateOn() ? omni.iGlobal["$Nav::TeleportFlag"] : 0); + return (LinkWalkFlag.isStateOn() ? iGlobal["$Nav::WalkFlag"] : 0) | (LinkJumpFlag.isStateOn() ? iGlobal["$Nav::JumpFlag"] : 0) | (LinkDropFlag.isStateOn() ? iGlobal["$Nav::DropFlag"] : 0) | (LinkLedgeFlag.isStateOn() ? iGlobal["$Nav::LedgeFlag"] : 0) | (LinkClimbFlag.isStateOn() ? iGlobal["$Nav::ClimbFlag"] : 0) | (LinkTeleportFlag.isStateOn() ? iGlobal["$Nav::TeleportFlag"] : 0); } [ConsoleInteraction] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/main.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/main.cs index 131cf672..4bbc3ce2 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/main.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/NavEditor/main.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -44,20 +44,18 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.NavEditor { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializeNavEditor() { - omni.Util._echo(" % - Initializing Navigation Editor"); + pInvokes.Util._echo(" % - Initializing Navigation Editor"); - omni.iGlobal["$Nav::WalkFlag"] = 1 << 0; - omni.iGlobal["$Nav::SwimFlag"] = 1 << 1; - omni.iGlobal["$Nav::JumpFlag"] = 1 << 2; - omni.iGlobal["$Nav::LedgeFlag"] = 1 << 3; - omni.iGlobal["$Nav::DropFlag"] = 1 << 4; - omni.iGlobal["$Nav::ClimbFlag"] = 1 << 5; - omni.iGlobal["$Nav::TeleportFlag"] = 1 << 6; + pInvokes.iGlobal["$Nav::WalkFlag"] = 1 << 0; + pInvokes.iGlobal["$Nav::SwimFlag"] = 1 << 1; + pInvokes.iGlobal["$Nav::JumpFlag"] = 1 << 2; + pInvokes.iGlobal["$Nav::LedgeFlag"] = 1 << 3; + pInvokes.iGlobal["$Nav::DropFlag"] = 1 << 4; + pInvokes.iGlobal["$Nav::ClimbFlag"] = 1 << 5; + pInvokes.iGlobal["$Nav::TeleportFlag"] = 1 << 6; // Execute all relevant scripts and GUIs. //exec("./NavEditor.cs"); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleEmitterEditor.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleEmitterEditor.ed.cs index a6c1e75a..1b209a2b 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleEmitterEditor.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleEmitterEditor.ed.cs @@ -49,12 +49,10 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.ParticleEditor.gui.Cod { public class ParticleEmitterEditor { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ParticleEmitterEditor_initialize")] public static void initialize() { - omni.sGlobal["$PE_EMITTEREDITOR_DEFAULT_FILENAME"] = "art/particles/managedParticleEmitterData.cs"; + pInvokes.sGlobal["$PE_EMITTEREDITOR_DEFAULT_FILENAME"] = "art/particles/managedParticleEmitterData.cs"; } //============================================================================================= diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleParticleEditor.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleParticleEditor.cs index a73a4942..1a28bd4c 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleParticleEditor.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/CodeBehind/ParticleParticleEditor.cs @@ -49,12 +49,10 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.ParticleEditor.gui.Cod { public class ParticleParticleEditor { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ParticleParticleEditor_intialize")] public static void initialize() { - omni.sGlobal["$PE_PARTICLEEDITOR_DEFAULT_FILENAME"] = "art/particles/managedParticleData.cs"; + pInvokes.sGlobal["$PE_PARTICLEEDITOR_DEFAULT_FILENAME"] = "art/particles/managedParticleData.cs"; } //============================================================================================= diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/ParticleEditor.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/ParticleEditor.ed.cs index 9679a5a7..eab5097d 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/ParticleEditor.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ParticleEditor/gui/ParticleEditor.ed.cs @@ -54,21 +54,21 @@ public class ParticleEditor : ScriptObject [ConsoleInteraction(true, "ParticleEditor_initialize")] public static void initialize() { - omni.sGlobal["$PE_guielement_pos_single_container"] = "0 0"; - omni.sGlobal["$PE_guielement_ext_single_container"] = "184 20"; - omni.sGlobal["$PE_guielement_pos_name"] = "1 0"; - omni.sGlobal["$PE_guielement_ext_name"] = "70 18"; - omni.sGlobal["$PE_guielement_pos_slider"] = "74 2"; - omni.sGlobal["$PE_guielement_ext_slider"] = "58 12"; - omni.sGlobal["$PE_guielement_pos_value"] = "138 0"; - omni.sGlobal["$PE_guielement_ext_value"] = "36 18"; - omni.sGlobal["$PE_guielement_pos_textedit"] = "74 0"; - omni.sGlobal["$PE_guielement_ext_textedit"] = "100 18"; - omni.sGlobal["$PE_guielement_ext_checkbox_name"] = "156 18"; - omni.sGlobal["$PE_guielement_pos_checkbox"] = "161 0"; - omni.sGlobal["$PE_guielement_ext_checkbox"] = "15 18"; - omni.sGlobal["$PE_guielement_pos_colorpicker"] = "158 0"; - omni.sGlobal["$PE_guielement_ext_colorpicker"] = "18 18"; + sGlobal["$PE_guielement_pos_single_container"] = "0 0"; + sGlobal["$PE_guielement_ext_single_container"] = "184 20"; + sGlobal["$PE_guielement_pos_name"] = "1 0"; + sGlobal["$PE_guielement_ext_name"] = "70 18"; + sGlobal["$PE_guielement_pos_slider"] = "74 2"; + sGlobal["$PE_guielement_ext_slider"] = "58 12"; + sGlobal["$PE_guielement_pos_value"] = "138 0"; + sGlobal["$PE_guielement_ext_value"] = "36 18"; + sGlobal["$PE_guielement_pos_textedit"] = "74 0"; + sGlobal["$PE_guielement_ext_textedit"] = "100 18"; + sGlobal["$PE_guielement_ext_checkbox_name"] = "156 18"; + sGlobal["$PE_guielement_pos_checkbox"] = "161 0"; + sGlobal["$PE_guielement_ext_checkbox"] = "15 18"; + sGlobal["$PE_guielement_pos_colorpicker"] = "158 0"; + sGlobal["$PE_guielement_ext_colorpicker"] = "18 18"; #region GuiWindowCollapseCtrl (PE_Window) oc_Newobject243 diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/CodeBehind/RiverEditorPlugin.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/CodeBehind/RiverEditorPlugin.cs index be8492ab..bdb9d8e0 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/CodeBehind/RiverEditorPlugin.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/CodeBehind/RiverEditorPlugin.cs @@ -116,7 +116,7 @@ public override void onActivated() //Copyright Winterleaf Entertainment L.L.C. 2013 this.readSettings(); - omni.bGlobal["$River::EditorOpen"] = true; + bGlobal["$River::EditorOpen"] = true; ((GuiBitmapButtonCtrl) ((GuiDynamicCtrlArrayControl) "ToolsPaletteArray").findObjectByInternalName("RiverEditorAddRiverMode", false)).performClick(); EditorGui.bringToFront("RiverEditorGui"); @@ -166,7 +166,7 @@ public override void onDeactivated() this.writeSettings(); - omni.bGlobal["$River::EditorOpen"] = false; + bGlobal["$River::EditorOpen"] = false; RiverEditorGui.setVisible(false); RiverEditorToolbar.setVisible(false); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/RiverEditorGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/RiverEditorGui.cs index 013eef3d..531fd5ee 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/RiverEditorGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RiverEditor/gui/RiverEditorGui.cs @@ -533,11 +533,11 @@ public static void initialize() oc_Newobject21.Create(); - omni.bGlobal["$River::EditorOpen"] = false; - omni.bGlobal["$River::wireframe"] = true; - omni.bGlobal["$River::showSpline"] = true; - omni.bGlobal["$River::showRiver"] = true; - omni.bGlobal["$River::showWalls"] = true; + bGlobal["$River::EditorOpen"] = false; + bGlobal["$River::wireframe"] = true; + bGlobal["$River::showSpline"] = true; + bGlobal["$River::showRiver"] = true; + bGlobal["$River::showWalls"] = true; } [ConsoleInteraction] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/CodeBehind/RoadEditorPlugin.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/CodeBehind/RoadEditorPlugin.cs index 35c02bc4..886ae47b 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/CodeBehind/RoadEditorPlugin.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/CodeBehind/RoadEditorPlugin.cs @@ -43,6 +43,7 @@ using WinterLeaf.Engine.Classes.Decorations; using WinterLeaf.Engine.Classes.Extensions; using WinterLeaf.Engine.Classes.Helpers; +using WinterLeaf.Engine.Classes.Interopt; using WinterLeaf.Engine.Classes.View.Creators; namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.RoadEditor.gui.CodeBehind @@ -87,14 +88,14 @@ public override void onWorldEditorStartup() // Add ourselves to the ToolsToolbar string tooltip = "Road Editor (" + accel + ")"; - EditorGui.addToToolsToolbar("RoadEditorPlugin", "RoadEditorPalette", omni.Util._expandFilename("tools/worldEditor/images/toolbar/road-path-editor"), tooltip); + EditorGui.addToToolsToolbar("RoadEditorPlugin", "RoadEditorPalette", pInvokes.Util._expandFilename("tools/worldEditor/images/toolbar/road-path-editor"), tooltip); //connect editor windows ((GuiWindowCollapseCtrl) "RoadEditorOptionsWindow").attachTo("RoadEditorTreeWindow"); // Add ourselves to the Editor Settings window //exec( "./RoadEditorSettingsTab.gui" ); - omni.console.Call("RoadEditorSettingsTab_initialize"); + pInvokes.console.Call("RoadEditorSettingsTab_initialize"); ((ESettingsWindow) "ESettingsWindow").addTabPage("ERoadEditorSettingsPage"); } @@ -210,7 +211,7 @@ public override void onSaveMission(string missionFile) public override bool? setEditorFunction(string overrideGroup = "") { bool terrainExists = AggregateControl.parseMissionGroup("TerrainBlock"); - // omni.console.Call("parseMissionGroup", new string[] { "TerrainBlock" }).AsBool(); + // pInvokes.console.Call("parseMissionGroup", new string[] { "TerrainBlock" }).AsBool(); if (terrainExists == false) messageBox.MessageBoxYesNoCancel("No Terrain", "Would you like to create a New Terrain?", "Canvas.pushDialog(CreateNewTerrainGui);"); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/RoadEditorGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/RoadEditorGui.cs index 1c9c1796..4833eace 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/RoadEditorGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/RoadEditor/gui/RoadEditorGui.cs @@ -493,7 +493,7 @@ public override void onWake() { EWorldEditor EWorldEditor = "EWorldEditor"; - omni.bGlobal["$DecalRoad::EditorOpen"] = true; + bGlobal["$DecalRoad::EditorOpen"] = true; int count = EWorldEditor.getSelectionSize(); for (uint i = 0; i < count; i++) @@ -511,7 +511,7 @@ public override void onWake() [ConsoleInteraction] public override void onSleep() { - omni.bGlobal["$DecalRoad::EditorOpen"] = false; + bGlobal["$DecalRoad::EditorOpen"] = false; } [ConsoleInteraction] @@ -560,7 +560,7 @@ public override void onRoadSelected(string road) // Update the materialEditorList if (road.isObject()) - omni.sGlobal["$Tools::materialEditorList"] = road; + sGlobal["$Tools::materialEditorList"] = road; else return; @@ -640,7 +640,7 @@ public void onBrowseClicked() if (dr == DialogResult.OK) { string fileName = Dialogs.GetForwardSlashFile(ofd.FileName); - this["lastPath"] = omni.console.Call("filePath", new string[] {fileName}); + this["lastPath"] = console.Call("filePath", new string[] {fileName}); //string filename = fileName; //TODO diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditor.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditor.ed.cs index bb03287d..98ecda5d 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditor.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditor.ed.cs @@ -90,8 +90,8 @@ public static void initialize() [ConsoleInteraction] public static string strcapitalise(string str) { - int len = omni.Util.strlen(str); - return omni.Util.strupr(omni.Util.getSubStr(str, 0, 1)) + omni.Util.getSubStr(str, 1, len - 1); + int len = Util.strlen(str); + return Util.strupr(Util.getSubStr(str, 0, 1)) + Util.getSubStr(str, 1, len - 1); } [ConsoleInteraction] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorActions.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorActions.ed.cs index e92899b5..80e39923 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorActions.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorActions.ed.cs @@ -49,8 +49,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.ShapeEditor.gui.CodeBe { public class ShapeEditorActions { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ShapeEditorActions_initialize")] public static void initialize() { diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorPlugin.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorPlugin.cs index d6938183..668df51d 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorPlugin.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/ShapeEditor/gui/CodeBehind/ShapeEditorPlugin.cs @@ -53,8 +53,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.ShapeEditor.gui.CodeBe [TypeConverter(typeof (TypeConverterGeneric))] public class ShapeEditorPlugin : EditorPlugin { - private static readonly pInvokes omni = new pInvokes(); - internal ActionMap map { get { return this["map"]; } @@ -424,8 +422,8 @@ public static void shapeEditorWireframeMode() ShapeEditorToolbar ShapeEditorToolbar = "ShapeEditorToolbar"; GuiBitmapButtonCtrl wireframeMode = ShapeEditorToolbar.FOT("wireframeMode"); - omni.bGlobal["$gfx::wireframe"] = !omni.bGlobal["$gfx::wireframe"]; - wireframeMode.setStateOn(omni.bGlobal["$gfx::wireframe"]); + bGlobal["$gfx::wireframe"] = !bGlobal["$gfx::wireframe"]; + wireframeMode.setStateOn(bGlobal["$gfx::wireframe"]); } //----------------------------------------------------------------------------- diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/MenuHandlers.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/MenuHandlers.ed.cs index 1dc78c6d..60be4998 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/MenuHandlers.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/MenuHandlers.ed.cs @@ -60,12 +60,10 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor { public class MenuHandlers { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "MenuHandlers_initialize")] public static void initialize() { - omni.sGlobal["$Pref::WorldEditor::FileSpec"] = "Torque Mission Files (*.mis)|*.mis|All Files (*.*)|*.*"; + pInvokes.sGlobal["$Pref::WorldEditor::FileSpec"] = "Torque Mission Files (*.mis)|*.mis|All Files (*.*)|*.*"; // Package that gets temporarily activated to toggle editor after mission loading. // Deactivates itself. @@ -80,9 +78,9 @@ public static void initialize() } };"; - omni.Util.eval(package); + pInvokes.Util.eval(package); - //omni.Util.deactivatePackage("BootEditor"); + //pInvokes.Util.deactivatePackage("BootEditor"); } /// Checks the various dirty flags and returns true if the @@ -133,16 +131,16 @@ public static void EditorClearDirty() [ConsoleInteraction] public static void EditorQuitGame() { - if (EditorIsDirty() && !omni.Util.isWebDemo()) + if (EditorIsDirty() && !pInvokes.Util.isWebDemo()) messageBox.MessageBoxYesNoCancel("Level Modified", "Would you like to save your changes before quitting?", "EditorSaveMissionMenu(); quit();", "quit();", ""); else - omni.console.Call("quit"); + pInvokes.console.Call("quit"); } [ConsoleInteraction] public static void EditorExitMission() { - if (EditorIsDirty() && !omni.Util.isWebDemo()) + if (EditorIsDirty() && !pInvokes.Util.isWebDemo()) messageBox.MessageBoxYesNoCancel("Level Modified", "Would you like to save your changes before exiting?", "EditorDoExitMission(true);", "EditorDoExitMission(false);", ""); else EditorDoExitMission(false); @@ -154,7 +152,7 @@ public static void EditorDoExitMission(bool saveFirst) GuiChunkedBitmapCtrl MainMenuGui = "MainMenuGui"; editor Editor = "Editor"; - if (saveFirst && !omni.Util.isWebDemo()) + if (saveFirst && !pInvokes.Util.isWebDemo()) EditorSaveMissionMenu(); else EditorClearDirty(); @@ -162,7 +160,7 @@ public static void EditorDoExitMission(bool saveFirst) if (MainMenuGui.isObject()) Editor.close(MainMenuGui); - omni.console.Call("disconnect"); + pInvokes.console.Call("disconnect"); } [ConsoleInteraction] @@ -173,7 +171,7 @@ public static void EditorOpenTorsionProject(string projectFile) // Make sure we have a valid path to the Torsion installation. string torsionPath = EditorSettings.value("WorldEditor/torsionPath"); - if (!omni.Util.isFile(torsionPath)) + if (!pInvokes.Util.isFile(torsionPath)) { messageBox.MessageBoxOK("Torsion Not Found", "Torsion not found at '" + torsionPath + "'. Please set the correct path in the preferences."); return; @@ -183,14 +181,14 @@ public static void EditorOpenTorsionProject(string projectFile) if (projectFile == "") { - string projectName = omni.Util.fileBase(omni.Util.getExecutableName()); - projectFile = omni.Util.makeFullPath(projectName + ".torsion", ""); - if (!omni.Util.isFile(projectFile)) + string projectName = pInvokes.Util.fileBase(pInvokes.Util.getExecutableName()); + projectFile = pInvokes.Util.makeFullPath(projectName + ".torsion", ""); + if (!pInvokes.Util.isFile(projectFile)) { - projectFile = omni.Util.findFirstFile("*.torsion", false); - if (!omni.Util.isFile(projectFile)) + projectFile = pInvokes.Util.findFirstFile("*.torsion", false); + if (!pInvokes.Util.isFile(projectFile)) { - messageBox.MessageBoxOK("Project File Not Found", "Cannot find .torsion project file in '" + omni.Util.getMainDotCsDir() + "'."); + messageBox.MessageBoxOK("Project File Not Found", "Cannot find .torsion project file in '" + pInvokes.Util.getMainDotCsDir() + "'."); return; } } @@ -198,7 +196,7 @@ public static void EditorOpenTorsionProject(string projectFile) // Open the project in Torsion. - omni.Util.shellExecute(torsionPath, "\"" + projectFile + "\""); + pInvokes.Util.shellExecute(torsionPath, "\"" + projectFile + "\""); } [ConsoleInteraction] @@ -209,7 +207,7 @@ public static void EditorOpenFileInTorsion(string file, string line) // Make sure we have a valid path to the Torsion installation. string torsionPath = EditorSettings.value("WorldEditor/torsionPath"); - if (!omni.Util.isFile(torsionPath)) + if (!pInvokes.Util.isFile(torsionPath)) { messageBox.MessageBoxOK("Torsion Not Found", "Torsion not found at '" + torsionPath + "'. Please set the correct path in the preferences."); return; @@ -218,7 +216,7 @@ public static void EditorOpenFileInTorsion(string file, string line) // If no file was specified, take the current mission file. if (file == "") - file = omni.Util.makeFullPath(omni.sGlobal["$Server::MissionFile"], ""); + file = pInvokes.Util.makeFullPath(pInvokes.sGlobal["$Server::MissionFile"], ""); // Open the file in Torsion. @@ -227,7 +225,7 @@ public static void EditorOpenFileInTorsion(string file, string line) args = args + ":" + line; args = args + "\""; - omni.Util.shellExecute(torsionPath, args); + pInvokes.Util.shellExecute(torsionPath, args); } [ConsoleInteraction] @@ -237,7 +235,7 @@ public static void EditorOpenDeclarationInTorsion(SimObject xobject) if (fileName == "") return; - EditorOpenFileInTorsion(omni.Util.makeFullPath(fileName, "'"), xobject.getDeclarationLine().AsString()); + EditorOpenFileInTorsion(pInvokes.Util.makeFullPath(fileName, "'"), xobject.getDeclarationLine().AsString()); } [ConsoleInteraction] @@ -247,14 +245,14 @@ public static void EditorNewLevel(string file) EditorGui EditorGui = "EditorGui"; Settings EditorSettings = "EditorSettings"; - if (omni.Util.isWebDemo()) + if (pInvokes.Util.isWebDemo()) return; bool saveFirst = false; if (EditorIsDirty()) { - omni.Util._error("knob"); - saveFirst = omni.Util.messageBox("Mission Modified", "Would you like to save changes to the current mission \"" + omni.sGlobal["$Server::MissionFile"] + "\" before creating a new mission?", "SaveDontSave", "Question") == omni.iGlobal["$MROk"]; + pInvokes.Util._error("knob"); + saveFirst = pInvokes.Util.messageBox("Mission Modified", "Would you like to save changes to the current mission \"" + pInvokes.sGlobal["$Server::MissionFile"] + "\" before creating a new mission?", "SaveDontSave", "Question") == pInvokes.iGlobal["$MROk"]; } if (saveFirst) @@ -270,9 +268,9 @@ public static void EditorNewLevel(string file) if (file == "") file = EditorSettings.value("WorldEditor/newLevelFile"); - if (!omni.bGlobal["$missionRunning"]) + if (!pInvokes.bGlobal["$missionRunning"]) { - omni.Util.activatePackage("BootEditor"); + pInvokes.Util.activatePackage("BootEditor"); chooseLevelDlg.StartLevel(file, ""); } else @@ -288,7 +286,7 @@ public static void EditorSaveMissionMenu() { EditorGui EditorGui = "EditorGui"; - if (!omni.bGlobal["$Pref::disableSaving"] && !omni.Util.isWebDemo()) + if (!pInvokes.bGlobal["$Pref::disableSaving"] && !pInvokes.Util.isWebDemo()) { if (EditorGui["saveAs"].AsBool()) EditorSaveMissionAs(""); @@ -312,22 +310,22 @@ public static bool EditorSaveMission() // just save the mission without renaming it // first check for dirty and read-only files: - if ((EWorldEditor.isDirty || ETerrainEditor.isMissionDirty) && !omni.Util.isWriteableFileName(omni.sGlobal["$Server::MissionFile"])) + if ((EWorldEditor.isDirty || ETerrainEditor.isMissionDirty) && !pInvokes.Util.isWriteableFileName(pInvokes.sGlobal["$Server::MissionFile"])) { - omni.Util.messageBox("Error", "Mission file \"" + omni.sGlobal["$Server::MissionFile"] + "\" is read-only. Continue?", "Ok", "Stop"); + pInvokes.Util.messageBox("Error", "Mission file \"" + pInvokes.sGlobal["$Server::MissionFile"] + "\" is read-only. Continue?", "Ok", "Stop"); return false; } if (ETerrainEditor.isDirty) { // Find all of the terrain files - omni.Util.initContainerTypeSearch(omni.uGlobal["$TypeMasks::TerrainObjectType"], false); + pInvokes.Util.initContainerTypeSearch(pInvokes.uGlobal["$TypeMasks::TerrainObjectType"], false); TerrainBlock terrainObject; - while ((terrainObject = omni.Util.containerSearchNext(false)) != 0) + while ((terrainObject = pInvokes.Util.containerSearchNext(false)) != 0) { - if (!omni.Util.isWriteableFileName(terrainObject["terrainFile"])) + if (!pInvokes.Util.isWriteableFileName(terrainObject["terrainFile"])) { - if (omni.Util.messageBox("Error", "Terrain file \"" + terrainObject["terrainFile"] + "\" is read-only. Continue?", "Ok", "Stop") == omni.iGlobal["$MROk"]) + if (pInvokes.Util.messageBox("Error", "Terrain file \"" + terrainObject["terrainFile"] + "\" is read-only. Continue?", "Ok", "Stop") == pInvokes.iGlobal["$MROk"]) continue; else return false; @@ -338,14 +336,14 @@ public static bool EditorSaveMission() // now write the terrain and mission files out: if (EWorldEditor.isDirty || ETerrainEditor["isMissionDirty"].AsBool()) - MissionGroup.save(omni.sGlobal["$Server::MissionFile"], false, ""); + MissionGroup.save(pInvokes.sGlobal["$Server::MissionFile"], false, ""); if (ETerrainEditor["isDirty"].AsBool()) { // Find all of the terrain files - omni.Util.initContainerTypeSearch(omni.uGlobal["$TypeMasks::TerrainObjectType"], false); + pInvokes.Util.initContainerTypeSearch(pInvokes.uGlobal["$TypeMasks::TerrainObjectType"], false); TerrainBlock terrainObject; - while ((terrainObject = omni.Util.containerSearchNext(false)) != 0) + while ((terrainObject = pInvokes.Util.containerSearchNext(false)) != 0) terrainObject.save(terrainObject["terrainFile"]); } @@ -356,7 +354,7 @@ public static bool EditorSaveMission() { EditorPlugin obj = EditorPluginSet.getObject(i); if (obj.isDirty()) - obj.onSaveMission(omni.sGlobal["$Server::MissionFile"]); + obj.onSaveMission(pInvokes.sGlobal["$Server::MissionFile"]); } EditorClearDirty(); @@ -388,13 +386,13 @@ public static void EditorSaveMissionAs(string missionName) EditorGui EditorGui = "EditorGui"; TerrainEditor ETerrainEditor = "ETerrainEditor"; - if (!omni.bGlobal["$Pref::disableSaving"] && !omni.Util.isWebDemo()) + if (!pInvokes.bGlobal["$Pref::disableSaving"] && !pInvokes.Util.isWebDemo()) { // If we didn't get passed a new mission name then // prompt the user for one. if (missionName == "") { - SaveFileDialog sfd = new SaveFileDialog {Filter = omni.sGlobal["$Pref::WorldEditor::FileSpec"], InitialDirectory = Path.Combine(Environment.CurrentDirectory, EditorSettings.value("LevelInformation/levelsDirectory")), OverwritePrompt = true,}; + SaveFileDialog sfd = new SaveFileDialog {Filter = pInvokes.sGlobal["$Pref::WorldEditor::FileSpec"], InitialDirectory = Path.Combine(Environment.CurrentDirectory, EditorSettings.value("LevelInformation/levelsDirectory")), OverwritePrompt = true,}; DialogResult dr = Dialogs.SaveFileDialog(ref sfd); @@ -403,7 +401,7 @@ public static void EditorSaveMissionAs(string missionName) case DialogResult.OK: string filename = Dialogs.GetForwardSlashFile(sfd.FileName); // Immediately override/set the levelsDirectory - EditorSettings.setValue("LevelInformation/levelsDirectory", omni.console.Call("collapseFilename", new string[] {omni.Util.filePath(filename)})); + EditorSettings.setValue("LevelInformation/levelsDirectory", pInvokes.console.Call("collapseFilename", new string[] {pInvokes.Util.filePath(filename)})); missionName = filename; break; @@ -416,36 +414,36 @@ public static void EditorSaveMissionAs(string missionName) } } - if (omni.Util.fileExt(missionName) != ".mis") + if (pInvokes.Util.fileExt(missionName) != ".mis") missionName = missionName + ".mis"; EWorldEditor.isDirty = true; - string saveMissionFile = omni.sGlobal["$Server::MissionFile"]; + string saveMissionFile = pInvokes.sGlobal["$Server::MissionFile"]; - omni.sGlobal["$Server::MissionFile"] = missionName; + pInvokes.sGlobal["$Server::MissionFile"] = missionName; bool copyTerrainsFailed = false; // Rename all the terrain files. Save all previous names so we can // reset them if saving fails. - string newMissionName = omni.Util.fileBase(missionName); - string oldMissionName = omni.Util.fileBase(saveMissionFile); + string newMissionName = pInvokes.Util.fileBase(missionName); + string oldMissionName = pInvokes.Util.fileBase(saveMissionFile); - omni.Util.initContainerTypeSearch(omni.uGlobal["$TypeMasks::TerrainObjectType"]); + pInvokes.Util.initContainerTypeSearch(pInvokes.uGlobal["$TypeMasks::TerrainObjectType"]); ScriptObject savedTerrNames = new ObjectCreator("ScriptObject").Create(); for (int i = 0;; i++) { - string nterrainObject = omni.Util.containerSearchNext(false); + string nterrainObject = pInvokes.Util.containerSearchNext(false); if (nterrainObject == "") break; - TerrainBlock terrainObject = nterrainObject; //omni.Util.containerSearchNext(false); + TerrainBlock terrainObject = nterrainObject; //pInvokes.Util.containerSearchNext(false); //if (terrainObject == null) // break; savedTerrNames["array[" + i + "]"] = terrainObject["terrainFile"]; - string terrainFilePath = omni.Util.makeRelativePath(omni.Util.filePath(terrainObject["terrainFile"]), omni.Util.getMainDotCsDir()); - string terrainFileName = omni.Util.fileName(terrainObject["terrainFile"]); + string terrainFilePath = pInvokes.Util.makeRelativePath(pInvokes.Util.filePath(terrainObject["terrainFile"]), pInvokes.Util.getMainDotCsDir()); + string terrainFileName = pInvokes.Util.fileName(terrainObject["terrainFile"]); // Workaround to have terrains created in an unsaved "New Level..." mission // moved to the correct place. @@ -455,16 +453,16 @@ public static void EditorSaveMissionAs(string missionName) // Try and follow the existing naming convention. // If we can't, use systematic terrain file names. - if (omni.Util.strstr(terrainFileName, oldMissionName) >= 0) - terrainFileName = omni.Util.strreplace(terrainFileName, oldMissionName, newMissionName); + if (pInvokes.Util.strstr(terrainFileName, oldMissionName) >= 0) + terrainFileName = pInvokes.Util.strreplace(terrainFileName, oldMissionName, newMissionName); else terrainFileName = newMissionName + "_" + i + ".ter"; string newTerrainFile = terrainFilePath + "/" + terrainFileName; - if (!omni.Util.isWriteableFileName(newTerrainFile)) + if (!pInvokes.Util.isWriteableFileName(newTerrainFile)) { - if (omni.Util.messageBox("Error", "Terrain file \"" + newTerrainFile + "\" is read-only. Continue?", "Ok", "Stop") == omni.iGlobal["$MROk"]) + if (pInvokes.Util.messageBox("Error", "Terrain file \"" + newTerrainFile + "\" is read-only. Continue?", "Ok", "Stop") == pInvokes.iGlobal["$MROk"]) continue; else { @@ -475,7 +473,7 @@ public static void EditorSaveMissionAs(string missionName) if (!terrainObject.save(newTerrainFile)) { - omni.Util._error("Failed to save '" + newTerrainFile + "'"); + pInvokes.Util._error("Failed to save '" + newTerrainFile + "'"); copyTerrainsFailed = true; break; } @@ -490,12 +488,12 @@ public static void EditorSaveMissionAs(string missionName) { // It failed, so restore the mission and terrain filenames. - omni.sGlobal["$Server::MissionFile"] = saveMissionFile; + pInvokes.sGlobal["$Server::MissionFile"] = saveMissionFile; - omni.Util.initContainerTypeSearch(omni.uGlobal["$TypeMasks::TerrainObjectType"], false); + pInvokes.Util.initContainerTypeSearch(pInvokes.uGlobal["$TypeMasks::TerrainObjectType"], false); for (int i = 0;; i++) { - TerrainBlock terrainObject = omni.Util.containerSearchNext(false); + TerrainBlock terrainObject = pInvokes.Util.containerSearchNext(false); if (terrainObject == null) break; @@ -518,10 +516,10 @@ public static void EditorOpenMission(string filename) EditorGui EditorGui = "EditorGui"; SimSet MissionCleanup = "MissionCleanup"; - if (EditorIsDirty() && !omni.Util.isWebDemo()) + if (EditorIsDirty() && !pInvokes.Util.isWebDemo()) { // "EditorSaveBeforeLoad();", "getLoadFilename(\"*.mis\", \"EditorDoLoadMission\");" - if (omni.Util.messageBox("Mission Modified", "Would you like to save changes to the current mission \"" + omni.sGlobal["$Server::MissionFile"] + "\" before opening a new mission?", "SaveDontSave", "Question") == omni.iGlobal["$MROk"]) + if (pInvokes.Util.messageBox("Mission Modified", "Would you like to save changes to the current mission \"" + pInvokes.sGlobal["$Server::MissionFile"] + "\" before opening a new mission?", "SaveDontSave", "Question") == pInvokes.iGlobal["$MROk"]) { if (!EditorSaveMission()) return; @@ -530,7 +528,7 @@ public static void EditorOpenMission(string filename) if (filename == "") { - OpenFileDialog ofd = new OpenFileDialog {Filter = omni.sGlobal["$Pref::WorldEditor::FileSpec"], InitialDirectory = EditorSettings.value("LevelInformation/levelsDirectory"), CheckFileExists = true, Multiselect = false}; + OpenFileDialog ofd = new OpenFileDialog {Filter = pInvokes.sGlobal["$Pref::WorldEditor::FileSpec"], InitialDirectory = EditorSettings.value("LevelInformation/levelsDirectory"), CheckFileExists = true, Multiselect = false}; DialogResult dr = Dialogs.OpenFileDialog(ref ofd); @@ -539,7 +537,7 @@ public static void EditorOpenMission(string filename) case DialogResult.OK: filename = Dialogs.GetForwardSlashFile(ofd.FileName); // Immediately override/set the levelsDirectory - EditorSettings.setValue("LevelInformation/levelsDirectory", omni.console.Call("collapseFilename", new string[] {omni.Util.filePath(filename)})); + EditorSettings.setValue("LevelInformation/levelsDirectory", pInvokes.console.Call("collapseFilename", new string[] {pInvokes.Util.filePath(filename)})); break; case DialogResult.Abort: case DialogResult.Ignore: @@ -559,26 +557,26 @@ public static void EditorOpenMission(string filename) // If we haven't yet connnected, create a server now. // Otherwise just load the mission. - if (!omni.bGlobal["$missionRunning"]) + if (!pInvokes.bGlobal["$missionRunning"]) { - omni.Util.activatePackage("BootEditor"); + pInvokes.Util.activatePackage("BootEditor"); chooseLevelDlg.StartLevel(filename, ""); } else { missionLoad.loadMission(filename, true); - omni.Util.pushInstantGroup(); + pInvokes.Util.pushInstantGroup(); // recreate and open the editor //Editor::create(); - omni.console.Call("Editor_Create"); + pInvokes.console.Call("Editor_Create"); MissionCleanup.add(Editor); MissionCleanup.add(Editor.getUndoManager()); EditorGui["loadingMission"] = true.AsString(); Editor.open(); - omni.Util.popInstantGroup(); + pInvokes.Util.popInstantGroup(); } } @@ -590,9 +588,9 @@ public static void EditorExportToCollada() ShapeEditor.gui.CodeBehind.ShapeEditor.ShapeEdShapeView ShapeEdShapeView = "ShapeEdShapeView"; EWorldEditor EWorldEditor = "EWorldEditor"; - if (!omni.bGlobal["$Pref::disableSaving"] && !omni.Util.isWebDemo()) + if (!pInvokes.bGlobal["$Pref::disableSaving"] && !pInvokes.Util.isWebDemo()) { - SaveFileDialog sfd = new SaveFileDialog {Filter = @"COLLADA Files (*.dae)|*.dae", InitialDirectory = omni.sGlobal["$Pref::WorldEditor::LastPath"], FileName = "", OverwritePrompt = true,}; + SaveFileDialog sfd = new SaveFileDialog {Filter = @"COLLADA Files (*.dae)|*.dae", InitialDirectory = pInvokes.sGlobal["$Pref::WorldEditor::LastPath"], FileName = "", OverwritePrompt = true,}; string exportFile = ""; @@ -602,7 +600,7 @@ public static void EditorExportToCollada() { case DialogResult.OK: exportFile = Dialogs.GetForwardSlashFile(sfd.FileName); - omni.sGlobal["$Pref::WorldEditor::LastPath"] = omni.Util.filePath(exportFile); + pInvokes.sGlobal["$Pref::WorldEditor::LastPath"] = pInvokes.Util.filePath(exportFile); break; case DialogResult.Abort: case DialogResult.Ignore: @@ -612,7 +610,7 @@ public static void EditorExportToCollada() return; } - if (omni.Util.fileExt(exportFile) != ".dae") + if (pInvokes.Util.fileExt(exportFile) != ".dae") exportFile = exportFile + ".dae"; if (EditorGui.currentEditor.getId() == ShapeEditorPlugin.getId()) @@ -629,9 +627,9 @@ public static void EditorMakePrefab() EditorTree EditorTree = "EditorTree"; // Should this be protected or not? - if (!omni.bGlobal["$Pref::disableSaving"] && !omni.Util.isWebDemo()) + if (!pInvokes.bGlobal["$Pref::disableSaving"] && !pInvokes.Util.isWebDemo()) { - SaveFileDialog sfd = new SaveFileDialog {Filter = @"Prefab Files (*.prefab)|*.prefab", InitialDirectory = omni.sGlobal["$Pref::WorldEditor::LastPath"], FileName = "", OverwritePrompt = true,}; + SaveFileDialog sfd = new SaveFileDialog {Filter = @"Prefab Files (*.prefab)|*.prefab", InitialDirectory = pInvokes.sGlobal["$Pref::WorldEditor::LastPath"], FileName = "", OverwritePrompt = true,}; string saveFile = ""; @@ -641,7 +639,7 @@ public static void EditorMakePrefab() { case DialogResult.OK: saveFile = Dialogs.GetForwardSlashFile(sfd.FileName); - omni.sGlobal["$Pref::WorldEditor::LastPath"] = omni.Util.filePath(saveFile); + pInvokes.sGlobal["$Pref::WorldEditor::LastPath"] = pInvokes.Util.filePath(saveFile); break; case DialogResult.Abort: case DialogResult.Ignore: @@ -651,7 +649,7 @@ public static void EditorMakePrefab() return; } - if (omni.Util.fileExt(saveFile) != ".prefab") + if (pInvokes.Util.fileExt(saveFile) != ".prefab") saveFile = saveFile + ".prefab"; EWorldEditor.makeSelectionPrefab(saveFile); @@ -678,7 +676,7 @@ public static void EditorMount() { EWorldEditor EWorldEditor = "EWorldEditor"; - omni.Util._echo("EditorMount"); + pInvokes.Util._echo("EditorMount"); int size = EWorldEditor.getSelectionSize(); if (size != 2) @@ -696,7 +694,7 @@ public static void EditorUnmount() { EWorldEditor EWorldEditor = "EWorldEditor"; - omni.Util._echo("EditorUnmount"); + pInvokes.Util._echo("EditorUnmount"); SimObject obj = EWorldEditor.getSelectedObject(0); obj.call("unmount"); @@ -756,7 +754,7 @@ public override bool onSelectItem(string id, string text) EWorldEditor EWorldEditor = "EWorldEditor"; // Have the editor align all selected objects by the selected bounds. - EWorldEditor.alignByBounds(omni.Util.getField(this["item[" + id + "]"], 2).AsInt()); + EWorldEditor.alignByBounds(pInvokes.Util.getField(this["item[" + id + "]"], 2).AsInt()); return true; } @@ -885,7 +883,7 @@ public override bool onSelectItem(string id, string text) EWorldEditor EWorldEditor = "EWorldEditor"; // Have the editor align all selected objects by the selected axis. - EWorldEditor.alignByAxis(omni.Util.getField(this["item[" + id + "]"], 2).AsInt()); + EWorldEditor.alignByAxis(pInvokes.Util.getField(this["item[" + id + "]"], 2).AsInt()); return true; } @@ -1156,17 +1154,17 @@ public override bool onSelectItem(string id, string text) GuiSliderCtrl Slider = CameraSpeedDropdownCtrlContainer.FOT("slider"); // Grab and set speed - float speed = omni.Util.getField(this["item[" + id + "]"], 2).AsFloat(); - omni.fGlobal["$Camera::movementSpeed"] = speed; + float speed = pInvokes.Util.getField(this["item[" + id + "]"], 2).AsFloat(); + pInvokes.fGlobal["$Camera::movementSpeed"] = speed; // Update Editor this.checkRadioItem(0, 6, id.AsInt()); // Update Toolbar TextEdit - EWorldEditorCameraSpeed.setText(omni.fGlobal["$Camera::movementSpeed"].AsString()); + EWorldEditorCameraSpeed.setText(pInvokes.fGlobal["$Camera::movementSpeed"].AsString()); // Update Toolbar Slider - Slider.setValue(omni.fGlobal["$Camera::movementSpeed"].AsString()); + Slider.setValue(pInvokes.fGlobal["$Camera::movementSpeed"].AsString()); return true; } @@ -1191,7 +1189,7 @@ public override void setupDefaultState() // Update Editor with default speed defaultSpeed = "25"; } - omni.fGlobal["$Camera::movementSpeed"] = defaultSpeed.AsFloat(); + pInvokes.fGlobal["$Camera::movementSpeed"] = defaultSpeed.AsFloat(); // Update Toolbar TextEdit EWorldEditorCameraSpeed.setText(defaultSpeed); @@ -1235,7 +1233,7 @@ public void setupGuiControls() // Set up the camera speed items float inc = ((maxSpeed - minSpeed)/(this.getItemCount() - 1)); for (int i = 0; i < this.getItemCount(); i++) - this["item[" + i + "]"] = omni.Util.setField(this["item[" + i + "]"], 2, (minSpeed + (inc*i)).AsString()); + this["item[" + i + "]"] = pInvokes.Util.setField(this["item[" + i + "]"], 2, (minSpeed + (inc*i)).AsString()); // Set up min/max camera slider range Slider.range = (minSpeed + " " + maxSpeed).AsPoint2F(); @@ -1365,7 +1363,7 @@ public override bool onSelectItem(string id, string text) // This sets up which drop script function to use when // a drop type is selected in the menu. - EWorldEditor.dropType = omni.Util.getField(this["item[" + id + "]"], 2); + EWorldEditor.dropType = pInvokes.Util.getField(this["item[" + id + "]"], 2); this.checkRadioItem(0, (this.getItemCount() - 1), id.AsInt()); @@ -1384,7 +1382,7 @@ public override void setupDefaultState() int dropTypeIndex = 0; for (; dropTypeIndex < numItems; dropTypeIndex++) { - if (omni.Util.getField(this["item[" + dropTypeIndex + "]"], 2) == EWorldEditor["dropType"]) + if (pInvokes.Util.getField(this["item[" + dropTypeIndex + "]"], 2) == EWorldEditor["dropType"]) break; } @@ -2115,7 +2113,7 @@ public override bool onSelectItem(string id, string text) { EditorGui EditorGui = "EditorGui"; - string toolName = omni.Util.getField(this["item[" + id + "]"], 2); + string toolName = pInvokes.Util.getField(this["item[" + id + "]"], 2); //In the torquescript they passed a local variable called %paletteName as the second parameter. //Well, in reality it's expecting a bool, so an unitialized variable is false by default, so they were sending false diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/UndoManager.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/UndoManager.ed.cs index d1312d53..87ec1624 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/UndoManager.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/UndoManager.ed.cs @@ -212,7 +212,7 @@ public static void submit(SimObject undoObject) // The instant group will try to add our // UndoAction if we don't disable it. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); // Create the undo action. ObjectCreator actionCreator = new ObjectCreator("MECreateUndoAction"); @@ -221,7 +221,7 @@ public static void submit(SimObject undoObject) MECreateUndoAction action = actionCreator.Create(); // Restore the instant group. - omni.Util.popInstantGroup(); + Util.popInstantGroup(); // Set the object to undo. action.addObject(undoObject); @@ -261,7 +261,7 @@ public static void submit(string deleteObjects, bool wordSeperated) // The instant group will try to add our // UndoAction if we don't disable it. - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); // Create the undo action. ObjectCreator actionCreator = new ObjectCreator("MEDeleteUndoAction"); @@ -270,27 +270,27 @@ public static void submit(string deleteObjects, bool wordSeperated) MEDeleteUndoAction action = actionCreator.Create(); // Restore the instant group. - omni.Util.popInstantGroup(); + Util.popInstantGroup(); // Add the deletion objects to the action which // will take care of properly deleting them. - deleteObjects = omni.Util.trim(deleteObjects); + deleteObjects = Util.trim(deleteObjects); if (wordSeperated) { - int count = omni.Util.getWordCount(deleteObjects); + int count = Util.getWordCount(deleteObjects); for (int i = 0; i < count; i++) { - SimObject xobject = omni.Util.getWord(deleteObjects, i); + SimObject xobject = Util.getWord(deleteObjects, i); action.deleteObject(xobject); } } else { - int count = omni.Util.getFieldCount(deleteObjects); + int count = Util.getFieldCount(deleteObjects); for (int i = 0; i < count; i++) { - SimObject xobject = omni.Util.getField(deleteObjects, i); + SimObject xobject = Util.getField(deleteObjects, i); action.deleteObject(xobject); } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.bind.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.bind.ed.cs index db02913a..b9d1bb5d 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.bind.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.bind.ed.cs @@ -45,8 +45,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor { public class editor_bind_ed { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "editor_bind_ed_cs_initialize")] public static void initialize() { @@ -70,8 +68,8 @@ public static void mouseWheelScroll(float val) //EditorGui-->CameraSpeedSpinner.setText( $Camera::movementSpeed ); float rollAdj = defaultBind.getMouseAdjustAmount(val); - rollAdj = omni.Util.mClamp(rollAdj, (float) (-Math.PI + 0.01), (float) (Math.PI - 0.01)); - omni.fGlobal["$mvRoll"] += rollAdj; + rollAdj = pInvokes.Util.mClamp(rollAdj, (float) (-Math.PI + 0.01), (float) (Math.PI - 0.01)); + pInvokes.fGlobal["$mvRoll"] += rollAdj; } [ConsoleInteraction] @@ -81,14 +79,14 @@ public static void editorYaw(float val) if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera() || ((EWorldEditor) "EWorldEditor").isMiddleMouseDown()) { // Clamp and scale - yawAdj = omni.Util.mClamp(yawAdj, ((float) (-2.0f*Math.PI) + 0.01f), ((float) (2.0f*Math.PI) - 0.01f)); + yawAdj = pInvokes.Util.mClamp(yawAdj, ((float) (-2.0f*Math.PI) + 0.01f), ((float) (2.0f*Math.PI) - 0.01f)); yawAdj *= 0.5f; } if (((SimObject) "EditorSettings")["Camera/invertXAxis"].AsBool()) yawAdj *= -1; - omni.fGlobal["$mvYaw"] += yawAdj; + pInvokes.fGlobal["$mvYaw"] += yawAdj; } [ConsoleInteraction] @@ -97,13 +95,13 @@ public static void editorPitch(float val) float pitchAdj = defaultBind.getMouseAdjustAmount(val); if (((GameConnection) "ServerConnection").isControlObjectRotDampedCamera() || ((EWorldEditor) "EWorldEditor").isMiddleMouseDown()) { - pitchAdj = omni.Util.mClamp(pitchAdj, ((float) (-2.0f*Math.PI) + 0.01f), ((float) (2.0f*Math.PI) - 0.01f)); + pitchAdj = pInvokes.Util.mClamp(pitchAdj, ((float) (-2.0f*Math.PI) + 0.01f), ((float) (2.0f*Math.PI) - 0.01f)); pitchAdj *= 0.5f; } if (((SimObject) "EditorSettings")["Camera/invertYAxis"].AsBool()) pitchAdj *= -1; - omni.fGlobal["$mvPitch"] += pitchAdj; + pInvokes.fGlobal["$mvPitch"] += pitchAdj; } [ConsoleInteraction] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.ed.cs index f96193d1..90ddb55a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/editor.ed.cs @@ -69,9 +69,9 @@ public class editor : EditManager [ConsoleInteraction(true, "editor_Initialize")] public static void initialize() { - omni.sGlobal["$RelightCallback"] = ""; + sGlobal["$RelightCallback"] = ""; ((ActionMap) "GlobalActionMap").bind("keyboard", "f11", "toggleEditor"); - omni.Util.eval(@" + Util.eval(@" package EditorDisconnectOverride { @@ -83,7 +83,7 @@ function disconnect() "); - omni.Util.activatePackage("EditorDisconnectOverride"); + Util.activatePackage("EditorDisconnectOverride"); } [ConsoleInteraction(true, "Editor_Create")] @@ -164,12 +164,12 @@ public static void toggleEditor(bool make) editor editor = "editor"; if (make) { - string timerID = omni.console.Call("startPrecisionTimer"); - if (omni.bGlobal["$InGuiEditor"]) - //omni.console.Call("GuiEdit"); + string timerID = console.Call("startPrecisionTimer"); + if (bGlobal["$InGuiEditor"]) + //console.Call("GuiEdit"); GuiEditorGui.GuiEdit(""); - if (!omni.bGlobal["$missionRunning"]) + if (!bGlobal["$missionRunning"]) { // Flag saying, when level is chosen, launch it with the editor open. ((GuiControl) "ChooseLevelDlg")["launchInEditor"] = true.AsString(); @@ -178,7 +178,7 @@ public static void toggleEditor(bool make) } else { - omni.Util.pushInstantGroup(); + Util.pushInstantGroup(); if (!"Editor".isObject()) { create(); @@ -191,7 +191,7 @@ public static void toggleEditor(bool make) { if (((LevelInfo) "theLevelInfo")["Type"] == "DemoScene") { - omni.console.commandToServer("dropPlayerAtCamera"); + console.commandToServer("dropPlayerAtCamera"); editor.close("SceneGui"); } else @@ -199,13 +199,13 @@ public static void toggleEditor(bool make) } else { - if (!omni.bGlobal["$GuiEditorBtnPressed"]) + if (!bGlobal["$GuiEditorBtnPressed"]) { ((GuiCanvas) "Canvas").pushDialog("EditorLoadingGui"); ((GuiCanvas) "Canvas").repaint(0); } else - omni.bGlobal["$GuiEditorBtnPressed"] = false; + bGlobal["$GuiEditorBtnPressed"] = false; editor.open(); @@ -213,20 +213,20 @@ public static void toggleEditor(bool make) // the level from cycling after it's duration // has elapsed. - omni.Util.cancel(omni.iGlobal["$Game::Schedule"]); + Util.cancel(iGlobal["$Game::Schedule"]); if (((LevelInfo) "theLevelInfo")["type"] == "DemoScene") - omni.console.commandToServer("dropCameraAtPlayer", new string[] {"true"}); + console.commandToServer("dropCameraAtPlayer", new string[] {"true"}); ((GuiCanvas) "Canvas").popDialog("EditorLoadingGui"); } - omni.Util.popInstantGroup(); + Util.popInstantGroup(); } - string elapsed = omni.console.Call("stopPrecisionTimer", new string[] {timerID}); + string elapsed = console.Call("stopPrecisionTimer", new string[] {timerID}); - omni.Util._warn("Time spent in toggleEditor() : " + (elapsed.AsFloat()/1000.0) + " s"); + Util._warn("Time spent in toggleEditor() : " + (elapsed.AsFloat()/1000.0) + " s"); } } @@ -259,9 +259,9 @@ public static void Editor_Disconnect() editor.close("MainMenuGui"); } - omni.Util.deactivatePackage("EditorDisconnectOverride"); - omni.Util._call("disconnect"); - omni.Util.activatePackage("EditorDisconnectOverride"); + Util.deactivatePackage("EditorDisconnectOverride"); + Util._call("disconnect"); + Util.activatePackage("EditorDisconnectOverride"); } [ConsoleInteraction] @@ -409,7 +409,6 @@ public void close(GuiControl gui) ShapeEdAdvancedWindow ShapeEdAdvancedWindow = "ShapeEdAdvancedWindow"; ShapeEdSelectWindow ShapeEdSelectWindow = "ShapeEdSelectWindow"; ShapeEdPropWindow ShapeEdPropWindow = "ShapeEdPropWindow"; - MessageHud MessageHud = "MessageHud"; EWTreeWindow["wasOpen"] = EWTreeWindow["isInPopup"]; EWInspectorWindow["wasOpen"] = EWInspectorWindow["isInPopup"]; @@ -463,8 +462,7 @@ public void close(GuiControl gui) this.editorDisabled(); Canvas.setContent(gui); - if (MessageHud.isObject()) - MessageHud.close(); + EditorGui.writeCameraSettings(); Util._schedule("1000", "0", "checkCursor"); @@ -494,7 +492,7 @@ public void lightScene(string callback, bool forceAlways) RelightStatus.visible = true; RelightProgress.setValue("0"); Canvas.repaint(0); - omni.Util.lightScene("EditorLightingComplete", forceAlways.AsString()); + Util.lightScene("EditorLightingComplete", forceAlways.AsString()); updateEditorLightingProgress(); } @@ -503,13 +501,13 @@ public static void EditorLightingComplete() { GuiControl RelightStatus = "RelightStatus"; - omni.bGlobal["$lightingMission"] = false; + bGlobal["$lightingMission"] = false; RelightStatus.visible = false; - if (omni.sGlobal["$RelightCallback"] != "") - omni.Util.eval(omni.sGlobal["$RelightCallback"]); + if (sGlobal["$RelightCallback"] != "") + Util.eval(sGlobal["$RelightCallback"]); - omni.sGlobal["$RelightCallback"] = ""; + sGlobal["$RelightCallback"] = ""; } [ConsoleInteraction] @@ -517,9 +515,9 @@ public static void updateEditorLightingProgress() { GuiProgressBitmapCtrl RelightProgress = "RelightProgress"; - RelightProgress.setValue(omni.sGlobal["$SceneLighting::lightingProgress"]); - if (omni.bGlobal["$lightingMission"]) - omni.iGlobal["$lightingProgressThread"] = omni.Util._schedule("1", "0", "updateEditorLightingProgress"); + RelightProgress.setValue(sGlobal["$SceneLighting::lightingProgress"]); + if (bGlobal["$lightingMission"]) + iGlobal["$lightingProgressThread"] = Util._schedule("1", "0", "updateEditorLightingProgress"); } [ConsoleInteraction] @@ -530,7 +528,7 @@ public bool validateObjectName(string name, bool mustHaveName) messageBox.MessageBoxOK("Missing Object Name", "No name given for object. Please enter a valid object name."); return false; } - if (!omni.Util.isValidObjectName(name)) + if (!Util.isValidObjectName(name)) { messageBox.MessageBoxOK("Invalid Object Name", "'" + name + "' is not a valid object name." + '\n' + "" + '\n' + "Please choose a name that begins with a letter or underscore and is otherwise comprised " + "exclusively of letters, digits, and/or underscores."); return false; @@ -544,7 +542,7 @@ public bool validateObjectName(string name, bool mustHaveName) messageBox.MessageBoxOK("Invalid Object Name", "Object names must be unique, and there is an " + "existing " + ((SimObject) name).getClassName() + " object with the name '" + name + "' (defined " + "in " + filename + "). Please choose another name."); return false; } - if (omni.Util.isClass(name)) + if (Util.isClass(name)) { messageBox.MessageBoxOK("Invalid Object Name", "'" + name + "' is the name of an existing TorqueScript " + "class. Please choose another name."); return false; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/Creator.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/Creator.ed.cs index 69eddc3b..e300ad44 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/Creator.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/Creator.ed.cs @@ -47,8 +47,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui.CodeBe { public class Creator { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static int alphaIconCompare(SimObject a, SimObject b) { @@ -64,7 +62,7 @@ public static int alphaIconCompare(SimObject a, SimObject b) return 1; } - int result = omni.Util.stricmp(a["text"], b["text"]); + int result = pInvokes.Util.stricmp(a["text"], b["text"]); return result; } @@ -74,9 +72,9 @@ public static string genericCreateObject(string className) { EWCreatorWindow EWCreatorWindow = "EWCreatorWindow"; - if (!omni.Util.isClass(className)) + if (!pInvokes.Util.isClass(className)) { - omni.Util._warn("createObject( " + className + " ) - Was not a valid class."); + pInvokes.Util._warn("createObject( " + className + " ) - Was not a valid class."); return ""; } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/EditorChooseLevelGui.ed.cs/staticFunctions.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/EditorChooseLevelGui.ed.cs/staticFunctions.cs index 3bf2f273..82afb8ff 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/EditorChooseLevelGui.ed.cs/staticFunctions.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/EditorChooseLevelGui.ed.cs/staticFunctions.cs @@ -5,11 +5,11 @@ // // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). // -// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. +// These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use pInvokes. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. // // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". // -// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: +// BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE pInvokes. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: // // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: // @@ -43,18 +43,16 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui.CodeBe { public class staticFunctions { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void WE_EditLevel(string levelFile) { - omni.Util._call("EditorOpenMission", levelFile); + pInvokes.Util._call("EditorOpenMission", levelFile); } [ConsoleInteraction] public static void WE_ReturnToMainMenu() { - omni.Util._call("loadMainMenu"); + pInvokes.Util._call("loadMainMenu"); } [ConsoleInteraction] @@ -91,14 +89,14 @@ public static string getLevelDisplayName(string levelFile) file.close(); } MissionInfoObject = "%MissionInfoObject = " + MissionInfoObject + "; return %MissionInfoObject;"; - MissionInfoObject = omni.console.Eval(MissionInfoObject, true); + MissionInfoObject = pInvokes.console.Eval(MissionInfoObject, true); file.delete(); string name = ""; if (((SimObject) MissionInfoObject)["LevelName"] != "") name = ((SimObject) MissionInfoObject)["LevelName"]; else - name = omni.Util.fileBase(levelFile); + name = pInvokes.Util.fileBase(levelFile); MissionInfoObject.delete(); diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/PlugIns/TerrainEditorPlugin.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/PlugIns/TerrainEditorPlugin.cs index db5c609e..7b966718 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/PlugIns/TerrainEditorPlugin.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/CodeBehind/PlugIns/TerrainEditorPlugin.cs @@ -58,7 +58,7 @@ internal ActionMap map [ConsoleInteraction] public static void LoadTerrainEditorTextureFileSpec() { - omni.sGlobal["$TerrainEditor::TextureFileSpec"] = "Image Files (*.png, *.jpg, *.dds)|*.png;*.jpg;*.dds|All Files (*.*)|*.*"; + sGlobal["$TerrainEditor::TextureFileSpec"] = "Image Files (*.png, *.jpg, *.dds)|*.png;*.jpg;*.dds|All Files (*.*)|*.*"; } [ConsoleInteraction] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ManageSFXParametersWindow.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ManageSFXParametersWindow.ed.cs index 3ae31245..ba975d70 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ManageSFXParametersWindow.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ManageSFXParametersWindow.ed.cs @@ -42,8 +42,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui { public class ManageSFXParametersWindow { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ManageSFXParametersWindow_initialize")] public static void initialize() { @@ -52,37 +50,37 @@ public static void initialize() //============================================================================= // File to save newly created SFXParameters in by default. - omni.sGlobal["$SFX_PARAMETER_FILE"] = "scripts/client/audioData.cs"; - - omni.sGlobal["$SFX_PARAMETER_CHANNELS[0]"] = "Volume"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[1]"] = "Pitch"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[2]"] = "Priority"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[3]"] = "MinDistance"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[4]"] = "MaxDistance"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[5]"] = "ConeInsideAngle"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[6]"] = "ConeOutsideAngle"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[7]"] = "ConeOutsideVolume"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[8]"] = "PositionX"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[9]"] = "PositionY"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[10]"] = "PositionZ"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[11]"] = "RotationX"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[12]"] = "RotationY"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[13]"] = "RotationZ"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[14]"] = "VelocityX"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[15]"] = "VelocityY"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[16]"] = "VelocityZ"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[17]"] = "Cursor"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[18]"] = "User0"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[19]"] = "User1"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[20]"] = "User2"; - omni.sGlobal["$SFX_PARAMETER_CHANNELS[21]"] = "User3"; - - omni.iGlobal["$SFX_PARAMETER_CHANNELS_COUNT"] = 22; + pInvokes.sGlobal["$SFX_PARAMETER_FILE"] = "scripts/client/audioData.cs"; + + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[0]"] = "Volume"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[1]"] = "Pitch"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[2]"] = "Priority"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[3]"] = "MinDistance"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[4]"] = "MaxDistance"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[5]"] = "ConeInsideAngle"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[6]"] = "ConeOutsideAngle"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[7]"] = "ConeOutsideVolume"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[8]"] = "PositionX"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[9]"] = "PositionY"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[10]"] = "PositionZ"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[11]"] = "RotationX"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[12]"] = "RotationY"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[13]"] = "RotationZ"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[14]"] = "VelocityX"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[15]"] = "VelocityY"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[16]"] = "VelocityZ"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[17]"] = "Cursor"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[18]"] = "User0"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[19]"] = "User1"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[20]"] = "User2"; + pInvokes.sGlobal["$SFX_PARAMETER_CHANNELS[21]"] = "User3"; + + pInvokes.iGlobal["$SFX_PARAMETER_CHANNELS_COUNT"] = 22; // Interval (in milliseconds) between GUI updates. Each update // syncs the displayed values to the actual parameter states. - omni.iGlobal["$SFX_PARAMETERS_UPDATE_INTERVAL"] = 50; + pInvokes.iGlobal["$SFX_PARAMETERS_UPDATE_INTERVAL"] = 50; #region GuiControl (ManageSFXParametersContainer,EditorGuiGroup) oc_Newobject10 diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ProceduralTerrainPainterGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ProceduralTerrainPainterGui.cs index d63b36a4..0f5d130a 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ProceduralTerrainPainterGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/ProceduralTerrainPainterGui.cs @@ -42,8 +42,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui { public class ProceduralTerrainPainterGui { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "ProceduralTerrainPainterGui_initialize")] public static void initialize() { @@ -520,11 +518,11 @@ public static void initialize() } - omni.iGlobal["$TPPHeightMin"] = -10000; - omni.iGlobal["$TPPHeightMax"] = 10000; - omni.iGlobal["$TPPSlopeMin"] = 0; - omni.iGlobal["$TPPSlopeMax"] = 90; - omni.iGlobal["$TPPCoverage"] = 100; + pInvokes.iGlobal["$TPPHeightMin"] = -10000; + pInvokes.iGlobal["$TPPHeightMax"] = 10000; + pInvokes.iGlobal["$TPPSlopeMin"] = 0; + pInvokes.iGlobal["$TPPSlopeMax"] = 90; + pInvokes.iGlobal["$TPPCoverage"] = 100; } @@ -538,8 +536,8 @@ public static void autoLayers() public static void generateProceduralTerrainMask() { ((GuiCanvas) "Canvas").popDialog("ProceduralTerrainPainterGui"); - ((TerrainEditor) "ETerrainEditor").autoMaterialLayer(omni.fGlobal["$TPPHeightMin"], - omni.fGlobal["$TPPHeightMax"], omni.fGlobal["$TPPSlopeMin"], omni.fGlobal["$TPPSlopeMax"], omni.fGlobal["$TPPCoverage"]); + ((TerrainEditor) "ETerrainEditor").autoMaterialLayer(pInvokes.fGlobal["$TPPHeightMin"], + pInvokes.fGlobal["$TPPHeightMax"], pInvokes.fGlobal["$TPPSlopeMin"], pInvokes.fGlobal["$TPPSlopeMax"], pInvokes.fGlobal["$TPPCoverage"]); } } } \ No newline at end of file diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/TerrainPainterToolbar.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/TerrainPainterToolbar.ed.cs index fd1a01be..43f7e783 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/TerrainPainterToolbar.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/TerrainPainterToolbar.ed.cs @@ -45,8 +45,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.WorldEditor.gui { public class TerrainPainterToolbar { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction(true, "TerrainPainterToolbar_initialize")] public static void initialize() { @@ -816,7 +814,7 @@ public static void setTerrainEditorMinSlope(float value) float val = ETerrainEditor.setSlopeLimitMinAngle(value); GuiTextEditCtrl SlopeMinAngle = ((GuiControl) "PaintBrushSlopeControl").findObjectByInternalName("SlopeMinAngle", true); - SlopeMinAngle.setValue(omni.Util.mFloatLength(val, 1)); + SlopeMinAngle.setValue(pInvokes.Util.mFloatLength(val, 1)); } [ConsoleInteraction] @@ -826,7 +824,7 @@ public static void setTerrainEditorMaxSlope(float value) float val = ETerrainEditor.setSlopeLimitMaxAngle(value); GuiTextEditCtrl SlopeMaxAngle = ((GuiControl) "PaintBrushSlopeControl").findObjectByInternalName("SlopeMaxAngle", true); - SlopeMaxAngle.setValue(omni.Util.mFloatLength(val, 1)); + SlopeMaxAngle.setValue(pInvokes.Util.mFloatLength(val, 1)); } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/guiTerrainImportGui.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/guiTerrainImportGui.cs index dfd02f42..7e39b4f0 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/guiTerrainImportGui.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/guiTerrainImportGui.cs @@ -717,8 +717,8 @@ public static void initialize() oc_Newobject22.Create(); - omni.sGlobal["$TerrainImportGui::HeightFieldFilter"] = "Heightfield Files (*.png, *.bmp, *.jpg, *.gif)|*.png;*.bmp;*.jpg;*.gif|All Files (*.*)|*.*"; - omni.sGlobal["$TerrainImportGui::OpacityMapFilter"] = "Opacity Map Files (*.png, *.bmp, *.jpg, *.gif)|*.png;*.bmp;*.jpg;*.gif|All Files (*.*)|*.*"; + sGlobal["$TerrainImportGui::HeightFieldFilter"] = "Heightfield Files (*.png, *.bmp, *.jpg, *.gif)|*.png;*.bmp;*.jpg;*.gif|All Files (*.*)|*.*"; + sGlobal["$TerrainImportGui::OpacityMapFilter"] = "Opacity Map Files (*.png, *.bmp, *.jpg, *.gif)|*.png;*.bmp;*.jpg;*.gif|All Files (*.*)|*.*"; } /* @@ -914,15 +914,15 @@ public static void TerrainImportGuiAddOpacityMap(string name) // TODO: Need to actually look at // the file here and figure // out how many channels it has. - string txt = omni.Util.makeRelativePath(name, omni.Util.getWorkingDirectory()); + string txt = Util.makeRelativePath(name, Util.getWorkingDirectory()); // Will need to do this stuff // once per channel in the file // currently it works with just grayscale. string channelsTxt = "R\tG\tB\tA"; - string bitmapInfo = omni.Util.getBitmapInfo(name); + string bitmapInfo = Util.getBitmapInfo(name); - string channelCount = omni.Util.getWord(bitmapInfo, 2); + string channelCount = Util.getWord(bitmapInfo, 2); GuiTextListCtrl opacityList = ((GuiControl) "TerrainImportGui").findObjectByInternalName("OpacityLayerTextList", true); @@ -933,10 +933,10 @@ public static void TerrainImportGuiAddOpacityMap(string name) for (int i = 0; i < channelCount.AsInt(); i++) { namesArray.push_back(txt, name); - channelsArray.push_back(txt, omni.Util.getWord(channelsTxt, i) + "/t" + channelCount); + channelsArray.push_back(txt, Util.getWord(channelsTxt, i) + "/t" + channelCount); //TerrainImportGui.namesArray.echo(); int count = opacityList.rowCount(); - opacityList.addRow(count, txt + "/t" + omni.Util.getWord(channelsTxt, i), -1); + opacityList.addRow(count, txt + "/t" + Util.getWord(channelsTxt, i), -1); } //OpacityMapListBox.addItem( %name ); } @@ -1022,10 +1022,10 @@ public static void TerrainImportGui_TerrainMaterialApplyCallback(string mat, str string rowTxt = opacityList.getRowTextById(itemIdx.AsInt()); - int columTxtCount = omni.Util.getFieldCount(rowTxt); + int columTxtCount = Util.getFieldCount(rowTxt); if (columTxtCount > 2) - rowTxt = omni.Util.getFields(rowTxt, 0, 1); + rowTxt = Util.getFields(rowTxt, 0, 1); opacityList.setRowById(itemIdx.AsInt(), rowTxt + "\t" + ((SimObject) mat).internalName + "/t" + mat); } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/objectBuilderGui.ed.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/objectBuilderGui.ed.cs index d0585c44..eb1030c9 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/objectBuilderGui.ed.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/WorldEditor/gui/objectBuilderGui.ed.cs @@ -403,7 +403,7 @@ public static void GenerateScriptObjectCreators() } "; - omni.Util.eval(toeval); + Util.eval(toeval); } [ConsoleInteraction] diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/main.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/main.cs index 2e406ed3..5f5942a1 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/main.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/main.cs @@ -45,8 +45,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools { public class main { - private static readonly pInvokes omni = new pInvokes(); - private static string[] EditorsToLoad = new string[] {"editorClasses", //Must be first "base", //Must be second "worldEditor", //Must be third, rest don't matter. @@ -54,20 +52,20 @@ public class main public static void initialize() { - omni.Util._echo("-------------------->Loading Tools"); + pInvokes.Util._echo("-------------------->Loading Tools"); //--------------------------------------------------------------------------------------------- // Path to the folder that contains the editors we will load. //--------------------------------------------------------------------------------------------- - omni.sGlobal["$Tools::resourcePath"] = "tools/"; + pInvokes.sGlobal["$Tools::resourcePath"] = "tools/"; // These must be loaded first, in this order, before anything else is loaded - omni.sGlobal["$Tools::loadFirst"] = "editorClasses base worldEditor"; + pInvokes.sGlobal["$Tools::loadFirst"] = "editorClasses base worldEditor"; //--------------------------------------------------------------------------------------------- // Object that holds the simObject id that the materialEditor uses to interpret its material list //--------------------------------------------------------------------------------------------- - omni.sGlobal["$Tools::materialEditorList"] = ""; + pInvokes.sGlobal["$Tools::materialEditorList"] = ""; String ToExecute = @" package Tools @@ -101,8 +99,8 @@ function onExit() } }; "; - omni.console.Eval(ToExecute); - omni.Util.activatePackage("Tools"); + pInvokes.console.Eval(ToExecute); + pInvokes.Util.activatePackage("Tools"); } [ConsoleInteraction] @@ -115,29 +113,29 @@ public static void tools_onStart() //new Settings(EditorSettings) { file = "tools/settings.xml"; }; EditorSettings.read(); - omni.Util._echo(" % - Initializing Tools"); + pInvokes.Util._echo(" % - Initializing Tools"); // Default file path when saving from the editor (such as prefabs) - if (omni.sGlobal["$Pref::WorldEditor::LastPath"] == "") - omni.sGlobal["$Pref::WorldEditor::LastPath"] = omni.Util.getMainDotCsDir(); + if (pInvokes.sGlobal["$Pref::WorldEditor::LastPath"] == "") + pInvokes.sGlobal["$Pref::WorldEditor::LastPath"] = pInvokes.Util.getMainDotCsDir(); // Common GUI stuff. //exec( "./gui/cursors.ed.cs" ); - //omni.Util.exec("tools/gui/profiles.ed.cs", false, false); + //pInvokes.Util.exec("tools/gui/profiles.ed.cs", false, false); profiles.initialize(); NavPanelProfiles.initialize(); // Make sure we get editor profiles before any GUI's // BUG: these dialogs are needed earlier in the init sequence, and should be moved to // common, along with the guiProfiles they depend on. - omni.Util.exec("tools/gui/guiDialogs.ed.cs", false, false); + pInvokes.Util.exec("tools/gui/guiDialogs.ed.cs", false, false); guiDialogs.initialize(); //%toggle = $Scripts::ignoreDSOs; //$Scripts::ignoreDSOs = true; - omni.uGlobal["$ignoredDatablockSet"] = new ObjectCreator("SimSet").Create(); + pInvokes.uGlobal["$ignoredDatablockSet"] = new ObjectCreator("SimSet").Create(); //// fill the list of editors //$editors[count] = getWordCount( $Tools::loadFirst ); @@ -179,8 +177,8 @@ public static void tools_onStart() foreach (string editor in EditorsToLoad) { string initializeFunction = "initialize" + editor; - if (omni.Util.isFunction(initializeFunction)) - omni.Util._call(initializeFunction); + if (pInvokes.Util.isFunction(initializeFunction)) + pInvokes.Util._call(initializeFunction); } //%count = $editors[count]; //for ( %i = 0; %i < %count; %i++ ) @@ -195,59 +193,59 @@ public static void tools_onStart() // Popuplate the default SimObject icons that // are used by the various editors. //EditorIconRegistry::loadFromPath( "tools/classIcons/" ); - omni.console.Call_Classname("EditorIconRegistry", "loadFromPath", new[] {"tools/classIcons/"}); + pInvokes.console.Call_Classname("EditorIconRegistry", "loadFromPath", new[] {"tools/classIcons/"}); // Load up the tools resources. All the editors are initialized at this point, so // resources can override, redefine, or add functionality. // Tools::LoadResources( $Tools::resourcePath ); - LoadResources(omni.sGlobal["$Tools::resourcePath"]); + LoadResources(pInvokes.sGlobal["$Tools::resourcePath"]); } [ConsoleInteraction] public static void tools_startToolTime(string tool) { - if (omni.sGlobal["$toolDataToolCount"] == "") - omni.sGlobal["$toolDataToolCount"] = "0"; + if (pInvokes.sGlobal["$toolDataToolCount"] == "") + pInvokes.sGlobal["$toolDataToolCount"] = "0"; - if (omni.sGlobal["$toolDataToolEntry[" + tool + "]"] != "true") + if (pInvokes.sGlobal["$toolDataToolEntry[" + tool + "]"] != "true") { - omni.sGlobal["$toolDataToolEntry[" + tool + "]"] = "true"; - omni.sGlobal["$toolDataToolList[" + omni.sGlobal["$toolDataToolCount"] + "]"] = tool; - omni.iGlobal["$toolDataToolCount"]++; - omni.iGlobal["$toolDataClickCount[" + tool + "]"] = 0; + pInvokes.sGlobal["$toolDataToolEntry[" + tool + "]"] = "true"; + pInvokes.sGlobal["$toolDataToolList[" + pInvokes.sGlobal["$toolDataToolCount"] + "]"] = tool; + pInvokes.iGlobal["$toolDataToolCount"]++; + pInvokes.iGlobal["$toolDataClickCount[" + tool + "]"] = 0; } - omni.iGlobal["$toolDataStartTime[" + tool + "]"] = omni.Util.getSimTime(); - omni.iGlobal["$toolDataClickCount[" + tool + "]"]++; + pInvokes.iGlobal["$toolDataStartTime[" + tool + "]"] = pInvokes.Util.getSimTime(); + pInvokes.iGlobal["$toolDataClickCount[" + tool + "]"]++; } [ConsoleInteraction] public static void tools_endtoolTime(string tool) { int startTime = 0; - if (omni.sGlobal["$toolDataStartTime[" + tool + "]"] != "") - startTime = omni.iGlobal["$toolDataStartTime[" + tool + "]"]; + if (pInvokes.sGlobal["$toolDataStartTime[" + tool + "]"] != "") + startTime = pInvokes.iGlobal["$toolDataStartTime[" + tool + "]"]; - if (omni.sGlobal["$toolDataTotalTime[" + tool + "]"] == "") - omni.iGlobal["$toolDataTotalTime[" + tool + "]"] = 0; + if (pInvokes.sGlobal["$toolDataTotalTime[" + tool + "]"] == "") + pInvokes.iGlobal["$toolDataTotalTime[" + tool + "]"] = 0; - omni.iGlobal["$toolDataTotalTime[" + tool + "]"] += omni.Util.getSimTime() - startTime; + pInvokes.iGlobal["$toolDataTotalTime[" + tool + "]"] += pInvokes.Util.getSimTime() - startTime; } [ConsoleInteraction] public static void tools_dumpToolData() { - int count = omni.iGlobal["$toolDataToolCount"]; + int count = pInvokes.iGlobal["$toolDataToolCount"]; for (int i = 0; i < count; i++) { - string tool = omni.sGlobal["$toolDataToolList[" + i + "]"]; - int totalTime = omni.iGlobal["$toolDataTotalTime[" + tool + "]"]; - int clickCount = omni.iGlobal["$toolDataClickCount[" + tool + "]"]; - omni.Util._echo("---"); - omni.Util._echo("Tool: " + tool); - omni.Util._echo("Time (Seconds): " + (totalTime/1000)); - omni.Util._echo("Activated: " + clickCount); - omni.Util._echo("---"); + string tool = pInvokes.sGlobal["$toolDataToolList[" + i + "]"]; + int totalTime = pInvokes.iGlobal["$toolDataTotalTime[" + tool + "]"]; + int clickCount = pInvokes.iGlobal["$toolDataClickCount[" + tool + "]"]; + pInvokes.Util._echo("---"); + pInvokes.Util._echo("Tool: " + tool); + pInvokes.Util._echo("Time (Seconds): " + (totalTime/1000)); + pInvokes.Util._echo("Activated: " + clickCount); + pInvokes.Util._echo("---"); } } @@ -294,7 +292,7 @@ public static void tools_onExit() // Free all the icon images in the registry. //EditorIconRegistry::clear(); - omni.console.Call_Classname("EditorIconRegistry", "clear"); + pInvokes.console.Call_Classname("EditorIconRegistry", "clear"); // Save any Layouts we might be using //GuiFormManager::SaveLayout(LevelBuilder, Default, User); @@ -310,22 +308,22 @@ public static void tools_onExit() foreach (string editor in EditorsToLoad) { string destroyfunction = "destroy" + editor; - if (omni.Util.isFunction(destroyfunction)) - omni.Util._call(destroyfunction); + if (pInvokes.Util.isFunction(destroyfunction)) + pInvokes.Util._call(destroyfunction); } } public static void LoadResources(string path) { string resourcesPath = path + "resources/"; - string resourcesList = omni.Util.getDirectoryList(resourcesPath, 0); + string resourcesList = pInvokes.Util.getDirectoryList(resourcesPath, 0); - int wordCount = omni.Util.getFieldCount(resourcesList); + int wordCount = pInvokes.Util.getFieldCount(resourcesList); for (int i = 0; i < wordCount; i++) { - string resource = omni.Util.getField(resourcesList, i); - if (omni.Util.isFile(resourcesPath + resource + "/resourceDatabase.cs")) - omni.console.Call_Classname("ResourceObject", "load", new string[] {path, resource}); + string resource = pInvokes.Util.getField(resourcesList, i); + if (pInvokes.Util.isFile(resourcesPath + resource + "/resourceDatabase.cs")) + pInvokes.console.Call_Classname("ResourceObject", "load", new string[] {path, resource}); } } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/PhysicsToolsMenu.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/PhysicsToolsMenu.cs index 05d696ef..ab3d484e 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/PhysicsToolsMenu.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/PhysicsToolsMenu.cs @@ -46,7 +46,7 @@ public class PhysicsToolsMenu : MenuBuilder public override void onMenuSelect() { - bool isEnabled = omni.Util.physicsSimulationEnabled(); + bool isEnabled = Util.physicsSimulationEnabled(); string itemText = !isEnabled ? "Start Simulation" : "Pause Simulation"; string itemCommand = !isEnabled ? "physicsStartSimulation( \"client\" );physicsStartSimulation( \"server\" );" : "physicsStopSimulation( \"client\" );physicsStopSimulation( \"server\" );"; diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/main.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/main.cs index 0a551e2e..9c841518 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/main.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/Tools/physicsTools/main.cs @@ -43,16 +43,14 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode.Tools.physicsTools { public class main { - private static readonly pInvokes omni = new pInvokes(); - [ConsoleInteraction] public static void initializePhysicsTools() { Omni.self.Print(" % - Initializing Physics Tools"); - if (!omni.Util.physicsPluginPresent()) + if (!pInvokes.Util.physicsPluginPresent()) { - omni.Util._echo("No physics plugin exists."); + pInvokes.Util._echo("No physics plugin exists."); return; } ActionMap globalactionmap = "globalactionmap"; @@ -73,19 +71,19 @@ public static void destroyPhysicsTools() [ConsoleInteraction] public static void physicsToggleSimulation() { - bool isEnabled = omni.Util.physicsSimulationEnabled(); + bool isEnabled = pInvokes.Util.physicsSimulationEnabled(); if (isEnabled) { // physicsStateText.setText("Simulation is paused."); - omni.Util._echo("Simulation is paused."); - omni.Util.physicsStopSimulation("client"); - omni.Util.physicsStopSimulation("server"); + pInvokes.Util._echo("Simulation is paused."); + pInvokes.Util.physicsStopSimulation("client"); + pInvokes.Util.physicsStopSimulation("server"); } else { - omni.Util._echo("Simulation is unpaused."); - omni.Util.physicsStartSimulation("client"); - omni.Util.physicsStartSimulation("server"); + pInvokes.Util._echo("Simulation is unpaused."); + pInvokes.Util.physicsStartSimulation("client"); + pInvokes.Util.physicsStartSimulation("server"); } } } diff --git a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/levelInfo.cs b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/levelInfo.cs index 64531974..f0ffcc1d 100644 --- a/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/levelInfo.cs +++ b/Templates/C#-Full/Winterleaf.Demo.Full/Models.User/GameCode/levelInfo.cs @@ -1,18 +1,18 @@ // WinterLeaf Entertainment // Copyright (c) 2014, WinterLeaf Entertainment LLC -// +// // All rights reserved. -// +// // The use of the WinterLeaf Entertainment LLC OMNI "Community Edition" is governed by this license agreement ("Agreement"). -// +// // These license terms are an agreement between WinterLeaf Entertainment LLC and you. Please read them. They apply to the source code and any other assets or works that are included with the product named above, which includes the media on which you received it, if any. These terms also apply to any updates, supplements, internet-based services, and support services for this software and its associated assets, unless other terms accompany those items. If so, those terms apply. You must read and agree to this Agreement terms BEFORE installing OMNI "Community Edition" to your hard drive or using OMNI in any way. If you do not agree to the license terms, do not download, install or use OMNI. Please make copies of this Agreement for all those in your organization who need to be familiar with the license terms. -// +// // This license allows companies of any size, government entities or individuals to create, sell, rent, lease, or otherwise profit commercially from, games using executables created from the source code that accompanies OMNI "Community Edition". -// +// // BY CLICKING THE ACCEPTANCE BUTTON AND/OR INSTALLING OR USING OMNI "Community Edition", THE INDIVIDUAL ACCESSING OMNI ("LICENSEE") IS CONSENTING TO BE BOUND BY AND BECOME A PARTY TO THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT INSTALL OR USE OMNI. IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW: -// +// // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -// +// // Redistributions of source code must retain the all copyright notice, this list of conditions and the following disclaimer. // Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. // With respect to any Product that the Licensee develop using the Software: @@ -30,8 +30,8 @@ // remove or alter any trademark, logo, copyright or other proprietary notices, legends, symbols or labels in OMNI Engine; or // use the Software to develop or distribute any software that competes with the Software without WinterLeaf Entertainment’s prior written consent; or // use the Software for any illegal purpose. -// -// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// THIS SOFTWARE IS PROVIDED BY WINTERLEAF ENTERTAINMENT LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WINTERLEAF ENTERTAINMENT LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #region @@ -46,7 +46,6 @@ namespace WinterLeaf.Demo.Full.Models.User.GameCode { public class levelInfo { - private static readonly pInvokes omni = new pInvokes(); //------------------------------------------------------------------------------ // Loading info is text displayed on the client side while the mission // is being loaded. This information is extracted from the mission file @@ -100,10 +99,10 @@ public static void BuildLoadInfo(string mission) infoObject += line + " "; } } - omni.console.Eval(infoObject); + pInvokes.console.Eval(infoObject); } else - omni.console.error(string.Format("Level File {0} not found.", mission)); + pInvokes.console.error(string.Format("Level File {0} not found.", mission)); } //------------------------------------------------------------------------------ @@ -116,10 +115,10 @@ public static void DumpLoadInfo() { LevelInfo thelevelinfo = "theLevelInfo"; - omni.console.print("Level Name: " + thelevelinfo["name"]); - omni.console.print("Level Description:"); + pInvokes.console.print("Level Name: " + thelevelinfo["name"]); + pInvokes.console.print("Level Description:"); for (int i = 0; thelevelinfo["desc[" + i + "]"] != ""; i++) - omni.console.print(" " + thelevelinfo["desc[" + i + "]"]); + pInvokes.console.print(" " + thelevelinfo["desc[" + i + "]"]); } } -} \ No newline at end of file +} diff --git a/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/Interopt/SafeNativeMethods.cs b/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/Interopt/SafeNativeMethods.cs index f6f15481..8ad3ba2a 100644 --- a/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/Interopt/SafeNativeMethods.cs +++ b/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/Interopt/SafeNativeMethods.cs @@ -514,6 +514,21 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn__expandOldFilename mwle_fn__expandOldFilename; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn__expandOldFilename([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn__getStockColorCount mwle_fn__getStockColorCount; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate int wle_fn__getStockColorCount(); +static internal wle_fn__getStockColorF mwle_fn__getStockColorF; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn__getStockColorF([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn__getStockColorI mwle_fn__getStockColorI; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn__getStockColorI([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn__getStockColorName mwle_fn__getStockColorName; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn__getStockColorName([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn__isStockColor mwle_fn__isStockColor; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate int wle_fn__isStockColor([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1); static internal wle_fn__mathInit mwle_fn__mathInit; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn__mathInit([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a1, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a2, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a3, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a4, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a5, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a6, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a7, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a8, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder a9); @@ -643,9 +658,15 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_clearServerPaths mwle_fn_clearServerPaths; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_clearServerPaths(); +static internal wle_fn_CloseAllPopOuts mwle_fn_CloseAllPopOuts; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_CloseAllPopOuts(); static internal wle_fn_closeNetPort mwle_fn_closeNetPort; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_closeNetPort(); +static internal wle_fn_closeSplashWindow mwle_fn_closeSplashWindow; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_closeSplashWindow(); static internal wle_fn_collapseEscape mwle_fn_collapseEscape; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_collapseEscape([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder text,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); @@ -901,9 +922,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_dumpStringMemStats mwle_fn_dumpStringMemStats; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_dumpStringMemStats(); -static internal wle_fn_dumpStringTableSize mwle_fn_dumpStringTableSize; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fn_dumpStringTableSize(); static internal wle_fn_dumpTextureObjects mwle_fn_dumpTextureObjects; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_dumpTextureObjects(); @@ -1207,6 +1225,12 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_getFileCRC mwle_fn_getFileCRC; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fn_getFileCRC([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder fileName); +static internal wle_fn_getFormatExtensions mwle_fn_getFormatExtensions; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_getFormatExtensions([MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); +static internal wle_fn_getFormatFilters mwle_fn_getFormatFilters; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_getFormatFilters([MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); static internal wle_fn_getFrustumOffset mwle_fn_getFrustumOffset; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_getFrustumOffset([MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); @@ -2418,7 +2442,7 @@ static private void MapConsoleExterns(string dllname) internal delegate int wle_fn_nameToID([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder objectName); static internal wle_fn_nextToken mwle_fn_nextToken; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fn_nextToken([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder str, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder token, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder delim,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); + internal delegate void wle_fn_nextToken([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder str1, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder token, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder delim,[MarshalAs(UnmanagedType.LPStr)] [Out] StringBuilder retval); static internal wle_fn_openFile mwle_fn_openFile; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_openFile([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder file); @@ -2605,6 +2629,12 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_querySingleServer mwle_fn_querySingleServer; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_querySingleServer([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder addrText, [In] byte flags); +static internal wle_fn_quit mwle_fn_quit; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_quit(); +static internal wle_fn_quitWithErrorMessage mwle_fn_quitWithErrorMessage; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fn_quitWithErrorMessage([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder message); static internal wle_fn_ReadXML_readFile mwle_fn_ReadXML_readFile; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fn_ReadXML_readFile([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder readxml); @@ -3168,7 +3198,7 @@ static private void MapConsoleExterns(string dllname) internal delegate void wle_fn_TerrainEditor_attachTerrain([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terraineditor, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terrain); static internal wle_fn_TerrainEditor_autoMaterialLayer mwle_fn_TerrainEditor_autoMaterialLayer; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fn_TerrainEditor_autoMaterialLayer([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terraineditor, [In] float minHeight, [In] float maxHeight, [In] float minSlope, [In] float maxSlope); + internal delegate void wle_fn_TerrainEditor_autoMaterialLayer([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terraineditor, [In] float minHeight, [In] float maxHeight, [In] float minSlope, [In] float maxSlope, [In] float coverage); static internal wle_fn_TerrainEditor_clearSelection mwle_fn_TerrainEditor_clearSelection; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_TerrainEditor_clearSelection([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder terraineditor); @@ -3355,9 +3385,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fn_UndoManager_undo mwle_fn_UndoManager_undo; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_UndoManager_undo([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder undomanager); -static internal wle_fn_unitTest_runTests mwle_fn_unitTest_runTests; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fn_unitTest_runTests([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder searchString, [In] bool skip); static internal wle_fn_unregisterMessageListener mwle_fn_unregisterMessageListener; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fn_unregisterMessageListener([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder queueName, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder listenerName); @@ -3571,6 +3598,12 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnAIPlayer_AISearchSimSet mwle_fnAIPlayer_AISearchSimSet; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnAIPlayer_AISearchSimSet([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder aiplayer, [In] float fOV, [In] float farDist, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder ObjToSearch, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder result); +static internal wle_fnAIPlayer_checkInFoV mwle_fnAIPlayer_checkInFoV; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate int wle_fnAIPlayer_checkInFoV([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder aiplayer, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder obj, [In] float fov, [In] bool checkEnabled); +static internal wle_fnAIPlayer_checkInLos mwle_fnAIPlayer_checkInLos; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate int wle_fnAIPlayer_checkInLos([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder aiplayer, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder obj, [In] bool useMuzzle, [In] bool checkEnabled); static internal wle_fnAIPlayer_clearAim mwle_fnAIPlayer_clearAim; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnAIPlayer_clearAim([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder aiplayer); @@ -3882,7 +3915,7 @@ static private void MapConsoleExterns(string dllname) internal delegate void wle_fnCamera_setOffset([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder offset); static internal wle_fnCamera_setOrbitMode mwle_fnCamera_setOrbitMode; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate int wle_fnCamera_setOrbitMode([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitObject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitPoint, [In] float minDistance, [In] float maxDistance, [In] float initDistance, [In] bool ownClientObj, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder offset, [In] bool lockedx); + internal delegate void wle_fnCamera_setOrbitMode([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitObject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitPoint, [In] float minDistance, [In] float maxDistance, [In] float initDistance, [In] bool ownClientObj, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder offset, [In] bool lockedx); static internal wle_fnCamera_setOrbitObject mwle_fnCamera_setOrbitObject; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnCamera_setOrbitObject([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder orbitObject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder rotation, [In] float minDistance, [In] float maxDistance, [In] float initDistance, [In] bool ownClientObject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder offset, [In] bool lockedx); @@ -3904,9 +3937,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnCamera_setVelocity mwle_fnCamera_setVelocity; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnCamera_setVelocity([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder camera, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder velocity); -static internal wle_fnCloudLayer_ChangeCoverage mwle_fnCloudLayer_ChangeCoverage; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fnCloudLayer_ChangeCoverage([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder cloudlayer, [In] float newCoverage); static internal wle_fnCoverPoint_isOccupied mwle_fnCoverPoint_isOccupied; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnCoverPoint_isOccupied([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder coverpoint); @@ -4027,9 +4057,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnForestWindEmitter_attachToObject mwle_fnForestWindEmitter_attachToObject; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnForestWindEmitter_attachToObject([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder forestwindemitter, [In] uint objectID); -static internal wle_fnForestWindEmitter_resetWind mwle_fnForestWindEmitter_resetWind; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fnForestWindEmitter_resetWind([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder forestwindemitter, [In] int randomSeed); static internal wle_fnGameBase_applyImpulse mwle_fnGameBase_applyImpulse; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnGameBase_applyImpulse([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder gamebase, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder pos, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder vel); @@ -4282,6 +4309,9 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnGuiCanvas_hideCursor mwle_fnGuiCanvas_hideCursor; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnGuiCanvas_hideCursor([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); +static internal wle_fnGuiCanvas_hideWindow mwle_fnGuiCanvas_hideWindow; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fnGuiCanvas_hideWindow([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); static internal wle_fnGuiCanvas_isCursorOn mwle_fnGuiCanvas_isCursorOn; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnGuiCanvas_isCursorOn([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); @@ -4318,6 +4348,9 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnGuiCanvas_showCursor mwle_fnGuiCanvas_showCursor; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnGuiCanvas_showCursor([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); +static internal wle_fnGuiCanvas_showWindow mwle_fnGuiCanvas_showWindow; +[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] + internal delegate void wle_fnGuiCanvas_showWindow([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); static internal wle_fnGuiCanvas_toggleFullscreen mwle_fnGuiCanvas_toggleFullscreen; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnGuiCanvas_toggleFullscreen([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder guicanvas); @@ -6325,9 +6358,6 @@ static private void MapConsoleExterns(string dllname) static internal wle_fnShapeBase_setImageTrigger mwle_fnShapeBase_setImageTrigger; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate int wle_fnShapeBase_setImageTrigger([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder shapebase, [In] int slot, [In] bool state); -static internal wle_fnShapeBase_setInvincibleMode mwle_fnShapeBase_setInvincibleMode; -[UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fnShapeBase_setInvincibleMode([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder shapebase, [In] float time, [In] float speed); static internal wle_fnShapeBase_setMeshHidden mwle_fnShapeBase_setMeshHidden; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnShapeBase_setMeshHidden([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder shapebase, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder name, [In] bool hide); @@ -6651,7 +6681,7 @@ static private void MapConsoleExterns(string dllname) internal delegate void wle_fnTCPObject_disconnect([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder tcpobject); static internal wle_fnTCPObject_listen mwle_fnTCPObject_listen; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] - internal delegate void wle_fnTCPObject_listen([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder tcpobject, [In] int port); + internal delegate void wle_fnTCPObject_listen([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder tcpobject, [In] uint port); static internal wle_fnTCPObject_send mwle_fnTCPObject_send; [UnmanagedFunctionPointer(CallingConvention.Cdecl, CharSet = CharSet.Ansi, SetLastError = true)] internal delegate void wle_fnTCPObject_send([MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder tcpobject, [MarshalAs(UnmanagedType.LPStr)] [In] StringBuilder data); @@ -7119,6 +7149,11 @@ static private void ClearAutoExterns(){ mwle_fn__execPrefs= null; mwle_fn__expandFilename= null; mwle_fn__expandOldFilename= null; +mwle_fn__getStockColorCount= null; +mwle_fn__getStockColorF= null; +mwle_fn__getStockColorI= null; +mwle_fn__getStockColorName= null; +mwle_fn__isStockColor= null; mwle_fn__mathInit= null; mwle_fn__resourceDump= null; mwle_fn__schedule= null; @@ -7162,7 +7197,9 @@ static private void ClearAutoExterns(){ mwle_fn_clearClientPaths= null; mwle_fn_clearGFXResourceFlags= null; mwle_fn_clearServerPaths= null; +mwle_fn_CloseAllPopOuts= null; mwle_fn_closeNetPort= null; +mwle_fn_closeSplashWindow= null; mwle_fn_collapseEscape= null; mwle_fn_compile= null; mwle_fn_CompoundUndoAction_addAction= null; @@ -7248,7 +7285,6 @@ static private void ClearAutoExterns(){ mwle_fn_dumpRandomNormalMap= null; mwle_fn_dumpSoCount= null; mwle_fn_dumpStringMemStats= null; -mwle_fn_dumpStringTableSize= null; mwle_fn_dumpTextureObjects= null; mwle_fn_duplicateCachedFont= null; mwle_fn_echoInputState= null; @@ -7350,6 +7386,8 @@ static private void ClearAutoExterns(){ mwle_fn_getFileCount= null; mwle_fn_getFileCountMultiExpr= null; mwle_fn_getFileCRC= null; +mwle_fn_getFormatExtensions= null; +mwle_fn_getFormatFilters= null; mwle_fn_getFrustumOffset= null; mwle_fn_getFunctionPackage= null; mwle_fn_getJoystickAxes= null; @@ -7816,6 +7854,8 @@ static private void ClearAutoExterns(){ mwle_fn_queryLanServers= null; mwle_fn_queryMasterServer= null; mwle_fn_querySingleServer= null; +mwle_fn_quit= null; +mwle_fn_quitWithErrorMessage= null; mwle_fn_ReadXML_readFile= null; mwle_fn_realQuit= null; mwle_fn_redbookClose= null; @@ -8066,7 +8106,6 @@ static private void ClearAutoExterns(){ mwle_fn_UndoManager_pushCompound= null; mwle_fn_UndoManager_redo= null; mwle_fn_UndoManager_undo= null; -mwle_fn_unitTest_runTests= null; mwle_fn_unregisterMessageListener= null; mwle_fn_unregisterMessageQueue= null; mwle_fn_VectorAdd= null; @@ -8138,6 +8177,8 @@ static private void ClearAutoExterns(){ mwle_fnActionMap_unbind= null; mwle_fnActionMap_unbindObj= null; mwle_fnAIPlayer_AISearchSimSet= null; +mwle_fnAIPlayer_checkInFoV= null; +mwle_fnAIPlayer_checkInLos= null; mwle_fnAIPlayer_clearAim= null; mwle_fnAIPlayer_findCover= null; mwle_fnAIPlayer_findNavMesh= null; @@ -8249,7 +8290,6 @@ static private void ClearAutoExterns(){ mwle_fnCamera_setTrackObject= null; mwle_fnCamera_setValidEditOrbitPoint= null; mwle_fnCamera_setVelocity= null; -mwle_fnCloudLayer_ChangeCoverage= null; mwle_fnCoverPoint_isOccupied= null; mwle_fnCubemapData_getFilename= null; mwle_fnCubemapData_updateFaces= null; @@ -8290,7 +8330,6 @@ static private void ClearAutoExterns(){ mwle_fnForest_addItem= null; mwle_fnForest_addItemWithTransform= null; mwle_fnForestWindEmitter_attachToObject= null; -mwle_fnForestWindEmitter_resetWind= null; mwle_fnGameBase_applyImpulse= null; mwle_fnGameBase_applyRadialImpulse= null; mwle_fnGameBase_getDataBlock= null; @@ -8375,6 +8414,7 @@ static private void ClearAutoExterns(){ mwle_fnGuiCanvas_getVideoMode= null; mwle_fnGuiCanvas_getWindowPosition= null; mwle_fnGuiCanvas_hideCursor= null; +mwle_fnGuiCanvas_hideWindow= null; mwle_fnGuiCanvas_isCursorOn= null; mwle_fnGuiCanvas_isCursorShown= null; mwle_fnGuiCanvas_renderFront= null; @@ -8387,6 +8427,7 @@ static private void ClearAutoExterns(){ mwle_fnGuiCanvas_setWindowPosition= null; mwle_fnGuiCanvas_setWindowTitle= null; mwle_fnGuiCanvas_showCursor= null; +mwle_fnGuiCanvas_showWindow= null; mwle_fnGuiCanvas_toggleFullscreen= null; mwle_fnGuiCheckBoxCtrl_isStateOn= null; mwle_fnGuiCheckBoxCtrl_setStateOn= null; @@ -9056,7 +9097,6 @@ static private void ClearAutoExterns(){ mwle_fnShapeBase_setImageScriptAnimPrefix= null; mwle_fnShapeBase_setImageTarget= null; mwle_fnShapeBase_setImageTrigger= null; -mwle_fnShapeBase_setInvincibleMode= null; mwle_fnShapeBase_setMeshHidden= null; mwle_fnShapeBase_setRechargeRate= null; mwle_fnShapeBase_setRepairRate= null; @@ -9328,6 +9368,11 @@ static private void ClearAutoExterns(){ mwle_fn__execPrefs= (wle_fn__execPrefs)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__execPrefs"), typeof(wle_fn__execPrefs)); mwle_fn__expandFilename= (wle_fn__expandFilename)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__expandFilename"), typeof(wle_fn__expandFilename)); mwle_fn__expandOldFilename= (wle_fn__expandOldFilename)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__expandOldFilename"), typeof(wle_fn__expandOldFilename)); +mwle_fn__getStockColorCount= (wle_fn__getStockColorCount)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__getStockColorCount"), typeof(wle_fn__getStockColorCount)); +mwle_fn__getStockColorF= (wle_fn__getStockColorF)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__getStockColorF"), typeof(wle_fn__getStockColorF)); +mwle_fn__getStockColorI= (wle_fn__getStockColorI)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__getStockColorI"), typeof(wle_fn__getStockColorI)); +mwle_fn__getStockColorName= (wle_fn__getStockColorName)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__getStockColorName"), typeof(wle_fn__getStockColorName)); +mwle_fn__isStockColor= (wle_fn__isStockColor)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__isStockColor"), typeof(wle_fn__isStockColor)); mwle_fn__mathInit= (wle_fn__mathInit)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__mathInit"), typeof(wle_fn__mathInit)); mwle_fn__resourceDump= (wle_fn__resourceDump)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__resourceDump"), typeof(wle_fn__resourceDump)); mwle_fn__schedule= (wle_fn__schedule)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn__schedule"), typeof(wle_fn__schedule)); @@ -9371,7 +9416,9 @@ static private void ClearAutoExterns(){ mwle_fn_clearClientPaths= (wle_fn_clearClientPaths)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_clearClientPaths"), typeof(wle_fn_clearClientPaths)); mwle_fn_clearGFXResourceFlags= (wle_fn_clearGFXResourceFlags)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_clearGFXResourceFlags"), typeof(wle_fn_clearGFXResourceFlags)); mwle_fn_clearServerPaths= (wle_fn_clearServerPaths)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_clearServerPaths"), typeof(wle_fn_clearServerPaths)); +mwle_fn_CloseAllPopOuts= (wle_fn_CloseAllPopOuts)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_CloseAllPopOuts"), typeof(wle_fn_CloseAllPopOuts)); mwle_fn_closeNetPort= (wle_fn_closeNetPort)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_closeNetPort"), typeof(wle_fn_closeNetPort)); +mwle_fn_closeSplashWindow= (wle_fn_closeSplashWindow)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_closeSplashWindow"), typeof(wle_fn_closeSplashWindow)); mwle_fn_collapseEscape= (wle_fn_collapseEscape)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_collapseEscape"), typeof(wle_fn_collapseEscape)); mwle_fn_compile= (wle_fn_compile)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_compile"), typeof(wle_fn_compile)); mwle_fn_CompoundUndoAction_addAction= (wle_fn_CompoundUndoAction_addAction)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_CompoundUndoAction_addAction"), typeof(wle_fn_CompoundUndoAction_addAction)); @@ -9457,7 +9504,6 @@ static private void ClearAutoExterns(){ mwle_fn_dumpRandomNormalMap= (wle_fn_dumpRandomNormalMap)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpRandomNormalMap"), typeof(wle_fn_dumpRandomNormalMap)); mwle_fn_dumpSoCount= (wle_fn_dumpSoCount)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpSoCount"), typeof(wle_fn_dumpSoCount)); mwle_fn_dumpStringMemStats= (wle_fn_dumpStringMemStats)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpStringMemStats"), typeof(wle_fn_dumpStringMemStats)); -mwle_fn_dumpStringTableSize= (wle_fn_dumpStringTableSize)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpStringTableSize"), typeof(wle_fn_dumpStringTableSize)); mwle_fn_dumpTextureObjects= (wle_fn_dumpTextureObjects)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_dumpTextureObjects"), typeof(wle_fn_dumpTextureObjects)); mwle_fn_duplicateCachedFont= (wle_fn_duplicateCachedFont)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_duplicateCachedFont"), typeof(wle_fn_duplicateCachedFont)); mwle_fn_echoInputState= (wle_fn_echoInputState)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_echoInputState"), typeof(wle_fn_echoInputState)); @@ -9559,6 +9605,8 @@ static private void ClearAutoExterns(){ mwle_fn_getFileCount= (wle_fn_getFileCount)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFileCount"), typeof(wle_fn_getFileCount)); mwle_fn_getFileCountMultiExpr= (wle_fn_getFileCountMultiExpr)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFileCountMultiExpr"), typeof(wle_fn_getFileCountMultiExpr)); mwle_fn_getFileCRC= (wle_fn_getFileCRC)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFileCRC"), typeof(wle_fn_getFileCRC)); +mwle_fn_getFormatExtensions= (wle_fn_getFormatExtensions)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFormatExtensions"), typeof(wle_fn_getFormatExtensions)); +mwle_fn_getFormatFilters= (wle_fn_getFormatFilters)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFormatFilters"), typeof(wle_fn_getFormatFilters)); mwle_fn_getFrustumOffset= (wle_fn_getFrustumOffset)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFrustumOffset"), typeof(wle_fn_getFrustumOffset)); mwle_fn_getFunctionPackage= (wle_fn_getFunctionPackage)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getFunctionPackage"), typeof(wle_fn_getFunctionPackage)); mwle_fn_getJoystickAxes= (wle_fn_getJoystickAxes)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_getJoystickAxes"), typeof(wle_fn_getJoystickAxes)); @@ -10025,6 +10073,8 @@ static private void ClearAutoExterns(){ mwle_fn_queryLanServers= (wle_fn_queryLanServers)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_queryLanServers"), typeof(wle_fn_queryLanServers)); mwle_fn_queryMasterServer= (wle_fn_queryMasterServer)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_queryMasterServer"), typeof(wle_fn_queryMasterServer)); mwle_fn_querySingleServer= (wle_fn_querySingleServer)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_querySingleServer"), typeof(wle_fn_querySingleServer)); +mwle_fn_quit= (wle_fn_quit)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_quit"), typeof(wle_fn_quit)); +mwle_fn_quitWithErrorMessage= (wle_fn_quitWithErrorMessage)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_quitWithErrorMessage"), typeof(wle_fn_quitWithErrorMessage)); mwle_fn_ReadXML_readFile= (wle_fn_ReadXML_readFile)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_ReadXML_readFile"), typeof(wle_fn_ReadXML_readFile)); mwle_fn_realQuit= (wle_fn_realQuit)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_realQuit"), typeof(wle_fn_realQuit)); mwle_fn_redbookClose= (wle_fn_redbookClose)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_redbookClose"), typeof(wle_fn_redbookClose)); @@ -10275,7 +10325,6 @@ static private void ClearAutoExterns(){ mwle_fn_UndoManager_pushCompound= (wle_fn_UndoManager_pushCompound)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_UndoManager_pushCompound"), typeof(wle_fn_UndoManager_pushCompound)); mwle_fn_UndoManager_redo= (wle_fn_UndoManager_redo)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_UndoManager_redo"), typeof(wle_fn_UndoManager_redo)); mwle_fn_UndoManager_undo= (wle_fn_UndoManager_undo)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_UndoManager_undo"), typeof(wle_fn_UndoManager_undo)); -mwle_fn_unitTest_runTests= (wle_fn_unitTest_runTests)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_unitTest_runTests"), typeof(wle_fn_unitTest_runTests)); mwle_fn_unregisterMessageListener= (wle_fn_unregisterMessageListener)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_unregisterMessageListener"), typeof(wle_fn_unregisterMessageListener)); mwle_fn_unregisterMessageQueue= (wle_fn_unregisterMessageQueue)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_unregisterMessageQueue"), typeof(wle_fn_unregisterMessageQueue)); mwle_fn_VectorAdd= (wle_fn_VectorAdd)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fn_VectorAdd"), typeof(wle_fn_VectorAdd)); @@ -10347,6 +10396,8 @@ static private void ClearAutoExterns(){ mwle_fnActionMap_unbind= (wle_fnActionMap_unbind)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnActionMap_unbind"), typeof(wle_fnActionMap_unbind)); mwle_fnActionMap_unbindObj= (wle_fnActionMap_unbindObj)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnActionMap_unbindObj"), typeof(wle_fnActionMap_unbindObj)); mwle_fnAIPlayer_AISearchSimSet= (wle_fnAIPlayer_AISearchSimSet)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_AISearchSimSet"), typeof(wle_fnAIPlayer_AISearchSimSet)); +mwle_fnAIPlayer_checkInFoV= (wle_fnAIPlayer_checkInFoV)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_checkInFoV"), typeof(wle_fnAIPlayer_checkInFoV)); +mwle_fnAIPlayer_checkInLos= (wle_fnAIPlayer_checkInLos)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_checkInLos"), typeof(wle_fnAIPlayer_checkInLos)); mwle_fnAIPlayer_clearAim= (wle_fnAIPlayer_clearAim)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_clearAim"), typeof(wle_fnAIPlayer_clearAim)); mwle_fnAIPlayer_findCover= (wle_fnAIPlayer_findCover)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_findCover"), typeof(wle_fnAIPlayer_findCover)); mwle_fnAIPlayer_findNavMesh= (wle_fnAIPlayer_findNavMesh)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnAIPlayer_findNavMesh"), typeof(wle_fnAIPlayer_findNavMesh)); @@ -10458,7 +10509,6 @@ static private void ClearAutoExterns(){ mwle_fnCamera_setTrackObject= (wle_fnCamera_setTrackObject)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCamera_setTrackObject"), typeof(wle_fnCamera_setTrackObject)); mwle_fnCamera_setValidEditOrbitPoint= (wle_fnCamera_setValidEditOrbitPoint)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCamera_setValidEditOrbitPoint"), typeof(wle_fnCamera_setValidEditOrbitPoint)); mwle_fnCamera_setVelocity= (wle_fnCamera_setVelocity)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCamera_setVelocity"), typeof(wle_fnCamera_setVelocity)); -mwle_fnCloudLayer_ChangeCoverage= (wle_fnCloudLayer_ChangeCoverage)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCloudLayer_ChangeCoverage"), typeof(wle_fnCloudLayer_ChangeCoverage)); mwle_fnCoverPoint_isOccupied= (wle_fnCoverPoint_isOccupied)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCoverPoint_isOccupied"), typeof(wle_fnCoverPoint_isOccupied)); mwle_fnCubemapData_getFilename= (wle_fnCubemapData_getFilename)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCubemapData_getFilename"), typeof(wle_fnCubemapData_getFilename)); mwle_fnCubemapData_updateFaces= (wle_fnCubemapData_updateFaces)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnCubemapData_updateFaces"), typeof(wle_fnCubemapData_updateFaces)); @@ -10499,7 +10549,6 @@ static private void ClearAutoExterns(){ mwle_fnForest_addItem= (wle_fnForest_addItem)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnForest_addItem"), typeof(wle_fnForest_addItem)); mwle_fnForest_addItemWithTransform= (wle_fnForest_addItemWithTransform)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnForest_addItemWithTransform"), typeof(wle_fnForest_addItemWithTransform)); mwle_fnForestWindEmitter_attachToObject= (wle_fnForestWindEmitter_attachToObject)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnForestWindEmitter_attachToObject"), typeof(wle_fnForestWindEmitter_attachToObject)); -mwle_fnForestWindEmitter_resetWind= (wle_fnForestWindEmitter_resetWind)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnForestWindEmitter_resetWind"), typeof(wle_fnForestWindEmitter_resetWind)); mwle_fnGameBase_applyImpulse= (wle_fnGameBase_applyImpulse)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGameBase_applyImpulse"), typeof(wle_fnGameBase_applyImpulse)); mwle_fnGameBase_applyRadialImpulse= (wle_fnGameBase_applyRadialImpulse)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGameBase_applyRadialImpulse"), typeof(wle_fnGameBase_applyRadialImpulse)); mwle_fnGameBase_getDataBlock= (wle_fnGameBase_getDataBlock)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGameBase_getDataBlock"), typeof(wle_fnGameBase_getDataBlock)); @@ -10584,6 +10633,7 @@ static private void ClearAutoExterns(){ mwle_fnGuiCanvas_getVideoMode= (wle_fnGuiCanvas_getVideoMode)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_getVideoMode"), typeof(wle_fnGuiCanvas_getVideoMode)); mwle_fnGuiCanvas_getWindowPosition= (wle_fnGuiCanvas_getWindowPosition)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_getWindowPosition"), typeof(wle_fnGuiCanvas_getWindowPosition)); mwle_fnGuiCanvas_hideCursor= (wle_fnGuiCanvas_hideCursor)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_hideCursor"), typeof(wle_fnGuiCanvas_hideCursor)); +mwle_fnGuiCanvas_hideWindow= (wle_fnGuiCanvas_hideWindow)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_hideWindow"), typeof(wle_fnGuiCanvas_hideWindow)); mwle_fnGuiCanvas_isCursorOn= (wle_fnGuiCanvas_isCursorOn)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_isCursorOn"), typeof(wle_fnGuiCanvas_isCursorOn)); mwle_fnGuiCanvas_isCursorShown= (wle_fnGuiCanvas_isCursorShown)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_isCursorShown"), typeof(wle_fnGuiCanvas_isCursorShown)); mwle_fnGuiCanvas_renderFront= (wle_fnGuiCanvas_renderFront)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_renderFront"), typeof(wle_fnGuiCanvas_renderFront)); @@ -10596,6 +10646,7 @@ static private void ClearAutoExterns(){ mwle_fnGuiCanvas_setWindowPosition= (wle_fnGuiCanvas_setWindowPosition)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_setWindowPosition"), typeof(wle_fnGuiCanvas_setWindowPosition)); mwle_fnGuiCanvas_setWindowTitle= (wle_fnGuiCanvas_setWindowTitle)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_setWindowTitle"), typeof(wle_fnGuiCanvas_setWindowTitle)); mwle_fnGuiCanvas_showCursor= (wle_fnGuiCanvas_showCursor)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_showCursor"), typeof(wle_fnGuiCanvas_showCursor)); +mwle_fnGuiCanvas_showWindow= (wle_fnGuiCanvas_showWindow)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_showWindow"), typeof(wle_fnGuiCanvas_showWindow)); mwle_fnGuiCanvas_toggleFullscreen= (wle_fnGuiCanvas_toggleFullscreen)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCanvas_toggleFullscreen"), typeof(wle_fnGuiCanvas_toggleFullscreen)); mwle_fnGuiCheckBoxCtrl_isStateOn= (wle_fnGuiCheckBoxCtrl_isStateOn)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCheckBoxCtrl_isStateOn"), typeof(wle_fnGuiCheckBoxCtrl_isStateOn)); mwle_fnGuiCheckBoxCtrl_setStateOn= (wle_fnGuiCheckBoxCtrl_setStateOn)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnGuiCheckBoxCtrl_setStateOn"), typeof(wle_fnGuiCheckBoxCtrl_setStateOn)); @@ -11265,7 +11316,6 @@ static private void ClearAutoExterns(){ mwle_fnShapeBase_setImageScriptAnimPrefix= (wle_fnShapeBase_setImageScriptAnimPrefix)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setImageScriptAnimPrefix"), typeof(wle_fnShapeBase_setImageScriptAnimPrefix)); mwle_fnShapeBase_setImageTarget= (wle_fnShapeBase_setImageTarget)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setImageTarget"), typeof(wle_fnShapeBase_setImageTarget)); mwle_fnShapeBase_setImageTrigger= (wle_fnShapeBase_setImageTrigger)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setImageTrigger"), typeof(wle_fnShapeBase_setImageTrigger)); -mwle_fnShapeBase_setInvincibleMode= (wle_fnShapeBase_setInvincibleMode)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setInvincibleMode"), typeof(wle_fnShapeBase_setInvincibleMode)); mwle_fnShapeBase_setMeshHidden= (wle_fnShapeBase_setMeshHidden)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setMeshHidden"), typeof(wle_fnShapeBase_setMeshHidden)); mwle_fnShapeBase_setRechargeRate= (wle_fnShapeBase_setRechargeRate)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setRechargeRate"), typeof(wle_fnShapeBase_setRechargeRate)); mwle_fnShapeBase_setRepairRate= (wle_fnShapeBase_setRepairRate)Marshal.GetDelegateForFunctionPointer(GetProcAddress(dllname, "wle_fnShapeBase_setRepairRate"), typeof(wle_fnShapeBase_setRepairRate)); diff --git a/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/Interopt/pInvokes.cs b/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/Interopt/pInvokes.cs index e3e6805f..df4c9203 100644 --- a/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/Interopt/pInvokes.cs +++ b/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/Interopt/pInvokes.cs @@ -34,11 +34,11 @@ public uint this[string key] set { m_ts.SetVar(key, value); } } } - private readonly muglobals _muglobals = new muglobals(); + private static readonly muglobals _muglobals = new muglobals(); /// /// used to set/get bool globals /// - public muglobals uGlobal + public static muglobals uGlobal { get { return _muglobals; } } @@ -64,12 +64,12 @@ public override string ToString() return base.ToString(); } - readonly mglobalsIsDefined _mglobalsIsDefined = new mglobalsIsDefined(); + private readonly static mglobalsIsDefined _mglobalsIsDefined = new mglobalsIsDefined(); /// /// Used to grab string globals /// - public mglobalsIsDefined isGlobal + public static mglobalsIsDefined isGlobal { get { return _mglobalsIsDefined; } } @@ -89,11 +89,11 @@ public string this[string key] set { m_ts.SetVar(key, value); } } } - public readonly msglobals _msglobals = new msglobals(); + private static readonly msglobals _msglobals = new msglobals(); /// /// Used to grab string globals /// - public msglobals sGlobal + public static msglobals sGlobal { get { return _msglobals; } } @@ -115,11 +115,11 @@ public int this[string key] } } - private readonly miglobals _miglobals = new miglobals(); + private static readonly miglobals _miglobals = new miglobals(); /// /// used to set/get int globals /// - public miglobals iGlobal + public static miglobals iGlobal { get { return _miglobals; } } @@ -139,11 +139,11 @@ public bool this[string key] set { m_ts.SetVar(key, value); } } } - private readonly mbglobals _mbglobals = new mbglobals(); + private static readonly mbglobals _mbglobals = new mbglobals(); /// /// used to set/get bool globals /// - public mbglobals bGlobal + public static mbglobals bGlobal { get { return _mbglobals; } } @@ -165,11 +165,11 @@ public float this[string key] set { m_ts.SetVar(key, value); } } } - private readonly mfglobals _mfglobals = new mfglobals(); + private static readonly mfglobals _mfglobals = new mfglobals(); /// /// used to set/get bool globals /// - public mfglobals fGlobal + public static mfglobals fGlobal { get { return _mfglobals; } } @@ -191,11 +191,11 @@ public double this[string key] set { m_ts.SetVar(key, value); } } } - public readonly mdglobals _mdglobals = new mdglobals(); + public static readonly mdglobals _mdglobals = new mdglobals(); /// /// used to set/get bool globals /// - public mdglobals dGlobal + public static mdglobals dGlobal { get { return _mdglobals; } } @@ -209,17 +209,17 @@ public mdglobals dGlobal /// /// A property exposing Custom dnTorque Console Functions. /// - private ConsoleObject _mConsoleobject; + private static ConsoleObject _mConsoleobject; /// /// A property exposing Custom Math console functions. /// - private tMath _mMathobject; + private static tMath _mMathobject; /// /// A property exposing Custom dnTorque Console Functions. /// - public ConsoleObject console + public static ConsoleObject console { get { return _mConsoleobject; } } @@ -227,7 +227,7 @@ public ConsoleObject console /// /// A property exposing Custom Math console functions. /// - public tMath math + public static tMath math { get { return _mMathobject; } } @@ -236,7 +236,7 @@ public tMath math /// /// A list of all the Connection Object ID's active in Torque at the moment of request. /// - public List ClientGroup + public static List ClientGroup { get { @@ -253,7 +253,7 @@ public List ClientGroup /// The count of connection ID's /// /// - public UInt32 ClientGroup__GetCount() + public static UInt32 ClientGroup__GetCount() { return m_ts.ClientGroupGetCount(); } @@ -263,7 +263,7 @@ public UInt32 ClientGroup__GetCount() /// /// /// - public uint ClientGroup__GetItem(UInt32 index) + public static uint ClientGroup__GetItem(UInt32 index) { return m_ts.ClientGroupGetObject(index); } @@ -272,7 +272,7 @@ public uint ClientGroup__GetItem(UInt32 index) /// Removes the tagged string from Torque. /// /// - public void removeTaggedString(string tag) + public static void removeTaggedString(string tag) { m_ts._removeTaggedString(tag); } @@ -282,9 +282,6 @@ public void removeTaggedString(string tag) /// public class ConsoleObject { - private Omni m_ts; - - /// /// /// @@ -474,16 +471,6 @@ public string Call(string simobject, string function) return m_ts.SimObjectCall(simobject, function, new string[] { }); } - - /// - /// Constructor. - /// - /// - public ConsoleObject(ref Omni ts) - { - m_ts = ts; - } - /// /// Returns the string for the passed tag. /// @@ -1202,18 +1189,6 @@ public class tMath /// /// /// - private Omni m_ts; - /// - /// - /// - /// - public tMath(ref Omni ts) - { - m_ts = ts; - } - /// - /// - /// public static double M_2PI_F { get { return 3.1415926535897932384626433f * 2.0f; } @@ -1278,1240 +1253,1233 @@ public pInvokes(ref Omni c) public void SetUp(ref Omni c) { m_ts = c; - _mConsoleobject = new ConsoleObject(ref c); - _mMathobject = new tMath(ref c); - _mUtil = new UtilObject(ref c); - _mAIClient = new AIClientObject(ref c); - _mAIConnection = new AIConnectionObject(ref c); - _mAIPlayer = new AIPlayerObject(ref c); - _mCompoundUndoAction = new CompoundUndoActionObject(ref c); - _mConsoleLogger = new ConsoleLoggerObject(ref c); - _mCreatorTree = new CreatorTreeObject(ref c); - _mDbgFileView = new DbgFileViewObject(ref c); - _mEditManager = new EditManagerObject(ref c); - _mEventManager = new EventManagerObject(ref c); - _mFieldBrushObject = new FieldBrushObjectObject(ref c); - _mFileObject = new FileObjectObject(ref c); - _mForest = new ForestObject(ref c); - _mForestBrush = new ForestBrushObject(ref c); - _mForestBrushTool = new ForestBrushToolObject(ref c); - _mForestEditorCtrl = new ForestEditorCtrlObject(ref c); - _mForestSelectionTool = new ForestSelectionToolObject(ref c); - _mGuiBitmapCtrl = new GuiBitmapCtrlObject(ref c); - _mGuiCanvas = new GuiCanvasObject(ref c); - _mGuiColorPickerCtrl = new GuiColorPickerCtrlObject(ref c); - _mGuiControl = new GuiControlObject(ref c); - _mGuiControlProfile = new GuiControlProfileObject(ref c); - _mGuiConvexEditorCtrl = new GuiConvexEditorCtrlObject(ref c); - _mGuiDecalEditorCtrl = new GuiDecalEditorCtrlObject(ref c); - _mGuiEditCtrl = new GuiEditCtrlObject(ref c); - _mGuiFileTreeCtrl = new GuiFileTreeCtrlObject(ref c); - _mGuiFilterCtrl = new GuiFilterCtrlObject(ref c); - _mGuiGradientCtrl = new GuiGradientCtrlObject(ref c); - _mGuiIdleCamFadeBitmapCtrl = new GuiIdleCamFadeBitmapCtrlObject(ref c); - _mGuiInspector = new GuiInspectorObject(ref c); - _mGuiInspectorDynamicField = new GuiInspectorDynamicFieldObject(ref c); - _mGuiInspectorDynamicGroup = new GuiInspectorDynamicGroupObject(ref c); - _mGuiInspectorField = new GuiInspectorFieldObject(ref c); - _mGuiMaterialCtrl = new GuiMaterialCtrlObject(ref c); - _mGuiMeshRoadEditorCtrl = new GuiMeshRoadEditorCtrlObject(ref c); - _mGuiMissionAreaEditorCtrl = new GuiMissionAreaEditorCtrlObject(ref c); - _mGuiNavEditorCtrl = new GuiNavEditorCtrlObject(ref c); - _mGuiParticleGraphCtrl = new GuiParticleGraphCtrlObject(ref c); - _mGuiPopUpMenuCtrl = new GuiPopUpMenuCtrlObject(ref c); - _mGuiPopUpMenuCtrlEx = new GuiPopUpMenuCtrlExObject(ref c); - _mGuiRiverEditorCtrl = new GuiRiverEditorCtrlObject(ref c); - _mGuiRoadEditorCtrl = new GuiRoadEditorCtrlObject(ref c); - _mGuiTerrPreviewCtrl = new GuiTerrPreviewCtrlObject(ref c); - _mGuiTextEditCtrl = new GuiTextEditCtrlObject(ref c); - _mGuiTickCtrl = new GuiTickCtrlObject(ref c); - _mGuiToolboxButtonCtrl = new GuiToolboxButtonCtrlObject(ref c); - _mGuiTreeViewCtrl = new GuiTreeViewCtrlObject(ref c); - _mGuiVariableInspector = new GuiVariableInspectorObject(ref c); - _mLangTable = new LangTableObject(ref c); - _mLightBase = new LightBaseObject(ref c); - _mMaterial = new MaterialObject(ref c); - _mMECreateUndoAction = new MECreateUndoActionObject(ref c); - _mMEDeleteUndoAction = new MEDeleteUndoActionObject(ref c); - _mMenuBar = new MenuBarObject(ref c); - _mMessage = new MessageObject(ref c); - _mMessageVector = new MessageVectorObject(ref c); - _mPersistenceManager = new PersistenceManagerObject(ref c); - _mPhysicsDebrisData = new PhysicsDebrisDataObject(ref c); - _mPopupMenu = new PopupMenuObject(ref c); - _mReadXML = new ReadXMLObject(ref c); - _mSettings = new SettingsObject(ref c); - _mSFXSource = new SFXSourceObject(ref c); - _mSimComponent = new SimComponentObject(ref c); - _mSimDataBlock = new SimDataBlockObject(ref c); - _mSimObject = new SimObjectObject(ref c); - _mSimPersistSet = new SimPersistSetObject(ref c); - _mSimResponseCurve = new SimResponseCurveObject(ref c); - _mSimSet = new SimSetObject(ref c); - _mSimXMLDocument = new SimXMLDocumentObject(ref c); - _mSkyBox = new SkyBoxObject(ref c); - _mSpawnSphere = new SpawnSphereObject(ref c); - _mStaticShape = new StaticShapeObject(ref c); - _mSun = new SunObject(ref c); - _mTerrainBlock = new TerrainBlockObject(ref c); - _mTerrainEditor = new TerrainEditorObject(ref c); - _mTerrainSmoothAction = new TerrainSmoothActionObject(ref c); - _mTerrainSolderEdgesAction = new TerrainSolderEdgesActionObject(ref c); - _mTheoraTextureObject = new TheoraTextureObjectObject(ref c); - _mUndoAction = new UndoActionObject(ref c); - _mUndoManager = new UndoManagerObject(ref c); - _mWorldEditor = new WorldEditorObject(ref c); - _mActionMap = new ActionMapObject(ref c); - _mAITurretShape = new AITurretShapeObject(ref c); - _mArrayObject = new ArrayObjectObject(ref c); - _mCamera = new CameraObject(ref c); - _mCloudLayer = new CloudLayerObject(ref c); - _mCoverPoint = new CoverPointObject(ref c); - _mCubemapData = new CubemapDataObject(ref c); - _mDebris = new DebrisObject(ref c); - _mDebugDrawer = new DebugDrawerObject(ref c); - _mDecalData = new DecalDataObject(ref c); - _mDecalRoad = new DecalRoadObject(ref c); - _mDynamicConsoleMethodComponent = new DynamicConsoleMethodComponentObject(ref c); - _mEditTSCtrl = new EditTSCtrlObject(ref c); - _mFileDialog = new FileDialogObject(ref c); - _mFileStreamObject = new FileStreamObjectObject(ref c); - _mFlyingVehicle = new FlyingVehicleObject(ref c); - _mForestWindEmitter = new ForestWindEmitterObject(ref c); - _mGameBase = new GameBaseObject(ref c); - _mGameConnection = new GameConnectionObject(ref c); - _mGroundPlane = new GroundPlaneObject(ref c); - _mGuiAutoCompleteCtrl = new GuiAutoCompleteCtrlObject(ref c); - _mGuiAutoScrollCtrl = new GuiAutoScrollCtrlObject(ref c); - _mGuiBitmapButtonCtrl = new GuiBitmapButtonCtrlObject(ref c); - _mGuiButtonBaseCtrl = new GuiButtonBaseCtrlObject(ref c); - _mGuiCheckBoxCtrl = new GuiCheckBoxCtrlObject(ref c); - _mGuiChunkedBitmapCtrl = new GuiChunkedBitmapCtrlObject(ref c); - _mGuiClockHud = new GuiClockHudObject(ref c); - _mGuiDirectoryFileListCtrl = new GuiDirectoryFileListCtrlObject(ref c); - _mGuiDragAndDropControl = new GuiDragAndDropControlObject(ref c); - _mGuiDynamicCtrlArrayControl = new GuiDynamicCtrlArrayControlObject(ref c); - _mGuiFormCtrl = new GuiFormCtrlObject(ref c); - _mGuiFrameSetCtrl = new GuiFrameSetCtrlObject(ref c); - _mGuiGameListMenuCtrl = new GuiGameListMenuCtrlObject(ref c); - _mGuiGameListOptionsCtrl = new GuiGameListOptionsCtrlObject(ref c); - _mGuiGraphCtrl = new GuiGraphCtrlObject(ref c); - _mGuiIconButtonCtrl = new GuiIconButtonCtrlObject(ref c); - _mGuiImageList = new GuiImageListObject(ref c); - _mGuiInspectorTypeBitMask32 = new GuiInspectorTypeBitMask32Object(ref c); - _mGuiInspectorTypeFileName = new GuiInspectorTypeFileNameObject(ref c); - _mGuiListBoxCtrl = new GuiListBoxCtrlObject(ref c); - _mGuiMaterialPreview = new GuiMaterialPreviewObject(ref c); - _mGuiMenuBar = new GuiMenuBarObject(ref c); - _mGuiMessageVectorCtrl = new GuiMessageVectorCtrlObject(ref c); - _mGuiMissionAreaCtrl = new GuiMissionAreaCtrlObject(ref c); - _mGuiMLTextCtrl = new GuiMLTextCtrlObject(ref c); - _mGuiObjectView = new GuiObjectViewObject(ref c); - _mGuiPaneControl = new GuiPaneControlObject(ref c); - _mGuiProgressBitmapCtrl = new GuiProgressBitmapCtrlObject(ref c); - _mGuiRolloutCtrl = new GuiRolloutCtrlObject(ref c); - _mGuiScrollCtrl = new GuiScrollCtrlObject(ref c); - _mGuiShapeEdPreview = new GuiShapeEdPreviewObject(ref c); - _mGuiSliderCtrl = new GuiSliderCtrlObject(ref c); - _mGuiStackControl = new GuiStackControlObject(ref c); - _mGuiSwatchButtonCtrl = new GuiSwatchButtonCtrlObject(ref c); - _mGuiTabBookCtrl = new GuiTabBookCtrlObject(ref c); - _mGuiTableControl = new GuiTableControlObject(ref c); - _mGuiTabPageCtrl = new GuiTabPageCtrlObject(ref c); - _mGuiTextCtrl = new GuiTextCtrlObject(ref c); - _mGuiTextListCtrl = new GuiTextListCtrlObject(ref c); - _mGuiTheoraCtrl = new GuiTheoraCtrlObject(ref c); - _mGuiTSCtrl = new GuiTSCtrlObject(ref c); - _mGuiWindowCtrl = new GuiWindowCtrlObject(ref c); - _mHTTPObject = new HTTPObjectObject(ref c); - _mItem = new ItemObject(ref c); - _mLevelInfo = new LevelInfoObject(ref c); - _mLightDescription = new LightDescriptionObject(ref c); - _mLightFlareData = new LightFlareDataObject(ref c); - _mLightning = new LightningObject(ref c); - _mMeshRoad = new MeshRoadObject(ref c); - _mMissionArea = new MissionAreaObject(ref c); - _mNavMesh = new NavMeshObject(ref c); - _mNavPath = new NavPathObject(ref c); - _mNetConnection = new NetConnectionObject(ref c); - _mNetObject = new NetObjectObject(ref c); - _mParticleData = new ParticleDataObject(ref c); - _mParticleEmitterData = new ParticleEmitterDataObject(ref c); - _mParticleEmitterNode = new ParticleEmitterNodeObject(ref c); - _mPathCamera = new PathCameraObject(ref c); - _mPhysicalZone = new PhysicalZoneObject(ref c); - _mPhysicsForce = new PhysicsForceObject(ref c); - _mPhysicsShape = new PhysicsShapeObject(ref c); - _mPlayer = new PlayerObject(ref c); - _mPortal = new PortalObject(ref c); - _mPostEffect = new PostEffectObject(ref c); - _mPrecipitation = new PrecipitationObject(ref c); - _mProjectile = new ProjectileObject(ref c); - _mProximityMine = new ProximityMineObject(ref c); - _mRenderBinManager = new RenderBinManagerObject(ref c); - _mRenderMeshExample = new RenderMeshExampleObject(ref c); - _mRenderPassManager = new RenderPassManagerObject(ref c); - _mRenderPassStateToken = new RenderPassStateTokenObject(ref c); - _mRigidShape = new RigidShapeObject(ref c); - _mRiver = new RiverObject(ref c); - _mScatterSky = new ScatterSkyObject(ref c); - _mSceneObject = new SceneObjectObject(ref c); - _mScriptTickObject = new ScriptTickObjectObject(ref c); - _mSFXController = new SFXControllerObject(ref c); - _mSFXEmitter = new SFXEmitterObject(ref c); - _mSFXParameter = new SFXParameterObject(ref c); - _mSFXProfile = new SFXProfileObject(ref c); - _mSFXSound = new SFXSoundObject(ref c); - _mSFXState = new SFXStateObject(ref c); - _mShaderData = new ShaderDataObject(ref c); - _mShapeBase = new ShapeBaseObject(ref c); - _mShapeBaseData = new ShapeBaseDataObject(ref c); - _mSimpleNetObject = new SimpleNetObjectObject(ref c); - _mStreamObject = new StreamObjectObject(ref c); - _mTCPObject = new TCPObjectObject(ref c); - _mTimeOfDay = new TimeOfDayObject(ref c); - _mTrigger = new TriggerObject(ref c); - _mTSAttachable = new TSAttachableObject(ref c); - _mTSDynamic = new TSDynamicObject(ref c); - _mTSPathShape = new TSPathShapeObject(ref c); - _mTSShapeConstructor = new TSShapeConstructorObject(ref c); - _mTSStatic = new TSStaticObject(ref c); - _mTurretShape = new TurretShapeObject(ref c); - _mVolumetricFog = new VolumetricFogObject(ref c); - _mWalkableShape = new WalkableShapeObject(ref c); - _mWheeledVehicle = new WheeledVehicleObject(ref c); - _mWorldEditorSelection = new WorldEditorSelectionObject(ref c); - _mZipObject = new ZipObjectObject(ref c); - _mZone = new ZoneObject(ref c); -} -public UtilObject _mUtil; - /// - /// - /// -public UtilObject Util{get { return _mUtil; }} -public AIClientObject _mAIClient; + _mConsoleobject = new ConsoleObject(); + _mMathobject = new tMath(); + _mUtil = new UtilObject(); + _mAIClient = new AIClientObject(); + _mAIConnection = new AIConnectionObject(); + _mAIPlayer = new AIPlayerObject(); + _mCompoundUndoAction = new CompoundUndoActionObject(); + _mConsoleLogger = new ConsoleLoggerObject(); + _mCreatorTree = new CreatorTreeObject(); + _mDbgFileView = new DbgFileViewObject(); + _mEditManager = new EditManagerObject(); + _mEventManager = new EventManagerObject(); + _mFieldBrushObject = new FieldBrushObjectObject(); + _mFileObject = new FileObjectObject(); + _mForest = new ForestObject(); + _mForestBrush = new ForestBrushObject(); + _mForestBrushTool = new ForestBrushToolObject(); + _mForestEditorCtrl = new ForestEditorCtrlObject(); + _mForestSelectionTool = new ForestSelectionToolObject(); + _mGuiBitmapCtrl = new GuiBitmapCtrlObject(); + _mGuiCanvas = new GuiCanvasObject(); + _mGuiColorPickerCtrl = new GuiColorPickerCtrlObject(); + _mGuiControl = new GuiControlObject(); + _mGuiControlProfile = new GuiControlProfileObject(); + _mGuiConvexEditorCtrl = new GuiConvexEditorCtrlObject(); + _mGuiDecalEditorCtrl = new GuiDecalEditorCtrlObject(); + _mGuiEditCtrl = new GuiEditCtrlObject(); + _mGuiFileTreeCtrl = new GuiFileTreeCtrlObject(); + _mGuiFilterCtrl = new GuiFilterCtrlObject(); + _mGuiGradientCtrl = new GuiGradientCtrlObject(); + _mGuiIdleCamFadeBitmapCtrl = new GuiIdleCamFadeBitmapCtrlObject(); + _mGuiInspector = new GuiInspectorObject(); + _mGuiInspectorDynamicField = new GuiInspectorDynamicFieldObject(); + _mGuiInspectorDynamicGroup = new GuiInspectorDynamicGroupObject(); + _mGuiInspectorField = new GuiInspectorFieldObject(); + _mGuiMaterialCtrl = new GuiMaterialCtrlObject(); + _mGuiMeshRoadEditorCtrl = new GuiMeshRoadEditorCtrlObject(); + _mGuiMissionAreaEditorCtrl = new GuiMissionAreaEditorCtrlObject(); + _mGuiNavEditorCtrl = new GuiNavEditorCtrlObject(); + _mGuiParticleGraphCtrl = new GuiParticleGraphCtrlObject(); + _mGuiPopUpMenuCtrl = new GuiPopUpMenuCtrlObject(); + _mGuiPopUpMenuCtrlEx = new GuiPopUpMenuCtrlExObject(); + _mGuiRiverEditorCtrl = new GuiRiverEditorCtrlObject(); + _mGuiRoadEditorCtrl = new GuiRoadEditorCtrlObject(); + _mGuiTerrPreviewCtrl = new GuiTerrPreviewCtrlObject(); + _mGuiTextEditCtrl = new GuiTextEditCtrlObject(); + _mGuiTickCtrl = new GuiTickCtrlObject(); + _mGuiToolboxButtonCtrl = new GuiToolboxButtonCtrlObject(); + _mGuiTreeViewCtrl = new GuiTreeViewCtrlObject(); + _mGuiVariableInspector = new GuiVariableInspectorObject(); + _mLangTable = new LangTableObject(); + _mLightBase = new LightBaseObject(); + _mMaterial = new MaterialObject(); + _mMECreateUndoAction = new MECreateUndoActionObject(); + _mMEDeleteUndoAction = new MEDeleteUndoActionObject(); + _mMenuBar = new MenuBarObject(); + _mMessage = new MessageObject(); + _mMessageVector = new MessageVectorObject(); + _mPersistenceManager = new PersistenceManagerObject(); + _mPhysicsDebrisData = new PhysicsDebrisDataObject(); + _mPopupMenu = new PopupMenuObject(); + _mReadXML = new ReadXMLObject(); + _mSettings = new SettingsObject(); + _mSFXSource = new SFXSourceObject(); + _mSimComponent = new SimComponentObject(); + _mSimDataBlock = new SimDataBlockObject(); + _mSimObject = new SimObjectObject(); + _mSimPersistSet = new SimPersistSetObject(); + _mSimResponseCurve = new SimResponseCurveObject(); + _mSimSet = new SimSetObject(); + _mSimXMLDocument = new SimXMLDocumentObject(); + _mSkyBox = new SkyBoxObject(); + _mSpawnSphere = new SpawnSphereObject(); + _mStaticShape = new StaticShapeObject(); + _mSun = new SunObject(); + _mTerrainBlock = new TerrainBlockObject(); + _mTerrainEditor = new TerrainEditorObject(); + _mTerrainSmoothAction = new TerrainSmoothActionObject(); + _mTerrainSolderEdgesAction = new TerrainSolderEdgesActionObject(); + _mTheoraTextureObject = new TheoraTextureObjectObject(); + _mUndoAction = new UndoActionObject(); + _mUndoManager = new UndoManagerObject(); + _mWorldEditor = new WorldEditorObject(); + _mActionMap = new ActionMapObject(); + _mAITurretShape = new AITurretShapeObject(); + _mArrayObject = new ArrayObjectObject(); + _mCamera = new CameraObject(); + _mCoverPoint = new CoverPointObject(); + _mCubemapData = new CubemapDataObject(); + _mDebris = new DebrisObject(); + _mDebugDrawer = new DebugDrawerObject(); + _mDecalData = new DecalDataObject(); + _mDecalRoad = new DecalRoadObject(); + _mDynamicConsoleMethodComponent = new DynamicConsoleMethodComponentObject(); + _mEditTSCtrl = new EditTSCtrlObject(); + _mFileDialog = new FileDialogObject(); + _mFileStreamObject = new FileStreamObjectObject(); + _mFlyingVehicle = new FlyingVehicleObject(); + _mForestWindEmitter = new ForestWindEmitterObject(); + _mGameBase = new GameBaseObject(); + _mGameConnection = new GameConnectionObject(); + _mGroundPlane = new GroundPlaneObject(); + _mGuiAutoCompleteCtrl = new GuiAutoCompleteCtrlObject(); + _mGuiAutoScrollCtrl = new GuiAutoScrollCtrlObject(); + _mGuiBitmapButtonCtrl = new GuiBitmapButtonCtrlObject(); + _mGuiButtonBaseCtrl = new GuiButtonBaseCtrlObject(); + _mGuiCheckBoxCtrl = new GuiCheckBoxCtrlObject(); + _mGuiChunkedBitmapCtrl = new GuiChunkedBitmapCtrlObject(); + _mGuiClockHud = new GuiClockHudObject(); + _mGuiDirectoryFileListCtrl = new GuiDirectoryFileListCtrlObject(); + _mGuiDragAndDropControl = new GuiDragAndDropControlObject(); + _mGuiDynamicCtrlArrayControl = new GuiDynamicCtrlArrayControlObject(); + _mGuiFormCtrl = new GuiFormCtrlObject(); + _mGuiFrameSetCtrl = new GuiFrameSetCtrlObject(); + _mGuiGameListMenuCtrl = new GuiGameListMenuCtrlObject(); + _mGuiGameListOptionsCtrl = new GuiGameListOptionsCtrlObject(); + _mGuiGraphCtrl = new GuiGraphCtrlObject(); + _mGuiIconButtonCtrl = new GuiIconButtonCtrlObject(); + _mGuiImageList = new GuiImageListObject(); + _mGuiInspectorTypeBitMask32 = new GuiInspectorTypeBitMask32Object(); + _mGuiInspectorTypeFileName = new GuiInspectorTypeFileNameObject(); + _mGuiListBoxCtrl = new GuiListBoxCtrlObject(); + _mGuiMaterialPreview = new GuiMaterialPreviewObject(); + _mGuiMenuBar = new GuiMenuBarObject(); + _mGuiMessageVectorCtrl = new GuiMessageVectorCtrlObject(); + _mGuiMissionAreaCtrl = new GuiMissionAreaCtrlObject(); + _mGuiMLTextCtrl = new GuiMLTextCtrlObject(); + _mGuiObjectView = new GuiObjectViewObject(); + _mGuiPaneControl = new GuiPaneControlObject(); + _mGuiProgressBitmapCtrl = new GuiProgressBitmapCtrlObject(); + _mGuiRolloutCtrl = new GuiRolloutCtrlObject(); + _mGuiScrollCtrl = new GuiScrollCtrlObject(); + _mGuiShapeEdPreview = new GuiShapeEdPreviewObject(); + _mGuiSliderCtrl = new GuiSliderCtrlObject(); + _mGuiStackControl = new GuiStackControlObject(); + _mGuiSwatchButtonCtrl = new GuiSwatchButtonCtrlObject(); + _mGuiTabBookCtrl = new GuiTabBookCtrlObject(); + _mGuiTableControl = new GuiTableControlObject(); + _mGuiTabPageCtrl = new GuiTabPageCtrlObject(); + _mGuiTextCtrl = new GuiTextCtrlObject(); + _mGuiTextListCtrl = new GuiTextListCtrlObject(); + _mGuiTheoraCtrl = new GuiTheoraCtrlObject(); + _mGuiTSCtrl = new GuiTSCtrlObject(); + _mGuiWindowCtrl = new GuiWindowCtrlObject(); + _mHTTPObject = new HTTPObjectObject(); + _mItem = new ItemObject(); + _mLevelInfo = new LevelInfoObject(); + _mLightDescription = new LightDescriptionObject(); + _mLightFlareData = new LightFlareDataObject(); + _mLightning = new LightningObject(); + _mMeshRoad = new MeshRoadObject(); + _mMissionArea = new MissionAreaObject(); + _mNavMesh = new NavMeshObject(); + _mNavPath = new NavPathObject(); + _mNetConnection = new NetConnectionObject(); + _mNetObject = new NetObjectObject(); + _mParticleData = new ParticleDataObject(); + _mParticleEmitterData = new ParticleEmitterDataObject(); + _mParticleEmitterNode = new ParticleEmitterNodeObject(); + _mPathCamera = new PathCameraObject(); + _mPhysicalZone = new PhysicalZoneObject(); + _mPhysicsForce = new PhysicsForceObject(); + _mPhysicsShape = new PhysicsShapeObject(); + _mPlayer = new PlayerObject(); + _mPortal = new PortalObject(); + _mPostEffect = new PostEffectObject(); + _mPrecipitation = new PrecipitationObject(); + _mProjectile = new ProjectileObject(); + _mProximityMine = new ProximityMineObject(); + _mRenderBinManager = new RenderBinManagerObject(); + _mRenderMeshExample = new RenderMeshExampleObject(); + _mRenderPassManager = new RenderPassManagerObject(); + _mRenderPassStateToken = new RenderPassStateTokenObject(); + _mRigidShape = new RigidShapeObject(); + _mRiver = new RiverObject(); + _mScatterSky = new ScatterSkyObject(); + _mSceneObject = new SceneObjectObject(); + _mScriptTickObject = new ScriptTickObjectObject(); + _mSFXController = new SFXControllerObject(); + _mSFXEmitter = new SFXEmitterObject(); + _mSFXParameter = new SFXParameterObject(); + _mSFXProfile = new SFXProfileObject(); + _mSFXSound = new SFXSoundObject(); + _mSFXState = new SFXStateObject(); + _mShaderData = new ShaderDataObject(); + _mShapeBase = new ShapeBaseObject(); + _mShapeBaseData = new ShapeBaseDataObject(); + _mSimpleNetObject = new SimpleNetObjectObject(); + _mStreamObject = new StreamObjectObject(); + _mTCPObject = new TCPObjectObject(); + _mTimeOfDay = new TimeOfDayObject(); + _mTrigger = new TriggerObject(); + _mTSAttachable = new TSAttachableObject(); + _mTSDynamic = new TSDynamicObject(); + _mTSPathShape = new TSPathShapeObject(); + _mTSShapeConstructor = new TSShapeConstructorObject(); + _mTSStatic = new TSStaticObject(); + _mTurretShape = new TurretShapeObject(); + _mVolumetricFog = new VolumetricFogObject(); + _mWalkableShape = new WalkableShapeObject(); + _mWheeledVehicle = new WheeledVehicleObject(); + _mWorldEditorSelection = new WorldEditorSelectionObject(); + _mZipObject = new ZipObjectObject(); + _mZone = new ZoneObject(); +} +private static UtilObject _mUtil; /// /// /// -public AIClientObject AIClient{get { return _mAIClient; }} -public AIConnectionObject _mAIConnection; +public static UtilObject Util{get { return _mUtil; }} +private static AIClientObject _mAIClient; /// /// /// -public AIConnectionObject AIConnection{get { return _mAIConnection; }} -public AIPlayerObject _mAIPlayer; +public static AIClientObject AIClient{get { return _mAIClient; }} +private static AIConnectionObject _mAIConnection; /// /// /// -public AIPlayerObject AIPlayer{get { return _mAIPlayer; }} -public CompoundUndoActionObject _mCompoundUndoAction; +public static AIConnectionObject AIConnection{get { return _mAIConnection; }} +private static AIPlayerObject _mAIPlayer; /// /// /// -public CompoundUndoActionObject CompoundUndoAction{get { return _mCompoundUndoAction; }} -public ConsoleLoggerObject _mConsoleLogger; +public static AIPlayerObject AIPlayer{get { return _mAIPlayer; }} +private static CompoundUndoActionObject _mCompoundUndoAction; /// /// /// -public ConsoleLoggerObject ConsoleLogger{get { return _mConsoleLogger; }} -public CreatorTreeObject _mCreatorTree; +public static CompoundUndoActionObject CompoundUndoAction{get { return _mCompoundUndoAction; }} +private static ConsoleLoggerObject _mConsoleLogger; /// /// /// -public CreatorTreeObject CreatorTree{get { return _mCreatorTree; }} -public DbgFileViewObject _mDbgFileView; +public static ConsoleLoggerObject ConsoleLogger{get { return _mConsoleLogger; }} +private static CreatorTreeObject _mCreatorTree; /// /// /// -public DbgFileViewObject DbgFileView{get { return _mDbgFileView; }} -public EditManagerObject _mEditManager; +public static CreatorTreeObject CreatorTree{get { return _mCreatorTree; }} +private static DbgFileViewObject _mDbgFileView; /// /// /// -public EditManagerObject EditManager{get { return _mEditManager; }} -public EventManagerObject _mEventManager; +public static DbgFileViewObject DbgFileView{get { return _mDbgFileView; }} +private static EditManagerObject _mEditManager; /// /// /// -public EventManagerObject EventManager{get { return _mEventManager; }} -public FieldBrushObjectObject _mFieldBrushObject; +public static EditManagerObject EditManager{get { return _mEditManager; }} +private static EventManagerObject _mEventManager; /// /// /// -public FieldBrushObjectObject FieldBrushObject{get { return _mFieldBrushObject; }} -public FileObjectObject _mFileObject; +public static EventManagerObject EventManager{get { return _mEventManager; }} +private static FieldBrushObjectObject _mFieldBrushObject; /// /// /// -public FileObjectObject FileObject{get { return _mFileObject; }} -public ForestObject _mForest; +public static FieldBrushObjectObject FieldBrushObject{get { return _mFieldBrushObject; }} +private static FileObjectObject _mFileObject; /// /// /// -public ForestObject Forest{get { return _mForest; }} -public ForestBrushObject _mForestBrush; +public static FileObjectObject FileObject{get { return _mFileObject; }} +private static ForestObject _mForest; /// /// /// -public ForestBrushObject ForestBrush{get { return _mForestBrush; }} -public ForestBrushToolObject _mForestBrushTool; +public static ForestObject Forest{get { return _mForest; }} +private static ForestBrushObject _mForestBrush; /// /// /// -public ForestBrushToolObject ForestBrushTool{get { return _mForestBrushTool; }} -public ForestEditorCtrlObject _mForestEditorCtrl; +public static ForestBrushObject ForestBrush{get { return _mForestBrush; }} +private static ForestBrushToolObject _mForestBrushTool; /// /// /// -public ForestEditorCtrlObject ForestEditorCtrl{get { return _mForestEditorCtrl; }} -public ForestSelectionToolObject _mForestSelectionTool; +public static ForestBrushToolObject ForestBrushTool{get { return _mForestBrushTool; }} +private static ForestEditorCtrlObject _mForestEditorCtrl; /// /// /// -public ForestSelectionToolObject ForestSelectionTool{get { return _mForestSelectionTool; }} -public GuiBitmapCtrlObject _mGuiBitmapCtrl; +public static ForestEditorCtrlObject ForestEditorCtrl{get { return _mForestEditorCtrl; }} +private static ForestSelectionToolObject _mForestSelectionTool; /// /// /// -public GuiBitmapCtrlObject GuiBitmapCtrl{get { return _mGuiBitmapCtrl; }} -public GuiCanvasObject _mGuiCanvas; +public static ForestSelectionToolObject ForestSelectionTool{get { return _mForestSelectionTool; }} +private static GuiBitmapCtrlObject _mGuiBitmapCtrl; /// /// /// -public GuiCanvasObject GuiCanvas{get { return _mGuiCanvas; }} -public GuiColorPickerCtrlObject _mGuiColorPickerCtrl; +public static GuiBitmapCtrlObject GuiBitmapCtrl{get { return _mGuiBitmapCtrl; }} +private static GuiCanvasObject _mGuiCanvas; /// /// /// -public GuiColorPickerCtrlObject GuiColorPickerCtrl{get { return _mGuiColorPickerCtrl; }} -public GuiControlObject _mGuiControl; +public static GuiCanvasObject GuiCanvas{get { return _mGuiCanvas; }} +private static GuiColorPickerCtrlObject _mGuiColorPickerCtrl; /// /// /// -public GuiControlObject GuiControl{get { return _mGuiControl; }} -public GuiControlProfileObject _mGuiControlProfile; +public static GuiColorPickerCtrlObject GuiColorPickerCtrl{get { return _mGuiColorPickerCtrl; }} +private static GuiControlObject _mGuiControl; /// /// /// -public GuiControlProfileObject GuiControlProfile{get { return _mGuiControlProfile; }} -public GuiConvexEditorCtrlObject _mGuiConvexEditorCtrl; +public static GuiControlObject GuiControl{get { return _mGuiControl; }} +private static GuiControlProfileObject _mGuiControlProfile; /// /// /// -public GuiConvexEditorCtrlObject GuiConvexEditorCtrl{get { return _mGuiConvexEditorCtrl; }} -public GuiDecalEditorCtrlObject _mGuiDecalEditorCtrl; +public static GuiControlProfileObject GuiControlProfile{get { return _mGuiControlProfile; }} +private static GuiConvexEditorCtrlObject _mGuiConvexEditorCtrl; /// /// /// -public GuiDecalEditorCtrlObject GuiDecalEditorCtrl{get { return _mGuiDecalEditorCtrl; }} -public GuiEditCtrlObject _mGuiEditCtrl; +public static GuiConvexEditorCtrlObject GuiConvexEditorCtrl{get { return _mGuiConvexEditorCtrl; }} +private static GuiDecalEditorCtrlObject _mGuiDecalEditorCtrl; /// /// /// -public GuiEditCtrlObject GuiEditCtrl{get { return _mGuiEditCtrl; }} -public GuiFileTreeCtrlObject _mGuiFileTreeCtrl; +public static GuiDecalEditorCtrlObject GuiDecalEditorCtrl{get { return _mGuiDecalEditorCtrl; }} +private static GuiEditCtrlObject _mGuiEditCtrl; /// /// /// -public GuiFileTreeCtrlObject GuiFileTreeCtrl{get { return _mGuiFileTreeCtrl; }} -public GuiFilterCtrlObject _mGuiFilterCtrl; +public static GuiEditCtrlObject GuiEditCtrl{get { return _mGuiEditCtrl; }} +private static GuiFileTreeCtrlObject _mGuiFileTreeCtrl; /// /// /// -public GuiFilterCtrlObject GuiFilterCtrl{get { return _mGuiFilterCtrl; }} -public GuiGradientCtrlObject _mGuiGradientCtrl; +public static GuiFileTreeCtrlObject GuiFileTreeCtrl{get { return _mGuiFileTreeCtrl; }} +private static GuiFilterCtrlObject _mGuiFilterCtrl; /// /// /// -public GuiGradientCtrlObject GuiGradientCtrl{get { return _mGuiGradientCtrl; }} -public GuiIdleCamFadeBitmapCtrlObject _mGuiIdleCamFadeBitmapCtrl; +public static GuiFilterCtrlObject GuiFilterCtrl{get { return _mGuiFilterCtrl; }} +private static GuiGradientCtrlObject _mGuiGradientCtrl; /// /// /// -public GuiIdleCamFadeBitmapCtrlObject GuiIdleCamFadeBitmapCtrl{get { return _mGuiIdleCamFadeBitmapCtrl; }} -public GuiInspectorObject _mGuiInspector; +public static GuiGradientCtrlObject GuiGradientCtrl{get { return _mGuiGradientCtrl; }} +private static GuiIdleCamFadeBitmapCtrlObject _mGuiIdleCamFadeBitmapCtrl; /// /// /// -public GuiInspectorObject GuiInspector{get { return _mGuiInspector; }} -public GuiInspectorDynamicFieldObject _mGuiInspectorDynamicField; +public static GuiIdleCamFadeBitmapCtrlObject GuiIdleCamFadeBitmapCtrl{get { return _mGuiIdleCamFadeBitmapCtrl; }} +private static GuiInspectorObject _mGuiInspector; /// /// /// -public GuiInspectorDynamicFieldObject GuiInspectorDynamicField{get { return _mGuiInspectorDynamicField; }} -public GuiInspectorDynamicGroupObject _mGuiInspectorDynamicGroup; +public static GuiInspectorObject GuiInspector{get { return _mGuiInspector; }} +private static GuiInspectorDynamicFieldObject _mGuiInspectorDynamicField; /// /// /// -public GuiInspectorDynamicGroupObject GuiInspectorDynamicGroup{get { return _mGuiInspectorDynamicGroup; }} -public GuiInspectorFieldObject _mGuiInspectorField; +public static GuiInspectorDynamicFieldObject GuiInspectorDynamicField{get { return _mGuiInspectorDynamicField; }} +private static GuiInspectorDynamicGroupObject _mGuiInspectorDynamicGroup; /// /// /// -public GuiInspectorFieldObject GuiInspectorField{get { return _mGuiInspectorField; }} -public GuiMaterialCtrlObject _mGuiMaterialCtrl; +public static GuiInspectorDynamicGroupObject GuiInspectorDynamicGroup{get { return _mGuiInspectorDynamicGroup; }} +private static GuiInspectorFieldObject _mGuiInspectorField; /// /// /// -public GuiMaterialCtrlObject GuiMaterialCtrl{get { return _mGuiMaterialCtrl; }} -public GuiMeshRoadEditorCtrlObject _mGuiMeshRoadEditorCtrl; +public static GuiInspectorFieldObject GuiInspectorField{get { return _mGuiInspectorField; }} +private static GuiMaterialCtrlObject _mGuiMaterialCtrl; /// /// /// -public GuiMeshRoadEditorCtrlObject GuiMeshRoadEditorCtrl{get { return _mGuiMeshRoadEditorCtrl; }} -public GuiMissionAreaEditorCtrlObject _mGuiMissionAreaEditorCtrl; +public static GuiMaterialCtrlObject GuiMaterialCtrl{get { return _mGuiMaterialCtrl; }} +private static GuiMeshRoadEditorCtrlObject _mGuiMeshRoadEditorCtrl; /// /// /// -public GuiMissionAreaEditorCtrlObject GuiMissionAreaEditorCtrl{get { return _mGuiMissionAreaEditorCtrl; }} -public GuiNavEditorCtrlObject _mGuiNavEditorCtrl; +public static GuiMeshRoadEditorCtrlObject GuiMeshRoadEditorCtrl{get { return _mGuiMeshRoadEditorCtrl; }} +private static GuiMissionAreaEditorCtrlObject _mGuiMissionAreaEditorCtrl; /// /// /// -public GuiNavEditorCtrlObject GuiNavEditorCtrl{get { return _mGuiNavEditorCtrl; }} -public GuiParticleGraphCtrlObject _mGuiParticleGraphCtrl; +public static GuiMissionAreaEditorCtrlObject GuiMissionAreaEditorCtrl{get { return _mGuiMissionAreaEditorCtrl; }} +private static GuiNavEditorCtrlObject _mGuiNavEditorCtrl; /// /// /// -public GuiParticleGraphCtrlObject GuiParticleGraphCtrl{get { return _mGuiParticleGraphCtrl; }} -public GuiPopUpMenuCtrlObject _mGuiPopUpMenuCtrl; +public static GuiNavEditorCtrlObject GuiNavEditorCtrl{get { return _mGuiNavEditorCtrl; }} +private static GuiParticleGraphCtrlObject _mGuiParticleGraphCtrl; /// /// /// -public GuiPopUpMenuCtrlObject GuiPopUpMenuCtrl{get { return _mGuiPopUpMenuCtrl; }} -public GuiPopUpMenuCtrlExObject _mGuiPopUpMenuCtrlEx; +public static GuiParticleGraphCtrlObject GuiParticleGraphCtrl{get { return _mGuiParticleGraphCtrl; }} +private static GuiPopUpMenuCtrlObject _mGuiPopUpMenuCtrl; /// /// /// -public GuiPopUpMenuCtrlExObject GuiPopUpMenuCtrlEx{get { return _mGuiPopUpMenuCtrlEx; }} -public GuiRiverEditorCtrlObject _mGuiRiverEditorCtrl; +public static GuiPopUpMenuCtrlObject GuiPopUpMenuCtrl{get { return _mGuiPopUpMenuCtrl; }} +private static GuiPopUpMenuCtrlExObject _mGuiPopUpMenuCtrlEx; /// /// /// -public GuiRiverEditorCtrlObject GuiRiverEditorCtrl{get { return _mGuiRiverEditorCtrl; }} -public GuiRoadEditorCtrlObject _mGuiRoadEditorCtrl; +public static GuiPopUpMenuCtrlExObject GuiPopUpMenuCtrlEx{get { return _mGuiPopUpMenuCtrlEx; }} +private static GuiRiverEditorCtrlObject _mGuiRiverEditorCtrl; /// /// /// -public GuiRoadEditorCtrlObject GuiRoadEditorCtrl{get { return _mGuiRoadEditorCtrl; }} -public GuiTerrPreviewCtrlObject _mGuiTerrPreviewCtrl; +public static GuiRiverEditorCtrlObject GuiRiverEditorCtrl{get { return _mGuiRiverEditorCtrl; }} +private static GuiRoadEditorCtrlObject _mGuiRoadEditorCtrl; /// /// /// -public GuiTerrPreviewCtrlObject GuiTerrPreviewCtrl{get { return _mGuiTerrPreviewCtrl; }} -public GuiTextEditCtrlObject _mGuiTextEditCtrl; +public static GuiRoadEditorCtrlObject GuiRoadEditorCtrl{get { return _mGuiRoadEditorCtrl; }} +private static GuiTerrPreviewCtrlObject _mGuiTerrPreviewCtrl; /// /// /// -public GuiTextEditCtrlObject GuiTextEditCtrl{get { return _mGuiTextEditCtrl; }} -public GuiTickCtrlObject _mGuiTickCtrl; +public static GuiTerrPreviewCtrlObject GuiTerrPreviewCtrl{get { return _mGuiTerrPreviewCtrl; }} +private static GuiTextEditCtrlObject _mGuiTextEditCtrl; /// /// /// -public GuiTickCtrlObject GuiTickCtrl{get { return _mGuiTickCtrl; }} -public GuiToolboxButtonCtrlObject _mGuiToolboxButtonCtrl; +public static GuiTextEditCtrlObject GuiTextEditCtrl{get { return _mGuiTextEditCtrl; }} +private static GuiTickCtrlObject _mGuiTickCtrl; /// /// /// -public GuiToolboxButtonCtrlObject GuiToolboxButtonCtrl{get { return _mGuiToolboxButtonCtrl; }} -public GuiTreeViewCtrlObject _mGuiTreeViewCtrl; +public static GuiTickCtrlObject GuiTickCtrl{get { return _mGuiTickCtrl; }} +private static GuiToolboxButtonCtrlObject _mGuiToolboxButtonCtrl; /// /// /// -public GuiTreeViewCtrlObject GuiTreeViewCtrl{get { return _mGuiTreeViewCtrl; }} -public GuiVariableInspectorObject _mGuiVariableInspector; +public static GuiToolboxButtonCtrlObject GuiToolboxButtonCtrl{get { return _mGuiToolboxButtonCtrl; }} +private static GuiTreeViewCtrlObject _mGuiTreeViewCtrl; /// /// /// -public GuiVariableInspectorObject GuiVariableInspector{get { return _mGuiVariableInspector; }} -public LangTableObject _mLangTable; +public static GuiTreeViewCtrlObject GuiTreeViewCtrl{get { return _mGuiTreeViewCtrl; }} +private static GuiVariableInspectorObject _mGuiVariableInspector; /// /// /// -public LangTableObject LangTable{get { return _mLangTable; }} -public LightBaseObject _mLightBase; +public static GuiVariableInspectorObject GuiVariableInspector{get { return _mGuiVariableInspector; }} +private static LangTableObject _mLangTable; /// /// /// -public LightBaseObject LightBase{get { return _mLightBase; }} -public MaterialObject _mMaterial; +public static LangTableObject LangTable{get { return _mLangTable; }} +private static LightBaseObject _mLightBase; /// /// /// -public MaterialObject Material{get { return _mMaterial; }} -public MECreateUndoActionObject _mMECreateUndoAction; +public static LightBaseObject LightBase{get { return _mLightBase; }} +private static MaterialObject _mMaterial; /// /// /// -public MECreateUndoActionObject MECreateUndoAction{get { return _mMECreateUndoAction; }} -public MEDeleteUndoActionObject _mMEDeleteUndoAction; +public static MaterialObject Material{get { return _mMaterial; }} +private static MECreateUndoActionObject _mMECreateUndoAction; /// /// /// -public MEDeleteUndoActionObject MEDeleteUndoAction{get { return _mMEDeleteUndoAction; }} -public MenuBarObject _mMenuBar; +public static MECreateUndoActionObject MECreateUndoAction{get { return _mMECreateUndoAction; }} +private static MEDeleteUndoActionObject _mMEDeleteUndoAction; /// /// /// -public MenuBarObject MenuBar{get { return _mMenuBar; }} -public MessageObject _mMessage; +public static MEDeleteUndoActionObject MEDeleteUndoAction{get { return _mMEDeleteUndoAction; }} +private static MenuBarObject _mMenuBar; /// /// /// -public MessageObject Message{get { return _mMessage; }} -public MessageVectorObject _mMessageVector; +public static MenuBarObject MenuBar{get { return _mMenuBar; }} +private static MessageObject _mMessage; /// /// /// -public MessageVectorObject MessageVector{get { return _mMessageVector; }} -public PersistenceManagerObject _mPersistenceManager; +public static MessageObject Message{get { return _mMessage; }} +private static MessageVectorObject _mMessageVector; /// /// /// -public PersistenceManagerObject PersistenceManager{get { return _mPersistenceManager; }} -public PhysicsDebrisDataObject _mPhysicsDebrisData; +public static MessageVectorObject MessageVector{get { return _mMessageVector; }} +private static PersistenceManagerObject _mPersistenceManager; /// /// /// -public PhysicsDebrisDataObject PhysicsDebrisData{get { return _mPhysicsDebrisData; }} -public PopupMenuObject _mPopupMenu; +public static PersistenceManagerObject PersistenceManager{get { return _mPersistenceManager; }} +private static PhysicsDebrisDataObject _mPhysicsDebrisData; /// /// /// -public PopupMenuObject PopupMenu{get { return _mPopupMenu; }} -public ReadXMLObject _mReadXML; +public static PhysicsDebrisDataObject PhysicsDebrisData{get { return _mPhysicsDebrisData; }} +private static PopupMenuObject _mPopupMenu; /// /// /// -public ReadXMLObject ReadXML{get { return _mReadXML; }} -public SettingsObject _mSettings; +public static PopupMenuObject PopupMenu{get { return _mPopupMenu; }} +private static ReadXMLObject _mReadXML; /// /// /// -public SettingsObject Settings{get { return _mSettings; }} -public SFXSourceObject _mSFXSource; +public static ReadXMLObject ReadXML{get { return _mReadXML; }} +private static SettingsObject _mSettings; /// /// /// -public SFXSourceObject SFXSource{get { return _mSFXSource; }} -public SimComponentObject _mSimComponent; +public static SettingsObject Settings{get { return _mSettings; }} +private static SFXSourceObject _mSFXSource; /// /// /// -public SimComponentObject SimComponent{get { return _mSimComponent; }} -public SimDataBlockObject _mSimDataBlock; +public static SFXSourceObject SFXSource{get { return _mSFXSource; }} +private static SimComponentObject _mSimComponent; /// /// /// -public SimDataBlockObject SimDataBlock{get { return _mSimDataBlock; }} -public SimObjectObject _mSimObject; +public static SimComponentObject SimComponent{get { return _mSimComponent; }} +private static SimDataBlockObject _mSimDataBlock; /// /// /// -public SimObjectObject SimObject{get { return _mSimObject; }} -public SimPersistSetObject _mSimPersistSet; +public static SimDataBlockObject SimDataBlock{get { return _mSimDataBlock; }} +private static SimObjectObject _mSimObject; /// /// /// -public SimPersistSetObject SimPersistSet{get { return _mSimPersistSet; }} -public SimResponseCurveObject _mSimResponseCurve; +public static SimObjectObject SimObject{get { return _mSimObject; }} +private static SimPersistSetObject _mSimPersistSet; /// /// /// -public SimResponseCurveObject SimResponseCurve{get { return _mSimResponseCurve; }} -public SimSetObject _mSimSet; +public static SimPersistSetObject SimPersistSet{get { return _mSimPersistSet; }} +private static SimResponseCurveObject _mSimResponseCurve; /// /// /// -public SimSetObject SimSet{get { return _mSimSet; }} -public SimXMLDocumentObject _mSimXMLDocument; +public static SimResponseCurveObject SimResponseCurve{get { return _mSimResponseCurve; }} +private static SimSetObject _mSimSet; /// /// /// -public SimXMLDocumentObject SimXMLDocument{get { return _mSimXMLDocument; }} -public SkyBoxObject _mSkyBox; +public static SimSetObject SimSet{get { return _mSimSet; }} +private static SimXMLDocumentObject _mSimXMLDocument; /// /// /// -public SkyBoxObject SkyBox{get { return _mSkyBox; }} -public SpawnSphereObject _mSpawnSphere; +public static SimXMLDocumentObject SimXMLDocument{get { return _mSimXMLDocument; }} +private static SkyBoxObject _mSkyBox; /// /// /// -public SpawnSphereObject SpawnSphere{get { return _mSpawnSphere; }} -public StaticShapeObject _mStaticShape; +public static SkyBoxObject SkyBox{get { return _mSkyBox; }} +private static SpawnSphereObject _mSpawnSphere; /// /// /// -public StaticShapeObject StaticShape{get { return _mStaticShape; }} -public SunObject _mSun; +public static SpawnSphereObject SpawnSphere{get { return _mSpawnSphere; }} +private static StaticShapeObject _mStaticShape; /// /// /// -public SunObject Sun{get { return _mSun; }} -public TerrainBlockObject _mTerrainBlock; +public static StaticShapeObject StaticShape{get { return _mStaticShape; }} +private static SunObject _mSun; /// /// /// -public TerrainBlockObject TerrainBlock{get { return _mTerrainBlock; }} -public TerrainEditorObject _mTerrainEditor; +public static SunObject Sun{get { return _mSun; }} +private static TerrainBlockObject _mTerrainBlock; /// /// /// -public TerrainEditorObject TerrainEditor{get { return _mTerrainEditor; }} -public TerrainSmoothActionObject _mTerrainSmoothAction; +public static TerrainBlockObject TerrainBlock{get { return _mTerrainBlock; }} +private static TerrainEditorObject _mTerrainEditor; /// /// /// -public TerrainSmoothActionObject TerrainSmoothAction{get { return _mTerrainSmoothAction; }} -public TerrainSolderEdgesActionObject _mTerrainSolderEdgesAction; +public static TerrainEditorObject TerrainEditor{get { return _mTerrainEditor; }} +private static TerrainSmoothActionObject _mTerrainSmoothAction; /// /// /// -public TerrainSolderEdgesActionObject TerrainSolderEdgesAction{get { return _mTerrainSolderEdgesAction; }} -public TheoraTextureObjectObject _mTheoraTextureObject; +public static TerrainSmoothActionObject TerrainSmoothAction{get { return _mTerrainSmoothAction; }} +private static TerrainSolderEdgesActionObject _mTerrainSolderEdgesAction; /// /// /// -public TheoraTextureObjectObject TheoraTextureObject{get { return _mTheoraTextureObject; }} -public UndoActionObject _mUndoAction; +public static TerrainSolderEdgesActionObject TerrainSolderEdgesAction{get { return _mTerrainSolderEdgesAction; }} +private static TheoraTextureObjectObject _mTheoraTextureObject; /// /// /// -public UndoActionObject UndoAction{get { return _mUndoAction; }} -public UndoManagerObject _mUndoManager; +public static TheoraTextureObjectObject TheoraTextureObject{get { return _mTheoraTextureObject; }} +private static UndoActionObject _mUndoAction; /// /// /// -public UndoManagerObject UndoManager{get { return _mUndoManager; }} -public WorldEditorObject _mWorldEditor; +public static UndoActionObject UndoAction{get { return _mUndoAction; }} +private static UndoManagerObject _mUndoManager; /// /// /// -public WorldEditorObject WorldEditor{get { return _mWorldEditor; }} -public ActionMapObject _mActionMap; +public static UndoManagerObject UndoManager{get { return _mUndoManager; }} +private static WorldEditorObject _mWorldEditor; /// /// /// -public ActionMapObject ActionMap{get { return _mActionMap; }} -public AITurretShapeObject _mAITurretShape; +public static WorldEditorObject WorldEditor{get { return _mWorldEditor; }} +private static ActionMapObject _mActionMap; /// /// /// -public AITurretShapeObject AITurretShape{get { return _mAITurretShape; }} -public ArrayObjectObject _mArrayObject; +public static ActionMapObject ActionMap{get { return _mActionMap; }} +private static AITurretShapeObject _mAITurretShape; /// /// /// -public ArrayObjectObject ArrayObject{get { return _mArrayObject; }} -public CameraObject _mCamera; +public static AITurretShapeObject AITurretShape{get { return _mAITurretShape; }} +private static ArrayObjectObject _mArrayObject; /// /// /// -public CameraObject Camera{get { return _mCamera; }} -public CloudLayerObject _mCloudLayer; +public static ArrayObjectObject ArrayObject{get { return _mArrayObject; }} +private static CameraObject _mCamera; /// /// /// -public CloudLayerObject CloudLayer{get { return _mCloudLayer; }} -public CoverPointObject _mCoverPoint; +public static CameraObject Camera{get { return _mCamera; }} +private static CoverPointObject _mCoverPoint; /// /// /// -public CoverPointObject CoverPoint{get { return _mCoverPoint; }} -public CubemapDataObject _mCubemapData; +public static CoverPointObject CoverPoint{get { return _mCoverPoint; }} +private static CubemapDataObject _mCubemapData; /// /// /// -public CubemapDataObject CubemapData{get { return _mCubemapData; }} -public DebrisObject _mDebris; +public static CubemapDataObject CubemapData{get { return _mCubemapData; }} +private static DebrisObject _mDebris; /// /// /// -public DebrisObject Debris{get { return _mDebris; }} -public DebugDrawerObject _mDebugDrawer; +public static DebrisObject Debris{get { return _mDebris; }} +private static DebugDrawerObject _mDebugDrawer; /// /// /// -public DebugDrawerObject DebugDrawer{get { return _mDebugDrawer; }} -public DecalDataObject _mDecalData; +public static DebugDrawerObject DebugDrawer{get { return _mDebugDrawer; }} +private static DecalDataObject _mDecalData; /// /// /// -public DecalDataObject DecalData{get { return _mDecalData; }} -public DecalRoadObject _mDecalRoad; +public static DecalDataObject DecalData{get { return _mDecalData; }} +private static DecalRoadObject _mDecalRoad; /// /// /// -public DecalRoadObject DecalRoad{get { return _mDecalRoad; }} -public DynamicConsoleMethodComponentObject _mDynamicConsoleMethodComponent; +public static DecalRoadObject DecalRoad{get { return _mDecalRoad; }} +private static DynamicConsoleMethodComponentObject _mDynamicConsoleMethodComponent; /// /// /// -public DynamicConsoleMethodComponentObject DynamicConsoleMethodComponent{get { return _mDynamicConsoleMethodComponent; }} -public EditTSCtrlObject _mEditTSCtrl; +public static DynamicConsoleMethodComponentObject DynamicConsoleMethodComponent{get { return _mDynamicConsoleMethodComponent; }} +private static EditTSCtrlObject _mEditTSCtrl; /// /// /// -public EditTSCtrlObject EditTSCtrl{get { return _mEditTSCtrl; }} -public FileDialogObject _mFileDialog; +public static EditTSCtrlObject EditTSCtrl{get { return _mEditTSCtrl; }} +private static FileDialogObject _mFileDialog; /// /// /// -public FileDialogObject FileDialog{get { return _mFileDialog; }} -public FileStreamObjectObject _mFileStreamObject; +public static FileDialogObject FileDialog{get { return _mFileDialog; }} +private static FileStreamObjectObject _mFileStreamObject; /// /// /// -public FileStreamObjectObject FileStreamObject{get { return _mFileStreamObject; }} -public FlyingVehicleObject _mFlyingVehicle; +public static FileStreamObjectObject FileStreamObject{get { return _mFileStreamObject; }} +private static FlyingVehicleObject _mFlyingVehicle; /// /// /// -public FlyingVehicleObject FlyingVehicle{get { return _mFlyingVehicle; }} -public ForestWindEmitterObject _mForestWindEmitter; +public static FlyingVehicleObject FlyingVehicle{get { return _mFlyingVehicle; }} +private static ForestWindEmitterObject _mForestWindEmitter; /// /// /// -public ForestWindEmitterObject ForestWindEmitter{get { return _mForestWindEmitter; }} -public GameBaseObject _mGameBase; +public static ForestWindEmitterObject ForestWindEmitter{get { return _mForestWindEmitter; }} +private static GameBaseObject _mGameBase; /// /// /// -public GameBaseObject GameBase{get { return _mGameBase; }} -public GameConnectionObject _mGameConnection; +public static GameBaseObject GameBase{get { return _mGameBase; }} +private static GameConnectionObject _mGameConnection; /// /// /// -public GameConnectionObject GameConnection{get { return _mGameConnection; }} -public GroundPlaneObject _mGroundPlane; +public static GameConnectionObject GameConnection{get { return _mGameConnection; }} +private static GroundPlaneObject _mGroundPlane; /// /// /// -public GroundPlaneObject GroundPlane{get { return _mGroundPlane; }} -public GuiAutoCompleteCtrlObject _mGuiAutoCompleteCtrl; +public static GroundPlaneObject GroundPlane{get { return _mGroundPlane; }} +private static GuiAutoCompleteCtrlObject _mGuiAutoCompleteCtrl; /// /// /// -public GuiAutoCompleteCtrlObject GuiAutoCompleteCtrl{get { return _mGuiAutoCompleteCtrl; }} -public GuiAutoScrollCtrlObject _mGuiAutoScrollCtrl; +public static GuiAutoCompleteCtrlObject GuiAutoCompleteCtrl{get { return _mGuiAutoCompleteCtrl; }} +private static GuiAutoScrollCtrlObject _mGuiAutoScrollCtrl; /// /// /// -public GuiAutoScrollCtrlObject GuiAutoScrollCtrl{get { return _mGuiAutoScrollCtrl; }} -public GuiBitmapButtonCtrlObject _mGuiBitmapButtonCtrl; +public static GuiAutoScrollCtrlObject GuiAutoScrollCtrl{get { return _mGuiAutoScrollCtrl; }} +private static GuiBitmapButtonCtrlObject _mGuiBitmapButtonCtrl; /// /// /// -public GuiBitmapButtonCtrlObject GuiBitmapButtonCtrl{get { return _mGuiBitmapButtonCtrl; }} -public GuiButtonBaseCtrlObject _mGuiButtonBaseCtrl; +public static GuiBitmapButtonCtrlObject GuiBitmapButtonCtrl{get { return _mGuiBitmapButtonCtrl; }} +private static GuiButtonBaseCtrlObject _mGuiButtonBaseCtrl; /// /// /// -public GuiButtonBaseCtrlObject GuiButtonBaseCtrl{get { return _mGuiButtonBaseCtrl; }} -public GuiCheckBoxCtrlObject _mGuiCheckBoxCtrl; +public static GuiButtonBaseCtrlObject GuiButtonBaseCtrl{get { return _mGuiButtonBaseCtrl; }} +private static GuiCheckBoxCtrlObject _mGuiCheckBoxCtrl; /// /// /// -public GuiCheckBoxCtrlObject GuiCheckBoxCtrl{get { return _mGuiCheckBoxCtrl; }} -public GuiChunkedBitmapCtrlObject _mGuiChunkedBitmapCtrl; +public static GuiCheckBoxCtrlObject GuiCheckBoxCtrl{get { return _mGuiCheckBoxCtrl; }} +private static GuiChunkedBitmapCtrlObject _mGuiChunkedBitmapCtrl; /// /// /// -public GuiChunkedBitmapCtrlObject GuiChunkedBitmapCtrl{get { return _mGuiChunkedBitmapCtrl; }} -public GuiClockHudObject _mGuiClockHud; +public static GuiChunkedBitmapCtrlObject GuiChunkedBitmapCtrl{get { return _mGuiChunkedBitmapCtrl; }} +private static GuiClockHudObject _mGuiClockHud; /// /// /// -public GuiClockHudObject GuiClockHud{get { return _mGuiClockHud; }} -public GuiDirectoryFileListCtrlObject _mGuiDirectoryFileListCtrl; +public static GuiClockHudObject GuiClockHud{get { return _mGuiClockHud; }} +private static GuiDirectoryFileListCtrlObject _mGuiDirectoryFileListCtrl; /// /// /// -public GuiDirectoryFileListCtrlObject GuiDirectoryFileListCtrl{get { return _mGuiDirectoryFileListCtrl; }} -public GuiDragAndDropControlObject _mGuiDragAndDropControl; +public static GuiDirectoryFileListCtrlObject GuiDirectoryFileListCtrl{get { return _mGuiDirectoryFileListCtrl; }} +private static GuiDragAndDropControlObject _mGuiDragAndDropControl; /// /// /// -public GuiDragAndDropControlObject GuiDragAndDropControl{get { return _mGuiDragAndDropControl; }} -public GuiDynamicCtrlArrayControlObject _mGuiDynamicCtrlArrayControl; +public static GuiDragAndDropControlObject GuiDragAndDropControl{get { return _mGuiDragAndDropControl; }} +private static GuiDynamicCtrlArrayControlObject _mGuiDynamicCtrlArrayControl; /// /// /// -public GuiDynamicCtrlArrayControlObject GuiDynamicCtrlArrayControl{get { return _mGuiDynamicCtrlArrayControl; }} -public GuiFormCtrlObject _mGuiFormCtrl; +public static GuiDynamicCtrlArrayControlObject GuiDynamicCtrlArrayControl{get { return _mGuiDynamicCtrlArrayControl; }} +private static GuiFormCtrlObject _mGuiFormCtrl; /// /// /// -public GuiFormCtrlObject GuiFormCtrl{get { return _mGuiFormCtrl; }} -public GuiFrameSetCtrlObject _mGuiFrameSetCtrl; +public static GuiFormCtrlObject GuiFormCtrl{get { return _mGuiFormCtrl; }} +private static GuiFrameSetCtrlObject _mGuiFrameSetCtrl; /// /// /// -public GuiFrameSetCtrlObject GuiFrameSetCtrl{get { return _mGuiFrameSetCtrl; }} -public GuiGameListMenuCtrlObject _mGuiGameListMenuCtrl; +public static GuiFrameSetCtrlObject GuiFrameSetCtrl{get { return _mGuiFrameSetCtrl; }} +private static GuiGameListMenuCtrlObject _mGuiGameListMenuCtrl; /// /// /// -public GuiGameListMenuCtrlObject GuiGameListMenuCtrl{get { return _mGuiGameListMenuCtrl; }} -public GuiGameListOptionsCtrlObject _mGuiGameListOptionsCtrl; +public static GuiGameListMenuCtrlObject GuiGameListMenuCtrl{get { return _mGuiGameListMenuCtrl; }} +private static GuiGameListOptionsCtrlObject _mGuiGameListOptionsCtrl; /// /// /// -public GuiGameListOptionsCtrlObject GuiGameListOptionsCtrl{get { return _mGuiGameListOptionsCtrl; }} -public GuiGraphCtrlObject _mGuiGraphCtrl; +public static GuiGameListOptionsCtrlObject GuiGameListOptionsCtrl{get { return _mGuiGameListOptionsCtrl; }} +private static GuiGraphCtrlObject _mGuiGraphCtrl; /// /// /// -public GuiGraphCtrlObject GuiGraphCtrl{get { return _mGuiGraphCtrl; }} -public GuiIconButtonCtrlObject _mGuiIconButtonCtrl; +public static GuiGraphCtrlObject GuiGraphCtrl{get { return _mGuiGraphCtrl; }} +private static GuiIconButtonCtrlObject _mGuiIconButtonCtrl; /// /// /// -public GuiIconButtonCtrlObject GuiIconButtonCtrl{get { return _mGuiIconButtonCtrl; }} -public GuiImageListObject _mGuiImageList; +public static GuiIconButtonCtrlObject GuiIconButtonCtrl{get { return _mGuiIconButtonCtrl; }} +private static GuiImageListObject _mGuiImageList; /// /// /// -public GuiImageListObject GuiImageList{get { return _mGuiImageList; }} -public GuiInspectorTypeBitMask32Object _mGuiInspectorTypeBitMask32; +public static GuiImageListObject GuiImageList{get { return _mGuiImageList; }} +private static GuiInspectorTypeBitMask32Object _mGuiInspectorTypeBitMask32; /// /// /// -public GuiInspectorTypeBitMask32Object GuiInspectorTypeBitMask32{get { return _mGuiInspectorTypeBitMask32; }} -public GuiInspectorTypeFileNameObject _mGuiInspectorTypeFileName; +public static GuiInspectorTypeBitMask32Object GuiInspectorTypeBitMask32{get { return _mGuiInspectorTypeBitMask32; }} +private static GuiInspectorTypeFileNameObject _mGuiInspectorTypeFileName; /// /// /// -public GuiInspectorTypeFileNameObject GuiInspectorTypeFileName{get { return _mGuiInspectorTypeFileName; }} -public GuiListBoxCtrlObject _mGuiListBoxCtrl; +public static GuiInspectorTypeFileNameObject GuiInspectorTypeFileName{get { return _mGuiInspectorTypeFileName; }} +private static GuiListBoxCtrlObject _mGuiListBoxCtrl; /// /// /// -public GuiListBoxCtrlObject GuiListBoxCtrl{get { return _mGuiListBoxCtrl; }} -public GuiMaterialPreviewObject _mGuiMaterialPreview; +public static GuiListBoxCtrlObject GuiListBoxCtrl{get { return _mGuiListBoxCtrl; }} +private static GuiMaterialPreviewObject _mGuiMaterialPreview; /// /// /// -public GuiMaterialPreviewObject GuiMaterialPreview{get { return _mGuiMaterialPreview; }} -public GuiMenuBarObject _mGuiMenuBar; +public static GuiMaterialPreviewObject GuiMaterialPreview{get { return _mGuiMaterialPreview; }} +private static GuiMenuBarObject _mGuiMenuBar; /// /// /// -public GuiMenuBarObject GuiMenuBar{get { return _mGuiMenuBar; }} -public GuiMessageVectorCtrlObject _mGuiMessageVectorCtrl; +public static GuiMenuBarObject GuiMenuBar{get { return _mGuiMenuBar; }} +private static GuiMessageVectorCtrlObject _mGuiMessageVectorCtrl; /// /// /// -public GuiMessageVectorCtrlObject GuiMessageVectorCtrl{get { return _mGuiMessageVectorCtrl; }} -public GuiMissionAreaCtrlObject _mGuiMissionAreaCtrl; +public static GuiMessageVectorCtrlObject GuiMessageVectorCtrl{get { return _mGuiMessageVectorCtrl; }} +private static GuiMissionAreaCtrlObject _mGuiMissionAreaCtrl; /// /// /// -public GuiMissionAreaCtrlObject GuiMissionAreaCtrl{get { return _mGuiMissionAreaCtrl; }} -public GuiMLTextCtrlObject _mGuiMLTextCtrl; +public static GuiMissionAreaCtrlObject GuiMissionAreaCtrl{get { return _mGuiMissionAreaCtrl; }} +private static GuiMLTextCtrlObject _mGuiMLTextCtrl; /// /// /// -public GuiMLTextCtrlObject GuiMLTextCtrl{get { return _mGuiMLTextCtrl; }} -public GuiObjectViewObject _mGuiObjectView; +public static GuiMLTextCtrlObject GuiMLTextCtrl{get { return _mGuiMLTextCtrl; }} +private static GuiObjectViewObject _mGuiObjectView; /// /// /// -public GuiObjectViewObject GuiObjectView{get { return _mGuiObjectView; }} -public GuiPaneControlObject _mGuiPaneControl; +public static GuiObjectViewObject GuiObjectView{get { return _mGuiObjectView; }} +private static GuiPaneControlObject _mGuiPaneControl; /// /// /// -public GuiPaneControlObject GuiPaneControl{get { return _mGuiPaneControl; }} -public GuiProgressBitmapCtrlObject _mGuiProgressBitmapCtrl; +public static GuiPaneControlObject GuiPaneControl{get { return _mGuiPaneControl; }} +private static GuiProgressBitmapCtrlObject _mGuiProgressBitmapCtrl; /// /// /// -public GuiProgressBitmapCtrlObject GuiProgressBitmapCtrl{get { return _mGuiProgressBitmapCtrl; }} -public GuiRolloutCtrlObject _mGuiRolloutCtrl; +public static GuiProgressBitmapCtrlObject GuiProgressBitmapCtrl{get { return _mGuiProgressBitmapCtrl; }} +private static GuiRolloutCtrlObject _mGuiRolloutCtrl; /// /// /// -public GuiRolloutCtrlObject GuiRolloutCtrl{get { return _mGuiRolloutCtrl; }} -public GuiScrollCtrlObject _mGuiScrollCtrl; +public static GuiRolloutCtrlObject GuiRolloutCtrl{get { return _mGuiRolloutCtrl; }} +private static GuiScrollCtrlObject _mGuiScrollCtrl; /// /// /// -public GuiScrollCtrlObject GuiScrollCtrl{get { return _mGuiScrollCtrl; }} -public GuiShapeEdPreviewObject _mGuiShapeEdPreview; +public static GuiScrollCtrlObject GuiScrollCtrl{get { return _mGuiScrollCtrl; }} +private static GuiShapeEdPreviewObject _mGuiShapeEdPreview; /// /// /// -public GuiShapeEdPreviewObject GuiShapeEdPreview{get { return _mGuiShapeEdPreview; }} -public GuiSliderCtrlObject _mGuiSliderCtrl; +public static GuiShapeEdPreviewObject GuiShapeEdPreview{get { return _mGuiShapeEdPreview; }} +private static GuiSliderCtrlObject _mGuiSliderCtrl; /// /// /// -public GuiSliderCtrlObject GuiSliderCtrl{get { return _mGuiSliderCtrl; }} -public GuiStackControlObject _mGuiStackControl; +public static GuiSliderCtrlObject GuiSliderCtrl{get { return _mGuiSliderCtrl; }} +private static GuiStackControlObject _mGuiStackControl; /// /// /// -public GuiStackControlObject GuiStackControl{get { return _mGuiStackControl; }} -public GuiSwatchButtonCtrlObject _mGuiSwatchButtonCtrl; +public static GuiStackControlObject GuiStackControl{get { return _mGuiStackControl; }} +private static GuiSwatchButtonCtrlObject _mGuiSwatchButtonCtrl; /// /// /// -public GuiSwatchButtonCtrlObject GuiSwatchButtonCtrl{get { return _mGuiSwatchButtonCtrl; }} -public GuiTabBookCtrlObject _mGuiTabBookCtrl; +public static GuiSwatchButtonCtrlObject GuiSwatchButtonCtrl{get { return _mGuiSwatchButtonCtrl; }} +private static GuiTabBookCtrlObject _mGuiTabBookCtrl; /// /// /// -public GuiTabBookCtrlObject GuiTabBookCtrl{get { return _mGuiTabBookCtrl; }} -public GuiTableControlObject _mGuiTableControl; +public static GuiTabBookCtrlObject GuiTabBookCtrl{get { return _mGuiTabBookCtrl; }} +private static GuiTableControlObject _mGuiTableControl; /// /// /// -public GuiTableControlObject GuiTableControl{get { return _mGuiTableControl; }} -public GuiTabPageCtrlObject _mGuiTabPageCtrl; +public static GuiTableControlObject GuiTableControl{get { return _mGuiTableControl; }} +private static GuiTabPageCtrlObject _mGuiTabPageCtrl; /// /// /// -public GuiTabPageCtrlObject GuiTabPageCtrl{get { return _mGuiTabPageCtrl; }} -public GuiTextCtrlObject _mGuiTextCtrl; +public static GuiTabPageCtrlObject GuiTabPageCtrl{get { return _mGuiTabPageCtrl; }} +private static GuiTextCtrlObject _mGuiTextCtrl; /// /// /// -public GuiTextCtrlObject GuiTextCtrl{get { return _mGuiTextCtrl; }} -public GuiTextListCtrlObject _mGuiTextListCtrl; +public static GuiTextCtrlObject GuiTextCtrl{get { return _mGuiTextCtrl; }} +private static GuiTextListCtrlObject _mGuiTextListCtrl; /// /// /// -public GuiTextListCtrlObject GuiTextListCtrl{get { return _mGuiTextListCtrl; }} -public GuiTheoraCtrlObject _mGuiTheoraCtrl; +public static GuiTextListCtrlObject GuiTextListCtrl{get { return _mGuiTextListCtrl; }} +private static GuiTheoraCtrlObject _mGuiTheoraCtrl; /// /// /// -public GuiTheoraCtrlObject GuiTheoraCtrl{get { return _mGuiTheoraCtrl; }} -public GuiTSCtrlObject _mGuiTSCtrl; +public static GuiTheoraCtrlObject GuiTheoraCtrl{get { return _mGuiTheoraCtrl; }} +private static GuiTSCtrlObject _mGuiTSCtrl; /// /// /// -public GuiTSCtrlObject GuiTSCtrl{get { return _mGuiTSCtrl; }} -public GuiWindowCtrlObject _mGuiWindowCtrl; +public static GuiTSCtrlObject GuiTSCtrl{get { return _mGuiTSCtrl; }} +private static GuiWindowCtrlObject _mGuiWindowCtrl; /// /// /// -public GuiWindowCtrlObject GuiWindowCtrl{get { return _mGuiWindowCtrl; }} -public HTTPObjectObject _mHTTPObject; +public static GuiWindowCtrlObject GuiWindowCtrl{get { return _mGuiWindowCtrl; }} +private static HTTPObjectObject _mHTTPObject; /// /// /// -public HTTPObjectObject HTTPObject{get { return _mHTTPObject; }} -public ItemObject _mItem; +public static HTTPObjectObject HTTPObject{get { return _mHTTPObject; }} +private static ItemObject _mItem; /// /// /// -public ItemObject Item{get { return _mItem; }} -public LevelInfoObject _mLevelInfo; +public static ItemObject Item{get { return _mItem; }} +private static LevelInfoObject _mLevelInfo; /// /// /// -public LevelInfoObject LevelInfo{get { return _mLevelInfo; }} -public LightDescriptionObject _mLightDescription; +public static LevelInfoObject LevelInfo{get { return _mLevelInfo; }} +private static LightDescriptionObject _mLightDescription; /// /// /// -public LightDescriptionObject LightDescription{get { return _mLightDescription; }} -public LightFlareDataObject _mLightFlareData; +public static LightDescriptionObject LightDescription{get { return _mLightDescription; }} +private static LightFlareDataObject _mLightFlareData; /// /// /// -public LightFlareDataObject LightFlareData{get { return _mLightFlareData; }} -public LightningObject _mLightning; +public static LightFlareDataObject LightFlareData{get { return _mLightFlareData; }} +private static LightningObject _mLightning; /// /// /// -public LightningObject Lightning{get { return _mLightning; }} -public MeshRoadObject _mMeshRoad; +public static LightningObject Lightning{get { return _mLightning; }} +private static MeshRoadObject _mMeshRoad; /// /// /// -public MeshRoadObject MeshRoad{get { return _mMeshRoad; }} -public MissionAreaObject _mMissionArea; +public static MeshRoadObject MeshRoad{get { return _mMeshRoad; }} +private static MissionAreaObject _mMissionArea; /// /// /// -public MissionAreaObject MissionArea{get { return _mMissionArea; }} -public NavMeshObject _mNavMesh; +public static MissionAreaObject MissionArea{get { return _mMissionArea; }} +private static NavMeshObject _mNavMesh; /// /// /// -public NavMeshObject NavMesh{get { return _mNavMesh; }} -public NavPathObject _mNavPath; +public static NavMeshObject NavMesh{get { return _mNavMesh; }} +private static NavPathObject _mNavPath; /// /// /// -public NavPathObject NavPath{get { return _mNavPath; }} -public NetConnectionObject _mNetConnection; +public static NavPathObject NavPath{get { return _mNavPath; }} +private static NetConnectionObject _mNetConnection; /// /// /// -public NetConnectionObject NetConnection{get { return _mNetConnection; }} -public NetObjectObject _mNetObject; +public static NetConnectionObject NetConnection{get { return _mNetConnection; }} +private static NetObjectObject _mNetObject; /// /// /// -public NetObjectObject NetObject{get { return _mNetObject; }} -public ParticleDataObject _mParticleData; +public static NetObjectObject NetObject{get { return _mNetObject; }} +private static ParticleDataObject _mParticleData; /// /// /// -public ParticleDataObject ParticleData{get { return _mParticleData; }} -public ParticleEmitterDataObject _mParticleEmitterData; +public static ParticleDataObject ParticleData{get { return _mParticleData; }} +private static ParticleEmitterDataObject _mParticleEmitterData; /// /// /// -public ParticleEmitterDataObject ParticleEmitterData{get { return _mParticleEmitterData; }} -public ParticleEmitterNodeObject _mParticleEmitterNode; +public static ParticleEmitterDataObject ParticleEmitterData{get { return _mParticleEmitterData; }} +private static ParticleEmitterNodeObject _mParticleEmitterNode; /// /// /// -public ParticleEmitterNodeObject ParticleEmitterNode{get { return _mParticleEmitterNode; }} -public PathCameraObject _mPathCamera; +public static ParticleEmitterNodeObject ParticleEmitterNode{get { return _mParticleEmitterNode; }} +private static PathCameraObject _mPathCamera; /// /// /// -public PathCameraObject PathCamera{get { return _mPathCamera; }} -public PhysicalZoneObject _mPhysicalZone; +public static PathCameraObject PathCamera{get { return _mPathCamera; }} +private static PhysicalZoneObject _mPhysicalZone; /// /// /// -public PhysicalZoneObject PhysicalZone{get { return _mPhysicalZone; }} -public PhysicsForceObject _mPhysicsForce; +public static PhysicalZoneObject PhysicalZone{get { return _mPhysicalZone; }} +private static PhysicsForceObject _mPhysicsForce; /// /// /// -public PhysicsForceObject PhysicsForce{get { return _mPhysicsForce; }} -public PhysicsShapeObject _mPhysicsShape; +public static PhysicsForceObject PhysicsForce{get { return _mPhysicsForce; }} +private static PhysicsShapeObject _mPhysicsShape; /// /// /// -public PhysicsShapeObject PhysicsShape{get { return _mPhysicsShape; }} -public PlayerObject _mPlayer; +public static PhysicsShapeObject PhysicsShape{get { return _mPhysicsShape; }} +private static PlayerObject _mPlayer; /// /// /// -public PlayerObject Player{get { return _mPlayer; }} -public PortalObject _mPortal; +public static PlayerObject Player{get { return _mPlayer; }} +private static PortalObject _mPortal; /// /// /// -public PortalObject Portal{get { return _mPortal; }} -public PostEffectObject _mPostEffect; +public static PortalObject Portal{get { return _mPortal; }} +private static PostEffectObject _mPostEffect; /// /// /// -public PostEffectObject PostEffect{get { return _mPostEffect; }} -public PrecipitationObject _mPrecipitation; +public static PostEffectObject PostEffect{get { return _mPostEffect; }} +private static PrecipitationObject _mPrecipitation; /// /// /// -public PrecipitationObject Precipitation{get { return _mPrecipitation; }} -public ProjectileObject _mProjectile; +public static PrecipitationObject Precipitation{get { return _mPrecipitation; }} +private static ProjectileObject _mProjectile; /// /// /// -public ProjectileObject Projectile{get { return _mProjectile; }} -public ProximityMineObject _mProximityMine; +public static ProjectileObject Projectile{get { return _mProjectile; }} +private static ProximityMineObject _mProximityMine; /// /// /// -public ProximityMineObject ProximityMine{get { return _mProximityMine; }} -public RenderBinManagerObject _mRenderBinManager; +public static ProximityMineObject ProximityMine{get { return _mProximityMine; }} +private static RenderBinManagerObject _mRenderBinManager; /// /// /// -public RenderBinManagerObject RenderBinManager{get { return _mRenderBinManager; }} -public RenderMeshExampleObject _mRenderMeshExample; +public static RenderBinManagerObject RenderBinManager{get { return _mRenderBinManager; }} +private static RenderMeshExampleObject _mRenderMeshExample; /// /// /// -public RenderMeshExampleObject RenderMeshExample{get { return _mRenderMeshExample; }} -public RenderPassManagerObject _mRenderPassManager; +public static RenderMeshExampleObject RenderMeshExample{get { return _mRenderMeshExample; }} +private static RenderPassManagerObject _mRenderPassManager; /// /// /// -public RenderPassManagerObject RenderPassManager{get { return _mRenderPassManager; }} -public RenderPassStateTokenObject _mRenderPassStateToken; +public static RenderPassManagerObject RenderPassManager{get { return _mRenderPassManager; }} +private static RenderPassStateTokenObject _mRenderPassStateToken; /// /// /// -public RenderPassStateTokenObject RenderPassStateToken{get { return _mRenderPassStateToken; }} -public RigidShapeObject _mRigidShape; +public static RenderPassStateTokenObject RenderPassStateToken{get { return _mRenderPassStateToken; }} +private static RigidShapeObject _mRigidShape; /// /// /// -public RigidShapeObject RigidShape{get { return _mRigidShape; }} -public RiverObject _mRiver; +public static RigidShapeObject RigidShape{get { return _mRigidShape; }} +private static RiverObject _mRiver; /// /// /// -public RiverObject River{get { return _mRiver; }} -public ScatterSkyObject _mScatterSky; +public static RiverObject River{get { return _mRiver; }} +private static ScatterSkyObject _mScatterSky; /// /// /// -public ScatterSkyObject ScatterSky{get { return _mScatterSky; }} -public SceneObjectObject _mSceneObject; +public static ScatterSkyObject ScatterSky{get { return _mScatterSky; }} +private static SceneObjectObject _mSceneObject; /// /// /// -public SceneObjectObject SceneObject{get { return _mSceneObject; }} -public ScriptTickObjectObject _mScriptTickObject; +public static SceneObjectObject SceneObject{get { return _mSceneObject; }} +private static ScriptTickObjectObject _mScriptTickObject; /// /// /// -public ScriptTickObjectObject ScriptTickObject{get { return _mScriptTickObject; }} -public SFXControllerObject _mSFXController; +public static ScriptTickObjectObject ScriptTickObject{get { return _mScriptTickObject; }} +private static SFXControllerObject _mSFXController; /// /// /// -public SFXControllerObject SFXController{get { return _mSFXController; }} -public SFXEmitterObject _mSFXEmitter; +public static SFXControllerObject SFXController{get { return _mSFXController; }} +private static SFXEmitterObject _mSFXEmitter; /// /// /// -public SFXEmitterObject SFXEmitter{get { return _mSFXEmitter; }} -public SFXParameterObject _mSFXParameter; +public static SFXEmitterObject SFXEmitter{get { return _mSFXEmitter; }} +private static SFXParameterObject _mSFXParameter; /// /// /// -public SFXParameterObject SFXParameter{get { return _mSFXParameter; }} -public SFXProfileObject _mSFXProfile; +public static SFXParameterObject SFXParameter{get { return _mSFXParameter; }} +private static SFXProfileObject _mSFXProfile; /// /// /// -public SFXProfileObject SFXProfile{get { return _mSFXProfile; }} -public SFXSoundObject _mSFXSound; +public static SFXProfileObject SFXProfile{get { return _mSFXProfile; }} +private static SFXSoundObject _mSFXSound; /// /// /// -public SFXSoundObject SFXSound{get { return _mSFXSound; }} -public SFXStateObject _mSFXState; +public static SFXSoundObject SFXSound{get { return _mSFXSound; }} +private static SFXStateObject _mSFXState; /// /// /// -public SFXStateObject SFXState{get { return _mSFXState; }} -public ShaderDataObject _mShaderData; +public static SFXStateObject SFXState{get { return _mSFXState; }} +private static ShaderDataObject _mShaderData; /// /// /// -public ShaderDataObject ShaderData{get { return _mShaderData; }} -public ShapeBaseObject _mShapeBase; +public static ShaderDataObject ShaderData{get { return _mShaderData; }} +private static ShapeBaseObject _mShapeBase; /// /// /// -public ShapeBaseObject ShapeBase{get { return _mShapeBase; }} -public ShapeBaseDataObject _mShapeBaseData; +public static ShapeBaseObject ShapeBase{get { return _mShapeBase; }} +private static ShapeBaseDataObject _mShapeBaseData; /// /// /// -public ShapeBaseDataObject ShapeBaseData{get { return _mShapeBaseData; }} -public SimpleNetObjectObject _mSimpleNetObject; +public static ShapeBaseDataObject ShapeBaseData{get { return _mShapeBaseData; }} +private static SimpleNetObjectObject _mSimpleNetObject; /// /// /// -public SimpleNetObjectObject SimpleNetObject{get { return _mSimpleNetObject; }} -public StreamObjectObject _mStreamObject; +public static SimpleNetObjectObject SimpleNetObject{get { return _mSimpleNetObject; }} +private static StreamObjectObject _mStreamObject; /// /// /// -public StreamObjectObject StreamObject{get { return _mStreamObject; }} -public TCPObjectObject _mTCPObject; +public static StreamObjectObject StreamObject{get { return _mStreamObject; }} +private static TCPObjectObject _mTCPObject; /// /// /// -public TCPObjectObject TCPObject{get { return _mTCPObject; }} -public TimeOfDayObject _mTimeOfDay; +public static TCPObjectObject TCPObject{get { return _mTCPObject; }} +private static TimeOfDayObject _mTimeOfDay; /// /// /// -public TimeOfDayObject TimeOfDay{get { return _mTimeOfDay; }} -public TriggerObject _mTrigger; +public static TimeOfDayObject TimeOfDay{get { return _mTimeOfDay; }} +private static TriggerObject _mTrigger; /// /// /// -public TriggerObject Trigger{get { return _mTrigger; }} -public TSAttachableObject _mTSAttachable; +public static TriggerObject Trigger{get { return _mTrigger; }} +private static TSAttachableObject _mTSAttachable; /// /// /// -public TSAttachableObject TSAttachable{get { return _mTSAttachable; }} -public TSDynamicObject _mTSDynamic; +public static TSAttachableObject TSAttachable{get { return _mTSAttachable; }} +private static TSDynamicObject _mTSDynamic; /// /// /// -public TSDynamicObject TSDynamic{get { return _mTSDynamic; }} -public TSPathShapeObject _mTSPathShape; +public static TSDynamicObject TSDynamic{get { return _mTSDynamic; }} +private static TSPathShapeObject _mTSPathShape; /// /// /// -public TSPathShapeObject TSPathShape{get { return _mTSPathShape; }} -public TSShapeConstructorObject _mTSShapeConstructor; +public static TSPathShapeObject TSPathShape{get { return _mTSPathShape; }} +private static TSShapeConstructorObject _mTSShapeConstructor; /// /// /// -public TSShapeConstructorObject TSShapeConstructor{get { return _mTSShapeConstructor; }} -public TSStaticObject _mTSStatic; +public static TSShapeConstructorObject TSShapeConstructor{get { return _mTSShapeConstructor; }} +private static TSStaticObject _mTSStatic; /// /// /// -public TSStaticObject TSStatic{get { return _mTSStatic; }} -public TurretShapeObject _mTurretShape; +public static TSStaticObject TSStatic{get { return _mTSStatic; }} +private static TurretShapeObject _mTurretShape; /// /// /// -public TurretShapeObject TurretShape{get { return _mTurretShape; }} -public VolumetricFogObject _mVolumetricFog; +public static TurretShapeObject TurretShape{get { return _mTurretShape; }} +private static VolumetricFogObject _mVolumetricFog; /// /// /// -public VolumetricFogObject VolumetricFog{get { return _mVolumetricFog; }} -public WalkableShapeObject _mWalkableShape; +public static VolumetricFogObject VolumetricFog{get { return _mVolumetricFog; }} +private static WalkableShapeObject _mWalkableShape; /// /// /// -public WalkableShapeObject WalkableShape{get { return _mWalkableShape; }} -public WheeledVehicleObject _mWheeledVehicle; +public static WalkableShapeObject WalkableShape{get { return _mWalkableShape; }} +private static WheeledVehicleObject _mWheeledVehicle; /// /// /// -public WheeledVehicleObject WheeledVehicle{get { return _mWheeledVehicle; }} -public WorldEditorSelectionObject _mWorldEditorSelection; +public static WheeledVehicleObject WheeledVehicle{get { return _mWheeledVehicle; }} +private static WorldEditorSelectionObject _mWorldEditorSelection; /// /// /// -public WorldEditorSelectionObject WorldEditorSelection{get { return _mWorldEditorSelection; }} -public ZipObjectObject _mZipObject; +public static WorldEditorSelectionObject WorldEditorSelection{get { return _mWorldEditorSelection; }} +private static ZipObjectObject _mZipObject; /// /// /// -public ZipObjectObject ZipObject{get { return _mZipObject; }} -public ZoneObject _mZone; +public static ZipObjectObject ZipObject{get { return _mZipObject; }} +private static ZoneObject _mZone; /// /// /// -public ZoneObject Zone{get { return _mZone; }} +public static ZoneObject Zone{get { return _mZone; }} /// /// /// public class UtilObject { -private Omni m_ts; - /// - /// - /// - /// -public UtilObject(ref Omni ts){m_ts = ts;} /// -/// (aiConnect, S32 , 2, 20, (...) @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. @returns The newly created AIConnection @see GameConnection for parameter information @ingroup AI) +/// (aiConnect, S32 , 2, 20, (...) +/// @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. +/// @returns The newly created AIConnection +/// @see GameConnection for parameter information +/// @ingroup AI) +/// /// public int _aiConnect(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2519,7 +2487,37 @@ public int _aiConnect(string a1, string a2= "", string a3= "", string a4= "", s return m_ts.fn__aiConnect(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( buildTaggedString, const char*, 2, 11, (string format, ...) @brief Build a string using the specified tagged string format. This function takes an already tagged string (passed in as a tagged string ID) and one or more additional strings. If the tagged string contains argument tags that range from %%1 through %%9, then each additional string will be substituted into the tagged string. The final (non-tagged) combined string will be returned. The maximum length of the tagged string plus any inserted additional strings is 511 characters. @param format A tagged string ID that contains zero or more argument tags, in the form of %%1 through %%9. @param ... A variable number of arguments that are insterted into the tagged string based on the argument tags within the format string. @returns An ordinary string that is a combination of the original tagged string with any additional strings passed in inserted in place of each argument tag. @tsexample // Create a tagged string with argument tags %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); // Some point later, combine the tagged string with some other string %string = buildTaggedString(%taggedStringID, %playerName); echo(%string); @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// ( buildTaggedString, const char*, 2, 11, (string format, ...) +/// @brief Build a string using the specified tagged string format. +/// +/// This function takes an already tagged string (passed in as a tagged string ID) and one +/// or more additional strings. If the tagged string contains argument tags that range from +/// %%1 through %%9, then each additional string will be substituted into the tagged string. +/// The final (non-tagged) combined string will be returned. The maximum length of the tagged +/// string plus any inserted additional strings is 511 characters. +/// +/// @param format A tagged string ID that contains zero or more argument tags, in the form of +/// %%1 through %%9. +/// @param ... A variable number of arguments that are insterted into the tagged string +/// based on the argument tags within the format string. +/// +/// @returns An ordinary string that is a combination of the original tagged string with any additional +/// strings passed in inserted in place of each argument tag. +/// +/// @tsexample +/// // Create a tagged string with argument tags +/// %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); +/// +/// // Some point later, combine the tagged string with some other string +/// %string = buildTaggedString(%taggedStringID, %playerName); +/// echo(%string); +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string _buildTaggedString(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= ""){ @@ -2527,7 +2525,21 @@ public string _buildTaggedString(string a1, string a2= "", string a3= "", strin return m_ts.fn__buildTaggedString(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); } /// -/// ( call, const char *, 2, 0, ( string functionName, string args... ) Apply the given arguments to the specified global function and return the result of the call. @param functionName The name of the function to call. This function must be in the global namespace, i.e. you cannot call a function in a namespace through #call. Use eval() for that. @return The result of the function call. @tsexample function myFunction( %arg ) { return ( %arg SPC \"World!\" ); } echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. @endtsexample @ingroup Scripting ) +/// ( call, const char *, 2, 0, ( string functionName, string args... ) +/// Apply the given arguments to the specified global function and return the result of the call. +/// @param functionName The name of the function to call. This function must be in the global namespace, i.e. +/// you cannot call a function in a namespace through #call. Use eval() for that. +/// @return The result of the function call. +/// @tsexample +/// function myFunction( %arg ) +/// { +/// return ( %arg SPC \"World!\" ); +/// } +/// +/// echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. +/// @endtsexample +/// @ingroup Scripting ) +/// /// public string _call(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2535,7 +2547,37 @@ public string _call(string a1, string a2= "", string a3= "", string a4= "", str return m_ts.fn__call(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) @brief Send a command from the server to the client @param client The numeric ID of a client GameConnection @param func Name of the client function being called @param ... Various parameters being passed to client command @tsexample // Set up the client command. Needs to be executed on the client, such as // within scripts/client/client.cs // Update the Ammo Counter with current ammo, if not any then hide the counter. function clientCmdSetAmmoAmountHud(%amount) { if (!%amount) AmmoAmount.setVisible(false); else { AmmoAmount.setVisible(true); AmmoAmount.setText(\"Ammo: \"@%amount); } } // Call it from a server function. Needs to be executed on the server, //such as within scripts/server/game.cs function GameConnection::setAmmoAmountHud(%client, %amount) { commandToClient(%client, 'SetAmmoAmountHud', %amount); } @endtsexample @ingroup Networking) +/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) +/// @brief Send a command from the server to the client +/// +/// @param client The numeric ID of a client GameConnection +/// @param func Name of the client function being called +/// @param ... Various parameters being passed to client command +/// +/// @tsexample +/// // Set up the client command. Needs to be executed on the client, such as +/// // within scripts/client/client.cs +/// // Update the Ammo Counter with current ammo, if not any then hide the counter. +/// function clientCmdSetAmmoAmountHud(%amount) +/// { +/// if (!%amount) +/// AmmoAmount.setVisible(false); +/// else +/// { +/// AmmoAmount.setVisible(true); +/// AmmoAmount.setText(\"Ammo: \"@%amount); +/// } +/// } +/// // Call it from a server function. Needs to be executed on the server, +/// //such as within scripts/server/game.cs +/// function GameConnection::setAmmoAmountHud(%client, %amount) +/// { +/// commandToClient(%client, 'SetAmmoAmountHud', %amount); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void _commandToClient(string a1, string a2, string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= "", string a21= ""){ @@ -2543,7 +2585,42 @@ public void _commandToClient(string a1, string a2, string a3= "", string a4= "" m_ts.fn__commandToClient(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21); } /// -/// ( commandToServer, void, 2, 21, (string func, ...) @brief Send a command to the server. @param func Name of the server command being called @param ... Various parameters being passed to server command @tsexample // Create a standard function. Needs to be executed on the client, such // as within scripts/client/default.bind.cs function toggleCamera(%val) { // If key was down, call a server command named 'ToggleCamera' if (%val) commandToServer('ToggleCamera'); } // Server command being called from above. Needs to be executed on the // server, such as within scripts/server/commands.cs function serverCmdToggleCamera(%client) { if (%client.getControlObject() == %client.player) { %client.camera.setVelocity(\"0 0 0\"); %control = %client.camera; } else { %client.player.setVelocity(\"0 0 0\"); %control = %client.player; } %client.setControlObject(%control); clientCmdSyncEditorGui(); } @endtsexample @ingroup Networking) +/// ( commandToServer, void, 2, 21, (string func, ...) +/// @brief Send a command to the server. +/// +/// @param func Name of the server command being called +/// @param ... Various parameters being passed to server command +/// +/// @tsexample +/// // Create a standard function. Needs to be executed on the client, such +/// // as within scripts/client/default.bind.cs +/// function toggleCamera(%val) +/// { +/// // If key was down, call a server command named 'ToggleCamera' +/// if (%val) +/// commandToServer('ToggleCamera'); +/// } +/// // Server command being called from above. Needs to be executed on the +/// // server, such as within scripts/server/commands.cs +/// function serverCmdToggleCamera(%client) +/// { +/// if (%client.getControlObject() == %client.player) +/// { +/// %client.camera.setVelocity(\"0 0 0\"); +/// %control = %client.camera; +/// } +/// else +/// { +/// %client.player.setVelocity(\"0 0 0\"); +/// %control = %client.player; +/// } +/// %client.setControlObject(%control); +/// clientCmdSyncEditorGui(); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void _commandToServer(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= ""){ @@ -2551,7 +2628,13 @@ public void _commandToServer(string a1, string a2= "", string a3= "", string a4 m_ts.fn__commandToServer(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20); } /// -/// ( echo, void, 2, 0, ( string message... ) @brief Logs a message to the console. Concatenates all given arguments to a single string and prints the string to the console. A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( echo, void, 2, 0, ( string message... ) +/// @brief Logs a message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console. +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void _echo(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2559,7 +2642,14 @@ public void _echo(string a1, string a2= "", string a3= "", string a4= "", strin m_ts.fn__echo(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( error, void, 2, 0, ( string message... ) @brief Logs an error message to the console. Concatenates all given arguments to a single string and prints the string to the console as an error message (in the in-game console, these will show up using a red font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( error, void, 2, 0, ( string message... ) +/// @brief Logs an error message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as an error +/// message (in the in-game console, these will show up using a red font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void _error(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2567,7 +2657,15 @@ public void _error(string a1, string a2= "", string a3= "", string a4= "", stri m_ts.fn__error(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) @brief Manually execute a special script file that contains game or editor preferences @param relativeFileName Name and path to file from project folder @param noCalls Deprecated @param journalScript Deprecated @return True if script was successfully executed @note Appears to be useless in Torque 3D, should be deprecated @ingroup Scripting) +/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) +/// @brief Manually execute a special script file that contains game or editor preferences +/// @param relativeFileName Name and path to file from project folder +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if script was successfully executed +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @ingroup Scripting) +/// /// public bool _execPrefs(string a1, string a2= "", string a3= ""){ @@ -2575,7 +2673,12 @@ public bool _execPrefs(string a1, string a2= "", string a3= ""){ return m_ts.fn__execPrefs(a1, a2, a3); } /// -/// (expandFilename, const char*, 2, 2, (string filename) @brief Grabs the full path of a specified file @param filename Name of the local file to locate @return String containing the full filepath on disk @ingroup FileSystem) +/// (expandFilename, const char*, 2, 2, (string filename) +/// @brief Grabs the full path of a specified file +/// @param filename Name of the local file to locate +/// @return String containing the full filepath on disk +/// @ingroup FileSystem) +/// /// public string _expandFilename(string a1){ @@ -2583,7 +2686,11 @@ public string _expandFilename(string a1){ return m_ts.fn__expandFilename(a1); } /// -/// (expandOldFilename, const char*, 2, 2, (string filename) @brief Retrofits a filepath that uses old Torque style @return String containing filepath with new formatting @ingroup FileSystem) +/// (expandOldFilename, const char*, 2, 2, (string filename) +/// @brief Retrofits a filepath that uses old Torque style +/// @return String containing filepath with new formatting +/// @ingroup FileSystem) +/// /// public string _expandOldFilename(string a1){ @@ -2591,7 +2698,73 @@ public string _expandOldFilename(string a1){ return m_ts.fn__expandOldFilename(a1); } /// -/// ( mathInit, void, 1, 10, ( ... ) @brief Install the math library with specified extensions. Possible parameters are: - 'DETECT' Autodetect math lib settings. - 'C' Enable the C math routines. C routines are always enabled. - 'FPU' Enable floating point unit routines. - 'MMX' Enable MMX math routines. - '3DNOW' Enable 3dNow! math routines. - 'SSE' Enable SSE math routines. @ingroup Math) +/// ( getStockColorCount, S32, 1, 1, () - Gets a count of available stock colors. +/// @return A count of available stock colors. ) +/// +/// +public int _getStockColorCount(){ + + +return m_ts.fn__getStockColorCount(); +} +/// +/// ( getStockColorF, const char*, 2, 2, (stockColorName) - Gets a floating-point-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// +public string _getStockColorF(string a1){ + + +return m_ts.fn__getStockColorF(a1); +} +/// +/// ( getStockColorI, const char*, 2, 2, (stockColorName) - Gets a byte-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// +public string _getStockColorI(string a1){ + + +return m_ts.fn__getStockColorI(a1); +} +/// +/// ( getStockColorName, const char*, 2, 2, (stockColorIndex) - Gets the stock color name at the specified index. +/// @param stockColorIndex The zero-based index of the stock color name to retrieve. +/// @return The stock color name at the specified index or nothing if the string is invalid. ) +/// +/// +public string _getStockColorName(string a1){ + + +return m_ts.fn__getStockColorName(a1); +} +/// +/// ( isStockColor, bool, 2, 2, (stockColorName) - Gets whether the specified name is a stock color or not. +/// @param stockColorName - The stock color name to test for. +/// @return Whether the specified name is a stock color or not. ) +/// +/// +public bool _isStockColor(string a1){ + + +return m_ts.fn__isStockColor(a1); +} +/// +/// ( mathInit, void, 1, 10, ( ... ) +/// @brief Install the math library with specified extensions. +/// Possible parameters are: +/// - 'DETECT' Autodetect math lib settings. +/// - 'C' Enable the C math routines. C routines are always enabled. +/// - 'FPU' Enable floating point unit routines. +/// - 'MMX' Enable MMX math routines. +/// - '3DNOW' Enable 3dNow! math routines. +/// - 'SSE' Enable SSE math routines. +/// @ingroup Math) +/// +/// +/// /// public void _mathInit(string a1= "", string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= ""){ @@ -2599,7 +2772,12 @@ public void _mathInit(string a1= "", string a2= "", string a3= "", string a4= " m_ts.fn__mathInit(a1, a2, a3, a4, a5, a6, a7, a8, a9); } /// -/// (resourceDump, void, 1, 1, () @brief List the currently managed resources Currently used by editors only, internal @ingroup Editors @internal) +/// (resourceDump, void, 1, 1, () +/// @brief List the currently managed resources +/// Currently used by editors only, internal +/// @ingroup Editors +/// @internal) +/// /// public void _resourceDump(){ @@ -2608,6 +2786,7 @@ public void _resourceDump(){ } /// /// (schedule, S32, 4, 0, schedule(time, refobject|0, command, arg1...argN>)) +/// /// public int _schedule(string a1, string a2, string a3, string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2616,6 +2795,7 @@ public int _schedule(string a1, string a2, string a3, string a4= "", string a5= } /// /// (TestFunction2Args, const char *, 3, 3, testFunction(arg1, arg2)) +/// /// public string _TestFunction2Args(string a1, string a2){ @@ -2623,7 +2803,14 @@ public string _TestFunction2Args(string a1, string a2){ return m_ts.fn__TestFunction2Args(a1, a2); } /// -/// ( warn, void, 2, 0, ( string message... ) @brief Logs a warning message to the console. Concatenates all given arguments to a single string and prints the string to the console as a warning message (in the in-game console, these will show up using a turquoise font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( warn, void, 2, 0, ( string message... ) +/// @brief Logs a warning message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as a warning +/// message (in the in-game console, these will show up using a turquoise font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void _warn(string a1, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -2631,7 +2818,11 @@ public void _warn(string a1, string a2= "", string a3= "", string a4= "", strin m_ts.fn__warn(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// () @brief Activates DirectInput. Also activates any connected joysticks. @ingroup Input) +/// () +/// @brief Activates DirectInput. +/// Also activates any connected joysticks. +/// @ingroup Input) +/// /// public void activateDirectInput(){ @@ -2651,7 +2842,28 @@ public void activatePackage(string packageName){ m_ts.fn_activatePackage(packageName); } /// -/// @brief Add a string to the bad word filter The bad word filter is a table containing words which will not be displayed in chat windows. Instead, a designated replacement string will be displayed. There are already a number of bad words automatically defined. @param badWord Exact text of the word to restrict. @return True if word was successfully added, false if the word or a subset of it already exists in the table @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Returns true, word was successfully added addBadWord(%badWord); // Returns false, word has already been added addBadWord(\"Foobar\"); @endtsexample @ingroup Game) +/// @brief Add a string to the bad word filter +/// +/// The bad word filter is a table containing words which will not be +/// displayed in chat windows. Instead, a designated replacement string will be displayed. +/// There are already a number of bad words automatically defined. +/// +/// @param badWord Exact text of the word to restrict. +/// @return True if word was successfully added, false if the word or a subset of it already exists in the table +/// +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Returns true, word was successfully added +/// addBadWord(%badWord); +/// // Returns false, word has already been added +/// addBadWord(\"Foobar\"); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool addBadWord(string badWord){ @@ -2659,7 +2871,13 @@ public bool addBadWord(string badWord){ return m_ts.fn_addBadWord(badWord); } /// -/// Adds a global shader macro which will be merged with the script defined macros on every shader. The macro will replace the value of an existing macro of the same name. For the new macro to take effect all the shaders in the system need to be reloaded. @see resetLightManager, removeGlobalShaderMacro @ingroup Rendering ) +/// Adds a global shader macro which will be merged with the script defined +/// macros on every shader. The macro will replace the value of an existing +/// macro of the same name. For the new macro to take effect all the shaders +/// in the system need to be reloaded. +/// @see resetLightManager, removeGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void addGlobalShaderMacro(string name, string value = null ){ if (value== null) {value = null;} @@ -2668,7 +2886,14 @@ public void addGlobalShaderMacro(string name, string value = null ){ m_ts.fn_addGlobalShaderMacro(name, value); } /// -/// (string texName, string matName) @brief Maps the given texture to the given material. Generates a console warning before overwriting. Material maps are used by terrain and interiors for triggering effects when an object moves onto a terrain block or interior surface using the associated texture. @ingroup Materials) +/// (string texName, string matName) +/// @brief Maps the given texture to the given material. +/// Generates a console warning before overwriting. +/// Material maps are used by terrain and interiors for triggering +/// effects when an object moves onto a terrain +/// block or interior surface using the associated texture. +/// @ingroup Materials) +/// /// public void addMaterialMapping(string texName, string matName){ @@ -2676,7 +2901,19 @@ public void addMaterialMapping(string texName, string matName){ m_ts.fn_addMaterialMapping(texName, matName); } /// -/// ), @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, so tagging the same string (excluding case differences) will be ignored as a duplicated tag. @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string @see \\ref syntaxDataTypes under Tagged %Strings @see removeTaggedString() @see getTaggedString() @ingroup Networking) +/// ), +/// @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable +/// +/// @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, +/// so tagging the same string (excluding case differences) will be ignored as a duplicated tag. +/// +/// @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see removeTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string addTaggedString(string str = ""){ @@ -2685,6 +2922,7 @@ public string addTaggedString(string str = ""){ } /// /// ), 'playerName'[, 'AIClassType'] );) +/// /// public int aiAddPlayer(string name, string ns = ""){ @@ -2692,7 +2930,13 @@ public int aiAddPlayer(string name, string ns = ""){ return m_ts.fn_aiAddPlayer(name, ns); } /// -/// allowConnections(bool allow) @brief Sets whether or not the global NetInterface allows connections from remote hosts. @param allow Set to true to allow remote connections. @ingroup Networking) +/// allowConnections(bool allow) +/// @brief Sets whether or not the global NetInterface allows connections from remote hosts. +/// +/// @param allow Set to true to allow remote connections. +/// +/// @ingroup Networking) +/// /// public void allowConnections(bool allow){ @@ -2712,7 +2956,16 @@ public void backtrace(){ m_ts.fn_backtrace(); } /// -/// CSV), (location, [backend]) - @brief Takes a string informing the backend where to store sample data and optionally a name of the specific logging backend to use. The default is the CSV backend. In most cases, the logging store will be a file name. @tsexample beginSampling( \"mysamples.csv\" ); @endtsexample @ingroup Rendering) +/// CSV), (location, [backend]) - +/// @brief Takes a string informing the backend where to store +/// sample data and optionally a name of the specific logging +/// backend to use. The default is the CSV backend. In most +/// cases, the logging store will be a file name. +/// @tsexample +/// beginSampling( \"mysamples.csv\" ); +/// @endtsexample +/// @ingroup Rendering) +/// /// public void beginSampling(string location, string backend = "CSV"){ @@ -2720,7 +2973,26 @@ public void beginSampling(string location, string backend = "CSV"){ m_ts.fn_beginSampling(location, backend); } /// -/// @brief Calculates how much an explosion effects a specific object. Use this to determine how much damage to apply to objects based on their distance from the explosion's center point, and whether the explosion is blocked by other objects. @param pos Center position of the explosion. @param id Id of the object of which to check coverage. @param covMask Mask of object types that may block the explosion. @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) @tsexample // Get the position of the explosion. %position = %explosion.getPosition(); // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType // Acquire the damage value from 0.0f - 1.0f. %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); // Apply damage to object %sceneObject.applyDamage( %coverage * 20 ); @endtsexample @ingroup FX) +/// @brief Calculates how much an explosion effects a specific object. +/// Use this to determine how much damage to apply to objects based on their +/// distance from the explosion's center point, and whether the explosion is +/// blocked by other objects. +/// @param pos Center position of the explosion. +/// @param id Id of the object of which to check coverage. +/// @param covMask Mask of object types that may block the explosion. +/// @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) +/// @tsexample +/// // Get the position of the explosion. +/// %position = %explosion.getPosition(); +/// // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. +/// %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType +/// // Acquire the damage value from 0.0f - 1.0f. +/// %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); +/// // Apply damage to object +/// %sceneObject.applyDamage( %coverage * 20 ); +/// @endtsexample +/// @ingroup FX) +/// /// public float calcExplosionCoverage(Point3F pos, int id, uint covMask){ @@ -2729,6 +3001,7 @@ public float calcExplosionCoverage(Point3F pos, int id, uint covMask){ } /// /// cancel(eventId)) +/// /// public void cancel(int eventId){ @@ -2737,6 +3010,7 @@ public void cancel(int eventId){ } /// /// cancelAll(objectId): cancel pending events on the specified object. Events will be automatically cancelled if object is deleted.) +/// /// public void cancelAll(string objectId){ @@ -2745,6 +3019,7 @@ public void cancelAll(string objectId){ } /// /// cancelServerQuery(...); ) +/// /// public void cancelServerQuery(){ @@ -2752,7 +3027,9 @@ public void cancelServerQuery(){ m_ts.fn_cancelServerQuery(); } /// -/// Release the unused pooled textures in texture manager freeing up video memory. @ingroup GFX ) +/// Release the unused pooled textures in texture manager freeing up video memory. +/// @ingroup GFX ) +/// /// public void cleanupTexturePool(){ @@ -2761,6 +3038,7 @@ public void cleanupTexturePool(){ } /// /// ) +/// /// public void clearClientPaths(){ @@ -2768,7 +3046,11 @@ public void clearClientPaths(){ m_ts.fn_clearClientPaths(); } /// -/// Clears the flagged state on all allocated GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// Clears the flagged state on all allocated GFX resources. +/// See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// /// public void clearGFXResourceFlags(){ @@ -2777,6 +3059,7 @@ public void clearGFXResourceFlags(){ } /// /// ) +/// /// public void clearServerPaths(){ @@ -2784,7 +3067,21 @@ public void clearServerPaths(){ m_ts.fn_clearServerPaths(); } /// -/// () @brief Closes the current network port @ingroup Networking) +/// () +/// Returns all pop'd out windows to the main canvas. +/// ) +/// +/// +public void CloseAllPopOuts(){ + + +m_ts.fn_CloseAllPopOuts(); +} +/// +/// () +/// @brief Closes the current network port +/// @ingroup Networking) +/// /// public void closeNetPort(){ @@ -2792,7 +3089,38 @@ public void closeNetPort(){ m_ts.fn_closeNetPort(); } /// -/// Replace all escape sequences in @a text with their respective character codes. This function replaces all escape sequences (\\\, \\\\t, etc) in the given string with the respective characters they represent. The primary use of this function is for converting strings from their literal form into their compiled/translated form, as is normally done by the TorqueScript compiler. @param text A string. @return A duplicate of @a text with all escape sequences replaced by their respective character codes. @tsexample // Print: // // str // ing // // to the console. Note how the backslash in the string must be escaped here // in order to prevent the TorqueScript compiler from collapsing the escape // sequence in the resulting string. echo( collapseEscape( \"str\ing\" ) ); @endtsexample @see expandEscape @ingroup Strings ) +/// Close our startup splash window. +/// @note This is currently only implemented on Windows. +/// @ingroup Platform ) +/// +/// +public void closeSplashWindow(){ + + +m_ts.fn_closeSplashWindow(); +} +/// +/// Replace all escape sequences in @a text with their respective character codes. +/// This function replaces all escape sequences (\\\, \\\\t, etc) in the given string +/// with the respective characters they represent. +/// The primary use of this function is for converting strings from their literal form into +/// their compiled/translated form, as is normally done by the TorqueScript compiler. +/// @param text A string. +/// @return A duplicate of @a text with all escape sequences replaced by their respective character codes. +/// @tsexample +/// // Print: +/// // +/// // str +/// // ing +/// // +/// // to the console. Note how the backslash in the string must be escaped here +/// // in order to prevent the TorqueScript compiler from collapsing the escape +/// // sequence in the resulting string. +/// echo( collapseEscape( \"str\ing\" ) ); +/// @endtsexample +/// @see expandEscape +/// @ingroup Strings ) +/// /// public string collapseEscape(string text){ @@ -2800,7 +3128,20 @@ public string collapseEscape(string text){ return m_ts.fn_collapseEscape(text); } /// -/// Compile a file to bytecode. This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file in the current DSO path mirrorring the path of @a fileName. @param fileName Path to the file to compile to bytecode. @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not generate write compiled code to DSO files. @return True if the file was successfully compiled, false if not. @note The definitions contained in the given file will not be made available and no code will actually be executed. Use exec() for that. @see getDSOPath @see exec @ingroup Scripting ) +/// Compile a file to bytecode. +/// This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, +/// if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file +/// in the current DSO path mirrorring the path of @a fileName. +/// @param fileName Path to the file to compile to bytecode. +/// @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not +/// generate write compiled code to DSO files. +/// @return True if the file was successfully compiled, false if not. +/// @note The definitions contained in the given file will not be made available and no code will actually +/// be executed. Use exec() for that. +/// @see getDSOPath +/// @see exec +/// @ingroup Scripting ) +/// /// public bool compile(string fileName, bool overrideNoDSO = false){ @@ -2809,6 +3150,7 @@ public bool compile(string fileName, bool overrideNoDSO = false){ } /// /// Exports console definition XML representation ) +/// /// public string consoleExportXML(){ @@ -2816,7 +3158,21 @@ public string consoleExportXML(){ return m_ts.fn_consoleExportXML(); } /// -/// @brief See if any objects of the given types are present in box of given extent. @note Extent parameter is last since only one radius is often needed. If one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, if you need to use the client container, you'll need to set all of the radius parameters. Fortunately, this function is mostly used on the server. @param mask Indicates the type of objects we are checking against. @param center Center of box. @param xRadius Search radius in the x-axis. See note above. @param yRadius Search radius in the y-axis. See note above. @param zRadius Search radius in the z-axis. See note above. @param useClientContainer Optionally indicates the search should be within the client container. @return true if the box is empty, false if any object is found. @ingroup Game) +/// @brief See if any objects of the given types are present in box of given extent. +/// @note Extent parameter is last since only one radius is often needed. If +/// one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, +/// if you need to use the client container, you'll need to set all of the radius parameters. +/// Fortunately, this function is mostly used on the server. +/// @param mask Indicates the type of objects we are checking against. +/// @param center Center of box. +/// @param xRadius Search radius in the x-axis. See note above. +/// @param yRadius Search radius in the y-axis. See note above. +/// @param zRadius Search radius in the z-axis. See note above. +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return true if the box is empty, false if any object is found. +/// @ingroup Game) +/// /// public bool containerBoxEmpty(uint mask, Point3F center, float xRadius, float yRadius = -1, float zRadius = -1, bool useClientContainer = false){ @@ -2824,7 +3180,13 @@ public bool containerBoxEmpty(uint mask, Point3F center, float xRadius, float y return m_ts.fn_containerBoxEmpty(mask, center.AsString(), xRadius, yRadius, zRadius, useClientContainer); } /// -/// (int mask, Point3F point, float x, float y, float z) @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more results using containerFindNext(). @see containerFindNext @ingroup Game) +/// (int mask, Point3F point, float x, float y, float z) +/// @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. +/// @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more +/// results using containerFindNext(). +/// @see containerFindNext +/// @ingroup Game) +/// /// public string containerFindFirst(uint typeMask, Point3F origin, Point3F size){ @@ -2832,7 +3194,13 @@ public string containerFindFirst(uint typeMask, Point3F origin, Point3F size){ return m_ts.fn_containerFindFirst(typeMask, origin.AsString(), size.AsString()); } /// -/// () @brief Get more results from a previous call to containerFindFirst(). @note You must call containerFindFirst() to begin the search. @returns The next object found, or an empty string if nothing else was found. @see containerFindFirst() @ingroup Game) +/// () +/// @brief Get more results from a previous call to containerFindFirst(). +/// @note You must call containerFindFirst() to begin the search. +/// @returns The next object found, or an empty string if nothing else was found. +/// @see containerFindFirst() +/// @ingroup Game) +/// /// public string containerFindNext(){ @@ -2840,7 +3208,26 @@ public string containerFindNext(){ return m_ts.fn_containerFindNext(); } /// -/// @brief Cast a ray from start to end, checking for collision against items matching mask. If pExempt is specified, then it is temporarily excluded from collision checks (For instance, you might want to exclude the player if said player was firing a weapon.) @param start An XYZ vector containing the tail position of the ray. @param end An XYZ vector containing the head position of the ray @param mask A bitmask corresponding to the type of objects to check for @param pExempt An optional ID for a single object that ignored for this raycast @param useClientContainer Optionally indicates the search should be within the client container. @returns A string containing either null, if nothing was struck, or these fields: ul>li>The ID of the object that was struck./li> li>The x, y, z position that it was struck./li> li>The x, y, z of the normal of the face that was struck./li> li>The distance between the start point and the position we hit./li>/ul> @ingroup Game) +/// @brief Cast a ray from start to end, checking for collision against items matching mask. +/// +/// If pExempt is specified, then it is temporarily excluded from collision checks (For +/// instance, you might want to exclude the player if said player was firing a weapon.) +/// +/// @param start An XYZ vector containing the tail position of the ray. +/// @param end An XYZ vector containing the head position of the ray +/// @param mask A bitmask corresponding to the type of objects to check for +/// @param pExempt An optional ID for a single object that ignored for this raycast +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @returns A string containing either null, if nothing was struck, or these fields: +/// ul>li>The ID of the object that was struck./li> +/// li>The x, y, z position that it was struck./li> +/// li>The x, y, z of the normal of the face that was struck./li> +/// li>The distance between the start point and the position we hit./li>/ul> +/// +/// @ingroup Game) +/// /// public string containerRayCast(Point3F start, Point3F end, uint mask, string pExempt = null , bool useClientContainer = false){ if (pExempt== null) {pExempt = null;} @@ -2849,7 +3236,17 @@ public string containerRayCast(Point3F start, Point3F end, uint mask, string pE return m_ts.fn_containerRayCast(start.AsString(), end.AsString(), mask, pExempt, useClientContainer); } /// -/// @brief Get distance of the center of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the center of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get distance of the center of the current item from the center of the +/// current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the center of the current object to the center of +/// the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float containerSearchCurrDist(bool useClientContainer = false){ @@ -2857,7 +3254,17 @@ public float containerSearchCurrDist(bool useClientContainer = false){ return m_ts.fn_containerSearchCurrDist(useClientContainer); } /// -/// @brief Get the distance of the closest point of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the closest point of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get the distance of the closest point of the current item from the center +/// of the current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the closest point of the current object to the +/// center of the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float containerSearchCurrRadiusDist(bool useClientContainer = false){ @@ -2865,7 +3272,29 @@ public float containerSearchCurrRadiusDist(bool useClientContainer = false){ return m_ts.fn_containerSearchCurrRadiusDist(useClientContainer); } /// -/// @brief Get next item from a search started with initContainerRadiusSearch() or initContainerTypeSearch(). @param useClientContainer Optionally indicates the search should be within the client container. @return the next object found in the search, or null if no more @tsexample // print the names of all nearby ShapeBase derived objects %position = %obj.getPosition; %radius = 20; %mask = $TypeMasks::ShapeBaseObjectType; initContainerRadiusSearch( %position, %radius, %mask ); while ( (%targetObject = containerSearchNext()) != 0 ) { echo( \"Found: \" @ %targetObject.getName() ); } @endtsexample @see initContainerRadiusSearch() @see initContainerTypeSearch() @ingroup Game) +/// @brief Get next item from a search started with initContainerRadiusSearch() or +/// initContainerTypeSearch(). +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return the next object found in the search, or null if no more +/// +/// @tsexample +/// // print the names of all nearby ShapeBase derived objects +/// %position = %obj.getPosition; +/// %radius = 20; +/// %mask = $TypeMasks::ShapeBaseObjectType; +/// initContainerRadiusSearch( %position, %radius, %mask ); +/// while ( (%targetObject = containerSearchNext()) != 0 ) +/// { +/// echo( \"Found: \" @ %targetObject.getName() ); +/// } +/// @endtsexample +/// +/// @see initContainerRadiusSearch() +/// @see initContainerTypeSearch() +/// @ingroup Game) +/// /// public string containerSearchNext(bool useClientContainer = false){ @@ -2873,7 +3302,40 @@ public string containerSearchNext(bool useClientContainer = false){ return m_ts.fn_containerSearchNext(useClientContainer); } /// -/// @brief Checks to see if text is a bad word The text is considered to be a bad word if it has been added to the bad word filter. @param text Text to scan for bad words @return True if the text has bad word(s), false if it is clean @see addBadWord() @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Add a banned word to the bad word filter addBadWord(%badWord); // Create the base string, can come from anywhere like user chat %userText = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // If the text contains a bad word, filter it before printing // Otherwise print the original text if(containsBadWords(%userText)) { // Filter the string %filteredText = filterString(%userText, %replacementChars); // Print filtered text echo(%filteredText); } else echo(%userText); @endtsexample @ingroup Game) +/// @brief Checks to see if text is a bad word +/// +/// The text is considered to be a bad word if it has been added to the bad word filter. +/// +/// @param text Text to scan for bad words +/// @return True if the text has bad word(s), false if it is clean +/// +/// @see addBadWord() +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Add a banned word to the bad word filter +/// addBadWord(%badWord); +/// // Create the base string, can come from anywhere like user chat +/// %userText = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // If the text contains a bad word, filter it before printing +/// // Otherwise print the original text +/// if(containsBadWords(%userText)) +/// { +/// // Filter the string +/// %filteredText = filterString(%userText, %replacementChars); +/// // Print filtered text +/// echo(%filteredText); +/// } +/// else +/// echo(%userText); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool containsBadWords(string text){ @@ -2881,7 +3343,11 @@ public bool containsBadWords(string text){ return m_ts.fn_containsBadWords(text); } /// -/// Count the number of bits that are set in the given 32 bit integer. @param v An integer value. @return The number of bits that are set in @a v. @ingroup Utilities ) +/// Count the number of bits that are set in the given 32 bit integer. +/// @param v An integer value. +/// @return The number of bits that are set in @a v. +/// @ingroup Utilities ) +/// /// public int countBits(int v){ @@ -2889,7 +3355,14 @@ public int countBits(int v){ return m_ts.fn_countBits(v); } /// -/// @brief Create the given directory or the path leading to the given filename. If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components of the path will be created. @param path The path to create. @note Only present in a Tools build of Torque. @ingroup FileSystem ) +/// @brief Create the given directory or the path leading to the given filename. +/// If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, +/// does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components +/// of the path will be created. +/// @param path The path to create. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem ) +/// /// public bool createPath(string path){ @@ -2897,7 +3370,10 @@ public bool createPath(string path){ return m_ts.fn_createPath(path); } /// -/// () Forcibly disconnects any attached script debugging client. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Forcibly disconnects any attached script debugging client. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void dbgDisconnect(){ @@ -2905,7 +3381,10 @@ public void dbgDisconnect(){ m_ts.fn_dbgDisconnect(); } /// -/// () Returns true if a script debugging client is connected else return false. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Returns true if a script debugging client is connected else return false. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public bool dbgIsConnected(){ @@ -2913,7 +3392,11 @@ public bool dbgIsConnected(){ return m_ts.fn_dbgIsConnected(); } /// -/// ( int port, string password, bool waitForClient ) Open a debug server port on the specified port, requiring the specified password, and optionally waiting for the debug client to connect. @internal Primarily used for Torsion and other debugging tools) +/// ( int port, string password, bool waitForClient ) +/// Open a debug server port on the specified port, requiring the specified password, +/// and optionally waiting for the debug client to connect. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void dbgSetParameters(int port, string password, bool waitForClient = false){ @@ -2921,7 +3404,11 @@ public void dbgSetParameters(int port, string password, bool waitForClient = fa m_ts.fn_dbgSetParameters(port, password, waitForClient); } /// -/// () @brief Disables DirectInput. Also deactivates any connected joysticks. @ingroup Input ) +/// () +/// @brief Disables DirectInput. +/// Also deactivates any connected joysticks. +/// @ingroup Input ) +/// /// public void deactivateDirectInput(){ @@ -2942,7 +3429,12 @@ public void deactivatePackage(string packageName){ m_ts.fn_deactivatePackage(packageName); } /// -/// Drops the engine into the native C++ debugger. This function triggers a debug break and drops the process into the IDE's debugger. If the process is not running with a debugger attached it will generate a runtime error on most platforms. @note This function is not available in shipping builds. @ingroup Debugging ) +/// Drops the engine into the native C++ debugger. +/// This function triggers a debug break and drops the process into the IDE's debugger. If the process is not +/// running with a debugger attached it will generate a runtime error on most platforms. +/// @note This function is not available in shipping builds. +/// @ingroup Debugging ) +/// /// public void debug(){ @@ -2950,7 +3442,10 @@ public void debug(){ m_ts.fn_debug(); } /// -/// @brief Dumps all current EngineObject instances to the console. @note This function is only available in debug builds. @ingroup Debugging ) +/// @brief Dumps all current EngineObject instances to the console. +/// @note This function is only available in debug builds. +/// @ingroup Debugging ) +/// /// public void debugDumpAllObjects(){ @@ -2971,7 +3466,15 @@ public void debugEnumInstances(string className, string functionName){ m_ts.fn_debugEnumInstances(className, functionName); } /// -/// @brief Logs the value of the given variable to the console. Prints a string of the form \"variableName> = variable value>\" to the console. @param variableName Name of the local or global variable to print. @tsexample %var = 1; debugv( \"%var\" ); // Prints \"%var = 1\" @endtsexample @ingroup Debugging ) +/// @brief Logs the value of the given variable to the console. +/// Prints a string of the form \"variableName> = variable value>\" to the console. +/// @param variableName Name of the local or global variable to print. +/// @tsexample +/// %var = 1; +/// debugv( \"%var\" ); // Prints \"%var = 1\" +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void debugv(string variableName){ @@ -2979,7 +3482,26 @@ public void debugv(string variableName){ m_ts.fn_debugv(variableName); } /// -/// Adds a new decal to the decal manager. @param position World position for the decal. @param normal Decal normal vector (if the decal was a tire lying flat on a surface, this is the vector pointing in the direction of the axle). @param rot Angle (in radians) to rotate this decal around its normal vector. @param scale Scale factor applied to the decal. @param decalData DecalData datablock to use for the new decal. @param isImmortal Whether or not this decal is immortal. If immortal, it does not expire automatically and must be removed explicitly. @return Returns the ID of the new Decal object or -1 on failure. @tsexample // Specify the decal position %position = \"1.0 1.0 1.0\"; // Specify the up vector %normal = \"0.0 0.0 1.0\"; // Add the new decal. %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); @endtsexample @ingroup Decals ) +/// Adds a new decal to the decal manager. +/// @param position World position for the decal. +/// @param normal Decal normal vector (if the decal was a tire lying flat on a +/// surface, this is the vector pointing in the direction of the axle). +/// @param rot Angle (in radians) to rotate this decal around its normal vector. +/// @param scale Scale factor applied to the decal. +/// @param decalData DecalData datablock to use for the new decal. +/// @param isImmortal Whether or not this decal is immortal. If immortal, it +/// does not expire automatically and must be removed explicitly. +/// @return Returns the ID of the new Decal object or -1 on failure. +/// @tsexample +/// // Specify the decal position +/// %position = \"1.0 1.0 1.0\"; +/// // Specify the up vector +/// %normal = \"0.0 0.0 1.0\"; +/// // Add the new decal. +/// %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public int decalManagerAddDecal(Point3F position, Point3F normal, float rot, float scale, string decalData, bool isImmortal = false){ @@ -2987,7 +3509,13 @@ public int decalManagerAddDecal(Point3F position, Point3F normal, float rot, fl return m_ts.fn_decalManagerAddDecal(position.AsString(), normal.AsString(), rot, scale, decalData, isImmortal); } /// -/// Removes all decals currently loaded in the decal manager. @tsexample // Tell the decal manager to remove all existing decals. decalManagerClear(); @endtsexample @ingroup Decals ) +/// Removes all decals currently loaded in the decal manager. +/// @tsexample +/// // Tell the decal manager to remove all existing decals. +/// decalManagerClear(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void decalManagerClear(){ @@ -2995,7 +3523,15 @@ public void decalManagerClear(){ m_ts.fn_decalManagerClear(); } /// -/// Returns whether the decal manager has unsaved modifications. @return True if the decal manager has unsaved modifications, false if everything has been saved. @tsexample // Ask the decal manager if it has unsaved modifications. %hasUnsavedModifications = decalManagerDirty(); @endtsexample @ingroup Decals ) +/// Returns whether the decal manager has unsaved modifications. +/// @return True if the decal manager has unsaved modifications, false if +/// everything has been saved. +/// @tsexample +/// // Ask the decal manager if it has unsaved modifications. +/// %hasUnsavedModifications = decalManagerDirty(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool decalManagerDirty(){ @@ -3003,7 +3539,18 @@ public bool decalManagerDirty(){ return m_ts.fn_decalManagerDirty(); } /// -/// Clears existing decals and replaces them with decals loaded from the specified file. @param fileName Filename to load the decals from. @return True if the decal manager was able to load the requested file, false if it could not. @tsexample // Set the filename to load the decals from. %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to load the decals from the entered filename. decalManagerLoad( %fileName ); @endtsexample @ingroup Decals ) +/// Clears existing decals and replaces them with decals loaded from the specified file. +/// @param fileName Filename to load the decals from. +/// @return True if the decal manager was able to load the requested file, +/// false if it could not. +/// @tsexample +/// // Set the filename to load the decals from. +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to load the decals from the entered filename. +/// decalManagerLoad( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool decalManagerLoad(string fileName){ @@ -3011,7 +3558,17 @@ public bool decalManagerLoad(string fileName){ return m_ts.fn_decalManagerLoad(fileName); } /// -/// Remove specified decal from the scene. @param decalID ID of the decal to remove. @return Returns true if successful, false if decal ID not found. @tsexample // Specify a decal ID to be removed %decalID = 1; // Tell the decal manager to remove the specified decal ID. decalManagerRemoveDecal( %decalId ) @endtsexample @ingroup Decals ) +/// Remove specified decal from the scene. +/// @param decalID ID of the decal to remove. +/// @return Returns true if successful, false if decal ID not found. +/// @tsexample +/// // Specify a decal ID to be removed +/// %decalID = 1; +/// // Tell the decal manager to remove the specified decal ID. +/// decalManagerRemoveDecal( %decalId ) +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool decalManagerRemoveDecal(int decalID){ @@ -3019,7 +3576,18 @@ public bool decalManagerRemoveDecal(int decalID){ return m_ts.fn_decalManagerRemoveDecal(decalID); } /// -/// ), Saves the decals for the active mission in the entered filename. @param decalSaveFile Filename to save the decals to. @tsexample // Set the filename to save the decals in. If no filename is set, then the // decals will default to activeMissionName>.mis.decals %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to save the decals for the active mission. decalManagerSave( %fileName ); @endtsexample @ingroup Decals ) +/// ), +/// Saves the decals for the active mission in the entered filename. +/// @param decalSaveFile Filename to save the decals to. +/// @tsexample +/// // Set the filename to save the decals in. If no filename is set, then the +/// // decals will default to activeMissionName>.mis.decals +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to save the decals for the active mission. +/// decalManagerSave( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void decalManagerSave(string decalSaveFile = ""){ @@ -3027,7 +3595,10 @@ public void decalManagerSave(string decalSaveFile = ""){ m_ts.fn_decalManagerSave(decalSaveFile); } /// -/// Delete all the datablocks we've downloaded. This is usually done in preparation of downloading a new set of datablocks, such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// Delete all the datablocks we've downloaded. +/// This is usually done in preparation of downloading a new set of datablocks, +/// such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// /// public void deleteDataBlocks(){ @@ -3035,7 +3606,11 @@ public void deleteDataBlocks(){ m_ts.fn_deleteDataBlocks(); } /// -/// @brief Deletes the given @a file. @param file %Path of the file to delete. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Deletes the given @a file. +/// @param file %Path of the file to delete. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool deleteFile(string file){ @@ -3043,7 +3618,17 @@ public bool deleteFile(string file){ return m_ts.fn_deleteFile(file); } /// -/// Undefine all global variables matching the given name @a pattern. @param pattern A global variable name pattern. Must begin with '$'. @tsexample // Define a global variable in the \"My\" namespace. $My::Variable = \"value\"; // Undefine all variable in the \"My\" namespace. deleteVariables( \"$My::*\" ); @endtsexample @see strIsMatchExpr @ingroup Scripting ) +/// Undefine all global variables matching the given name @a pattern. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @tsexample +/// // Define a global variable in the \"My\" namespace. +/// $My::Variable = \"value\"; +/// // Undefine all variable in the \"My\" namespace. +/// deleteVariables( \"$My::*\" ); +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Scripting ) +/// /// public void deleteVariables(string pattern){ @@ -3051,7 +3636,22 @@ public void deleteVariables(string pattern){ m_ts.fn_deleteVariables(pattern); } /// -/// @brief Dumps a description of GFX resources to a file or the console. @param resourceTypes A space seperated list of resource types or an empty string for all resources. @param filePath A file to dump the list to or an empty string to write to the console. @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. @note The resource types can be one or more of the following: - texture - texture target - window target - vertex buffers - primitive buffers - fences - cubemaps - shaders - stateblocks @ingroup GFX ) +/// @brief Dumps a description of GFX resources to a file or the console. +/// @param resourceTypes A space seperated list of resource types or an empty string for all resources. +/// @param filePath A file to dump the list to or an empty string to write to the console. +/// @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. +/// @note The resource types can be one or more of the following: +/// - texture +/// - texture target +/// - window target +/// - vertex buffers +/// - primitive buffers +/// - fences +/// - cubemaps +/// - shaders +/// - stateblocks +/// @ingroup GFX ) +/// /// public void describeGFXResources(string resourceTypes, string filePath, bool unflaggedOnly = false){ @@ -3059,7 +3659,10 @@ public void describeGFXResources(string resourceTypes, string filePath, bool un m_ts.fn_describeGFXResources(resourceTypes, filePath, unflaggedOnly); } /// -/// Dumps a description of all state blocks. @param filePath A file to dump the state blocks to or an empty string to write to the console. @ingroup GFX ) +/// Dumps a description of all state blocks. +/// @param filePath A file to dump the state blocks to or an empty string to write to the console. +/// @ingroup GFX ) +/// /// public void describeGFXStateBlocks(string filePath){ @@ -3067,7 +3670,26 @@ public void describeGFXStateBlocks(string filePath){ m_ts.fn_describeGFXStateBlocks(filePath); } /// -/// @brief Returns the string from a tag string. Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. Use getTaggedString() to convert a tagged string ID back into a regular string at any time. @tsexample // From scripts/client/message.cs function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) { onChatMessage(detag(%msgString), %voice, %pitch); } @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see getTag() @see getTaggedString() @ingroup Networking) +/// @brief Returns the string from a tag string. +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. Use getTaggedString() +/// to convert a tagged string ID back into a regular string at any time. +/// +/// @tsexample +/// // From scripts/client/message.cs +/// function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) +/// { +/// onChatMessage(detag(%msgString), %voice, %pitch); +/// } +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see getTag() +/// @see getTaggedString() +/// +/// @ingroup Networking) +/// /// public string detag(string str){ @@ -3075,7 +3697,11 @@ public string detag(string str){ return m_ts.fn_detag(str); } /// -/// () @brief Disables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Disables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public void disableJoystick(){ @@ -3083,7 +3709,10 @@ public void disableJoystick(){ m_ts.fn_disableJoystick(); } /// -/// () @brief Disables XInput for Xbox 360 controllers. @ingroup Input) +/// () +/// @brief Disables XInput for Xbox 360 controllers. +/// @ingroup Input) +/// /// public void disableXInput(){ @@ -3091,7 +3720,15 @@ public void disableXInput(){ m_ts.fn_disableXInput(); } /// -/// ), (string queueName, string message, string data) @brief Dispatch a message to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @param data Data for message @return True for success, false for failure @see dispatchMessageObject @ingroup Messaging) +/// ), (string queueName, string message, string data) +/// @brief Dispatch a message to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @param data Data for message +/// @return True for success, false for failure +/// @see dispatchMessageObject +/// @ingroup Messaging) +/// /// public bool dispatchMessage(string queueName, string message, string data = ""){ @@ -3099,7 +3736,14 @@ public bool dispatchMessage(string queueName, string message, string data = "") return m_ts.fn_dispatchMessage(queueName, message, data); } /// -/// , ), (string queueName, string message) @brief Dispatch a message object to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @return true for success, false for failure @see dispatchMessage @ingroup Messaging) +/// , ), (string queueName, string message) +/// @brief Dispatch a message object to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @return true for success, false for failure +/// @see dispatchMessage +/// @ingroup Messaging) +/// /// public bool dispatchMessageObject(string queueName = "", string message = ""){ @@ -3107,7 +3751,12 @@ public bool dispatchMessageObject(string queueName = "", string message = ""){ return m_ts.fn_dispatchMessageObject(queueName, message); } /// -/// art/gui/splash.bmp), Display a startup splash window suitable for showing while the engine still starts up. @note This is currently only implemented on Windows. @return True if the splash window could be successfully initialized. @ingroup Platform ) +/// art/gui/splash.bmp), +/// Display a startup splash window suitable for showing while the engine still starts up. +/// @note This is currently only implemented on Windows. +/// @return True if the splash window could be successfully initialized. +/// @ingroup Platform ) +/// /// public bool displaySplashWindow(string path = "art/gui/splash.bmp"){ @@ -3115,7 +3764,12 @@ public bool displaySplashWindow(string path = "art/gui/splash.bmp"){ return m_ts.fn_displaySplashWindow(path); } /// -/// (bool enabled) @brief Enables logging of the connection protocols When enabled a lot of network debugging information is sent to the console. @param enabled True to enable, false to disable @ingroup Networking) +/// (bool enabled) +/// @brief Enables logging of the connection protocols +/// When enabled a lot of network debugging information is sent to the console. +/// @param enabled True to enable, false to disable +/// @ingroup Networking) +/// /// public void DNetSetLogging(bool enabled){ @@ -3263,7 +3917,11 @@ public Point3F dnt_testcase_9(Point3F chr){ return new Point3F ( m_ts.fn_dnt_testcase_9(chr.AsString())); } /// -/// @brief Dumps all declared console classes to the console. @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console classes to the console. +/// @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. +/// @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void dumpConsoleClasses(bool dumpScript = true, bool dumpEngine = true){ @@ -3271,7 +3929,11 @@ public void dumpConsoleClasses(bool dumpScript = true, bool dumpEngine = true){ m_ts.fn_dumpConsoleClasses(dumpScript, dumpEngine); } /// -/// @brief Dumps all declared console functions to the console. @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console functions to the console. +/// @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. +/// @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void dumpConsoleFunctions(bool dumpScript = true, bool dumpEngine = true){ @@ -3279,7 +3941,11 @@ public void dumpConsoleFunctions(bool dumpScript = true, bool dumpEngine = true m_ts.fn_dumpConsoleFunctions(dumpScript, dumpEngine); } /// -/// Dumps the engine scripting documentation to the specified file overwriting any existing content. @param outputFile The relative or absolute output file path and name. @return Returns true if successful. @ingroup Console) +/// Dumps the engine scripting documentation to the specified file overwriting any existing content. +/// @param outputFile The relative or absolute output file path and name. +/// @return Returns true if successful. +/// @ingroup Console) +/// /// public bool dumpEngineDocs(string outputFile){ @@ -3287,7 +3953,10 @@ public bool dumpEngineDocs(string outputFile){ return m_ts.fn_dumpEngineDocs(outputFile); } /// -/// Dumps to the console a full description of all cached fonts, along with info on the codepoints each contains. @ingroup Font ) +/// Dumps to the console a full description of all cached fonts, along with +/// info on the codepoints each contains. +/// @ingroup Font ) +/// /// public void dumpFontCacheStatus(){ @@ -3295,7 +3964,9 @@ public void dumpFontCacheStatus(){ m_ts.fn_dumpFontCacheStatus(); } /// -/// @brief Dumps a formatted list of currently allocated material instances to the console. @ingroup Materials) +/// @brief Dumps a formatted list of currently allocated material instances to the console. +/// @ingroup Materials) +/// /// public void dumpMaterialInstances(){ @@ -3303,7 +3974,14 @@ public void dumpMaterialInstances(){ m_ts.fn_dumpMaterialInstances(); } /// -/// @brief Dumps network statistics for each class to the console. The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. The i>num/i> value is the total number of events collected. @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. @ingroup Networking ) +/// @brief Dumps network statistics for each class to the console. +/// +/// The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. +/// The i>num/i> value is the total number of events collected. +/// +/// @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. +/// @ingroup Networking ) +/// /// public void dumpNetStats(){ @@ -3311,7 +3989,13 @@ public void dumpNetStats(){ m_ts.fn_dumpNetStats(); } /// -/// @brief Dump the current contents of the networked string table to the console. The results are returned in three columns. The first column is the network string ID. The second column is the string itself. The third column is the reference count to the network string. @note This function is available only in debug builds. @ingroup Networking ) +/// @brief Dump the current contents of the networked string table to the console. +/// The results are returned in three columns. The first column is the network string ID. +/// The second column is the string itself. The third column is the reference count to the +/// network string. +/// @note This function is available only in debug builds. +/// @ingroup Networking ) +/// /// public void dumpNetStringTable(){ @@ -3320,6 +4004,7 @@ public void dumpNetStringTable(){ } /// /// Dumps all ProcessObjects in ServerProcessList and ClientProcessList to the console. ) +/// /// public void dumpProcessList(bool allow){ @@ -3327,7 +4012,10 @@ public void dumpProcessList(bool allow){ m_ts.fn_dumpProcessList(allow); } /// -/// Creates a 64x64 normal map texture filled with noise. The texture is saved to randNormTex.png in the location of the game executable. @ingroup GFX) +/// Creates a 64x64 normal map texture filled with noise. The texture is saved +/// to randNormTex.png in the location of the game executable. +/// @ingroup GFX) +/// /// public void dumpRandomNormalMap(){ @@ -3344,7 +4032,11 @@ public void dumpSoCount(){ m_ts.fn_dumpSoCount(); } /// -/// () @brief Dumps information about String memory usage @ingroup Debugging @ingroup Strings) +/// () +/// @brief Dumps information about String memory usage +/// @ingroup Debugging +/// @ingroup Strings) +/// /// public void dumpStringMemStats(){ @@ -3352,15 +4044,10 @@ public void dumpStringMemStats(){ m_ts.fn_dumpStringMemStats(); } /// -/// ) -/// -public void dumpStringTableSize(){ - - -m_ts.fn_dumpStringTableSize(); -} -/// -/// Dumps a list of all active texture objects to the console. @note This function is only available in debug builds. @ingroup GFX ) +/// Dumps a list of all active texture objects to the console. +/// @note This function is only available in debug builds. +/// @ingroup GFX ) +/// /// public void dumpTextureObjects(){ @@ -3368,7 +4055,15 @@ public void dumpTextureObjects(){ m_ts.fn_dumpTextureObjects(); } /// -/// Copy the specified old font to a new name. The new copy will not have a platform font backing it, and so will never have characters added to it. But this is useful for making copies of fonts to add postprocessing effects to via exportCachedFont. @param oldFontName The name of the font face to copy. @param oldFontSize The size of the font to copy. @param newFontName The name of the new font face. @ingroup Font ) +/// Copy the specified old font to a new name. The new copy will not have a +/// platform font backing it, and so will never have characters added to it. +/// But this is useful for making copies of fonts to add postprocessing effects +/// to via exportCachedFont. +/// @param oldFontName The name of the font face to copy. +/// @param oldFontSize The size of the font to copy. +/// @param newFontName The name of the new font face. +/// @ingroup Font ) +/// /// public void duplicateCachedFont(string oldFontName, int oldFontSize, string newFontName){ @@ -3376,7 +4071,10 @@ public void duplicateCachedFont(string oldFontName, int oldFontSize, string new m_ts.fn_duplicateCachedFont(oldFontName, oldFontSize, newFontName); } /// -/// () @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. @ingroup Input) +/// () +/// @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. +/// @ingroup Input) +/// /// public void echoInputState(){ @@ -3384,7 +4082,11 @@ public void echoInputState(){ m_ts.fn_echoInputState(); } /// -/// () @brief Enables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Enables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public bool enableJoystick(){ @@ -3392,7 +4094,11 @@ public bool enableJoystick(){ return m_ts.fn_enableJoystick(); } /// -/// (pattern, [state]) - @brief Enable sampling for all keys that match the given name pattern. Slashes are treated as separators. @ingroup Rendering) +/// (pattern, [state]) - +/// @brief Enable sampling for all keys that match the given name +/// pattern. Slashes are treated as separators. +/// @ingroup Rendering) +/// /// public void enableSamples(string pattern, bool state = true){ @@ -3401,6 +4107,7 @@ public void enableSamples(string pattern, bool state = true){ } /// /// enableWinConsole(bool);) +/// /// public void enableWinConsole(bool flag){ @@ -3408,7 +4115,12 @@ public void enableWinConsole(bool flag){ m_ts.fn_enableWinConsole(flag); } /// -/// () @brief Enables XInput for Xbox 360 controllers. @note XInput is enabled by default. Disable to use an Xbox 360 Controller as a joystick device. @ingroup Input) +/// () +/// @brief Enables XInput for Xbox 360 controllers. +/// @note XInput is enabled by default. Disable to use an Xbox 360 +/// Controller as a joystick device. +/// @ingroup Input) +/// /// public bool enableXInput(){ @@ -3416,7 +4128,18 @@ public bool enableXInput(){ return m_ts.fn_enableXInput(); } /// -/// @brief Test whether the given string ends with the given suffix. @param str The string to test. @param suffix The potential suffix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. @tsexample startsWith( \"TEST123\", \"123\" ) // Returns true. @endtsexample @see startsWith @ingroup Strings ) +/// @brief Test whether the given string ends with the given suffix. +/// @param str The string to test. +/// @param suffix The potential suffix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"123\" ) // Returns true. +/// @endtsexample +/// @see startsWith +/// @ingroup Strings ) +/// /// public bool endsWith(string str, string suffix, bool caseSensitive = false){ @@ -3424,7 +4147,16 @@ public bool endsWith(string str, string suffix, bool caseSensitive = false){ return m_ts.fn_endsWith(str, suffix, caseSensitive); } /// -/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from a COLLADA file and store it in a GuiTreeView control. This function is used by the COLLADA import gui to show a preview of the scene contents prior to import, and is probably not much use for anything else. @param shapePath COLLADA filename @param ctrl GuiTreeView control to add elements to @return true if successful, false otherwise @ingroup Editors @internal) +/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from +/// a COLLADA file and store it in a GuiTreeView control. This function is +/// used by the COLLADA import gui to show a preview of the scene contents +/// prior to import, and is probably not much use for anything else. +/// @param shapePath COLLADA filename +/// @param ctrl GuiTreeView control to add elements to +/// @return true if successful, false otherwise +/// @ingroup Editors +/// @internal) +/// /// public bool enumColladaForImport(string shapePath, string ctrl){ @@ -3432,7 +4164,14 @@ public bool enumColladaForImport(string shapePath, string ctrl){ return m_ts.fn_enumColladaForImport(shapePath, ctrl); } /// -/// ), @brief Returns a list of classes that derive from the named class. If the named class is omitted this dumps all the classes. @param className The optional base class name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// ), +/// @brief Returns a list of classes that derive from the named class. +/// If the named class is omitted this dumps all the classes. +/// @param className The optional base class name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string enumerateConsoleClasses(string className = ""){ @@ -3440,7 +4179,12 @@ public string enumerateConsoleClasses(string className = ""){ return m_ts.fn_enumerateConsoleClasses(className); } /// -/// @brief Provide a list of classes that belong to the given category. @param category The category name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// @brief Provide a list of classes that belong to the given category. +/// @param category The category name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string enumerateConsoleClassesByCategory(string category){ @@ -3449,6 +4193,7 @@ public string enumerateConsoleClassesByCategory(string category){ } /// /// eval(consoleString) ) +/// /// public string eval(string consoleString){ @@ -3456,7 +4201,17 @@ public string eval(string consoleString){ return m_ts.fn_eval(consoleString); } /// -/// @brief Used to exclude/prevent all other instances using the same identifier specified @note Not used on OSX, Xbox, or in Win debug builds @param appIdentifier Name of the app set up for exclusive use. @return False if another app is running that specified the same appIdentifier @ingroup Platform @ingroup GuiCore) +/// @brief Used to exclude/prevent all other instances using the same identifier specified +/// +/// @note Not used on OSX, Xbox, or in Win debug builds +/// +/// @param appIdentifier Name of the app set up for exclusive use. +/// +/// @return False if another app is running that specified the same appIdentifier +/// +/// @ingroup Platform +/// @ingroup GuiCore) +/// /// public bool excludeOtherInstance(string appIdentifer){ @@ -3464,7 +4219,19 @@ public bool excludeOtherInstance(string appIdentifer){ return m_ts.fn_excludeOtherInstance(appIdentifer); } /// -/// Execute the given script file. @param fileName Path to the file to execute @param noCalls Deprecated @param journalScript Deprecated @return True if the script was successfully executed, false if not. @tsexample // Execute the init.cs script file found in the same directory as the current script file. exec( \"./init.cs\" ); @endtsexample @see compile @see eval @ingroup Scripting ) +/// Execute the given script file. +/// @param fileName Path to the file to execute +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if the script was successfully executed, false if not. +/// @tsexample +/// // Execute the init.cs script file found in the same directory as the current script file. +/// exec( \"./init.cs\" ); +/// @endtsexample +/// @see compile +/// @see eval +/// @ingroup Scripting ) +/// /// public bool exec(string fileName, bool noCalls = false, bool journalScript = false){ @@ -3472,7 +4239,20 @@ public bool exec(string fileName, bool noCalls = false, bool journalScript = fa return m_ts.fn_exec(fileName, noCalls, journalScript); } /// -/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their respective escape sequences. All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). The primary use of this function is for converting strings suitable for being passed as string literals to the TorqueScript compiler. @param text A string @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective escape sequences. @tsxample expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". @endtsxample @see collapseEscape @ingroup Strings) +/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their +/// respective escape sequences. +/// All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). +/// The primary use of this function is for converting strings suitable for being passed as string literals +/// to the TorqueScript compiler. +/// @param text A string +/// @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective +/// escape sequences. +/// @tsxample +/// expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". +/// @endtsxample +/// @see collapseEscape +/// @ingroup Strings) +/// /// public string expandEscape(string text){ @@ -3480,7 +4260,23 @@ public string expandEscape(string text){ return m_ts.fn_expandEscape(text); } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void export(string pattern, string filename = "", bool append = false){ @@ -3488,7 +4284,17 @@ public void export(string pattern, string filename = "", bool append = false){ m_ts.fn_export(pattern, filename, append); } /// -/// Export specified font to the specified filename as a PNG. The image can then be processed in Photoshop or another tool and reimported using importCachedFont. Characters in the font are exported as one long strip. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the output PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Export specified font to the specified filename as a PNG. The +/// image can then be processed in Photoshop or another tool and +/// reimported using importCachedFont. Characters in the font are +/// exported as one long strip. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the output PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void exportCachedFont(string faceName, int fontSize, string fileName, int padding, int kerning){ @@ -3496,7 +4302,10 @@ public void exportCachedFont(string faceName, int fontSize, string fileName, in m_ts.fn_exportCachedFont(faceName, fontSize, fileName, padding, kerning); } /// -/// Create a XML document containing a dump of the entire exported engine API. @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. @ingroup Console ) +/// Create a XML document containing a dump of the entire exported engine API. +/// @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. +/// @ingroup Console ) +/// /// public string exportEngineAPIToXML(){ @@ -3504,7 +4313,23 @@ public string exportEngineAPIToXML(){ return m_ts.fn_exportEngineAPIToXML(); } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void exportToSettings(string pattern, string filename = "", bool append = false){ @@ -3512,7 +4337,12 @@ public void exportToSettings(string pattern, string filename = "", bool append m_ts.fn_exportToSettings(pattern, filename, append); } /// -/// @brief Get the base of a file name (removes extension) @param fileName Name and path of file to check @return String containing the file name, minus extension @ingroup FileSystem) +/// @brief Get the base of a file name (removes extension and path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus extension and path +/// @ingroup FileSystem) +/// /// public string fileBase(string fileName){ @@ -3520,7 +4350,12 @@ public string fileBase(string fileName){ return m_ts.fn_fileBase(fileName); } /// -/// @brief Returns a platform specific formatted string with the creation time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the creation time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fileCreatedTime(string fileName){ @@ -3528,7 +4363,13 @@ public string fileCreatedTime(string fileName){ return m_ts.fn_fileCreatedTime(fileName); } /// -/// @brief Delete a file from the hard drive @param path Name and path of the file to delete @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. @return True if file was successfully deleted @ingroup FileSystem) +/// @brief Delete a file from the hard drive +/// +/// @param path Name and path of the file to delete +/// @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. +/// @return True if file was successfully deleted +/// @ingroup FileSystem) +/// /// public bool fileDelete(string path){ @@ -3536,7 +4377,12 @@ public bool fileDelete(string path){ return m_ts.fn_fileDelete(path); } /// -/// @brief Get the extension of a file @param fileName Name and path of file @return String containing the extension, such as \".exe\" or \".cs\" @ingroup FileSystem) +/// @brief Get the extension of a file +/// +/// @param fileName Name and path of file +/// @return String containing the extension, such as \".exe\" or \".cs\" +/// @ingroup FileSystem) +/// /// public string fileExt(string fileName){ @@ -3544,7 +4390,12 @@ public string fileExt(string fileName){ return m_ts.fn_fileExt(fileName); } /// -/// @brief Returns a platform specific formatted string with the last modified time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the last modified time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fileModifiedTime(string fileName){ @@ -3552,7 +4403,12 @@ public string fileModifiedTime(string fileName){ return m_ts.fn_fileModifiedTime(fileName); } /// -/// @brief Get the file name of a file (removes extension and path) @param fileName Name and path of file to check @return String containing the file name, minus extension and path @ingroup FileSystem) +/// @brief Get only the file name of a path and file name string (removes path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus the path +/// @ingroup FileSystem) +/// /// public string fileName(string fileName){ @@ -3560,7 +4416,12 @@ public string fileName(string fileName){ return m_ts.fn_fileName(fileName); } /// -/// @brief Get the path of a file (removes name and extension) @param fileName Name and path of file to check @return String containing the path, minus name and extension @ingroup FileSystem) +/// @brief Get the path of a file (removes name and extension) +/// +/// @param fileName Name and path of file to check +/// @return String containing the path, minus name and extension +/// @ingroup FileSystem) +/// /// public string filePath(string fileName){ @@ -3568,7 +4429,13 @@ public string filePath(string fileName){ return m_ts.fn_filePath(fileName); } /// -/// @brief Determines the size of a file on disk @param fileName Name and path of the file to check @return Returns filesize in KB, or -1 if no file @ingroup FileSystem) +/// @brief Determines the size of a file on disk +/// +/// @param fileName Name and path of the file to check +/// @return Returns filesize in KB, or -1 if no file +/// +/// @ingroup FileSystem) +/// /// public int fileSize(string fileName){ @@ -3576,7 +4443,30 @@ public int fileSize(string fileName){ return m_ts.fn_fileSize(fileName); } /// -/// @brief Replaces the characters in a string with designated text Uses the bad word filter to determine which characters within the string will be replaced. @param baseString The original string to filter. @param replacementChars A string containing letters you wish to swap in the baseString. @return The new scrambled string @see addBadWord() @see containsBadWords() @tsexample // Create the base string, can come from anywhere %baseString = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // Filter the string %newString = filterString(%baseString, %replacementChars); // Print the new string to console echo(%newString); @endtsexample @ingroup Game) +/// @brief Replaces the characters in a string with designated text +/// +/// Uses the bad word filter to determine which characters within the string will be replaced. +/// +/// @param baseString The original string to filter. +/// @param replacementChars A string containing letters you wish to swap in the baseString. +/// @return The new scrambled string +/// +/// @see addBadWord() +/// @see containsBadWords() +/// +/// @tsexample +/// // Create the base string, can come from anywhere +/// %baseString = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // Filter the string +/// %newString = filterString(%baseString, %replacementChars); +/// // Print the new string to console +/// echo(%newString); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public string filterString(string baseString = null , string replacementChars = null ){ if (baseString== null) {baseString = null;} @@ -3586,7 +4476,34 @@ public string filterString(string baseString = null , string replacementChars = return m_ts.fn_filterString(baseString, replacementChars); } /// -/// @brief Returns the first file in the directory system matching the given pattern. Use the corresponding findNextFile() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCount(). This function differs from findFirstFileMultiExpr() in that it supports a single search pattern being passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return The path of the first file matched by the search or an empty string if no matching file could be found. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findNextFile() @see getFileCount() @see findFirstFileMultiExpr() @ingroup FileSearches ) +/// @brief Returns the first file in the directory system matching the given pattern. +/// +/// Use the corresponding findNextFile() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCount(). +/// +/// This function differs from findFirstFileMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. +/// @return The path of the first file matched by the search or an empty string if no matching file could be found. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findNextFile() +/// @see getFileCount() +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches ) +/// /// public string findFirstFile(string pattern, bool recurse = true){ @@ -3594,7 +4511,42 @@ public string findFirstFile(string pattern, bool recurse = true){ return m_ts.fn_findFirstFile(pattern, recurse); } /// -/// @brief Returns the first file in the directory system matching the given patterns. Use the corresponding findNextFileMultiExpr() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCountMultiExpr(). This function differs from findFirstFile() in that it supports multiple search patterns to be passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename patterns. @return String of the first matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findNextFileMultiExpr() @see getFileCountMultiExpr() @see findFirstFile() @ingroup FileSearches) +/// @brief Returns the first file in the directory system matching the given patterns. +/// +/// Use the corresponding findNextFileMultiExpr() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCountMultiExpr(). +/// +/// This function differs from findFirstFile() in that it supports multiple search patterns +/// to be passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename patterns. +/// @return String of the first matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findNextFileMultiExpr() +/// @see getFileCountMultiExpr() +/// @see findFirstFile() +/// @ingroup FileSearches) +/// /// public string findFirstFileMultiExpr(string pattern, bool recurse = true){ @@ -3602,7 +4554,22 @@ public string findFirstFileMultiExpr(string pattern, bool recurse = true){ return m_ts.fn_findFirstFileMultiExpr(pattern, recurse); } /// -/// ), @brief Returns the next file matching a search begun in findFirstFile(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return The path of the next filename matched by the search or an empty string if no more files match. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findFirstFile() @ingroup FileSearches ) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFile(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return The path of the next filename matched by the search or an empty string if no more files match. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @ingroup FileSearches ) +/// /// public string findNextFile(string pattern = ""){ @@ -3610,7 +4577,28 @@ public string findNextFile(string pattern = ""){ return m_ts.fn_findNextFile(pattern); } /// -/// ), @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return String of the next matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findFirstFileMultiExpr() @ingroup FileSearches) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return String of the next matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches) +/// /// public string findNextFileMultiExpr(string pattern = ""){ @@ -3618,7 +4606,16 @@ public string findNextFileMultiExpr(string pattern = ""){ return m_ts.fn_findNextFileMultiExpr(pattern); } /// -/// Return the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return The word at index 0 in @a text or \"\" if @a text is empty. @note This is equal to @tsexample_nopar getWord( text, 0 ) @endtsexample @see getWord @ingroup FieldManip ) +/// Return the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return The word at index 0 in @a text or \"\" if @a text is empty. +/// @note This is equal to +/// @tsexample_nopar +/// getWord( text, 0 ) +/// @endtsexample +/// @see getWord +/// @ingroup FieldManip ) +/// /// public string firstWord(string text){ @@ -3626,7 +4623,13 @@ public string firstWord(string text){ return m_ts.fn_firstWord(text); } /// -/// @brief Flags all currently allocated GFX resources. Used for resource allocation and leak tracking by flagging current resources then dumping a list of unflagged resources at some later point in execution. @ingroup GFX @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// @brief Flags all currently allocated GFX resources. +/// Used for resource allocation and leak tracking by flagging +/// current resources then dumping a list of unflagged resources +/// at some later point in execution. +/// @ingroup GFX +/// @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void flagCurrentGFXResources(){ @@ -3634,7 +4637,9 @@ public void flagCurrentGFXResources(){ m_ts.fn_flagCurrentGFXResources(); } /// -/// Releases all textures and resurrects the texture manager. @ingroup GFX ) +/// Releases all textures and resurrects the texture manager. +/// @ingroup GFX ) +/// /// public void flushTextureCache(){ @@ -3642,7 +4647,9 @@ public void flushTextureCache(){ m_ts.fn_flushTextureCache(); } /// -/// Returns the count of active DDSs files in memory. @ingroup Rendering ) +/// Returns the count of active DDSs files in memory. +/// @ingroup Rendering ) +/// /// public int getActiveDDSFiles(){ @@ -3650,7 +4657,9 @@ public int getActiveDDSFiles(){ return m_ts.fn_getActiveDDSFiles(); } /// -/// Returns the active light manager name. @ingroup Lighting ) +/// Returns the active light manager name. +/// @ingroup Lighting ) +/// /// public string getActiveLightManager(){ @@ -3658,7 +4667,9 @@ public string getActiveLightManager(){ return m_ts.fn_getActiveLightManager(); } /// -/// Get the version of the application build, as a string. @ingroup Debugging) +/// Get the version of the application build, as a string. +/// @ingroup Debugging) +/// /// public int getAppVersionNumber(){ @@ -3666,7 +4677,9 @@ public int getAppVersionNumber(){ return m_ts.fn_getAppVersionNumber(); } /// -/// Get the version of the aplication build, as a human readable string. @ingroup Debugging) +/// Get the version of the aplication build, as a human readable string. +/// @ingroup Debugging) +/// /// public string getAppVersionString(){ @@ -3674,7 +4687,9 @@ public string getAppVersionString(){ return m_ts.fn_getAppVersionString(); } /// -/// Returns the best texture format for storage of HDR data for the active device. @ingroup GFX ) +/// Returns the best texture format for storage of HDR data for the active device. +/// @ingroup GFX ) +/// /// public TypeGFXFormat getBestHDRFormat(){ @@ -3682,7 +4697,10 @@ public TypeGFXFormat getBestHDRFormat(){ return (TypeGFXFormat)( m_ts.fn_getBestHDRFormat()); } /// -/// Returns image info in the following format: width TAB height TAB bytesPerPixel. It will return an empty string if the file is not found. @ingroup Rendering ) +/// Returns image info in the following format: width TAB height TAB bytesPerPixel. +/// It will return an empty string if the file is not found. +/// @ingroup Rendering ) +/// /// public string getBitmapInfo(string filename){ @@ -3690,7 +4708,11 @@ public string getBitmapInfo(string filename){ return m_ts.fn_getBitmapInfo(filename); } /// -/// Get the center point of an axis-aligned box. @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" @return Center of the box. @ingroup Math) +/// Get the center point of an axis-aligned box. +/// @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" +/// @return Center of the box. +/// @ingroup Math) +/// /// public Point3F getBoxCenter(Box3F box){ @@ -3698,7 +4720,9 @@ public Point3F getBoxCenter(Box3F box){ return new Point3F ( m_ts.fn_getBoxCenter(box.AsString())); } /// -/// Get the type of build, \"Debug\" or \"Release\". @ingroup Debugging) +/// Get the type of build, \"Debug\" or \"Release\". +/// @ingroup Debugging) +/// /// public string getBuildString(){ @@ -3706,7 +4730,10 @@ public string getBuildString(){ return m_ts.fn_getBuildString(); } /// -/// @brief Returns the category of the given class. @param className The name of the class. @ingroup Console) +/// @brief Returns the category of the given class. +/// @param className The name of the class. +/// @ingroup Console) +/// /// public string getCategoryOfClass(string className){ @@ -3725,7 +4752,9 @@ public string getClipboard(){ return m_ts.fn_getClipboard(); } /// -/// Get the time of compilation. @ingroup Debugging) +/// Get the time of compilation. +/// @ingroup Debugging) +/// /// public string getCompileTimeString(){ @@ -3733,7 +4762,11 @@ public string getCompileTimeString(){ return m_ts.fn_getCompileTimeString(); } /// -/// () @brief Gets the primary LangTable used by the game @return ID of the core LangTable @ingroup Localization) +/// () +/// @brief Gets the primary LangTable used by the game +/// @return ID of the core LangTable +/// @ingroup Localization) +/// /// public int getCoreLangTable(){ @@ -3741,7 +4774,10 @@ public int getCoreLangTable(){ return m_ts.fn_getCoreLangTable(); } /// -/// @brief Returns the current %ActionMap. @see ActionMap @ingroup Input) +/// @brief Returns the current %ActionMap. +/// @see ActionMap +/// @ingroup Input) +/// /// public string getCurrentActionMap(){ @@ -3749,7 +4785,12 @@ public string getCurrentActionMap(){ return m_ts.fn_getCurrentActionMap(); } /// -/// @brief Return the current working directory. @return The absolute path of the current working directory. @note Only present in a Tools build of Torque. @see getWorkingDirectory() @ingroup FileSystem) +/// @brief Return the current working directory. +/// @return The absolute path of the current working directory. +/// @note Only present in a Tools build of Torque. +/// @see getWorkingDirectory() +/// @ingroup FileSystem) +/// /// public string getCurrentDirectory(){ @@ -3757,7 +4798,11 @@ public string getCurrentDirectory(){ return m_ts.fn_getCurrentDirectory(); } /// -/// @brief Returns the description string for the named class. @param className The name of the class. @return The class description in string format. @ingroup Console) +/// @brief Returns the description string for the named class. +/// @param className The name of the class. +/// @return The class description in string format. +/// @ingroup Console) +/// /// public string getDescriptionOfClass(string className){ @@ -3766,6 +4811,7 @@ public string getDescriptionOfClass(string className){ } /// /// Returns the width, height, and bitdepth of the screen/desktop.@ingroup GFX ) +/// /// public Point3F getDesktopResolution(){ @@ -3773,7 +4819,14 @@ public Point3F getDesktopResolution(){ return new Point3F ( m_ts.fn_getDesktopResolution()); } /// -/// @brief Gathers a list of directories starting at the given path. @param path String containing the path of the directory @param depth Depth of search, as in how many subdirectories to parse through @return Tab delimited string containing list of directories found during search, \"\" if no files were found @ingroup FileSystem) +/// @brief Gathers a list of directories starting at the given path. +/// +/// @param path String containing the path of the directory +/// @param depth Depth of search, as in how many subdirectories to parse through +/// @return Tab delimited string containing list of directories found during search, \"\" if no files were found +/// +/// @ingroup FileSystem) +/// /// public string getDirectoryList(string path, int depth = 0){ @@ -3781,7 +4834,9 @@ public string getDirectoryList(string path, int depth = 0){ return m_ts.fn_getDirectoryList(path, depth); } /// -/// Get the string describing the active GFX device. @ingroup GFX ) +/// Get the string describing the active GFX device. +/// @ingroup GFX ) +/// /// public string getDisplayDeviceInformation(){ @@ -3789,7 +4844,9 @@ public string getDisplayDeviceInformation(){ return m_ts.fn_getDisplayDeviceInformation(); } /// -/// Returns a tab-seperated string of the detected devices across all adapters. @ingroup GFX ) +/// Returns a tab-seperated string of the detected devices across all adapters. +/// @ingroup GFX ) +/// /// public string getDisplayDeviceList(){ @@ -3797,7 +4854,15 @@ public string getDisplayDeviceList(){ return m_ts.fn_getDisplayDeviceList(); } /// -/// Get the absolute path to the file in which the compiled code for the given script file will be stored. @param scriptFileName %Path to the .cs script file. @return The absolute path to the .dso file for the given script file. @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded from the current paths. @see compile @see getPrefsPath @ingroup Scripting ) +/// Get the absolute path to the file in which the compiled code for the given script file will be stored. +/// @param scriptFileName %Path to the .cs script file. +/// @return The absolute path to the .dso file for the given script file. +/// @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded +/// from the current paths. +/// @see compile +/// @see getPrefsPath +/// @ingroup Scripting ) +/// /// public string getDSOPath(string scriptFileName){ @@ -3805,7 +4870,9 @@ public string getDSOPath(string scriptFileName){ return m_ts.fn_getDSOPath(scriptFileName); } /// -/// Get the name of the engine product that this is running from, as a string. @ingroup Debugging) +/// Get the name of the engine product that this is running from, as a string. +/// @ingroup Debugging) +/// /// public string getEngineName(){ @@ -3814,6 +4881,7 @@ public string getEngineName(){ } /// /// getEventTimeLeft(scheduleId) Get the time left in ms until this event will trigger.) +/// /// public int getEventTimeLeft(int scheduleId){ @@ -3821,7 +4889,11 @@ public int getEventTimeLeft(int scheduleId){ return m_ts.fn_getEventTimeLeft(scheduleId); } /// -/// @brief Gets the name of the game's executable @return String containing this game's executable name @ingroup FileSystem) +/// @brief Gets the name of the game's executable +/// +/// @return String containing this game's executable name +/// @ingroup FileSystem) +/// /// public string getExecutableName(){ @@ -3829,7 +4901,9 @@ public string getExecutableName(){ return m_ts.fn_getExecutableName(); } /// -/// Gets the clients far clipping. ) +/// Gets the clients far clipping. +/// ) +/// /// public float getFarClippingDistance(){ @@ -3837,7 +4911,20 @@ public float getFarClippingDistance(){ return m_ts.fn_getFarClippingDistance(); } /// -/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to extract. @return The field at the given index or \"\" if the index is out of range. @tsexample getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getFields @see getFieldCount @see getWord @see getRecord @ingroup FieldManip ) +/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to extract. +/// @return The field at the given index or \"\" if the index is out of range. +/// @tsexample +/// getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getFields +/// @see getFieldCount +/// @see getWord +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string getField(string text, int index){ @@ -3845,7 +4932,16 @@ public string getField(string text, int index){ return m_ts.fn_getField(text, index); } /// -/// Return the number of newline and/or tab separated fields in @a text. @param text A list of fields separated by newlines and/or tabs. @return The number of newline and/or tab sepearated elements in @a text. @tsexample getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of newline and/or tab separated fields in @a text. +/// @param text A list of fields separated by newlines and/or tabs. +/// @return The number of newline and/or tab sepearated elements in @a text. +/// @tsexample +/// getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int getFieldCount(string text){ @@ -3853,7 +4949,23 @@ public int getFieldCount(string text){ return m_ts.fn_getFieldCount(text); } /// -/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param startIndex The zero-based index of the first field to extract from @a text. @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of fields from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" @endtsexample @see getField @see getFieldCount @see getWords @see getRecords @ingroup FieldManip ) +/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param startIndex The zero-based index of the first field to extract from @a text. +/// @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of fields from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see getFieldCount +/// @see getWords +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string getFields(string text, int startIndex, int endIndex = -1){ @@ -3861,7 +4973,29 @@ public string getFields(string text, int startIndex, int endIndex = -1){ return m_ts.fn_getFields(text, startIndex, endIndex); } /// -/// @brief Returns the number of files in the directory tree that match the given patterns This function differs from getFileCountMultiExpr() in that it supports a single search pattern being passed in. If you're interested in a list of files that match the given pattern and not just the number of files, use findFirstFile() and findNextFile(). @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern counting files in subdirectories. @return Number of files located using the pattern @tsexample // Count the number of .cs files in a subdirectory and its subdirectories. getFileCount( \"subdirectory/*.cs\" ); @endtsexample @see findFirstFile() @see findNextFile() @see getFileCountMultiExpr() @ingroup FileSearches ) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// This function differs from getFileCountMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// If you're interested in a list of files that match the given pattern and not just +/// the number of files, use findFirstFile() and findNextFile(). +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern +/// counting files in subdirectories. +/// @return Number of files located using the pattern +/// +/// @tsexample +/// // Count the number of .cs files in a subdirectory and its subdirectories. +/// getFileCount( \"subdirectory/*.cs\" ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @see findNextFile() +/// @see getFileCountMultiExpr() +/// @ingroup FileSearches ) +/// /// public int getFileCount(string pattern, bool recurse = true){ @@ -3869,7 +5003,27 @@ public int getFileCount(string pattern, bool recurse = true){ return m_ts.fn_getFileCount(pattern, recurse); } /// -/// @brief Returns the number of files in the directory tree that match the given patterns If you're interested in a list of files that match the given patterns and not just the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return Number of files located using the patterns @tsexample // Count all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); @endtsexample @see findFirstFileMultiExpr() @see findNextFileMultiExpr() @ingroup FileSearches) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// If you're interested in a list of files that match the given patterns and not just +/// the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename pattern. +/// @return Number of files located using the patterns +/// +/// @tsexample +/// // Count all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @see findNextFileMultiExpr() +/// @ingroup FileSearches) +/// /// public int getFileCountMultiExpr(string pattern, bool recurse = true){ @@ -3877,7 +5031,14 @@ public int getFileCountMultiExpr(string pattern, bool recurse = true){ return m_ts.fn_getFileCountMultiExpr(pattern, recurse); } /// -/// @brief Provides the CRC checksum of the given file. @param fileName The path to the file. @return The calculated CRC checksum of the file, or -1 if the file could not be found. @ingroup FileSystem) +/// @brief Provides the CRC checksum of the given file. +/// +/// @param fileName The path to the file. +/// @return The calculated CRC checksum of the file, or -1 if the file +/// could not be found. +/// +/// @ingroup FileSystem) +/// /// public int getFileCRC(string fileName){ @@ -3885,7 +5046,28 @@ public int getFileCRC(string fileName){ return m_ts.fn_getFileCRC(fileName); } /// +/// Returns a list of supported shape format extensions separated by tabs. +/// Example output: *.dsq TAB *.dae TAB) +/// +/// +public string getFormatExtensions(){ + + +return m_ts.fn_getFormatExtensions(); +} +/// +/// Returns a list of supported shape formats in filter form. +/// Example output: DSQ Files|*.dsq|COLLADA Files|*.dae|) +/// +/// +public string getFormatFilters(){ + + +return m_ts.fn_getFormatFilters(); +} +/// /// @brief .) +/// /// public Point4F getFrustumOffset(){ @@ -3893,7 +5075,12 @@ public Point4F getFrustumOffset(){ return new Point4F ( m_ts.fn_getFrustumOffset()); } /// -/// (string funcName) @brief Provides the name of the package the function belongs to @param funcName String containing name of the function @return The name of the function's package @ingroup Packages) +/// (string funcName) +/// @brief Provides the name of the package the function belongs to +/// @param funcName String containing name of the function +/// @return The name of the function's package +/// @ingroup Packages) +/// /// public string getFunctionPackage(string funcName){ @@ -3902,6 +5089,7 @@ public string getFunctionPackage(string funcName){ } /// /// getJoystickAxes( instance )) +/// /// public string getJoystickAxes(uint deviceID){ @@ -3909,7 +5097,9 @@ public string getJoystickAxes(uint deviceID){ return m_ts.fn_getJoystickAxes(deviceID); } /// -/// Returns a tab seperated list of light manager names. @ingroup Lighting ) +/// Returns a tab seperated list of light manager names. +/// @ingroup Lighting ) +/// /// public string getLightManagerNames(){ @@ -3917,7 +5107,13 @@ public string getLightManagerNames(){ return m_ts.fn_getLightManagerNames(); } /// -/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. This directory will usually contain all the game assets and, in a user-side game installation, will usually be read-only. @return The path to the main game assets. @ingroup FileSystem) +/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. +/// +/// This directory will usually contain all the game assets and, in a user-side game installation, will usually be +/// read-only. +/// @return The path to the main game assets. +/// @ingroup FileSystem) +/// /// public string getMainDotCsDir(){ @@ -3926,6 +5122,7 @@ public string getMainDotCsDir(){ } /// /// @hide) +/// /// public string getMapEntry(string texName){ @@ -3933,7 +5130,12 @@ public string getMapEntry(string texName){ return m_ts.fn_getMapEntry(texName); } /// -/// (string texName) @brief Returns the name of the material mapped to this texture. If no materials are found, an empty string is returned. @param texName Name of the texture @ingroup Materials) +/// (string texName) +/// @brief Returns the name of the material mapped to this texture. +/// If no materials are found, an empty string is returned. +/// @param texName Name of the texture +/// @ingroup Materials) +/// /// public string getMaterialMapping(string texName){ @@ -3941,7 +5143,12 @@ public string getMaterialMapping(string texName){ return m_ts.fn_getMaterialMapping(texName); } /// -/// Calculate the greater of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The greater value of the two specified values. @ingroup Math ) +/// Calculate the greater of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The greater value of the two specified values. +/// @ingroup Math ) +/// /// public float getMax(float v1, float v2){ @@ -3950,6 +5157,7 @@ public float getMax(float v1, float v2){ } /// /// getMaxFrameAllocation(); ) +/// /// public int getMaxFrameAllocation(){ @@ -3957,7 +5165,13 @@ public int getMaxFrameAllocation(){ return m_ts.fn_getMaxFrameAllocation(); } /// -/// (string namespace, string method) @brief Provides the name of the package the method belongs to @param namespace Class or namespace, such as Player @param method Name of the funciton to search for @return The name of the method's package @ingroup Packages) +/// (string namespace, string method) +/// @brief Provides the name of the package the method belongs to +/// @param namespace Class or namespace, such as Player +/// @param method Name of the funciton to search for +/// @return The name of the method's package +/// @ingroup Packages) +/// /// public string getMethodPackage(string nameSpace, string method){ @@ -3965,7 +5179,12 @@ public string getMethodPackage(string nameSpace, string method){ return m_ts.fn_getMethodPackage(nameSpace, method); } /// -/// Calculate the lesser of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The lesser value of the two specified values. @ingroup Math ) +/// Calculate the lesser of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The lesser value of the two specified values. +/// @ingroup Math ) +/// /// public float getMin(float v1, float v2){ @@ -3973,7 +5192,9 @@ public float getMin(float v1, float v2){ return m_ts.fn_getMin(v1, v2); } /// -/// Get the MissionArea object, if any. @ingroup enviroMisc) +/// Get the MissionArea object, if any. +/// @ingroup enviroMisc) +/// /// public string getMissionAreaServerObject(){ @@ -3981,7 +5202,12 @@ public string getMissionAreaServerObject(){ return m_ts.fn_getMissionAreaServerObject(); } /// -/// (string path) @brief Attempts to extract a mod directory from path. Returns empty string on failure. @param File path of mod folder @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated @internal) +/// (string path) +/// @brief Attempts to extract a mod directory from path. Returns empty string on failure. +/// @param File path of mod folder +/// @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated +/// @internal) +/// /// public string getModNameFromPath(string path){ @@ -4008,7 +5234,9 @@ public string getPackageList(){ return m_ts.fn_getPackageList(); } /// -/// Returns the pixel shader version for the active device. @ingroup GFX ) +/// Returns the pixel shader version for the active device. +/// @ingroup GFX ) +/// /// public float getPixelShaderVersion(){ @@ -4016,7 +5244,10 @@ public float getPixelShaderVersion(){ return m_ts.fn_getPixelShaderVersion(); } /// -/// ([relativeFileName]) @note Appears to be useless in Torque 3D, should be deprecated @internal) +/// ([relativeFileName]) +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @internal) +/// /// public string getPrefsPath(string relativeFileName){ @@ -4024,7 +5255,19 @@ public string getPrefsPath(string relativeFileName){ return m_ts.fn_getPrefsPath(relativeFileName); } /// -/// ( int a, int b ) @brief Returns a random number based on parameters passed in.. If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will return an integer between the specified numbers. @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. @param b Upper bound on the random number. The random number will be = @a b. @return A pseudo-random integer between @a a and @a b, between 0 and a, or a float between 0.0 and 1.1 depending on usage. @note All parameters are optional. @see setRandomSeed @ingroup Random ) +/// ( int a, int b ) +/// @brief Returns a random number based on parameters passed in.. +/// If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one +/// parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will +/// return an integer between the specified numbers. +/// @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. +/// @param b Upper bound on the random number. The random number will be = @a b. +/// @return A pseudo-random integer between @a a and @a b, between 0 and a, or a +/// float between 0.0 and 1.1 depending on usage. +/// @note All parameters are optional. +/// @see setRandomSeed +/// @ingroup Random ) +/// /// public float getRandom(int a = 1, int b = 0){ @@ -4032,7 +5275,10 @@ public float getRandom(int a = 1, int b = 0){ return m_ts.fn_getRandom(a, b); } /// -/// Get the current seed used by the random number generator. @return The current random number generator seed value. @ingroup Random ) +/// Get the current seed used by the random number generator. +/// @return The current random number generator seed value. +/// @ingroup Random ) +/// /// public int getRandomSeed(){ @@ -4040,7 +5286,11 @@ public int getRandomSeed(){ return m_ts.fn_getRandomSeed(); } /// -/// () @brief Return the current real time in milliseconds. Real time is platform defined; typically time since the computer booted. @ingroup Platform) +/// () +/// @brief Return the current real time in milliseconds. +/// Real time is platform defined; typically time since the computer booted. +/// @ingroup Platform) +/// /// public int getRealTime(){ @@ -4048,7 +5298,20 @@ public int getRealTime(){ return m_ts.fn_getRealTime(); } /// -/// Extract the record at the given @a index in the newline-separated list in @a text. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to extract. @return The record at the given index or \"\" if @a index is out of range. @tsexample getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getRecords @see getRecordCount @see getWord @see getField @ingroup FieldManip ) +/// Extract the record at the given @a index in the newline-separated list in @a text. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to extract. +/// @return The record at the given index or \"\" if @a index is out of range. +/// @tsexample +/// getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getRecords +/// @see getRecordCount +/// @see getWord +/// @see getField +/// @ingroup FieldManip ) +/// /// public string getRecord(string text, int index){ @@ -4056,7 +5319,16 @@ public string getRecord(string text, int index){ return m_ts.fn_getRecord(text, index); } /// -/// Return the number of newline-separated records in @a text. @param text A list of records separated by newlines. @return The number of newline-sepearated elements in @a text. @tsexample getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getFieldCount @ingroup FieldManip ) +/// Return the number of newline-separated records in @a text. +/// @param text A list of records separated by newlines. +/// @return The number of newline-sepearated elements in @a text. +/// @tsexample +/// getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getFieldCount +/// @ingroup FieldManip ) +/// /// public int getRecordCount(string text){ @@ -4064,7 +5336,23 @@ public int getRecordCount(string text){ return m_ts.fn_getRecordCount(text); } /// -/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param startIndex The zero-based index of the first record to extract from @a text. @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of records from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" @endtsexample @see getRecord @see getRecordCount @see getWords @see getFields @ingroup FieldManip ) +/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param startIndex The zero-based index of the first record to extract from @a text. +/// @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of records from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see getRecordCount +/// @see getWords +/// @see getFields +/// @ingroup FieldManip ) +/// /// public string getRecords(string text, int startIndex, int endIndex = -1){ @@ -4073,6 +5361,7 @@ public string getRecords(string text, int startIndex, int endIndex = -1){ } /// /// getScheduleDuration(%scheduleId); ) +/// /// public int getScheduleDuration(int scheduleId){ @@ -4081,6 +5370,7 @@ public int getScheduleDuration(int scheduleId){ } /// /// getServerCount(...); ) +/// /// public int getServerCount(){ @@ -4088,7 +5378,11 @@ public int getServerCount(){ return m_ts.fn_getServerCount(); } /// -/// () Return the current sim time in milliseconds. @brief Sim time is time since the game started. @ingroup Platform) +/// () +/// Return the current sim time in milliseconds. +/// @brief Sim time is time since the game started. +/// @ingroup Platform) +/// /// public int getSimTime(){ @@ -4096,7 +5390,19 @@ public int getSimTime(){ return m_ts.fn_getSimTime(); } /// -/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source string length). @param str The string from which to extract a substring. @param start The offset at which to start copying out characters. @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end of the input string are copied. @return A string that contains the given portion of the input string. @tsexample getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". @endtsexample @ingroup Strings ) +/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str +/// (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source +/// string length). +/// @param str The string from which to extract a substring. +/// @param start The offset at which to start copying out characters. +/// @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end +/// of the input string are copied. +/// @return A string that contains the given portion of the input string. +/// @tsexample +/// getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string getSubStr(string str, int start, int numChars = -1){ @@ -4104,7 +5410,20 @@ public string getSubStr(string str, int start, int numChars = -1){ return m_ts.fn_getSubStr(str, start, numChars); } /// -/// ( string textTagString ) @brief Extracts the tag from a tagged string Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. @param textTagString The tagged string to extract. @returns The tag ID of the string. @see \\ref syntaxDataTypes under Tagged %Strings @see detag() @ingroup Networking) +/// ( string textTagString ) +/// @brief Extracts the tag from a tagged string +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. +/// +/// @param textTagString The tagged string to extract. +/// +/// @returns The tag ID of the string. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see detag() +/// @ingroup Networking) +/// /// public string getTag(string textTagString){ @@ -4112,7 +5431,22 @@ public string getTag(string textTagString){ return m_ts.fn_getTag(textTagString); } /// -/// ), @brief Use the getTaggedString function to convert a tag to a string. This is not the same as detag() which can only be used within the context of a function that receives a tag. This function can be used any time and anywhere to convert a tag to a string. @param tag A numeric tag ID. @returns The string as found in the Net String table. @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see removeTaggedString() @ingroup Networking) +/// ), +/// @brief Use the getTaggedString function to convert a tag to a string. +/// +/// This is not the same as detag() which can only be used within the context +/// of a function that receives a tag. This function can be used any time and +/// anywhere to convert a tag to a string. +/// +/// @param tag A numeric tag ID. +/// +/// @returns The string as found in the Net String table. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see removeTaggedString() +/// @ingroup Networking) +/// /// public string getTaggedString(string tag = ""){ @@ -4120,7 +5454,16 @@ public string getTaggedString(string tag = ""){ return m_ts.fn_getTaggedString(tag); } /// -/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example @note This can be useful to adhering to OS standards and practices, but not really used in Torque 3D right now. @note Be very careful when getting into OS level File I/O. @return String containing path to OS temp directory @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example +/// @note This can be useful to adhering to OS standards and practices, +/// but not really used in Torque 3D right now. +/// @note Be very careful when getting into OS level File I/O. +/// @return String containing path to OS temp directory +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string getTemporaryDirectory(){ @@ -4128,7 +5471,14 @@ public string getTemporaryDirectory(){ return m_ts.fn_getTemporaryDirectory(); } /// -/// @brief Creates a name and extension for a potential temporary file This does not create the actual file. It simply creates a random name for a file that does not exist. @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Creates a name and extension for a potential temporary file +/// This does not create the actual file. It simply creates a random name +/// for a file that does not exist. +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string getTemporaryFileName(){ @@ -4136,7 +5486,11 @@ public string getTemporaryFileName(){ return m_ts.fn_getTemporaryFileName(); } /// -/// (Point2 pos) - gets the terrain height at the specified position. @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point2 pos) - gets the terrain height at the specified position. +/// @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float getTerrainHeight(Point2F pos){ @@ -4144,7 +5498,12 @@ public float getTerrainHeight(Point2F pos){ return m_ts.fn_getTerrainHeight(pos.AsString()); } /// -/// (Point3F pos) - gets the terrain height at the specified position. @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) @note This function is useful if you simply want to grab the terrain height underneath an object. @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point3F pos) - gets the terrain height at the specified position. +/// @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) +/// @note This function is useful if you simply want to grab the terrain height underneath an object. +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float getTerrainHeightBelowPosition(Point3F pos){ @@ -4152,7 +5511,12 @@ public float getTerrainHeightBelowPosition(Point3F pos){ return m_ts.fn_getTerrainHeightBelowPosition(pos.AsString()); } /// -/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found). @hide) +/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found). +/// @hide) +/// /// public int getTerrainUnderWorldPoint(Point3F position){ @@ -4160,7 +5524,9 @@ public int getTerrainUnderWorldPoint(Point3F position){ return m_ts.fn_getTerrainUnderWorldPoint(position.AsString()); } /// -/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB @ingroup GFX ) +/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB +/// @ingroup GFX ) +/// /// public string getTextureProfileStats(){ @@ -4169,6 +5535,7 @@ public string getTextureProfileStats(){ } /// /// getTimeSinceStart(%scheduleId); ) +/// /// public int getTimeSinceStart(int scheduleId){ @@ -4176,7 +5543,15 @@ public int getTimeSinceStart(int scheduleId){ return m_ts.fn_getTimeSinceStart(scheduleId); } /// -/// Get the numeric suffix of the given input string. @param str The string from which to read out the numeric suffix. @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. @tsexample getTrailingNumber( \"test123\" ) // Returns '123'. @endtsexample @see stripTrailingNumber @ingroup Strings ) +/// Get the numeric suffix of the given input string. +/// @param str The string from which to read out the numeric suffix. +/// @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. +/// @tsexample +/// getTrailingNumber( \"test123\" ) // Returns '123'. +/// @endtsexample +/// @see stripTrailingNumber +/// @ingroup Strings ) +/// /// public int getTrailingNumber(string str){ @@ -4184,7 +5559,12 @@ public int getTrailingNumber(string str){ return m_ts.fn_getTrailingNumber(str); } /// -/// ( String baseName, SimSet set, bool searchChildren ) @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName, SimSet set, bool searchChildren ) +/// @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string getUniqueInternalName(string baseName, string setString, bool searchChildren){ @@ -4192,7 +5572,13 @@ public string getUniqueInternalName(string baseName, string setString, bool sea return m_ts.fn_getUniqueInternalName(baseName, setString, searchChildren); } /// -/// ( String baseName ) @brief Returns a unique unused SimObject name based on a given base name. @baseName Name to conver to a unique string if another instance exists @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName ) +/// @brief Returns a unique unused SimObject name based on a given base name. +/// @baseName Name to conver to a unique string if another instance exists +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string getUniqueName(string baseName){ @@ -4201,6 +5587,7 @@ public string getUniqueName(string baseName){ } /// /// getUserDataDirectory()) +/// /// public string getUserDataDirectory(){ @@ -4209,6 +5596,7 @@ public string getUserDataDirectory(){ } /// /// getUserHomeDirectory()) +/// /// public string getUserHomeDirectory(){ @@ -4216,7 +5604,12 @@ public string getUserHomeDirectory(){ return m_ts.fn_getUserHomeDirectory(); } /// -/// (string varName) @brief Returns the value of the named variable or an empty string if not found. @varName Name of the variable to search for @return Value contained by varName, \"\" if the variable does not exist @ingroup Scripting) +/// (string varName) +/// @brief Returns the value of the named variable or an empty string if not found. +/// @varName Name of the variable to search for +/// @return Value contained by varName, \"\" if the variable does not exist +/// @ingroup Scripting) +/// /// public string getVariable(string varName){ @@ -4224,7 +5617,9 @@ public string getVariable(string varName){ return m_ts.fn_getVariable(varName); } /// -/// Get the version of the engine build, as a string. @ingroup Debugging) +/// Get the version of the engine build, as a string. +/// @ingroup Debugging) +/// /// public int getVersionNumber(){ @@ -4232,7 +5627,9 @@ public int getVersionNumber(){ return m_ts.fn_getVersionNumber(); } /// -/// Get the version of the engine build, as a human readable string. @ingroup Debugging) +/// Get the version of the engine build, as a human readable string. +/// @ingroup Debugging) +/// /// public string getVersionString(){ @@ -4240,7 +5637,12 @@ public string getVersionString(){ return m_ts.fn_getVersionString(); } /// -/// Test whether Torque is running in web-deployment mode. In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not be able to enter fullscreen exclusive mode). @return True if Torque is running in web-deployment mode. @ingroup Platform ) +/// Test whether Torque is running in web-deployment mode. +/// In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not +/// be able to enter fullscreen exclusive mode). +/// @return True if Torque is running in web-deployment mode. +/// @ingroup Platform ) +/// /// public bool getWebDeployment(){ @@ -4248,7 +5650,20 @@ public bool getWebDeployment(){ return m_ts.fn_getWebDeployment(); } /// -/// Extract the word at the given @a index in the whitespace-separated list in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to extract. @return The word at the given index or \"\" if the index is out of range. @tsexample getWord( \"a b c\", 1 ) // Returns \"b\" @endtsexample @see getWords @see getWordCount @see getField @see getRecord @ingroup FieldManip ) +/// Extract the word at the given @a index in the whitespace-separated list in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to extract. +/// @return The word at the given index or \"\" if the index is out of range. +/// @tsexample +/// getWord( \"a b c\", 1 ) // Returns \"b\" +/// @endtsexample +/// @see getWords +/// @see getWordCount +/// @see getField +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string getWord(string text, int index){ @@ -4256,7 +5671,17 @@ public string getWord(string text, int index){ return m_ts.fn_getWord(text, index); } /// -/// Return the number of whitespace-separated words in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @return The number of whitespace-separated words in @a text. @tsexample getWordCount( \"a b c d e\" ) // Returns 5 @endtsexample @see getFieldCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of whitespace-separated words in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @return The number of whitespace-separated words in @a text. +/// @tsexample +/// getWordCount( \"a b c d e\" ) // Returns 5 +/// @endtsexample +/// @see getFieldCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int getWordCount(string text){ @@ -4264,7 +5689,23 @@ public int getWordCount(string text){ return m_ts.fn_getWordCount(text); } /// -/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param startIndex The zero-based index of the first word to extract from @a text. @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of words from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" @endtsexample @see getWord @see getWordCount @see getFields @see getRecords @ingroup FieldManip ) +/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param startIndex The zero-based index of the first word to extract from @a text. +/// @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of words from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" +/// @endtsexample +/// @see getWord +/// @see getWordCount +/// @see getFields +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string getWords(string text, int startIndex, int endIndex = -1){ @@ -4272,7 +5713,11 @@ public string getWords(string text, int startIndex, int endIndex = -1){ return m_ts.fn_getWords(text, startIndex, endIndex); } /// -/// @brief Reports the current directory @return String containing full file path of working directory @ingroup FileSystem) +/// @brief Reports the current directory +/// +/// @return String containing full file path of working directory +/// @ingroup FileSystem) +/// /// public string getWorkingDirectory(){ @@ -4280,7 +5725,25 @@ public string getWorkingDirectory(){ return m_ts.fn_getWorkingDirectory(); } /// -/// ( int controllerID, string property, bool currentD ) @brief Queries the current state of a connected Xbox 360 controller. XInput Properties: - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. - XI_START, XI_BACK - The Start and Back buttons. - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. @param controllerID Zero-based index of the controller to return information about. @param property Name of input action being queried, such as \"XI_THUMBLX\". @param current True checks current device in action. @return Button queried - 1 if the button is pressed, 0 if it's not. @return Thumbstick queried - Int representing displacement from rest position. @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. @ingroup Input) +/// ( int controllerID, string property, bool currentD ) +/// @brief Queries the current state of a connected Xbox 360 controller. +/// XInput Properties: +/// - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. +/// - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. +/// - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. +/// - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. +/// - XI_START, XI_BACK - The Start and Back buttons. +/// - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. +/// - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. +/// - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. +/// @param controllerID Zero-based index of the controller to return information about. +/// @param property Name of input action being queried, such as \"XI_THUMBLX\". +/// @param current True checks current device in action. +/// @return Button queried - 1 if the button is pressed, 0 if it's not. +/// @return Thumbstick queried - Int representing displacement from rest position. +/// @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. +/// @ingroup Input) +/// /// public int getXInputState(int controllerID, string properties, bool current = false){ @@ -4288,7 +5751,15 @@ public int getXInputState(int controllerID, string properties, bool current = f return m_ts.fn_getXInputState(controllerID, properties, current); } /// -/// Open the given URL or file in the user's web browser. @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then the function checks whether the address refers to a file or directory and if so, prepends \"file://\" to @a adress; if the file check fails, \"http://\" is prepended to @a address. @tsexample gotoWebPage( \"http://www.garagegames.com\" ); @endtsexample @ingroup Platform ) +/// Open the given URL or file in the user's web browser. +/// @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then +/// the function checks whether the address refers to a file or directory and if so, prepends \"file://\" +/// to @a adress; if the file check fails, \"http://\" is prepended to @a address. +/// @tsexample +/// gotoWebPage( \"http://www.garagegames.com\" ); +/// @endtsexample +/// @ingroup Platform ) +/// /// public void gotoWebPage(string address){ @@ -4296,7 +5767,15 @@ public void gotoWebPage(string address){ m_ts.fn_gotoWebPage(address); } /// -/// Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the input PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Import an image strip from exportCachedFont. Call with the +/// same parameters you called exportCachedFont. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the input PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void importCachedFont(string faceName, int fontSize, string fileName, int padding, int kerning){ @@ -4304,7 +5783,17 @@ public void importCachedFont(string faceName, int fontSize, string fileName, in m_ts.fn_importCachedFont(faceName, fontSize, fileName, padding, kerning); } /// -/// @brief Start a search for items at the given position and within the given radius, filtering by mask. @param pos Center position for the search @param radius Search radius @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for items at the given position and within the given radius, filtering by mask. +/// +/// @param pos Center position for the search +/// @param radius Search radius +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void initContainerRadiusSearch(Point3F pos, float radius, uint mask, bool useClientContainer = false){ @@ -4312,7 +5801,15 @@ public void initContainerRadiusSearch(Point3F pos, float radius, uint mask, boo m_ts.fn_initContainerRadiusSearch(pos.AsString(), radius, mask, useClientContainer); } /// -/// @brief Start a search for all items of the types specified by the bitset mask. @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for all items of the types specified by the bitset mask. +/// +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void initContainerTypeSearch(uint mask, bool useClientContainer = false){ @@ -4320,7 +5817,10 @@ public void initContainerTypeSearch(uint mask, bool useClientContainer = false) m_ts.fn_initContainerTypeSearch(mask, useClientContainer); } /// -/// () @brief Initializes variables that track device and vendor information/IDs @ingroup Rendering) +/// () +/// @brief Initializes variables that track device and vendor information/IDs +/// @ingroup Rendering) +/// /// public void initDisplayDeviceInfo(){ @@ -4328,7 +5828,14 @@ public void initDisplayDeviceInfo(){ m_ts.fn_initDisplayDeviceInfo(); } /// -/// Test whether the character at the given position is an alpha-numeric character. Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. @see isspace @ingroup Strings ) +/// Test whether the character at the given position is an alpha-numeric character. +/// Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. +/// @see isspace +/// @ingroup Strings ) +/// /// public bool isalnum(string str, int index){ @@ -4336,7 +5843,9 @@ public bool isalnum(string str, int index){ return m_ts.fn_isalnum(str, index); } /// -/// @brief Returns true if the passed identifier is the name of a declared class. @ingroup Console) +/// @brief Returns true if the passed identifier is the name of a declared class. +/// @ingroup Console) +/// /// public bool isClass(string identifier){ @@ -4344,7 +5853,10 @@ public bool isClass(string identifier){ return m_ts.fn_isClass(identifier); } /// -/// () Returns true if the calling script is a tools script. @hide) +/// () +/// Returns true if the calling script is a tools script. +/// @hide) +/// /// public bool isCurrentScriptToolScript(){ @@ -4352,7 +5864,10 @@ public bool isCurrentScriptToolScript(){ return m_ts.fn_isCurrentScriptToolScript(); } /// -/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. @return True if this is a debug build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. +/// @return True if this is a debug build; false otherwise. +/// @ingroup Platform ) +/// /// public bool isDebugBuild(){ @@ -4360,7 +5875,15 @@ public bool isDebugBuild(){ return m_ts.fn_isDebugBuild(); } /// -/// ) , (string varName) @brief Determines if a variable exists and contains a value @param varName Name of the variable to search for @return True if the variable was defined in script, false if not @tsexample isDefined( \"$myVar\" ); @endtsexample @ingroup Scripting) +/// ) , (string varName) +/// @brief Determines if a variable exists and contains a value +/// @param varName Name of the variable to search for +/// @return True if the variable was defined in script, false if not +/// @tsexample +/// isDefined( \"$myVar\" ); +/// @endtsexample +/// @ingroup Scripting) +/// /// public bool isDefined(string varName, string varValue = ""){ @@ -4369,6 +5892,7 @@ public bool isDefined(string varName, string varValue = ""){ } /// /// ) +/// /// public bool isDemo(){ @@ -4376,7 +5900,15 @@ public bool isDemo(){ return m_ts.fn_isDemo(); } /// -/// @brief Determines if a specified directory exists or not @param directory String containing path in the form of \"foo/bar\" @return Returns true if the directory was found. @note Do not include a trailing slash '/'. @ingroup FileSystem) +/// @brief Determines if a specified directory exists or not +/// +/// @param directory String containing path in the form of \"foo/bar\" +/// @return Returns true if the directory was found. +/// +/// @note Do not include a trailing slash '/'. +/// +/// @ingroup FileSystem) +/// /// public bool IsDirectory(string directory){ @@ -4385,6 +5917,7 @@ public bool IsDirectory(string directory){ } /// /// isEventPending(%scheduleId);) +/// /// public bool isEventPending(int scheduleId){ @@ -4392,7 +5925,13 @@ public bool isEventPending(int scheduleId){ return m_ts.fn_isEventPending(scheduleId); } /// -/// @brief Determines if the specified file exists or not @param fileName The path to the file. @return Returns true if the file was found. @ingroup FileSystem) +/// @brief Determines if the specified file exists or not +/// +/// @param fileName The path to the file. +/// @return Returns true if the file was found. +/// +/// @ingroup FileSystem) +/// /// public bool isFile(string fileName){ @@ -4400,7 +5939,12 @@ public bool isFile(string fileName){ return m_ts.fn_isFile(fileName); } /// -/// (string funcName) @brief Determines if a function exists or not @param funcName String containing name of the function @return True if the function exists, false if not @ingroup Scripting) +/// (string funcName) +/// @brief Determines if a function exists or not +/// @param funcName String containing name of the function +/// @return True if the function exists, false if not +/// @ingroup Scripting) +/// /// public bool isFunction(string funcName){ @@ -4409,6 +5953,7 @@ public bool isFunction(string funcName){ } /// /// isJoystickDetected()) +/// /// public bool isJoystickDetected(){ @@ -4416,7 +5961,11 @@ public bool isJoystickDetected(){ return m_ts.fn_isJoystickDetected(); } /// -/// () @brief Queries input manager to see if a joystick is enabled @return 1 if a joystick exists and is enabled, 0 if it's not. @ingroup Input) +/// () +/// @brief Queries input manager to see if a joystick is enabled +/// @return 1 if a joystick exists and is enabled, 0 if it's not. +/// @ingroup Input) +/// /// public bool isJoystickEnabled(){ @@ -4425,6 +5974,7 @@ public bool isJoystickEnabled(){ } /// /// isKoreanBuild()) +/// /// public bool isKoreanBuild(){ @@ -4432,7 +5982,12 @@ public bool isKoreanBuild(){ return m_ts.fn_isKoreanBuild(); } /// -/// @brief Returns true if the class is derived from the super class. If either class doesn't exist this returns false. @param className The class name. @param superClassName The super class to look for. @ingroup Console) +/// @brief Returns true if the class is derived from the super class. +/// If either class doesn't exist this returns false. +/// @param className The class name. +/// @param superClassName The super class to look for. +/// @ingroup Console) +/// /// public bool isMemberOfClass(string className, string superClassName){ @@ -4440,7 +5995,13 @@ public bool isMemberOfClass(string className, string superClassName){ return m_ts.fn_isMemberOfClass(className, superClassName); } /// -/// (string namespace, string method) @brief Determines if a class/namespace method exists @param namespace Class or namespace, such as Player @param method Name of the function to search for @return True if the method exists, false if not @ingroup Scripting) +/// (string namespace, string method) +/// @brief Determines if a class/namespace method exists +/// @param namespace Class or namespace, such as Player +/// @param method Name of the function to search for +/// @return True if the method exists, false if not +/// @ingroup Scripting) +/// /// public bool isMethod(string nameSpace, string method){ @@ -4449,6 +6010,7 @@ public bool isMethod(string nameSpace, string method){ } /// /// isObject(object)) +/// /// public bool isObject(string objectName){ @@ -4466,7 +6028,11 @@ public bool isPackage(string identifier){ return m_ts.fn_isPackage(identifier); } /// -/// (string queueName) @brief Determines if a dispatcher queue exists @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Determines if a dispatcher queue exists +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public bool isQueueRegistered(string queueName){ @@ -4474,7 +6040,10 @@ public bool isQueueRegistered(string queueName){ return m_ts.fn_isQueueRegistered(queueName); } /// -/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. @return True if this is a shipping build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. +/// @return True if this is a shipping build; false otherwise. +/// @ingroup Platform ) +/// /// public bool isShippingBuild(){ @@ -4482,7 +6051,14 @@ public bool isShippingBuild(){ return m_ts.fn_isShippingBuild(); } /// -/// Test whether the character at the given position is a whitespace character. Characters such as tab, space, or newline are considered whitespace. @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is a whitespace character; false otherwise. @see isalnum @ingroup Strings ) +/// Test whether the character at the given position is a whitespace character. +/// Characters such as tab, space, or newline are considered whitespace. +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is a whitespace character; false otherwise. +/// @see isalnum +/// @ingroup Strings ) +/// /// public bool isspace(string str, int index){ @@ -4490,7 +6066,10 @@ public bool isspace(string str, int index){ return m_ts.fn_isspace(str, index); } /// -/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. @return True if this is a tool build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. +/// @return True if this is a tool build; false otherwise. +/// @ingroup Platform ) +/// /// public bool isToolBuild(){ @@ -4498,7 +6077,12 @@ public bool isToolBuild(){ return m_ts.fn_isToolBuild(); } /// -/// ( string name ) @brief Return true if the given name makes for a valid object name. @param name Name of object @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character @ingroup Console) +/// ( string name ) +/// @brief Return true if the given name makes for a valid object name. +/// @param name Name of object +/// @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character +/// @ingroup Console) +/// /// public bool isValidObjectName(string name){ @@ -4507,6 +6091,7 @@ public bool isValidObjectName(string name){ } /// /// ) +/// /// public bool isWebDemo(){ @@ -4514,7 +6099,13 @@ public bool isWebDemo(){ return m_ts.fn_isWebDemo(); } /// -/// @brief Determines if a file name can be written to using File I/O @param fileName Name and path of file to check @return Returns true if the file can be written to. @ingroup FileSystem) +/// @brief Determines if a file name can be written to using File I/O +/// +/// @param fileName Name and path of file to check +/// @return Returns true if the file can be written to. +/// +/// @ingroup FileSystem) +/// /// public bool isWriteableFileName(string fileName){ @@ -4522,7 +6113,13 @@ public bool isWriteableFileName(string fileName){ return m_ts.fn_isWriteableFileName(fileName); } /// -/// ( int controllerID ) @brief Checks to see if an Xbox 360 controller is connected @param controllerID Zero-based index of the controller to check. @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput hasn't been initialized. @ingroup Input) +/// ( int controllerID ) +/// @brief Checks to see if an Xbox 360 controller is connected +/// @param controllerID Zero-based index of the controller to check. +/// @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput +/// hasn't been initialized. +/// @ingroup Input) +/// /// public bool isXInputConnected(int controllerID){ @@ -4530,7 +6127,15 @@ public bool isXInputConnected(int controllerID){ return m_ts.fn_isXInputConnected(controllerID); } /// -/// Will generate static lighting for the scene if supported by the active light manager. If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps will be regenerated only if the lighting cache files can be written. @param completeCallbackFn The name of the function to execute when the lighting is complete. @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". @return Returns true if the scene lighting process was started. @ingroup Lighting ) +/// Will generate static lighting for the scene if supported by the active light manager. +/// If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether +/// lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps +/// will be regenerated only if the lighting cache files can be written. +/// @param completeCallbackFn The name of the function to execute when the lighting is complete. +/// @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". +/// @return Returns true if the scene lighting process was started. +/// @ingroup Lighting ) +/// /// public bool lightScene(string completeCallbackFn = null , string mode = null ){ if (completeCallbackFn== null) {completeCallbackFn = null;} @@ -4540,7 +6145,10 @@ public bool lightScene(string completeCallbackFn = null , string mode = null ){ return m_ts.fn_lightScene(completeCallbackFn, mode); } /// -/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void listGFXResources(bool unflaggedOnly = false){ @@ -4548,7 +6156,29 @@ public void listGFXResources(bool unflaggedOnly = false){ m_ts.fn_listGFXResources(unflaggedOnly); } /// -/// , ), (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) Load all light instances from a COLLADA (.dae) file and add to the scene. @param filename COLLADA filename to load lights from @param parentGroup (optional) name of an existing simgroup to add the new lights to (defaults to MissionGroup) @param baseObject (optional) name of an object to use as the origin (useful if you are loading the lights for a collada scene and have moved or rotated the geometry) @return true if successful, false otherwise @tsexample // load the lights in room.dae loadColladaLights( \"art/shapes/collada/room.dae\" ); // load the lights in room.dae and add them to the RoomLights group loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); // load the lights in room.dae and use the transform of the \"Room\" object as the origin loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); @endtsexample @note Currently for editor use only @ingroup Editors @internal) +/// , ), +/// (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) +/// Load all light instances from a COLLADA (.dae) file and add to the scene. +/// @param filename COLLADA filename to load lights from +/// @param parentGroup (optional) name of an existing simgroup to add the new +/// lights to (defaults to MissionGroup) +/// @param baseObject (optional) name of an object to use as the origin (useful +/// if you are loading the lights for a collada scene and have moved or rotated +/// the geometry) +/// @return true if successful, false otherwise +/// @tsexample +/// // load the lights in room.dae +/// loadColladaLights( \"art/shapes/collada/room.dae\" ); +/// // load the lights in room.dae and add them to the RoomLights group +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); +/// // load the lights in room.dae and use the transform of the \"Room\" +/// object as the origin +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); +/// @endtsexample +/// @note Currently for editor use only +/// @ingroup Editors +/// @internal) +/// /// public bool loadColladaLights(string filename, string parentGroup = "", string baseObject = ""){ @@ -4556,7 +6186,10 @@ public bool loadColladaLights(string filename, string parentGroup = "", string return m_ts.fn_loadColladaLights(filename, parentGroup, baseObject); } /// -/// @brief Loads a serialized object from a file. @param Name and path to text file containing the object @ingroup Console) +/// @brief Loads a serialized object from a file. +/// @param Name and path to text file containing the object +/// @ingroup Console) +/// /// public string loadObject(string filename){ @@ -4564,7 +6197,11 @@ public string loadObject(string filename){ return m_ts.fn_loadObject(filename); } /// -/// (bool isLocked) @brief Lock or unlock the mouse to the window. When true, prevents the mouse from leaving the bounds of the game window. @ingroup Input) +/// (bool isLocked) +/// @brief Lock or unlock the mouse to the window. +/// When true, prevents the mouse from leaving the bounds of the game window. +/// @ingroup Input) +/// /// public void lockMouse(bool isLocked){ @@ -4608,7 +6245,16 @@ public void logWarning(string message){ m_ts.fn_logWarning(message); } /// -/// Remove leading whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. @tsexample ltrim( \" string \" ); // Returns \"string \". @endtsexample @see rtrim @see trim @ingroup Strings ) +/// Remove leading whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. +/// @tsexample +/// ltrim( \" string \" ); // Returns \"string \". +/// @endtsexample +/// @see rtrim +/// @see trim +/// @ingroup Strings ) +/// /// public string ltrim(string str){ @@ -4616,7 +6262,10 @@ public string ltrim(string str){ return m_ts.fn_ltrim(str); } /// -/// Return the value of 2*PI (full-circle in radians). @returns The value of 2*PI. @ingroup Math ) +/// Return the value of 2*PI (full-circle in radians). +/// @returns The value of 2*PI. +/// @ingroup Math ) +/// /// public float m2Pi(){ @@ -4624,7 +6273,11 @@ public float m2Pi(){ return m_ts.fn_m2Pi(); } /// -/// Calculate absolute value of specified value. @param v Input Value. @returns Absolute value of specified value. @ingroup Math ) +/// Calculate absolute value of specified value. +/// @param v Input Value. +/// @returns Absolute value of specified value. +/// @ingroup Math ) +/// /// public float mAbs(float v){ @@ -4632,7 +6285,11 @@ public float mAbs(float v){ return m_ts.fn_mAbs(v); } /// -/// Calculate the arc-cosine of v. @param v Input Value (in radians). @returns The arc-cosine of the input value. @ingroup Math ) +/// Calculate the arc-cosine of v. +/// @param v Input Value (in radians). +/// @returns The arc-cosine of the input value. +/// @ingroup Math ) +/// /// public float mAcos(float v){ @@ -4640,7 +6297,15 @@ public float mAcos(float v){ return m_ts.fn_mAcos(v); } /// -/// ), @brief Converts a relative file path to a full path For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" @param path Name of file or path to check @param cwd Optional current working directory from which to build the full path. @return String containing non-relative directory of path @ingroup FileSystem) +/// ), +/// @brief Converts a relative file path to a full path +/// +/// For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" +/// @param path Name of file or path to check +/// @param cwd Optional current working directory from which to build the full path. +/// @return String containing non-relative directory of path +/// @ingroup FileSystem) +/// /// public string makeFullPath(string path, string cwd = ""){ @@ -4648,7 +6313,16 @@ public string makeFullPath(string path, string cwd = ""){ return m_ts.fn_makeFullPath(path, cwd); } /// -/// ), @brief Turns a full or local path to a relative one For example, \"./game/art\" becomes \"game/art\" @param path Full path (may include a file) to convert @param to Optional base path used for the conversion. If not supplied the current working directory is used. @returns String containing relative path @ingroup FileSystem) +/// ), +/// @brief Turns a full or local path to a relative one +/// +/// For example, \"./game/art\" becomes \"game/art\" +/// @param path Full path (may include a file) to convert +/// @param to Optional base path used for the conversion. If not supplied the current +/// working directory is used. +/// @returns String containing relative path +/// @ingroup FileSystem) +/// /// public string makeRelativePath(string path, string to = ""){ @@ -4656,7 +6330,11 @@ public string makeRelativePath(string path, string to = ""){ return m_ts.fn_makeRelativePath(path, to); } /// -/// Calculate the arc-sine of v. @param v Input Value (in radians). @returns The arc-sine of the input value. @ingroup Math ) +/// Calculate the arc-sine of v. +/// @param v Input Value (in radians). +/// @returns The arc-sine of the input value. +/// @ingroup Math ) +/// /// public float mAsin(float v){ @@ -4664,7 +6342,12 @@ public float mAsin(float v){ return m_ts.fn_mAsin(v); } /// -/// Calculate the arc-tangent (slope) of a line defined by rise and run. @param rise of line. @param run of line. @returns The arc-tangent (slope) of a line defined by rise and run. @ingroup Math ) +/// Calculate the arc-tangent (slope) of a line defined by rise and run. +/// @param rise of line. +/// @param run of line. +/// @returns The arc-tangent (slope) of a line defined by rise and run. +/// @ingroup Math ) +/// /// public float mAtan(float rise, float run){ @@ -4672,7 +6355,12 @@ public float mAtan(float rise, float run){ return m_ts.fn_mAtan(rise, run); } /// -/// Create a transform from the given translation and orientation. @param position The translation vector for the transform. @param orientation The axis and rotation that orients the transform. @return A transform based on the given position and orientation. @ingroup Matrices ) +/// Create a transform from the given translation and orientation. +/// @param position The translation vector for the transform. +/// @param orientation The axis and rotation that orients the transform. +/// @return A transform based on the given position and orientation. +/// @ingroup Matrices ) +/// /// public TransformF MatrixCreate(Point3F position, AngAxisF orientation){ @@ -4680,7 +6368,11 @@ public TransformF MatrixCreate(Point3F position, AngAxisF orientation){ return new TransformF ( m_ts.fn_MatrixCreate(position.AsString(), orientation.AsString())); } /// -/// @Create a matrix from the given rotations. @param Vector3F X, Y, and Z rotation in *radians*. @return A transform based on the given orientation. @ingroup Matrices ) +/// @Create a matrix from the given rotations. +/// @param Vector3F X, Y, and Z rotation in *radians*. +/// @return A transform based on the given orientation. +/// @ingroup Matrices ) +/// /// public TransformF MatrixCreateFromEuler(Point3F angles){ @@ -4688,7 +6380,13 @@ public TransformF MatrixCreateFromEuler(Point3F angles){ return new TransformF ( m_ts.fn_MatrixCreateFromEuler(angles.AsString())); } /// -/// @brief Multiply the given point by the given transform assuming that w=1. This function will multiply the given vector such that translation with take effect. @param transform A transform. @param point A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the given point by the given transform assuming that w=1. +/// This function will multiply the given vector such that translation with take effect. +/// @param transform A transform. +/// @param point A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public Point3F MatrixMulPoint(TransformF transform, Point3F point){ @@ -4696,7 +6394,12 @@ public Point3F MatrixMulPoint(TransformF transform, Point3F point){ return new Point3F ( m_ts.fn_MatrixMulPoint(transform.AsString(), point.AsString())); } /// -/// @brief Multiply the two matrices. @param left First transform. @param right Right transform. @return Concatenation of the two transforms. @ingroup Matrices ) +/// @brief Multiply the two matrices. +/// @param left First transform. +/// @param right Right transform. +/// @return Concatenation of the two transforms. +/// @ingroup Matrices ) +/// /// public TransformF MatrixMultiply(TransformF left, TransformF right){ @@ -4704,7 +6407,14 @@ public TransformF MatrixMultiply(TransformF left, TransformF right){ return new TransformF ( m_ts.fn_MatrixMultiply(left.AsString(), right.AsString())); } /// -/// @brief Multiply the vector by the transform assuming that w=0. This function will multiply the given vector by the given transform such that translation will not affect the vector. @param transform A transform. @param vector A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the vector by the transform assuming that w=0. +/// This function will multiply the given vector by the given transform such that translation will +/// not affect the vector. +/// @param transform A transform. +/// @param vector A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public Point3F MatrixMulVector(TransformF transform, Point3F vector){ @@ -4712,7 +6422,11 @@ public Point3F MatrixMulVector(TransformF transform, Point3F vector){ return new Point3F ( m_ts.fn_MatrixMulVector(transform.AsString(), vector.AsString())); } /// -/// Round v up to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v up to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int mCeil(float v){ @@ -4720,7 +6434,13 @@ public int mCeil(float v){ return m_ts.fn_mCeil(v); } /// -/// Clamp the specified value between two bounds. @param v Input value. @param min Minimum Bound. @param max Maximum Bound. @returns The specified value clamped to the specified bounds. @ingroup Math ) +/// Clamp the specified value between two bounds. +/// @param v Input value. +/// @param min Minimum Bound. +/// @param max Maximum Bound. +/// @returns The specified value clamped to the specified bounds. +/// @ingroup Math ) +/// /// public float mClamp(float v, float min, float max){ @@ -4728,7 +6448,11 @@ public float mClamp(float v, float min, float max){ return m_ts.fn_mClamp(v, min, max); } /// -/// Calculate the cosine of v. @param v Input Value (in radians). @returns The cosine of the input value. @ingroup Math ) +/// Calculate the cosine of v. +/// @param v Input Value (in radians). +/// @returns The cosine of the input value. +/// @ingroup Math ) +/// /// public float mCos(float v){ @@ -4736,7 +6460,11 @@ public float mCos(float v){ return m_ts.fn_mCos(v); } /// -/// Convert specified degrees into radians. @param degrees Input Value (in degrees). @returns The specified degrees value converted to radians. @ingroup Math ) +/// Convert specified degrees into radians. +/// @param degrees Input Value (in degrees). +/// @returns The specified degrees value converted to radians. +/// @ingroup Math ) +/// /// public float mDegToRad(float degrees){ @@ -4744,7 +6472,16 @@ public float mDegToRad(float degrees){ return m_ts.fn_mDegToRad(degrees); } /// -/// Display a modal message box using the platform's native message box implementation. @param title The title to display on the message box window. @param message The text message to display in the box. @param buttons Which buttons to put on the message box. @param icons Which icon to show next to the message. @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. @tsexample messageBox( \"Error\", \"\" ); @endtsexample @ingroup Platform ) +/// Display a modal message box using the platform's native message box implementation. +/// @param title The title to display on the message box window. +/// @param message The text message to display in the box. +/// @param buttons Which buttons to put on the message box. +/// @param icons Which icon to show next to the message. +/// @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. +/// @tsexample +/// messageBox( \"Error\", \"\" ); @endtsexample +/// @ingroup Platform ) +/// /// public int messageBox(string title, string message, TypeMBButtons buttons = null , TypeMBIcons icons = null ){ if (buttons== null) {buttons = 1;} @@ -4754,7 +6491,12 @@ public int messageBox(string title, string message, TypeMBButtons buttons = nul return m_ts.fn_messageBox(title, message, (int)buttons , (int)icons ); } /// -/// Formats the specified number to the given number of decimal places. @param v Number to format. @param precision Number of decimal places to format to (1-9). @returns Number formatted to the specified number of decimal places. @ingroup Math ) +/// Formats the specified number to the given number of decimal places. +/// @param v Number to format. +/// @param precision Number of decimal places to format to (1-9). +/// @returns Number formatted to the specified number of decimal places. +/// @ingroup Math ) +/// /// public string mFloatLength(float v, uint precision){ @@ -4762,7 +6504,11 @@ public string mFloatLength(float v, uint precision){ return m_ts.fn_mFloatLength(v, precision); } /// -/// Round v down to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v down to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int mFloor(float v){ @@ -4770,7 +6516,12 @@ public int mFloor(float v){ return m_ts.fn_mFloor(v); } /// -/// Calculate the remainder of v/d. @param v Input Value. @param d Divisor Value. @returns The remainder of v/d. @ingroup Math ) +/// Calculate the remainder of v/d. +/// @param v Input Value. +/// @param d Divisor Value. +/// @returns The remainder of v/d. +/// @ingroup Math ) +/// /// public float mFMod(float v, float d){ @@ -4778,7 +6529,11 @@ public float mFMod(float v, float d){ return m_ts.fn_mFMod(v, d); } /// -/// Returns whether the value is an exact power of two. @param v Input value. @returns Whether the specified value is an exact power of two. @ingroup Math ) +/// Returns whether the value is an exact power of two. +/// @param v Input value. +/// @returns Whether the specified value is an exact power of two. +/// @ingroup Math ) +/// /// public bool mIsPow2(int v){ @@ -4786,7 +6541,13 @@ public bool mIsPow2(int v){ return m_ts.fn_mIsPow2(v); } /// -/// Calculate linearly interpolated value between two specified numbers using specified normalized time. @param v1 Interpolate From Input value. @param v2 Interpolate To Input value. @param time Normalized time used to interpolate values (0-1). @returns The interpolated value between the two specified values at normalized time t. @ingroup Math ) +/// Calculate linearly interpolated value between two specified numbers using specified normalized time. +/// @param v1 Interpolate From Input value. +/// @param v2 Interpolate To Input value. +/// @param time Normalized time used to interpolate values (0-1). +/// @returns The interpolated value between the two specified values at normalized time t. +/// @ingroup Math ) +/// /// public float mLerp(float v1, float v2, float time){ @@ -4794,7 +6555,11 @@ public float mLerp(float v1, float v2, float time){ return m_ts.fn_mLerp(v1, v2, time); } /// -/// Calculate the natural logarithm of v. @param v Input Value. @returns The natural logarithm of the input value. @ingroup Math ) +/// Calculate the natural logarithm of v. +/// @param v Input Value. +/// @returns The natural logarithm of the input value. +/// @ingroup Math ) +/// /// public float mLog(float v){ @@ -4802,7 +6567,10 @@ public float mLog(float v){ return m_ts.fn_mLog(v); } /// -/// Return the value of PI (half-circle in radians). @returns The value of PI. @ingroup Math ) +/// Return the value of PI (half-circle in radians). +/// @returns The value of PI. +/// @ingroup Math ) +/// /// public float mPi(){ @@ -4810,7 +6578,12 @@ public float mPi(){ return m_ts.fn_mPi(); } /// -/// Calculate b raised to the p-th power. @param v Input Value. @param p Power to raise value by. @returns v raised to the p-th power. @ingroup Math ) +/// Calculate b raised to the p-th power. +/// @param v Input Value. +/// @param p Power to raise value by. +/// @returns v raised to the p-th power. +/// @ingroup Math ) +/// /// public float mPow(float v, float p){ @@ -4818,7 +6591,11 @@ public float mPow(float v, float p){ return m_ts.fn_mPow(v, p); } /// -/// Convert specified radians into degrees. @param radians Input Value (in radians). @returns The specified radians value converted to degrees. @ingroup Math ) +/// Convert specified radians into degrees. +/// @param radians Input Value (in radians). +/// @returns The specified radians value converted to degrees. +/// @ingroup Math ) +/// /// public float mRadToDeg(float radians){ @@ -4826,7 +6603,12 @@ public float mRadToDeg(float radians){ return m_ts.fn_mRadToDeg(radians); } /// -/// Round v to the nth decimal place or the nearest whole number by default. @param v Value to roundn @param n Number of decimal places to round to, 0 by defaultn @return The rounded value as a S32. @ingroup Math ) +/// Round v to the nth decimal place or the nearest whole number by default. +/// @param v Value to roundn +/// @param n Number of decimal places to round to, 0 by defaultn +/// @return The rounded value as a S32. +/// @ingroup Math ) +/// /// public float mRound(float v, int n = 0){ @@ -4834,7 +6616,11 @@ public float mRound(float v, int n = 0){ return m_ts.fn_mRound(v, n); } /// -/// Clamp the specified value between 0 and 1 (inclusive). @param v Input value. @returns The specified value clamped between 0 and 1 (inclusive). @ingroup Math ) +/// Clamp the specified value between 0 and 1 (inclusive). +/// @param v Input value. +/// @returns The specified value clamped between 0 and 1 (inclusive). +/// @ingroup Math ) +/// /// public float mSaturate(float v){ @@ -4842,7 +6628,11 @@ public float mSaturate(float v){ return m_ts.fn_mSaturate(v); } /// -/// Calculate the sine of v. @param v Input Value (in radians). @returns The sine of the input value. @ingroup Math ) +/// Calculate the sine of v. +/// @param v Input Value (in radians). +/// @returns The sine of the input value. +/// @ingroup Math ) +/// /// public float mSin(float v){ @@ -4850,7 +6640,15 @@ public float mSin(float v){ return m_ts.fn_mSin(v); } /// -/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. @ingroup Math ) +/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions +/// (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. +/// @ingroup Math ) +/// /// public string mSolveCubic(float a, float b, float c, float d){ @@ -4858,7 +6656,14 @@ public string mSolveCubic(float a, float b, float c, float d){ return m_ts.fn_mSolveCubic(a, b, c, d); } /// -/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. @ingroup Math ) +/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions +/// (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. +/// @ingroup Math ) +/// /// public string mSolveQuadratic(float a, float b, float c){ @@ -4866,7 +6671,16 @@ public string mSolveQuadratic(float a, float b, float c){ return m_ts.fn_mSolveQuadratic(a, b, c); } /// -/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @param e Fifth Coefficient. @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. @ingroup Math ) +/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @param e Fifth Coefficient. +/// @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions +/// (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. +/// @ingroup Math ) +/// /// public string mSolveQuartic(float a, float b, float c, float d, float e){ @@ -4874,7 +6688,11 @@ public string mSolveQuartic(float a, float b, float c, float d, float e){ return m_ts.fn_mSolveQuartic(a, b, c, d, e); } /// -/// Calculate the square-root of v. @param v Input Value. @returns The square-root of the input value. @ingroup Math ) +/// Calculate the square-root of v. +/// @param v Input Value. +/// @returns The square-root of the input value. +/// @ingroup Math ) +/// /// public float mSqrt(float v){ @@ -4882,7 +6700,11 @@ public float mSqrt(float v){ return m_ts.fn_mSqrt(v); } /// -/// Calculate the tangent of v. @param v Input Value (in radians). @returns The tangent of the input value. @ingroup Math ) +/// Calculate the tangent of v. +/// @param v Input Value (in radians). +/// @returns The tangent of the input value. +/// @ingroup Math ) +/// /// public float mTan(float v){ @@ -4891,6 +6713,7 @@ public float mTan(float v){ } /// /// nameToID(object)) +/// /// public int nameToID(string objectName){ @@ -4898,15 +6721,47 @@ public int nameToID(string objectName){ return m_ts.fn_nameToID(objectName); } /// -/// ( string str, string token, string delimiters ) Tokenize a string using a set of delimiting characters. This function first skips all leading charaters in @a str that are contained in @a delimiters. From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str until the function returns \"\". @param str A string. @param token The name of the variable in which to store the current token. This variable is set in the scope in which nextToken is called. @param delimiters A string of characters. Each character is considered a delimiter. @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. @tsexample // Prints: // a // b // c %str = \"a b c\"; while ( %str !$= \"\" ) { // First time, stores \"a\" in the variable %token and sets %str to \"b c\". %str = nextToken( %str, \"token\", \" \" ); echo( %token ); } @endtsexample @ingroup Strings ) +/// ( string str, string token, string delimiters ) +/// Tokenize a string using a set of delimiting characters. +/// This function first skips all leading charaters in @a str that are contained in @a delimiters. +/// From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters +/// from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it +/// skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. +/// To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str +/// until the function returns \"\". +/// @param str A string. +/// @param token The name of the variable in which to store the current token. This variable is set in the +/// scope in which nextToken is called. +/// @param delimiters A string of characters. Each character is considered a delimiter. +/// @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. +/// @tsexample +/// // Prints: +/// // a +/// // b +/// // c +/// %str = \"a b c\"; +/// while ( %str !$= \"\" ) +/// { +/// // First time, stores \"a\" in the variable %token and sets %str to \"b c\". +/// %str = nextToken( %str, \"token\", \" \" ); +/// echo( %token ); +/// } +/// @endtsexample +/// @ingroup Strings ) +/// /// -public string nextToken(string str, string token, string delim){ +public string nextToken(string str1, string token, string delim){ -return m_ts.fn_nextToken(str, token, delim); +return m_ts.fn_nextToken(str1, token, delim); } /// -/// @brief Open the given @a file through the system. This will usually open the file in its associated application. @param file %Path of the file to open. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given @a file through the system. This will usually open the file in its +/// associated application. +/// @param file %Path of the file to open. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void openFile(string file){ @@ -4914,7 +6769,11 @@ public void openFile(string file){ m_ts.fn_openFile(file); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void openFolder(string path){ @@ -4922,7 +6781,13 @@ public void openFolder(string path){ m_ts.fn_openFolder(path); } /// -/// @brief Combines two separate strings containing a file path and file name together into a single string @param path String containing file path @param file String containing file name @return String containing concatenated file name and path @ingroup FileSystem) +/// @brief Combines two separate strings containing a file path and file name together into a single string +/// +/// @param path String containing file path +/// @param file String containing file name +/// @return String containing concatenated file name and path +/// @ingroup FileSystem) +/// /// public string pathConcat(string path, string file){ @@ -4930,7 +6795,14 @@ public string pathConcat(string path, string file){ return m_ts.fn_pathConcat(path, file); } /// -/// @brief Copy a file to a new location. @param fromFile %Path of the file to copy. @param toFile %Path where to copy @a fromFile to. @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. @return True if the file was successfully copied, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Copy a file to a new location. +/// @param fromFile %Path of the file to copy. +/// @param toFile %Path where to copy @a fromFile to. +/// @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. +/// @return True if the file was successfully copied, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool pathCopy(string fromFile, string toFile, bool noOverwrite = true){ @@ -4938,7 +6810,23 @@ public bool pathCopy(string fromFile, string toFile, bool noOverwrite = true){ return m_ts.fn_pathCopy(fromFile, toFile, noOverwrite); } /// -/// @brief Load all Path information from the mission. This function is usually called from the loadMissionStage2() server-side function after the mission file has loaded. Internally it places all Paths into the server's PathManager. From this point the Paths are ready for transmission to the clients. @tsexample // Inform the engine to load all Path information from the mission. pathOnMissionLoadDone(); @endtsexample @see NetConnection::transmitPaths() @see NetConnection::clearPaths() @see Path @ingroup Networking) +/// @brief Load all Path information from the mission. +/// +/// This function is usually called from the loadMissionStage2() server-side function +/// after the mission file has loaded. Internally it places all Paths into the server's +/// PathManager. From this point the Paths are ready for transmission to the clients. +/// +/// @tsexample +/// // Inform the engine to load all Path information from the mission. +/// pathOnMissionLoadDone(); +/// @endtsexample +/// +/// @see NetConnection::transmitPaths() +/// @see NetConnection::clearPaths() +/// @see Path +/// +/// @ingroup Networking) +/// /// public void pathOnMissionLoadDone(){ @@ -4947,6 +6835,7 @@ public void pathOnMissionLoadDone(){ } /// /// physicsDebugDraw( bool enable )) +/// /// public void physicsDebugDraw(bool enable){ @@ -4955,6 +6844,7 @@ public void physicsDebugDraw(bool enable){ } /// /// physicsDestroy()) +/// /// public void physicsDestroy(){ @@ -4963,6 +6853,7 @@ public void physicsDestroy(){ } /// /// physicsDestroyWorld( String worldName )) +/// /// public void physicsDestroyWorld(string worldName){ @@ -4971,6 +6862,7 @@ public void physicsDestroyWorld(string worldName){ } /// /// physicsGetTimeScale()) +/// /// public float physicsGetTimeScale(){ @@ -4979,6 +6871,7 @@ public float physicsGetTimeScale(){ } /// /// ), physicsInit( [string library] )) +/// /// public bool physicsInit(string library = ""){ @@ -4987,6 +6880,7 @@ public bool physicsInit(string library = ""){ } /// /// physicsInitWorld( String worldName )) +/// /// public bool physicsInitWorld(string worldName){ @@ -4994,7 +6888,10 @@ public bool physicsInitWorld(string worldName){ return m_ts.fn_physicsInitWorld(worldName); } /// -/// physicsPluginPresent() @brief Returns true if a physics plugin exists and is initialized. @ingroup Physics ) +/// physicsPluginPresent() +/// @brief Returns true if a physics plugin exists and is initialized. +/// @ingroup Physics ) +/// /// public bool physicsPluginPresent(){ @@ -5003,6 +6900,7 @@ public bool physicsPluginPresent(){ } /// /// physicsRestoreState()) +/// /// public void physicsRestoreState(){ @@ -5011,6 +6909,7 @@ public void physicsRestoreState(){ } /// /// physicsSetTimeScale( F32 scale )) +/// /// public void physicsSetTimeScale(float scale){ @@ -5019,6 +6918,7 @@ public void physicsSetTimeScale(float scale){ } /// /// physicsStopSimulation( String worldName )) +/// /// public bool physicsSimulationEnabled(){ @@ -5027,6 +6927,7 @@ public bool physicsSimulationEnabled(){ } /// /// physicsStartSimulation( String worldName )) +/// /// public void physicsStartSimulation(string worldName){ @@ -5035,6 +6936,7 @@ public void physicsStartSimulation(string worldName){ } /// /// physicsStopSimulation( String worldName )) +/// /// public void physicsStopSimulation(string worldName){ @@ -5043,6 +6945,7 @@ public void physicsStopSimulation(string worldName){ } /// /// physicsStoreState()) +/// /// public void physicsStoreState(){ @@ -5050,7 +6953,11 @@ public void physicsStoreState(){ m_ts.fn_physicsStoreState(); } /// -/// (string filename) @brief Begin playback of a journal from a specified field. @param filename Name and path of file journal file @ingroup Platform) +/// (string filename) +/// @brief Begin playback of a journal from a specified field. +/// @param filename Name and path of file journal file +/// @ingroup Platform) +/// /// public void playJournal(string filename){ @@ -5058,7 +6965,10 @@ public void playJournal(string filename){ m_ts.fn_playJournal(filename); } /// -/// THEORA, 30.0f, Point2I::Zero ), Load a journal file and capture it video. @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Load a journal file and capture it video. +/// @ingroup Rendering ) +/// /// public void playJournalToVideo(string journalFile, string videoFile = null , string encoder = "THEORA", float framerate = 30.0f, Point2I resolution = null ){ if (videoFile== null) {videoFile = null;} @@ -5068,7 +6978,12 @@ public void playJournalToVideo(string journalFile, string videoFile = null , st m_ts.fn_playJournalToVideo(journalFile, videoFile, encoder, framerate, resolution.AsString()); } /// -/// () @brief Pop and restore the last setting of $instantGroup off the stack. @note Currently only used for editors @ingroup Editors @internal) +/// () +/// @brief Pop and restore the last setting of $instantGroup off the stack. +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void popInstantGroup(){ @@ -5076,7 +6991,12 @@ public void popInstantGroup(){ m_ts.fn_popInstantGroup(); } /// -/// Populate the font cache for all fonts with Unicode code points in the specified range. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for all fonts with Unicode code points in the specified range. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void populateAllFontCacheRange(uint rangeStart, uint rangeEnd){ @@ -5084,7 +7004,9 @@ public void populateAllFontCacheRange(uint rangeStart, uint rangeEnd){ m_ts.fn_populateAllFontCacheRange(rangeStart, rangeEnd); } /// -/// Populate the font cache for all fonts with characters from the specified string. @ingroup Font ) +/// Populate the font cache for all fonts with characters from the specified string. +/// @ingroup Font ) +/// /// public void populateAllFontCacheString(string stringx){ @@ -5092,7 +7014,14 @@ public void populateAllFontCacheString(string stringx){ m_ts.fn_populateAllFontCacheString(stringx); } /// -/// Populate the font cache for the specified font with Unicode code points in the specified range. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for the specified font with Unicode code points in the specified range. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void populateFontCacheRange(string faceName, int fontSize, uint rangeStart, uint rangeEnd){ @@ -5100,7 +7029,12 @@ public void populateFontCacheRange(string faceName, int fontSize, uint rangeSta m_ts.fn_populateFontCacheRange(faceName, fontSize, rangeStart, rangeEnd); } /// -/// Populate the font cache for the specified font with characters from the specified string. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param string The string to populate. @ingroup Font ) +/// Populate the font cache for the specified font with characters from the specified string. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param string The string to populate. +/// @ingroup Font ) +/// /// public void populateFontCacheString(string faceName, int fontSize, string stringx){ @@ -5108,7 +7042,9 @@ public void populateFontCacheString(string faceName, int fontSize, string strin m_ts.fn_populateFontCacheString(faceName, fontSize, stringx); } /// -/// Preload all datablocks in client mode. (Server parameter is set to false). This will take some time to complete.) +/// Preload all datablocks in client mode. +/// (Server parameter is set to false). This will take some time to complete.) +/// /// public void preloadClientDataBlocks(){ @@ -5116,7 +7052,11 @@ public void preloadClientDataBlocks(){ m_ts.fn_preloadClientDataBlocks(); } /// -/// @brief Dumps current profiling stats to the console window. @note Markers disabled with profilerMarkerEnable() will be skipped over. If the profiler is currently running, it will be disabled. @ingroup Debugging) +/// @brief Dumps current profiling stats to the console window. +/// @note Markers disabled with profilerMarkerEnable() will be skipped over. +/// If the profiler is currently running, it will be disabled. +/// @ingroup Debugging) +/// /// public void profilerDump(){ @@ -5124,7 +7064,15 @@ public void profilerDump(){ m_ts.fn_profilerDump(); } /// -/// @brief Dumps current profiling stats to a file. @note If the profiler is currently running, it will be disabled. @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). Will attempt to create the file if it does not already exist. @tsexample profilerDumpToFile( \"C:/Torque/log1.txt\" ); @endtsexample @ingroup Debugging ) +/// @brief Dumps current profiling stats to a file. +/// @note If the profiler is currently running, it will be disabled. +/// @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). +/// Will attempt to create the file if it does not already exist. +/// @tsexample +/// profilerDumpToFile( \"C:/Torque/log1.txt\" ); +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void profilerDumpToFile(string fileName){ @@ -5132,7 +7080,14 @@ public void profilerDumpToFile(string fileName){ m_ts.fn_profilerDumpToFile(fileName); } /// -/// @brief Enables or disables the profiler. Data is only gathered while the profiler is enabled. @note Profiler is not available in shipping builds. T3D has predefined profiling areas surrounded by markers, but you may need to define additional markers (in C++) around areas you wish to profile, by using the PROFILE_START( markerName ); and PROFILE_END(); macros. @ingroup Debugging ) +/// @brief Enables or disables the profiler. +/// Data is only gathered while the profiler is enabled. +/// @note Profiler is not available in shipping builds. +/// T3D has predefined profiling areas surrounded by markers, +/// but you may need to define additional markers (in C++) around areas you wish to profile, +/// by using the PROFILE_START( markerName ); and PROFILE_END(); macros. +/// @ingroup Debugging ) +/// /// public void profilerEnable(bool enable){ @@ -5140,7 +7095,13 @@ public void profilerEnable(bool enable){ m_ts.fn_profilerEnable(enable); } /// -/// @brief Enable or disable a specific profile. @param enable Optional paramater to enable or disable the profile. @param markerName Name of a specific marker to enable or disable. @note Calling this function will first call profilerReset(), clearing all data from profiler. All profile markers are enabled by default. @ingroup Debugging) +/// @brief Enable or disable a specific profile. +/// @param enable Optional paramater to enable or disable the profile. +/// @param markerName Name of a specific marker to enable or disable. +/// @note Calling this function will first call profilerReset(), clearing all data from profiler. +/// All profile markers are enabled by default. +/// @ingroup Debugging) +/// /// public void profilerMarkerEnable(string markerName, bool enable = true){ @@ -5148,7 +7109,11 @@ public void profilerMarkerEnable(string markerName, bool enable = true){ m_ts.fn_profilerMarkerEnable(markerName, enable); } /// -/// @brief Resets the profiler, clearing it of all its data. If the profiler is currently running, it will first be disabled. All markers will retain their current enabled/disabled status. @ingroup Debugging ) +/// @brief Resets the profiler, clearing it of all its data. +/// If the profiler is currently running, it will first be disabled. +/// All markers will retain their current enabled/disabled status. +/// @ingroup Debugging ) +/// /// public void profilerReset(){ @@ -5156,7 +7121,13 @@ public void profilerReset(){ m_ts.fn_profilerReset(); } /// -/// ) , ([group]) @brief Pushes the current $instantGroup on a stack and sets it to the given value (or clears it). @note Currently only used for editors @ingroup Editors @internal) +/// ) , ([group]) +/// @brief Pushes the current $instantGroup on a stack +/// and sets it to the given value (or clears it). +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void pushInstantGroup(string group = ""){ @@ -5165,6 +7136,7 @@ public void pushInstantGroup(string group = ""){ } /// /// queryAllServers(...); ) +/// /// public void queryAllServers(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags){ @@ -5173,6 +7145,8 @@ public void queryAllServers(uint lanPort, uint flags, string gameType, string m } /// /// queryLanServers(...); ) +/// +/// /// public void queryLanServers(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags){ @@ -5181,6 +7155,7 @@ public void queryLanServers(uint lanPort, uint flags, string gameType, string m } /// /// queryMasterServer(...); ) +/// /// public void queryMasterServer(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags){ @@ -5189,19 +7164,50 @@ public void queryMasterServer(uint lanPort, uint flags, string gameType, string } /// /// querySingleServer(...); ) +/// /// public void querySingleServer(string addrText, byte flags = 0){ m_ts.fn_querySingleServer(addrText, flags); } +/// +/// Shut down the engine and exit its process. +/// This function cleanly uninitializes the engine and then exits back to the system with a process +/// exit status indicating a clean exit. +/// @see quitWithErrorMessage +/// @ingroup Platform ) +/// +/// +public void quit(){ + + +m_ts.fn_quit(); +} +/// +/// Display an error message box showing the given @a message and then shut down the engine and exit its process. +/// This function cleanly uninitialized the engine and then exits back to the system with a process +/// exit status indicating an error. +/// @param message The message to log to the console and show in an error message box. +/// @see quit +/// @ingroup Platform ) +/// +/// +public void quitWithErrorMessage(string message){ + + +m_ts.fn_quitWithErrorMessage(message); +} public void realQuit(){ m_ts.fn_realQuit(); } /// -/// Close the current Redbook device. @brief Deprecated @internal) +/// Close the current Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public bool redbookClose(){ @@ -5209,7 +7215,10 @@ public bool redbookClose(){ return m_ts.fn_redbookClose(); } /// -/// get the number of redbook devices. @brief Deprecated @internal) +/// get the number of redbook devices. +/// @brief Deprecated +/// @internal) +/// /// public int redbookGetDeviceCount(){ @@ -5217,7 +7226,10 @@ public int redbookGetDeviceCount(){ return m_ts.fn_redbookGetDeviceCount(); } /// -/// (int index) Get name of specified Redbook device. @brief Deprecated @internal) +/// (int index) Get name of specified Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public string redbookGetDeviceName(int index){ @@ -5225,7 +7237,10 @@ public string redbookGetDeviceName(int index){ return m_ts.fn_redbookGetDeviceName(index); } /// -/// Get a string explaining the last redbook error. @brief Deprecated @internal) +/// Get a string explaining the last redbook error. +/// @brief Deprecated +/// @internal) +/// /// public string redbookGetLastError(){ @@ -5233,7 +7248,10 @@ public string redbookGetLastError(){ return m_ts.fn_redbookGetLastError(); } /// -/// Return the number of tracks. @brief Deprecated @internal) +/// Return the number of tracks. +/// @brief Deprecated +/// @internal) +/// /// public int redbookGetTrackCount(){ @@ -5241,7 +7259,10 @@ public int redbookGetTrackCount(){ return m_ts.fn_redbookGetTrackCount(); } /// -/// Get the volume. @brief Deprecated @internal) +/// Get the volume. +/// @brief Deprecated +/// @internal) +/// /// public float redbookGetVolume(){ @@ -5249,7 +7270,10 @@ public float redbookGetVolume(){ return m_ts.fn_redbookGetVolume(); } /// -/// ), (string device=NULL) @brief Deprecated @internal) +/// ), (string device=NULL) +/// @brief Deprecated +/// @internal) +/// /// public bool redbookOpen(string device = ""){ @@ -5257,7 +7281,10 @@ public bool redbookOpen(string device = ""){ return m_ts.fn_redbookOpen(device); } /// -/// (int track) Play the selected track. @brief Deprecated @internal) +/// (int track) Play the selected track. +/// @brief Deprecated +/// @internal) +/// /// public bool redbookPlay(int track){ @@ -5265,7 +7292,10 @@ public bool redbookPlay(int track){ return m_ts.fn_redbookPlay(track); } /// -/// (float volume) Set playback volume. @brief Deprecated @internal) +/// (float volume) Set playback volume. +/// @brief Deprecated +/// @internal) +/// /// public bool redbookSetVolume(float volume){ @@ -5273,7 +7303,10 @@ public bool redbookSetVolume(float volume){ return m_ts.fn_redbookSetVolume(volume); } /// -/// Stop playing. @brief Deprecated @internal) +/// Stop playing. +/// @brief Deprecated +/// @internal) +/// /// public bool redbookStop(){ @@ -5281,7 +7314,12 @@ public bool redbookStop(){ return m_ts.fn_redbookStop(); } /// -/// (string queueName, string listener) @brief Registers an event message @param queueName String containing the name of queue to attach listener to @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Registers an event message +/// @param queueName String containing the name of queue to attach listener to +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public bool registerMessageListener(string queueName, string listenerName){ @@ -5289,7 +7327,11 @@ public bool registerMessageListener(string queueName, string listenerName){ return m_ts.fn_registerMessageListener(queueName, listenerName); } /// -/// (string queueName) @brief Registeres a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Registeres a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void registerMessageQueue(string queueName){ @@ -5297,7 +7339,9 @@ public void registerMessageQueue(string queueName){ m_ts.fn_registerMessageQueue(queueName); } /// -/// @brief Flushes all procedural shaders and re-initializes all active material instances. @ingroup Materials) +/// @brief Flushes all procedural shaders and re-initializes all active material instances. +/// @ingroup Materials) +/// /// public void reInitMaterials(){ @@ -5305,7 +7349,15 @@ public void reInitMaterials(){ m_ts.fn_reInitMaterials(); } /// -/// Force the resource at specified input path to be reloaded @param path Path to the resource to be reloaded @tsexample reloadResource( \"art/shapes/box.dts\" ); @endtsexample @note Currently used by editors only @ingroup Editors @internal) +/// Force the resource at specified input path to be reloaded +/// @param path Path to the resource to be reloaded +/// @tsexample +/// reloadResource( \"art/shapes/box.dts\" ); +/// @endtsexample +/// @note Currently used by editors only +/// @ingroup Editors +/// @internal) +/// /// public void reloadResource(string path){ @@ -5313,7 +7365,9 @@ public void reloadResource(string path){ m_ts.fn_reloadResource(path); } /// -/// Reload all the textures from disk. @ingroup GFX ) +/// Reload all the textures from disk. +/// @ingroup GFX ) +/// /// public void reloadTextures(){ @@ -5321,7 +7375,19 @@ public void reloadTextures(){ m_ts.fn_reloadTextures(); } /// -/// Remove the field in @a text at the given @a index. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field in @a text. @return A new string with the field at the given index removed or the original string if @a index is out of range. @tsexample removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" @endtsexample @see removeWord @see removeRecord @ingroup FieldManip ) +/// Remove the field in @a text at the given @a index. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field in @a text. +/// @return A new string with the field at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string removeField(string text, int index){ @@ -5329,7 +7395,10 @@ public string removeField(string text, int index){ return m_ts.fn_removeField(text, index); } /// -/// Removes an existing global macro by name. @see addGlobalShaderMacro @ingroup Rendering ) +/// Removes an existing global macro by name. +/// @see addGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void removeGlobalShaderMacro(string name){ @@ -5337,7 +7406,19 @@ public void removeGlobalShaderMacro(string name){ m_ts.fn_removeGlobalShaderMacro(name); } /// -/// Remove the record in @a text at the given @a index. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record in @a text. @return A new string with the record at the given @a index removed or the original string if @a index is out of range. @tsexample removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" @endtsexample @see removeWord @see removeField @ingroup FieldManip ) +/// Remove the record in @a text at the given @a index. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record in @a text. +/// @return A new string with the record at the given @a index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeField +/// @ingroup FieldManip ) +/// /// public string removeRecord(string text, int index){ @@ -5345,7 +7426,15 @@ public string removeRecord(string text, int index){ return m_ts.fn_removeRecord(text, index); } /// -/// @brief Remove a tagged string from the Net String Table @param tag The tag associated with the string @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// @brief Remove a tagged string from the Net String Table +/// +/// @param tag The tag associated with the string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public void removeTaggedString(int tag = -1){ @@ -5353,7 +7442,19 @@ public void removeTaggedString(int tag = -1){ m_ts.fn_removeTaggedString(tag); } /// -/// Remove the word in @a text at the given @a index. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word in @a text. @return A new string with the word at the given index removed or the original string if @a index is out of range. @tsexample removeWord( \"a b c d\", 2 ) // Returns \"a b d\" @endtsexample @see removeField @see removeRecord @ingroup FieldManip ) +/// Remove the word in @a text at the given @a index. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word in @a text. +/// @return A new string with the word at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeWord( \"a b c d\", 2 ) // Returns \"a b d\" +/// @endtsexample +/// @see removeField +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string removeWord(string text, int index){ @@ -5361,7 +7462,12 @@ public string removeWord(string text, int index){ return m_ts.fn_removeWord(text, index); } /// -/// @brief Renames the given @a file. @param from %Path of the file to rename from. @param frome %Path of the file to rename to. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Renames the given @a file. +/// @param from %Path of the file to rename from. +/// @param frome %Path of the file to rename to. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool renameFile(string from, string to){ @@ -5369,7 +7475,10 @@ public bool renameFile(string from, string to){ return m_ts.fn_renameFile(from, to); } /// -/// () @brief Reset FPS stats (fps::) @ingroup Game) +/// () +/// @brief Reset FPS stats (fps::) +/// @ingroup Game) +/// /// public void resetFPSTracker(){ @@ -5377,7 +7486,11 @@ public void resetFPSTracker(){ m_ts.fn_resetFPSTracker(); } /// -/// @brief Deactivates and then activates the currently active light manager. This causes most shaders to be regenerated and is often used when global rendering changes have occured. @ingroup Lighting ) +/// @brief Deactivates and then activates the currently active light manager. +/// This causes most shaders to be regenerated and is often used when global +/// rendering changes have occured. +/// @ingroup Lighting ) +/// /// public void resetLightManager(){ @@ -5385,7 +7498,12 @@ public void resetLightManager(){ m_ts.fn_resetLightManager(); } /// -/// () @brief Rebuilds the XInput section of the InputManager Requests a full refresh of events for all controllers. Useful when called at the beginning of game code after actionMaps are set up to hook up all appropriate events. @ingroup Input) +/// () +/// @brief Rebuilds the XInput section of the InputManager +/// Requests a full refresh of events for all controllers. Useful when called at the beginning +/// of game code after actionMaps are set up to hook up all appropriate events. +/// @ingroup Input) +/// /// public void resetXInput(){ @@ -5393,7 +7511,16 @@ public void resetXInput(){ m_ts.fn_resetXInput(); } /// -/// Return all but the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return @a text with the first word removed. @note This is equal to @tsexample_nopar getWords( text, 1 ) @endtsexample @see getWords @ingroup FieldManip ) +/// Return all but the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return @a text with the first word removed. +/// @note This is equal to +/// @tsexample_nopar +/// getWords( text, 1 ) +/// @endtsexample +/// @see getWords +/// @ingroup FieldManip ) +/// /// public string restWords(string text){ @@ -5401,7 +7528,16 @@ public string restWords(string text){ return m_ts.fn_restWords(text); } /// -/// Remove trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. @tsexample rtrim( \" string \" ); // Returns \" string\". @endtsexample @see ltrim @see trim @ingroup Strings ) +/// Remove trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// rtrim( \" string \" ); // Returns \" string\". +/// @endtsexample +/// @see ltrim +/// @see trim +/// @ingroup Strings ) +/// /// public string rtrim(string str){ @@ -5409,7 +7545,18 @@ public string rtrim(string str){ return m_ts.fn_rtrim(str); } /// -/// (string device, float xRumble, float yRumble) @brief Activates the vibration motors in the specified controller. The controller will constantly at it's xRumble and yRumble intensities until changed or told to stop. Valid inputs for xRumble/yRumble are [0 - 1]. @param device Name of the device to rumble. @param xRumble Intensity to apply to the left motor. @param yRumble Intensity to apply to the right motor. @note in an Xbox 360 controller, the left motor is low-frequency, while the right motor is high-frequency. @ingroup Input) +/// (string device, float xRumble, float yRumble) +/// @brief Activates the vibration motors in the specified controller. +/// The controller will constantly at it's xRumble and yRumble intensities until +/// changed or told to stop. +/// Valid inputs for xRumble/yRumble are [0 - 1]. +/// @param device Name of the device to rumble. +/// @param xRumble Intensity to apply to the left motor. +/// @param yRumble Intensity to apply to the right motor. +/// @note in an Xbox 360 controller, the left motor is low-frequency, +/// while the right motor is high-frequency. +/// @ingroup Input) +/// /// public void rumble(string device, float xRumble, float yRumble){ @@ -5417,7 +7564,10 @@ public void rumble(string device, float xRumble, float yRumble){ m_ts.fn_rumble(device, xRumble, yRumble); } /// -/// (string filename) Save the journal to the specified file. @ingroup Platform) +/// (string filename) +/// Save the journal to the specified file. +/// @ingroup Platform) +/// /// public void saveJournal(string filename){ @@ -5425,7 +7575,11 @@ public void saveJournal(string filename){ m_ts.fn_saveJournal(filename); } /// -/// @brief Serialize the object to a file. @param object The object to serialize. @param filename The file name and path. @ingroup Console) +/// @brief Serialize the object to a file. +/// @param object The object to serialize. +/// @param filename The file name and path. +/// @ingroup Console) +/// /// public bool saveObject(string objectx, string filename){ @@ -5433,7 +7587,12 @@ public bool saveObject(string objectx, string filename){ return m_ts.fn_saveObject(objectx, filename); } /// -/// Dump the current zoning states of all zone spaces in the scene to the console. @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states are dumped as is. @note Only valid on the client. @ingroup Game ) +/// Dump the current zoning states of all zone spaces in the scene to the console. +/// @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states +/// are dumped as is. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public void sceneDumpZoneStates(bool updateFirst = true){ @@ -5441,7 +7600,12 @@ public void sceneDumpZoneStates(bool updateFirst = true){ m_ts.fn_sceneDumpZoneStates(updateFirst); } /// -/// Return the SceneObject that contains the given zone. @param zoneId ID of zone. @return A SceneObject or NULL if the given @a zoneId is invalid. @note Only valid on the client. @ingroup Game ) +/// Return the SceneObject that contains the given zone. +/// @param zoneId ID of zone. +/// @return A SceneObject or NULL if the given @a zoneId is invalid. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public string sceneGetZoneOwner(uint zoneId = 1){ @@ -5449,7 +7613,13 @@ public string sceneGetZoneOwner(uint zoneId = 1){ return m_ts.fn_sceneGetZoneOwner(zoneId); } /// -/// Takes a screenshot with optional tiling to produce huge screenshots. @param file The output image file path. @param format Either JPEG or PNG. @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. @ingroup GFX ) +/// Takes a screenshot with optional tiling to produce huge screenshots. +/// @param file The output image file path. +/// @param format Either JPEG or PNG. +/// @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. +/// @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. +/// @ingroup GFX ) +/// /// public void screenShot(string file, string format, uint tileCount = 1, float tileOverlap = 0){ @@ -5457,7 +7627,11 @@ public void screenShot(string file, string format, uint tileCount = 1, float ti m_ts.fn_screenShot(file, format, tileCount, tileOverlap); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void selectFile(string path){ @@ -5476,7 +7650,11 @@ public bool setClipboard(string text){ return m_ts.fn_setClipboard(text); } /// -/// (string LangTable) @brief Sets the primary LangTable used by the game @param LangTable ID of the core LangTable @ingroup Localization) +/// (string LangTable) +/// @brief Sets the primary LangTable used by the game +/// @param LangTable ID of the core LangTable +/// @ingroup Localization) +/// /// public void setCoreLangTable(string lgTable){ @@ -5484,7 +7662,13 @@ public void setCoreLangTable(string lgTable){ m_ts.fn_setCoreLangTable(lgTable); } /// -/// @brief Set the current working directory. @param path The absolute or relative (to the current working directory) path of the directory which should be made the new working directory. @return True if the working directory was successfully changed to @a path, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Set the current working directory. +/// @param path The absolute or relative (to the current working directory) path of the directory which should be made the new +/// working directory. +/// @return True if the working directory was successfully changed to @a path, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool setCurrentDirectory(string path){ @@ -5492,7 +7676,10 @@ public bool setCurrentDirectory(string path){ return m_ts.fn_setCurrentDirectory(path); } /// -/// @brief Set the default FOV for a camera. @param defaultFOV The default field of view in degrees @ingroup CameraSystem) +/// @brief Set the default FOV for a camera. +/// @param defaultFOV The default field of view in degrees +/// @ingroup CameraSystem) +/// /// public void setDefaultFov(float defaultFOV){ @@ -5500,7 +7687,9 @@ public void setDefaultFov(float defaultFOV){ m_ts.fn_setDefaultFov(defaultFOV); } /// -/// Sets the clients far clipping. ) +/// Sets the clients far clipping. +/// ) +/// /// public void setFarClippingDistance(float dist){ @@ -5508,7 +7697,21 @@ public void setFarClippingDistance(float dist){ m_ts.fn_setFarClippingDistance(dist); } /// -/// Replace the field in @a text at the given @a index with @a replacement. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to replace. @param replacement The string with which to replace the field. @return A new string with the field at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" @endtsexample @see getField @see setWord @see setRecord @ingroup FieldManip ) +/// Replace the field in @a text at the given @a index with @a replacement. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to replace. +/// @param replacement The string with which to replace the field. +/// @return A new string with the field at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see setWord +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string setField(string text, int index, string replacement){ @@ -5528,7 +7731,10 @@ public int SetFogVolumeQuality(uint new_quality){ return m_ts.fn_SetFogVolumeQuality(new_quality); } /// -/// @brief Set the FOV of the camera. @param FOV The camera's new FOV in degrees @ingroup CameraSystem) +/// @brief Set the FOV of the camera. +/// @param FOV The camera's new FOV in degrees +/// @ingroup CameraSystem) +/// /// public void setFov(float FOV){ @@ -5537,6 +7743,7 @@ public void setFov(float FOV){ } /// /// @brief .) +/// /// public void setFrustumOffset(Point4F offset){ @@ -5544,7 +7751,10 @@ public void setFrustumOffset(Point4F offset){ m_ts.fn_setFrustumOffset(offset.AsString()); } /// -/// Finds and activates the named light manager. @return Returns true if the light manager is found and activated. @ingroup Lighting ) +/// Finds and activates the named light manager. +/// @return Returns true if the light manager is found and activated. +/// @ingroup Lighting ) +/// /// public bool setLightManager(string name){ @@ -5552,7 +7762,22 @@ public bool setLightManager(string name){ return m_ts.fn_setLightManager(name); } /// -/// @brief Determines how log files are written. Sets the operational mode of the console logging system. @param mode Parameter specifying the logging mode. This can be: - 1: Open and close the console log file for each seperate string of output. This will ensure that all parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. - 2: Keep the log file open and write to it continuously. This will make the system operate faster but if the process crashes, parts of the output may not have been written to disk yet and will be missing from the log. Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been issued to the console system into the newly created log file. @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. @ingroup Logging ) +/// @brief Determines how log files are written. +/// Sets the operational mode of the console logging system. +/// @param mode Parameter specifying the logging mode. This can be: +/// - 1: Open and close the console log file for each seperate string of output. This will ensure that all +/// parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. +/// - 2: Keep the log file open and write to it continuously. This will make the system operate faster but +/// if the process crashes, parts of the output may not have been written to disk yet and will be missing from +/// the log. +/// +/// Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be +/// combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been +/// issued to the console system into the newly created log file. +/// +/// @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. +/// @ingroup Logging ) +/// /// public void setLogMode(int mode){ @@ -5560,7 +7785,18 @@ public void setLogMode(int mode){ m_ts.fn_setLogMode(mode); } /// -/// (int port, bool bind=true) @brief Set the network port for the game to use. @param port The port to use. @param bind True if bind() should be called on the port. @returns True if the port was successfully opened. This will trigger a windows firewall prompt. If you don't have firewall tunneling tech you can set this to false to avoid the prompt. @ingroup Networking) +/// (int port, bool bind=true) +/// @brief Set the network port for the game to use. +/// +/// @param port The port to use. +/// @param bind True if bind() should be called on the port. +/// +/// @returns True if the port was successfully opened. +/// +/// This will trigger a windows firewall prompt. +/// If you don't have firewall tunneling tech you can set this to false to avoid the prompt. +/// @ingroup Networking) +/// /// public bool setNetPort(int port, bool bind = true){ @@ -5568,7 +7804,15 @@ public bool setNetPort(int port, bool bind = true){ return m_ts.fn_setNetPort(port, bind); } /// -/// @brief Sets the pixel shader version for the active device. This can be used to force a lower pixel shader version than is supported by the device for testing or performance optimization. @param version The floating point shader version number. @note This will only affect shaders/materials created after the call and should be used before the game begins. @see $pref::Video::forcedPixVersion @ingroup GFX ) +/// @brief Sets the pixel shader version for the active device. +/// This can be used to force a lower pixel shader version than is supported by +/// the device for testing or performance optimization. +/// @param version The floating point shader version number. +/// @note This will only affect shaders/materials created after the call +/// and should be used before the game begins. +/// @see $pref::Video::forcedPixVersion +/// @ingroup GFX ) +/// /// public void setPixelShaderVersion(float version){ @@ -5576,7 +7820,13 @@ public void setPixelShaderVersion(float version){ m_ts.fn_setPixelShaderVersion(version); } /// -/// Set the current seed for the random number generator. Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to the same sequence of pseudo-random numbers. If -1, the current timestamp will be used as the seed which is a good basis for randomization. @ingroup Random ) +/// Set the current seed for the random number generator. +/// Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). +/// @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to +/// the same sequence of pseudo-random numbers. +/// If -1, the current timestamp will be used as the seed which is a good basis for randomization. +/// @ingroup Random ) +/// /// public void setRandomSeed(int seed = -1){ @@ -5584,7 +7834,21 @@ public void setRandomSeed(int seed = -1){ m_ts.fn_setRandomSeed(seed); } /// -/// Replace the record in @a text at the given @a index with @a replacement. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to replace. @param replacement The string with which to replace the record. @return A new string with the record at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" @endtsexample @see getRecord @see setWord @see setField @ingroup FieldManip ) +/// Replace the record in @a text at the given @a index with @a replacement. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to replace. +/// @param replacement The string with which to replace the record. +/// @return A new string with the record at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see setWord +/// @see setField +/// @ingroup FieldManip ) +/// /// public string setRecord(string text, int index, string replacement){ @@ -5592,7 +7856,9 @@ public string setRecord(string text, int index, string replacement){ return m_ts.fn_setRecord(text, index, replacement); } /// -/// Set the reflection texture format. @ingroup GFX ) +/// Set the reflection texture format. +/// @ingroup GFX ) +/// /// public void setReflectFormat(TypeGFXFormat format){ @@ -5601,6 +7867,7 @@ public void setReflectFormat(TypeGFXFormat format){ } /// /// setServerInfo(...); ) +/// /// public bool setServerInfo(uint index){ @@ -5609,6 +7876,7 @@ public bool setServerInfo(uint index){ } /// /// ), string sShadowSystemName) +/// /// public bool setShadowManager(string sShadowSystemName = ""){ @@ -5617,6 +7885,7 @@ public bool setShadowManager(string sShadowSystemName = ""){ } /// /// ), ) +/// /// public string setShadowVizLight(string name = ""){ @@ -5624,7 +7893,13 @@ public string setShadowVizLight(string name = ""){ return m_ts.fn_setShadowVizLight(name); } /// -/// (string varName, string value) @brief Sets the value of the named variable. @param varName Name of the variable to locate @param value New value of the variable @return True if variable was successfully found and set @ingroup Scripting) +/// (string varName, string value) +/// @brief Sets the value of the named variable. +/// @param varName Name of the variable to locate +/// @param value New value of the variable +/// @return True if variable was successfully found and set +/// @ingroup Scripting) +/// /// public void setVariable(string varName, string value){ @@ -5632,7 +7907,21 @@ public void setVariable(string varName, string value){ m_ts.fn_setVariable(varName, value); } /// -/// Replace the word in @a text at the given @a index with @a replacement. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to replace. @param replacement The string with which to replace the word. @return A new string with the word at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" @endtsexample @see getWord @see setField @see setRecord @ingroup FieldManip ) +/// Replace the word in @a text at the given @a index with @a replacement. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to replace. +/// @param replacement The string with which to replace the word. +/// @return A new string with the word at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" +/// @endtsexample +/// @see getWord +/// @see setField +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string setWord(string text, int index, string replacement){ @@ -5640,7 +7929,12 @@ public string setWord(string text, int index, string replacement){ return m_ts.fn_setWord(text, index, replacement); } /// -/// @brief Set the zoom speed of the camera. This affects how quickly the camera changes from one field of view to another. @param speed The camera's zoom speed in ms per 90deg FOV change @ingroup CameraSystem) +/// @brief Set the zoom speed of the camera. +/// This affects how quickly the camera changes from one field of view +/// to another. +/// @param speed The camera's zoom speed in ms per 90deg FOV change +/// @ingroup CameraSystem) +/// /// public void setZoomSpeed(int speed){ @@ -5648,7 +7942,25 @@ public void setZoomSpeed(int speed){ m_ts.fn_setZoomSpeed(speed); } /// -/// Try to create a new sound device using the given properties. If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, if this function fails, it will not restore the previously active device but rather leave the sound system in an uninitialized state. Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized playback and then resume normal playback once the device has been created. In the core scripts, sound is automatically set up during startup in the sfxStartup() function. @param provider The name of the device provider as returned by sfxGetAvailableDevices(). @param device The name of the device as returned by sfxGetAvailableDevices(). @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. @return True if the initialization was successful, false if not. @note This function must be called before any of the sound playback functions can be used. @see sfxGetAvailableDevices @see sfxGetDeviceInfo @see sfxDeleteDevice @ref SFX_devices @ingroup SFX ) +/// Try to create a new sound device using the given properties. +/// If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, +/// if this function fails, it will not restore the previously active device but rather leave the sound system in an +/// uninitialized state. +/// Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized +/// playback and then resume normal playback once the device has been created. +/// In the core scripts, sound is automatically set up during startup in the sfxStartup() function. +/// @param provider The name of the device provider as returned by sfxGetAvailableDevices(). +/// @param device The name of the device as returned by sfxGetAvailableDevices(). +/// @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. +/// @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. +/// @return True if the initialization was successful, false if not. +/// @note This function must be called before any of the sound playback functions can be used. +/// @see sfxGetAvailableDevices +/// @see sfxGetDeviceInfo +/// @see sfxDeleteDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public bool sfxCreateDevice(string provider, string device, bool useHardware, int maxBuffers){ @@ -5656,7 +7968,13 @@ public bool sfxCreateDevice(string provider, string device, bool useHardware, i return m_ts.fn_sfxCreateDevice(provider, device, useHardware, maxBuffers); } /// -/// , , , ), ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) Creates a new paused sound source using a profile or a description and filename. The return value is the source which must be released by delete(). @hide ) +/// , , , ), +/// ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) +/// Creates a new paused sound source using a profile or a description +/// and filename. The return value is the source which must be +/// released by delete(). +/// @hide ) +/// /// public int sfxCreateSource(string SFXType, string filename = "", string x = "", string y = "", string z = ""){ @@ -5664,7 +7982,14 @@ public int sfxCreateSource(string SFXType, string filename = "", string x = "", return m_ts.fn_sfxCreateSource(SFXType, filename, x, y, z); } /// -/// Delete the currently active sound device and release all its resources. SFXSources that are still playing will be transitioned to virtualized playback mode. When creating a new device, they will automatically transition back to normal playback. In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. @see sfxCreateDevice @ref SFX_devices @ingroup SFX ) +/// Delete the currently active sound device and release all its resources. +/// SFXSources that are still playing will be transitioned to virtualized playback mode. +/// When creating a new device, they will automatically transition back to normal playback. +/// In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. +/// @see sfxCreateDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public void sfxDeleteDevice(){ @@ -5672,7 +7997,11 @@ public void sfxDeleteDevice(){ m_ts.fn_sfxDeleteDevice(); } /// -/// Mark the given @a source for deletion as soon as it moves into stopped state. This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). @param source A sound source. @ingroup SFX ) +/// Mark the given @a source for deletion as soon as it moves into stopped state. +/// This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). +/// @param source A sound source. +/// @ingroup SFX ) +/// /// public void sfxDeleteWhenStopped(string source){ @@ -5680,7 +8009,14 @@ public void sfxDeleteWhenStopped(string source){ m_ts.fn_sfxDeleteWhenStopped(source); } /// -/// Dump information about all current SFXSource instances to the console. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @see SFXSource @see sfxDumpSourcesToString @ingroup SFX ) +/// Dump information about all current SFXSource instances to the console. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @see SFXSource +/// @see sfxDumpSourcesToString +/// @ingroup SFX ) +/// /// public void sfxDumpSources(bool includeGroups = false){ @@ -5688,7 +8024,15 @@ public void sfxDumpSources(bool includeGroups = false){ m_ts.fn_sfxDumpSources(includeGroups); } /// -/// Dump information about all current SFXSource instances to a string. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @return A string containing a dump of information about all currently instantiated SFXSources. @see SFXSource @see sfxDumpSources @ingroup SFX ) +/// Dump information about all current SFXSource instances to a string. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @return A string containing a dump of information about all currently instantiated SFXSources. +/// @see SFXSource +/// @see sfxDumpSources +/// @ingroup SFX ) +/// /// public string sfxDumpSourcesToString(bool includeGroups = false){ @@ -5696,7 +8040,19 @@ public string sfxDumpSourcesToString(bool includeGroups = false){ return m_ts.fn_sfxDumpSourcesToString(includeGroups); } /// -/// Return a newline-separated list of all active states. @return A list of the form @verbatim stateName1 NL stateName2 NL stateName3 ... @endverbatim where each element is the name of an active state object. @tsexample // Disable all active states. foreach$( %state in sfxGetActiveStates() ) %state.disable(); @endtsexample @ingroup SFX ) +/// Return a newline-separated list of all active states. +/// @return A list of the form +/// @verbatim +/// stateName1 NL stateName2 NL stateName3 ... +/// @endverbatim +/// where each element is the name of an active state object. +/// @tsexample +/// // Disable all active states. +/// foreach$( %state in sfxGetActiveStates() ) +/// %state.disable(); +/// @endtsexample +/// @ingroup SFX ) +/// /// public string sfxGetActiveStates(){ @@ -5704,7 +8060,29 @@ public string sfxGetActiveStates(){ return m_ts.fn_sfxGetActiveStates(); } /// -/// Get a list of all available sound devices. The return value will be a newline-separated list of entries where each line describes one available sound device. Each such line will have the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. @return A newline-separated list of information about all available sound devices. @see sfxCreateDevice @see sfxGetDeviceInfo @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @ref SFX_devices @ingroup SFX ) +/// Get a list of all available sound devices. +/// The return value will be a newline-separated list of entries where each line describes one available sound +/// device. Each such line will have the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// @return A newline-separated list of information about all available sound devices. +/// @see sfxCreateDevice +/// @see sfxGetDeviceInfo +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string sfxGetAvailableDevices(){ @@ -5712,7 +8090,36 @@ public string sfxGetAvailableDevices(){ return m_ts.fn_sfxGetAvailableDevices(); } /// -/// Return information about the currently active sound device. The return value is a tab-delimited string of the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. - caps: A bitfield of capability flags. @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. @see sfxCreateDevice @see sfxGetAvailableDevices @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @see $SFX::DEVICE_INFO_CAPS @see $SFX::DEVICE_CAPS_REVERB @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT @see $SFX::DEVICE_CAPS_OCCLUSION @see $SFX::DEVICE_CAPS_DSPEFFECTS @see $SFX::DEVICE_CAPS_MULTILISTENER @see $SFX::DEVICE_CAPS_FMODDESIGNER @ref SFX_devices @ingroup SFX ) +/// Return information about the currently active sound device. +/// The return value is a tab-delimited string of the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// - caps: A bitfield of capability flags. +/// @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. +/// @see sfxCreateDevice +/// @see sfxGetAvailableDevices +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @see $SFX::DEVICE_INFO_CAPS +/// @see $SFX::DEVICE_CAPS_REVERB +/// @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT +/// @see $SFX::DEVICE_CAPS_OCCLUSION +/// @see $SFX::DEVICE_CAPS_DSPEFFECTS +/// @see $SFX::DEVICE_CAPS_MULTILISTENER +/// @see $SFX::DEVICE_CAPS_FMODDESIGNER +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string sfxGetDeviceInfo(){ @@ -5720,7 +8127,12 @@ public string sfxGetDeviceInfo(){ return m_ts.fn_sfxGetDeviceInfo(); } /// -/// Get the falloff curve type currently being applied to 3D sounds. @return The current distance model type. @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the falloff curve type currently being applied to 3D sounds. +/// @return The current distance model type. +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public TypeSFXDistanceModel sfxGetDistanceModel(){ @@ -5728,7 +8140,12 @@ public TypeSFXDistanceModel sfxGetDistanceModel(){ return (TypeSFXDistanceModel)( m_ts.fn_sfxGetDistanceModel()); } /// -/// Get the current global doppler effect setting. @return The current global doppler effect scale factor (>=0). @see sfxSetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Get the current global doppler effect setting. +/// @return The current global doppler effect scale factor (>=0). +/// @see sfxSetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public float sfxGetDopplerFactor(){ @@ -5736,7 +8153,14 @@ public float sfxGetDopplerFactor(){ return m_ts.fn_sfxGetDopplerFactor(); } /// -/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. @return The current scale factor for logarithmic 3D sound falloff curves. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. +/// @return The current scale factor for logarithmic 3D sound falloff curves. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public float sfxGetRolloffFactor(){ @@ -5744,7 +8168,10 @@ public float sfxGetRolloffFactor(){ return m_ts.fn_sfxGetRolloffFactor(); } /// -/// , , ), Start playing the given source or create a new source for the given track and play it. @hide ) +/// , , ), +/// Start playing the given source or create a new source for the given track and play it. +/// @hide ) +/// /// public int sfxPlay(string trackName, string pointOrX = "", string y = "", string z = ""){ @@ -5752,7 +8179,11 @@ public int sfxPlay(string trackName, string pointOrX = "", string y = "", strin return m_ts.fn_sfxPlay(trackName, pointOrX, y, z); } /// -/// , , , -1.0f), SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) Create a new play-once source for the given profile or description+filename and start playback of the source. @hide ) +/// , , , -1.0f), +/// SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) +/// Create a new play-once source for the given profile or description+filename and start playback of the source. +/// @hide ) +/// /// public int sfxPlayOnce(string SFXType, string filename, string x = "", string y = "", string z = "", float fadeInTime = -1.0f){ @@ -5760,7 +8191,11 @@ public int sfxPlayOnce(string SFXType, string filename, string x = "", string y return m_ts.fn_sfxPlayOnce(SFXType, filename, x, y, z, fadeInTime); } /// -/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. @param model The distance model to use for 3D sound. @note This setting takes effect globally and is applied to all 3D sounds. @ingroup SFX ) +/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. +/// @param model The distance model to use for 3D sound. +/// @note This setting takes effect globally and is applied to all 3D sounds. +/// @ingroup SFX ) +/// /// public void sfxSetDistanceModel(TypeSFXDistanceModel model){ @@ -5768,7 +8203,13 @@ public void sfxSetDistanceModel(TypeSFXDistanceModel model){ m_ts.fn_sfxSetDistanceModel((int)model ); } /// -/// Set the global doppler effect scale factor. @param value The new doppler shift scale factor. @pre @a value must be >= 0. @see sfxGetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Set the global doppler effect scale factor. +/// @param value The new doppler shift scale factor. +/// @pre @a value must be >= 0. +/// @see sfxGetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public void sfxSetDopplerFactor(float value){ @@ -5776,7 +8217,16 @@ public void sfxSetDopplerFactor(float value){ m_ts.fn_sfxSetDopplerFactor(value); } /// -/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. @param value The new scale factor for logarithmic 3D sound falloff curves. @pre @a value must be > 0. @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. +/// @param value The new scale factor for logarithmic 3D sound falloff curves. +/// @pre @a value must be > 0. +/// @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public void sfxSetRolloffFactor(float value){ @@ -5784,7 +8234,11 @@ public void sfxSetRolloffFactor(float value){ m_ts.fn_sfxSetRolloffFactor(value); } /// -/// Stop playback of the given @a source. This is equivalent to calling SFXSource::stop(). @param source The source to put into stopped state. @ingroup SFX ) +/// Stop playback of the given @a source. +/// This is equivalent to calling SFXSource::stop(). +/// @param source The source to put into stopped state. +/// @ingroup SFX ) +/// /// public void sfxStop(string source){ @@ -5792,7 +8246,15 @@ public void sfxStop(string source){ m_ts.fn_sfxStop(source); } /// -/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. The advantage of this function over directly calling delete() is that it will correctly handle volume fades that may be configured on the source. Whereas calling delete() would immediately stop playback and delete the source, this functionality will wait for the fade-out to play and only then stop the source and delete it. @param source A sound source. @ref SFXSource_fades @ingroup SFX ) +/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. +/// The advantage of this function over directly calling delete() is that it will correctly +/// handle volume fades that may be configured on the source. Whereas calling delete() would immediately +/// stop playback and delete the source, this functionality will wait for the fade-out to play and only then +/// stop the source and delete it. +/// @param source A sound source. +/// @ref SFXSource_fades +/// @ingroup SFX ) +/// /// public void sfxStopAndDelete(string source){ @@ -5800,7 +8262,13 @@ public void sfxStopAndDelete(string source){ m_ts.fn_sfxStopAndDelete(source); } /// -/// , ), (string executable, string args, string directory) @brief Launches an outside executable or batch file @param executable Name of the executable or batch file @param args Optional list of arguments, in string format, to pass to the executable @param directory Optional string containing path to output or shell @ingroup Platform) +/// , ), (string executable, string args, string directory) +/// @brief Launches an outside executable or batch file +/// @param executable Name of the executable or batch file +/// @param args Optional list of arguments, in string format, to pass to the executable +/// @param directory Optional string containing path to output or shell +/// @ingroup Platform) +/// /// public bool shellExecute(string executable, string args = "", string directory = ""){ @@ -5808,7 +8276,11 @@ public bool shellExecute(string executable, string args = "", string directory return m_ts.fn_shellExecute(executable, args, directory); } /// -/// @brief Determines the memory consumption of a class or object. @param objectOrClass The object or class being measured. @return Returns the total size of an object in bytes. @ingroup Debugging) +/// @brief Determines the memory consumption of a class or object. +/// @param objectOrClass The object or class being measured. +/// @return Returns the total size of an object in bytes. +/// @ingroup Debugging) +/// /// public int sizeofx(string objectOrClass){ @@ -5816,7 +8288,25 @@ public int sizeofx(string objectOrClass){ return m_ts.fn_sizeof(objectOrClass); } /// -/// @brief Prevents mouse movement from being processed In the source, whenever a mouse move event occurs GameTSCtrl::onMouseMove() is called. Whenever snapToggle() is called, it will flag a variable that can prevent this from happening: gSnapLine. This variable is not exposed to script, so you need to call this function to trigger it. @tsexample // Snapping is off by default, so we will toggle // it on first: PlayGui.snapToggle(); // Mouse movement should be disabled // Let's turn it back on PlayGui.snapToggle(); @endtsexample @ingroup GuiGame) +/// @brief Prevents mouse movement from being processed +/// +/// In the source, whenever a mouse move event occurs +/// GameTSCtrl::onMouseMove() is called. Whenever snapToggle() +/// is called, it will flag a variable that can prevent this +/// from happening: gSnapLine. This variable is not exposed to +/// script, so you need to call this function to trigger it. +/// +/// @tsexample +/// // Snapping is off by default, so we will toggle +/// // it on first: +/// PlayGui.snapToggle(); +/// // Mouse movement should be disabled +/// // Let's turn it back on +/// PlayGui.snapToggle(); +/// @endtsexample +/// +/// @ingroup GuiGame) +/// /// public void snapToggle(){ @@ -5824,7 +8314,9 @@ public void snapToggle(){ m_ts.fn_snapToggle(); } /// -/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) @hide) +/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) +/// @hide) +/// /// public int spawnObject(string spawnClass, string spawnDataBlock = "", string spawnName = "", string spawnProperties = "", string spawnScript = "", string modelName = ""){ @@ -5832,7 +8324,14 @@ public int spawnObject(string spawnClass, string spawnDataBlock = "", string sp return m_ts.fn_spawnObject(spawnClass, spawnDataBlock, spawnName, spawnProperties, spawnScript, modelName); } /// -/// Activates the shape replicator. @tsexample // Call the function StartClientReplication() @endtsexample @ingroup Foliage ) +/// Activates the shape replicator. +/// @tsexample +/// // Call the function +/// StartClientReplication() +/// @endtsexample +/// @ingroup Foliage +/// ) +/// /// public void StartClientReplication(){ @@ -5840,7 +8339,11 @@ public void StartClientReplication(){ m_ts.fn_StartClientReplication(); } /// -/// @brief Start watching resources for file changes Typically this is called during initializeCore(). @see stopFileChangeNotifications() @ingroup FileSystem) +/// @brief Start watching resources for file changes +/// Typically this is called during initializeCore(). +/// @see stopFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void startFileChangeNotifications(){ @@ -5848,7 +8351,13 @@ public void startFileChangeNotifications(){ m_ts.fn_startFileChangeNotifications(); } /// -/// Activates the foliage replicator. @tsexample // Call the function StartFoliageReplication(); @endtsexample @ingroup Foliage) +/// Activates the foliage replicator. +/// @tsexample +/// // Call the function +/// StartFoliageReplication(); +/// @endtsexample +/// @ingroup Foliage) +/// /// public void StartFoliageReplication(){ @@ -5857,6 +8366,7 @@ public void StartFoliageReplication(){ } /// /// startHeartbeat(...); ) +/// /// public void startHeartbeat(){ @@ -5865,6 +8375,7 @@ public void startHeartbeat(){ } /// /// startPrecisionTimer() - Create and start a high resolution platform timer. Returns the timer id. ) +/// /// public int startPrecisionTimer(){ @@ -5872,7 +8383,18 @@ public int startPrecisionTimer(){ return m_ts.fn_startPrecisionTimer(); } /// -/// Test whether the given string begins with the given prefix. @param str The string to test. @param prefix The potential prefix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. @tsexample startsWith( \"TEST123\", \"test\" ) // Returns true. @endtsexample @see endsWith @ingroup Strings ) +/// Test whether the given string begins with the given prefix. +/// @param str The string to test. +/// @param prefix The potential prefix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"test\" ) // Returns true. +/// @endtsexample +/// @see endsWith +/// @ingroup Strings ) +/// /// public bool startsWith(string str, string prefix, bool caseSensitive = false){ @@ -5880,7 +8402,11 @@ public bool startsWith(string str, string prefix, bool caseSensitive = false){ return m_ts.fn_startsWith(str, prefix, caseSensitive); } /// -/// THEORA, 30.0f, Point2I::Zero ), Begins a video capture session. @see stopVideoCapture @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Begins a video capture session. +/// @see stopVideoCapture +/// @ingroup Rendering ) +/// /// public void startVideoCapture(string canvas, string filename, string encoder = "THEORA", float framerate = 30.0f, Point2I resolution = null ){ if (resolution== null) {resolution = new Point2I(0,0);} @@ -5889,7 +8415,11 @@ public void startVideoCapture(string canvas, string filename, string encoder = m_ts.fn_startVideoCapture(canvas, filename, encoder, framerate, resolution.AsString()); } /// -/// @brief Stop watching resources for file changes Typically this is called during shutdownCore(). @see startFileChangeNotifications() @ingroup FileSystem) +/// @brief Stop watching resources for file changes +/// Typically this is called during shutdownCore(). +/// @see startFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void stopFileChangeNotifications(){ @@ -5898,6 +8428,7 @@ public void stopFileChangeNotifications(){ } /// /// stopHeartbeat(...); ) +/// /// public void stopHeartbeat(){ @@ -5906,6 +8437,7 @@ public void stopHeartbeat(){ } /// /// stopPrecisionTimer( S32 id ) - Stop and destroy timer with the passed id. Returns the elapsed milliseconds. ) +/// /// public int stopPrecisionTimer(int id){ @@ -5913,7 +8445,10 @@ public int stopPrecisionTimer(int id){ return m_ts.fn_stopPrecisionTimer(id); } /// -/// () @brief Stops the rendering sampler @ingroup Rendering) +/// () +/// @brief Stops the rendering sampler +/// @ingroup Rendering) +/// /// public void stopSampling(){ @@ -5922,6 +8457,7 @@ public void stopSampling(){ } /// /// stopServerQuery(...); ) +/// /// public void stopServerQuery(){ @@ -5929,7 +8465,10 @@ public void stopServerQuery(){ m_ts.fn_stopServerQuery(); } /// -/// Stops the video capture session. @see startVideoCapture @ingroup Rendering ) +/// Stops the video capture session. +/// @see startVideoCapture +/// @ingroup Rendering ) +/// /// public void stopVideoCapture(){ @@ -5937,7 +8476,11 @@ public void stopVideoCapture(){ m_ts.fn_stopVideoCapture(); } /// -/// Return the integer character code value corresponding to the first character in the given string. @param chr a (one-character) string. @return the UTF32 code value for the first character in the given string. @ingroup Strings ) +/// Return the integer character code value corresponding to the first character in the given string. +/// @param chr a (one-character) string. +/// @return the UTF32 code value for the first character in the given string. +/// @ingroup Strings ) +/// /// public int strasc(string chr){ @@ -5945,7 +8488,13 @@ public int strasc(string chr){ return m_ts.fn_strasc(chr); } /// -/// Find the first occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strrchr @ingroup Strings ) +/// Find the first occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strrchr +/// @ingroup Strings ) +/// /// public string strchr(string str, string chr){ @@ -5953,7 +8502,16 @@ public string strchr(string str, string chr){ return m_ts.fn_strchr(str, chr); } /// -/// Find the first occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strchrpos( \"test\", \"s\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the first occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strchrpos( \"test\", \"s\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int strchrpos(string str, string chr, int start = 0){ @@ -5961,7 +8519,19 @@ public int strchrpos(string str, string chr, int start = 0){ return m_ts.fn_strchrpos(str, chr, start); } /// -/// Compares two strings using case-b>sensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >1 otherwise. @tsexample if( strcmp( %var, \"foobar\" ) == 0 ) echo( \"%var is equal to 'foobar'\" ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using case-b>sensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >1 otherwise. +/// @tsexample +/// if( strcmp( %var, \"foobar\" ) == 0 ) +/// echo( \"%var is equal to 'foobar'\" ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int strcmp(string str1, string str2){ @@ -5969,7 +8539,16 @@ public int strcmp(string str1, string str2){ return m_ts.fn_strcmp(str1, str2); } /// -/// Format the given value as a string using printf-style formatting. @param format A printf-style format string. @param value The value argument matching the given format string. @tsexample // Convert the given integer value to a string in a hex notation. %hex = strformat( \"%x\", %value ); @endtsexample @ingroup Strings @see http://en.wikipedia.org/wiki/Printf ) +/// Format the given value as a string using printf-style formatting. +/// @param format A printf-style format string. +/// @param value The value argument matching the given format string. +/// @tsexample +/// // Convert the given integer value to a string in a hex notation. +/// %hex = strformat( \"%x\", %value ); +/// @endtsexample +/// @ingroup Strings +/// @see http://en.wikipedia.org/wiki/Printf ) +/// /// public string strformat(string format, string value){ @@ -5977,7 +8556,19 @@ public string strformat(string format, string value){ return m_ts.fn_strformat(format, value); } /// -/// Compares two strings using case-b>insensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >0 otherwise. @tsexample if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) echo( \"this is always true\" ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using case-b>insensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >0 otherwise. +/// @tsexample +/// if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) +/// echo( \"this is always true\" ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int stricmp(string str1, string str2){ @@ -5985,7 +8576,35 @@ public int stricmp(string str1, string str2){ return m_ts.fn_stricmp(str1, str2); } /// -/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int strinatcmp(string str1, string str2){ @@ -5993,7 +8612,15 @@ public int strinatcmp(string str1, string str2){ return m_ts.fn_strinatcmp(str1, str2); } /// -/// Remove all occurrences of characters contained in @a chars from @a str. @param str The string to filter characters out from. @param chars A string of characters to filter out from @a str. @return A version of @a str with all occurrences of characters contained in @a chars filtered out. @tsexample stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". @endtsexample @ingroup Strings ) +/// Remove all occurrences of characters contained in @a chars from @a str. +/// @param str The string to filter characters out from. +/// @param chars A string of characters to filter out from @a str. +/// @return A version of @a str with all occurrences of characters contained in @a chars filtered out. +/// @tsexample +/// stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string stripChars(string str, string chars){ @@ -6001,7 +8628,18 @@ public string stripChars(string str, string chars){ return m_ts.fn_stripChars(str, chars); } /// -/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. @param inString String to strip TorqueML control characters from. @tsexample // Define the string to strip TorqueML control characters from %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; // Request the stripped version of the string %strippedString = StripMLControlChars(%string); @endtsexample @return Version of the inputted string with all TorqueML characters removed. @see References @ingroup GuiCore) +/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. +/// @param inString String to strip TorqueML control characters from. +/// @tsexample +/// // Define the string to strip TorqueML control characters from +/// %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; +/// // Request the stripped version of the string +/// %strippedString = StripMLControlChars(%string); +/// @endtsexample +/// @return Version of the inputted string with all TorqueML characters removed. +/// @see References +/// @ingroup GuiCore) +/// /// public string StripMLControlChars(string inString){ @@ -6009,7 +8647,15 @@ public string StripMLControlChars(string inString){ return m_ts.fn_StripMLControlChars(inString); } /// -/// Strip a numeric suffix from the given string. @param str The string from which to strip its numeric suffix. @return The string @a str without its number suffix or the original string @a str if it has no such suffix. @tsexample stripTrailingNumber( \"test123\" ) // Returns \"test\". @endtsexample @see getTrailingNumber @ingroup Strings ) +/// Strip a numeric suffix from the given string. +/// @param str The string from which to strip its numeric suffix. +/// @return The string @a str without its number suffix or the original string @a str if it has no such suffix. +/// @tsexample +/// stripTrailingNumber( \"test123\" ) // Returns \"test\". +/// @endtsexample +/// @see getTrailingNumber +/// @ingroup Strings ) +/// /// public string stripTrailingNumber(string str){ @@ -6017,7 +8663,19 @@ public string stripTrailingNumber(string str){ return m_ts.fn_stripTrailingNumber(str); } /// -/// Match a pattern against a string. @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match any number of characters and '?' to match a single character. @param str The string which should be matched against @a pattern. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches the given @a pattern. @tsexample strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. @endtsexample @see strIsMatchMultipleExpr @ingroup Strings ) +/// Match a pattern against a string. +/// @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match +/// any number of characters and '?' to match a single character. +/// @param str The string which should be matched against @a pattern. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches the given @a pattern. +/// @tsexample +/// strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchMultipleExpr +/// @ingroup Strings ) +/// /// public bool strIsMatchExpr(string pattern, string str, bool caseSensitive = false){ @@ -6025,7 +8683,19 @@ public bool strIsMatchExpr(string pattern, string str, bool caseSensitive = fal return m_ts.fn_strIsMatchExpr(pattern, str, caseSensitive); } /// -/// Match a multiple patterns against a single string. @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match any number of characters and '?' to match a single character. Each of the patterns is tried in turn. @param str The string which should be matched against @a patterns. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches any of the given @a patterns. @tsexample strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. @endtsexample @see strIsMatchExpr @ingroup Strings ) +/// Match a multiple patterns against a single string. +/// @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match +/// any number of characters and '?' to match a single character. Each of the patterns is tried in turn. +/// @param str The string which should be matched against @a patterns. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches any of the given @a patterns. +/// @tsexample +/// strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Strings ) +/// /// public bool strIsMatchMultipleExpr(string patterns, string str, bool caseSensitive = false){ @@ -6033,7 +8703,12 @@ public bool strIsMatchMultipleExpr(string patterns, string str, bool caseSensit return m_ts.fn_strIsMatchMultipleExpr(patterns, str, caseSensitive); } /// -/// Get the length of the given string in bytes. @note This does b>not/b> return a true character count for strings with multi-byte characters! @param str A string. @return The length of the given string in bytes. @ingroup Strings ) +/// Get the length of the given string in bytes. +/// @note This does b>not/b> return a true character count for strings with multi-byte characters! +/// @param str A string. +/// @return The length of the given string in bytes. +/// @ingroup Strings ) +/// /// public int strlen(string str){ @@ -6041,7 +8716,15 @@ public int strlen(string str){ return m_ts.fn_strlen(str); } /// -/// Return an all lower-case version of the given string. @param str A string. @return A version of @a str with all characters converted to lower-case. @tsexample strlwr( \"TesT1\" ) // Returns \"test1\" @endtsexample @see strupr @ingroup Strings ) +/// Return an all lower-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to lower-case. +/// @tsexample +/// strlwr( \"TesT1\" ) // Returns \"test1\" +/// @endtsexample +/// @see strupr +/// @ingroup Strings ) +/// /// public string strlwr(string str){ @@ -6049,7 +8732,35 @@ public string strlwr(string str){ return m_ts.fn_strlwr(str); } /// -/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int strnatcmp(string str1, string str2){ @@ -6057,7 +8768,15 @@ public int strnatcmp(string str1, string str2){ return m_ts.fn_strnatcmp(str1, str2); } /// -/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. @param haystack The string to search. @param needle The string to search for. @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. @tsexample strpos( \"b ab\", \"b\", 1 ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. +/// @param haystack The string to search. +/// @param needle The string to search for. +/// @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. +/// @tsexample +/// strpos( \"b ab\", \"b\", 1 ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int strpos(string haystack, string needle, int offset = 0){ @@ -6065,7 +8784,13 @@ public int strpos(string haystack, string needle, int offset = 0){ return m_ts.fn_strpos(haystack, needle, offset); } /// -/// Find the last occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strchr @ingroup Strings ) +/// Find the last occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strchr +/// @ingroup Strings ) +/// /// public string strrchr(string str, string chr){ @@ -6073,7 +8798,16 @@ public string strrchr(string str, string chr){ return m_ts.fn_strrchr(str, chr); } /// -/// Find the last occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strrchrpos( \"test\", \"t\" ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the last occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strrchrpos( \"test\", \"t\" ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int strrchrpos(string str, string chr, int start = 0){ @@ -6081,7 +8815,17 @@ public int strrchrpos(string str, string chr, int start = 0){ return m_ts.fn_strrchrpos(str, chr, start); } /// -/// ), Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. @param str The string to repeat multiple times. @param numTimes The number of times to repeat @a str in the result string. @param delimiter The string to put between each repetition of @a str. @return A string containing @a str repeated @a numTimes times. @tsexample strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". @endtsexample @ingroup Strings ) +/// ), +/// Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. +/// @param str The string to repeat multiple times. +/// @param numTimes The number of times to repeat @a str in the result string. +/// @param delimiter The string to put between each repetition of @a str. +/// @return A string containing @a str repeated @a numTimes times. +/// @tsexample +/// strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string strrepeat(string str, int numTimes, string delimiter = ""){ @@ -6089,7 +8833,16 @@ public string strrepeat(string str, int numTimes, string delimiter = ""){ return m_ts.fn_strrepeat(str, numTimes, delimiter); } /// -/// Replace all occurrences of @a from in @a source with @a to. @param source The string in which to replace the occurrences of @a from. @param from The string to replace in @a source. @param to The string with which to replace occurrences of @from. @return A string with all occurrences of @a from in @a source replaced by @a to. @tsexample strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". @endtsexample @ingroup Strings ) +/// Replace all occurrences of @a from in @a source with @a to. +/// @param source The string in which to replace the occurrences of @a from. +/// @param from The string to replace in @a source. +/// @param to The string with which to replace occurrences of @from. +/// @return A string with all occurrences of @a from in @a source replaced by @a to. +/// @tsexample +/// strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string strreplace(string source, string from, string to){ @@ -6097,7 +8850,15 @@ public string strreplace(string source, string from, string to){ return m_ts.fn_strreplace(source, from, to); } /// -/// Find the start of @a substring in the given @a string searching from left to right. @param string The string to search. @param substring The string to search for. @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. @tsexample strstr( \"abcd\", \"c\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the start of @a substring in the given @a string searching from left to right. +/// @param string The string to search. +/// @param substring The string to search for. +/// @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. +/// @tsexample +/// strstr( \"abcd\", \"c\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int strstr(string stringx, string substring){ @@ -6106,6 +8867,7 @@ public int strstr(string stringx, string substring){ } /// /// strToPlayerName(string); ) +/// /// public string strToPlayerName(string ptr){ @@ -6113,7 +8875,15 @@ public string strToPlayerName(string ptr){ return m_ts.fn_strToPlayerName(ptr); } /// -/// Return an all upper-case version of the given string. @param str A string. @return A version of @a str with all characters converted to upper-case. @tsexample strupr( \"TesT1\" ) // Returns \"TEST1\" @endtsexample @see strlwr @ingroup Strings ) +/// Return an all upper-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to upper-case. +/// @tsexample +/// strupr( \"TesT1\" ) // Returns \"TEST1\" +/// @endtsexample +/// @see strlwr +/// @ingroup Strings ) +/// /// public string strupr(string str){ @@ -6121,7 +8891,13 @@ public string strupr(string str){ return m_ts.fn_strupr(str); } /// -/// @brief Initializes and open the telnet console. @param port Port to listen on for console connections (0 will shut down listening). @param consolePass Password for read/write access to console. @param listenPass Password for read access to console. @param remoteEcho [optional] Enable echoing back to the client, off by default. @ingroup Debugging) +/// @brief Initializes and open the telnet console. +/// @param port Port to listen on for console connections (0 will shut down listening). +/// @param consolePass Password for read/write access to console. +/// @param listenPass Password for read access to console. +/// @param remoteEcho [optional] Enable echoing back to the client, off by default. +/// @ingroup Debugging) +/// /// public void telnetSetParameters(int port, string consolePass, string listenPass, bool remoteEcho = false){ @@ -6130,6 +8906,7 @@ public void telnetSetParameters(int port, string consolePass, string listenPass } /// /// testBridge(arg1, arg2, arg3)) +/// /// public string testJavaScriptBridge(string arg1, string arg2, string arg3){ @@ -6137,7 +8914,13 @@ public string testJavaScriptBridge(string arg1, string arg2, string arg3){ return m_ts.fn_testJavaScriptBridge(arg1, arg2, arg3); } /// -/// Enable or disable tracing in the script code VM. When enabled, the script code runtime will trace the invocation and returns from all functions that are called and log them to the console. This is helpful in observing the flow of the script program. @param enable New setting for script trace execution, on by default. @ingroup Debugging ) +/// Enable or disable tracing in the script code VM. +/// When enabled, the script code runtime will trace the invocation and returns +/// from all functions that are called and log them to the console. This is helpful in +/// observing the flow of the script program. +/// @param enable New setting for script trace execution, on by default. +/// @ingroup Debugging ) +/// /// public void trace(bool enable = true){ @@ -6145,7 +8928,14 @@ public void trace(bool enable = true){ m_ts.fn_trace(enable); } /// -/// Remove leading and trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. @tsexample trim( \" string \" ); // Returns \"string\". @endtsexample @ingroup Strings ) +/// Remove leading and trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// trim( \" string \" ); // Returns \"string\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string trim(string str){ @@ -6154,6 +8944,7 @@ public string trim(string str){ } /// /// tsUpdateImposterImages( bool forceupdate )) +/// /// public void tsUpdateImposterImages(bool forceUpdate = false){ @@ -6161,15 +8952,12 @@ public void tsUpdateImposterImages(bool forceUpdate = false){ m_ts.fn_tsUpdateImposterImages(forceUpdate); } /// -/// , false), ([searchString[, bool skipInteractive]]) @brief Run unit tests, or just the tests that prefix match against the searchString. @ingroup Console) -/// -public void unitTest_runTests(string searchString = "", bool skip = false){ - - -m_ts.fn_unitTest_runTests(searchString, skip); -} -/// -/// (string queueName, string listener) @brief Unregisters an event message @param queueName String containing the name of queue @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Unregisters an event message +/// @param queueName String containing the name of queue +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public void unregisterMessageListener(string queueName, string listenerName){ @@ -6177,7 +8965,11 @@ public void unregisterMessageListener(string queueName, string listenerName){ m_ts.fn_unregisterMessageListener(queueName, listenerName); } /// -/// (string queueName) @brief Unregisters a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Unregisters a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void unregisterMessageQueue(string queueName){ @@ -6185,7 +8977,28 @@ public void unregisterMessageQueue(string queueName){ m_ts.fn_unregisterMessageQueue(queueName); } /// -/// Add two vectors. @param a The first vector. @param b The second vector. @return The vector @a a + @a b. @tsexample //----------------------------------------------------------------------------- // // VectorAdd( %a, %b ); // // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a + b = ( ax + bx, ay + by, az + bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; // %r = \"1 1 0\"; %r = VectorAdd( %a, %b ); @endtsexample @ingroup Vectors) +/// Add two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a + @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorAdd( %a, %b ); +/// // +/// // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a + b = ( ax + bx, ay + by, az + bz ) +/// // +/// //----------------------------------------------------------------------------- +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; +/// // %r = \"1 1 0\"; +/// %r = VectorAdd( %a, %b ); +/// @endtsexample +/// @ingroup Vectors) +/// /// public Point3F VectorAdd(Point3F a, Point3F b){ @@ -6193,7 +9006,30 @@ public Point3F VectorAdd(Point3F a, Point3F b){ return new Point3F ( m_ts.fn_VectorAdd(a.AsString(), b.AsString())); } /// -/// Calculcate the cross product of two vectors. @param a The first vector. @param b The second vector. @return The cross product @a x @a b. @tsexample //----------------------------------------------------------------------------- // // VectorCross( %a, %b ); // // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; // %r = \"1 -1 -2\"; %r = VectorCross( %a, %b ); @endtsexample @ingroup Vectors ) +/// Calculcate the cross product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The cross product @a x @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorCross( %a, %b ); +/// // +/// // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; +/// // %r = \"1 -1 -2\"; +/// %r = VectorCross( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorCross(Point3F a, Point3F b){ @@ -6201,7 +9037,32 @@ public Point3F VectorCross(Point3F a, Point3F b){ return new Point3F ( m_ts.fn_VectorCross(a.AsString(), b.AsString())); } /// -/// Compute the distance between two vectors. @param a The first vector. @param b The second vector. @return The length( @a b - @a a ). @tsexample //----------------------------------------------------------------------------- // // VectorDist( %a, %b ); // // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a -> b = ||( b - a )|| // = ||( bx - ax, by - ay, bz - az )|| // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); // %r = mSqrt( 3 ); %r = VectorDist( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the distance between two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The length( @a b - @a a ). +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDist( %a, %b ); +/// // +/// // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a -> b = ||( b - a )|| +/// // = ||( bx - ax, by - ay, bz - az )|| +/// // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); +/// // %r = mSqrt( 3 ); +/// %r = VectorDist( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float VectorDist(Point3F a, Point3F b){ @@ -6209,7 +9070,30 @@ public float VectorDist(Point3F a, Point3F b){ return m_ts.fn_VectorDist(a.AsString(), b.AsString()); } /// -/// Compute the dot product of two vectors. @param a The first vector. @param b The second vector. @return The dot product @a a * @a b. @tsexample //----------------------------------------------------------------------------- // // VectorDot( %a, %b ); // // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: // // a . b = ( ax * bx + ay * by + az * bz ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; // %r = 2; %r = VectorDot( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the dot product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The dot product @a a * @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDot( %a, %b ); +/// // +/// // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: +/// // +/// // a . b = ( ax * bx + ay * by + az * bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; +/// // %r = 2; +/// %r = VectorDot( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float VectorDot(Point3F a, Point3F b){ @@ -6217,7 +9101,29 @@ public float VectorDot(Point3F a, Point3F b){ return m_ts.fn_VectorDot(a.AsString(), b.AsString()); } /// -/// Calculate the magnitude of the given vector. @param v A vector. @return The length of vector @a v. @tsexample //----------------------------------------------------------------------------- // // VectorLen( %a ); // // The length or magnitude of vector a, (ax, ay, az), is: // // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); // %r = mSqrt( 2 ); // %r = 1.414; %r = VectorLen( %a ); @endtsexample @ingroup Vectors ) +/// Calculate the magnitude of the given vector. +/// @param v A vector. +/// @return The length of vector @a v. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLen( %a ); +/// // +/// // The length or magnitude of vector a, (ax, ay, az), is: +/// // +/// // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// +/// // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); +/// // %r = mSqrt( 2 ); +/// // %r = 1.414; +/// %r = VectorLen( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float VectorLen(Point3F v){ @@ -6225,7 +9131,35 @@ public float VectorLen(Point3F v){ return m_ts.fn_VectorLen(v.AsString()); } /// -/// Linearly interpolate between two vectors by @a t. @param a Vector to start interpolation from. @param b Vector to interpolate to. @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector between @a a and @a b is returned. @return An interpolated vector between @a a and @a b. @tsexample //----------------------------------------------------------------------------- // // VectorLerp( %a, %b ); // // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is // weighted by the interpolation factor, t, is // // r = a + t * ( b - a ) // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; %v = \"0.25\"; // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; // %r = \"1.25 0.75 0.25\"; %r = VectorLerp( %a, %b ); @endtsexample @ingroup Vectors ) +/// Linearly interpolate between two vectors by @a t. +/// @param a Vector to start interpolation from. +/// @param b Vector to interpolate to. +/// @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector +/// between @a a and @a b is returned. +/// @return An interpolated vector between @a a and @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLerp( %a, %b ); +/// // +/// // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is +/// // weighted by the interpolation factor, t, is +/// // +/// // r = a + t * ( b - a ) +/// // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// %v = \"0.25\"; +/// +/// // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; +/// // %r = \"1.25 0.75 0.25\"; +/// %r = VectorLerp( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorLerp(Point3F a, Point3F b, float t){ @@ -6233,7 +9167,30 @@ public Point3F VectorLerp(Point3F a, Point3F b, float t){ return new Point3F ( m_ts.fn_VectorLerp(a.AsString(), b.AsString(), t)); } /// -/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. @param v The vector to normalize. @return The vector @a v scaled to length 1. @tsexample //----------------------------------------------------------------------------- // // VectorNormalize( %a ); // // The normalized vector a, (ax, ay, az), is: // // a^ = a / ||a|| // = ( ax / ||a||, ay / ||a||, az / ||a|| ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %l = 1.414; // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; // %r = \"0.707 0.707 0\"; %r = VectorNormalize( %a ); @endtsexample @ingroup Vectors ) +/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. +/// @param v The vector to normalize. +/// @return The vector @a v scaled to length 1. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorNormalize( %a ); +/// // +/// // The normalized vector a, (ax, ay, az), is: +/// // +/// // a^ = a / ||a|| +/// // = ( ax / ||a||, ay / ||a||, az / ||a|| ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %l = 1.414; +/// +/// // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; +/// // %r = \"0.707 0.707 0\"; +/// %r = VectorNormalize( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorNormalize(Point3F v){ @@ -6241,7 +9198,11 @@ public Point3F VectorNormalize(Point3F v){ return new Point3F ( m_ts.fn_VectorNormalize(v.AsString())); } /// -/// Create an orthogonal basis from the given vector. @param aaf The vector to create the orthogonal basis from. @return A matrix representing the orthogonal basis. @ingroup Vectors ) +/// Create an orthogonal basis from the given vector. +/// @param aaf The vector to create the orthogonal basis from. +/// @return A matrix representing the orthogonal basis. +/// @ingroup Vectors ) +/// /// public MatrixF VectorOrthoBasis(AngAxisF aa){ @@ -6250,6 +9211,7 @@ public MatrixF VectorOrthoBasis(AngAxisF aa){ } /// /// (Vector3F, float) rotate a vector in 2d) +/// /// public string VectorRot(Point3F v, float angle){ @@ -6257,7 +9219,30 @@ public string VectorRot(Point3F v, float angle){ return m_ts.fn_VectorRot(v.AsString(), angle); } /// -/// Scales a vector by a scalar. @param a The vector to scale. @param scalar The scale factor. @return The vector @a a * @a scalar. @tsexample //----------------------------------------------------------------------------- // // VectorScale( %a, %v ); // // Scaling vector a, (ax, ay, az), but the scalar, v, is: // // a * v = ( ax * v, ay * v, az * v ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %v = \"2\"; // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; // %r = \"2 2 0\"; %r = VectorScale( %a, %v ); @endtsexample @ingroup Vectors ) +/// Scales a vector by a scalar. +/// @param a The vector to scale. +/// @param scalar The scale factor. +/// @return The vector @a a * @a scalar. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorScale( %a, %v ); +/// // +/// // Scaling vector a, (ax, ay, az), but the scalar, v, is: +/// // +/// // a * v = ( ax * v, ay * v, az * v ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %v = \"2\"; +/// +/// // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; +/// // %r = \"2 2 0\"; +/// %r = VectorScale( %a, %v ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorScale(Point3F a, float scalar){ @@ -6265,7 +9250,30 @@ public Point3F VectorScale(Point3F a, float scalar){ return new Point3F ( m_ts.fn_VectorScale(a.AsString(), scalar)); } /// -/// Subtract two vectors. @param a The first vector. @param b The second vector. @return The vector @a a - @a b. @tsexample //----------------------------------------------------------------------------- // // VectorSub( %a, %b ); // // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a - b = ( ax - bx, ay - by, az - bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; // %r = \"1 -1 0\"; %r = VectorSub( %a, %b ); @endtsexample @ingroup Vectors ) +/// Subtract two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a - @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorSub( %a, %b ); +/// // +/// // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a - b = ( ax - bx, ay - by, az - bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// +/// // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; +/// // %r = \"1 -1 0\"; +/// %r = VectorSub( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public Point3F VectorSub(Point3F a, Point3F b){ @@ -6291,7 +9299,9 @@ public void WalkaboutUpdateMesh(int meshid = 0, int objid = 0, bool remove = fa m_ts.fn_WalkaboutUpdateMesh(meshid, objid, remove); } /// -/// Force all cached fonts to serialize themselves to the cache. @ingroup Font ) +/// Force all cached fonts to serialize themselves to the cache. +/// @ingroup Font ) +/// /// public void writeFontCache(){ @@ -6304,14 +9314,10 @@ public void writeFontCache(){ /// public class ActionMapObject { -private Omni m_ts; - /// - /// - /// - /// -public ActionMapObject(ref Omni ts){m_ts = ts;} /// -/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) @hide) +/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) +/// @hide) +/// /// public bool bind(string actionmap, string a2, string a3, string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= ""){ @@ -6319,7 +9325,29 @@ public bool bind(string actionmap, string a2, string a3, string a4= "", string return m_ts.fnActionMap_bind(actionmap, a2, a3, a4, a5, a6, a7, a8, a9); } /// -/// ), @brief Associates a make command and optional break command to a specified input device action. Must include parenthesis and semicolon in the make and break command strings. @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. @param makeCmd The command to execute when the device/action is made. @param breakCmd [optional] The command to execute when the device or action is unmade. @return True the bind was successful, false if the device was unknown or description failed. @tsexample // Print to the console when the spacebar is pressed function onSpaceDown() { echo(\"Space bar down!\"); } // Print to the console when the spacebar is released function onSpaceUp() { echo(\"Space bar up!\"); } // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); @endtsexample) +/// ), +/// @brief Associates a make command and optional break command to a specified input device action. +/// Must include parenthesis and semicolon in the make and break command strings. +/// @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. +/// @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. +/// @param makeCmd The command to execute when the device/action is made. +/// @param breakCmd [optional] The command to execute when the device or action is unmade. +/// @return True the bind was successful, false if the device was unknown or description failed. +/// @tsexample +/// // Print to the console when the spacebar is pressed +/// function onSpaceDown() +/// { +/// echo(\"Space bar down!\"); +/// } +/// // Print to the console when the spacebar is released +/// function onSpaceUp() +/// { +/// echo(\"Space bar up!\"); +/// } +/// // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events +/// moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); +/// @endtsexample) +/// /// public bool bindCmd(string actionmap, string device, string action, string makeCmd, string breakCmd = ""){ @@ -6327,7 +9355,9 @@ public bool bindCmd(string actionmap, string device, string action, string make return m_ts.fnActionMap_bindCmd(actionmap, device, action, makeCmd, breakCmd); } /// -/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) @hide) +/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) +/// @hide) +/// /// public bool bindObj(string actionmap, string a2, string a3, string a4, string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= ""){ @@ -6335,7 +9365,24 @@ public bool bindObj(string actionmap, string a2, string a3, string a4, string a return m_ts.fnActionMap_bindObj(actionmap, a2, a3, a4, a5, a6, a7, a8, a9, a10); } /// -/// @brief Gets the ActionMap binding for the specified command. Use getField() on the return value to get the device and action of the binding. @param command The function to search bindings for. @return The binding against the specified command. Returns an empty string(\"\") if a binding wasn't found. @tsexample // Find what the function \"jump()\" is bound to in moveMap %bind = moveMap.getBinding( \"jump\" ); if ( %bind !$= \"\" ) { // Find out what device is used in the binding %device = getField( %bind, 0 ); // Find out what action (such as a key) is used in the binding %action = getField( %bind, 1 ); } @endtsexample @see getField) +/// @brief Gets the ActionMap binding for the specified command. +/// Use getField() on the return value to get the device and action of the binding. +/// @param command The function to search bindings for. +/// @return The binding against the specified command. Returns an empty string(\"\") +/// if a binding wasn't found. +/// @tsexample +/// // Find what the function \"jump()\" is bound to in moveMap +/// %bind = moveMap.getBinding( \"jump\" ); +/// if ( %bind !$= \"\" ) +/// { +/// // Find out what device is used in the binding +/// %device = getField( %bind, 0 ); +/// // Find out what action (such as a key) is used in the binding +/// %action = getField( %bind, 1 ); +/// } +/// @endtsexample +/// @see getField) +/// /// public string getBinding(string actionmap, string command){ @@ -6343,7 +9390,18 @@ public string getBinding(string actionmap, string command){ return m_ts.fnActionMap_getBinding(actionmap, command); } /// -/// @brief Gets ActionMap command for the device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The command against the specified device and action. @tsexample // Find what function is bound to a device\'s action // In this example, \"jump()\" was assigned to the space key in another script %command = moveMap.getCommand(\"keyboard\", \"space\"); // Should print \"jump\" in the console echo(%command) @endtsexample) +/// @brief Gets ActionMap command for the device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The command against the specified device and action. +/// @tsexample +/// // Find what function is bound to a device\'s action +/// // In this example, \"jump()\" was assigned to the space key in another script +/// %command = moveMap.getCommand(\"keyboard\", \"space\"); +/// // Should print \"jump\" in the console +/// echo(%command) +/// @endtsexample) +/// /// public string getCommand(string actionmap, string device, string action){ @@ -6351,7 +9409,15 @@ public string getCommand(string actionmap, string device, string action){ return m_ts.fnActionMap_getCommand(actionmap, device, action); } /// -/// @brief Gets the Dead zone for the specified device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone or an empty string(\"\") if the mapping was not found. @tsexample %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Gets the Dead zone for the specified device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone +/// or an empty string(\"\") if the mapping was not found. +/// @tsexample +/// %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public string getDeadZone(string actionmap, string device, string action){ @@ -6359,7 +9425,14 @@ public string getDeadZone(string actionmap, string device, string action){ return m_ts.fnActionMap_getDeadZone(actionmap, device, action); } /// -/// @brief Get any scaling on the specified device and action. @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return Any scaling applied to the specified device and action. @tsexample %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Get any scaling on the specified device and action. +/// @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return Any scaling applied to the specified device and action. +/// @tsexample +/// %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public float getScale(string actionmap, string device, string action){ @@ -6367,7 +9440,16 @@ public float getScale(string actionmap, string device, string action){ return m_ts.fnActionMap_getScale(actionmap, device, action); } /// -/// @brief Determines if the specified device and action is inverted. Should only be used for scrolling devices or gamepad/joystick axes. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return True if the specified device and action is inverted. @tsexample %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) echo(\"Mouse's xAxis is inverted\"); @endtsexample) +/// @brief Determines if the specified device and action is inverted. +/// Should only be used for scrolling devices or gamepad/joystick axes. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the specified device and action is inverted. +/// @tsexample +/// %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) +/// echo(\"Mouse's xAxis is inverted\"); +/// @endtsexample) +/// /// public bool isInverted(string actionmap, string device, string action){ @@ -6375,7 +9457,14 @@ public bool isInverted(string actionmap, string device, string action){ return m_ts.fnActionMap_isInverted(actionmap, device, action); } /// -/// @brief Pop the ActionMap off the %ActionMap stack. Deactivates an %ActionMap and removes it from the @ActionMap stack. @tsexample // Deactivate moveMap moveMap.pop(); @endtsexample @see ActionMap) +/// @brief Pop the ActionMap off the %ActionMap stack. +/// Deactivates an %ActionMap and removes it from the @ActionMap stack. +/// @tsexample +/// // Deactivate moveMap +/// moveMap.pop(); +/// @endtsexample +/// @see ActionMap) +/// /// public void pop(string actionmap){ @@ -6383,7 +9472,14 @@ public void pop(string actionmap){ m_ts.fnActionMap_pop(actionmap); } /// -/// @brief Push the ActionMap onto the %ActionMap stack. Activates an ActionMap and placees it at the top of the ActionMap stack. @tsexample // Make moveMap the active action map moveMap.push(); @endtsexample @see ActionMap) +/// @brief Push the ActionMap onto the %ActionMap stack. +/// Activates an ActionMap and placees it at the top of the ActionMap stack. +/// @tsexample +/// // Make moveMap the active action map +/// moveMap.push(); +/// @endtsexample +/// @see ActionMap) +/// /// public void push(string actionmap){ @@ -6391,7 +9487,15 @@ public void push(string actionmap){ m_ts.fnActionMap_push(actionmap); } /// -/// @brief Saves the ActionMap to a file or dumps it to the console. @param fileName The file path to save the ActionMap to. If a filename is not specified the ActionMap will be dumped to the console. @param append Whether to write the ActionMap at the end of the file or overwrite it. @tsexample // Write out the actionmap into the config.cs file moveMap.save( \"scripts/client/config.cs\" ); @endtsexample) +/// @brief Saves the ActionMap to a file or dumps it to the console. +/// @param fileName The file path to save the ActionMap to. If a filename is not specified +/// the ActionMap will be dumped to the console. +/// @param append Whether to write the ActionMap at the end of the file or overwrite it. +/// @tsexample +/// // Write out the actionmap into the config.cs file +/// moveMap.save( \"scripts/client/config.cs\" ); +/// @endtsexample) +/// /// public void save(string actionmap, string fileName = null , bool append = false){ if (fileName== null) {fileName = null;} @@ -6400,7 +9504,14 @@ public void save(string actionmap, string fileName = null , bool append = false m_ts.fnActionMap_save(actionmap, fileName, append); } /// -/// @brief Removes the binding on an input device and action. @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbind(\"keyboard\", \"space\"); @endtsexample) +/// @brief Removes the binding on an input device and action. +/// @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbind(\"keyboard\", \"space\"); +/// @endtsexample) +/// /// public bool unbind(string actionmap, string device, string action){ @@ -6408,7 +9519,15 @@ public bool unbind(string actionmap, string device, string action){ return m_ts.fnActionMap_unbind(actionmap, device, action); } /// -/// @brief Remove any object-binding on an input device and action. @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @param obj The object to perform unbind against. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); @endtsexample) +/// @brief Remove any object-binding on an input device and action. +/// @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @param obj The object to perform unbind against. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); +/// @endtsexample) +/// /// public bool unbindObj(string actionmap, string device, string action, string obj){ @@ -6421,14 +9540,9 @@ public bool unbindObj(string actionmap, string device, string action, string ob /// public class AIClientObject { -private Omni m_ts; - /// - /// - /// - /// -public AIClientObject(ref Omni ts){m_ts = ts;} /// /// ai.getAimLocation(); ) +/// /// public string AIClient_getAimLocation(string aiclient){ @@ -6437,6 +9551,7 @@ public string AIClient_getAimLocation(string aiclient){ } /// /// ai.getLocation(); ) +/// /// public string AIClient_getLocation(string aiclient){ @@ -6445,6 +9560,7 @@ public string AIClient_getLocation(string aiclient){ } /// /// ai.getMoveDestination(); ) +/// /// public string AIClient_getMoveDestination(string aiclient){ @@ -6453,6 +9569,7 @@ public string AIClient_getMoveDestination(string aiclient){ } /// /// ai.getTargetObject(); ) +/// /// public int AIClient_getTargetObject(string aiclient){ @@ -6461,6 +9578,7 @@ public int AIClient_getTargetObject(string aiclient){ } /// /// ai.missionCycleCleanup(); ) +/// /// public void AIClient_missionCycleCleanup(string aiclient){ @@ -6469,6 +9587,7 @@ public void AIClient_missionCycleCleanup(string aiclient){ } /// /// ai.move(); ) +/// /// public void AIClient_move(string aiclient){ @@ -6477,6 +9596,7 @@ public void AIClient_move(string aiclient){ } /// /// ai.moveForward(); ) +/// /// public void AIClient_moveForward(string aiclient){ @@ -6485,6 +9605,7 @@ public void AIClient_moveForward(string aiclient){ } /// /// ai.setAimLocation( x y z ); ) +/// /// public void AIClient_setAimLocation(string aiclient, Point3F v){ @@ -6493,6 +9614,7 @@ public void AIClient_setAimLocation(string aiclient, Point3F v){ } /// /// ai.setMoveDestination( x y z ); ) +/// /// public void AIClient_setMoveDestination(string aiclient, Point3F v){ @@ -6501,6 +9623,7 @@ public void AIClient_setMoveDestination(string aiclient, Point3F v){ } /// /// ai.setMoveSpeed( float ); ) +/// /// public void AIClient_setMoveSpeed(string aiclient, float speed){ @@ -6509,6 +9632,7 @@ public void AIClient_setMoveSpeed(string aiclient, float speed){ } /// /// ai.setTargetObject( obj ); ) +/// /// public void AIClient_setTargetObject(string aiclient, string objName){ @@ -6517,6 +9641,7 @@ public void AIClient_setTargetObject(string aiclient, string objName){ } /// /// ai.stop(); ) +/// /// public void AIClient_stop(string aiclient){ @@ -6529,14 +9654,9 @@ public void AIClient_stop(string aiclient){ /// public class AIConnectionObject { -private Omni m_ts; - /// - /// - /// - /// -public AIConnectionObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public string AIConnection_getAddress(string aiconnection){ @@ -6544,7 +9664,9 @@ public string AIConnection_getAddress(string aiconnection){ return m_ts.fn_AIConnection_getAddress(aiconnection); } /// -/// getFreeLook() Is freelook on for the current move?) +/// getFreeLook() +/// Is freelook on for the current move?) +/// /// public bool AIConnection_getFreeLook(string aiconnection){ @@ -6552,7 +9674,11 @@ public bool AIConnection_getFreeLook(string aiconnection){ return m_ts.fn_AIConnection_getFreeLook(aiconnection); } /// -/// (string field) Get the given field of a move. @param field One of {'x','y','z','yaw','pitch','roll'} @returns The requested field on the current move.) +/// (string field) +/// Get the given field of a move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @returns The requested field on the current move.) +/// /// public float AIConnection_getMove(string aiconnection, string field){ @@ -6560,7 +9686,9 @@ public float AIConnection_getMove(string aiconnection, string field){ return m_ts.fn_AIConnection_getMove(aiconnection, field); } /// -/// (int trigger) Is the given trigger set?) +/// (int trigger) +/// Is the given trigger set?) +/// /// public bool AIConnection_getTrigger(string aiconnection, int idx){ @@ -6568,7 +9696,9 @@ public bool AIConnection_getTrigger(string aiconnection, int idx){ return m_ts.fn_AIConnection_getTrigger(aiconnection, idx); } /// -/// (bool isFreeLook) Enable/disable freelook on the current move.) +/// (bool isFreeLook) +/// Enable/disable freelook on the current move.) +/// /// public void AIConnection_setFreeLook(string aiconnection, bool isFreeLook){ @@ -6576,7 +9706,11 @@ public void AIConnection_setFreeLook(string aiconnection, bool isFreeLook){ m_ts.fn_AIConnection_setFreeLook(aiconnection, isFreeLook); } /// -/// (string field, float value) Set a field on the current move. @param field One of {'x','y','z','yaw','pitch','roll'} @param value Value to set field to.) +/// (string field, float value) +/// Set a field on the current move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @param value Value to set field to.) +/// /// public void AIConnection_setMove(string aiconnection, string field, float value){ @@ -6584,7 +9718,9 @@ public void AIConnection_setMove(string aiconnection, string field, float value m_ts.fn_AIConnection_setMove(aiconnection, field, value); } /// -/// (int trigger, bool set) Set a trigger.) +/// (int trigger, bool set) +/// Set a trigger.) +/// /// public void AIConnection_setTrigger(string aiconnection, int idx, bool set){ @@ -6597,14 +9733,11 @@ public void AIConnection_setTrigger(string aiconnection, int idx, bool set){ /// public class AIPlayerObject { -private Omni m_ts; - /// - /// - /// - /// -public AIPlayerObject(ref Omni ts){m_ts = ts;} /// -/// ( GameBase obj, [Point3F offset] ) Sets the bot's target object. Optionally set an offset from target location. @hide) +/// ( GameBase obj, [Point3F offset] ) +/// Sets the bot's target object. Optionally set an offset from target location. +/// @hide) +/// /// public void AIPlayer_setAimObject(string aiplayer, string objName, Point3F offset = null ){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} @@ -6613,7 +9746,8 @@ public void AIPlayer_setAimObject(string aiplayer, string objName, Point3F offs m_ts.fn_AIPlayer_setAimObject(aiplayer, objName, offset.AsString()); } /// -/// ) +/// ) +/// /// public void AISearchSimSet(string aiplayer, float fOV, float farDist, string ObjToSearch, string result){ @@ -6621,7 +9755,37 @@ public void AISearchSimSet(string aiplayer, float fOV, float farDist, string Ob m_ts.fnAIPlayer_AISearchSimSet(aiplayer, fOV, farDist, ObjToSearch, result); } /// -/// @brief Use this to stop aiming at an object or a point. @see setAimLocation() @see setAimObject()) +/// @brief Check whether an object is within a specified veiw cone. +/// @obj Object to check. (If blank, it will check the current target). +/// @fov view angle in degrees.(Defaults to 45) +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// +public bool checkInFoV(string aiplayer, string obj = null , float fov = 45.0f, bool checkEnabled = false){ +if (obj== null) {obj = null;} + + +return m_ts.fnAIPlayer_checkInFoV(aiplayer, obj, fov, checkEnabled); +} +/// +/// @brief Check whether an object is in line of sight. +/// @obj Object to check. (If blank, it will check the current target). +/// @useMuzzle Use muzzle position. Otherwise use eye position. (defaults to false). +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// +public bool checkInLos(string aiplayer, string obj = null , bool useMuzzle = false, bool checkEnabled = false){ +if (obj== null) {obj = null;} + + +return m_ts.fnAIPlayer_checkInLos(aiplayer, obj, useMuzzle, checkEnabled); +} +/// +/// @brief Use this to stop aiming at an object or a point. +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public void clearAim(string aiplayer){ @@ -6679,7 +9843,18 @@ public void followObject(string aiplayer, uint obj, float radius){ m_ts.fnAIPlayer_followObject(aiplayer, obj, radius); } /// -/// @brief Returns the point the AIPlayer is aiming at. This will reflect the position set by setAimLocation(), or the position of the object that the bot is now aiming at. If the bot is not aiming at anything, this value will change to whatever point the bot's current line-of-sight intercepts. @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". @see setAimLocation() @see setAimObject()) +/// @brief Returns the point the AIPlayer is aiming at. +/// +/// This will reflect the position set by setAimLocation(), +/// or the position of the object that the bot is now aiming at. +/// If the bot is not aiming at anything, this value will +/// change to whatever point the bot's current line-of-sight intercepts. +/// +/// @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public Point3F getAimLocation(string aiplayer){ @@ -6687,7 +9862,13 @@ public Point3F getAimLocation(string aiplayer){ return new Point3F ( m_ts.fnAIPlayer_getAimLocation(aiplayer)); } /// -/// @brief Gets the object the AIPlayer is targeting. @return Returns -1 if no object is being aimed at, or the SimObjectID of the object the AIPlayer is aiming at. @see setAimObject()) +/// @brief Gets the object the AIPlayer is targeting. +/// +/// @return Returns -1 if no object is being aimed at, +/// or the SimObjectID of the object the AIPlayer is aiming at. +/// +/// @see setAimObject()) +/// /// public int getAimObject(string aiplayer){ @@ -6695,7 +9876,14 @@ public int getAimObject(string aiplayer){ return m_ts.fnAIPlayer_getAimObject(aiplayer); } /// -/// @brief Get the AIPlayer's current destination. @return Returns a point containing the \"x y z\" position of the AIPlayer's current move destination. If no move destination has yet been set, this returns \"0 0 0\". @see setMoveDestination()) +/// @brief Get the AIPlayer's current destination. +/// +/// @return Returns a point containing the \"x y z\" position +/// of the AIPlayer's current move destination. If no move destination +/// has yet been set, this returns \"0 0 0\". +/// +/// @see setMoveDestination()) +/// /// public Point3F getMoveDestination(string aiplayer){ @@ -6703,7 +9891,12 @@ public Point3F getMoveDestination(string aiplayer){ return new Point3F ( m_ts.fnAIPlayer_getMoveDestination(aiplayer)); } /// -/// @brief Gets the move speed of an AI object. @return A speed multiplier between 0.0 and 1.0. @see setMoveSpeed()) +/// @brief Gets the move speed of an AI object. +/// +/// @return A speed multiplier between 0.0 and 1.0. +/// +/// @see setMoveSpeed()) +/// /// public float getMoveSpeed(string aiplayer){ @@ -6754,7 +9947,12 @@ public void repath(string aiplayer){ m_ts.fnAIPlayer_repath(aiplayer); } /// -/// @brief Tells the AIPlayer to aim at the location provided. @param target An \"x y z\" position in the game world to target. @see getAimLocation()) +/// @brief Tells the AIPlayer to aim at the location provided. +/// +/// @param target An \"x y z\" position in the game world to target. +/// +/// @see getAimLocation()) +/// /// public void setAimLocation(string aiplayer, Point3F target){ @@ -6762,7 +9960,18 @@ public void setAimLocation(string aiplayer, Point3F target){ m_ts.fnAIPlayer_setAimLocation(aiplayer, target.AsString()); } /// -/// @brief Tells the AI to move to the location provided @param goal Coordinates in world space representing location to move to. @param slowDown A boolean value. If set to true, the bot will slow down when it gets within 5-meters of its move destination. If false, the bot will stop abruptly when it reaches the move destination. By default, this is true. @note Upon reaching a move destination, the bot will clear its move destination and calls to getMoveDestination will return \"0 0 0\". @see getMoveDestination()) +/// @brief Tells the AI to move to the location provided +/// +/// @param goal Coordinates in world space representing location to move to. +/// @param slowDown A boolean value. If set to true, the bot will slow down +/// when it gets within 5-meters of its move destination. If false, the bot +/// will stop abruptly when it reaches the move destination. By default, this is true. +/// +/// @note Upon reaching a move destination, the bot will clear its move destination and +/// calls to getMoveDestination will return \"0 0 0\". +/// +/// @see getMoveDestination()) +/// /// public void setMoveDestination(string aiplayer, Point3F goal, bool slowDown = true){ @@ -6770,7 +9979,14 @@ public void setMoveDestination(string aiplayer, Point3F goal, bool slowDown = t m_ts.fnAIPlayer_setMoveDestination(aiplayer, goal.AsString(), slowDown); } /// -/// @brief Sets the move speed for an AI object. @param speed A speed multiplier between 0.0 and 1.0. This is multiplied by the AIPlayer's base movement rates (as defined in its PlayerData datablock) @see getMoveDestination()) +/// @brief Sets the move speed for an AI object. +/// +/// @param speed A speed multiplier between 0.0 and 1.0. +/// This is multiplied by the AIPlayer's base movement rates (as defined in +/// its PlayerData datablock) +/// +/// @see getMoveDestination()) +/// /// public void setMoveSpeed(string aiplayer, float speed){ @@ -6803,6 +10019,7 @@ public bool setPathDestination(string aiplayer, Point3F goal){ } /// /// @brief Tells the AIPlayer to stop moving.) +/// /// public void stop(string aiplayer){ @@ -6815,14 +10032,9 @@ public void stop(string aiplayer){ /// public class AITurretShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public AITurretShapeObject(ref Omni ts){m_ts = ts;} /// /// @brief Activate a turret from a deactive state.) +/// /// public void activateTurret(string aiturretshape){ @@ -6830,7 +10042,10 @@ public void activateTurret(string aiturretshape){ m_ts.fnAITurretShape_activateTurret(aiturretshape); } /// -/// @brief Adds object to the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to ignore.) +/// @brief Adds object to the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to ignore.) +/// /// public void addToIgnoreList(string aiturretshape, string obj){ @@ -6839,6 +10054,7 @@ public void addToIgnoreList(string aiturretshape, string obj){ } /// /// @brief Deactivate a turret from an active state.) +/// /// public void deactivateTurret(string aiturretshape){ @@ -6846,7 +10062,9 @@ public void deactivateTurret(string aiturretshape){ m_ts.fnAITurretShape_deactivateTurret(aiturretshape); } /// -/// @brief Get the turret's current target. @returns The object that is the target's current target, or 0 if no target.) +/// @brief Get the turret's current target. +/// @returns The object that is the target's current target, or 0 if no target.) +/// /// public string getTarget(string aiturretshape){ @@ -6854,7 +10072,9 @@ public string getTarget(string aiturretshape){ return m_ts.fnAITurretShape_getTarget(aiturretshape); } /// -/// @brief Get the turret's defined projectile velocity that helps with target leading. @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// @brief Get the turret's defined projectile velocity that helps with target leading. +/// @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// /// public float getWeaponLeadVelocity(string aiturretshape){ @@ -6862,7 +10082,9 @@ public float getWeaponLeadVelocity(string aiturretshape){ return m_ts.fnAITurretShape_getWeaponLeadVelocity(aiturretshape); } /// -/// @brief Indicates if the turret has a target. @returns True if the turret has a target.) +/// @brief Indicates if the turret has a target. +/// @returns True if the turret has a target.) +/// /// public bool hasTarget(string aiturretshape){ @@ -6871,6 +10093,7 @@ public bool hasTarget(string aiturretshape){ } /// /// @brief Recenter the turret's weapon.) +/// /// public void recenterTurret(string aiturretshape){ @@ -6878,7 +10101,10 @@ public void recenterTurret(string aiturretshape){ m_ts.fnAITurretShape_recenterTurret(aiturretshape); } /// -/// @brief Removes object from the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to once again allow for targeting.) +/// @brief Removes object from the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to once again allow for targeting.) +/// /// public void removeFromIgnoreList(string aiturretshape, string obj){ @@ -6886,7 +10112,9 @@ public void removeFromIgnoreList(string aiturretshape, string obj){ m_ts.fnAITurretShape_removeFromIgnoreList(aiturretshape, obj); } /// -/// @brief Resets the turret's target tracking. Only resets the internal target tracking. Does not modify the turret's facing.) +/// @brief Resets the turret's target tracking. +/// Only resets the internal target tracking. Does not modify the turret's facing.) +/// /// public void resetTarget(string aiturretshape){ @@ -6894,7 +10122,9 @@ public void resetTarget(string aiturretshape){ m_ts.fnAITurretShape_resetTarget(aiturretshape); } /// -/// @brief Set the firing state of the turret's guns. @param fire Set to true to activate all guns. False to deactivate them.) +/// @brief Set the firing state of the turret's guns. +/// @param fire Set to true to activate all guns. False to deactivate them.) +/// /// public void setAllGunsFiring(string aiturretshape, bool fire){ @@ -6902,7 +10132,10 @@ public void setAllGunsFiring(string aiturretshape, bool fire){ m_ts.fnAITurretShape_setAllGunsFiring(aiturretshape, fire); } /// -/// @brief Set the firing state of the given gun slot. @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. @param fire Set to true to activate the gun. False to deactivate it.) +/// @brief Set the firing state of the given gun slot. +/// @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. +/// @param fire Set to true to activate the gun. False to deactivate it.) +/// /// public void setGunSlotFiring(string aiturretshape, int slot, bool fire){ @@ -6910,7 +10143,14 @@ public void setGunSlotFiring(string aiturretshape, int slot, bool fire){ m_ts.fnAITurretShape_setGunSlotFiring(aiturretshape, slot, fire); } /// -/// @brief Set the turret's current state. Normally the turret's state comes from updating the state machine but this method allows you to override this and jump to the requested state immediately. @param newState The name of the new state. @param force Is true then force the full processing of the new state even if it is the same as the current state. If false then only the time out value is reset and the state's script method is called, if any.) +/// @brief Set the turret's current state. +/// Normally the turret's state comes from updating the state machine but this method +/// allows you to override this and jump to the requested state immediately. +/// @param newState The name of the new state. +/// @param force Is true then force the full processing of the new state even if it is the +/// same as the current state. If false then only the time out value is reset and the state's +/// script method is called, if any.) +/// /// public void setTurretState(string aiturretshape, string newState, bool force = false){ @@ -6918,7 +10158,12 @@ public void setTurretState(string aiturretshape, string newState, bool force = m_ts.fnAITurretShape_setTurretState(aiturretshape, newState, force); } /// -/// @brief Set the turret's projectile velocity to help lead the target. This value normally comes from AITurretShapeData::weaponLeadVelocity but this method allows you to override the datablock value. This can be useful if the turret changes ammunition, uses a different weapon than the default, is damaged, etc. @note Setting this to 0 will disable target leading.) +/// @brief Set the turret's projectile velocity to help lead the target. +/// This value normally comes from AITurretShapeData::weaponLeadVelocity but this method +/// allows you to override the datablock value. This can be useful if the turret changes +/// ammunition, uses a different weapon than the default, is damaged, etc. +/// @note Setting this to 0 will disable target leading.) +/// /// public void setWeaponLeadVelocity(string aiturretshape, float velocity){ @@ -6927,6 +10172,7 @@ public void setWeaponLeadVelocity(string aiturretshape, float velocity){ } /// /// @brief Begin scanning for a target.) +/// /// public void startScanForTargets(string aiturretshape){ @@ -6935,6 +10181,7 @@ public void startScanForTargets(string aiturretshape){ } /// /// @brief Have the turret track the current target.) +/// /// public void startTrackingTarget(string aiturretshape){ @@ -6942,7 +10189,10 @@ public void startTrackingTarget(string aiturretshape){ m_ts.fnAITurretShape_startTrackingTarget(aiturretshape); } /// -/// @brief Stop scanning for targets. @note Only impacts the scanning for new targets. Does not effect a turret's current target lock.) +/// @brief Stop scanning for targets. +/// @note Only impacts the scanning for new targets. Does not effect a turret's current +/// target lock.) +/// /// public void stopScanForTargets(string aiturretshape){ @@ -6951,6 +10201,7 @@ public void stopScanForTargets(string aiturretshape){ } /// /// @brief Stop the turret from tracking the current target.) +/// /// public void stopTrackingTarget(string aiturretshape){ @@ -6963,14 +10214,12 @@ public void stopTrackingTarget(string aiturretshape){ /// public class ArrayObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public ArrayObjectObject(ref Omni ts){m_ts = ts;} /// -/// ), Adds a new element to the end of an array (same as push_back()). @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array (same as push_back()). +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void add(string arrayobject, string key, string value = ""){ @@ -6978,7 +10227,9 @@ public void add(string arrayobject, string key, string value = ""){ m_ts.fnArrayObject_add(arrayobject, key, value); } /// -/// Appends the target array to the array object. @param target ArrayObject to append to the end of this array ) +/// Appends the target array to the array object. +/// @param target ArrayObject to append to the end of this array ) +/// /// public bool append(string arrayobject, string target){ @@ -6987,6 +10238,7 @@ public bool append(string arrayobject, string target){ } /// /// Get the number of elements in the array. ) +/// /// public int count(string arrayobject){ @@ -6994,7 +10246,9 @@ public int count(string arrayobject){ return m_ts.fnArrayObject_count(arrayobject); } /// -/// Get the number of times a particular key is found in the array. @param key Key value to count ) +/// Get the number of times a particular key is found in the array. +/// @param key Key value to count ) +/// /// public int countKey(string arrayobject, string key){ @@ -7002,7 +10256,9 @@ public int countKey(string arrayobject, string key){ return m_ts.fnArrayObject_countKey(arrayobject, key); } /// -/// Get the number of times a particular value is found in the array. @param value Array element value to count ) +/// Get the number of times a particular value is found in the array. +/// @param value Array element value to count ) +/// /// public int countValue(string arrayobject, string value){ @@ -7010,7 +10266,9 @@ public int countValue(string arrayobject, string value){ return m_ts.fnArrayObject_countValue(arrayobject, value); } /// -/// Removes elements with matching keys from array. @param target ArrayObject containing keys to remove from this array ) +/// Removes elements with matching keys from array. +/// @param target ArrayObject containing keys to remove from this array ) +/// /// public bool crop(string arrayobject, string target){ @@ -7018,7 +10276,9 @@ public bool crop(string arrayobject, string target){ return m_ts.fnArrayObject_crop(arrayobject, target); } /// -/// Alters array into an exact duplicate of the target array. @param target ArrayObject to duplicate ) +/// Alters array into an exact duplicate of the target array. +/// @param target ArrayObject to duplicate ) +/// /// public bool duplicate(string arrayobject, string target){ @@ -7027,6 +10287,7 @@ public bool duplicate(string arrayobject, string target){ } /// /// Echos the array contents to the console ) +/// /// public void echo(string arrayobject){ @@ -7035,6 +10296,7 @@ public void echo(string arrayobject){ } /// /// Emptys all elements from an array ) +/// /// public void empty(string arrayobject){ @@ -7042,7 +10304,9 @@ public void empty(string arrayobject){ m_ts.fnArrayObject_empty(arrayobject); } /// -/// Removes an element at a specific position from the array. @param index 0-based index of the element to remove ) +/// Removes an element at a specific position from the array. +/// @param index 0-based index of the element to remove ) +/// /// public void erase(string arrayobject, int index){ @@ -7051,6 +10315,7 @@ public void erase(string arrayobject, int index){ } /// /// Gets the current pointer index ) +/// /// public int getCurrent(string arrayobject){ @@ -7058,7 +10323,10 @@ public int getCurrent(string arrayobject){ return m_ts.fnArrayObject_getCurrent(arrayobject); } /// -/// Search the array from the current position for the key @param value Array key to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the key +/// @param value Array key to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int getIndexFromKey(string arrayobject, string key){ @@ -7066,7 +10334,10 @@ public int getIndexFromKey(string arrayobject, string key){ return m_ts.fnArrayObject_getIndexFromKey(arrayobject, key); } /// -/// Search the array from the current position for the element @param value Array value to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the element +/// @param value Array value to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int getIndexFromValue(string arrayobject, string value){ @@ -7074,7 +10345,11 @@ public int getIndexFromValue(string arrayobject, string value){ return m_ts.fnArrayObject_getIndexFromValue(arrayobject, value); } /// -/// Get the key of the array element at the submitted index. @param index 0-based index of the array element to get @return The key associated with the array element at the specified index, or \"\" if the index is out of range ) +/// Get the key of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The key associated with the array element at the +/// specified index, or \"\" if the index is out of range ) +/// /// public string getKey(string arrayobject, int index){ @@ -7082,7 +10357,11 @@ public string getKey(string arrayobject, int index){ return m_ts.fnArrayObject_getKey(arrayobject, index); } /// -/// Get the value of the array element at the submitted index. @param index 0-based index of the array element to get @return The value of the array element at the specified index, or \"\" if the index is out of range ) +/// Get the value of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The value of the array element at the specified index, +/// or \"\" if the index is out of range ) +/// /// public string getValue(string arrayobject, int index){ @@ -7090,7 +10369,13 @@ public string getValue(string arrayobject, int index){ return m_ts.fnArrayObject_getValue(arrayobject, index); } /// -/// Adds a new element to a specified position in the array. - @a index = 0 will insert an element at the start of the array (same as push_front()) - @a index = %array.count() will insert an element at the end of the array (same as push_back()) @param key Key for the new element @param value Value for the new element @param index 0-based index at which to insert the new element ) +/// Adds a new element to a specified position in the array. +/// - @a index = 0 will insert an element at the start of the array (same as push_front()) +/// - @a index = %array.count() will insert an element at the end of the array (same as push_back()) +/// @param key Key for the new element +/// @param value Value for the new element +/// @param index 0-based index at which to insert the new element ) +/// /// public void insert(string arrayobject, string key, string value, int index){ @@ -7098,7 +10383,9 @@ public void insert(string arrayobject, string key, string value, int index){ m_ts.fnArrayObject_insert(arrayobject, key, value, index); } /// -/// Moves array pointer to start of array @return Returns the new array pointer ) +/// Moves array pointer to start of array +/// @return Returns the new array pointer ) +/// /// public int moveFirst(string arrayobject){ @@ -7106,7 +10393,9 @@ public int moveFirst(string arrayobject){ return m_ts.fnArrayObject_moveFirst(arrayobject); } /// -/// Moves array pointer to end of array @return Returns the new array pointer ) +/// Moves array pointer to end of array +/// @return Returns the new array pointer ) +/// /// public int moveLast(string arrayobject){ @@ -7114,7 +10403,9 @@ public int moveLast(string arrayobject){ return m_ts.fnArrayObject_moveLast(arrayobject); } /// -/// Moves array pointer to next position @return Returns the new array pointer, or -1 if already at the end ) +/// Moves array pointer to next position +/// @return Returns the new array pointer, or -1 if already at the end ) +/// /// public int moveNext(string arrayobject){ @@ -7122,7 +10413,9 @@ public int moveNext(string arrayobject){ return m_ts.fnArrayObject_moveNext(arrayobject); } /// -/// Moves array pointer to prev position @return Returns the new array pointer, or -1 if already at the start ) +/// Moves array pointer to prev position +/// @return Returns the new array pointer, or -1 if already at the start ) +/// /// public int movePrev(string arrayobject){ @@ -7131,6 +10424,7 @@ public int movePrev(string arrayobject){ } /// /// Removes the last element from the array ) +/// /// public void pop_back(string arrayobject){ @@ -7139,6 +10433,7 @@ public void pop_back(string arrayobject){ } /// /// Removes the first element from the array ) +/// /// public void pop_front(string arrayobject){ @@ -7146,7 +10441,11 @@ public void pop_front(string arrayobject){ m_ts.fnArrayObject_pop_front(arrayobject); } /// -/// ), Adds a new element to the end of an array. @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array. +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void push_back(string arrayobject, string key, string value = ""){ @@ -7154,7 +10453,9 @@ public void push_back(string arrayobject, string key, string value = ""){ m_ts.fnArrayObject_push_back(arrayobject, key, value); } /// -/// ), Adds a new element to the front of an array ) +/// ), +/// Adds a new element to the front of an array ) +/// /// public void push_front(string arrayobject, string key, string value = ""){ @@ -7162,7 +10463,9 @@ public void push_front(string arrayobject, string key, string value = ""){ m_ts.fnArrayObject_push_front(arrayobject, key, value); } /// -/// Sets the current pointer index. @param index New 0-based pointer index ) +/// Sets the current pointer index. +/// @param index New 0-based pointer index ) +/// /// public void setCurrent(string arrayobject, int index){ @@ -7170,7 +10473,10 @@ public void setCurrent(string arrayobject, int index){ m_ts.fnArrayObject_setCurrent(arrayobject, index); } /// -/// Set the key at the given index. @param key New key value @param index 0-based index of the array element to update ) +/// Set the key at the given index. +/// @param key New key value +/// @param index 0-based index of the array element to update ) +/// /// public void setKey(string arrayobject, string key, int index){ @@ -7178,7 +10484,10 @@ public void setKey(string arrayobject, string key, int index){ m_ts.fnArrayObject_setKey(arrayobject, key, index); } /// -/// Set the value at the given index. @param value New array element value @param index 0-based index of the array element to update ) +/// Set the value at the given index. +/// @param value New array element value +/// @param index 0-based index of the array element to update ) +/// /// public void setValue(string arrayobject, string value, int index){ @@ -7186,7 +10495,9 @@ public void setValue(string arrayobject, string value, int index){ m_ts.fnArrayObject_setValue(arrayobject, value, index); } /// -/// Alpha sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void sort(string arrayobject, bool ascending = false){ @@ -7195,6 +10506,7 @@ public void sort(string arrayobject, bool ascending = false){ } /// /// Alpha sorts the array by value in ascending order ) +/// /// public void sorta(string arrayobject){ @@ -7203,6 +10515,7 @@ public void sorta(string arrayobject){ } /// /// Alpha sorts the array by value in descending order ) +/// /// public void sortd(string arrayobject){ @@ -7210,7 +10523,16 @@ public void sortd(string arrayobject){ m_ts.fnArrayObject_sortd(arrayobject); } /// -/// Sorts the array by value in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @tsexample function mySortCallback(%a, %b) { return strcmp( %a.name, %b.name ); } %array.sortf( \"mySortCallback\" ); @endtsexample ) +/// Sorts the array by value in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @tsexample +/// function mySortCallback(%a, %b) +/// { +/// return strcmp( %a.name, %b.name ); +/// } +/// %array.sortf( \"mySortCallback\" ); +/// @endtsexample ) +/// /// public void sortf(string arrayobject, string functionName){ @@ -7218,7 +10540,10 @@ public void sortf(string arrayobject, string functionName){ m_ts.fnArrayObject_sortf(arrayobject, functionName); } /// -/// Sorts the array by value in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by value in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void sortfd(string arrayobject, string functionName){ @@ -7226,7 +10551,10 @@ public void sortfd(string arrayobject, string functionName){ m_ts.fnArrayObject_sortfd(arrayobject, functionName); } /// -/// Sorts the array by key in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void sortfk(string arrayobject, string functionName){ @@ -7234,7 +10562,10 @@ public void sortfk(string arrayobject, string functionName){ m_ts.fnArrayObject_sortfk(arrayobject, functionName); } /// -/// Sorts the array by key in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void sortfkd(string arrayobject, string functionName){ @@ -7242,7 +10573,9 @@ public void sortfkd(string arrayobject, string functionName){ m_ts.fnArrayObject_sortfkd(arrayobject, functionName); } /// -/// Alpha sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void sortk(string arrayobject, bool ascending = false){ @@ -7251,6 +10584,7 @@ public void sortk(string arrayobject, bool ascending = false){ } /// /// Alpha sorts the array by key in ascending order ) +/// /// public void sortka(string arrayobject){ @@ -7259,6 +10593,7 @@ public void sortka(string arrayobject){ } /// /// Alpha sorts the array by key in descending order ) +/// /// public void sortkd(string arrayobject){ @@ -7266,7 +10601,9 @@ public void sortkd(string arrayobject){ m_ts.fnArrayObject_sortkd(arrayobject); } /// -/// Numerically sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void sortn(string arrayobject, bool ascending = false){ @@ -7275,6 +10612,7 @@ public void sortn(string arrayobject, bool ascending = false){ } /// /// Numerically sorts the array by value in ascending order ) +/// /// public void sortna(string arrayobject){ @@ -7283,6 +10621,7 @@ public void sortna(string arrayobject){ } /// /// Numerically sorts the array by value in descending order ) +/// /// public void sortnd(string arrayobject){ @@ -7290,7 +10629,9 @@ public void sortnd(string arrayobject){ m_ts.fnArrayObject_sortnd(arrayobject); } /// -/// Numerically sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void sortnk(string arrayobject, bool ascending = false){ @@ -7299,6 +10640,7 @@ public void sortnk(string arrayobject, bool ascending = false){ } /// /// Numerical sorts the array by key in ascending order ) +/// /// public void sortnka(string arrayobject){ @@ -7307,6 +10649,7 @@ public void sortnka(string arrayobject){ } /// /// Numerical sorts the array by key in descending order ) +/// /// public void sortnkd(string arrayobject){ @@ -7315,6 +10658,7 @@ public void sortnkd(string arrayobject){ } /// /// Removes any elements that have duplicated keys (leaving the first instance) ) +/// /// public void uniqueKey(string arrayobject){ @@ -7323,6 +10667,7 @@ public void uniqueKey(string arrayobject){ } /// /// Removes any elements that have duplicated values (leaving the first instance) ) +/// /// public void uniqueValue(string arrayobject){ @@ -7335,14 +10680,11 @@ public void uniqueValue(string arrayobject){ /// public class CameraObject { -private Omni m_ts; - /// - /// - /// - /// -public CameraObject(ref Omni ts){m_ts = ts;} /// -/// Move the camera to fully view the given radius. @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). @param radius The radius to view.) +/// Move the camera to fully view the given radius. +/// @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). +/// @param radius The radius to view.) +/// /// public void autoFitRadius(string camera, float radius){ @@ -7350,7 +10692,10 @@ public void autoFitRadius(string camera, float radius){ m_ts.fnCamera_autoFitRadius(camera, radius); } /// -/// Get the angular velocity for a Newton mode camera. @returns The angular velocity in the form of \"x y z\". @note Only returns useful results when Camera::newtonRotation is set to true.) +/// Get the angular velocity for a Newton mode camera. +/// @returns The angular velocity in the form of \"x y z\". +/// @note Only returns useful results when Camera::newtonRotation is set to true.) +/// /// public Point3F getAngularVelocity(string camera){ @@ -7358,7 +10703,9 @@ public Point3F getAngularVelocity(string camera){ return new Point3F ( m_ts.fnCamera_getAngularVelocity(camera)); } /// -/// Returns the current camera control mode. @see CameraMotionMode) +/// Returns the current camera control mode. +/// @see CameraMotionMode) +/// /// public TypeCameraMotionMode getMode(string camera){ @@ -7366,7 +10713,10 @@ public TypeCameraMotionMode getMode(string camera){ return (TypeCameraMotionMode)( m_ts.fnCamera_getMode(camera)); } /// -/// Get the camera's offset from its orbit or tracking point. The offset is added to the camera's position when set to CameraMode::OrbitObject. @returns The offset in the form of \"x y z\".) +/// Get the camera's offset from its orbit or tracking point. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @returns The offset in the form of \"x y z\".) +/// /// public Point3F getOffset(string camera){ @@ -7374,7 +10724,9 @@ public Point3F getOffset(string camera){ return new Point3F ( m_ts.fnCamera_getOffset(camera)); } /// -/// Get the camera's position in the world. @returns The position in the form of \"x y z\".) +/// Get the camera's position in the world. +/// @returns The position in the form of \"x y z\".) +/// /// public Point3F getPosition(string camera){ @@ -7382,7 +10734,9 @@ public Point3F getPosition(string camera){ return new Point3F ( m_ts.fnCamera_getPosition(camera)); } /// -/// Get the camera's Euler rotation in radians. @returns The rotation in radians in the form of \"x y z\".) +/// Get the camera's Euler rotation in radians. +/// @returns The rotation in radians in the form of \"x y z\".) +/// /// public Point3F getRotation(string camera){ @@ -7390,7 +10744,10 @@ public Point3F getRotation(string camera){ return new Point3F ( m_ts.fnCamera_getRotation(camera)); } /// -/// Get the velocity for the camera. @returns The camera's velocity in the form of \"x y z\". @note Only useful when the Camera is in Newton mode.) +/// Get the velocity for the camera. +/// @returns The camera's velocity in the form of \"x y z\". +/// @note Only useful when the Camera is in Newton mode.) +/// /// public Point3F getVelocity(string camera){ @@ -7398,7 +10755,9 @@ public Point3F getVelocity(string camera){ return new Point3F ( m_ts.fnCamera_getVelocity(camera)); } /// -/// Is the camera in edit orbit mode? @returns true if the camera is in edit orbit mode.) +/// Is the camera in edit orbit mode? +/// @returns true if the camera is in edit orbit mode.) +/// /// public bool isEditOrbitMode(string camera){ @@ -7406,7 +10765,9 @@ public bool isEditOrbitMode(string camera){ return m_ts.fnCamera_isEditOrbitMode(camera); } /// -/// Is this a Newton Fly mode camera with damped rotation? @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// Is this a Newton Fly mode camera with damped rotation? +/// @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// /// public bool isRotationDamped(string camera){ @@ -7414,7 +10775,9 @@ public bool isRotationDamped(string camera){ return m_ts.fnCamera_isRotationDamped(camera); } /// -/// Point the camera at the specified position. Does not work in Orbit or Track modes. @param point The position to point the camera at.) +/// Point the camera at the specified position. Does not work in Orbit or Track modes. +/// @param point The position to point the camera at.) +/// /// public void lookAt(string camera, Point3F point){ @@ -7422,7 +10785,10 @@ public void lookAt(string camera, Point3F point){ m_ts.fnCamera_lookAt(camera, point.AsString()); } /// -/// Set the angular drag for a Newton mode camera. @param drag The angular drag applied while the camera is rotating. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular drag for a Newton mode camera. +/// @param drag The angular drag applied while the camera is rotating. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void setAngularDrag(string camera, float drag){ @@ -7430,7 +10796,10 @@ public void setAngularDrag(string camera, float drag){ m_ts.fnCamera_setAngularDrag(camera, drag); } /// -/// Set the angular force for a Newton mode camera. @param force The angular force applied when attempting to rotate the camera. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular force for a Newton mode camera. +/// @param force The angular force applied when attempting to rotate the camera. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void setAngularForce(string camera, float force){ @@ -7438,7 +10807,10 @@ public void setAngularForce(string camera, float force){ m_ts.fnCamera_setAngularForce(camera, force); } /// -/// Set the angular velocity for a Newton mode camera. @param velocity The angular velocity infor form of \"x y z\". @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular velocity for a Newton mode camera. +/// @param velocity The angular velocity infor form of \"x y z\". +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void setAngularVelocity(string camera, Point3F velocity){ @@ -7446,7 +10818,10 @@ public void setAngularVelocity(string camera, Point3F velocity){ m_ts.fnCamera_setAngularVelocity(camera, velocity.AsString()); } /// -/// Set the Newton mode camera brake multiplier when trigger[1] is active. @param multiplier The brake multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera brake multiplier when trigger[1] is active. +/// @param multiplier The brake multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setBrakeMultiplier(string camera, float multiplier){ @@ -7454,7 +10829,10 @@ public void setBrakeMultiplier(string camera, float multiplier){ m_ts.fnCamera_setBrakeMultiplier(camera, multiplier); } /// -/// Set the drag for a Newton mode camera. @param drag The drag applied to the camera while moving. @note Only used when Camera is in Newton mode.) +/// Set the drag for a Newton mode camera. +/// @param drag The drag applied to the camera while moving. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setDrag(string camera, float drag){ @@ -7462,7 +10840,10 @@ public void setDrag(string camera, float drag){ m_ts.fnCamera_setDrag(camera, drag); } /// -/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). @note This method is generally used only within the World Editor and other tools. To orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). +/// @note This method is generally used only within the World Editor and other tools. To +/// orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// /// public void setEditOrbitMode(string camera){ @@ -7470,7 +10851,9 @@ public void setEditOrbitMode(string camera){ m_ts.fnCamera_setEditOrbitMode(camera); } /// -/// Set the editor camera's orbit point. @param point The point the camera will orbit in the form of \"x y z\".) +/// Set the editor camera's orbit point. +/// @param point The point the camera will orbit in the form of \"x y z\".) +/// /// public void setEditOrbitPoint(string camera, Point3F point){ @@ -7478,7 +10861,10 @@ public void setEditOrbitPoint(string camera, Point3F point){ m_ts.fnCamera_setEditOrbitPoint(camera, point.AsString()); } /// -/// Set the force applied to a Newton mode camera while moving. @param force The force applied to the camera while attempting to move. @note Only used when Camera is in Newton mode.) +/// Set the force applied to a Newton mode camera while moving. +/// @param force The force applied to the camera while attempting to move. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setFlyForce(string camera, float force){ @@ -7486,7 +10872,11 @@ public void setFlyForce(string camera, float force){ m_ts.fnCamera_setFlyForce(camera, force); } /// -/// Set the camera to fly freely. Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode and Camera::newtonRotation.) +/// Set the camera to fly freely. +/// Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion +/// and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode +/// and Camera::newtonRotation.) +/// /// public void setFlyMode(string camera){ @@ -7494,7 +10884,10 @@ public void setFlyMode(string camera){ m_ts.fnCamera_setFlyMode(camera); } /// -/// Set the mass for a Newton mode camera. @param mass The mass used during ease-in and ease-out calculations. @note Only used when Camera is in Newton mode.) +/// Set the mass for a Newton mode camera. +/// @param mass The mass used during ease-in and ease-out calculations. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setMass(string camera, float mass){ @@ -7502,7 +10895,11 @@ public void setMass(string camera, float mass){ m_ts.fnCamera_setMass(camera, mass); } /// -/// Set the camera to fly freely, but with ease-in and ease-out. This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but activates the ease-in and ease-out on the camera's movement. To also activate Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// Set the camera to fly freely, but with ease-in and ease-out. +/// This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but +/// activates the ease-in and ease-out on the camera's movement. To also activate +/// Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// /// public void setNewtonFlyMode(string camera){ @@ -7510,7 +10907,10 @@ public void setNewtonFlyMode(string camera){ m_ts.fnCamera_setNewtonFlyMode(camera); } /// -/// Set the camera's offset. The offset is added to the camera's position when set to CameraMode::OrbitObject. @param offset The distance to offset the camera by in the form of \"x y z\".) +/// Set the camera's offset. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @param offset The distance to offset the camera by in the form of \"x y z\".) +/// /// public void setOffset(string camera, Point3F offset){ @@ -7518,16 +10918,38 @@ public void setOffset(string camera, Point3F offset){ m_ts.fnCamera_setOffset(camera, offset.AsString()); } /// -/// Set the camera to orbit around the given object, or if none is given, around the given point. @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitObject() @see Camera::setOrbitPoint()) +/// Set the camera to orbit around the given object, or if none is given, around the given point. +/// @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead +/// @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitObject() +/// @see Camera::setOrbitPoint()) +/// /// -public bool setOrbitMode(string camera, string orbitObject, TransformF orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj = false, Point3F offset = null , bool lockedx = false){ +public void setOrbitMode(string camera, string orbitObject, TransformF orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj = false, Point3F offset = null , bool lockedx = false){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} -return m_ts.fnCamera_setOrbitMode(camera, orbitObject, orbitPoint.AsString(), minDistance, maxDistance, initDistance, ownClientObj, offset.AsString(), lockedx); +m_ts.fnCamera_setOrbitMode(camera, orbitObject, orbitPoint.AsString(), minDistance, maxDistance, initDistance, ownClientObj, offset.AsString(), lockedx); } /// -/// Set the camera to orbit around a given object. @param orbitObject The object to orbit around. @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @returns false if the given object could not be found. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given object. +/// @param orbitObject The object to orbit around. +/// @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @returns false if the given object could not be found. +/// @see Camera::setOrbitMode()) +/// /// public bool setOrbitObject(string camera, string orbitObject, Point3F rotation, float minDistance, float maxDistance, float initDistance, bool ownClientObject = false, Point3F offset = null , bool lockedx = false){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} @@ -7536,7 +10958,15 @@ public bool setOrbitObject(string camera, string orbitObject, Point3F rotation, return m_ts.fnCamera_setOrbitObject(camera, orbitObject, rotation.AsString(), minDistance, maxDistance, initDistance, ownClientObject, offset.AsString(), lockedx); } /// -/// Set the camera to orbit around a given point. @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given point. +/// @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitMode()) +/// /// public void setOrbitPoint(string camera, TransformF orbitPoint, float minDistance, float maxDistance, float initDistance, Point3F offset = null , bool lockedx = false){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} @@ -7545,7 +10975,10 @@ public void setOrbitPoint(string camera, TransformF orbitPoint, float minDistan m_ts.fnCamera_setOrbitPoint(camera, orbitPoint.AsString(), minDistance, maxDistance, initDistance, offset.AsString(), lockedx); } /// -/// Set the camera's Euler rotation in radians. @param rot The rotation in radians in the form of \"x y z\". @note Rotation around the Y axis is ignored ) +/// Set the camera's Euler rotation in radians. +/// @param rot The rotation in radians in the form of \"x y z\". +/// @note Rotation around the Y axis is ignored ) +/// /// public void setRotation(string camera, Point3F rot){ @@ -7553,7 +10986,10 @@ public void setRotation(string camera, Point3F rot){ m_ts.fnCamera_setRotation(camera, rot.AsString()); } /// -/// Set the Newton mode camera speed multiplier when trigger[0] is active. @param multiplier The speed multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera speed multiplier when trigger[0] is active. +/// @param multiplier The speed multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void setSpeedMultiplier(string camera, float multiplier){ @@ -7561,7 +10997,11 @@ public void setSpeedMultiplier(string camera, float multiplier){ m_ts.fnCamera_setSpeedMultiplier(camera, multiplier); } /// -/// Set the camera to track a given object. @param trackObject The object to track. @param offset [optional] An offset added to the camera's position. Default is no offset. @returns false if the given object could not be found.) +/// Set the camera to track a given object. +/// @param trackObject The object to track. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @returns false if the given object could not be found.) +/// /// public bool setTrackObject(string camera, string trackObject, Point3F offset = null ){ if (offset== null) {offset = new Point3F(0.0f, 0.0f, 0.0f);} @@ -7570,7 +11010,12 @@ public bool setTrackObject(string camera, string trackObject, Point3F offset = return m_ts.fnCamera_setTrackObject(camera, trackObject, offset.AsString()); } /// -/// Set if there is a valid editor camera orbit point. When validPoint is set to false the Camera operates as if it is in Fly mode rather than an Orbit mode. @param validPoint Indicates the validity of the orbit point. @note Only used when Camera is in Edit Orbit Mode.) +/// Set if there is a valid editor camera orbit point. +/// When validPoint is set to false the Camera operates as if it is +/// in Fly mode rather than an Orbit mode. +/// @param validPoint Indicates the validity of the orbit point. +/// @note Only used when Camera is in Edit Orbit Mode.) +/// /// public void setValidEditOrbitPoint(string camera, bool validPoint){ @@ -7578,47 +11023,25 @@ public void setValidEditOrbitPoint(string camera, bool validPoint){ m_ts.fnCamera_setValidEditOrbitPoint(camera, validPoint); } /// -/// Set the velocity for the camera. @param velocity The camera's velocity in the form of \"x y z\". @note Only affects the Camera when in Newton mode.) +/// Set the velocity for the camera. +/// @param velocity The camera's velocity in the form of \"x y z\". +/// @note Only affects the Camera when in Newton mode.) +/// /// public void setVelocity(string camera, Point3F velocity){ m_ts.fnCamera_setVelocity(camera, velocity.AsString()); } -} - /// - /// - /// - public class CloudLayerObject -{ -private Omni m_ts; - /// - /// - /// - /// -public CloudLayerObject(ref Omni ts){m_ts = ts;} -/// -/// Change coverage of the cloudlayer.) -/// -public void ChangeCoverage(string cloudlayer, float newCoverage){ - - -m_ts.fnCloudLayer_ChangeCoverage(cloudlayer, newCoverage); -} } /// /// /// public class CompoundUndoActionObject { -private Omni m_ts; - /// - /// - /// - /// -public CompoundUndoActionObject(ref Omni ts){m_ts = ts;} /// /// addAction( UndoAction ) ) +/// /// public void CompoundUndoAction_addAction(string compoundundoaction, string objName){ @@ -7631,14 +11054,23 @@ public void CompoundUndoAction_addAction(string compoundundoaction, string objN /// public class ConsoleLoggerObject { -private Omni m_ts; - /// - /// - /// - /// -public ConsoleLoggerObject(ref Omni ts){m_ts = ts;} /// -/// () Attaches the logger to the console and begins writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Attaches the logger to the console and begins writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool ConsoleLogger_attach(string consolelogger){ @@ -7646,7 +11078,22 @@ public bool ConsoleLogger_attach(string consolelogger){ return m_ts.fn_ConsoleLogger_attach(consolelogger); } /// -/// () Detaches the logger from the console and stops writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Detaches the logger from the console and stops writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool ConsoleLogger_detach(string consolelogger){ @@ -7659,12 +11106,6 @@ public bool ConsoleLogger_detach(string consolelogger){ /// public class CoverPointObject { -private Omni m_ts; - /// - /// - /// - /// -public CoverPointObject(ref Omni ts){m_ts = ts;} /// /// @brief Returns true if someone is already using this cover point.) /// @@ -7680,14 +11121,9 @@ public bool isOccupied(string coverpoint){ /// public class CreatorTreeObject { -private Omni m_ts; - /// - /// - /// - /// -public CreatorTreeObject(ref Omni ts){m_ts = ts;} /// /// (string group, string name, string value)) +/// /// public int CreatorTree_addGroup(string creatortree, int group, string name, string value){ @@ -7696,6 +11132,7 @@ public int CreatorTree_addGroup(string creatortree, int group, string name, str } /// /// (Node group, string name, string value)) +/// /// public int CreatorTree_addItem(string creatortree, int group, string name, string value){ @@ -7704,6 +11141,7 @@ public int CreatorTree_addItem(string creatortree, int group, string name, stri } /// /// Clear the tree.) +/// /// public void CreatorTree_clear(string creatortree){ @@ -7712,6 +11150,7 @@ public void CreatorTree_clear(string creatortree){ } /// /// (string world, string type, string filename)) +/// /// public bool CreatorTree_fileNameMatch(string creatortree, string world, string type, string filename){ @@ -7720,6 +11159,7 @@ public bool CreatorTree_fileNameMatch(string creatortree, string world, string } /// /// (Node item)) +/// /// public string CreatorTree_getName(string creatortree, string item){ @@ -7728,6 +11168,7 @@ public string CreatorTree_getName(string creatortree, string item){ } /// /// (Node n)) +/// /// public int CreatorTree_getParent(string creatortree, int nodeValue){ @@ -7736,6 +11177,7 @@ public int CreatorTree_getParent(string creatortree, int nodeValue){ } /// /// Return a handle to the currently selected item.) +/// /// public int CreatorTree_getSelected(string creatortree){ @@ -7744,6 +11186,7 @@ public int CreatorTree_getSelected(string creatortree){ } /// /// (Node n)) +/// /// public string CreatorTree_getValue(string creatortree, int nodeValue){ @@ -7752,6 +11195,7 @@ public string CreatorTree_getValue(string creatortree, int nodeValue){ } /// /// (Group g)) +/// /// public bool CreatorTree_isGroup(string creatortree, string group){ @@ -7764,14 +11208,10 @@ public bool CreatorTree_isGroup(string creatortree, string group){ /// public class CubemapDataObject { -private Omni m_ts; - /// - /// - /// - /// -public CubemapDataObject(ref Omni ts){m_ts = ts;} /// -/// Returns the script filename of where the CubemapData object was defined. This is used by the material editor. ) +/// Returns the script filename of where the CubemapData object was +/// defined. This is used by the material editor. ) +/// /// public string getFilename(string cubemapdata){ @@ -7780,6 +11220,7 @@ public string getFilename(string cubemapdata){ } /// /// Update the assigned cubemaps faces. ) +/// /// public void updateFaces(string cubemapdata){ @@ -7792,14 +11233,10 @@ public void updateFaces(string cubemapdata){ /// public class DbgFileViewObject { -private Omni m_ts; - /// - /// - /// - /// -public DbgFileViewObject(ref Omni ts){m_ts = ts;} /// -/// () Clear all break points in the current file.) +/// () +/// Clear all break points in the current file.) +/// /// public void DbgFileView_clearBreakPositions(string dbgfileview){ @@ -7807,7 +11244,10 @@ public void DbgFileView_clearBreakPositions(string dbgfileview){ m_ts.fn_DbgFileView_clearBreakPositions(dbgfileview); } /// -/// (string findThis) Find the specified string in the currently viewed file and scroll it into view.) +/// (string findThis) +/// Find the specified string in the currently viewed file and +/// scroll it into view.) +/// /// public bool DbgFileView_findString(string dbgfileview, string findThis){ @@ -7815,7 +11255,11 @@ public bool DbgFileView_findString(string dbgfileview, string findThis){ return m_ts.fn_DbgFileView_findString(dbgfileview, findThis); } /// -/// () Get the currently executing file and line, if any. @returns A string containing the file, a tab, and then the line number. Use getField() with this.) +/// () +/// Get the currently executing file and line, if any. +/// @returns A string containing the file, a tab, and then the line number. +/// Use getField() with this.) +/// /// public string DbgFileView_getCurrentLine(string dbgfileview){ @@ -7823,7 +11267,10 @@ public string DbgFileView_getCurrentLine(string dbgfileview){ return m_ts.fn_DbgFileView_getCurrentLine(dbgfileview); } /// -/// (string filename) Open a file for viewing. @note This loads the file from the local system.) +/// (string filename) +/// Open a file for viewing. +/// @note This loads the file from the local system.) +/// /// public bool DbgFileView_open(string dbgfileview, string filename){ @@ -7831,7 +11278,9 @@ public bool DbgFileView_open(string dbgfileview, string filename){ return m_ts.fn_DbgFileView_open(dbgfileview, filename); } /// -/// (int line) Remove a breakpoint from the specified line.) +/// (int line) +/// Remove a breakpoint from the specified line.) +/// /// public void DbgFileView_removeBreak(string dbgfileview, uint line){ @@ -7839,7 +11288,9 @@ public void DbgFileView_removeBreak(string dbgfileview, uint line){ m_ts.fn_DbgFileView_removeBreak(dbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void DbgFileView_setBreak(string dbgfileview, uint line){ @@ -7847,7 +11298,9 @@ public void DbgFileView_setBreak(string dbgfileview, uint line){ m_ts.fn_DbgFileView_setBreak(dbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void DbgFileView_setBreakPosition(string dbgfileview, uint line){ @@ -7855,7 +11308,9 @@ public void DbgFileView_setBreakPosition(string dbgfileview, uint line){ m_ts.fn_DbgFileView_setBreakPosition(dbgfileview, line); } /// -/// (int line, bool selected) Set the current highlighted line.) +/// (int line, bool selected) +/// Set the current highlighted line.) +/// /// public void DbgFileView_setCurrentLine(string dbgfileview, int line, bool selected){ @@ -7868,14 +11323,27 @@ public void DbgFileView_setCurrentLine(string dbgfileview, int line, bool selec /// public class DebrisObject { -private Omni m_ts; - /// - /// - /// - /// -public DebrisObject(ref Omni ts){m_ts = ts;} /// -/// 1.0 1.0 1.0, 1.0 0.0 0.0), @brief Manually set this piece of debris at the given position with the given velocity. Usually you do not manually create Debris objects as they are generated through other means, such as an Explosion. This method exists when you do manually create a Debris object and want to have it start moving. @param inputPosition Position to place the debris. @param inputVelocity Velocity to move the debris after it has been placed. @return Always returns true. @tsexample // Define the position %position = \"1.0 1.0 1.0\"; // Define the velocity %velocity = \"1.0 0.0 0.0\"; // Inform the debris object of its new position and velocity %debris.init(%position,%velocity); @endtsexample) +/// 1.0 1.0 1.0, 1.0 0.0 0.0), +/// @brief Manually set this piece of debris at the given position with the given velocity. +/// +/// Usually you do not manually create Debris objects as they are generated through other means, +/// such as an Explosion. This method exists when you do manually create a Debris object and +/// want to have it start moving. +/// +/// @param inputPosition Position to place the debris. +/// @param inputVelocity Velocity to move the debris after it has been placed. +/// @return Always returns true. +/// +/// @tsexample +/// // Define the position +/// %position = \"1.0 1.0 1.0\"; +/// // Define the velocity +/// %velocity = \"1.0 0.0 0.0\"; +/// // Inform the debris object of its new position and velocity +/// %debris.init(%position,%velocity); +/// @endtsexample) +/// /// public bool init(string debris, string inputPosition = "1.01.01.0", string inputVelocity = "1.00.00.0"){ @@ -7888,14 +11356,9 @@ public bool init(string debris, string inputPosition = "1.01.01.0", string inpu /// public class DebugDrawerObject { -private Omni m_ts; - /// - /// - /// - /// -public DebugDrawerObject(ref Omni ts){m_ts = ts;} /// /// Draws an axis aligned box primitive within the two 3d points. ) +/// /// public void drawBox(string debugdrawer, Point3F a, Point3F b, ColorF color = null ){ if (color== null) {color = new ColorF(1.0f, 1.0f, 1.0f,1.0f);} @@ -7905,6 +11368,7 @@ public void drawBox(string debugdrawer, Point3F a, Point3F b, ColorF color = nu } /// /// Draws a line primitive between two 3d points. ) +/// /// public void drawLine(string debugdrawer, Point3F a, Point3F b, ColorF color = null ){ if (color== null) {color = new ColorF(1.0f, 1.0f, 1.0f,1.0f);} @@ -7914,6 +11378,7 @@ public void drawLine(string debugdrawer, Point3F a, Point3F b, ColorF color = n } /// /// Sets the \"time to live\" (TTL) for the last rendered primitive. ) +/// /// public void setLastTTL(string debugdrawer, uint ms){ @@ -7922,6 +11387,7 @@ public void setLastTTL(string debugdrawer, uint ms){ } /// /// Sets the z buffer reading state for the last rendered primitive. ) +/// /// public void setLastZTest(string debugdrawer, bool enabled){ @@ -7930,6 +11396,7 @@ public void setLastZTest(string debugdrawer, bool enabled){ } /// /// Toggles the rendering of DebugDrawer primitives. ) +/// /// public void toggleDrawing(string debugdrawer){ @@ -7938,6 +11405,7 @@ public void toggleDrawing(string debugdrawer){ } /// /// Toggles freeze mode which keeps the currently rendered primitives from expiring. ) +/// /// public void toggleFreeze(string debugdrawer){ @@ -7950,14 +11418,14 @@ public void toggleFreeze(string debugdrawer){ /// public class DecalDataObject { -private Omni m_ts; - /// - /// - /// - /// -public DecalDataObject(ref Omni ts){m_ts = ts;} /// -/// Recompute the imagemap sub-texture rectangles for this DecalData. @tsexample // Inform the decal object to reload its imagemap and frame data. %decalData.texRows = 4; %decalData.postApply(); @endtsexample) +/// Recompute the imagemap sub-texture rectangles for this DecalData. +/// @tsexample +/// // Inform the decal object to reload its imagemap and frame data. +/// %decalData.texRows = 4; +/// %decalData.postApply(); +/// @endtsexample) +/// /// public void postApply(string decaldata){ @@ -7970,14 +11438,13 @@ public void postApply(string decaldata){ /// public class DecalRoadObject { -private Omni m_ts; - /// - /// - /// - /// -public DecalRoadObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit the material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// the material and other fields ( not including nodes ) +/// to client objects. +/// ) +/// /// public void postApply(string decalroad){ @@ -7985,7 +11452,10 @@ public void postApply(string decalroad){ m_ts.fnDecalRoad_postApply(decalroad); } /// -/// Intended as a helper to developers and editor scripts. Force DecalRoad to update it's spline and reclip geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force DecalRoad to update it's spline and reclip geometry. +/// ) +/// /// public void regenerate(string decalroad){ @@ -7998,14 +11468,14 @@ public void regenerate(string decalroad){ /// public class DynamicConsoleMethodComponentObject { -private Omni m_ts; - /// - /// - /// - /// -public DynamicConsoleMethodComponentObject(ref Omni ts){m_ts = ts;} /// -/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method @param methodName The method's name as a string @param argi Any arguments to pass to the method @return No return value @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method +/// @param methodName The method's name as a string +/// @param argi Any arguments to pass to the method +/// @return No return value +/// @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// +/// /// public void callMethod(string dynamicconsolemethodcomponent, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= "", string a21= "", string a22= "", string a23= "", string a24= "", string a25= "", string a26= "", string a27= "", string a28= "", string a29= "", string a30= "", string a31= "", string a32= "", string a33= "", string a34= "", string a35= "", string a36= "", string a37= "", string a38= "", string a39= "", string a40= "", string a41= "", string a42= "", string a43= "", string a44= "", string a45= "", string a46= "", string a47= "", string a48= "", string a49= "", string a50= "", string a51= "", string a52= "", string a53= "", string a54= "", string a55= "", string a56= "", string a57= "", string a58= "", string a59= "", string a60= "", string a61= "", string a62= "", string a63= ""){ @@ -8018,14 +11488,9 @@ public void callMethod(string dynamicconsolemethodcomponent, string a2= "", str /// public class EditManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public EditManagerObject(ref Omni ts){m_ts = ts;} /// /// Perform the onEditorDisabled callback on all SimObjects and set gEditingMission false ) +/// /// public void EditManager_editorDisabled(string editmanager){ @@ -8034,6 +11499,7 @@ public void EditManager_editorDisabled(string editmanager){ } /// /// Perform the onEditorEnabled callback on all SimObjects and set gEditingMission true ) +/// /// public void EditManager_editorEnabled(string editmanager){ @@ -8042,6 +11508,7 @@ public void EditManager_editorEnabled(string editmanager){ } /// /// (int slot)) +/// /// public void EditManager_gotoBookmark(string editmanager, int val){ @@ -8050,6 +11517,7 @@ public void EditManager_gotoBookmark(string editmanager, int val){ } /// /// Return the value of gEditingMission. ) +/// /// public bool EditManager_isEditorEnabled(string editmanager){ @@ -8058,6 +11526,7 @@ public bool EditManager_isEditorEnabled(string editmanager){ } /// /// (int slot)) +/// /// public void EditManager_setBookmark(string editmanager, int val){ @@ -8070,14 +11539,9 @@ public void EditManager_setBookmark(string editmanager, int val){ /// public class EditTSCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public EditTSCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public int getDisplayType(string edittsctrl){ @@ -8086,6 +11550,7 @@ public int getDisplayType(string edittsctrl){ } /// /// ) +/// /// public int getGizmo(string edittsctrl){ @@ -8094,6 +11559,7 @@ public int getGizmo(string edittsctrl){ } /// /// Return the FOV for orthographic views. ) +/// /// public float getOrthoFOV(string edittsctrl){ @@ -8102,6 +11568,7 @@ public float getOrthoFOV(string edittsctrl){ } /// /// ) +/// /// public bool isMiddleMouseDown(string edittsctrl){ @@ -8110,6 +11577,7 @@ public bool isMiddleMouseDown(string edittsctrl){ } /// /// ) +/// /// public void renderBox(string edittsctrl, Point3F pos, Point3F size){ @@ -8118,6 +11586,7 @@ public void renderBox(string edittsctrl, Point3F pos, Point3F size){ } /// /// ) +/// /// public void renderCircle(string edittsctrl, Point3F pos, Point3F normal, float radius, int segments = 0){ @@ -8126,6 +11595,7 @@ public void renderCircle(string edittsctrl, Point3F pos, Point3F normal, float } /// /// ) +/// /// public void renderLine(string edittsctrl, Point3F start, Point3F end, float lineWidth = 0){ @@ -8134,6 +11604,7 @@ public void renderLine(string edittsctrl, Point3F start, Point3F end, float lin } /// /// ) +/// /// public void renderSphere(string edittsctrl, Point3F pos, float radius, int sphereLevel = 0){ @@ -8142,6 +11613,7 @@ public void renderSphere(string edittsctrl, Point3F pos, float radius, int sphe } /// /// ) +/// /// public void renderTriangle(string edittsctrl, Point3F a, Point3F b, Point3F c){ @@ -8150,6 +11622,7 @@ public void renderTriangle(string edittsctrl, Point3F a, Point3F b, Point3F c){ } /// /// ) +/// /// public void setDisplayType(string edittsctrl, int displayType){ @@ -8158,6 +11631,7 @@ public void setDisplayType(string edittsctrl, int displayType){ } /// /// Set the FOV for to use for orthographic views. ) +/// /// public void setOrthoFOV(string edittsctrl, float fov){ @@ -8170,14 +11644,10 @@ public void setOrthoFOV(string edittsctrl, float fov){ /// public class EventManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public EventManagerObject(ref Omni ts){m_ts = ts;} /// -/// () Print all registered events to the console. ) +/// () +/// Print all registered events to the console. ) +/// /// public void EventManager_dumpEvents(string eventmanager){ @@ -8185,7 +11655,10 @@ public void EventManager_dumpEvents(string eventmanager){ m_ts.fn_EventManager_dumpEvents(eventmanager); } /// -/// ), ( String event ) Print all subscribers to an event to the console. @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// ), ( String event ) +/// Print all subscribers to an event to the console. +/// @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// /// public void EventManager_dumpSubscribers(string eventmanager, string listenerName = ""){ @@ -8193,7 +11666,11 @@ public void EventManager_dumpSubscribers(string eventmanager, string listenerNa m_ts.fn_EventManager_dumpSubscribers(eventmanager, listenerName); } /// -/// ( String event ) Check if an event is registered or not. @param event The event to check. @return Whether or not the event exists. ) +/// ( String event ) +/// Check if an event is registered or not. +/// @param event The event to check. +/// @return Whether or not the event exists. ) +/// /// public bool EventManager_isRegisteredEvent(string eventmanager, string evt){ @@ -8201,7 +11678,12 @@ public bool EventManager_isRegisteredEvent(string eventmanager, string evt){ return m_ts.fn_EventManager_isRegisteredEvent(eventmanager, evt); } /// -/// ), ( String event, String data ) ~Trigger an event. @param event The event to trigger. @param data The data associated with the event. @return Whether or not the event was dispatched successfully. ) +/// ), ( String event, String data ) +/// ~Trigger an event. +/// @param event The event to trigger. +/// @param data The data associated with the event. +/// @return Whether or not the event was dispatched successfully. ) +/// /// public bool EventManager_postEvent(string eventmanager, string evt, string data = ""){ @@ -8209,7 +11691,11 @@ public bool EventManager_postEvent(string eventmanager, string evt, string data return m_ts.fn_EventManager_postEvent(eventmanager, evt, data); } /// -/// ( String event ) Register an event with the event manager. @param event The event to register. @return Whether or not the event was registered successfully. ) +/// ( String event ) +/// Register an event with the event manager. +/// @param event The event to register. +/// @return Whether or not the event was registered successfully. ) +/// /// public bool EventManager_registerEvent(string eventmanager, string evt){ @@ -8217,7 +11703,11 @@ public bool EventManager_registerEvent(string eventmanager, string evt){ return m_ts.fn_EventManager_registerEvent(eventmanager, evt); } /// -/// ( SimObject listener, String event ) Remove a listener from an event. @param listener The listener to remove. @param event The event to be removed from.) +/// ( SimObject listener, String event ) +/// Remove a listener from an event. +/// @param listener The listener to remove. +/// @param event The event to be removed from.) +/// /// public void EventManager_remove(string eventmanager, string listenerName, string evt){ @@ -8225,7 +11715,10 @@ public void EventManager_remove(string eventmanager, string listenerName, strin m_ts.fn_EventManager_remove(eventmanager, listenerName, evt); } /// -/// ( SimObject listener ) Remove a listener from all events. @param listener The listener to remove.) +/// ( SimObject listener ) +/// Remove a listener from all events. +/// @param listener The listener to remove.) +/// /// public void EventManager_removeAll(string eventmanager, string listenerName){ @@ -8233,7 +11726,13 @@ public void EventManager_removeAll(string eventmanager, string listenerName){ m_ts.fn_EventManager_removeAll(eventmanager, listenerName); } /// -/// ), ( SimObject listener, String event, String callback ) Subscribe a listener to an event. @param listener The listener to subscribe. @param event The event to subscribe to. @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. @return Whether or not the subscription was successful. ) +/// ), ( SimObject listener, String event, String callback ) +/// Subscribe a listener to an event. +/// @param listener The listener to subscribe. +/// @param event The event to subscribe to. +/// @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. +/// @return Whether or not the subscription was successful. ) +/// /// public bool EventManager_subscribe(string eventmanager, string listenerName, string evt, string callback = ""){ @@ -8241,7 +11740,10 @@ public bool EventManager_subscribe(string eventmanager, string listenerName, st return m_ts.fn_EventManager_subscribe(eventmanager, listenerName, evt, callback); } /// -/// ( String event ) Remove an event from the EventManager. @param event The event to remove. ) +/// ( String event ) +/// Remove an event from the EventManager. +/// @param event The event to remove. ) +/// /// public void EventManager_unregisterEvent(string eventmanager, string evt){ @@ -8254,14 +11756,12 @@ public void EventManager_unregisterEvent(string eventmanager, string evt){ /// public class FieldBrushObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public FieldBrushObjectObject(ref Omni ts){m_ts = ts;} /// -/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ @param simObject Object to copy static-fields from. @param fieldList fields to filter static-fields against. @return No return value.) +/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ +/// @param simObject Object to copy static-fields from. +/// @param fieldList fields to filter static-fields against. +/// @return No return value.) +/// /// public void FieldBrushObject_copyFields(string fieldbrushobject, string simObjName, string pFieldList = ""){ @@ -8269,7 +11769,10 @@ public void FieldBrushObject_copyFields(string fieldbrushobject, string simObjN m_ts.fn_FieldBrushObject_copyFields(fieldbrushobject, simObjName, pFieldList); } /// -/// (simObject) Paste copied static-fields to selected object./ @param simObject Object to paste static-fields to. @return No return value.) +/// (simObject) Paste copied static-fields to selected object./ +/// @param simObject Object to paste static-fields to. +/// @return No return value.) +/// /// public void FieldBrushObject_pasteFields(string fieldbrushobject, string simObjName){ @@ -8277,7 +11780,11 @@ public void FieldBrushObject_pasteFields(string fieldbrushobject, string simObj m_ts.fn_FieldBrushObject_pasteFields(fieldbrushobject, simObjName); } /// -/// ), (simObject, [groupList]) Query available static-fields for selected object./ @param simObject Object to query static-fields on. @param groupList groups to filter static-fields against. @return Space-seperated static-field list.) +/// ), (simObject, [groupList]) Query available static-fields for selected object./ +/// @param simObject Object to query static-fields on. +/// @param groupList groups to filter static-fields against. +/// @return Space-seperated static-field list.) +/// /// public string FieldBrushObject_queryFields(string fieldbrushobject, string simObjName, string groupList = ""){ @@ -8285,7 +11792,10 @@ public string FieldBrushObject_queryFields(string fieldbrushobject, string simO return m_ts.fn_FieldBrushObject_queryFields(fieldbrushobject, simObjName, groupList); } /// -/// (simObject) Query available static-field groups for selected object./ @param simObject Object to query static-field groups on. @return Space-seperated static-field group list.) +/// (simObject) Query available static-field groups for selected object./ +/// @param simObject Object to query static-field groups on. +/// @return Space-seperated static-field group list.) +/// /// public string FieldBrushObject_queryGroups(string fieldbrushobject, string simObjName){ @@ -8298,14 +11808,92 @@ public string FieldBrushObject_queryGroups(string fieldbrushobject, string simO /// public class FileDialogObject { -private Omni m_ts; - /// - /// - /// - /// -public FileDialogObject(ref Omni ts){m_ts = ts;} /// -/// @brief Launches the OS file browser After an Execute() call, the chosen file name and path is available in one of two areas. If only a single file selection is permitted, the results will be stored in the @a fileName attribute. If multiple file selection is permitted, the results will be stored in the @a files array. The total number of files in the array will be stored in the @a fileCount attribute. @tsexample // NOTE: This is not he preferred class to use, but this still works // Create the file dialog %baseFileDialog = new FileDialog() { // Allow browsing of all file types filters = \"*.*\"; // No default file defaultFile = ; // Set default path relative to project defaultPath = \"./\"; // Set the title title = \"Durpa\"; // Allow changing of path you are browsing changePath = true; }; // Launch the file dialog %baseFileDialog.Execute(); // Don't forget to cleanup %baseFileDialog.delete(); // A better alternative is to use the // derived classes which are specific to file open and save // Create a dialog dedicated to opening files %openFileDlg = new OpenFileDialog() { // Look for jpg image files // First part is the descriptor|second part is the extension Filters = \"Jepg Files|*.jpg\"; // Allow browsing through other folders ChangePath = true; // Only allow opening of one file at a time MultipleFiles = false; }; // Launch the open file dialog %result = %openFileDlg.Execute(); // Obtain the chosen file name and path if ( %result ) { %seletedFile = %openFileDlg.file; } else { %selectedFile = \"\"; } // Cleanup %openFileDlg.delete(); // Create a dialog dedicated to saving a file %saveFileDlg = new SaveFileDialog() { // Only allow for saving of COLLADA files Filters = \"COLLADA Files (*.dae)|*.dae|\"; // Default save path to where the WorldEditor last saved DefaultPath = $pref::WorldEditor::LastPath; // No default file specified DefaultFile = \"\"; // Do not allow the user to change to a new directory ChangePath = false; // Prompt the user if they are going to overwrite an existing file OverwritePrompt = true; }; // Launch the save file dialog %result = %saveFileDlg.Execute(); // Obtain the file name %selectedFile = \"\"; if ( %result ) %selectedFile = %saveFileDlg.file; // Cleanup %saveFileDlg.delete(); @endtsexample @return True if the file was selected was successfully found (opened) or declared (saved).) +/// @brief Launches the OS file browser +/// +/// After an Execute() call, the chosen file name and path is available in one of two areas. +/// If only a single file selection is permitted, the results will be stored in the @a fileName +/// attribute. +/// +/// If multiple file selection is permitted, the results will be stored in the +/// @a files array. The total number of files in the array will be stored in the +/// @a fileCount attribute. +/// +/// @tsexample +/// // NOTE: This is not he preferred class to use, but this still works +/// // Create the file dialog +/// %baseFileDialog = new FileDialog() +/// { +/// // Allow browsing of all file types +/// filters = \"*.*\"; +/// // No default file +/// defaultFile = ; +/// // Set default path relative to project +/// defaultPath = \"./\"; +/// // Set the title +/// title = \"Durpa\"; +/// // Allow changing of path you are browsing +/// changePath = true; +/// }; +/// // Launch the file dialog +/// %baseFileDialog.Execute(); +/// +/// // Don't forget to cleanup +/// %baseFileDialog.delete(); +/// +/// // A better alternative is to use the +/// // derived classes which are specific to file open and save +/// // Create a dialog dedicated to opening files +/// %openFileDlg = new OpenFileDialog() +/// { +/// // Look for jpg image files +/// // First part is the descriptor|second part is the extension +/// Filters = \"Jepg Files|*.jpg\"; +/// // Allow browsing through other folders +/// ChangePath = true; +/// // Only allow opening of one file at a time +/// MultipleFiles = false; +/// }; +/// // Launch the open file dialog +/// %result = %openFileDlg.Execute(); +/// // Obtain the chosen file name and path +/// if ( %result ) +/// { +/// %seletedFile = %openFileDlg.file; +/// } +/// else +/// { +/// %selectedFile = \"\"; +/// } +/// // Cleanup +/// %openFileDlg.delete(); +/// +/// // Create a dialog dedicated to saving a file +/// %saveFileDlg = new SaveFileDialog() +/// { +/// // Only allow for saving of COLLADA files +/// Filters = \"COLLADA Files (*.dae)|*.dae|\"; +/// // Default save path to where the WorldEditor last saved +/// DefaultPath = $pref::WorldEditor::LastPath; +/// // No default file specified +/// DefaultFile = \"\"; +/// // Do not allow the user to change to a new directory +/// ChangePath = false; +/// // Prompt the user if they are going to overwrite an existing file +/// OverwritePrompt = true; +/// }; +/// // Launch the save file dialog +/// %result = %saveFileDlg.Execute(); +/// // Obtain the file name +/// %selectedFile = \"\"; +/// if ( %result ) +/// %selectedFile = %saveFileDlg.file; +/// // Cleanup +/// %saveFileDlg.delete(); +/// @endtsexample +/// +/// @return True if the file was selected was successfully found (opened) or declared (saved).) +/// /// public bool Execute(string filedialog){ @@ -8318,14 +11906,10 @@ public bool Execute(string filedialog){ /// public class FileObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public FileObjectObject(ref Omni ts){m_ts = ts;} /// -/// ), FileObject.writeObject(SimObject, object prepend) @hide) +/// ), FileObject.writeObject(SimObject, object prepend) +/// @hide) +/// /// public void FileObject_writeObject(string fileobject, string simName, string objName = ""){ @@ -8333,7 +11917,32 @@ public void FileObject_writeObject(string fileobject, string simName, string ob m_ts.fn_FileObject_writeObject(fileobject, simName, objName); } /// -/// @brief Close the file. It is EXTREMELY important that you call this function when you are finished reading or writing to a file. Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. Remember: Open, Read/Write, Close, Delete...in that order! @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); // Close the file when finished %fileWrite.close(); // Cleanup the file object %fileWrite.delete(); @endtsexample) +/// @brief Close the file. +/// +/// It is EXTREMELY important that you call this function when you are finished reading or writing to a file. +/// Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. +/// Remember: Open, Read/Write, Close, Delete...in that order! +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// // Close the file when finished +/// %fileWrite.close(); +/// // Cleanup the file object +/// %fileWrite.delete(); +/// @endtsexample) +/// /// public void close(string fileobject){ @@ -8341,7 +11950,25 @@ public void close(string fileobject){ m_ts.fnFileObject_close(fileobject); } /// -/// @brief Determines if the parser for this FileObject has reached the end of the file @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Keep reading until we reach the end of the file while( !%fileRead.isEOF() ) { %line = %fileRead.readline(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); @endtsexample @return True if the parser has reached the end of the file, false otherwise) +/// @brief Determines if the parser for this FileObject has reached the end of the file +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Keep reading until we reach the end of the file +/// while( !%fileRead.isEOF() ) +/// { +/// %line = %fileRead.readline(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise) +/// /// public bool isEOF(string fileobject){ @@ -8349,7 +11976,23 @@ public bool isEOF(string fileobject){ return m_ts.fnFileObject_isEOF(fileobject); } /// -/// @brief Open a specified file for writing, adding data to the end of the file There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. @param filename Path, name, and extension of file to append to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created // If it does exist, whatever we write will be added to the end %result = %fileWrite.OpenForAppend(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing, adding data to the end of the file +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), +/// which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. +/// +/// @param filename Path, name, and extension of file to append to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// // If it does exist, whatever we write will be added to the end +/// %result = %fileWrite.OpenForAppend(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool openForAppend(string fileobject, string filename){ @@ -8357,7 +12000,21 @@ public bool openForAppend(string fileobject, string filename){ return m_ts.fnFileObject_openForAppend(fileobject, filename); } /// -/// @brief Open a specified file for reading There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %result = %fileRead.OpenForRead(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for reading +/// +/// There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %result = %fileRead.OpenForRead(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool openForRead(string fileobject, string filename){ @@ -8365,7 +12022,21 @@ public bool openForRead(string fileobject, string filename){ return m_ts.fnFileObject_openForRead(fileobject, filename); } /// -/// @brief Open a specified file for writing There is no limit as to what kind of file you can write. Any format and data is allowable, not just text @param filename Path, name, and extension of file to write to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %result = %fileWrite.OpenForWrite(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text +/// +/// @param filename Path, name, and extension of file to write to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %result = %fileWrite.OpenForWrite(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool openForWrite(string fileobject, string filename){ @@ -8373,7 +12044,31 @@ public bool openForWrite(string fileobject, string filename){ return m_ts.fnFileObject_openForWrite(fileobject, filename); } /// -/// @brief Read a line from the file without moving the stream position. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); @endtsexample @return String containing the line of data that was just peeked) +/// @brief Read a line from the file without moving the stream position. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just peeked) +/// /// public string peekLine(string fileobject){ @@ -8381,7 +12076,24 @@ public string peekLine(string fileobject){ return m_ts.fnFileObject_peekLine(fileobject); } /// -/// @brief Read a line from file. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Read in the first line %line = %fileRead.readline(); // Print the line we just read echo(%line); @endtsexample @return String containing the line of data that was just read) +/// @brief Read a line from file. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Read in the first line +/// %line = %fileRead.readline(); +/// // Print the line we just read +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just read) +/// /// public string readLine(string fileobject){ @@ -8389,7 +12101,24 @@ public string readLine(string fileobject){ return m_ts.fnFileObject_readLine(fileobject); } /// -/// @brief Write a line to the file, if it was opened for writing. There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param text The data we are writing out to file. @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %fileWrite.OpenForWrite(\"./test.txt\"); // Write a line to the text files %fileWrite.writeLine(\"READ. READ CODE. CODE\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Write a line to the file, if it was opened for writing. +/// +/// There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param text The data we are writing out to file. +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %fileWrite.OpenForWrite(\"./test.txt\"); +/// // Write a line to the text files +/// %fileWrite.writeLine(\"READ. READ CODE. CODE\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public void writeLine(string fileobject, string text){ @@ -8402,14 +12131,20 @@ public void writeLine(string fileobject, string text){ /// public class FileStreamObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public FileStreamObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Close the file. You can no longer read or write to it unless you open it again. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see open()) +/// @brief Close the file. You can no longer read or write to it unless you open it again. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see open()) +/// /// public void close(string filestreamobject){ @@ -8417,7 +12152,34 @@ public void close(string filestreamobject){ m_ts.fnFileStreamObject_close(filestreamobject); } /// -/// @brief Open a file for reading, writing, reading and writing, or appending Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting at the end of the files existing contents. @param filename Name of file to open @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the file was successfully opened, false if something went wrong @see close()) +/// @brief Open a file for reading, writing, reading and writing, or appending +/// +/// Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new +/// file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. +/// +/// \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can +/// move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting +/// at the end of the files existing contents. +/// +/// @param filename Name of file to open +/// @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the file was successfully opened, false if something went wrong +/// +/// @see close()) +/// /// public bool open(string filestreamobject, string filename, string openMode){ @@ -8430,14 +12192,11 @@ public bool open(string filestreamobject, string filename, string openMode){ /// public class FlyingVehicleObject { -private Omni m_ts; - /// - /// - /// - /// -public FlyingVehicleObject(ref Omni ts){m_ts = ts;} /// -/// @brief Set whether the vehicle should temporarily use the createHoverHeight specified in the datablock.This can help avoid problems with spawning. @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// @brief Set whether the vehicle should temporarily use the createHoverHeight +/// specified in the datablock.This can help avoid problems with spawning. +/// @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// /// public void useCreateHeight(string flyingvehicle, bool enabled){ @@ -8450,14 +12209,9 @@ public void useCreateHeight(string flyingvehicle, bool enabled){ /// public class ForestObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestObject(ref Omni ts){m_ts = ts;} /// /// () ) +/// /// public void Forest_clear(string forest){ @@ -8466,6 +12220,7 @@ public void Forest_clear(string forest){ } /// /// ()) +/// /// public bool Forest_isDirty(string forest){ @@ -8474,6 +12229,7 @@ public bool Forest_isDirty(string forest){ } /// /// ()) +/// /// public void Forest_regenCells(string forest){ @@ -8481,15 +12237,18 @@ public void Forest_regenCells(string forest){ m_ts.fn_Forest_regenCells(forest); } /// -/// ), saveDataFile( [path] ) ) +/// saveDataFile( [path] ) ) +/// /// -public void Forest_saveDataFile(string forest, string path = ""){ +public void Forest_saveDataFile(string forest, string path = null ){ +if (path== null) {path = null;} m_ts.fn_Forest_saveDataFile(forest, path); } /// /// .) +/// /// public void addItem(string forest, string data, Point3F position, float rotation, float scale){ @@ -8498,6 +12257,7 @@ public void addItem(string forest, string data, Point3F position, float rotatio } /// /// .) +/// /// public void addItemWithTransform(string forest, string data, TransformF trans, float scale){ @@ -8510,14 +12270,9 @@ public void addItemWithTransform(string forest, string data, TransformF trans, /// public class ForestBrushObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestBrushObject(ref Omni ts){m_ts = ts;} /// /// ( ForestItemData obj ) ) +/// /// public bool ForestBrush_containsItemData(string forestbrush, string obj){ @@ -8530,14 +12285,9 @@ public bool ForestBrush_containsItemData(string forestbrush, string obj){ /// public class ForestBrushToolObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestBrushToolObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void ForestBrushTool_collectElements(string forestbrushtool){ @@ -8550,14 +12300,9 @@ public void ForestBrushTool_collectElements(string forestbrushtool){ /// public class ForestEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// ( ForestItemData obj ) ) +/// /// public void ForestEditorCtrl_deleteMeshSafe(string foresteditorctrl, string obj){ @@ -8566,6 +12311,7 @@ public void ForestEditorCtrl_deleteMeshSafe(string foresteditorctrl, string obj } /// /// () ) +/// /// public int ForestEditorCtrl_getActiveTool(string foresteditorctrl){ @@ -8574,6 +12320,7 @@ public int ForestEditorCtrl_getActiveTool(string foresteditorctrl){ } /// /// ) +/// /// public bool ForestEditorCtrl_isDirty(string foresteditorctrl){ @@ -8582,6 +12329,7 @@ public bool ForestEditorCtrl_isDirty(string foresteditorctrl){ } /// /// ( ForestTool tool ) ) +/// /// public void ForestEditorCtrl_setActiveTool(string foresteditorctrl, string toolName){ @@ -8590,6 +12338,7 @@ public void ForestEditorCtrl_setActiveTool(string foresteditorctrl, string tool } /// /// () ) +/// /// public void ForestEditorCtrl_updateActiveForest(string foresteditorctrl){ @@ -8602,14 +12351,9 @@ public void ForestEditorCtrl_updateActiveForest(string foresteditorctrl){ /// public class ForestSelectionToolObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestSelectionToolObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void ForestSelectionTool_clearSelection(string forestselectiontool){ @@ -8618,6 +12362,7 @@ public void ForestSelectionTool_clearSelection(string forestselectiontool){ } /// /// ) +/// /// public void ForestSelectionTool_copySelection(string forestselectiontool){ @@ -8626,6 +12371,7 @@ public void ForestSelectionTool_copySelection(string forestselectiontool){ } /// /// ) +/// /// public void ForestSelectionTool_cutSelection(string forestselectiontool){ @@ -8634,6 +12380,7 @@ public void ForestSelectionTool_cutSelection(string forestselectiontool){ } /// /// ) +/// /// public void ForestSelectionTool_deleteSelection(string forestselectiontool){ @@ -8642,6 +12389,7 @@ public void ForestSelectionTool_deleteSelection(string forestselectiontool){ } /// /// ) +/// /// public int ForestSelectionTool_getSelectionCount(string forestselectiontool){ @@ -8650,6 +12398,7 @@ public int ForestSelectionTool_getSelectionCount(string forestselectiontool){ } /// /// ) +/// /// public void ForestSelectionTool_pasteSelection(string forestselectiontool){ @@ -8662,42 +12411,38 @@ public void ForestSelectionTool_pasteSelection(string forestselectiontool){ /// public class ForestWindEmitterObject { -private Omni m_ts; - /// - /// - /// - /// -public ForestWindEmitterObject(ref Omni ts){m_ts = ts;} /// -/// @brief Mounts the wind emitter to another scene object @param objectID Unique ID of the object wind emitter should attach to @tsexample // Wind emitter previously created and named %windEmitter // Going to attach it to the player, making him a walking wind storm %windEmitter.attachToObject(%player); @endtsexample) +/// @brief Mounts the wind emitter to another scene object +/// +/// @param objectID Unique ID of the object wind emitter should attach to +/// +/// @tsexample +/// // Wind emitter previously created and named %windEmitter +/// // Going to attach it to the player, making him a walking wind storm +/// %windEmitter.attachToObject(%player); +/// @endtsexample) +/// /// public void attachToObject(string forestwindemitter, uint objectID){ m_ts.fnForestWindEmitter_attachToObject(forestwindemitter, objectID); } -/// -/// @brief Mounts the wind emitter to another scene object @param ) -/// -public void resetWind(string forestwindemitter, int randomSeed){ - - -m_ts.fnForestWindEmitter_resetWind(forestwindemitter, randomSeed); -} } /// /// /// public class GameBaseObject { -private Omni m_ts; - /// - /// - /// - /// -public GameBaseObject(ref Omni ts){m_ts = ts;} /// -/// @brief Apply an impulse to this object as defined by a world position and velocity vector. @param pos impulse world position @param vel impulse velocity (impulse force F = m * v) @return Always true @note Not all objects that derrive from GameBase have this defined.) +/// @brief Apply an impulse to this object as defined by a world position and velocity vector. +/// +/// @param pos impulse world position +/// @param vel impulse velocity (impulse force F = m * v) +/// @return Always true +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public bool applyImpulse(string gamebase, Point3F pos, Point3F vel){ @@ -8705,7 +12450,14 @@ public bool applyImpulse(string gamebase, Point3F pos, Point3F vel){ return m_ts.fnGameBase_applyImpulse(gamebase, pos.AsString(), vel.AsString()); } /// -/// @brief Applies a radial impulse to the object using the given origin and force. @param origin World point of origin of the radial impulse. @param radius The radius of the impulse area. @param magnitude The strength of the impulse. @note Not all objects that derrive from GameBase have this defined.) +/// @brief Applies a radial impulse to the object using the given origin and force. +/// +/// @param origin World point of origin of the radial impulse. +/// @param radius The radius of the impulse area. +/// @param magnitude The strength of the impulse. +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public void applyRadialImpulse(string gamebase, Point3F origin, float radius, float magnitude){ @@ -8713,7 +12465,10 @@ public void applyRadialImpulse(string gamebase, Point3F origin, float radius, f m_ts.fnGameBase_applyRadialImpulse(gamebase, origin.AsString(), radius, magnitude); } /// -/// @brief Get the datablock used by this object. @return the datablock this GameBase is using. @see setDataBlock()) +/// @brief Get the datablock used by this object. +/// @return the datablock this GameBase is using. +/// @see setDataBlock()) +/// /// public int getDataBlock(string gamebase){ @@ -8721,7 +12476,11 @@ public int getDataBlock(string gamebase){ return m_ts.fnGameBase_getDataBlock(gamebase); } /// -/// @brief Assign this GameBase to use the specified datablock. @param data new datablock to use @return true if successful, false if failed. @see getDataBlock()) +/// @brief Assign this GameBase to use the specified datablock. +/// @param data new datablock to use +/// @return true if successful, false if failed. +/// @see getDataBlock()) +/// /// public bool setDataBlock(string gamebase, string data){ @@ -8734,14 +12493,37 @@ public bool setDataBlock(string gamebase, string data){ /// public class GameConnectionObject { -private Omni m_ts; - /// - /// - /// - /// -public GameConnectionObject(ref Omni ts){m_ts = ts;} /// -/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. Ghosts represent objects on the server that are in scope for the client. These need to be synchronized with the client in order for the client to see and interact with them. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mod paths, this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. +/// +/// Ghosts represent objects on the server that are in scope for the client. These need +/// to be synchronized with the client in order for the client to see and interact with them. +/// This is typically done during the standard mission start phase 2 when following Torque's +/// example mission startup sequence. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mod paths, this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void activateGhosting(string gameconnection){ @@ -8749,7 +12531,10 @@ public void activateGhosting(string gameconnection){ m_ts.fnGameConnection_activateGhosting(gameconnection); } /// -/// @brief Sets the size of the chase camera's matrix queue. @note This sets the queue size across all GameConnections. @note This is not currently hooked up.) +/// @brief Sets the size of the chase camera's matrix queue. +/// @note This sets the queue size across all GameConnections. +/// @note This is not currently hooked up.) +/// /// public bool chaseCam(string gameconnection, int size){ @@ -8757,7 +12542,10 @@ public bool chaseCam(string gameconnection, int size){ return m_ts.fnGameConnection_chaseCam(gameconnection, size); } /// -/// @brief Clear the connection's camera object reference. @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// @brief Clear the connection's camera object reference. +/// +/// @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// /// public void clearCameraObject(string gameconnection){ @@ -8765,7 +12553,9 @@ public void clearCameraObject(string gameconnection){ m_ts.fnGameConnection_clearCameraObject(gameconnection); } /// -/// @brief Clear any display device. A display device may define a number of properties that are used during rendering.) +/// @brief Clear any display device. +/// A display device may define a number of properties that are used during rendering.) +/// /// public void clearDisplayDevice(string gameconnection){ @@ -8773,7 +12563,26 @@ public void clearDisplayDevice(string gameconnection){ m_ts.fnGameConnection_clearDisplayDevice(gameconnection); } /// -/// ), @brief On the server, disconnect a client and pass along an optional reason why. This method performs two operations: it disconnects a client connection from the server, and it deletes the connection object. The optional reason is sent in the disconnect packet and is often displayed to the user so they know why they've been disconnected. @param reason [optional] The reason why the user has been disconnected from the server. @tsexample function kick(%client) { messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); if (!%client.isAIControlled()) BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); %client.delete(\"You have been kicked from this server\"); } @endtsexample) +/// ), +/// @brief On the server, disconnect a client and pass along an optional reason why. +/// +/// This method performs two operations: it disconnects a client connection from the server, +/// and it deletes the connection object. The optional reason is sent in the disconnect packet +/// and is often displayed to the user so they know why they've been disconnected. +/// +/// @param reason [optional] The reason why the user has been disconnected from the server. +/// +/// @tsexample +/// function kick(%client) +/// { +/// messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); +/// +/// if (!%client.isAIControlled()) +/// BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); +/// %client.delete(\"You have been kicked from this server\"); +/// } +/// @endtsexample) +/// /// public void delete(string gameconnection, string reason = ""){ @@ -8781,7 +12590,10 @@ public void delete(string gameconnection, string reason = ""){ m_ts.fnGameConnection_delete(gameconnection, reason); } /// -/// @brief Returns the connection's camera object used when not viewing through the control object. @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// @brief Returns the connection's camera object used when not viewing through the control object. +/// +/// @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// /// public string getCameraObject(string gameconnection){ @@ -8790,6 +12602,7 @@ public string getCameraObject(string gameconnection){ } /// /// @brief Returns the default field of view as used by the control object's camera.) +/// /// public float getControlCameraDefaultFov(string gameconnection){ @@ -8798,6 +12611,7 @@ public float getControlCameraDefaultFov(string gameconnection){ } /// /// @brief Returns the field of view as used by the control object's camera.) +/// /// public float getControlCameraFov(string gameconnection){ @@ -8805,7 +12619,12 @@ public float getControlCameraFov(string gameconnection){ return m_ts.fnGameConnection_getControlCameraFov(gameconnection); } /// -/// @brief On the server, returns the object that the client is controlling. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @see GameConnection::setControlObject()) +/// @brief On the server, returns the object that the client is controlling. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @see GameConnection::setControlObject()) +/// /// public string getControlObject(string gameconnection){ @@ -8813,7 +12632,11 @@ public string getControlObject(string gameconnection){ return m_ts.fnGameConnection_getControlObject(gameconnection); } /// -/// @brief Get the connection's control scheme absolute rotation property. @return True if the connection's control object should use an absolute rotation control scheme. @see GameConnection::setControlSchemeParameters()) +/// @brief Get the connection's control scheme absolute rotation property. +/// +/// @return True if the connection's control object should use an absolute rotation control scheme. +/// @see GameConnection::setControlSchemeParameters()) +/// /// public bool getControlSchemeAbsoluteRotation(string gameconnection){ @@ -8821,7 +12644,9 @@ public bool getControlSchemeAbsoluteRotation(string gameconnection){ return m_ts.fnGameConnection_getControlSchemeAbsoluteRotation(gameconnection); } /// -/// @brief On the client, get the control object's damage flash level. @return flash level) +/// @brief On the client, get the control object's damage flash level. +/// @return flash level) +/// /// public float getDamageFlash(string gameconnection){ @@ -8829,7 +12654,9 @@ public float getDamageFlash(string gameconnection){ return m_ts.fnGameConnection_getDamageFlash(gameconnection); } /// -/// @brief On the client, get the control object's white-out level. @return white-out level) +/// @brief On the client, get the control object's white-out level. +/// @return white-out level) +/// /// public float getWhiteOut(string gameconnection){ @@ -8837,7 +12664,9 @@ public float getWhiteOut(string gameconnection){ return m_ts.fnGameConnection_getWhiteOut(gameconnection); } /// -/// @brief Returns true if this connection is AI controlled. @see AIConnection) +/// @brief Returns true if this connection is AI controlled. +/// @see AIConnection) +/// /// public bool isAIControlled(string gameconnection){ @@ -8845,7 +12674,10 @@ public bool isAIControlled(string gameconnection){ return m_ts.fnGameConnection_isAIControlled(gameconnection); } /// -/// @brief Returns true if the object being controlled by the client is making use of a rotation damped camera. @see Camera) +/// @brief Returns true if the object being controlled by the client is making use +/// of a rotation damped camera. +/// @see Camera) +/// /// public bool isControlObjectRotDampedCamera(string gameconnection){ @@ -8853,7 +12685,10 @@ public bool isControlObjectRotDampedCamera(string gameconnection){ return m_ts.fnGameConnection_isControlObjectRotDampedCamera(gameconnection); } /// -/// @brief Returns true if a previously recorded demo file is now playing. @see GameConnection::playDemo()) +/// @brief Returns true if a previously recorded demo file is now playing. +/// +/// @see GameConnection::playDemo()) +/// /// public bool isDemoPlaying(string gameconnection){ @@ -8861,7 +12696,10 @@ public bool isDemoPlaying(string gameconnection){ return m_ts.fnGameConnection_isDemoPlaying(gameconnection); } /// -/// @brief Returns true if a demo file is now being recorded. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief Returns true if a demo file is now being recorded. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool isDemoRecording(string gameconnection){ @@ -8869,7 +12707,11 @@ public bool isDemoRecording(string gameconnection){ return m_ts.fnGameConnection_isDemoRecording(gameconnection); } /// -/// @brief Returns true if this connection is in first person mode. @note Transition to first person occurs over time via mCameraPos, so this won't immediately return true after a set.) +/// @brief Returns true if this connection is in first person mode. +/// +/// @note Transition to first person occurs over time via mCameraPos, so this +/// won't immediately return true after a set.) +/// /// public bool isFirstPerson(string gameconnection){ @@ -8877,7 +12719,9 @@ public bool isFirstPerson(string gameconnection){ return m_ts.fnGameConnection_isFirstPerson(gameconnection); } /// -/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. @note The list is sent to the console.) +/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. +/// @note The list is sent to the console.) +/// /// public void listClassIDs(string gameconnection){ @@ -8886,6 +12730,7 @@ public void listClassIDs(string gameconnection){ } /// /// ) +/// /// public bool LoadDatablocksFromFile(string gameconnection, uint crc){ @@ -8893,7 +12738,20 @@ public bool LoadDatablocksFromFile(string gameconnection, uint crc){ return m_ts.fnGameConnection_LoadDatablocksFromFile(gameconnection, crc); } /// -/// @brief Used on the server to play a 2D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @tsexample function ServerPlay2D(%profile) { // Play the given sound profile on every client. // The sounds will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play2D(%profile); } @endtsexample) +/// @brief Used on the server to play a 2D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// +/// @tsexample +/// function ServerPlay2D(%profile) +/// { +/// // Play the given sound profile on every client. +/// // The sounds will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play2D(%profile); +/// } +/// @endtsexample) +/// /// public bool play2D(string gameconnection, string profile){ @@ -8901,7 +12759,21 @@ public bool play2D(string gameconnection, string profile){ return m_ts.fnGameConnection_play2D(gameconnection, profile); } /// -/// @brief Used on the server to play a 3D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". @tsexample function ServerPlay3D(%profile,%transform) { // Play the given sound profile at the given position on every client // The sound will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play3D(%profile,%transform); } @endtsexample) +/// @brief Used on the server to play a 3D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". +/// +/// @tsexample +/// function ServerPlay3D(%profile,%transform) +/// { +/// // Play the given sound profile at the given position on every client +/// // The sound will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play3D(%profile,%transform); +/// } +/// @endtsexample) +/// /// public bool play3D(string gameconnection, string profile, TransformF location){ @@ -8909,7 +12781,19 @@ public bool play3D(string gameconnection, string profile, TransformF location){ return m_ts.fnGameConnection_play3D(gameconnection, profile, location.AsString()); } /// -/// @brief On the client, play back a previously recorded game session. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @returns True if the playback was successful. False if there was an issue, such as not being able to open the demo file for playback. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief On the client, play back a previously recorded game session. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @returns True if the playback was successful. False if there was an issue, such as +/// not being able to open the demo file for playback. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool playDemo(string gameconnection, string demoFileName){ @@ -8917,7 +12801,27 @@ public bool playDemo(string gameconnection, string demoFileName){ return m_ts.fnGameConnection_playDemo(gameconnection, demoFileName); } /// -/// @brief On the server, resets the connection to indicate that ghosting has been disabled. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that ghosts are no longer being transmitted. On the client end, all ghost information will be deleted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, resets the connection to indicate that ghosting has been disabled. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that ghosts are no longer being transmitted. On the client end, all ghost +/// information will be deleted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void resetGhosting(string gameconnection){ @@ -8925,7 +12829,11 @@ public void resetGhosting(string gameconnection){ m_ts.fnGameConnection_resetGhosting(gameconnection); } /// -/// @brief On the server, sets the client's 3D display to fade to black. @param doFade Set to true to fade to black, and false to fade from black. @param timeMS Time it takes to perform the fade as measured in ms. @note Not currently hooked up, and is not synchronized over the network.) +/// @brief On the server, sets the client's 3D display to fade to black. +/// @param doFade Set to true to fade to black, and false to fade from black. +/// @param timeMS Time it takes to perform the fade as measured in ms. +/// @note Not currently hooked up, and is not synchronized over the network.) +/// /// public void setBlackOut(string gameconnection, bool doFade, int timeMS){ @@ -8933,7 +12841,11 @@ public void setBlackOut(string gameconnection, bool doFade, int timeMS){ m_ts.fnGameConnection_setBlackOut(gameconnection, doFade, timeMS); } /// -/// @brief On the server, set the connection's camera object used when not viewing through the control object. @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// @brief On the server, set the connection's camera object used when not viewing +/// through the control object. +/// +/// @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// /// public bool setCameraObject(string gameconnection, string camera){ @@ -8941,7 +12853,14 @@ public bool setCameraObject(string gameconnection, string camera){ return m_ts.fnGameConnection_setCameraObject(gameconnection, camera); } /// -/// (GameConnection, setConnectArgs, void, 3, 17, (const char* args) @brief On the client, pass along a variable set of parameters to the server. Once the connection is established with the server, the server calls its onConnect() method with the client's passed in parameters as aruments. @see GameConnection::onConnect()) +/// (GameConnection, setConnectArgs, void, 3, 17, +/// (const char* args) @brief On the client, pass along a variable set of parameters to the server. +/// +/// Once the connection is established with the server, the server calls its onConnect() method +/// with the client's passed in parameters as aruments. +/// +/// @see GameConnection::onConnect()) +/// /// public void setConnectArgs(string gameconnection, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= ""){ @@ -8949,7 +12868,12 @@ public void setConnectArgs(string gameconnection, string a2= "", string a3= "", m_ts.fnGameConnection_setConnectArgs(gameconnection, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16); } /// -/// @brief On the server, sets the control object's camera's field of view. @param newFOV New field of view (in degrees) to force the control object's camera to use. This value is clamped to be within the range of 1 to 179 degrees. @note When transmitted over the network to the client, the resolution is limited to one degree. Any fraction is dropped.) +/// @brief On the server, sets the control object's camera's field of view. +/// @param newFOV New field of view (in degrees) to force the control object's camera to use. This value +/// is clamped to be within the range of 1 to 179 degrees. +/// @note When transmitted over the network to the client, the resolution is limited to +/// one degree. Any fraction is dropped.) +/// /// public void setControlCameraFov(string gameconnection, float newFOV){ @@ -8957,7 +12881,12 @@ public void setControlCameraFov(string gameconnection, float newFOV){ m_ts.fnGameConnection_setControlCameraFov(gameconnection, newFOV); } /// -/// @brief On the server, sets the object that the client will control. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @param ctrlObj The GameBase object on the server to control.) +/// @brief On the server, sets the object that the client will control. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @param ctrlObj The GameBase object on the server to control.) +/// /// public bool setControlObject(string gameconnection, string ctrlObj){ @@ -8965,7 +12894,11 @@ public bool setControlObject(string gameconnection, string ctrlObj){ return m_ts.fnGameConnection_setControlObject(gameconnection, ctrlObj); } /// -/// @brief Set the control scheme that may be used by a connection's control object. @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// @brief Set the control scheme that may be used by a connection's control object. +/// +/// @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. +/// @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// /// public void setControlSchemeParameters(string gameconnection, bool absoluteRotation, bool addYawToAbsRot, bool addPitchToAbsRot){ @@ -8973,7 +12906,10 @@ public void setControlSchemeParameters(string gameconnection, bool absoluteRota m_ts.fnGameConnection_setControlSchemeParameters(gameconnection, absoluteRotation, addYawToAbsRot, addPitchToAbsRot); } /// -/// @brief On the server, sets this connection into or out of first person mode. @param firstPerson Set to true to put the connection into first person mode.) +/// @brief On the server, sets this connection into or out of first person mode. +/// +/// @param firstPerson Set to true to put the connection into first person mode.) +/// /// public void setFirstPerson(string gameconnection, bool firstPerson){ @@ -8981,7 +12917,16 @@ public void setFirstPerson(string gameconnection, bool firstPerson){ m_ts.fnGameConnection_setFirstPerson(gameconnection, firstPerson); } /// -/// @brief On the client, set the password that will be passed to the server. On the server, this password is compared with what is stored in $pref::Server::Password. If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, if the passed in client password and the server password do not match, the CHR_PASSWORD error string is sent back to the client and the connection is immediately terminated. This password checking is performed quite early on in the connection request process so as to minimize the impact of multiple failed attempts -- also known as hacking.) +/// @brief On the client, set the password that will be passed to the server. +/// +/// On the server, this password is compared with what is stored in $pref::Server::Password. +/// If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, +/// if the passed in client password and the server password do not match, the CHR_PASSWORD +/// error string is sent back to the client and the connection is immediately terminated. +/// +/// This password checking is performed quite early on in the connection request process so as +/// to minimize the impact of multiple failed attempts -- also known as hacking.) +/// /// public void setJoinPassword(string gameconnection, string password){ @@ -8989,7 +12934,35 @@ public void setJoinPassword(string gameconnection, string password){ m_ts.fnGameConnection_setJoinPassword(gameconnection, password); } /// -/// @brief On the server, transmits the mission file's CRC value to the client. Typically, during the standard mission start phase 1, the mission file's CRC value on the server is send to the client. This allows the client to determine if the mission has changed since the last time it downloaded this mission and act appropriately, such as rebuilt cached lightmaps. @param CRC The mission file's CRC value on the server. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample) +/// @brief On the server, transmits the mission file's CRC value to the client. +/// +/// Typically, during the standard mission start phase 1, the mission file's CRC value +/// on the server is send to the client. This allows the client to determine if the mission +/// has changed since the last time it downloaded this mission and act appropriately, such as +/// rebuilt cached lightmaps. +/// +/// @param CRC The mission file's CRC value on the server. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample) +/// /// public void setMissionCRC(string gameconnection, int CRC){ @@ -8997,7 +12970,18 @@ public void setMissionCRC(string gameconnection, int CRC){ m_ts.fnGameConnection_setMissionCRC(gameconnection, CRC); } /// -/// @brief On the client, starts recording the network connection's traffic to a demo file. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @param fileName The file name to use for the demo recording. @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// @brief On the client, starts recording the network connection's traffic to a demo file. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @param fileName The file name to use for the demo recording. +/// +/// @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// /// public void startRecording(string gameconnection, string fileName){ @@ -9005,7 +12989,10 @@ public void startRecording(string gameconnection, string fileName){ m_ts.fnGameConnection_startRecording(gameconnection, fileName); } /// -/// @brief On the client, stops the recording of a connection's network traffic to a file. @see GameConnection::startRecording(), GameConnection::playDemo()) +/// @brief On the client, stops the recording of a connection's network traffic to a file. +/// +/// @see GameConnection::startRecording(), GameConnection::playDemo()) +/// /// public void stopRecording(string gameconnection){ @@ -9013,7 +13000,44 @@ public void stopRecording(string gameconnection){ m_ts.fnGameConnection_stopRecording(gameconnection); } /// -/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. SimDataBlocks, also known as just datablocks, need to be transmitted to the client prior to the client entering the game world. These represent the static data that most objects in the world reference. This is typically done during the standard mission start phase 1 when following Torque's example mission startup sequence. When the datablocks have all been transmitted, onDataBlocksDone() is called to move the mission start process to the next phase. @param sequence The sequence is common between the server and client and ensures that the client is acting on the most recent mission start process. If an errant network packet (one that was lost but has now been found) is received by the client with an incorrect sequence, it is just ignored. This sequence number is updated on the server every time a mission is loaded. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample @see GameConnection::onDataBlocksDone()) +/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. +/// +/// SimDataBlocks, also known as just datablocks, need to be transmitted to the client +/// prior to the client entering the game world. These represent the static data that +/// most objects in the world reference. This is typically done during the standard +/// mission start phase 1 when following Torque's example mission startup sequence. +/// +/// When the datablocks have all been transmitted, onDataBlocksDone() is called to move +/// the mission start process to the next phase. +/// +/// @param sequence The sequence is common between the server and client and ensures +/// that the client is acting on the most recent mission start process. If an errant +/// network packet (one that was lost but has now been found) is received by the client +/// with an incorrect sequence, it is just ignored. This sequence number is updated on +/// the server every time a mission is loaded. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample +/// +/// @see GameConnection::onDataBlocksDone()) +/// /// public void transmitDataBlocks(string gameconnection, int sequence){ @@ -9026,14 +13050,12 @@ public void transmitDataBlocks(string gameconnection, int sequence){ /// public class GroundPlaneObject { -private Omni m_ts; - /// - /// - /// - /// -public GroundPlaneObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields to client objects. +/// ) +/// /// public void postApply(string groundplane){ @@ -9046,14 +13068,9 @@ public void postApply(string groundplane){ /// public class GuiAutoCompleteCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiAutoCompleteCtrlObject(ref Omni ts){m_ts = ts;} /// /// ( GuiAutoCompleteCtrl, add, void, 3, 5, (string name, int idNum, int scheme=0)) +/// /// public void add(string guiautocompletectrl, string a2= "", string a3= "", string a4= ""){ @@ -9062,6 +13079,7 @@ public void add(string guiautocompletectrl, string a2= "", string a3= "", strin } /// /// ( GuiAutoCompleteCtrl, addScheme, void, 6, 6, (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void addScheme(string guiautocompletectrl, string a2, string a3, string a4, string a5= ""){ @@ -9070,6 +13088,7 @@ public void addScheme(string guiautocompletectrl, string a2, string a3, string } /// /// ( GuiAutoCompleteCtrl, changeTextById, void, 4, 4, ( int id, string text ) ) +/// /// public void changeTextById(string guiautocompletectrl, string a2, string a3= ""){ @@ -9078,6 +13097,7 @@ public void changeTextById(string guiautocompletectrl, string a2, string a3= "" } /// /// ( GuiAutoCompleteCtrl, clear, void, 2, 2, Clear the popup list.) +/// /// public void clear(string guiautocompletectrl= ""){ @@ -9086,6 +13106,7 @@ public void clear(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, clearEntry, void, 3, 3, (S32 entry)) +/// /// public void clearEntry(string guiautocompletectrl, string a2= ""){ @@ -9093,7 +13114,9 @@ public void clearEntry(string guiautocompletectrl, string a2= ""){ m_ts.fnGuiAutoCompleteCtrl_clearEntry(guiautocompletectrl, a2); } /// -/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) Returns the position of the first entry containing the specified text.) +/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int findText(string guiautocompletectrl, string a2= ""){ @@ -9102,6 +13125,7 @@ public int findText(string guiautocompletectrl, string a2= ""){ } /// /// ( GuiAutoCompleteCtrl, forceClose, void, 2, 2, ) +/// /// public void forceClose(string guiautocompletectrl= ""){ @@ -9110,6 +13134,7 @@ public void forceClose(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, forceOnAction, void, 2, 2, ) +/// /// public void forceOnAction(string guiautocompletectrl= ""){ @@ -9118,6 +13143,7 @@ public void forceOnAction(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, getSelected, S32, 2, 2, ) +/// /// public int getSelected(string guiautocompletectrl= ""){ @@ -9126,6 +13152,7 @@ public int getSelected(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, getText, void, 2, 2, ) +/// /// public void getText(string guiautocompletectrl= ""){ @@ -9134,6 +13161,7 @@ public void getText(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, getTextById, const char*, 3, 3, (int id)) +/// /// public string getTextById(string guiautocompletectrl, string a2= ""){ @@ -9142,6 +13170,7 @@ public string getTextById(string guiautocompletectrl, string a2= ""){ } /// /// ( GuiAutoCompleteCtrl, replaceText, void, 3, 3, (bool doReplaceText)) +/// /// public void replaceText(string guiautocompletectrl, string a2= ""){ @@ -9149,7 +13178,11 @@ public void replaceText(string guiautocompletectrl, string a2= ""){ m_ts.fnGuiAutoCompleteCtrl_replaceText(guiautocompletectrl, a2); } /// -/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void setEnumContent(string guiautocompletectrl, string a2, string a3= ""){ @@ -9158,6 +13191,7 @@ public void setEnumContent(string guiautocompletectrl, string a2, string a3= "" } /// /// ( GuiAutoCompleteCtrl, setFirstSelected, void, 2, 3, ([scriptCallback=true])) +/// /// public void setFirstSelected(string guiautocompletectrl= "", string a2= ""){ @@ -9166,6 +13200,7 @@ public void setFirstSelected(string guiautocompletectrl= "", string a2= ""){ } /// /// ( GuiAutoCompleteCtrl, setNoneSelected, void, 2, 2, ) +/// /// public void setNoneSelected(string guiautocompletectrl= ""){ @@ -9174,6 +13209,7 @@ public void setNoneSelected(string guiautocompletectrl= ""){ } /// /// ( GuiAutoCompleteCtrl, setSelected, void, 3, 4, (int id, [scriptCallback=true])) +/// /// public void setSelected(string guiautocompletectrl, string a2= "", string a3= ""){ @@ -9182,6 +13218,7 @@ public void setSelected(string guiautocompletectrl, string a2= "", string a3= " } /// /// ( GuiAutoCompleteCtrl, size, S32, 2, 2, Get the size of the menu - the number of entries in it.) +/// /// public int size(string guiautocompletectrl= ""){ @@ -9190,6 +13227,7 @@ public int size(string guiautocompletectrl= ""){ } /// /// (GuiAutoCompleteCtrl, sort, void, 2, 2, Sort the list alphabetically.) +/// /// public void sort(string guiautocompletectrl= ""){ @@ -9198,6 +13236,7 @@ public void sort(string guiautocompletectrl= ""){ } /// /// (GuiAutoCompleteCtrl, sortID, void, 2, 2, Sort the list by ID.) +/// /// public void sortID(string guiautocompletectrl= ""){ @@ -9210,14 +13249,9 @@ public void sortID(string guiautocompletectrl= ""){ /// public class GuiAutoScrollCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiAutoScrollCtrlObject(ref Omni ts){m_ts = ts;} /// /// Reset scrolling. ) +/// /// public void reset(string guiautoscrollctrl){ @@ -9230,14 +13264,10 @@ public void reset(string guiautoscrollctrl){ /// public class GuiBitmapButtonCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiBitmapButtonCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Set the bitmap to show on the button. @param path Path to the texture file in any of the supported formats. ) +/// Set the bitmap to show on the button. +/// @param path Path to the texture file in any of the supported formats. ) +/// /// public void setBitmap(string guibitmapbuttonctrl, string path){ @@ -9250,14 +13280,10 @@ public void setBitmap(string guibitmapbuttonctrl, string path){ /// public class GuiBitmapCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiBitmapCtrlObject(ref Omni ts){m_ts = ts;} /// -/// ( String filename | String filename, bool resize ) Assign an image to the control. @hide ) +/// ( String filename | String filename, bool resize ) Assign an image to the control. +/// @hide ) +/// /// public void GuiBitmapCtrl_setBitmap(string guibitmapctrl, string fileRoot, bool resize = false){ @@ -9265,7 +13291,10 @@ public void GuiBitmapCtrl_setBitmap(string guibitmapctrl, string fileRoot, bool m_ts.fn_GuiBitmapCtrl_setBitmap(guibitmapctrl, fileRoot, resize); } /// -/// Set the offset of the bitmap within the control. @param x The x-axis offset of the image. @param y The y-axis offset of the image.) +/// Set the offset of the bitmap within the control. +/// @param x The x-axis offset of the image. +/// @param y The y-axis offset of the image.) +/// /// public void setValue(string guibitmapctrl, int x, int y){ @@ -9278,14 +13307,10 @@ public void setValue(string guibitmapctrl, int x, int y){ /// public class GuiButtonBaseCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiButtonBaseCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the text display on the button's label (if any). @return The button's label. ) +/// Get the text display on the button's label (if any). +/// @return The button's label. ) +/// /// public string getText(string guibuttonbasectrl){ @@ -9293,7 +13318,10 @@ public string getText(string guibuttonbasectrl){ return m_ts.fnGuiButtonBaseCtrl_getText(guibuttonbasectrl); } /// -/// Simulate a click on the button. This method will trigger the button's action just as if the button had been pressed by the user. ) +/// Simulate a click on the button. +/// This method will trigger the button's action just as if the button had been pressed by the +/// user. ) +/// /// public void performClick(string guibuttonbasectrl){ @@ -9301,7 +13329,9 @@ public void performClick(string guibuttonbasectrl){ m_ts.fnGuiButtonBaseCtrl_performClick(guibuttonbasectrl); } /// -/// Reset the mousing state of the button. This method should not generally be called. ) +/// Reset the mousing state of the button. +/// This method should not generally be called. ) +/// /// public void resetState(string guibuttonbasectrl){ @@ -9309,7 +13339,12 @@ public void resetState(string guibuttonbasectrl){ m_ts.fnGuiButtonBaseCtrl_resetState(guibuttonbasectrl); } /// -/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, toggling a button on will toggle all other radio buttons in its group to off. @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the button. To do that, use performClick(). ) +/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, +/// toggling a button on will toggle all other radio buttons in its group to off. +/// @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. +/// @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the +/// button. To do that, use performClick(). ) +/// /// public void setStateOn(string guibuttonbasectrl, bool isOn = true){ @@ -9317,7 +13352,12 @@ public void setStateOn(string guibuttonbasectrl, bool isOn = true){ m_ts.fnGuiButtonBaseCtrl_setStateOn(guibuttonbasectrl, isOn); } /// -/// Set the text displayed on the button's label. @param text The text to display as the button's text label. @note Not all buttons render text labels. @see getText @see setTextID ) +/// Set the text displayed on the button's label. +/// @param text The text to display as the button's text label. +/// @note Not all buttons render text labels. +/// @see getText +/// @see setTextID ) +/// /// public void setText(string guibuttonbasectrl, string text){ @@ -9325,7 +13365,17 @@ public void setText(string guibuttonbasectrl, string text){ m_ts.fnGuiButtonBaseCtrl_setText(guibuttonbasectrl, text); } /// -/// Set the text displayed on the button's label using a string from the string table assigned to the control. @param id Name of the variable that contains the integer string ID. Used to look up string in table. @note Not all buttons render text labels. @see setText @see getText @see GuiControl::langTableMod @see LangTable @ref Gui_i18n ) +/// Set the text displayed on the button's label using a string from the string table +/// assigned to the control. +/// @param id Name of the variable that contains the integer string ID. Used to look up +/// string in table. +/// @note Not all buttons render text labels. +/// @see setText +/// @see getText +/// @see GuiControl::langTableMod +/// @see LangTable +/// @ref Gui_i18n ) +/// /// public void setTextID(string guibuttonbasectrl, string id){ @@ -9338,14 +13388,9 @@ public void setTextID(string guibuttonbasectrl, string id){ /// public class GuiCanvasObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiCanvasObject(ref Omni ts){m_ts = ts;} /// /// () - Is this canvas currently fullscreen? ) +/// /// public bool GuiCanvas_isFullscreen(string guicanvas){ @@ -9354,6 +13399,7 @@ public bool GuiCanvas_isFullscreen(string guicanvas){ } /// /// () ) +/// /// public bool GuiCanvas_isMaximized(string guicanvas){ @@ -9362,6 +13408,7 @@ public bool GuiCanvas_isMaximized(string guicanvas){ } /// /// () ) +/// /// public bool GuiCanvas_isMinimized(string guicanvas){ @@ -9370,6 +13417,7 @@ public bool GuiCanvas_isMinimized(string guicanvas){ } /// /// () - maximize this canvas' window. ) +/// /// public void GuiCanvas_maximizeWindow(string guicanvas){ @@ -9378,6 +13426,7 @@ public void GuiCanvas_maximizeWindow(string guicanvas){ } /// /// () - minimize this canvas' window. ) +/// /// public void GuiCanvas_minimizeWindow(string guicanvas){ @@ -9385,7 +13434,9 @@ public void GuiCanvas_minimizeWindow(string guicanvas){ m_ts.fn_GuiCanvas_minimizeWindow(guicanvas); } /// -/// (GuiControl ctrl=NULL) @hide) +/// (GuiControl ctrl=NULL) +/// @hide) +/// /// public void GuiCanvas_popDialog(string guicanvas, string gui){ @@ -9393,7 +13444,9 @@ public void GuiCanvas_popDialog(string guicanvas, string gui){ m_ts.fn_GuiCanvas_popDialog(guicanvas, gui); } /// -/// (int layer) @hide) +/// (int layer) +/// @hide) +/// /// public void GuiCanvas_popLayer(string guicanvas, int layer = 0){ @@ -9401,7 +13454,9 @@ public void GuiCanvas_popLayer(string guicanvas, int layer = 0){ m_ts.fn_GuiCanvas_popLayer(guicanvas, layer); } /// -/// (GuiControl ctrl, int layer=0, bool center=false) @hide) +/// (GuiControl ctrl, int layer=0, bool center=false) +/// @hide) +/// /// public void GuiCanvas_pushDialog(string guicanvas, string ctrlName, int layer = 0, bool center = false){ @@ -9410,6 +13465,7 @@ public void GuiCanvas_pushDialog(string guicanvas, string ctrlName, int layer = } /// /// () - restore this canvas' window. ) +/// /// public void GuiCanvas_restoreWindow(string guicanvas){ @@ -9417,7 +13473,9 @@ public void GuiCanvas_restoreWindow(string guicanvas){ m_ts.fn_GuiCanvas_restoreWindow(guicanvas); } /// -/// (Point2I pos) @hide) +/// (Point2I pos) +/// @hide) +/// /// public void GuiCanvas_setCursorPos(string guicanvas, Point2I pos){ @@ -9426,6 +13484,7 @@ public void GuiCanvas_setCursorPos(string guicanvas, Point2I pos){ } /// /// () - Claim OS input focus for this canvas' window.) +/// /// public void GuiCanvas_setFocus(string guicanvas){ @@ -9433,7 +13492,15 @@ public void GuiCanvas_setFocus(string guicanvas){ m_ts.fn_GuiCanvas_setFocus(guicanvas); } /// -/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. \\param width The screen width to set. \\param height The screen height to set. \\param fullscreen Specify true to run fullscreen or false to run in a window \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) +/// Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. +/// \\param width The screen width to set. +/// \\param height The screen height to set. +/// \\param fullscreen Specify true to run fullscreen or false to run in a window +/// \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. +/// \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window +/// \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// /// public void GuiCanvas_setVideoMode(string guicanvas, uint width, uint height, bool fullscreen = false, uint bitDepth = 0, uint refreshRate = 0, uint antialiasLevel = 0){ @@ -9441,7 +13508,10 @@ public void GuiCanvas_setVideoMode(string guicanvas, uint width, uint height, b m_ts.fn_GuiCanvas_setVideoMode(guicanvas, width, height, fullscreen, bitDepth, refreshRate, antialiasLevel); } /// -/// Translate a coordinate from canvas window-space to screen-space. @param coordinate The coordinate in window-space. @return The given coordinate translated to screen-space. ) +/// Translate a coordinate from canvas window-space to screen-space. +/// @param coordinate The coordinate in window-space. +/// @return The given coordinate translated to screen-space. ) +/// /// public Point2I clientToScreen(string guicanvas, Point2I coordinate){ @@ -9449,7 +13519,11 @@ public Point2I clientToScreen(string guicanvas, Point2I coordinate){ return new Point2I ( m_ts.fnGuiCanvas_clientToScreen(guicanvas, coordinate.AsString())); } /// -/// @brief Turns on the mouse off. @tsexample Canvas.cursorOff(); @endtsexample) +/// @brief Turns on the mouse off. +/// @tsexample +/// Canvas.cursorOff(); +/// @endtsexample) +/// /// public void cursorOff(string guicanvas){ @@ -9457,7 +13531,11 @@ public void cursorOff(string guicanvas){ m_ts.fnGuiCanvas_cursorOff(guicanvas); } /// -/// @brief Turns on the mouse cursor. @tsexample Canvas.cursorOn(); @endtsexample) +/// @brief Turns on the mouse cursor. +/// @tsexample +/// Canvas.cursorOn(); +/// @endtsexample) +/// /// public void cursorOn(string guicanvas){ @@ -9465,7 +13543,11 @@ public void cursorOn(string guicanvas){ m_ts.fnGuiCanvas_cursorOn(guicanvas); } /// -/// @brief Find the first monitor index that matches the given name. The actual match algorithm depends on the implementation. @param name The name to search for. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Find the first monitor index that matches the given name. +/// The actual match algorithm depends on the implementation. +/// @param name The name to search for. +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int findFirstMatchingMonitor(string guicanvas, string name){ @@ -9473,7 +13555,14 @@ public int findFirstMatchingMonitor(string guicanvas, string name){ return m_ts.fnGuiCanvas_findFirstMatchingMonitor(guicanvas, name); } /// -/// @brief Get the GuiControl which is being used as the content. @tsexample Canvas.getContent(); @endtsexample @return ID of current content control) +/// @brief Get the GuiControl which is being used as the content. +/// +/// @tsexample +/// Canvas.getContent(); +/// @endtsexample +/// +/// @return ID of current content control) +/// /// public int getContent(string guicanvas){ @@ -9481,7 +13570,13 @@ public int getContent(string guicanvas){ return m_ts.fnGuiCanvas_getContent(guicanvas); } /// -/// @brief Get the current position of the cursor. @param param Description @tsexample %cursorPos = Canvas.getCursorPos(); @endtsexample @return Screen coordinates of mouse cursor, in format \"X Y\") +/// @brief Get the current position of the cursor. +/// @param param Description +/// @tsexample +/// %cursorPos = Canvas.getCursorPos(); +/// @endtsexample +/// @return Screen coordinates of mouse cursor, in format \"X Y\") +/// /// public Point2I getCursorPos(string guicanvas){ @@ -9489,7 +13584,14 @@ public Point2I getCursorPos(string guicanvas){ return new Point2I ( m_ts.fnGuiCanvas_getCursorPos(guicanvas)); } /// -/// @brief Returns the dimensions of the canvas @tsexample %extent = Canvas.getExtent(); @endtsexample @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// @brief Returns the dimensions of the canvas +/// +/// @tsexample +/// %extent = Canvas.getExtent(); +/// @endtsexample +/// +/// @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// /// public Point2I getExtent(string guicanvas){ @@ -9497,7 +13599,11 @@ public Point2I getExtent(string guicanvas){ return new Point2I ( m_ts.fnGuiCanvas_getExtent(guicanvas)); } /// -/// @brief Gets information on the specified mode of this device. @param modeId Index of the mode to get data from. @return A video mode string given an adapter and mode index. @see GuiCanvas::getVideoMode()) +/// @brief Gets information on the specified mode of this device. +/// @param modeId Index of the mode to get data from. +/// @return A video mode string given an adapter and mode index. +/// @see GuiCanvas::getVideoMode()) +/// /// public string getMode(string guicanvas, int modeId){ @@ -9505,7 +13611,16 @@ public string getMode(string guicanvas, int modeId){ return m_ts.fnGuiCanvas_getMode(guicanvas, modeId); } /// -/// @brief Gets the number of modes available on this device. @param param Description @tsexample %modeCount = Canvas.getModeCount() @endtsexample @return The number of video modes supported by the device) +/// @brief Gets the number of modes available on this device. +/// +/// @param param Description +/// +/// @tsexample +/// %modeCount = Canvas.getModeCount() +/// @endtsexample +/// +/// @return The number of video modes supported by the device) +/// /// public int getModeCount(string guicanvas){ @@ -9513,7 +13628,10 @@ public int getModeCount(string guicanvas){ return m_ts.fnGuiCanvas_getModeCount(guicanvas); } /// -/// @brief Gets the number of monitors attached to the system. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Gets the number of monitors attached to the system. +/// +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int getMonitorCount(string guicanvas){ @@ -9521,7 +13639,10 @@ public int getMonitorCount(string guicanvas){ return m_ts.fnGuiCanvas_getMonitorCount(guicanvas); } /// -/// @brief Gets the name of the requested monitor. @param index The monitor index. @return The name of the requested monitor.) +/// @brief Gets the name of the requested monitor. +/// @param index The monitor index. +/// @return The name of the requested monitor.) +/// /// public string getMonitorName(string guicanvas, int index){ @@ -9529,7 +13650,10 @@ public string getMonitorName(string guicanvas, int index){ return m_ts.fnGuiCanvas_getMonitorName(guicanvas, index); } /// -/// @brief Gets the region of the requested monitor. @param index The monitor index. @return The rectangular region of the requested monitor.) +/// @brief Gets the region of the requested monitor. +/// @param index The monitor index. +/// @return The rectangular region of the requested monitor.) +/// /// public RectI getMonitorRect(string guicanvas, int index){ @@ -9537,7 +13661,13 @@ public RectI getMonitorRect(string guicanvas, int index){ return new RectI ( m_ts.fnGuiCanvas_getMonitorRect(guicanvas, index)); } /// -/// @brief Gets the gui control under the mouse. @tsexample %underMouse = Canvas.getMouseControl(); @endtsexample @return ID of the gui control, if one was found. NULL otherwise) +/// @brief Gets the gui control under the mouse. +/// @tsexample +/// %underMouse = Canvas.getMouseControl(); +/// @endtsexample +/// +/// @return ID of the gui control, if one was found. NULL otherwise) +/// /// public int getMouseControl(string guicanvas){ @@ -9545,7 +13675,21 @@ public int getMouseControl(string guicanvas){ return m_ts.fnGuiCanvas_getMouseControl(guicanvas); } /// -/// @brief Gets the current screen mode as a string. The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). You will need to parse out each one for individual use. @tsexample %screenWidth = getWord(Canvas.getVideoMode(), 0); %screenHeight = getWord(Canvas.getVideoMode(), 1); %isFullscreen = getWord(Canvas.getVideoMode(), 2); %bitdepth = getWord(Canvas.getVideoMode(), 3); %refreshRate = getWord(Canvas.getVideoMode(), 4); @endtsexample @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// @brief Gets the current screen mode as a string. +/// +/// The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). +/// You will need to parse out each one for individual use. +/// +/// @tsexample +/// %screenWidth = getWord(Canvas.getVideoMode(), 0); +/// %screenHeight = getWord(Canvas.getVideoMode(), 1); +/// %isFullscreen = getWord(Canvas.getVideoMode(), 2); +/// %bitdepth = getWord(Canvas.getVideoMode(), 3); +/// %refreshRate = getWord(Canvas.getVideoMode(), 4); +/// @endtsexample +/// +/// @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// /// public string getVideoMode(string guicanvas){ @@ -9553,7 +13697,9 @@ public string getVideoMode(string guicanvas){ return m_ts.fnGuiCanvas_getVideoMode(guicanvas); } /// -/// Get the current position of the platform window associated with the canvas. @return The window position of the canvas in screen-space. ) +/// Get the current position of the platform window associated with the canvas. +/// @return The window position of the canvas in screen-space. ) +/// /// public Point2I getWindowPosition(string guicanvas){ @@ -9561,7 +13707,12 @@ public Point2I getWindowPosition(string guicanvas){ return new Point2I ( m_ts.fnGuiCanvas_getWindowPosition(guicanvas)); } /// -/// @brief Disable rendering of the cursor. @tsexample Canvas.hideCursor(); @endtsexample) +/// @brief Disable rendering of the cursor. +/// +/// @tsexample +/// Canvas.hideCursor(); +/// @endtsexample) +/// /// public void hideCursor(string guicanvas){ @@ -9569,7 +13720,24 @@ public void hideCursor(string guicanvas){ m_ts.fnGuiCanvas_hideCursor(guicanvas); } /// -/// @brief Determines if mouse cursor is enabled. @tsexample // Is cursor on? if(Canvas.isCursorOn()) echo(\"Canvas cursor is on\"); @endtsexample @return Returns true if the cursor is on.) +/// ( GuiCanvas, hideWindow, void, 2, 2, ) +/// +/// +public void hideWindow(string guicanvas= ""){ + + +m_ts.fnGuiCanvas_hideWindow(guicanvas); +} +/// +/// @brief Determines if mouse cursor is enabled. +/// +/// @tsexample +/// // Is cursor on? +/// if(Canvas.isCursorOn()) +/// echo(\"Canvas cursor is on\"); +/// @endtsexample +/// @return Returns true if the cursor is on.) +/// /// public bool isCursorOn(string guicanvas){ @@ -9577,7 +13745,15 @@ public bool isCursorOn(string guicanvas){ return m_ts.fnGuiCanvas_isCursorOn(guicanvas); } /// -/// @brief Determines if mouse cursor is rendering. @tsexample // Is cursor rendering? if(Canvas.isCursorShown()) echo(\"Canvas cursor is rendering\"); @endtsexample @return Returns true if the cursor is rendering.) +/// @brief Determines if mouse cursor is rendering. +/// +/// @tsexample +/// // Is cursor rendering? +/// if(Canvas.isCursorShown()) +/// echo(\"Canvas cursor is rendering\"); +/// @endtsexample +/// @return Returns true if the cursor is rendering.) +/// /// public bool isCursorShown(string guicanvas){ @@ -9585,7 +13761,14 @@ public bool isCursorShown(string guicanvas){ return m_ts.fnGuiCanvas_isCursorShown(guicanvas); } /// -/// @brief This turns on/off front-buffer rendering. @param enable True if all rendering should be done to the front buffer @tsexample Canvas.renderFront(false); @endtsexample) +/// @brief This turns on/off front-buffer rendering. +/// +/// @param enable True if all rendering should be done to the front buffer +/// +/// @tsexample +/// Canvas.renderFront(false); +/// @endtsexample) +/// /// public void renderFront(string guicanvas, bool enable){ @@ -9593,7 +13776,15 @@ public void renderFront(string guicanvas, bool enable){ m_ts.fnGuiCanvas_renderFront(guicanvas, enable); } /// -/// @brief Force canvas to redraw. If the elapsed time is greater than the time since the last paint then the repaint will be skipped. @param elapsedMS The optional elapsed time in milliseconds. @tsexample Canvas.repaint(); @endtsexample) +/// @brief Force canvas to redraw. +/// If the elapsed time is greater than the time since the last paint +/// then the repaint will be skipped. +/// @param elapsedMS The optional elapsed time in milliseconds. +/// +/// @tsexample +/// Canvas.repaint(); +/// @endtsexample) +/// /// public void repaint(string guicanvas, int elapsedMS = 0){ @@ -9601,7 +13792,12 @@ public void repaint(string guicanvas, int elapsedMS = 0){ m_ts.fnGuiCanvas_repaint(guicanvas, elapsedMS); } /// -/// @brief Reset the update regions for the canvas. @tsexample Canvas.reset(); @endtsexample) +/// @brief Reset the update regions for the canvas. +/// +/// @tsexample +/// Canvas.reset(); +/// @endtsexample) +/// /// public void reset(string guicanvas){ @@ -9609,7 +13805,10 @@ public void reset(string guicanvas){ m_ts.fnGuiCanvas_reset(guicanvas); } /// -/// Translate a coordinate from screen-space to canvas window-space. @param coordinate The coordinate in screen-space. @return The given coordinate translated to window-space. ) +/// Translate a coordinate from screen-space to canvas window-space. +/// @param coordinate The coordinate in screen-space. +/// @return The given coordinate translated to window-space. ) +/// /// public Point2I screenToClient(string guicanvas, Point2I coordinate){ @@ -9617,7 +13816,14 @@ public Point2I screenToClient(string guicanvas, Point2I coordinate){ return new Point2I ( m_ts.fnGuiCanvas_screenToClient(guicanvas, coordinate.AsString())); } /// -/// @brief Set the content of the canvas to a specified control. @param ctrl ID or name of GuiControl to set content to @tsexample Canvas.setContent(PlayGui); @endtsexample) +/// @brief Set the content of the canvas to a specified control. +/// +/// @param ctrl ID or name of GuiControl to set content to +/// +/// @tsexample +/// Canvas.setContent(PlayGui); +/// @endtsexample) +/// /// public void setContent(string guicanvas, string ctrl){ @@ -9625,7 +13831,14 @@ public void setContent(string guicanvas, string ctrl){ m_ts.fnGuiCanvas_setContent(guicanvas, ctrl); } /// -/// @brief Sets the cursor for the canvas. @param cursor Name of the GuiCursor to use @tsexample Canvas.setCursor(\"DefaultCursor\"); @endtsexample) +/// @brief Sets the cursor for the canvas. +/// +/// @param cursor Name of the GuiCursor to use +/// +/// @tsexample +/// Canvas.setCursor(\"DefaultCursor\"); +/// @endtsexample) +/// /// public void setCursor(string guicanvas, string cursor){ @@ -9634,6 +13847,7 @@ public void setCursor(string guicanvas, string cursor){ } /// /// (bool shown) - Enabled when a context menu/popup menu is shown.) +/// /// public void setPopupShown(string guicanvas, bool shown){ @@ -9641,7 +13855,9 @@ public void setPopupShown(string guicanvas, bool shown){ m_ts.fnGuiCanvas_setPopupShown(guicanvas, shown); } /// -/// Set the position of the platform window associated with the canvas. @param position The new position of the window in screen-space. ) +/// Set the position of the platform window associated with the canvas. +/// @param position The new position of the window in screen-space. ) +/// /// public void setWindowPosition(string guicanvas, Point2I position){ @@ -9649,7 +13865,14 @@ public void setWindowPosition(string guicanvas, Point2I position){ m_ts.fnGuiCanvas_setWindowPosition(guicanvas, position.AsString()); } /// -/// @brief Change the title of the OS window. @param newTitle String containing the new name @tsexample Canvas.setWindowTitle(\"Documentation Rocks!\"); @endtsexample) +/// @brief Change the title of the OS window. +/// +/// @param newTitle String containing the new name +/// +/// @tsexample +/// Canvas.setWindowTitle(\"Documentation Rocks!\"); +/// @endtsexample) +/// /// public void setWindowTitle(string guicanvas, string newTitle){ @@ -9657,7 +13880,12 @@ public void setWindowTitle(string guicanvas, string newTitle){ m_ts.fnGuiCanvas_setWindowTitle(guicanvas, newTitle); } /// -/// @brief Enable rendering of the cursor. @tsexample Canvas.showCursor(); @endtsexample) +/// @brief Enable rendering of the cursor. +/// +/// @tsexample +/// Canvas.showCursor(); +/// @endtsexample) +/// /// public void showCursor(string guicanvas){ @@ -9665,7 +13893,22 @@ public void showCursor(string guicanvas){ m_ts.fnGuiCanvas_showCursor(guicanvas); } /// -/// @brief toggle canvas from fullscreen to windowed mode or back. @tsexample // If we are in windowed mode, the following will put is in fullscreen Canvas.toggleFullscreen(); @endtsexample) +/// ( GuiCanvas, showWindow, void, 2, 2, ) +/// +/// +public void showWindow(string guicanvas= ""){ + + +m_ts.fnGuiCanvas_showWindow(guicanvas); +} +/// +/// @brief toggle canvas from fullscreen to windowed mode or back. +/// +/// @tsexample +/// // If we are in windowed mode, the following will put is in fullscreen +/// Canvas.toggleFullscreen(); +/// @endtsexample) +/// /// public void toggleFullscreen(string guicanvas){ @@ -9678,14 +13921,10 @@ public void toggleFullscreen(string guicanvas){ /// public class GuiCheckBoxCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiCheckBoxCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Test whether the checkbox is currently checked. @return True if the checkbox is currently ticked, false otherwise. ) +/// Test whether the checkbox is currently checked. +/// @return True if the checkbox is currently ticked, false otherwise. ) +/// /// public bool isStateOn(string guicheckboxctrl){ @@ -9693,7 +13932,11 @@ public bool isStateOn(string guicheckboxctrl){ return m_ts.fnGuiCheckBoxCtrl_isStateOn(guicheckboxctrl); } /// -/// Set whether the checkbox is ticked or not. @param newState If true the box will be checked, if false, it will be unchecked. @note This method will @b not trigger the command associated with the control. To toggle the checkbox state as if the user had clicked the control, use performClick(). ) +/// Set whether the checkbox is ticked or not. +/// @param newState If true the box will be checked, if false, it will be unchecked. +/// @note This method will @b not trigger the command associated with the control. To toggle the +/// checkbox state as if the user had clicked the control, use performClick(). ) +/// /// public void setStateOn(string guicheckboxctrl, bool newState){ @@ -9706,14 +13949,13 @@ public void setStateOn(string guicheckboxctrl, bool newState){ /// public class GuiChunkedBitmapCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiChunkedBitmapCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Set the image rendered in this control. @param filename The image name you want to set @tsexample ChunkedBitmap.setBitmap(\"images/background.png\"); @endtsexample) +/// @brief Set the image rendered in this control. +/// @param filename The image name you want to set +/// @tsexample +/// ChunkedBitmap.setBitmap(\"images/background.png\"); +/// @endtsexample) +/// /// public void setBitmap(string guichunkedbitmapctrl, string filename){ @@ -9726,14 +13968,15 @@ public void setBitmap(string guichunkedbitmapctrl, string filename){ /// public class GuiClockHudObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiClockHudObject(ref Omni ts){m_ts = ts;} /// -/// Returns the current time, in seconds. @return timeInseconds Current time, in seconds @tsexample // Get the current time from the GuiClockHud control %timeInSeconds = %guiClockHud.getTime(); @endtsexample ) +/// Returns the current time, in seconds. +/// @return timeInseconds Current time, in seconds +/// @tsexample +/// // Get the current time from the GuiClockHud control +/// %timeInSeconds = %guiClockHud.getTime(); +/// @endtsexample +/// ) +/// /// public float getTime(string guiclockhud){ @@ -9741,7 +13984,12 @@ public float getTime(string guiclockhud){ return m_ts.fnGuiClockHud_getTime(guiclockhud); } /// -/// @brief Sets a time for a countdown clock. Setting the time like this will cause the clock to count backwards from the specified time. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @see setTime ) +/// @brief Sets a time for a countdown clock. +/// Setting the time like this will cause the clock to count backwards from the specified time. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @see setTime +/// ) +/// /// public void setReverseTime(string guiclockhud, float timeInSeconds = 60){ @@ -9749,7 +13997,16 @@ public void setReverseTime(string guiclockhud, float timeInSeconds = 60){ m_ts.fnGuiClockHud_setReverseTime(guiclockhud, timeInSeconds); } /// -/// Sets the current base time for the clock. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @tsexample // Define the time, in seconds %timeInSeconds = 120; // Change the time on the GuiClockHud control %guiClockHud.setTime(%timeInSeconds); @endtsexample ) +/// Sets the current base time for the clock. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @tsexample +/// // Define the time, in seconds +/// %timeInSeconds = 120; +/// // Change the time on the GuiClockHud control +/// %guiClockHud.setTime(%timeInSeconds); +/// @endtsexample +/// ) +/// /// public void setTime(string guiclockhud, float timeInSeconds = 60){ @@ -9762,14 +14019,9 @@ public void setTime(string guiclockhud, float timeInSeconds = 60){ /// public class GuiColorPickerCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiColorPickerCtrlObject(ref Omni ts){m_ts = ts;} /// /// Gets the current position of the selector) +/// /// public Point2I GuiColorPickerCtrl_getSelectorPos(string guicolorpickerctrl){ @@ -9778,6 +14030,7 @@ public Point2I GuiColorPickerCtrl_getSelectorPos(string guicolorpickerctrl){ } /// /// Sets the current position of the selector) +/// /// public void GuiColorPickerCtrl_setSelectorPos(string guicolorpickerctrl, Point2I newPos){ @@ -9786,6 +14039,7 @@ public void GuiColorPickerCtrl_setSelectorPos(string guicolorpickerctrl, Point2 } /// /// Forces update of pick color) +/// /// public void GuiColorPickerCtrl_updateColor(string guicolorpickerctrl){ @@ -9798,14 +14052,9 @@ public void GuiColorPickerCtrl_updateColor(string guicolorpickerctrl){ /// public class GuiControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiControlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public RectI GuiControl_getBounds(string guicontrol){ @@ -9814,6 +14063,7 @@ public RectI GuiControl_getBounds(string guicontrol){ } /// /// ) +/// /// public string GuiControl_getValue(string guicontrol){ @@ -9822,6 +14072,7 @@ public string GuiControl_getValue(string guicontrol){ } /// /// ) +/// /// public bool GuiControl_isActive(string guicontrol){ @@ -9830,6 +14081,7 @@ public bool GuiControl_isActive(string guicontrol){ } /// /// (bool isFirst)) +/// /// public void GuiControl_makeFirstResponder(string guicontrol, bool isFirst){ @@ -9837,7 +14089,9 @@ public void GuiControl_makeFirstResponder(string guicontrol, bool isFirst){ m_ts.fn_GuiControl_makeFirstResponder(guicontrol, isFirst); } /// -/// Set the width and height of the control. @hide ) +/// Set the width and height of the control. +/// @hide ) +/// /// public void GuiControl_setExtent(string guicontrol, Point2F ext){ @@ -9845,7 +14099,13 @@ public void GuiControl_setExtent(string guicontrol, Point2F ext){ m_ts.fn_GuiControl_setExtent(guicontrol, ext.AsString()); } /// -/// Add the given control as a child to this control. This is synonymous to calling SimGroup::addObject. @param control The control to add as a child. @note The control will retain its current position and size. @see SimGroup::addObject @ref GuiControl_Hierarchy ) +/// Add the given control as a child to this control. +/// This is synonymous to calling SimGroup::addObject. +/// @param control The control to add as a child. +/// @note The control will retain its current position and size. +/// @see SimGroup::addObject +/// @ref GuiControl_Hierarchy ) +/// /// public void addGuiControl(string guicontrol, string control){ @@ -9854,6 +14114,7 @@ public void addGuiControl(string guicontrol, string control){ } /// /// Returns if the control's background color can be changed in the game or not. ) +/// /// public bool canChangeContextBackColor(string guicontrol){ @@ -9862,6 +14123,7 @@ public bool canChangeContextBackColor(string guicontrol){ } /// /// Returns if the control's fill color can be changed in the game or not. ) +/// /// public bool canChangeContextFillColor(string guicontrol){ @@ -9870,6 +14132,7 @@ public bool canChangeContextFillColor(string guicontrol){ } /// /// Returns if the control's font color can be changed in the game or not. ) +/// /// public bool canChangeContextFontColor(string guicontrol){ @@ -9878,6 +14141,7 @@ public bool canChangeContextFontColor(string guicontrol){ } /// /// Returns if the control's font size can be changed in the game or not. ) +/// /// public bool canChangeContextFontSize(string guicontrol){ @@ -9886,6 +14150,7 @@ public bool canChangeContextFontSize(string guicontrol){ } /// /// Returns if the control's window settings can be changed in the game or not. ) +/// /// public bool canShowContextWindowSettings(string guicontrol){ @@ -9893,7 +14158,9 @@ public bool canShowContextWindowSettings(string guicontrol){ return m_ts.fnGuiControl_canShowContextWindowSettings(guicontrol); } /// -/// Clear this control from being the first responder in its hierarchy chain. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Clear this control from being the first responder in its hierarchy chain. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void clearFirstResponder(string guicontrol, bool ignored = false){ @@ -9901,7 +14168,10 @@ public void clearFirstResponder(string guicontrol, bool ignored = false){ m_ts.fnGuiControl_clearFirstResponder(guicontrol, ignored); } /// -/// Test whether the given control is a direct or indirect child to this control. @param control The potential child control. @return True if the given control is a direct or indirect child to this control. ) +/// Test whether the given control is a direct or indirect child to this control. +/// @param control The potential child control. +/// @return True if the given control is a direct or indirect child to this control. ) +/// /// public bool controlIsChild(string guicontrol, string control){ @@ -9909,7 +14179,10 @@ public bool controlIsChild(string guicontrol, string control){ return m_ts.fnGuiControl_controlIsChild(guicontrol, control); } /// -/// Test whether the given control is a sibling of this control. @param control The potential sibling control. @return True if the given control is a sibling of this control. ) +/// Test whether the given control is a sibling of this control. +/// @param control The potential sibling control. +/// @return True if the given control is a sibling of this control. ) +/// /// public bool controlIsSibling(string guicontrol, string control){ @@ -9917,7 +14190,14 @@ public bool controlIsSibling(string guicontrol, string control){ return m_ts.fnGuiControl_controlIsSibling(guicontrol, control); } /// -/// Find the topmost child control located at the given coordinates. @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. @param x The X coordinate in the control's own coordinate space. @param y The Y coordinate in the control's own coordinate space. @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. @see GuiControlProfile::modal @see findHitControls ) +/// Find the topmost child control located at the given coordinates. +/// @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. +/// @param x The X coordinate in the control's own coordinate space. +/// @param y The Y coordinate in the control's own coordinate space. +/// @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. +/// @see GuiControlProfile::modal +/// @see findHitControls ) +/// /// public string findHitControl(string guicontrol, int x, int y){ @@ -9925,7 +14205,20 @@ public string findHitControl(string guicontrol, int x, int y){ return m_ts.fnGuiControl_findHitControl(guicontrol, x, y); } /// -/// Find all visible child controls that intersect with the given rectangle. @note Invisible child controls will not be included in the search. @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. @param width The width of the search rectangle in pixels. @param height The height of the search rectangle in pixels. @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. @tsexample // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) %ctrl.setLocked( true ); @endtsexample @see findHitControl ) +/// Find all visible child controls that intersect with the given rectangle. +/// @note Invisible child controls will not be included in the search. +/// @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param width The width of the search rectangle in pixels. +/// @param height The height of the search rectangle in pixels. +/// @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. +/// @tsexample +/// // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. +/// foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) +/// %ctrl.setLocked( true ); +/// @endtsexample +/// @see findHitControl ) +/// /// public string findHitControls(string guicontrol, int x, int y, int width, int height){ @@ -9934,6 +14227,7 @@ public string findHitControls(string guicontrol, int x, int y, int width, int h } /// /// Get the alpha fade time for the object. ) +/// /// public int getAlphaFadeTime(string guicontrol){ @@ -9942,6 +14236,7 @@ public int getAlphaFadeTime(string guicontrol){ } /// /// Get the alpha for the object. ) +/// /// public float getAlphaValue(string guicontrol){ @@ -9949,7 +14244,10 @@ public float getAlphaValue(string guicontrol){ return m_ts.fnGuiControl_getAlphaValue(guicontrol); } /// -/// Get the aspect ratio of the control's extents. @return The width of the control divided by its height. @see getExtent ) +/// Get the aspect ratio of the control's extents. +/// @return The width of the control divided by its height. +/// @see getExtent ) +/// /// public float getAspect(string guicontrol){ @@ -9957,7 +14255,9 @@ public float getAspect(string guicontrol){ return m_ts.fnGuiControl_getAspect(guicontrol); } /// -/// Get the coordinate of the control's center point relative to its parent. @return The coordinate of the control's center point in parent-relative coordinates. ) +/// Get the coordinate of the control's center point relative to its parent. +/// @return The coordinate of the control's center point in parent-relative coordinates. ) +/// /// public Point2I getCenter(string guicontrol){ @@ -9966,6 +14266,7 @@ public Point2I getCenter(string guicontrol){ } /// /// Sets the font size of a control. ) +/// /// public int getControlFontSize(string guicontrol){ @@ -9974,6 +14275,7 @@ public int getControlFontSize(string guicontrol){ } /// /// Returns if the control is locked or not. ) +/// /// public bool getControlLock(string guicontrol){ @@ -9982,6 +14284,7 @@ public bool getControlLock(string guicontrol){ } /// /// Returns the filename of the texture of the control. ) +/// /// public string getControlTextureFile(string guicontrol){ @@ -9989,7 +14292,9 @@ public string getControlTextureFile(string guicontrol){ return m_ts.fnGuiControl_getControlTextureFile(guicontrol); } /// -/// Get the width and height of the control. @return A point structure containing the width of the control in x and the height in y. ) +/// Get the width and height of the control. +/// @return A point structure containing the width of the control in x and the height in y. ) +/// /// public Point2I getExtent(string guicontrol){ @@ -9997,7 +14302,13 @@ public Point2I getExtent(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getExtent(guicontrol)); } /// -/// Get the first responder set on this GuiControl tree. @return The first responder set on the control's subtree. @see isFirstResponder @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Get the first responder set on this GuiControl tree. +/// @return The first responder set on the control's subtree. +/// @see isFirstResponder +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public string getFirstResponder(string guicontrol){ @@ -10005,7 +14316,9 @@ public string getFirstResponder(string guicontrol){ return m_ts.fnGuiControl_getFirstResponder(guicontrol); } /// -/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. @Return the center coordinate of the control in root-relative coordinates. ) +/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. +/// @Return the center coordinate of the control in root-relative coordinates. ) +/// /// public Point2I getGlobalCenter(string guicontrol){ @@ -10013,7 +14326,9 @@ public Point2I getGlobalCenter(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getGlobalCenter(guicontrol)); } /// -/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. @return The control's current position in root-relative coordinates. ) +/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @return The control's current position in root-relative coordinates. ) +/// /// public Point2I getGlobalPosition(string guicontrol){ @@ -10021,7 +14336,10 @@ public Point2I getGlobalPosition(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getGlobalPosition(guicontrol)); } /// -/// Get the maximum allowed size of the control. @return The maximum size to which the control can be shrunk. @see maxExtent ) +/// Get the maximum allowed size of the control. +/// @return The maximum size to which the control can be shrunk. +/// @see maxExtent ) +/// /// public Point2I getMaxExtent(string guicontrol){ @@ -10029,7 +14347,10 @@ public Point2I getMaxExtent(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getMaxExtent(guicontrol)); } /// -/// Get the minimum allowed size of the control. @return The minimum size to which the control can be shrunk. @see minExtent ) +/// Get the minimum allowed size of the control. +/// @return The minimum size to which the control can be shrunk. +/// @see minExtent ) +/// /// public Point2I getMinExtent(string guicontrol){ @@ -10038,6 +14359,7 @@ public Point2I getMinExtent(string guicontrol){ } /// /// Get the mouse over alpha for the object. ) +/// /// public float getMouseOverAlphaValue(string guicontrol){ @@ -10045,7 +14367,9 @@ public float getMouseOverAlphaValue(string guicontrol){ return m_ts.fnGuiControl_getMouseOverAlphaValue(guicontrol); } /// -/// Get the immediate parent control of the control. @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// Get the immediate parent control of the control. +/// @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// /// public string getParent(string guicontrol){ @@ -10053,7 +14377,9 @@ public string getParent(string guicontrol){ return m_ts.fnGuiControl_getParent(guicontrol); } /// -/// Get the control's current position relative to its parent. @return The coordinate of the control in its parent's coordinate space. ) +/// Get the control's current position relative to its parent. +/// @return The coordinate of the control in its parent's coordinate space. ) +/// /// public Point2I getPosition(string guicontrol){ @@ -10061,7 +14387,10 @@ public Point2I getPosition(string guicontrol){ return new Point2I ( m_ts.fnGuiControl_getPosition(guicontrol)); } /// -/// Get the canvas on which the control is placed. @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. @see GuiControl_Hierarchy ) +/// Get the canvas on which the control is placed. +/// @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. +/// @see GuiControl_Hierarchy ) +/// /// public string getRoot(string guicontrol){ @@ -10070,6 +14399,7 @@ public string getRoot(string guicontrol){ } /// /// Get root control ) +/// /// public string getRootControl(string guicontrol){ @@ -10077,7 +14407,11 @@ public string getRootControl(string guicontrol){ return m_ts.fnGuiControl_getRootControl(guicontrol); } /// -/// Test whether the control is currently awake. If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. @return True if the control is awake. @ref GuiControl_Waking ) +/// Test whether the control is currently awake. +/// If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. +/// @return True if the control is awake. +/// @ref GuiControl_Waking ) +/// /// public bool isAwake(string guicontrol){ @@ -10086,6 +14420,7 @@ public bool isAwake(string guicontrol){ } /// /// Returns if the control's alpha value can be changed in the game or not. ) +/// /// public bool isContextAlphaEnabled(string guicontrol){ @@ -10094,6 +14429,7 @@ public bool isContextAlphaEnabled(string guicontrol){ } /// /// Returns if the control's alpha fade value can be changed in the game or not. ) +/// /// public bool isContextAlphaFadeEnabled(string guicontrol){ @@ -10102,6 +14438,7 @@ public bool isContextAlphaFadeEnabled(string guicontrol){ } /// /// Returns if the control can be locked in the game or not. ) +/// /// public bool isContextLockable(string guicontrol){ @@ -10110,6 +14447,7 @@ public bool isContextLockable(string guicontrol){ } /// /// Returns if the control's mouse-over alpha value can be changed in the game or not. ) +/// /// public bool isContextMouseOverAlphaEnabled(string guicontrol){ @@ -10118,6 +14456,7 @@ public bool isContextMouseOverAlphaEnabled(string guicontrol){ } /// /// Returns if the control can be moved in the game or not. ) +/// /// public bool isContextMovable(string guicontrol){ @@ -10125,7 +14464,12 @@ public bool isContextMovable(string guicontrol){ return m_ts.fnGuiControl_isContextMovable(guicontrol); } /// -/// Test whether the control is the current first responder. @return True if the control is the current first responder. @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Test whether the control is the current first responder. +/// @return True if the control is the current first responder. +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public bool isFirstResponder(string guicontrol){ @@ -10133,7 +14477,9 @@ public bool isFirstResponder(string guicontrol){ return m_ts.fnGuiControl_isFirstResponder(guicontrol); } /// -/// Indicates if the mouse is locked in this control. @return True if the mouse is currently locked. ) +/// Indicates if the mouse is locked in this control. +/// @return True if the mouse is currently locked. ) +/// /// public bool isMouseLocked(string guicontrol){ @@ -10141,7 +14487,12 @@ public bool isMouseLocked(string guicontrol){ return m_ts.fnGuiControl_isMouseLocked(guicontrol); } /// -/// Test whether the control is currently set to be visible. @return True if the control is currently set to be visible. @note This method does not tell anything about whether the control is actually visible to the user at the moment. @ref GuiControl_VisibleActive ) +/// Test whether the control is currently set to be visible. +/// @return True if the control is currently set to be visible. +/// @note This method does not tell anything about whether the control is actually visible to +/// the user at the moment. +/// @ref GuiControl_VisibleActive ) +/// /// public bool isVisible(string guicontrol){ @@ -10149,7 +14500,13 @@ public bool isVisible(string guicontrol){ return m_ts.fnGuiControl_isVisible(guicontrol); } /// -/// Test whether the given point lies within the rectangle of the control. @param x X coordinate of the point in parent-relative coordinates. @param y Y coordinate of the point in parent-relative coordinates. @return True if the point is within the control, false if not. @see getExtent @see getPosition ) +/// Test whether the given point lies within the rectangle of the control. +/// @param x X coordinate of the point in parent-relative coordinates. +/// @param y Y coordinate of the point in parent-relative coordinates. +/// @return True if the point is within the control, false if not. +/// @see getExtent +/// @see getPosition ) +/// /// public bool pointInControl(string guicontrol, int x, int y){ @@ -10166,7 +14523,9 @@ public void refresh(string guicontrol){ m_ts.fnGuiControl_refresh(guicontrol); } /// -/// Removes the plus cursor. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Removes the plus cursor. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void resetCur(string guicontrol){ @@ -10174,7 +14533,13 @@ public void resetCur(string guicontrol){ m_ts.fnGuiControl_resetCur(guicontrol); } /// -/// Resize and reposition the control using the give coordinates and dimensions. Child controls will resize according to their layout behaviors. @param x The new X coordinate of the control in its parent's coordinate space. @param y The new Y coordinate of the control in its parent's coordinate space. @param width The new width to which the control should be resized. @param height The new height to which the control should be resized. ) +/// Resize and reposition the control using the give coordinates and dimensions. Child controls +/// will resize according to their layout behaviors. +/// @param x The new X coordinate of the control in its parent's coordinate space. +/// @param y The new Y coordinate of the control in its parent's coordinate space. +/// @param width The new width to which the control should be resized. +/// @param height The new height to which the control should be resized. ) +/// /// public void resize(string guicontrol, int x, int y, int width, int height){ @@ -10183,6 +14548,7 @@ public void resize(string guicontrol, int x, int y, int width, int height){ } /// /// ) +/// /// public void setActive(string guicontrol, bool state = true){ @@ -10190,7 +14556,9 @@ public void setActive(string guicontrol, bool state = true){ m_ts.fnGuiControl_setActive(guicontrol, state); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void setAlphaFadeTime(string guicontrol, int fadeTime = 1000){ @@ -10198,7 +14566,9 @@ public void setAlphaFadeTime(string guicontrol, int fadeTime = 1000){ m_ts.fnGuiControl_setAlphaFadeTime(guicontrol, fadeTime); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void setAlphaValue(string guicontrol, float alpha = 1){ @@ -10206,7 +14576,10 @@ public void setAlphaValue(string guicontrol, float alpha = 1){ m_ts.fnGuiControl_setAlphaValue(guicontrol, alpha); } /// -/// Set the control's position by its center point. @param x The X coordinate of the new center point of the control relative to the control's parent. @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// Set the control's position by its center point. +/// @param x The X coordinate of the new center point of the control relative to the control's parent. +/// @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// /// public void setCenter(string guicontrol, int x, int y){ @@ -10215,6 +14588,7 @@ public void setCenter(string guicontrol, int x, int y){ } /// /// Displays the option to set the alpha of the control in the game when true. ) +/// /// public void setContextAlpha(string guicontrol, bool alpha){ @@ -10223,6 +14597,7 @@ public void setContextAlpha(string guicontrol, bool alpha){ } /// /// Displays the option to set the alpha fade value of the control in the game when true. ) +/// /// public void setContextAlphaFade(string guicontrol, bool fade){ @@ -10231,6 +14606,7 @@ public void setContextAlphaFade(string guicontrol, bool fade){ } /// /// Displays the option to set the background color of the control in the game when true. ) +/// /// public void setContextBackColor(string guicontrol, bool backColor){ @@ -10239,6 +14615,7 @@ public void setContextBackColor(string guicontrol, bool backColor){ } /// /// Displays the option to set the fill color of the control in the game when true. ) +/// /// public void setContextFillColor(string guicontrol, bool fillColor){ @@ -10247,6 +14624,7 @@ public void setContextFillColor(string guicontrol, bool fillColor){ } /// /// Displays the option to set the font color of the control in the game when true. ) +/// /// public void setContextFontColor(string guicontrol, bool fontColor){ @@ -10255,6 +14633,7 @@ public void setContextFontColor(string guicontrol, bool fontColor){ } /// /// Displays the option to set the font size of the control in the game when true. ) +/// /// public void setContextFontSize(string guicontrol, bool fontSize){ @@ -10263,6 +14642,7 @@ public void setContextFontSize(string guicontrol, bool fontSize){ } /// /// Displays the option to lock the control in the game when true. ) +/// /// public void setContextLockControl(string guicontrol, bool lockx){ @@ -10271,6 +14651,7 @@ public void setContextLockControl(string guicontrol, bool lockx){ } /// /// Displays the option to set the mouse-over alpha of the control in the game when true. ) +/// /// public void setContextMouseOverAlpha(string guicontrol, bool mouseOver){ @@ -10279,6 +14660,7 @@ public void setContextMouseOverAlpha(string guicontrol, bool mouseOver){ } /// /// Displays the option to move the control in the game when true. ) +/// /// public void setContextMoveControl(string guicontrol, bool move){ @@ -10287,6 +14669,7 @@ public void setContextMoveControl(string guicontrol, bool move){ } /// /// Set control background color. ) +/// /// public void setControlBackgroundColor(string guicontrol, ColorI color){ @@ -10295,6 +14678,7 @@ public void setControlBackgroundColor(string guicontrol, ColorI color){ } /// /// Set control fill color. ) +/// /// public void setControlFillColor(string guicontrol, ColorI color){ @@ -10303,6 +14687,7 @@ public void setControlFillColor(string guicontrol, ColorI color){ } /// /// Set control font color. ) +/// /// public void setControlFontColor(string guicontrol, ColorI color){ @@ -10311,6 +14696,7 @@ public void setControlFontColor(string guicontrol, ColorI color){ } /// /// Sets the font size of a control. ) +/// /// public void setControlFontSize(string guicontrol, int fontSize){ @@ -10319,6 +14705,7 @@ public void setControlFontSize(string guicontrol, int fontSize){ } /// /// Lock the control. ) +/// /// public void setControlLock(string guicontrol, bool lockedx){ @@ -10327,6 +14714,7 @@ public void setControlLock(string guicontrol, bool lockedx){ } /// /// Set control texture. ) +/// /// public void setControlTexture(string guicontrol, string fileName){ @@ -10334,7 +14722,9 @@ public void setControlTexture(string guicontrol, string fileName){ m_ts.fnGuiControl_setControlTexture(guicontrol, fileName); } /// -/// Sets the cursor as a plus. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Sets the cursor as a plus. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void setCur(string guicontrol){ @@ -10342,7 +14732,12 @@ public void setCur(string guicontrol){ m_ts.fnGuiControl_setCur(guicontrol); } /// -/// Make this control the current first responder. @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. @see GuiControlProfile::canKeyFocus @see isFirstResponder @ref GuiControl_FirstResponders ) +/// Make this control the current first responder. +/// @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. +/// @see GuiControlProfile::canKeyFocus +/// @see isFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public void setFirstResponder(string guicontrol){ @@ -10350,7 +14745,9 @@ public void setFirstResponder(string guicontrol){ m_ts.fnGuiControl_setFirstResponder(guicontrol); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void setMouseOverAlphaValue(string guicontrol, float alpha = 1){ @@ -10358,7 +14755,10 @@ public void setMouseOverAlphaValue(string guicontrol, float alpha = 1){ m_ts.fnGuiControl_setMouseOverAlphaValue(guicontrol, alpha); } /// -/// Position the control in the local space of the parent control. @param x The new X coordinate of the control relative to its parent's upper left corner. @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// Position the control in the local space of the parent control. +/// @param x The new X coordinate of the control relative to its parent's upper left corner. +/// @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// /// public void setPosition(string guicontrol, int x, int y){ @@ -10366,7 +14766,10 @@ public void setPosition(string guicontrol, int x, int y){ m_ts.fnGuiControl_setPosition(guicontrol, x, y); } /// -/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. @param x The new X coordinate of the control relative to the root's upper left corner. @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @param x The new X coordinate of the control relative to the root's upper left corner. +/// @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// /// public void setPositionGlobal(string guicontrol, int x, int y){ @@ -10374,7 +14777,11 @@ public void setPositionGlobal(string guicontrol, int x, int y){ m_ts.fnGuiControl_setPositionGlobal(guicontrol, x, y); } /// -/// Set the control profile for the control to use. The profile used by a control determines a great part of its behavior and appearance. @param profile The new profile the control should use. @ref GuiControl_Profiles ) +/// Set the control profile for the control to use. +/// The profile used by a control determines a great part of its behavior and appearance. +/// @param profile The new profile the control should use. +/// @ref GuiControl_Profiles ) +/// /// public void setProfile(string guicontrol, string profile){ @@ -10383,6 +14790,7 @@ public void setProfile(string guicontrol, string profile){ } /// /// Displays the option to set the window settings of the control in the game when true. ) +/// /// public void setShowContextWindowSettings(string guicontrol, bool lockx){ @@ -10390,7 +14798,9 @@ public void setShowContextWindowSettings(string guicontrol, bool lockx){ m_ts.fnGuiControl_setShowContextWindowSettings(guicontrol, lockx); } /// -/// Set the value associated with the control. @param value The new value for the control. ) +/// Set the value associated with the control. +/// @param value The new value for the control. ) +/// /// public void setValue(string guicontrol, string value){ @@ -10398,7 +14808,10 @@ public void setValue(string guicontrol, string value){ m_ts.fnGuiControl_setValue(guicontrol, value); } /// -/// Set whether the control is visible or not. @param state The new visiblity flag state for the control. @ref GuiControl_VisibleActive ) +/// Set whether the control is visible or not. +/// @param state The new visiblity flag state for the control. +/// @ref GuiControl_VisibleActive ) +/// /// public void setVisible(string guicontrol, bool state = true){ @@ -10407,6 +14820,7 @@ public void setVisible(string guicontrol, bool state = true){ } /// /// Returns true if the control is transparent. ) +/// /// public bool transparentControlCheck(string guicontrol){ @@ -10419,14 +14833,9 @@ public bool transparentControlCheck(string guicontrol){ /// public class GuiControlProfileObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiControlProfileObject(ref Omni ts){m_ts = ts;} /// /// ( pString ) ) +/// /// public int GuiControlProfile_getStringWidth(string guicontrolprofile, string pString){ @@ -10439,14 +14848,9 @@ public int GuiControlProfile_getStringWidth(string guicontrolprofile, string pS /// public class GuiConvexEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiConvexEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void GuiConvexEditorCtrl_dropSelectionAtScreenCenter(string guiconvexeditorctrl){ @@ -10455,6 +14859,7 @@ public void GuiConvexEditorCtrl_dropSelectionAtScreenCenter(string guiconvexedi } /// /// ) +/// /// public void GuiConvexEditorCtrl_handleDelete(string guiconvexeditorctrl){ @@ -10463,6 +14868,7 @@ public void GuiConvexEditorCtrl_handleDelete(string guiconvexeditorctrl){ } /// /// ) +/// /// public void GuiConvexEditorCtrl_handleDeselect(string guiconvexeditorctrl){ @@ -10471,6 +14877,7 @@ public void GuiConvexEditorCtrl_handleDeselect(string guiconvexeditorctrl){ } /// /// ) +/// /// public int GuiConvexEditorCtrl_hasSelection(string guiconvexeditorctrl){ @@ -10479,6 +14886,7 @@ public int GuiConvexEditorCtrl_hasSelection(string guiconvexeditorctrl){ } /// /// ) +/// /// public void GuiConvexEditorCtrl_hollowSelection(string guiconvexeditorctrl){ @@ -10487,6 +14895,7 @@ public void GuiConvexEditorCtrl_hollowSelection(string guiconvexeditorctrl){ } /// /// ) +/// /// public void GuiConvexEditorCtrl_recenterSelection(string guiconvexeditorctrl){ @@ -10495,6 +14904,7 @@ public void GuiConvexEditorCtrl_recenterSelection(string guiconvexeditorctrl){ } /// /// ( ConvexShape ) ) +/// /// public void GuiConvexEditorCtrl_selectConvex(string guiconvexeditorctrl, string convex){ @@ -10503,6 +14913,7 @@ public void GuiConvexEditorCtrl_selectConvex(string guiconvexeditorctrl, string } /// /// ) +/// /// public void GuiConvexEditorCtrl_splitSelectedFace(string guiconvexeditorctrl){ @@ -10515,14 +14926,9 @@ public void GuiConvexEditorCtrl_splitSelectedFace(string guiconvexeditorctrl){ /// public class GuiDecalEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiDecalEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// deleteSelectedDecalDatablock( String datablock ) ) +/// /// public void GuiDecalEditorCtrl_deleteDecalDatablock(string guidecaleditorctrl, string datablock){ @@ -10531,6 +14937,7 @@ public void GuiDecalEditorCtrl_deleteDecalDatablock(string guidecaleditorctrl, } /// /// deleteSelectedDecal() ) +/// /// public void GuiDecalEditorCtrl_deleteSelectedDecal(string guidecaleditorctrl){ @@ -10539,6 +14946,7 @@ public void GuiDecalEditorCtrl_deleteSelectedDecal(string guidecaleditorctrl){ } /// /// editDecalDetails( S32 )() ) +/// /// public void GuiDecalEditorCtrl_editDecalDetails(string guidecaleditorctrl, uint id, Point3F pos, Point3F tan, float size){ @@ -10547,6 +14955,7 @@ public void GuiDecalEditorCtrl_editDecalDetails(string guidecaleditorctrl, uint } /// /// getDecalCount() ) +/// /// public int GuiDecalEditorCtrl_getDecalCount(string guidecaleditorctrl){ @@ -10555,6 +14964,7 @@ public int GuiDecalEditorCtrl_getDecalCount(string guidecaleditorctrl){ } /// /// getDecalLookupName( S32 )() ) +/// /// public string GuiDecalEditorCtrl_getDecalLookupName(string guidecaleditorctrl, uint id){ @@ -10563,6 +14973,7 @@ public string GuiDecalEditorCtrl_getDecalLookupName(string guidecaleditorctrl, } /// /// getDecalTransform() ) +/// /// public string GuiDecalEditorCtrl_getDecalTransform(string guidecaleditorctrl, uint id){ @@ -10571,6 +14982,7 @@ public string GuiDecalEditorCtrl_getDecalTransform(string guidecaleditorctrl, u } /// /// getMode() ) +/// /// public string GuiDecalEditorCtrl_getMode(string guidecaleditorctrl){ @@ -10579,6 +14991,7 @@ public string GuiDecalEditorCtrl_getMode(string guidecaleditorctrl){ } /// /// ) +/// /// public int GuiDecalEditorCtrl_getSelectionCount(string guidecaleditorctrl){ @@ -10587,6 +15000,7 @@ public int GuiDecalEditorCtrl_getSelectionCount(string guidecaleditorctrl){ } /// /// ) +/// /// public void GuiDecalEditorCtrl_retargetDecalDatablock(string guidecaleditorctrl, string dbFrom, string dbTo){ @@ -10595,6 +15009,7 @@ public void GuiDecalEditorCtrl_retargetDecalDatablock(string guidecaleditorctrl } /// /// selectDecal( S32 )() ) +/// /// public void GuiDecalEditorCtrl_selectDecal(string guidecaleditorctrl, uint id){ @@ -10603,6 +15018,7 @@ public void GuiDecalEditorCtrl_selectDecal(string guidecaleditorctrl, uint id){ } /// /// setMode( String mode )() ) +/// /// public void GuiDecalEditorCtrl_setMode(string guidecaleditorctrl, string newMode){ @@ -10615,14 +15031,10 @@ public void GuiDecalEditorCtrl_setMode(string guidecaleditorctrl, string newMod /// public class GuiDirectoryFileListCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiDirectoryFileListCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the currently selected filename. @return The filename of the currently selected file ) +/// Get the currently selected filename. +/// @return The filename of the currently selected file ) +/// /// public string getSelectedFile(string guidirectoryfilelistctrl){ @@ -10630,7 +15042,9 @@ public string getSelectedFile(string guidirectoryfilelistctrl){ return m_ts.fnGuiDirectoryFileListCtrl_getSelectedFile(guidirectoryfilelistctrl); } /// -/// Get the list of selected files. @return A space separated list of selected files ) +/// Get the list of selected files. +/// @return A space separated list of selected files ) +/// /// public string getSelectedFiles(string guidirectoryfilelistctrl){ @@ -10639,6 +15053,7 @@ public string getSelectedFiles(string guidirectoryfilelistctrl){ } /// /// Update the file list. ) +/// /// public void reload(string guidirectoryfilelistctrl){ @@ -10646,7 +15061,9 @@ public void reload(string guidirectoryfilelistctrl){ m_ts.fnGuiDirectoryFileListCtrl_reload(guidirectoryfilelistctrl); } /// -/// Set the file filter. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the file filter. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public void setFilter(string guidirectoryfilelistctrl, string filter){ @@ -10654,7 +15071,10 @@ public void setFilter(string guidirectoryfilelistctrl, string filter){ m_ts.fnGuiDirectoryFileListCtrl_setFilter(guidirectoryfilelistctrl, filter); } /// -/// Set the search path and file filter. @param path Path in game directory from which to list files. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the search path and file filter. +/// @param path Path in game directory from which to list files. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public bool setPath(string guidirectoryfilelistctrl, string path, string filter){ @@ -10667,14 +15087,11 @@ public bool setPath(string guidirectoryfilelistctrl, string path, string filter /// public class GuiDragAndDropControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiDragAndDropControlObject(ref Omni ts){m_ts = ts;} /// -/// Start the drag operation. @param x X coordinate for the mouse pointer offset which the drag control should position itself. @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// Start the drag operation. +/// @param x X coordinate for the mouse pointer offset which the drag control should position itself. +/// @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// /// public void startDragging(string guidraganddropcontrol, int x = 0, int y = 0){ @@ -10687,14 +15104,9 @@ public void startDragging(string guidraganddropcontrol, int x = 0, int y = 0){ /// public class GuiDynamicCtrlArrayControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiDynamicCtrlArrayControlObject(ref Omni ts){m_ts = ts;} /// /// Recalculates the position and size of this control and all its children. ) +/// /// public void refresh(string guidynamicctrlarraycontrol){ @@ -10707,14 +15119,9 @@ public void refresh(string guidynamicctrlarraycontrol){ /// public class GuiEditCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiEditCtrlObject(ref Omni ts){m_ts = ts;} /// /// (GuiControl ctrl)) +/// /// public void GuiEditCtrl_addNewCtrl(string guieditctrl, string ctrl){ @@ -10723,6 +15130,7 @@ public void GuiEditCtrl_addNewCtrl(string guieditctrl, string ctrl){ } /// /// selects a control.) +/// /// public void GuiEditCtrl_addSelection(string guieditctrl, int id){ @@ -10731,6 +15139,7 @@ public void GuiEditCtrl_addSelection(string guieditctrl, int id){ } /// /// ) +/// /// public void GuiEditCtrl_bringToFront(string guieditctrl){ @@ -10739,6 +15148,7 @@ public void GuiEditCtrl_bringToFront(string guieditctrl){ } /// /// ( [ int axis ] ) - Clear all currently set guide lines. ) +/// /// public void GuiEditCtrl_clearGuides(string guieditctrl, int axis = -1){ @@ -10747,6 +15157,7 @@ public void GuiEditCtrl_clearGuides(string guieditctrl, int axis = -1){ } /// /// Clear selected controls list.) +/// /// public void GuiEditCtrl_clearSelection(string guieditctrl){ @@ -10755,6 +15166,7 @@ public void GuiEditCtrl_clearSelection(string guieditctrl){ } /// /// () - Delete the selected controls.) +/// /// public void GuiEditCtrl_deleteSelection(string guieditctrl){ @@ -10763,6 +15175,7 @@ public void GuiEditCtrl_deleteSelection(string guieditctrl){ } /// /// ( bool width=true, bool height=true ) - Fit selected controls into their parents. ) +/// /// public void GuiEditCtrl_fitIntoParents(string guieditctrl, bool width = true, bool height = true){ @@ -10771,6 +15184,7 @@ public void GuiEditCtrl_fitIntoParents(string guieditctrl, bool width = true, b } /// /// () - Return the toplevel control edited inside the GUI editor. ) +/// /// public int GuiEditCtrl_getContentControl(string guieditctrl){ @@ -10779,6 +15193,7 @@ public int GuiEditCtrl_getContentControl(string guieditctrl){ } /// /// Returns the set to which new controls will be added) +/// /// public int GuiEditCtrl_getCurrentAddSet(string guieditctrl){ @@ -10787,6 +15202,7 @@ public int GuiEditCtrl_getCurrentAddSet(string guieditctrl){ } /// /// () - Return the current mouse mode. ) +/// /// public string GuiEditCtrl_getMouseMode(string guieditctrl){ @@ -10795,6 +15211,7 @@ public string GuiEditCtrl_getMouseMode(string guieditctrl){ } /// /// () - Return the number of controls currently selected. ) +/// /// public int GuiEditCtrl_getNumSelected(string guieditctrl){ @@ -10803,6 +15220,7 @@ public int GuiEditCtrl_getNumSelected(string guieditctrl){ } /// /// () - Returns global bounds of current selection as vector 'x y width height'. ) +/// /// public string GuiEditCtrl_getSelectionGlobalBounds(string guieditctrl){ @@ -10811,6 +15229,7 @@ public string GuiEditCtrl_getSelectionGlobalBounds(string guieditctrl){ } /// /// (int mode) ) +/// /// public void GuiEditCtrl_justify(string guieditctrl, uint mode){ @@ -10819,6 +15238,7 @@ public void GuiEditCtrl_justify(string guieditctrl, uint mode){ } /// /// ( string fileName=null ) - Load selection from file or clipboard.) +/// /// public void GuiEditCtrl_loadSelection(string guieditctrl, string filename = null ){ if (filename== null) {filename = null;} @@ -10828,6 +15248,7 @@ public void GuiEditCtrl_loadSelection(string guieditctrl, string filename = nul } /// /// Move all controls in the selection by (dx,dy) pixels.) +/// /// public void GuiEditCtrl_moveSelection(string guieditctrl, Point2I pos){ @@ -10836,6 +15257,7 @@ public void GuiEditCtrl_moveSelection(string guieditctrl, Point2I pos){ } /// /// ) +/// /// public void GuiEditCtrl_pushToBack(string guieditctrl){ @@ -10844,6 +15266,7 @@ public void GuiEditCtrl_pushToBack(string guieditctrl){ } /// /// ( GuiControl ctrl [, int axis ] ) - Read the guides from the given control. ) +/// /// public void GuiEditCtrl_readGuides(string guieditctrl, string ctrl, int axis = -1){ @@ -10852,6 +15275,7 @@ public void GuiEditCtrl_readGuides(string guieditctrl, string ctrl, int axis = } /// /// deselects a control.) +/// /// public void GuiEditCtrl_removeSelection(string guieditctrl, int id){ @@ -10860,6 +15284,7 @@ public void GuiEditCtrl_removeSelection(string guieditctrl, int id){ } /// /// ( string fileName=null ) - Save selection to file or clipboard.) +/// /// public void GuiEditCtrl_saveSelection(string guieditctrl, string filename = null ){ if (filename== null) {filename = null;} @@ -10869,6 +15294,7 @@ public void GuiEditCtrl_saveSelection(string guieditctrl, string filename = nul } /// /// (GuiControl ctrl)) +/// /// public void GuiEditCtrl_select(string guieditctrl, string ctrl){ @@ -10877,6 +15303,7 @@ public void GuiEditCtrl_select(string guieditctrl, string ctrl){ } /// /// ()) +/// /// public void GuiEditCtrl_selectAll(string guieditctrl){ @@ -10885,6 +15312,7 @@ public void GuiEditCtrl_selectAll(string guieditctrl){ } /// /// ( bool addToSelection=false ) - Select children of currently selected controls. ) +/// /// public void GuiEditCtrl_selectChildren(string guieditctrl, bool addToSelection = false){ @@ -10893,6 +15321,7 @@ public void GuiEditCtrl_selectChildren(string guieditctrl, bool addToSelection } /// /// ( bool addToSelection=false ) - Select parents of currently selected controls. ) +/// /// public void GuiEditCtrl_selectParents(string guieditctrl, bool addToSelection = false){ @@ -10901,6 +15330,7 @@ public void GuiEditCtrl_selectParents(string guieditctrl, bool addToSelection = } /// /// ( GuiControl ctrl ) - Set the toplevel control to edit in the GUI editor. ) +/// /// public void GuiEditCtrl_setContentControl(string guieditctrl, string ctrl){ @@ -10909,6 +15339,7 @@ public void GuiEditCtrl_setContentControl(string guieditctrl, string ctrl){ } /// /// (GuiControl ctrl)) +/// /// public void GuiEditCtrl_setCurrentAddSet(string guieditctrl, string addSet){ @@ -10917,6 +15348,7 @@ public void GuiEditCtrl_setCurrentAddSet(string guieditctrl, string addSet){ } /// /// GuiEditCtrl.setSnapToGrid(gridsize)) +/// /// public void GuiEditCtrl_setSnapToGrid(string guieditctrl, uint gridsize){ @@ -10925,6 +15357,7 @@ public void GuiEditCtrl_setSnapToGrid(string guieditctrl, uint gridsize){ } /// /// Toggle activation.) +/// /// public void GuiEditCtrl_toggle(string guieditctrl){ @@ -10933,6 +15366,7 @@ public void GuiEditCtrl_toggle(string guieditctrl){ } /// /// ( GuiControl ctrl [, int axis ] ) - Write the guides to the given control. ) +/// /// public void GuiEditCtrl_writeGuides(string guieditctrl, string ctrl, int axis = -1){ @@ -10941,6 +15375,7 @@ public void GuiEditCtrl_writeGuides(string guieditctrl, string ctrl, int axis = } /// /// Gets the set of GUI controls currently selected in the editor. ) +/// /// public string getSelection(string guieditctrl){ @@ -10949,6 +15384,7 @@ public string getSelection(string guieditctrl){ } /// /// Gets the GUI controls(s) that are currently in the trash.) +/// /// public string getTrash(string guieditctrl){ @@ -10961,14 +15397,9 @@ public string getTrash(string guieditctrl){ /// public class GuiFileTreeCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiFileTreeCtrlObject(ref Omni ts){m_ts = ts;} /// /// getSelectedPath() - returns the currently selected path in the tree) +/// /// public string GuiFileTreeCtrl_getSelectedPath(string guifiletreectrl){ @@ -10977,6 +15408,7 @@ public string GuiFileTreeCtrl_getSelectedPath(string guifiletreectrl){ } /// /// () - Reread the directory tree hierarchy. ) +/// /// public void GuiFileTreeCtrl_reload(string guifiletreectrl){ @@ -10985,6 +15417,7 @@ public void GuiFileTreeCtrl_reload(string guifiletreectrl){ } /// /// setSelectedPath(path) - expands the tree to the specified path) +/// /// public bool GuiFileTreeCtrl_setSelectedPath(string guifiletreectrl, string path){ @@ -10997,14 +15430,10 @@ public bool GuiFileTreeCtrl_setSelectedPath(string guifiletreectrl, string path /// public class GuiFilterCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiFilterCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Return a tuple containing all the values in the filter. @internal) +/// Return a tuple containing all the values in the filter. +/// @internal) +/// /// public string GuiFilterCtrl_getValue(string guifilterctrl){ @@ -11012,7 +15441,9 @@ public string GuiFilterCtrl_getValue(string guifilterctrl){ return m_ts.fn_GuiFilterCtrl_getValue(guifilterctrl); } /// -/// Reset the filtering. @internal) +/// Reset the filtering. +/// @internal) +/// /// public void GuiFilterCtrl_identity(string guifilterctrl){ @@ -11020,7 +15451,10 @@ public void GuiFilterCtrl_identity(string guifilterctrl){ m_ts.fn_GuiFilterCtrl_identity(guifilterctrl); } /// -/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) Reset the filter to use the specified points, spread equidistantly across the domain. @internal) +/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) +/// Reset the filter to use the specified points, spread equidistantly across the domain. +/// @internal) +/// /// public void setValue(string guifilterctrl, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -11033,14 +15467,10 @@ public void setValue(string guifilterctrl, string a2= "", string a3= "", string /// public class GuiFormCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiFormCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the ID of this form's menu. @return The ID of the form menu ) +/// Get the ID of this form's menu. +/// @return The ID of the form menu ) +/// /// public int getMenuID(string guiformctrl){ @@ -11048,7 +15478,9 @@ public int getMenuID(string guiformctrl){ return m_ts.fnGuiFormCtrl_getMenuID(guiformctrl); } /// -/// Sets the title of the form. @param caption Form caption ) +/// Sets the title of the form. +/// @param caption Form caption ) +/// /// public void setCaption(string guiformctrl, string caption){ @@ -11061,14 +15493,9 @@ public void setCaption(string guiformctrl, string caption){ /// public class GuiFrameSetCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiFrameSetCtrlObject(ref Omni ts){m_ts = ts;} /// /// Add a new column. ) +/// /// public void addColumn(string guiframesetctrl){ @@ -11077,6 +15504,7 @@ public void addColumn(string guiframesetctrl){ } /// /// Add a new row. ) +/// /// public void addRow(string guiframesetctrl){ @@ -11084,7 +15512,11 @@ public void addRow(string guiframesetctrl){ m_ts.fnGuiFrameSetCtrl_addRow(guiframesetctrl); } /// -/// dynamic ), Override the i>borderEnable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderEnable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void frameBorder(string guiframesetctrl, int index, string state = "dynamic"){ @@ -11092,7 +15524,12 @@ public void frameBorder(string guiframesetctrl, int index, string state = "dyna m_ts.fnGuiFrameSetCtrl_frameBorder(guiframesetctrl, index, state); } /// -/// Set the minimum width and height for the frame. It will not be possible for the user to resize the frame smaller than this. @param index Index of the frame to modify @param width Minimum width in pixels @param height Minimum height in pixels ) +/// Set the minimum width and height for the frame. It will not be possible +/// for the user to resize the frame smaller than this. +/// @param index Index of the frame to modify +/// @param width Minimum width in pixels +/// @param height Minimum height in pixels ) +/// /// public void frameMinExtent(string guiframesetctrl, int index, int width, int height){ @@ -11100,7 +15537,11 @@ public void frameMinExtent(string guiframesetctrl, int index, int width, int he m_ts.fnGuiFrameSetCtrl_frameMinExtent(guiframesetctrl, index, width, height); } /// -/// dynamic ), Override the i>borderMovable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderMovable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void frameMovable(string guiframesetctrl, int index, string state = "dynamic"){ @@ -11108,7 +15549,11 @@ public void frameMovable(string guiframesetctrl, int index, string state = "dyn m_ts.fnGuiFrameSetCtrl_frameMovable(guiframesetctrl, index, state); } /// -/// Set the padding for this frame. Padding introduces blank space on the inside edge of the frame. @param index Index of the frame to modify @param padding Frame top, bottom, left, and right padding ) +/// Set the padding for this frame. Padding introduces blank space on the inside +/// edge of the frame. +/// @param index Index of the frame to modify +/// @param padding Frame top, bottom, left, and right padding ) +/// /// public void framePadding(string guiframesetctrl, int index, RectSpacingI padding){ @@ -11116,7 +15561,9 @@ public void framePadding(string guiframesetctrl, int index, RectSpacingI paddin m_ts.fnGuiFrameSetCtrl_framePadding(guiframesetctrl, index, padding.AsString()); } /// -/// Get the number of columns. @return The number of columns ) +/// Get the number of columns. +/// @return The number of columns ) +/// /// public int getColumnCount(string guiframesetctrl){ @@ -11124,7 +15571,10 @@ public int getColumnCount(string guiframesetctrl){ return m_ts.fnGuiFrameSetCtrl_getColumnCount(guiframesetctrl); } /// -/// Get the horizontal offset of a column. @param index Index of the column to query @return Column offset in pixels ) +/// Get the horizontal offset of a column. +/// @param index Index of the column to query +/// @return Column offset in pixels ) +/// /// public int getColumnOffset(string guiframesetctrl, int index){ @@ -11132,7 +15582,9 @@ public int getColumnOffset(string guiframesetctrl, int index){ return m_ts.fnGuiFrameSetCtrl_getColumnOffset(guiframesetctrl, index); } /// -/// Get the padding for this frame. @param index Index of the frame to query ) +/// Get the padding for this frame. +/// @param index Index of the frame to query ) +/// /// public RectSpacingI getFramePadding(string guiframesetctrl, int index){ @@ -11140,7 +15592,9 @@ public RectSpacingI getFramePadding(string guiframesetctrl, int index){ return new RectSpacingI ( m_ts.fnGuiFrameSetCtrl_getFramePadding(guiframesetctrl, index)); } /// -/// Get the number of rows. @return The number of rows ) +/// Get the number of rows. +/// @return The number of rows ) +/// /// public int getRowCount(string guiframesetctrl){ @@ -11148,7 +15602,10 @@ public int getRowCount(string guiframesetctrl){ return m_ts.fnGuiFrameSetCtrl_getRowCount(guiframesetctrl); } /// -/// Get the vertical offset of a row. @param index Index of the row to query @return Row offset in pixels ) +/// Get the vertical offset of a row. +/// @param index Index of the row to query +/// @return Row offset in pixels ) +/// /// public int getRowOffset(string guiframesetctrl, int index){ @@ -11157,6 +15614,7 @@ public int getRowOffset(string guiframesetctrl, int index){ } /// /// Remove the last (rightmost) column. ) +/// /// public void removeColumn(string guiframesetctrl){ @@ -11165,6 +15623,7 @@ public void removeColumn(string guiframesetctrl){ } /// /// Remove the last (bottom) row. ) +/// /// public void removeRow(string guiframesetctrl){ @@ -11172,7 +15631,12 @@ public void removeRow(string guiframesetctrl){ m_ts.fnGuiFrameSetCtrl_removeRow(guiframesetctrl); } /// -/// Set the horizontal offset of a column. Note that column offsets must always be in increasing order, and therefore this offset must be between the offsets of the colunns either side. @param index Index of the column to modify @param offset New column offset ) +/// Set the horizontal offset of a column. +/// Note that column offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the colunns either side. +/// @param index Index of the column to modify +/// @param offset New column offset ) +/// /// public void setColumnOffset(string guiframesetctrl, int index, int offset){ @@ -11180,7 +15644,12 @@ public void setColumnOffset(string guiframesetctrl, int index, int offset){ m_ts.fnGuiFrameSetCtrl_setColumnOffset(guiframesetctrl, index, offset); } /// -/// Set the vertical offset of a row. Note that row offsets must always be in increasing order, and therefore this offset must be between the offsets of the rows either side. @param index Index of the row to modify @param offset New row offset ) +/// Set the vertical offset of a row. +/// Note that row offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the rows either side. +/// @param index Index of the row to modify +/// @param offset New row offset ) +/// /// public void setRowOffset(string guiframesetctrl, int index, int offset){ @@ -11189,6 +15658,7 @@ public void setRowOffset(string guiframesetctrl, int index, int offset){ } /// /// Recalculates child control sizes. ) +/// /// public void updateSizes(string guiframesetctrl){ @@ -11201,14 +15671,9 @@ public void updateSizes(string guiframesetctrl){ /// public class GuiGameListMenuCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiGameListMenuCtrlObject(ref Omni ts){m_ts = ts;} /// /// Activates the current row. The script callback of the current row will be called (if it has one). ) +/// /// public void activateRow(string guigamelistmenuctrl){ @@ -11216,7 +15681,14 @@ public void activateRow(string guigamelistmenuctrl){ m_ts.fnGuiGameListMenuCtrl_activateRow(guigamelistmenuctrl); } /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param useHighlightIcon [optional] Does this row use the highlight icon?. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param useHighlightIcon [optional] Does this row use the highlight icon?. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void addRow(string guigamelistmenuctrl, string label, string callback, int icon = -1, int yPad = 0, bool useHighlightIcon = true, bool enabled = true){ @@ -11224,7 +15696,9 @@ public void addRow(string guigamelistmenuctrl, string label, string callback, i m_ts.fnGuiGameListMenuCtrl_addRow(guigamelistmenuctrl, label, callback, icon, yPad, useHighlightIcon, enabled); } /// -/// Gets the number of rows on the control. @return (int) The number of rows on the control. ) +/// Gets the number of rows on the control. +/// @return (int) The number of rows on the control. ) +/// /// public int getRowCount(string guigamelistmenuctrl){ @@ -11232,7 +15706,10 @@ public int getRowCount(string guigamelistmenuctrl){ return m_ts.fnGuiGameListMenuCtrl_getRowCount(guigamelistmenuctrl); } /// -/// Gets the label displayed on the specified row. @param row Index of the row to get the label of. @return The label for the row. ) +/// Gets the label displayed on the specified row. +/// @param row Index of the row to get the label of. +/// @return The label for the row. ) +/// /// public string getRowLabel(string guigamelistmenuctrl, int row){ @@ -11240,7 +15717,9 @@ public string getRowLabel(string guigamelistmenuctrl, int row){ return m_ts.fnGuiGameListMenuCtrl_getRowLabel(guigamelistmenuctrl, row); } /// -/// Gets the index of the currently selected row. @return Index of the selected row. ) +/// Gets the index of the currently selected row. +/// @return Index of the selected row. ) +/// /// public int getSelectedRow(string guigamelistmenuctrl){ @@ -11248,7 +15727,10 @@ public int getSelectedRow(string guigamelistmenuctrl){ return m_ts.fnGuiGameListMenuCtrl_getSelectedRow(guigamelistmenuctrl); } /// -/// Determines if the specified row is enabled or disabled. @param row The row to set the enabled status of. @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// Determines if the specified row is enabled or disabled. +/// @param row The row to set the enabled status of. +/// @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// /// public bool isRowEnabled(string guigamelistmenuctrl, int row){ @@ -11256,7 +15738,10 @@ public bool isRowEnabled(string guigamelistmenuctrl, int row){ return m_ts.fnGuiGameListMenuCtrl_isRowEnabled(guigamelistmenuctrl, row); } /// -/// Sets a row's enabled status according to the given parameters. @param row The index to check for validity. @param enabled Indicate true to enable the row or false to disable it. ) +/// Sets a row's enabled status according to the given parameters. +/// @param row The index to check for validity. +/// @param enabled Indicate true to enable the row or false to disable it. ) +/// /// public void setRowEnabled(string guigamelistmenuctrl, int row, bool enabled){ @@ -11264,7 +15749,10 @@ public void setRowEnabled(string guigamelistmenuctrl, int row, bool enabled){ m_ts.fnGuiGameListMenuCtrl_setRowEnabled(guigamelistmenuctrl, row, enabled); } /// -/// Sets the label on the given row. @param row Index of the row to set the label on. @param label Text to set as the label of the row. ) +/// Sets the label on the given row. +/// @param row Index of the row to set the label on. +/// @param label Text to set as the label of the row. ) +/// /// public void setRowLabel(string guigamelistmenuctrl, int row, string label){ @@ -11272,7 +15760,9 @@ public void setRowLabel(string guigamelistmenuctrl, int row, string label){ m_ts.fnGuiGameListMenuCtrl_setRowLabel(guigamelistmenuctrl, row, label); } /// -/// Sets the selected row. Only rows that are enabled can be selected. @param row Index of the row to set as selected. ) +/// Sets the selected row. Only rows that are enabled can be selected. +/// @param row Index of the row to set as selected. ) +/// /// public void setSelected(string guigamelistmenuctrl, int row){ @@ -11285,14 +15775,16 @@ public void setSelected(string guigamelistmenuctrl, int row){ /// public class GuiGameListOptionsCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiGameListOptionsCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param options A tab separated list of options. @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param options A tab separated list of options. +/// @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void addRow(string guigamelistoptionsctrl, string label, string options, bool wrapOptions, string callback, int icon = -1, int yPad = 0, bool enabled = true){ @@ -11300,7 +15792,10 @@ public void addRow(string guigamelistoptionsctrl, string label, string options, m_ts.fnGuiGameListOptionsCtrl_addRow(guigamelistoptionsctrl, label, options, wrapOptions, callback, icon, yPad, enabled); } /// -/// Gets the text for the currently selected option of the given row. @param row Index of the row to get the option from. @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// Gets the text for the currently selected option of the given row. +/// @param row Index of the row to get the option from. +/// @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// /// public string getCurrentOption(string guigamelistoptionsctrl, int row){ @@ -11308,7 +15803,11 @@ public string getCurrentOption(string guigamelistoptionsctrl, int row){ return m_ts.fnGuiGameListOptionsCtrl_getCurrentOption(guigamelistoptionsctrl, row); } /// -/// Set the row's current option to the one specified @param row Index of the row to set an option on. @param option The option to be made active. @return True if the row contained the option and was set, false otherwise. ) +/// Set the row's current option to the one specified +/// @param row Index of the row to set an option on. +/// @param option The option to be made active. +/// @return True if the row contained the option and was set, false otherwise. ) +/// /// public bool selectOption(string guigamelistoptionsctrl, int row, string option){ @@ -11316,7 +15815,10 @@ public bool selectOption(string guigamelistoptionsctrl, int row, string option) return m_ts.fnGuiGameListOptionsCtrl_selectOption(guigamelistoptionsctrl, row, option); } /// -/// Sets the list of options on the given row. @param row Index of the row to set options on. @param optionsList A tab separated list of options for the control. ) +/// Sets the list of options on the given row. +/// @param row Index of the row to set options on. +/// @param optionsList A tab separated list of options for the control. ) +/// /// public void setOptions(string guigamelistoptionsctrl, int row, string optionsList){ @@ -11329,14 +15831,9 @@ public void setOptions(string guigamelistoptionsctrl, int row, string optionsLi /// public class GuiGradientCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiGradientCtrlObject(ref Omni ts){m_ts = ts;} /// /// Get color value) +/// /// public ColorF GuiGradientCtrl_getColor(string guigradientctrl, int idx){ @@ -11345,6 +15842,7 @@ public ColorF GuiGradientCtrl_getColor(string guigradientctrl, int idx){ } /// /// Get color count) +/// /// public int GuiGradientCtrl_getColorCount(string guigradientctrl){ @@ -11357,14 +15855,17 @@ public int GuiGradientCtrl_getColorCount(string guigradientctrl){ /// public class GuiGraphCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiGraphCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Sets up the given plotting curve to automatically plot the value of the @a variable with a frequency of @a updateFrequency. @param plotId Index of the plotting curve. Must be 0=plotId6. @param variable Name of the global variable. @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). @tsexample // Plot FPS counter at 1 second intervals. %graph.addAutoPlot( 0, \"fps::real\", 1000 ); @endtsexample ) +/// Sets up the given plotting curve to automatically plot the value of the @a variable with a +/// frequency of @a updateFrequency. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param variable Name of the global variable. +/// @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). +/// @tsexample +/// // Plot FPS counter at 1 second intervals. +/// %graph.addAutoPlot( 0, \"fps::real\", 1000 ); +/// @endtsexample ) +/// /// public void addAutoPlot(string guigraphctrl, int plotId, string variable, int updateFrequency){ @@ -11372,7 +15873,13 @@ public void addAutoPlot(string guigraphctrl, int plotId, string variable, int u m_ts.fnGuiGraphCtrl_addAutoPlot(guigraphctrl, plotId, variable, updateFrequency); } /// -/// Add a data point to the plot's curve. @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. @param value Value of the data point to add to the curve. @note Data values are added to the @b left end of the plotting curve. @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If this limit is exceeded, data points on the right end of the curve are culled. ) +/// Add a data point to the plot's curve. +/// @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. +/// @param value Value of the data point to add to the curve. +/// @note Data values are added to the @b left end of the plotting curve. +/// @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If +/// this limit is exceeded, data points on the right end of the curve are culled. ) +/// /// public void addDatum(string guigraphctrl, int plotId, float value){ @@ -11380,7 +15887,11 @@ public void addDatum(string guigraphctrl, int plotId, float value){ m_ts.fnGuiGraphCtrl_addDatum(guigraphctrl, plotId, value); } /// -/// Get a data point on the given plotting curve. @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. @param index Index of the data point on the curve. @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// Get a data point on the given plotting curve. +/// @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. +/// @param index Index of the data point on the curve. +/// @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// /// public float getDatum(string guigraphctrl, int plotId, int index){ @@ -11388,7 +15899,9 @@ public float getDatum(string guigraphctrl, int plotId, int index){ return m_ts.fnGuiGraphCtrl_getDatum(guigraphctrl, plotId, index); } /// -/// Stop automatic variable plotting for the given curve. @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// Stop automatic variable plotting for the given curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// /// public void removeAutoPlot(string guigraphctrl, int plotId){ @@ -11396,7 +15909,11 @@ public void removeAutoPlot(string guigraphctrl, int plotId){ m_ts.fnGuiGraphCtrl_removeAutoPlot(guigraphctrl, plotId); } /// -/// Change the charting type of the given plotting curve. @param plotId Index of the plotting curve. Must be 0=plotId6. @param graphType Charting type to use for the curve. @note Instead of calling this method, you can directly assign to #plotType. ) +/// Change the charting type of the given plotting curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param graphType Charting type to use for the curve. +/// @note Instead of calling this method, you can directly assign to #plotType. ) +/// /// public void setGraphType(string guigraphctrl, int plotId, TypeGuiGraphType graphType){ @@ -11409,14 +15926,18 @@ public void setGraphType(string guigraphctrl, int plotId, TypeGuiGraphType grap /// public class GuiIconButtonCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiIconButtonCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Set the bitmap to use for the button portion of this control. @param buttonFilename Filename for the image @tsexample // Define the button filename %buttonFilename = \"pearlButton\"; // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); @endtsexample @see GuiControl @see GuiButtonCtrl) +/// @brief Set the bitmap to use for the button portion of this control. +/// @param buttonFilename Filename for the image +/// @tsexample +/// // Define the button filename +/// %buttonFilename = \"pearlButton\"; +/// // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap +/// %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); +/// @endtsexample +/// @see GuiControl +/// @see GuiButtonCtrl) +/// /// public void setBitmap(string guiiconbuttonctrl, string buttonFilename){ @@ -11429,14 +15950,10 @@ public void setBitmap(string guiiconbuttonctrl, string buttonFilename){ /// public class GuiIdleCamFadeBitmapCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiIdleCamFadeBitmapCtrlObject(ref Omni ts){m_ts = ts;} /// -/// () @internal) +/// () +/// @internal) +/// /// public void GuiIdleCamFadeBitmapCtrl_fadeIn(string guiidlecamfadebitmapctrl){ @@ -11444,7 +15961,9 @@ public void GuiIdleCamFadeBitmapCtrl_fadeIn(string guiidlecamfadebitmapctrl){ m_ts.fn_GuiIdleCamFadeBitmapCtrl_fadeIn(guiidlecamfadebitmapctrl); } /// -/// () @internal) +/// () +/// @internal) +/// /// public void GuiIdleCamFadeBitmapCtrl_fadeOut(string guiidlecamfadebitmapctrl){ @@ -11457,14 +15976,15 @@ public void GuiIdleCamFadeBitmapCtrl_fadeOut(string guiidlecamfadebitmapctrl){ /// public class GuiImageListObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiImageListObject(ref Omni ts){m_ts = ts;} /// -/// @brief Clears the imagelist @tsexample // Inform the GuiImageList control to clear itself. %isFinished = %thisGuiImageList.clear(); @endtsexample @return Returns true when finished. @see SimObject) +/// @brief Clears the imagelist +/// @tsexample +/// // Inform the GuiImageList control to clear itself. +/// %isFinished = %thisGuiImageList.clear(); +/// @endtsexample +/// @return Returns true when finished. +/// @see SimObject) +/// /// public bool clear(string guiimagelist){ @@ -11472,7 +15992,14 @@ public bool clear(string guiimagelist){ return m_ts.fnGuiImageList_clear(guiimagelist); } /// -/// @brief Gets the number of images in the list. @tsexample // Request the number of images from the GuiImageList control. %imageCount = %thisGuiImageList.count(); @endtsexample @return Number of images in the control. @see SimObject) +/// @brief Gets the number of images in the list. +/// @tsexample +/// // Request the number of images from the GuiImageList control. +/// %imageCount = %thisGuiImageList.count(); +/// @endtsexample +/// @return Number of images in the control. +/// @see SimObject) +/// /// public int count(string guiimagelist){ @@ -11480,7 +16007,17 @@ public int count(string guiimagelist){ return m_ts.fnGuiImageList_count(guiimagelist); } /// -/// @brief Get a path to the texture at the specified index. @param index Index of the image in the list. @tsexample // Define the image index/n %index = \"5\"; // Request the image path location from the control. %imagePath = %thisGuiImageList.getImage(%index); @endtsexample @return File path to the image map for the specified index. @see SimObject) +/// @brief Get a path to the texture at the specified index. +/// @param index Index of the image in the list. +/// @tsexample +/// // Define the image index/n +/// %index = \"5\"; +/// // Request the image path location from the control. +/// %imagePath = %thisGuiImageList.getImage(%index); +/// @endtsexample +/// @return File path to the image map for the specified index. +/// @see SimObject) +/// /// public string getImage(string guiimagelist, int index){ @@ -11488,7 +16025,17 @@ public string getImage(string guiimagelist, int index){ return m_ts.fnGuiImageList_getImage(guiimagelist, index); } /// -/// @brief Retrieves the imageindex of a specified texture in the list. @param imagePath Imagemap including filepath of image to search for @tsexample // Define the imagemap to search for %imagePath = \"./game/client/data/images/thisImage\"; // Request the index entry for the defined imagemap %imageIndex = %thisGuiImageList.getIndex(%imagePath); @endtsexample @return Index of the imagemap matching the defined image path. @see SimObject) +/// @brief Retrieves the imageindex of a specified texture in the list. +/// @param imagePath Imagemap including filepath of image to search for +/// @tsexample +/// // Define the imagemap to search for +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the index entry for the defined imagemap +/// %imageIndex = %thisGuiImageList.getIndex(%imagePath); +/// @endtsexample +/// @return Index of the imagemap matching the defined image path. +/// @see SimObject) +/// /// public int getIndex(string guiimagelist, string imagePath){ @@ -11496,7 +16043,17 @@ public int getIndex(string guiimagelist, string imagePath){ return m_ts.fnGuiImageList_getIndex(guiimagelist, imagePath); } /// -/// @brief Insert an image into imagelist- returns the image index or -1 for failure. @param imagePath Imagemap, with path, to add to the list. @tsexample // Define the imagemap to add to the list %imagePath = \"./game/client/data/images/thisImage\"; // Request the GuiImageList control to add the defined image to its list. %imageIndex = %thisGuiImageList.insert(%imagePath); @endtsexample @return The index of the newly inserted imagemap, or -1 if the insertion failed. @see SimObject) +/// @brief Insert an image into imagelist- returns the image index or -1 for failure. +/// @param imagePath Imagemap, with path, to add to the list. +/// @tsexample +/// // Define the imagemap to add to the list +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the GuiImageList control to add the defined image to its list. +/// %imageIndex = %thisGuiImageList.insert(%imagePath); +/// @endtsexample +/// @return The index of the newly inserted imagemap, or -1 if the insertion failed. +/// @see SimObject) +/// /// public int insert(string guiimagelist, string imagePath){ @@ -11504,7 +16061,17 @@ public int insert(string guiimagelist, string imagePath){ return m_ts.fnGuiImageList_insert(guiimagelist, imagePath); } /// -/// @brief Removes an image from the list by index. @param index Image index to remove. @tsexample // Define the image index. %imageIndex = \"4\"; // Inform the GuiImageList control to remove the image at the defined index. %wasSuccessful = %thisGuiImageList.remove(%imageIndex); @endtsexample @return True if the operation was successful, false if it was not. @see SimObject) +/// @brief Removes an image from the list by index. +/// @param index Image index to remove. +/// @tsexample +/// // Define the image index. +/// %imageIndex = \"4\"; +/// // Inform the GuiImageList control to remove the image at the defined index. +/// %wasSuccessful = %thisGuiImageList.remove(%imageIndex); +/// @endtsexample +/// @return True if the operation was successful, false if it was not. +/// @see SimObject) +/// /// public bool remove(string guiimagelist, int index){ @@ -11517,14 +16084,9 @@ public bool remove(string guiimagelist, int index){ /// public class GuiInspectorObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorObject(ref Omni ts){m_ts = ts;} /// /// ( id object, (bool autoSync = true) ) - Add the object to the list of objects being inspected. ) +/// /// public void GuiInspector_addInspect(string guiinspector, string className, bool autoSync = true){ @@ -11533,6 +16095,7 @@ public void GuiInspector_addInspect(string guiinspector, string className, bool } /// /// apply() - Force application of inspected object's attributes ) +/// /// public void GuiInspector_apply(string guiinspector){ @@ -11541,6 +16104,7 @@ public void GuiInspector_apply(string guiinspector){ } /// /// getInspectObject( int index=0 ) - Returns currently inspected object ) +/// /// public string GuiInspector_getInspectObject(string guiinspector, uint index = 0){ @@ -11549,6 +16113,7 @@ public string GuiInspector_getInspectObject(string guiinspector, uint index = 0 } /// /// () - Return the number of objects currently being inspected. ) +/// /// public int GuiInspector_getNumInspectObjects(string guiinspector){ @@ -11557,6 +16122,7 @@ public int GuiInspector_getNumInspectObjects(string guiinspector){ } /// /// Inspect(Object)) +/// /// public void GuiInspector_inspect(string guiinspector, string className){ @@ -11565,6 +16131,7 @@ public void GuiInspector_inspect(string guiinspector, string className){ } /// /// Reinspect the currently selected object. ) +/// /// public void GuiInspector_refresh(string guiinspector){ @@ -11573,6 +16140,7 @@ public void GuiInspector_refresh(string guiinspector){ } /// /// ( id object ) - Remove the object from the list of objects being inspected. ) +/// /// public void GuiInspector_removeInspect(string guiinspector, string obj){ @@ -11581,6 +16149,7 @@ public void GuiInspector_removeInspect(string guiinspector, string obj){ } /// /// setName(NewObjectName)) +/// /// public void GuiInspector_setName(string guiinspector, string newObjectName){ @@ -11589,6 +16158,7 @@ public void GuiInspector_setName(string guiinspector, string newObjectName){ } /// /// setObjectField( fieldname, data ) - Set a named fields value on the inspected object if it exists. This triggers all the usual callbacks that would occur if the field had been changed through the gui. ) +/// /// public void GuiInspector_setObjectField(string guiinspector, string fieldname, string data){ @@ -11601,14 +16171,9 @@ public void GuiInspector_setObjectField(string guiinspector, string fieldname, /// public class GuiInspectorDynamicFieldObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorDynamicFieldObject(ref Omni ts){m_ts = ts;} /// /// field.renameField(newDynamicFieldName); ) +/// /// public void GuiInspectorDynamicField_renameField(string guiinspectordynamicfield, string newDynamicFieldName){ @@ -11621,14 +16186,9 @@ public void GuiInspectorDynamicField_renameField(string guiinspectordynamicfiel /// public class GuiInspectorDynamicGroupObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorDynamicGroupObject(ref Omni ts){m_ts = ts;} /// /// obj.addDynamicField(); ) +/// /// public void GuiInspectorDynamicGroup_addDynamicField(string guiinspectordynamicgroup){ @@ -11637,6 +16197,7 @@ public void GuiInspectorDynamicGroup_addDynamicField(string guiinspectordynamic } /// /// Refreshes the dynamic fields in the inspector.) +/// /// public bool GuiInspectorDynamicGroup_inspectGroup(string guiinspectordynamicgroup){ @@ -11645,6 +16206,7 @@ public bool GuiInspectorDynamicGroup_inspectGroup(string guiinspectordynamicgro } /// /// ) +/// /// public void GuiInspectorDynamicGroup_removeDynamicField(string guiinspectordynamicgroup){ @@ -11657,14 +16219,9 @@ public void GuiInspectorDynamicGroup_removeDynamicField(string guiinspectordyna /// public class GuiInspectorFieldObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorFieldObject(ref Omni ts){m_ts = ts;} /// /// , true), ( string newValue, bool callbacks=true ) - Set the field's value. Suppress callbacks for undo if callbacks=false. ) +/// /// public void GuiInspectorField_apply(string guiinspectorfield, string newValue = "", bool callbacks = true){ @@ -11673,6 +16230,7 @@ public void GuiInspectorField_apply(string guiinspectorfield, string newValue = } /// /// () - Set field value without recording undo (same as 'apply( value, false )'). ) +/// /// public void GuiInspectorField_applyWithoutUndo(string guiinspectorfield, string data){ @@ -11681,6 +16239,7 @@ public void GuiInspectorField_applyWithoutUndo(string guiinspectorfield, string } /// /// () - Return the value currently displayed on the field. ) +/// /// public string GuiInspectorField_getData(string guiinspectorfield){ @@ -11689,6 +16248,7 @@ public string GuiInspectorField_getData(string guiinspectorfield){ } /// /// () - Return the name of the field edited by this inspector field. ) +/// /// public string GuiInspectorField_getInspectedFieldName(string guiinspectorfield){ @@ -11697,6 +16257,7 @@ public string GuiInspectorField_getInspectedFieldName(string guiinspectorfield) } /// /// () - Return the type of the field edited by this inspector field. ) +/// /// public string GuiInspectorField_getInspectedFieldType(string guiinspectorfield){ @@ -11705,6 +16266,7 @@ public string GuiInspectorField_getInspectedFieldType(string guiinspectorfield) } /// /// () - Return the GuiInspector to which this field belongs. ) +/// /// public int GuiInspectorField_getInspector(string guiinspectorfield){ @@ -11713,6 +16275,7 @@ public int GuiInspectorField_getInspector(string guiinspectorfield){ } /// /// () - Reset to default value. ) +/// /// public void GuiInspectorField_reset(string guiinspectorfield){ @@ -11725,14 +16288,9 @@ public void GuiInspectorField_reset(string guiinspectorfield){ /// public class GuiInspectorTypeBitMask32Object { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorTypeBitMask32Object(ref Omni ts){m_ts = ts;} /// /// ( GuiInspectorTypeBitMask32, applyBit, void, 2,2, apply(); ) +/// /// public void applyBit(string guiinspectortypebitmask32= ""){ @@ -11745,14 +16303,9 @@ public void applyBit(string guiinspectortypebitmask32= ""){ /// public class GuiInspectorTypeFileNameObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiInspectorTypeFileNameObject(ref Omni ts){m_ts = ts;} /// /// ( GuiInspectorTypeFileName, apply, void, 3,3, apply(newValue); ) +/// /// public void apply(string guiinspectortypefilename, string a2= ""){ @@ -11765,14 +16318,18 @@ public void apply(string guiinspectortypefilename, string a2= ""){ /// public class GuiListBoxCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiListBoxCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Checks if there is an item with the exact text of what is passed in, and if so the item is removed from the list and adds that item's data to the filtered list. @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. @tsexample // Define the itemName that we wish to add to the filtered item list. %itemName = \"This Item Name\"; // Add the item name to the filtered item list. %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); @endtsexample @see GuiControl) +/// @brief Checks if there is an item with the exact text of what is passed in, and if so +/// the item is removed from the list and adds that item's data to the filtered list. +/// @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. +/// @tsexample +/// // Define the itemName that we wish to add to the filtered item list. +/// %itemName = \"This Item Name\"; +/// // Add the item name to the filtered item list. +/// %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void addFilteredItem(string guilistboxctrl, string newItem){ @@ -11780,7 +16337,22 @@ public void addFilteredItem(string guilistboxctrl, string newItem){ m_ts.fnGuiListBoxCtrl_addFilteredItem(guilistboxctrl, newItem); } /// -/// ), @brief Adds an item to the end of the list with an optional color. @param newItem New item to add to the list. @param color Optional color parameter to add to the new item. @tsexample // Define the item to add to the list. %newItem = \"Gideon's Blue Coat\"; // Define the optional color for the new list item. %color = \"0.0 0.0 1.0\"; // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. %thisGuiListBoxCtrl.addItem(%newItem,%color); @endtsexample @return If not void, return value and description @see GuiControl @hide) +/// ), +/// @brief Adds an item to the end of the list with an optional color. +/// @param newItem New item to add to the list. +/// @param color Optional color parameter to add to the new item. +/// @tsexample +/// // Define the item to add to the list. +/// %newItem = \"Gideon's Blue Coat\"; +/// // Define the optional color for the new list item. +/// %color = \"0.0 0.0 1.0\"; +/// // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. +/// %thisGuiListBoxCtrl.addItem(%newItem,%color); +/// @endtsexample +/// @return If not void, return value and description +/// @see GuiControl +/// @hide) +/// /// public int addItem(string guilistboxctrl, string newItem, string color = ""){ @@ -11788,7 +16360,16 @@ public int addItem(string guilistboxctrl, string newItem, string color = ""){ return m_ts.fnGuiListBoxCtrl_addItem(guilistboxctrl, newItem, color); } /// -/// @brief Removes any custom coloring from an item at the defined index id in the list. @param index Index id for the item to clear any custom color from. @tsexample // Define the index id %index = \"4\"; // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry %thisGuiListBoxCtrl.clearItemColor(%index); @endtsexample @see GuiControl) +/// @brief Removes any custom coloring from an item at the defined index id in the list. +/// @param index Index id for the item to clear any custom color from. +/// @tsexample +/// // Define the index id +/// %index = \"4\"; +/// // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry +/// %thisGuiListBoxCtrl.clearItemColor(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearItemColor(string guilistboxctrl, int index){ @@ -11796,7 +16377,13 @@ public void clearItemColor(string guilistboxctrl, int index){ m_ts.fnGuiListBoxCtrl_clearItemColor(guilistboxctrl, index); } /// -/// @brief Clears all the items in the listbox. @tsexample // Inform the GuiListBoxCtrl object to clear all items from its list. %thisGuiListBoxCtrl.clearItems(); @endtsexample @see GuiControl) +/// @brief Clears all the items in the listbox. +/// @tsexample +/// // Inform the GuiListBoxCtrl object to clear all items from its list. +/// %thisGuiListBoxCtrl.clearItems(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearItems(string guilistboxctrl){ @@ -11804,7 +16391,14 @@ public void clearItems(string guilistboxctrl){ m_ts.fnGuiListBoxCtrl_clearItems(guilistboxctrl); } /// -/// @brief Sets all currently selected items to unselected. Detailed description @tsexample // Inform the GuiListBoxCtrl object to set all of its items to unselected./n %thisGuiListBoxCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Sets all currently selected items to unselected. +/// Detailed description +/// @tsexample +/// // Inform the GuiListBoxCtrl object to set all of its items to unselected./n +/// %thisGuiListBoxCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearSelection(string guilistboxctrl){ @@ -11812,7 +16406,16 @@ public void clearSelection(string guilistboxctrl){ m_ts.fnGuiListBoxCtrl_clearSelection(guilistboxctrl); } /// -/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. @param itemIndex Index id location to remove the item from. @tsexample // Define the index id we want to remove from the list %itemIndex = \"8\"; // Inform the GuiListBoxCtrl object to remove the item at the defined index id. %thisGuiListBoxCtrl.deleteItem(%itemIndex); @endtsexample @see References) +/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. +/// @param itemIndex Index id location to remove the item from. +/// @tsexample +/// // Define the index id we want to remove from the list +/// %itemIndex = \"8\"; +/// // Inform the GuiListBoxCtrl object to remove the item at the defined index id. +/// %thisGuiListBoxCtrl.deleteItem(%itemIndex); +/// @endtsexample +/// @see References) +/// /// public void deleteItem(string guilistboxctrl, int itemIndex){ @@ -11820,7 +16423,13 @@ public void deleteItem(string guilistboxctrl, int itemIndex){ m_ts.fnGuiListBoxCtrl_deleteItem(guilistboxctrl, itemIndex); } /// -/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. @tsexample \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet %thisGuiListBox.doMirror(); @endtsexample @see GuiCore) +/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. +/// @tsexample +/// \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet +/// %thisGuiListBox.doMirror(); +/// @endtsexample +/// @see GuiCore) +/// /// public void doMirror(string guilistboxctrl){ @@ -11828,7 +16437,20 @@ public void doMirror(string guilistboxctrl){ m_ts.fnGuiListBoxCtrl_doMirror(guilistboxctrl); } /// -/// @brief Returns index of item with matching text or -1 if none found. @param findText Text in the list to find. @param isCaseSensitive If true, the search will be case sensitive. @tsexample // Define the text we wish to find in the list. %findText = \"Hickory Smoked Gideon\"/n/n // Define if this is a case sensitive search or not. %isCaseSensitive = \"false\"; // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); @endtsexample @return Index id of item with matching text or -1 if none found. @see GuiControl) +/// @brief Returns index of item with matching text or -1 if none found. +/// @param findText Text in the list to find. +/// @param isCaseSensitive If true, the search will be case sensitive. +/// @tsexample +/// // Define the text we wish to find in the list. +/// %findText = \"Hickory Smoked Gideon\"/n/n +/// // Define if this is a case sensitive search or not. +/// %isCaseSensitive = \"false\"; +/// // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. +/// %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); +/// @endtsexample +/// @return Index id of item with matching text or -1 if none found. +/// @see GuiControl) +/// /// public int findItemText(string guilistboxctrl, string findText, bool bCaseSensitive = false){ @@ -11836,7 +16458,14 @@ public int findItemText(string guilistboxctrl, string findText, bool bCaseSensi return m_ts.fnGuiListBoxCtrl_findItemText(guilistboxctrl, findText, bCaseSensitive); } /// -/// @brief Returns the number of items in the list. @tsexample // Request the number of items in the list of the GuiListBoxCtrl object. %listItemCount = %thisGuiListBoxCtrl.getItemCount(); @endtsexample @return The number of items in the list. @see GuiControl) +/// @brief Returns the number of items in the list. +/// @tsexample +/// // Request the number of items in the list of the GuiListBoxCtrl object. +/// %listItemCount = %thisGuiListBoxCtrl.getItemCount(); +/// @endtsexample +/// @return The number of items in the list. +/// @see GuiControl) +/// /// public int getItemCount(string guilistboxctrl){ @@ -11844,7 +16473,17 @@ public int getItemCount(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getItemCount(guilistboxctrl); } /// -/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. @param index Index id to request the associated item from. @tsexample // Define the index id %index = \"12\"; // Request the item from the GuiListBoxCtrl object %object = %thisGuiListBoxCtrl.getItemObject(%index); @endtsexample @return The object associated with the item in the list. @see References) +/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. +/// @param index Index id to request the associated item from. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Request the item from the GuiListBoxCtrl object +/// %object = %thisGuiListBoxCtrl.getItemObject(%index); +/// @endtsexample +/// @return The object associated with the item in the list. +/// @see References) +/// /// public string getItemObject(string guilistboxctrl, int index){ @@ -11852,7 +16491,17 @@ public string getItemObject(string guilistboxctrl, int index){ return m_ts.fnGuiListBoxCtrl_getItemObject(guilistboxctrl, index); } /// -/// @brief Returns the text of the item at the specified index. @param index Index id to return the item text from. @tsexample // Define the index id entry to request the text from %index = \"12\"; // Request the item id text from the GuiListBoxCtrl object. %text = %thisGuiListBoxCtrl.getItemText(%index); @endtsexample @return The text of the requested index id. @see GuiControl) +/// @brief Returns the text of the item at the specified index. +/// @param index Index id to return the item text from. +/// @tsexample +/// // Define the index id entry to request the text from +/// %index = \"12\"; +/// // Request the item id text from the GuiListBoxCtrl object. +/// %text = %thisGuiListBoxCtrl.getItemText(%index); +/// @endtsexample +/// @return The text of the requested index id. +/// @see GuiControl) +/// /// public string getItemText(string guilistboxctrl, int index){ @@ -11860,7 +16509,14 @@ public string getItemText(string guilistboxctrl, int index){ return m_ts.fnGuiListBoxCtrl_getItemText(guilistboxctrl, index); } /// -/// @brief Request the item index for the item that was last clicked. @tsexample // Request the item index for the last clicked item in the list %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); @endtsexample @return Index id for the last clicked item in the list. @see GuiControl) +/// @brief Request the item index for the item that was last clicked. +/// @tsexample +/// // Request the item index for the last clicked item in the list +/// %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); +/// @endtsexample +/// @return Index id for the last clicked item in the list. +/// @see GuiControl) +/// /// public int getLastClickItem(string guilistboxctrl){ @@ -11868,7 +16524,14 @@ public int getLastClickItem(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getLastClickItem(guilistboxctrl); } /// -/// @brief Returns the number of items currently selected. @tsexample // Request the number of currently selected items %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); @endtsexample @return Number of currently selected items. @see GuiControl) +/// @brief Returns the number of items currently selected. +/// @tsexample +/// // Request the number of currently selected items +/// %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); +/// @endtsexample +/// @return Number of currently selected items. +/// @see GuiControl) +/// /// public int getSelCount(string guilistboxctrl){ @@ -11876,7 +16539,14 @@ public int getSelCount(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getSelCount(guilistboxctrl); } /// -/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. @tsexample // Request the index id of the currently selected item %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); @endtsexample @return The selected items index or -1 if none selected. @see GuiControl) +/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. +/// @tsexample +/// // Request the index id of the currently selected item +/// %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); +/// @endtsexample +/// @return The selected items index or -1 if none selected. +/// @see GuiControl) +/// /// public int getSelectedItem(string guilistboxctrl){ @@ -11884,7 +16554,14 @@ public int getSelectedItem(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getSelectedItem(guilistboxctrl); } /// -/// @brief Returns a space delimited list of the selected items indexes in the list. @tsexample // Request a space delimited list of the items in the GuiListBoxCtrl object. %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); @endtsexample @return Space delimited list of the selected items indexes in the list @see GuiControl) +/// @brief Returns a space delimited list of the selected items indexes in the list. +/// @tsexample +/// // Request a space delimited list of the items in the GuiListBoxCtrl object. +/// %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); +/// @endtsexample +/// @return Space delimited list of the selected items indexes in the list +/// @see GuiControl) +/// /// public string getSelectedItems(string guilistboxctrl){ @@ -11892,7 +16569,20 @@ public string getSelectedItems(string guilistboxctrl){ return m_ts.fnGuiListBoxCtrl_getSelectedItems(guilistboxctrl); } /// -/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. @param text Text item to add. @param index Index id to insert the list item text at. @tsexample // Define the text to insert %text = \"Secret Agent Gideon\"; // Define the index entry to insert the text at %index = \"14\"; // In form the GuiListBoxCtrl object to insert the text at the defined index. %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); @endtsexample @return If successful will return the index id assigned. If unsuccessful, will return -1. @see GuiControl) +/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. +/// @param text Text item to add. +/// @param index Index id to insert the list item text at. +/// @tsexample +/// // Define the text to insert +/// %text = \"Secret Agent Gideon\"; +/// // Define the index entry to insert the text at +/// %index = \"14\"; +/// // In form the GuiListBoxCtrl object to insert the text at the defined index. +/// %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); +/// @endtsexample +/// @return If successful will return the index id assigned. If unsuccessful, will return -1. +/// @see GuiControl) +/// /// public void insertItem(string guilistboxctrl, string text, int index){ @@ -11900,7 +16590,16 @@ public void insertItem(string guilistboxctrl, string text, int index){ m_ts.fnGuiListBoxCtrl_insertItem(guilistboxctrl, text, index); } /// -/// @brief Removes an item of the entered name from the filtered items list. @param itemName Name of the item to remove from the filtered list. @tsexample // Define the itemName that you wish to remove. %itemName = \"This Item Name\"; // Remove the itemName from the GuiListBoxCtrl %thisGuiListBoxCtrl.removeFilteredItem(%itemName); @endtsexample @see GuiControl) +/// @brief Removes an item of the entered name from the filtered items list. +/// @param itemName Name of the item to remove from the filtered list. +/// @tsexample +/// // Define the itemName that you wish to remove. +/// %itemName = \"This Item Name\"; +/// // Remove the itemName from the GuiListBoxCtrl +/// %thisGuiListBoxCtrl.removeFilteredItem(%itemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void removeFilteredItem(string guilistboxctrl, string itemName){ @@ -11908,7 +16607,16 @@ public void removeFilteredItem(string guilistboxctrl, string itemName){ m_ts.fnGuiListBoxCtrl_removeFilteredItem(guilistboxctrl, itemName); } /// -/// @brief Sets the currently selected item at the specified index. @param indexId Index Id to set selected. @tsexample // Define the index id that we wish to select. %selectId = \"4\"; // Inform the GuiListBoxCtrl object to set the requested index as selected. %thisGuiListBoxCtrl.setCurSel(%selectId); @endtsexample @see GuiControl) +/// @brief Sets the currently selected item at the specified index. +/// @param indexId Index Id to set selected. +/// @tsexample +/// // Define the index id that we wish to select. +/// %selectId = \"4\"; +/// // Inform the GuiListBoxCtrl object to set the requested index as selected. +/// %thisGuiListBoxCtrl.setCurSel(%selectId); +/// @endtsexample +/// @see GuiControl) +/// /// public void setCurSel(string guilistboxctrl, int indexId){ @@ -11916,7 +16624,19 @@ public void setCurSel(string guilistboxctrl, int indexId){ m_ts.fnGuiListBoxCtrl_setCurSel(guilistboxctrl, indexId); } /// -/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list @param indexStart Index Id to start selection. @param indexStop Index Id to end selection. @tsexample // Set start id %indexStart = \"3\"; // Set end id %indexEnd = \"6\"; // Request the GuiListBoxCtrl object to select the defined range. %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); @endtsexample @see GuiControl) +/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list +/// @param indexStart Index Id to start selection. +/// @param indexStop Index Id to end selection. +/// @tsexample +/// // Set start id +/// %indexStart = \"3\"; +/// // Set end id +/// %indexEnd = \"6\"; +/// // Request the GuiListBoxCtrl object to select the defined range. +/// %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); +/// @endtsexample +/// @see GuiControl) +/// /// public void setCurSelRange(string guilistboxctrl, int indexStart, int indexStop = 999999){ @@ -11924,7 +16644,19 @@ public void setCurSelRange(string guilistboxctrl, int indexStart, int indexStop m_ts.fnGuiListBoxCtrl_setCurSelRange(guilistboxctrl, indexStart, indexStop); } /// -/// @brief Sets the color of a single list entry at the specified index id. @param index Index id to modify the color of in the list. @param color Color value to set the list entry to. @tsexample // Define the index id value %index = \"5\"; // Define the color value %color = \"1.0 0.0 0.0\"; // Inform the GuiListBoxCtrl object to change the color of the requested index %thisGuiListBoxCtrl.setItemColor(%index,%color); @endtsexample @see GuiControl) +/// @brief Sets the color of a single list entry at the specified index id. +/// @param index Index id to modify the color of in the list. +/// @param color Color value to set the list entry to. +/// @tsexample +/// // Define the index id value +/// %index = \"5\"; +/// // Define the color value +/// %color = \"1.0 0.0 0.0\"; +/// // Inform the GuiListBoxCtrl object to change the color of the requested index +/// %thisGuiListBoxCtrl.setItemColor(%index,%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void setItemColor(string guilistboxctrl, int index, ColorF color){ @@ -11932,7 +16664,19 @@ public void setItemColor(string guilistboxctrl, int index, ColorF color){ m_ts.fnGuiListBoxCtrl_setItemColor(guilistboxctrl, index, color.AsString()); } /// -/// @brief Sets the items text at the specified index. @param index Index id to set the item text at. @param newtext Text to change the list item at index id to. @tsexample // Define the index id/n %index = \"12\"; // Define the text to set the list item to %newtext = \"Gideon's Fancy Goggles\"; // Inform the GuiListBoxCtrl object to change the text at the requested index %thisGuiListBoxCtrl.setItemText(%index,%newText); @endtsexample @see GuiControl) +/// @brief Sets the items text at the specified index. +/// @param index Index id to set the item text at. +/// @param newtext Text to change the list item at index id to. +/// @tsexample +/// // Define the index id/n +/// %index = \"12\"; +/// // Define the text to set the list item to +/// %newtext = \"Gideon's Fancy Goggles\"; +/// // Inform the GuiListBoxCtrl object to change the text at the requested index +/// %thisGuiListBoxCtrl.setItemText(%index,%newText); +/// @endtsexample +/// @see GuiControl) +/// /// public void setItemText(string guilistboxctrl, int index, string newtext){ @@ -11940,7 +16684,19 @@ public void setItemText(string guilistboxctrl, int index, string newtext){ m_ts.fnGuiListBoxCtrl_setItemText(guilistboxctrl, index, newtext); } /// -/// @brief Set the tooltip text to display for the given list item. @param index Index id to change the tooltip text @param text Text for the tooltip. @tsexample // Define the index id %index = \"12\"; // Define the tooltip text %tooltip = \"Gideon's goggles can see through space and time.\" // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); @endtsexample @see GuiControl) +/// @brief Set the tooltip text to display for the given list item. +/// @param index Index id to change the tooltip text +/// @param text Text for the tooltip. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Define the tooltip text +/// %tooltip = \"Gideon's goggles can see through space and time.\" +/// // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id +/// %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); +/// @endtsexample +/// @see GuiControl) +/// /// public void setItemTooltip(string guilistboxctrl, int index, string text){ @@ -11948,7 +16704,16 @@ public void setItemTooltip(string guilistboxctrl, int index, string text){ m_ts.fnGuiListBoxCtrl_setItemTooltip(guilistboxctrl, index, text); } /// -/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. @param allowMultSelections Boolean variable to set the use of multiple selections or not. @tsexample // Define the multiple selection use state. %allowMultSelections = \"true\"; // Set the allow multiple selection state on the GuiListBoxCtrl object. %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); @endtsexample @see GuiControl) +/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. +/// @param allowMultSelections Boolean variable to set the use of multiple selections or not. +/// @tsexample +/// // Define the multiple selection use state. +/// %allowMultSelections = \"true\"; +/// // Set the allow multiple selection state on the GuiListBoxCtrl object. +/// %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); +/// @endtsexample +/// @see GuiControl) +/// /// public void setMultipleSelection(string guilistboxctrl, bool allowMultSelections){ @@ -11956,7 +16721,20 @@ public void setMultipleSelection(string guilistboxctrl, bool allowMultSelection m_ts.fnGuiListBoxCtrl_setMultipleSelection(guilistboxctrl, allowMultSelections); } /// -/// @brief Sets the item at the index specified to selected or not. Detailed description @param index Item index to set selected or unselected. @param setSelected Boolean selection state to set the requested item index. @tsexample // Define the index %index = \"5\"; // Define the selection state %selected = \"true\" // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. %thisGuiListBoxCtrl.setSelected(%index,%selected); @endtsexample @see GuiControl) +/// @brief Sets the item at the index specified to selected or not. +/// Detailed description +/// @param index Item index to set selected or unselected. +/// @param setSelected Boolean selection state to set the requested item index. +/// @tsexample +/// // Define the index +/// %index = \"5\"; +/// // Define the selection state +/// %selected = \"true\" +/// // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. +/// %thisGuiListBoxCtrl.setSelected(%index,%selected); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSelected(string guilistboxctrl, int index, bool setSelected = true){ @@ -11969,14 +16747,10 @@ public void setSelected(string guilistboxctrl, int index, bool setSelected = tr /// public class GuiMaterialCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMaterialCtrlObject(ref Omni ts){m_ts = ts;} /// -/// ( string materialName ) Set the material to be displayed in the control. ) +/// ( string materialName ) +/// Set the material to be displayed in the control. ) +/// /// public bool GuiMaterialCtrl_setMaterial(string guimaterialctrl, string materialName){ @@ -11989,14 +16763,9 @@ public bool GuiMaterialCtrl_setMaterial(string guimaterialctrl, string material /// public class GuiMaterialPreviewObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMaterialPreviewObject(ref Omni ts){m_ts = ts;} /// /// Deletes the preview model.) +/// /// public void deleteModel(string guimaterialpreview){ @@ -12005,6 +16774,7 @@ public void deleteModel(string guimaterialpreview){ } /// /// Resets the viewport to default zoom, pan, rotate and lighting.) +/// /// public void reset(string guimaterialpreview){ @@ -12013,6 +16783,7 @@ public void reset(string guimaterialpreview){ } /// /// Sets the color of the ambient light in the scene.) +/// /// public void setAmbientLightColor(string guimaterialpreview, ColorF color){ @@ -12021,6 +16792,7 @@ public void setAmbientLightColor(string guimaterialpreview, ColorF color){ } /// /// Sets the color of the light in the scene.) +/// /// public void setLightColor(string guimaterialpreview, ColorF color){ @@ -12028,7 +16800,9 @@ public void setLightColor(string guimaterialpreview, ColorF color){ m_ts.fnGuiMaterialPreview_setLightColor(guimaterialpreview, color.AsString()); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display.) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display.) +/// /// public void setModel(string guimaterialpreview, string shapeName){ @@ -12036,7 +16810,10 @@ public void setModel(string guimaterialpreview, string shapeName){ m_ts.fnGuiMaterialPreview_setModel(guimaterialpreview, shapeName); } /// -/// Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. @param distance The distance to set the orbit to (will be clamped).) +/// Sets the distance at which the camera orbits the object. Clamped to the +/// acceptable range defined in the class by min and max orbit distances. +/// @param distance The distance to set the orbit to (will be clamped).) +/// /// public void setOrbitDistance(string guimaterialpreview, float distance){ @@ -12049,14 +16826,20 @@ public void setOrbitDistance(string guimaterialpreview, float distance){ /// public class GuiMenuBarObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMenuBarObject(ref Omni ts){m_ts = ts;} /// -/// @brief Adds a new menu to the menu bar. @param menuText Text to display for the new menu item. @param menuId ID for the new menu item. @tsexample // Define the menu text %menuText = \"New Menu\"; // Define the menu ID. %menuId = \"2\"; // Inform the GuiMenuBar control to add the new menu %thisGuiMenuBar.addMenu(%menuText,%menuId); @endtsexample @see GuiTickCtrl) +/// @brief Adds a new menu to the menu bar. +/// @param menuText Text to display for the new menu item. +/// @param menuId ID for the new menu item. +/// @tsexample +/// // Define the menu text +/// %menuText = \"New Menu\"; +/// // Define the menu ID. +/// %menuId = \"2\"; +/// // Inform the GuiMenuBar control to add the new menu +/// %thisGuiMenuBar.addMenu(%menuText,%menuId); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void addMenu(string guimenubar, string menuText, int menuId){ @@ -12064,7 +16847,29 @@ public void addMenu(string guimenubar, string menuText, int menuId){ m_ts.fnGuiMenuBar_addMenu(guimenubar, menuText, menuId); } /// -/// ,,0,,-1), @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menu Menu name or menu Id to add the new item to. @param menuItemText Text for the new menu item. @param menuItemId Id for the new menu item. @param accelerator Accelerator key for the new menu item. @param checkGroup Check group to include this menu item in. @tsexample // Define the menu we wish to add the item to %targetMenu = \"New Menu\"; or %menu = \"4\"; // Define the text for the new menu item %menuItemText = \"Menu Item\"; // Define the id for the new menu item %menuItemId = \"3\"; // Set the accelerator key to toggle this menu item with %accelerator = \"n\"; // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. %checkGroup = \"4\"; // Inform the GuiMenuBar control to add the new menu item with the defined fields %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); @endtsexample @see GuiTickCtrl) +/// ,,0,,-1), +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menu Menu name or menu Id to add the new item to. +/// @param menuItemText Text for the new menu item. +/// @param menuItemId Id for the new menu item. +/// @param accelerator Accelerator key for the new menu item. +/// @param checkGroup Check group to include this menu item in. +/// @tsexample +/// // Define the menu we wish to add the item to +/// %targetMenu = \"New Menu\"; or %menu = \"4\"; +/// // Define the text for the new menu item +/// %menuItemText = \"Menu Item\"; +/// // Define the id for the new menu item +/// %menuItemId = \"3\"; +/// // Set the accelerator key to toggle this menu item with +/// %accelerator = \"n\"; +/// // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. +/// %checkGroup = \"4\"; +/// // Inform the GuiMenuBar control to add the new menu item with the defined fields +/// %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void addMenuItem(string guimenubar, string targetMenu = "", string menuItemText = "", int menuItemId = 0, string accelerator = "", int checkGroup = -1){ @@ -12072,7 +16877,31 @@ public void addMenuItem(string guimenubar, string targetMenu = "", string menuI m_ts.fnGuiMenuBar_addMenuItem(guimenubar, targetMenu, menuItemText, menuItemId, accelerator, checkGroup); } /// -/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for the new submenu @param submenuItemId Id for the new submenu @param accelerator Accelerator key for the new submenu @param checkGroup Which check group the new submenu should be in, or -1 for none. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"New Submenu Item\"; // Define the id for the new submenu %submenuItemId = \"4\"; // Define the accelerator key for the new submenu %accelerator = \"n\"; // Define the checkgroup for the new submenu %checkgroup = \"7\"; // Request the GuiMenuBar control to add the new submenu with the defined information %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); @endtsexample @see GuiTickCtrl) +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for the new submenu +/// @param submenuItemId Id for the new submenu +/// @param accelerator Accelerator key for the new submenu +/// @param checkGroup Which check group the new submenu should be in, or -1 for none. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"New Submenu Item\"; +/// // Define the id for the new submenu +/// %submenuItemId = \"4\"; +/// // Define the accelerator key for the new submenu +/// %accelerator = \"n\"; +/// // Define the checkgroup for the new submenu +/// %checkgroup = \"7\"; +/// // Request the GuiMenuBar control to add the new submenu with the defined information +/// %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void addSubmenuItem(string guimenubar, string menuTarget, string menuItem, string submenuItemText, int submenuItemId, string accelerator, int checkGroup){ @@ -12080,7 +16909,16 @@ public void addSubmenuItem(string guimenubar, string menuTarget, string menuIte m_ts.fnGuiMenuBar_addSubmenuItem(guimenubar, menuTarget, menuItem, submenuItemText, submenuItemId, accelerator, checkGroup); } /// -/// @brief Removes all the menu items from the specified menu. @param menuTarget Menu to remove all items from @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar control to clear all menu items from the defined menu %thisGuiMenuBar.clearMenuItems(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes all the menu items from the specified menu. +/// @param menuTarget Menu to remove all items from +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar control to clear all menu items from the defined menu +/// %thisGuiMenuBar.clearMenuItems(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void clearMenuItems(string guimenubar, string menuTarget){ @@ -12088,7 +16926,13 @@ public void clearMenuItems(string guimenubar, string menuTarget){ m_ts.fnGuiMenuBar_clearMenuItems(guimenubar, menuTarget); } /// -/// @brief Clears all the menus from the menu bar. @tsexample // Inform the GuiMenuBar control to clear all menus from itself. %thisGuiMenuBar.clearMenus(); @endtsexample @see GuiTickCtrl) +/// @brief Clears all the menus from the menu bar. +/// @tsexample +/// // Inform the GuiMenuBar control to clear all menus from itself. +/// %thisGuiMenuBar.clearMenus(); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void clearMenus(string guimenubar, int param1, int param2){ @@ -12096,7 +16940,19 @@ public void clearMenus(string guimenubar, int param1, int param2){ m_ts.fnGuiMenuBar_clearMenus(guimenubar, param1, param2); } /// -/// @brief Removes all the menu items from the specified submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Inform the GuiMenuBar to remove all submenu items from the defined menu item %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); @endtsexample @see GuiControl) +/// @brief Removes all the menu items from the specified submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Inform the GuiMenuBar to remove all submenu items from the defined menu item +/// %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearSubmenuItems(string guimenubar, string menuTarget, string menuItem){ @@ -12104,7 +16960,16 @@ public void clearSubmenuItems(string guimenubar, string menuTarget, string menu m_ts.fnGuiMenuBar_clearSubmenuItems(guimenubar, menuTarget, menuItem); } /// -/// @brief Removes the specified menu from the menu bar. @param menuTarget Menu to remove from the menu bar @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar to remove the defined menu from the menu bar %thisGuiMenuBar.removeMenu(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu from the menu bar. +/// @param menuTarget Menu to remove from the menu bar +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar to remove the defined menu from the menu bar +/// %thisGuiMenuBar.removeMenu(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void removeMenu(string guimenubar, string menuTarget){ @@ -12112,7 +16977,19 @@ public void removeMenu(string guimenubar, string menuTarget){ m_ts.fnGuiMenuBar_removeMenu(guimenubar, menuTarget); } /// -/// @brief Removes the specified menu item from the menu. @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Request the GuiMenuBar control to remove the define menu item %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu item from the menu. +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Request the GuiMenuBar control to remove the define menu item +/// %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void removeMenuItem(string guimenubar, string menuTarget, string menuItemTarget){ @@ -12120,7 +16997,16 @@ public void removeMenuItem(string guimenubar, string menuTarget, string menuIte m_ts.fnGuiMenuBar_removeMenuItem(guimenubar, menuTarget, menuItemTarget); } /// -/// @brief Sets the menu bitmap index for the check mark image. @param bitmapIndex Bitmap index for the check mark image. @tsexample // Define the bitmap index %bitmapIndex = \"2\"; // Inform the GuiMenuBar control of the proper bitmap index for the check mark image %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu bitmap index for the check mark image. +/// @param bitmapIndex Bitmap index for the check mark image. +/// @tsexample +/// // Define the bitmap index +/// %bitmapIndex = \"2\"; +/// // Inform the GuiMenuBar control of the proper bitmap index for the check mark image +/// %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setCheckmarkBitmapIndex(string guimenubar, int bitmapindex){ @@ -12128,7 +17014,25 @@ public void setCheckmarkBitmapIndex(string guimenubar, int bitmapindex){ m_ts.fnGuiMenuBar_setCheckmarkBitmapIndex(guimenubar, bitmapindex); } /// -/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. @param menuTarget Menu to affect @param bitmapindex Bitmap index to set for the menu @param bitmaponly If true, only the bitmap will be rendered @param drawborder If true, a border will be drawn around the menu. @tsexample // Define the menuTarget to affect %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Set the bitmap index %bitmapIndex = \"5\"; // Set if we are only to render the bitmap or not %bitmaponly = \"true\"; // Set if we are rendering a border or not %drawborder = \"true\"; // Inform the GuiMenuBar of the bitmap and rendering changes %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); @endtsexample @see GuiTickCtrl) +/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. +/// @param menuTarget Menu to affect +/// @param bitmapindex Bitmap index to set for the menu +/// @param bitmaponly If true, only the bitmap will be rendered +/// @param drawborder If true, a border will be drawn around the menu. +/// @tsexample +/// // Define the menuTarget to affect +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Set the bitmap index +/// %bitmapIndex = \"5\"; +/// // Set if we are only to render the bitmap or not +/// %bitmaponly = \"true\"; +/// // Set if we are rendering a border or not +/// %drawborder = \"true\"; +/// // Inform the GuiMenuBar of the bitmap and rendering changes +/// %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuBitmapIndex(string guimenubar, string menuTarget, int bitmapindex, bool bitmaponly, bool drawborder){ @@ -12136,7 +17040,22 @@ public void setMenuBitmapIndex(string guimenubar, string menuTarget, int bitmap m_ts.fnGuiMenuBar_setMenuBitmapIndex(guimenubar, menuTarget, bitmapindex, bitmaponly, drawborder); } /// -/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. @param menuTarget Menu to affect the menuItem in @param menuItem Menu item to affect @param bitmapIndex Bitmap index to set the menu item to @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem\" %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the bitmapIndex %bitmapIndex = \"6\"; // Inform the GuiMenuBar control to set the menu item to the defined bitmap %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. +/// @param menuTarget Menu to affect the menuItem in +/// @param menuItem Menu item to affect +/// @param bitmapIndex Bitmap index to set the menu item to +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem\" +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the bitmapIndex +/// %bitmapIndex = \"6\"; +/// // Inform the GuiMenuBar control to set the menu item to the defined bitmap +/// %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemBitmap(string guimenubar, string menuTarget, string menuItemTarget, int bitmapIndex){ @@ -12144,7 +17063,18 @@ public void setMenuItemBitmap(string guimenubar, string menuTarget, string menu m_ts.fnGuiMenuBar_setMenuItemBitmap(guimenubar, menuTarget, menuItemTarget, bitmapIndex); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to work in @param menuItem Menu item to affect @param checked Whether we are setting it to checked or not @tsexample @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in +/// the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to work in +/// @param menuItem Menu item to affect +/// @param checked Whether we are setting it to checked or not +/// @tsexample +/// +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void setMenuItemChecked(string guimenubar, string menuTarget, string menuItemTarget, bool checkedx){ @@ -12152,7 +17082,24 @@ public void setMenuItemChecked(string guimenubar, string menuTarget, string men m_ts.fnGuiMenuBar_setMenuItemChecked(guimenubar, menuTarget, menuItemTarget, checkedx); } /// -/// @brief sets the menu item to enabled or disabled based on the enable parameter. The specified menu and menu item can either be text or ids. Detailed description @param menuTarget Menu to work in @param menuItemTarget The menu item inside of the menu to enable or disable @param enabled Boolean enable / disable value. @tsexample // Define the menu %menu = \"New Menu\"; or %menu = \"4\"; // Define the menu item %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the enabled state %enabled = \"true\"; // Inform the GuiMenuBar control to set the enabled state of the requested menu item %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); @endtsexample @see GuiTickCtrl) +/// @brief sets the menu item to enabled or disabled based on the enable parameter. +/// The specified menu and menu item can either be text or ids. +/// Detailed description +/// @param menuTarget Menu to work in +/// @param menuItemTarget The menu item inside of the menu to enable or disable +/// @param enabled Boolean enable / disable value. +/// @tsexample +/// // Define the menu +/// %menu = \"New Menu\"; or %menu = \"4\"; +/// // Define the menu item +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the enabled state +/// %enabled = \"true\"; +/// // Inform the GuiMenuBar control to set the enabled state of the requested menu item +/// %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemEnable(string guimenubar, string menuTarget, string menuItemTarget, bool enabled){ @@ -12160,7 +17107,22 @@ public void setMenuItemEnable(string guimenubar, string menuTarget, string menu m_ts.fnGuiMenuBar_setMenuItemEnable(guimenubar, menuTarget, menuItemTarget, enabled); } /// -/// @brief Sets the given menu item to be a submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param isSubmenu Whether or not the menuItem will become a subMenu or not @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define whether or not the Menu Item is a sub menu or not %isSubmenu = \"true\"; // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); @endtsexample @see GuiTickCtrl) +/// @brief Sets the given menu item to be a submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param isSubmenu Whether or not the menuItem will become a subMenu or not +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define whether or not the Menu Item is a sub menu or not +/// %isSubmenu = \"true\"; +/// // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. +/// %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemSubmenuState(string guimenubar, string menuTarget, string menuItem, bool isSubmenu){ @@ -12168,7 +17130,22 @@ public void setMenuItemSubmenuState(string guimenubar, string menuTarget, strin m_ts.fnGuiMenuBar_setMenuItemSubmenuState(guimenubar, menuTarget, menuItem, isSubmenu); } /// -/// @brief Sets the text of the specified menu item to the new string. @param menuTarget Menu to affect @param menuItem Menu item in the menu to change the text at @param newMenuItemText New menu text @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the new text for the menu item %newMenuItemText = \"Very New Menu Item\"; // Inform the GuiMenuBar control to change the defined menu item with the new text %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu item to the new string. +/// @param menuTarget Menu to affect +/// @param menuItem Menu item in the menu to change the text at +/// @param newMenuItemText New menu text +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the new text for the menu item +/// %newMenuItemText = \"Very New Menu Item\"; +/// // Inform the GuiMenuBar control to change the defined menu item with the new text +/// %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemText(string guimenubar, string menuTarget, string menuItemTarget, string newMenuItemText){ @@ -12176,7 +17153,23 @@ public void setMenuItemText(string guimenubar, string menuTarget, string menuIt m_ts.fnGuiMenuBar_setMenuItemText(guimenubar, menuTarget, menuItemTarget, newMenuItemText); } /// -/// @brief Brief Description. Detailed description @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @param isVisible Visible state to set the menu item to. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the visibility state %isVisible = \"true\"; // Inform the GuiMenuBarControl of the visibility state of the defined menu item %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); @endtsexample @see GuiTickCtrl) +/// @brief Brief Description. +/// Detailed description +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @param isVisible Visible state to set the menu item to. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the visibility state +/// %isVisible = \"true\"; +/// // Inform the GuiMenuBarControl of the visibility state of the defined menu item +/// %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuItemVisible(string guimenubar, string menuTarget, string menuItemTarget, bool isVisible){ @@ -12184,7 +17177,23 @@ public void setMenuItemVisible(string guimenubar, string menuTarget, string men m_ts.fnGuiMenuBar_setMenuItemVisible(guimenubar, menuTarget, menuItemTarget, isVisible); } /// -/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. Detailed description @param horizontalMargin Number of pixels on the left and right side of a menu's text. @param verticalMargin Number of pixels on the top and bottom of a menu's text. @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. @tsexample // Define the horizontalMargin %horizontalMargin = \"5\"; // Define the verticalMargin %verticalMargin = \"5\"; // Define the bitmapToTextSpacing %bitmapToTextSpacing = \"12\"; // Inform the GuiMenuBar control to set its margins based on the defined values. %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. +/// Detailed description +/// @param horizontalMargin Number of pixels on the left and right side of a menu's text. +/// @param verticalMargin Number of pixels on the top and bottom of a menu's text. +/// @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. +/// @tsexample +/// // Define the horizontalMargin +/// %horizontalMargin = \"5\"; +/// // Define the verticalMargin +/// %verticalMargin = \"5\"; +/// // Define the bitmapToTextSpacing +/// %bitmapToTextSpacing = \"12\"; +/// // Inform the GuiMenuBar control to set its margins based on the defined values. +/// %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuMargins(string guimenubar, int horizontalMargin, int verticalMargin, int bitmapToTextSpacing){ @@ -12192,7 +17201,19 @@ public void setMenuMargins(string guimenubar, int horizontalMargin, int vertica m_ts.fnGuiMenuBar_setMenuMargins(guimenubar, horizontalMargin, verticalMargin, bitmapToTextSpacing); } /// -/// @brief Sets the text of the specified menu to the new string. @param menuTarget Menu to affect @param newMenuText New menu text @tsexample // Define the menu to affect %menu = \"New Menu\"; or %menu = \"3\"; // Define the text to change the menu to %newMenuText = \"Still a New Menu\"; // Inform the GuiMenuBar control to change the defined menu to the defined text %thisGuiMenuBar.setMenuText(%menu,%newMenuText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu to the new string. +/// @param menuTarget Menu to affect +/// @param newMenuText New menu text +/// @tsexample +/// // Define the menu to affect +/// %menu = \"New Menu\"; or %menu = \"3\"; +/// // Define the text to change the menu to +/// %newMenuText = \"Still a New Menu\"; +/// // Inform the GuiMenuBar control to change the defined menu to the defined text +/// %thisGuiMenuBar.setMenuText(%menu,%newMenuText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuText(string guimenubar, string menuTarget, string newMenuText){ @@ -12200,7 +17221,19 @@ public void setMenuText(string guimenubar, string menuTarget, string newMenuTex m_ts.fnGuiMenuBar_setMenuText(guimenubar, menuTarget, newMenuText); } /// -/// @brief Sets the whether or not to display the specified menu. @param menuTarget Menu item to affect @param visible Whether the menu item will be visible or not @tsexample // Define the menu to work with %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define if the menu should be visible or not %visible = \"true\"; // Inform the GuiMenuBar control of the new visibility state for the defined menu %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); @endtsexample @see GuiTickCtrl) +/// @brief Sets the whether or not to display the specified menu. +/// @param menuTarget Menu item to affect +/// @param visible Whether the menu item will be visible or not +/// @tsexample +/// // Define the menu to work with +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define if the menu should be visible or not +/// %visible = \"true\"; +/// // Inform the GuiMenuBar control of the new visibility state for the defined menu +/// %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void setMenuVisible(string guimenubar, string menuTarget, bool visible){ @@ -12208,7 +17241,28 @@ public void setMenuVisible(string guimenubar, string menuTarget, bool visible){ m_ts.fnGuiMenuBar_setMenuVisible(guimenubar, menuTarget, visible); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for submenu @param checked Whether or not this submenu item will be checked. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"Submenu Item\"; // Define if this submenu item should be checked or not %checked = \"true\"; // Inform the GuiMenuBar control to set the checked state of the defined submenu item %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the +/// bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for submenu +/// @param checked Whether or not this submenu item will be checked. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"Submenu Item\"; +/// // Define if this submenu item should be checked or not +/// %checked = \"true\"; +/// // Inform the GuiMenuBar control to set the checked state of the defined submenu item +/// %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void setSubmenuItemChecked(string guimenubar, string menuTarget, string menuItemTarget, string submenuItemText, bool checkedx){ @@ -12221,14 +17275,9 @@ public void setSubmenuItemChecked(string guimenubar, string menuTarget, string /// public class GuiMeshRoadEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMeshRoadEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// deleteNode() ) +/// /// public void GuiMeshRoadEditorCtrl_deleteNode(string guimeshroadeditorctrl){ @@ -12237,6 +17286,7 @@ public void GuiMeshRoadEditorCtrl_deleteNode(string guimeshroadeditorctrl){ } /// /// ) +/// /// public string GuiMeshRoadEditorCtrl_getMode(string guimeshroadeditorctrl){ @@ -12245,6 +17295,7 @@ public string GuiMeshRoadEditorCtrl_getMode(string guimeshroadeditorctrl){ } /// /// ) +/// /// public float GuiMeshRoadEditorCtrl_getNodeDepth(string guimeshroadeditorctrl){ @@ -12253,6 +17304,7 @@ public float GuiMeshRoadEditorCtrl_getNodeDepth(string guimeshroadeditorctrl){ } /// /// ) +/// /// public Point3F GuiMeshRoadEditorCtrl_getNodeNormal(string guimeshroadeditorctrl){ @@ -12261,6 +17313,7 @@ public Point3F GuiMeshRoadEditorCtrl_getNodeNormal(string guimeshroadeditorctrl } /// /// ) +/// /// public Point3F GuiMeshRoadEditorCtrl_getNodePosition(string guimeshroadeditorctrl){ @@ -12269,6 +17322,7 @@ public Point3F GuiMeshRoadEditorCtrl_getNodePosition(string guimeshroadeditorct } /// /// ) +/// /// public float GuiMeshRoadEditorCtrl_getNodeWidth(string guimeshroadeditorctrl){ @@ -12277,6 +17331,7 @@ public float GuiMeshRoadEditorCtrl_getNodeWidth(string guimeshroadeditorctrl){ } /// /// ) +/// /// public int GuiMeshRoadEditorCtrl_getSelectedRoad(string guimeshroadeditorctrl){ @@ -12285,6 +17340,7 @@ public int GuiMeshRoadEditorCtrl_getSelectedRoad(string guimeshroadeditorctrl){ } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_matchTerrainToRoad(string guimeshroadeditorctrl){ @@ -12293,6 +17349,7 @@ public void GuiMeshRoadEditorCtrl_matchTerrainToRoad(string guimeshroadeditorct } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_regenerate(string guimeshroadeditorctrl){ @@ -12301,6 +17358,7 @@ public void GuiMeshRoadEditorCtrl_regenerate(string guimeshroadeditorctrl){ } /// /// setMode( String mode ) ) +/// /// public void GuiMeshRoadEditorCtrl_setMode(string guimeshroadeditorctrl, string mode){ @@ -12309,6 +17367,7 @@ public void GuiMeshRoadEditorCtrl_setMode(string guimeshroadeditorctrl, string } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_setNodeDepth(string guimeshroadeditorctrl, float depth){ @@ -12317,6 +17376,7 @@ public void GuiMeshRoadEditorCtrl_setNodeDepth(string guimeshroadeditorctrl, fl } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_setNodeNormal(string guimeshroadeditorctrl, Point3F normal){ @@ -12325,6 +17385,7 @@ public void GuiMeshRoadEditorCtrl_setNodeNormal(string guimeshroadeditorctrl, P } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_setNodePosition(string guimeshroadeditorctrl, Point3F pos){ @@ -12333,6 +17394,7 @@ public void GuiMeshRoadEditorCtrl_setNodePosition(string guimeshroadeditorctrl, } /// /// ) +/// /// public void GuiMeshRoadEditorCtrl_setNodeWidth(string guimeshroadeditorctrl, float width){ @@ -12341,6 +17403,7 @@ public void GuiMeshRoadEditorCtrl_setNodeWidth(string guimeshroadeditorctrl, fl } /// /// ), ) +/// /// public void GuiMeshRoadEditorCtrl_setSelectedRoad(string guimeshroadeditorctrl, string objName = ""){ @@ -12353,14 +17416,21 @@ public void GuiMeshRoadEditorCtrl_setSelectedRoad(string guimeshroadeditorctrl, /// public class GuiMessageVectorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMessageVectorCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Push a line onto the back of the list. @param item The GUI element being pushed into the control @tsexample // All messages are stored in this HudMessageVector, the actual // MainChatHud only displays the contents of this vector. new MessageVector(HudMessageVector); // Attach the MessageVector to the chat control chatHud.attach(HudMessageVector); @endtsexample @return Value) +/// @brief Push a line onto the back of the list. +/// +/// @param item The GUI element being pushed into the control +/// +/// @tsexample +/// // All messages are stored in this HudMessageVector, the actual +/// // MainChatHud only displays the contents of this vector. +/// new MessageVector(HudMessageVector); +/// // Attach the MessageVector to the chat control +/// chatHud.attach(HudMessageVector); +/// @endtsexample +/// +/// @return Value) +/// /// public bool attach(string guimessagevectorctrl, string item){ @@ -12368,7 +17438,18 @@ public bool attach(string guimessagevectorctrl, string item){ return m_ts.fnGuiMessageVectorCtrl_attach(guimessagevectorctrl, item); } /// -/// @brief Stop listing messages from the MessageVector previously attached to, if any. Detailed description @param param Description @tsexample // Deatch the MessageVector from HudMessageVector // HudMessageVector will no longer render the text chatHud.detach(); @endtsexample) +/// @brief Stop listing messages from the MessageVector previously attached to, if any. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Deatch the MessageVector from HudMessageVector +/// // HudMessageVector will no longer render the text +/// chatHud.detach(); +/// @endtsexample) +/// /// public void detach(string guimessagevectorctrl){ @@ -12381,14 +17462,9 @@ public void detach(string guimessagevectorctrl){ /// public class GuiMissionAreaCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMissionAreaCtrlObject(ref Omni ts){m_ts = ts;} /// /// @brief Set the MissionArea to edit.) +/// /// public void setMissionArea(string guimissionareactrl, string area){ @@ -12397,6 +17473,7 @@ public void setMissionArea(string guimissionareactrl, string area){ } /// /// @brief Update the terrain bitmap.) +/// /// public void updateTerrain(string guimissionareactrl){ @@ -12409,14 +17486,9 @@ public void updateTerrain(string guimissionareactrl){ /// public class GuiMissionAreaEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMissionAreaEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public string GuiMissionAreaEditorCtrl_getSelectedMissionArea(string guimissionareaeditorctrl){ @@ -12425,6 +17497,7 @@ public string GuiMissionAreaEditorCtrl_getSelectedMissionArea(string guimission } /// /// ), ) +/// /// public void GuiMissionAreaEditorCtrl_setSelectedMissionArea(string guimissionareaeditorctrl, string missionAreaName = ""){ @@ -12437,14 +17510,20 @@ public void GuiMissionAreaEditorCtrl_setSelectedMissionArea(string guimissionar /// public class GuiMLTextCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiMLTextCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Appends the text in the control with additional text. Also . @param text New text to append to the existing text. @param reformat If true, the control will also be visually reset (defaults to true). @tsexample // Define new text to add %text = \"New Text to Add\"; // Set reformat boolean %reformat = \"true\"; // Inform the control to add the new text %thisGuiMLTextCtrl.addText(%text,%reformat); @endtsexample @see GuiControl) +/// @brief Appends the text in the control with additional text. Also . +/// @param text New text to append to the existing text. +/// @param reformat If true, the control will also be visually reset (defaults to true). +/// @tsexample +/// // Define new text to add +/// %text = \"New Text to Add\"; +/// // Set reformat boolean +/// %reformat = \"true\"; +/// // Inform the control to add the new text +/// %thisGuiMLTextCtrl.addText(%text,%reformat); +/// @endtsexample +/// @see GuiControl) +/// /// public void addText(string guimltextctrl, string text, bool reformat = true){ @@ -12452,7 +17531,17 @@ public void addText(string guimltextctrl, string text, bool reformat = true){ m_ts.fnGuiMLTextCtrl_addText(guimltextctrl, text, reformat); } /// -/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. @tsexample // Define new text to add %newText = \"BACON!\"; // Add the new text to the control %thisGuiMLTextCtrl.addText(%newText); // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. %thisGuiMLTextCtrl.forceReflow(); @endtsexample @see GuiControl) +/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. +/// @tsexample +/// // Define new text to add +/// %newText = \"BACON!\"; +/// // Add the new text to the control +/// %thisGuiMLTextCtrl.addText(%newText); +/// // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. +/// %thisGuiMLTextCtrl.forceReflow(); +/// @endtsexample +/// @see GuiControl) +/// /// public void forceReflow(string guimltextctrl){ @@ -12460,7 +17549,14 @@ public void forceReflow(string guimltextctrl){ m_ts.fnGuiMLTextCtrl_forceReflow(guimltextctrl); } /// -/// @brief Returns the text from the control, including TorqueML characters. @tsexample // Get the text displayed in the control %controlText = %thisGuiMLTextCtrl.getText(); @endtsexample @return Text string displayed in the control, including any TorqueML characters. @see GuiControl) +/// @brief Returns the text from the control, including TorqueML characters. +/// @tsexample +/// // Get the text displayed in the control +/// %controlText = %thisGuiMLTextCtrl.getText(); +/// @endtsexample +/// @return Text string displayed in the control, including any TorqueML characters. +/// @see GuiControl) +/// /// public string getText(string guimltextctrl){ @@ -12468,7 +17564,13 @@ public string getText(string guimltextctrl){ return m_ts.fnGuiMLTextCtrl_getText(guimltextctrl); } /// -/// @brief Scroll to the bottom of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its bottom %thisGuiMLTextCtrl.scrollToBottom(); @endtsexample @see GuiControl) +/// @brief Scroll to the bottom of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its bottom +/// %thisGuiMLTextCtrl.scrollToBottom(); +/// @endtsexample +/// @see GuiControl) +/// /// public void scrollToBottom(string guimltextctrl){ @@ -12476,7 +17578,17 @@ public void scrollToBottom(string guimltextctrl){ m_ts.fnGuiMLTextCtrl_scrollToBottom(guimltextctrl); } /// -/// @brief Scroll down to a specified tag. Detailed description @param tagID TagID to scroll the control to @tsexample // Define the TagID we want to scroll the control to %tagId = \"4\"; // Inform the GuiMLTextCtrl to scroll to the defined TagID %thisGuiMLTextCtrl.scrollToTag(%tagId); @endtsexample @see GuiControl) +/// @brief Scroll down to a specified tag. +/// Detailed description +/// @param tagID TagID to scroll the control to +/// @tsexample +/// // Define the TagID we want to scroll the control to +/// %tagId = \"4\"; +/// // Inform the GuiMLTextCtrl to scroll to the defined TagID +/// %thisGuiMLTextCtrl.scrollToTag(%tagId); +/// @endtsexample +/// @see GuiControl) +/// /// public void scrollToTag(string guimltextctrl, int tagID){ @@ -12484,7 +17596,13 @@ public void scrollToTag(string guimltextctrl, int tagID){ m_ts.fnGuiMLTextCtrl_scrollToTag(guimltextctrl, tagID); } /// -/// @brief Scroll to the top of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its top %thisGuiMLTextCtrl.scrollToTop(); @endtsexample @see GuiControl) +/// @brief Scroll to the top of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its top +/// %thisGuiMLTextCtrl.scrollToTop(); +/// @endtsexample +/// @see GuiControl) +/// /// public void scrollToTop(string guimltextctrl, int param1, int param2){ @@ -12492,7 +17610,16 @@ public void scrollToTop(string guimltextctrl, int param1, int param2){ m_ts.fnGuiMLTextCtrl_scrollToTop(guimltextctrl, param1, param2); } /// -/// @brief Sets the alpha value of the control. @param alphaVal n - 1.0 floating value for the alpha @tsexample // Define the alphe value %alphaVal = \"0.5\"; // Inform the control to update its alpha value. %thisGuiMLTextCtrl.setAlpha(%alphaVal); @endtsexample @see GuiControl) +/// @brief Sets the alpha value of the control. +/// @param alphaVal n - 1.0 floating value for the alpha +/// @tsexample +/// // Define the alphe value +/// %alphaVal = \"0.5\"; +/// // Inform the control to update its alpha value. +/// %thisGuiMLTextCtrl.setAlpha(%alphaVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void setAlpha(string guimltextctrl, float alphaVal){ @@ -12500,7 +17627,17 @@ public void setAlpha(string guimltextctrl, float alphaVal){ m_ts.fnGuiMLTextCtrl_setAlpha(guimltextctrl, alphaVal); } /// -/// @brief Change the text cursor's position to a new defined offset within the text in the control. @param newPos Offset to place cursor. @tsexample // Define cursor offset position %position = \"23\"; // Inform the GuiMLTextCtrl object to move the cursor to the new position. %thisGuiMLTextCtrl.setCursorPosition(%position); @endtsexample @return Returns true if the cursor position moved, or false if the position was not changed. @see GuiControl) +/// @brief Change the text cursor's position to a new defined offset within the text in the control. +/// @param newPos Offset to place cursor. +/// @tsexample +/// // Define cursor offset position +/// %position = \"23\"; +/// // Inform the GuiMLTextCtrl object to move the cursor to the new position. +/// %thisGuiMLTextCtrl.setCursorPosition(%position); +/// @endtsexample +/// @return Returns true if the cursor position moved, or false if the position was not changed. +/// @see GuiControl) +/// /// public bool setCursorPosition(string guimltextctrl, int newPos){ @@ -12508,7 +17645,16 @@ public bool setCursorPosition(string guimltextctrl, int newPos){ return m_ts.fnGuiMLTextCtrl_setCursorPosition(guimltextctrl, newPos); } /// -/// @brief Set the text contained in the control. @param text The text to display in the control. @tsexample // Define the text to display %text = \"Nifty Control Text\"; // Set the text displayed within the control %thisGuiMLTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Set the text contained in the control. +/// @param text The text to display in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Nifty Control Text\"; +/// // Set the text displayed within the control +/// %thisGuiMLTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void setText(string guimltextctrl, string text){ @@ -12521,12 +17667,6 @@ public void setText(string guimltextctrl, string text){ /// public class GuiNavEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiNavEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) /// @@ -12623,14 +17763,15 @@ public void spawnPlayer(string guinaveditorctrl){ /// public class GuiObjectViewObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiObjectViewObject(ref Omni ts){m_ts = ts;} /// -/// @brief Return the current multiplier for camera zooming and rotation. @tsexample // Request the current camera zooming and rotation multiplier value %multiplier = %thisGuiObjectView.getCameraSpeed(); @endtsexample @return Camera zooming / rotation multiplier value. @see GuiControl) +/// @brief Return the current multiplier for camera zooming and rotation. +/// @tsexample +/// // Request the current camera zooming and rotation multiplier value +/// %multiplier = %thisGuiObjectView.getCameraSpeed(); +/// @endtsexample +/// @return Camera zooming / rotation multiplier value. +/// @see GuiControl) +/// /// public float getCameraSpeed(string guiobjectview){ @@ -12638,7 +17779,14 @@ public float getCameraSpeed(string guiobjectview){ return m_ts.fnGuiObjectView_getCameraSpeed(guiobjectview); } /// -/// @brief Return the model displayed in this view. @tsexample // Request the displayed model name from the GuiObjectView object. %modelName = %thisGuiObjectView.getModel(); @endtsexample @return Name of the displayed model. @see GuiControl) +/// @brief Return the model displayed in this view. +/// @tsexample +/// // Request the displayed model name from the GuiObjectView object. +/// %modelName = %thisGuiObjectView.getModel(); +/// @endtsexample +/// @return Name of the displayed model. +/// @see GuiControl) +/// /// public string getModel(string guiobjectview){ @@ -12646,7 +17794,14 @@ public string getModel(string guiobjectview){ return m_ts.fnGuiObjectView_getModel(guiobjectview); } /// -/// @brief Return the name of the mounted model. @tsexample // Request the name of the mounted model from the GuiObjectView object %mountedModelName = %thisGuiObjectView.getMountedModel(); @endtsexample @return Name of the mounted model. @see GuiControl) +/// @brief Return the name of the mounted model. +/// @tsexample +/// // Request the name of the mounted model from the GuiObjectView object +/// %mountedModelName = %thisGuiObjectView.getMountedModel(); +/// @endtsexample +/// @return Name of the mounted model. +/// @see GuiControl) +/// /// public string getMountedModel(string guiobjectview){ @@ -12654,7 +17809,14 @@ public string getMountedModel(string guiobjectview){ return m_ts.fnGuiObjectView_getMountedModel(guiobjectview); } /// -/// @brief Return the name of skin used on the mounted model. @tsexample // Request the skin name from the model mounted on to the main model in the control %mountModelSkin = %thisGuiObjectView.getMountSkin(); @endtsexample @return Name of the skin used on the mounted model. @see GuiControl) +/// @brief Return the name of skin used on the mounted model. +/// @tsexample +/// // Request the skin name from the model mounted on to the main model in the control +/// %mountModelSkin = %thisGuiObjectView.getMountSkin(); +/// @endtsexample +/// @return Name of the skin used on the mounted model. +/// @see GuiControl) +/// /// public string getMountSkin(string guiobjectview, int param1, int param2){ @@ -12662,7 +17824,14 @@ public string getMountSkin(string guiobjectview, int param1, int param2){ return m_ts.fnGuiObjectView_getMountSkin(guiobjectview, param1, param2); } /// -/// @brief Return the current distance at which the camera orbits the object. @tsexample // Request the current orbit distance %orbitDistance = %thisGuiObjectView.getOrbitDistance(); @endtsexample @return The distance at which the camera orbits the object. @see GuiControl) +/// @brief Return the current distance at which the camera orbits the object. +/// @tsexample +/// // Request the current orbit distance +/// %orbitDistance = %thisGuiObjectView.getOrbitDistance(); +/// @endtsexample +/// @return The distance at which the camera orbits the object. +/// @see GuiControl) +/// /// public float getOrbitDistance(string guiobjectview){ @@ -12670,7 +17839,14 @@ public float getOrbitDistance(string guiobjectview){ return m_ts.fnGuiObjectView_getOrbitDistance(guiobjectview); } /// -/// @brief Return the name of skin used on the primary model. @tsexample // Request the name of the skin used on the primary model in the control %skinName = %thisGuiObjectView.getSkin(); @endtsexample @return Name of the skin used on the primary model. @see GuiControl) +/// @brief Return the name of skin used on the primary model. +/// @tsexample +/// // Request the name of the skin used on the primary model in the control +/// %skinName = %thisGuiObjectView.getSkin(); +/// @endtsexample +/// @return Name of the skin used on the primary model. +/// @see GuiControl) +/// /// public string getSkin(string guiobjectview){ @@ -12678,7 +17854,16 @@ public string getSkin(string guiobjectview){ return m_ts.fnGuiObjectView_getSkin(guiobjectview); } /// -/// @brief Sets the multiplier for the camera rotation and zoom speed. @param factor Multiplier for camera rotation and zoom speed. @tsexample // Set the factor value %factor = \"0.75\"; // Inform the GuiObjectView object to set the camera speed. %thisGuiObjectView.setCameraSpeed(%factor); @endtsexample @see GuiControl) +/// @brief Sets the multiplier for the camera rotation and zoom speed. +/// @param factor Multiplier for camera rotation and zoom speed. +/// @tsexample +/// // Set the factor value +/// %factor = \"0.75\"; +/// // Inform the GuiObjectView object to set the camera speed. +/// %thisGuiObjectView.setCameraSpeed(%factor); +/// @endtsexample +/// @see GuiControl) +/// /// public void setCameraSpeed(string guiobjectview, float factor){ @@ -12686,7 +17871,16 @@ public void setCameraSpeed(string guiobjectview, float factor){ m_ts.fnGuiObjectView_setCameraSpeed(guiobjectview, factor); } /// -/// @brief Set the light ambient color on the sun object used to render the model. @param color Ambient color of sunlight. @tsexample // Define the sun ambient color value %color = \"1.0 0.4 0.6\"; // Inform the GuiObjectView object to set the sun ambient color to the requested value %thisGuiObjectView.setLightAmbient(%color); @endtsexample @see GuiControl) +/// @brief Set the light ambient color on the sun object used to render the model. +/// @param color Ambient color of sunlight. +/// @tsexample +/// // Define the sun ambient color value +/// %color = \"1.0 0.4 0.6\"; +/// // Inform the GuiObjectView object to set the sun ambient color to the requested value +/// %thisGuiObjectView.setLightAmbient(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void setLightAmbient(string guiobjectview, ColorF color){ @@ -12694,7 +17888,16 @@ public void setLightAmbient(string guiobjectview, ColorF color){ m_ts.fnGuiObjectView_setLightAmbient(guiobjectview, color.AsString()); } /// -/// @brief Set the light color on the sun object used to render the model. @param color Color of sunlight. @tsexample // Set the color value for the sun %color = \"1.0 0.4 0.5\"; // Inform the GuiObjectView object to change the sun color to the defined value %thisGuiObjectView.setLightColor(%color); @endtsexample @see GuiControl) +/// @brief Set the light color on the sun object used to render the model. +/// @param color Color of sunlight. +/// @tsexample +/// // Set the color value for the sun +/// %color = \"1.0 0.4 0.5\"; +/// // Inform the GuiObjectView object to change the sun color to the defined value +/// %thisGuiObjectView.setLightColor(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void setLightColor(string guiobjectview, ColorF color){ @@ -12702,7 +17905,16 @@ public void setLightColor(string guiobjectview, ColorF color){ m_ts.fnGuiObjectView_setLightColor(guiobjectview, color.AsString()); } /// -/// @brief Set the light direction from which to light the model. @param direction XYZ direction from which the light will shine on the model @tsexample // Set the light direction %direction = \"1.0 0.2 0.4\" // Inform the GuiObjectView object to change the light direction to the defined value %thisGuiObjectView.setLightDirection(%direction); @endtsexample @see GuiControl) +/// @brief Set the light direction from which to light the model. +/// @param direction XYZ direction from which the light will shine on the model +/// @tsexample +/// // Set the light direction +/// %direction = \"1.0 0.2 0.4\" +/// // Inform the GuiObjectView object to change the light direction to the defined value +/// %thisGuiObjectView.setLightDirection(%direction); +/// @endtsexample +/// @see GuiControl) +/// /// public void setLightDirection(string guiobjectview, Point3F direction){ @@ -12710,7 +17922,16 @@ public void setLightDirection(string guiobjectview, Point3F direction){ m_ts.fnGuiObjectView_setLightDirection(guiobjectview, direction.AsString()); } /// -/// @brief Sets the model to be displayed in this control. @param shapeName Name of the model to display. @tsexample // Define the model we want to display %shapeName = \"gideon.dts\"; // Tell the GuiObjectView object to display the defined model %thisGuiObjectView.setModel(%shapeName); @endtsexample @see GuiControl) +/// @brief Sets the model to be displayed in this control. +/// @param shapeName Name of the model to display. +/// @tsexample +/// // Define the model we want to display +/// %shapeName = \"gideon.dts\"; +/// // Tell the GuiObjectView object to display the defined model +/// %thisGuiObjectView.setModel(%shapeName); +/// @endtsexample +/// @see GuiControl) +/// /// public void setModel(string guiobjectview, string shapeName){ @@ -12718,7 +17939,22 @@ public void setModel(string guiobjectview, string shapeName){ m_ts.fnGuiObjectView_setModel(guiobjectview, shapeName); } /// -/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. Detailed description @param shapeName Name of the model to mount. @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. @tsexample // Set the shapeName to mount %shapeName = \"GideonGlasses.dts\" // Set the mount node of the primary model in the control to mount the new shape at %mountNodeIndexOrName = \"3\"; //OR: %mountNodeIndexOrName = \"Face\"; // Inform the GuiObjectView object to mount the shape at the specified node. %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); @endtsexample @see GuiControl) +/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. +/// Detailed description +/// @param shapeName Name of the model to mount. +/// @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. +/// @tsexample +/// // Set the shapeName to mount +/// %shapeName = \"GideonGlasses.dts\" +/// // Set the mount node of the primary model in the control to mount the new shape at +/// %mountNodeIndexOrName = \"3\"; +/// //OR: +/// %mountNodeIndexOrName = \"Face\"; +/// // Inform the GuiObjectView object to mount the shape at the specified node. +/// %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); +/// @endtsexample +/// @see GuiControl) +/// /// public void setMount(string guiobjectview, string shapeName, string mountNodeIndexOrName){ @@ -12726,7 +17962,16 @@ public void setMount(string guiobjectview, string shapeName, string mountNodeIn m_ts.fnGuiObjectView_setMount(guiobjectview, shapeName, mountNodeIndexOrName); } /// -/// @brief Sets the model to be mounted on the primary model. @param shapeName Name of the model to mount. @tsexample // Define the model name to mount %modelToMount = \"GideonGlasses.dts\"; // Inform the GuiObjectView object to mount the defined model to the existing model in the control %thisGuiObjectView.setMountedModel(%modelToMount); @endtsexample @see GuiControl) +/// @brief Sets the model to be mounted on the primary model. +/// @param shapeName Name of the model to mount. +/// @tsexample +/// // Define the model name to mount +/// %modelToMount = \"GideonGlasses.dts\"; +/// // Inform the GuiObjectView object to mount the defined model to the existing model in the control +/// %thisGuiObjectView.setMountedModel(%modelToMount); +/// @endtsexample +/// @see GuiControl) +/// /// public void setMountedModel(string guiobjectview, string shapeName){ @@ -12734,7 +17979,16 @@ public void setMountedModel(string guiobjectview, string shapeName){ m_ts.fnGuiObjectView_setMountedModel(guiobjectview, shapeName); } /// -/// @brief Sets the skin to use on the mounted model. @param skinName Name of the skin to set on the model mounted to the main model in the control @tsexample // Define the name of the skin %skinName = \"BronzeGlasses\"; // Inform the GuiObjectView Control of the skin to use on the mounted model %thisGuiObjectViewCtrl.setMountSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the mounted model. +/// @param skinName Name of the skin to set on the model mounted to the main model in the control +/// @tsexample +/// // Define the name of the skin +/// %skinName = \"BronzeGlasses\"; +/// // Inform the GuiObjectView Control of the skin to use on the mounted model +/// %thisGuiObjectViewCtrl.setMountSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void setMountSkin(string guiobjectview, string skinName){ @@ -12742,7 +17996,17 @@ public void setMountSkin(string guiobjectview, string skinName){ m_ts.fnGuiObjectView_setMountSkin(guiobjectview, skinName); } /// -/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. Detailed description @param distance The distance to set the orbit to (will be clamped). @tsexample // Define the orbit distance value %orbitDistance = \"1.5\"; // Inform the GuiObjectView object to set the orbit distance to the defined value %thisGuiObjectView.setOrbitDistance(%orbitDistance); @endtsexample @see GuiControl) +/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. +/// Detailed description +/// @param distance The distance to set the orbit to (will be clamped). +/// @tsexample +/// // Define the orbit distance value +/// %orbitDistance = \"1.5\"; +/// // Inform the GuiObjectView object to set the orbit distance to the defined value +/// %thisGuiObjectView.setOrbitDistance(%orbitDistance); +/// @endtsexample +/// @see GuiControl) +/// /// public void setOrbitDistance(string guiobjectview, float distance){ @@ -12750,7 +18014,18 @@ public void setOrbitDistance(string guiobjectview, float distance){ m_ts.fnGuiObjectView_setOrbitDistance(guiobjectview, distance); } /// -/// @brief Sets the animation to play for the viewed object. @param indexOrName The index or name of the animation to play. @tsexample // Set the animation index value, or animation sequence name. %indexVal = \"3\"; //OR: %indexVal = \"idle\"; // Inform the GuiObjectView object to set the animation sequence of the object in the control. %thisGuiObjectVew.setSeq(%indexVal); @endtsexample @see GuiControl) +/// @brief Sets the animation to play for the viewed object. +/// @param indexOrName The index or name of the animation to play. +/// @tsexample +/// // Set the animation index value, or animation sequence name. +/// %indexVal = \"3\"; +/// //OR: +/// %indexVal = \"idle\"; +/// // Inform the GuiObjectView object to set the animation sequence of the object in the control. +/// %thisGuiObjectVew.setSeq(%indexVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSeq(string guiobjectview, string indexOrName){ @@ -12758,7 +18033,16 @@ public void setSeq(string guiobjectview, string indexOrName){ m_ts.fnGuiObjectView_setSeq(guiobjectview, indexOrName); } /// -/// @brief Sets the skin to use on the model being displayed. @param skinName Name of the skin to use. @tsexample // Define the skin we want to apply to the main model in the control %skinName = \"disco_gideon\"; // Inform the GuiObjectView control to update the skin the to defined skin %thisGuiObjectView.setSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the model being displayed. +/// @param skinName Name of the skin to use. +/// @tsexample +/// // Define the skin we want to apply to the main model in the control +/// %skinName = \"disco_gideon\"; +/// // Inform the GuiObjectView control to update the skin the to defined skin +/// %thisGuiObjectView.setSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSkin(string guiobjectview, string skinName){ @@ -12771,14 +18055,10 @@ public void setSkin(string guiobjectview, string skinName){ /// public class GuiPaneControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiPaneControlObject(ref Omni ts){m_ts = ts;} /// -/// Collapse or un-collapse the control. @param collapse True to collapse the control, false to un-collapse it ) +/// Collapse or un-collapse the control. +/// @param collapse True to collapse the control, false to un-collapse it ) +/// /// public void setCollapsed(string guipanecontrol, bool collapse){ @@ -12791,14 +18071,11 @@ public void setCollapsed(string guipanecontrol, bool collapse){ /// public class GuiParticleGraphCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiParticleGraphCtrlObject(ref Omni ts){m_ts = ts;} /// -/// (int plotID, float x, float y, bool setAdded = true;) Add a data point to the given plot. @return) +/// (int plotID, float x, float y, bool setAdded = true;) +/// Add a data point to the given plot. +/// @return) +/// /// public string GuiParticleGraphCtrl_addPlotPoint(string guiparticlegraphctrl, int plotID, float x, float y, bool setAdded = true){ @@ -12806,7 +18083,13 @@ public string GuiParticleGraphCtrl_addPlotPoint(string guiparticlegraphctrl, in return m_ts.fn_GuiParticleGraphCtrl_addPlotPoint(guiparticlegraphctrl, plotID, x, y, setAdded); } /// -/// (int plotID, int i, float x, float y) Change a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Change a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public string GuiParticleGraphCtrl_changePlotPoint(string guiparticlegraphctrl, int plotID, int i, float x, float y){ @@ -12814,7 +18097,10 @@ public string GuiParticleGraphCtrl_changePlotPoint(string guiparticlegraphctrl, return m_ts.fn_GuiParticleGraphCtrl_changePlotPoint(guiparticlegraphctrl, plotID, i, x, y); } /// -/// () Clear all of the graphs. @return No return value) +/// () +/// Clear all of the graphs. +/// @return No return value) +/// /// public void GuiParticleGraphCtrl_clearAllGraphs(string guiparticlegraphctrl){ @@ -12822,7 +18108,10 @@ public void GuiParticleGraphCtrl_clearAllGraphs(string guiparticlegraphctrl){ m_ts.fn_GuiParticleGraphCtrl_clearAllGraphs(guiparticlegraphctrl); } /// -/// (int plotID) Clear the graph of the given plot. @return No return value) +/// (int plotID) +/// Clear the graph of the given plot. +/// @return No return value) +/// /// public void GuiParticleGraphCtrl_clearGraph(string guiparticlegraphctrl, int plotID){ @@ -12830,7 +18119,10 @@ public void GuiParticleGraphCtrl_clearGraph(string guiparticlegraphctrl, int pl m_ts.fn_GuiParticleGraphCtrl_clearGraph(guiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the color of the graph passed. @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// (int plotID) +/// Get the color of the graph passed. +/// @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// /// public string GuiParticleGraphCtrl_getGraphColor(string guiparticlegraphctrl, int plotID){ @@ -12838,7 +18130,10 @@ public string GuiParticleGraphCtrl_getGraphColor(string guiparticlegraphctrl, i return m_ts.fn_GuiParticleGraphCtrl_getGraphColor(guiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the maximum values of the graph ranges. @return Returns the maximum of the range formatted as \"x-max y-max\") +/// (int plotID) +/// Get the maximum values of the graph ranges. +/// @return Returns the maximum of the range formatted as \"x-max y-max\") +/// /// public string GuiParticleGraphCtrl_getGraphMax(string guiparticlegraphctrl, int plotID){ @@ -12846,7 +18141,10 @@ public string GuiParticleGraphCtrl_getGraphMax(string guiparticlegraphctrl, int return m_ts.fn_GuiParticleGraphCtrl_getGraphMax(guiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the minimum values of the graph ranges. @return Returns the minimum of the range formatted as \"x-min y-min\") +/// (int plotID) +/// Get the minimum values of the graph ranges. +/// @return Returns the minimum of the range formatted as \"x-min y-min\") +/// /// public string GuiParticleGraphCtrl_getGraphMin(string guiparticlegraphctrl, int plotID){ @@ -12854,7 +18152,10 @@ public string GuiParticleGraphCtrl_getGraphMin(string guiparticlegraphctrl, int return m_ts.fn_GuiParticleGraphCtrl_getGraphMin(guiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the name of the graph passed. @return Returns the name of the plot) +/// (int plotID) +/// Get the name of the graph passed. +/// @return Returns the name of the plot) +/// /// public string GuiParticleGraphCtrl_getGraphName(string guiparticlegraphctrl, int plotID){ @@ -12862,7 +18163,12 @@ public string GuiParticleGraphCtrl_getGraphName(string guiparticlegraphctrl, in return m_ts.fn_GuiParticleGraphCtrl_getGraphName(guiparticlegraphctrl, plotID); } /// -/// (int plotID, float x, float y) Gets the index of the point passed on the plotID passed (graph ID). @param plotID The plot you wish to check. @param x,y The coordinates of the point to get. @return Returns the index of the point.) +/// (int plotID, float x, float y) +/// Gets the index of the point passed on the plotID passed (graph ID). +/// @param plotID The plot you wish to check. +/// @param x,y The coordinates of the point to get. +/// @return Returns the index of the point.) +/// /// public string GuiParticleGraphCtrl_getPlotIndex(string guiparticlegraphctrl, int plotID, float x, float y){ @@ -12870,7 +18176,10 @@ public string GuiParticleGraphCtrl_getPlotIndex(string guiparticlegraphctrl, in return m_ts.fn_GuiParticleGraphCtrl_getPlotIndex(guiparticlegraphctrl, plotID, x, y); } /// -/// (int plotID, int samples) Get a data point from the plot specified, samples from the start of the graph. @return The data point ID) +/// (int plotID, int samples) +/// Get a data point from the plot specified, samples from the start of the graph. +/// @return The data point ID) +/// /// public string GuiParticleGraphCtrl_getPlotPoint(string guiparticlegraphctrl, int plotID, int samples){ @@ -12878,7 +18187,10 @@ public string GuiParticleGraphCtrl_getPlotPoint(string guiparticlegraphctrl, in return m_ts.fn_GuiParticleGraphCtrl_getPlotPoint(guiparticlegraphctrl, plotID, samples); } /// -/// () Gets the selected Plot (a.k.a. graph). @return The plot's ID.) +/// () +/// Gets the selected Plot (a.k.a. graph). +/// @return The plot's ID.) +/// /// public string GuiParticleGraphCtrl_getSelectedPlot(string guiparticlegraphctrl){ @@ -12886,7 +18198,10 @@ public string GuiParticleGraphCtrl_getSelectedPlot(string guiparticlegraphctrl) return m_ts.fn_GuiParticleGraphCtrl_getSelectedPlot(guiparticlegraphctrl); } /// -/// () Gets the selected Point on the Plot (a.k.a. graph). @return The last selected point ID) +/// () +/// Gets the selected Point on the Plot (a.k.a. graph). +/// @return The last selected point ID) +/// /// public string GuiParticleGraphCtrl_getSelectedPoint(string guiparticlegraphctrl){ @@ -12894,7 +18209,13 @@ public string GuiParticleGraphCtrl_getSelectedPoint(string guiparticlegraphctrl return m_ts.fn_GuiParticleGraphCtrl_getSelectedPoint(guiparticlegraphctrl); } /// -/// (int plotID, int i, float x, float y) Insert a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Insert a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_insertPlotPoint(string guiparticlegraphctrl, int plotID, int i, float x, float y){ @@ -12902,7 +18223,9 @@ public void GuiParticleGraphCtrl_insertPlotPoint(string guiparticlegraphctrl, i m_ts.fn_GuiParticleGraphCtrl_insertPlotPoint(guiparticlegraphctrl, plotID, i, x, y); } /// -/// (int plotID, int samples) @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// (int plotID, int samples) +/// @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// /// public string GuiParticleGraphCtrl_isExistingPoint(string guiparticlegraphctrl, int plotID, int samples){ @@ -12910,7 +18233,10 @@ public string GuiParticleGraphCtrl_isExistingPoint(string guiparticlegraphctrl, return m_ts.fn_GuiParticleGraphCtrl_isExistingPoint(guiparticlegraphctrl, plotID, samples); } /// -/// () This will reset the currently selected point to nothing. @return No return value.) +/// () +/// This will reset the currently selected point to nothing. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_resetSelectedPoint(string guiparticlegraphctrl){ @@ -12918,7 +18244,11 @@ public void GuiParticleGraphCtrl_resetSelectedPoint(string guiparticlegraphctrl m_ts.fn_GuiParticleGraphCtrl_resetSelectedPoint(guiparticlegraphctrl); } /// -/// (bool autoMax) Set whether the max will automatically be set when adding points (ie if you add a value over the current max, the max is increased to that value). @return No return value.) +/// (bool autoMax) +/// Set whether the max will automatically be set when adding points +/// (ie if you add a value over the current max, the max is increased to that value). +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setAutoGraphMax(string guiparticlegraphctrl, bool autoMax){ @@ -12926,7 +18256,10 @@ public void GuiParticleGraphCtrl_setAutoGraphMax(string guiparticlegraphctrl, b m_ts.fn_GuiParticleGraphCtrl_setAutoGraphMax(guiparticlegraphctrl, autoMax); } /// -/// (bool autoRemove) Set whether or not a point should be deleted when you drag another one over it. @return No return value.) +/// (bool autoRemove) +/// Set whether or not a point should be deleted when you drag another one over it. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setAutoRemove(string guiparticlegraphctrl, bool autoRemove){ @@ -12934,7 +18267,10 @@ public void GuiParticleGraphCtrl_setAutoRemove(string guiparticlegraphctrl, boo m_ts.fn_GuiParticleGraphCtrl_setAutoRemove(guiparticlegraphctrl, autoRemove); } /// -/// (int plotID, bool isHidden) Set whether the graph number passed is hidden or not. @return No return value.) +/// (int plotID, bool isHidden) +/// Set whether the graph number passed is hidden or not. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setGraphHidden(string guiparticlegraphctrl, int plotID, bool isHidden){ @@ -12942,7 +18278,12 @@ public void GuiParticleGraphCtrl_setGraphHidden(string guiparticlegraphctrl, in m_ts.fn_GuiParticleGraphCtrl_setGraphHidden(guiparticlegraphctrl, plotID, isHidden); } /// -/// (int plotID, float maxX, float maxY) Set the max values of the graph of plotID. @param plotID The plot to modify @param maxX,maxY The maximum bound of the value range. @return No return value.) +/// (int plotID, float maxX, float maxY) +/// Set the max values of the graph of plotID. +/// @param plotID The plot to modify +/// @param maxX,maxY The maximum bound of the value range. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setGraphMax(string guiparticlegraphctrl, int plotID, float maxX, float maxY){ @@ -12950,7 +18291,12 @@ public void GuiParticleGraphCtrl_setGraphMax(string guiparticlegraphctrl, int p m_ts.fn_GuiParticleGraphCtrl_setGraphMax(guiparticlegraphctrl, plotID, maxX, maxY); } /// -/// (int plotID, float maxX) Set the max X value of the graph of plotID. @param plotID The plot to modify. @param maxX The maximum x value. @return No return Value.) +/// (int plotID, float maxX) +/// Set the max X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxX The maximum x value. +/// @return No return Value.) +/// /// public void GuiParticleGraphCtrl_setGraphMaxX(string guiparticlegraphctrl, int plotID, float maxX){ @@ -12958,7 +18304,12 @@ public void GuiParticleGraphCtrl_setGraphMaxX(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphMaxX(guiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float maxY) Set the max Y value of the graph of plotID. @param plotID The plot to modify. @param maxY The maximum y value. @return No return Value.) +/// (int plotID, float maxY) +/// Set the max Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxY The maximum y value. +/// @return No return Value.) +/// /// public void GuiParticleGraphCtrl_setGraphMaxY(string guiparticlegraphctrl, int plotID, float maxX){ @@ -12966,7 +18317,12 @@ public void GuiParticleGraphCtrl_setGraphMaxY(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphMaxY(guiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float minX, float minY) Set the min values of the graph of plotID. @param plotID The plot to modify @param minX,minY The minimum bound of the value range. @return No return value.) +/// (int plotID, float minX, float minY) +/// Set the min values of the graph of plotID. +/// @param plotID The plot to modify +/// @param minX,minY The minimum bound of the value range. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setGraphMin(string guiparticlegraphctrl, int plotID, float minX, float minY){ @@ -12974,7 +18330,12 @@ public void GuiParticleGraphCtrl_setGraphMin(string guiparticlegraphctrl, int p m_ts.fn_GuiParticleGraphCtrl_setGraphMin(guiparticlegraphctrl, plotID, minX, minY); } /// -/// (int plotID, float minX) Set the min X value of the graph of plotID. @param plotID The plot to modify. @param minX The minimum x value. @return No return Value.) +/// (int plotID, float minX) +/// Set the min X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minX The minimum x value. +/// @return No return Value.) +/// /// public void GuiParticleGraphCtrl_setGraphMinX(string guiparticlegraphctrl, int plotID, float minX){ @@ -12982,7 +18343,12 @@ public void GuiParticleGraphCtrl_setGraphMinX(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphMinX(guiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, float minY) Set the min Y value of the graph of plotID. @param plotID The plot to modify. @param minY The minimum y value. @return No return Value.) +/// (int plotID, float minY) +/// Set the min Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minY The minimum y value. +/// @return No return Value.) +/// /// public void GuiParticleGraphCtrl_setGraphMinY(string guiparticlegraphctrl, int plotID, float minX){ @@ -12990,7 +18356,12 @@ public void GuiParticleGraphCtrl_setGraphMinY(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphMinY(guiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, string graphName) Set the name of the given plot. @param plotID The plot to modify. @param graphName The name to set on the plot. @return No return value.) +/// (int plotID, string graphName) +/// Set the name of the given plot. +/// @param plotID The plot to modify. +/// @param graphName The name to set on the plot. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setGraphName(string guiparticlegraphctrl, int plotID, string graphName){ @@ -12998,7 +18369,10 @@ public void GuiParticleGraphCtrl_setGraphName(string guiparticlegraphctrl, int m_ts.fn_GuiParticleGraphCtrl_setGraphName(guiparticlegraphctrl, plotID, graphName); } /// -/// (bool clamped) Set whether the x position of the selected graph point should be clamped @return No return value.) +/// (bool clamped) +/// Set whether the x position of the selected graph point should be clamped +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setPointXMovementClamped(string guiparticlegraphctrl, bool autoRemove){ @@ -13006,7 +18380,10 @@ public void GuiParticleGraphCtrl_setPointXMovementClamped(string guiparticlegra m_ts.fn_GuiParticleGraphCtrl_setPointXMovementClamped(guiparticlegraphctrl, autoRemove); } /// -/// (bool renderAll) Set whether or not a position should be rendered on every point or just the last selected. @return No return value.) +/// (bool renderAll) +/// Set whether or not a position should be rendered on every point or just the last selected. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setRenderAll(string guiparticlegraphctrl, bool autoRemove){ @@ -13014,7 +18391,10 @@ public void GuiParticleGraphCtrl_setRenderAll(string guiparticlegraphctrl, bool m_ts.fn_GuiParticleGraphCtrl_setRenderAll(guiparticlegraphctrl, autoRemove); } /// -/// (bool renderGraphTooltip) Set whether or not to render the graph tooltip. @return No return value.) +/// (bool renderGraphTooltip) +/// Set whether or not to render the graph tooltip. +/// @return No return value.) +/// /// public void GuiParticleGraphCtrl_setRenderGraphTooltip(string guiparticlegraphctrl, bool autoRemove){ @@ -13022,7 +18402,10 @@ public void GuiParticleGraphCtrl_setRenderGraphTooltip(string guiparticlegraphc m_ts.fn_GuiParticleGraphCtrl_setRenderGraphTooltip(guiparticlegraphctrl, autoRemove); } /// -/// (int plotID) Set the selected plot (a.k.a. graph). @return No return value ) +/// (int plotID) +/// Set the selected plot (a.k.a. graph). +/// @return No return value ) +/// /// public void GuiParticleGraphCtrl_setSelectedPlot(string guiparticlegraphctrl, int plotID){ @@ -13030,7 +18413,10 @@ public void GuiParticleGraphCtrl_setSelectedPlot(string guiparticlegraphctrl, i m_ts.fn_GuiParticleGraphCtrl_setSelectedPlot(guiparticlegraphctrl, plotID); } /// -/// (int point) Set the selected point on the graph. @return No return value) +/// (int point) +/// Set the selected point on the graph. +/// @return No return value) +/// /// public void GuiParticleGraphCtrl_setSelectedPoint(string guiparticlegraphctrl, int point){ @@ -13043,14 +18429,9 @@ public void GuiParticleGraphCtrl_setSelectedPoint(string guiparticlegraphctrl, /// public class GuiPopUpMenuCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiPopUpMenuCtrlObject(ref Omni ts){m_ts = ts;} /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void GuiPopUpMenuCtrl_add(string guipopupmenuctrl, string name = "", int idNum = -1, uint scheme = 0){ @@ -13059,6 +18440,7 @@ public void GuiPopUpMenuCtrl_add(string guipopupmenuctrl, string name = "", int } /// /// (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void GuiPopUpMenuCtrl_addScheme(string guipopupmenuctrl, uint id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL){ @@ -13067,6 +18449,7 @@ public void GuiPopUpMenuCtrl_addScheme(string guipopupmenuctrl, uint id, ColorI } /// /// ( int id, string text ) ) +/// /// public void GuiPopUpMenuCtrl_changeTextById(string guipopupmenuctrl, int id, string text){ @@ -13075,6 +18458,7 @@ public void GuiPopUpMenuCtrl_changeTextById(string guipopupmenuctrl, int id, st } /// /// Clear the popup list.) +/// /// public void GuiPopUpMenuCtrl_clear(string guipopupmenuctrl){ @@ -13083,6 +18467,7 @@ public void GuiPopUpMenuCtrl_clear(string guipopupmenuctrl){ } /// /// (S32 entry)) +/// /// public void GuiPopUpMenuCtrl_clearEntry(string guipopupmenuctrl, int entry){ @@ -13090,7 +18475,9 @@ public void GuiPopUpMenuCtrl_clearEntry(string guipopupmenuctrl, int entry){ m_ts.fn_GuiPopUpMenuCtrl_clearEntry(guipopupmenuctrl, entry); } /// -/// (string text) Returns the position of the first entry containing the specified text.) +/// (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int GuiPopUpMenuCtrl_findText(string guipopupmenuctrl, string text){ @@ -13099,6 +18486,7 @@ public int GuiPopUpMenuCtrl_findText(string guipopupmenuctrl, string text){ } /// /// ) +/// /// public void GuiPopUpMenuCtrl_forceClose(string guipopupmenuctrl){ @@ -13107,6 +18495,7 @@ public void GuiPopUpMenuCtrl_forceClose(string guipopupmenuctrl){ } /// /// ) +/// /// public void GuiPopUpMenuCtrl_forceOnAction(string guipopupmenuctrl){ @@ -13115,6 +18504,7 @@ public void GuiPopUpMenuCtrl_forceOnAction(string guipopupmenuctrl){ } /// /// ) +/// /// public int GuiPopUpMenuCtrl_getSelected(string guipopupmenuctrl){ @@ -13123,6 +18513,7 @@ public int GuiPopUpMenuCtrl_getSelected(string guipopupmenuctrl){ } /// /// ) +/// /// public string GuiPopUpMenuCtrl_getText(string guipopupmenuctrl){ @@ -13131,6 +18522,7 @@ public string GuiPopUpMenuCtrl_getText(string guipopupmenuctrl){ } /// /// (int id)) +/// /// public string GuiPopUpMenuCtrl_getTextById(string guipopupmenuctrl, int id){ @@ -13139,6 +18531,7 @@ public string GuiPopUpMenuCtrl_getTextById(string guipopupmenuctrl, int id){ } /// /// (bool doReplaceText)) +/// /// public void GuiPopUpMenuCtrl_replaceText(string guipopupmenuctrl, bool doReplaceText){ @@ -13146,7 +18539,11 @@ public void GuiPopUpMenuCtrl_replaceText(string guipopupmenuctrl, bool doReplac m_ts.fn_GuiPopUpMenuCtrl_replaceText(guipopupmenuctrl, doReplaceText); } /// -/// (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void GuiPopUpMenuCtrl_setEnumContent(string guipopupmenuctrl, string className, string enumName){ @@ -13155,6 +18552,7 @@ public void GuiPopUpMenuCtrl_setEnumContent(string guipopupmenuctrl, string cla } /// /// ([scriptCallback=true])) +/// /// public void GuiPopUpMenuCtrl_setFirstSelected(string guipopupmenuctrl, bool scriptCallback = true){ @@ -13163,6 +18561,7 @@ public void GuiPopUpMenuCtrl_setFirstSelected(string guipopupmenuctrl, bool scr } /// /// ) +/// /// public void GuiPopUpMenuCtrl_setNoneSelected(string guipopupmenuctrl){ @@ -13171,6 +18570,7 @@ public void GuiPopUpMenuCtrl_setNoneSelected(string guipopupmenuctrl){ } /// /// (int id, [scriptCallback=true])) +/// /// public void GuiPopUpMenuCtrl_setSelected(string guipopupmenuctrl, int id, bool scriptCallback = true){ @@ -13179,6 +18579,7 @@ public void GuiPopUpMenuCtrl_setSelected(string guipopupmenuctrl, int id, bool } /// /// Get the size of the menu - the number of entries in it.) +/// /// public int GuiPopUpMenuCtrl_size(string guipopupmenuctrl){ @@ -13187,6 +18588,7 @@ public int GuiPopUpMenuCtrl_size(string guipopupmenuctrl){ } /// /// Sort the list alphabetically.) +/// /// public void GuiPopUpMenuCtrl_sort(string guipopupmenuctrl){ @@ -13195,6 +18597,7 @@ public void GuiPopUpMenuCtrl_sort(string guipopupmenuctrl){ } /// /// Sort the list by ID.) +/// /// public void GuiPopUpMenuCtrl_sortID(string guipopupmenuctrl){ @@ -13207,14 +18610,9 @@ public void GuiPopUpMenuCtrl_sortID(string guipopupmenuctrl){ /// public class GuiPopUpMenuCtrlExObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiPopUpMenuCtrlExObject(ref Omni ts){m_ts = ts;} /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void GuiPopUpMenuCtrlEx_add(string guipopupmenuctrlex, string name = "", int idNum = -1, uint scheme = 0){ @@ -13223,6 +18621,7 @@ public void GuiPopUpMenuCtrlEx_add(string guipopupmenuctrlex, string name = "", } /// /// (S32 entry)) +/// /// public void GuiPopUpMenuCtrlEx_clearEntry(string guipopupmenuctrlex, int entry){ @@ -13230,7 +18629,11 @@ public void GuiPopUpMenuCtrlEx_clearEntry(string guipopupmenuctrlex, int entry) m_ts.fn_GuiPopUpMenuCtrlEx_clearEntry(guipopupmenuctrlex, entry); } /// -/// (string text) Returns the id of the first entry containing the specified text or -1 if not found. @param text String value used for the query @return Numerical ID of entry containing the text.) +/// (string text) +/// Returns the id of the first entry containing the specified text or -1 if not found. +/// @param text String value used for the query +/// @return Numerical ID of entry containing the text.) +/// /// public int GuiPopUpMenuCtrlEx_findText(string guipopupmenuctrlex, string text){ @@ -13238,7 +18641,10 @@ public int GuiPopUpMenuCtrlEx_findText(string guipopupmenuctrlex, string text){ return m_ts.fn_GuiPopUpMenuCtrlEx_findText(guipopupmenuctrlex, text); } /// -/// @brief Get color of an entry's box @param id ID number of entry to query @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// @brief Get color of an entry's box +/// @param id ID number of entry to query +/// @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// /// public ColorI GuiPopUpMenuCtrlEx_getColorById(string guipopupmenuctrlex, int id){ @@ -13246,7 +18652,9 @@ public ColorI GuiPopUpMenuCtrlEx_getColorById(string guipopupmenuctrlex, int id return new ColorI ( m_ts.fn_GuiPopUpMenuCtrlEx_getColorById(guipopupmenuctrlex, id)); } /// -/// @brief Flag that causes each new text addition to replace the current entry @param True to turn on replacing, false to disable it) +/// @brief Flag that causes each new text addition to replace the current entry +/// @param True to turn on replacing, false to disable it) +/// /// public void GuiPopUpMenuCtrlEx_replaceText(string guipopupmenuctrlex, int boolVal){ @@ -13254,7 +18662,12 @@ public void GuiPopUpMenuCtrlEx_replaceText(string guipopupmenuctrlex, int boolV m_ts.fn_GuiPopUpMenuCtrlEx_replaceText(guipopupmenuctrlex, boolVal); } /// -/// @brief This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away. @param class Name of the class containing the enum @param enum Name of the enum value to acces) +/// @brief This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away. +/// @param class Name of the class containing the enum +/// @param enum Name of the enum value to acces) +/// /// public void GuiPopUpMenuCtrlEx_setEnumContent(string guipopupmenuctrlex, string className, string enumName){ @@ -13262,7 +18675,9 @@ public void GuiPopUpMenuCtrlEx_setEnumContent(string guipopupmenuctrlex, string m_ts.fn_GuiPopUpMenuCtrlEx_setEnumContent(guipopupmenuctrlex, className, enumName); } /// -/// ([scriptCallback=true]) @hide) +/// ([scriptCallback=true]) +/// @hide) +/// /// public void GuiPopUpMenuCtrlEx_setFirstSelected(string guipopupmenuctrlex, bool scriptCallback = true){ @@ -13270,7 +18685,9 @@ public void GuiPopUpMenuCtrlEx_setFirstSelected(string guipopupmenuctrlex, bool m_ts.fn_GuiPopUpMenuCtrlEx_setFirstSelected(guipopupmenuctrlex, scriptCallback); } /// -/// (int id, [scriptCallback=true]) @hide) +/// (int id, [scriptCallback=true]) +/// @hide) +/// /// public void GuiPopUpMenuCtrlEx_setSelected(string guipopupmenuctrlex, int id, bool scriptCallback = true){ @@ -13278,7 +18695,9 @@ public void GuiPopUpMenuCtrlEx_setSelected(string guipopupmenuctrlex, int id, b m_ts.fn_GuiPopUpMenuCtrlEx_setSelected(guipopupmenuctrlex, id, scriptCallback); } /// -/// @brief Get the size of the menu @return Number of entries in the menu) +/// @brief Get the size of the menu +/// @return Number of entries in the menu) +/// /// public int GuiPopUpMenuCtrlEx_size(string guipopupmenuctrlex){ @@ -13286,7 +18705,12 @@ public int GuiPopUpMenuCtrlEx_size(string guipopupmenuctrlex){ return m_ts.fn_GuiPopUpMenuCtrlEx_size(guipopupmenuctrlex); } /// -/// @brief Add a category to the list. Acts as a separator between entries, allowing for sub-lists @param text Name of the new category) +/// @brief Add a category to the list. +/// +/// Acts as a separator between entries, allowing for sub-lists +/// +/// @param text Name of the new category) +/// /// public void addCategory(string guipopupmenuctrlex, string text){ @@ -13294,7 +18718,12 @@ public void addCategory(string guipopupmenuctrlex, string text){ m_ts.fnGuiPopUpMenuCtrlEx_addCategory(guipopupmenuctrlex, text); } /// -/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. @param id Numerical id associated with this scheme @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. +/// @param id Numerical id associated with this scheme +/// @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// /// public void addScheme(string guipopupmenuctrlex, int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL){ @@ -13303,6 +18732,7 @@ public void addScheme(string guipopupmenuctrlex, int id, ColorI fontColor, Colo } /// /// @brief Clear the popup list.) +/// /// public void clear(string guipopupmenuctrlex){ @@ -13311,6 +18741,7 @@ public void clear(string guipopupmenuctrlex){ } /// /// @brief Manually force this control to collapse and close.) +/// /// public void forceClose(string guipopupmenuctrlex){ @@ -13319,6 +18750,7 @@ public void forceClose(string guipopupmenuctrlex){ } /// /// @brief Manually for the onAction function, which updates everything in this control.) +/// /// public void forceOnAction(string guipopupmenuctrlex){ @@ -13326,7 +18758,9 @@ public void forceOnAction(string guipopupmenuctrlex){ m_ts.fnGuiPopUpMenuCtrlEx_forceOnAction(guipopupmenuctrlex); } /// -/// @brief Get the current selection of the menu. @return Returns the ID of the currently selected entry) +/// @brief Get the current selection of the menu. +/// @return Returns the ID of the currently selected entry) +/// /// public int getSelected(string guipopupmenuctrlex){ @@ -13334,7 +18768,19 @@ public int getSelected(string guipopupmenuctrlex){ return m_ts.fnGuiPopUpMenuCtrlEx_getSelected(guipopupmenuctrlex); } /// -/// @brief Get the. Detailed description @param param Description @tsexample // Comment code(); @endtsexample @return Returns current text in string format) +/// @brief Get the. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Comment +/// code(); +/// @endtsexample +/// +/// @return Returns current text in string format) +/// /// public string getText(string guipopupmenuctrlex){ @@ -13342,7 +18788,10 @@ public string getText(string guipopupmenuctrlex){ return m_ts.fnGuiPopUpMenuCtrlEx_getText(guipopupmenuctrlex); } /// -/// @brief Get the text of an entry based on an ID. @param id The ID assigned to the entry being queried @return String contained by the specified entry, NULL if empty or bad ID) +/// @brief Get the text of an entry based on an ID. +/// @param id The ID assigned to the entry being queried +/// @return String contained by the specified entry, NULL if empty or bad ID) +/// /// public string getTextById(string guipopupmenuctrlex, int id){ @@ -13351,6 +18800,7 @@ public string getTextById(string guipopupmenuctrlex, int id){ } /// /// @brief Clears selection in the menu.) +/// /// public void setNoneSelected(string guipopupmenuctrlex, int param){ @@ -13358,7 +18808,9 @@ public void setNoneSelected(string guipopupmenuctrlex, int param){ m_ts.fnGuiPopUpMenuCtrlEx_setNoneSelected(guipopupmenuctrlex, param); } /// -/// @brief Set the current text to a specified value. @param text String containing new text to set) +/// @brief Set the current text to a specified value. +/// @param text String containing new text to set) +/// /// public void setText(string guipopupmenuctrlex, string text){ @@ -13367,6 +18819,7 @@ public void setText(string guipopupmenuctrlex, string text){ } /// /// @brief Sort the list alphabetically.) +/// /// public void sort(string guipopupmenuctrlex){ @@ -13375,6 +18828,7 @@ public void sort(string guipopupmenuctrlex){ } /// /// @brief Sort the list by ID.) +/// /// public void sortID(string guipopupmenuctrlex){ @@ -13387,14 +18841,12 @@ public void sortID(string guipopupmenuctrlex){ /// public class GuiProgressBitmapCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiProgressBitmapCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Set the bitmap to use for rendering the progress bar. @param filename ~Path to the bitmap file. @note Directly assign to #bitmap rather than using this method. @see GuiProgressBitmapCtrl::setBitmap ) +/// Set the bitmap to use for rendering the progress bar. +/// @param filename ~Path to the bitmap file. +/// @note Directly assign to #bitmap rather than using this method. +/// @see GuiProgressBitmapCtrl::setBitmap ) +/// /// public void setBitmap(string guiprogressbitmapctrl, string filename){ @@ -13407,14 +18859,9 @@ public void setBitmap(string guiprogressbitmapctrl, string filename){ /// public class GuiRiverEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiRiverEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// deleteNode() ) +/// /// public void GuiRiverEditorCtrl_deleteNode(string guirivereditorctrl){ @@ -13423,6 +18870,7 @@ public void GuiRiverEditorCtrl_deleteNode(string guirivereditorctrl){ } /// /// ) +/// /// public string GuiRiverEditorCtrl_getMode(string guirivereditorctrl){ @@ -13431,6 +18879,7 @@ public string GuiRiverEditorCtrl_getMode(string guirivereditorctrl){ } /// /// ) +/// /// public float GuiRiverEditorCtrl_getNodeDepth(string guirivereditorctrl){ @@ -13439,6 +18888,7 @@ public float GuiRiverEditorCtrl_getNodeDepth(string guirivereditorctrl){ } /// /// ) +/// /// public Point3F GuiRiverEditorCtrl_getNodeNormal(string guirivereditorctrl){ @@ -13447,6 +18897,7 @@ public Point3F GuiRiverEditorCtrl_getNodeNormal(string guirivereditorctrl){ } /// /// ) +/// /// public Point3F GuiRiverEditorCtrl_getNodePosition(string guirivereditorctrl){ @@ -13455,6 +18906,7 @@ public Point3F GuiRiverEditorCtrl_getNodePosition(string guirivereditorctrl){ } /// /// ) +/// /// public float GuiRiverEditorCtrl_getNodeWidth(string guirivereditorctrl){ @@ -13463,6 +18915,7 @@ public float GuiRiverEditorCtrl_getNodeWidth(string guirivereditorctrl){ } /// /// ) +/// /// public int GuiRiverEditorCtrl_getSelectedRiver(string guirivereditorctrl){ @@ -13471,6 +18924,7 @@ public int GuiRiverEditorCtrl_getSelectedRiver(string guirivereditorctrl){ } /// /// ) +/// /// public void GuiRiverEditorCtrl_regenerate(string guirivereditorctrl){ @@ -13479,6 +18933,7 @@ public void GuiRiverEditorCtrl_regenerate(string guirivereditorctrl){ } /// /// setMode( String mode ) ) +/// /// public void GuiRiverEditorCtrl_setMode(string guirivereditorctrl, string mode){ @@ -13487,6 +18942,7 @@ public void GuiRiverEditorCtrl_setMode(string guirivereditorctrl, string mode){ } /// /// ) +/// /// public void GuiRiverEditorCtrl_setNodeDepth(string guirivereditorctrl, float depth){ @@ -13495,6 +18951,7 @@ public void GuiRiverEditorCtrl_setNodeDepth(string guirivereditorctrl, float de } /// /// ) +/// /// public void GuiRiverEditorCtrl_setNodeNormal(string guirivereditorctrl, Point3F normal){ @@ -13503,6 +18960,7 @@ public void GuiRiverEditorCtrl_setNodeNormal(string guirivereditorctrl, Point3F } /// /// ) +/// /// public void GuiRiverEditorCtrl_setNodePosition(string guirivereditorctrl, Point3F pos){ @@ -13511,6 +18969,7 @@ public void GuiRiverEditorCtrl_setNodePosition(string guirivereditorctrl, Point } /// /// ) +/// /// public void GuiRiverEditorCtrl_setNodeWidth(string guirivereditorctrl, float width){ @@ -13519,6 +18978,7 @@ public void GuiRiverEditorCtrl_setNodeWidth(string guirivereditorctrl, float wi } /// /// ), ) +/// /// public void GuiRiverEditorCtrl_setSelectedRiver(string guirivereditorctrl, string objName = ""){ @@ -13531,14 +18991,9 @@ public void GuiRiverEditorCtrl_setSelectedRiver(string guirivereditorctrl, stri /// public class GuiRoadEditorCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiRoadEditorCtrlObject(ref Omni ts){m_ts = ts;} /// /// deleteNode() ) +/// /// public void GuiRoadEditorCtrl_deleteNode(string guiroadeditorctrl){ @@ -13547,6 +19002,7 @@ public void GuiRoadEditorCtrl_deleteNode(string guiroadeditorctrl){ } /// /// ) +/// /// public void GuiRoadEditorCtrl_deleteRoad(string guiroadeditorctrl){ @@ -13555,6 +19011,7 @@ public void GuiRoadEditorCtrl_deleteRoad(string guiroadeditorctrl){ } /// /// ) +/// /// public string GuiRoadEditorCtrl_getMode(string guiroadeditorctrl){ @@ -13563,6 +19020,7 @@ public string GuiRoadEditorCtrl_getMode(string guiroadeditorctrl){ } /// /// ) +/// /// public Point3F GuiRoadEditorCtrl_getNodePosition(string guiroadeditorctrl){ @@ -13571,6 +19029,7 @@ public Point3F GuiRoadEditorCtrl_getNodePosition(string guiroadeditorctrl){ } /// /// ) +/// /// public float GuiRoadEditorCtrl_getNodeWidth(string guiroadeditorctrl){ @@ -13579,6 +19038,7 @@ public float GuiRoadEditorCtrl_getNodeWidth(string guiroadeditorctrl){ } /// /// ) +/// /// public int GuiRoadEditorCtrl_getSelectedNode(string guiroadeditorctrl){ @@ -13587,6 +19047,7 @@ public int GuiRoadEditorCtrl_getSelectedNode(string guiroadeditorctrl){ } /// /// ) +/// /// public int GuiRoadEditorCtrl_getSelectedRoad(string guiroadeditorctrl){ @@ -13595,6 +19056,7 @@ public int GuiRoadEditorCtrl_getSelectedRoad(string guiroadeditorctrl){ } /// /// setMode( String mode ) ) +/// /// public void GuiRoadEditorCtrl_setMode(string guiroadeditorctrl, string mode){ @@ -13603,6 +19065,7 @@ public void GuiRoadEditorCtrl_setMode(string guiroadeditorctrl, string mode){ } /// /// ) +/// /// public void GuiRoadEditorCtrl_setNodePosition(string guiroadeditorctrl, Point3F pos){ @@ -13611,6 +19074,7 @@ public void GuiRoadEditorCtrl_setNodePosition(string guiroadeditorctrl, Point3F } /// /// ) +/// /// public void GuiRoadEditorCtrl_setNodeWidth(string guiroadeditorctrl, float width){ @@ -13619,6 +19083,7 @@ public void GuiRoadEditorCtrl_setNodeWidth(string guiroadeditorctrl, float widt } /// /// ), ) +/// /// public void GuiRoadEditorCtrl_setSelectedRoad(string guiroadeditorctrl, string pathRoad = ""){ @@ -13631,14 +19096,10 @@ public void GuiRoadEditorCtrl_setSelectedRoad(string guiroadeditorctrl, string /// public class GuiRolloutCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiRolloutCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. +/// @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// /// public void collapse(string guirolloutctrl){ @@ -13646,7 +19107,9 @@ public void collapse(string guirolloutctrl){ m_ts.fnGuiRolloutCtrl_collapse(guirolloutctrl); } /// -/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. +/// @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// /// public void expand(string guirolloutctrl){ @@ -13655,6 +19118,7 @@ public void expand(string guirolloutctrl){ } /// /// Instantly collapse the rollout without animation. To smoothly slide the rollout to collapsed state, use collapse(). ) +/// /// public void instantCollapse(string guirolloutctrl){ @@ -13663,6 +19127,7 @@ public void instantCollapse(string guirolloutctrl){ } /// /// Instantly expand the rollout without animation. To smoothly slide the rollout to expanded state, use expand(). ) +/// /// public void instantExpand(string guirolloutctrl){ @@ -13670,7 +19135,9 @@ public void instantExpand(string guirolloutctrl){ m_ts.fnGuiRolloutCtrl_instantExpand(guirolloutctrl); } /// -/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. @return True if the rollout is expanded, false if not. ) +/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. +/// @return True if the rollout is expanded, false if not. ) +/// /// public bool isExpanded(string guirolloutctrl){ @@ -13678,7 +19145,9 @@ public bool isExpanded(string guirolloutctrl){ return m_ts.fnGuiRolloutCtrl_isExpanded(guirolloutctrl); } /// -/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of the rollout size. ) +/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of +/// the rollout size. ) +/// /// public void sizeToContents(string guirolloutctrl){ @@ -13686,7 +19155,9 @@ public void sizeToContents(string guirolloutctrl){ m_ts.fnGuiRolloutCtrl_sizeToContents(guirolloutctrl); } /// -/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. ) +/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. ) +/// /// public void toggleCollapse(string guirolloutctrl){ @@ -13694,7 +19165,11 @@ public void toggleCollapse(string guirolloutctrl){ m_ts.fnGuiRolloutCtrl_toggleCollapse(guirolloutctrl); } /// -/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will smoothly slide into the opposite state. ) +/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. +/// @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will +/// smoothly slide into the opposite state. ) +/// /// public void toggleExpanded(string guirolloutctrl, bool instantly = false){ @@ -13707,14 +19182,9 @@ public void toggleExpanded(string guirolloutctrl, bool instantly = false){ /// public class GuiScrollCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiScrollCtrlObject(ref Omni ts){m_ts = ts;} /// /// Refresh sizing and positioning of child controls. ) +/// /// public void computeSizes(string guiscrollctrl){ @@ -13722,7 +19192,9 @@ public void computeSizes(string guiscrollctrl){ m_ts.fnGuiScrollCtrl_computeSizes(guiscrollctrl); } /// -/// Get the current coordinates of the scrolled content. @return The current position of the scrolled content. ) +/// Get the current coordinates of the scrolled content. +/// @return The current position of the scrolled content. ) +/// /// public Point2I getScrollPosition(string guiscrollctrl){ @@ -13730,7 +19202,9 @@ public Point2I getScrollPosition(string guiscrollctrl){ return new Point2I ( m_ts.fnGuiScrollCtrl_getScrollPosition(guiscrollctrl)); } /// -/// Get the current X coordinate of the scrolled content. @return The current X coordinate of the scrolled content. ) +/// Get the current X coordinate of the scrolled content. +/// @return The current X coordinate of the scrolled content. ) +/// /// public int getScrollPositionX(string guiscrollctrl){ @@ -13738,7 +19212,9 @@ public int getScrollPositionX(string guiscrollctrl){ return m_ts.fnGuiScrollCtrl_getScrollPositionX(guiscrollctrl); } /// -/// Get the current Y coordinate of the scrolled content. @return The current Y coordinate of the scrolled content. ) +/// Get the current Y coordinate of the scrolled content. +/// @return The current Y coordinate of the scrolled content. ) +/// /// public int getScrollPositionY(string guiscrollctrl){ @@ -13747,6 +19223,7 @@ public int getScrollPositionY(string guiscrollctrl){ } /// /// Scroll all the way to the bottom of the vertical scrollbar and the left of the horizontal bar. ) +/// /// public void scrollToBottom(string guiscrollctrl){ @@ -13754,7 +19231,9 @@ public void scrollToBottom(string guiscrollctrl){ m_ts.fnGuiScrollCtrl_scrollToBottom(guiscrollctrl); } /// -/// Scroll the control so that the given child @a control is visible. @param control A child control. ) +/// Scroll the control so that the given child @a control is visible. +/// @param control A child control. ) +/// /// public void scrollToObject(string guiscrollctrl, string control){ @@ -13763,6 +19242,7 @@ public void scrollToObject(string guiscrollctrl, string control){ } /// /// Scroll all the way to the top of the vertical and left of the horizontal scrollbar. ) +/// /// public void scrollToTop(string guiscrollctrl){ @@ -13770,7 +19250,10 @@ public void scrollToTop(string guiscrollctrl){ m_ts.fnGuiScrollCtrl_scrollToTop(guiscrollctrl); } /// -/// Set the position of the scrolled content. @param x Position on X axis. @param y Position on y axis. ) +/// Set the position of the scrolled content. +/// @param x Position on X axis. +/// @param y Position on y axis. ) +/// /// public void setScrollPosition(string guiscrollctrl, int x, int y){ @@ -13783,14 +19266,9 @@ public void setScrollPosition(string guiscrollctrl, int x, int y){ /// public class GuiShapeEdPreviewObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiShapeEdPreviewObject(ref Omni ts){m_ts = ts;} /// /// Add a new thread (initially without any sequence set) ) +/// /// public void addThread(string guishapeedpreview){ @@ -13798,7 +19276,9 @@ public void addThread(string guishapeedpreview){ m_ts.fnGuiShapeEdPreview_addThread(guishapeedpreview); } /// -/// Compute the bounding box of the shape using the current detail and node transforms @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// Compute the bounding box of the shape using the current detail and node transforms +/// @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// /// public Box3F computeShapeBounds(string guishapeedpreview){ @@ -13806,7 +19286,11 @@ public Box3F computeShapeBounds(string guishapeedpreview){ return new Box3F ( m_ts.fnGuiShapeEdPreview_computeShapeBounds(guishapeedpreview)); } /// -/// Export the current shape and all mounted objects to COLLADA (.dae). Note that animation is not exported, and all geometry is combined into a single mesh. @param path Destination filename ) +/// Export the current shape and all mounted objects to COLLADA (.dae). +/// Note that animation is not exported, and all geometry is combined into a +/// single mesh. +/// @param path Destination filename ) +/// /// public void exportToCollada(string guishapeedpreview, string path){ @@ -13815,6 +19299,7 @@ public void exportToCollada(string guishapeedpreview, string path){ } /// /// Adjust the camera position and zoom to fit the shape within the view. ) +/// /// public void fitToShape(string guishapeedpreview){ @@ -13823,6 +19308,7 @@ public void fitToShape(string guishapeedpreview){ } /// /// Return whether the named object is currently hidden ) +/// /// public bool getMeshHidden(string guishapeedpreview, string name){ @@ -13830,7 +19316,10 @@ public bool getMeshHidden(string guishapeedpreview, string name){ return m_ts.fnGuiShapeEdPreview_getMeshHidden(guishapeedpreview, name); } /// -/// Get the playback direction of the sequence playing on this mounted shape @param slot mounted shape slot @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// Get the playback direction of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// /// public float getMountThreadDir(string guishapeedpreview, int slot){ @@ -13838,7 +19327,10 @@ public float getMountThreadDir(string guishapeedpreview, int slot){ return m_ts.fnGuiShapeEdPreview_getMountThreadDir(guishapeedpreview, slot); } /// -/// Get the playback position of the sequence playing on this mounted shape @param slot mounted shape slot @return playback position of the sequence (0-1) ) +/// Get the playback position of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return playback position of the sequence (0-1) ) +/// /// public float getMountThreadPos(string guishapeedpreview, int slot){ @@ -13846,7 +19338,10 @@ public float getMountThreadPos(string guishapeedpreview, int slot){ return m_ts.fnGuiShapeEdPreview_getMountThreadPos(guishapeedpreview, slot); } /// -/// Get the name of the sequence playing on this mounted shape @param slot mounted shape slot @return name of the sequence (if any) ) +/// Get the name of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return name of the sequence (if any) ) +/// /// public string getMountThreadSequence(string guishapeedpreview, int slot){ @@ -13854,7 +19349,9 @@ public string getMountThreadSequence(string guishapeedpreview, int slot){ return m_ts.fnGuiShapeEdPreview_getMountThreadSequence(guishapeedpreview, slot); } /// -/// Get the number of threads @return the number of threads ) +/// Get the number of threads +/// @return the number of threads ) +/// /// public int getThreadCount(string guishapeedpreview){ @@ -13863,6 +19360,7 @@ public int getThreadCount(string guishapeedpreview){ } /// /// Get the name of the sequence assigned to the active thread ) +/// /// public string getThreadSequence(string guishapeedpreview){ @@ -13870,7 +19368,12 @@ public string getThreadSequence(string guishapeedpreview){ return m_ts.fnGuiShapeEdPreview_getThreadSequence(guishapeedpreview); } /// -/// Mount a shape onto the main shape at the specified node @param shapePath path to the shape to mount @param nodeName name of the node on the main shape to mount to @param type type of mounting to use (Object, Image or Wheel) @param slot mount slot ) +/// Mount a shape onto the main shape at the specified node +/// @param shapePath path to the shape to mount +/// @param nodeName name of the node on the main shape to mount to +/// @param type type of mounting to use (Object, Image or Wheel) +/// @param slot mount slot ) +/// /// public bool mountShape(string guishapeedpreview, string shapePath, string nodeName, string type, int slot){ @@ -13879,6 +19382,7 @@ public bool mountShape(string guishapeedpreview, string shapePath, string nodeN } /// /// Refresh the shape (used when the shape meshes or nodes have been added or removed) ) +/// /// public void refreshShape(string guishapeedpreview){ @@ -13887,6 +19391,7 @@ public void refreshShape(string guishapeedpreview){ } /// /// Refreshes thread sequences (in case of removed/renamed sequences ) +/// /// public void refreshThreadSequences(string guishapeedpreview){ @@ -13894,7 +19399,9 @@ public void refreshThreadSequences(string guishapeedpreview){ m_ts.fnGuiShapeEdPreview_refreshThreadSequences(guishapeedpreview); } /// -/// Removes the specifed thread @param slot index of the thread to remove ) +/// Removes the specifed thread +/// @param slot index of the thread to remove ) +/// /// public void removeThread(string guishapeedpreview, int slot){ @@ -13903,6 +19410,7 @@ public void removeThread(string guishapeedpreview, int slot){ } /// /// Show or hide all objects in the shape ) +/// /// public void setAllMeshesHidden(string guishapeedpreview, bool hidden){ @@ -13911,6 +19419,7 @@ public void setAllMeshesHidden(string guishapeedpreview, bool hidden){ } /// /// Show or hide the named object in the shape ) +/// /// public void setMeshHidden(string guishapeedpreview, string name, bool hidden){ @@ -13918,7 +19427,10 @@ public void setMeshHidden(string guishapeedpreview, string name, bool hidden){ m_ts.fnGuiShapeEdPreview_setMeshHidden(guishapeedpreview, name, hidden); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display. @return True if the model was loaded successfully, false otherwise. ) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display. +/// @return True if the model was loaded successfully, false otherwise. ) +/// /// public bool setModel(string guishapeedpreview, string shapePath){ @@ -13926,7 +19438,10 @@ public bool setModel(string guishapeedpreview, string shapePath){ return m_ts.fnGuiShapeEdPreview_setModel(guishapeedpreview, shapePath); } /// -/// Set the node a shape is mounted to. @param slot mounted shape slot @param nodename name of the node to mount to ) +/// Set the node a shape is mounted to. +/// @param slot mounted shape slot +/// @param nodename name of the node to mount to ) +/// /// public void setMountNode(string guishapeedpreview, int slot, string nodeName){ @@ -13934,7 +19449,10 @@ public void setMountNode(string guishapeedpreview, int slot, string nodeName){ m_ts.fnGuiShapeEdPreview_setMountNode(guishapeedpreview, slot, nodeName); } /// -/// Set the playback direction of the shape mounted in the specified slot @param slot mounted shape slot @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// Set the playback direction of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// /// public void setMountThreadDir(string guishapeedpreview, int slot, float dir){ @@ -13942,7 +19460,10 @@ public void setMountThreadDir(string guishapeedpreview, int slot, float dir){ m_ts.fnGuiShapeEdPreview_setMountThreadDir(guishapeedpreview, slot, dir); } /// -/// Set the sequence position of the shape mounted in the specified slot @param slot mounted shape slot @param pos sequence position (0-1) ) +/// Set the sequence position of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param pos sequence position (0-1) ) +/// /// public void setMountThreadPos(string guishapeedpreview, int slot, float pos){ @@ -13950,7 +19471,10 @@ public void setMountThreadPos(string guishapeedpreview, int slot, float pos){ m_ts.fnGuiShapeEdPreview_setMountThreadPos(guishapeedpreview, slot, pos); } /// -/// Set the sequence to play for the shape mounted in the specified slot @param slot mounted shape slot @param name name of the sequence to play ) +/// Set the sequence to play for the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param name name of the sequence to play ) +/// /// public void setMountThreadSequence(string guishapeedpreview, int slot, string name){ @@ -13958,7 +19482,9 @@ public void setMountThreadSequence(string guishapeedpreview, int slot, string n m_ts.fnGuiShapeEdPreview_setMountThreadSequence(guishapeedpreview, slot, name); } /// -/// Set the camera orbit position @param pos Position in the form \"x y z\" ) +/// Set the camera orbit position +/// @param pos Position in the form \"x y z\" ) +/// /// public void setOrbitPos(string guishapeedpreview, Point3F pos){ @@ -13966,7 +19492,12 @@ public void setOrbitPos(string guishapeedpreview, Point3F pos){ m_ts.fnGuiShapeEdPreview_setOrbitPos(guishapeedpreview, pos.AsString()); } /// -/// Sets the sequence to play for the active thread. @param name name of the sequence to play @param duration transition duration (0 for no transition) @param pos position in the new sequence to transition to @param play if true, the new sequence will play during the transition ) +/// Sets the sequence to play for the active thread. +/// @param name name of the sequence to play +/// @param duration transition duration (0 for no transition) +/// @param pos position in the new sequence to transition to +/// @param play if true, the new sequence will play during the transition ) +/// /// public void setThreadSequence(string guishapeedpreview, string name, float duration = 0, float pos = 0, bool play = false){ @@ -13974,7 +19505,9 @@ public void setThreadSequence(string guishapeedpreview, string name, float dura m_ts.fnGuiShapeEdPreview_setThreadSequence(guishapeedpreview, name, duration, pos, play); } /// -/// Set the time scale of all threads @param scale new time scale value ) +/// Set the time scale of all threads +/// @param scale new time scale value ) +/// /// public void setTimeScale(string guishapeedpreview, float scale){ @@ -13983,6 +19516,7 @@ public void setTimeScale(string guishapeedpreview, float scale){ } /// /// Unmount all shapes ) +/// /// public void unmountAll(string guishapeedpreview){ @@ -13990,7 +19524,9 @@ public void unmountAll(string guishapeedpreview){ m_ts.fnGuiShapeEdPreview_unmountAll(guishapeedpreview); } /// -/// Unmount the shape in the specified slot @param slot mounted shape slot ) +/// Unmount the shape in the specified slot +/// @param slot mounted shape slot ) +/// /// public void unmountShape(string guishapeedpreview, int slot){ @@ -13999,6 +19535,7 @@ public void unmountShape(string guishapeedpreview, int slot){ } /// /// Refresh the shape node transforms (used when a node transform has been modified externally) ) +/// /// public void updateNodeTransforms(string guishapeedpreview){ @@ -14011,14 +19548,10 @@ public void updateNodeTransforms(string guishapeedpreview){ /// public class GuiSliderCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiSliderCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the current value of the slider based on the position of the thumb. @return Slider position (from range.x to range.y). ) +/// Get the current value of the slider based on the position of the thumb. +/// @return Slider position (from range.x to range.y). ) +/// /// public float getValue(string guisliderctrl){ @@ -14026,7 +19559,10 @@ public float getValue(string guisliderctrl){ return m_ts.fnGuiSliderCtrl_getValue(guisliderctrl); } /// -/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful for scrubbing type sliders where the slider position is sync'd to a changing value. When the user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful +/// for scrubbing type sliders where the slider position is sync'd to a changing value. When the +/// user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// /// public bool isThumbBeingDragged(string guisliderctrl){ @@ -14034,7 +19570,10 @@ public bool isThumbBeingDragged(string guisliderctrl){ return m_ts.fnGuiSliderCtrl_isThumbBeingDragged(guisliderctrl); } /// -/// Set position of the thumb on the slider. @param pos New slider position (from range.x to range.y) @param doCallback If true, the altCommand callback will be invoked ) +/// Set position of the thumb on the slider. +/// @param pos New slider position (from range.x to range.y) +/// @param doCallback If true, the altCommand callback will be invoked ) +/// /// public void setValue(string guisliderctrl, float pos, bool doCallback = false){ @@ -14047,14 +19586,15 @@ public void setValue(string guisliderctrl, float pos, bool doCallback = false){ /// public class GuiStackControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiStackControlObject(ref Omni ts){m_ts = ts;} /// -/// Prevents control from restacking - useful when adding or removing child controls @param freeze True to freeze the control, false to unfreeze it @tsexample %stackCtrl.freeze(true); // add controls to stack %stackCtrl.freeze(false); @endtsexample ) +/// Prevents control from restacking - useful when adding or removing child controls +/// @param freeze True to freeze the control, false to unfreeze it +/// @tsexample +/// %stackCtrl.freeze(true); +/// // add controls to stack +/// %stackCtrl.freeze(false); +/// @endtsexample ) +/// /// public void freeze(string guistackcontrol, bool freeze){ @@ -14063,6 +19603,7 @@ public void freeze(string guistackcontrol, bool freeze){ } /// /// Return whether or not this control is frozen ) +/// /// public bool isFrozen(string guistackcontrol){ @@ -14071,6 +19612,7 @@ public bool isFrozen(string guistackcontrol){ } /// /// Restack the child controls. ) +/// /// public void updateStack(string guistackcontrol){ @@ -14083,14 +19625,12 @@ public void updateStack(string guistackcontrol){ /// public class GuiSwatchButtonCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiSwatchButtonCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Set the color of the swatch control. @param newColor The new color string given to the swatch control in float format \"r g b a\". @note It's also important to note that when setColor is called causes the control's altCommand field to be executed. ) +/// Set the color of the swatch control. +/// @param newColor The new color string given to the swatch control in float format \"r g b a\". +/// @note It's also important to note that when setColor is called causes +/// the control's altCommand field to be executed. ) +/// /// public void setColor(string guiswatchbuttonctrl, string newColor){ @@ -14103,14 +19643,11 @@ public void setColor(string guiswatchbuttonctrl, string newColor){ /// public class GuiTabBookCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTabBookCtrlObject(ref Omni ts){m_ts = ts;} /// -/// ), Add a new tab page to the control. @param title Title text for the tab page header. ) +/// ), +/// Add a new tab page to the control. +/// @param title Title text for the tab page header. ) +/// /// public void addPage(string guitabbookctrl, string title = ""){ @@ -14118,7 +19655,9 @@ public void addPage(string guitabbookctrl, string title = ""){ m_ts.fnGuiTabBookCtrl_addPage(guitabbookctrl, title); } /// -/// Get the index of the currently selected tab page. @return Index of the selected tab page or -1 if no tab page is selected. ) +/// Get the index of the currently selected tab page. +/// @return Index of the selected tab page or -1 if no tab page is selected. ) +/// /// public int getSelectedPage(string guitabbookctrl){ @@ -14126,7 +19665,9 @@ public int getSelectedPage(string guitabbookctrl){ return m_ts.fnGuiTabBookCtrl_getSelectedPage(guitabbookctrl); } /// -/// Set the selected tab page. @param index Index of the tab page. ) +/// Set the selected tab page. +/// @param index Index of the tab page. ) +/// /// public void selectPage(string guitabbookctrl, int index){ @@ -14139,12 +19680,6 @@ public void selectPage(string guitabbookctrl, int index){ /// public class GuiTableControlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTableControlObject(ref Omni ts){m_ts = ts;} /// /// ) /// @@ -14227,14 +19762,9 @@ public void setSelectedRow(string guitablecontrol, int rowNum){ /// public class GuiTabPageCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTabPageCtrlObject(ref Omni ts){m_ts = ts;} /// /// Select this page in its tab book. ) +/// /// public void select(string guitabpagectrl){ @@ -14247,14 +19777,9 @@ public void select(string guitabpagectrl){ /// public class GuiTerrPreviewCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTerrPreviewCtrlObject(ref Omni ts){m_ts = ts;} /// /// Return a Point2F containing the position of the origin.) +/// /// public Point2F GuiTerrPreviewCtrl_getOrigin(string guiterrpreviewctrl){ @@ -14263,6 +19788,7 @@ public Point2F GuiTerrPreviewCtrl_getOrigin(string guiterrpreviewctrl){ } /// /// Return a Point2F representing the position of the root.) +/// /// public Point2F GuiTerrPreviewCtrl_getRoot(string guiterrpreviewctrl){ @@ -14271,6 +19797,7 @@ public Point2F GuiTerrPreviewCtrl_getRoot(string guiterrpreviewctrl){ } /// /// Returns a 4-tuple containing: root_x root_y origin_x origin_y) +/// /// public string GuiTerrPreviewCtrl_getValue(string guiterrpreviewctrl){ @@ -14279,6 +19806,7 @@ public string GuiTerrPreviewCtrl_getValue(string guiterrpreviewctrl){ } /// /// Reset the view of the terrain.) +/// /// public void GuiTerrPreviewCtrl_reset(string guiterrpreviewctrl){ @@ -14286,7 +19814,9 @@ public void GuiTerrPreviewCtrl_reset(string guiterrpreviewctrl){ m_ts.fn_GuiTerrPreviewCtrl_reset(guiterrpreviewctrl); } /// -/// (float x, float y) Set the origin of the view.) +/// (float x, float y) +/// Set the origin of the view.) +/// /// public void GuiTerrPreviewCtrl_setOrigin(string guiterrpreviewctrl, Point2F pos){ @@ -14295,6 +19825,7 @@ public void GuiTerrPreviewCtrl_setOrigin(string guiterrpreviewctrl, Point2F pos } /// /// Add the origin to the root and reset the origin.) +/// /// public void GuiTerrPreviewCtrl_setRoot(string guiterrpreviewctrl){ @@ -14302,7 +19833,9 @@ public void GuiTerrPreviewCtrl_setRoot(string guiterrpreviewctrl){ m_ts.fn_GuiTerrPreviewCtrl_setRoot(guiterrpreviewctrl); } /// -/// Accepts a 4-tuple in the same form as getValue returns. @see GuiTerrPreviewCtrl::getValue()) +/// Accepts a 4-tuple in the same form as getValue returns. +/// @see GuiTerrPreviewCtrl::getValue()) +/// /// public void GuiTerrPreviewCtrl_setValue(string guiterrpreviewctrl, string tuple){ @@ -14315,14 +19848,17 @@ public void GuiTerrPreviewCtrl_setValue(string guiterrpreviewctrl, string tuple /// public class GuiTextCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTextCtrlObject(ref Omni ts){m_ts = ts;} /// -/// @brief Sets the text in the control. @param text Text to display in the control. @tsexample // Set the text to show in the control %text = \"Gideon - Destroyer of World\"; // Inform the GuiTextCtrl control to change its text to the defined value %thisGuiTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to display in the control. +/// @tsexample +/// // Set the text to show in the control +/// %text = \"Gideon - Destroyer of World\"; +/// // Inform the GuiTextCtrl control to change its text to the defined value +/// %thisGuiTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void setText(string guitextctrl, string text){ @@ -14330,7 +19866,15 @@ public void setText(string guitextctrl, string text){ m_ts.fnGuiTextCtrl_setText(guitextctrl, text); } /// -/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. @param textID Name of variable text should be mapped to @tsexample // Inform the GuiTextCtrl control of the textID to use %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); @endtsexample @see GuiControl @see Localization) +/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. +/// @param textID Name of variable text should be mapped to +/// @tsexample +/// // Inform the GuiTextCtrl control of the textID to use +/// %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); +/// @endtsexample +/// @see GuiControl +/// @see Localization) +/// /// public void setTextID(string guitextctrl, string textID){ @@ -14343,14 +19887,9 @@ public void setTextID(string guitextctrl, string textID){ /// public class GuiTextEditCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTextEditCtrlObject(ref Omni ts){m_ts = ts;} /// /// textEditCtrl.selectText( %startBlock, %endBlock ) ) +/// /// public void GuiTextEditCtrl_selectText(string guitexteditctrl, int startBlock, int endBlock){ @@ -14358,7 +19897,13 @@ public void GuiTextEditCtrl_selectText(string guitexteditctrl, int startBlock, m_ts.fn_GuiTextEditCtrl_selectText(guitexteditctrl, startBlock, endBlock); } /// -/// @brief Unselects all selected text in the control. @tsexample // Inform the control to unselect all of its selected text %thisGuiTextEditCtrl.clearSelectedText(); @endtsexample @see GuiControl) +/// @brief Unselects all selected text in the control. +/// @tsexample +/// // Inform the control to unselect all of its selected text +/// %thisGuiTextEditCtrl.clearSelectedText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearSelectedText(string guitexteditctrl){ @@ -14366,7 +19911,13 @@ public void clearSelectedText(string guitexteditctrl){ m_ts.fnGuiTextEditCtrl_clearSelectedText(guitexteditctrl); } /// -/// @brief Force a validation to occur. @tsexample // Inform the control to force a validation of its text. %thisGuiTextEditCtrl.forceValidateText(); @endtsexample @see GuiControl) +/// @brief Force a validation to occur. +/// @tsexample +/// // Inform the control to force a validation of its text. +/// %thisGuiTextEditCtrl.forceValidateText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void forceValidateText(string guitexteditctrl){ @@ -14374,7 +19925,14 @@ public void forceValidateText(string guitexteditctrl){ m_ts.fnGuiTextEditCtrl_forceValidateText(guitexteditctrl); } /// -/// @brief Returns the current position of the text cursor in the control. @tsexample // Acquire the cursor position in the control %position = %thisGuiTextEditCtrl.getCursorPost(); @endtsexample @return Text cursor position within the control. @see GuiControl) +/// @brief Returns the current position of the text cursor in the control. +/// @tsexample +/// // Acquire the cursor position in the control +/// %position = %thisGuiTextEditCtrl.getCursorPost(); +/// @endtsexample +/// @return Text cursor position within the control. +/// @see GuiControl) +/// /// public int getCursorPos(string guitexteditctrl){ @@ -14382,7 +19940,14 @@ public int getCursorPos(string guitexteditctrl){ return m_ts.fnGuiTextEditCtrl_getCursorPos(guitexteditctrl); } /// -/// @brief Acquires the current text displayed in this control. @tsexample // Acquire the value of the text control. %text = %thisGuiTextEditCtrl.getText(); @endtsexample @return The current text within the control. @see GuiControl) +/// @brief Acquires the current text displayed in this control. +/// @tsexample +/// // Acquire the value of the text control. +/// %text = %thisGuiTextEditCtrl.getText(); +/// @endtsexample +/// @return The current text within the control. +/// @see GuiControl) +/// /// public string getText(string guitexteditctrl){ @@ -14390,7 +19955,14 @@ public string getText(string guitexteditctrl){ return m_ts.fnGuiTextEditCtrl_getText(guitexteditctrl); } /// -/// @brief Checks to see if all text in the control has been selected. @tsexample // Check to see if all text has been selected or not. %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); @endtsexample @return True if all text in the control is selected, otherwise false. @see GuiControl) +/// @brief Checks to see if all text in the control has been selected. +/// @tsexample +/// // Check to see if all text has been selected or not. +/// %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); +/// @endtsexample +/// @return True if all text in the control is selected, otherwise false. +/// @see GuiControl) +/// /// public bool isAllTextSelected(string guitexteditctrl){ @@ -14398,7 +19970,13 @@ public bool isAllTextSelected(string guitexteditctrl){ return m_ts.fnGuiTextEditCtrl_isAllTextSelected(guitexteditctrl); } /// -/// @brief Selects all text within the control. @tsexample // Inform the control to select all of its text. %thisGuiTextEditCtrl.selectAllText(); @endtsexample @see GuiControl) +/// @brief Selects all text within the control. +/// @tsexample +/// // Inform the control to select all of its text. +/// %thisGuiTextEditCtrl.selectAllText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void selectAllText(string guitexteditctrl){ @@ -14406,7 +19984,16 @@ public void selectAllText(string guitexteditctrl){ m_ts.fnGuiTextEditCtrl_selectAllText(guitexteditctrl); } /// -/// @brief Sets the text cursor at the defined position within the control. @param position Text position to set the text cursor. @tsexample // Define the cursor position %position = \"12\"; // Inform the GuiTextEditCtrl control to place the text cursor at the defined position %thisGuiTextEditCtrl.setCursorPos(%position); @endtsexample @see GuiControl) +/// @brief Sets the text cursor at the defined position within the control. +/// @param position Text position to set the text cursor. +/// @tsexample +/// // Define the cursor position +/// %position = \"12\"; +/// // Inform the GuiTextEditCtrl control to place the text cursor at the defined position +/// %thisGuiTextEditCtrl.setCursorPos(%position); +/// @endtsexample +/// @see GuiControl) +/// /// public void setCursorPos(string guitexteditctrl, int position){ @@ -14414,7 +20001,16 @@ public void setCursorPos(string guitexteditctrl, int position){ m_ts.fnGuiTextEditCtrl_setCursorPos(guitexteditctrl, position); } /// -/// @brief Sets the text in the control. @param text Text to place in the control. @tsexample // Define the text to display %text = \"Text!\" // Inform the GuiTextEditCtrl to display the defined text %thisGuiTextEditCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to place in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Text!\" +/// // Inform the GuiTextEditCtrl to display the defined text +/// %thisGuiTextEditCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void setText(string guitexteditctrl, string text){ @@ -14427,14 +20023,26 @@ public void setText(string guitexteditctrl, string text){ /// public class GuiTextListCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTextListCtrlObject(ref Omni ts){m_ts = ts;} /// -/// ,-1), @brief Adds a new row at end of the list with the defined id and text. If index is used, then the new row is inserted at the row location of 'index'. @param id Id of the new row. @param text Text to display at the new row. @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. @tsexample // Define the id %id = \"4\"; // Define the text to display %text = \"Display Text\" // Define the index (optional) %index = \"2\" // Inform the GuiTextListCtrl control to add the new row with the defined information. %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); @endtsexample @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. @see References) +/// ,-1), +/// @brief Adds a new row at end of the list with the defined id and text. +/// If index is used, then the new row is inserted at the row location of 'index'. +/// @param id Id of the new row. +/// @param text Text to display at the new row. +/// @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text to display +/// %text = \"Display Text\" +/// // Define the index (optional) +/// %index = \"2\" +/// // Inform the GuiTextListCtrl control to add the new row with the defined information. +/// %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); +/// @endtsexample +/// @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. +/// @see References) +/// /// public int addRow(string guitextlistctrl, int id = 0, string text = "", int index = -1){ @@ -14442,7 +20050,13 @@ public int addRow(string guitextlistctrl, int id = 0, string text = "", int ind return m_ts.fnGuiTextListCtrl_addRow(guitextlistctrl, id, text, index); } /// -/// @brief Clear the list. @tsexample // Inform the GuiTextListCtrl control to clear its contents %thisGuiTextListCtrl.clear(); @endtsexample @see GuiControl) +/// @brief Clear the list. +/// @tsexample +/// // Inform the GuiTextListCtrl control to clear its contents +/// %thisGuiTextListCtrl.clear(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clear(string guitextlistctrl){ @@ -14450,7 +20064,13 @@ public void clear(string guitextlistctrl){ m_ts.fnGuiTextListCtrl_clear(guitextlistctrl); } /// -/// @brief Set the selection to nothing. @tsexample // Deselect anything that is currently selected %thisGuiTextListCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Set the selection to nothing. +/// @tsexample +/// // Deselect anything that is currently selected +/// %thisGuiTextListCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void clearSelection(string guitextlistctrl){ @@ -14459,6 +20079,7 @@ public void clearSelection(string guitextlistctrl){ } /// /// ) +/// /// public int findColumnTextIndex(string guitextlistctrl, int columnId, string columnText){ @@ -14466,7 +20087,17 @@ public int findColumnTextIndex(string guitextlistctrl, int columnId, string col return m_ts.fnGuiTextListCtrl_findColumnTextIndex(guitextlistctrl, columnId, columnText); } /// -/// @brief Find needle in the list, and return the row number it was found in. @param needle Text to find in the list. @tsexample // Define the text to find in the list %needle = \"Text To Find\"; // Request the row number that contains the defined text to find %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); @endtsexample @return Row number that the defined text was found in, @see GuiControl) +/// @brief Find needle in the list, and return the row number it was found in. +/// @param needle Text to find in the list. +/// @tsexample +/// // Define the text to find in the list +/// %needle = \"Text To Find\"; +/// // Request the row number that contains the defined text to find +/// %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); +/// @endtsexample +/// @return Row number that the defined text was found in, +/// @see GuiControl) +/// /// public int findTextIndex(string guitextlistctrl, string needle){ @@ -14474,7 +20105,17 @@ public int findTextIndex(string guitextlistctrl, string needle){ return m_ts.fnGuiTextListCtrl_findTextIndex(guitextlistctrl, needle); } /// -/// @brief Get the row ID for an index. @param index Index to get the RowID at @tsexample // Define the index %index = \"3\"; // Request the row ID at the defined index %rowId = %thisGuiTextListCtrl.getRowId(%index); @endtsexample @return RowId at the defined index. @see GuiControl) +/// @brief Get the row ID for an index. +/// @param index Index to get the RowID at +/// @tsexample +/// // Define the index +/// %index = \"3\"; +/// // Request the row ID at the defined index +/// %rowId = %thisGuiTextListCtrl.getRowId(%index); +/// @endtsexample +/// @return RowId at the defined index. +/// @see GuiControl) +/// /// public int getRowId(string guitextlistctrl, int index){ @@ -14482,7 +20123,16 @@ public int getRowId(string guitextlistctrl, int index){ return m_ts.fnGuiTextListCtrl_getRowId(guitextlistctrl, index); } /// -/// @brief Get the row number for a specified id. @param id Id to get the row number at @tsexample // Define the id %id = \"4\"; // Request the row number from the GuiTextListCtrl control at the defined id. %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); @endtsexample @see GuiControl) +/// @brief Get the row number for a specified id. +/// @param id Id to get the row number at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Request the row number from the GuiTextListCtrl control at the defined id. +/// %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public int getRowNumById(string guitextlistctrl, int id){ @@ -14490,7 +20140,17 @@ public int getRowNumById(string guitextlistctrl, int id){ return m_ts.fnGuiTextListCtrl_getRowNumById(guitextlistctrl, id); } /// -/// @brief Get the text of the row with the specified index. @param index Row index to acquire the text at. @tsexample // Define the row index %index = \"5\"; // Request the text from the row at the defined index %rowText = %thisGuiTextListCtrl.getRowText(%index); @endtsexample @return Text at the defined row index. @see GuiControl) +/// @brief Get the text of the row with the specified index. +/// @param index Row index to acquire the text at. +/// @tsexample +/// // Define the row index +/// %index = \"5\"; +/// // Request the text from the row at the defined index +/// %rowText = %thisGuiTextListCtrl.getRowText(%index); +/// @endtsexample +/// @return Text at the defined row index. +/// @see GuiControl) +/// /// public string getRowText(string guitextlistctrl, int index){ @@ -14498,7 +20158,16 @@ public string getRowText(string guitextlistctrl, int index){ return m_ts.fnGuiTextListCtrl_getRowText(guitextlistctrl, index); } /// -/// @brief Get the text of a row with the specified id. @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to return the text at the defined row id %rowText = %thisGuiTextListCtrl.getRowTextById(%id); @endtsexample @return Row text at the requested row id. @see GuiControl) +/// @brief Get the text of a row with the specified id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to return the text at the defined row id +/// %rowText = %thisGuiTextListCtrl.getRowTextById(%id); +/// @endtsexample +/// @return Row text at the requested row id. +/// @see GuiControl) +/// /// public string getRowTextById(string guitextlistctrl, int id){ @@ -14506,7 +20175,14 @@ public string getRowTextById(string guitextlistctrl, int id){ return m_ts.fnGuiTextListCtrl_getRowTextById(guitextlistctrl, id); } /// -/// @brief Get the ID of the currently selected item. @tsexample // Acquire the ID of the selected item in the list. %id = %thisGuiTextListCtrl.getSelectedId(); @endtsexample @return The id of the selected item in the list. @see GuiControl) +/// @brief Get the ID of the currently selected item. +/// @tsexample +/// // Acquire the ID of the selected item in the list. +/// %id = %thisGuiTextListCtrl.getSelectedId(); +/// @endtsexample +/// @return The id of the selected item in the list. +/// @see GuiControl) +/// /// public int getSelectedId(string guitextlistctrl){ @@ -14514,7 +20190,14 @@ public int getSelectedId(string guitextlistctrl){ return m_ts.fnGuiTextListCtrl_getSelectedId(guitextlistctrl); } /// -/// @brief Returns the selected row index (not the row ID). @tsexample // Acquire the selected row index %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); @endtsexample @return Index of the selected row @see GuiControl) +/// @brief Returns the selected row index (not the row ID). +/// @tsexample +/// // Acquire the selected row index +/// %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); +/// @endtsexample +/// @return Index of the selected row +/// @see GuiControl) +/// /// public int getSelectedRow(string guitextlistctrl){ @@ -14522,7 +20205,17 @@ public int getSelectedRow(string guitextlistctrl){ return m_ts.fnGuiTextListCtrl_getSelectedRow(guitextlistctrl); } /// -/// @brief Check if the specified row is currently active or not. @param rowNum Row number to check the active state. @tsexample // Define the row number %rowNum = \"5\"; // Request the active state of the defined row number from the GuiTextListCtrl control. %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); @endtsexample @return Active state of the defined row number. @see GuiControl) +/// @brief Check if the specified row is currently active or not. +/// @param rowNum Row number to check the active state. +/// @tsexample +/// // Define the row number +/// %rowNum = \"5\"; +/// // Request the active state of the defined row number from the GuiTextListCtrl control. +/// %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); +/// @endtsexample +/// @return Active state of the defined row number. +/// @see GuiControl) +/// /// public bool isRowActive(string guitextlistctrl, int rowNum){ @@ -14530,7 +20223,16 @@ public bool isRowActive(string guitextlistctrl, int rowNum){ return m_ts.fnGuiTextListCtrl_isRowActive(guitextlistctrl, rowNum); } /// -/// @brief Remove a row from the table, based on its index. @param index Row index to remove from the list. @tsexample // Define the row index %index = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined row index %thisGuiTextListCtrl.removeRow(%index); @endtsexample @see GuiControl) +/// @brief Remove a row from the table, based on its index. +/// @param index Row index to remove from the list. +/// @tsexample +/// // Define the row index +/// %index = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined row index +/// %thisGuiTextListCtrl.removeRow(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void removeRow(string guitextlistctrl, int index){ @@ -14538,7 +20240,16 @@ public void removeRow(string guitextlistctrl, int index){ m_ts.fnGuiTextListCtrl_removeRow(guitextlistctrl, index); } /// -/// @brief Remove row with the specified id. @param id Id to remove the row entry at @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined id %thisGuiTextListCtrl.removeRowById(%id); @endtsexample @see GuiControl) +/// @brief Remove row with the specified id. +/// @param id Id to remove the row entry at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined id +/// %thisGuiTextListCtrl.removeRowById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void removeRowById(string guitextlistctrl, int id){ @@ -14546,7 +20257,14 @@ public void removeRowById(string guitextlistctrl, int id){ m_ts.fnGuiTextListCtrl_removeRowById(guitextlistctrl, id); } /// -/// @brief Get the number of rows. @tsexample // Get the number of rows in the list %rowCount = %thisGuiTextListCtrl.rowCount(); @endtsexample @return Number of rows in the list. @see GuiControl) +/// @brief Get the number of rows. +/// @tsexample +/// // Get the number of rows in the list +/// %rowCount = %thisGuiTextListCtrl.rowCount(); +/// @endtsexample +/// @return Number of rows in the list. +/// @see GuiControl) +/// /// public int rowCount(string guitextlistctrl){ @@ -14554,7 +20272,16 @@ public int rowCount(string guitextlistctrl){ return m_ts.fnGuiTextListCtrl_rowCount(guitextlistctrl); } /// -/// @brief Scroll so the specified row is visible @param rowNum Row number to make visible @tsexample // Define the row number to make visible %rowNum = \"4\"; // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. %thisGuiTextListCtrl.scrollVisible(%rowNum); @endtsexample @see GuiControl) +/// @brief Scroll so the specified row is visible +/// @param rowNum Row number to make visible +/// @tsexample +/// // Define the row number to make visible +/// %rowNum = \"4\"; +/// // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. +/// %thisGuiTextListCtrl.scrollVisible(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void scrollVisible(string guitextlistctrl, int rowNum){ @@ -14562,7 +20289,19 @@ public void scrollVisible(string guitextlistctrl, int rowNum){ m_ts.fnGuiTextListCtrl_scrollVisible(guitextlistctrl, rowNum); } /// -/// @brief Mark a specified row as active/not. @param rowNum Row number to change the active state. @param active Boolean active state to set the row number. @tsexample // Define the row number %rowNum = \"4\"; // Define the boolean active state %active = \"true\"; // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. %thisGuiTextListCtrl.setRowActive(%rowNum,%active); @endtsexample @see GuiControl) +/// @brief Mark a specified row as active/not. +/// @param rowNum Row number to change the active state. +/// @param active Boolean active state to set the row number. +/// @tsexample +/// // Define the row number +/// %rowNum = \"4\"; +/// // Define the boolean active state +/// %active = \"true\"; +/// // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. +/// %thisGuiTextListCtrl.setRowActive(%rowNum,%active); +/// @endtsexample +/// @see GuiControl) +/// /// public void setRowActive(string guitextlistctrl, int rowNum, bool active){ @@ -14570,7 +20309,19 @@ public void setRowActive(string guitextlistctrl, int rowNum, bool active){ m_ts.fnGuiTextListCtrl_setRowActive(guitextlistctrl, rowNum, active); } /// -/// @brief Sets the text at the defined id. @param id Id to change. @param text Text to use at the Id. @tsexample // Define the id %id = \"4\"; // Define the text %text = \"Text To Display\"; // Inform the GuiTextListCtrl control to display the defined text at the defined id %thisGuiTextListCtrl.setRowById(%id,%text); @endtsexample @see GuiControl) +/// @brief Sets the text at the defined id. +/// @param id Id to change. +/// @param text Text to use at the Id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text +/// %text = \"Text To Display\"; +/// // Inform the GuiTextListCtrl control to display the defined text at the defined id +/// %thisGuiTextListCtrl.setRowById(%id,%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void setRowById(string guitextlistctrl, int id, string text){ @@ -14578,7 +20329,16 @@ public void setRowById(string guitextlistctrl, int id, string text){ m_ts.fnGuiTextListCtrl_setRowById(guitextlistctrl, id, text); } /// -/// @brief Finds the specified entry by id, then marks its row as selected. @param id Entry within the text list to make selected. @tsexample // Define the id %id = \"5\"; // Inform the GuiTextListCtrl control to set the defined id entry as selected %thisGuiTextListCtrl.setSelectedById(%id); @endtsexample @see GuiControl) +/// @brief Finds the specified entry by id, then marks its row as selected. +/// @param id Entry within the text list to make selected. +/// @tsexample +/// // Define the id +/// %id = \"5\"; +/// // Inform the GuiTextListCtrl control to set the defined id entry as selected +/// %thisGuiTextListCtrl.setSelectedById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSelectedById(string guitextlistctrl, int id){ @@ -14586,7 +20346,15 @@ public void setSelectedById(string guitextlistctrl, int id){ m_ts.fnGuiTextListCtrl_setSelectedById(guitextlistctrl, id); } /// -/// @briefSelects the specified row. @param rowNum Row number to set selected. @tsexample // Define the row number to set selected %rowNum = \"4\"; %guiTextListCtrl.setSelectedRow(%rowNum); @endtsexample @see GuiControl) +/// @briefSelects the specified row. +/// @param rowNum Row number to set selected. +/// @tsexample +/// // Define the row number to set selected +/// %rowNum = \"4\"; +/// %guiTextListCtrl.setSelectedRow(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void setSelectedRow(string guitextlistctrl, int rowNum){ @@ -14594,7 +20362,19 @@ public void setSelectedRow(string guitextlistctrl, int rowNum){ m_ts.fnGuiTextListCtrl_setSelectedRow(guitextlistctrl, rowNum); } /// -/// @brief Performs a standard (alphabetical) sort on the values in the specified column. @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sort(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Performs a standard (alphabetical) sort on the values in the specified column. +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sort(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void sort(string guitextlistctrl, int columnId, bool increasing = true){ @@ -14602,7 +20382,20 @@ public void sort(string guitextlistctrl, int columnId, bool increasing = true){ m_ts.fnGuiTextListCtrl_sort(guitextlistctrl, columnId, increasing); } /// -/// @brief Perform a numerical sort on the values in the specified column. Detailed description @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sortNumerical(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Perform a numerical sort on the values in the specified column. +/// Detailed description +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sortNumerical(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void sortNumerical(string guitextlistctrl, int columnID, bool increasing = true){ @@ -14615,14 +20408,10 @@ public void sortNumerical(string guitextlistctrl, int columnID, bool increasing /// public class GuiTheoraCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTheoraCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Get the current playback time. @return The elapsed playback time in seconds. ) +/// Get the current playback time. +/// @return The elapsed playback time in seconds. ) +/// /// public float getCurrentTime(string guitheoractrl){ @@ -14630,7 +20419,9 @@ public float getCurrentTime(string guitheoractrl){ return m_ts.fnGuiTheoraCtrl_getCurrentTime(guitheoractrl); } /// -/// Test whether the video has finished playing. @return True if the video has finished playing, false otherwise. ) +/// Test whether the video has finished playing. +/// @return True if the video has finished playing, false otherwise. ) +/// /// public bool isPlaybackDone(string guitheoractrl){ @@ -14638,7 +20429,9 @@ public bool isPlaybackDone(string guitheoractrl){ return m_ts.fnGuiTheoraCtrl_isPlaybackDone(guitheoractrl); } /// -/// Pause playback of the video. If the video is not currently playing, the call is ignored. While stopped, the control displays the last frame. ) +/// Pause playback of the video. If the video is not currently playing, the call is ignored. +/// While stopped, the control displays the last frame. ) +/// /// public void pause(string guitheoractrl){ @@ -14647,6 +20440,7 @@ public void pause(string guitheoractrl){ } /// /// Start playing the video. If the video is already playing, the call is ignored. ) +/// /// public void play(string guitheoractrl){ @@ -14654,7 +20448,10 @@ public void play(string guitheoractrl){ m_ts.fnGuiTheoraCtrl_play(guitheoractrl); } /// -/// Set the video file to play. If a video is already playing, playback is stopped and the new video file is loaded. @param filename The video file to load. ) +/// Set the video file to play. If a video is already playing, playback is stopped and +/// the new video file is loaded. +/// @param filename The video file to load. ) +/// /// public void setFile(string guitheoractrl, string filename){ @@ -14662,7 +20459,9 @@ public void setFile(string guitheoractrl, string filename){ m_ts.fnGuiTheoraCtrl_setFile(guitheoractrl, filename); } /// -/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. While stopped, the control renders empty with just the background color. ) +/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. +/// While stopped, the control renders empty with just the background color. ) +/// /// public void stop(string guitheoractrl){ @@ -14675,14 +20474,9 @@ public void stop(string guitheoractrl){ /// public class GuiTickCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTickCtrlObject(ref Omni ts){m_ts = ts;} /// /// ( [tick = true] ) - This will set this object to either be processing ticks or not ) +/// /// public void GuiTickCtrl_setProcessTicks(string guitickctrl, bool tick = true){ @@ -14695,14 +20489,9 @@ public void GuiTickCtrl_setProcessTicks(string guitickctrl, bool tick = true){ /// public class GuiToolboxButtonCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiToolboxButtonCtrlObject(ref Omni ts){m_ts = ts;} /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void GuiToolboxButtonCtrl_setHoverBitmap(string guitoolboxbuttonctrl, string name){ @@ -14711,6 +20500,7 @@ public void GuiToolboxButtonCtrl_setHoverBitmap(string guitoolboxbuttonctrl, st } /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void GuiToolboxButtonCtrl_setLoweredBitmap(string guitoolboxbuttonctrl, string name){ @@ -14719,6 +20509,7 @@ public void GuiToolboxButtonCtrl_setLoweredBitmap(string guitoolboxbuttonctrl, } /// /// ( filepath name ) sets the bitmap that shows when the button is active) +/// /// public void GuiToolboxButtonCtrl_setNormalBitmap(string guitoolboxbuttonctrl, string name){ @@ -14731,14 +20522,9 @@ public void GuiToolboxButtonCtrl_setNormalBitmap(string guitoolboxbuttonctrl, s /// public class GuiTreeViewCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTreeViewCtrlObject(ref Omni ts){m_ts = ts;} /// /// addChildSelectionByValue(TreeItemId parent, value)) +/// /// public void GuiTreeViewCtrl_addChildSelectionByValue(string guitreeviewctrl, int id, string tableEntry){ @@ -14747,6 +20533,7 @@ public void GuiTreeViewCtrl_addChildSelectionByValue(string guitreeviewctrl, in } /// /// (builds an icon table)) +/// /// public bool GuiTreeViewCtrl_buildIconTable(string guitreeviewctrl, string icons){ @@ -14755,6 +20542,7 @@ public bool GuiTreeViewCtrl_buildIconTable(string guitreeviewctrl, string icons } /// /// Build the visible tree) +/// /// public void GuiTreeViewCtrl_buildVisibleTree(string guitreeviewctrl, bool forceFullUpdate = false){ @@ -14763,6 +20551,7 @@ public void GuiTreeViewCtrl_buildVisibleTree(string guitreeviewctrl, bool force } /// /// For internal use. ) +/// /// public void GuiTreeViewCtrl_cancelRename(string guitreeviewctrl){ @@ -14771,6 +20560,7 @@ public void GuiTreeViewCtrl_cancelRename(string guitreeviewctrl){ } /// /// () - empty tree) +/// /// public void GuiTreeViewCtrl_clear(string guitreeviewctrl){ @@ -14779,6 +20569,7 @@ public void GuiTreeViewCtrl_clear(string guitreeviewctrl){ } /// /// (TreeItemId item, string newText, string newValue)) +/// /// public bool GuiTreeViewCtrl_editItem(string guitreeviewctrl, int item, string newText, string newValue){ @@ -14787,6 +20578,7 @@ public bool GuiTreeViewCtrl_editItem(string guitreeviewctrl, int item, string n } /// /// (TreeItemId item, bool expand=true)) +/// /// public bool GuiTreeViewCtrl_expandItem(string guitreeviewctrl, int id, bool expand = true){ @@ -14795,6 +20587,7 @@ public bool GuiTreeViewCtrl_expandItem(string guitreeviewctrl, int id, bool exp } /// /// (find item by object id and returns the mId)) +/// /// public int GuiTreeViewCtrl_findItemByObjectId(string guitreeviewctrl, int itemId){ @@ -14803,6 +20596,7 @@ public int GuiTreeViewCtrl_findItemByObjectId(string guitreeviewctrl, int itemI } /// /// (TreeItemId item)) +/// /// public int GuiTreeViewCtrl_getChild(string guitreeviewctrl, int itemId){ @@ -14811,6 +20605,7 @@ public int GuiTreeViewCtrl_getChild(string guitreeviewctrl, int itemId){ } /// /// Get id for root item.) +/// /// public int GuiTreeViewCtrl_getFirstRootItem(string guitreeviewctrl){ @@ -14819,6 +20614,7 @@ public int GuiTreeViewCtrl_getFirstRootItem(string guitreeviewctrl){ } /// /// ) +/// /// public int GuiTreeViewCtrl_getItemCount(string guitreeviewctrl){ @@ -14827,6 +20623,7 @@ public int GuiTreeViewCtrl_getItemCount(string guitreeviewctrl){ } /// /// (TreeItemId item)) +/// /// public string GuiTreeViewCtrl_getItemText(string guitreeviewctrl, int index){ @@ -14835,6 +20632,7 @@ public string GuiTreeViewCtrl_getItemText(string guitreeviewctrl, int index){ } /// /// (TreeItemId item)) +/// /// public string GuiTreeViewCtrl_getItemValue(string guitreeviewctrl, int itemId){ @@ -14843,6 +20641,7 @@ public string GuiTreeViewCtrl_getItemValue(string guitreeviewctrl, int itemId){ } /// /// (TreeItemId item)) +/// /// public int GuiTreeViewCtrl_getNextSibling(string guitreeviewctrl, int itemId){ @@ -14851,6 +20650,7 @@ public int GuiTreeViewCtrl_getNextSibling(string guitreeviewctrl, int itemId){ } /// /// (TreeItemId item)) +/// /// public int GuiTreeViewCtrl_getParentItem(string guitreeviewctrl, int itemId){ @@ -14859,6 +20659,7 @@ public int GuiTreeViewCtrl_getParentItem(string guitreeviewctrl, int itemId){ } /// /// (TreeItemId item)) +/// /// public int GuiTreeViewCtrl_getPrevSibling(string guitreeviewctrl, int itemId){ @@ -14867,6 +20668,7 @@ public int GuiTreeViewCtrl_getPrevSibling(string guitreeviewctrl, int itemId){ } /// /// ( int index=0 ) - Return the selected item at the given index.) +/// /// public int GuiTreeViewCtrl_getSelectedItem(string guitreeviewctrl, int index = 0){ @@ -14875,6 +20677,7 @@ public int GuiTreeViewCtrl_getSelectedItem(string guitreeviewctrl, int index = } /// /// returns a space seperated list of mulitple item ids) +/// /// public string GuiTreeViewCtrl_getSelectedItemList(string guitreeviewctrl){ @@ -14883,6 +20686,7 @@ public string GuiTreeViewCtrl_getSelectedItemList(string guitreeviewctrl){ } /// /// ) +/// /// public int GuiTreeViewCtrl_getSelectedItemsCount(string guitreeviewctrl){ @@ -14891,6 +20695,7 @@ public int GuiTreeViewCtrl_getSelectedItemsCount(string guitreeviewctrl){ } /// /// ( int index=0 ) - Return the currently selected SimObject at the given index in inspector mode or -1) +/// /// public int GuiTreeViewCtrl_getSelectedObject(string guitreeviewctrl, int index = 0){ @@ -14899,6 +20704,7 @@ public int GuiTreeViewCtrl_getSelectedObject(string guitreeviewctrl, int index } /// /// Returns a space sperated list of all selected object ids.) +/// /// public string GuiTreeViewCtrl_getSelectedObjectList(string guitreeviewctrl){ @@ -14907,6 +20713,7 @@ public string GuiTreeViewCtrl_getSelectedObjectList(string guitreeviewctrl){ } /// /// (TreeItemId item,Delimiter=none) gets the text from the current node to the root, concatenating at each branch upward, with a specified delimiter optionally) +/// /// public string GuiTreeViewCtrl_getTextToRoot(string guitreeviewctrl, int itemId, string delimiter){ @@ -14915,6 +20722,7 @@ public string GuiTreeViewCtrl_getTextToRoot(string guitreeviewctrl, int itemId, } /// /// ( int id ) - Returns true if the given item contains child items. ) +/// /// public bool GuiTreeViewCtrl_isParentItem(string guitreeviewctrl, int id){ @@ -14923,6 +20731,7 @@ public bool GuiTreeViewCtrl_isParentItem(string guitreeviewctrl, int id){ } /// /// (TreeItemId item, bool mark=true)) +/// /// public bool GuiTreeViewCtrl_markItem(string guitreeviewctrl, int id, bool mark = true){ @@ -14931,6 +20740,7 @@ public bool GuiTreeViewCtrl_markItem(string guitreeviewctrl, int id, bool mark } /// /// (TreeItemId item)) +/// /// public void GuiTreeViewCtrl_moveItemDown(string guitreeviewctrl, int index){ @@ -14939,6 +20749,7 @@ public void GuiTreeViewCtrl_moveItemDown(string guitreeviewctrl, int index){ } /// /// (TreeItemId item)) +/// /// public void GuiTreeViewCtrl_moveItemUp(string guitreeviewctrl, int index){ @@ -14947,6 +20758,7 @@ public void GuiTreeViewCtrl_moveItemUp(string guitreeviewctrl, int index){ } /// /// For internal use. ) +/// /// public void GuiTreeViewCtrl_onRenameValidate(string guitreeviewctrl){ @@ -14955,6 +20767,7 @@ public void GuiTreeViewCtrl_onRenameValidate(string guitreeviewctrl){ } /// /// (SimSet obj, bool okToEdit=true) Set the root of the tree view to the specified object, or to the root set.) +/// /// public void GuiTreeViewCtrl_open(string guitreeviewctrl, string objName, bool okToEdit = true){ @@ -14963,6 +20776,7 @@ public void GuiTreeViewCtrl_open(string guitreeviewctrl, string objName, bool o } /// /// removeAllChildren(TreeItemId parent)) +/// /// public void GuiTreeViewCtrl_removeAllChildren(string guitreeviewctrl, int itemId){ @@ -14971,6 +20785,7 @@ public void GuiTreeViewCtrl_removeAllChildren(string guitreeviewctrl, int itemI } /// /// removeChildSelectionByValue(TreeItemId parent, value)) +/// /// public void GuiTreeViewCtrl_removeChildSelectionByValue(string guitreeviewctrl, int id, string tableEntry){ @@ -14979,6 +20794,7 @@ public void GuiTreeViewCtrl_removeChildSelectionByValue(string guitreeviewctrl, } /// /// (TreeItemId item)) +/// /// public bool GuiTreeViewCtrl_removeItem(string guitreeviewctrl, int itemId){ @@ -14987,6 +20803,7 @@ public bool GuiTreeViewCtrl_removeItem(string guitreeviewctrl, int itemId){ } /// /// (deselects an item)) +/// /// public void GuiTreeViewCtrl_removeSelection(string guitreeviewctrl, int id){ @@ -14995,6 +20812,7 @@ public void GuiTreeViewCtrl_removeSelection(string guitreeviewctrl, int id){ } /// /// (TreeItemId item)) +/// /// public void GuiTreeViewCtrl_scrollVisible(string guitreeviewctrl, int itemId){ @@ -15003,6 +20821,7 @@ public void GuiTreeViewCtrl_scrollVisible(string guitreeviewctrl, int itemId){ } /// /// (show item by object id. returns true if sucessful.)) +/// /// public int GuiTreeViewCtrl_scrollVisibleByObjectId(string guitreeviewctrl, int itemId){ @@ -15011,6 +20830,7 @@ public int GuiTreeViewCtrl_scrollVisibleByObjectId(string guitreeviewctrl, int } /// /// (TreeItemId item, bool select=true)) +/// /// public bool GuiTreeViewCtrl_selectItem(string guitreeviewctrl, int id, bool select = true){ @@ -15019,6 +20839,7 @@ public bool GuiTreeViewCtrl_selectItem(string guitreeviewctrl, int id, bool sel } /// /// ( bool value=true ) - Enable/disable debug output. ) +/// /// public void GuiTreeViewCtrl_setDebug(string guitreeviewctrl, bool value = true){ @@ -15027,6 +20848,7 @@ public void GuiTreeViewCtrl_setDebug(string guitreeviewctrl, bool value = true) } /// /// ( int id, int normalImage, int expandedImage ) - Sets the normal and expanded images to show for the given item. ) +/// /// public void GuiTreeViewCtrl_setItemImages(string guitreeviewctrl, int id, sbyte normalImage, sbyte expandedImage){ @@ -15035,6 +20857,7 @@ public void GuiTreeViewCtrl_setItemImages(string guitreeviewctrl, int id, sbyte } /// /// ( int id, string text ) - Set the tooltip to show for the given item. ) +/// /// public void GuiTreeViewCtrl_setItemTooltip(string guitreeviewctrl, int id, string text){ @@ -15043,6 +20866,7 @@ public void GuiTreeViewCtrl_setItemTooltip(string guitreeviewctrl, int id, stri } /// /// ( TreeItemId id ) - Show the rename text field for the given item (only one at a time). ) +/// /// public void GuiTreeViewCtrl_showItemRenameCtrl(string guitreeviewctrl, int id){ @@ -15051,6 +20875,7 @@ public void GuiTreeViewCtrl_showItemRenameCtrl(string guitreeviewctrl, int id){ } /// /// ( int parent, bool traverseHierarchy=false, bool parentsFirst=false, bool caseSensitive=true ) - Sorts all items of the given parent (or root). With 'hierarchy', traverses hierarchy. ) +/// /// public void GuiTreeViewCtrl_sort(string guitreeviewctrl, int parent = 0, bool traverseHierarchy = false, bool parentsFirst = false, bool caseSensitive = true){ @@ -15058,7 +20883,12 @@ public void GuiTreeViewCtrl_sort(string guitreeviewctrl, int parent = 0, bool t m_ts.fn_GuiTreeViewCtrl_sort(guitreeviewctrl, parent, traverseHierarchy, parentsFirst, caseSensitive); } /// -/// Add an item/object to the current selection. @param id ID of item/object to add to the selection. @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, the control will defer refreshing the tree and wait until addSelection() is called with this parameter set to true. ) +/// Add an item/object to the current selection. +/// @param id ID of item/object to add to the selection. +/// @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, +/// the control will defer refreshing the tree and wait until addSelection() is called with this parameter set +/// to true. ) +/// /// public void addSelection(string guitreeviewctrl, int id, bool isLastSelection = true){ @@ -15066,7 +20896,10 @@ public void addSelection(string guitreeviewctrl, int id, bool isLastSelection = m_ts.fnGuiTreeViewCtrl_addSelection(guitreeviewctrl, id, isLastSelection); } /// -/// Clear the current item filtering pattern. @see setFilterText @see getFilterText ) +/// Clear the current item filtering pattern. +/// @see setFilterText +/// @see getFilterText ) +/// /// public void clearFilterText(string guitreeviewctrl){ @@ -15075,6 +20908,7 @@ public void clearFilterText(string guitreeviewctrl){ } /// /// Unselect all currently selected items. ) +/// /// public void clearSelection(string guitreeviewctrl){ @@ -15083,6 +20917,7 @@ public void clearSelection(string guitreeviewctrl){ } /// /// Delete all items/objects in the current selection. ) +/// /// public void deleteSelection(string guitreeviewctrl){ @@ -15090,7 +20925,12 @@ public void deleteSelection(string guitreeviewctrl){ m_ts.fnGuiTreeViewCtrl_deleteSelection(guitreeviewctrl); } /// -/// Get the child item of the given parent item whose text matches @a childName. @param parentId Item ID of the parent in which to look for the child. @param childName Text of the child item to find. @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. @note This method does not recurse, i.e. it only looks for direct children. ) +/// Get the child item of the given parent item whose text matches @a childName. +/// @param parentId Item ID of the parent in which to look for the child. +/// @param childName Text of the child item to find. +/// @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. +/// @note This method does not recurse, i.e. it only looks for direct children. ) +/// /// public int findChildItemByName(string guitreeviewctrl, int parentId, string childName){ @@ -15098,7 +20938,10 @@ public int findChildItemByName(string guitreeviewctrl, int parentId, string chi return m_ts.fnGuiTreeViewCtrl_findChildItemByName(guitreeviewctrl, parentId, childName); } /// -/// Get the ID of the item whose text matches the given @a text. @param text Item text to match. @return ID of the item or -1 if no item matches the given text. ) +/// Get the ID of the item whose text matches the given @a text. +/// @param text Item text to match. +/// @return ID of the item or -1 if no item matches the given text. ) +/// /// public int findItemByName(string guitreeviewctrl, string text){ @@ -15106,7 +20949,10 @@ public int findItemByName(string guitreeviewctrl, string text){ return m_ts.fnGuiTreeViewCtrl_findItemByName(guitreeviewctrl, text); } /// -/// Get the ID of the item whose value matches @a value. @param value Value text to match. @return ID of the item or -1 if no item has the given value. ) +/// Get the ID of the item whose value matches @a value. +/// @param value Value text to match. +/// @return ID of the item or -1 if no item has the given value. ) +/// /// public int findItemByValue(string guitreeviewctrl, string value){ @@ -15114,7 +20960,12 @@ public int findItemByValue(string guitreeviewctrl, string value){ return m_ts.fnGuiTreeViewCtrl_findItemByValue(guitreeviewctrl, value); } /// -/// Get the current filter expression. Only tree items whose text matches this expression are displayed. By default, the expression is empty and all items are shown. @return The current filter pattern or an empty string if no filter pattern is currently active. @see setFilterText @see clearFilterText ) +/// Get the current filter expression. Only tree items whose text matches this expression +/// are displayed. By default, the expression is empty and all items are shown. +/// @return The current filter pattern or an empty string if no filter pattern is currently active. +/// @see setFilterText +/// @see clearFilterText ) +/// /// public string getFilterText(string guitreeviewctrl){ @@ -15122,7 +20973,9 @@ public string getFilterText(string guitreeviewctrl){ return m_ts.fnGuiTreeViewCtrl_getFilterText(guitreeviewctrl); } /// -/// Call SimObject::setHidden( @a state ) on all objects in the current selection. @param state Visibility state to set objects in selection to. ) +/// Call SimObject::setHidden( @a state ) on all objects in the current selection. +/// @param state Visibility state to set objects in selection to. ) +/// /// public void hideSelection(string guitreeviewctrl, bool state = true){ @@ -15130,7 +20983,16 @@ public void hideSelection(string guitreeviewctrl, bool state = true){ m_ts.fnGuiTreeViewCtrl_hideSelection(guitreeviewctrl, state); } /// -/// , , 0, 0 ), Add a new item to the tree. @param parentId Item ID of parent to which to add the item as a child. 0 is root item. @param text Text to display on the item in the tree. @param value Behind-the-scenes value of the item. @param icon @param normalImage @param expandedImage @return The ID of the newly added item. ) +/// , , 0, 0 ), +/// Add a new item to the tree. +/// @param parentId Item ID of parent to which to add the item as a child. 0 is root item. +/// @param text Text to display on the item in the tree. +/// @param value Behind-the-scenes value of the item. +/// @param icon +/// @param normalImage +/// @param expandedImage +/// @return The ID of the newly added item. ) +/// /// public int insertItem(string guitreeviewctrl, int parentId, string text, string value = "", string icon = "", int normalImage = 0, int expandedImage = 0){ @@ -15139,6 +21001,7 @@ public int insertItem(string guitreeviewctrl, int parentId, string text, string } /// /// Inserts object as a child to the given parent. ) +/// /// public int insertObject(string guitreeviewctrl, int parentId, string obj, bool OKToEdit = false){ @@ -15146,7 +21009,10 @@ public int insertObject(string guitreeviewctrl, int parentId, string obj, bool return m_ts.fnGuiTreeViewCtrl_insertObject(guitreeviewctrl, parentId, obj, OKToEdit); } /// -/// Check whether the given item is currently selected in the tree. @param id Item/object ID. @return True if the given item/object is currently selected in the tree. ) +/// Check whether the given item is currently selected in the tree. +/// @param id Item/object ID. +/// @return True if the given item/object is currently selected in the tree. ) +/// /// public bool isItemSelected(string guitreeviewctrl, int id){ @@ -15154,7 +21020,10 @@ public bool isItemSelected(string guitreeviewctrl, int id){ return m_ts.fnGuiTreeViewCtrl_isItemSelected(guitreeviewctrl, id); } /// -/// Set whether the current selection can be changed by the user or not. @param lock If true, the current selection is frozen and cannot be changed. If false, the selection may be modified. ) +/// Set whether the current selection can be changed by the user or not. +/// @param lock If true, the current selection is frozen and cannot be changed. If false, +/// the selection may be modified. ) +/// /// public void lockSelection(string guitreeviewctrl, bool lockx = true){ @@ -15162,7 +21031,12 @@ public void lockSelection(string guitreeviewctrl, bool lockx = true){ m_ts.fnGuiTreeViewCtrl_lockSelection(guitreeviewctrl, lockx); } /// -/// Set the pattern by which to filter items in the tree. Only items in the tree whose text matches this pattern are displayed. @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. @see getFilterText @see clearFilterText ) +/// Set the pattern by which to filter items in the tree. Only items in the tree whose text +/// matches this pattern are displayed. +/// @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. +/// @see getFilterText +/// @see clearFilterText ) +/// /// public void setFilterText(string guitreeviewctrl, string pattern){ @@ -15171,6 +21045,7 @@ public void setFilterText(string guitreeviewctrl, string pattern){ } /// /// Toggle the hidden state of all objects in the current selection. ) +/// /// public void toggleHideSelection(string guitreeviewctrl){ @@ -15179,6 +21054,7 @@ public void toggleHideSelection(string guitreeviewctrl){ } /// /// Toggle the locked state of all objects in the current selection. ) +/// /// public void toggleLockSelection(string guitreeviewctrl){ @@ -15191,14 +21067,11 @@ public void toggleLockSelection(string guitreeviewctrl){ /// public class GuiTSCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiTSCtrlObject(ref Omni ts){m_ts = ts;} /// -/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. @param radius Radius in world-space units which should fit in the view. @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. +/// @param radius Radius in world-space units which should fit in the view. +/// @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// /// public float calculateViewDistance(string guitsctrl, float radius){ @@ -15207,6 +21080,7 @@ public float calculateViewDistance(string guitsctrl, float radius){ } /// /// ) +/// /// public string getClickVector(string guitsctrl, Point2I mousePoint){ @@ -15215,6 +21089,7 @@ public string getClickVector(string guitsctrl, Point2I mousePoint){ } /// /// ) +/// /// public string getWorldPosition(string guitsctrl, Point2I mousePoint){ @@ -15222,7 +21097,9 @@ public string getWorldPosition(string guitsctrl, Point2I mousePoint){ return m_ts.fnGuiTSCtrl_getWorldPosition(guitsctrl, mousePoint.AsString()); } /// -/// Get the ratio between world-space units and pixels. @return The amount of world-space units covered by the extent of a single pixel. ) +/// Get the ratio between world-space units and pixels. +/// @return The amount of world-space units covered by the extent of a single pixel. ) +/// /// public Point2F getWorldToScreenScale(string guitsctrl){ @@ -15230,7 +21107,10 @@ public Point2F getWorldToScreenScale(string guitsctrl){ return new Point2F ( m_ts.fnGuiTSCtrl_getWorldToScreenScale(guitsctrl)); } /// -/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. @param worldPosition The world-space position to transform to screen-space. @return The ) +/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. +/// @param worldPosition The world-space position to transform to screen-space. +/// @return The ) +/// /// public Point3F project(string guitsctrl, Point3F worldPosition){ @@ -15238,7 +21118,11 @@ public Point3F project(string guitsctrl, Point3F worldPosition){ return new Point3F ( m_ts.fnGuiTSCtrl_project(guitsctrl, worldPosition.AsString())); } /// -/// Transform 3D screen-space coordinates (x, y, depth) to world space. This method can be, for example, used to find the world-space position relating to the current mouse cursor position. @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. @return The world-space position corresponding to the given screen-space coordinates. ) +/// Transform 3D screen-space coordinates (x, y, depth) to world space. +/// This method can be, for example, used to find the world-space position relating to the current mouse cursor position. +/// @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. +/// @return The world-space position corresponding to the given screen-space coordinates. ) +/// /// public Point3F unproject(string guitsctrl, Point3F screenPosition){ @@ -15251,14 +21135,9 @@ public Point3F unproject(string guitsctrl, Point3F screenPosition){ /// public class GuiVariableInspectorObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiVariableInspectorObject(ref Omni ts){m_ts = ts;} /// /// loadVars( searchString ) ) +/// /// public void GuiVariableInspector_loadVars(string guivariableinspector, string searchString){ @@ -15271,14 +21150,9 @@ public void GuiVariableInspector_loadVars(string guivariableinspector, string s /// public class GuiWindowCtrlObject { -private Omni m_ts; - /// - /// - /// - /// -public GuiWindowCtrlObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void attachTo(string guiwindowctrl, string window){ @@ -15287,6 +21161,7 @@ public void attachTo(string guiwindowctrl, string window){ } /// /// Puts the guiwindow back on the main canvas. ) +/// /// public void ClosePopOut(string guiwindowctrl){ @@ -15295,6 +21170,7 @@ public void ClosePopOut(string guiwindowctrl){ } /// /// Returns the title of the window. ) +/// /// public string getWindowTitle(string guiwindowctrl){ @@ -15303,6 +21179,7 @@ public string getWindowTitle(string guiwindowctrl){ } /// /// Returns if the title can be set or not. ) +/// /// public bool isTitleSet(string guiwindowctrl){ @@ -15311,6 +21188,7 @@ public bool isTitleSet(string guiwindowctrl){ } /// /// Puts the guiwindow on a new canvas. ) +/// /// public void OpenPopOut(string guiwindowctrl){ @@ -15319,6 +21197,7 @@ public void OpenPopOut(string guiwindowctrl){ } /// /// Bring the window to the front. ) +/// /// public void selectWindow(string guiwindowctrl){ @@ -15327,6 +21206,7 @@ public void selectWindow(string guiwindowctrl){ } /// /// Set the window's collapsing state. ) +/// /// public void setCollapseGroup(string guiwindowctrl, bool state){ @@ -15335,6 +21215,7 @@ public void setCollapseGroup(string guiwindowctrl, bool state){ } /// /// Displays the option to set the title of the window. ) +/// /// public void setContextTitle(string guiwindowctrl, bool title){ @@ -15343,6 +21224,7 @@ public void setContextTitle(string guiwindowctrl, bool title){ } /// /// Sets the title of the window. ) +/// /// public void setWindowTitle(string guiwindowctrl, string title){ @@ -15351,6 +21233,7 @@ public void setWindowTitle(string guiwindowctrl, string title){ } /// /// Toggle the window collapsing. ) +/// /// public void toggleCollapseGroup(string guiwindowctrl){ @@ -15363,14 +21246,29 @@ public void toggleCollapseGroup(string guiwindowctrl){ /// public class HTTPObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public HTTPObjectObject(ref Omni ts){m_ts = ts;} /// -/// ), @brief Send a GET command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Send the GET command to the server %httpObj.get(%url,%URI,%query); @endtsexample ) +/// ), +/// @brief Send a GET command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Send the GET command to the server +/// %httpObj.get(%url,%URI,%query); +/// @endtsexample +/// ) +/// /// public void get(string httpobject, string Address, string requirstURI, string query = ""){ @@ -15378,7 +21276,31 @@ public void get(string httpobject, string Address, string requirstURI, string q m_ts.fnHTTPObject_get(httpobject, Address, requirstURI, query); } /// -/// @brief Send POST command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. @param post Submission data to be processed. @note The post() method is currently non-functional. @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Specify the submission data. %post = \"\"; // Send the POST command to the server %httpObj.POST(%url,%URI,%query,%post); @endtsexample ) +/// @brief Send POST command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// @param post Submission data to be processed. +/// +/// @note The post() method is currently non-functional. +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Specify the submission data. +/// %post = \"\"; +/// // Send the POST command to the server +/// %httpObj.POST(%url,%URI,%query,%post); +/// @endtsexample +/// ) +/// /// public void post(string httpobject, string Address, string requirstURI, string query, string post){ @@ -15391,14 +21313,16 @@ public void post(string httpobject, string Address, string requirstURI, string /// public class ItemObject { -private Omni m_ts; - /// - /// - /// - /// -public ItemObject(ref Omni ts){m_ts = ts;} /// -/// @brief Get the normal of the surface on which the object is stuck. @return Returns The XYZ normal from where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the normal of the surface on which the object is stuck. +/// @return Returns The XYZ normal from where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string getLastStickyNormal(string item){ @@ -15406,7 +21330,15 @@ public string getLastStickyNormal(string item){ return m_ts.fnItem_getLastStickyNormal(item); } /// -/// @brief Get the position on the surface on which this Item is stuck. @return Returns The XYZ position of where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the position on the surface on which this Item is stuck. +/// @return Returns The XYZ position of where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string getLastStickyPos(string item){ @@ -15414,7 +21346,14 @@ public string getLastStickyPos(string item){ return m_ts.fnItem_getLastStickyPos(item); } /// -/// @brief Is the object at rest (ie, no longer moving)? @return True if the object is at rest, false if it is not. @tsexample // Query the item on if it is or is not at rest. %isAtRest = %item.isAtRest(); @endtsexample ) +/// @brief Is the object at rest (ie, no longer moving)? +/// @return True if the object is at rest, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not at rest. +/// %isAtRest = %item.isAtRest(); +/// @endtsexample +/// ) +/// /// public bool isAtRest(string item){ @@ -15422,7 +21361,15 @@ public bool isAtRest(string item){ return m_ts.fnItem_isAtRest(item); } /// -/// @brief Is the object still rotating? @return True if the object is still rotating, false if it is not. @tsexample // Query the item on if it is or is not rotating. %isRotating = %itemData.isRotating(); @endtsexample @see rotate ) +/// @brief Is the object still rotating? +/// @return True if the object is still rotating, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not rotating. +/// %isRotating = %itemData.isRotating(); +/// @endtsexample +/// @see rotate +/// ) +/// /// public bool isRotating(string item){ @@ -15430,7 +21377,15 @@ public bool isRotating(string item){ return m_ts.fnItem_isRotating(item); } /// -/// @brief Is the object static (ie, non-movable)? @return True if the object is static, false if it is not. @tsexample // Query the item on if it is or is not static. %isStatic = %itemData.isStatic(); @endtsexample @see static ) +/// @brief Is the object static (ie, non-movable)? +/// @return True if the object is static, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not static. +/// %isStatic = %itemData.isStatic(); +/// @endtsexample +/// @see static +/// ) +/// /// public bool isStatic(string item){ @@ -15438,7 +21393,23 @@ public bool isStatic(string item){ return m_ts.fnItem_isStatic(item); } /// -/// @brief Temporarily disable collisions against a specific ShapeBase object. This is useful to prevent a player from immediately picking up an Item they have just thrown. Only one object may be on the timeout list at a time. The timeout is defined as 15 ticks. @param objectID ShapeBase object ID to disable collisions against. @return Returns true if the ShapeBase object requested could be found, false if it could not. @tsexample // Set the ShapeBase Object ID to disable collisions against %ignoreColObj = %player.getID(); // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. %item.setCollisionTimeout(%ignoreColObj); @endtsexample ) +/// @brief Temporarily disable collisions against a specific ShapeBase object. +/// +/// This is useful to prevent a player from immediately picking up an Item they have +/// just thrown. Only one object may be on the timeout list at a time. The timeout is +/// defined as 15 ticks. +/// +/// @param objectID ShapeBase object ID to disable collisions against. +/// @return Returns true if the ShapeBase object requested could be found, false if it could not. +/// +/// @tsexample +/// // Set the ShapeBase Object ID to disable collisions against +/// %ignoreColObj = %player.getID(); +/// // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. +/// %item.setCollisionTimeout(%ignoreColObj); +/// @endtsexample +/// ) +/// /// public bool setCollisionTimeout(string item, int ignoreColObj){ @@ -15451,14 +21422,15 @@ public bool setCollisionTimeout(string item, int ignoreColObj){ /// public class LangTableObject { -private Omni m_ts; - /// - /// - /// - /// -public LangTableObject(ref Omni ts){m_ts = ts;} /// -/// , ), (string filename, [string languageName]) @brief Adds a language to the table @param filename Name and path to the language file @param languageName Optional name to assign to the new language entry @return True If file was successfully found and language created ) +/// , ), +/// (string filename, [string languageName]) +/// @brief Adds a language to the table +/// @param filename Name and path to the language file +/// @param languageName Optional name to assign to the new language entry +/// @return True If file was successfully found and language created +/// ) +/// /// public int LangTable_addLanguage(string langtable, string filename = "", string languageName = ""){ @@ -15466,7 +21438,10 @@ public int LangTable_addLanguage(string langtable, string filename = "", string return m_ts.fn_LangTable_addLanguage(langtable, filename, languageName); } /// -/// () @brief Get the ID of the current language table @return Numerical ID of the current language table) +/// () +/// @brief Get the ID of the current language table +/// @return Numerical ID of the current language table) +/// /// public int LangTable_getCurrentLanguage(string langtable){ @@ -15474,7 +21449,11 @@ public int LangTable_getCurrentLanguage(string langtable){ return m_ts.fn_LangTable_getCurrentLanguage(langtable); } /// -/// (int language) @brief Return the readable name of the language table @param language Numerical ID of the language table to access @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// (int language) +/// @brief Return the readable name of the language table +/// @param language Numerical ID of the language table to access +/// @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// /// public string LangTable_getLangName(string langtable, int langId){ @@ -15482,7 +21461,10 @@ public string LangTable_getLangName(string langtable, int langId){ return m_ts.fn_LangTable_getLangName(langtable, langId); } /// -/// () @brief Used to find out how many languages are in the table @return Size of the vector containing the languages, numerical) +/// () +/// @brief Used to find out how many languages are in the table +/// @return Size of the vector containing the languages, numerical) +/// /// public int LangTable_getNumLang(string langtable){ @@ -15490,7 +21472,13 @@ public int LangTable_getNumLang(string langtable){ return m_ts.fn_LangTable_getNumLang(langtable); } /// -/// (string filename) @brief Grabs a string from the specified table If an invalid is passed, the function will attempt to to grab from the default table @param filename Name of the language table to access @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// (string filename) +/// @brief Grabs a string from the specified table +/// If an invalid is passed, the function will attempt to +/// to grab from the default table +/// @param filename Name of the language table to access +/// @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// /// public string LangTable_getString(string langtable, uint id){ @@ -15498,7 +21486,10 @@ public string LangTable_getString(string langtable, uint id){ return m_ts.fn_LangTable_getString(langtable, id); } /// -/// (int language) @brief Sets the current language table for grabbing text @param language ID of the table) +/// (int language) +/// @brief Sets the current language table for grabbing text +/// @param language ID of the table) +/// /// public void LangTable_setCurrentLanguage(string langtable, int langId){ @@ -15506,7 +21497,10 @@ public void LangTable_setCurrentLanguage(string langtable, int langId){ m_ts.fn_LangTable_setCurrentLanguage(langtable, langId); } /// -/// (int language) @brief Sets the default language table @param language ID of the table) +/// (int language) +/// @brief Sets the default language table +/// @param language ID of the table) +/// /// public void LangTable_setDefaultLanguage(string langtable, int langId){ @@ -15519,14 +21513,9 @@ public void LangTable_setDefaultLanguage(string langtable, int langId){ /// public class LevelInfoObject { -private Omni m_ts; - /// - /// - /// - /// -public LevelInfoObject(ref Omni ts){m_ts = ts;} /// /// ( LevelInfo, setNearClip, void, 3, 3, ( F32 nearClip )) +/// /// public void setNearClip(string levelinfo, string a2= ""){ @@ -15539,14 +21528,9 @@ public void setNearClip(string levelinfo, string a2= ""){ /// public class LightBaseObject { -private Omni m_ts; - /// - /// - /// - /// -public LightBaseObject(ref Omni ts){m_ts = ts;} /// /// Stops the light animation. ) +/// /// public void LightBase_pauseAnimation(string lightbase){ @@ -15554,7 +21538,11 @@ public void LightBase_pauseAnimation(string lightbase){ m_ts.fn_LightBase_pauseAnimation(lightbase); } /// -/// ), ( [LightAnimData anim] )\t Plays a light animation on the light. If no LightAnimData is passed the existing one is played. @hide) +/// ), ( [LightAnimData anim] )\t +/// Plays a light animation on the light. If no LightAnimData is passed the +/// existing one is played. +/// @hide) +/// /// public void LightBase_playAnimation(string lightbase, string anim = ""){ @@ -15562,7 +21550,19 @@ public void LightBase_playAnimation(string lightbase, string anim = ""){ m_ts.fn_LightBase_playAnimation(lightbase, anim); } /// -/// @brief Toggles the light on and off @param state Turns the light on (true) or off (false) @tsexample // Disable the light CrystalLight.setLightEnabled(false); // Renable the light CrystalLight.setLightEnabled(true); @endtsexample) +/// @brief Toggles the light on and off +/// +/// @param state Turns the light on (true) or off (false) +/// +/// @tsexample +/// // Disable the light +/// CrystalLight.setLightEnabled(false); +/// // Renable the light +/// CrystalLight.setLightEnabled(true); +/// +/// @endtsexample +/// ) +/// /// public void setLightEnabled(string lightbase, bool state){ @@ -15575,14 +21575,23 @@ public void setLightEnabled(string lightbase, bool state){ /// public class LightDescriptionObject { -private Omni m_ts; - /// - /// - /// - /// -public LightDescriptionObject(ref Omni ts){m_ts = ts;} /// -/// @brief Force an inspectPostApply call for the benefit of tweaking via the console Normally this functionality is only exposed to objects via the World Editor, once changes have been made. Exposing apply to script allows you to make changes to it on the fly without the World Editor. @note This is intended for debugging and tweaking, not for game play @tsexample // Change a property of the light description RocketLauncherLightDesc.brightness = 10; // Make it so RocketLauncherLightDesc.apply(); @endtsexample) +/// @brief Force an inspectPostApply call for the benefit of tweaking via the console +/// +/// Normally this functionality is only exposed to objects via the World Editor, once changes have been made. +/// Exposing apply to script allows you to make changes to it on the fly without the World Editor. +/// +/// @note This is intended for debugging and tweaking, not for game play +/// +/// @tsexample +/// // Change a property of the light description +/// RocketLauncherLightDesc.brightness = 10; +/// // Make it so +/// RocketLauncherLightDesc.apply(); +/// +/// @endtsexample +/// ) +/// /// public void apply(string lightdescription){ @@ -15595,14 +21604,11 @@ public void apply(string lightdescription){ /// public class LightFlareDataObject { -private Omni m_ts; - /// - /// - /// - /// -public LightFlareDataObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply +/// ) +/// /// public void apply(string lightflaredata){ @@ -15615,14 +21621,10 @@ public void apply(string lightflaredata){ /// public class LightningObject { -private Omni m_ts; - /// - /// - /// - /// -public LightningObject(ref Omni ts){m_ts = ts;} /// -/// Creates a LightningStrikeEvent which strikes a specific object. @note This method is currently unimplemented. ) +/// Creates a LightningStrikeEvent which strikes a specific object. +/// @note This method is currently unimplemented. ) +/// /// public void strikeObject(string lightning, string pSB){ @@ -15630,7 +21632,13 @@ public void strikeObject(string lightning, string pSB){ m_ts.fnLightning_strikeObject(lightning, pSB); } /// -/// Creates a LightningStrikeEvent which attempts to strike and damage a random object in range of the Lightning object. @tsexample // Generate a damaging lightning strike effect on all clients %lightning.strikeRandomPoint(); @endtsexample ) +/// Creates a LightningStrikeEvent which attempts to strike and damage a random +/// object in range of the Lightning object. +/// @tsexample +/// // Generate a damaging lightning strike effect on all clients +/// %lightning.strikeRandomPoint(); +/// @endtsexample ) +/// /// public void strikeRandomPoint(string lightning){ @@ -15638,7 +21646,14 @@ public void strikeRandomPoint(string lightning){ m_ts.fnLightning_strikeRandomPoint(lightning); } /// -/// @brief Creates a LightningStrikeEvent that triggers harmless lightning bolts on all clients. No objects will be damaged by these bolts. @tsexample // Generate a harmless lightning strike effect on all clients %lightning.warningFlashes(); @endtsexample ) +/// @brief Creates a LightningStrikeEvent that triggers harmless lightning +/// bolts on all clients. +/// No objects will be damaged by these bolts. +/// @tsexample +/// // Generate a harmless lightning strike effect on all clients +/// %lightning.warningFlashes(); +/// @endtsexample ) +/// /// public void warningFlashes(string lightning){ @@ -15651,14 +21666,9 @@ public void warningFlashes(string lightning){ /// public class MaterialObject { -private Omni m_ts; - /// - /// - /// - /// -public MaterialObject(ref Omni ts){m_ts = ts;} /// /// Dumps a formatted list of the currently allocated material instances for this material to the console. ) +/// /// public void Material_dumpInstances(string material){ @@ -15667,6 +21677,7 @@ public void Material_dumpInstances(string material){ } /// /// Flushes all material instances that use this material. ) +/// /// public void Material_flush(string material){ @@ -15675,6 +21686,7 @@ public void Material_flush(string material){ } /// /// ) +/// /// public string Material_getAnimFlags(string material, uint id){ @@ -15683,6 +21695,7 @@ public string Material_getAnimFlags(string material, uint id){ } /// /// Get filename of material) +/// /// public string Material_getFilename(string material){ @@ -15691,6 +21704,7 @@ public string Material_getFilename(string material){ } /// /// Returns true if this Material was automatically generated by MaterialList::mapMaterials() ) +/// /// public bool Material_isAutoGenerated(string material){ @@ -15699,6 +21713,7 @@ public bool Material_isAutoGenerated(string material){ } /// /// Reloads all material instances that use this material. ) +/// /// public void Material_reload(string material){ @@ -15707,6 +21722,7 @@ public void Material_reload(string material){ } /// /// setAutoGenerated(bool isAutoGenerated): Set whether or not the Material is autogenerated. ) +/// /// public void Material_setAutoGenerated(string material, bool isAutoGenerated){ @@ -15719,14 +21735,9 @@ public void Material_setAutoGenerated(string material, bool isAutoGenerated){ /// public class MECreateUndoActionObject { -private Omni m_ts; - /// - /// - /// - /// -public MECreateUndoActionObject(ref Omni ts){m_ts = ts;} /// /// ( SimObject obj )) +/// /// public void MECreateUndoAction_addObject(string mecreateundoaction, string obj){ @@ -15739,14 +21750,9 @@ public void MECreateUndoAction_addObject(string mecreateundoaction, string obj) /// public class MEDeleteUndoActionObject { -private Omni m_ts; - /// - /// - /// - /// -public MEDeleteUndoActionObject(ref Omni ts){m_ts = ts;} /// /// ( SimObject obj )) +/// /// public void MEDeleteUndoAction_deleteObject(string medeleteundoaction, string obj){ @@ -15759,14 +21765,9 @@ public void MEDeleteUndoAction_deleteObject(string medeleteundoaction, string o /// public class MenuBarObject { -private Omni m_ts; - /// - /// - /// - /// -public MenuBarObject(ref Omni ts){m_ts = ts;} /// /// (GuiCanvas, pos)) +/// /// public void MenuBar_attachToCanvas(string menubar, string canvas, int pos){ @@ -15775,6 +21776,7 @@ public void MenuBar_attachToCanvas(string menubar, string canvas, int pos){ } /// /// (object, pos) insert object at position) +/// /// public void MenuBar_insert(string menubar, string pObject, int pos){ @@ -15783,6 +21785,7 @@ public void MenuBar_insert(string menubar, string pObject, int pos){ } /// /// ()) +/// /// public void MenuBar_removeFromCanvas(string menubar){ @@ -15795,14 +21798,12 @@ public void MenuBar_removeFromCanvas(string menubar){ /// public class MeshRoadObject { -private Omni m_ts; - /// - /// - /// - /// -public MeshRoadObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void postApply(string meshroad){ @@ -15810,7 +21811,10 @@ public void postApply(string meshroad){ m_ts.fnMeshRoad_postApply(meshroad); } /// -/// Intended as a helper to developers and editor scripts. Force MeshRoad to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force MeshRoad to recreate its geometry. +/// ) +/// /// public void regenerate(string meshroad){ @@ -15818,7 +21822,10 @@ public void regenerate(string meshroad){ m_ts.fnMeshRoad_regenerate(meshroad); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void setNodeDepth(string meshroad, int idx, float meters){ @@ -15831,14 +21838,9 @@ public void setNodeDepth(string meshroad, int idx, float meters){ /// public class MessageObject { -private Omni m_ts; - /// - /// - /// - /// -public MessageObject(ref Omni ts){m_ts = ts;} /// /// () Increment the reference count for this message) +/// /// public void Message_addReference(string message){ @@ -15847,6 +21849,7 @@ public void Message_addReference(string message){ } /// /// () Decrement the reference count for this message) +/// /// public void Message_freeReference(string message){ @@ -15855,6 +21858,7 @@ public void Message_freeReference(string message){ } /// /// () Get message type (script class name or C++ class name if no script defined class)) +/// /// public string Message_getType(string message){ @@ -15867,14 +21871,11 @@ public string Message_getType(string message){ /// public class MessageVectorObject { -private Omni m_ts; - /// - /// - /// - /// -public MessageVectorObject(ref Omni ts){m_ts = ts;} /// -/// ), (string filename, string header=NULL) Dump the message vector to a file, optionally prefixing a header. @hide) +/// ), (string filename, string header=NULL) +/// Dump the message vector to a file, optionally prefixing a header. +/// @hide) +/// /// public void MessageVector_dump(string messagevector, string filename, string header = ""){ @@ -15882,7 +21883,11 @@ public void MessageVector_dump(string messagevector, string filename, string he m_ts.fn_MessageVector_dump(messagevector, filename, header); } /// -/// Clear all messages in the vector @tsexample HudMessageVector.clear(); @endtsexample) +/// Clear all messages in the vector +/// @tsexample +/// HudMessageVector.clear(); +/// @endtsexample) +/// /// public void clear(string messagevector){ @@ -15890,7 +21895,14 @@ public void clear(string messagevector){ m_ts.fnMessageVector_clear(messagevector); } /// -/// Delete the line at the specified position. @param deletePos Position in the vector containing the line to be deleted @tsexample // Delete the first line (index 0) in the vector... HudMessageVector.deleteLine(0); @endtsexample @return False if deletePos is greater than the number of lines in the current vector) +/// Delete the line at the specified position. +/// @param deletePos Position in the vector containing the line to be deleted +/// @tsexample +/// // Delete the first line (index 0) in the vector... +/// HudMessageVector.deleteLine(0); +/// @endtsexample +/// @return False if deletePos is greater than the number of lines in the current vector) +/// /// public bool deleteLine(string messagevector, int deletePos){ @@ -15898,7 +21910,15 @@ public bool deleteLine(string messagevector, int deletePos){ return m_ts.fnMessageVector_deleteLine(messagevector, deletePos); } /// -/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate a line of text tagged with the value \"1\", then delete it. %taggedLine = HudMessageVector.getLineIndexByTag(1); HudMessageVector.deleteLine(%taggedLine); @endtsexample @return Line with matching tag, other wise -1) +/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate a line of text tagged with the value \"1\", then delete it. +/// %taggedLine = HudMessageVector.getLineIndexByTag(1); +/// HudMessageVector.deleteLine(%taggedLine); +/// @endtsexample +/// @return Line with matching tag, other wise -1) +/// /// public int getLineIndexByTag(string messagevector, int tag){ @@ -15906,7 +21926,20 @@ public int getLineIndexByTag(string messagevector, int tag){ return m_ts.fnMessageVector_getLineIndexByTag(messagevector, tag); } /// -/// Get the tag of a specified line. @param pos Position in vector to grab tag from @tsexample // Remove all lines that do not have a tag value of 1. while( HudMessageVector.getNumLines()) { %tag = HudMessageVector.getLineTag(1); if(%tag != 1) %tag.delete(); HudMessageVector.popFrontLine(); } @endtsexample @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// Get the tag of a specified line. +/// @param pos Position in vector to grab tag from +/// @tsexample +/// // Remove all lines that do not have a tag value of 1. +/// while( HudMessageVector.getNumLines()) +/// { +/// %tag = HudMessageVector.getLineTag(1); +/// if(%tag != 1) +/// %tag.delete(); +/// HudMessageVector.popFrontLine(); +/// } +/// @endtsexample +/// @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// /// public int getLineTag(string messagevector, int pos){ @@ -15914,7 +21947,15 @@ public int getLineTag(string messagevector, int pos){ return m_ts.fnMessageVector_getLineTag(messagevector, pos); } /// -/// Get the text at a specified line. @param pos Position in vector to grab text from @tsexample // Print a line of text at position 1. %text = HudMessageVector.getLineText(1); echo(%text); @endtsexample @return Text at specified line, if the position is greater than the number of lines return \"\") +/// Get the text at a specified line. +/// @param pos Position in vector to grab text from +/// @tsexample +/// // Print a line of text at position 1. +/// %text = HudMessageVector.getLineText(1); +/// echo(%text); +/// @endtsexample +/// @return Text at specified line, if the position is greater than the number of lines return \"\") +/// /// public string getLineText(string messagevector, int pos){ @@ -15922,7 +21963,15 @@ public string getLineText(string messagevector, int pos){ return m_ts.fnMessageVector_getLineText(messagevector, pos); } /// -/// Scan through the lines in the vector, returning the first line that has a matching tag. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate text in the vector tagged with the value \"1\", then print it %taggedText = HudMessageVector.getLineTextByTag(1); echo(%taggedText); @endtsexample @return Text from a line with matching tag, other wise \"\") +/// Scan through the lines in the vector, returning the first line that has a matching tag. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate text in the vector tagged with the value \"1\", then print it +/// %taggedText = HudMessageVector.getLineTextByTag(1); +/// echo(%taggedText); +/// @endtsexample +/// @return Text from a line with matching tag, other wise \"\") +/// /// public string getLineTextByTag(string messagevector, int tag){ @@ -15930,7 +21979,13 @@ public string getLineTextByTag(string messagevector, int tag){ return m_ts.fnMessageVector_getLineTextByTag(messagevector, tag); } /// -/// Get the number of lines in the vector. @tsexample // Find out how many lines have been stored in HudMessageVector %chatLines = HudMessageVector.getNumLines(); echo(%chatLines); @endtsexample) +/// Get the number of lines in the vector. +/// @tsexample +/// // Find out how many lines have been stored in HudMessageVector +/// %chatLines = HudMessageVector.getNumLines(); +/// echo(%chatLines); +/// @endtsexample) +/// /// public int getNumLines(string messagevector){ @@ -15938,7 +21993,15 @@ public int getNumLines(string messagevector){ return m_ts.fnMessageVector_getNumLines(messagevector); } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.insertLine(1, \"Hello World\", 0); @endtsexample @return False if insertPos is greater than the number of lines in the current vector) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.insertLine(1, \"Hello World\", 0); +/// @endtsexample +/// @return False if insertPos is greater than the number of lines in the current vector) +/// /// public bool insertLine(string messagevector, int insertPos, string msg, int tag){ @@ -15946,7 +22009,12 @@ public bool insertLine(string messagevector, int insertPos, string msg, int tag return m_ts.fnMessageVector_insertLine(messagevector, insertPos, msg, tag); } /// -/// Pop a line from the back of the list; destroys the line. @tsexample HudMessageVector.popBackLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the back of the list; destroys the line. +/// @tsexample +/// HudMessageVector.popBackLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool popBackLine(string messagevector){ @@ -15954,7 +22022,12 @@ public bool popBackLine(string messagevector){ return m_ts.fnMessageVector_popBackLine(messagevector); } /// -/// Pop a line from the front of the vector, destroying the line. @tsexample HudMessageVector.popFrontLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the front of the vector, destroying the line. +/// @tsexample +/// HudMessageVector.popFrontLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool popFrontLine(string messagevector){ @@ -15962,7 +22035,14 @@ public bool popFrontLine(string messagevector){ return m_ts.fnMessageVector_popFrontLine(messagevector); } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushBackLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushBackLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void pushBackLine(string messagevector, string msg, int tag){ @@ -15970,7 +22050,14 @@ public void pushBackLine(string messagevector, string msg, int tag){ m_ts.fnMessageVector_pushBackLine(messagevector, msg, tag); } /// -/// Push a line onto the front of the vector. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushFrontLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the front of the vector. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushFrontLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void pushFrontLine(string messagevector, string msg, int tag){ @@ -15983,14 +22070,9 @@ public void pushFrontLine(string messagevector, string msg, int tag){ /// public class MissionAreaObject { -private Omni m_ts; - /// - /// - /// - /// -public MissionAreaObject(ref Omni ts){m_ts = ts;} /// /// Returns 4 fields: starting x, starting y, extents x, extents y.) +/// /// public string getArea(string missionarea){ @@ -15998,7 +22080,11 @@ public string getArea(string missionarea){ return m_ts.fnMissionArea_getArea(missionarea); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void postApply(string missionarea){ @@ -16006,7 +22092,14 @@ public void postApply(string missionarea){ m_ts.fnMissionArea_postApply(missionarea); } /// -/// @brief - Defines the size of the MissionArea param x Starting X coordinate position for MissionArea param y Starting Y coordinate position for MissionArea param width New width of the MissionArea param height New height of the MissionArea @note Only the server object may be set. ) +/// @brief - Defines the size of the MissionArea +/// param x Starting X coordinate position for MissionArea +/// param y Starting Y coordinate position for MissionArea +/// param width New width of the MissionArea +/// param height New height of the MissionArea +/// @note Only the server object may be set. +/// ) +/// /// public void setArea(string missionarea, int x, int y, int width, int height){ @@ -16019,12 +22112,6 @@ public void setArea(string missionarea, int x, int y, int width, int height){ /// public class NavMeshObject { -private Omni m_ts; - /// - /// - /// - /// -public NavMeshObject(ref Omni ts){m_ts = ts;} /// /// Add a link to this NavMesh between two points. /// ) @@ -16185,12 +22272,6 @@ public void setLinkFlags(string navmesh, uint id, uint flags){ /// public class NavPathObject { -private Omni m_ts; - /// - /// - /// - /// -public NavPathObject(ref Omni ts){m_ts = ts;} /// /// @brief Get a specified node along the path.) /// @@ -16260,14 +22341,16 @@ public int size(string navpath){ /// public class NetConnectionObject { -private Omni m_ts; - /// - /// - /// - /// -public NetConnectionObject(ref Omni ts){m_ts = ts;} /// -/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. This method is normally only called when a NetConnection class is first constructed. It need only be manually called if the global variables that set the packet rate or size have changed. @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize have been changed since a NetConnection has been created, this method must be called on all connections for them to follow the new rates or size.) +/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. +/// +/// This method is normally only called when a NetConnection class is first constructed. It need +/// only be manually called if the global variables that set the packet rate or size have changed. +/// +/// @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize +/// have been changed since a NetConnection has been created, this method must be called on +/// all connections for them to follow the new rates or size.) +/// /// public void checkMaxRate(string netconnection){ @@ -16275,7 +22358,27 @@ public void checkMaxRate(string netconnection){ m_ts.fnNetConnection_checkMaxRate(netconnection); } /// -/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that motion spline paths have not been transmitted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see transmitPaths() @see Path) +/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that motion spline paths have not been transmitted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see transmitPaths() +/// @see Path) +/// /// public void clearPaths(string netconnection){ @@ -16283,7 +22386,23 @@ public void clearPaths(string netconnection){ m_ts.fnNetConnection_clearPaths(netconnection); } /// -/// @brief Connects to the remote address. Attempts to connect with another NetConnection on the given address. Typically once connected, a game's information is passed along from the server to the client, followed by the player entering the game world. The actual procedure is dependent on the NetConnection subclass that is used. i.e. GameConnection. @param remoteAddress The address to connect to in the form of IP:address>:port although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also substitue the word i>broadcast/i> for the address to broadcast the connect request over the local subnet. @see NetConnection::connectLocal() to connect to a server running within the same process as the client. ) +/// @brief Connects to the remote address. +/// +/// Attempts to connect with another NetConnection on the given address. Typically once +/// connected, a game's information is passed along from the server to the client, followed +/// by the player entering the game world. The actual procedure is dependent on +/// the NetConnection subclass that is used. i.e. GameConnection. +/// +/// @param remoteAddress The address to connect to in the form of IP:address>:port +/// although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form +/// of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also +/// substitue the word i>broadcast/i> for the address to broadcast the connect request over +/// the local subnet. +/// +/// @see NetConnection::connectLocal() to connect to a server running within the same process +/// as the client. +/// ) +/// /// public void connect(string netconnection, string remoteAddress){ @@ -16291,7 +22410,13 @@ public void connect(string netconnection, string remoteAddress){ m_ts.fnNetConnection_connect(netconnection, remoteAddress); } /// -/// @brief Connects with the server that is running within the same process as the client. @returns An error text message upon failure, or an empty string when successful. @see See @ref local_connections for a description of local connections and their use. See NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// @brief Connects with the server that is running within the same process as the client. +/// +/// @returns An error text message upon failure, or an empty string when successful. +/// +/// @see See @ref local_connections for a description of local connections and their use. See +/// NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// /// public string connectLocal(string netconnection){ @@ -16299,7 +22424,13 @@ public string connectLocal(string netconnection){ return m_ts.fnNetConnection_connectLocal(netconnection); } /// -/// @brief Returns the far end network address for the connection. The address will be in one of the following forms: - b>IP:Broadcast:port>/b> for broadcast type addresses - b>IP:address>:port>/b> for IP addresses - b>local/b> when connected locally (server and client running in same process) +/// @brief Returns the far end network address for the connection. +/// +/// The address will be in one of the following forms: +/// - b>IP:Broadcast:port>/b> for broadcast type addresses +/// - b>IP:address>:port>/b> for IP addresses +/// - b>local/b> when connected locally (server and client running in same process) +/// /// public string getAddress(string netconnection){ @@ -16307,7 +22438,16 @@ public string getAddress(string netconnection){ return m_ts.fnNetConnection_getAddress(netconnection); } /// -/// @brief On server or client, convert a real id to the ghost id for this connection. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server or client to discover an object's ghost ID based on its real SimObject ID. @param realID The real SimObject ID of the object. @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On server or client, convert a real id to the ghost id for this connection. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server or client to discover an object's ghost ID based on its real SimObject ID. +/// +/// @param realID The real SimObject ID of the object. +/// @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int getGhostID(string netconnection, int realID){ @@ -16325,7 +22465,10 @@ public int GetGhostIndex(string netconnection, string obj){ return m_ts.fnNetConnection_GetGhostIndex(netconnection, obj); } /// -/// @brief Provides the number of active ghosts on the connection. @returns The number of active ghosts. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Provides the number of active ghosts on the connection. +/// @returns The number of active ghosts. +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int getGhostsActive(string netconnection){ @@ -16333,7 +22476,10 @@ public int getGhostsActive(string netconnection){ return m_ts.fnNetConnection_getGhostsActive(netconnection); } /// -/// @brief Returns the percentage of packets lost per tick. @note This method is not yet hooked up.) +/// @brief Returns the percentage of packets lost per tick. +/// +/// @note This method is not yet hooked up.) +/// /// public int getPacketLoss(string netconnection){ @@ -16341,7 +22487,12 @@ public int getPacketLoss(string netconnection){ return m_ts.fnNetConnection_getPacketLoss(netconnection); } /// -/// @brief Returns the average round trip time (in ms) for the connection. The round trip time is recalculated every time a notify packet is received. Notify packets are used to information the connection that the far end successfully received the sent packet.) +/// @brief Returns the average round trip time (in ms) for the connection. +/// +/// The round trip time is recalculated every time a notify packet is received. Notify +/// packets are used to information the connection that the far end successfully received +/// the sent packet.) +/// /// public int getPing(string netconnection){ @@ -16359,7 +22510,21 @@ public int ResolveGhost(string netconnection, int ghostIndex){ return m_ts.fnNetConnection_ResolveGhost(netconnection, ghostIndex); } /// -/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the client to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = ServerConnection.resolveGhostID( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the client to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = ServerConnection.resolveGhostID( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int resolveGhostID(string netconnection, int ghostID){ @@ -16367,7 +22532,21 @@ public int resolveGhostID(string netconnection, int ghostID){ return m_ts.fnNetConnection_resolveGhostID(netconnection, ghostID); } /// -/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = %client.resolveObjectFromGhostIndex( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = %client.resolveObjectFromGhostIndex( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int resolveObjectFromGhostIndex(string netconnection, int ghostID){ @@ -16375,7 +22554,12 @@ public int resolveObjectFromGhostIndex(string netconnection, int ghostID){ return m_ts.fnNetConnection_resolveObjectFromGhostIndex(netconnection, ghostID); } /// -/// @brief Simulate network issues on the connection for testing. @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute integer, measured in ms.) +/// @brief Simulate network issues on the connection for testing. +/// +/// @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) +/// @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute +/// integer, measured in ms.) +/// /// public void setSimulatedNetParams(string netconnection, float packetLoss, int delay){ @@ -16383,7 +22567,44 @@ public void setSimulatedNetParams(string netconnection, float packetLoss, int d m_ts.fnNetConnection_setSimulatedNetParams(netconnection, packetLoss, delay); } /// -/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. The server transmits all spline motion paths that are within the mission (Path) separate from other objects. This is due to the potentially large number of nodes within each path, which may saturate a packet sent to the client. By managing this step separately, Torque has finer control over how packets are organised vs. doing it during the ghosting stage. Internally a PathManager is used to track all paths defined within a mission on the server, and each one is transmitted using a PathManagerEvent. The client side collects these events and builds the given paths within its own PathManager. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. When a mission is ended, all paths need to be cleared from their respective path managers. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mission paths (SimPath), this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see clearPaths() @see Path) +/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. +/// +/// The server transmits all spline motion paths that are within the mission (Path) separate from +/// other objects. This is due to the potentially large number of nodes within each path, which may +/// saturate a packet sent to the client. By managing this step separately, Torque has finer control +/// over how packets are organised vs. doing it during the ghosting stage. +/// +/// Internally a PathManager is used to track all paths defined within a mission on the server, and each +/// one is transmitted using a PathManagerEvent. The client side collects these events and builds the +/// given paths within its own PathManager. This is typically done during the standard mission start +/// phase 2 when following Torque's example mission startup sequence. +/// +/// When a mission is ended, all paths need to be cleared from their respective path managers. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mission paths (SimPath), this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see clearPaths() +/// @see Path) +/// /// public void transmitPaths(string netconnection){ @@ -16396,14 +22617,13 @@ public void transmitPaths(string netconnection){ /// public class NetObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public NetObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Undo the effects of a scopeToClient() call. @param client The connection to remove this object's scoping from @see scopeToClient()) +/// @brief Undo the effects of a scopeToClient() call. +/// +/// @param client The connection to remove this object's scoping from +/// +/// @see scopeToClient()) +/// /// public void clearScopeToClient(string netobject, string client){ @@ -16411,7 +22631,22 @@ public void clearScopeToClient(string netobject, string client){ m_ts.fnNetObject_clearScopeToClient(netobject, client); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. @returns the SimObject ID of the client object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %clientObject = %node.getClientObject(); if(isObject(%clientObject) %clientObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns the SimObject ID of the client object. +/// +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %clientObject = %node.getClientObject(); +/// if(isObject(%clientObject) +/// %clientObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int getClientObject(string netobject){ @@ -16419,7 +22654,14 @@ public int getClientObject(string netobject){ return m_ts.fnNetObject_getClientObject(netobject); } /// -/// @brief Get the ghost index of this object from the server. @returns The ghost ID of this NetObject on the server @tsexample %ghostID = LocalClientConnection.getGhostId( %serverObject ); @endtsexample) +/// @brief Get the ghost index of this object from the server. +/// +/// @returns The ghost ID of this NetObject on the server +/// +/// @tsexample +/// %ghostID = LocalClientConnection.getGhostId( %serverObject ); +/// @endtsexample) +/// /// public int getGhostID(string netobject){ @@ -16427,7 +22669,21 @@ public int getGhostID(string netobject){ return m_ts.fnNetObject_getGhostID(netobject); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. @returns The SimObject ID of the server object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %serverObject = %node.getServerObject(); if(isObject(%serverObject) %serverObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns The SimObject ID of the server object. +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %serverObject = %node.getServerObject(); +/// if(isObject(%serverObject) +/// %serverObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int getServerObject(string netobject){ @@ -16435,7 +22691,9 @@ public int getServerObject(string netobject){ return m_ts.fnNetObject_getServerObject(netobject); } /// -/// @brief Called to check if an object resides on the clientside. @return True if the object resides on the client, false otherwise.) +/// @brief Called to check if an object resides on the clientside. +/// @return True if the object resides on the client, false otherwise.) +/// /// public bool isClientObject(string netobject){ @@ -16443,7 +22701,9 @@ public bool isClientObject(string netobject){ return m_ts.fnNetObject_isClientObject(netobject); } /// -/// @brief Checks if an object resides on the server. @return True if the object resides on the server, false otherwise.) +/// @brief Checks if an object resides on the server. +/// @return True if the object resides on the server, false otherwise.) +/// /// public bool isServerObject(string netobject){ @@ -16451,7 +22711,29 @@ public bool isServerObject(string netobject){ return m_ts.fnNetObject_isServerObject(netobject); } /// -/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. @param client The connection this object will always be scoped to @tsexample // Called to create new cameras in TorqueScript // %this - The active GameConnection // %spawnPoint - The spawn point location where we creat the camera function GameConnection::spawnCamera(%this, %spawnPoint) { // If this connection's camera exists if(isObject(%this.camera)) { // Add it to the mission group to be cleaned up later MissionCleanup.add( %this.camera ); // Force it to scope to the client side %this.camera.scopeToClient(%this); } } @endtsexample @see clearScopeToClient()) +/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. +/// +/// @param client The connection this object will always be scoped to +/// +/// @tsexample +/// // Called to create new cameras in TorqueScript +/// // %this - The active GameConnection +/// // %spawnPoint - The spawn point location where we creat the camera +/// function GameConnection::spawnCamera(%this, %spawnPoint) +/// { +/// // If this connection's camera exists +/// if(isObject(%this.camera)) +/// { +/// // Add it to the mission group to be cleaned up later +/// MissionCleanup.add( %this.camera ); +/// // Force it to scope to the client side +/// %this.camera.scopeToClient(%this); +/// } +/// } +/// @endtsexample +/// +/// @see clearScopeToClient()) +/// /// public void scopeToClient(string netobject, string client){ @@ -16459,7 +22741,12 @@ public void scopeToClient(string netobject, string client){ m_ts.fnNetObject_scopeToClient(netobject, client); } /// -/// @brief Always scope this object on all connections. The object is marked as ScopeAlways and is immediately ghosted to all active connections. This function has no effect if the object is not marked as Ghostable.) +/// @brief Always scope this object on all connections. +/// +/// The object is marked as ScopeAlways and is immediately ghosted to +/// all active connections. This function has no effect if the object +/// is not marked as Ghostable.) +/// /// public void setScopeAlways(string netobject){ @@ -16472,14 +22759,17 @@ public void setScopeAlways(string netobject){ /// public class ParticleDataObject { -private Omni m_ts; - /// - /// - /// - /// -public ParticleDataObject(ref Omni ts){m_ts = ts;} /// -/// Reloads this particle. @tsexample // Get the editor's current particle %particle = PE_ParticleEditor.currParticle // Change a particle value %particle.setFieldValue( %propertyField, %value ); // Reload it %particle.reload(); @endtsexample ) +/// Reloads this particle. +/// @tsexample +/// // Get the editor's current particle +/// %particle = PE_ParticleEditor.currParticle +/// // Change a particle value +/// %particle.setFieldValue( %propertyField, %value ); +/// // Reload it +/// %particle.reload(); +/// @endtsexample ) +/// /// public void reload(string particledata){ @@ -16492,14 +22782,17 @@ public void reload(string particledata){ /// public class ParticleEmitterDataObject { -private Omni m_ts; - /// - /// - /// - /// -public ParticleEmitterDataObject(ref Omni ts){m_ts = ts;} /// -/// Reloads the ParticleData datablocks and other fields used by this emitter. @tsexample // Get the editor's current particle emitter %emitter = PE_EmitterEditor.currEmitter // Change a field value %emitter.setFieldValue( %propertyField, %value ); // Reload this emitter %emitter.reload(); @endtsexample) +/// Reloads the ParticleData datablocks and other fields used by this emitter. +/// @tsexample +/// // Get the editor's current particle emitter +/// %emitter = PE_EmitterEditor.currEmitter +/// // Change a field value +/// %emitter.setFieldValue( %propertyField, %value ); +/// // Reload this emitter +/// %emitter.reload(); +/// @endtsexample) +/// /// public void reload(string particleemitterdata){ @@ -16512,14 +22805,10 @@ public void reload(string particleemitterdata){ /// public class ParticleEmitterNodeObject { -private Omni m_ts; - /// - /// - /// - /// -public ParticleEmitterNodeObject(ref Omni ts){m_ts = ts;} /// -/// Turns the emitter on or off. @param active New emitter state ) +/// Turns the emitter on or off. +/// @param active New emitter state ) +/// /// public void setActive(string particleemitternode, bool active){ @@ -16527,7 +22816,13 @@ public void setActive(string particleemitternode, bool active){ m_ts.fnParticleEmitterNode_setActive(particleemitternode, active); } /// -/// Assigns the datablock for this emitter node. @param emitterDatablock ParticleEmitterData datablock to assign @tsexample // Assign a new emitter datablock %emitter.setEmitterDatablock( %emitterDatablock ); @endtsexample ) +/// Assigns the datablock for this emitter node. +/// @param emitterDatablock ParticleEmitterData datablock to assign +/// @tsexample +/// // Assign a new emitter datablock +/// %emitter.setEmitterDatablock( %emitterDatablock ); +/// @endtsexample ) +/// /// public void setEmitterDataBlock(string particleemitternode, string emitterDatablock = null ){ if (emitterDatablock== null) {emitterDatablock = null;} @@ -16541,14 +22836,13 @@ public void setEmitterDataBlock(string particleemitternode, string emitterDatab /// public class PathCameraObject { -private Omni m_ts; - /// - /// - /// - /// -public PathCameraObject(ref Omni ts){m_ts = ts;} /// -/// Removes the knot at the front of the camera's path. @tsexample // Remove the first knot in the camera's path. %pathCamera.popFront(); @endtsexample) +/// Removes the knot at the front of the camera's path. +/// @tsexample +/// // Remove the first knot in the camera's path. +/// %pathCamera.popFront(); +/// @endtsexample) +/// /// public void popFront(string pathcamera){ @@ -16556,7 +22850,25 @@ public void popFront(string pathcamera){ m_ts.fnPathCamera_popFront(pathcamera); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the back of its path %pathCamera.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the back of its path +/// %pathCamera.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void pushBack(string pathcamera, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -16564,7 +22876,25 @@ public void pushBack(string pathcamera, TransformF transform, float speed = 1.0 m_ts.fnPathCamera_pushBack(pathcamera, transform.AsString(), speed, type, path); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the front of its path %pathCamera.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the front of its path +/// %pathCamera.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void pushFront(string pathcamera, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -16572,7 +22902,20 @@ public void pushFront(string pathcamera, TransformF transform, float speed = 1. m_ts.fnPathCamera_pushFront(pathcamera, transform.AsString(), speed, type, path); } /// -/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. What specifically occurs is a new knot is created from the camera's current transform. Then the current path is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement state is set to Forward. The camera is now ready for a new path to be defined. @param speed Speed for the camera to move along its path after being reset. @tsexample //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. %speed = \"0.50\"; // Inform the path camera to start a new path at // the camera's current position, and set the new // path's speed value. %pathCamera.reset(%speed); @endtsexample) +/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. +/// What specifically occurs is a new knot is created from the camera's current transform. Then the current path +/// is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement +/// state is set to Forward. The camera is now ready for a new path to be defined. +/// @param speed Speed for the camera to move along its path after being reset. +/// @tsexample +/// //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. +/// %speed = \"0.50\"; +/// // Inform the path camera to start a new path at +/// // the camera's current position, and set the new +/// // path's speed value. +/// %pathCamera.reset(%speed); +/// @endtsexample) +/// /// public void reset(string pathcamera, float speed = 1.0f){ @@ -16580,7 +22923,15 @@ public void reset(string pathcamera, float speed = 1.0f){ m_ts.fnPathCamera_reset(pathcamera, speed); } /// -/// Set the current position of the camera along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. @tsexample // Set the camera on a position along its path from 0.0 - 1.0. %position = \"0.35\"; // Force the pathCamera to its new position along the path. %pathCamera.setPosition(%position); @endtsexample) +/// Set the current position of the camera along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. +/// @tsexample +/// // Set the camera on a position along its path from 0.0 - 1.0. +/// %position = \"0.35\"; +/// // Force the pathCamera to its new position along the path. +/// %pathCamera.setPosition(%position); +/// @endtsexample) +/// /// public void setPosition(string pathcamera, float position = 0.0f){ @@ -16588,7 +22939,17 @@ public void setPosition(string pathcamera, float position = 0.0f){ m_ts.fnPathCamera_setPosition(pathcamera, position); } /// -/// forward), Set the movement state for this path camera. @param newState New movement state type for this camera. Forward, Backward or Stop. @tsexample // Set the state type (forward, backward, stop). // In this example, the camera will travel from the first node // to the last node (or target if given with setTarget()) %state = \"forward\"; // Inform the pathCamera to change its movement state to the defined value. %pathCamera.setState(%state); @endtsexample) +/// forward), Set the movement state for this path camera. +/// @param newState New movement state type for this camera. Forward, Backward or Stop. +/// @tsexample +/// // Set the state type (forward, backward, stop). +/// // In this example, the camera will travel from the first node +/// // to the last node (or target if given with setTarget()) +/// %state = \"forward\"; +/// // Inform the pathCamera to change its movement state to the defined value. +/// %pathCamera.setState(%state); +/// @endtsexample) +/// /// public void setState(string pathcamera, string newState = "forward"){ @@ -16596,7 +22957,18 @@ public void setState(string pathcamera, string newState = "forward"){ m_ts.fnPathCamera_setState(pathcamera, newState); } /// -/// @brief Set the movement target for this camera along its path. The camera will attempt to move along the path to the given target in the direction provided by setState() (the default is forwards). Once the camera moves past this target it will come to a stop, and the target state will be cleared. @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. @tsexample // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. %position = \"0.50\"; // Inform the pathCamera of the new target position it will move to. %pathCamera.setTarget(%position); @endtsexample) +/// @brief Set the movement target for this camera along its path. +/// The camera will attempt to move along the path to the given target in the direction provided +/// by setState() (the default is forwards). Once the camera moves past this target it will come +/// to a stop, and the target state will be cleared. +/// @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. +/// @tsexample +/// // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. +/// %position = \"0.50\"; +/// // Inform the pathCamera of the new target position it will move to. +/// %pathCamera.setTarget(%position); +/// @endtsexample) +/// /// public void setTarget(string pathcamera, float position = 1.0f){ @@ -16609,14 +22981,10 @@ public void setTarget(string pathcamera, float position = 1.0f){ /// public class PersistenceManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public PersistenceManagerObject(ref Omni ts){m_ts = ts;} /// -/// () Clears all the tracked objects without saving them. ) +/// () +/// Clears all the tracked objects without saving them. ) +/// /// public void PersistenceManager_clearAll(string persistencemanager){ @@ -16624,7 +22992,9 @@ public void PersistenceManager_clearAll(string persistencemanager){ m_ts.fn_PersistenceManager_clearAll(persistencemanager); } /// -/// ( fileName ) Delete all of the objects that are created from the given file. ) +/// ( fileName ) +/// Delete all of the objects that are created from the given file. ) +/// /// public void PersistenceManager_deleteObjectsFromFile(string persistencemanager, string fileName){ @@ -16632,7 +23002,9 @@ public void PersistenceManager_deleteObjectsFromFile(string persistencemanager, m_ts.fn_PersistenceManager_deleteObjectsFromFile(persistencemanager, fileName); } /// -/// ( index ) Returns the ith dirty object. ) +/// ( index ) +/// Returns the ith dirty object. ) +/// /// public int PersistenceManager_getDirtyObject(string persistencemanager, int index){ @@ -16640,7 +23012,9 @@ public int PersistenceManager_getDirtyObject(string persistencemanager, int ind return m_ts.fn_PersistenceManager_getDirtyObject(persistencemanager, index); } /// -/// () Returns the number of dirty objects. ) +/// () +/// Returns the number of dirty objects. ) +/// /// public int PersistenceManager_getDirtyObjectCount(string persistencemanager){ @@ -16648,7 +23022,9 @@ public int PersistenceManager_getDirtyObjectCount(string persistencemanager){ return m_ts.fn_PersistenceManager_getDirtyObjectCount(persistencemanager); } /// -/// () Returns true if the manager has dirty objects to save. ) +/// () +/// Returns true if the manager has dirty objects to save. ) +/// /// public bool PersistenceManager_hasDirty(string persistencemanager){ @@ -16656,7 +23032,9 @@ public bool PersistenceManager_hasDirty(string persistencemanager){ return m_ts.fn_PersistenceManager_hasDirty(persistencemanager); } /// -/// (SimObject object) Returns true if the SimObject is on the dirty list.) +/// (SimObject object) +/// Returns true if the SimObject is on the dirty list.) +/// /// public bool PersistenceManager_isDirty(string persistencemanager, string objName){ @@ -16664,7 +23042,9 @@ public bool PersistenceManager_isDirty(string persistencemanager, string objNam return m_ts.fn_PersistenceManager_isDirty(persistencemanager, objName); } /// -/// () Prints the dirty list to the console.) +/// () +/// Prints the dirty list to the console.) +/// /// public void PersistenceManager_listDirty(string persistencemanager){ @@ -16672,7 +23052,9 @@ public void PersistenceManager_listDirty(string persistencemanager){ m_ts.fn_PersistenceManager_listDirty(persistencemanager); } /// -/// (SimObject object) Remove a SimObject from the dirty list.) +/// (SimObject object) +/// Remove a SimObject from the dirty list.) +/// /// public void PersistenceManager_removeDirty(string persistencemanager, string objName){ @@ -16680,7 +23062,9 @@ public void PersistenceManager_removeDirty(string persistencemanager, string ob m_ts.fn_PersistenceManager_removeDirty(persistencemanager, objName); } /// -/// (SimObject object, string fieldName) Remove a specific field from an object declaration.) +/// (SimObject object, string fieldName) +/// Remove a specific field from an object declaration.) +/// /// public void PersistenceManager_removeField(string persistencemanager, string objName, string fieldName){ @@ -16688,7 +23072,10 @@ public void PersistenceManager_removeField(string persistencemanager, string ob m_ts.fn_PersistenceManager_removeField(persistencemanager, objName, fieldName); } /// -/// ) , (SimObject object, [filename]) Remove an existing SimObject from a file (can optionally specify a different file than \ the one it was created in.) +/// ) , (SimObject object, [filename]) +/// Remove an existing SimObject from a file (can optionally specify a different file than \ +/// the one it was created in.) +/// /// public void PersistenceManager_removeObjectFromFile(string persistencemanager, string objName, string filename = ""){ @@ -16696,7 +23083,9 @@ public void PersistenceManager_removeObjectFromFile(string persistencemanager, m_ts.fn_PersistenceManager_removeObjectFromFile(persistencemanager, objName, filename); } /// -/// () Saves all of the SimObject's on the dirty list to their respective files.) +/// () +/// Saves all of the SimObject's on the dirty list to their respective files.) +/// /// public bool PersistenceManager_saveDirty(string persistencemanager){ @@ -16704,7 +23093,9 @@ public bool PersistenceManager_saveDirty(string persistencemanager){ return m_ts.fn_PersistenceManager_saveDirty(persistencemanager); } /// -/// (SimObject object) Save a dirty SimObject to it's file.) +/// (SimObject object) +/// Save a dirty SimObject to it's file.) +/// /// public bool PersistenceManager_saveDirtyObject(string persistencemanager, string objName){ @@ -16712,7 +23103,9 @@ public bool PersistenceManager_saveDirtyObject(string persistencemanager, strin return m_ts.fn_PersistenceManager_saveDirtyObject(persistencemanager, objName); } /// -/// ), (SimObject object, [filename]) Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// ), (SimObject object, [filename]) +/// Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// /// public void PersistenceManager_setDirty(string persistencemanager, string objName, string fileName = ""){ @@ -16725,14 +23118,15 @@ public void PersistenceManager_setDirty(string persistencemanager, string objNa /// public class PhysicalZoneObject { -private Omni m_ts; - /// - /// - /// - /// -public PhysicalZoneObject(ref Omni ts){m_ts = ts;} /// -/// Activate the physical zone's effects. @tsexample // Activate effects for a specific physical zone. %thisPhysicalZone.activate(); @endtsexample @ingroup Datablocks ) +/// Activate the physical zone's effects. +/// @tsexample +/// // Activate effects for a specific physical zone. +/// %thisPhysicalZone.activate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void activate(string physicalzone){ @@ -16740,7 +23134,14 @@ public void activate(string physicalzone){ m_ts.fnPhysicalZone_activate(physicalzone); } /// -/// Deactivate the physical zone's effects. @tsexample // Deactivate effects for a specific physical zone. %thisPhysicalZone.deactivate(); @endtsexample @ingroup Datablocks ) +/// Deactivate the physical zone's effects. +/// @tsexample +/// // Deactivate effects for a specific physical zone. +/// %thisPhysicalZone.deactivate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void deactivate(string physicalzone){ @@ -16753,14 +23154,12 @@ public void deactivate(string physicalzone){ /// public class PhysicsDebrisDataObject { -private Omni m_ts; - /// - /// - /// - /// -public PhysicsDebrisDataObject(ref Omni ts){m_ts = ts;} /// -/// @brief Loads some information to have readily available at simulation time. Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. This function should be used while a level is loading in order to shorten the amount of time to create a PhysicsDebris in game.) +/// @brief Loads some information to have readily available at simulation time. +/// Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. +/// This function should be used while a level is loading in order to shorten +/// the amount of time to create a PhysicsDebris in game.) +/// /// public void PhysicsDebrisData_preload(string physicsdebrisdata){ @@ -16773,14 +23172,15 @@ public void PhysicsDebrisData_preload(string physicsdebrisdata){ /// public class PhysicsForceObject { -private Omni m_ts; - /// - /// - /// - /// -public PhysicsForceObject(ref Omni ts){m_ts = ts;} /// -/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. Performs a physics ray cast of the provided length and direction. The %PhysicsForce will attach itself to the first dynamic PhysicsBody the ray collides with. On every tick, the attached body will be attracted towards the position of the %PhysicsForce. A %PhysicsForce can only be attached to one body at a time. @note To determine if an %attach was successful, check isAttached() immediately after calling this function.n) +/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. +/// Performs a physics ray cast of the provided length and direction. The %PhysicsForce +/// will attach itself to the first dynamic PhysicsBody the ray collides with. +/// On every tick, the attached body will be attracted towards the position of the %PhysicsForce. +/// A %PhysicsForce can only be attached to one body at a time. +/// @note To determine if an %attach was successful, check isAttached() immediately after +/// calling this function.n) +/// /// public void attach(string physicsforce, Point3F start, Point3F direction, float maxDist){ @@ -16788,7 +23188,11 @@ public void attach(string physicsforce, Point3F start, Point3F direction, float m_ts.fnPhysicsForce_attach(physicsforce, start.AsString(), direction.AsString(), maxDist); } /// -/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. @param force Optional force to apply to the attached PhysicsBody before detaching. @note Has no effect if the %PhysicsForce is not attached to anything.) +/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. +/// @param force Optional force to apply to the attached PhysicsBody +/// before detaching. +/// @note Has no effect if the %PhysicsForce is not attached to anything.) +/// /// public void detach(string physicsforce, Point3F force = null ){ if (force== null) {force = new Point3F(0.0f, 0.0f, 0.0f);} @@ -16797,7 +23201,9 @@ public void detach(string physicsforce, Point3F force = null ){ m_ts.fnPhysicsForce_detach(physicsforce, force.AsString()); } /// -/// @brief Returns true if the %PhysicsForce is currently attached to an object. @see PhysicsForce::attach()) +/// @brief Returns true if the %PhysicsForce is currently attached to an object. +/// @see PhysicsForce::attach()) +/// /// public bool isAttached(string physicsforce){ @@ -16810,14 +23216,13 @@ public bool isAttached(string physicsforce){ /// public class PhysicsShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public PhysicsShapeObject(ref Omni ts){m_ts = ts;} /// -/// @brief Disables rendering and physical simulation. Calling destroy() will also spawn any explosions, debris, and/or destroyedShape defined for it, as well as remove it from the scene graph. Destroyed objects are only created on the server. Ghosting will later update the client. @note This does not actually delete the PhysicsShape. ) +/// @brief Disables rendering and physical simulation. +/// Calling destroy() will also spawn any explosions, debris, and/or destroyedShape +/// defined for it, as well as remove it from the scene graph. +/// Destroyed objects are only created on the server. Ghosting will later update the client. +/// @note This does not actually delete the PhysicsShape. ) +/// /// public void destroy(string physicsshape){ @@ -16826,6 +23231,7 @@ public void destroy(string physicsshape){ } /// /// @brief Returns if a PhysicsShape has been destroyed or not. ) +/// /// public bool isDestroyed(string physicsshape){ @@ -16833,7 +23239,11 @@ public bool isDestroyed(string physicsshape){ return m_ts.fnPhysicsShape_isDestroyed(physicsshape); } /// -/// @brief Restores the shape to its state before being destroyed. Re-enables rendering and physical simulation on the object and adds it to the client's scene graph. Has no effect if the shape is not destroyed.) +/// @brief Restores the shape to its state before being destroyed. +/// Re-enables rendering and physical simulation on the object and +/// adds it to the client's scene graph. +/// Has no effect if the shape is not destroyed.) +/// /// public void restore(string physicsshape){ @@ -16846,14 +23256,20 @@ public void restore(string physicsshape){ /// public class PlayerObject { -private Omni m_ts; - /// - /// - /// - /// -public PlayerObject(ref Omni ts){m_ts = ts;} /// -/// @brief Allow all poses a chance to occur. This method resets any poses that have manually been blocked from occuring. This includes the regular pose states such as sprinting, crouch, being prone and swimming. It also includes being able to jump and jet jump. While this is allowing these poses to occur it doesn't mean that they all can due to other conditions. We're just not manually blocking them from being allowed. @see allowJumping() @see allowJetJumping() @see allowSprinting() @see allowCrouching() @see allowProne() @see allowSwimming() ) +/// @brief Allow all poses a chance to occur. +/// This method resets any poses that have manually been blocked from occuring. +/// This includes the regular pose states such as sprinting, crouch, being prone +/// and swimming. It also includes being able to jump and jet jump. While this +/// is allowing these poses to occur it doesn't mean that they all can due to other +/// conditions. We're just not manually blocking them from being allowed. +/// @see allowJumping() +/// @see allowJetJumping() +/// @see allowSprinting() +/// @see allowCrouching() +/// @see allowProne() +/// @see allowSwimming() ) +/// /// public void allowAllPoses(string player){ @@ -16861,7 +23277,13 @@ public void allowAllPoses(string player){ m_ts.fnPlayer_allowAllPoses(player); } /// -/// @brief Set if the Player is allowed to crouch. The default is to allow crouching unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow crouching at any time. @param state Set to true to allow crouching, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to crouch. +/// The default is to allow crouching unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow crouching +/// at any time. +/// @param state Set to true to allow crouching, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowCrouching(string player, bool state){ @@ -16869,7 +23291,13 @@ public void allowCrouching(string player, bool state){ m_ts.fnPlayer_allowCrouching(player, state); } /// -/// @brief Set if the Player is allowed to jet jump. The default is to allow jet jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jet jumping at any time. @param state Set to true to allow jet jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jet jump. +/// The default is to allow jet jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jet jumping +/// at any time. +/// @param state Set to true to allow jet jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowJetJumping(string player, bool state){ @@ -16877,7 +23305,13 @@ public void allowJetJumping(string player, bool state){ m_ts.fnPlayer_allowJetJumping(player, state); } /// -/// @brief Set if the Player is allowed to jump. The default is to allow jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jumping at any time. @param state Set to true to allow jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jump. +/// The default is to allow jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jumping +/// at any time. +/// @param state Set to true to allow jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowJumping(string player, bool state){ @@ -16885,7 +23319,13 @@ public void allowJumping(string player, bool state){ m_ts.fnPlayer_allowJumping(player, state); } /// -/// @brief Set if the Player is allowed to go prone. The default is to allow being prone unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow going prone at any time. @param state Set to true to allow being prone, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to go prone. +/// The default is to allow being prone unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow going prone +/// at any time. +/// @param state Set to true to allow being prone, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowProne(string player, bool state){ @@ -16893,7 +23333,13 @@ public void allowProne(string player, bool state){ m_ts.fnPlayer_allowProne(player, state); } /// -/// @brief Set if the Player is allowed to sprint. The default is to allow sprinting unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow sprinting at any time. @param state Set to true to allow sprinting, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to sprint. +/// The default is to allow sprinting unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow sprinting +/// at any time. +/// @param state Set to true to allow sprinting, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowSprinting(string player, bool state){ @@ -16901,7 +23347,13 @@ public void allowSprinting(string player, bool state){ m_ts.fnPlayer_allowSprinting(player, state); } /// -/// @brief Set if the Player is allowed to swim. The default is to allow swimming unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow swimming at any time. @param state Set to true to allow swimming, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to swim. +/// The default is to allow swimming unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow swimming +/// at any time. +/// @param state Set to true to allow swimming, false to disable it. +/// @see allowAllPoses() ) +/// /// public void allowSwimming(string player, bool state){ @@ -16909,7 +23361,21 @@ public void allowSwimming(string player, bool state){ m_ts.fnPlayer_allowSwimming(player, state); } /// -/// @brief Check if it is safe to dismount at this position. Internally this method casts a ray from oldPos to pos to determine if it hits the terrain, an interior object, a water object, another player, a static shape, a vehicle (exluding the one currently mounted), or physical zone. If this ray is in the clear, then the player's bounding box is also checked for a collision at the pos position. If this displaced bounding box is also in the clear, then checkDismountPoint() returns true. @param oldPos The player's current position @param pos The dismount position to check @return True if the dismount position is clear, false if not @note The player must be already mounted for this method to not assert.) +/// @brief Check if it is safe to dismount at this position. +/// +/// Internally this method casts a ray from oldPos to pos to determine if it hits the +/// terrain, an interior object, a water object, another player, a static shape, +/// a vehicle (exluding the one currently mounted), or physical zone. If this ray +/// is in the clear, then the player's bounding box is also checked for a collision at +/// the pos position. If this displaced bounding box is also in the clear, then +/// checkDismountPoint() returns true. +/// +/// @param oldPos The player's current position +/// @param pos The dismount position to check +/// @return True if the dismount position is clear, false if not +/// +/// @note The player must be already mounted for this method to not assert.) +/// /// public bool checkDismountPoint(string player, Point3F oldPos, Point3F pos){ @@ -16917,7 +23383,23 @@ public bool checkDismountPoint(string player, Point3F oldPos, Point3F pos){ return m_ts.fnPlayer_checkDismountPoint(player, oldPos.AsString(), pos.AsString()); } /// -/// @brief Clears the player's current control object. Returns control to the player. This internally calls Player::setControlObject(0). @tsexample %player.clearControlObject(); echo(%player.getControlObject()); //-- Returns 0, player assumes control %player.setControlObject(%vehicle); echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. @endtsexample @note If the player does not have a control object, the player will receive all moves from its GameConnection. If you're looking to remove control from the player itself (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer control to another object, such as a camera. @see setControlObject() @see getControlObject() @see GameConnection::setControlObject()) +/// @brief Clears the player's current control object. +/// Returns control to the player. This internally calls +/// Player::setControlObject(0). +/// @tsexample +/// %player.clearControlObject(); +/// echo(%player.getControlObject()); //-- Returns 0, player assumes control +/// %player.setControlObject(%vehicle); +/// echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. +/// @endtsexample +/// @note If the player does not have a control object, the player will receive all moves +/// from its GameConnection. If you're looking to remove control from the player itself +/// (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer +/// control to another object, such as a camera. +/// @see setControlObject() +/// @see getControlObject() +/// @see GameConnection::setControlObject()) +/// /// public void clearControlObject(string player){ @@ -16925,7 +23407,12 @@ public void clearControlObject(string player){ m_ts.fnPlayer_clearControlObject(player); } /// -/// @brief Get the current object we are controlling. @return ID of the ShapeBase object we control, or 0 if not controlling an object. @see setControlObject() @see clearControlObject()) +/// @brief Get the current object we are controlling. +/// @return ID of the ShapeBase object we control, or 0 if not controlling an +/// object. +/// @see setControlObject() +/// @see clearControlObject()) +/// /// public int getControlObject(string player){ @@ -16933,7 +23420,59 @@ public int getControlObject(string player){ return m_ts.fnPlayer_getControlObject(player); } /// -/// @brief Get the named damage location and modifier for a given world position. the Player object can simulate different hit locations based on a pre-defined set of PlayerData defined percentages. These hit percentages divide up the Player's bounding box into different regions. The diagram below demonstrates how the various PlayerData properties split up the bounding volume: img src=\"images/player_damageloc.png\"> While you may pass in any world position and getDamageLocation() will provide a best-fit location, you should be aware that this can produce some interesting results. For example, any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even if the world position is high in the sky. Therefore it may be wise to keep the passed in point to somewhere on the surface of, or within, the Player's bounding volume. @note This method will not return an accurate location when the player is prone or swimming. @param pos A world position for which to retrieve a body region on this player. @return a string containing two words (space separated strings), where the first is a location and the second is a modifier. Posible locations:ul> li>head/li> li>torso/li> li>legs/li>/ul> Head modifiers:ul> li>left_back/li> li>middle_back/li> li>right_back/li> li>left_middle/li> li>middle_middle/li> li>right_middle/li> li>left_front/li> li>middle_front/li> li>right_front/li>/ul> Legs/Torso modifiers:ul> li>front_left/li> li>front_right/li> li>back_left/li> li>back_right/li>/ul> @see PlayerData::boxHeadPercentage @see PlayerData::boxHeadFrontPercentage @see PlayerData::boxHeadBackPercentage @see PlayerData::boxHeadLeftPercentage @see PlayerData::boxHeadRightPercentage @see PlayerData::boxTorsoPercentage ) +/// @brief Get the named damage location and modifier for a given world position. +/// +/// the Player object can simulate different hit locations based on a pre-defined set +/// of PlayerData defined percentages. These hit percentages divide up the Player's +/// bounding box into different regions. The diagram below demonstrates how the various +/// PlayerData properties split up the bounding volume: +/// +/// img src=\"images/player_damageloc.png\"> +/// +/// While you may pass in any world position and getDamageLocation() will provide a best-fit +/// location, you should be aware that this can produce some interesting results. For example, +/// any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even +/// if the world position is high in the sky. Therefore it may be wise to keep the passed in point +/// to somewhere on the surface of, or within, the Player's bounding volume. +/// +/// @note This method will not return an accurate location when the player is +/// prone or swimming. +/// +/// @param pos A world position for which to retrieve a body region on this player. +/// +/// @return a string containing two words (space separated strings), where the +/// first is a location and the second is a modifier. +/// +/// Posible locations:ul> +/// li>head/li> +/// li>torso/li> +/// li>legs/li>/ul> +/// +/// Head modifiers:ul> +/// li>left_back/li> +/// li>middle_back/li> +/// li>right_back/li> +/// li>left_middle/li> +/// li>middle_middle/li> +/// li>right_middle/li> +/// li>left_front/li> +/// li>middle_front/li> +/// li>right_front/li>/ul> +/// +/// Legs/Torso modifiers:ul> +/// li>front_left/li> +/// li>front_right/li> +/// li>back_left/li> +/// li>back_right/li>/ul> +/// +/// @see PlayerData::boxHeadPercentage +/// @see PlayerData::boxHeadFrontPercentage +/// @see PlayerData::boxHeadBackPercentage +/// @see PlayerData::boxHeadLeftPercentage +/// @see PlayerData::boxHeadRightPercentage +/// @see PlayerData::boxTorsoPercentage +/// ) +/// /// public string getDamageLocation(string player, Point3F pos){ @@ -16941,7 +23480,9 @@ public string getDamageLocation(string player, Point3F pos){ return m_ts.fnPlayer_getDamageLocation(player, pos.AsString()); } /// -/// @brief Get the number of death animations available to this player. Death animations are assumed to be named death1-N using consecutive indices. ) +/// @brief Get the number of death animations available to this player. +/// Death animations are assumed to be named death1-N using consecutive indices. ) +/// /// public int getNumDeathAnimations(string player){ @@ -16949,7 +23490,17 @@ public int getNumDeathAnimations(string player){ return m_ts.fnPlayer_getNumDeathAnimations(player); } /// -/// @brief Get the name of the player's current pose. The pose is one of the following:ul> li>Stand - Standard movement pose./li> li>Sprint - Sprinting pose./li> li>Crouch - Crouch pose./li> li>Prone - Prone pose./li> li>Swim - Swimming pose./li>/ul> @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// @brief Get the name of the player's current pose. +/// +/// The pose is one of the following:ul> +/// li>Stand - Standard movement pose./li> +/// li>Sprint - Sprinting pose./li> +/// li>Crouch - Crouch pose./li> +/// li>Prone - Prone pose./li> +/// li>Swim - Swimming pose./li>/ul> +/// +/// @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// /// public string getPose(string player){ @@ -16957,7 +23508,16 @@ public string getPose(string player){ return m_ts.fnPlayer_getPose(player); } /// -/// @brief Get the name of the player's current state. The state is one of the following:ul> li>Dead - The Player is dead./li> li>Mounted - The Player is mounted to an object such as a vehicle./li> li>Move - The Player is free to move. The usual state./li> li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// @brief Get the name of the player's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The Player is dead./li> +/// li>Mounted - The Player is mounted to an object such as a vehicle./li> +/// li>Move - The Player is free to move. The usual state./li> +/// li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// /// public string getState(string player){ @@ -16965,7 +23525,58 @@ public string getState(string player){ return m_ts.fnPlayer_getState(player); } /// -/// @brief Set the main action sequence to play for this player. @param name Name of the action sequence to set @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). When set to true no callback is made. @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's spine nodes to animate. @return True if succesful, false if failed @note The spine nodes for the Player's shape are named as follows:ul> li>Bip01 Pelvis/li> li>Bip01 Spine/li> li>Bip01 Spine1/li> li>Bip01 Spine2/li> li>Bip01 Neck/li> li>Bip01 Head/li>/ul> You cannot use setActionThread() to have the Player play one of the motion determined action animation sequences. These sequences are chosen based on how the Player moves and the Player's current pose. The names of these sequences are:ul> li>root/li> li>run/li> li>side/li> li>side_right/li> li>crouch_root/li> li>crouch_forward/li> li>crouch_backward/li> li>crouch_side/li> li>crouch_right/li> li>prone_root/li> li>prone_forward/li> li>prone_backward/li> li>swim_root/li> li>swim_forward/li> li>swim_backward/li> li>swim_left/li> li>swim_right/li> li>fall/li> li>jump/li> li>standjump/li> li>land/li> li>jet/li>/ul> If the player moves in any direction then the animation sequence set using this method will be cancelled and the chosen mation-based sequence will take over. This makes great for times when the Player cannot move, such as when mounted, or when it doesn't matter if the action sequence changes, such as waving and saluting. @tsexample // Place the player in a sitting position after being mounted %player.setActionThread( \"sitting\", true, true ); @endtsexample) +/// @brief Set the main action sequence to play for this player. +/// @param name Name of the action sequence to set +/// @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). +/// When set to true no callback is made. +/// @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's +/// spine nodes to animate. +/// @return True if succesful, false if failed +/// +/// @note The spine nodes for the Player's shape are named as follows:ul> +/// li>Bip01 Pelvis/li> +/// li>Bip01 Spine/li> +/// li>Bip01 Spine1/li> +/// li>Bip01 Spine2/li> +/// li>Bip01 Neck/li> +/// li>Bip01 Head/li>/ul> +/// +/// You cannot use setActionThread() to have the Player play one of the motion +/// determined action animation sequences. These sequences are chosen based on how +/// the Player moves and the Player's current pose. The names of these sequences are:ul> +/// li>root/li> +/// li>run/li> +/// li>side/li> +/// li>side_right/li> +/// li>crouch_root/li> +/// li>crouch_forward/li> +/// li>crouch_backward/li> +/// li>crouch_side/li> +/// li>crouch_right/li> +/// li>prone_root/li> +/// li>prone_forward/li> +/// li>prone_backward/li> +/// li>swim_root/li> +/// li>swim_forward/li> +/// li>swim_backward/li> +/// li>swim_left/li> +/// li>swim_right/li> +/// li>fall/li> +/// li>jump/li> +/// li>standjump/li> +/// li>land/li> +/// li>jet/li>/ul> +/// +/// If the player moves in any direction then the animation sequence set using this +/// method will be cancelled and the chosen mation-based sequence will take over. This makes +/// great for times when the Player cannot move, such as when mounted, or when it doesn't matter +/// if the action sequence changes, such as waving and saluting. +/// +/// @tsexample +/// // Place the player in a sitting position after being mounted +/// %player.setActionThread( \"sitting\", true, true ); +/// @endtsexample) +/// /// public bool setActionThread(string player, string name, bool hold = false, bool fsp = true){ @@ -16973,7 +23584,12 @@ public bool setActionThread(string player, string name, bool hold = false, bool return m_ts.fnPlayer_setActionThread(player, name, hold, fsp); } /// -/// @brief Set the sequence that controls the player's arms (dynamically adjusted to match look direction). @param name Name of the sequence to play on the player's arms. @return true if successful, false if failed. @note By default the 'look' sequence is used, if available.) +/// @brief Set the sequence that controls the player's arms (dynamically adjusted +/// to match look direction). +/// @param name Name of the sequence to play on the player's arms. +/// @return true if successful, false if failed. +/// @note By default the 'look' sequence is used, if available.) +/// /// public bool setArmThread(string player, string name){ @@ -16981,7 +23597,23 @@ public bool setArmThread(string player, string name){ return m_ts.fnPlayer_setArmThread(player, name); } /// -/// @brief Set the object to be controlled by this player It is possible to have the moves sent to the Player object from the GameConnection to be passed along to another object. This happens, for example when a player is mounted to a vehicle. The move commands pass through the Player and on to the vehicle (while the player remains stationary within the vehicle). With setControlObject() you can have the Player pass along its moves to any object. One possible use is for a player to move a remote controlled vehicle. In this case the player does not mount the vehicle directly, but still wants to be able to control it. @param obj Object to control with this player @return True if the object is valid, false if not @see getControlObject() @see clearControlObject() @see GameConnection::setControlObject()) +/// @brief Set the object to be controlled by this player +/// +/// It is possible to have the moves sent to the Player object from the +/// GameConnection to be passed along to another object. This happens, for example +/// when a player is mounted to a vehicle. The move commands pass through the Player +/// and on to the vehicle (while the player remains stationary within the vehicle). +/// With setControlObject() you can have the Player pass along its moves to any object. +/// One possible use is for a player to move a remote controlled vehicle. In this case +/// the player does not mount the vehicle directly, but still wants to be able to control it. +/// +/// @param obj Object to control with this player +/// @return True if the object is valid, false if not +/// +/// @see getControlObject() +/// @see clearControlObject() +/// @see GameConnection::setControlObject()) +/// /// public bool setControlObject(string player, string obj){ @@ -16994,14 +23626,9 @@ public bool setControlObject(string player, string obj){ /// public class PopupMenuObject { -private Omni m_ts; - /// - /// - /// - /// -public PopupMenuObject(ref Omni ts){m_ts = ts;} /// /// (GuiCanvas, pos, title)) +/// /// public void PopupMenu_attachToMenuBar(string popupmenu, string canvasName, int pos, string title){ @@ -17010,6 +23637,7 @@ public void PopupMenu_attachToMenuBar(string popupmenu, string canvasName, int } /// /// (pos, checked)) +/// /// public void PopupMenu_checkItem(string popupmenu, int pos, bool checkedx){ @@ -17018,6 +23646,7 @@ public void PopupMenu_checkItem(string popupmenu, int pos, bool checkedx){ } /// /// (firstPos, lastPos, checkPos)) +/// /// public void PopupMenu_checkRadioItem(string popupmenu, int firstPos, int lastPos, int checkPos){ @@ -17026,6 +23655,7 @@ public void PopupMenu_checkRadioItem(string popupmenu, int firstPos, int lastPo } /// /// (pos, enabled)) +/// /// public void PopupMenu_enableItem(string popupmenu, int pos, bool enabled){ @@ -17034,6 +23664,7 @@ public void PopupMenu_enableItem(string popupmenu, int pos, bool enabled){ } /// /// ()) +/// /// public int PopupMenu_getItemCount(string popupmenu){ @@ -17042,6 +23673,7 @@ public int PopupMenu_getItemCount(string popupmenu){ } /// /// , ), (pos[, title][, accelerator])) +/// /// public int PopupMenu_insertItem(string popupmenu, int pos, string title = "", string accelerator = ""){ @@ -17050,6 +23682,7 @@ public int PopupMenu_insertItem(string popupmenu, int pos, string title = "", s } /// /// (pos, title, subMenu)) +/// /// public int PopupMenu_insertSubMenu(string popupmenu, int pos, string title, string subMenu){ @@ -17058,6 +23691,7 @@ public int PopupMenu_insertSubMenu(string popupmenu, int pos, string title, str } /// /// (pos)) +/// /// public bool PopupMenu_isItemChecked(string popupmenu, int pos){ @@ -17066,6 +23700,7 @@ public bool PopupMenu_isItemChecked(string popupmenu, int pos){ } /// /// ()) +/// /// public void PopupMenu_removeFromMenuBar(string popupmenu){ @@ -17074,6 +23709,7 @@ public void PopupMenu_removeFromMenuBar(string popupmenu){ } /// /// (pos)) +/// /// public void PopupMenu_removeItem(string popupmenu, int pos){ @@ -17082,6 +23718,7 @@ public void PopupMenu_removeItem(string popupmenu, int pos){ } /// /// ), (pos, title[, accelerator])) +/// /// public bool PopupMenu_setItem(string popupmenu, int pos, string title, string accelerator = ""){ @@ -17090,6 +23727,7 @@ public bool PopupMenu_setItem(string popupmenu, int pos, string title, string a } /// /// (Canvas,[x, y])) +/// /// public void PopupMenu_showPopup(string popupmenu, string canvasName, int x = -1, int y = -1){ @@ -17102,14 +23740,10 @@ public void PopupMenu_showPopup(string popupmenu, string canvasName, int x = -1 /// public class PortalObject { -private Omni m_ts; - /// - /// - /// - /// -public PortalObject(ref Omni ts){m_ts = ts;} /// -/// Test whether the portal connects interior zones to the outdoor zone. @return True if the portal is an exterior portal. ) +/// Test whether the portal connects interior zones to the outdoor zone. +/// @return True if the portal is an exterior portal. ) +/// /// public bool isExteriorPortal(string portal){ @@ -17117,7 +23751,9 @@ public bool isExteriorPortal(string portal){ return m_ts.fnPortal_isExteriorPortal(portal); } /// -/// Test whether the portal connects interior zones only. @return True if the portal is an interior portal. ) +/// Test whether the portal connects interior zones only. +/// @return True if the portal is an interior portal. ) +/// /// public bool isInteriorPortal(string portal){ @@ -17130,14 +23766,9 @@ public bool isInteriorPortal(string portal){ /// public class PostEffectObject { -private Omni m_ts; - /// - /// - /// - /// -public PostEffectObject(ref Omni ts){m_ts = ts;} /// /// Remove all shader macros. ) +/// /// public void clearShaderMacros(string posteffect){ @@ -17146,6 +23777,7 @@ public void clearShaderMacros(string posteffect){ } /// /// Disables the effect. ) +/// /// public void disable(string posteffect){ @@ -17153,7 +23785,9 @@ public void disable(string posteffect){ m_ts.fnPostEffect_disable(posteffect); } /// -/// Dumps this PostEffect shader's disassembly to a temporary text file. @return Full path to the dumped file or an empty string if failed. ) +/// Dumps this PostEffect shader's disassembly to a temporary text file. +/// @return Full path to the dumped file or an empty string if failed. ) +/// /// public string dumpShaderDisassembly(string posteffect){ @@ -17162,6 +23796,7 @@ public string dumpShaderDisassembly(string posteffect){ } /// /// Enables the effect. ) +/// /// public void enable(string posteffect){ @@ -17170,6 +23805,7 @@ public void enable(string posteffect){ } /// /// @return Width over height of the backbuffer. ) +/// /// public float getAspectRatio(string posteffect){ @@ -17178,6 +23814,7 @@ public float getAspectRatio(string posteffect){ } /// /// @return True if the effect is enabled. ) +/// /// public bool isEnabled(string posteffect){ @@ -17186,6 +23823,7 @@ public bool isEnabled(string posteffect){ } /// /// Reloads the effect shader and textures. ) +/// /// public void reload(string posteffect){ @@ -17193,7 +23831,9 @@ public void reload(string posteffect){ m_ts.fnPostEffect_reload(posteffect); } /// -/// Remove a shader macro. This will usually be called within the preProcess callback. @param key Macro to remove. ) +/// Remove a shader macro. This will usually be called within the preProcess callback. +/// @param key Macro to remove. ) +/// /// public void removeShaderMacro(string posteffect, string key){ @@ -17201,7 +23841,23 @@ public void removeShaderMacro(string posteffect, string key){ m_ts.fnPostEffect_removeShaderMacro(posteffect, key); } /// -/// Sets the value of a uniform defined in the shader. This will usually be called within the setShaderConsts callback. Array type constants are not supported. @param name Name of the constanst, prefixed with '$'. @param value Value to set, space seperate values with more than one element. @tsexample function MyPfx::setShaderConsts( %this ) { // example float4 uniform %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); // example float1 uniform %this.setShaderConst( \"$strength\", \"3.0\" ); // example integer uniform %this.setShaderConst( \"$loops\", \"5\" ); } @endtsexample ) +/// Sets the value of a uniform defined in the shader. This will usually +/// be called within the setShaderConsts callback. Array type constants are +/// not supported. +/// @param name Name of the constanst, prefixed with '$'. +/// @param value Value to set, space seperate values with more than one element. +/// @tsexample +/// function MyPfx::setShaderConsts( %this ) +/// { +/// // example float4 uniform +/// %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); +/// // example float1 uniform +/// %this.setShaderConst( \"$strength\", \"3.0\" ); +/// // example integer uniform +/// %this.setShaderConst( \"$loops\", \"5\" ); +/// } +/// @endtsexample ) +/// /// public void setShaderConst(string posteffect, string name, string value){ @@ -17209,7 +23865,23 @@ public void setShaderConst(string posteffect, string name, string value){ m_ts.fnPostEffect_setShaderConst(posteffect, name, value); } /// -/// ), Adds a macro to the effect's shader or sets an existing one's value. This will usually be called within the onAdd or preProcess callback. @param key lval of the macro. @param value rval of the macro, or may be empty. @tsexample function MyPfx::onAdd( %this ) { %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); // In the shader looks like... // #define NUM_SAMPLES 10 // #define HIGH_QUALITY_MODE } @endtsexample ) +/// ), +/// Adds a macro to the effect's shader or sets an existing one's value. +/// This will usually be called within the onAdd or preProcess callback. +/// @param key lval of the macro. +/// @param value rval of the macro, or may be empty. +/// @tsexample +/// function MyPfx::onAdd( %this ) +/// { +/// %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); +/// %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); +/// +/// // In the shader looks like... +/// // #define NUM_SAMPLES 10 +/// // #define HIGH_QUALITY_MODE +/// } +/// @endtsexample ) +/// /// public void setShaderMacro(string posteffect, string key, string value = ""){ @@ -17217,7 +23889,12 @@ public void setShaderMacro(string posteffect, string key, string value = ""){ m_ts.fnPostEffect_setShaderMacro(posteffect, key, value); } /// -/// This is used to set the texture file and load the texture on a running effect. If the texture file is not different from the current file nothing is changed. If the texture cannot be found a null texture is assigned. @param index The texture stage index. @param filePath The file name of the texture to set. ) +/// This is used to set the texture file and load the texture on a running effect. +/// If the texture file is not different from the current file nothing is changed. If +/// the texture cannot be found a null texture is assigned. +/// @param index The texture stage index. +/// @param filePath The file name of the texture to set. ) +/// /// public void setTexture(string posteffect, int index, string filePath){ @@ -17225,7 +23902,9 @@ public void setTexture(string posteffect, int index, string filePath){ m_ts.fnPostEffect_setTexture(posteffect, index, filePath); } /// -/// Toggles the effect between enabled / disabled. @return True if effect is enabled. ) +/// Toggles the effect between enabled / disabled. +/// @return True if effect is enabled. ) +/// /// public bool toggle(string posteffect){ @@ -17238,14 +23917,21 @@ public bool toggle(string posteffect){ /// public class PrecipitationObject { -private Omni m_ts; - /// - /// - /// - /// -public PrecipitationObject(ref Omni ts){m_ts = ts;} /// -/// Smoothly change the maximum number of drops in the effect (from current value to #numDrops * @a percentage). This method can be used to simulate a storm building or fading in intensity as the number of drops in the Precipitation box changes. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @param seconds Length of time (in seconds) over which to increase the drops percentage value. Set to 0 to change instantly. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %seconds = 5.0; // The length of time over which to make the change. %precipitation.modifyStorm( %percentage, %seconds ); @endtsexample ) +/// Smoothly change the maximum number of drops in the effect (from current +/// value to #numDrops * @a percentage). +/// This method can be used to simulate a storm building or fading in intensity +/// as the number of drops in the Precipitation box changes. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @param seconds Length of time (in seconds) over which to increase the drops +/// percentage value. Set to 0 to change instantly. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.modifyStorm( %percentage, %seconds ); +/// @endtsexample ) +/// /// public void modifyStorm(string precipitation, float percentage = 1.0f, float seconds = 5.0f){ @@ -17253,7 +23939,17 @@ public void modifyStorm(string precipitation, float percentage = 1.0f, float se m_ts.fnPrecipitation_modifyStorm(precipitation, percentage, seconds); } /// -/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. The change occurs instantly (use modifyStorm() to change the number of drops over a period of time. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %precipitation.setPercentage( %percentage ); @endtsexample @see modifyStorm ) +/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. +/// The change occurs instantly (use modifyStorm() to change the number of drops +/// over a period of time. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %precipitation.setPercentage( %percentage ); +/// @endtsexample +/// @see modifyStorm ) +/// /// public void setPercentage(string precipitation, float percentage = 1.0f){ @@ -17261,7 +23957,18 @@ public void setPercentage(string precipitation, float percentage = 1.0f){ m_ts.fnPrecipitation_setPercentage(precipitation, percentage); } /// -/// Smoothly change the turbulence parameters over a period of time. @param max New #maxTurbulence value. Set to 0 to disable turbulence. @param speed New #turbulenceSpeed value. @param seconds Length of time (in seconds) over which to interpolate the turbulence settings. Set to 0 to change instantly. @tsexample %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. %speed = 5.0; // The new speed of the turbulance effect. %seconds = 5.0; // The length of time over which to make the change. %precipitation.setTurbulence( %turbulence, %speed, %seconds ); @endtsexample ) +/// Smoothly change the turbulence parameters over a period of time. +/// @param max New #maxTurbulence value. Set to 0 to disable turbulence. +/// @param speed New #turbulenceSpeed value. +/// @param seconds Length of time (in seconds) over which to interpolate the +/// turbulence settings. Set to 0 to change instantly. +/// @tsexample +/// %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. +/// %speed = 5.0; // The new speed of the turbulance effect. +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.setTurbulence( %turbulence, %speed, %seconds ); +/// @endtsexample ) +/// /// public void setTurbulence(string precipitation, float max = 1.0f, float speed = 5.0f, float seconds = 5.0f){ @@ -17274,14 +23981,20 @@ public void setTurbulence(string precipitation, float max = 1.0f, float speed = /// public class ProjectileObject { -private Omni m_ts; - /// - /// - /// - /// -public ProjectileObject(ref Omni ts){m_ts = ts;} /// -/// @brief Updates the projectile's positional and collision information. This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. Also responsible for applying gravity, determining collisions, triggering explosions, emitting trail particles, and calculating bounces if necessary. @param seconds Amount of time, in seconds since the simulation's start, to advance. @tsexample // Tell the projectile to process a simulation event, and provide the amount of time // that has passed since the simulation began. %seconds = 2.0; %projectile.presimulate(%seconds); @endtsexample @note This function is not called if the SimObject::hidden is true.) +/// @brief Updates the projectile's positional and collision information. +/// This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. +/// Also responsible for applying gravity, determining collisions, triggering explosions, +/// emitting trail particles, and calculating bounces if necessary. +/// @param seconds Amount of time, in seconds since the simulation's start, to advance. +/// @tsexample +/// // Tell the projectile to process a simulation event, and provide the amount of time +/// // that has passed since the simulation began. +/// %seconds = 2.0; +/// %projectile.presimulate(%seconds); +/// @endtsexample +/// @note This function is not called if the SimObject::hidden is true.) +/// /// public void presimulate(string projectile, float seconds = 1.0f){ @@ -17294,14 +24007,9 @@ public void presimulate(string projectile, float seconds = 1.0f){ /// public class ProximityMineObject { -private Omni m_ts; - /// - /// - /// - /// -public ProximityMineObject(ref Omni ts){m_ts = ts;} /// /// @brief Manually cause the mine to explode.) +/// /// public void explode(string proximitymine){ @@ -17314,12 +24022,6 @@ public void explode(string proximitymine){ /// public class ReadXMLObject { -private Omni m_ts; - /// - /// - /// - /// -public ReadXMLObject(ref Omni ts){m_ts = ts;} /// /// readXMLObj.readFile();) /// @@ -17335,14 +24037,9 @@ public bool ReadXML_readFile(string readxml){ /// public class RenderBinManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public RenderBinManagerObject(ref Omni ts){m_ts = ts;} /// /// Returns the bin type string. ) +/// /// public string getBinType(string renderbinmanager){ @@ -17355,14 +24052,9 @@ public string getBinType(string renderbinmanager){ /// public class RenderMeshExampleObject { -private Omni m_ts; - /// - /// - /// - /// -public RenderMeshExampleObject(ref Omni ts){m_ts = ts;} /// /// A utility method for forcing a network update.) +/// /// public void postApply(string rendermeshexample){ @@ -17375,14 +24067,9 @@ public void postApply(string rendermeshexample){ /// public class RenderPassManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public RenderPassManagerObject(ref Omni ts){m_ts = ts;} /// /// Add as a render bin manager to the pass. ) +/// /// public void addManager(string renderpassmanager, string renderBin){ @@ -17391,6 +24078,7 @@ public void addManager(string renderpassmanager, string renderBin){ } /// /// Returns the render bin manager at the index or null if the index is out of range. ) +/// /// public string getManager(string renderpassmanager, int index){ @@ -17399,6 +24087,7 @@ public string getManager(string renderpassmanager, int index){ } /// /// Returns the total number of bin managers. ) +/// /// public int getManagerCount(string renderpassmanager){ @@ -17407,6 +24096,7 @@ public int getManagerCount(string renderpassmanager){ } /// /// Removes a render bin manager. ) +/// /// public void removeManager(string renderpassmanager, string renderBin){ @@ -17419,14 +24109,9 @@ public void removeManager(string renderpassmanager, string renderBin){ /// public class RenderPassStateTokenObject { -private Omni m_ts; - /// - /// - /// - /// -public RenderPassStateTokenObject(ref Omni ts){m_ts = ts;} /// /// @brief Disables the token.) +/// /// public void disable(string renderpassstatetoken){ @@ -17435,6 +24120,7 @@ public void disable(string renderpassstatetoken){ } /// /// @brief Enables the token. ) +/// /// public void enable(string renderpassstatetoken){ @@ -17443,6 +24129,7 @@ public void enable(string renderpassstatetoken){ } /// /// @brief Toggles the token from enabled to disabled or vice versa. ) +/// /// public void toggle(string renderpassstatetoken){ @@ -17455,14 +24142,9 @@ public void toggle(string renderpassstatetoken){ /// public class RigidShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public RigidShapeObject(ref Omni ts){m_ts = ts;} /// /// @brief Forces the client to jump to the RigidShape's transform rather then warp to it.) +/// /// public void forceClientTransform(string rigidshape){ @@ -17470,7 +24152,16 @@ public void forceClientTransform(string rigidshape){ m_ts.fnRigidShape_forceClientTransform(rigidshape); } /// -/// @brief Enables or disables the physics simulation on the RigidShape object. @param isFrozen Boolean frozen state to set the object. @tsexample // Define the frozen state. %isFrozen = \"true\"; // Inform the object of the defined frozen state %thisRigidShape.freezeSim(%isFrozen); @endtsexample @see ShapeBaseData) +/// @brief Enables or disables the physics simulation on the RigidShape object. +/// @param isFrozen Boolean frozen state to set the object. +/// @tsexample +/// // Define the frozen state. +/// %isFrozen = \"true\"; +/// // Inform the object of the defined frozen state +/// %thisRigidShape.freezeSim(%isFrozen); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void freezeSim(string rigidshape, bool isFrozen){ @@ -17478,7 +24169,13 @@ public void freezeSim(string rigidshape, bool isFrozen){ m_ts.fnRigidShape_freezeSim(rigidshape, isFrozen); } /// -/// @brief Clears physic forces from the shape and sets it at rest. @tsexample // Inform the RigidShape object to reset. %thisRigidShape.reset(); @endtsexample @see ShapeBaseData) +/// @brief Clears physic forces from the shape and sets it at rest. +/// @tsexample +/// // Inform the RigidShape object to reset. +/// %thisRigidShape.reset(); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void reset(string rigidshape){ @@ -17491,14 +24188,11 @@ public void reset(string rigidshape){ /// public class RiverObject { -private Omni m_ts; - /// - /// - /// - /// -public RiverObject(ref Omni ts){m_ts = ts;} /// -/// Intended as a helper to developers and editor scripts. Force River to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force River to recreate its geometry. +/// ) +/// /// public void regenerate(string river){ @@ -17506,7 +24200,10 @@ public void regenerate(string river){ m_ts.fnRiver_regenerate(river); } /// -/// Intended as a helper to developers and editor scripts. BatchSize is not currently used. ) +/// Intended as a helper to developers and editor scripts. +/// BatchSize is not currently used. +/// ) +/// /// public void setBatchSize(string river, float meters){ @@ -17514,7 +24211,10 @@ public void setBatchSize(string river, float meters){ m_ts.fnRiver_setBatchSize(river, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SubdivideLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SubdivideLength field. +/// ) +/// /// public void setMaxDivisionSize(string river, float meters){ @@ -17522,7 +24222,10 @@ public void setMaxDivisionSize(string river, float meters){ m_ts.fnRiver_setMaxDivisionSize(river, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SegmentLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SegmentLength field. +/// ) +/// /// public void setMetersPerSegment(string river, float meters){ @@ -17530,7 +24233,10 @@ public void setMetersPerSegment(string river, float meters){ m_ts.fnRiver_setMetersPerSegment(river, meters); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void setNodeDepth(string river, int idx, float meters){ @@ -17543,14 +24249,10 @@ public void setNodeDepth(string river, int idx, float meters){ /// public class ScatterSkyObject { -private Omni m_ts; - /// - /// - /// - /// -public ScatterSkyObject(ref Omni ts){m_ts = ts;} /// -/// Apply a full network update of all fields to all clients. ) +/// Apply a full network update of all fields to all clients. +/// ) +/// /// public void applyChanges(string scattersky){ @@ -17563,14 +24265,11 @@ public void applyChanges(string scattersky){ /// public class SceneObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public SceneObjectObject(ref Omni ts){m_ts = ts;} /// -/// Get Euler rotation of this object. @return the orientation of the object in the form of rotations around the X, Y and Z axes in degrees. ) +/// Get Euler rotation of this object. +/// @return the orientation of the object in the form of rotations around the +/// X, Y and Z axes in degrees. ) +/// /// public Point3F getEulerRotation(string sceneobject){ @@ -17578,7 +24277,10 @@ public Point3F getEulerRotation(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getEulerRotation(sceneobject)); } /// -/// Get the direction this object is facing. @return a vector indicating the direction this object is facing. @note This is the object's y axis. ) +/// Get the direction this object is facing. +/// @return a vector indicating the direction this object is facing. +/// @note This is the object's y axis. ) +/// /// public Point3F getForwardVector(string sceneobject){ @@ -17586,7 +24288,9 @@ public Point3F getForwardVector(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getForwardVector(sceneobject)); } /// -/// Get the object's inverse transform. @return the inverse transform of the object ) +/// Get the object's inverse transform. +/// @return the inverse transform of the object ) +/// /// public TransformF getInverseTransform(string sceneobject){ @@ -17594,7 +24298,10 @@ public TransformF getInverseTransform(string sceneobject){ return new TransformF ( m_ts.fnSceneObject_getInverseTransform(sceneobject)); } /// -/// Get the object mounted at a particular slot. @param slot mount slot index to query @return ID of the object mounted in the slot, or 0 if no object. ) +/// Get the object mounted at a particular slot. +/// @param slot mount slot index to query +/// @return ID of the object mounted in the slot, or 0 if no object. ) +/// /// public int getMountedObject(string sceneobject, int slot){ @@ -17602,7 +24309,9 @@ public int getMountedObject(string sceneobject, int slot){ return m_ts.fnSceneObject_getMountedObject(sceneobject, slot); } /// -/// Get the number of objects mounted to us. @return the number of mounted objects. ) +/// Get the number of objects mounted to us. +/// @return the number of mounted objects. ) +/// /// public int getMountedObjectCount(string sceneobject){ @@ -17610,7 +24319,10 @@ public int getMountedObjectCount(string sceneobject){ return m_ts.fnSceneObject_getMountedObjectCount(sceneobject); } /// -/// @brief Get the mount node index of the object mounted at our given slot. @param slot mount slot index to query @return index of the mount node used by the object mounted in this slot. ) +/// @brief Get the mount node index of the object mounted at our given slot. +/// @param slot mount slot index to query +/// @return index of the mount node used by the object mounted in this slot. ) +/// /// public int getMountedObjectNode(string sceneobject, int slot){ @@ -17618,7 +24330,10 @@ public int getMountedObjectNode(string sceneobject, int slot){ return m_ts.fnSceneObject_getMountedObjectNode(sceneobject, slot); } /// -/// @brief Get the object mounted at our given node index. @param node mount node index to query @return ID of the first object mounted at the node, or 0 if none found. ) +/// @brief Get the object mounted at our given node index. +/// @param node mount node index to query +/// @return ID of the first object mounted at the node, or 0 if none found. ) +/// /// public int getMountNodeObject(string sceneobject, int node){ @@ -17626,7 +24341,10 @@ public int getMountNodeObject(string sceneobject, int node){ return m_ts.fnSceneObject_getMountNodeObject(sceneobject, node); } /// -/// Get the object's bounding box (relative to the object's origin). @return six fields, two Point3Fs, containing the min and max points of the objectbox. ) +/// Get the object's bounding box (relative to the object's origin). +/// @return six fields, two Point3Fs, containing the min and max points of the +/// objectbox. ) +/// /// public Box3F getObjectBox(string sceneobject){ @@ -17634,7 +24352,9 @@ public Box3F getObjectBox(string sceneobject){ return new Box3F ( m_ts.fnSceneObject_getObjectBox(sceneobject)); } /// -/// @brief Get the object we are mounted to. @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// @brief Get the object we are mounted to. +/// @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// /// public int getObjectMount(string sceneobject){ @@ -17642,7 +24362,9 @@ public int getObjectMount(string sceneobject){ return m_ts.fnSceneObject_getObjectMount(sceneobject); } /// -/// Get the object's world position. @return the current world position of the object ) +/// Get the object's world position. +/// @return the current world position of the object ) +/// /// public Point3F getPosition(string sceneobject){ @@ -17650,7 +24372,10 @@ public Point3F getPosition(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getPosition(sceneobject)); } /// -/// Get the right vector of the object. @return a vector indicating the right direction of this object. @note This is the object's x axis. ) +/// Get the right vector of the object. +/// @return a vector indicating the right direction of this object. +/// @note This is the object's x axis. ) +/// /// public Point3F getRightVector(string sceneobject){ @@ -17658,7 +24383,9 @@ public Point3F getRightVector(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getRightVector(sceneobject)); } /// -/// Get the object's scale. @return object scale as a Point3F ) +/// Get the object's scale. +/// @return object scale as a Point3F ) +/// /// public Point3F getScale(string sceneobject){ @@ -17666,7 +24393,9 @@ public Point3F getScale(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getScale(sceneobject)); } /// -/// Get the object's transform. @return the current transform of the object ) +/// Get the object's transform. +/// @return the current transform of the object ) +/// /// public TransformF getTransform(string sceneobject){ @@ -17674,7 +24403,9 @@ public TransformF getTransform(string sceneobject){ return new TransformF ( m_ts.fnSceneObject_getTransform(sceneobject)); } /// -/// Return the type mask for this object. @return The numeric type mask for the object. ) +/// Return the type mask for this object. +/// @return The numeric type mask for the object. ) +/// /// public int getType(string sceneobject){ @@ -17682,7 +24413,10 @@ public int getType(string sceneobject){ return m_ts.fnSceneObject_getType(sceneobject); } /// -/// Get the up vector of the object. @return a vector indicating the up direction of this object. @note This is the object's z axis. ) +/// Get the up vector of the object. +/// @return a vector indicating the up direction of this object. +/// @note This is the object's z axis. ) +/// /// public Point3F getUpVector(string sceneobject){ @@ -17690,7 +24424,10 @@ public Point3F getUpVector(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getUpVector(sceneobject)); } /// -/// Get the object's world bounding box. @return six fields, two Point3Fs, containing the min and max points of the worldbox. ) +/// Get the object's world bounding box. +/// @return six fields, two Point3Fs, containing the min and max points of the +/// worldbox. ) +/// /// public Box3F getWorldBox(string sceneobject){ @@ -17698,7 +24435,9 @@ public Box3F getWorldBox(string sceneobject){ return new Box3F ( m_ts.fnSceneObject_getWorldBox(sceneobject)); } /// -/// Get the center of the object's world bounding box. @return the center of the world bounding box for this object. ) +/// Get the center of the object's world bounding box. +/// @return the center of the world bounding box for this object. ) +/// /// public Point3F getWorldBoxCenter(string sceneobject){ @@ -17706,7 +24445,11 @@ public Point3F getWorldBoxCenter(string sceneobject){ return new Point3F ( m_ts.fnSceneObject_getWorldBoxCenter(sceneobject)); } /// -/// Check if this object has a global bounds set. If global bounds are set to be true, then the object is assumed to have an infinitely large bounding box for collision and rendering purposes. @return true if the object has a global bounds. ) +/// Check if this object has a global bounds set. +/// If global bounds are set to be true, then the object is assumed to have an +/// infinitely large bounding box for collision and rendering purposes. +/// @return true if the object has a global bounds. ) +/// /// public bool isGlobalBounds(string sceneobject){ @@ -17714,7 +24457,9 @@ public bool isGlobalBounds(string sceneobject){ return m_ts.fnSceneObject_isGlobalBounds(sceneobject); } /// -/// @brief Check if we are mounted to another object. @return true if mounted to another object, false if not mounted. ) +/// @brief Check if we are mounted to another object. +/// @return true if mounted to another object, false if not mounted. ) +/// /// public bool isMounted(string sceneobject){ @@ -17722,7 +24467,13 @@ public bool isMounted(string sceneobject){ return m_ts.fnSceneObject_isMounted(sceneobject); } /// -/// @brief Mount objB to this object at the desired slot with optional transform. @param objB Object to mount onto us @param slot Mount slot ID @param txfm (optional) mount offset transform @return true if successful, false if failed (objB is not valid) ) +/// @brief Mount objB to this object at the desired slot with optional transform. +/// +/// @param objB Object to mount onto us +/// @param slot Mount slot ID +/// @param txfm (optional) mount offset transform +/// @return true if successful, false if failed (objB is not valid) ) +/// /// public bool mountObject(string sceneobject, string objB, int slot, TransformF txfm = null ){ if (txfm== null) {txfm = new TransformF("0.000000,0.000000,0.000000,1.000000,0.000000,0.000000,0.000000");} @@ -17731,7 +24482,9 @@ public bool mountObject(string sceneobject, string objB, int slot, TransformF t return m_ts.fnSceneObject_mountObject(sceneobject, objB, slot, txfm.AsString()); } /// -/// Set the object's scale. @param scale object scale to set ) +/// Set the object's scale. +/// @param scale object scale to set ) +/// /// public void setScale(string sceneobject, Point3F scale){ @@ -17739,7 +24492,9 @@ public void setScale(string sceneobject, Point3F scale){ m_ts.fnSceneObject_setScale(sceneobject, scale.AsString()); } /// -/// Set the object's transform (orientation and position). @param txfm object transform to set ) +/// Set the object's transform (orientation and position). +/// @param txfm object transform to set ) +/// /// public void setTransform(string sceneobject, TransformF txfm){ @@ -17747,7 +24502,9 @@ public void setTransform(string sceneobject, TransformF txfm){ m_ts.fnSceneObject_setTransform(sceneobject, txfm.AsString()); } /// -/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool TickCounterAdd(string sceneobject, string countername, uint interval){ @@ -17755,7 +24512,9 @@ public bool TickCounterAdd(string sceneobject, string countername, uint interva return m_ts.fnSceneObject_TickCounterAdd(sceneobject, countername, interval); } /// -/// @brief returns the interval for a counter. @return true if successful, false if failed ) +/// @brief returns the interval for a counter. +/// @return true if successful, false if failed ) +/// /// public uint TickCounterGetInterval(string sceneobject, string countername){ @@ -17763,7 +24522,9 @@ public uint TickCounterGetInterval(string sceneobject, string countername){ return m_ts.fnSceneObject_TickCounterGetInterval(sceneobject, countername); } /// -/// @brief Checks to see if the counter exists. @return true if successful, false if failed ) +/// @brief Checks to see if the counter exists. +/// @return true if successful, false if failed ) +/// /// public bool TickCounterHas(string sceneobject, string countername){ @@ -17771,7 +24532,9 @@ public bool TickCounterHas(string sceneobject, string countername){ return m_ts.fnSceneObject_TickCounterHas(sceneobject, countername); } /// -/// @brief Removes a counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Removes a counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool TickCounterRemove(string sceneobject, string countername){ @@ -17779,7 +24542,9 @@ public bool TickCounterRemove(string sceneobject, string countername){ return m_ts.fnSceneObject_TickCounterRemove(sceneobject, countername); } /// -/// @brief resets the current count for a counter. @return true if successful, false if failed ) +/// @brief resets the current count for a counter. +/// @return true if successful, false if failed ) +/// /// public void TickCounterReset(string sceneobject, string countername){ @@ -17787,7 +24552,8 @@ public void TickCounterReset(string sceneobject, string countername){ m_ts.fnSceneObject_TickCounterReset(sceneobject, countername); } /// -/// @brief Clears all counters from the object.) +/// @brief Clears all counters from the object.) +/// /// public void TickCountersClear(string sceneobject){ @@ -17795,7 +24561,9 @@ public void TickCountersClear(string sceneobject){ m_ts.fnSceneObject_TickCountersClear(sceneobject); } /// -/// @brief Adds a new counter to be tracked via ticks. ) +/// @brief Adds a new counter to be tracked via ticks. +/// ) +/// /// public void TickCounterSuspend(string sceneobject, string countername, bool suspend){ @@ -17804,6 +24572,7 @@ public void TickCounterSuspend(string sceneobject, string countername, bool sus } /// /// Unmount us from the currently mounted object if any. ) +/// /// public void unmount(string sceneobject){ @@ -17811,7 +24580,11 @@ public void unmount(string sceneobject){ m_ts.fnSceneObject_unmount(sceneobject); } /// -/// @brief Unmount an object from ourselves. @param target object to unmount @return true if successful, false if failed ) +/// @brief Unmount an object from ourselves. +/// +/// @param target object to unmount +/// @return true if successful, false if failed ) +/// /// public bool unmountObject(string sceneobject, string target){ @@ -17824,14 +24597,13 @@ public bool unmountObject(string sceneobject, string target){ /// public class ScriptTickObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public ScriptTickObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Is this object wanting to receive tick notifications. If this object is set to receive tick notifications then its onInterpolateTick() and onProcessTick() callbacks are called. @return True if object wants tick notifications ) +/// @brief Is this object wanting to receive tick notifications. +/// +/// If this object is set to receive tick notifications then its onInterpolateTick() and +/// onProcessTick() callbacks are called. +/// @return True if object wants tick notifications ) +/// /// public bool isProcessingTicks(string scripttickobject){ @@ -17839,7 +24611,10 @@ public bool isProcessingTicks(string scripttickobject){ return m_ts.fnScriptTickObject_isProcessingTicks(scripttickobject); } /// -/// @brief Sets this object as either tick processing or not. @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// @brief Sets this object as either tick processing or not. +/// +/// @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// /// public void setProcessTicks(string scripttickobject, bool tick){ @@ -17852,14 +24627,9 @@ public void setProcessTicks(string scripttickobject, bool tick){ /// public class SettingsObject { -private Omni m_ts; - /// - /// - /// - /// -public SettingsObject(ref Omni ts){m_ts = ts;} /// /// settingObj.beginGroup(groupName, fromStart = false);) +/// /// public void Settings_beginGroup(string settings, string groupName, bool includeDefaults = false){ @@ -17868,6 +24638,7 @@ public void Settings_beginGroup(string settings, string groupName, bool include } /// /// settingObj.clearGroups();) +/// /// public void Settings_clearGroups(string settings){ @@ -17876,6 +24647,7 @@ public void Settings_clearGroups(string settings){ } /// /// settingObj.endGroup();) +/// /// public void Settings_endGroup(string settings){ @@ -17884,6 +24656,7 @@ public void Settings_endGroup(string settings){ } /// /// , false, false), settingObj.findFirstValue();) +/// /// public string Settings_findFirstValue(string settings, string pattern = "", bool deepSearch = false, bool includeDefaults = false){ @@ -17892,6 +24665,7 @@ public string Settings_findFirstValue(string settings, string pattern = "", boo } /// /// settingObj.findNextValue();) +/// /// public string Settings_findNextValue(string settings){ @@ -17900,6 +24674,7 @@ public string Settings_findNextValue(string settings){ } /// /// settingObj.getCurrentGroups();) +/// /// public string Settings_getCurrentGroups(string settings){ @@ -17908,6 +24683,7 @@ public string Settings_getCurrentGroups(string settings){ } /// /// %success = settingObj.read();) +/// /// public bool Settings_read(string settings){ @@ -17916,6 +24692,7 @@ public bool Settings_read(string settings){ } /// /// settingObj.remove(settingName, includeDefaults = false);) +/// /// public void Settings_remove(string settings, string settingName, bool includeDefaults = false){ @@ -17924,6 +24701,7 @@ public void Settings_remove(string settings, string settingName, bool includeDe } /// /// settingObj.setDefaultValue(settingName, value);) +/// /// public void Settings_setDefaultValue(string settings, string settingName, string value){ @@ -17932,6 +24710,7 @@ public void Settings_setDefaultValue(string settings, string settingName, strin } /// /// ), settingObj.setValue(settingName, value);) +/// /// public void Settings_setValue(string settings, string settingName, string value = ""){ @@ -17940,6 +24719,7 @@ public void Settings_setValue(string settings, string settingName, string value } /// /// ), settingObj.value(settingName, defaultValue);) +/// /// public string Settings_value(string settings, string settingName, string defaultValue = ""){ @@ -17948,6 +24728,7 @@ public string Settings_value(string settings, string settingName, string defaul } /// /// (Settings, write, bool, 2, 2, %success = settingObj.write();) +/// /// public bool write(string settings= ""){ @@ -17960,14 +24741,11 @@ public bool write(string settings= ""){ /// public class SFXControllerObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXControllerObject(ref Omni ts){m_ts = ts;} /// -/// Get the index of the playlist slot currently processed by the controller. @return The slot index currently being played. @see SFXPlayList ) +/// Get the index of the playlist slot currently processed by the controller. +/// @return The slot index currently being played. +/// @see SFXPlayList ) +/// /// public int getCurrentSlot(string sfxcontroller){ @@ -17975,7 +24753,9 @@ public int getCurrentSlot(string sfxcontroller){ return m_ts.fnSFXController_getCurrentSlot(sfxcontroller); } /// -/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. @param index Index of the playlist slot. ) +/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. +/// @param index Index of the playlist slot. ) +/// /// public void setCurrentSlot(string sfxcontroller, int index){ @@ -17988,14 +24768,12 @@ public void setCurrentSlot(string sfxcontroller, int index){ /// public class SFXEmitterObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXEmitterObject(ref Omni ts){m_ts = ts;} /// -/// Get the sound source object from the emitter. @return The sound source used by the emitter or null. @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts actually hold on to %SFXSources. ) +/// Get the sound source object from the emitter. +/// @return The sound source used by the emitter or null. +/// @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts +/// actually hold on to %SFXSources. ) +/// /// public string getSource(string sfxemitter){ @@ -18003,7 +24781,9 @@ public string getSource(string sfxemitter){ return m_ts.fnSFXEmitter_getSource(sfxemitter); } /// -/// Manually start playback of the emitter's sound. If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// Manually start playback of the emitter's sound. +/// If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// /// public void play(string sfxemitter){ @@ -18011,7 +24791,9 @@ public void play(string sfxemitter){ m_ts.fnSFXEmitter_play(sfxemitter); } /// -/// Manually stop playback of the emitter's sound. If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// Manually stop playback of the emitter's sound. +/// If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// /// public void stop(string sfxemitter){ @@ -18024,14 +24806,10 @@ public void stop(string sfxemitter){ /// public class SFXParameterObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXParameterObject(ref Omni ts){m_ts = ts;} /// -/// Get the name of the parameter. @return The paramete name. ) +/// Get the name of the parameter. +/// @return The paramete name. ) +/// /// public string getParameterName(string sfxparameter){ @@ -18039,7 +24817,9 @@ public string getParameterName(string sfxparameter){ return m_ts.fnSFXParameter_getParameterName(sfxparameter); } /// -/// Reset the parameter's value to its default. @see SFXParameter::defaultValue ) +/// Reset the parameter's value to its default. +/// @see SFXParameter::defaultValue ) +/// /// public void reset(string sfxparameter){ @@ -18052,14 +24832,10 @@ public void reset(string sfxparameter){ /// public class SFXProfileObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXProfileObject(ref Omni ts){m_ts = ts;} /// -/// Return the length of the sound data in seconds. @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// Return the length of the sound data in seconds. +/// @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// /// public float getSoundDuration(string sfxprofile){ @@ -18072,14 +24848,11 @@ public float getSoundDuration(string sfxprofile){ /// public class SFXSoundObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXSoundObject(ref Omni ts){m_ts = ts;} /// -/// Get the total play time (in seconds) of the sound data attached to the sound. @return @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// Get the total play time (in seconds) of the sound data attached to the sound. +/// @return +/// @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// /// public float getDuration(string sfxsound){ @@ -18087,7 +24860,9 @@ public float getDuration(string sfxsound){ return m_ts.fnSFXSound_getDuration(sfxsound); } /// -/// Get the current playback position in seconds. @return The current play cursor offset. ) +/// Get the current playback position in seconds. +/// @return The current play cursor offset. ) +/// /// public float getPosition(string sfxsound){ @@ -18095,7 +24870,12 @@ public float getPosition(string sfxsound){ return m_ts.fnSFXSound_getPosition(sfxsound); } /// -/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. For streamed sounds, this will be false during playback when the stream queue for the sound is starved and waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to return false. @return True if the sound is ready for playback. ) +/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. +/// For streamed sounds, this will be false during playback when the stream queue for the sound is starved and +/// waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to +/// return false. +/// @return True if the sound is ready for playback. ) +/// /// public bool isReady(string sfxsound){ @@ -18103,7 +24883,11 @@ public bool isReady(string sfxsound){ return m_ts.fnSFXSound_isReady(sfxsound); } /// -/// Set the current playback position in seconds. If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, playback will resume at the given position when play() is called. @param position The new position of the play cursor (in seconds). ) +/// Set the current playback position in seconds. +/// If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, +/// playback will resume at the given position when play() is called. +/// @param position The new position of the play cursor (in seconds). ) +/// /// public void setPosition(string sfxsound, float position){ @@ -18116,14 +24900,12 @@ public void setPosition(string sfxsound, float position){ /// public class SFXSourceObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXSourceObject(ref Omni ts){m_ts = ts;} /// -/// ), ( vector position [, vector direction ] ) Set the position and orientation of a 3D sound source. @hide ) +/// ), +/// ( vector position [, vector direction ] ) +/// Set the position and orientation of a 3D sound source. +/// @hide ) +/// /// public void SFXSource_setTransform(string sfxsource, string position, string direction = ""){ @@ -18131,7 +24913,32 @@ public void SFXSource_setTransform(string sfxsource, string position, string di m_ts.fn_SFXSource_setTransform(sfxsource, position, direction); } /// -/// Add a notification marker called @a name at @a pos seconds of playback. @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there may be a delay between the play cursor actually passing the position and the callback being triggered. @note For looped sounds, the marker will trigger on each iteration. @tsexample // Create a new source. $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); // Assign a class to the source. $source.class = \"BackgroundMusic\"; // Add a playback marker at one minute into playback. $source.addMarker( \"first\", 60 ); // Define the callback function. This function will be called when the playback position passes the one minute mark. function BackgroundMusic::onMarkerPassed( %this, %markerName ) { if( %markerName $= \"first\" ) echo( \"Playback has passed the 60 seconds mark.\" ); } // Play the sound. $source.play(); @endtsexample ) +/// Add a notification marker called @a name at @a pos seconds of playback. +/// @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. +/// @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there +/// may be a delay between the play cursor actually passing the position and the callback being triggered. +/// @note For looped sounds, the marker will trigger on each iteration. +/// @tsexample +/// // Create a new source. +/// $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); +/// +/// // Assign a class to the source. +/// $source.class = \"BackgroundMusic\"; +/// +/// // Add a playback marker at one minute into playback. +/// $source.addMarker( \"first\", 60 ); +/// +/// // Define the callback function. This function will be called when the playback position passes the one minute mark. +/// function BackgroundMusic::onMarkerPassed( %this, %markerName ) +/// { +/// if( %markerName $= \"first\" ) +/// echo( \"Playback has passed the 60 seconds mark.\" ); +/// } +/// +/// // Play the sound. +/// $source.play(); +/// @endtsexample ) +/// /// public void addMarker(string sfxsource, string name, float pos){ @@ -18139,7 +24946,11 @@ public void addMarker(string sfxsource, string name, float pos){ m_ts.fnSFXSource_addMarker(sfxsource, name, pos); } /// -/// Attach @a parameter to the source, Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter will also trigger an initial read-out of the parameter's current value. @param parameter The parameter to attach to the source. ) +/// Attach @a parameter to the source, +/// Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter +/// will also trigger an initial read-out of the parameter's current value. +/// @param parameter The parameter to attach to the source. ) +/// /// public void addParameter(string sfxsource, string parameter){ @@ -18147,7 +24958,12 @@ public void addParameter(string sfxsource, string parameter){ m_ts.fnSFXSource_addParameter(sfxsource, parameter); } /// -/// Get the final effective volume level of the source. This method returns the volume level as it is after source group volume modulation, fades, and distance-based volume attenuation have been applied to the base volume level. @return The effective volume of the source. @ref SFXSource_volume ) +/// Get the final effective volume level of the source. +/// This method returns the volume level as it is after source group volume modulation, fades, and distance-based +/// volume attenuation have been applied to the base volume level. +/// @return The effective volume of the source. +/// @ref SFXSource_volume ) +/// /// public float getAttenuatedVolume(string sfxsource){ @@ -18155,7 +24971,12 @@ public float getAttenuatedVolume(string sfxsource){ return m_ts.fnSFXSource_getAttenuatedVolume(sfxsource); } /// -/// Get the fade-in time set on the source. This will initially be SFXDescription::fadeInTime. @return The fade-in time set on the source in seconds. @see SFXDescription::fadeInTime @ref SFXSource_fades ) +/// Get the fade-in time set on the source. +/// This will initially be SFXDescription::fadeInTime. +/// @return The fade-in time set on the source in seconds. +/// @see SFXDescription::fadeInTime +/// @ref SFXSource_fades ) +/// /// public float getFadeInTime(string sfxsource){ @@ -18163,7 +24984,12 @@ public float getFadeInTime(string sfxsource){ return m_ts.fnSFXSource_getFadeInTime(sfxsource); } /// -/// Get the fade-out time set on the source. This will initially be SFXDescription::fadeOutTime. @return The fade-out time set on the source in seconds. @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Get the fade-out time set on the source. +/// This will initially be SFXDescription::fadeOutTime. +/// @return The fade-out time set on the source in seconds. +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public float getFadeOutTime(string sfxsource){ @@ -18171,7 +24997,17 @@ public float getFadeOutTime(string sfxsource){ return m_ts.fnSFXSource_getFadeOutTime(sfxsource); } /// -/// Get the parameter at the given index. @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). @return The parameter at the given @a index or null if @a index is out of range. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameterCount ) +/// Get the parameter at the given index. +/// @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). +/// @return The parameter at the given @a index or null if @a index is out of range. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameterCount ) +/// /// public string getParameter(string sfxsource, int index){ @@ -18179,7 +25015,17 @@ public string getParameter(string sfxsource, int index){ return m_ts.fnSFXSource_getParameter(sfxsource, index); } /// -/// Get the number of SFXParameters that are attached to the source. @return The number of parameters attached to the source. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameter @see addParameter ) +/// Get the number of SFXParameters that are attached to the source. +/// @return The number of parameters attached to the source. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameter +/// @see addParameter ) +/// /// public int getParameterCount(string sfxsource){ @@ -18187,7 +25033,12 @@ public int getParameterCount(string sfxsource){ return m_ts.fnSFXSource_getParameterCount(sfxsource); } /// -/// Get the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @return The current pitch scale factor of the source. @see setPitch @see SFXDescription::pitch ) +/// Get the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @return The current pitch scale factor of the source. +/// @see setPitch +/// @see SFXDescription::pitch ) +/// /// public float getPitch(string sfxsource){ @@ -18195,7 +25046,9 @@ public float getPitch(string sfxsource){ return m_ts.fnSFXSource_getPitch(sfxsource); } /// -/// Get the current playback status. @return Te current playback status ) +/// Get the current playback status. +/// @return Te current playback status ) +/// /// public TypeSFXStatus getStatus(string sfxsource){ @@ -18203,7 +25056,14 @@ public TypeSFXStatus getStatus(string sfxsource){ return (TypeSFXStatus)( m_ts.fnSFXSource_getStatus(sfxsource)); } /// -/// Get the current base volume level of the source. This is not the final effective volume that the source is playing at but rather the starting volume level before source group modulation, fades, or distance-based volume attenuation are applied. @return The current base volume level. @see setVolume @see SFXDescription::volume @ref SFXSource_volume ) +/// Get the current base volume level of the source. +/// This is not the final effective volume that the source is playing at but rather the starting +/// volume level before source group modulation, fades, or distance-based volume attenuation are applied. +/// @return The current base volume level. +/// @see setVolume +/// @see SFXDescription::volume +/// @ref SFXSource_volume ) +/// /// public float getVolume(string sfxsource){ @@ -18211,7 +25071,12 @@ public float getVolume(string sfxsource){ return m_ts.fnSFXSource_getVolume(sfxsource); } /// -/// Test whether the source is currently paused. @return True if the source is in paused state, false otherwise. @see pause @see getStatus @see SFXStatus ) +/// Test whether the source is currently paused. +/// @return True if the source is in paused state, false otherwise. +/// @see pause +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool isPaused(string sfxsource){ @@ -18219,7 +25084,12 @@ public bool isPaused(string sfxsource){ return m_ts.fnSFXSource_isPaused(sfxsource); } /// -/// Test whether the source is currently playing. @return True if the source is in playing state, false otherwise. @see play @see getStatus @see SFXStatus ) +/// Test whether the source is currently playing. +/// @return True if the source is in playing state, false otherwise. +/// @see play +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool isPlaying(string sfxsource){ @@ -18227,7 +25097,12 @@ public bool isPlaying(string sfxsource){ return m_ts.fnSFXSource_isPlaying(sfxsource); } /// -/// Test whether the source is currently stopped. @return True if the source is in stopped state, false otherwise. @see stop @see getStatus @see SFXStatus ) +/// Test whether the source is currently stopped. +/// @return True if the source is in stopped state, false otherwise. +/// @see stop +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool isStopped(string sfxsource){ @@ -18235,7 +25110,13 @@ public bool isStopped(string sfxsource){ return m_ts.fnSFXSource_isStopped(sfxsource); } /// -/// Pause playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately to paused state but will rather remain in playing state until the fade-out time has expired.. ) +/// Pause playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately to paused state but will +/// rather remain in playing state until the fade-out time has expired.. ) +/// /// public void pause(string sfxsource, float fadeOutTime = -1.0f){ @@ -18243,7 +25124,13 @@ public void pause(string sfxsource, float fadeOutTime = -1.0f){ m_ts.fnSFXSource_pause(sfxsource, fadeOutTime); } /// -/// Start playback of the source. If the sound data for the source has not yet been fully loaded, there will be a delay after calling play and playback will start after the data has become available. @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime set in the source's associated description is used. Pass 0 to disable a fade-in effect that may be configured on the description. ) +/// Start playback of the source. +/// If the sound data for the source has not yet been fully loaded, there will be a delay after calling +/// play and playback will start after the data has become available. +/// @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime +/// set in the source's associated description is used. Pass 0 to disable a fade-in effect that may +/// be configured on the description. ) +/// /// public void play(string sfxsource, float fadeInTime = -1.0f){ @@ -18251,7 +25138,11 @@ public void play(string sfxsource, float fadeInTime = -1.0f){ m_ts.fnSFXSource_play(sfxsource, fadeInTime); } /// -/// Detach @a parameter from the source. Once detached, the source will no longer react to value changes of the given @a parameter. If the parameter is not attached to the source, the method will do nothing. @param parameter The parameter to detach from the source. ) +/// Detach @a parameter from the source. +/// Once detached, the source will no longer react to value changes of the given @a parameter. +/// If the parameter is not attached to the source, the method will do nothing. +/// @param parameter The parameter to detach from the source. ) +/// /// public void removeParameter(string sfxsource, string parameter){ @@ -18259,7 +25150,12 @@ public void removeParameter(string sfxsource, string parameter){ m_ts.fnSFXSource_removeParameter(sfxsource, parameter); } /// -/// Set up the 3D volume cone for the source. @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. @note This method has no effect on the source if the source is not 3D. ) +/// Set up the 3D volume cone for the source. +/// @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. +/// @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. +/// @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. +/// @note This method has no effect on the source if the source is not 3D. ) +/// /// public void setCone(string sfxsource, float innerAngle, float outerAngle, float outsideVolume){ @@ -18267,7 +25163,13 @@ public void setCone(string sfxsource, float innerAngle, float outerAngle, float m_ts.fnSFXSource_setCone(sfxsource, innerAngle, outerAngle, outsideVolume); } /// -/// Set the fade time parameters of the source. @param fadeInTime The new fade-in time in seconds. @param fadeOutTime The new fade-out time in seconds. @see SFXDescription::fadeInTime @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Set the fade time parameters of the source. +/// @param fadeInTime The new fade-in time in seconds. +/// @param fadeOutTime The new fade-out time in seconds. +/// @see SFXDescription::fadeInTime +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public void setFadeTimes(string sfxsource, float fadeInTime, float fadeOutTime){ @@ -18275,7 +25177,12 @@ public void setFadeTimes(string sfxsource, float fadeInTime, float fadeOutTime) m_ts.fnSFXSource_setFadeTimes(sfxsource, fadeInTime, fadeOutTime); } /// -/// Set the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @param pitch The new pitch scale factor. @see getPitch @see SFXDescription::pitch ) +/// Set the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @param pitch The new pitch scale factor. +/// @see getPitch +/// @see SFXDescription::pitch ) +/// /// public void setPitch(string sfxsource, float pitch){ @@ -18283,7 +25190,13 @@ public void setPitch(string sfxsource, float pitch){ m_ts.fnSFXSource_setPitch(sfxsource, pitch); } /// -/// Set the base volume level for the source. This volume will be the starting point for source group volume modulation, fades, and distance-based volume attenuation. @param volume The new base volume level for the source. Must be 0>=volume=1. @see getVolume @ref SFXSource_volume ) +/// Set the base volume level for the source. +/// This volume will be the starting point for source group volume modulation, fades, and distance-based +/// volume attenuation. +/// @param volume The new base volume level for the source. Must be 0>=volume=1. +/// @see getVolume +/// @ref SFXSource_volume ) +/// /// public void setVolume(string sfxsource, float volume){ @@ -18291,7 +25204,13 @@ public void setVolume(string sfxsource, float volume){ m_ts.fnSFXSource_setVolume(sfxsource, volume); } /// -/// Stop playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but will rather remain in playing state until the fade-out time has expired. ) +/// Stop playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but +/// will rather remain in playing state until the fade-out time has expired. ) +/// /// public void stop(string sfxsource, float fadeOutTime = -1.0f){ @@ -18304,14 +25223,12 @@ public void stop(string sfxsource, float fadeOutTime = -1.0f){ /// public class SFXStateObject { -private Omni m_ts; - /// - /// - /// - /// -public SFXStateObject(ref Omni ts){m_ts = ts;} /// -/// Increase the activation count on the state. If the state isn't already active and it is not disabled, the state will be activated. @see isActive @see deactivate ) +/// Increase the activation count on the state. +/// If the state isn't already active and it is not disabled, the state will be activated. +/// @see isActive +/// @see deactivate ) +/// /// public void activate(string sfxstate){ @@ -18319,7 +25236,11 @@ public void activate(string sfxstate){ m_ts.fnSFXState_activate(sfxstate); } /// -/// Decrease the activation count on the state. If the count reaches zero and the state was not disabled, the state will be deactivated. @see isActive @see activate ) +/// Decrease the activation count on the state. +/// If the count reaches zero and the state was not disabled, the state will be deactivated. +/// @see isActive +/// @see activate ) +/// /// public void deactivate(string sfxstate){ @@ -18327,7 +25248,10 @@ public void deactivate(string sfxstate){ m_ts.fnSFXState_deactivate(sfxstate); } /// -/// Increase the disabling count of the state. If the state is currently active, it will be deactivated. @see isDisabled ) +/// Increase the disabling count of the state. +/// If the state is currently active, it will be deactivated. +/// @see isDisabled ) +/// /// public void disable(string sfxstate){ @@ -18335,7 +25259,11 @@ public void disable(string sfxstate){ m_ts.fnSFXState_disable(sfxstate); } /// -/// Decrease the disabling count of the state. If the disabling count reaches zero while the activation count is still non-zero, the state will be reactivated again. @see isDisabled ) +/// Decrease the disabling count of the state. +/// If the disabling count reaches zero while the activation count is still non-zero, +/// the state will be reactivated again. +/// @see isDisabled ) +/// /// public void enable(string sfxstate){ @@ -18343,7 +25271,11 @@ public void enable(string sfxstate){ m_ts.fnSFXState_enable(sfxstate); } /// -/// Test whether the state is currently active. This is true when the activation count is >0 and the disabling count is =0. @return True if the state is currently active. @see activate ) +/// Test whether the state is currently active. +/// This is true when the activation count is >0 and the disabling count is =0. +/// @return True if the state is currently active. +/// @see activate ) +/// /// public bool isActive(string sfxstate){ @@ -18351,7 +25283,11 @@ public bool isActive(string sfxstate){ return m_ts.fnSFXState_isActive(sfxstate); } /// -/// Test whether the state is currently disabled. This is true when the disabling count of the state is non-zero. @return True if the state is disabled. @see disable ) +/// Test whether the state is currently disabled. +/// This is true when the disabling count of the state is non-zero. +/// @return True if the state is disabled. +/// @see disable ) +/// /// public bool isDisabled(string sfxstate){ @@ -18364,14 +25300,14 @@ public bool isDisabled(string sfxstate){ /// public class ShaderDataObject { -private Omni m_ts; - /// - /// - /// - /// -public ShaderDataObject(ref Omni ts){m_ts = ts;} /// -/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. @tsexample // Rebuild the shader instances from ShaderData CloudLayerShader CloudLayerShader.reload(); @endtsexample) +/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. +/// +/// @tsexample +/// // Rebuild the shader instances from ShaderData CloudLayerShader +/// CloudLayerShader.reload(); +/// @endtsexample) +/// /// public void reload(string shaderdata){ @@ -18384,14 +25320,11 @@ public void reload(string shaderdata){ /// public class ShapeBaseObject { -private Omni m_ts; - /// - /// - /// - /// -public ShapeBaseObject(ref Omni ts){m_ts = ts;} /// -/// @brief Increment the current damage level by the specified amount. @param amount value to add to current damage level ) +/// @brief Increment the current damage level by the specified amount. +/// +/// @param amount value to add to current damage level ) +/// /// public void applyDamage(string shapebase, float amount){ @@ -18399,7 +25332,12 @@ public void applyDamage(string shapebase, float amount){ m_ts.fnShapeBase_applyDamage(shapebase, amount); } /// -/// @brief Apply an impulse to the object. @param pos world position of the impulse @param vec impulse momentum (velocity * mass) @return true ) +/// @brief Apply an impulse to the object. +/// +/// @param pos world position of the impulse +/// @param vec impulse momentum (velocity * mass) +/// @return true ) +/// /// public bool applyImpulse(string shapebase, Point3F pos, Point3F vec){ @@ -18407,7 +25345,13 @@ public bool applyImpulse(string shapebase, Point3F pos, Point3F vec){ return m_ts.fnShapeBase_applyImpulse(shapebase, pos.AsString(), vec.AsString()); } /// -/// @brief Repair damage by the specified amount. Note that the damage level is only reduced by repairRate per tick, so it may take several ticks for the total repair to complete. @param amount total repair value (subtracted from damage level over time) ) +/// @brief Repair damage by the specified amount. +/// +/// Note that the damage level is only reduced by repairRate per tick, so it may +/// take several ticks for the total repair to complete. +/// +/// @param amount total repair value (subtracted from damage level over time) ) +/// /// public void applyRepair(string shapebase, float amount){ @@ -18416,6 +25360,7 @@ public void applyRepair(string shapebase, float amount){ } /// /// @brief Explodes an object into pieces.) +/// /// public void blowUp(string shapebase){ @@ -18423,7 +25368,11 @@ public void blowUp(string shapebase){ m_ts.fnShapeBase_blowUp(shapebase); } /// -/// @brief Check if this object can cloak. @return true @note Not implemented as it always returns true.) +/// @brief Check if this object can cloak. +/// @return true +/// +/// @note Not implemented as it always returns true.) +/// /// public bool canCloak(string shapebase){ @@ -18431,7 +25380,24 @@ public bool canCloak(string shapebase){ return m_ts.fnShapeBase_canCloak(shapebase); } /// -/// @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void changeMaterial(string shapebase, string mapTo, string oldMat, string newMat){ @@ -18439,7 +25405,13 @@ public void changeMaterial(string shapebase, string mapTo, string oldMat, strin m_ts.fnShapeBase_changeMaterial(shapebase, mapTo, oldMat, newMat); } /// -/// @brief Destroy an animation thread, which prevents it from playing. @param slot thread slot to destroy @return true if successful, false if failed @see playThread ) +/// @brief Destroy an animation thread, which prevents it from playing. +/// +/// @param slot thread slot to destroy +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool destroyThread(string shapebase, int slot){ @@ -18447,7 +25419,10 @@ public bool destroyThread(string shapebase, int slot){ return m_ts.fnShapeBase_destroyThread(shapebase, slot); } /// -/// @brief Print a list of visible and hidden meshes in the shape to the console for debugging purposes. @note Only in a SHIPPING build.) +/// @brief Print a list of visible and hidden meshes in the shape to the console +/// for debugging purposes. +/// @note Only in a SHIPPING build.) +/// /// public void dumpMeshVisibility(string shapebase){ @@ -18455,7 +25430,12 @@ public void dumpMeshVisibility(string shapebase){ m_ts.fnShapeBase_dumpMeshVisibility(shapebase); } /// -/// @brief Get the position at which the AI should stand to repair things. If the shape defines a node called \"AIRepairNode\", this method will return the current world position of that node, otherwise \"0 0 0\". @return the AI repair position ) +/// @brief Get the position at which the AI should stand to repair things. +/// +/// If the shape defines a node called \"AIRepairNode\", this method will +/// return the current world position of that node, otherwise \"0 0 0\". +/// @return the AI repair position ) +/// /// public Point3F getAIRepairPoint(string shapebase){ @@ -18463,7 +25443,10 @@ public Point3F getAIRepairPoint(string shapebase){ return new Point3F ( m_ts.fnShapeBase_getAIRepairPoint(shapebase)); } /// -/// @brief Returns the vertical field of view in degrees for this object if used as a camera. @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// @brief Returns the vertical field of view in degrees for this object if used as a camera. +/// +/// @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// /// public float getCameraFov(string shapebase){ @@ -18471,7 +25454,15 @@ public float getCameraFov(string shapebase){ return m_ts.fnShapeBase_getCameraFov(shapebase); } /// -/// @brief Get the client (if any) that controls this object. The controlling client is the one that will send moves to us to act on. @return the ID of the controlling GameConnection, or 0 if this object is not controlled by any client. @see GameConnection) +/// @brief Get the client (if any) that controls this object. +/// +/// The controlling client is the one that will send moves to us to act on. +/// +/// @return the ID of the controlling GameConnection, or 0 if this object is not +/// controlled by any client. +/// +/// @see GameConnection) +/// /// public int getControllingClient(string shapebase){ @@ -18479,7 +25470,11 @@ public int getControllingClient(string shapebase){ return m_ts.fnShapeBase_getControllingClient(shapebase); } /// -/// @brief Get the object (if any) that controls this object. @return the ID of the controlling ShapeBase object, or 0 if this object is not controlled by another object. ) +/// @brief Get the object (if any) that controls this object. +/// +/// @return the ID of the controlling ShapeBase object, or 0 if this object is +/// not controlled by another object. ) +/// /// public int getControllingObject(string shapebase){ @@ -18487,7 +25482,12 @@ public int getControllingObject(string shapebase){ return m_ts.fnShapeBase_getControllingObject(shapebase); } /// -/// @brief Get the damage flash level. @return flash level @see setDamageFlash ) +/// @brief Get the damage flash level. +/// +/// @return flash level +/// +/// @see setDamageFlash ) +/// /// public float getDamageFlash(string shapebase){ @@ -18495,7 +25495,12 @@ public float getDamageFlash(string shapebase){ return m_ts.fnShapeBase_getDamageFlash(shapebase); } /// -/// @brief Get the object's current damage level. @return damage level @see setDamageLevel()) +/// @brief Get the object's current damage level. +/// +/// @return damage level +/// +/// @see setDamageLevel()) +/// /// public float getDamageLevel(string shapebase){ @@ -18503,7 +25508,12 @@ public float getDamageLevel(string shapebase){ return m_ts.fnShapeBase_getDamageLevel(shapebase); } /// -/// @brief Get the object's current damage level as a percentage of maxDamage. @return damageLevel / datablock.maxDamage @see setDamageLevel()) +/// @brief Get the object's current damage level as a percentage of maxDamage. +/// +/// @return damageLevel / datablock.maxDamage +/// +/// @see setDamageLevel()) +/// /// public float getDamagePercent(string shapebase){ @@ -18511,7 +25521,12 @@ public float getDamagePercent(string shapebase){ return m_ts.fnShapeBase_getDamagePercent(shapebase); } /// -/// @brief Get the object's damage state. @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" @see setDamageState()) +/// @brief Get the object's damage state. +/// +/// @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// +/// @see setDamageState()) +/// /// public string getDamageState(string shapebase){ @@ -18519,7 +25534,10 @@ public string getDamageState(string shapebase){ return m_ts.fnShapeBase_getDamageState(shapebase); } /// -/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. @return Default FOV ) +/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. +/// +/// @return Default FOV ) +/// /// public float getDefaultCameraFov(string shapebase){ @@ -18527,7 +25545,12 @@ public float getDefaultCameraFov(string shapebase){ return m_ts.fnShapeBase_getDefaultCameraFov(shapebase); } /// -/// @brief Get the object's current energy level. @return energy level @see setEnergyLevel()) +/// @brief Get the object's current energy level. +/// +/// @return energy level +/// +/// @see setEnergyLevel()) +/// /// public float getEnergyLevel(string shapebase){ @@ -18535,7 +25558,11 @@ public float getEnergyLevel(string shapebase){ return m_ts.fnShapeBase_getEnergyLevel(shapebase); } /// -/// @brief Get the object's current energy level as a percentage of maxEnergy. @return energyLevel / datablock.maxEnergy @see setEnergyLevel()) +/// @brief Get the object's current energy level as a percentage of maxEnergy. +/// @return energyLevel / datablock.maxEnergy +/// +/// @see setEnergyLevel()) +/// /// public float getEnergyPercent(string shapebase){ @@ -18543,7 +25570,17 @@ public float getEnergyPercent(string shapebase){ return m_ts.fnShapeBase_getEnergyPercent(shapebase); } /// -/// @brief Get the position of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current world position, otherwise it will return the object's current world position. @return the eye position for this object @see getEyeVector @see getEyeTransform ) +/// @brief Get the position of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current world position, otherwise it will return the object's current +/// world position. +/// +/// @return the eye position for this object +/// +/// @see getEyeVector +/// @see getEyeTransform ) +/// /// public Point3F getEyePoint(string shapebase){ @@ -18551,7 +25588,17 @@ public Point3F getEyePoint(string shapebase){ return new Point3F ( m_ts.fnShapeBase_getEyePoint(shapebase)); } /// -/// @brief Get the 'eye' transform for this object. If the object model has a node called 'eye', this method will return that node's current transform, otherwise it will return the object's current transform. @return the eye transform for this object @see getEyeVector @see getEyePoint ) +/// @brief Get the 'eye' transform for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current transform, otherwise it will return the object's current +/// transform. +/// +/// @return the eye transform for this object +/// +/// @see getEyeVector +/// @see getEyePoint ) +/// /// public TransformF getEyeTransform(string shapebase){ @@ -18559,7 +25606,17 @@ public TransformF getEyeTransform(string shapebase){ return new TransformF ( m_ts.fnShapeBase_getEyeTransform(shapebase)); } /// -/// @brief Get the forward direction of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current forward direction vector, otherwise it will return the object's current forward direction vector. @return the eye vector for this object @see getEyePoint @see getEyeTransform ) +/// @brief Get the forward direction of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current forward direction vector, otherwise it will return the +/// object's current forward direction vector. +/// +/// @return the eye vector for this object +/// +/// @see getEyePoint +/// @see getEyeTransform ) +/// /// public Point3F getEyeVector(string shapebase){ @@ -18567,7 +25624,11 @@ public Point3F getEyeVector(string shapebase){ return new Point3F ( m_ts.fnShapeBase_getEyeVector(shapebase)); } /// -/// @brief Get the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current alt trigger state ) +/// @brief Get the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current alt trigger state ) +/// /// public bool getImageAltTrigger(string shapebase, int slot){ @@ -18575,7 +25636,11 @@ public bool getImageAltTrigger(string shapebase, int slot){ return m_ts.fnShapeBase_getImageAltTrigger(shapebase, slot); } /// -/// @brief Get the ammo state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current ammo state ) +/// @brief Get the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current ammo state ) +/// /// public bool getImageAmmo(string shapebase, int slot){ @@ -18583,7 +25648,12 @@ public bool getImageAmmo(string shapebase, int slot){ return m_ts.fnShapeBase_getImageAmmo(shapebase, slot); } /// -/// @brief Get the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to query @param trigger Generic trigger number @return the Image's current generic trigger state ) +/// @brief Get the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @param trigger Generic trigger number +/// @return the Image's current generic trigger state ) +/// /// public bool getImageGenericTrigger(string shapebase, int slot, int trigger){ @@ -18591,7 +25661,11 @@ public bool getImageGenericTrigger(string shapebase, int slot, int trigger){ return m_ts.fnShapeBase_getImageGenericTrigger(shapebase, slot, trigger); } /// -/// @brief Get the loaded state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current loaded state ) +/// @brief Get the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current loaded state ) +/// /// public bool getImageLoaded(string shapebase, int slot){ @@ -18599,7 +25673,11 @@ public bool getImageLoaded(string shapebase, int slot){ return m_ts.fnShapeBase_getImageLoaded(shapebase, slot); } /// -/// @brief Get the script animation prefix of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current script animation prefix ) +/// @brief Get the script animation prefix of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current script animation prefix ) +/// /// public string getImageScriptAnimPrefix(string shapebase, int slot){ @@ -18607,7 +25685,12 @@ public string getImageScriptAnimPrefix(string shapebase, int slot){ return m_ts.fnShapeBase_getImageScriptAnimPrefix(shapebase, slot); } /// -/// @brief Get the skin tag ID for the Image mounted in the specified slot. @param slot Image slot to query @return the skinTag value passed to mountImage when the image was mounted ) +/// @brief Get the skin tag ID for the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the skinTag value passed to mountImage when the image was +/// mounted ) +/// /// public int getImageSkinTag(string shapebase, int slot){ @@ -18615,7 +25698,11 @@ public int getImageSkinTag(string shapebase, int slot){ return m_ts.fnShapeBase_getImageSkinTag(shapebase, slot); } /// -/// @brief Get the name of the current state of the Image in the specified slot. @param slot Image slot to query @return name of the current Image state, or \"Error\" if slot is invalid ) +/// @brief Get the name of the current state of the Image in the specified slot. +/// +/// @param slot Image slot to query +/// @return name of the current Image state, or \"Error\" if slot is invalid ) +/// /// public string getImageState(string shapebase, int slot){ @@ -18623,7 +25710,11 @@ public string getImageState(string shapebase, int slot){ return m_ts.fnShapeBase_getImageState(shapebase, slot); } /// -/// @brief Get the target state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current target state ) +/// @brief Get the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current target state ) +/// /// public bool getImageTarget(string shapebase, int slot){ @@ -18631,7 +25722,11 @@ public bool getImageTarget(string shapebase, int slot){ return m_ts.fnShapeBase_getImageTarget(shapebase, slot); } /// -/// @brief Get the trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current trigger state ) +/// @brief Get the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current trigger state ) +/// /// public bool getImageTrigger(string shapebase, int slot){ @@ -18639,7 +25734,19 @@ public bool getImageTrigger(string shapebase, int slot){ return m_ts.fnShapeBase_getImageTrigger(shapebase, slot); } /// -/// @brief Get the world position this object is looking at. Casts a ray from the eye and returns information about what the ray hits. @param distance maximum distance of the raycast @param typeMask typeMask of objects to include for raycast collision testing @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit @tsexample %lookat = %obj.getLookAtPoint(); echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); @endtsexample ) +/// @brief Get the world position this object is looking at. +/// +/// Casts a ray from the eye and returns information about what the ray hits. +/// +/// @param distance maximum distance of the raycast +/// @param typeMask typeMask of objects to include for raycast collision testing +/// @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit +/// +/// @tsexample +/// %lookat = %obj.getLookAtPoint(); +/// echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); +/// @endtsexample ) +/// /// public string getLookAtPoint(string shapebase, float distance = 2000, uint typeMask = 0xFFFFFFFF){ @@ -18647,7 +25754,9 @@ public string getLookAtPoint(string shapebase, float distance = 2000, uint type return m_ts.fnShapeBase_getLookAtPoint(shapebase, distance, typeMask); } /// -/// Get the object's maxDamage level. @return datablock.maxDamage) +/// Get the object's maxDamage level. +/// @return datablock.maxDamage) +/// /// public float getMaxDamage(string shapebase){ @@ -18655,7 +25764,10 @@ public float getMaxDamage(string shapebase){ return m_ts.fnShapeBase_getMaxDamage(shapebase); } /// -/// @brief Get the model filename used by this shape. @return the shape filename ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename ) +/// /// public string getModelFile(string shapebase){ @@ -18663,7 +25775,12 @@ public string getModelFile(string shapebase){ return m_ts.fnShapeBase_getModelFile(shapebase); } /// -/// @brief Get the Image mounted in the specified slot. @param slot Image slot to query @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 if no Image is mounted there. ) +/// @brief Get the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 +/// if no Image is mounted there. ) +/// /// public int getMountedImage(string shapebase, int slot){ @@ -18671,7 +25788,13 @@ public int getMountedImage(string shapebase, int slot){ return m_ts.fnShapeBase_getMountedImage(shapebase, slot); } /// -/// @brief Get the first slot the given datablock is mounted to on this object. @param image ShapeBaseImageData datablock to query @return index of the first slot the Image is mounted in, or -1 if the Image is not mounted in any slot on this object. ) +/// @brief Get the first slot the given datablock is mounted to on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return index of the first slot the Image is mounted in, or -1 if the Image +/// is not mounted in any slot on this object. ) +/// +/// /// public int getMountSlot(string shapebase, string image){ @@ -18679,7 +25802,15 @@ public int getMountSlot(string shapebase, string image){ return m_ts.fnShapeBase_getMountSlot(shapebase, image); } /// -/// @brief Get the muzzle position of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle position is the position of that node in world space. If no such node is specified, the slot's mount node is used instead. @param slot Image slot to query @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// @brief Get the muzzle position of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// position is the position of that node in world space. If no such node +/// is specified, the slot's mount node is used instead. +/// +/// @param slot Image slot to query +/// @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// /// public Point3F getMuzzlePoint(string shapebase, int slot){ @@ -18687,7 +25818,20 @@ public Point3F getMuzzlePoint(string shapebase, int slot){ return new Point3F ( m_ts.fnShapeBase_getMuzzlePoint(shapebase, slot)); } /// -/// @brief Get the muzzle vector of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle vector is the forward direction vector of that node's transform in world space. If no such node is specified, the slot's mount node is used instead. If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) is set in the Image, the muzzle vector is computed to point at whatever object is right in front of the object's 'eye' node. @param slot Image slot to query @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// @brief Get the muzzle vector of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// vector is the forward direction vector of that node's transform in world +/// space. If no such node is specified, the slot's mount node is used +/// instead. +/// +/// If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) +/// is set in the Image, the muzzle vector is computed to point at whatever +/// object is right in front of the object's 'eye' node. +/// +/// @param slot Image slot to query +/// @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// /// public Point3F getMuzzleVector(string shapebase, int slot){ @@ -18695,7 +25839,20 @@ public Point3F getMuzzleVector(string shapebase, int slot){ return new Point3F ( m_ts.fnShapeBase_getMuzzleVector(shapebase, slot)); } /// -/// @brief Get the Image that will be mounted next in the specified slot. Calling mountImage when an Image is already mounted does one of two things: ol>li>Mount the new Image immediately, the old Image is discarded and whatever state it was in is ignored./li> li>If the current Image state does not allow Image changes, the new Image is marked as pending, and will not be mounted until the current state completes. eg. if the user changes weapons, you may wish to ensure that the current weapon firing state plays to completion first./li>/ol> This command retrieves the ID of the pending Image (2nd case above). @param slot Image slot to query @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// @brief Get the Image that will be mounted next in the specified slot. +/// +/// Calling mountImage when an Image is already mounted does one of two things: +/// ol>li>Mount the new Image immediately, the old Image is discarded and +/// whatever state it was in is ignored./li> +/// li>If the current Image state does not allow Image changes, the new +/// Image is marked as pending, and will not be mounted until the current +/// state completes. eg. if the user changes weapons, you may wish to ensure +/// that the current weapon firing state plays to completion first./li>/ol> +/// This command retrieves the ID of the pending Image (2nd case above). +/// +/// @param slot Image slot to query +/// @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// /// public int getPendingImage(string shapebase, int slot){ @@ -18703,7 +25860,12 @@ public int getPendingImage(string shapebase, int slot){ return m_ts.fnShapeBase_getPendingImage(shapebase, slot); } /// -/// @brief Get the current recharge rate. @return the recharge rate (per tick) @see setRechargeRate()) +/// @brief Get the current recharge rate. +/// +/// @return the recharge rate (per tick) +/// +/// @see setRechargeRate()) +/// /// public float getRechargeRate(string shapebase){ @@ -18711,7 +25873,12 @@ public float getRechargeRate(string shapebase){ return m_ts.fnShapeBase_getRechargeRate(shapebase); } /// -/// @brief Get the per-tick repair amount. @return the current value to be subtracted from damage level each tick @see setRepairRate ) +/// @brief Get the per-tick repair amount. +/// +/// @return the current value to be subtracted from damage level each tick +/// +/// @see setRepairRate ) +/// /// public float getRepairRate(string shapebase){ @@ -18719,7 +25886,15 @@ public float getRepairRate(string shapebase){ return m_ts.fnShapeBase_getRepairRate(shapebase); } /// -/// @brief Get the name of the shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @return the name of the shape @see setShapeName()) +/// @brief Get the name of the shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @return the name of the shape +/// +/// @see setShapeName()) +/// /// public string getShapeName(string shapebase){ @@ -18727,7 +25902,13 @@ public string getShapeName(string shapebase){ return m_ts.fnShapeBase_getShapeName(shapebase); } /// -/// @brief Get the name of the skin applied to this shape. @return the name of the skin @see skin @see setSkinName()) +/// @brief Get the name of the skin applied to this shape. +/// +/// @return the name of the skin +/// +/// @see skin +/// @see setSkinName()) +/// /// public string getSkinName(string shapebase){ @@ -18735,7 +25916,11 @@ public string getSkinName(string shapebase){ return m_ts.fnShapeBase_getSkinName(shapebase); } /// -/// @brief Get the world transform of the specified mount slot. @param slot Image slot to query @return the mount transform ) +/// @brief Get the world transform of the specified mount slot. +/// +/// @param slot Image slot to query +/// @return the mount transform ) +/// /// public TransformF getSlotTransform(string shapebase, int slot){ @@ -18743,7 +25928,12 @@ public TransformF getSlotTransform(string shapebase, int slot){ return new TransformF ( m_ts.fnShapeBase_getSlotTransform(shapebase, slot)); } /// -/// @brief Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// @brief Get the number of materials in the shape. +/// +/// @return the number of materials in the shape. +/// +/// @see getTargetName()) +/// /// public int getTargetCount(string shapebase){ @@ -18751,7 +25941,13 @@ public int getTargetCount(string shapebase){ return m_ts.fnShapeBase_getTargetCount(shapebase); } /// -/// @brief Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// @brief Get the name of the indexed shape material. +/// +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// +/// @see getTargetCount()) +/// /// public string getTargetName(string shapebase, int index){ @@ -18759,7 +25955,10 @@ public string getTargetName(string shapebase, int index){ return m_ts.fnShapeBase_getTargetName(shapebase, index); } /// -/// @brief Get the object's current velocity. @return the current velocity ) +/// @brief Get the object's current velocity. +/// +/// @return the current velocity ) +/// /// public Point3F getVelocity(string shapebase){ @@ -18767,7 +25966,12 @@ public Point3F getVelocity(string shapebase){ return new Point3F ( m_ts.fnShapeBase_getVelocity(shapebase)); } /// -/// @brief Get the white-out level. @return white-out level @see setWhiteOut ) +/// @brief Get the white-out level. +/// +/// @return white-out level +/// +/// @see setWhiteOut ) +/// /// public float getWhiteOut(string shapebase){ @@ -18775,7 +25979,12 @@ public float getWhiteOut(string shapebase){ return m_ts.fnShapeBase_getWhiteOut(shapebase); } /// -/// @brief Check if the given state exists on the mounted Image. @param slot Image slot to query @param state Image state to check for @return true if the Image has the requested state defined. ) +/// @brief Check if the given state exists on the mounted Image. +/// +/// @param slot Image slot to query +/// @param state Image state to check for +/// @return true if the Image has the requested state defined. ) +/// /// public bool hasImageState(string shapebase, int slot, string state){ @@ -18783,7 +25992,12 @@ public bool hasImageState(string shapebase, int slot, string state){ return m_ts.fnShapeBase_hasImageState(shapebase, slot, state); } /// -/// @brief Check if this object is cloaked. @return true if cloaked, false if not @see setCloaked()) +/// @brief Check if this object is cloaked. +/// +/// @return true if cloaked, false if not +/// +/// @see setCloaked()) +/// /// public bool isCloaked(string shapebase){ @@ -18791,7 +26005,13 @@ public bool isCloaked(string shapebase){ return m_ts.fnShapeBase_isCloaked(shapebase); } /// -/// @brief Check if the object is in the Destroyed damage state. @return true if damage state is \"Destroyed\", false if not @see isDisabled() @see isEnabled()) +/// @brief Check if the object is in the Destroyed damage state. +/// +/// @return true if damage state is \"Destroyed\", false if not +/// +/// @see isDisabled() +/// @see isEnabled()) +/// /// public bool isDestroyed(string shapebase){ @@ -18799,7 +26019,13 @@ public bool isDestroyed(string shapebase){ return m_ts.fnShapeBase_isDestroyed(shapebase); } /// -/// @brief Check if the object is in the Disabled or Destroyed damage state. @return true if damage state is not \"Enabled\", false if it is @see isDestroyed() @see isEnabled()) +/// @brief Check if the object is in the Disabled or Destroyed damage state. +/// +/// @return true if damage state is not \"Enabled\", false if it is +/// +/// @see isDestroyed() +/// @see isEnabled()) +/// /// public bool isDisabled(string shapebase){ @@ -18807,7 +26033,13 @@ public bool isDisabled(string shapebase){ return m_ts.fnShapeBase_isDisabled(shapebase); } /// -/// @brief Check if the object is in the Enabled damage state. @return true if damage state is \"Enabled\", false if not @see isDestroyed() @see isDisabled()) +/// @brief Check if the object is in the Enabled damage state. +/// +/// @return true if damage state is \"Enabled\", false if not +/// +/// @see isDestroyed() +/// @see isDisabled()) +/// /// public bool isEnabled(string shapebase){ @@ -18815,7 +26047,9 @@ public bool isEnabled(string shapebase){ return m_ts.fnShapeBase_isEnabled(shapebase); } /// -/// Check if the object is hidden. @return true if the object is hidden, false if visible. ) +/// Check if the object is hidden. +/// @return true if the object is hidden, false if visible. ) +/// /// public bool isHidden(string shapebase){ @@ -18823,7 +26057,11 @@ public bool isHidden(string shapebase){ return m_ts.fnShapeBase_isHidden(shapebase); } /// -/// @brief Check if the current Image state is firing. @param slot Image slot to query @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// @brief Check if the current Image state is firing. +/// +/// @param slot Image slot to query +/// @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// /// public bool isImageFiring(string shapebase, int slot){ @@ -18831,7 +26069,11 @@ public bool isImageFiring(string shapebase, int slot){ return m_ts.fnShapeBase_isImageFiring(shapebase, slot); } /// -/// @brief Check if the given datablock is mounted to any slot on this object. @param image ShapeBaseImageData datablock to query @return true if the Image is mounted to any slot, false otherwise. ) +/// @brief Check if the given datablock is mounted to any slot on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return true if the Image is mounted to any slot, false otherwise. ) +/// /// public bool isImageMounted(string shapebase, string image){ @@ -18839,7 +26081,26 @@ public bool isImageMounted(string shapebase, string image){ return m_ts.fnShapeBase_isImageMounted(shapebase, image); } /// -/// ), @brief Mount a new Image. @param image the Image to mount @param slot Image slot to mount into (valid range is 0 - 3) @param loaded initial loaded state for the Image @param skinTag tagged string to reskin the mounted Image @return true if successful, false if failed @tsexample %player.mountImage( PistolImage, 1 ); %player.mountImage( CrossbowImage, 0, false ); %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); @endtsexample @see unmountImage() @see getMountedImage() @see getPendingImage() @see isImageMounted()) +/// ), +/// @brief Mount a new Image. +/// +/// @param image the Image to mount +/// @param slot Image slot to mount into (valid range is 0 - 3) +/// @param loaded initial loaded state for the Image +/// @param skinTag tagged string to reskin the mounted Image +/// @return true if successful, false if failed +/// +/// @tsexample +/// %player.mountImage( PistolImage, 1 ); +/// %player.mountImage( CrossbowImage, 0, false ); +/// %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); +/// @endtsexample +/// +/// @see unmountImage() +/// @see getMountedImage() +/// @see getPendingImage() +/// @see isImageMounted()) +/// /// public bool mountImage(string shapebase, string image, int slot, bool loaded = true, string skinTag = ""){ @@ -18847,7 +26108,15 @@ public bool mountImage(string shapebase, string image, int slot, bool loaded = return m_ts.fnShapeBase_mountImage(shapebase, image, slot, loaded, skinTag); } /// -/// @brief Pause an animation thread. If restarted using playThread, the animation will resume from the paused position. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Pause an animation thread. +/// +/// If restarted using playThread, the animation +/// will resume from the paused position. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool pauseThread(string shapebase, int slot){ @@ -18855,7 +26124,13 @@ public bool pauseThread(string shapebase, int slot){ return m_ts.fnShapeBase_pauseThread(shapebase, slot); } /// -/// @brief Attach a sound to this shape and start playing it. @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play @return true if the sound was attached successfully, false if failed @see stopAudio()) +/// @brief Attach a sound to this shape and start playing it. +/// +/// @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play +/// @return true if the sound was attached successfully, false if failed +/// +/// @see stopAudio()) +/// /// public bool playAudio(string shapebase, int slot, string track){ @@ -18863,7 +26138,28 @@ public bool playAudio(string shapebase, int slot, string track){ return m_ts.fnShapeBase_playAudio(shapebase, slot, track); } /// -/// ), @brief Start a new animation thread, or restart one that has been paused or stopped. @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not specified, the paused or stopped thread in this slot will be resumed. @return true if successful, false if failed @tsexample %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed %obj.pauseThread( 0 ); // Pause the sequence %obj.playThread( 0 ); // Resume playback %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 @endtsexample @see pauseThread() @see stopThread() @see setThreadDir() @see setThreadTimeScale() @see destroyThread()) +/// ), +/// @brief Start a new animation thread, or restart one that has been paused or +/// stopped. +/// +/// @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not +/// specified, the paused or stopped thread in this slot will be resumed. +/// @return true if successful, false if failed +/// +/// @tsexample +/// %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 +/// %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed +/// %obj.pauseThread( 0 ); // Pause the sequence +/// %obj.playThread( 0 ); // Resume playback +/// %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 +/// @endtsexample +/// +/// @see pauseThread() +/// @see stopThread() +/// @see setThreadDir() +/// @see setThreadTimeScale() +/// @see destroyThread()) +/// /// public bool playThread(string shapebase, int slot, string name = ""){ @@ -18871,7 +26167,13 @@ public bool playThread(string shapebase, int slot, string name = ""){ return m_ts.fnShapeBase_playThread(shapebase, slot, name); } /// -/// @brief Set the hidden state on all the shape meshes. This allows you to hide all meshes in the shape, for example, and then only enable a few. @param hide new hidden state for all meshes ) +/// @brief Set the hidden state on all the shape meshes. +/// +/// This allows you to hide all meshes in the shape, for example, and then only +/// enable a few. +/// +/// @param hide new hidden state for all meshes ) +/// /// public void setAllMeshesHidden(string shapebase, bool hide){ @@ -18879,7 +26181,10 @@ public void setAllMeshesHidden(string shapebase, bool hide){ m_ts.fnShapeBase_setAllMeshesHidden(shapebase, hide); } /// -/// @brief Set the vertical field of view in degrees for this object if used as a camera. @param fov new FOV value ) +/// @brief Set the vertical field of view in degrees for this object if used as a camera. +/// +/// @param fov new FOV value ) +/// /// public void setCameraFov(string shapebase, float fov){ @@ -18887,7 +26192,14 @@ public void setCameraFov(string shapebase, float fov){ m_ts.fnShapeBase_setCameraFov(shapebase, fov); } /// -/// @brief Set the cloaked state of this object. When an object is cloaked it is not rendered. @param cloak true to cloak the object, false to uncloak @see isCloaked()) +/// @brief Set the cloaked state of this object. +/// +/// When an object is cloaked it is not rendered. +/// +/// @param cloak true to cloak the object, false to uncloak +/// +/// @see isCloaked()) +/// /// public void setCloaked(string shapebase, bool cloak){ @@ -18895,7 +26207,17 @@ public void setCloaked(string shapebase, bool cloak){ m_ts.fnShapeBase_setCloaked(shapebase, cloak); } /// -/// @brief Set the damage flash level. Damage flash may be used as a postfx effect to flash the screen when the client is damaged. @note Relies on the flash postFx. @param level flash level (0-1) @see getDamageFlash()) +/// @brief Set the damage flash level. +/// +/// Damage flash may be used as a postfx effect to flash the screen when the +/// client is damaged. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getDamageFlash()) +/// /// public void setDamageFlash(string shapebase, float level){ @@ -18903,7 +26225,13 @@ public void setDamageFlash(string shapebase, float level){ m_ts.fnShapeBase_setDamageFlash(shapebase, level); } /// -/// @brief Set the object's current damage level. @param level new damage level @see getDamageLevel() @see getDamagePercent()) +/// @brief Set the object's current damage level. +/// +/// @param level new damage level +/// +/// @see getDamageLevel() +/// @see getDamagePercent()) +/// /// public void setDamageLevel(string shapebase, float level){ @@ -18911,7 +26239,13 @@ public void setDamageLevel(string shapebase, float level){ m_ts.fnShapeBase_setDamageLevel(shapebase, level); } /// -/// @brief Set the object's damage state. @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" @return true if successful, false if failed @see getDamageState()) +/// @brief Set the object's damage state. +/// +/// @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// @return true if successful, false if failed +/// +/// @see getDamageState()) +/// /// public bool setDamageState(string shapebase, string state){ @@ -18919,7 +26253,17 @@ public bool setDamageState(string shapebase, string state){ return m_ts.fnShapeBase_setDamageState(shapebase, state); } /// -/// @brief Set the damage direction vector. Currently this is only used to initialise the explosion if this object is blown up. @param vec damage direction vector @tsexample %obj.setDamageVector( \"0 0 1\" ); @endtsexample ) +/// @brief Set the damage direction vector. +/// +/// Currently this is only used to initialise the explosion if this object +/// is blown up. +/// +/// @param vec damage direction vector +/// +/// @tsexample +/// %obj.setDamageVector( \"0 0 1\" ); +/// @endtsexample ) +/// /// public void setDamageVector(string shapebase, Point3F vec){ @@ -18927,7 +26271,13 @@ public void setDamageVector(string shapebase, Point3F vec){ m_ts.fnShapeBase_setDamageVector(shapebase, vec.AsString()); } /// -/// @brief Set this object's current energy level. @param level new energy level @see getEnergyLevel() @see getEnergyPercent()) +/// @brief Set this object's current energy level. +/// +/// @param level new energy level +/// +/// @see getEnergyLevel() +/// @see getEnergyPercent()) +/// /// public void setEnergyLevel(string shapebase, float level){ @@ -18935,7 +26285,10 @@ public void setEnergyLevel(string shapebase, float level){ m_ts.fnShapeBase_setEnergyLevel(shapebase, level); } /// -/// @brief Add or remove this object from the scene. When removed from the scene, the object will not be processed or rendered. @param show False to hide the object, true to re-show it ) +/// @brief Add or remove this object from the scene. +/// When removed from the scene, the object will not be processed or rendered. +/// @param show False to hide the object, true to re-show it ) +/// /// public void setHidden(string shapebase, bool show){ @@ -18943,7 +26296,12 @@ public void setHidden(string shapebase, bool show){ m_ts.fnShapeBase_setHidden(shapebase, show); } /// -/// @brief Set the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new alt trigger state for the Image @return the Image's new alt trigger state ) +/// @brief Set the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new alt trigger state for the Image +/// @return the Image's new alt trigger state ) +/// /// public bool setImageAltTrigger(string shapebase, int slot, bool state){ @@ -18951,7 +26309,12 @@ public bool setImageAltTrigger(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageAltTrigger(shapebase, slot, state); } /// -/// @brief Set the ammo state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new ammo state for the Image @return the Image's new ammo state ) +/// @brief Set the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new ammo state for the Image +/// @return the Image's new ammo state ) +/// /// public bool setImageAmmo(string shapebase, int slot, bool state){ @@ -18959,7 +26322,13 @@ public bool setImageAmmo(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageAmmo(shapebase, slot, state); } /// -/// @brief Set the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param trigger Generic trigger number @param state new generic trigger state for the Image @return the Image's new generic trigger state or -1 if there was a problem. ) +/// @brief Set the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param trigger Generic trigger number +/// @param state new generic trigger state for the Image +/// @return the Image's new generic trigger state or -1 if there was a problem. ) +/// /// public int setImageGenericTrigger(string shapebase, int slot, int trigger, bool state){ @@ -18967,7 +26336,12 @@ public int setImageGenericTrigger(string shapebase, int slot, int trigger, bool return m_ts.fnShapeBase_setImageGenericTrigger(shapebase, slot, trigger, state); } /// -/// @brief Set the loaded state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new loaded state for the Image @return the Image's new loaded state ) +/// @brief Set the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new loaded state for the Image +/// @return the Image's new loaded state ) +/// /// public bool setImageLoaded(string shapebase, int slot, bool state){ @@ -18975,7 +26349,13 @@ public bool setImageLoaded(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageLoaded(shapebase, slot, state); } /// -/// @brief Set the script animation prefix for the Image mounted in the specified slot. This is used to further modify the prefix used when deciding which animation sequence to play while this image is mounted. @param slot Image slot to modify @param prefix The prefix applied to the image ) +/// @brief Set the script animation prefix for the Image mounted in the specified slot. +/// This is used to further modify the prefix used when deciding which animation sequence to +/// play while this image is mounted. +/// +/// @param slot Image slot to modify +/// @param prefix The prefix applied to the image ) +/// /// public void setImageScriptAnimPrefix(string shapebase, int slot, string prefix){ @@ -18983,7 +26363,12 @@ public void setImageScriptAnimPrefix(string shapebase, int slot, string prefix) m_ts.fnShapeBase_setImageScriptAnimPrefix(shapebase, slot, prefix); } /// -/// @brief Set the target state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new target state for the Image @return the Image's new target state ) +/// @brief Set the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new target state for the Image +/// @return the Image's new target state ) +/// /// public bool setImageTarget(string shapebase, int slot, bool state){ @@ -18991,7 +26376,12 @@ public bool setImageTarget(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageTarget(shapebase, slot, state); } /// -/// @brief Set the trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new trigger state for the Image @return the Image's new trigger state ) +/// @brief Set the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new trigger state for the Image +/// @return the Image's new trigger state ) +/// /// public bool setImageTrigger(string shapebase, int slot, bool state){ @@ -18999,15 +26389,11 @@ public bool setImageTrigger(string shapebase, int slot, bool state){ return m_ts.fnShapeBase_setImageTrigger(shapebase, slot, state); } /// -/// @brief Setup the invincible effect. This effect is used for HUD feedback to the user that they are invincible. @note Currently not implemented @param time duration in seconds for the invincible effect @param speed speed at which the invincible effect progresses ) -/// -public void setInvincibleMode(string shapebase, float time, float speed){ - - -m_ts.fnShapeBase_setInvincibleMode(shapebase, time, speed); -} -/// -/// @brief Set the hidden state on the named shape mesh. @param name name of the mesh to hide/show @param hide new hidden state for the mesh ) +/// @brief Set the hidden state on the named shape mesh. +/// +/// @param name name of the mesh to hide/show +/// @param hide new hidden state for the mesh ) +/// /// public void setMeshHidden(string shapebase, string name, bool hide){ @@ -19015,7 +26401,15 @@ public void setMeshHidden(string shapebase, string name, bool hide){ m_ts.fnShapeBase_setMeshHidden(shapebase, name, hide); } /// -/// @brief Set the recharge rate. The recharge rate is added to the object's current energy level each tick, up to the maxEnergy level set in the ShapeBaseData datablock. @param rate the recharge rate (per tick) @see getRechargeRate()) +/// @brief Set the recharge rate. +/// +/// The recharge rate is added to the object's current energy level each tick, +/// up to the maxEnergy level set in the ShapeBaseData datablock. +/// +/// @param rate the recharge rate (per tick) +/// +/// @see getRechargeRate()) +/// /// public void setRechargeRate(string shapebase, float rate){ @@ -19023,7 +26417,17 @@ public void setRechargeRate(string shapebase, float rate){ m_ts.fnShapeBase_setRechargeRate(shapebase, rate); } /// -/// @brief Set amount to repair damage by each tick. Note that this value is separate to the repairRate field in ShapeBaseData. This value will be subtracted from the damage level each tick, whereas the ShapeBaseData field limits how much of the applyRepair value is subtracted each tick. Both repair types can be active at the same time. @param rate value to subtract from damage level each tick (must be > 0) @see getRepairRate()) +/// @brief Set amount to repair damage by each tick. +/// +/// Note that this value is separate to the repairRate field in ShapeBaseData. +/// This value will be subtracted from the damage level each tick, whereas the +/// ShapeBaseData field limits how much of the applyRepair value is subtracted +/// each tick. Both repair types can be active at the same time. +/// +/// @param rate value to subtract from damage level each tick (must be > 0) +/// +/// @see getRepairRate()) +/// /// public void setRepairRate(string shapebase, float rate){ @@ -19031,7 +26435,15 @@ public void setRepairRate(string shapebase, float rate){ m_ts.fnShapeBase_setRepairRate(shapebase, rate); } /// -/// @brief Set the name of this shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @param name new name for the shape @see getShapeName()) +/// @brief Set the name of this shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @param name new name for the shape +/// +/// @see getShapeName()) +/// /// public void setShapeName(string shapebase, string name){ @@ -19039,7 +26451,16 @@ public void setShapeName(string shapebase, string name){ m_ts.fnShapeBase_setShapeName(shapebase, name); } /// -/// @brief Apply a new skin to this shape. 'Skinning' the shape effectively renames the material targets, allowing different materials to be used on different instances of the same model. @param name name of the skin to apply @see skin @see getSkinName()) +/// @brief Apply a new skin to this shape. +/// +/// 'Skinning' the shape effectively renames the material targets, allowing +/// different materials to be used on different instances of the same model. +/// +/// @param name name of the skin to apply +/// +/// @see skin +/// @see getSkinName()) +/// /// public void setSkinName(string shapebase, string name){ @@ -19047,7 +26468,14 @@ public void setSkinName(string shapebase, string name){ m_ts.fnShapeBase_setSkinName(shapebase, name); } /// -/// @brief Set the playback direction of an animation thread. @param slot thread slot to modify @param fwd true to play the animation forwards, false to play backwards @return true if successful, false if failed @see playThread() ) +/// @brief Set the playback direction of an animation thread. +/// +/// @param slot thread slot to modify +/// @param fwd true to play the animation forwards, false to play backwards +/// @return true if successful, false if failed +/// +/// @see playThread() ) +/// /// public bool setThreadDir(string shapebase, int slot, bool fwd){ @@ -19055,7 +26483,14 @@ public bool setThreadDir(string shapebase, int slot, bool fwd){ return m_ts.fnShapeBase_setThreadDir(shapebase, slot, fwd); } /// -/// @brief Set the position within an animation thread. @param slot thread slot to modify @param pos position within thread @return true if successful, false if failed @see playThread ) +/// @brief Set the position within an animation thread. +/// +/// @param slot thread slot to modify +/// @param pos position within thread +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool setThreadPosition(string shapebase, int slot, float pos){ @@ -19063,7 +26498,14 @@ public bool setThreadPosition(string shapebase, int slot, float pos){ return m_ts.fnShapeBase_setThreadPosition(shapebase, slot, pos); } /// -/// @brief Set the playback time scale of an animation thread. @param slot thread slot to modify @param scale new thread time scale (1=normal speed, 0.5=half speed etc) @return true if successful, false if failed @see playThread ) +/// @brief Set the playback time scale of an animation thread. +/// +/// @param slot thread slot to modify +/// @param scale new thread time scale (1=normal speed, 0.5=half speed etc) +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool setThreadTimeScale(string shapebase, int slot, float scale){ @@ -19071,7 +26513,11 @@ public bool setThreadTimeScale(string shapebase, int slot, float scale){ return m_ts.fnShapeBase_setThreadTimeScale(shapebase, slot, scale); } /// -/// @brief Set the object's velocity. @param vel new velocity for the object @return true ) +/// @brief Set the object's velocity. +/// +/// @param vel new velocity for the object +/// @return true ) +/// /// public bool setVelocity(string shapebase, Point3F vel){ @@ -19079,7 +26525,17 @@ public bool setVelocity(string shapebase, Point3F vel){ return m_ts.fnShapeBase_setVelocity(shapebase, vel.AsString()); } /// -/// @brief Set the white-out level. White-out may be used as a postfx effect to brighten the screen in response to a game event. @note Relies on the flash postFx. @param level flash level (0-1) @see getWhiteOut()) +/// @brief Set the white-out level. +/// +/// White-out may be used as a postfx effect to brighten the screen in response +/// to a game event. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getWhiteOut()) +/// /// public void setWhiteOut(string shapebase, float level){ @@ -19087,7 +26543,21 @@ public void setWhiteOut(string shapebase, float level){ m_ts.fnShapeBase_setWhiteOut(shapebase, level); } /// -/// @brief Fade the object in or out without removing it from the scene. A faded out object is still in the scene and can still be collided with, so if you want to disable collisions for this shape after it fades out use setHidden to temporarily remove this shape from the scene. @note Items have the ability to light their surroundings. When an Item with an active light is fading out, the light it emits is correspondingly reduced until it goes out. Likewise, when the item fades in, the light is turned-up till it reaches it's normal brightntess. @param time duration of the fade effect in ms @param delay delay in ms before the fade effect begins @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// @brief Fade the object in or out without removing it from the scene. +/// +/// A faded out object is still in the scene and can still be collided with, +/// so if you want to disable collisions for this shape after it fades out +/// use setHidden to temporarily remove this shape from the scene. +/// +/// @note Items have the ability to light their surroundings. When an Item with +/// an active light is fading out, the light it emits is correspondingly +/// reduced until it goes out. Likewise, when the item fades in, the light is +/// turned-up till it reaches it's normal brightntess. +/// +/// @param time duration of the fade effect in ms +/// @param delay delay in ms before the fade effect begins +/// @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// /// public void startFade(string shapebase, int time, int delay, bool fadeOut){ @@ -19095,7 +26565,13 @@ public void startFade(string shapebase, int time, int delay, bool fadeOut){ m_ts.fnShapeBase_startFade(shapebase, time, delay, fadeOut); } /// -/// @brief Stop a sound started with playAudio. @param slot audio slot index (started with playAudio) @return true if the sound was stopped successfully, false if failed @see playAudio()) +/// @brief Stop a sound started with playAudio. +/// +/// @param slot audio slot index (started with playAudio) +/// @return true if the sound was stopped successfully, false if failed +/// +/// @see playAudio()) +/// /// public bool stopAudio(string shapebase, int slot){ @@ -19103,7 +26579,15 @@ public bool stopAudio(string shapebase, int slot){ return m_ts.fnShapeBase_stopAudio(shapebase, slot); } /// -/// @brief Stop an animation thread. If restarted using playThread, the animation will start from the beginning again. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Stop an animation thread. +/// +/// If restarted using playThread, the animation +/// will start from the beginning again. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool stopThread(string shapebase, int slot){ @@ -19111,7 +26595,13 @@ public bool stopThread(string shapebase, int slot){ return m_ts.fnShapeBase_stopThread(shapebase, slot); } /// -/// @brief Unmount the mounted Image in the specified slot. @param slot Image slot to unmount @return true if successful, false if failed @see mountImage()) +/// @brief Unmount the mounted Image in the specified slot. +/// +/// @param slot Image slot to unmount +/// @return true if successful, false if failed +/// +/// @see mountImage()) +/// /// public bool unmountImage(string shapebase, int slot){ @@ -19124,14 +26614,18 @@ public bool unmountImage(string shapebase, int slot){ /// public class ShapeBaseDataObject { -private Omni m_ts; - /// - /// - /// - /// -public ShapeBaseDataObject(ref Omni ts){m_ts = ts;} /// -/// @brief Check if there is the space at the given transform is free to spawn into. The shape's bounding box volume is used to check for collisions at the given world transform. Only interior and static objects are checked for collision. @param txfm Deploy transform to check @return True if the space is free, false if there is already something in the way. @note This is a server side only check, and is not actually limited to spawning.) +/// @brief Check if there is the space at the given transform is free to spawn into. +/// +/// The shape's bounding box volume is used to check for collisions at the given world +/// transform. Only interior and static objects are checked for collision. +/// +/// @param txfm Deploy transform to check +/// @return True if the space is free, false if there is already something in +/// the way. +/// +/// @note This is a server side only check, and is not actually limited to spawning.) +/// /// public bool checkDeployPos(string shapebasedata, TransformF txfm){ @@ -19139,7 +26633,11 @@ public bool checkDeployPos(string shapebasedata, TransformF txfm){ return m_ts.fnShapeBaseData_checkDeployPos(shapebasedata, txfm.AsString()); } /// -/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). @param pos Desired transform position @param normal Vector of desired direction @return The deploy transform ) +/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). +/// @param pos Desired transform position +/// @param normal Vector of desired direction +/// @return The deploy transform ) +/// /// public TransformF getDeployTransform(string shapebasedata, Point3F pos, Point3F normal){ @@ -19152,14 +26650,11 @@ public TransformF getDeployTransform(string shapebasedata, Point3F pos, Point3F /// public class SimComponentObject { -private Omni m_ts; - /// - /// - /// - /// -public SimComponentObject(ref Omni ts){m_ts = ts;} /// -/// (idx) Get the component corresponding to the given index. @param idx An integer index value corresponding to the desired component. @return The id of the component at the given index as an integer) +/// (idx) Get the component corresponding to the given index. +/// @param idx An integer index value corresponding to the desired component. +/// @return The id of the component at the given index as an integer) +/// /// public int SimComponent_getComponent(string simcomponent, int idx){ @@ -19167,7 +26662,9 @@ public int SimComponent_getComponent(string simcomponent, int idx){ return m_ts.fn_SimComponent_getComponent(simcomponent, idx); } /// -/// () Get the current component count @return The number of components in the list as an integer) +/// () Get the current component count +/// @return The number of components in the list as an integer) +/// /// public int SimComponent_getComponentCount(string simcomponent){ @@ -19175,7 +26672,9 @@ public int SimComponent_getComponentCount(string simcomponent){ return m_ts.fn_SimComponent_getComponentCount(simcomponent); } /// -/// () Check whether SimComponent is currently a template @return true if is a template and false if not) +/// () Check whether SimComponent is currently a template +/// @return true if is a template and false if not) +/// /// public bool SimComponent_getIsTemplate(string simcomponent){ @@ -19183,7 +26682,9 @@ public bool SimComponent_getIsTemplate(string simcomponent){ return m_ts.fn_SimComponent_getIsTemplate(simcomponent); } /// -/// () Check whether SimComponent is currently enabled @return true if enabled and false if not) +/// () Check whether SimComponent is currently enabled +/// @return true if enabled and false if not) +/// /// public bool SimComponent_isEnabled(string simcomponent){ @@ -19191,7 +26692,10 @@ public bool SimComponent_isEnabled(string simcomponent){ return m_ts.fn_SimComponent_isEnabled(simcomponent); } /// -/// (enabled) Sets or unsets the enabled flag @param enabled Boolean value @return No return value) +/// (enabled) Sets or unsets the enabled flag +/// @param enabled Boolean value +/// @return No return value) +/// /// public void SimComponent_setEnabled(string simcomponent, bool enabled){ @@ -19199,7 +26703,10 @@ public void SimComponent_setEnabled(string simcomponent, bool enabled){ m_ts.fn_SimComponent_setEnabled(simcomponent, enabled); } /// -/// (template) Sets or unsets the template flag @param template Boolean value @return No return value) +/// (template) Sets or unsets the template flag +/// @param template Boolean value +/// @return No return value) +/// /// public void SimComponent_setIsTemplate(string simcomponent, bool templateFlag){ @@ -19207,7 +26714,11 @@ public void SimComponent_setIsTemplate(string simcomponent, bool templateFlag){ m_ts.fn_SimComponent_setIsTemplate(simcomponent, templateFlag); } /// -/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); Adds additional components to current list. @param Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); +/// Adds additional components to current list. +/// @param Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool addComponents(string simcomponent, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= "", string a21= "", string a22= "", string a23= "", string a24= "", string a25= "", string a26= "", string a27= "", string a28= "", string a29= "", string a30= "", string a31= "", string a32= "", string a33= "", string a34= "", string a35= "", string a36= "", string a37= "", string a38= "", string a39= "", string a40= "", string a41= "", string a42= "", string a43= "", string a44= "", string a45= "", string a46= "", string a47= "", string a48= "", string a49= "", string a50= "", string a51= "", string a52= "", string a53= "", string a54= "", string a55= "", string a56= "", string a57= "", string a58= "", string a59= "", string a60= "", string a61= "", string a62= "", string a63= ""){ @@ -19215,7 +26726,11 @@ public bool addComponents(string simcomponent, string a2= "", string a3= "", st return m_ts.fnSimComponent_addComponents(simcomponent, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41, a42, a43, a44, a45, a46, a47, a48, a49, a50, a51, a52, a53, a54, a55, a56, a57, a58, a59, a60, a61, a62, a63); } /// -/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); Removes components by name from current list. @param objNamex Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); +/// Removes components by name from current list. +/// @param objNamex Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool removeComponents(string simcomponent, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= "", string a20= "", string a21= "", string a22= "", string a23= "", string a24= "", string a25= "", string a26= "", string a27= "", string a28= "", string a29= "", string a30= "", string a31= "", string a32= "", string a33= "", string a34= "", string a35= "", string a36= "", string a37= "", string a38= "", string a39= "", string a40= "", string a41= "", string a42= "", string a43= "", string a44= "", string a45= "", string a46= "", string a47= "", string a48= "", string a49= "", string a50= "", string a51= "", string a52= "", string a53= "", string a54= "", string a55= "", string a56= "", string a57= "", string a58= "", string a59= "", string a60= "", string a61= "", string a62= "", string a63= ""){ @@ -19228,14 +26743,9 @@ public bool removeComponents(string simcomponent, string a2= "", string a3= "", /// public class SimDataBlockObject { -private Omni m_ts; - /// - /// - /// - /// -public SimDataBlockObject(ref Omni ts){m_ts = ts;} /// /// Reload the datablock. This can only be used with a local client configuration. ) +/// /// public void SimDataBlock_reloadOnLocalClient(string simdatablock){ @@ -19248,12 +26758,6 @@ public void SimDataBlock_reloadOnLocalClient(string simdatablock){ /// public class SimObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public SimObjectObject(ref Omni ts){m_ts = ts;} /// /// Copy fields from another object onto this one. The objects must /// be of same type. Everything from the object will overwrite what's @@ -19871,14 +27375,9 @@ public void signal(string simobject, string a2= "", string a3= ""){ /// public class SimPersistSetObject { -private Omni m_ts; - /// - /// - /// - /// -public SimPersistSetObject(ref Omni ts){m_ts = ts;} /// /// () - Try to bind unresolved persistent IDs in the set. ) +/// /// public void SimPersistSet_resolvePersistentIds(string simpersistset){ @@ -19891,14 +27390,33 @@ public void SimPersistSet_resolvePersistentIds(string simpersistset){ /// public class SimpleNetObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public SimpleNetObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Sets the internal message variable. SimpleNetObject is set up to automatically transmit this new message to all connected clients. It will appear in the clients' console. @param msg The new message to send @tsexample // On the server, create a new SimpleNetObject. This is a ghost always // object so it will be immediately ghosted to all connected clients. $s = new SimpleNetObject(); // All connected clients will see the following in their console: // // Got message: Hello World! // Now again on the server, change the message. This will cause it to // be sent to all connected clients. $s.setMessage(\"A new message from me!\"); // All connected clients will now see in their console: // // Go message: A new message from me! @endtsexample ) +/// @brief Sets the internal message variable. +/// +/// SimpleNetObject is set up to automatically transmit this new message to +/// all connected clients. It will appear in the clients' console. +/// +/// @param msg The new message to send +/// +/// @tsexample +/// // On the server, create a new SimpleNetObject. This is a ghost always +/// // object so it will be immediately ghosted to all connected clients. +/// $s = new SimpleNetObject(); +/// +/// // All connected clients will see the following in their console: +/// // +/// // Got message: Hello World! +/// +/// // Now again on the server, change the message. This will cause it to +/// // be sent to all connected clients. +/// $s.setMessage(\"A new message from me!\"); +/// +/// // All connected clients will now see in their console: +/// // +/// // Go message: A new message from me! +/// @endtsexample +/// ) +/// /// public void setMessage(string simplenetobject, string msg){ @@ -19911,14 +27429,9 @@ public void setMessage(string simplenetobject, string msg){ /// public class SimResponseCurveObject { -private Omni m_ts; - /// - /// - /// - /// -public SimResponseCurveObject(ref Omni ts){m_ts = ts;} /// /// addPoint( F32 value, F32 time ) ) +/// /// public void SimResponseCurve_addPoint(string simresponsecurve, float value, float time){ @@ -19927,6 +27440,7 @@ public void SimResponseCurve_addPoint(string simresponsecurve, float value, flo } /// /// clear() ) +/// /// public void SimResponseCurve_clear(string simresponsecurve){ @@ -19935,6 +27449,7 @@ public void SimResponseCurve_clear(string simresponsecurve){ } /// /// getValue( F32 time ) ) +/// /// public float SimResponseCurve_getValue(string simresponsecurve, float time){ @@ -19947,14 +27462,9 @@ public float SimResponseCurve_getValue(string simresponsecurve, float time){ /// public class SimSetObject { -private Omni m_ts; - /// - /// - /// - /// -public SimSetObject(ref Omni ts){m_ts = ts;} /// /// () Delete all objects in the set. ) +/// /// public void SimSet_deleteAllObjects(string simset){ @@ -19962,7 +27472,9 @@ public void SimSet_deleteAllObjects(string simset){ m_ts.fn_SimSet_deleteAllObjects(simset); } /// -/// () Get the number of direct and indirect child objects contained in the set. @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// () Get the number of direct and indirect child objects contained in the set. +/// @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// /// public int SimSet_getFullCount(string simset){ @@ -19970,7 +27482,9 @@ public int SimSet_getFullCount(string simset){ return m_ts.fn_SimSet_getFullCount(simset); } /// -/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. +/// @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// /// public void SimSet_sort(string simset, string callbackFunction){ @@ -19978,7 +27492,10 @@ public void SimSet_sort(string simset, string callbackFunction){ m_ts.fn_SimSet_sort(simset, callbackFunction); } /// -/// Test whether the given object may be added to the set. @param obj The object to test for potential membership. @return True if the object may be added to the set, false otherwise. ) +/// Test whether the given object may be added to the set. +/// @param obj The object to test for potential membership. +/// @return True if the object may be added to the set, false otherwise. ) +/// /// public bool acceptsAsChild(string simset, string obj){ @@ -19986,7 +27503,10 @@ public bool acceptsAsChild(string simset, string obj){ return m_ts.fnSimSet_acceptsAsChild(simset, obj); } /// -/// ( SimSet, add, void, 3, 0, ( SimObject objects... ) Add the given objects to the set. @param objects The objects to add to the set. ) +/// ( SimSet, add, void, 3, 0, +/// ( SimObject objects... ) Add the given objects to the set. +/// @param objects The objects to add to the set. ) +/// /// public void add(string simset, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -19994,7 +27514,9 @@ public void add(string simset, string a2= "", string a3= "", string a4= "", str m_ts.fnSimSet_add(simset, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// Make the given object the first object in the set. @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// Make the given object the first object in the set. +/// @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// /// public void bringToFront(string simset, string obj){ @@ -20002,7 +27524,13 @@ public void bringToFront(string simset, string obj){ m_ts.fnSimSet_bringToFront(simset, obj); } /// -/// ( SimSet, callOnChildren, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method recurses into all SimSets that are children to the set. @see callOnChildrenNoRecurse ) +/// ( SimSet, callOnChildren, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method recurses into all SimSets that are children to the set. +/// @see callOnChildrenNoRecurse ) +/// /// public void callOnChildren(string simset, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -20010,7 +27538,13 @@ public void callOnChildren(string simset, string a2= "", string a3= "", string m_ts.fnSimSet_callOnChildren(simset, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method does not recurse into child SimSets. @see callOnChildren ) +/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method does not recurse into child SimSets. +/// @see callOnChildren ) +/// /// public void callOnChildrenNoRecurse(string simset, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -20019,6 +27553,7 @@ public void callOnChildrenNoRecurse(string simset, string a2= "", string a3= "" } /// /// Remove all objects from the set. ) +/// /// public void clear(string simset){ @@ -20026,7 +27561,11 @@ public void clear(string simset){ m_ts.fnSimSet_clear(simset); } /// -/// Find an object in the set by its internal name. @param internalName The internal name of the object to look for. @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. @return The object with the given internal name or 0 if no match was found. ) +/// Find an object in the set by its internal name. +/// @param internalName The internal name of the object to look for. +/// @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. +/// @return The object with the given internal name or 0 if no match was found. ) +/// /// public string findObjectByInternalName(string simset, string internalName, bool searchChildren = false){ @@ -20034,7 +27573,9 @@ public string findObjectByInternalName(string simset, string internalName, bool return m_ts.fnSimSet_findObjectByInternalName(simset, internalName, searchChildren); } /// -/// Get the number of objects contained in the set. @return The number of objects contained in the set. ) +/// Get the number of objects contained in the set. +/// @return The number of objects contained in the set. ) +/// /// public int getCount(string simset){ @@ -20042,7 +27583,10 @@ public int getCount(string simset){ return m_ts.fnSimSet_getCount(simset); } /// -/// Get the object at the given index. @param index The object index. @return The object at the given index or -1 if index is out of range. ) +/// Get the object at the given index. +/// @param index The object index. +/// @return The object at the given index or -1 if index is out of range. ) +/// /// public string getObject(string simset, uint index){ @@ -20050,7 +27594,10 @@ public string getObject(string simset, uint index){ return m_ts.fnSimSet_getObject(simset, index); } /// -/// Return the index of the given object in this set. @param obj The object for which to return the index. Must be contained in the set. @return The index of the object or -1 if the object is not contained in the set. ) +/// Return the index of the given object in this set. +/// @param obj The object for which to return the index. Must be contained in the set. +/// @return The index of the object or -1 if the object is not contained in the set. ) +/// /// public int getObjectIndex(string simset, string obj){ @@ -20058,7 +27605,9 @@ public int getObjectIndex(string simset, string obj){ return m_ts.fnSimSet_getObjectIndex(simset, obj); } /// -/// Return a random object from the set. @return A randomly selected object from the set or -1 if the set is empty. ) +/// Return a random object from the set. +/// @return A randomly selected object from the set or -1 if the set is empty. ) +/// /// public string getRandom(string simset){ @@ -20066,7 +27615,10 @@ public string getRandom(string simset){ return m_ts.fnSimSet_getRandom(simset); } /// -/// Test whether the given object belongs to the set. @param obj The object. @return True if the object is contained in the set; false otherwise. ) +/// Test whether the given object belongs to the set. +/// @param obj The object. +/// @return True if the object is contained in the set; false otherwise. ) +/// /// public bool isMember(string simset, string obj){ @@ -20075,6 +27627,7 @@ public bool isMember(string simset, string obj){ } /// /// Dump a list of all objects contained in the set to the console. ) +/// /// public void listObjects(string simset){ @@ -20082,7 +27635,9 @@ public void listObjects(string simset){ m_ts.fnSimSet_listObjects(simset); } /// -/// Make the given object the last object in the set. @param obj The object to bring to the last position. Must be contained in the set. ) +/// Make the given object the last object in the set. +/// @param obj The object to bring to the last position. Must be contained in the set. ) +/// /// public void pushToBack(string simset, string obj){ @@ -20090,7 +27645,10 @@ public void pushToBack(string simset, string obj){ m_ts.fnSimSet_pushToBack(simset, obj); } /// -/// ( SimSet, remove, void, 3, 0, ( SimObject objects... ) Remove the given objects from the set. @param objects The objects to remove from the set. ) +/// ( SimSet, remove, void, 3, 0, +/// ( SimObject objects... ) Remove the given objects from the set. +/// @param objects The objects to remove from the set. ) +/// /// public void remove(string simset, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -20098,7 +27656,10 @@ public void remove(string simset, string a2= "", string a3= "", string a4= "", m_ts.fnSimSet_remove(simset, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19); } /// -/// Make sure child1 is ordered right before child2 in the set. @param child1 The first child. The object must already be contained in the set. @param child2 The second child. The object must already be contained in the set. ) +/// Make sure child1 is ordered right before child2 in the set. +/// @param child1 The first child. The object must already be contained in the set. +/// @param child2 The second child. The object must already be contained in the set. ) +/// /// public void reorderChild(string simset, string child1, string child2){ @@ -20111,14 +27672,13 @@ public void reorderChild(string simset, string child1, string child2){ /// public class SimXMLDocumentObject { -private Omni m_ts; - /// - /// - /// - /// -public SimXMLDocumentObject(ref Omni ts){m_ts = ts;} /// -/// (string attributeName) @brief Get float attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of a float. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get float attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of a float. +/// @deprecated Use attribute().) +/// /// public float SimXMLDocument_attributeF32(string simxmldocument, string attributeName){ @@ -20126,7 +27686,12 @@ public float SimXMLDocument_attributeF32(string simxmldocument, string attribut return m_ts.fn_SimXMLDocument_attributeF32(simxmldocument, attributeName); } /// -/// (string attributeName) @brief Get int attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of an integer. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get int attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of an integer. +/// @deprecated Use attribute().) +/// /// public int SimXMLDocument_attributeS32(string simxmldocument, string attributeName){ @@ -20134,7 +27699,24 @@ public int SimXMLDocument_attributeS32(string simxmldocument, string attributeN return m_ts.fn_SimXMLDocument_attributeS32(simxmldocument, attributeName); } /// -/// @brief Add the given comment as a child of the document. @param comment String containing the comment. @tsexample // Create a new XML document with a header, a comment and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addComment(\"This is a test comment\"); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // !--This is a test comment--> // NewElement /> @endtsexample @see readComment()) +/// @brief Add the given comment as a child of the document. +/// @param comment String containing the comment. +/// +/// @tsexample +/// // Create a new XML document with a header, a comment and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addComment(\"This is a test comment\"); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // !--This is a test comment--> +/// // NewElement /> +/// @endtsexample +/// +/// @see readComment()) +/// /// public void addComment(string simxmldocument, string comment){ @@ -20142,7 +27724,34 @@ public void addComment(string simxmldocument, string comment){ m_ts.fnSimXMLDocument_addComment(simxmldocument, comment); } /// -/// @brief Add the given text as a child of current Element. Use getData() to retrieve any text from the current Element. addData() and addText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added data. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addData(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getData() @see addText() @see getText() @see removeText()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getData() to retrieve any text from the current Element. +/// +/// addData() and addText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added data. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addData(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public void addData(string simxmldocument, string text){ @@ -20150,7 +27759,24 @@ public void addData(string simxmldocument, string text){ m_ts.fnSimXMLDocument_addData(simxmldocument, text); } /// -/// @brief Add a XML header to a document. Sometimes called a declaration, you typically add a standard header to the document before adding any elements. SimXMLDocument always produces the following header: ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> @tsexample // Create a new XML document with just a header and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement /> @endtsexample) +/// @brief Add a XML header to a document. +/// +/// Sometimes called a declaration, you typically add a standard header to +/// the document before adding any elements. SimXMLDocument always produces +/// the following header: +/// ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// +/// @tsexample +/// // Create a new XML document with just a header and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement /> +/// @endtsexample) +/// /// public void addHeader(string simxmldocument){ @@ -20158,7 +27784,17 @@ public void addHeader(string simxmldocument){ m_ts.fnSimXMLDocument_addHeader(simxmldocument); } /// -/// @brief Create a new element with the given name as child of current Element's parent and push it onto the Element stack making it the current one. @note This differs from pushNewElement() in that it adds the new Element to the current Element's parent (or document if there is no parent Element). This makes the new Element a sibling of the current one. @param name XML tag for the new Element. @see pushNewElement()) +/// @brief Create a new element with the given name as child of current Element's +/// parent and push it onto the Element stack making it the current one. +/// +/// @note This differs from pushNewElement() in that it adds the new Element to the +/// current Element's parent (or document if there is no parent Element). This makes +/// the new Element a sibling of the current one. +/// +/// @param name XML tag for the new Element. +/// +/// @see pushNewElement()) +/// /// public void addNewElement(string simxmldocument, string name){ @@ -20166,7 +27802,33 @@ public void addNewElement(string simxmldocument, string name){ m_ts.fnSimXMLDocument_addNewElement(simxmldocument, name); } /// -/// @brief Add the given text as a child of current Element. Use getText() to retrieve any text from the current Element and removeText() to clear any text. addText() and addData() may be used interchangeably. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added text. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addText(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getText() @see removeText() @see addData() @see getData()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getText() to retrieve any text from the current Element and removeText() +/// to clear any text. +/// +/// addText() and addData() may be used interchangeably. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added text. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addText(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public void addText(string simxmldocument, string text){ @@ -20174,7 +27836,10 @@ public void addText(string simxmldocument, string text){ m_ts.fnSimXMLDocument_addText(simxmldocument, text); } /// -/// @brief Get a string attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The attribute string if found. Otherwise returns an empty string.) +/// @brief Get a string attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The attribute string if found. Otherwise returns an empty string.) +/// /// public string attribute(string simxmldocument, string attributeName){ @@ -20182,7 +27847,10 @@ public string attribute(string simxmldocument, string attributeName){ return m_ts.fnSimXMLDocument_attribute(simxmldocument, attributeName); } /// -/// @brief Tests if the requested attribute exists. @param attributeName Name of attribute being queried for. @return True if the attribute exists.) +/// @brief Tests if the requested attribute exists. +/// @param attributeName Name of attribute being queried for. +/// @return True if the attribute exists.) +/// /// public bool attributeExists(string simxmldocument, string attributeName){ @@ -20190,7 +27858,12 @@ public bool attributeExists(string simxmldocument, string attributeName){ return m_ts.fnSimXMLDocument_attributeExists(simxmldocument, attributeName); } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using reset() @see reset()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using reset() +/// +/// @see reset()) +/// /// public void clear(string simxmldocument){ @@ -20199,6 +27872,7 @@ public void clear(string simxmldocument){ } /// /// @brief Clear the last error description.) +/// /// public void clearError(string simxmldocument){ @@ -20206,7 +27880,10 @@ public void clearError(string simxmldocument){ m_ts.fnSimXMLDocument_clearError(simxmldocument); } /// -/// @brief Get the Element's value if it exists. Usually returns the text from the Element. @return The value from the Element, or an empty string if none is found.) +/// @brief Get the Element's value if it exists. +/// Usually returns the text from the Element. +/// @return The value from the Element, or an empty string if none is found.) +/// /// public string elementValue(string simxmldocument){ @@ -20214,7 +27891,12 @@ public string elementValue(string simxmldocument){ return m_ts.fnSimXMLDocument_elementValue(simxmldocument); } /// -/// @brief Obtain the name of the current Element's first attribute. @return String containing the first attribute's name, or an empty string if none is found. @see nextAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Obtain the name of the current Element's first attribute. +/// @return String containing the first attribute's name, or an empty string if none is found. +/// @see nextAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string firstAttribute(string simxmldocument){ @@ -20222,7 +27904,39 @@ public string firstAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_firstAttribute(simxmldocument); } /// -/// @brief Gets the text from the current Element. Use addData() to add text to the current Element. getData() and getText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some data/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's data ('Some data' in this example) // into 'result' %result = %x.getData(); echo( %result ); @endtsexample @see addData() @see addText() @see getText() @see removeText()) +/// @brief Gets the text from the current Element. +/// +/// Use addData() to add text to the current Element. +/// +/// getData() and getText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some data/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's data ('Some data' in this example) +/// // into 'result' +/// %result = %x.getData(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public string getData(string simxmldocument){ @@ -20230,7 +27944,9 @@ public string getData(string simxmldocument){ return m_ts.fnSimXMLDocument_getData(simxmldocument); } /// -/// @brief Get last error description. @return A string of the last error message.) +/// @brief Get last error description. +/// @return A string of the last error message.) +/// /// public string getErrorDesc(string simxmldocument){ @@ -20238,7 +27954,38 @@ public string getErrorDesc(string simxmldocument){ return m_ts.fnSimXMLDocument_getErrorDesc(simxmldocument); } /// -/// @brief Gets the text from the current Element. Use addText() to add text to the current Element and removeText() to clear any text. getText() and getData() may be used interchangeably. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample @see addText() @see removeText() @see addData() @see getData()) +/// @brief Gets the text from the current Element. +/// +/// Use addText() to add text to the current Element and removeText() +/// to clear any text. +/// +/// getText() and getData() may be used interchangeably. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public string getText(string simxmldocument){ @@ -20246,7 +27993,12 @@ public string getText(string simxmldocument){ return m_ts.fnSimXMLDocument_getText(simxmldocument); } /// -/// @brief Obtain the name of the current Element's last attribute. @return String containing the last attribute's name, or an empty string if none is found. @see prevAttribute() @see firstAttribute() @see lastAttribute()) +/// @brief Obtain the name of the current Element's last attribute. +/// @return String containing the last attribute's name, or an empty string if none is found. +/// @see prevAttribute() +/// @see firstAttribute() +/// @see lastAttribute()) +/// /// public string lastAttribute(string simxmldocument){ @@ -20254,7 +28006,11 @@ public string lastAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_lastAttribute(simxmldocument); } /// -/// @brief Load in given filename and prepare it for use. @note Clears the current document's contents. @param fileName Name and path of XML document @return True if the file was loaded successfully.) +/// @brief Load in given filename and prepare it for use. +/// @note Clears the current document's contents. +/// @param fileName Name and path of XML document +/// @return True if the file was loaded successfully.) +/// /// public bool loadFile(string simxmldocument, string fileName){ @@ -20262,7 +28018,12 @@ public bool loadFile(string simxmldocument, string fileName){ return m_ts.fnSimXMLDocument_loadFile(simxmldocument, fileName); } /// -/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). @return String containing the next attribute's name, or an empty string if none is found. @see firstAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). +/// @return String containing the next attribute's name, or an empty string if none is found. +/// @see firstAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string nextAttribute(string simxmldocument){ @@ -20270,7 +28031,10 @@ public string nextAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_nextAttribute(simxmldocument); } /// -/// @brief Put the next sibling Element with the given name on the stack, making it the current one. @param name String containing name of the next sibling. @return True if the Element was found and made the current one.) +/// @brief Put the next sibling Element with the given name on the stack, making it the current one. +/// @param name String containing name of the next sibling. +/// @return True if the Element was found and made the current one.) +/// /// public bool nextSiblingElement(string simxmldocument, string name){ @@ -20278,7 +28042,10 @@ public bool nextSiblingElement(string simxmldocument, string name){ return m_ts.fnSimXMLDocument_nextSiblingElement(simxmldocument, name); } /// -/// @brief Create a document from a XML string. @note Clears the current document's contents. @param xmlString Valid XML to parse and store as a document.) +/// @brief Create a document from a XML string. +/// @note Clears the current document's contents. +/// @param xmlString Valid XML to parse and store as a document.) +/// /// public void parse(string simxmldocument, string xmlString){ @@ -20287,6 +28054,7 @@ public void parse(string simxmldocument, string xmlString){ } /// /// @brief Pop the last Element off the stack.) +/// /// public void popElement(string simxmldocument){ @@ -20294,7 +28062,12 @@ public void popElement(string simxmldocument){ m_ts.fnSimXMLDocument_popElement(simxmldocument); } /// -/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). @return String containing the previous attribute's name, or an empty string if none is found. @see lastAttribute() @see firstAttribute() @see nextAttribute()) +/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). +/// @return String containing the previous attribute's name, or an empty string if none is found. +/// @see lastAttribute() +/// @see firstAttribute() +/// @see nextAttribute()) +/// /// public string prevAttribute(string simxmldocument){ @@ -20302,7 +28075,10 @@ public string prevAttribute(string simxmldocument){ return m_ts.fnSimXMLDocument_prevAttribute(simxmldocument); } /// -/// @brief Push the child Element at the given index onto the stack, making it the current one. @param index Numerical index of Element being pushed. @return True if the Element was found and made the current one.) +/// @brief Push the child Element at the given index onto the stack, making it the current one. +/// @param index Numerical index of Element being pushed. +/// @return True if the Element was found and made the current one.) +/// /// public bool pushChildElement(string simxmldocument, int index){ @@ -20310,7 +28086,29 @@ public bool pushChildElement(string simxmldocument, int index){ return m_ts.fnSimXMLDocument_pushChildElement(simxmldocument, index); } /// -/// @brief Push the first child Element with the given name onto the stack, making it the current Element. @param name String containing name of the child Element. @return True if the Element was found and made the current one. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample) +/// @brief Push the first child Element with the given name onto the stack, making it the current Element. +/// +/// @param name String containing name of the child Element. +/// @return True if the Element was found and made the current one. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample) +/// /// public bool pushFirstChildElement(string simxmldocument, string name){ @@ -20318,7 +28116,16 @@ public bool pushFirstChildElement(string simxmldocument, string name){ return m_ts.fnSimXMLDocument_pushFirstChildElement(simxmldocument, name); } /// -/// @brief Create a new element with the given name as child of current Element and push it onto the Element stack making it the current one. @note This differs from addNewElement() in that it adds the new Element as a child of the current Element (or a child of the document if no Element exists). @param name XML tag for the new Element. @see addNewElement()) +/// @brief Create a new element with the given name as child of current Element +/// and push it onto the Element stack making it the current one. +/// +/// @note This differs from addNewElement() in that it adds the new Element as a +/// child of the current Element (or a child of the document if no Element exists). +/// +/// @param name XML tag for the new Element. +/// +/// @see addNewElement()) +/// /// public void pushNewElement(string simxmldocument, string name){ @@ -20326,7 +28133,18 @@ public void pushNewElement(string simxmldocument, string name){ m_ts.fnSimXMLDocument_pushNewElement(simxmldocument, name); } /// -/// Gives the comment at the specified index, if any. Unlike addComment() that only works at the document level, readComment() may read comments from the document or any child Element. The current Element (or document if no Elements have been pushed to the stack) is the parent for any comments, and the provided index is the number of comments in to read back. @param index Comment index number to query from the current Element stack @return String containing the comment, or an empty string if no comment is found. @see addComment()) +/// Gives the comment at the specified index, if any. +/// +/// Unlike addComment() that only works at the document level, readComment() may read +/// comments from the document or any child Element. The current Element (or document +/// if no Elements have been pushed to the stack) is the parent for any comments, and the +/// provided index is the number of comments in to read back. +/// +/// @param index Comment index number to query from the current Element stack +/// @return String containing the comment, or an empty string if no comment is found. +/// +/// @see addComment()) +/// /// public string readComment(string simxmldocument, int index){ @@ -20334,7 +28152,18 @@ public string readComment(string simxmldocument, int index){ return m_ts.fnSimXMLDocument_readComment(simxmldocument, index); } /// -/// @brief Remove any text on the current Element. Use getText() to retrieve any text from the current Element and addText() to add text to the current Element. As getData() and addData() are equivalent to getText() and addText(), removeText() will also remove any data from the current Element. @see addText() @see getText() @see addData() @see getData()) +/// @brief Remove any text on the current Element. +/// +/// Use getText() to retrieve any text from the current Element and addText() +/// to add text to the current Element. As getData() and addData() are equivalent +/// to getText() and addText(), removeText() will also remove any data from the +/// current Element. +/// +/// @see addText() +/// @see getText() +/// @see addData() +/// @see getData()) +/// /// public void removeText(string simxmldocument){ @@ -20342,7 +28171,12 @@ public void removeText(string simxmldocument){ m_ts.fnSimXMLDocument_removeText(simxmldocument); } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using clear() @see clear()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using clear() +/// +/// @see clear()) +/// /// public void reset(string simxmldocument){ @@ -20350,7 +28184,10 @@ public void reset(string simxmldocument){ m_ts.fnSimXMLDocument_reset(simxmldocument); } /// -/// @brief Save document to the given file name. @param fileName Path and name of XML file to save to. @return True if the file was successfully saved.) +/// @brief Save document to the given file name. +/// @param fileName Path and name of XML file to save to. +/// @return True if the file was successfully saved.) +/// /// public bool saveFile(string simxmldocument, string fileName){ @@ -20358,7 +28195,10 @@ public bool saveFile(string simxmldocument, string fileName){ return m_ts.fnSimXMLDocument_saveFile(simxmldocument, fileName); } /// -/// @brief Set the attribute of the current Element on the stack to the given value. @param attributeName Name of attribute being changed @param value New value to assign to the attribute) +/// @brief Set the attribute of the current Element on the stack to the given value. +/// @param attributeName Name of attribute being changed +/// @param value New value to assign to the attribute) +/// /// public void setAttribute(string simxmldocument, string attributeName, string value){ @@ -20366,7 +28206,9 @@ public void setAttribute(string simxmldocument, string attributeName, string va m_ts.fnSimXMLDocument_setAttribute(simxmldocument, attributeName, value); } /// -/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. @param objectID ID of SimObject being copied.) +/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. +/// @param objectID ID of SimObject being copied.) +/// /// public void setObjectAttributes(string simxmldocument, string objectID){ @@ -20379,14 +28221,9 @@ public void setObjectAttributes(string simxmldocument, string objectID){ /// public class SkyBoxObject { -private Omni m_ts; - /// - /// - /// - /// -public SkyBoxObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void SkyBox_postApply(string skybox){ @@ -20399,14 +28236,12 @@ public void SkyBox_postApply(string skybox){ /// public class SpawnSphereObject { -private Omni m_ts; - /// - /// - /// - /// -public SpawnSphereObject(ref Omni ts){m_ts = ts;} /// -/// ([string additionalProps]) Spawns the object based on the SpawnSphere's class, datablock, properties, and script settings. Allows you to pass in extra properties. @hide ) +/// ([string additionalProps]) Spawns the object based on the SpawnSphere's +/// class, datablock, properties, and script settings. Allows you to pass in +/// extra properties. +/// @hide ) +/// /// public int SpawnSphere_spawnObject(string spawnsphere, string additionalProps){ @@ -20419,14 +28254,9 @@ public int SpawnSphere_spawnObject(string spawnsphere, string additionalProps){ /// public class StaticShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public StaticShapeObject(ref Omni ts){m_ts = ts;} /// /// @internal) +/// /// public bool StaticShape_getPoweredState(string staticshape){ @@ -20434,7 +28264,9 @@ public bool StaticShape_getPoweredState(string staticshape){ return m_ts.fn_StaticShape_getPoweredState(staticshape); } /// -/// (bool isPowered) @internal) +/// (bool isPowered) +/// @internal) +/// /// public void StaticShape_setPoweredState(string staticshape, bool isPowered){ @@ -20447,14 +28279,11 @@ public void StaticShape_setPoweredState(string staticshape, bool isPowered){ /// public class StreamObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public StreamObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Copy from another StreamObject into this StreamObject @param other The StreamObject to copy from. @return True if the copy was successful.) +/// @brief Copy from another StreamObject into this StreamObject +/// @param other The StreamObject to copy from. +/// @return True if the copy was successful.) +/// /// public bool copyFrom(string streamobject, string other){ @@ -20462,7 +28291,36 @@ public bool copyFrom(string streamobject, string other){ return m_ts.fnStreamObject_copyFrom(streamobject, other); } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains two lines of text repeated: // Hello World // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Get the position of the stream %position = %fsObject.getPosition(); // Print the current position // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline echo(%position); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see setPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains two lines of text repeated: +/// // Hello World +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Get the position of the stream +/// %position = %fsObject.getPosition(); +/// // Print the current position +/// // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline +/// echo(%position); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see setPosition()) +/// /// public int getPosition(string streamobject){ @@ -20470,7 +28328,36 @@ public int getPosition(string streamobject){ return m_ts.fnStreamObject_getPosition(streamobject); } /// -/// @brief Gets a printable string form of the stream's status @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing status constant, one of the following: OK - Stream is active and no file errors IOError - Something went wrong during read or writing the stream EOS - End of Stream reached (mostly for reads) IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn Closed - Tried to operate on a closed stream (or detached filter) UnknownError - Catch all for an error of some kind Invalid - Entire stream is invalid) +/// @brief Gets a printable string form of the stream's status +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing status constant, one of the following: +/// +/// OK - Stream is active and no file errors +/// +/// IOError - Something went wrong during read or writing the stream +/// +/// EOS - End of Stream reached (mostly for reads) +/// +/// IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn +/// +/// Closed - Tried to operate on a closed stream (or detached filter) +/// +/// UnknownError - Catch all for an error of some kind +/// +/// Invalid - Entire stream is invalid) +/// /// public string getStatus(string streamobject){ @@ -20478,7 +28365,30 @@ public string getStatus(string streamobject){ return m_ts.fnStreamObject_getStatus(streamobject); } /// -/// @brief Gets the size of the stream The size is dependent on the type of stream being used. If it is a file stream, returned value will be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject.open(\"./test.txt\", \"read\"); // Found out how large the file stream is // Then print it to the console // Should be 22 %streamSize = %fsObject.getStreamSize(); echo(%streamSize); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Size of stream, in bytes) +/// @brief Gets the size of the stream +/// +/// The size is dependent on the type of stream being used. If it is a file stream, returned value will +/// be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Found out how large the file stream is +/// // Then print it to the console +/// // Should be 22 +/// %streamSize = %fsObject.getStreamSize(); +/// echo(%streamSize); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Size of stream, in bytes) +/// /// public int getStreamSize(string streamobject){ @@ -20486,7 +28396,32 @@ public int getStreamSize(string streamobject){ return m_ts.fnStreamObject_getStreamSize(streamobject); } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOS. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOF() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOS()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOS. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOF() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOS()) +/// /// public bool isEOF(string streamobject){ @@ -20494,7 +28429,32 @@ public bool isEOF(string streamobject){ return m_ts.fnStreamObject_isEOF(streamobject); } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOF. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOS() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOF()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOF. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOS() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOF()) +/// /// public bool isEOS(string streamobject){ @@ -20502,7 +28462,30 @@ public bool isEOS(string streamobject){ return m_ts.fnStreamObject_isEOS(streamobject); } /// -/// @brief Read a line from the stream. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file stream object for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject = new FileStreamObject(); %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Print the line we just read echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing the line of data that was just read @see writeLine()) +/// @brief Read a line from the stream. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file stream object for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject = new FileStreamObject(); +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Print the line we just read +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing the line of data that was just read +/// +/// @see writeLine()) +/// /// public string readLine(string streamobject){ @@ -20510,7 +28493,15 @@ public string readLine(string streamobject){ return m_ts.fnStreamObject_readLine(streamobject); } /// -/// @brief Read in a string up to the given maximum number of characters. @param maxLength The maximum number of characters to read in. @return The string that was read from the stream. @see writeLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string up to the given maximum number of characters. +/// @param maxLength The maximum number of characters to read in. +/// @return The string that was read from the stream. +/// @see writeLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string readLongString(string streamobject, int maxLength){ @@ -20518,7 +28509,14 @@ public string readLongString(string streamobject, int maxLength){ return m_ts.fnStreamObject_readLongString(streamobject, maxLength); } /// -/// @brief Read a string up to a maximum of 256 characters @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read a string up to a maximum of 256 characters +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string readString(string streamobject){ @@ -20526,7 +28524,16 @@ public string readString(string streamobject){ return m_ts.fnStreamObject_readString(streamobject); } /// -/// @brief Read in a string and place it on the string table. @param caseSensitive If false then case will not be taken into account when attempting to match the read in string with what is already in the string table. @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string and place it on the string table. +/// @param caseSensitive If false then case will not be taken into account when attempting +/// to match the read in string with what is already in the string table. +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string readSTString(string streamobject, bool caseSensitive = false){ @@ -20534,7 +28541,35 @@ public string readSTString(string streamobject, bool caseSensitive = false){ return m_ts.fnStreamObject_readSTString(streamobject, caseSensitive); } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // 11111111111 // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Skip ahead by 12, which will bypass the first line entirely %fsObject.setPosition(12); // Read in the next line %line = %fsObject.readLine(); // Print the line just read in, should be \"Hello World\" echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see getPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // 11111111111 +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Skip ahead by 12, which will bypass the first line entirely +/// %fsObject.setPosition(12); +/// // Read in the next line +/// %line = %fsObject.readLine(); +/// // Print the line just read in, should be \"Hello World\" +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see getPosition()) +/// /// public bool setPosition(string streamobject, int newPosition){ @@ -20542,7 +28577,29 @@ public bool setPosition(string streamobject, int newPosition){ return m_ts.fnStreamObject_setPosition(streamobject, newPosition); } /// -/// @brief Write a line to the stream, if it was opened for writing. There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param line The data we are writing out to file. @tsexample // Create a file stream %fsObject = new FileStreamObject(); // Open the file for writing // If it does not exist, it is created. If it does exist, the file is cleared %fsObject.open(\"./test.txt\", \"write\"); // Write a line to the file %fsObject.writeLine(\"Hello World\"); // Write another line to the file %fsObject.writeLine(\"Documentation Rocks!\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see readLine()) +/// @brief Write a line to the stream, if it was opened for writing. +/// +/// There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param line The data we are writing out to file. +/// +/// @tsexample +/// // Create a file stream +/// %fsObject = new FileStreamObject(); +/// // Open the file for writing +/// // If it does not exist, it is created. If it does exist, the file is cleared +/// %fsObject.open(\"./test.txt\", \"write\"); +/// // Write a line to the file +/// %fsObject.writeLine(\"Hello World\"); +/// // Write another line to the file +/// %fsObject.writeLine(\"Documentation Rocks!\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see readLine()) +/// /// public void writeLine(string streamobject, string line){ @@ -20550,7 +28607,15 @@ public void writeLine(string streamobject, string line){ m_ts.fnStreamObject_writeLine(streamobject, line); } /// -/// @brief Write out a string up to the maximum number of characters. @param maxLength The maximum number of characters that will be written. @param string The string to write out to the stream. @see readLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string up to the maximum number of characters. +/// @param maxLength The maximum number of characters that will be written. +/// @param string The string to write out to the stream. +/// @see readLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void writeLongString(string streamobject, int maxLength, string stringx){ @@ -20558,7 +28623,16 @@ public void writeLongString(string streamobject, int maxLength, string stringx) m_ts.fnStreamObject_writeLongString(streamobject, maxLength, stringx); } /// -/// @brief Write out a string with a default maximum length of 256 characters. @param string The string to write out to the stream @param maxLength The maximum string length to write out with a default of 256 characters. This value should not be larger than 256 as it is written to the stream as a single byte. @see readString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string with a default maximum length of 256 characters. +/// @param string The string to write out to the stream +/// @param maxLength The maximum string length to write out with a default of 256 characters. This +/// value should not be larger than 256 as it is written to the stream as a single byte. +/// @see readString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void writeString(string streamobject, string stringx, int maxLength = 256){ @@ -20571,14 +28645,9 @@ public void writeString(string streamobject, string stringx, int maxLength = 25 /// public class SunObject { -private Omni m_ts; - /// - /// - /// - /// -public SunObject(ref Omni ts){m_ts = ts;} /// /// animate( F32 duration, F32 startAzimuth, F32 endAzimuth, F32 startElevation, F32 endElevation )) +/// /// public void Sun_animate(string sun, float duration, float startAzimuth, float endAzimuth, float startElevation, float endElevation){ @@ -20587,6 +28656,7 @@ public void Sun_animate(string sun, float duration, float startAzimuth, float e } /// /// ) +/// /// public void Sun_apply(string sun){ @@ -20599,14 +28669,19 @@ public void Sun_apply(string sun){ /// public class TCPObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public TCPObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Connect to the given address. @param address Server address (including port) to connect to. @tsexample // Set the address. %address = \"www.garagegames.com:80\"; // Inform this TCPObject to connect to the specified address. %thisTCPObj.connect(%address); @endtsexample) +/// @brief Connect to the given address. +/// +/// @param address Server address (including port) to connect to. +/// +/// @tsexample +/// // Set the address. +/// %address = \"www.garagegames.com:80\"; +/// +/// // Inform this TCPObject to connect to the specified address. +/// %thisTCPObj.connect(%address); +/// @endtsexample) +/// /// public void connect(string tcpobject, string address){ @@ -20614,7 +28689,13 @@ public void connect(string tcpobject, string address){ m_ts.fnTCPObject_connect(tcpobject, address); } /// -/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. @tsexample // Inform this TCPObject to disconnect from anything it is currently connected to. %thisTCPObj.disconnect(); @endtsexample) +/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. +/// +/// @tsexample +/// // Inform this TCPObject to disconnect from anything it is currently connected to. +/// %thisTCPObj.disconnect(); +/// @endtsexample) +/// /// public void disconnect(string tcpobject){ @@ -20622,15 +28703,58 @@ public void disconnect(string tcpobject){ m_ts.fnTCPObject_disconnect(tcpobject); } /// -/// @brief Start listening on the specified port for connections. This method starts a listener which looks for incoming TCP connections to a port. You must overload the onConnectionRequest callback to create a new TCPObject to read, write, or reject the new connection. @param port Port for this TCPObject to start listening for connections on. @tsexample // Create a listener on port 8080. new TCPObject( TCPListener ); TCPListener.listen( 8080 ); function TCPListener::onConnectionRequest( %this, %address, %id ) { // Create a new object to manage the connection. new TCPObject( TCPClient, %id ); } function TCPClient::onLine( %this, %line ) { // Print the line of text from client. echo( %line ); } @endtsexample) +/// @brief Start listening on the specified port for connections. +/// +/// This method starts a listener which looks for incoming TCP connections to a port. +/// You must overload the onConnectionRequest callback to create a new TCPObject to +/// read, write, or reject the new connection. +/// +/// @param port Port for this TCPObject to start listening for connections on. +/// +/// @tsexample +/// +/// // Create a listener on port 8080. +/// new TCPObject( TCPListener ); +/// TCPListener.listen( 8080 ); +/// +/// function TCPListener::onConnectionRequest( %this, %address, %id ) +/// { +/// // Create a new object to manage the connection. +/// new TCPObject( TCPClient, %id ); +/// } +/// +/// function TCPClient::onLine( %this, %line ) +/// { +/// // Print the line of text from client. +/// echo( %line ); +/// } +/// +/// @endtsexample) +/// /// -public void listen(string tcpobject, int port){ +public void listen(string tcpobject, uint port){ m_ts.fnTCPObject_listen(tcpobject, port); } /// -/// @brief Transmits the data string to the connected computer. This method is used to send text data to the connected computer regardless if we initiated the connection using connect(), or listening to a port using listen(). @param data The data string to send. @tsexample // Set the command data %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" // Send the command to the connected server. %thisTCPObj.send(%data); @endtsexample) +/// @brief Transmits the data string to the connected computer. +/// +/// This method is used to send text data to the connected computer regardless if we initiated the +/// connection using connect(), or listening to a port using listen(). +/// +/// @param data The data string to send. +/// +/// @tsexample +/// // Set the command data +/// %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; +/// %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; +/// %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" +/// +/// // Send the command to the connected server. +/// %thisTCPObj.send(%data); +/// @endtsexample) +/// /// public void send(string tcpobject, string data){ @@ -20643,14 +28767,9 @@ public void send(string tcpobject, string data){ /// public class TerrainBlockObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainBlockObject(ref Omni ts){m_ts = ts;} /// /// png), (string filename, [string format]) - export the terrain block's heightmap to a bitmap file (default: png) ) +/// /// public bool TerrainBlock_exportHeightMap(string terrainblock, string fileNameStr, string format = "png"){ @@ -20659,6 +28778,7 @@ public bool TerrainBlock_exportHeightMap(string terrainblock, string fileNameSt } /// /// png), (string filePrefix, [string format]) - export the terrain block's layer maps to bitmap files (default: png) ) +/// /// public bool TerrainBlock_exportLayerMaps(string terrainblock, string filePrefixStr, string format = "png"){ @@ -20666,7 +28786,12 @@ public bool TerrainBlock_exportLayerMaps(string terrainblock, string filePrefix return m_ts.fn_TerrainBlock_exportLayerMaps(terrainblock, filePrefixStr, format); } /// -/// @brief Saves the terrain block's terrain file to the specified file name. @param fileName Name and path of file to save terrain data to. @return True if file save was successful, false otherwise) +/// @brief Saves the terrain block's terrain file to the specified file name. +/// +/// @param fileName Name and path of file to save terrain data to. +/// +/// @return True if file save was successful, false otherwise) +/// /// public bool save(string terrainblock, string fileName){ @@ -20679,14 +28804,10 @@ public bool save(string terrainblock, string fileName){ /// public class TerrainEditorObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainEditorObject(ref Omni ts){m_ts = ts;} /// -/// ( string matName ) Adds a new material. ) +/// ( string matName ) +/// Adds a new material. ) +/// /// public int TerrainEditor_addMaterial(string terraineditor, string matName){ @@ -20695,6 +28816,7 @@ public int TerrainEditor_addMaterial(string terraineditor, string matName){ } /// /// ), (TerrainBlock terrain)) +/// /// public void TerrainEditor_attachTerrain(string terraineditor, string terrain = ""){ @@ -20702,15 +28824,17 @@ public void TerrainEditor_attachTerrain(string terraineditor, string terrain = m_ts.fn_TerrainEditor_attachTerrain(terraineditor, terrain); } /// -/// (float minHeight, float maxHeight, float minSlope, float maxSlope)) +/// (F32 minHeight, F32 maxHeight, F32 minSlope, F32 maxSlope , F32 coverage)) +/// /// -public void TerrainEditor_autoMaterialLayer(string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope){ +public void TerrainEditor_autoMaterialLayer(string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope, float coverage){ -m_ts.fn_TerrainEditor_autoMaterialLayer(terraineditor, minHeight, maxHeight, minSlope, maxSlope); +m_ts.fn_TerrainEditor_autoMaterialLayer(terraineditor, minHeight, maxHeight, minSlope, maxSlope, coverage); } /// /// ) +/// /// public void TerrainEditor_clearSelection(string terraineditor){ @@ -20719,6 +28843,7 @@ public void TerrainEditor_clearSelection(string terraineditor){ } /// /// (int num)) +/// /// public string TerrainEditor_getActionName(string terraineditor, uint index){ @@ -20727,6 +28852,7 @@ public string TerrainEditor_getActionName(string terraineditor, uint index){ } /// /// ) +/// /// public int TerrainEditor_getActiveTerrain(string terraineditor){ @@ -20735,6 +28861,7 @@ public int TerrainEditor_getActiveTerrain(string terraineditor){ } /// /// Returns a Point2I.) +/// /// public string TerrainEditor_getBrushPos(string terraineditor){ @@ -20743,6 +28870,7 @@ public string TerrainEditor_getBrushPos(string terraineditor){ } /// /// ()) +/// /// public float TerrainEditor_getBrushPressure(string terraineditor){ @@ -20751,6 +28879,7 @@ public float TerrainEditor_getBrushPressure(string terraineditor){ } /// /// ()) +/// /// public string TerrainEditor_getBrushSize(string terraineditor){ @@ -20759,6 +28888,7 @@ public string TerrainEditor_getBrushSize(string terraineditor){ } /// /// ()) +/// /// public float TerrainEditor_getBrushSoftness(string terraineditor){ @@ -20767,6 +28897,7 @@ public float TerrainEditor_getBrushSoftness(string terraineditor){ } /// /// ()) +/// /// public string TerrainEditor_getBrushType(string terraineditor){ @@ -20775,6 +28906,7 @@ public string TerrainEditor_getBrushType(string terraineditor){ } /// /// ) +/// /// public string TerrainEditor_getCurrentAction(string terraineditor){ @@ -20783,6 +28915,7 @@ public string TerrainEditor_getCurrentAction(string terraineditor){ } /// /// Returns the current material count. ) +/// /// public int TerrainEditor_getMaterialCount(string terraineditor){ @@ -20791,6 +28924,7 @@ public int TerrainEditor_getMaterialCount(string terraineditor){ } /// /// ( string name ) - Returns the index of the material with the given name or -1. ) +/// /// public int TerrainEditor_getMaterialIndex(string terraineditor, string name){ @@ -20799,6 +28933,7 @@ public int TerrainEditor_getMaterialIndex(string terraineditor, string name){ } /// /// ( int index ) - Returns the name of the material at the given index. ) +/// /// public string TerrainEditor_getMaterialName(string terraineditor, int index){ @@ -20807,6 +28942,7 @@ public string TerrainEditor_getMaterialName(string terraineditor, int index){ } /// /// () gets the list of current terrain materials.) +/// /// public string TerrainEditor_getMaterials(string terraineditor){ @@ -20815,6 +28951,7 @@ public string TerrainEditor_getMaterials(string terraineditor){ } /// /// ) +/// /// public int TerrainEditor_getNumActions(string terraineditor){ @@ -20823,6 +28960,7 @@ public int TerrainEditor_getNumActions(string terraineditor){ } /// /// ) +/// /// public int TerrainEditor_getNumTextures(string terraineditor){ @@ -20831,6 +28969,7 @@ public int TerrainEditor_getNumTextures(string terraineditor){ } /// /// ) +/// /// public float TerrainEditor_getSlopeLimitMaxAngle(string terraineditor){ @@ -20839,6 +28978,7 @@ public float TerrainEditor_getSlopeLimitMaxAngle(string terraineditor){ } /// /// ) +/// /// public float TerrainEditor_getSlopeLimitMinAngle(string terraineditor){ @@ -20847,6 +28987,7 @@ public float TerrainEditor_getSlopeLimitMinAngle(string terraineditor){ } /// /// (S32 index)) +/// /// public int TerrainEditor_getTerrainBlock(string terraineditor, int index){ @@ -20855,6 +28996,7 @@ public int TerrainEditor_getTerrainBlock(string terraineditor, int index){ } /// /// ()) +/// /// public int TerrainEditor_getTerrainBlockCount(string terraineditor){ @@ -20863,6 +29005,7 @@ public int TerrainEditor_getTerrainBlockCount(string terraineditor){ } /// /// () gets the list of current terrain materials for all terrain blocks.) +/// /// public string TerrainEditor_getTerrainBlocksMaterialList(string terraineditor){ @@ -20870,7 +29013,12 @@ public string TerrainEditor_getTerrainBlocksMaterialList(string terraineditor){ return m_ts.fn_TerrainEditor_getTerrainBlocksMaterialList(terraineditor); } /// -/// , , ), (x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found).) +/// , , ), +/// (x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found).) +/// /// public int TerrainEditor_getTerrainUnderWorldPoint(string terraineditor, string ptOrX = "", string Y = "", string Z = ""){ @@ -20879,6 +29027,7 @@ public int TerrainEditor_getTerrainUnderWorldPoint(string terraineditor, string } /// /// ) +/// /// public void TerrainEditor_markEmptySquares(string terraineditor){ @@ -20887,6 +29036,7 @@ public void TerrainEditor_markEmptySquares(string terraineditor){ } /// /// ) +/// /// public void TerrainEditor_mirrorTerrain(string terraineditor, int mirrorIndex){ @@ -20895,6 +29045,7 @@ public void TerrainEditor_mirrorTerrain(string terraineditor, int mirrorIndex){ } /// /// ), (string action=NULL)) +/// /// public void TerrainEditor_processAction(string terraineditor, string action = ""){ @@ -20903,6 +29054,7 @@ public void TerrainEditor_processAction(string terraineditor, string action = " } /// /// ( int index ) - Remove the material at the given index. ) +/// /// public void TerrainEditor_removeMaterial(string terraineditor, int index){ @@ -20910,7 +29062,9 @@ public void TerrainEditor_removeMaterial(string terraineditor, int index){ m_ts.fn_TerrainEditor_removeMaterial(terraineditor, index); } /// -/// ( int index, int order ) - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// ( int index, int order ) +/// - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// /// public void TerrainEditor_reorderMaterial(string terraineditor, int index, int orderPos){ @@ -20919,6 +29073,7 @@ public void TerrainEditor_reorderMaterial(string terraineditor, int index, int } /// /// (bool clear)) +/// /// public void TerrainEditor_resetSelWeights(string terraineditor, bool clear){ @@ -20927,6 +29082,7 @@ public void TerrainEditor_resetSelWeights(string terraineditor, bool clear){ } /// /// (string action_name)) +/// /// public void TerrainEditor_setAction(string terraineditor, string action_name){ @@ -20935,6 +29091,7 @@ public void TerrainEditor_setAction(string terraineditor, string action_name){ } /// /// Location) +/// /// public void TerrainEditor_setBrushPos(string terraineditor, Point2I pos){ @@ -20943,6 +29100,7 @@ public void TerrainEditor_setBrushPos(string terraineditor, Point2I pos){ } /// /// (float pressure)) +/// /// public void TerrainEditor_setBrushPressure(string terraineditor, float pressure){ @@ -20951,6 +29109,7 @@ public void TerrainEditor_setBrushPressure(string terraineditor, float pressure } /// /// (int w [, int h])) +/// /// public void TerrainEditor_setBrushSize(string terraineditor, int w, int h = 0){ @@ -20959,6 +29118,7 @@ public void TerrainEditor_setBrushSize(string terraineditor, int w, int h = 0){ } /// /// (float softness)) +/// /// public void TerrainEditor_setBrushSoftness(string terraineditor, float softness){ @@ -20966,7 +29126,9 @@ public void TerrainEditor_setBrushSoftness(string terraineditor, float softness m_ts.fn_TerrainEditor_setBrushSoftness(terraineditor, softness); } /// -/// (string type) One of box, ellipse, selection.) +/// (string type) +/// One of box, ellipse, selection.) +/// /// public void TerrainEditor_setBrushType(string terraineditor, string type){ @@ -20975,6 +29137,7 @@ public void TerrainEditor_setBrushType(string terraineditor, string type){ } /// /// ) +/// /// public float TerrainEditor_setSlopeLimitMaxAngle(string terraineditor, float angle){ @@ -20983,6 +29146,7 @@ public float TerrainEditor_setSlopeLimitMaxAngle(string terraineditor, float an } /// /// ) +/// /// public float TerrainEditor_setSlopeLimitMinAngle(string terraineditor, float angle){ @@ -20991,6 +29155,7 @@ public float TerrainEditor_setSlopeLimitMinAngle(string terraineditor, float an } /// /// (bool overlayEnable) - sets the terraformer current heightmap to draw as an overlay over the current terrain.) +/// /// public void TerrainEditor_setTerraformOverlay(string terraineditor, bool overlayEnable){ @@ -20998,7 +29163,9 @@ public void TerrainEditor_setTerraformOverlay(string terraineditor, bool overla m_ts.fn_TerrainEditor_setTerraformOverlay(terraineditor, overlayEnable); } /// -/// ( int index, string matName ) Changes the material name at the index. ) +/// ( int index, string matName ) +/// Changes the material name at the index. ) +/// /// public bool TerrainEditor_updateMaterial(string terraineditor, uint index, string matName){ @@ -21011,14 +29178,9 @@ public bool TerrainEditor_updateMaterial(string terraineditor, uint index, stri /// public class TerrainSmoothActionObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainSmoothActionObject(ref Omni ts){m_ts = ts;} /// /// ( TerrainBlock obj, F32 factor, U32 steps )) +/// /// public void TerrainSmoothAction_smooth(string terrainsmoothaction, string terrain, float factor, uint steps){ @@ -21031,14 +29193,9 @@ public void TerrainSmoothAction_smooth(string terrainsmoothaction, string terra /// public class TerrainSolderEdgesActionObject { -private Omni m_ts; - /// - /// - /// - /// -public TerrainSolderEdgesActionObject(ref Omni ts){m_ts = ts;} /// /// () ) +/// /// public void TerrainSolderEdgesAction_solder(string terrainsolderedgesaction){ @@ -21051,14 +29208,9 @@ public void TerrainSolderEdgesAction_solder(string terrainsolderedgesaction){ /// public class TheoraTextureObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public TheoraTextureObjectObject(ref Omni ts){m_ts = ts;} /// /// Pause playback of the video. ) +/// /// public void TheoraTextureObject_pause(string theoratextureobject){ @@ -21067,6 +29219,7 @@ public void TheoraTextureObject_pause(string theoratextureobject){ } /// /// Start playback of the video. ) +/// /// public void TheoraTextureObject_play(string theoratextureobject){ @@ -21075,6 +29228,7 @@ public void TheoraTextureObject_play(string theoratextureobject){ } /// /// Stop playback of the video. ) +/// /// public void TheoraTextureObject_stop(string theoratextureobject){ @@ -21087,14 +29241,9 @@ public void TheoraTextureObject_stop(string theoratextureobject){ /// public class TimeOfDayObject { -private Omni m_ts; - /// - /// - /// - /// -public TimeOfDayObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void addTimeOfDayEvent(string timeofday, float elevation, string identifier){ @@ -21103,6 +29252,7 @@ public void addTimeOfDayEvent(string timeofday, float elevation, string identif } /// /// ) +/// /// public void animate(string timeofday, float elevation, float degreesPerSecond){ @@ -21111,6 +29261,7 @@ public void animate(string timeofday, float elevation, float degreesPerSecond){ } /// /// ) +/// /// public void setDayLength(string timeofday, float seconds){ @@ -21119,6 +29270,7 @@ public void setDayLength(string timeofday, float seconds){ } /// /// ) +/// /// public void setPlay(string timeofday, bool enabled){ @@ -21127,6 +29279,7 @@ public void setPlay(string timeofday, bool enabled){ } /// /// ) +/// /// public void setTimeOfDay(string timeofday, float time){ @@ -21139,14 +29292,10 @@ public void setTimeOfDay(string timeofday, float time){ /// public class TriggerObject { -private Omni m_ts; - /// - /// - /// - /// -public TriggerObject(ref Omni ts){m_ts = ts;} /// -/// @brief Get the number of objects that are within the Trigger's bounds. @see getObject()) +/// @brief Get the number of objects that are within the Trigger's bounds. +/// @see getObject()) +/// /// public int getNumObjects(string trigger){ @@ -21154,7 +29303,11 @@ public int getNumObjects(string trigger){ return m_ts.fnTrigger_getNumObjects(trigger); } /// -/// @brief Retrieve the requested object that is within the Trigger's bounds. @param index Index of the object to get (range is 0 to getNumObjects()-1) @returns The SimObjectID of the object, or -1 if the requested index is invalid. @see getNumObjects()) +/// @brief Retrieve the requested object that is within the Trigger's bounds. +/// @param index Index of the object to get (range is 0 to getNumObjects()-1) +/// @returns The SimObjectID of the object, or -1 if the requested index is invalid. +/// @see getNumObjects()) +/// /// public int getObject(string trigger, int index){ @@ -21167,14 +29320,12 @@ public int getObject(string trigger, int index){ /// public class TSAttachableObject { -private Omni m_ts; - /// - /// - /// - /// -public TSAttachableObject(ref Omni ts){m_ts = ts;} /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool attachObject(string tsattachable, string obj){ @@ -21182,7 +29333,14 @@ public bool attachObject(string tsattachable, string obj){ return m_ts.fnTSAttachable_attachObject(tsattachable, obj); } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void detachAll(string tsattachable){ @@ -21190,7 +29348,11 @@ public void detachAll(string tsattachable){ m_ts.fnTSAttachable_detachAll(tsattachable); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool detachObject(string tsattachable, string obj){ @@ -21199,6 +29361,7 @@ public bool detachObject(string tsattachable, string obj){ } /// /// Returns the attachment at the passed index value.) +/// /// public string getAttachment(string tsattachable, int index = 0){ @@ -21207,6 +29370,7 @@ public string getAttachment(string tsattachable, int index = 0){ } /// /// Returns the number of objects that are currently attached.) +/// /// public int getNumAttachments(string tsattachable){ @@ -21219,14 +29383,26 @@ public int getNumAttachments(string tsattachable){ /// public class TSDynamicObject { -private Omni m_ts; - /// - /// - /// - /// -public TSDynamicObject(ref Omni ts){m_ts = ts;} /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void changeMaterial(string tsdynamic, string mapTo = "", string oldMat = null , string newMat = null ){ if (oldMat== null) {oldMat = null;} @@ -21236,7 +29412,15 @@ public void changeMaterial(string tsdynamic, string mapTo = "", string oldMat = m_ts.fnTSDynamic_changeMaterial(tsdynamic, mapTo, oldMat, newMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string getModelFile(string tsdynamic){ @@ -21244,7 +29428,10 @@ public string getModelFile(string tsdynamic){ return m_ts.fnTSDynamic_getModelFile(tsdynamic); } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int getTargetCount(string tsdynamic){ @@ -21252,7 +29439,11 @@ public int getTargetCount(string tsdynamic){ return m_ts.fnTSDynamic_getTargetCount(tsdynamic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string getTargetName(string tsdynamic, int index = 0){ @@ -21265,14 +29456,9 @@ public string getTargetName(string tsdynamic, int index = 0){ /// public class TSPathShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public TSPathShapeObject(ref Omni ts){m_ts = ts;} /// /// Returns the looping state for the shape.) +/// /// public bool getLooping(string tspathshape){ @@ -21281,6 +29467,7 @@ public bool getLooping(string tspathshape){ } /// /// Returns the number of nodes on the shape's path.) +/// /// public int getNodeCount(string tspathshape){ @@ -21289,6 +29476,7 @@ public int getNodeCount(string tspathshape){ } /// /// Get the current position of the shape along the path (0.0 - lastNode - 1).) +/// /// public float getPathPosition(string tspathshape){ @@ -21296,7 +29484,12 @@ public float getPathPosition(string tspathshape){ return m_ts.fnTSPathShape_getPathPosition(tspathshape); } /// -/// Removes the knot at the front of the shape's path. @tsexample // Remove the first knot in the shape's path. %pathShape.popFront(); @endtsexample) +/// Removes the knot at the front of the shape's path. +/// @tsexample +/// // Remove the first knot in the shape's path. +/// %pathShape.popFront(); +/// @endtsexample) +/// /// public void popFront(string tspathshape){ @@ -21304,7 +29497,25 @@ public void popFront(string tspathshape){ m_ts.fnTSPathShape_popFront(tspathshape); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the back of its path %pathShape.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the back of its path +/// %pathShape.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void pushBack(string tspathshape, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -21312,7 +29523,25 @@ public void pushBack(string tspathshape, TransformF transform, float speed = 1. m_ts.fnTSPathShape_pushBack(tspathshape, transform.AsString(), speed, type, path); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the front of its path %pathShape.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the front of its path +/// %pathShape.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void pushFront(string tspathshape, TransformF transform, float speed = 1.0f, string type = "Normal", string path = "Linear"){ @@ -21320,7 +29549,13 @@ public void pushFront(string tspathshape, TransformF transform, float speed = 1 m_ts.fnTSPathShape_pushFront(tspathshape, transform.AsString(), speed, type, path); } /// -/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. When makeFirstKnot is true a new knot is created and pushed onto the path. @param speed Speed for the first knot if created. @param makeFirstKnot Initialize a new path with the current shape transform. @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. +/// The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. +/// When makeFirstKnot is true a new knot is created and pushed onto the path. +/// @param speed Speed for the first knot if created. +/// @param makeFirstKnot Initialize a new path with the current shape transform. +/// @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// /// public void reset(string tspathshape, float speed = 1.0f, bool makeFirstKnot = true, bool initFromPath = true){ @@ -21328,7 +29563,9 @@ public void reset(string tspathshape, float speed = 1.0f, bool makeFirstKnot = m_ts.fnTSPathShape_reset(tspathshape, speed, makeFirstKnot, initFromPath); } /// -/// Sets whether the path should loop or stop at the last node. @param isLooping New loop flag true/false.) +/// Sets whether the path should loop or stop at the last node. +/// @param isLooping New loop flag true/false.) +/// /// public void setLooping(string tspathshape, bool isLooping = true){ @@ -21336,7 +29573,9 @@ public void setLooping(string tspathshape, bool isLooping = true){ m_ts.fnTSPathShape_setLooping(tspathshape, isLooping); } /// -/// Set the movement state for this shape. @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// Set the movement state for this shape. +/// @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// /// public void setMoveState(string tspathshape, TypePathShapeState newState = null ){ if (newState== null) {newState = TypePathShapeState.Forward;} @@ -21345,7 +29584,9 @@ public void setMoveState(string tspathshape, TypePathShapeState newState = null m_ts.fnTSPathShape_setMoveState(tspathshape, (int)newState ); } /// -/// Set the current position of the shape along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// Set the current position of the shape along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// /// public void setPathPosition(string tspathshape, float position = 0.0f){ @@ -21353,7 +29594,13 @@ public void setPathPosition(string tspathshape, float position = 0.0f){ m_ts.fnTSPathShape_setPathPosition(tspathshape, position); } /// -/// @brief Set the movement target for this shape along its path. The shape will attempt to move along the path to the given target without going past the loop node. Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target state will be cleared. @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the shape to move to along its path.) +/// @brief Set the movement target for this shape along its path. +/// The shape will attempt to move along the path to the given target without going past the loop node. +/// Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target +/// state will be cleared. +/// @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the +/// shape to move to along its path.) +/// /// public void setTarget(string tspathshape, float position = 1.0f){ @@ -21366,14 +29613,33 @@ public void setTarget(string tspathshape, float position = 1.0f){ /// public class TSShapeConstructorObject { -private Omni m_ts; - /// - /// - /// - /// -public TSShapeConstructorObject(ref Omni ts){m_ts = ts;} /// -/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls may optionally be converted to boxes, spheres and/or capsules based on their volume. @param size size for this detail level @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, 26-dop, convex hulls. See the Shape Editor documentation for more details about these types. @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the whole shape), or the name of an object in the shape @param depth maximum split recursion depth (hulls only) @param merge volume % threshold used to merge hulls together (hulls only) @param concavity volume % threshold used to detect concavity (hulls only) @param maxVerts maximum number of vertices per hull (hulls only) @param boxMaxError max % volume difference for a hull to be converted to a box (hulls only) @param sphereMaxError max % volume difference for a hull to be converted to a sphere (hulls only) @param capsuleMaxError max % volume difference for a hull to be converted to a capsule (hulls only) @return true if successful, false otherwise @tsexample %this.addCollisionDetail( -1, \"box\", \"bounds\" ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); @endtsexample ) +/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls +/// may optionally be converted to boxes, spheres and/or capsules based on their +/// volume. +/// @param size size for this detail level +/// @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, +/// 26-dop, convex hulls. See the Shape Editor documentation for more details +/// about these types. +/// @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the +/// whole shape), or the name of an object in the shape +/// @param depth maximum split recursion depth (hulls only) +/// @param merge volume % threshold used to merge hulls together (hulls only) +/// @param concavity volume % threshold used to detect concavity (hulls only) +/// @param maxVerts maximum number of vertices per hull (hulls only) +/// @param boxMaxError max % volume difference for a hull to be converted to a +/// box (hulls only) +/// @param sphereMaxError max % volume difference for a hull to be converted to +/// a sphere (hulls only) +/// @param capsuleMaxError max % volume difference for a hull to be converted to +/// a capsule (hulls only) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addCollisionDetail( -1, \"box\", \"bounds\" ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); +/// @endtsexample ) +/// /// public bool addCollisionDetail(string tsshapeconstructor, int size, string type, string target, int depth = 4, float merge = 30, float concavity = 30, int maxVerts = 32, float boxMaxError = 0, float sphereMaxError = 0, float capsuleMaxError = 0){ @@ -21381,7 +29647,35 @@ public bool addCollisionDetail(string tsshapeconstructor, int size, string type return m_ts.fnTSShapeConstructor_addCollisionDetail(tsshapeconstructor, size, type, target, depth, merge, concavity, maxVerts, boxMaxError, sphereMaxError, capsuleMaxError); } /// -/// Add (or edit) an imposter detail level to the shape. If the shape already contains an imposter detail level, this command will simply change the imposter settings @param size size of the imposter detail level @param equatorSteps defines the number of snapshots to take around the equator. Imagine the object being rotated around the vertical axis, then a snapshot taken at regularly spaced intervals. @param polarSteps defines the number of snapshots taken between the poles (top and bottom), at each equator step. eg. At each equator snapshot, snapshots are taken at regular intervals between the poles. @param dl the detail level to use when generating the snapshots. Note that this is an array index rather than a detail size. So if an object has detail sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots using detail size 150. @param dim defines the size of the imposter images in pixels. The larger the number, the more detailed the billboard will be. @param includePoles flag indicating whether to include the \"pole\" snapshots. ie. the views from the top and bottom of the object. @param polar_angle if pole snapshots are active (@a includePoles is true), this parameter defines the camera angle (in degrees) within which to render the pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot taken at the pole (looking directly down or up at the object) will be rendered when the camera is within 25 degrees of the pole. @return true if successful, false otherwise @tsexample %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level @endtsexample ) +/// Add (or edit) an imposter detail level to the shape. +/// If the shape already contains an imposter detail level, this command will +/// simply change the imposter settings +/// @param size size of the imposter detail level +/// @param equatorSteps defines the number of snapshots to take around the +/// equator. Imagine the object being rotated around the vertical axis, then +/// a snapshot taken at regularly spaced intervals. +/// @param polarSteps defines the number of snapshots taken between the poles +/// (top and bottom), at each equator step. eg. At each equator snapshot, +/// snapshots are taken at regular intervals between the poles. +/// @param dl the detail level to use when generating the snapshots. Note that +/// this is an array index rather than a detail size. So if an object has detail +/// sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots +/// using detail size 150. +/// @param dim defines the size of the imposter images in pixels. The larger the +/// number, the more detailed the billboard will be. +/// @param includePoles flag indicating whether to include the \"pole\" snapshots. +/// ie. the views from the top and bottom of the object. +/// @param polar_angle if pole snapshots are active (@a includePoles is true), this +/// parameter defines the camera angle (in degrees) within which to render the +/// pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot +/// taken at the pole (looking directly down or up at the object) will be rendered +/// when the camera is within 25 degrees of the pole. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); +/// %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level +/// @endtsexample ) +/// /// public int addImposter(string tsshapeconstructor, int size, int equatorSteps, int polarSteps, int dl, int dim, bool includePoles, float polarAngle){ @@ -21389,7 +29683,21 @@ public int addImposter(string tsshapeconstructor, int size, int equatorSteps, i return m_ts.fnTSShapeConstructor_addImposter(tsshapeconstructor, size, equatorSteps, polarSteps, dl, dim, includePoles, polarAngle); } /// -/// Add geometry from another DTS or DAE shape file into this shape. Any materials required by the source mesh are also copied into this shape.br> @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param srcShape name of a shape file (DTS or DAE) that contains the mesh @param srcMesh the full name (object name + detail size) of the mesh to copy from the DTS/DAE file into this shape/li> @return true if successful, false otherwise @tsexample %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); @endtsexample ) +/// Add geometry from another DTS or DAE shape file into this shape. +/// Any materials required by the source mesh are also copied into this shape.br> +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param srcShape name of a shape file (DTS or DAE) that contains the mesh +/// @param srcMesh the full name (object name + detail size) of the mesh to +/// copy from the DTS/DAE file into this shape/li> +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); +/// %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); +/// @endtsexample ) +/// /// public bool addMesh(string tsshapeconstructor, string meshName, string srcShape, string srcMesh){ @@ -21397,7 +29705,21 @@ public bool addMesh(string tsshapeconstructor, string meshName, string srcShape return m_ts.fnTSShapeConstructor_addMesh(tsshapeconstructor, meshName, srcShape, srcMesh); } /// -/// Add a new node. @param name name for the new node (must not already exist) @param parentName name of an existing node to be the parent of the new node. If empty (\"\"), the new node will be at the root level of the node hierarchy. @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); @endtsexample ) +/// Add a new node. +/// @param name name for the new node (must not already exist) +/// @param parentName name of an existing node to be the parent of the new node. +/// If empty (\"\"), the new node will be at the root level of the node hierarchy. +/// @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); +/// %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); +/// %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool addNode(string tsshapeconstructor, string name, string parentName, TransformF txfm = null , bool isWorld = false){ if (txfm== null) {txfm = new TransformF(0,0,0,0,0,1,0);} @@ -21406,7 +29728,29 @@ public bool addNode(string tsshapeconstructor, string name, string parentName, return m_ts.fnTSShapeConstructor_addNode(tsshapeconstructor, name, parentName, txfm.AsString(), isWorld); } /// -/// Add a new mesh primitive to the shape. @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param type one of: \"box\", \"sphere\", \"capsule\" @param params mesh primitive parameters: ul> li>for box: \"size_x size_y size_z\"/li> li>for sphere: \"radius\"/li> li>for capsule: \"height radius\"/li> /ul> /ul> @param txfm local transform offset from the node for this mesh @param nodeName name of the node to attach the new mesh to (will change the object's node if adding a new mesh to an existing object) @return true if successful, false otherwise @tsexample %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); @endtsexample ) +/// Add a new mesh primitive to the shape. +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param type one of: \"box\", \"sphere\", \"capsule\" +/// @param params mesh primitive parameters: +/// ul> +/// li>for box: \"size_x size_y size_z\"/li> +/// li>for sphere: \"radius\"/li> +/// li>for capsule: \"height radius\"/li> +/// /ul> +/// /ul> +/// @param txfm local transform offset from the node for this mesh +/// @param nodeName name of the node to attach the new mesh to (will change the +/// object's node if adding a new mesh to an existing object) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); +/// %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); +/// %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); +/// @endtsexample ) +/// /// public bool addPrimitive(string tsshapeconstructor, string meshName, string type, string paramsx, TransformF txfm, string nodeName){ @@ -21414,7 +29758,34 @@ public bool addPrimitive(string tsshapeconstructor, string meshName, string typ return m_ts.fnTSShapeConstructor_addPrimitive(tsshapeconstructor, meshName, type, paramsx, txfm.AsString(), nodeName); } /// -/// Add a new sequence to the shape. @param source the name of an existing sequence, or the name of a DTS or DAE shape or DSQ sequence file. When the shape file contains more than one sequence, the desired sequence can be specified by appending the name to the end of the shape file. eg. \"myShape.dts run\" would select the \"run\" sequence from the \"myShape.dts\" file. @param name name of the new sequence @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose rotation to the target shape root pose. @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose position to the target shape root pose. @return true if successful, false otherwise @tsexample %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); %this.addSequence( \"./myPlayer.dae run\", \"run\" ); %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end @endtsexample ) +/// Add a new sequence to the shape. +/// @param source the name of an existing sequence, or the name of a DTS or DAE +/// shape or DSQ sequence file. When the shape file contains more than one +/// sequence, the desired sequence can be specified by appending the name to the +/// end of the shape file. eg. \"myShape.dts run\" would select the \"run\" +/// sequence from the \"myShape.dts\" file. +/// @param name name of the new sequence +/// @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. +/// @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. +/// @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose rotation to the target shape root pose. +/// @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose position to the target shape root pose. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); +/// %this.addSequence( \"./myPlayer.dae run\", \"run\" ); +/// %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end +/// %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 +/// %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end +/// @endtsexample ) +/// /// public bool addSequence(string tsshapeconstructor, string source, string name, int start = 0, int end = -1, bool padRot = true, bool padTrans = false){ @@ -21422,7 +29793,16 @@ public bool addSequence(string tsshapeconstructor, string source, string name, return m_ts.fnTSShapeConstructor_addSequence(tsshapeconstructor, source, name, start, end, padRot, padTrans); } /// -/// Add a new trigger to the sequence. @param name name of the sequence to modify @param keyframe keyframe of the new trigger @param state of the new trigger @return true if successful, false otherwise @tsexample %this.addTrigger( \"walk\", 3, 1 ); %this.addTrigger( \"walk\", 5, -1 ); @endtsexample ) +/// Add a new trigger to the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the new trigger +/// @param state of the new trigger +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addTrigger( \"walk\", 3, 1 ); +/// %this.addTrigger( \"walk\", 5, -1 ); +/// @endtsexample ) +/// /// public bool addTrigger(string tsshapeconstructor, string name, int keyframe, int state){ @@ -21430,7 +29810,14 @@ public bool addTrigger(string tsshapeconstructor, string name, int keyframe, in return m_ts.fnTSShapeConstructor_addTrigger(tsshapeconstructor, name, keyframe, state); } /// -/// Dump the shape hierarchy to the console or to a file. Useful for reviewing the result of a series of construction commands. @param filename Destination filename. If not specified, dump to console. @tsexample %this.dumpShape(); // dump to console %this.dumpShape( \"./dump.txt\" ); // dump to file @endtsexample ) +/// Dump the shape hierarchy to the console or to a file. Useful for reviewing +/// the result of a series of construction commands. +/// @param filename Destination filename. If not specified, dump to console. +/// @tsexample +/// %this.dumpShape(); // dump to console +/// %this.dumpShape( \"./dump.txt\" ); // dump to file +/// @endtsexample ) +/// /// public void dumpShape(string tsshapeconstructor, string filename = ""){ @@ -21438,7 +29825,9 @@ public void dumpShape(string tsshapeconstructor, string filename = ""){ m_ts.fnTSShapeConstructor_dumpShape(tsshapeconstructor, filename); } /// -/// Get the bounding box for the shape. @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// Get the bounding box for the shape. +/// @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// /// public Box3F getBounds(string tsshapeconstructor){ @@ -21446,7 +29835,9 @@ public Box3F getBounds(string tsshapeconstructor){ return new Box3F ( m_ts.fnTSShapeConstructor_getBounds(tsshapeconstructor)); } /// -/// Get the total number of detail levels in the shape. @return the number of detail levels in the shape ) +/// Get the total number of detail levels in the shape. +/// @return the number of detail levels in the shape ) +/// /// public int getDetailLevelCount(string tsshapeconstructor){ @@ -21454,7 +29845,15 @@ public int getDetailLevelCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getDetailLevelCount(tsshapeconstructor); } /// -/// Get the index of the detail level with a given size. @param size size of the detail level to lookup @return index of the detail level with the desired size, or -1 if no such detail exists @tsexample if ( %this.getDetailLevelSize( 32 ) == -1 ) echo( \"Error: This shape does not have a detail level at size 32\" ); @endtsexample ) +/// Get the index of the detail level with a given size. +/// @param size size of the detail level to lookup +/// @return index of the detail level with the desired size, or -1 if no such +/// detail exists +/// @tsexample +/// if ( %this.getDetailLevelSize( 32 ) == -1 ) +/// echo( \"Error: This shape does not have a detail level at size 32\" ); +/// @endtsexample ) +/// /// public int getDetailLevelIndex(string tsshapeconstructor, int size){ @@ -21462,7 +29861,16 @@ public int getDetailLevelIndex(string tsshapeconstructor, int size){ return m_ts.fnTSShapeConstructor_getDetailLevelIndex(tsshapeconstructor, size); } /// -/// Get the name of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level name @tsexample // print the names of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getDetailLevelName( %i ) ); @endtsexample ) +/// Get the name of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level name +/// @tsexample +/// // print the names of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getDetailLevelName( %i ) ); +/// @endtsexample ) +/// /// public string getDetailLevelName(string tsshapeconstructor, int index){ @@ -21470,7 +29878,16 @@ public string getDetailLevelName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getDetailLevelName(tsshapeconstructor, index); } /// -/// Get the size of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level size @tsexample // print the sizes of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); @endtsexample ) +/// Get the size of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level size +/// @tsexample +/// // print the sizes of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); +/// @endtsexample ) +/// /// public int getDetailLevelSize(string tsshapeconstructor, int index){ @@ -21478,7 +29895,10 @@ public int getDetailLevelSize(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getDetailLevelSize(tsshapeconstructor, index); } /// -/// Get the index of the imposter (auto-billboard) detail level (if any). @return imposter detail level index, or -1 if the shape does not use imposters. ) +/// Get the index of the imposter (auto-billboard) detail level (if any). +/// @return imposter detail level index, or -1 if the shape does not use +/// imposters. ) +/// /// public int getImposterDetailLevel(string tsshapeconstructor){ @@ -21486,7 +29906,26 @@ public int getImposterDetailLevel(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getImposterDetailLevel(tsshapeconstructor); } /// -/// Get the settings used to generate imposters for the indexed detail level. @param index index of the detail level to query (does not need to be an imposter detail level @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: dl> dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> dt>eqSteps/dt>dd>number of steps around the equator/dd> dt>pSteps/dt>dd>number of steps between the poles/dd> dt>dl/dt>dd>index of the detail level used to generate imposters/dd> dt>dim/dt>dd>size (in pixels) of each imposter image/dd> dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> dt>angle/dt>dd>angle at which to display pole images/dd> /dl> @tsexample // print the imposter detail level settings %index = %this.getImposterDetailLevel(); if ( %index != -1 ) echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); @endtsexample ) +/// Get the settings used to generate imposters for the indexed detail level. +/// @param index index of the detail level to query (does not need to be an +/// imposter detail level +/// @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: +/// dl> +/// dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> +/// dt>eqSteps/dt>dd>number of steps around the equator/dd> +/// dt>pSteps/dt>dd>number of steps between the poles/dd> +/// dt>dl/dt>dd>index of the detail level used to generate imposters/dd> +/// dt>dim/dt>dd>size (in pixels) of each imposter image/dd> +/// dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> +/// dt>angle/dt>dd>angle at which to display pole images/dd> +/// /dl> +/// @tsexample +/// // print the imposter detail level settings +/// %index = %this.getImposterDetailLevel(); +/// if ( %index != -1 ) +/// echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); +/// @endtsexample ) +/// /// public string getImposterSettings(string tsshapeconstructor, int index){ @@ -21494,7 +29933,13 @@ public string getImposterSettings(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getImposterSettings(tsshapeconstructor, index); } /// -/// Get the number of meshes (detail levels) for the specified object. @param name name of the object to query @return the number of meshes for this object. @tsexample %count = %this.getMeshCount( \"SimpleShape\" ); @endtsexample ) +/// Get the number of meshes (detail levels) for the specified object. +/// @param name name of the object to query +/// @return the number of meshes for this object. +/// @tsexample +/// %count = %this.getMeshCount( \"SimpleShape\" ); +/// @endtsexample ) +/// /// public int getMeshCount(string tsshapeconstructor, string name){ @@ -21502,7 +29947,14 @@ public int getMeshCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getMeshCount(tsshapeconstructor, name); } /// -/// Get the name of the material attached to a mesh. Note that only the first material used by the mesh is returned. @param name full name (object name + detail size) of the mesh to query @return name of the material attached to the mesh (suitable for use with the Material mapTo field) @tsexample echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the name of the material attached to a mesh. Note that only the first +/// material used by the mesh is returned. +/// @param name full name (object name + detail size) of the mesh to query +/// @return name of the material attached to the mesh (suitable for use with the Material mapTo field) +/// @tsexample +/// echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string getMeshMaterial(string tsshapeconstructor, string name){ @@ -21510,7 +29962,22 @@ public string getMeshMaterial(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getMeshMaterial(tsshapeconstructor, name); } /// -/// Get the name of the indexed mesh (detail level) for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh name. @tsexample // print the names of all meshes in the shape %objCount = %this.getObjectCount(); for ( %i = 0; %i %objCount; %i++ ) { %objName = %this.getObjectName( %i ); %meshCount = %this.getMeshCount( %objName ); for ( %j = 0; %j %meshCount; %j++ ) echo( %this.getMeshName( %objName, %j ) ); } @endtsexample ) +/// Get the name of the indexed mesh (detail level) for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh name. +/// @tsexample +/// // print the names of all meshes in the shape +/// %objCount = %this.getObjectCount(); +/// for ( %i = 0; %i %objCount; %i++ ) +/// { +/// %objName = %this.getObjectName( %i ); +/// %meshCount = %this.getMeshCount( %objName ); +/// for ( %j = 0; %j %meshCount; %j++ ) +/// echo( %this.getMeshName( %objName, %j ) ); +/// } +/// @endtsexample ) +/// /// public string getMeshName(string tsshapeconstructor, string name, int index){ @@ -21518,7 +29985,18 @@ public string getMeshName(string tsshapeconstructor, string name, int index){ return m_ts.fnTSShapeConstructor_getMeshName(tsshapeconstructor, name, index); } /// -/// Get the detail level size of the indexed mesh for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh detail level size. @tsexample // print sizes for all detail levels of this object %objName = \"trunk\"; %count = %this.getMeshCount( %objName ); for ( %i = 0; %i %count; %i++ ) echo( %this.getMeshSize( %objName, %i ) ); @endtsexample ) +/// Get the detail level size of the indexed mesh for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh detail level size. +/// @tsexample +/// // print sizes for all detail levels of this object +/// %objName = \"trunk\"; +/// %count = %this.getMeshCount( %objName ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getMeshSize( %objName, %i ) ); +/// @endtsexample ) +/// /// public int getMeshSize(string tsshapeconstructor, string name, int index){ @@ -21526,7 +30004,16 @@ public int getMeshSize(string tsshapeconstructor, string name, int index){ return m_ts.fnTSShapeConstructor_getMeshSize(tsshapeconstructor, name, index); } /// -/// Get the display type of the mesh. @param name name of the mesh to query @return the string returned is one of: dl>dt>normal/dt>dd>a normal 3D mesh/dd> dt>billboard/dt>dd>a mesh that always faces the camera/dd> dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> @tsexample echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the display type of the mesh. +/// @param name name of the mesh to query +/// @return the string returned is one of: +/// dl>dt>normal/dt>dd>a normal 3D mesh/dd> +/// dt>billboard/dt>dd>a mesh that always faces the camera/dd> +/// dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> +/// @tsexample +/// echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string getMeshType(string tsshapeconstructor, string name){ @@ -21534,7 +30021,13 @@ public string getMeshType(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getMeshType(tsshapeconstructor, name); } /// -/// Get the number of children of this node. @param name name of the node to query. @return the number of child nodes. @tsexample %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the number of children of this node. +/// @param name name of the node to query. +/// @return the number of child nodes. +/// @tsexample +/// %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int getNodeChildCount(string tsshapeconstructor, string name){ @@ -21542,7 +30035,32 @@ public int getNodeChildCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeChildCount(tsshapeconstructor, name); } /// -/// Get the name of the indexed child node. @param name name of the parent node to query. @param index index of the child node (valid range is 0 - getNodeChildName()-1). @return the name of the indexed child node. @tsexample function dumpNode( %shape, %name, %indent ) { echo( %indent @ %name ); %count = %shape.getNodeChildCount( %name ); for ( %i = 0; %i %count; %i++ ) dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); } function dumpShape( %shape ) { // recursively dump node hierarchy %count = %shape.getNodeCount(); for ( %i = 0; %i %count; %i++ ) { // dump top level nodes %name = %shape.getNodeName( %i ); if ( %shape.getNodeParentName( %name ) $= ) dumpNode( %shape, %name, \"\" ); } } @endtsexample ) +/// Get the name of the indexed child node. +/// @param name name of the parent node to query. +/// @param index index of the child node (valid range is 0 - getNodeChildName()-1). +/// @return the name of the indexed child node. +/// @tsexample +/// function dumpNode( %shape, %name, %indent ) +/// { +/// echo( %indent @ %name ); +/// %count = %shape.getNodeChildCount( %name ); +/// for ( %i = 0; %i %count; %i++ ) +/// dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); +/// } +/// function dumpShape( %shape ) +/// { +/// // recursively dump node hierarchy +/// %count = %shape.getNodeCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// { +/// // dump top level nodes +/// %name = %shape.getNodeName( %i ); +/// if ( %shape.getNodeParentName( %name ) $= ) +/// dumpNode( %shape, %name, \"\" ); +/// } +/// } +/// @endtsexample ) +/// /// public string getNodeChildName(string tsshapeconstructor, string name, int index){ @@ -21550,7 +30068,12 @@ public string getNodeChildName(string tsshapeconstructor, string name, int inde return m_ts.fnTSShapeConstructor_getNodeChildName(tsshapeconstructor, name, index); } /// -/// Get the total number of nodes in the shape. @return the number of nodes in the shape. @tsexample %count = %this.getNodeCount(); @endtsexample ) +/// Get the total number of nodes in the shape. +/// @return the number of nodes in the shape. +/// @tsexample +/// %count = %this.getNodeCount(); +/// @endtsexample ) +/// /// public int getNodeCount(string tsshapeconstructor){ @@ -21558,7 +30081,14 @@ public int getNodeCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getNodeCount(tsshapeconstructor); } /// -/// Get the index of the node. @param name name of the node to lookup. @return the index of the named node, or -1 if no such node exists. @tsexample // get the index of Bip01 Pelvis node in the shape %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the index of the node. +/// @param name name of the node to lookup. +/// @return the index of the named node, or -1 if no such node exists. +/// @tsexample +/// // get the index of Bip01 Pelvis node in the shape +/// %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int getNodeIndex(string tsshapeconstructor, string name){ @@ -21566,7 +30096,16 @@ public int getNodeIndex(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeIndex(tsshapeconstructor, name); } /// -/// Get the name of the indexed node. @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). @return the name of the indexed node, or \"\" if no such node exists. @tsexample // print the names of all the nodes in the shape %count = %this.getNodeCount(); for (%i = 0; %i %count; %i++) echo(%i SPC %this.getNodeName(%i)); @endtsexample ) +/// Get the name of the indexed node. +/// @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). +/// @return the name of the indexed node, or \"\" if no such node exists. +/// @tsexample +/// // print the names of all the nodes in the shape +/// %count = %this.getNodeCount(); +/// for (%i = 0; %i %count; %i++) +/// echo(%i SPC %this.getNodeName(%i)); +/// @endtsexample ) +/// /// public string getNodeName(string tsshapeconstructor, int index){ @@ -21574,7 +30113,13 @@ public string getNodeName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getNodeName(tsshapeconstructor, index); } /// -/// Get the number of geometry objects attached to this node. @param name name of the node to query. @return the number of attached objects. @tsexample %count = %this.getNodeObjectCount( \"Bip01 Head\" ); @endtsexample ) +/// Get the number of geometry objects attached to this node. +/// @param name name of the node to query. +/// @return the number of attached objects. +/// @tsexample +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// @endtsexample ) +/// /// public int getNodeObjectCount(string tsshapeconstructor, string name){ @@ -21582,7 +30127,17 @@ public int getNodeObjectCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeObjectCount(tsshapeconstructor, name); } /// -/// Get the name of the indexed object. @param name name of the node to query. @param index index of the object (valid range is 0 - getNodeObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects attached to the node %count = %this.getNodeObjectCount( \"Bip01 Head\" ); for ( %i = 0; %i %count; %i++ ) echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param name name of the node to query. +/// @param index index of the object (valid range is 0 - getNodeObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects attached to the node +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); +/// @endtsexample ) +/// /// public string getNodeObjectName(string tsshapeconstructor, string name, int index){ @@ -21590,7 +30145,14 @@ public string getNodeObjectName(string tsshapeconstructor, string name, int ind return m_ts.fnTSShapeConstructor_getNodeObjectName(tsshapeconstructor, name, index); } /// -/// Get the name of the node's parent. If the node has no parent (ie. it is at the root level), return an empty string. @param name name of the node to query. @return the name of the node's parent, or \"\" if the node is at the root level @tsexample echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); @endtsexample ) +/// Get the name of the node's parent. If the node has no parent (ie. it is at +/// the root level), return an empty string. +/// @param name name of the node to query. +/// @return the name of the node's parent, or \"\" if the node is at the root level +/// @tsexample +/// echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); +/// @endtsexample ) +/// /// public string getNodeParentName(string tsshapeconstructor, string name){ @@ -21598,7 +30160,16 @@ public string getNodeParentName(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getNodeParentName(tsshapeconstructor, name); } /// -/// Get the base (ie. not animated) transform of a node. @param name name of the node to query. @param isWorld true to get the global transform, false (or omitted) to get the local-to-parent transform. @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". @tsexample %ret = %this.getNodeTransform( \"mount0\" ); %this.setNodeTransform( \"mount4\", %ret ); @endtsexample ) +/// Get the base (ie. not animated) transform of a node. +/// @param name name of the node to query. +/// @param isWorld true to get the global transform, false (or omitted) to get +/// the local-to-parent transform. +/// @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". +/// @tsexample +/// %ret = %this.getNodeTransform( \"mount0\" ); +/// %this.setNodeTransform( \"mount4\", %ret ); +/// @endtsexample ) +/// /// public TransformF getNodeTransform(string tsshapeconstructor, string name, bool isWorld = false){ @@ -21606,7 +30177,12 @@ public TransformF getNodeTransform(string tsshapeconstructor, string name, bool return new TransformF ( m_ts.fnTSShapeConstructor_getNodeTransform(tsshapeconstructor, name, isWorld)); } /// -/// Get the total number of objects in the shape. @return the number of objects in the shape. @tsexample %count = %this.getObjectCount(); @endtsexample ) +/// Get the total number of objects in the shape. +/// @return the number of objects in the shape. +/// @tsexample +/// %count = %this.getObjectCount(); +/// @endtsexample ) +/// /// public int getObjectCount(string tsshapeconstructor){ @@ -21614,7 +30190,13 @@ public int getObjectCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getObjectCount(tsshapeconstructor); } /// -/// Get the index of the first object with the given name. @param name name of the object to get. @return the index of the named object. @tsexample %index = %this.getObjectIndex( \"Head\" ); @endtsexample ) +/// Get the index of the first object with the given name. +/// @param name name of the object to get. +/// @return the index of the named object. +/// @tsexample +/// %index = %this.getObjectIndex( \"Head\" ); +/// @endtsexample ) +/// /// public int getObjectIndex(string tsshapeconstructor, string name){ @@ -21622,7 +30204,16 @@ public int getObjectIndex(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getObjectIndex(tsshapeconstructor, name); } /// -/// Get the name of the indexed object. @param index index of the object to get (valid range is 0 - getObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects in the shape %count = %this.getObjectCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getObjectName( %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param index index of the object to get (valid range is 0 - getObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getObjectName( %i ) ); +/// @endtsexample ) +/// /// public string getObjectName(string tsshapeconstructor, int index){ @@ -21630,7 +30221,14 @@ public string getObjectName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getObjectName(tsshapeconstructor, index); } /// -/// Get the name of the node this object is attached to. @param name name of the object to get. @return the name of the attached node, or an empty string if this object is not attached to a node (usually the case for skinned meshes). @tsexample echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); @endtsexample ) +/// Get the name of the node this object is attached to. +/// @param name name of the object to get. +/// @return the name of the attached node, or an empty string if this +/// object is not attached to a node (usually the case for skinned meshes). +/// @tsexample +/// echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); +/// @endtsexample ) +/// /// public string getObjectNode(string tsshapeconstructor, string name){ @@ -21638,7 +30236,24 @@ public string getObjectNode(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getObjectNode(tsshapeconstructor, name); } /// -/// Get information about blended sequences. @param name name of the sequence to query @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: dl> dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference frame (empty for blend sequences embedded in DTS files)/dd> dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences embedded in DTS files)/dd> /dl> @note Note that only sequences set to be blends using the setSequenceBlend command will contain the blendSeq and blendFrame information. @tsexample %blendData = %this.getSequenceBlend( \"look\" ); if ( getField( %blendData, 0 ) ) echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); @endtsexample ) +/// Get information about blended sequences. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: +/// dl> +/// dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> +/// dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference +/// frame (empty for blend sequences embedded in DTS files)/dd> +/// dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences +/// embedded in DTS files)/dd> +/// /dl> +/// @note Note that only sequences set to be blends using the setSequenceBlend +/// command will contain the blendSeq and blendFrame information. +/// @tsexample +/// %blendData = %this.getSequenceBlend( \"look\" ); +/// if ( getField( %blendData, 0 ) ) +/// echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); +/// @endtsexample ) +/// /// public string getSequenceBlend(string tsshapeconstructor, string name){ @@ -21646,7 +30261,9 @@ public string getSequenceBlend(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceBlend(tsshapeconstructor, name); } /// -/// Get the total number of sequences in the shape. @return the number of sequences in the shape ) +/// Get the total number of sequences in the shape. +/// @return the number of sequences in the shape ) +/// /// public int getSequenceCount(string tsshapeconstructor){ @@ -21654,7 +30271,14 @@ public int getSequenceCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getSequenceCount(tsshapeconstructor); } /// -/// Check if this sequence is cyclic (looping). @param name name of the sequence to query @return true if this sequence is cyclic, false if not @tsexample if ( !%this.getSequenceCyclic( \"ambient\" ) ) error( \"ambient sequence is not cyclic!\" ); @endtsexample ) +/// Check if this sequence is cyclic (looping). +/// @param name name of the sequence to query +/// @return true if this sequence is cyclic, false if not +/// @tsexample +/// if ( !%this.getSequenceCyclic( \"ambient\" ) ) +/// error( \"ambient sequence is not cyclic!\" ); +/// @endtsexample ) +/// /// public bool getSequenceCyclic(string tsshapeconstructor, string name){ @@ -21662,7 +30286,13 @@ public bool getSequenceCyclic(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceCyclic(tsshapeconstructor, name); } /// -/// Get the number of keyframes in the sequence. @param name name of the sequence to query @return number of keyframes in the sequence @tsexample echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); @endtsexample ) +/// Get the number of keyframes in the sequence. +/// @param name name of the sequence to query +/// @return number of keyframes in the sequence +/// @tsexample +/// echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); +/// @endtsexample ) +/// /// public int getSequenceFrameCount(string tsshapeconstructor, string name){ @@ -21670,7 +30300,16 @@ public int getSequenceFrameCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceFrameCount(tsshapeconstructor, name); } /// -/// Get the ground speed of the sequence. @note Note that only the first 2 ground frames of the sequence are examined; the speed is assumed to be constant throughout the sequence. @param name name of the sequence to query @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" @tsexample %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); echo( \"Run moves at \" @ %speed @ \" units per frame\" ); @endtsexample ) +/// Get the ground speed of the sequence. +/// @note Note that only the first 2 ground frames of the sequence are +/// examined; the speed is assumed to be constant throughout the sequence. +/// @param name name of the sequence to query +/// @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" +/// @tsexample +/// %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); +/// echo( \"Run moves at \" @ %speed @ \" units per frame\" ); +/// @endtsexample ) +/// /// public string getSequenceGroundSpeed(string tsshapeconstructor, string name){ @@ -21678,7 +30317,15 @@ public string getSequenceGroundSpeed(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceGroundSpeed(tsshapeconstructor, name); } /// -/// Find the index of the sequence with the given name. @param name name of the sequence to lookup @return index of the sequence with matching name, or -1 if not found @tsexample // Check if a given sequence exists in the shape if ( %this.getSequenceIndex( \"walk\" ) == -1 ) echo( \"Could not find 'walk' sequence\" ); @endtsexample ) +/// Find the index of the sequence with the given name. +/// @param name name of the sequence to lookup +/// @return index of the sequence with matching name, or -1 if not found +/// @tsexample +/// // Check if a given sequence exists in the shape +/// if ( %this.getSequenceIndex( \"walk\" ) == -1 ) +/// echo( \"Could not find 'walk' sequence\" ); +/// @endtsexample ) +/// /// public int getSequenceIndex(string tsshapeconstructor, string name){ @@ -21686,7 +30333,16 @@ public int getSequenceIndex(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceIndex(tsshapeconstructor, name); } /// -/// Get the name of the indexed sequence. @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) @return the name of the sequence @tsexample // print the name of all sequences in the shape %count = %this.getSequenceCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getSequenceName( %i ) ); @endtsexample ) +/// Get the name of the indexed sequence. +/// @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) +/// @return the name of the sequence +/// @tsexample +/// // print the name of all sequences in the shape +/// %count = %this.getSequenceCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getSequenceName( %i ) ); +/// @endtsexample ) +/// /// public string getSequenceName(string tsshapeconstructor, int index){ @@ -21694,7 +30350,10 @@ public string getSequenceName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getSequenceName(tsshapeconstructor, index); } /// -/// Get the priority setting of the sequence. @param name name of the sequence to query @return priority value of the sequence ) +/// Get the priority setting of the sequence. +/// @param name name of the sequence to query +/// @return priority value of the sequence ) +/// /// public float getSequencePriority(string tsshapeconstructor, string name){ @@ -21702,7 +30361,24 @@ public float getSequencePriority(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequencePriority(tsshapeconstructor, name); } /// -/// Get information about where the sequence data came from. For example, whether it was loaded from an external DSQ file. @param name name of the sequence to query @return TAB delimited string of the form: \"from reserved start end total\", where: dl> dt>from/dt>dd>the source of the animation data, such as the path to a DSQ file, or the name of an existing sequence in the shape. This field will be empty for sequences already embedded in the DTS or DAE file./dd> dt>reserved/dt>dd>reserved value/dd> dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> dt>total/dt>dd>the total number of frames in the source sequence/dd> /dl> @tsexample // print the source for the walk animation echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); @endtsexample ) +/// Get information about where the sequence data came from. +/// For example, whether it was loaded from an external DSQ file. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"from reserved start end total\", where: +/// dl> +/// dt>from/dt>dd>the source of the animation data, such as the path to +/// a DSQ file, or the name of an existing sequence in the shape. This field +/// will be empty for sequences already embedded in the DTS or DAE file./dd> +/// dt>reserved/dt>dd>reserved value/dd> +/// dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> +/// dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> +/// dt>total/dt>dd>the total number of frames in the source sequence/dd> +/// /dl> +/// @tsexample +/// // print the source for the walk animation +/// echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); +/// @endtsexample ) +/// /// public string getSequenceSource(string tsshapeconstructor, string name){ @@ -21710,7 +30386,12 @@ public string getSequenceSource(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getSequenceSource(tsshapeconstructor, name); } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @tsexample %count = %this.getTargetCount(); @endtsexample ) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @tsexample +/// %count = %this.getTargetCount(); +/// @endtsexample ) +/// /// public int getTargetCount(string tsshapeconstructor){ @@ -21718,7 +30399,15 @@ public int getTargetCount(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_getTargetCount(tsshapeconstructor); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @tsexample %count = %this.getTargetCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); @endtsexample ) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @tsexample +/// %count = %this.getTargetCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); +/// @endtsexample ) +/// /// public string getTargetName(string tsshapeconstructor, int index){ @@ -21726,7 +30415,17 @@ public string getTargetName(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_getTargetName(tsshapeconstructor, index); } /// -/// Get information about the indexed trigger @param name name of the sequence to query @param index index of the trigger (valid range is 0 - getTriggerCount()-1) @return string of the form \"frame state\" @tsexample // print all triggers in the sequence %count = %this.getTriggerCount( \"back\" ); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getTrigger( \"back\", %i ) ); @endtsexample ) +/// Get information about the indexed trigger +/// @param name name of the sequence to query +/// @param index index of the trigger (valid range is 0 - getTriggerCount()-1) +/// @return string of the form \"frame state\" +/// @tsexample +/// // print all triggers in the sequence +/// %count = %this.getTriggerCount( \"back\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getTrigger( \"back\", %i ) ); +/// @endtsexample ) +/// /// public string getTrigger(string tsshapeconstructor, string name, int index){ @@ -21734,7 +30433,10 @@ public string getTrigger(string tsshapeconstructor, string name, int index){ return m_ts.fnTSShapeConstructor_getTrigger(tsshapeconstructor, name, index); } /// -/// Get the number of triggers in the specified sequence. @param name name of the sequence to query @return number of triggers in the sequence ) +/// Get the number of triggers in the specified sequence. +/// @param name name of the sequence to query +/// @return number of triggers in the sequence ) +/// /// public int getTriggerCount(string tsshapeconstructor, string name){ @@ -21742,7 +30444,9 @@ public int getTriggerCount(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_getTriggerCount(tsshapeconstructor, name); } /// -/// Notify game objects that this shape file has changed, allowing them to update internal data if needed. ) +/// Notify game objects that this shape file has changed, allowing them to update +/// internal data if needed. ) +/// /// public void notifyShapeChanged(string tsshapeconstructor){ @@ -21750,7 +30454,13 @@ public void notifyShapeChanged(string tsshapeconstructor){ m_ts.fnTSShapeConstructor_notifyShapeChanged(tsshapeconstructor); } /// -/// Remove the detail level (including all meshes in the detail level) @param size size of the detail level to remove @return true if successful, false otherwise @tsexample %this.removeDetailLevel( 2 ); @endtsexample ) +/// Remove the detail level (including all meshes in the detail level) +/// @param size size of the detail level to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeDetailLevel( 2 ); +/// @endtsexample ) +/// /// public bool removeDetailLevel(string tsshapeconstructor, int index){ @@ -21758,7 +30468,9 @@ public bool removeDetailLevel(string tsshapeconstructor, int index){ return m_ts.fnTSShapeConstructor_removeDetailLevel(tsshapeconstructor, index); } /// -/// () Remove the imposter detail level (if any) from the shape. @return true if successful, false otherwise ) +/// () Remove the imposter detail level (if any) from the shape. +/// @return true if successful, false otherwise ) +/// /// public bool removeImposter(string tsshapeconstructor){ @@ -21766,7 +30478,14 @@ public bool removeImposter(string tsshapeconstructor){ return m_ts.fnTSShapeConstructor_removeImposter(tsshapeconstructor); } /// -/// Remove a mesh from the shape. If all geometry is removed from an object, the object is also removed. @param name full name (object name + detail size) of the mesh to remove @return true if successful, false otherwise @tsexample %this.removeMesh( \"SimpleShape128\" ); @endtsexample ) +/// Remove a mesh from the shape. +/// If all geometry is removed from an object, the object is also removed. +/// @param name full name (object name + detail size) of the mesh to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeMesh( \"SimpleShape128\" ); +/// @endtsexample ) +/// /// public bool removeMesh(string tsshapeconstructor, string name){ @@ -21774,7 +30493,16 @@ public bool removeMesh(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeMesh(tsshapeconstructor, name); } /// -/// Remove a node from the shape. The named node is removed from the shape, including from any sequences that use the node. Child nodes and objects attached to the node are re-assigned to the node's parent. @param name name of the node to remove. @return true if successful, false otherwise. @tsexample %this.removeNode( \"Nose\" ); @endtsexample ) +/// Remove a node from the shape. +/// The named node is removed from the shape, including from any sequences that +/// use the node. Child nodes and objects attached to the node are re-assigned +/// to the node's parent. +/// @param name name of the node to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.removeNode( \"Nose\" ); +/// @endtsexample ) +/// /// public bool removeNode(string tsshapeconstructor, string name){ @@ -21782,7 +30510,16 @@ public bool removeNode(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeNode(tsshapeconstructor, name); } /// -/// Remove an object (including all meshes for that object) from the shape. @param name name of the object to remove. @return true if successful, false otherwise. @tsexample // clear all objects in the shape %count = %this.getObjectCount(); for ( %i = %count-1; %i >= 0; %i-- ) %this.removeObject( %this.getObjectName(%i) ); @endtsexample ) +/// Remove an object (including all meshes for that object) from the shape. +/// @param name name of the object to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// // clear all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = %count-1; %i >= 0; %i-- ) +/// %this.removeObject( %this.getObjectName(%i) ); +/// @endtsexample ) +/// /// public bool removeObject(string tsshapeconstructor, string name){ @@ -21790,7 +30527,10 @@ public bool removeObject(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeObject(tsshapeconstructor, name); } /// -/// Remove the sequence from the shape. @param name name of the sequence to remove @return true if successful, false otherwise ) +/// Remove the sequence from the shape. +/// @param name name of the sequence to remove +/// @return true if successful, false otherwise ) +/// /// public bool removeSequence(string tsshapeconstructor, string name){ @@ -21798,7 +30538,15 @@ public bool removeSequence(string tsshapeconstructor, string name){ return m_ts.fnTSShapeConstructor_removeSequence(tsshapeconstructor, name); } /// -/// Remove a trigger from the sequence. @param name name of the sequence to modify @param keyframe keyframe of the trigger to remove @param state of the trigger to remove @return true if successful, false otherwise @tsexample %this.removeTrigger( \"walk\", 3, 1 ); @endtsexample ) +/// Remove a trigger from the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the trigger to remove +/// @param state of the trigger to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeTrigger( \"walk\", 3, 1 ); +/// @endtsexample ) +/// /// public bool removeTrigger(string tsshapeconstructor, string name, int keyframe, int state){ @@ -21806,7 +30554,16 @@ public bool removeTrigger(string tsshapeconstructor, string name, int keyframe, return m_ts.fnTSShapeConstructor_removeTrigger(tsshapeconstructor, name, keyframe, state); } /// -/// Rename a detail level. @note Note that detail level names must be unique, so this command will fail if there is already a detail level with the desired name @param oldName current name of the detail level @param newName new name of the detail level @return true if successful, false otherwise @tsexample %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); @endtsexample ) +/// Rename a detail level. +/// @note Note that detail level names must be unique, so this command will +/// fail if there is already a detail level with the desired name +/// @param oldName current name of the detail level +/// @param newName new name of the detail level +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); +/// @endtsexample ) +/// /// public bool renameDetailLevel(string tsshapeconstructor, string oldName, string newName){ @@ -21814,7 +30571,16 @@ public bool renameDetailLevel(string tsshapeconstructor, string oldName, string return m_ts.fnTSShapeConstructor_renameDetailLevel(tsshapeconstructor, oldName, newName); } /// -/// Rename a node. @note Note that node names must be unique, so this command will fail if there is already a node with the desired name @param oldName current name of the node @param newName new name of the node @return true if successful, false otherwise @tsexample %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); @endtsexample ) +/// Rename a node. +/// @note Note that node names must be unique, so this command will fail if +/// there is already a node with the desired name +/// @param oldName current name of the node +/// @param newName new name of the node +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); +/// @endtsexample ) +/// /// public bool renameNode(string tsshapeconstructor, string oldName, string newName){ @@ -21822,7 +30588,16 @@ public bool renameNode(string tsshapeconstructor, string oldName, string newNam return m_ts.fnTSShapeConstructor_renameNode(tsshapeconstructor, oldName, newName); } /// -/// Rename an object. @note Note that object names must be unique, so this command will fail if there is already an object with the desired name @param oldName current name of the object @param newName new name of the object @return true if successful, false otherwise @tsexample %this.renameObject( \"MyBox\", \"Box\" ); @endtsexample ) +/// Rename an object. +/// @note Note that object names must be unique, so this command will fail if +/// there is already an object with the desired name +/// @param oldName current name of the object +/// @param newName new name of the object +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameObject( \"MyBox\", \"Box\" ); +/// @endtsexample ) +/// /// public bool renameObject(string tsshapeconstructor, string oldName, string newName){ @@ -21830,7 +30605,16 @@ public bool renameObject(string tsshapeconstructor, string oldName, string newN return m_ts.fnTSShapeConstructor_renameObject(tsshapeconstructor, oldName, newName); } /// -/// Rename a sequence. @note Note that sequence names must be unique, so this command will fail if there is already a sequence with the desired name @param oldName current name of the sequence @param newName new name of the sequence @return true if successful, false otherwise @tsexample %this.renameSequence( \"walking\", \"walk\" ); @endtsexample ) +/// Rename a sequence. +/// @note Note that sequence names must be unique, so this command will fail +/// if there is already a sequence with the desired name +/// @param oldName current name of the sequence +/// @param newName new name of the sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameSequence( \"walking\", \"walk\" ); +/// @endtsexample ) +/// /// public bool renameSequence(string tsshapeconstructor, string oldName, string newName){ @@ -21838,7 +30622,12 @@ public bool renameSequence(string tsshapeconstructor, string oldName, string ne return m_ts.fnTSShapeConstructor_renameSequence(tsshapeconstructor, oldName, newName); } /// -/// Save the shape (with all current changes) to a new DTS file. @param filename Destination filename. @tsexample %this.saveShape( \"./myShape.dts\" ); @endtsexample ) +/// Save the shape (with all current changes) to a new DTS file. +/// @param filename Destination filename. +/// @tsexample +/// %this.saveShape( \"./myShape.dts\" ); +/// @endtsexample ) +/// /// public void saveShape(string tsshapeconstructor, string filename){ @@ -21846,7 +30635,10 @@ public void saveShape(string tsshapeconstructor, string filename){ m_ts.fnTSShapeConstructor_saveShape(tsshapeconstructor, filename); } /// -/// Set the shape bounds to the given bounding box. @param Bounding box \"minX minY minZ maxX maxY maxZ\" @return true if successful, false otherwise ) +/// Set the shape bounds to the given bounding box. +/// @param Bounding box \"minX minY minZ maxX maxY maxZ\" +/// @return true if successful, false otherwise ) +/// /// public bool setBounds(string tsshapeconstructor, Box3F bbox){ @@ -21854,7 +30646,16 @@ public bool setBounds(string tsshapeconstructor, Box3F bbox){ return m_ts.fnTSShapeConstructor_setBounds(tsshapeconstructor, bbox.AsString()); } /// -/// Change the size of a detail level. @note Note that detail levels are always sorted in decreasing size order, so this command may cause detail level indices to change. @param index index of the detail level to modify @param newSize new size for the detail level @return new index for this detail level @tsexample %this.setDetailLevelSize( 2, 256 ); @endtsexample ) +/// Change the size of a detail level. +/// @note Note that detail levels are always sorted in decreasing size order, +/// so this command may cause detail level indices to change. +/// @param index index of the detail level to modify +/// @param newSize new size for the detail level +/// @return new index for this detail level +/// @tsexample +/// %this.setDetailLevelSize( 2, 256 ); +/// @endtsexample ) +/// /// public int setDetailLevelSize(string tsshapeconstructor, int index, int newSize){ @@ -21862,7 +30663,17 @@ public int setDetailLevelSize(string tsshapeconstructor, int index, int newSize return m_ts.fnTSShapeConstructor_setDetailLevelSize(tsshapeconstructor, index, newSize); } /// -/// Set the name of the material attached to the mesh. @param meshName full name (object name + detail size) of the mesh to modify @param matName name of the material to attach. This could be the base name of the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a Material object already defined in script. @return true if successful, false otherwise @tsexample // set the mesh material %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); @endtsexample ) +/// Set the name of the material attached to the mesh. +/// @param meshName full name (object name + detail size) of the mesh to modify +/// @param matName name of the material to attach. This could be the base name of +/// the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a +/// Material object already defined in script. +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh material +/// %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); +/// @endtsexample ) +/// /// public bool setMeshMaterial(string tsshapeconstructor, string meshName, string matName){ @@ -21870,7 +30681,14 @@ public bool setMeshMaterial(string tsshapeconstructor, string meshName, string return m_ts.fnTSShapeConstructor_setMeshMaterial(tsshapeconstructor, meshName, matName); } /// -/// Change the detail level size of the named mesh. @param name full name (object name + current size ) of the mesh to modify @param size new detail level size @return true if successful, false otherwise. @tsexample %this.setMeshSize( \"SimpleShape128\", 64 ); @endtsexample ) +/// Change the detail level size of the named mesh. +/// @param name full name (object name + current size ) of the mesh to modify +/// @param size new detail level size +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.setMeshSize( \"SimpleShape128\", 64 ); +/// @endtsexample ) +/// /// public bool setMeshSize(string tsshapeconstructor, string name, int size){ @@ -21878,7 +30696,15 @@ public bool setMeshSize(string tsshapeconstructor, string name, int size){ return m_ts.fnTSShapeConstructor_setMeshSize(tsshapeconstructor, name, size); } /// -/// Set the display type for the mesh. @param name full name (object name + detail size) of the mesh to modify @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" @return true if successful, false otherwise @tsexample // set the mesh to be a billboard %this.setMeshType( \"SimpleShape64\", \"billboard\" ); @endtsexample ) +/// Set the display type for the mesh. +/// @param name full name (object name + detail size) of the mesh to modify +/// @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh to be a billboard +/// %this.setMeshType( \"SimpleShape64\", \"billboard\" ); +/// @endtsexample ) +/// /// public bool setMeshType(string tsshapeconstructor, string name, string type){ @@ -21886,7 +30712,14 @@ public bool setMeshType(string tsshapeconstructor, string name, string type){ return m_ts.fnTSShapeConstructor_setMeshType(tsshapeconstructor, name, type); } /// -/// Set the parent of a node. @param name name of the node to modify @param parentName name of the parent node to set (use \"\" to move the node to the root level) @return true if successful, false if failed @tsexample %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); @endtsexample ) +/// Set the parent of a node. +/// @param name name of the node to modify +/// @param parentName name of the parent node to set (use \"\" to move the node to the root level) +/// @return true if successful, false if failed +/// @tsexample +/// %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); +/// @endtsexample ) +/// /// public bool setNodeParent(string tsshapeconstructor, string name, string parentName){ @@ -21894,7 +30727,20 @@ public bool setNodeParent(string tsshapeconstructor, string name, string parent return m_ts.fnTSShapeConstructor_setNodeParent(tsshapeconstructor, name, parentName); } /// -/// Set the base transform of a node. That is, the transform of the node when in the root (not-animated) pose. @param name name of the node to modify @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); @endtsexample ) +/// Set the base transform of a node. That is, the transform of the node when +/// in the root (not-animated) pose. +/// @param name name of the node to modify +/// @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); +/// %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); +/// %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool setNodeTransform(string tsshapeconstructor, string name, TransformF txfm, bool isWorld = false){ @@ -21902,7 +30748,16 @@ public bool setNodeTransform(string tsshapeconstructor, string name, TransformF return m_ts.fnTSShapeConstructor_setNodeTransform(tsshapeconstructor, name, txfm.AsString(), isWorld); } /// -/// Set the node an object is attached to. When the shape is rendered, the object geometry is rendered at the node's current transform. @param objName name of the object to modify @param nodeName name of the node to attach the object to @return true if successful, false otherwise @tsexample %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); @endtsexample ) +/// Set the node an object is attached to. +/// When the shape is rendered, the object geometry is rendered at the node's +/// current transform. +/// @param objName name of the object to modify +/// @param nodeName name of the node to attach the object to +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); +/// @endtsexample ) +/// /// public bool setObjectNode(string tsshapeconstructor, string objName, string nodeName){ @@ -21910,7 +30765,19 @@ public bool setObjectNode(string tsshapeconstructor, string objName, string nod return m_ts.fnTSShapeConstructor_setObjectNode(tsshapeconstructor, objName, nodeName); } /// -/// Mark a sequence as a blend or non-blend. A blend sequence is one that will be added on top of any other playing sequences. This is done by storing the animated node transforms relative to a reference frame, rather than as absolute transforms. @param name name of the sequence to modify @param blend true to make the sequence a blend, false for a non-blend @param blendSeq the name of the sequence that contains the blend reference frame @param blendFrame the reference frame in the blendSeq sequence @return true if successful, false otherwise @tsexample %this.setSequenceBlend( \"look\", true, \"root\", 0 ); @endtsexample ) +/// Mark a sequence as a blend or non-blend. +/// A blend sequence is one that will be added on top of any other playing +/// sequences. This is done by storing the animated node transforms relative +/// to a reference frame, rather than as absolute transforms. +/// @param name name of the sequence to modify +/// @param blend true to make the sequence a blend, false for a non-blend +/// @param blendSeq the name of the sequence that contains the blend reference frame +/// @param blendFrame the reference frame in the blendSeq sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceBlend( \"look\", true, \"root\", 0 ); +/// @endtsexample ) +/// /// public bool setSequenceBlend(string tsshapeconstructor, string name, bool blend, string blendSeq, int blendFrame){ @@ -21918,7 +30785,15 @@ public bool setSequenceBlend(string tsshapeconstructor, string name, bool blend return m_ts.fnTSShapeConstructor_setSequenceBlend(tsshapeconstructor, name, blend, blendSeq, blendFrame); } /// -/// Mark a sequence as cyclic or non-cyclic. @param name name of the sequence to modify @param cyclic true to make the sequence cyclic, false for non-cyclic @return true if successful, false otherwise @tsexample %this.setSequenceCyclic( \"ambient\", true ); %this.setSequenceCyclic( \"shoot\", false ); @endtsexample ) +/// Mark a sequence as cyclic or non-cyclic. +/// @param name name of the sequence to modify +/// @param cyclic true to make the sequence cyclic, false for non-cyclic +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceCyclic( \"ambient\", true ); +/// %this.setSequenceCyclic( \"shoot\", false ); +/// @endtsexample ) +/// /// public bool setSequenceCyclic(string tsshapeconstructor, string name, bool cyclic){ @@ -21926,7 +30801,22 @@ public bool setSequenceCyclic(string tsshapeconstructor, string name, bool cycl return m_ts.fnTSShapeConstructor_setSequenceCyclic(tsshapeconstructor, name, cyclic); } /// -/// Set the translation and rotation ground speed of the sequence. The ground speed of the sequence is set by generating ground transform keyframes. The ground translational and rotational speed is assumed to be constant for the duration of the sequence. Existing ground frames for the sequence (if any) will be replaced. @param name name of the sequence to modify @param transSpeed translational speed (trans.x trans.y trans.z) in Torque units per frame @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in radians per frame. Default is \"0 0 0\" @return true if successful, false otherwise @tsexample %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); @endtsexample ) +/// Set the translation and rotation ground speed of the sequence. +/// The ground speed of the sequence is set by generating ground transform +/// keyframes. The ground translational and rotational speed is assumed to +/// be constant for the duration of the sequence. Existing ground frames for +/// the sequence (if any) will be replaced. +/// @param name name of the sequence to modify +/// @param transSpeed translational speed (trans.x trans.y trans.z) in +/// Torque units per frame +/// @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in +/// radians per frame. Default is \"0 0 0\" +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); +/// %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); +/// @endtsexample ) +/// /// public bool setSequenceGroundSpeed(string tsshapeconstructor, string name, Point3F transSpeed, Point3F rotSpeed = null ){ if (rotSpeed== null) {rotSpeed = new Point3F(0.0f, 0.0f, 0.0f);} @@ -21935,7 +30825,11 @@ public bool setSequenceGroundSpeed(string tsshapeconstructor, string name, Poin return m_ts.fnTSShapeConstructor_setSequenceGroundSpeed(tsshapeconstructor, name, transSpeed.AsString(), rotSpeed.AsString()); } /// -/// Set the sequence priority. @param name name of the sequence to modify @param priority new priority value @return true if successful, false otherwise ) +/// Set the sequence priority. +/// @param name name of the sequence to modify +/// @param priority new priority value +/// @return true if successful, false otherwise ) +/// /// public bool setSequencePriority(string tsshapeconstructor, string name, float priority){ @@ -21943,7 +30837,10 @@ public bool setSequencePriority(string tsshapeconstructor, string name, float p return m_ts.fnTSShapeConstructor_setSequencePriority(tsshapeconstructor, name, priority); } /// -/// Write the current change set to a TSShapeConstructor script file. The name of the script file is the same as the model, but with .cs extension. eg. myShape.cs for myShape.dts or myShape.dae. ) +/// Write the current change set to a TSShapeConstructor script file. The +/// name of the script file is the same as the model, but with .cs extension. +/// eg. myShape.cs for myShape.dts or myShape.dae. ) +/// /// public void writeChangeSet(string tsshapeconstructor){ @@ -21956,14 +30853,26 @@ public void writeChangeSet(string tsshapeconstructor){ /// public class TSStaticObject { -private Omni m_ts; - /// - /// - /// - /// -public TSStaticObject(ref Omni ts){m_ts = ts;} /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void changeMaterial(string tsstatic, string mapTo = "", string oldMat = null , string newMat = null ){ if (oldMat== null) {oldMat = null;} @@ -21973,7 +30882,15 @@ public void changeMaterial(string tsstatic, string mapTo = "", string oldMat = m_ts.fnTSStatic_changeMaterial(tsstatic, mapTo, oldMat, newMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string getModelFile(string tsstatic){ @@ -21981,7 +30898,10 @@ public string getModelFile(string tsstatic){ return m_ts.fnTSStatic_getModelFile(tsstatic); } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int getTargetCount(string tsstatic){ @@ -21989,7 +30909,11 @@ public int getTargetCount(string tsstatic){ return m_ts.fnTSStatic_getTargetCount(tsstatic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string getTargetName(string tsstatic, int index = 0){ @@ -22002,14 +30926,10 @@ public string getTargetName(string tsstatic, int index = 0){ /// public class TurretShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public TurretShapeObject(ref Omni ts){m_ts = ts;} /// -/// @brief Does the turret respawn after it has been destroyed. @returns True if the turret respawns.) +/// @brief Does the turret respawn after it has been destroyed. +/// @returns True if the turret respawns.) +/// /// public bool doRespawn(string turretshape){ @@ -22017,7 +30937,9 @@ public bool doRespawn(string turretshape){ return m_ts.fnTurretShape_doRespawn(turretshape); } /// -/// @brief Get if the turret is allowed to fire through moves. @return True if the turret is allowed to fire through moves. ) +/// @brief Get if the turret is allowed to fire through moves. +/// @return True if the turret is allowed to fire through moves. ) +/// /// public bool getAllowManualFire(string turretshape){ @@ -22025,7 +30947,9 @@ public bool getAllowManualFire(string turretshape){ return m_ts.fnTurretShape_getAllowManualFire(turretshape); } /// -/// @brief Get if the turret is allowed to rotate through moves. @return True if the turret is allowed to rotate through moves. ) +/// @brief Get if the turret is allowed to rotate through moves. +/// @return True if the turret is allowed to rotate through moves. ) +/// /// public bool getAllowManualRotation(string turretshape){ @@ -22033,7 +30957,15 @@ public bool getAllowManualRotation(string turretshape){ return m_ts.fnTurretShape_getAllowManualRotation(turretshape); } /// -/// @brief Get the name of the turret's current state. The state is one of the following:ul> li>Dead - The TurretShape is destroyed./li> li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> li>Ready - The TurretShape is free to move. The usual state./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// @brief Get the name of the turret's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The TurretShape is destroyed./li> +/// li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> +/// li>Ready - The TurretShape is free to move. The usual state./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// /// public string getState(string turretshape){ @@ -22041,7 +30973,10 @@ public string getState(string turretshape){ return m_ts.fnTurretShape_getState(turretshape); } /// -/// @brief Get Euler rotation of this turret's heading and pitch nodes. @return the orientation of the turret's heading and pitch nodes in the form of rotations around the X, Y and Z axes in degrees. ) +/// @brief Get Euler rotation of this turret's heading and pitch nodes. +/// @return the orientation of the turret's heading and pitch nodes in the +/// form of rotations around the X, Y and Z axes in degrees. ) +/// /// public Point3F getTurretEulerRotation(string turretshape){ @@ -22049,7 +30984,9 @@ public Point3F getTurretEulerRotation(string turretshape){ return new Point3F ( m_ts.fnTurretShape_getTurretEulerRotation(turretshape)); } /// -/// @brief Set if the turret is allowed to fire through moves. @param allow If true then the turret may be fired through moves.) +/// @brief Set if the turret is allowed to fire through moves. +/// @param allow If true then the turret may be fired through moves.) +/// /// public void setAllowManualFire(string turretshape, bool allow){ @@ -22057,7 +30994,9 @@ public void setAllowManualFire(string turretshape, bool allow){ m_ts.fnTurretShape_setAllowManualFire(turretshape, allow); } /// -/// @brief Set if the turret is allowed to rotate through moves. @param allow If true then the turret may be rotated through moves.) +/// @brief Set if the turret is allowed to rotate through moves. +/// @param allow If true then the turret may be rotated through moves.) +/// /// public void setAllowManualRotation(string turretshape, bool allow){ @@ -22065,7 +31004,10 @@ public void setAllowManualRotation(string turretshape, bool allow){ m_ts.fnTurretShape_setAllowManualRotation(turretshape, allow); } /// -/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. @param rot The rotation in degrees. The pitch is the X component and the heading is the Z component. The Y component is ignored.) +/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. +/// @param rot The rotation in degrees. The pitch is the X component and the +/// heading is the Z component. The Y component is ignored.) +/// /// public void setTurretEulerRotation(string turretshape, Point3F rot){ @@ -22078,14 +31020,9 @@ public void setTurretEulerRotation(string turretshape, Point3F rot){ /// public class UndoActionObject { -private Omni m_ts; - /// - /// - /// - /// -public UndoActionObject(ref Omni ts){m_ts = ts;} /// /// ), action.addToManager([undoManager])) +/// /// public void UndoAction_addToManager(string undoaction, string undoManager = ""){ @@ -22094,6 +31031,7 @@ public void UndoAction_addToManager(string undoaction, string undoManager = "") } /// /// () - Reo action contained in undo. ) +/// /// public void UndoAction_redo(string undoaction){ @@ -22102,6 +31040,7 @@ public void UndoAction_redo(string undoaction){ } /// /// () - Undo action contained in undo. ) +/// /// public void UndoAction_undo(string undoaction){ @@ -22114,14 +31053,9 @@ public void UndoAction_undo(string undoaction){ /// public class UndoManagerObject { -private Omni m_ts; - /// - /// - /// - /// -public UndoManagerObject(ref Omni ts){m_ts = ts;} /// /// Clears the undo manager.) +/// /// public void UndoManager_clearAll(string undomanager){ @@ -22130,6 +31064,7 @@ public void UndoManager_clearAll(string undomanager){ } /// /// UndoManager.getNextRedoName();) +/// /// public string UndoManager_getNextRedoName(string undomanager){ @@ -22138,6 +31073,7 @@ public string UndoManager_getNextRedoName(string undomanager){ } /// /// UndoManager.getNextUndoName();) +/// /// public string UndoManager_getNextUndoName(string undomanager){ @@ -22146,6 +31082,7 @@ public string UndoManager_getNextUndoName(string undomanager){ } /// /// (index)) +/// /// public int UndoManager_getRedoAction(string undomanager, int index){ @@ -22154,6 +31091,7 @@ public int UndoManager_getRedoAction(string undomanager, int index){ } /// /// ) +/// /// public int UndoManager_getRedoCount(string undomanager){ @@ -22162,6 +31100,7 @@ public int UndoManager_getRedoCount(string undomanager){ } /// /// (index)) +/// /// public string UndoManager_getRedoName(string undomanager, int index){ @@ -22170,6 +31109,7 @@ public string UndoManager_getRedoName(string undomanager, int index){ } /// /// (index)) +/// /// public int UndoManager_getUndoAction(string undomanager, int index){ @@ -22178,6 +31118,7 @@ public int UndoManager_getUndoAction(string undomanager, int index){ } /// /// ) +/// /// public int UndoManager_getUndoCount(string undomanager){ @@ -22186,6 +31127,7 @@ public int UndoManager_getUndoCount(string undomanager){ } /// /// (index)) +/// /// public string UndoManager_getUndoName(string undomanager, int index){ @@ -22194,6 +31136,7 @@ public string UndoManager_getUndoName(string undomanager, int index){ } /// /// ( bool discard=false ) - Pop the current CompoundUndoAction off the stack. ) +/// /// public void UndoManager_popCompound(string undomanager, bool discard = false){ @@ -22202,6 +31145,7 @@ public void UndoManager_popCompound(string undomanager, bool discard = false){ } /// /// \"\"), ( string name=\"\" ) - Push a CompoundUndoAction onto the compound stack for assembly. ) +/// /// public string UndoManager_pushCompound(string undomanager, string name = "\"\""){ @@ -22210,6 +31154,7 @@ public string UndoManager_pushCompound(string undomanager, string name = "\"\"" } /// /// UndoManager.redo();) +/// /// public void UndoManager_redo(string undomanager){ @@ -22218,6 +31163,7 @@ public void UndoManager_redo(string undomanager){ } /// /// UndoManager.undo();) +/// /// public void UndoManager_undo(string undomanager){ @@ -22230,12 +31176,6 @@ public void UndoManager_undo(string undomanager){ /// public class VolumetricFogObject { -private Omni m_ts; - /// - /// - /// - /// -public VolumetricFogObject(ref Omni ts){m_ts = ts;} /// /// @brief Changes the color of the fog. /// @params new_color the new fog color (rgb 0-255, a is ignored.) @@ -22284,14 +31224,12 @@ public void SetFogModulation(string volumetricfog, float new_strenght, Point2F /// public class WalkableShapeObject { -private Omni m_ts; - /// - /// - /// - /// -public WalkableShapeObject(ref Omni ts){m_ts = ts;} /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool attachObject(string walkableshape, string obj){ @@ -22299,7 +31237,14 @@ public bool attachObject(string walkableshape, string obj){ return m_ts.fnWalkableShape_attachObject(walkableshape, obj); } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void detachAll(string walkableshape){ @@ -22307,7 +31252,11 @@ public void detachAll(string walkableshape){ m_ts.fnWalkableShape_detachAll(walkableshape); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool detachObject(string walkableshape, string obj){ @@ -22316,6 +31265,7 @@ public bool detachObject(string walkableshape, string obj){ } /// /// Returns the attachment at the passed index value.) +/// /// public string getAttachment(string walkableshape, int index = 0){ @@ -22324,6 +31274,7 @@ public string getAttachment(string walkableshape, int index = 0){ } /// /// Returns the number of objects that are currently attached.) +/// /// public int getNumAttachments(string walkableshape){ @@ -22336,14 +31287,10 @@ public int getNumAttachments(string walkableshape){ /// public class WheeledVehicleObject { -private Omni m_ts; - /// - /// - /// - /// -public WheeledVehicleObject(ref Omni ts){m_ts = ts;} /// -/// @brief Get the number of wheels on this vehicle. @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// @brief Get the number of wheels on this vehicle. +/// @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// /// public int getWheelCount(string wheeledvehicle){ @@ -22351,7 +31298,13 @@ public int getWheelCount(string wheeledvehicle){ return m_ts.fnWheeledVehicle_getWheelCount(wheeledvehicle); } /// -/// @brief Set whether the wheel is powered (has torque applied from the engine). A rear wheel drive car for example would set the front wheels to false, and the rear wheels to true. @param wheel index of the wheel to set (hub node #) @param powered flag indicating whether to power the wheel or not @return true if successful, false if failed ) +/// @brief Set whether the wheel is powered (has torque applied from the engine). +/// A rear wheel drive car for example would set the front wheels to false, +/// and the rear wheels to true. +/// @param wheel index of the wheel to set (hub node #) +/// @param powered flag indicating whether to power the wheel or not +/// @return true if successful, false if failed ) +/// /// public bool setWheelPowered(string wheeledvehicle, int wheel, bool powered){ @@ -22359,7 +31312,14 @@ public bool setWheelPowered(string wheeledvehicle, int wheel, bool powered){ return m_ts.fnWheeledVehicle_setWheelPowered(wheeledvehicle, wheel, powered); } /// -/// @brief Set the WheeledVehicleSpring datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param spring WheeledVehicleSpring datablock @return true if successful, false if failed @tsexample %obj.setWheelSpring( 0, FrontSpring ); @endtsexample ) +/// @brief Set the WheeledVehicleSpring datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param spring WheeledVehicleSpring datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelSpring( 0, FrontSpring ); +/// @endtsexample ) +/// /// public bool setWheelSpring(string wheeledvehicle, int wheel, string spring){ @@ -22367,7 +31327,16 @@ public bool setWheelSpring(string wheeledvehicle, int wheel, string spring){ return m_ts.fnWheeledVehicle_setWheelSpring(wheeledvehicle, wheel, spring); } /// -/// @brief Set how much the wheel is affected by steering. The steering factor controls how much the wheel is rotated by the vehicle steering. For example, most cars would have their front wheels set to 1.0, and their rear wheels set to 0 since only the front wheels should turn. Negative values will turn the wheel in the opposite direction to the steering angle. @param wheel index of the wheel to set (hub node #) @param steering steering factor from -1 (full inverse) to 1 (full) @return true if successful, false if failed ) +/// @brief Set how much the wheel is affected by steering. +/// The steering factor controls how much the wheel is rotated by the vehicle +/// steering. For example, most cars would have their front wheels set to 1.0, +/// and their rear wheels set to 0 since only the front wheels should turn. +/// Negative values will turn the wheel in the opposite direction to the steering +/// angle. +/// @param wheel index of the wheel to set (hub node #) +/// @param steering steering factor from -1 (full inverse) to 1 (full) +/// @return true if successful, false if failed ) +/// /// public bool setWheelSteering(string wheeledvehicle, int wheel, float steering){ @@ -22375,7 +31344,14 @@ public bool setWheelSteering(string wheeledvehicle, int wheel, float steering){ return m_ts.fnWheeledVehicle_setWheelSteering(wheeledvehicle, wheel, steering); } /// -/// @brief Set the WheeledVehicleTire datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param tire WheeledVehicleTire datablock @return true if successful, false if failed @tsexample %obj.setWheelTire( 0, FrontTire ); @endtsexample ) +/// @brief Set the WheeledVehicleTire datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param tire WheeledVehicleTire datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelTire( 0, FrontTire ); +/// @endtsexample ) +/// /// public bool setWheelTire(string wheeledvehicle, int wheel, string tire){ @@ -22388,14 +31364,9 @@ public bool setWheelTire(string wheeledvehicle, int wheel, string tire){ /// public class WorldEditorObject { -private Omni m_ts; - /// - /// - /// - /// -public WorldEditorObject(ref Omni ts){m_ts = ts;} /// /// ) +/// /// public void WorldEditor_addUndoState(string worldeditor){ @@ -22403,7 +31374,9 @@ public void WorldEditor_addUndoState(string worldeditor){ m_ts.fn_WorldEditor_addUndoState(worldeditor); } /// -/// (int axis) Align all selected objects along the given axis.) +/// (int axis) +/// Align all selected objects along the given axis.) +/// /// public void WorldEditor_alignByAxis(string worldeditor, int boundsAxis){ @@ -22411,7 +31384,9 @@ public void WorldEditor_alignByAxis(string worldeditor, int boundsAxis){ m_ts.fn_WorldEditor_alignByAxis(worldeditor, boundsAxis); } /// -/// (int boundsAxis) Align all selected objects against the given bounds axis.) +/// (int boundsAxis) +/// Align all selected objects against the given bounds axis.) +/// /// public void WorldEditor_alignByBounds(string worldeditor, int boundsAxis){ @@ -22420,6 +31395,7 @@ public void WorldEditor_alignByBounds(string worldeditor, int boundsAxis){ } /// /// ) +/// /// public bool WorldEditor_canPasteSelection(string worldeditor){ @@ -22428,6 +31404,7 @@ public bool WorldEditor_canPasteSelection(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_clearIgnoreList(string worldeditor){ @@ -22436,6 +31413,7 @@ public void WorldEditor_clearIgnoreList(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_clearSelection(string worldeditor){ @@ -22444,6 +31422,7 @@ public void WorldEditor_clearSelection(string worldeditor){ } /// /// ( String path ) - Export the combined geometry of all selected objects to the specified path in collada format. ) +/// /// public void WorldEditor_colladaExportSelection(string worldeditor, string path){ @@ -22452,6 +31431,7 @@ public void WorldEditor_colladaExportSelection(string worldeditor, string path) } /// /// ) +/// /// public void WorldEditor_copySelection(string worldeditor){ @@ -22460,6 +31440,7 @@ public void WorldEditor_copySelection(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_cutSelection(string worldeditor){ @@ -22468,6 +31449,7 @@ public void WorldEditor_cutSelection(string worldeditor){ } /// /// ( bool skipUndo = false )) +/// /// public void WorldEditor_dropSelection(string worldeditor, bool skipUndo = false){ @@ -22476,6 +31458,7 @@ public void WorldEditor_dropSelection(string worldeditor, bool skipUndo = false } /// /// () - Replace selected Prefab objects with a SimGroup containing all children objects defined in the .prefab. ) +/// /// public void WorldEditor_explodeSelectedPrefab(string worldeditor){ @@ -22484,6 +31467,7 @@ public void WorldEditor_explodeSelectedPrefab(string worldeditor){ } /// /// () - Return the currently active WorldEditorSelection object. ) +/// /// public int WorldEditor_getActiveSelection(string worldeditor){ @@ -22492,6 +31476,7 @@ public int WorldEditor_getActiveSelection(string worldeditor){ } /// /// (int index)) +/// /// public int WorldEditor_getSelectedObject(string worldeditor, int index){ @@ -22500,6 +31485,7 @@ public int WorldEditor_getSelectedObject(string worldeditor, int index){ } /// /// ) +/// /// public string WorldEditor_getSelectionCentroid(string worldeditor){ @@ -22508,6 +31494,7 @@ public string WorldEditor_getSelectionCentroid(string worldeditor){ } /// /// ) +/// /// public Point3F WorldEditor_getSelectionExtent(string worldeditor){ @@ -22516,6 +31503,7 @@ public Point3F WorldEditor_getSelectionExtent(string worldeditor){ } /// /// ) +/// /// public float WorldEditor_getSelectionRadius(string worldeditor){ @@ -22524,6 +31512,7 @@ public float WorldEditor_getSelectionRadius(string worldeditor){ } /// /// () - Return the number of objects currently selected in the editor.) +/// /// public int WorldEditor_getSelectionSize(string worldeditor){ @@ -22531,7 +31520,9 @@ public int WorldEditor_getSelectionSize(string worldeditor){ return m_ts.fn_WorldEditor_getSelectionSize(worldeditor); } /// -/// getSoftSnap() Is soft snapping always on?) +/// getSoftSnap() +/// Is soft snapping always on?) +/// /// public bool WorldEditor_getSoftSnap(string worldeditor){ @@ -22539,7 +31530,9 @@ public bool WorldEditor_getSoftSnap(string worldeditor){ return m_ts.fn_WorldEditor_getSoftSnap(worldeditor); } /// -/// getSoftSnapBackfaceTolerance() The fraction of the soft snap radius that backfaces may be included.) +/// getSoftSnapBackfaceTolerance() +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public float WorldEditor_getSoftSnapBackfaceTolerance(string worldeditor){ @@ -22547,7 +31540,9 @@ public float WorldEditor_getSoftSnapBackfaceTolerance(string worldeditor){ return m_ts.fn_WorldEditor_getSoftSnapBackfaceTolerance(worldeditor); } /// -/// getSoftSnapSize() Get the absolute size to trigger a soft snap.) +/// getSoftSnapSize() +/// Get the absolute size to trigger a soft snap.) +/// /// public float WorldEditor_getSoftSnapSize(string worldeditor){ @@ -22556,6 +31551,7 @@ public float WorldEditor_getSoftSnapSize(string worldeditor){ } /// /// (Object obj, bool hide)) +/// /// public void WorldEditor_hideObject(string worldeditor, string obj, bool hide){ @@ -22564,6 +31560,7 @@ public void WorldEditor_hideObject(string worldeditor, string obj, bool hide){ } /// /// (bool hide)) +/// /// public void WorldEditor_hideSelection(string worldeditor, bool hide){ @@ -22572,6 +31569,7 @@ public void WorldEditor_hideSelection(string worldeditor, bool hide){ } /// /// ) +/// /// public void WorldEditor_invalidateSelectionCentroid(string worldeditor){ @@ -22580,6 +31578,7 @@ public void WorldEditor_invalidateSelectionCentroid(string worldeditor){ } /// /// (bool lock)) +/// /// public void WorldEditor_lockSelection(string worldeditor, bool lockx){ @@ -22588,6 +31587,7 @@ public void WorldEditor_lockSelection(string worldeditor, bool lockx){ } /// /// ( string filename ) - Save selected objects to a .prefab file and replace them in the level with a Prefab object. ) +/// /// public void WorldEditor_makeSelectionPrefab(string worldeditor, string filename){ @@ -22596,6 +31596,7 @@ public void WorldEditor_makeSelectionPrefab(string worldeditor, string filename } /// /// ( Object A, Object B ) ) +/// /// public void WorldEditor_mountRelative(string worldeditor, string objA, string objB){ @@ -22604,6 +31605,7 @@ public void WorldEditor_mountRelative(string worldeditor, string objA, string o } /// /// ) +/// /// public void WorldEditor_pasteSelection(string worldeditor){ @@ -22612,6 +31614,7 @@ public void WorldEditor_pasteSelection(string worldeditor){ } /// /// ( int objID )) +/// /// public void WorldEditor_redirectConsole(string worldeditor, int objID){ @@ -22620,6 +31623,7 @@ public void WorldEditor_redirectConsole(string worldeditor, int objID){ } /// /// ) +/// /// public void WorldEditor_resetSelectedRotation(string worldeditor){ @@ -22628,6 +31632,7 @@ public void WorldEditor_resetSelectedRotation(string worldeditor){ } /// /// ) +/// /// public void WorldEditor_resetSelectedScale(string worldeditor){ @@ -22636,6 +31641,7 @@ public void WorldEditor_resetSelectedScale(string worldeditor){ } /// /// (SimObject obj)) +/// /// public void WorldEditor_selectObject(string worldeditor, string objName){ @@ -22644,6 +31650,7 @@ public void WorldEditor_selectObject(string worldeditor, string objName){ } /// /// ( id set ) - Set the currently active WorldEditorSelection object. ) +/// /// public void WorldEditor_setActiveSelection(string worldeditor, string selection){ @@ -22651,7 +31658,9 @@ public void WorldEditor_setActiveSelection(string worldeditor, string selection m_ts.fn_WorldEditor_setActiveSelection(worldeditor, selection); } /// -/// setSoftSnap(bool) Allow soft snapping all of the time.) +/// setSoftSnap(bool) +/// Allow soft snapping all of the time.) +/// /// public void WorldEditor_setSoftSnap(string worldeditor, bool enable){ @@ -22659,7 +31668,9 @@ public void WorldEditor_setSoftSnap(string worldeditor, bool enable){ m_ts.fn_WorldEditor_setSoftSnap(worldeditor, enable); } /// -/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) The fraction of the soft snap radius that backfaces may be included.) +/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public void WorldEditor_setSoftSnapBackfaceTolerance(string worldeditor, float range){ @@ -22667,7 +31678,9 @@ public void WorldEditor_setSoftSnapBackfaceTolerance(string worldeditor, float m_ts.fn_WorldEditor_setSoftSnapBackfaceTolerance(worldeditor, range); } /// -/// setSoftSnapSize(F32) Set the absolute size to trigger a soft snap.) +/// setSoftSnapSize(F32) +/// Set the absolute size to trigger a soft snap.) +/// /// public void WorldEditor_setSoftSnapSize(string worldeditor, float size){ @@ -22675,7 +31688,9 @@ public void WorldEditor_setSoftSnapSize(string worldeditor, float size){ m_ts.fn_WorldEditor_setSoftSnapSize(worldeditor, size); } /// -/// softSnapDebugRender(bool) Toggle soft snapping debug rendering.) +/// softSnapDebugRender(bool) +/// Toggle soft snapping debug rendering.) +/// /// public void WorldEditor_softSnapDebugRender(string worldeditor, bool enable){ @@ -22683,7 +31698,9 @@ public void WorldEditor_softSnapDebugRender(string worldeditor, bool enable){ m_ts.fn_WorldEditor_softSnapDebugRender(worldeditor, enable); } /// -/// softSnapRender(bool) Render the soft snapping bounds.) +/// softSnapRender(bool) +/// Render the soft snapping bounds.) +/// /// public void WorldEditor_softSnapRender(string worldeditor, bool enable){ @@ -22691,7 +31708,9 @@ public void WorldEditor_softSnapRender(string worldeditor, bool enable){ m_ts.fn_WorldEditor_softSnapRender(worldeditor, enable); } /// -/// softSnapRenderTriangle(bool) Render the soft snapped triangle.) +/// softSnapRenderTriangle(bool) +/// Render the soft snapped triangle.) +/// /// public void WorldEditor_softSnapRenderTriangle(string worldeditor, bool enable){ @@ -22699,7 +31718,9 @@ public void WorldEditor_softSnapRenderTriangle(string worldeditor, bool enable) m_ts.fn_WorldEditor_softSnapRenderTriangle(worldeditor, enable); } /// -/// softSnapSizeByBounds(bool) Use selection bounds size as soft snap bounds.) +/// softSnapSizeByBounds(bool) +/// Use selection bounds size as soft snap bounds.) +/// /// public void WorldEditor_softSnapSizeByBounds(string worldeditor, bool enable){ @@ -22707,7 +31728,9 @@ public void WorldEditor_softSnapSizeByBounds(string worldeditor, bool enable){ m_ts.fn_WorldEditor_softSnapSizeByBounds(worldeditor, enable); } /// -/// transformSelection(...) Transform selection by given parameters.) +/// transformSelection(...) +/// Transform selection by given parameters.) +/// /// public void WorldEditor_transformSelection(string worldeditor, bool position, Point3F point, bool relativePos, bool rotate, Point3F rotation, bool relativeRot, bool rotLocal, int scaleType, Point3F scale, bool sRelative, bool sLocal){ @@ -22716,6 +31739,7 @@ public void WorldEditor_transformSelection(string worldeditor, bool position, P } /// /// (SimObject obj)) +/// /// public void WorldEditor_unselectObject(string worldeditor, string objName){ @@ -22724,6 +31748,7 @@ public void WorldEditor_unselectObject(string worldeditor, string objName){ } /// /// Create a ConvexShape from the given polyhedral object. ) +/// /// public string createConvexShapeFrom(string worldeditor, string polyObject){ @@ -22732,6 +31757,7 @@ public string createConvexShapeFrom(string worldeditor, string polyObject){ } /// /// Grab the geometry from @a geometryProvider, create a @a className object, and assign it the extracted geometry. ) +/// /// public string createPolyhedralObject(string worldeditor, string className, string geometryProvider){ @@ -22740,6 +31766,7 @@ public string createPolyhedralObject(string worldeditor, string className, stri } /// /// Get the soft snap alignment. ) +/// /// public TypeWorldEditorAlignmentType getSoftSnapAlignment(string worldeditor){ @@ -22748,6 +31775,7 @@ public TypeWorldEditorAlignmentType getSoftSnapAlignment(string worldeditor){ } /// /// Get the terrain snap alignment. ) +/// /// public TypeWorldEditorAlignmentType getTerrainSnapAlignment(string worldeditor){ @@ -22756,6 +31784,7 @@ public TypeWorldEditorAlignmentType getTerrainSnapAlignment(string worldeditor) } /// /// ( WorldEditor, ignoreObjClass, void, 3, 0, (string class_name, ...)) +/// /// public void ignoreObjClass(string worldeditor, string a2= "", string a3= "", string a4= "", string a5= "", string a6= "", string a7= "", string a8= "", string a9= "", string a10= "", string a11= "", string a12= "", string a13= "", string a14= "", string a15= "", string a16= "", string a17= "", string a18= "", string a19= ""){ @@ -22764,6 +31793,7 @@ public void ignoreObjClass(string worldeditor, string a2= "", string a3= "", st } /// /// Set the soft snap alignment. ) +/// /// public void setSoftSnapAlignment(string worldeditor, TypeWorldEditorAlignmentType type){ @@ -22772,6 +31802,7 @@ public void setSoftSnapAlignment(string worldeditor, TypeWorldEditorAlignmentTy } /// /// Set the terrain snap alignment. ) +/// /// public void setTerrainSnapAlignment(string worldeditor, TypeWorldEditorAlignmentType alignment){ @@ -22784,14 +31815,9 @@ public void setTerrainSnapAlignment(string worldeditor, TypeWorldEditorAlignmen /// public class WorldEditorSelectionObject { -private Omni m_ts; - /// - /// - /// - /// -public WorldEditorSelectionObject(ref Omni ts){m_ts = ts;} /// /// ( WorldEditorSelection, containsGlobalBounds, bool, 2, 2, () - True if an object with global bounds is contained in the selection. ) +/// /// public bool containsGlobalBounds(string worldeditorselection= ""){ @@ -22800,6 +31826,7 @@ public bool containsGlobalBounds(string worldeditorselection= ""){ } /// /// ( WorldEditorSelection, getBoxCentroid, const char*, 2, 2, () - Return the center of the bounding box around the selection. ) +/// /// public string getBoxCentroid(string worldeditorselection= ""){ @@ -22808,6 +31835,7 @@ public string getBoxCentroid(string worldeditorselection= ""){ } /// /// ( WorldEditorSelection, getCentroid, const char*, 2, 2, () - Return the median of all object positions in the selection. ) +/// /// public string getCentroid(string worldeditorselection= ""){ @@ -22816,6 +31844,7 @@ public string getCentroid(string worldeditorselection= ""){ } /// /// ( WorldEditorSelection, offset, void, 3, 4, ( vector delta, float gridSnap=0 ) - Move all objects in the selection by the given delta. ) +/// /// public void offset(string worldeditorselection, string a2= "", string a3= ""){ @@ -22824,6 +31853,7 @@ public void offset(string worldeditorselection, string a2= "", string a3= ""){ } /// /// ( WorldEditorSelection, subtract, void, 3, 3, ( SimSet ) - Remove all objects in the given set from this selection. ) +/// /// public void subtract(string worldeditorselection, string a2= ""){ @@ -22832,6 +31862,7 @@ public void subtract(string worldeditorselection, string a2= ""){ } /// /// ( WorldEditorSelection, union, void, 3, 3, ( SimSet set ) - Add all objects in the given set to this selection. ) +/// /// public void union(string worldeditorselection, string a2= ""){ @@ -22844,14 +31875,15 @@ public void union(string worldeditorselection, string a2= ""){ /// public class ZipObjectObject { -private Omni m_ts; - /// - /// - /// - /// -public ZipObjectObject(ref Omni ts){m_ts = ts;} /// -/// @brief Add a file to the zip archive @param filename The path and name of the file to add to the zip archive. @param pathInZip The path and name to be given to the file within the zip archive. @param replace If a file already exists within the zip archive at the same location as this new file, this parameter indicates if it should be replaced. By default, it will be replaced. @return True if the file was successfully added to the zip archive.) +/// @brief Add a file to the zip archive +/// +/// @param filename The path and name of the file to add to the zip archive. +/// @param pathInZip The path and name to be given to the file within the zip archive. +/// @param replace If a file already exists within the zip archive at the same location as this +/// new file, this parameter indicates if it should be replaced. By default, it will be replaced. +/// @return True if the file was successfully added to the zip archive.) +/// /// public bool addFile(string zipobject, string filename, string pathInZip, bool replace = true){ @@ -22859,7 +31891,9 @@ public bool addFile(string zipobject, string filename, string pathInZip, bool r return m_ts.fnZipObject_addFile(zipobject, filename, pathInZip, replace); } /// -/// @brief Close an already opened zip archive. @see openArchive()) +/// @brief Close an already opened zip archive. +/// @see openArchive()) +/// /// public void closeArchive(string zipobject){ @@ -22867,7 +31901,11 @@ public void closeArchive(string zipobject){ m_ts.fnZipObject_closeArchive(zipobject); } /// -/// @brief Close a previously opened file within the zip archive. @param stream The StreamObject of a previously opened file within the zip archive. @see openFileForRead() @see openFileForWrite()) +/// @brief Close a previously opened file within the zip archive. +/// @param stream The StreamObject of a previously opened file within the zip archive. +/// @see openFileForRead() +/// @see openFileForWrite()) +/// /// public void closeFile(string zipobject, string stream){ @@ -22875,7 +31913,19 @@ public void closeFile(string zipobject, string stream){ m_ts.fnZipObject_closeFile(zipobject, stream); } /// -/// @brief Deleted the given file from the zip archive @param pathInZip The path and name of the file to be deleted from the zip archive. @return True of the file was successfully deleted. @note Files that have been deleted from the archive will still show up with a getFileEntryCount() until you close the archive. If you need to have the file count up to date with only valid files within the archive, you could close and then open the archive again. @see getFileEntryCount() @see closeArchive() @see openArchive()) +/// @brief Deleted the given file from the zip archive +/// @param pathInZip The path and name of the file to be deleted from the zip archive. +/// @return True of the file was successfully deleted. +/// +/// @note Files that have been deleted from the archive will still show up with a +/// getFileEntryCount() until you close the archive. If you need to have the file +/// count up to date with only valid files within the archive, you could close and then +/// open the archive again. +/// +/// @see getFileEntryCount() +/// @see closeArchive() +/// @see openArchive()) +/// /// public bool deleteFile(string zipobject, string pathInZip){ @@ -22883,7 +31933,11 @@ public bool deleteFile(string zipobject, string pathInZip){ return m_ts.fnZipObject_deleteFile(zipobject, pathInZip); } /// -/// @brief Extact a file from the zip archive and save it to the requested location. @param pathInZip The path and name of the file to be extracted within the zip archive. @param filename The path and name to give the extracted file. @return True if the file was successfully extracted.) +/// @brief Extact a file from the zip archive and save it to the requested location. +/// @param pathInZip The path and name of the file to be extracted within the zip archive. +/// @param filename The path and name to give the extracted file. +/// @return True if the file was successfully extracted.) +/// /// public bool extractFile(string zipobject, string pathInZip, string filename){ @@ -22891,7 +31945,22 @@ public bool extractFile(string zipobject, string pathInZip, string filename){ return m_ts.fnZipObject_extractFile(zipobject, pathInZip, filename); } /// -/// @brief Get information on the requested file within the zip archive. This methods provides five different pieces of information for the requested file: ul>li>filename - The path and name of the file within the zip archive/li> li>uncompressed size/li> li>compressed size/li> li>compression method/li> li>CRC32/li>/ul> Use getFileEntryCount() to obtain the total number of files within the archive. @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. @see getFileEntryCount()) +/// @brief Get information on the requested file within the zip archive. +/// +/// This methods provides five different pieces of information for the requested file: +/// ul>li>filename - The path and name of the file within the zip archive/li> +/// li>uncompressed size/li> +/// li>compressed size/li> +/// li>compression method/li> +/// li>CRC32/li>/ul> +/// +/// Use getFileEntryCount() to obtain the total number of files within the archive. +/// +/// @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. +/// @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. +/// +/// @see getFileEntryCount()) +/// /// public string getFileEntry(string zipobject, int index){ @@ -22899,7 +31968,20 @@ public string getFileEntry(string zipobject, int index){ return m_ts.fnZipObject_getFileEntry(zipobject, index); } /// -/// @brief Get the number of files within the zip archive. Use getFileEntry() to retrive information on each file within the archive. @return The number of files within the zip archive. @note The returned count will include any files that have been deleted from the archive using deleteFile(). To clear out all deleted files, you could close and then open the archive again. @see getFileEntry() @see closeArchive() @see openArchive()) +/// @brief Get the number of files within the zip archive. +/// +/// Use getFileEntry() to retrive information on each file within the archive. +/// +/// @return The number of files within the zip archive. +/// +/// @note The returned count will include any files that have been deleted from +/// the archive using deleteFile(). To clear out all deleted files, you could +/// close and then open the archive again. +/// +/// @see getFileEntry() +/// @see closeArchive() +/// @see openArchive()) +/// /// public int getFileEntryCount(string zipobject){ @@ -22907,7 +31989,23 @@ public int getFileEntryCount(string zipobject){ return m_ts.fnZipObject_getFileEntryCount(zipobject); } /// -/// read ), @brief Open a zip archive for manipulation. Once a zip archive is opened use the various ZipObject methods for working with the files within the archive. Be sure to close the archive when you are done with it. @param filename The path and file name of the zip archive to open. @param accessMode One of read, write or readwrite @return True is the archive was successfully opened. @note If you wish to make any changes to the archive, be sure to open it with a write or readwrite access mode. @see closeArchive()) +/// read ), +/// @brief Open a zip archive for manipulation. +/// +/// Once a zip archive is opened use the various ZipObject methods for +/// working with the files within the archive. Be sure to close the archive when +/// you are done with it. +/// +/// @param filename The path and file name of the zip archive to open. +/// @param accessMode One of read, write or readwrite +/// +/// @return True is the archive was successfully opened. +/// +/// @note If you wish to make any changes to the archive, be sure to open it +/// with a write or readwrite access mode. +/// +/// @see closeArchive()) +/// /// public bool openArchive(string zipobject, string filename, string accessMode = "read"){ @@ -22915,7 +32013,18 @@ public bool openArchive(string zipobject, string filename, string accessMode = return m_ts.fnZipObject_openArchive(zipobject, filename, accessMode); } /// -/// @brief Open a file within the zip archive for reading. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for reading. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string openFileForRead(string zipobject, string filename){ @@ -22923,7 +32032,18 @@ public string openFileForRead(string zipobject, string filename){ return m_ts.fnZipObject_openFileForRead(zipobject, filename); } /// -/// @brief Open a file within the zip archive for writing to. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for writing to. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string openFileForWrite(string zipobject, string filename){ @@ -22936,14 +32056,12 @@ public string openFileForWrite(string zipobject, string filename){ /// public class ZoneObject { -private Omni m_ts; - /// - /// - /// - /// -public ZoneObject(ref Omni ts){m_ts = ts;} /// -/// Dump a list of all objects assigned to the zone to the console as well as a list of all connected zone spaces. @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of objects are updated on demand, the zone contents can be outdated. ) +/// Dump a list of all objects assigned to the zone to the console as well as a list +/// of all connected zone spaces. +/// @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of +/// objects are updated on demand, the zone contents can be outdated. ) +/// /// public void dumpZoneState(string zone, bool updateFirst = true){ @@ -22951,7 +32069,9 @@ public void dumpZoneState(string zone, bool updateFirst = true){ m_ts.fnZone_dumpZoneState(zone, updateFirst); } /// -/// Get the unique numeric ID of the zone in its scene. @return The ID of the zone. ) +/// Get the unique numeric ID of the zone in its scene. +/// @return The ID of the zone. ) +/// /// public int getZoneId(string zone){ diff --git a/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/ModelBase.cs b/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/ModelBase.cs index f52ea1bf..ae729213 100644 --- a/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/ModelBase.cs +++ b/Templates/C#-Full/Winterleaf.Engine.Omni/Classes/ModelBase.cs @@ -48,8 +48,6 @@ namespace WinterLeaf.Engine.Classes [TypeConverter(typeof (TypeConverterGeneric))] public class ModelBase : pInvokes, IConvertible { - public static readonly pInvokes omni = new pInvokes(); - public static ulong Objectcount = 0; public ModelBase() diff --git a/Templates/C#-Full/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs b/Templates/C#-Full/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs index 0564d352..f7930249 100644 --- a/Templates/C#-Full/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs +++ b/Templates/C#-Full/Winterleaf.Engine.Omni/Enums/T3D_Enums.cs @@ -5960,7 +5960,7 @@ public object this[string key] public static readonly TypeGuiStackingType Vertical = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeVert,"Vertical","Stack children vertically by setting their Y position"); public static readonly TypeGuiStackingType Horizontal = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeHoriz,"Horizontal","Stack children horizontall by setting their X position"); - public static readonly TypeGuiStackingType Dynamic = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeDyn,"Dynamic","Automatically switch between Vertical and Horizontal stacking. Vertical stacking is chosen when the stack control is taller than it is wide, horizontal stacking is chosen when the stack control is wider than it is tall. "); + public static readonly TypeGuiStackingType Dynamic = new TypeGuiStackingType((int)R__GuiStackControl__StackingType.stackingTypeDyn,"Dynamic","Automatically switch between Vertical and Horizontal stacking. Vertical stacking is chosen when the stack control is taller than it is wide, horizontal stacking is chosen when the stack control is wider than it is tall. "); }; /// @@ -7896,29 +7896,29 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXChannel Volume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVolume,"Volume","Channel controls volume level of attached sound sources. n @see SFXDescription::volume "); - public static readonly TypeSFXChannel Pitch = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPitch,"Pitch","Channel controls pitch of attached sound sources. n @see SFXDescription::pitch "); - public static readonly TypeSFXChannel Priority = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPriority,"Priority","Channel controls virtualizaton priority level of attached sound sources. n @see SFXDescription::priority "); - public static readonly TypeSFXChannel PositionX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionX,"PositionX","Channel controls X coordinate of 3D sound position of attached sources. "); - public static readonly TypeSFXChannel PositionY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionY,"PositionY","Channel controls Y coordinate of 3D sound position of attached sources. "); - public static readonly TypeSFXChannel PositionZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionZ,"PositionZ","Channel controls Z coordinate of 3D sound position of attached sources. "); - public static readonly TypeSFXChannel RotationX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationX,"RotationX","Channel controls X rotation (in degrees) of 3D sound orientation of attached sources. "); - public static readonly TypeSFXChannel RotationY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationY,"RotationY","Channel controls Y rotation (in degrees) of 3D sound orientation of attached sources. "); - public static readonly TypeSFXChannel RotationZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationZ,"RotationZ","Channel controls Z rotation (in degrees) of 3D sound orientation of attached sources. "); - public static readonly TypeSFXChannel VelocityX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityX,"VelocityX","Channel controls X coordinate of 3D sound velocity vector of attached sources. "); - public static readonly TypeSFXChannel VelocityY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityY,"VelocityY","Channel controls Y coordinate of 3D sound velocity vector of attached sources. "); - public static readonly TypeSFXChannel VelocityZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityZ,"VelocityZ","Channel controls Z coordinate of 3D sound velocity vector of attached sources. "); - public static readonly TypeSFXChannel ReferenceDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMinDistance,"ReferenceDistance","Channel controls reference distance of 3D sound of attached sources. n @see SFXDescription::referenceDistance "); - public static readonly TypeSFXChannel MaxDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMaxDistance,"MaxDistance","Channel controls max volume attenuation distance of 3D sound of attached sources. n @see SFXDescription::maxDistance "); - public static readonly TypeSFXChannel ConeInsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeInsideAngle,"ConeInsideAngle","Channel controls angle (in degrees) of 3D sound inner volume cone of attached sources. n @see SFXDescription::coneInsideAngle "); - public static readonly TypeSFXChannel ConeOutsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideAngle,"ConeOutsideAngle","Channel controls angle (in degrees) of 3D sound outer volume cone of attached sources. n @see SFXDescription::coneOutsideAngle "); - public static readonly TypeSFXChannel ConeOutsideVolume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideVolume,"ConeOutsideVolume","Channel controls volume outside of 3D sound outer cone of attached sources. n @see SFXDescription::coneOutsideVolume "); - public static readonly TypeSFXChannel Cursor = new TypeSFXChannel((int)R__SFXChannel.SFXChannelCursor,"Cursor","Channel controls playback cursor of attached sound sources. n n @note Be aware that different types of sound sources interpret play cursor positions differently or do not actually have play cursors (these sources will ignore the channel). "); - public static readonly TypeSFXChannel Status = new TypeSFXChannel((int)R__SFXChannel.SFXChannelStatus,"Status","Channel controls playback status of attached sound sources. n n The channel's value is rounded down to the nearest integer and interpreted in the following way: n - 1: Play n - 2: Stop n - 3: Pause n n "); - public static readonly TypeSFXChannel User0 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser0,"User0","Channel available for custom use. By default ignored by sources. n n @note For FMOD Designer event sources (SFXFMODEventSource), this channel is used for event parameters defined in FMOD Designer and should not be used otherwise. n n @see SFXSource::onParameterValueChange "); - public static readonly TypeSFXChannel User1 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser1,"User1","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); - public static readonly TypeSFXChannel User2 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser2,"User2","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); - public static readonly TypeSFXChannel User3 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser3,"User3","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel Volume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVolume,"Volume","Channel controls volume level of attached sound sources. n @see SFXDescription::volume "); + public static readonly TypeSFXChannel Pitch = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPitch,"Pitch","Channel controls pitch of attached sound sources. n @see SFXDescription::pitch "); + public static readonly TypeSFXChannel Priority = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPriority,"Priority","Channel controls virtualizaton priority level of attached sound sources. n @see SFXDescription::priority "); + public static readonly TypeSFXChannel PositionX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionX,"PositionX"," Channel controls X coordinate of 3D sound position of attached sources. "); + public static readonly TypeSFXChannel PositionY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionY,"PositionY"," Channel controls Y coordinate of 3D sound position of attached sources. "); + public static readonly TypeSFXChannel PositionZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelPositionZ,"PositionZ"," Channel controls Z coordinate of 3D sound position of attached sources. "); + public static readonly TypeSFXChannel RotationX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationX,"RotationX"," Channel controls X rotation (in degrees) of 3D sound orientation of attached sources. "); + public static readonly TypeSFXChannel RotationY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationY,"RotationY"," Channel controls Y rotation (in degrees) of 3D sound orientation of attached sources. "); + public static readonly TypeSFXChannel RotationZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelRotationZ,"RotationZ"," Channel controls Z rotation (in degrees) of 3D sound orientation of attached sources. "); + public static readonly TypeSFXChannel VelocityX = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityX,"VelocityX"," Channel controls X coordinate of 3D sound velocity vector of attached sources. "); + public static readonly TypeSFXChannel VelocityY = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityY,"VelocityY"," Channel controls Y coordinate of 3D sound velocity vector of attached sources. "); + public static readonly TypeSFXChannel VelocityZ = new TypeSFXChannel((int)R__SFXChannel.SFXChannelVelocityZ,"VelocityZ"," Channel controls Z coordinate of 3D sound velocity vector of attached sources. "); + public static readonly TypeSFXChannel ReferenceDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMinDistance,"ReferenceDistance","Channel controls reference distance of 3D sound of attached sources. n @see SFXDescription::referenceDistance "); + public static readonly TypeSFXChannel MaxDistance = new TypeSFXChannel((int)R__SFXChannel.SFXChannelMaxDistance,"MaxDistance","Channel controls max volume attenuation distance of 3D sound of attached sources. n @see SFXDescription::maxDistance "); + public static readonly TypeSFXChannel ConeInsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeInsideAngle,"ConeInsideAngle","Channel controls angle (in degrees) of 3D sound inner volume cone of attached sources. n @see SFXDescription::coneInsideAngle "); + public static readonly TypeSFXChannel ConeOutsideAngle = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideAngle,"ConeOutsideAngle","Channel controls angle (in degrees) of 3D sound outer volume cone of attached sources. n @see SFXDescription::coneOutsideAngle "); + public static readonly TypeSFXChannel ConeOutsideVolume = new TypeSFXChannel((int)R__SFXChannel.SFXChannelConeOutsideVolume,"ConeOutsideVolume","Channel controls volume outside of 3D sound outer cone of attached sources. n @see SFXDescription::coneOutsideVolume "); + public static readonly TypeSFXChannel Cursor = new TypeSFXChannel((int)R__SFXChannel.SFXChannelCursor,"Cursor","Channel controls playback cursor of attached sound sources. n n @note Be aware that different types of sound sources interpret play cursor positions differently or do not actually have play cursors (these sources will ignore the channel). "); + public static readonly TypeSFXChannel Status = new TypeSFXChannel((int)R__SFXChannel.SFXChannelStatus,"Status","Channel controls playback status of attached sound sources. n n The channel's value is rounded down to the nearest integer and interpreted in the following way: n - 1: Play n - 2: Stop n - 3: Pause n n "); + public static readonly TypeSFXChannel User0 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser0,"User0","Channel available for custom use. By default ignored by sources. n n @note For FMOD Designer event sources (SFXFMODEventSource), this channel is used for event parameters defined in FMOD Designer and should not be used otherwise. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel User1 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser1,"User1","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel User2 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser2,"User2","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); + public static readonly TypeSFXChannel User3 = new TypeSFXChannel((int)R__SFXChannel.SFXChannelUser3,"User3","Channel available for custom use. By default ignored by sources. n n @see SFXSource::onParameterValueChange "); }; /// @@ -7993,8 +7993,8 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXDistanceModel Linear = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLinear,"Linear","Volume attenuates linearly from the references distance onwards to max distance where it reaches zero. "); - public static readonly TypeSFXDistanceModel Logarithmic = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLogarithmic,"Logarithmic","Volume attenuates logarithmically starting from the reference distance and halving every reference distance step from there on. Attenuation stops at max distance but volume won't reach zero. "); + public static readonly TypeSFXDistanceModel Linear = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLinear,"Linear"," Volume attenuates linearly from the references distance onwards to max distance where it reaches zero. "); + public static readonly TypeSFXDistanceModel Logarithmic = new TypeSFXDistanceModel((int)R__SFXDistanceModel.SFXDistanceModelLogarithmic,"Logarithmic","Volume attenuates logarithmically starting from the reference distance and halving every reference distance step from there on. Attenuation stops at max distance but volume won't reach zero. "); }; /// @@ -8069,8 +8069,8 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListLoopMode All = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_All,"All","Loop over all slots, i.e. jump from last to first slot after all slots have played. "); - public static readonly TypeSFXPlayListLoopMode Single = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_Single,"Single","Loop infinitely over the current slot. Only useful in combination with either states or manual playlist control. "); + public static readonly TypeSFXPlayListLoopMode All = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_All,"All"," Loop over all slots, i.e. jump from last to first slot after all slots have played. "); + public static readonly TypeSFXPlayListLoopMode Single = new TypeSFXPlayListLoopMode((int)R__SFXPlayList__ELoopMode.LOOP_Single,"Single"," Loop infinitely over the current slot. Only useful in combination with either states or manual playlist control. "); }; /// @@ -8145,9 +8145,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListRandomMode NotRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_NotRandom,"NotRandom","Play slots in sequential order. No randomization. "); - public static readonly TypeSFXPlayListRandomMode StrictRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_StrictRandom,"StrictRandom","Play a strictly random selection of slots. n n In this mode, a set of numSlotsToPlay random numbers between 0 and numSlotsToPlay-1 (inclusive), i.e. in the range of valid slot indices, is generated and playlist slots are played back in the order of this list. This allows the same slot to occur multiple times in a list and, consequentially, allows for other slots to not appear at all in a given slot ordering. "); - public static readonly TypeSFXPlayListRandomMode OrderedRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_OrderedRandom,"OrderedRandom","Play all slots in the list in a random order. n n In this mode, the @c numSlotsToPlay slots from the list with valid tracks assigned are put into a random order and played. This guarantees that each slots is played exactly once albeit at a random position in the total ordering. "); + public static readonly TypeSFXPlayListRandomMode NotRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_NotRandom,"NotRandom"," Play slots in sequential order. No randomization. "); + public static readonly TypeSFXPlayListRandomMode StrictRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_StrictRandom,"StrictRandom","Play a strictly random selection of slots. n n In this mode, a set of numSlotsToPlay random numbers between 0 and numSlotsToPlay-1 (inclusive), i.e. in the range of valid slot indices, is generated and playlist slots are played back in the order of this list. This allows the same slot to occur multiple times in a list and, consequentially, allows for other slots to not appear at all in a given slot ordering. "); + public static readonly TypeSFXPlayListRandomMode OrderedRandom = new TypeSFXPlayListRandomMode((int)R__SFXPlayList__ERandomMode.RANDOM_OrderedRandom,"OrderedRandom","Play all slots in the list in a random order. n n In this mode, the @c numSlotsToPlay slots from the list with valid tracks assigned are put into a random order and played. This guarantees that each slots is played exactly once albeit at a random position in the total ordering. "); }; /// @@ -8222,11 +8222,11 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListReplayMode IgnorePlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_IgnorePlaying,"IgnorePlaying","Ignore any sources that may already be playing on the slot and just create a new source. "); - public static readonly TypeSFXPlayListReplayMode RestartPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_RestartPlaying,"RestartPlaying","Restart all sources that was last created for the slot. "); - public static readonly TypeSFXPlayListReplayMode KeepPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_KeepPlaying,"KeepPlaying","Keep playing the current source(s) as if the source started last on the slot was created in this cycle. For this, the sources associated with the slot are brought to the top of the play stack. "); - public static readonly TypeSFXPlayListReplayMode StartNew = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_StartNew,"StartNew","Stop all sources currently playing on the slot and then create a new source. "); - public static readonly TypeSFXPlayListReplayMode SkipIfPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_SkipIfPlaying,"SkipIfPlaying","If there are sources already playing on the slot, skip the play stage. "); + public static readonly TypeSFXPlayListReplayMode IgnorePlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_IgnorePlaying,"IgnorePlaying"," Ignore any sources that may already be playing on the slot and just create a new source. "); + public static readonly TypeSFXPlayListReplayMode RestartPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_RestartPlaying,"RestartPlaying"," Restart all sources that was last created for the slot. "); + public static readonly TypeSFXPlayListReplayMode KeepPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_KeepPlaying,"KeepPlaying","Keep playing the current source(s) as if the source started last on the slot was created in this cycle. For this, the sources associated with the slot are brought to the top of the play stack. "); + public static readonly TypeSFXPlayListReplayMode StartNew = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_StartNew,"StartNew"," Stop all sources currently playing on the slot and then create a new source. "); + public static readonly TypeSFXPlayListReplayMode SkipIfPlaying = new TypeSFXPlayListReplayMode((int)R__SFXPlayList__EReplayMode.REPLAY_SkipIfPlaying,"SkipIfPlaying"," If there are sources already playing on the slot, skip the play stage. "); }; /// @@ -8301,9 +8301,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListStateMode StopWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_StopInactive,"StopWhenDeactivated","Stop the sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. "); - public static readonly TypeSFXPlayListStateMode PauseWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_PauseInactive,"PauseWhenDeactivated","Pause all sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. n n When the slot's state is reactivated again, the sources will resume playback. "); - public static readonly TypeSFXPlayListStateMode IgnoreWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_IgnoreInactive,"IgnoreWhenDeactivated","Ignore when a state changes to a setting incompatible with the slot's state setting and just keep playing sources attached to the slot. "); + public static readonly TypeSFXPlayListStateMode StopWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_StopInactive,"StopWhenDeactivated","Stop the sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. "); + public static readonly TypeSFXPlayListStateMode PauseWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_PauseInactive,"PauseWhenDeactivated","Pause all sources playing on the slot when a state changes to a setting that is incompatible with the slot's state setting. n n When the slot's state is reactivated again, the sources will resume playback. "); + public static readonly TypeSFXPlayListStateMode IgnoreWhenDeactivated = new TypeSFXPlayListStateMode((int)R__SFXPlayList__EStateMode.STATE_IgnoreInactive,"IgnoreWhenDeactivated","Ignore when a state changes to a setting incompatible with the slot's state setting and just keep playing sources attached to the slot. "); }; /// @@ -8378,11 +8378,11 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXPlayListTransitionMode None = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_None,"None","No transition. Immediately move on to processing the slot or immediately move on to the next slot. "); - public static readonly TypeSFXPlayListTransitionMode Wait = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Wait,"Wait","Wait for the sound source spawned last by this playlist to finish playing. Then proceed. "); - public static readonly TypeSFXPlayListTransitionMode WaitAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_WaitAll,"WaitAll","Wait for all sound sources currently spawned by the playlist to finish playing. Then proceed. "); - public static readonly TypeSFXPlayListTransitionMode Stop = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Stop,"Stop","Stop the sound source spawned last by this playlist. Then proceed. "); - public static readonly TypeSFXPlayListTransitionMode StopAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_StopAll,"StopAll","Stop all sound sources spawned by the playlist. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode None = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_None,"None"," No transition. Immediately move on to processing the slot or immediately move on to the next slot. "); + public static readonly TypeSFXPlayListTransitionMode Wait = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Wait,"Wait"," Wait for the sound source spawned last by this playlist to finish playing. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode WaitAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_WaitAll,"WaitAll"," Wait for all sound sources currently spawned by the playlist to finish playing. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode Stop = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_Stop,"Stop"," Stop the sound source spawned last by this playlist. Then proceed. "); + public static readonly TypeSFXPlayListTransitionMode StopAll = new TypeSFXPlayListTransitionMode((int)R__SFXPlayList__ETransitionMode.TRANSITION_StopAll,"StopAll"," Stop all sound sources spawned by the playlist. Then proceed. "); }; /// @@ -8457,9 +8457,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeSFXStatus Playing = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPlaying,"Playing","The source is currently playing. "); - public static readonly TypeSFXStatus Stopped = new TypeSFXStatus((int)R__SFXStatus.SFXStatusStopped,"Stopped","Playback of the source is stopped. When transitioning to Playing state, playback will start at the beginning of the source. "); - public static readonly TypeSFXStatus Paused = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPaused,"Paused","Playback of the source is paused. Resuming playback will play from the current playback position. "); + public static readonly TypeSFXStatus Playing = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPlaying,"Playing"," The source is currently playing. "); + public static readonly TypeSFXStatus Stopped = new TypeSFXStatus((int)R__SFXStatus.SFXStatusStopped,"Stopped","Playback of the source is stopped. When transitioning to Playing state, playback will start at the beginning of the source. "); + public static readonly TypeSFXStatus Paused = new TypeSFXStatus((int)R__SFXStatus.SFXStatusPaused,"Paused"," Playback of the source is paused. Resuming playback will play from the current playback position. "); }; /// @@ -8534,9 +8534,9 @@ public object this[string key] get { return msdict[key]; } } - public static readonly TypeShadowFilterMode None = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_None,"None","@brief Simple point sampled filtering. n This is the fastest and lowest quality mode. "); - public static readonly TypeShadowFilterMode SoftShadow = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadow,"SoftShadow","@brief A variable tap rotated poisson disk soft shadow filter. n It performs 4 taps to classify the point as in shadow, out of shadow, or along a shadow edge. Samples on the edge get an additional 8 taps to soften them. "); - public static readonly TypeShadowFilterMode SoftShadowHighQuality = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadowHighQuality,"SoftShadowHighQuality","@brief A 12 tap rotated poisson disk soft shadow filter. n It performs all the taps for every point without any early rejection. "); + public static readonly TypeShadowFilterMode None = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_None,"None","@brief Simple point sampled filtering. n This is the fastest and lowest quality mode. "); + public static readonly TypeShadowFilterMode SoftShadow = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadow,"SoftShadow","@brief A variable tap rotated poisson disk soft shadow filter. n It performs 4 taps to classify the point as in shadow, out of shadow, or along a shadow edge. Samples on the edge get an additional 8 taps to soften them. "); + public static readonly TypeShadowFilterMode SoftShadowHighQuality = new TypeShadowFilterMode((int)R__ShadowFilterMode.ShadowFilterMode_SoftShadowHighQuality,"SoftShadowHighQuality","@brief A 12 tap rotated poisson disk soft shadow filter. n It performs all the taps for every point without any early rejection. "); }; /// diff --git a/Templates/C#-Full/Winterleaf.Engine.Omni/Omni.Auto.cs b/Templates/C#-Full/Winterleaf.Engine.Omni/Omni.Auto.cs index 127ae127..c3616d92 100644 --- a/Templates/C#-Full/Winterleaf.Engine.Omni/Omni.Auto.cs +++ b/Templates/C#-Full/Winterleaf.Engine.Omni/Omni.Auto.cs @@ -10,7 +10,12 @@ sealed public partial class Omni { /// -/// (aiConnect, S32 , 2, 20, (...) @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. @returns The newly created AIConnection @see GameConnection for parameter information @ingroup AI) +/// (aiConnect, S32 , 2, 20, (...) +/// @brief Creates a new AIConnection, and passes arguments to its onConnect script callback. +/// @returns The newly created AIConnection +/// @see GameConnection for parameter information +/// @ingroup AI) +/// /// public int fn__aiConnect (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -78,7 +83,37 @@ public int fn__aiConnect (string a1, string a2, string a3, string a4, string a5, return SafeNativeMethods.mwle_fn__aiConnect(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( buildTaggedString, const char*, 2, 11, (string format, ...) @brief Build a string using the specified tagged string format. This function takes an already tagged string (passed in as a tagged string ID) and one or more additional strings. If the tagged string contains argument tags that range from %%1 through %%9, then each additional string will be substituted into the tagged string. The final (non-tagged) combined string will be returned. The maximum length of the tagged string plus any inserted additional strings is 511 characters. @param format A tagged string ID that contains zero or more argument tags, in the form of %%1 through %%9. @param ... A variable number of arguments that are insterted into the tagged string based on the argument tags within the format string. @returns An ordinary string that is a combination of the original tagged string with any additional strings passed in inserted in place of each argument tag. @tsexample // Create a tagged string with argument tags %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); // Some point later, combine the tagged string with some other string %string = buildTaggedString(%taggedStringID, %playerName); echo(%string); @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// ( buildTaggedString, const char*, 2, 11, (string format, ...) +/// @brief Build a string using the specified tagged string format. +/// +/// This function takes an already tagged string (passed in as a tagged string ID) and one +/// or more additional strings. If the tagged string contains argument tags that range from +/// %%1 through %%9, then each additional string will be substituted into the tagged string. +/// The final (non-tagged) combined string will be returned. The maximum length of the tagged +/// string plus any inserted additional strings is 511 characters. +/// +/// @param format A tagged string ID that contains zero or more argument tags, in the form of +/// %%1 through %%9. +/// @param ... A variable number of arguments that are insterted into the tagged string +/// based on the argument tags within the format string. +/// +/// @returns An ordinary string that is a combination of the original tagged string with any additional +/// strings passed in inserted in place of each argument tag. +/// +/// @tsexample +/// // Create a tagged string with argument tags +/// %taggedStringID = addTaggedString(\"Welcome %1 to the game!\"); +/// +/// // Some point later, combine the tagged string with some other string +/// %string = buildTaggedString(%taggedStringID, %playerName); +/// echo(%string); +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string fn__buildTaggedString (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10) @@ -122,7 +157,21 @@ public string fn__buildTaggedString (string a1, string a2, string a3, string a4, } /// -/// ( call, const char *, 2, 0, ( string functionName, string args... ) Apply the given arguments to the specified global function and return the result of the call. @param functionName The name of the function to call. This function must be in the global namespace, i.e. you cannot call a function in a namespace through #call. Use eval() for that. @return The result of the function call. @tsexample function myFunction( %arg ) { return ( %arg SPC \"World!\" ); } echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. @endtsexample @ingroup Scripting ) +/// ( call, const char *, 2, 0, ( string functionName, string args... ) +/// Apply the given arguments to the specified global function and return the result of the call. +/// @param functionName The name of the function to call. This function must be in the global namespace, i.e. +/// you cannot call a function in a namespace through #call. Use eval() for that. +/// @return The result of the function call. +/// @tsexample +/// function myFunction( %arg ) +/// { +/// return ( %arg SPC \"World!\" ); +/// } +/// +/// echo( call( \"myFunction\", \"Hello\" ) ); // Prints \"Hello World!\" to the console. +/// @endtsexample +/// @ingroup Scripting ) +/// /// public string fn__call (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -193,7 +242,37 @@ public string fn__call (string a1, string a2, string a3, string a4, string a5, s } /// -/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) @brief Send a command from the server to the client @param client The numeric ID of a client GameConnection @param func Name of the client function being called @param ... Various parameters being passed to client command @tsexample // Set up the client command. Needs to be executed on the client, such as // within scripts/client/client.cs // Update the Ammo Counter with current ammo, if not any then hide the counter. function clientCmdSetAmmoAmountHud(%amount) { if (!%amount) AmmoAmount.setVisible(false); else { AmmoAmount.setVisible(true); AmmoAmount.setText(\"Ammo: \"@%amount); } } // Call it from a server function. Needs to be executed on the server, //such as within scripts/server/game.cs function GameConnection::setAmmoAmountHud(%client, %amount) { commandToClient(%client, 'SetAmmoAmountHud', %amount); } @endtsexample @ingroup Networking) +/// ( commandToClient, void, 3, 22, (NetConnection client, string func, ...) +/// @brief Send a command from the server to the client +/// +/// @param client The numeric ID of a client GameConnection +/// @param func Name of the client function being called +/// @param ... Various parameters being passed to client command +/// +/// @tsexample +/// // Set up the client command. Needs to be executed on the client, such as +/// // within scripts/client/client.cs +/// // Update the Ammo Counter with current ammo, if not any then hide the counter. +/// function clientCmdSetAmmoAmountHud(%amount) +/// { +/// if (!%amount) +/// AmmoAmount.setVisible(false); +/// else +/// { +/// AmmoAmount.setVisible(true); +/// AmmoAmount.setText(\"Ammo: \"@%amount); +/// } +/// } +/// // Call it from a server function. Needs to be executed on the server, +/// //such as within scripts/server/game.cs +/// function GameConnection::setAmmoAmountHud(%client, %amount) +/// { +/// commandToClient(%client, 'SetAmmoAmountHud', %amount); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void fn__commandToClient (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21) @@ -267,7 +346,42 @@ public void fn__commandToClient (string a1, string a2, string a3, string a4, str SafeNativeMethods.mwle_fn__commandToClient(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19, sba20, sba21); } /// -/// ( commandToServer, void, 2, 21, (string func, ...) @brief Send a command to the server. @param func Name of the server command being called @param ... Various parameters being passed to server command @tsexample // Create a standard function. Needs to be executed on the client, such // as within scripts/client/default.bind.cs function toggleCamera(%val) { // If key was down, call a server command named 'ToggleCamera' if (%val) commandToServer('ToggleCamera'); } // Server command being called from above. Needs to be executed on the // server, such as within scripts/server/commands.cs function serverCmdToggleCamera(%client) { if (%client.getControlObject() == %client.player) { %client.camera.setVelocity(\"0 0 0\"); %control = %client.camera; } else { %client.player.setVelocity(\"0 0 0\"); %control = %client.player; } %client.setControlObject(%control); clientCmdSyncEditorGui(); } @endtsexample @ingroup Networking) +/// ( commandToServer, void, 2, 21, (string func, ...) +/// @brief Send a command to the server. +/// +/// @param func Name of the server command being called +/// @param ... Various parameters being passed to server command +/// +/// @tsexample +/// // Create a standard function. Needs to be executed on the client, such +/// // as within scripts/client/default.bind.cs +/// function toggleCamera(%val) +/// { +/// // If key was down, call a server command named 'ToggleCamera' +/// if (%val) +/// commandToServer('ToggleCamera'); +/// } +/// // Server command being called from above. Needs to be executed on the +/// // server, such as within scripts/server/commands.cs +/// function serverCmdToggleCamera(%client) +/// { +/// if (%client.getControlObject() == %client.player) +/// { +/// %client.camera.setVelocity(\"0 0 0\"); +/// %control = %client.camera; +/// } +/// else +/// { +/// %client.player.setVelocity(\"0 0 0\"); +/// %control = %client.player; +/// } +/// %client.setControlObject(%control); +/// clientCmdSyncEditorGui(); +/// } +/// @endtsexample +/// +/// @ingroup Networking) +/// /// public void fn__commandToServer (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20) @@ -338,7 +452,13 @@ public void fn__commandToServer (string a1, string a2, string a3, string a4, str SafeNativeMethods.mwle_fn__commandToServer(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19, sba20); } /// -/// ( echo, void, 2, 0, ( string message... ) @brief Logs a message to the console. Concatenates all given arguments to a single string and prints the string to the console. A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( echo, void, 2, 0, ( string message... ) +/// @brief Logs a message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console. +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void fn__echo (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -406,7 +526,14 @@ public void fn__echo (string a1, string a2, string a3, string a4, string a5, str SafeNativeMethods.mwle_fn__echo(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( error, void, 2, 0, ( string message... ) @brief Logs an error message to the console. Concatenates all given arguments to a single string and prints the string to the console as an error message (in the in-game console, these will show up using a red font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( error, void, 2, 0, ( string message... ) +/// @brief Logs an error message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as an error +/// message (in the in-game console, these will show up using a red font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void fn__error (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -474,7 +601,15 @@ public void fn__error (string a1, string a2, string a3, string a4, string a5, st SafeNativeMethods.mwle_fn__error(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) @brief Manually execute a special script file that contains game or editor preferences @param relativeFileName Name and path to file from project folder @param noCalls Deprecated @param journalScript Deprecated @return True if script was successfully executed @note Appears to be useless in Torque 3D, should be deprecated @ingroup Scripting) +/// ( execPrefs, bool, 2, 4, ( string relativeFileName, bool noCalls=false, bool journalScript=false ) +/// @brief Manually execute a special script file that contains game or editor preferences +/// @param relativeFileName Name and path to file from project folder +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if script was successfully executed +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @ingroup Scripting) +/// /// public bool fn__execPrefs (string a1, string a2, string a3) @@ -494,7 +629,12 @@ public bool fn__execPrefs (string a1, string a2, string a3) return SafeNativeMethods.mwle_fn__execPrefs(sba1, sba2, sba3)>=1; } /// -/// (expandFilename, const char*, 2, 2, (string filename) @brief Grabs the full path of a specified file @param filename Name of the local file to locate @return String containing the full filepath on disk @ingroup FileSystem) +/// (expandFilename, const char*, 2, 2, (string filename) +/// @brief Grabs the full path of a specified file +/// @param filename Name of the local file to locate +/// @return String containing the full filepath on disk +/// @ingroup FileSystem) +/// /// public string fn__expandFilename (string a1) @@ -511,7 +651,11 @@ public string fn__expandFilename (string a1) } /// -/// (expandOldFilename, const char*, 2, 2, (string filename) @brief Retrofits a filepath that uses old Torque style @return String containing filepath with new formatting @ingroup FileSystem) +/// (expandOldFilename, const char*, 2, 2, (string filename) +/// @brief Retrofits a filepath that uses old Torque style +/// @return String containing filepath with new formatting +/// @ingroup FileSystem) +/// /// public string fn__expandOldFilename (string a1) @@ -528,7 +672,110 @@ public string fn__expandOldFilename (string a1) } /// -/// ( mathInit, void, 1, 10, ( ... ) @brief Install the math library with specified extensions. Possible parameters are: - 'DETECT' Autodetect math lib settings. - 'C' Enable the C math routines. C routines are always enabled. - 'FPU' Enable floating point unit routines. - 'MMX' Enable MMX math routines. - '3DNOW' Enable 3dNow! math routines. - 'SSE' Enable SSE math routines. @ingroup Math) +/// ( getStockColorCount, S32, 1, 1, () - Gets a count of available stock colors. +/// @return A count of available stock colors. ) +/// +/// + +public int fn__getStockColorCount () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorCount'"); + + +return SafeNativeMethods.mwle_fn__getStockColorCount(); +} +/// +/// ( getStockColorF, const char*, 2, 2, (stockColorName) - Gets a floating-point-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// + +public string fn__getStockColorF (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorF'" + string.Format("\"{0}\" ",a1)); +var returnbuff = new StringBuilder(16384); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +SafeNativeMethods.mwle_fn__getStockColorF(sba1, returnbuff); +return returnbuff.ToString(); + +} +/// +/// ( getStockColorI, const char*, 2, 2, (stockColorName) - Gets a byte-based stock color by name. +/// @param stockColorName - The stock color name to retrieve. +/// @return The stock color that matches the specified color name. Returns nothing if the color name is not found. ) +/// +/// + +public string fn__getStockColorI (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorI'" + string.Format("\"{0}\" ",a1)); +var returnbuff = new StringBuilder(16384); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +SafeNativeMethods.mwle_fn__getStockColorI(sba1, returnbuff); +return returnbuff.ToString(); + +} +/// +/// ( getStockColorName, const char*, 2, 2, (stockColorIndex) - Gets the stock color name at the specified index. +/// @param stockColorIndex The zero-based index of the stock color name to retrieve. +/// @return The stock color name at the specified index or nothing if the string is invalid. ) +/// +/// + +public string fn__getStockColorName (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__getStockColorName'" + string.Format("\"{0}\" ",a1)); +var returnbuff = new StringBuilder(16384); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +SafeNativeMethods.mwle_fn__getStockColorName(sba1, returnbuff); +return returnbuff.ToString(); + +} +/// +/// ( isStockColor, bool, 2, 2, (stockColorName) - Gets whether the specified name is a stock color or not. +/// @param stockColorName - The stock color name to test for. +/// @return Whether the specified name is a stock color or not. ) +/// +/// + +public bool fn__isStockColor (string a1) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn__isStockColor'" + string.Format("\"{0}\" ",a1)); +StringBuilder sba1 = null; +if (a1 != null) + sba1 = new StringBuilder(a1, 1024); + +return SafeNativeMethods.mwle_fn__isStockColor(sba1)>=1; +} +/// +/// ( mathInit, void, 1, 10, ( ... ) +/// @brief Install the math library with specified extensions. +/// Possible parameters are: +/// - 'DETECT' Autodetect math lib settings. +/// - 'C' Enable the C math routines. C routines are always enabled. +/// - 'FPU' Enable floating point unit routines. +/// - 'MMX' Enable MMX math routines. +/// - '3DNOW' Enable 3dNow! math routines. +/// - 'SSE' Enable SSE math routines. +/// @ingroup Math) +/// +/// +/// /// public void fn__mathInit (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9) @@ -566,7 +813,12 @@ public void fn__mathInit (string a1, string a2, string a3, string a4, string a5, SafeNativeMethods.mwle_fn__mathInit(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9); } /// -/// (resourceDump, void, 1, 1, () @brief List the currently managed resources Currently used by editors only, internal @ingroup Editors @internal) +/// (resourceDump, void, 1, 1, () +/// @brief List the currently managed resources +/// Currently used by editors only, internal +/// @ingroup Editors +/// @internal) +/// /// public void fn__resourceDump () @@ -579,6 +831,7 @@ public void fn__resourceDump () } /// /// (schedule, S32, 4, 0, schedule(time, refobject|0, command, arg1...argN>)) +/// /// public int fn__schedule (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -647,6 +900,7 @@ public int fn__schedule (string a1, string a2, string a3, string a4, string a5, } /// /// (TestFunction2Args, const char *, 3, 3, testFunction(arg1, arg2)) +/// /// public string fn__TestFunction2Args (string a1, string a2) @@ -666,7 +920,14 @@ public string fn__TestFunction2Args (string a1, string a2) } /// -/// ( warn, void, 2, 0, ( string message... ) @brief Logs a warning message to the console. Concatenates all given arguments to a single string and prints the string to the console as a warning message (in the in-game console, these will show up using a turquoise font by default). A newline is added automatically after the text. @param message Any number of string arguments. @ingroup Logging ) +/// ( warn, void, 2, 0, ( string message... ) +/// @brief Logs a warning message to the console. +/// Concatenates all given arguments to a single string and prints the string to the console as a warning +/// message (in the in-game console, these will show up using a turquoise font by default). +/// A newline is added automatically after the text. +/// @param message Any number of string arguments. +/// @ingroup Logging ) +/// /// public void fn__warn (string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -734,7 +995,11 @@ public void fn__warn (string a1, string a2, string a3, string a4, string a5, str SafeNativeMethods.mwle_fn__warn(sba1, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// () @brief Activates DirectInput. Also activates any connected joysticks. @ingroup Input) +/// () +/// @brief Activates DirectInput. +/// Also activates any connected joysticks. +/// @ingroup Input) +/// /// public void fn_activateDirectInput () @@ -764,7 +1029,28 @@ public void fn_activatePackage (string packageName) SafeNativeMethods.mwle_fn_activatePackage(sbpackageName); } /// -/// @brief Add a string to the bad word filter The bad word filter is a table containing words which will not be displayed in chat windows. Instead, a designated replacement string will be displayed. There are already a number of bad words automatically defined. @param badWord Exact text of the word to restrict. @return True if word was successfully added, false if the word or a subset of it already exists in the table @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Returns true, word was successfully added addBadWord(%badWord); // Returns false, word has already been added addBadWord(\"Foobar\"); @endtsexample @ingroup Game) +/// @brief Add a string to the bad word filter +/// +/// The bad word filter is a table containing words which will not be +/// displayed in chat windows. Instead, a designated replacement string will be displayed. +/// There are already a number of bad words automatically defined. +/// +/// @param badWord Exact text of the word to restrict. +/// @return True if word was successfully added, false if the word or a subset of it already exists in the table +/// +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Returns true, word was successfully added +/// addBadWord(%badWord); +/// // Returns false, word has already been added +/// addBadWord(\"Foobar\"); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool fn_addBadWord (string badWord) @@ -778,7 +1064,13 @@ public bool fn_addBadWord (string badWord) return SafeNativeMethods.mwle_fn_addBadWord(sbbadWord)>=1; } /// -/// Adds a global shader macro which will be merged with the script defined macros on every shader. The macro will replace the value of an existing macro of the same name. For the new macro to take effect all the shaders in the system need to be reloaded. @see resetLightManager, removeGlobalShaderMacro @ingroup Rendering ) +/// Adds a global shader macro which will be merged with the script defined +/// macros on every shader. The macro will replace the value of an existing +/// macro of the same name. For the new macro to take effect all the shaders +/// in the system need to be reloaded. +/// @see resetLightManager, removeGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void fn_addGlobalShaderMacro (string name, string value) @@ -795,7 +1087,14 @@ public void fn_addGlobalShaderMacro (string name, string value) SafeNativeMethods.mwle_fn_addGlobalShaderMacro(sbname, sbvalue); } /// -/// (string texName, string matName) @brief Maps the given texture to the given material. Generates a console warning before overwriting. Material maps are used by terrain and interiors for triggering effects when an object moves onto a terrain block or interior surface using the associated texture. @ingroup Materials) +/// (string texName, string matName) +/// @brief Maps the given texture to the given material. +/// Generates a console warning before overwriting. +/// Material maps are used by terrain and interiors for triggering +/// effects when an object moves onto a terrain +/// block or interior surface using the associated texture. +/// @ingroup Materials) +/// /// public void fn_addMaterialMapping (string texName, string matName) @@ -812,7 +1111,19 @@ public void fn_addMaterialMapping (string texName, string matName) SafeNativeMethods.mwle_fn_addMaterialMapping(sbtexName, sbmatName); } /// -/// ), @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, so tagging the same string (excluding case differences) will be ignored as a duplicated tag. @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string @see \\ref syntaxDataTypes under Tagged %Strings @see removeTaggedString() @see getTaggedString() @ingroup Networking) +/// ), +/// @brief Use the addTaggedString function to tag a new string and add it to the NetStringTable +/// +/// @param str The string to be tagged and placed in the NetStringTable. Tagging ignores case, +/// so tagging the same string (excluding case differences) will be ignored as a duplicated tag. +/// +/// @return Returns a string( containing a numeric value) equivalent to the string ID for the newly tagged string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see removeTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public string fn_addTaggedString (string str) @@ -830,6 +1141,7 @@ public string fn_addTaggedString (string str) } /// /// ), 'playerName'[, 'AIClassType'] );) +/// /// public int fn_aiAddPlayer (string name, string ns) @@ -847,6 +1159,7 @@ public int fn_aiAddPlayer (string name, string ns) } /// /// ai.getAimLocation(); ) +/// /// public string fn_AIClient_getAimLocation (string aiclient) @@ -864,6 +1177,7 @@ public string fn_AIClient_getAimLocation (string aiclient) } /// /// ai.getLocation(); ) +/// /// public string fn_AIClient_getLocation (string aiclient) @@ -881,6 +1195,7 @@ public string fn_AIClient_getLocation (string aiclient) } /// /// ai.getMoveDestination(); ) +/// /// public string fn_AIClient_getMoveDestination (string aiclient) @@ -898,6 +1213,7 @@ public string fn_AIClient_getMoveDestination (string aiclient) } /// /// ai.getTargetObject(); ) +/// /// public int fn_AIClient_getTargetObject (string aiclient) @@ -912,6 +1228,7 @@ public int fn_AIClient_getTargetObject (string aiclient) } /// /// ai.missionCycleCleanup(); ) +/// /// public void fn_AIClient_missionCycleCleanup (string aiclient) @@ -926,6 +1243,7 @@ public void fn_AIClient_missionCycleCleanup (string aiclient) } /// /// ai.move(); ) +/// /// public void fn_AIClient_move (string aiclient) @@ -940,6 +1258,7 @@ public void fn_AIClient_move (string aiclient) } /// /// ai.moveForward(); ) +/// /// public void fn_AIClient_moveForward (string aiclient) @@ -954,6 +1273,7 @@ public void fn_AIClient_moveForward (string aiclient) } /// /// ai.setAimLocation( x y z ); ) +/// /// public void fn_AIClient_setAimLocation (string aiclient, string v) @@ -971,6 +1291,7 @@ public void fn_AIClient_setAimLocation (string aiclient, string v) } /// /// ai.setMoveDestination( x y z ); ) +/// /// public void fn_AIClient_setMoveDestination (string aiclient, string v) @@ -988,6 +1309,7 @@ public void fn_AIClient_setMoveDestination (string aiclient, string v) } /// /// ai.setMoveSpeed( float ); ) +/// /// public void fn_AIClient_setMoveSpeed (string aiclient, float speed) @@ -1002,6 +1324,7 @@ public void fn_AIClient_setMoveSpeed (string aiclient, float speed) } /// /// ai.setTargetObject( obj ); ) +/// /// public void fn_AIClient_setTargetObject (string aiclient, string objName) @@ -1019,6 +1342,7 @@ public void fn_AIClient_setTargetObject (string aiclient, string objName) } /// /// ai.stop(); ) +/// /// public void fn_AIClient_stop (string aiclient) @@ -1033,6 +1357,7 @@ public void fn_AIClient_stop (string aiclient) } /// /// ) +/// /// public string fn_AIConnection_getAddress (string aiconnection) @@ -1049,7 +1374,9 @@ public string fn_AIConnection_getAddress (string aiconnection) } /// -/// getFreeLook() Is freelook on for the current move?) +/// getFreeLook() +/// Is freelook on for the current move?) +/// /// public bool fn_AIConnection_getFreeLook (string aiconnection) @@ -1063,7 +1390,11 @@ public bool fn_AIConnection_getFreeLook (string aiconnection) return SafeNativeMethods.mwle_fn_AIConnection_getFreeLook(sbaiconnection)>=1; } /// -/// (string field) Get the given field of a move. @param field One of {'x','y','z','yaw','pitch','roll'} @returns The requested field on the current move.) +/// (string field) +/// Get the given field of a move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @returns The requested field on the current move.) +/// /// public float fn_AIConnection_getMove (string aiconnection, string field) @@ -1080,7 +1411,9 @@ public float fn_AIConnection_getMove (string aiconnection, string field) return SafeNativeMethods.mwle_fn_AIConnection_getMove(sbaiconnection, sbfield); } /// -/// (int trigger) Is the given trigger set?) +/// (int trigger) +/// Is the given trigger set?) +/// /// public bool fn_AIConnection_getTrigger (string aiconnection, int idx) @@ -1094,7 +1427,9 @@ public bool fn_AIConnection_getTrigger (string aiconnection, int idx) return SafeNativeMethods.mwle_fn_AIConnection_getTrigger(sbaiconnection, idx)>=1; } /// -/// (bool isFreeLook) Enable/disable freelook on the current move.) +/// (bool isFreeLook) +/// Enable/disable freelook on the current move.) +/// /// public void fn_AIConnection_setFreeLook (string aiconnection, bool isFreeLook) @@ -1108,7 +1443,11 @@ public void fn_AIConnection_setFreeLook (string aiconnection, bool isFreeLook) SafeNativeMethods.mwle_fn_AIConnection_setFreeLook(sbaiconnection, isFreeLook); } /// -/// (string field, float value) Set a field on the current move. @param field One of {'x','y','z','yaw','pitch','roll'} @param value Value to set field to.) +/// (string field, float value) +/// Set a field on the current move. +/// @param field One of {'x','y','z','yaw','pitch','roll'} +/// @param value Value to set field to.) +/// /// public void fn_AIConnection_setMove (string aiconnection, string field, float value) @@ -1125,7 +1464,9 @@ public void fn_AIConnection_setMove (string aiconnection, string field, float va SafeNativeMethods.mwle_fn_AIConnection_setMove(sbaiconnection, sbfield, value); } /// -/// (int trigger, bool set) Set a trigger.) +/// (int trigger, bool set) +/// Set a trigger.) +/// /// public void fn_AIConnection_setTrigger (string aiconnection, int idx, bool set) @@ -1139,7 +1480,10 @@ public void fn_AIConnection_setTrigger (string aiconnection, int idx, bool set) SafeNativeMethods.mwle_fn_AIConnection_setTrigger(sbaiconnection, idx, set); } /// -/// ( GameBase obj, [Point3F offset] ) Sets the bot's target object. Optionally set an offset from target location. @hide) +/// ( GameBase obj, [Point3F offset] ) +/// Sets the bot's target object. Optionally set an offset from target location. +/// @hide) +/// /// public void fn_AIPlayer_setAimObject (string aiplayer, string objName, string offset) @@ -1159,7 +1503,13 @@ public void fn_AIPlayer_setAimObject (string aiplayer, string objName, string of SafeNativeMethods.mwle_fn_AIPlayer_setAimObject(sbaiplayer, sbobjName, sboffset); } /// -/// allowConnections(bool allow) @brief Sets whether or not the global NetInterface allows connections from remote hosts. @param allow Set to true to allow remote connections. @ingroup Networking) +/// allowConnections(bool allow) +/// @brief Sets whether or not the global NetInterface allows connections from remote hosts. +/// +/// @param allow Set to true to allow remote connections. +/// +/// @ingroup Networking) +/// /// public void fn_allowConnections (bool allow) @@ -1186,7 +1536,16 @@ public void fn_backtrace () SafeNativeMethods.mwle_fn_backtrace(); } /// -/// CSV), (location, [backend]) - @brief Takes a string informing the backend where to store sample data and optionally a name of the specific logging backend to use. The default is the CSV backend. In most cases, the logging store will be a file name. @tsexample beginSampling( \"mysamples.csv\" ); @endtsexample @ingroup Rendering) +/// CSV), (location, [backend]) - +/// @brief Takes a string informing the backend where to store +/// sample data and optionally a name of the specific logging +/// backend to use. The default is the CSV backend. In most +/// cases, the logging store will be a file name. +/// @tsexample +/// beginSampling( \"mysamples.csv\" ); +/// @endtsexample +/// @ingroup Rendering) +/// /// public void fn_beginSampling (string location, string backend) @@ -1203,7 +1562,26 @@ public void fn_beginSampling (string location, string backend) SafeNativeMethods.mwle_fn_beginSampling(sblocation, sbbackend); } /// -/// @brief Calculates how much an explosion effects a specific object. Use this to determine how much damage to apply to objects based on their distance from the explosion's center point, and whether the explosion is blocked by other objects. @param pos Center position of the explosion. @param id Id of the object of which to check coverage. @param covMask Mask of object types that may block the explosion. @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) @tsexample // Get the position of the explosion. %position = %explosion.getPosition(); // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType // Acquire the damage value from 0.0f - 1.0f. %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); // Apply damage to object %sceneObject.applyDamage( %coverage * 20 ); @endtsexample @ingroup FX) +/// @brief Calculates how much an explosion effects a specific object. +/// Use this to determine how much damage to apply to objects based on their +/// distance from the explosion's center point, and whether the explosion is +/// blocked by other objects. +/// @param pos Center position of the explosion. +/// @param id Id of the object of which to check coverage. +/// @param covMask Mask of object types that may block the explosion. +/// @return Coverage value from 0 (not affected by the explosion) to 1 (fully affected) +/// @tsexample +/// // Get the position of the explosion. +/// %position = %explosion.getPosition(); +/// // Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character. +/// %TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType +/// // Acquire the damage value from 0.0f - 1.0f. +/// %coverage = calcExplosionCoverage( %position, %sceneObject, %TypeMasks ); +/// // Apply damage to object +/// %sceneObject.applyDamage( %coverage * 20 ); +/// @endtsexample +/// @ingroup FX) +/// /// public float fn_calcExplosionCoverage (string pos, int id, uint covMask) @@ -1218,6 +1596,7 @@ public float fn_calcExplosionCoverage (string pos, int id, uint covMask) } /// /// cancel(eventId)) +/// /// public void fn_cancel (int eventId) @@ -1229,6 +1608,7 @@ public void fn_cancel (int eventId) } /// /// cancelAll(objectId): cancel pending events on the specified object. Events will be automatically cancelled if object is deleted.) +/// /// public void fn_cancelAll (string objectId) @@ -1243,6 +1623,7 @@ public void fn_cancelAll (string objectId) } /// /// cancelServerQuery(...); ) +/// /// public void fn_cancelServerQuery () @@ -1254,7 +1635,9 @@ public void fn_cancelServerQuery () SafeNativeMethods.mwle_fn_cancelServerQuery(); } /// -/// Release the unused pooled textures in texture manager freeing up video memory. @ingroup GFX ) +/// Release the unused pooled textures in texture manager freeing up video memory. +/// @ingroup GFX ) +/// /// public void fn_cleanupTexturePool () @@ -1267,6 +1650,7 @@ public void fn_cleanupTexturePool () } /// /// ) +/// /// public void fn_clearClientPaths () @@ -1278,7 +1662,11 @@ public void fn_clearClientPaths () SafeNativeMethods.mwle_fn_clearClientPaths(); } /// -/// Clears the flagged state on all allocated GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// Clears the flagged state on all allocated GFX resources. +/// See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, listGFXResources, describeGFXResources ) +/// /// public void fn_clearGFXResourceFlags () @@ -1291,6 +1679,7 @@ public void fn_clearGFXResourceFlags () } /// /// ) +/// /// public void fn_clearServerPaths () @@ -1302,7 +1691,25 @@ public void fn_clearServerPaths () SafeNativeMethods.mwle_fn_clearServerPaths(); } /// -/// () @brief Closes the current network port @ingroup Networking) +/// () +/// Returns all pop'd out windows to the main canvas. +/// ) +/// +/// + +public void fn_CloseAllPopOuts () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_CloseAllPopOuts'"); + + +SafeNativeMethods.mwle_fn_CloseAllPopOuts(); +} +/// +/// () +/// @brief Closes the current network port +/// @ingroup Networking) +/// /// public void fn_closeNetPort () @@ -1314,7 +1721,42 @@ public void fn_closeNetPort () SafeNativeMethods.mwle_fn_closeNetPort(); } /// -/// Replace all escape sequences in @a text with their respective character codes. This function replaces all escape sequences (\\\, \\\\t, etc) in the given string with the respective characters they represent. The primary use of this function is for converting strings from their literal form into their compiled/translated form, as is normally done by the TorqueScript compiler. @param text A string. @return A duplicate of @a text with all escape sequences replaced by their respective character codes. @tsexample // Print: // // str // ing // // to the console. Note how the backslash in the string must be escaped here // in order to prevent the TorqueScript compiler from collapsing the escape // sequence in the resulting string. echo( collapseEscape( \"str\ing\" ) ); @endtsexample @see expandEscape @ingroup Strings ) +/// Close our startup splash window. +/// @note This is currently only implemented on Windows. +/// @ingroup Platform ) +/// +/// + +public void fn_closeSplashWindow () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_closeSplashWindow'"); + + +SafeNativeMethods.mwle_fn_closeSplashWindow(); +} +/// +/// Replace all escape sequences in @a text with their respective character codes. +/// This function replaces all escape sequences (\\\, \\\\t, etc) in the given string +/// with the respective characters they represent. +/// The primary use of this function is for converting strings from their literal form into +/// their compiled/translated form, as is normally done by the TorqueScript compiler. +/// @param text A string. +/// @return A duplicate of @a text with all escape sequences replaced by their respective character codes. +/// @tsexample +/// // Print: +/// // +/// // str +/// // ing +/// // +/// // to the console. Note how the backslash in the string must be escaped here +/// // in order to prevent the TorqueScript compiler from collapsing the escape +/// // sequence in the resulting string. +/// echo( collapseEscape( \"str\ing\" ) ); +/// @endtsexample +/// @see expandEscape +/// @ingroup Strings ) +/// /// public string fn_collapseEscape (string text) @@ -1331,7 +1773,20 @@ public string fn_collapseEscape (string text) } /// -/// Compile a file to bytecode. This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file in the current DSO path mirrorring the path of @a fileName. @param fileName Path to the file to compile to bytecode. @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not generate write compiled code to DSO files. @return True if the file was successfully compiled, false if not. @note The definitions contained in the given file will not be made available and no code will actually be executed. Use exec() for that. @see getDSOPath @see exec @ingroup Scripting ) +/// Compile a file to bytecode. +/// This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, +/// if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file +/// in the current DSO path mirrorring the path of @a fileName. +/// @param fileName Path to the file to compile to bytecode. +/// @param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not +/// generate write compiled code to DSO files. +/// @return True if the file was successfully compiled, false if not. +/// @note The definitions contained in the given file will not be made available and no code will actually +/// be executed. Use exec() for that. +/// @see getDSOPath +/// @see exec +/// @ingroup Scripting ) +/// /// public bool fn_compile (string fileName, bool overrideNoDSO) @@ -1346,6 +1801,7 @@ public bool fn_compile (string fileName, bool overrideNoDSO) } /// /// addAction( UndoAction ) ) +/// /// public void fn_CompoundUndoAction_addAction (string compoundundoaction, string objName) @@ -1363,6 +1819,7 @@ public void fn_CompoundUndoAction_addAction (string compoundundoaction, string o } /// /// Exports console definition XML representation ) +/// /// public string fn_consoleExportXML () @@ -1377,7 +1834,22 @@ public string fn_consoleExportXML () } /// -/// () Attaches the logger to the console and begins writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Attaches the logger to the console and begins writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool fn_ConsoleLogger_attach (string consolelogger) @@ -1391,7 +1863,22 @@ public bool fn_ConsoleLogger_attach (string consolelogger) return SafeNativeMethods.mwle_fn_ConsoleLogger_attach(sbconsolelogger)>=1; } /// -/// () Detaches the logger from the console and stops writing to file @tsexample // Create the logger // Will automatically start writing to testLogging.txt with normal priority new ConsoleLogger(logger, \"testLogging.txt\", false); // Send something to the console, with the logger consumes and writes to file echo(\"This is logged to the file\"); // Stop logging, but do not delete the logger logger.detach(); echo(\"This is not logged to the file\"); // Attach the logger to the console again logger.attach(); // Logging has resumed echo(\"Logging has resumed\"); @endtsexample) +/// () Detaches the logger from the console and stops writing to file +/// @tsexample +/// // Create the logger +/// // Will automatically start writing to testLogging.txt with normal priority +/// new ConsoleLogger(logger, \"testLogging.txt\", false); +/// // Send something to the console, with the logger consumes and writes to file +/// echo(\"This is logged to the file\"); +/// // Stop logging, but do not delete the logger +/// logger.detach(); +/// echo(\"This is not logged to the file\"); +/// // Attach the logger to the console again +/// logger.attach(); +/// // Logging has resumed +/// echo(\"Logging has resumed\"); +/// @endtsexample) +/// /// public bool fn_ConsoleLogger_detach (string consolelogger) @@ -1405,7 +1892,21 @@ public bool fn_ConsoleLogger_detach (string consolelogger) return SafeNativeMethods.mwle_fn_ConsoleLogger_detach(sbconsolelogger)>=1; } /// -/// @brief See if any objects of the given types are present in box of given extent. @note Extent parameter is last since only one radius is often needed. If one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, if you need to use the client container, you'll need to set all of the radius parameters. Fortunately, this function is mostly used on the server. @param mask Indicates the type of objects we are checking against. @param center Center of box. @param xRadius Search radius in the x-axis. See note above. @param yRadius Search radius in the y-axis. See note above. @param zRadius Search radius in the z-axis. See note above. @param useClientContainer Optionally indicates the search should be within the client container. @return true if the box is empty, false if any object is found. @ingroup Game) +/// @brief See if any objects of the given types are present in box of given extent. +/// @note Extent parameter is last since only one radius is often needed. If +/// one radius is provided, the yRadius and zRadius are assumed to be the same. Unfortunately, +/// if you need to use the client container, you'll need to set all of the radius parameters. +/// Fortunately, this function is mostly used on the server. +/// @param mask Indicates the type of objects we are checking against. +/// @param center Center of box. +/// @param xRadius Search radius in the x-axis. See note above. +/// @param yRadius Search radius in the y-axis. See note above. +/// @param zRadius Search radius in the z-axis. See note above. +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return true if the box is empty, false if any object is found. +/// @ingroup Game) +/// /// public bool fn_containerBoxEmpty (uint mask, string center, float xRadius, float yRadius, float zRadius, bool useClientContainer) @@ -1419,7 +1920,13 @@ public bool fn_containerBoxEmpty (uint mask, string center, float xRadius, float return SafeNativeMethods.mwle_fn_containerBoxEmpty(mask, sbcenter, xRadius, yRadius, zRadius, useClientContainer)>=1; } /// -/// (int mask, Point3F point, float x, float y, float z) @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more results using containerFindNext(). @see containerFindNext @ingroup Game) +/// (int mask, Point3F point, float x, float y, float z) +/// @brief Find objects matching the bitmask type within a box centered at point, with extents x, y, z. +/// @returns The first object found, or an empty string if nothing was found. Thereafter, you can get more +/// results using containerFindNext(). +/// @see containerFindNext +/// @ingroup Game) +/// /// public string fn_containerFindFirst (uint typeMask, string origin, string size) @@ -1439,7 +1946,13 @@ public string fn_containerFindFirst (uint typeMask, string origin, string size) } /// -/// () @brief Get more results from a previous call to containerFindFirst(). @note You must call containerFindFirst() to begin the search. @returns The next object found, or an empty string if nothing else was found. @see containerFindFirst() @ingroup Game) +/// () +/// @brief Get more results from a previous call to containerFindFirst(). +/// @note You must call containerFindFirst() to begin the search. +/// @returns The next object found, or an empty string if nothing else was found. +/// @see containerFindFirst() +/// @ingroup Game) +/// /// public string fn_containerFindNext () @@ -1454,7 +1967,26 @@ public string fn_containerFindNext () } /// -/// @brief Cast a ray from start to end, checking for collision against items matching mask. If pExempt is specified, then it is temporarily excluded from collision checks (For instance, you might want to exclude the player if said player was firing a weapon.) @param start An XYZ vector containing the tail position of the ray. @param end An XYZ vector containing the head position of the ray @param mask A bitmask corresponding to the type of objects to check for @param pExempt An optional ID for a single object that ignored for this raycast @param useClientContainer Optionally indicates the search should be within the client container. @returns A string containing either null, if nothing was struck, or these fields: ul>li>The ID of the object that was struck./li> li>The x, y, z position that it was struck./li> li>The x, y, z of the normal of the face that was struck./li> li>The distance between the start point and the position we hit./li>/ul> @ingroup Game) +/// @brief Cast a ray from start to end, checking for collision against items matching mask. +/// +/// If pExempt is specified, then it is temporarily excluded from collision checks (For +/// instance, you might want to exclude the player if said player was firing a weapon.) +/// +/// @param start An XYZ vector containing the tail position of the ray. +/// @param end An XYZ vector containing the head position of the ray +/// @param mask A bitmask corresponding to the type of objects to check for +/// @param pExempt An optional ID for a single object that ignored for this raycast +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @returns A string containing either null, if nothing was struck, or these fields: +/// ul>li>The ID of the object that was struck./li> +/// li>The x, y, z position that it was struck./li> +/// li>The x, y, z of the normal of the face that was struck./li> +/// li>The distance between the start point and the position we hit./li>/ul> +/// +/// @ingroup Game) +/// /// public string fn_containerRayCast (string start, string end, uint mask, string pExempt, bool useClientContainer) @@ -1477,7 +2009,17 @@ public string fn_containerRayCast (string start, string end, uint mask, string p } /// -/// @brief Get distance of the center of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the center of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get distance of the center of the current item from the center of the +/// current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the center of the current object to the center of +/// the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float fn_containerSearchCurrDist (bool useClientContainer) @@ -1488,7 +2030,17 @@ public float fn_containerSearchCurrDist (bool useClientContainer) return SafeNativeMethods.mwle_fn_containerSearchCurrDist(useClientContainer); } /// -/// @brief Get the distance of the closest point of the current item from the center of the current initContainerRadiusSearch. @param useClientContainer Optionally indicates the search should be within the client container. @return distance from the closest point of the current object to the center of the search @see containerSearchNext @ingroup Game) +/// @brief Get the distance of the closest point of the current item from the center +/// of the current initContainerRadiusSearch. +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return distance from the closest point of the current object to the +/// center of the search +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public float fn_containerSearchCurrRadiusDist (bool useClientContainer) @@ -1499,7 +2051,29 @@ public float fn_containerSearchCurrRadiusDist (bool useClientContainer) return SafeNativeMethods.mwle_fn_containerSearchCurrRadiusDist(useClientContainer); } /// -/// @brief Get next item from a search started with initContainerRadiusSearch() or initContainerTypeSearch(). @param useClientContainer Optionally indicates the search should be within the client container. @return the next object found in the search, or null if no more @tsexample // print the names of all nearby ShapeBase derived objects %position = %obj.getPosition; %radius = 20; %mask = $TypeMasks::ShapeBaseObjectType; initContainerRadiusSearch( %position, %radius, %mask ); while ( (%targetObject = containerSearchNext()) != 0 ) { echo( \"Found: \" @ %targetObject.getName() ); } @endtsexample @see initContainerRadiusSearch() @see initContainerTypeSearch() @ingroup Game) +/// @brief Get next item from a search started with initContainerRadiusSearch() or +/// initContainerTypeSearch(). +/// +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// @return the next object found in the search, or null if no more +/// +/// @tsexample +/// // print the names of all nearby ShapeBase derived objects +/// %position = %obj.getPosition; +/// %radius = 20; +/// %mask = $TypeMasks::ShapeBaseObjectType; +/// initContainerRadiusSearch( %position, %radius, %mask ); +/// while ( (%targetObject = containerSearchNext()) != 0 ) +/// { +/// echo( \"Found: \" @ %targetObject.getName() ); +/// } +/// @endtsexample +/// +/// @see initContainerRadiusSearch() +/// @see initContainerTypeSearch() +/// @ingroup Game) +/// /// public string fn_containerSearchNext (bool useClientContainer) @@ -1513,7 +2087,40 @@ public string fn_containerSearchNext (bool useClientContainer) } /// -/// @brief Checks to see if text is a bad word The text is considered to be a bad word if it has been added to the bad word filter. @param text Text to scan for bad words @return True if the text has bad word(s), false if it is clean @see addBadWord() @see filterString() @tsexample // In this game, \"Foobar\" is banned %badWord = \"Foobar\"; // Add a banned word to the bad word filter addBadWord(%badWord); // Create the base string, can come from anywhere like user chat %userText = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // If the text contains a bad word, filter it before printing // Otherwise print the original text if(containsBadWords(%userText)) { // Filter the string %filteredText = filterString(%userText, %replacementChars); // Print filtered text echo(%filteredText); } else echo(%userText); @endtsexample @ingroup Game) +/// @brief Checks to see if text is a bad word +/// +/// The text is considered to be a bad word if it has been added to the bad word filter. +/// +/// @param text Text to scan for bad words +/// @return True if the text has bad word(s), false if it is clean +/// +/// @see addBadWord() +/// @see filterString() +/// +/// @tsexample +/// // In this game, \"Foobar\" is banned +/// %badWord = \"Foobar\"; +/// // Add a banned word to the bad word filter +/// addBadWord(%badWord); +/// // Create the base string, can come from anywhere like user chat +/// %userText = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // If the text contains a bad word, filter it before printing +/// // Otherwise print the original text +/// if(containsBadWords(%userText)) +/// { +/// // Filter the string +/// %filteredText = filterString(%userText, %replacementChars); +/// // Print filtered text +/// echo(%filteredText); +/// } +/// else +/// echo(%userText); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public bool fn_containsBadWords (string text) @@ -1527,7 +2134,11 @@ public bool fn_containsBadWords (string text) return SafeNativeMethods.mwle_fn_containsBadWords(sbtext)>=1; } /// -/// Count the number of bits that are set in the given 32 bit integer. @param v An integer value. @return The number of bits that are set in @a v. @ingroup Utilities ) +/// Count the number of bits that are set in the given 32 bit integer. +/// @param v An integer value. +/// @return The number of bits that are set in @a v. +/// @ingroup Utilities ) +/// /// public int fn_countBits (int v) @@ -1538,7 +2149,14 @@ public int fn_countBits (int v) return SafeNativeMethods.mwle_fn_countBits(v); } /// -/// @brief Create the given directory or the path leading to the given filename. If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components of the path will be created. @param path The path to create. @note Only present in a Tools build of Torque. @ingroup FileSystem ) +/// @brief Create the given directory or the path leading to the given filename. +/// If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place). If @a path, +/// does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components +/// of the path will be created. +/// @param path The path to create. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem ) +/// /// public bool fn_createPath (string path) @@ -1553,6 +2171,7 @@ public bool fn_createPath (string path) } /// /// (string group, string name, string value)) +/// /// public int fn_CreatorTree_addGroup (string creatortree, int group, string name, string value) @@ -1573,6 +2192,7 @@ public int fn_CreatorTree_addGroup (string creatortree, int group, string name, } /// /// (Node group, string name, string value)) +/// /// public int fn_CreatorTree_addItem (string creatortree, int group, string name, string value) @@ -1593,6 +2213,7 @@ public int fn_CreatorTree_addItem (string creatortree, int group, string name, s } /// /// Clear the tree.) +/// /// public void fn_CreatorTree_clear (string creatortree) @@ -1607,6 +2228,7 @@ public void fn_CreatorTree_clear (string creatortree) } /// /// (string world, string type, string filename)) +/// /// public bool fn_CreatorTree_fileNameMatch (string creatortree, string world, string type, string filename) @@ -1630,6 +2252,7 @@ public bool fn_CreatorTree_fileNameMatch (string creatortree, string world, stri } /// /// (Node item)) +/// /// public string fn_CreatorTree_getName (string creatortree, string item) @@ -1650,6 +2273,7 @@ public string fn_CreatorTree_getName (string creatortree, string item) } /// /// (Node n)) +/// /// public int fn_CreatorTree_getParent (string creatortree, int nodeValue) @@ -1664,6 +2288,7 @@ public int fn_CreatorTree_getParent (string creatortree, int nodeValue) } /// /// Return a handle to the currently selected item.) +/// /// public int fn_CreatorTree_getSelected (string creatortree) @@ -1678,6 +2303,7 @@ public int fn_CreatorTree_getSelected (string creatortree) } /// /// (Node n)) +/// /// public string fn_CreatorTree_getValue (string creatortree, int nodeValue) @@ -1695,6 +2321,7 @@ public string fn_CreatorTree_getValue (string creatortree, int nodeValue) } /// /// (Group g)) +/// /// public bool fn_CreatorTree_isGroup (string creatortree, string group) @@ -1711,7 +2338,10 @@ public bool fn_CreatorTree_isGroup (string creatortree, string group) return SafeNativeMethods.mwle_fn_CreatorTree_isGroup(sbcreatortree, sbgroup)>=1; } /// -/// () Forcibly disconnects any attached script debugging client. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Forcibly disconnects any attached script debugging client. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void fn_dbgDisconnect () @@ -1723,7 +2353,9 @@ public void fn_dbgDisconnect () SafeNativeMethods.mwle_fn_dbgDisconnect(); } /// -/// () Clear all break points in the current file.) +/// () +/// Clear all break points in the current file.) +/// /// public void fn_DbgFileView_clearBreakPositions (string dbgfileview) @@ -1737,7 +2369,10 @@ public void fn_DbgFileView_clearBreakPositions (string dbgfileview) SafeNativeMethods.mwle_fn_DbgFileView_clearBreakPositions(sbdbgfileview); } /// -/// (string findThis) Find the specified string in the currently viewed file and scroll it into view.) +/// (string findThis) +/// Find the specified string in the currently viewed file and +/// scroll it into view.) +/// /// public bool fn_DbgFileView_findString (string dbgfileview, string findThis) @@ -1754,7 +2389,11 @@ public bool fn_DbgFileView_findString (string dbgfileview, string findThis) return SafeNativeMethods.mwle_fn_DbgFileView_findString(sbdbgfileview, sbfindThis)>=1; } /// -/// () Get the currently executing file and line, if any. @returns A string containing the file, a tab, and then the line number. Use getField() with this.) +/// () +/// Get the currently executing file and line, if any. +/// @returns A string containing the file, a tab, and then the line number. +/// Use getField() with this.) +/// /// public string fn_DbgFileView_getCurrentLine (string dbgfileview) @@ -1771,7 +2410,10 @@ public string fn_DbgFileView_getCurrentLine (string dbgfileview) } /// -/// (string filename) Open a file for viewing. @note This loads the file from the local system.) +/// (string filename) +/// Open a file for viewing. +/// @note This loads the file from the local system.) +/// /// public bool fn_DbgFileView_open (string dbgfileview, string filename) @@ -1788,7 +2430,9 @@ public bool fn_DbgFileView_open (string dbgfileview, string filename) return SafeNativeMethods.mwle_fn_DbgFileView_open(sbdbgfileview, sbfilename)>=1; } /// -/// (int line) Remove a breakpoint from the specified line.) +/// (int line) +/// Remove a breakpoint from the specified line.) +/// /// public void fn_DbgFileView_removeBreak (string dbgfileview, uint line) @@ -1802,7 +2446,9 @@ public void fn_DbgFileView_removeBreak (string dbgfileview, uint line) SafeNativeMethods.mwle_fn_DbgFileView_removeBreak(sbdbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void fn_DbgFileView_setBreak (string dbgfileview, uint line) @@ -1816,7 +2462,9 @@ public void fn_DbgFileView_setBreak (string dbgfileview, uint line) SafeNativeMethods.mwle_fn_DbgFileView_setBreak(sbdbgfileview, line); } /// -/// (int line) Set a breakpoint at the specified line.) +/// (int line) +/// Set a breakpoint at the specified line.) +/// /// public void fn_DbgFileView_setBreakPosition (string dbgfileview, uint line) @@ -1830,7 +2478,9 @@ public void fn_DbgFileView_setBreakPosition (string dbgfileview, uint line) SafeNativeMethods.mwle_fn_DbgFileView_setBreakPosition(sbdbgfileview, line); } /// -/// (int line, bool selected) Set the current highlighted line.) +/// (int line, bool selected) +/// Set the current highlighted line.) +/// /// public void fn_DbgFileView_setCurrentLine (string dbgfileview, int line, bool selected) @@ -1844,7 +2494,10 @@ public void fn_DbgFileView_setCurrentLine (string dbgfileview, int line, bool se SafeNativeMethods.mwle_fn_DbgFileView_setCurrentLine(sbdbgfileview, line, selected); } /// -/// () Returns true if a script debugging client is connected else return false. @internal Primarily used for Torsion and other debugging tools) +/// () +/// Returns true if a script debugging client is connected else return false. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public bool fn_dbgIsConnected () @@ -1856,7 +2509,11 @@ public bool fn_dbgIsConnected () return SafeNativeMethods.mwle_fn_dbgIsConnected()>=1; } /// -/// ( int port, string password, bool waitForClient ) Open a debug server port on the specified port, requiring the specified password, and optionally waiting for the debug client to connect. @internal Primarily used for Torsion and other debugging tools) +/// ( int port, string password, bool waitForClient ) +/// Open a debug server port on the specified port, requiring the specified password, +/// and optionally waiting for the debug client to connect. +/// @internal Primarily used for Torsion and other debugging tools) +/// /// public void fn_dbgSetParameters (int port, string password, bool waitForClient) @@ -1870,7 +2527,11 @@ public void fn_dbgSetParameters (int port, string password, bool waitForClient) SafeNativeMethods.mwle_fn_dbgSetParameters(port, sbpassword, waitForClient); } /// -/// () @brief Disables DirectInput. Also deactivates any connected joysticks. @ingroup Input ) +/// () +/// @brief Disables DirectInput. +/// Also deactivates any connected joysticks. +/// @ingroup Input ) +/// /// public void fn_deactivateDirectInput () @@ -1901,7 +2562,12 @@ public void fn_deactivatePackage (string packageName) SafeNativeMethods.mwle_fn_deactivatePackage(sbpackageName); } /// -/// Drops the engine into the native C++ debugger. This function triggers a debug break and drops the process into the IDE's debugger. If the process is not running with a debugger attached it will generate a runtime error on most platforms. @note This function is not available in shipping builds. @ingroup Debugging ) +/// Drops the engine into the native C++ debugger. +/// This function triggers a debug break and drops the process into the IDE's debugger. If the process is not +/// running with a debugger attached it will generate a runtime error on most platforms. +/// @note This function is not available in shipping builds. +/// @ingroup Debugging ) +/// /// public void fn_debug () @@ -1913,7 +2579,10 @@ public void fn_debug () SafeNativeMethods.mwle_fn_debug(); } /// -/// @brief Dumps all current EngineObject instances to the console. @note This function is only available in debug builds. @ingroup Debugging ) +/// @brief Dumps all current EngineObject instances to the console. +/// @note This function is only available in debug builds. +/// @ingroup Debugging ) +/// /// public void fn_debugDumpAllObjects () @@ -1947,7 +2616,15 @@ public void fn_debugEnumInstances (string className, string functionName) SafeNativeMethods.mwle_fn_debugEnumInstances(sbclassName, sbfunctionName); } /// -/// @brief Logs the value of the given variable to the console. Prints a string of the form \"variableName> = variable value>\" to the console. @param variableName Name of the local or global variable to print. @tsexample %var = 1; debugv( \"%var\" ); // Prints \"%var = 1\" @endtsexample @ingroup Debugging ) +/// @brief Logs the value of the given variable to the console. +/// Prints a string of the form \"variableName> = variable value>\" to the console. +/// @param variableName Name of the local or global variable to print. +/// @tsexample +/// %var = 1; +/// debugv( \"%var\" ); // Prints \"%var = 1\" +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void fn_debugv (string variableName) @@ -1961,7 +2638,26 @@ public void fn_debugv (string variableName) SafeNativeMethods.mwle_fn_debugv(sbvariableName); } /// -/// Adds a new decal to the decal manager. @param position World position for the decal. @param normal Decal normal vector (if the decal was a tire lying flat on a surface, this is the vector pointing in the direction of the axle). @param rot Angle (in radians) to rotate this decal around its normal vector. @param scale Scale factor applied to the decal. @param decalData DecalData datablock to use for the new decal. @param isImmortal Whether or not this decal is immortal. If immortal, it does not expire automatically and must be removed explicitly. @return Returns the ID of the new Decal object or -1 on failure. @tsexample // Specify the decal position %position = \"1.0 1.0 1.0\"; // Specify the up vector %normal = \"0.0 0.0 1.0\"; // Add the new decal. %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); @endtsexample @ingroup Decals ) +/// Adds a new decal to the decal manager. +/// @param position World position for the decal. +/// @param normal Decal normal vector (if the decal was a tire lying flat on a +/// surface, this is the vector pointing in the direction of the axle). +/// @param rot Angle (in radians) to rotate this decal around its normal vector. +/// @param scale Scale factor applied to the decal. +/// @param decalData DecalData datablock to use for the new decal. +/// @param isImmortal Whether or not this decal is immortal. If immortal, it +/// does not expire automatically and must be removed explicitly. +/// @return Returns the ID of the new Decal object or -1 on failure. +/// @tsexample +/// // Specify the decal position +/// %position = \"1.0 1.0 1.0\"; +/// // Specify the up vector +/// %normal = \"0.0 0.0 1.0\"; +/// // Add the new decal. +/// %decalObj = decalManagerAddDecal( %position, %normal, 0.5, 0.35, ScorchBigDecal, false ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public int fn_decalManagerAddDecal (string position, string normal, float rot, float scale, string decalData, bool isImmortal) @@ -1981,7 +2677,13 @@ public int fn_decalManagerAddDecal (string position, string normal, float rot, f return SafeNativeMethods.mwle_fn_decalManagerAddDecal(sbposition, sbnormal, rot, scale, sbdecalData, isImmortal); } /// -/// Removes all decals currently loaded in the decal manager. @tsexample // Tell the decal manager to remove all existing decals. decalManagerClear(); @endtsexample @ingroup Decals ) +/// Removes all decals currently loaded in the decal manager. +/// @tsexample +/// // Tell the decal manager to remove all existing decals. +/// decalManagerClear(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void fn_decalManagerClear () @@ -1993,7 +2695,15 @@ public void fn_decalManagerClear () SafeNativeMethods.mwle_fn_decalManagerClear(); } /// -/// Returns whether the decal manager has unsaved modifications. @return True if the decal manager has unsaved modifications, false if everything has been saved. @tsexample // Ask the decal manager if it has unsaved modifications. %hasUnsavedModifications = decalManagerDirty(); @endtsexample @ingroup Decals ) +/// Returns whether the decal manager has unsaved modifications. +/// @return True if the decal manager has unsaved modifications, false if +/// everything has been saved. +/// @tsexample +/// // Ask the decal manager if it has unsaved modifications. +/// %hasUnsavedModifications = decalManagerDirty(); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool fn_decalManagerDirty () @@ -2005,7 +2715,18 @@ public bool fn_decalManagerDirty () return SafeNativeMethods.mwle_fn_decalManagerDirty()>=1; } /// -/// Clears existing decals and replaces them with decals loaded from the specified file. @param fileName Filename to load the decals from. @return True if the decal manager was able to load the requested file, false if it could not. @tsexample // Set the filename to load the decals from. %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to load the decals from the entered filename. decalManagerLoad( %fileName ); @endtsexample @ingroup Decals ) +/// Clears existing decals and replaces them with decals loaded from the specified file. +/// @param fileName Filename to load the decals from. +/// @return True if the decal manager was able to load the requested file, +/// false if it could not. +/// @tsexample +/// // Set the filename to load the decals from. +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to load the decals from the entered filename. +/// decalManagerLoad( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool fn_decalManagerLoad (string fileName) @@ -2019,7 +2740,17 @@ public bool fn_decalManagerLoad (string fileName) return SafeNativeMethods.mwle_fn_decalManagerLoad(sbfileName)>=1; } /// -/// Remove specified decal from the scene. @param decalID ID of the decal to remove. @return Returns true if successful, false if decal ID not found. @tsexample // Specify a decal ID to be removed %decalID = 1; // Tell the decal manager to remove the specified decal ID. decalManagerRemoveDecal( %decalId ) @endtsexample @ingroup Decals ) +/// Remove specified decal from the scene. +/// @param decalID ID of the decal to remove. +/// @return Returns true if successful, false if decal ID not found. +/// @tsexample +/// // Specify a decal ID to be removed +/// %decalID = 1; +/// // Tell the decal manager to remove the specified decal ID. +/// decalManagerRemoveDecal( %decalId ) +/// @endtsexample +/// @ingroup Decals ) +/// /// public bool fn_decalManagerRemoveDecal (int decalID) @@ -2030,7 +2761,18 @@ public bool fn_decalManagerRemoveDecal (int decalID) return SafeNativeMethods.mwle_fn_decalManagerRemoveDecal(decalID)>=1; } /// -/// ), Saves the decals for the active mission in the entered filename. @param decalSaveFile Filename to save the decals to. @tsexample // Set the filename to save the decals in. If no filename is set, then the // decals will default to activeMissionName>.mis.decals %fileName = \"./missionDecals.mis.decals\"; // Inform the decal manager to save the decals for the active mission. decalManagerSave( %fileName ); @endtsexample @ingroup Decals ) +/// ), +/// Saves the decals for the active mission in the entered filename. +/// @param decalSaveFile Filename to save the decals to. +/// @tsexample +/// // Set the filename to save the decals in. If no filename is set, then the +/// // decals will default to activeMissionName>.mis.decals +/// %fileName = \"./missionDecals.mis.decals\"; +/// // Inform the decal manager to save the decals for the active mission. +/// decalManagerSave( %fileName ); +/// @endtsexample +/// @ingroup Decals ) +/// /// public void fn_decalManagerSave (string decalSaveFile) @@ -2044,7 +2786,10 @@ public void fn_decalManagerSave (string decalSaveFile) SafeNativeMethods.mwle_fn_decalManagerSave(sbdecalSaveFile); } /// -/// Delete all the datablocks we've downloaded. This is usually done in preparation of downloading a new set of datablocks, such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// Delete all the datablocks we've downloaded. +/// This is usually done in preparation of downloading a new set of datablocks, +/// such as occurs on a mission change, but it's also good post-mission cleanup. ) +/// /// public void fn_deleteDataBlocks () @@ -2056,7 +2801,11 @@ public void fn_deleteDataBlocks () SafeNativeMethods.mwle_fn_deleteDataBlocks(); } /// -/// @brief Deletes the given @a file. @param file %Path of the file to delete. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Deletes the given @a file. +/// @param file %Path of the file to delete. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_deleteFile (string file) @@ -2070,7 +2819,17 @@ public bool fn_deleteFile (string file) return SafeNativeMethods.mwle_fn_deleteFile(sbfile)>=1; } /// -/// Undefine all global variables matching the given name @a pattern. @param pattern A global variable name pattern. Must begin with '$'. @tsexample // Define a global variable in the \"My\" namespace. $My::Variable = \"value\"; // Undefine all variable in the \"My\" namespace. deleteVariables( \"$My::*\" ); @endtsexample @see strIsMatchExpr @ingroup Scripting ) +/// Undefine all global variables matching the given name @a pattern. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @tsexample +/// // Define a global variable in the \"My\" namespace. +/// $My::Variable = \"value\"; +/// // Undefine all variable in the \"My\" namespace. +/// deleteVariables( \"$My::*\" ); +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Scripting ) +/// /// public void fn_deleteVariables (string pattern) @@ -2084,7 +2843,22 @@ public void fn_deleteVariables (string pattern) SafeNativeMethods.mwle_fn_deleteVariables(sbpattern); } /// -/// @brief Dumps a description of GFX resources to a file or the console. @param resourceTypes A space seperated list of resource types or an empty string for all resources. @param filePath A file to dump the list to or an empty string to write to the console. @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. @note The resource types can be one or more of the following: - texture - texture target - window target - vertex buffers - primitive buffers - fences - cubemaps - shaders - stateblocks @ingroup GFX ) +/// @brief Dumps a description of GFX resources to a file or the console. +/// @param resourceTypes A space seperated list of resource types or an empty string for all resources. +/// @param filePath A file to dump the list to or an empty string to write to the console. +/// @param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources. +/// @note The resource types can be one or more of the following: +/// - texture +/// - texture target +/// - window target +/// - vertex buffers +/// - primitive buffers +/// - fences +/// - cubemaps +/// - shaders +/// - stateblocks +/// @ingroup GFX ) +/// /// public void fn_describeGFXResources (string resourceTypes, string filePath, bool unflaggedOnly) @@ -2101,7 +2875,10 @@ public void fn_describeGFXResources (string resourceTypes, string filePath, bool SafeNativeMethods.mwle_fn_describeGFXResources(sbresourceTypes, sbfilePath, unflaggedOnly); } /// -/// Dumps a description of all state blocks. @param filePath A file to dump the state blocks to or an empty string to write to the console. @ingroup GFX ) +/// Dumps a description of all state blocks. +/// @param filePath A file to dump the state blocks to or an empty string to write to the console. +/// @ingroup GFX ) +/// /// public void fn_describeGFXStateBlocks (string filePath) @@ -2115,7 +2892,26 @@ public void fn_describeGFXStateBlocks (string filePath) SafeNativeMethods.mwle_fn_describeGFXStateBlocks(sbfilePath); } /// -/// @brief Returns the string from a tag string. Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. Use getTaggedString() to convert a tagged string ID back into a regular string at any time. @tsexample // From scripts/client/message.cs function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) { onChatMessage(detag(%msgString), %voice, %pitch); } @endtsexample @see \\ref syntaxDataTypes under Tagged %Strings @see getTag() @see getTaggedString() @ingroup Networking) +/// @brief Returns the string from a tag string. +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. Use getTaggedString() +/// to convert a tagged string ID back into a regular string at any time. +/// +/// @tsexample +/// // From scripts/client/message.cs +/// function clientCmdChatMessage(%sender, %voice, %pitch, %msgString, %a1, %a2, %a3, %a4, %a5, %a6, %a7, %a8, %a9, %a10) +/// { +/// onChatMessage(detag(%msgString), %voice, %pitch); +/// } +/// @endtsexample +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see getTag() +/// @see getTaggedString() +/// +/// @ingroup Networking) +/// /// public string fn_detag (string str) @@ -2132,7 +2928,11 @@ public string fn_detag (string str) } /// -/// () @brief Disables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Disables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public void fn_disableJoystick () @@ -2144,7 +2944,10 @@ public void fn_disableJoystick () SafeNativeMethods.mwle_fn_disableJoystick(); } /// -/// () @brief Disables XInput for Xbox 360 controllers. @ingroup Input) +/// () +/// @brief Disables XInput for Xbox 360 controllers. +/// @ingroup Input) +/// /// public void fn_disableXInput () @@ -2156,7 +2959,15 @@ public void fn_disableXInput () SafeNativeMethods.mwle_fn_disableXInput(); } /// -/// ), (string queueName, string message, string data) @brief Dispatch a message to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @param data Data for message @return True for success, false for failure @see dispatchMessageObject @ingroup Messaging) +/// ), (string queueName, string message, string data) +/// @brief Dispatch a message to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @param data Data for message +/// @return True for success, false for failure +/// @see dispatchMessageObject +/// @ingroup Messaging) +/// /// public bool fn_dispatchMessage (string queueName, string message, string data) @@ -2176,7 +2987,14 @@ public bool fn_dispatchMessage (string queueName, string message, string data) return SafeNativeMethods.mwle_fn_dispatchMessage(sbqueueName, sbmessage, sbdata)>=1; } /// -/// , ), (string queueName, string message) @brief Dispatch a message object to a queue @param queueName Queue to dispatch the message to @param message Message to dispatch @return true for success, false for failure @see dispatchMessage @ingroup Messaging) +/// , ), (string queueName, string message) +/// @brief Dispatch a message object to a queue +/// @param queueName Queue to dispatch the message to +/// @param message Message to dispatch +/// @return true for success, false for failure +/// @see dispatchMessage +/// @ingroup Messaging) +/// /// public bool fn_dispatchMessageObject (string queueName, string message) @@ -2193,7 +3011,12 @@ public bool fn_dispatchMessageObject (string queueName, string message) return SafeNativeMethods.mwle_fn_dispatchMessageObject(sbqueueName, sbmessage)>=1; } /// -/// art/gui/splash.bmp), Display a startup splash window suitable for showing while the engine still starts up. @note This is currently only implemented on Windows. @return True if the splash window could be successfully initialized. @ingroup Platform ) +/// art/gui/splash.bmp), +/// Display a startup splash window suitable for showing while the engine still starts up. +/// @note This is currently only implemented on Windows. +/// @return True if the splash window could be successfully initialized. +/// @ingroup Platform ) +/// /// public bool fn_displaySplashWindow (string path) @@ -2207,7 +3030,12 @@ public bool fn_displaySplashWindow (string path) return SafeNativeMethods.mwle_fn_displaySplashWindow(sbpath)>=1; } /// -/// (bool enabled) @brief Enables logging of the connection protocols When enabled a lot of network debugging information is sent to the console. @param enabled True to enable, false to disable @ingroup Networking) +/// (bool enabled) +/// @brief Enables logging of the connection protocols +/// When enabled a lot of network debugging information is sent to the console. +/// @param enabled True to enable, false to disable +/// @ingroup Networking) +/// /// public void fn_DNetSetLogging (bool enabled) @@ -2484,7 +3312,11 @@ public string fn_dnt_testcase_9 (string chr) } /// -/// @brief Dumps all declared console classes to the console. @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console classes to the console. +/// @param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped. +/// @param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void fn_dumpConsoleClasses (bool dumpScript, bool dumpEngine) @@ -2495,7 +3327,11 @@ public void fn_dumpConsoleClasses (bool dumpScript, bool dumpEngine) SafeNativeMethods.mwle_fn_dumpConsoleClasses(dumpScript, dumpEngine); } /// -/// @brief Dumps all declared console functions to the console. @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. @ingroup Logging) +/// @brief Dumps all declared console functions to the console. +/// @param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped. +/// @param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped. +/// @ingroup Logging) +/// /// public void fn_dumpConsoleFunctions (bool dumpScript, bool dumpEngine) @@ -2506,7 +3342,11 @@ public void fn_dumpConsoleFunctions (bool dumpScript, bool dumpEngine) SafeNativeMethods.mwle_fn_dumpConsoleFunctions(dumpScript, dumpEngine); } /// -/// Dumps the engine scripting documentation to the specified file overwriting any existing content. @param outputFile The relative or absolute output file path and name. @return Returns true if successful. @ingroup Console) +/// Dumps the engine scripting documentation to the specified file overwriting any existing content. +/// @param outputFile The relative or absolute output file path and name. +/// @return Returns true if successful. +/// @ingroup Console) +/// /// public bool fn_dumpEngineDocs (string outputFile) @@ -2520,7 +3360,10 @@ public bool fn_dumpEngineDocs (string outputFile) return SafeNativeMethods.mwle_fn_dumpEngineDocs(sboutputFile)>=1; } /// -/// Dumps to the console a full description of all cached fonts, along with info on the codepoints each contains. @ingroup Font ) +/// Dumps to the console a full description of all cached fonts, along with +/// info on the codepoints each contains. +/// @ingroup Font ) +/// /// public void fn_dumpFontCacheStatus () @@ -2532,7 +3375,9 @@ public void fn_dumpFontCacheStatus () SafeNativeMethods.mwle_fn_dumpFontCacheStatus(); } /// -/// @brief Dumps a formatted list of currently allocated material instances to the console. @ingroup Materials) +/// @brief Dumps a formatted list of currently allocated material instances to the console. +/// @ingroup Materials) +/// /// public void fn_dumpMaterialInstances () @@ -2544,7 +3389,14 @@ public void fn_dumpMaterialInstances () SafeNativeMethods.mwle_fn_dumpMaterialInstances(); } /// -/// @brief Dumps network statistics for each class to the console. The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. The i>num/i> value is the total number of events collected. @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. @ingroup Networking ) +/// @brief Dumps network statistics for each class to the console. +/// +/// The returned i>avg/i>, i>min/i> and i>max/i> values are in bits sent per update. +/// The i>num/i> value is the total number of events collected. +/// +/// @note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h. +/// @ingroup Networking ) +/// /// public void fn_dumpNetStats () @@ -2556,7 +3408,13 @@ public void fn_dumpNetStats () SafeNativeMethods.mwle_fn_dumpNetStats(); } /// -/// @brief Dump the current contents of the networked string table to the console. The results are returned in three columns. The first column is the network string ID. The second column is the string itself. The third column is the reference count to the network string. @note This function is available only in debug builds. @ingroup Networking ) +/// @brief Dump the current contents of the networked string table to the console. +/// The results are returned in three columns. The first column is the network string ID. +/// The second column is the string itself. The third column is the reference count to the +/// network string. +/// @note This function is available only in debug builds. +/// @ingroup Networking ) +/// /// public void fn_dumpNetStringTable () @@ -2569,6 +3427,7 @@ public void fn_dumpNetStringTable () } /// /// Dumps all ProcessObjects in ServerProcessList and ClientProcessList to the console. ) +/// /// public void fn_dumpProcessList (bool allow) @@ -2579,7 +3438,10 @@ public void fn_dumpProcessList (bool allow) SafeNativeMethods.mwle_fn_dumpProcessList(allow); } /// -/// Creates a 64x64 normal map texture filled with noise. The texture is saved to randNormTex.png in the location of the game executable. @ingroup GFX) +/// Creates a 64x64 normal map texture filled with noise. The texture is saved +/// to randNormTex.png in the location of the game executable. +/// @ingroup GFX) +/// /// public void fn_dumpRandomNormalMap () @@ -2604,7 +3466,11 @@ public void fn_dumpSoCount () SafeNativeMethods.mwle_fn_dumpSoCount(); } /// -/// () @brief Dumps information about String memory usage @ingroup Debugging @ingroup Strings) +/// () +/// @brief Dumps information about String memory usage +/// @ingroup Debugging +/// @ingroup Strings) +/// /// public void fn_dumpStringMemStats () @@ -2616,19 +3482,10 @@ public void fn_dumpStringMemStats () SafeNativeMethods.mwle_fn_dumpStringMemStats(); } /// -/// ) -/// - -public void fn_dumpStringTableSize () -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_dumpStringTableSize'"); - - -SafeNativeMethods.mwle_fn_dumpStringTableSize(); -} -/// -/// Dumps a list of all active texture objects to the console. @note This function is only available in debug builds. @ingroup GFX ) +/// Dumps a list of all active texture objects to the console. +/// @note This function is only available in debug builds. +/// @ingroup GFX ) +/// /// public void fn_dumpTextureObjects () @@ -2640,7 +3497,15 @@ public void fn_dumpTextureObjects () SafeNativeMethods.mwle_fn_dumpTextureObjects(); } /// -/// Copy the specified old font to a new name. The new copy will not have a platform font backing it, and so will never have characters added to it. But this is useful for making copies of fonts to add postprocessing effects to via exportCachedFont. @param oldFontName The name of the font face to copy. @param oldFontSize The size of the font to copy. @param newFontName The name of the new font face. @ingroup Font ) +/// Copy the specified old font to a new name. The new copy will not have a +/// platform font backing it, and so will never have characters added to it. +/// But this is useful for making copies of fonts to add postprocessing effects +/// to via exportCachedFont. +/// @param oldFontName The name of the font face to copy. +/// @param oldFontSize The size of the font to copy. +/// @param newFontName The name of the new font face. +/// @ingroup Font ) +/// /// public void fn_duplicateCachedFont (string oldFontName, int oldFontSize, string newFontName) @@ -2657,7 +3522,10 @@ public void fn_duplicateCachedFont (string oldFontName, int oldFontSize, string SafeNativeMethods.mwle_fn_duplicateCachedFont(sboldFontName, oldFontSize, sbnewFontName); } /// -/// () @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. @ingroup Input) +/// () +/// @brief Prints information to the console stating if DirectInput and a Joystick are enabled and active. +/// @ingroup Input) +/// /// public void fn_echoInputState () @@ -2670,6 +3538,7 @@ public void fn_echoInputState () } /// /// Perform the onEditorDisabled callback on all SimObjects and set gEditingMission false ) +/// /// public void fn_EditManager_editorDisabled (string editmanager) @@ -2684,6 +3553,7 @@ public void fn_EditManager_editorDisabled (string editmanager) } /// /// Perform the onEditorEnabled callback on all SimObjects and set gEditingMission true ) +/// /// public void fn_EditManager_editorEnabled (string editmanager) @@ -2698,6 +3568,7 @@ public void fn_EditManager_editorEnabled (string editmanager) } /// /// (int slot)) +/// /// public void fn_EditManager_gotoBookmark (string editmanager, int val) @@ -2712,6 +3583,7 @@ public void fn_EditManager_gotoBookmark (string editmanager, int val) } /// /// Return the value of gEditingMission. ) +/// /// public bool fn_EditManager_isEditorEnabled (string editmanager) @@ -2726,6 +3598,7 @@ public bool fn_EditManager_isEditorEnabled (string editmanager) } /// /// (int slot)) +/// /// public void fn_EditManager_setBookmark (string editmanager, int val) @@ -2739,7 +3612,11 @@ public void fn_EditManager_setBookmark (string editmanager, int val) SafeNativeMethods.mwle_fn_EditManager_setBookmark(sbeditmanager, val); } /// -/// () @brief Enables use of the joystick. @note DirectInput must be enabled and active to use this function. @ingroup Input) +/// () +/// @brief Enables use of the joystick. +/// @note DirectInput must be enabled and active to use this function. +/// @ingroup Input) +/// /// public bool fn_enableJoystick () @@ -2751,7 +3628,11 @@ public bool fn_enableJoystick () return SafeNativeMethods.mwle_fn_enableJoystick()>=1; } /// -/// (pattern, [state]) - @brief Enable sampling for all keys that match the given name pattern. Slashes are treated as separators. @ingroup Rendering) +/// (pattern, [state]) - +/// @brief Enable sampling for all keys that match the given name +/// pattern. Slashes are treated as separators. +/// @ingroup Rendering) +/// /// public void fn_enableSamples (string pattern, bool state) @@ -2766,6 +3647,7 @@ public void fn_enableSamples (string pattern, bool state) } /// /// enableWinConsole(bool);) +/// /// public void fn_enableWinConsole (bool flag) @@ -2776,7 +3658,12 @@ public void fn_enableWinConsole (bool flag) SafeNativeMethods.mwle_fn_enableWinConsole(flag); } /// -/// () @brief Enables XInput for Xbox 360 controllers. @note XInput is enabled by default. Disable to use an Xbox 360 Controller as a joystick device. @ingroup Input) +/// () +/// @brief Enables XInput for Xbox 360 controllers. +/// @note XInput is enabled by default. Disable to use an Xbox 360 +/// Controller as a joystick device. +/// @ingroup Input) +/// /// public bool fn_enableXInput () @@ -2788,7 +3675,18 @@ public bool fn_enableXInput () return SafeNativeMethods.mwle_fn_enableXInput()>=1; } /// -/// @brief Test whether the given string ends with the given suffix. @param str The string to test. @param suffix The potential suffix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. @tsexample startsWith( \"TEST123\", \"123\" ) // Returns true. @endtsexample @see startsWith @ingroup Strings ) +/// @brief Test whether the given string ends with the given suffix. +/// @param str The string to test. +/// @param suffix The potential suffix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the last characters in @a str match the complete contents of @a suffix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"123\" ) // Returns true. +/// @endtsexample +/// @see startsWith +/// @ingroup Strings ) +/// /// public bool fn_endsWith (string str, string suffix, bool caseSensitive) @@ -2805,7 +3703,16 @@ public bool fn_endsWith (string str, string suffix, bool caseSensitive) return SafeNativeMethods.mwle_fn_endsWith(sbstr, sbsuffix, caseSensitive)>=1; } /// -/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from a COLLADA file and store it in a GuiTreeView control. This function is used by the COLLADA import gui to show a preview of the scene contents prior to import, and is probably not much use for anything else. @param shapePath COLLADA filename @param ctrl GuiTreeView control to add elements to @return true if successful, false otherwise @ingroup Editors @internal) +/// (string shapePath, GuiTreeViewCtrl ctrl) Collect scene information from +/// a COLLADA file and store it in a GuiTreeView control. This function is +/// used by the COLLADA import gui to show a preview of the scene contents +/// prior to import, and is probably not much use for anything else. +/// @param shapePath COLLADA filename +/// @param ctrl GuiTreeView control to add elements to +/// @return true if successful, false otherwise +/// @ingroup Editors +/// @internal) +/// /// public bool fn_enumColladaForImport (string shapePath, string ctrl) @@ -2822,7 +3729,14 @@ public bool fn_enumColladaForImport (string shapePath, string ctrl) return SafeNativeMethods.mwle_fn_enumColladaForImport(sbshapePath, sbctrl)>=1; } /// -/// ), @brief Returns a list of classes that derive from the named class. If the named class is omitted this dumps all the classes. @param className The optional base class name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// ), +/// @brief Returns a list of classes that derive from the named class. +/// If the named class is omitted this dumps all the classes. +/// @param className The optional base class name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string fn_enumerateConsoleClasses (string className) @@ -2839,7 +3753,12 @@ public string fn_enumerateConsoleClasses (string className) } /// -/// @brief Provide a list of classes that belong to the given category. @param category The category name. @return A tab delimited list of classes. @ingroup Editors @internal) +/// @brief Provide a list of classes that belong to the given category. +/// @param category The category name. +/// @return A tab delimited list of classes. +/// @ingroup Editors +/// @internal) +/// /// public string fn_enumerateConsoleClassesByCategory (string category) @@ -2857,6 +3776,7 @@ public string fn_enumerateConsoleClassesByCategory (string category) } /// /// eval(consoleString) ) +/// /// public string fn_eval (string consoleString) @@ -2873,7 +3793,9 @@ public string fn_eval (string consoleString) } /// -/// () Print all registered events to the console. ) +/// () +/// Print all registered events to the console. ) +/// /// public void fn_EventManager_dumpEvents (string eventmanager) @@ -2887,7 +3809,10 @@ public void fn_EventManager_dumpEvents (string eventmanager) SafeNativeMethods.mwle_fn_EventManager_dumpEvents(sbeventmanager); } /// -/// ), ( String event ) Print all subscribers to an event to the console. @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// ), ( String event ) +/// Print all subscribers to an event to the console. +/// @param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped. ) +/// /// public void fn_EventManager_dumpSubscribers (string eventmanager, string listenerName) @@ -2904,7 +3829,11 @@ public void fn_EventManager_dumpSubscribers (string eventmanager, string listene SafeNativeMethods.mwle_fn_EventManager_dumpSubscribers(sbeventmanager, sblistenerName); } /// -/// ( String event ) Check if an event is registered or not. @param event The event to check. @return Whether or not the event exists. ) +/// ( String event ) +/// Check if an event is registered or not. +/// @param event The event to check. +/// @return Whether or not the event exists. ) +/// /// public bool fn_EventManager_isRegisteredEvent (string eventmanager, string evt) @@ -2921,7 +3850,12 @@ public bool fn_EventManager_isRegisteredEvent (string eventmanager, string evt) return SafeNativeMethods.mwle_fn_EventManager_isRegisteredEvent(sbeventmanager, sbevt)>=1; } /// -/// ), ( String event, String data ) ~Trigger an event. @param event The event to trigger. @param data The data associated with the event. @return Whether or not the event was dispatched successfully. ) +/// ), ( String event, String data ) +/// ~Trigger an event. +/// @param event The event to trigger. +/// @param data The data associated with the event. +/// @return Whether or not the event was dispatched successfully. ) +/// /// public bool fn_EventManager_postEvent (string eventmanager, string evt, string data) @@ -2941,7 +3875,11 @@ public bool fn_EventManager_postEvent (string eventmanager, string evt, string d return SafeNativeMethods.mwle_fn_EventManager_postEvent(sbeventmanager, sbevt, sbdata)>=1; } /// -/// ( String event ) Register an event with the event manager. @param event The event to register. @return Whether or not the event was registered successfully. ) +/// ( String event ) +/// Register an event with the event manager. +/// @param event The event to register. +/// @return Whether or not the event was registered successfully. ) +/// /// public bool fn_EventManager_registerEvent (string eventmanager, string evt) @@ -2958,7 +3896,11 @@ public bool fn_EventManager_registerEvent (string eventmanager, string evt) return SafeNativeMethods.mwle_fn_EventManager_registerEvent(sbeventmanager, sbevt)>=1; } /// -/// ( SimObject listener, String event ) Remove a listener from an event. @param listener The listener to remove. @param event The event to be removed from.) +/// ( SimObject listener, String event ) +/// Remove a listener from an event. +/// @param listener The listener to remove. +/// @param event The event to be removed from.) +/// /// public void fn_EventManager_remove (string eventmanager, string listenerName, string evt) @@ -2978,7 +3920,10 @@ public void fn_EventManager_remove (string eventmanager, string listenerName, st SafeNativeMethods.mwle_fn_EventManager_remove(sbeventmanager, sblistenerName, sbevt); } /// -/// ( SimObject listener ) Remove a listener from all events. @param listener The listener to remove.) +/// ( SimObject listener ) +/// Remove a listener from all events. +/// @param listener The listener to remove.) +/// /// public void fn_EventManager_removeAll (string eventmanager, string listenerName) @@ -2995,7 +3940,13 @@ public void fn_EventManager_removeAll (string eventmanager, string listenerName) SafeNativeMethods.mwle_fn_EventManager_removeAll(sbeventmanager, sblistenerName); } /// -/// ), ( SimObject listener, String event, String callback ) Subscribe a listener to an event. @param listener The listener to subscribe. @param event The event to subscribe to. @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. @return Whether or not the subscription was successful. ) +/// ), ( SimObject listener, String event, String callback ) +/// Subscribe a listener to an event. +/// @param listener The listener to subscribe. +/// @param event The event to subscribe to. +/// @param callback Optional method name to receive the event notification. If this is not specified, \"on[event]\" will be used. +/// @return Whether or not the subscription was successful. ) +/// /// public bool fn_EventManager_subscribe (string eventmanager, string listenerName, string evt, string callback) @@ -3018,7 +3969,10 @@ public bool fn_EventManager_subscribe (string eventmanager, string listenerName, return SafeNativeMethods.mwle_fn_EventManager_subscribe(sbeventmanager, sblistenerName, sbevt, sbcallback)>=1; } /// -/// ( String event ) Remove an event from the EventManager. @param event The event to remove. ) +/// ( String event ) +/// Remove an event from the EventManager. +/// @param event The event to remove. ) +/// /// public void fn_EventManager_unregisterEvent (string eventmanager, string evt) @@ -3035,7 +3989,17 @@ public void fn_EventManager_unregisterEvent (string eventmanager, string evt) SafeNativeMethods.mwle_fn_EventManager_unregisterEvent(sbeventmanager, sbevt); } /// -/// @brief Used to exclude/prevent all other instances using the same identifier specified @note Not used on OSX, Xbox, or in Win debug builds @param appIdentifier Name of the app set up for exclusive use. @return False if another app is running that specified the same appIdentifier @ingroup Platform @ingroup GuiCore) +/// @brief Used to exclude/prevent all other instances using the same identifier specified +/// +/// @note Not used on OSX, Xbox, or in Win debug builds +/// +/// @param appIdentifier Name of the app set up for exclusive use. +/// +/// @return False if another app is running that specified the same appIdentifier +/// +/// @ingroup Platform +/// @ingroup GuiCore) +/// /// public bool fn_excludeOtherInstance (string appIdentifer) @@ -3049,7 +4013,19 @@ public bool fn_excludeOtherInstance (string appIdentifer) return SafeNativeMethods.mwle_fn_excludeOtherInstance(sbappIdentifer)>=1; } /// -/// Execute the given script file. @param fileName Path to the file to execute @param noCalls Deprecated @param journalScript Deprecated @return True if the script was successfully executed, false if not. @tsexample // Execute the init.cs script file found in the same directory as the current script file. exec( \"./init.cs\" ); @endtsexample @see compile @see eval @ingroup Scripting ) +/// Execute the given script file. +/// @param fileName Path to the file to execute +/// @param noCalls Deprecated +/// @param journalScript Deprecated +/// @return True if the script was successfully executed, false if not. +/// @tsexample +/// // Execute the init.cs script file found in the same directory as the current script file. +/// exec( \"./init.cs\" ); +/// @endtsexample +/// @see compile +/// @see eval +/// @ingroup Scripting ) +/// /// public bool fn_exec (string fileName, bool noCalls, bool journalScript) @@ -3063,7 +4039,20 @@ public bool fn_exec (string fileName, bool noCalls, bool journalScript) return SafeNativeMethods.mwle_fn_exec(sbfileName, noCalls, journalScript)>=1; } /// -/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their respective escape sequences. All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). The primary use of this function is for converting strings suitable for being passed as string literals to the TorqueScript compiler. @param text A string @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective escape sequences. @tsxample expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". @endtsxample @see collapseEscape @ingroup Strings) +/// @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their +/// respective escape sequences. +/// All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\\, \\\\t, etc). +/// The primary use of this function is for converting strings suitable for being passed as string literals +/// to the TorqueScript compiler. +/// @param text A string +/// @return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective +/// escape sequences. +/// @tsxample +/// expandEscape( \"str\" NL \"ing\" ) // Returns \"str\ing\". +/// @endtsxample +/// @see collapseEscape +/// @ingroup Strings) +/// /// public string fn_expandEscape (string text) @@ -3080,7 +4069,23 @@ public string fn_expandEscape (string text) } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void fn_export (string pattern, string filename, bool append) @@ -3097,7 +4102,17 @@ public void fn_export (string pattern, string filename, bool append) SafeNativeMethods.mwle_fn_export(sbpattern, sbfilename, append); } /// -/// Export specified font to the specified filename as a PNG. The image can then be processed in Photoshop or another tool and reimported using importCachedFont. Characters in the font are exported as one long strip. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the output PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Export specified font to the specified filename as a PNG. The +/// image can then be processed in Photoshop or another tool and +/// reimported using importCachedFont. Characters in the font are +/// exported as one long strip. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the output PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void fn_exportCachedFont (string faceName, int fontSize, string fileName, int padding, int kerning) @@ -3114,7 +4129,10 @@ public void fn_exportCachedFont (string faceName, int fontSize, string fileName, SafeNativeMethods.mwle_fn_exportCachedFont(sbfaceName, fontSize, sbfileName, padding, kerning); } /// -/// Create a XML document containing a dump of the entire exported engine API. @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. @ingroup Console ) +/// Create a XML document containing a dump of the entire exported engine API. +/// @return A SimXMLDocument containing a dump of the engine's export information or NULL if the operation failed. +/// @ingroup Console ) +/// /// public string fn_exportEngineAPIToXML () @@ -3129,7 +4147,23 @@ public string fn_exportEngineAPIToXML () } /// -/// , false ), Write out the definitions of all global variables matching the given name @a pattern. If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the definitions will be printed to the console. The output are valid TorqueScript statements that can be executed to restore the global variable values. @param pattern A global variable name pattern. Must begin with '$'. @param filename %Path of the file to which to write the definitions or \"\" to write the definitions to the console. @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten. @tsexample // Write out all preference variables to a prefs.cs file. export( \"$prefs::*\", \"prefs.cs\" ); @endtsexample @ingroup Scripting ) +/// , false ), +/// Write out the definitions of all global variables matching the given name @a pattern. +/// If @a fileName is not \"\", the variable definitions are written to the specified file. Otherwise the +/// definitions will be printed to the console. +/// The output are valid TorqueScript statements that can be executed to restore the global variable +/// values. +/// @param pattern A global variable name pattern. Must begin with '$'. +/// @param filename %Path of the file to which to write the definitions or \"\" to write the definitions +/// to the console. +/// @param append If true and @a fileName is not \"\", then the definitions are appended to the specified file. +/// Otherwise existing contents of the file (if any) will be overwritten. +/// @tsexample +/// // Write out all preference variables to a prefs.cs file. +/// export( \"$prefs::*\", \"prefs.cs\" ); +/// @endtsexample +/// @ingroup Scripting ) +/// /// public void fn_exportToSettings (string pattern, string filename, bool append) @@ -3146,7 +4180,11 @@ public void fn_exportToSettings (string pattern, string filename, bool append) SafeNativeMethods.mwle_fn_exportToSettings(sbpattern, sbfilename, append); } /// -/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ @param simObject Object to copy static-fields from. @param fieldList fields to filter static-fields against. @return No return value.) +/// ), (simObject, [fieldList]) Copy selected static-fields for selected object./ +/// @param simObject Object to copy static-fields from. +/// @param fieldList fields to filter static-fields against. +/// @return No return value.) +/// /// public void fn_FieldBrushObject_copyFields (string fieldbrushobject, string simObjName, string pFieldList) @@ -3166,7 +4204,10 @@ public void fn_FieldBrushObject_copyFields (string fieldbrushobject, string simO SafeNativeMethods.mwle_fn_FieldBrushObject_copyFields(sbfieldbrushobject, sbsimObjName, sbpFieldList); } /// -/// (simObject) Paste copied static-fields to selected object./ @param simObject Object to paste static-fields to. @return No return value.) +/// (simObject) Paste copied static-fields to selected object./ +/// @param simObject Object to paste static-fields to. +/// @return No return value.) +/// /// public void fn_FieldBrushObject_pasteFields (string fieldbrushobject, string simObjName) @@ -3183,7 +4224,11 @@ public void fn_FieldBrushObject_pasteFields (string fieldbrushobject, string sim SafeNativeMethods.mwle_fn_FieldBrushObject_pasteFields(sbfieldbrushobject, sbsimObjName); } /// -/// ), (simObject, [groupList]) Query available static-fields for selected object./ @param simObject Object to query static-fields on. @param groupList groups to filter static-fields against. @return Space-seperated static-field list.) +/// ), (simObject, [groupList]) Query available static-fields for selected object./ +/// @param simObject Object to query static-fields on. +/// @param groupList groups to filter static-fields against. +/// @return Space-seperated static-field list.) +/// /// public string fn_FieldBrushObject_queryFields (string fieldbrushobject, string simObjName, string groupList) @@ -3206,7 +4251,10 @@ public string fn_FieldBrushObject_queryFields (string fieldbrushobject, string s } /// -/// (simObject) Query available static-field groups for selected object./ @param simObject Object to query static-field groups on. @return Space-seperated static-field group list.) +/// (simObject) Query available static-field groups for selected object./ +/// @param simObject Object to query static-field groups on. +/// @return Space-seperated static-field group list.) +/// /// public string fn_FieldBrushObject_queryGroups (string fieldbrushobject, string simObjName) @@ -3226,7 +4274,12 @@ public string fn_FieldBrushObject_queryGroups (string fieldbrushobject, string s } /// -/// @brief Get the base of a file name (removes extension) @param fileName Name and path of file to check @return String containing the file name, minus extension @ingroup FileSystem) +/// @brief Get the base of a file name (removes extension and path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus extension and path +/// @ingroup FileSystem) +/// /// public string fn_fileBase (string fileName) @@ -3243,7 +4296,12 @@ public string fn_fileBase (string fileName) } /// -/// @brief Returns a platform specific formatted string with the creation time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the creation time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing created time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fn_fileCreatedTime (string fileName) @@ -3260,7 +4318,13 @@ public string fn_fileCreatedTime (string fileName) } /// -/// @brief Delete a file from the hard drive @param path Name and path of the file to delete @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. @return True if file was successfully deleted @ingroup FileSystem) +/// @brief Delete a file from the hard drive +/// +/// @param path Name and path of the file to delete +/// @note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good. +/// @return True if file was successfully deleted +/// @ingroup FileSystem) +/// /// public bool fn_fileDelete (string path) @@ -3274,7 +4338,12 @@ public bool fn_fileDelete (string path) return SafeNativeMethods.mwle_fn_fileDelete(sbpath)>=1; } /// -/// @brief Get the extension of a file @param fileName Name and path of file @return String containing the extension, such as \".exe\" or \".cs\" @ingroup FileSystem) +/// @brief Get the extension of a file +/// +/// @param fileName Name and path of file +/// @return String containing the extension, such as \".exe\" or \".cs\" +/// @ingroup FileSystem) +/// /// public string fn_fileExt (string fileName) @@ -3291,7 +4360,12 @@ public string fn_fileExt (string fileName) } /// -/// @brief Returns a platform specific formatted string with the last modified time for the file. @param fileName Name and path of file to check @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example @ingroup FileSystem) +/// @brief Returns a platform specific formatted string with the last modified time for the file. +/// +/// @param fileName Name and path of file to check +/// @return Formatted string (OS specific) containing modified time, \"9/3/2010 12:33:47 PM\" for example +/// @ingroup FileSystem) +/// /// public string fn_fileModifiedTime (string fileName) @@ -3308,7 +4382,12 @@ public string fn_fileModifiedTime (string fileName) } /// -/// @brief Get the file name of a file (removes extension and path) @param fileName Name and path of file to check @return String containing the file name, minus extension and path @ingroup FileSystem) +/// @brief Get only the file name of a path and file name string (removes path) +/// +/// @param fileName Name and path of file to check +/// @return String containing the file name, minus the path +/// @ingroup FileSystem) +/// /// public string fn_fileName (string fileName) @@ -3325,7 +4404,9 @@ public string fn_fileName (string fileName) } /// -/// ), FileObject.writeObject(SimObject, object prepend) @hide) +/// ), FileObject.writeObject(SimObject, object prepend) +/// @hide) +/// /// public void fn_FileObject_writeObject (string fileobject, string simName, string objName) @@ -3345,7 +4426,12 @@ public void fn_FileObject_writeObject (string fileobject, string simName, string SafeNativeMethods.mwle_fn_FileObject_writeObject(sbfileobject, sbsimName, sbobjName); } /// -/// @brief Get the path of a file (removes name and extension) @param fileName Name and path of file to check @return String containing the path, minus name and extension @ingroup FileSystem) +/// @brief Get the path of a file (removes name and extension) +/// +/// @param fileName Name and path of file to check +/// @return String containing the path, minus name and extension +/// @ingroup FileSystem) +/// /// public string fn_filePath (string fileName) @@ -3362,7 +4448,13 @@ public string fn_filePath (string fileName) } /// -/// @brief Determines the size of a file on disk @param fileName Name and path of the file to check @return Returns filesize in KB, or -1 if no file @ingroup FileSystem) +/// @brief Determines the size of a file on disk +/// +/// @param fileName Name and path of the file to check +/// @return Returns filesize in KB, or -1 if no file +/// +/// @ingroup FileSystem) +/// /// public int fn_fileSize (string fileName) @@ -3376,7 +4468,30 @@ public int fn_fileSize (string fileName) return SafeNativeMethods.mwle_fn_fileSize(sbfileName); } /// -/// @brief Replaces the characters in a string with designated text Uses the bad word filter to determine which characters within the string will be replaced. @param baseString The original string to filter. @param replacementChars A string containing letters you wish to swap in the baseString. @return The new scrambled string @see addBadWord() @see containsBadWords() @tsexample // Create the base string, can come from anywhere %baseString = \"Foobar\"; // Create a string of random letters %replacementChars = \"knqwrtlzs\"; // Filter the string %newString = filterString(%baseString, %replacementChars); // Print the new string to console echo(%newString); @endtsexample @ingroup Game) +/// @brief Replaces the characters in a string with designated text +/// +/// Uses the bad word filter to determine which characters within the string will be replaced. +/// +/// @param baseString The original string to filter. +/// @param replacementChars A string containing letters you wish to swap in the baseString. +/// @return The new scrambled string +/// +/// @see addBadWord() +/// @see containsBadWords() +/// +/// @tsexample +/// // Create the base string, can come from anywhere +/// %baseString = \"Foobar\"; +/// // Create a string of random letters +/// %replacementChars = \"knqwrtlzs\"; +/// // Filter the string +/// %newString = filterString(%baseString, %replacementChars); +/// // Print the new string to console +/// echo(%newString); +/// @endtsexample +/// +/// @ingroup Game) +/// /// public string fn_filterString (string baseString, string replacementChars) @@ -3396,7 +4511,34 @@ public string fn_filterString (string baseString, string replacementChars) } /// -/// @brief Returns the first file in the directory system matching the given pattern. Use the corresponding findNextFile() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCount(). This function differs from findFirstFileMultiExpr() in that it supports a single search pattern being passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return The path of the first file matched by the search or an empty string if no matching file could be found. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findNextFile() @see getFileCount() @see findFirstFileMultiExpr() @ingroup FileSearches ) +/// @brief Returns the first file in the directory system matching the given pattern. +/// +/// Use the corresponding findNextFile() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCount(). +/// +/// This function differs from findFirstFileMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. +/// @return The path of the first file matched by the search or an empty string if no matching file could be found. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findNextFile() +/// @see getFileCount() +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches ) +/// /// public string fn_findFirstFile (string pattern, bool recurse) @@ -3413,7 +4555,42 @@ public string fn_findFirstFile (string pattern, bool recurse) } /// -/// @brief Returns the first file in the directory system matching the given patterns. Use the corresponding findNextFileMultiExpr() to step through the results. If you're only interested in the number of files returned by the pattern match, use getFileCountMultiExpr(). This function differs from findFirstFile() in that it supports multiple search patterns to be passed in. @note You cannot run multiple simultaneous file system searches with these functions. Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid. @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename patterns. @return String of the first matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findNextFileMultiExpr() @see getFileCountMultiExpr() @see findFirstFile() @ingroup FileSearches) +/// @brief Returns the first file in the directory system matching the given patterns. +/// +/// Use the corresponding findNextFileMultiExpr() to step through +/// the results. If you're only interested in the number of files returned by the +/// pattern match, use getFileCountMultiExpr(). +/// +/// This function differs from findFirstFile() in that it supports multiple search patterns +/// to be passed in. +/// +/// @note You cannot run multiple simultaneous file system searches with these functions. Each +/// call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders +/// a previous search invalid. +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename patterns. +/// @return String of the first matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findNextFileMultiExpr() +/// @see getFileCountMultiExpr() +/// @see findFirstFile() +/// @ingroup FileSearches) +/// /// public string fn_findFirstFileMultiExpr (string pattern, bool recurse) @@ -3430,7 +4607,22 @@ public string fn_findFirstFileMultiExpr (string pattern, bool recurse) } /// -/// ), @brief Returns the next file matching a search begun in findFirstFile(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return The path of the next filename matched by the search or an empty string if no more files match. @tsexample // Execute all .cs files in a subdirectory and its subdirectories. for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) exec( %file ); @endtsexample @see findFirstFile() @ingroup FileSearches ) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFile(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return The path of the next filename matched by the search or an empty string if no more files match. +/// +/// @tsexample +/// // Execute all .cs files in a subdirectory and its subdirectories. +/// for( %file = findFirstFile( \"subdirectory/*.cs\" ); %file !$= \"\"; %file = findNextFile() ) +/// exec( %file ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @ingroup FileSearches ) +/// /// public string fn_findNextFile (string pattern) @@ -3447,7 +4639,28 @@ public string fn_findNextFile (string pattern) } /// -/// ), @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). @param pattern The path and file name pattern to match against. This is optional and may be left out as it is not used by the code. It is here for legacy reasons. @return String of the next matching file path, or an empty string if no matching files were found. @tsexample // Find all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; %fullPath = findFirstFileMultiExpr( %filePatterns ); while ( %fullPath !$= \"\" ) { echo( %fullPath ); %fullPath = findNextFileMultiExpr( %filePatterns ); } @endtsexample @see findFirstFileMultiExpr() @ingroup FileSearches) +/// ), +/// @brief Returns the next file matching a search begun in findFirstFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against. This is optional +/// and may be left out as it is not used by the code. It is here for legacy reasons. +/// @return String of the next matching file path, or an empty string if no matching +/// files were found. +/// +/// @tsexample +/// // Find all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// %fullPath = findFirstFileMultiExpr( %filePatterns ); +/// while ( %fullPath !$= \"\" ) +/// { +/// echo( %fullPath ); +/// %fullPath = findNextFileMultiExpr( %filePatterns ); +/// } +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @ingroup FileSearches) +/// /// public string fn_findNextFileMultiExpr (string pattern) @@ -3464,7 +4677,16 @@ public string fn_findNextFileMultiExpr (string pattern) } /// -/// Return the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return The word at index 0 in @a text or \"\" if @a text is empty. @note This is equal to @tsexample_nopar getWord( text, 0 ) @endtsexample @see getWord @ingroup FieldManip ) +/// Return the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return The word at index 0 in @a text or \"\" if @a text is empty. +/// @note This is equal to +/// @tsexample_nopar +/// getWord( text, 0 ) +/// @endtsexample +/// @see getWord +/// @ingroup FieldManip ) +/// /// public string fn_firstWord (string text) @@ -3481,7 +4703,13 @@ public string fn_firstWord (string text) } /// -/// @brief Flags all currently allocated GFX resources. Used for resource allocation and leak tracking by flagging current resources then dumping a list of unflagged resources at some later point in execution. @ingroup GFX @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// @brief Flags all currently allocated GFX resources. +/// Used for resource allocation and leak tracking by flagging +/// current resources then dumping a list of unflagged resources +/// at some later point in execution. +/// @ingroup GFX +/// @see listGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void fn_flagCurrentGFXResources () @@ -3493,7 +4721,9 @@ public void fn_flagCurrentGFXResources () SafeNativeMethods.mwle_fn_flagCurrentGFXResources(); } /// -/// Releases all textures and resurrects the texture manager. @ingroup GFX ) +/// Releases all textures and resurrects the texture manager. +/// @ingroup GFX ) +/// /// public void fn_flushTextureCache () @@ -3506,6 +4736,7 @@ public void fn_flushTextureCache () } /// /// () ) +/// /// public void fn_Forest_clear (string forest) @@ -3520,6 +4751,7 @@ public void fn_Forest_clear (string forest) } /// /// ()) +/// /// public bool fn_Forest_isDirty (string forest) @@ -3534,6 +4766,7 @@ public bool fn_Forest_isDirty (string forest) } /// /// ()) +/// /// public void fn_Forest_regenCells (string forest) @@ -3547,7 +4780,8 @@ public void fn_Forest_regenCells (string forest) SafeNativeMethods.mwle_fn_Forest_regenCells(sbforest); } /// -/// ), saveDataFile( [path] ) ) +/// saveDataFile( [path] ) ) +/// /// public void fn_Forest_saveDataFile (string forest, string path) @@ -3565,6 +4799,7 @@ public void fn_Forest_saveDataFile (string forest, string path) } /// /// ( ForestItemData obj ) ) +/// /// public bool fn_ForestBrush_containsItemData (string forestbrush, string obj) @@ -3582,6 +4817,7 @@ public bool fn_ForestBrush_containsItemData (string forestbrush, string obj) } /// /// ) +/// /// public void fn_ForestBrushTool_collectElements (string forestbrushtool) @@ -3596,6 +4832,7 @@ public void fn_ForestBrushTool_collectElements (string forestbrushtool) } /// /// ( ForestItemData obj ) ) +/// /// public void fn_ForestEditorCtrl_deleteMeshSafe (string foresteditorctrl, string obj) @@ -3613,6 +4850,7 @@ public void fn_ForestEditorCtrl_deleteMeshSafe (string foresteditorctrl, string } /// /// () ) +/// /// public int fn_ForestEditorCtrl_getActiveTool (string foresteditorctrl) @@ -3627,6 +4865,7 @@ public int fn_ForestEditorCtrl_getActiveTool (string foresteditorctrl) } /// /// ) +/// /// public bool fn_ForestEditorCtrl_isDirty (string foresteditorctrl) @@ -3641,6 +4880,7 @@ public bool fn_ForestEditorCtrl_isDirty (string foresteditorctrl) } /// /// ( ForestTool tool ) ) +/// /// public void fn_ForestEditorCtrl_setActiveTool (string foresteditorctrl, string toolName) @@ -3658,6 +4898,7 @@ public void fn_ForestEditorCtrl_setActiveTool (string foresteditorctrl, string t } /// /// () ) +/// /// public void fn_ForestEditorCtrl_updateActiveForest (string foresteditorctrl) @@ -3672,6 +4913,7 @@ public void fn_ForestEditorCtrl_updateActiveForest (string foresteditorctrl) } /// /// ) +/// /// public void fn_ForestSelectionTool_clearSelection (string forestselectiontool) @@ -3686,6 +4928,7 @@ public void fn_ForestSelectionTool_clearSelection (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_copySelection (string forestselectiontool) @@ -3700,6 +4943,7 @@ public void fn_ForestSelectionTool_copySelection (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_cutSelection (string forestselectiontool) @@ -3714,6 +4958,7 @@ public void fn_ForestSelectionTool_cutSelection (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_deleteSelection (string forestselectiontool) @@ -3728,6 +4973,7 @@ public void fn_ForestSelectionTool_deleteSelection (string forestselectiontool) } /// /// ) +/// /// public int fn_ForestSelectionTool_getSelectionCount (string forestselectiontool) @@ -3742,6 +4988,7 @@ public int fn_ForestSelectionTool_getSelectionCount (string forestselectiontool) } /// /// ) +/// /// public void fn_ForestSelectionTool_pasteSelection (string forestselectiontool) @@ -3755,7 +5002,9 @@ public void fn_ForestSelectionTool_pasteSelection (string forestselectiontool) SafeNativeMethods.mwle_fn_ForestSelectionTool_pasteSelection(sbforestselectiontool); } /// -/// Returns the count of active DDSs files in memory. @ingroup Rendering ) +/// Returns the count of active DDSs files in memory. +/// @ingroup Rendering ) +/// /// public int fn_getActiveDDSFiles () @@ -3767,7 +5016,9 @@ public int fn_getActiveDDSFiles () return SafeNativeMethods.mwle_fn_getActiveDDSFiles(); } /// -/// Returns the active light manager name. @ingroup Lighting ) +/// Returns the active light manager name. +/// @ingroup Lighting ) +/// /// public string fn_getActiveLightManager () @@ -3782,7 +5033,9 @@ public string fn_getActiveLightManager () } /// -/// Get the version of the application build, as a string. @ingroup Debugging) +/// Get the version of the application build, as a string. +/// @ingroup Debugging) +/// /// public int fn_getAppVersionNumber () @@ -3794,7 +5047,9 @@ public int fn_getAppVersionNumber () return SafeNativeMethods.mwle_fn_getAppVersionNumber(); } /// -/// Get the version of the aplication build, as a human readable string. @ingroup Debugging) +/// Get the version of the aplication build, as a human readable string. +/// @ingroup Debugging) +/// /// public string fn_getAppVersionString () @@ -3809,7 +5064,9 @@ public string fn_getAppVersionString () } /// -/// Returns the best texture format for storage of HDR data for the active device. @ingroup GFX ) +/// Returns the best texture format for storage of HDR data for the active device. +/// @ingroup GFX ) +/// /// public int fn_getBestHDRFormat () @@ -3821,7 +5078,10 @@ public int fn_getBestHDRFormat () return SafeNativeMethods.mwle_fn_getBestHDRFormat(); } /// -/// Returns image info in the following format: width TAB height TAB bytesPerPixel. It will return an empty string if the file is not found. @ingroup Rendering ) +/// Returns image info in the following format: width TAB height TAB bytesPerPixel. +/// It will return an empty string if the file is not found. +/// @ingroup Rendering ) +/// /// public string fn_getBitmapInfo (string filename) @@ -3838,7 +5098,11 @@ public string fn_getBitmapInfo (string filename) } /// -/// Get the center point of an axis-aligned box. @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" @return Center of the box. @ingroup Math) +/// Get the center point of an axis-aligned box. +/// @param b A Box3F, in string format using \"minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ\" +/// @return Center of the box. +/// @ingroup Math) +/// /// public string fn_getBoxCenter (string box) @@ -3855,7 +5119,9 @@ public string fn_getBoxCenter (string box) } /// -/// Get the type of build, \"Debug\" or \"Release\". @ingroup Debugging) +/// Get the type of build, \"Debug\" or \"Release\". +/// @ingroup Debugging) +/// /// public string fn_getBuildString () @@ -3870,7 +5136,10 @@ public string fn_getBuildString () } /// -/// @brief Returns the category of the given class. @param className The name of the class. @ingroup Console) +/// @brief Returns the category of the given class. +/// @param className The name of the class. +/// @ingroup Console) +/// /// public string fn_getCategoryOfClass (string className) @@ -3905,7 +5174,9 @@ public string fn_getClipboard () } /// -/// Get the time of compilation. @ingroup Debugging) +/// Get the time of compilation. +/// @ingroup Debugging) +/// /// public string fn_getCompileTimeString () @@ -3920,7 +5191,11 @@ public string fn_getCompileTimeString () } /// -/// () @brief Gets the primary LangTable used by the game @return ID of the core LangTable @ingroup Localization) +/// () +/// @brief Gets the primary LangTable used by the game +/// @return ID of the core LangTable +/// @ingroup Localization) +/// /// public int fn_getCoreLangTable () @@ -3932,7 +5207,10 @@ public int fn_getCoreLangTable () return SafeNativeMethods.mwle_fn_getCoreLangTable(); } /// -/// @brief Returns the current %ActionMap. @see ActionMap @ingroup Input) +/// @brief Returns the current %ActionMap. +/// @see ActionMap +/// @ingroup Input) +/// /// public string fn_getCurrentActionMap () @@ -3947,7 +5225,12 @@ public string fn_getCurrentActionMap () } /// -/// @brief Return the current working directory. @return The absolute path of the current working directory. @note Only present in a Tools build of Torque. @see getWorkingDirectory() @ingroup FileSystem) +/// @brief Return the current working directory. +/// @return The absolute path of the current working directory. +/// @note Only present in a Tools build of Torque. +/// @see getWorkingDirectory() +/// @ingroup FileSystem) +/// /// public string fn_getCurrentDirectory () @@ -3962,7 +5245,11 @@ public string fn_getCurrentDirectory () } /// -/// @brief Returns the description string for the named class. @param className The name of the class. @return The class description in string format. @ingroup Console) +/// @brief Returns the description string for the named class. +/// @param className The name of the class. +/// @return The class description in string format. +/// @ingroup Console) +/// /// public string fn_getDescriptionOfClass (string className) @@ -3980,6 +5267,7 @@ public string fn_getDescriptionOfClass (string className) } /// /// Returns the width, height, and bitdepth of the screen/desktop.@ingroup GFX ) +/// /// public string fn_getDesktopResolution () @@ -3994,7 +5282,14 @@ public string fn_getDesktopResolution () } /// -/// @brief Gathers a list of directories starting at the given path. @param path String containing the path of the directory @param depth Depth of search, as in how many subdirectories to parse through @return Tab delimited string containing list of directories found during search, \"\" if no files were found @ingroup FileSystem) +/// @brief Gathers a list of directories starting at the given path. +/// +/// @param path String containing the path of the directory +/// @param depth Depth of search, as in how many subdirectories to parse through +/// @return Tab delimited string containing list of directories found during search, \"\" if no files were found +/// +/// @ingroup FileSystem) +/// /// public string fn_getDirectoryList (string path, int depth) @@ -4011,7 +5306,9 @@ public string fn_getDirectoryList (string path, int depth) } /// -/// Get the string describing the active GFX device. @ingroup GFX ) +/// Get the string describing the active GFX device. +/// @ingroup GFX ) +/// /// public string fn_getDisplayDeviceInformation () @@ -4026,7 +5323,9 @@ public string fn_getDisplayDeviceInformation () } /// -/// Returns a tab-seperated string of the detected devices across all adapters. @ingroup GFX ) +/// Returns a tab-seperated string of the detected devices across all adapters. +/// @ingroup GFX ) +/// /// public string fn_getDisplayDeviceList () @@ -4041,7 +5340,15 @@ public string fn_getDisplayDeviceList () } /// -/// Get the absolute path to the file in which the compiled code for the given script file will be stored. @param scriptFileName %Path to the .cs script file. @return The absolute path to the .dso file for the given script file. @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded from the current paths. @see compile @see getPrefsPath @ingroup Scripting ) +/// Get the absolute path to the file in which the compiled code for the given script file will be stored. +/// @param scriptFileName %Path to the .cs script file. +/// @return The absolute path to the .dso file for the given script file. +/// @note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded +/// from the current paths. +/// @see compile +/// @see getPrefsPath +/// @ingroup Scripting ) +/// /// public string fn_getDSOPath (string scriptFileName) @@ -4058,7 +5365,9 @@ public string fn_getDSOPath (string scriptFileName) } /// -/// Get the name of the engine product that this is running from, as a string. @ingroup Debugging) +/// Get the name of the engine product that this is running from, as a string. +/// @ingroup Debugging) +/// /// public string fn_getEngineName () @@ -4074,6 +5383,7 @@ public string fn_getEngineName () } /// /// getEventTimeLeft(scheduleId) Get the time left in ms until this event will trigger.) +/// /// public int fn_getEventTimeLeft (int scheduleId) @@ -4084,7 +5394,11 @@ public int fn_getEventTimeLeft (int scheduleId) return SafeNativeMethods.mwle_fn_getEventTimeLeft(scheduleId); } /// -/// @brief Gets the name of the game's executable @return String containing this game's executable name @ingroup FileSystem) +/// @brief Gets the name of the game's executable +/// +/// @return String containing this game's executable name +/// @ingroup FileSystem) +/// /// public string fn_getExecutableName () @@ -4099,7 +5413,9 @@ public string fn_getExecutableName () } /// -/// Gets the clients far clipping. ) +/// Gets the clients far clipping. +/// ) +/// /// public float fn_getFarClippingDistance () @@ -4111,7 +5427,20 @@ public float fn_getFarClippingDistance () return SafeNativeMethods.mwle_fn_getFarClippingDistance(); } /// -/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to extract. @return The field at the given index or \"\" if the index is out of range. @tsexample getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getFields @see getFieldCount @see getWord @see getRecord @ingroup FieldManip ) +/// Extract the field at the given @a index in the newline and/or tab separated list in @a text. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to extract. +/// @return The field at the given index or \"\" if the index is out of range. +/// @tsexample +/// getField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getFields +/// @see getFieldCount +/// @see getWord +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string fn_getField (string text, int index) @@ -4128,7 +5457,16 @@ public string fn_getField (string text, int index) } /// -/// Return the number of newline and/or tab separated fields in @a text. @param text A list of fields separated by newlines and/or tabs. @return The number of newline and/or tab sepearated elements in @a text. @tsexample getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of newline and/or tab separated fields in @a text. +/// @param text A list of fields separated by newlines and/or tabs. +/// @return The number of newline and/or tab sepearated elements in @a text. +/// @tsexample +/// getFieldCount( \"a b\" TAB \"c d\" TAB \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int fn_getFieldCount (string text) @@ -4142,7 +5480,23 @@ public int fn_getFieldCount (string text) return SafeNativeMethods.mwle_fn_getFieldCount(sbtext); } /// -/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param startIndex The zero-based index of the first field to extract from @a text. @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of fields from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" @endtsexample @see getField @see getFieldCount @see getWords @see getRecords @ingroup FieldManip ) +/// Extract a range of fields from the given @a startIndex onwards thru @a endIndex. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param startIndex The zero-based index of the first field to extract from @a text. +/// @param endIndex The zero-based index of the last field to extract from @a text. If this is -1, all fields beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of fields from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getFields( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"c d\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see getFieldCount +/// @see getWords +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string fn_getFields (string text, int startIndex, int endIndex) @@ -4159,7 +5513,29 @@ public string fn_getFields (string text, int startIndex, int endIndex) } /// -/// @brief Returns the number of files in the directory tree that match the given patterns This function differs from getFileCountMultiExpr() in that it supports a single search pattern being passed in. If you're interested in a list of files that match the given pattern and not just the number of files, use findFirstFile() and findNextFile(). @param pattern The path and file name pattern to match against. @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern counting files in subdirectories. @return Number of files located using the pattern @tsexample // Count the number of .cs files in a subdirectory and its subdirectories. getFileCount( \"subdirectory/*.cs\" ); @endtsexample @see findFirstFile() @see findNextFile() @see getFileCountMultiExpr() @ingroup FileSearches ) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// This function differs from getFileCountMultiExpr() in that it supports a single search +/// pattern being passed in. +/// +/// If you're interested in a list of files that match the given pattern and not just +/// the number of files, use findFirstFile() and findNextFile(). +/// +/// @param pattern The path and file name pattern to match against. +/// @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern +/// counting files in subdirectories. +/// @return Number of files located using the pattern +/// +/// @tsexample +/// // Count the number of .cs files in a subdirectory and its subdirectories. +/// getFileCount( \"subdirectory/*.cs\" ); +/// @endtsexample +/// +/// @see findFirstFile() +/// @see findNextFile() +/// @see getFileCountMultiExpr() +/// @ingroup FileSearches ) +/// /// public int fn_getFileCount (string pattern, bool recurse) @@ -4173,7 +5549,27 @@ public int fn_getFileCount (string pattern, bool recurse) return SafeNativeMethods.mwle_fn_getFileCount(sbpattern, recurse); } /// -/// @brief Returns the number of files in the directory tree that match the given patterns If you're interested in a list of files that match the given patterns and not just the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). @param pattern The path and file name pattern to match against, such as *.cs. Separate multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" @param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern. @return Number of files located using the patterns @tsexample // Count all DTS or Collada models %filePatterns = \"*.dts\" TAB \"*.dae\"; echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); @endtsexample @see findFirstFileMultiExpr() @see findNextFileMultiExpr() @ingroup FileSearches) +/// @brief Returns the number of files in the directory tree that match the given patterns +/// +/// If you're interested in a list of files that match the given patterns and not just +/// the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr(). +/// +/// @param pattern The path and file name pattern to match against, such as *.cs. Separate +/// multiple patterns with TABs. For example: \"*.cs\" TAB \"*.dso\" +/// @param recurse If true, the search will exhaustively recurse into subdirectories +/// of the given path and match the given filename pattern. +/// @return Number of files located using the patterns +/// +/// @tsexample +/// // Count all DTS or Collada models +/// %filePatterns = \"*.dts\" TAB \"*.dae\"; +/// echo( \"Nunmer of shape files:\" SPC getFileCountMultiExpr( %filePatterns ) ); +/// @endtsexample +/// +/// @see findFirstFileMultiExpr() +/// @see findNextFileMultiExpr() +/// @ingroup FileSearches) +/// /// public int fn_getFileCountMultiExpr (string pattern, bool recurse) @@ -4187,7 +5583,14 @@ public int fn_getFileCountMultiExpr (string pattern, bool recurse) return SafeNativeMethods.mwle_fn_getFileCountMultiExpr(sbpattern, recurse); } /// -/// @brief Provides the CRC checksum of the given file. @param fileName The path to the file. @return The calculated CRC checksum of the file, or -1 if the file could not be found. @ingroup FileSystem) +/// @brief Provides the CRC checksum of the given file. +/// +/// @param fileName The path to the file. +/// @return The calculated CRC checksum of the file, or -1 if the file +/// could not be found. +/// +/// @ingroup FileSystem) +/// /// public int fn_getFileCRC (string fileName) @@ -4199,9 +5602,44 @@ public int fn_getFileCRC (string fileName) sbfileName = new StringBuilder(fileName, 1024); return SafeNativeMethods.mwle_fn_getFileCRC(sbfileName); +} +/// +/// Returns a list of supported shape format extensions separated by tabs. +/// Example output: *.dsq TAB *.dae TAB) +/// +/// + +public string fn_getFormatExtensions () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_getFormatExtensions'"); + +var returnbuff = new StringBuilder(16384); + +SafeNativeMethods.mwle_fn_getFormatExtensions(returnbuff); +return returnbuff.ToString(); + +} +/// +/// Returns a list of supported shape formats in filter form. +/// Example output: DSQ Files|*.dsq|COLLADA Files|*.dae|) +/// +/// + +public string fn_getFormatFilters () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_getFormatFilters'"); + +var returnbuff = new StringBuilder(16384); + +SafeNativeMethods.mwle_fn_getFormatFilters(returnbuff); +return returnbuff.ToString(); + } /// /// @brief .) +/// /// public string fn_getFrustumOffset () @@ -4216,7 +5654,12 @@ public string fn_getFrustumOffset () } /// -/// (string funcName) @brief Provides the name of the package the function belongs to @param funcName String containing name of the function @return The name of the function's package @ingroup Packages) +/// (string funcName) +/// @brief Provides the name of the package the function belongs to +/// @param funcName String containing name of the function +/// @return The name of the function's package +/// @ingroup Packages) +/// /// public string fn_getFunctionPackage (string funcName) @@ -4234,6 +5677,7 @@ public string fn_getFunctionPackage (string funcName) } /// /// getJoystickAxes( instance )) +/// /// public string fn_getJoystickAxes (uint deviceID) @@ -4247,7 +5691,9 @@ public string fn_getJoystickAxes (uint deviceID) } /// -/// Returns a tab seperated list of light manager names. @ingroup Lighting ) +/// Returns a tab seperated list of light manager names. +/// @ingroup Lighting ) +/// /// public string fn_getLightManagerNames () @@ -4262,7 +5708,13 @@ public string fn_getLightManagerNames () } /// -/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. This directory will usually contain all the game assets and, in a user-side game installation, will usually be read-only. @return The path to the main game assets. @ingroup FileSystem) +/// @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started. +/// +/// This directory will usually contain all the game assets and, in a user-side game installation, will usually be +/// read-only. +/// @return The path to the main game assets. +/// @ingroup FileSystem) +/// /// public string fn_getMainDotCsDir () @@ -4278,6 +5730,7 @@ public string fn_getMainDotCsDir () } /// /// @hide) +/// /// public string fn_getMapEntry (string texName) @@ -4294,7 +5747,12 @@ public string fn_getMapEntry (string texName) } /// -/// (string texName) @brief Returns the name of the material mapped to this texture. If no materials are found, an empty string is returned. @param texName Name of the texture @ingroup Materials) +/// (string texName) +/// @brief Returns the name of the material mapped to this texture. +/// If no materials are found, an empty string is returned. +/// @param texName Name of the texture +/// @ingroup Materials) +/// /// public string fn_getMaterialMapping (string texName) @@ -4311,7 +5769,12 @@ public string fn_getMaterialMapping (string texName) } /// -/// Calculate the greater of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The greater value of the two specified values. @ingroup Math ) +/// Calculate the greater of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The greater value of the two specified values. +/// @ingroup Math ) +/// /// public float fn_getMax (float v1, float v2) @@ -4323,6 +5786,7 @@ public float fn_getMax (float v1, float v2) } /// /// getMaxFrameAllocation(); ) +/// /// public int fn_getMaxFrameAllocation () @@ -4334,7 +5798,13 @@ public int fn_getMaxFrameAllocation () return SafeNativeMethods.mwle_fn_getMaxFrameAllocation(); } /// -/// (string namespace, string method) @brief Provides the name of the package the method belongs to @param namespace Class or namespace, such as Player @param method Name of the funciton to search for @return The name of the method's package @ingroup Packages) +/// (string namespace, string method) +/// @brief Provides the name of the package the method belongs to +/// @param namespace Class or namespace, such as Player +/// @param method Name of the funciton to search for +/// @return The name of the method's package +/// @ingroup Packages) +/// /// public string fn_getMethodPackage (string nameSpace, string method) @@ -4354,7 +5824,12 @@ public string fn_getMethodPackage (string nameSpace, string method) } /// -/// Calculate the lesser of two specified numbers. @param v1 Input value. @param v2 Input value. @returns The lesser value of the two specified values. @ingroup Math ) +/// Calculate the lesser of two specified numbers. +/// @param v1 Input value. +/// @param v2 Input value. +/// @returns The lesser value of the two specified values. +/// @ingroup Math ) +/// /// public float fn_getMin (float v1, float v2) @@ -4365,7 +5840,9 @@ public float fn_getMin (float v1, float v2) return SafeNativeMethods.mwle_fn_getMin(v1, v2); } /// -/// Get the MissionArea object, if any. @ingroup enviroMisc) +/// Get the MissionArea object, if any. +/// @ingroup enviroMisc) +/// /// public string fn_getMissionAreaServerObject () @@ -4380,7 +5857,12 @@ public string fn_getMissionAreaServerObject () } /// -/// (string path) @brief Attempts to extract a mod directory from path. Returns empty string on failure. @param File path of mod folder @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated @internal) +/// (string path) +/// @brief Attempts to extract a mod directory from path. Returns empty string on failure. +/// @param File path of mod folder +/// @note This is no longer relevant in Torque 3D (which does not use mod folders), should be deprecated +/// @internal) +/// /// public string fn_getModNameFromPath (string path) @@ -4427,7 +5909,9 @@ public string fn_getPackageList () } /// -/// Returns the pixel shader version for the active device. @ingroup GFX ) +/// Returns the pixel shader version for the active device. +/// @ingroup GFX ) +/// /// public float fn_getPixelShaderVersion () @@ -4439,7 +5923,10 @@ public float fn_getPixelShaderVersion () return SafeNativeMethods.mwle_fn_getPixelShaderVersion(); } /// -/// ([relativeFileName]) @note Appears to be useless in Torque 3D, should be deprecated @internal) +/// ([relativeFileName]) +/// @note Appears to be useless in Torque 3D, should be deprecated +/// @internal) +/// /// public string fn_getPrefsPath (string relativeFileName) @@ -4456,7 +5943,19 @@ public string fn_getPrefsPath (string relativeFileName) } /// -/// ( int a, int b ) @brief Returns a random number based on parameters passed in.. If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will return an integer between the specified numbers. @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. @param b Upper bound on the random number. The random number will be = @a b. @return A pseudo-random integer between @a a and @a b, between 0 and a, or a float between 0.0 and 1.1 depending on usage. @note All parameters are optional. @see setRandomSeed @ingroup Random ) +/// ( int a, int b ) +/// @brief Returns a random number based on parameters passed in.. +/// If no parameters are passed in, getRandom() will return a float between 0.0 and 1.0. If one +/// parameter is passed an integer between 0 and the passed in value will be returned. Two parameters will +/// return an integer between the specified numbers. +/// @param a If this is the only parameter, a number between 0 and a is returned. Elsewise represents the lower bound. +/// @param b Upper bound on the random number. The random number will be = @a b. +/// @return A pseudo-random integer between @a a and @a b, between 0 and a, or a +/// float between 0.0 and 1.1 depending on usage. +/// @note All parameters are optional. +/// @see setRandomSeed +/// @ingroup Random ) +/// /// public float fn_getRandom (int a, int b) @@ -4467,7 +5966,10 @@ public float fn_getRandom (int a, int b) return SafeNativeMethods.mwle_fn_getRandom(a, b); } /// -/// Get the current seed used by the random number generator. @return The current random number generator seed value. @ingroup Random ) +/// Get the current seed used by the random number generator. +/// @return The current random number generator seed value. +/// @ingroup Random ) +/// /// public int fn_getRandomSeed () @@ -4479,7 +5981,11 @@ public int fn_getRandomSeed () return SafeNativeMethods.mwle_fn_getRandomSeed(); } /// -/// () @brief Return the current real time in milliseconds. Real time is platform defined; typically time since the computer booted. @ingroup Platform) +/// () +/// @brief Return the current real time in milliseconds. +/// Real time is platform defined; typically time since the computer booted. +/// @ingroup Platform) +/// /// public int fn_getRealTime () @@ -4491,7 +5997,20 @@ public int fn_getRealTime () return SafeNativeMethods.mwle_fn_getRealTime(); } /// -/// Extract the record at the given @a index in the newline-separated list in @a text. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to extract. @return The record at the given index or \"\" if @a index is out of range. @tsexample getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" @endtsexample @see getRecords @see getRecordCount @see getWord @see getField @ingroup FieldManip ) +/// Extract the record at the given @a index in the newline-separated list in @a text. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to extract. +/// @return The record at the given index or \"\" if @a index is out of range. +/// @tsexample +/// getRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" +/// @endtsexample +/// @see getRecords +/// @see getRecordCount +/// @see getWord +/// @see getField +/// @ingroup FieldManip ) +/// /// public string fn_getRecord (string text, int index) @@ -4508,7 +6027,16 @@ public string fn_getRecord (string text, int index) } /// -/// Return the number of newline-separated records in @a text. @param text A list of records separated by newlines. @return The number of newline-sepearated elements in @a text. @tsexample getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 @endtsexample @see getWordCount @see getFieldCount @ingroup FieldManip ) +/// Return the number of newline-separated records in @a text. +/// @param text A list of records separated by newlines. +/// @return The number of newline-sepearated elements in @a text. +/// @tsexample +/// getRecordCount( \"a b\" NL \"c d\" NL \"e f\" ) // Returns 3 +/// @endtsexample +/// @see getWordCount +/// @see getFieldCount +/// @ingroup FieldManip ) +/// /// public int fn_getRecordCount (string text) @@ -4522,7 +6050,23 @@ public int fn_getRecordCount (string text) return SafeNativeMethods.mwle_fn_getRecordCount(sbtext); } /// -/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param startIndex The zero-based index of the first record to extract from @a text. @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of records from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" @endtsexample @see getRecord @see getRecordCount @see getWords @see getFields @ingroup FieldManip ) +/// Extract a range of records from the given @a startIndex onwards thru @a endIndex. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param startIndex The zero-based index of the first record to extract from @a text. +/// @param endIndex The zero-based index of the last record to extract from @a text. If this is -1, all records beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of records from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getRecords( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"c d\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see getRecordCount +/// @see getWords +/// @see getFields +/// @ingroup FieldManip ) +/// /// public string fn_getRecords (string text, int startIndex, int endIndex) @@ -4540,6 +6084,7 @@ public string fn_getRecords (string text, int startIndex, int endIndex) } /// /// getScheduleDuration(%scheduleId); ) +/// /// public int fn_getScheduleDuration (int scheduleId) @@ -4551,6 +6096,7 @@ public int fn_getScheduleDuration (int scheduleId) } /// /// getServerCount(...); ) +/// /// public int fn_getServerCount () @@ -4562,7 +6108,11 @@ public int fn_getServerCount () return SafeNativeMethods.mwle_fn_getServerCount(); } /// -/// () Return the current sim time in milliseconds. @brief Sim time is time since the game started. @ingroup Platform) +/// () +/// Return the current sim time in milliseconds. +/// @brief Sim time is time since the game started. +/// @ingroup Platform) +/// /// public int fn_getSimTime () @@ -4574,7 +6124,19 @@ public int fn_getSimTime () return SafeNativeMethods.mwle_fn_getSimTime(); } /// -/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source string length). @param str The string from which to extract a substring. @param start The offset at which to start copying out characters. @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end of the input string are copied. @return A string that contains the given portion of the input string. @tsexample getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". @endtsexample @ingroup Strings ) +/// @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str +/// (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source +/// string length). +/// @param str The string from which to extract a substring. +/// @param start The offset at which to start copying out characters. +/// @param numChars Optional argument to specify the number of characters to copy. If this is -1, all characters up the end +/// of the input string are copied. +/// @return A string that contains the given portion of the input string. +/// @tsexample +/// getSubStr( \"foobar\", 1, 2 ) // Returns \"oo\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_getSubStr (string str, int start, int numChars) @@ -4591,7 +6153,20 @@ public string fn_getSubStr (string str, int start, int numChars) } /// -/// ( string textTagString ) @brief Extracts the tag from a tagged string Should only be used within the context of a function that receives a tagged string, and is not meant to be used outside of this context. @param textTagString The tagged string to extract. @returns The tag ID of the string. @see \\ref syntaxDataTypes under Tagged %Strings @see detag() @ingroup Networking) +/// ( string textTagString ) +/// @brief Extracts the tag from a tagged string +/// +/// Should only be used within the context of a function that receives a tagged +/// string, and is not meant to be used outside of this context. +/// +/// @param textTagString The tagged string to extract. +/// +/// @returns The tag ID of the string. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see detag() +/// @ingroup Networking) +/// /// public string fn_getTag (string textTagString) @@ -4608,7 +6183,22 @@ public string fn_getTag (string textTagString) } /// -/// ), @brief Use the getTaggedString function to convert a tag to a string. This is not the same as detag() which can only be used within the context of a function that receives a tag. This function can be used any time and anywhere to convert a tag to a string. @param tag A numeric tag ID. @returns The string as found in the Net String table. @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see removeTaggedString() @ingroup Networking) +/// ), +/// @brief Use the getTaggedString function to convert a tag to a string. +/// +/// This is not the same as detag() which can only be used within the context +/// of a function that receives a tag. This function can be used any time and +/// anywhere to convert a tag to a string. +/// +/// @param tag A numeric tag ID. +/// +/// @returns The string as found in the Net String table. +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see removeTaggedString() +/// @ingroup Networking) +/// /// public string fn_getTaggedString (string tag) @@ -4625,7 +6215,16 @@ public string fn_getTaggedString (string tag) } /// -/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example @note This can be useful to adhering to OS standards and practices, but not really used in Torque 3D right now. @note Be very careful when getting into OS level File I/O. @return String containing path to OS temp directory @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example +/// @note This can be useful to adhering to OS standards and practices, +/// but not really used in Torque 3D right now. +/// @note Be very careful when getting into OS level File I/O. +/// @return String containing path to OS temp directory +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string fn_getTemporaryDirectory () @@ -4640,7 +6239,14 @@ public string fn_getTemporaryDirectory () } /// -/// @brief Creates a name and extension for a potential temporary file This does not create the actual file. It simply creates a random name for a file that does not exist. @note This is legacy function brought over from TGB, and does not appear to have much use. Possibly deprecate? @ingroup FileSystem @internal) +/// @brief Creates a name and extension for a potential temporary file +/// This does not create the actual file. It simply creates a random name +/// for a file that does not exist. +/// @note This is legacy function brought over from TGB, and does not appear +/// to have much use. Possibly deprecate? +/// @ingroup FileSystem +/// @internal) +/// /// public string fn_getTemporaryFileName () @@ -4655,7 +6261,11 @@ public string fn_getTemporaryFileName () } /// -/// (Point2 pos) - gets the terrain height at the specified position. @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point2 pos) - gets the terrain height at the specified position. +/// @param pos The world space point, minus the z (height) value Can be formatted as either (\"x y\") or (x,y) +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float fn_getTerrainHeight (string pos) @@ -4669,7 +6279,12 @@ public float fn_getTerrainHeight (string pos) return SafeNativeMethods.mwle_fn_getTerrainHeight(sbpos); } /// -/// (Point3F pos) - gets the terrain height at the specified position. @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) @note This function is useful if you simply want to grab the terrain height underneath an object. @return Returns the terrain height at the given point as an F32 value. @hide) +/// (Point3F pos) - gets the terrain height at the specified position. +/// @param pos The world space point. Can be formatted as either (\"x y z\") or (x,y,z) +/// @note This function is useful if you simply want to grab the terrain height underneath an object. +/// @return Returns the terrain height at the given point as an F32 value. +/// @hide) +/// /// public float fn_getTerrainHeightBelowPosition (string pos) @@ -4683,7 +6298,12 @@ public float fn_getTerrainHeightBelowPosition (string pos) return SafeNativeMethods.mwle_fn_getTerrainHeightBelowPosition(sbpos); } /// -/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found). @hide) +/// (Point3F x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found). +/// @hide) +/// /// public int fn_getTerrainUnderWorldPoint (string position) @@ -4697,7 +6317,9 @@ public int fn_getTerrainUnderWorldPoint (string position) return SafeNativeMethods.mwle_fn_getTerrainUnderWorldPoint(sbposition); } /// -/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB @ingroup GFX ) +/// Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB +/// @ingroup GFX ) +/// /// public string fn_getTextureProfileStats () @@ -4713,6 +6335,7 @@ public string fn_getTextureProfileStats () } /// /// getTimeSinceStart(%scheduleId); ) +/// /// public int fn_getTimeSinceStart (int scheduleId) @@ -4723,7 +6346,15 @@ public int fn_getTimeSinceStart (int scheduleId) return SafeNativeMethods.mwle_fn_getTimeSinceStart(scheduleId); } /// -/// Get the numeric suffix of the given input string. @param str The string from which to read out the numeric suffix. @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. @tsexample getTrailingNumber( \"test123\" ) // Returns '123'. @endtsexample @see stripTrailingNumber @ingroup Strings ) +/// Get the numeric suffix of the given input string. +/// @param str The string from which to read out the numeric suffix. +/// @return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix. +/// @tsexample +/// getTrailingNumber( \"test123\" ) // Returns '123'. +/// @endtsexample +/// @see stripTrailingNumber +/// @ingroup Strings ) +/// /// public int fn_getTrailingNumber (string str) @@ -4737,7 +6368,12 @@ public int fn_getTrailingNumber (string str) return SafeNativeMethods.mwle_fn_getTrailingNumber(sbstr); } /// -/// ( String baseName, SimSet set, bool searchChildren ) @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName, SimSet set, bool searchChildren ) +/// @brief Returns a unique unused internal name within the SimSet/Group based on a given base name. +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string fn_getUniqueInternalName (string baseName, string setString, bool searchChildren) @@ -4757,7 +6393,13 @@ public string fn_getUniqueInternalName (string baseName, string setString, bool } /// -/// ( String baseName ) @brief Returns a unique unused SimObject name based on a given base name. @baseName Name to conver to a unique string if another instance exists @note Currently only used by editors @ingroup Editors @internal) +/// ( String baseName ) +/// @brief Returns a unique unused SimObject name based on a given base name. +/// @baseName Name to conver to a unique string if another instance exists +/// @note Currently only used by editors +/// @ingroup Editors +/// @internal) +/// /// public string fn_getUniqueName (string baseName) @@ -4775,6 +6417,7 @@ public string fn_getUniqueName (string baseName) } /// /// getUserDataDirectory()) +/// /// public string fn_getUserDataDirectory () @@ -4790,6 +6433,7 @@ public string fn_getUserDataDirectory () } /// /// getUserHomeDirectory()) +/// /// public string fn_getUserHomeDirectory () @@ -4804,7 +6448,12 @@ public string fn_getUserHomeDirectory () } /// -/// (string varName) @brief Returns the value of the named variable or an empty string if not found. @varName Name of the variable to search for @return Value contained by varName, \"\" if the variable does not exist @ingroup Scripting) +/// (string varName) +/// @brief Returns the value of the named variable or an empty string if not found. +/// @varName Name of the variable to search for +/// @return Value contained by varName, \"\" if the variable does not exist +/// @ingroup Scripting) +/// /// public string fn_getVariable (string varName) @@ -4821,7 +6470,9 @@ public string fn_getVariable (string varName) } /// -/// Get the version of the engine build, as a string. @ingroup Debugging) +/// Get the version of the engine build, as a string. +/// @ingroup Debugging) +/// /// public int fn_getVersionNumber () @@ -4833,7 +6484,9 @@ public int fn_getVersionNumber () return SafeNativeMethods.mwle_fn_getVersionNumber(); } /// -/// Get the version of the engine build, as a human readable string. @ingroup Debugging) +/// Get the version of the engine build, as a human readable string. +/// @ingroup Debugging) +/// /// public string fn_getVersionString () @@ -4848,7 +6501,12 @@ public string fn_getVersionString () } /// -/// Test whether Torque is running in web-deployment mode. In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not be able to enter fullscreen exclusive mode). @return True if Torque is running in web-deployment mode. @ingroup Platform ) +/// Test whether Torque is running in web-deployment mode. +/// In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not +/// be able to enter fullscreen exclusive mode). +/// @return True if Torque is running in web-deployment mode. +/// @ingroup Platform ) +/// /// public bool fn_getWebDeployment () @@ -4860,7 +6518,20 @@ public bool fn_getWebDeployment () return SafeNativeMethods.mwle_fn_getWebDeployment()>=1; } /// -/// Extract the word at the given @a index in the whitespace-separated list in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to extract. @return The word at the given index or \"\" if the index is out of range. @tsexample getWord( \"a b c\", 1 ) // Returns \"b\" @endtsexample @see getWords @see getWordCount @see getField @see getRecord @ingroup FieldManip ) +/// Extract the word at the given @a index in the whitespace-separated list in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to extract. +/// @return The word at the given index or \"\" if the index is out of range. +/// @tsexample +/// getWord( \"a b c\", 1 ) // Returns \"b\" +/// @endtsexample +/// @see getWords +/// @see getWordCount +/// @see getField +/// @see getRecord +/// @ingroup FieldManip ) +/// /// public string fn_getWord (string text, int index) @@ -4877,7 +6548,17 @@ public string fn_getWord (string text, int index) } /// -/// Return the number of whitespace-separated words in @a text. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @return The number of whitespace-separated words in @a text. @tsexample getWordCount( \"a b c d e\" ) // Returns 5 @endtsexample @see getFieldCount @see getRecordCount @ingroup FieldManip ) +/// Return the number of whitespace-separated words in @a text. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @return The number of whitespace-separated words in @a text. +/// @tsexample +/// getWordCount( \"a b c d e\" ) // Returns 5 +/// @endtsexample +/// @see getFieldCount +/// @see getRecordCount +/// @ingroup FieldManip ) +/// /// public int fn_getWordCount (string text) @@ -4891,7 +6572,23 @@ public int fn_getWordCount (string text) return SafeNativeMethods.mwle_fn_getWordCount(sbtext); } /// -/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param startIndex The zero-based index of the first word to extract from @a text. @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning with @a startIndex are extracted from @a text. @return A string containing the specified range of words from @a text or \"\" if @a startIndex is out of range or greater than @a endIndex. @tsexample getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" @endtsexample @see getWord @see getWordCount @see getFields @see getRecords @ingroup FieldManip ) +/// Extract a range of words from the given @a startIndex onwards thru @a endIndex. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param startIndex The zero-based index of the first word to extract from @a text. +/// @param endIndex The zero-based index of the last word to extract from @a text. If this is -1, all words beginning +/// with @a startIndex are extracted from @a text. +/// @return A string containing the specified range of words from @a text or \"\" if @a startIndex +/// is out of range or greater than @a endIndex. +/// @tsexample +/// getWords( \"a b c d\", 1, 2, ) // Returns \"b c\" +/// @endtsexample +/// @see getWord +/// @see getWordCount +/// @see getFields +/// @see getRecords +/// @ingroup FieldManip ) +/// /// public string fn_getWords (string text, int startIndex, int endIndex) @@ -4908,7 +6605,11 @@ public string fn_getWords (string text, int startIndex, int endIndex) } /// -/// @brief Reports the current directory @return String containing full file path of working directory @ingroup FileSystem) +/// @brief Reports the current directory +/// +/// @return String containing full file path of working directory +/// @ingroup FileSystem) +/// /// public string fn_getWorkingDirectory () @@ -4923,7 +6624,25 @@ public string fn_getWorkingDirectory () } /// -/// ( int controllerID, string property, bool currentD ) @brief Queries the current state of a connected Xbox 360 controller. XInput Properties: - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. - XI_START, XI_BACK - The Start and Back buttons. - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. @param controllerID Zero-based index of the controller to return information about. @param property Name of input action being queried, such as \"XI_THUMBLX\". @param current True checks current device in action. @return Button queried - 1 if the button is pressed, 0 if it's not. @return Thumbstick queried - Int representing displacement from rest position. @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. @ingroup Input) +/// ( int controllerID, string property, bool currentD ) +/// @brief Queries the current state of a connected Xbox 360 controller. +/// XInput Properties: +/// - XI_THUMBLX, XI_THUMBLY - X and Y axes of the left thumbstick. +/// - XI_THUMBRX, XI_THUMBRY - X and Y axes of the right thumbstick. +/// - XI_LEFT_TRIGGER, XI_RIGHT_TRIGGER - Left and Right triggers. +/// - SI_UPOV, SI_DPOV, SI_LPOV, SI_RPOV - Up, Down, Left, and Right on the directional pad. +/// - XI_START, XI_BACK - The Start and Back buttons. +/// - XI_LEFT_THUMB, XI_RIGHT_THUMB - Clicking in the left and right thumbstick. +/// - XI_LEFT_SHOULDER, XI_RIGHT_SHOULDER - Left and Right bumpers. +/// - XI_A, XI_B , XI_X, XI_Y - The A, B, X, and Y buttons. +/// @param controllerID Zero-based index of the controller to return information about. +/// @param property Name of input action being queried, such as \"XI_THUMBLX\". +/// @param current True checks current device in action. +/// @return Button queried - 1 if the button is pressed, 0 if it's not. +/// @return Thumbstick queried - Int representing displacement from rest position. +/// @return %Trigger queried - Int from 0 to 255 representing how far the trigger is displaced. +/// @ingroup Input) +/// /// public int fn_getXInputState (int controllerID, string properties, bool current) @@ -4937,7 +6656,15 @@ public int fn_getXInputState (int controllerID, string properties, bool current) return SafeNativeMethods.mwle_fn_getXInputState(controllerID, sbproperties, current); } /// -/// Open the given URL or file in the user's web browser. @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then the function checks whether the address refers to a file or directory and if so, prepends \"file://\" to @a adress; if the file check fails, \"http://\" is prepended to @a address. @tsexample gotoWebPage( \"http://www.garagegames.com\" ); @endtsexample @ingroup Platform ) +/// Open the given URL or file in the user's web browser. +/// @param address The address to open. If this is not prefixed by a protocol specifier (\"...://\"), then +/// the function checks whether the address refers to a file or directory and if so, prepends \"file://\" +/// to @a adress; if the file check fails, \"http://\" is prepended to @a address. +/// @tsexample +/// gotoWebPage( \"http://www.garagegames.com\" ); +/// @endtsexample +/// @ingroup Platform ) +/// /// public void fn_gotoWebPage (string address) @@ -4951,7 +6678,9 @@ public void fn_gotoWebPage (string address) SafeNativeMethods.mwle_fn_gotoWebPage(sbaddress); } /// -/// ( String filename | String filename, bool resize ) Assign an image to the control. @hide ) +/// ( String filename | String filename, bool resize ) Assign an image to the control. +/// @hide ) +/// /// public void fn_GuiBitmapCtrl_setBitmap (string guibitmapctrl, string fileRoot, bool resize) @@ -4969,6 +6698,7 @@ public void fn_GuiBitmapCtrl_setBitmap (string guibitmapctrl, string fileRoot, b } /// /// () - Is this canvas currently fullscreen? ) +/// /// public bool fn_GuiCanvas_isFullscreen (string guicanvas) @@ -4983,6 +6713,7 @@ public bool fn_GuiCanvas_isFullscreen (string guicanvas) } /// /// () ) +/// /// public bool fn_GuiCanvas_isMaximized (string guicanvas) @@ -4997,6 +6728,7 @@ public bool fn_GuiCanvas_isMaximized (string guicanvas) } /// /// () ) +/// /// public bool fn_GuiCanvas_isMinimized (string guicanvas) @@ -5011,6 +6743,7 @@ public bool fn_GuiCanvas_isMinimized (string guicanvas) } /// /// () - maximize this canvas' window. ) +/// /// public void fn_GuiCanvas_maximizeWindow (string guicanvas) @@ -5025,6 +6758,7 @@ public void fn_GuiCanvas_maximizeWindow (string guicanvas) } /// /// () - minimize this canvas' window. ) +/// /// public void fn_GuiCanvas_minimizeWindow (string guicanvas) @@ -5038,7 +6772,9 @@ public void fn_GuiCanvas_minimizeWindow (string guicanvas) SafeNativeMethods.mwle_fn_GuiCanvas_minimizeWindow(sbguicanvas); } /// -/// (GuiControl ctrl=NULL) @hide) +/// (GuiControl ctrl=NULL) +/// @hide) +/// /// public void fn_GuiCanvas_popDialog (string guicanvas, string gui) @@ -5055,7 +6791,9 @@ public void fn_GuiCanvas_popDialog (string guicanvas, string gui) SafeNativeMethods.mwle_fn_GuiCanvas_popDialog(sbguicanvas, sbgui); } /// -/// (int layer) @hide) +/// (int layer) +/// @hide) +/// /// public void fn_GuiCanvas_popLayer (string guicanvas, int layer) @@ -5069,7 +6807,9 @@ public void fn_GuiCanvas_popLayer (string guicanvas, int layer) SafeNativeMethods.mwle_fn_GuiCanvas_popLayer(sbguicanvas, layer); } /// -/// (GuiControl ctrl, int layer=0, bool center=false) @hide) +/// (GuiControl ctrl, int layer=0, bool center=false) +/// @hide) +/// /// public void fn_GuiCanvas_pushDialog (string guicanvas, string ctrlName, int layer, bool center) @@ -5087,6 +6827,7 @@ public void fn_GuiCanvas_pushDialog (string guicanvas, string ctrlName, int laye } /// /// () - restore this canvas' window. ) +/// /// public void fn_GuiCanvas_restoreWindow (string guicanvas) @@ -5100,7 +6841,9 @@ public void fn_GuiCanvas_restoreWindow (string guicanvas) SafeNativeMethods.mwle_fn_GuiCanvas_restoreWindow(sbguicanvas); } /// -/// (Point2I pos) @hide) +/// (Point2I pos) +/// @hide) +/// /// public void fn_GuiCanvas_setCursorPos (string guicanvas, string pos) @@ -5118,6 +6861,7 @@ public void fn_GuiCanvas_setCursorPos (string guicanvas, string pos) } /// /// () - Claim OS input focus for this canvas' window.) +/// /// public void fn_GuiCanvas_setFocus (string guicanvas) @@ -5131,7 +6875,15 @@ public void fn_GuiCanvas_setFocus (string guicanvas) SafeNativeMethods.mwle_fn_GuiCanvas_setFocus(sbguicanvas); } /// -/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. \\param width The screen width to set. \\param height The screen height to set. \\param fullscreen Specify true to run fullscreen or false to run in a window \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// (int width, int height, bool fullscreen, [int bitDepth], [int refreshRate], [int antialiasLevel] ) +/// Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values. +/// \\param width The screen width to set. +/// \\param height The screen height to set. +/// \\param fullscreen Specify true to run fullscreen or false to run in a window +/// \\param bitDepth [optional] The desired bit-depth. Defaults to the current setting. This parameter is ignored if you are running in a window. +/// \\param refreshRate [optional] The desired refresh rate. Defaults to the current setting. This parameter is ignored if you are running in a window +/// \\param antialiasLevel [optional] The level of anti-aliasing to apply 0 = none ) +/// /// public void fn_GuiCanvas_setVideoMode (string guicanvas, uint width, uint height, bool fullscreen, uint bitDepth, uint refreshRate, uint antialiasLevel) @@ -5146,6 +6898,7 @@ public void fn_GuiCanvas_setVideoMode (string guicanvas, uint width, uint height } /// /// Gets the current position of the selector) +/// /// public string fn_GuiColorPickerCtrl_getSelectorPos (string guicolorpickerctrl) @@ -5163,6 +6916,7 @@ public string fn_GuiColorPickerCtrl_getSelectorPos (string guicolorpickerctrl) } /// /// Sets the current position of the selector) +/// /// public void fn_GuiColorPickerCtrl_setSelectorPos (string guicolorpickerctrl, string newPos) @@ -5180,6 +6934,7 @@ public void fn_GuiColorPickerCtrl_setSelectorPos (string guicolorpickerctrl, str } /// /// Forces update of pick color) +/// /// public void fn_GuiColorPickerCtrl_updateColor (string guicolorpickerctrl) @@ -5194,6 +6949,7 @@ public void fn_GuiColorPickerCtrl_updateColor (string guicolorpickerctrl) } /// /// ) +/// /// public string fn_GuiControl_getBounds (string guicontrol) @@ -5211,6 +6967,7 @@ public string fn_GuiControl_getBounds (string guicontrol) } /// /// ) +/// /// public string fn_GuiControl_getValue (string guicontrol) @@ -5228,6 +6985,7 @@ public string fn_GuiControl_getValue (string guicontrol) } /// /// ) +/// /// public bool fn_GuiControl_isActive (string guicontrol) @@ -5242,6 +7000,7 @@ public bool fn_GuiControl_isActive (string guicontrol) } /// /// (bool isFirst)) +/// /// public void fn_GuiControl_makeFirstResponder (string guicontrol, bool isFirst) @@ -5255,7 +7014,9 @@ public void fn_GuiControl_makeFirstResponder (string guicontrol, bool isFirst) SafeNativeMethods.mwle_fn_GuiControl_makeFirstResponder(sbguicontrol, isFirst); } /// -/// Set the width and height of the control. @hide ) +/// Set the width and height of the control. +/// @hide ) +/// /// public void fn_GuiControl_setExtent (string guicontrol, string ext) @@ -5273,6 +7034,7 @@ public void fn_GuiControl_setExtent (string guicontrol, string ext) } /// /// ( pString ) ) +/// /// public int fn_GuiControlProfile_getStringWidth (string guicontrolprofile, string pString) @@ -5290,6 +7052,7 @@ public int fn_GuiControlProfile_getStringWidth (string guicontrolprofile, string } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_dropSelectionAtScreenCenter (string guiconvexeditorctrl) @@ -5304,6 +7067,7 @@ public void fn_GuiConvexEditorCtrl_dropSelectionAtScreenCenter (string guiconvex } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_handleDelete (string guiconvexeditorctrl) @@ -5318,6 +7082,7 @@ public void fn_GuiConvexEditorCtrl_handleDelete (string guiconvexeditorctrl) } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_handleDeselect (string guiconvexeditorctrl) @@ -5332,6 +7097,7 @@ public void fn_GuiConvexEditorCtrl_handleDeselect (string guiconvexeditorctrl) } /// /// ) +/// /// public int fn_GuiConvexEditorCtrl_hasSelection (string guiconvexeditorctrl) @@ -5346,6 +7112,7 @@ public int fn_GuiConvexEditorCtrl_hasSelection (string guiconvexeditorctrl) } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_hollowSelection (string guiconvexeditorctrl) @@ -5360,6 +7127,7 @@ public void fn_GuiConvexEditorCtrl_hollowSelection (string guiconvexeditorctrl) } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_recenterSelection (string guiconvexeditorctrl) @@ -5374,6 +7142,7 @@ public void fn_GuiConvexEditorCtrl_recenterSelection (string guiconvexeditorctrl } /// /// ( ConvexShape ) ) +/// /// public void fn_GuiConvexEditorCtrl_selectConvex (string guiconvexeditorctrl, string convex) @@ -5391,6 +7160,7 @@ public void fn_GuiConvexEditorCtrl_selectConvex (string guiconvexeditorctrl, str } /// /// ) +/// /// public void fn_GuiConvexEditorCtrl_splitSelectedFace (string guiconvexeditorctrl) @@ -5405,6 +7175,7 @@ public void fn_GuiConvexEditorCtrl_splitSelectedFace (string guiconvexeditorctrl } /// /// deleteSelectedDecalDatablock( String datablock ) ) +/// /// public void fn_GuiDecalEditorCtrl_deleteDecalDatablock (string guidecaleditorctrl, string datablock) @@ -5422,6 +7193,7 @@ public void fn_GuiDecalEditorCtrl_deleteDecalDatablock (string guidecaleditorctr } /// /// deleteSelectedDecal() ) +/// /// public void fn_GuiDecalEditorCtrl_deleteSelectedDecal (string guidecaleditorctrl) @@ -5436,6 +7208,7 @@ public void fn_GuiDecalEditorCtrl_deleteSelectedDecal (string guidecaleditorctrl } /// /// editDecalDetails( S32 )() ) +/// /// public void fn_GuiDecalEditorCtrl_editDecalDetails (string guidecaleditorctrl, uint id, string pos, string tan, float size) @@ -5456,6 +7229,7 @@ public void fn_GuiDecalEditorCtrl_editDecalDetails (string guidecaleditorctrl, u } /// /// getDecalCount() ) +/// /// public int fn_GuiDecalEditorCtrl_getDecalCount (string guidecaleditorctrl) @@ -5470,6 +7244,7 @@ public int fn_GuiDecalEditorCtrl_getDecalCount (string guidecaleditorctrl) } /// /// getDecalLookupName( S32 )() ) +/// /// public string fn_GuiDecalEditorCtrl_getDecalLookupName (string guidecaleditorctrl, uint id) @@ -5487,6 +7262,7 @@ public string fn_GuiDecalEditorCtrl_getDecalLookupName (string guidecaleditorctr } /// /// getDecalTransform() ) +/// /// public string fn_GuiDecalEditorCtrl_getDecalTransform (string guidecaleditorctrl, uint id) @@ -5504,6 +7280,7 @@ public string fn_GuiDecalEditorCtrl_getDecalTransform (string guidecaleditorctrl } /// /// getMode() ) +/// /// public string fn_GuiDecalEditorCtrl_getMode (string guidecaleditorctrl) @@ -5521,6 +7298,7 @@ public string fn_GuiDecalEditorCtrl_getMode (string guidecaleditorctrl) } /// /// ) +/// /// public int fn_GuiDecalEditorCtrl_getSelectionCount (string guidecaleditorctrl) @@ -5535,6 +7313,7 @@ public int fn_GuiDecalEditorCtrl_getSelectionCount (string guidecaleditorctrl) } /// /// ) +/// /// public void fn_GuiDecalEditorCtrl_retargetDecalDatablock (string guidecaleditorctrl, string dbFrom, string dbTo) @@ -5555,6 +7334,7 @@ public void fn_GuiDecalEditorCtrl_retargetDecalDatablock (string guidecaleditorc } /// /// selectDecal( S32 )() ) +/// /// public void fn_GuiDecalEditorCtrl_selectDecal (string guidecaleditorctrl, uint id) @@ -5569,6 +7349,7 @@ public void fn_GuiDecalEditorCtrl_selectDecal (string guidecaleditorctrl, uint i } /// /// setMode( String mode )() ) +/// /// public void fn_GuiDecalEditorCtrl_setMode (string guidecaleditorctrl, string newMode) @@ -5586,6 +7367,7 @@ public void fn_GuiDecalEditorCtrl_setMode (string guidecaleditorctrl, string new } /// /// (GuiControl ctrl)) +/// /// public void fn_GuiEditCtrl_addNewCtrl (string guieditctrl, string ctrl) @@ -5603,6 +7385,7 @@ public void fn_GuiEditCtrl_addNewCtrl (string guieditctrl, string ctrl) } /// /// selects a control.) +/// /// public void fn_GuiEditCtrl_addSelection (string guieditctrl, int id) @@ -5617,6 +7400,7 @@ public void fn_GuiEditCtrl_addSelection (string guieditctrl, int id) } /// /// ) +/// /// public void fn_GuiEditCtrl_bringToFront (string guieditctrl) @@ -5631,6 +7415,7 @@ public void fn_GuiEditCtrl_bringToFront (string guieditctrl) } /// /// ( [ int axis ] ) - Clear all currently set guide lines. ) +/// /// public void fn_GuiEditCtrl_clearGuides (string guieditctrl, int axis) @@ -5645,6 +7430,7 @@ public void fn_GuiEditCtrl_clearGuides (string guieditctrl, int axis) } /// /// Clear selected controls list.) +/// /// public void fn_GuiEditCtrl_clearSelection (string guieditctrl) @@ -5659,6 +7445,7 @@ public void fn_GuiEditCtrl_clearSelection (string guieditctrl) } /// /// () - Delete the selected controls.) +/// /// public void fn_GuiEditCtrl_deleteSelection (string guieditctrl) @@ -5673,6 +7460,7 @@ public void fn_GuiEditCtrl_deleteSelection (string guieditctrl) } /// /// ( bool width=true, bool height=true ) - Fit selected controls into their parents. ) +/// /// public void fn_GuiEditCtrl_fitIntoParents (string guieditctrl, bool width, bool height) @@ -5687,6 +7475,7 @@ public void fn_GuiEditCtrl_fitIntoParents (string guieditctrl, bool width, bool } /// /// () - Return the toplevel control edited inside the GUI editor. ) +/// /// public int fn_GuiEditCtrl_getContentControl (string guieditctrl) @@ -5701,6 +7490,7 @@ public int fn_GuiEditCtrl_getContentControl (string guieditctrl) } /// /// Returns the set to which new controls will be added) +/// /// public int fn_GuiEditCtrl_getCurrentAddSet (string guieditctrl) @@ -5715,6 +7505,7 @@ public int fn_GuiEditCtrl_getCurrentAddSet (string guieditctrl) } /// /// () - Return the current mouse mode. ) +/// /// public string fn_GuiEditCtrl_getMouseMode (string guieditctrl) @@ -5732,6 +7523,7 @@ public string fn_GuiEditCtrl_getMouseMode (string guieditctrl) } /// /// () - Return the number of controls currently selected. ) +/// /// public int fn_GuiEditCtrl_getNumSelected (string guieditctrl) @@ -5746,6 +7538,7 @@ public int fn_GuiEditCtrl_getNumSelected (string guieditctrl) } /// /// () - Returns global bounds of current selection as vector 'x y width height'. ) +/// /// public string fn_GuiEditCtrl_getSelectionGlobalBounds (string guieditctrl) @@ -5763,6 +7556,7 @@ public string fn_GuiEditCtrl_getSelectionGlobalBounds (string guieditctrl) } /// /// (int mode) ) +/// /// public void fn_GuiEditCtrl_justify (string guieditctrl, uint mode) @@ -5777,6 +7571,7 @@ public void fn_GuiEditCtrl_justify (string guieditctrl, uint mode) } /// /// ( string fileName=null ) - Load selection from file or clipboard.) +/// /// public void fn_GuiEditCtrl_loadSelection (string guieditctrl, string filename) @@ -5794,6 +7589,7 @@ public void fn_GuiEditCtrl_loadSelection (string guieditctrl, string filename) } /// /// Move all controls in the selection by (dx,dy) pixels.) +/// /// public void fn_GuiEditCtrl_moveSelection (string guieditctrl, string pos) @@ -5811,6 +7607,7 @@ public void fn_GuiEditCtrl_moveSelection (string guieditctrl, string pos) } /// /// ) +/// /// public void fn_GuiEditCtrl_pushToBack (string guieditctrl) @@ -5825,6 +7622,7 @@ public void fn_GuiEditCtrl_pushToBack (string guieditctrl) } /// /// ( GuiControl ctrl [, int axis ] ) - Read the guides from the given control. ) +/// /// public void fn_GuiEditCtrl_readGuides (string guieditctrl, string ctrl, int axis) @@ -5842,6 +7640,7 @@ public void fn_GuiEditCtrl_readGuides (string guieditctrl, string ctrl, int axis } /// /// deselects a control.) +/// /// public void fn_GuiEditCtrl_removeSelection (string guieditctrl, int id) @@ -5856,6 +7655,7 @@ public void fn_GuiEditCtrl_removeSelection (string guieditctrl, int id) } /// /// ( string fileName=null ) - Save selection to file or clipboard.) +/// /// public void fn_GuiEditCtrl_saveSelection (string guieditctrl, string filename) @@ -5873,6 +7673,7 @@ public void fn_GuiEditCtrl_saveSelection (string guieditctrl, string filename) } /// /// (GuiControl ctrl)) +/// /// public void fn_GuiEditCtrl_select (string guieditctrl, string ctrl) @@ -5890,6 +7691,7 @@ public void fn_GuiEditCtrl_select (string guieditctrl, string ctrl) } /// /// ()) +/// /// public void fn_GuiEditCtrl_selectAll (string guieditctrl) @@ -5904,6 +7706,7 @@ public void fn_GuiEditCtrl_selectAll (string guieditctrl) } /// /// ( bool addToSelection=false ) - Select children of currently selected controls. ) +/// /// public void fn_GuiEditCtrl_selectChildren (string guieditctrl, bool addToSelection) @@ -5918,6 +7721,7 @@ public void fn_GuiEditCtrl_selectChildren (string guieditctrl, bool addToSelecti } /// /// ( bool addToSelection=false ) - Select parents of currently selected controls. ) +/// /// public void fn_GuiEditCtrl_selectParents (string guieditctrl, bool addToSelection) @@ -5932,6 +7736,7 @@ public void fn_GuiEditCtrl_selectParents (string guieditctrl, bool addToSelectio } /// /// ( GuiControl ctrl ) - Set the toplevel control to edit in the GUI editor. ) +/// /// public void fn_GuiEditCtrl_setContentControl (string guieditctrl, string ctrl) @@ -5949,6 +7754,7 @@ public void fn_GuiEditCtrl_setContentControl (string guieditctrl, string ctrl) } /// /// (GuiControl ctrl)) +/// /// public void fn_GuiEditCtrl_setCurrentAddSet (string guieditctrl, string addSet) @@ -5966,6 +7772,7 @@ public void fn_GuiEditCtrl_setCurrentAddSet (string guieditctrl, string addSet) } /// /// GuiEditCtrl.setSnapToGrid(gridsize)) +/// /// public void fn_GuiEditCtrl_setSnapToGrid (string guieditctrl, uint gridsize) @@ -5980,6 +7787,7 @@ public void fn_GuiEditCtrl_setSnapToGrid (string guieditctrl, uint gridsize) } /// /// Toggle activation.) +/// /// public void fn_GuiEditCtrl_toggle (string guieditctrl) @@ -5994,6 +7802,7 @@ public void fn_GuiEditCtrl_toggle (string guieditctrl) } /// /// ( GuiControl ctrl [, int axis ] ) - Write the guides to the given control. ) +/// /// public void fn_GuiEditCtrl_writeGuides (string guieditctrl, string ctrl, int axis) @@ -6011,6 +7820,7 @@ public void fn_GuiEditCtrl_writeGuides (string guieditctrl, string ctrl, int axi } /// /// getSelectedPath() - returns the currently selected path in the tree) +/// /// public string fn_GuiFileTreeCtrl_getSelectedPath (string guifiletreectrl) @@ -6028,6 +7838,7 @@ public string fn_GuiFileTreeCtrl_getSelectedPath (string guifiletreectrl) } /// /// () - Reread the directory tree hierarchy. ) +/// /// public void fn_GuiFileTreeCtrl_reload (string guifiletreectrl) @@ -6042,6 +7853,7 @@ public void fn_GuiFileTreeCtrl_reload (string guifiletreectrl) } /// /// setSelectedPath(path) - expands the tree to the specified path) +/// /// public bool fn_GuiFileTreeCtrl_setSelectedPath (string guifiletreectrl, string path) @@ -6058,7 +7870,9 @@ public bool fn_GuiFileTreeCtrl_setSelectedPath (string guifiletreectrl, string p return SafeNativeMethods.mwle_fn_GuiFileTreeCtrl_setSelectedPath(sbguifiletreectrl, sbpath)>=1; } /// -/// Return a tuple containing all the values in the filter. @internal) +/// Return a tuple containing all the values in the filter. +/// @internal) +/// /// public string fn_GuiFilterCtrl_getValue (string guifilterctrl) @@ -6075,7 +7889,9 @@ public string fn_GuiFilterCtrl_getValue (string guifilterctrl) } /// -/// Reset the filtering. @internal) +/// Reset the filtering. +/// @internal) +/// /// public void fn_GuiFilterCtrl_identity (string guifilterctrl) @@ -6090,6 +7906,7 @@ public void fn_GuiFilterCtrl_identity (string guifilterctrl) } /// /// Get color value) +/// /// public string fn_GuiGradientCtrl_getColor (string guigradientctrl, int idx) @@ -6107,6 +7924,7 @@ public string fn_GuiGradientCtrl_getColor (string guigradientctrl, int idx) } /// /// Get color count) +/// /// public int fn_GuiGradientCtrl_getColorCount (string guigradientctrl) @@ -6120,7 +7938,9 @@ public int fn_GuiGradientCtrl_getColorCount (string guigradientctrl) return SafeNativeMethods.mwle_fn_GuiGradientCtrl_getColorCount(sbguigradientctrl); } /// -/// () @internal) +/// () +/// @internal) +/// /// public void fn_GuiIdleCamFadeBitmapCtrl_fadeIn (string guiidlecamfadebitmapctrl) @@ -6134,7 +7954,9 @@ public void fn_GuiIdleCamFadeBitmapCtrl_fadeIn (string guiidlecamfadebitmapctrl) SafeNativeMethods.mwle_fn_GuiIdleCamFadeBitmapCtrl_fadeIn(sbguiidlecamfadebitmapctrl); } /// -/// () @internal) +/// () +/// @internal) +/// /// public void fn_GuiIdleCamFadeBitmapCtrl_fadeOut (string guiidlecamfadebitmapctrl) @@ -6149,6 +7971,7 @@ public void fn_GuiIdleCamFadeBitmapCtrl_fadeOut (string guiidlecamfadebitmapctrl } /// /// ( id object, (bool autoSync = true) ) - Add the object to the list of objects being inspected. ) +/// /// public void fn_GuiInspector_addInspect (string guiinspector, string className, bool autoSync) @@ -6166,6 +7989,7 @@ public void fn_GuiInspector_addInspect (string guiinspector, string className, b } /// /// apply() - Force application of inspected object's attributes ) +/// /// public void fn_GuiInspector_apply (string guiinspector) @@ -6180,6 +8004,7 @@ public void fn_GuiInspector_apply (string guiinspector) } /// /// getInspectObject( int index=0 ) - Returns currently inspected object ) +/// /// public string fn_GuiInspector_getInspectObject (string guiinspector, uint index) @@ -6197,6 +8022,7 @@ public string fn_GuiInspector_getInspectObject (string guiinspector, uint index) } /// /// () - Return the number of objects currently being inspected. ) +/// /// public int fn_GuiInspector_getNumInspectObjects (string guiinspector) @@ -6211,6 +8037,7 @@ public int fn_GuiInspector_getNumInspectObjects (string guiinspector) } /// /// Inspect(Object)) +/// /// public void fn_GuiInspector_inspect (string guiinspector, string className) @@ -6228,6 +8055,7 @@ public void fn_GuiInspector_inspect (string guiinspector, string className) } /// /// Reinspect the currently selected object. ) +/// /// public void fn_GuiInspector_refresh (string guiinspector) @@ -6242,6 +8070,7 @@ public void fn_GuiInspector_refresh (string guiinspector) } /// /// ( id object ) - Remove the object from the list of objects being inspected. ) +/// /// public void fn_GuiInspector_removeInspect (string guiinspector, string obj) @@ -6259,6 +8088,7 @@ public void fn_GuiInspector_removeInspect (string guiinspector, string obj) } /// /// setName(NewObjectName)) +/// /// public void fn_GuiInspector_setName (string guiinspector, string newObjectName) @@ -6276,6 +8106,7 @@ public void fn_GuiInspector_setName (string guiinspector, string newObjectName) } /// /// setObjectField( fieldname, data ) - Set a named fields value on the inspected object if it exists. This triggers all the usual callbacks that would occur if the field had been changed through the gui. ) +/// /// public void fn_GuiInspector_setObjectField (string guiinspector, string fieldname, string data) @@ -6296,6 +8127,7 @@ public void fn_GuiInspector_setObjectField (string guiinspector, string fieldnam } /// /// field.renameField(newDynamicFieldName); ) +/// /// public void fn_GuiInspectorDynamicField_renameField (string guiinspectordynamicfield, string newDynamicFieldName) @@ -6313,6 +8145,7 @@ public void fn_GuiInspectorDynamicField_renameField (string guiinspectordynamicf } /// /// obj.addDynamicField(); ) +/// /// public void fn_GuiInspectorDynamicGroup_addDynamicField (string guiinspectordynamicgroup) @@ -6327,6 +8160,7 @@ public void fn_GuiInspectorDynamicGroup_addDynamicField (string guiinspectordyna } /// /// Refreshes the dynamic fields in the inspector.) +/// /// public bool fn_GuiInspectorDynamicGroup_inspectGroup (string guiinspectordynamicgroup) @@ -6341,6 +8175,7 @@ public bool fn_GuiInspectorDynamicGroup_inspectGroup (string guiinspectordynamic } /// /// ) +/// /// public void fn_GuiInspectorDynamicGroup_removeDynamicField (string guiinspectordynamicgroup) @@ -6355,6 +8190,7 @@ public void fn_GuiInspectorDynamicGroup_removeDynamicField (string guiinspectord } /// /// , true), ( string newValue, bool callbacks=true ) - Set the field's value. Suppress callbacks for undo if callbacks=false. ) +/// /// public void fn_GuiInspectorField_apply (string guiinspectorfield, string newValue, bool callbacks) @@ -6372,6 +8208,7 @@ public void fn_GuiInspectorField_apply (string guiinspectorfield, string newValu } /// /// () - Set field value without recording undo (same as 'apply( value, false )'). ) +/// /// public void fn_GuiInspectorField_applyWithoutUndo (string guiinspectorfield, string data) @@ -6389,6 +8226,7 @@ public void fn_GuiInspectorField_applyWithoutUndo (string guiinspectorfield, str } /// /// () - Return the value currently displayed on the field. ) +/// /// public string fn_GuiInspectorField_getData (string guiinspectorfield) @@ -6406,6 +8244,7 @@ public string fn_GuiInspectorField_getData (string guiinspectorfield) } /// /// () - Return the name of the field edited by this inspector field. ) +/// /// public string fn_GuiInspectorField_getInspectedFieldName (string guiinspectorfield) @@ -6423,6 +8262,7 @@ public string fn_GuiInspectorField_getInspectedFieldName (string guiinspectorfie } /// /// () - Return the type of the field edited by this inspector field. ) +/// /// public string fn_GuiInspectorField_getInspectedFieldType (string guiinspectorfield) @@ -6440,6 +8280,7 @@ public string fn_GuiInspectorField_getInspectedFieldType (string guiinspectorfie } /// /// () - Return the GuiInspector to which this field belongs. ) +/// /// public int fn_GuiInspectorField_getInspector (string guiinspectorfield) @@ -6454,6 +8295,7 @@ public int fn_GuiInspectorField_getInspector (string guiinspectorfield) } /// /// () - Reset to default value. ) +/// /// public void fn_GuiInspectorField_reset (string guiinspectorfield) @@ -6467,7 +8309,9 @@ public void fn_GuiInspectorField_reset (string guiinspectorfield) SafeNativeMethods.mwle_fn_GuiInspectorField_reset(sbguiinspectorfield); } /// -/// ( string materialName ) Set the material to be displayed in the control. ) +/// ( string materialName ) +/// Set the material to be displayed in the control. ) +/// /// public bool fn_GuiMaterialCtrl_setMaterial (string guimaterialctrl, string materialName) @@ -6485,6 +8329,7 @@ public bool fn_GuiMaterialCtrl_setMaterial (string guimaterialctrl, string mater } /// /// deleteNode() ) +/// /// public void fn_GuiMeshRoadEditorCtrl_deleteNode (string guimeshroadeditorctrl) @@ -6499,6 +8344,7 @@ public void fn_GuiMeshRoadEditorCtrl_deleteNode (string guimeshroadeditorctrl) } /// /// ) +/// /// public string fn_GuiMeshRoadEditorCtrl_getMode (string guimeshroadeditorctrl) @@ -6516,6 +8362,7 @@ public string fn_GuiMeshRoadEditorCtrl_getMode (string guimeshroadeditorctrl) } /// /// ) +/// /// public float fn_GuiMeshRoadEditorCtrl_getNodeDepth (string guimeshroadeditorctrl) @@ -6530,6 +8377,7 @@ public float fn_GuiMeshRoadEditorCtrl_getNodeDepth (string guimeshroadeditorctrl } /// /// ) +/// /// public string fn_GuiMeshRoadEditorCtrl_getNodeNormal (string guimeshroadeditorctrl) @@ -6547,6 +8395,7 @@ public string fn_GuiMeshRoadEditorCtrl_getNodeNormal (string guimeshroadeditorct } /// /// ) +/// /// public string fn_GuiMeshRoadEditorCtrl_getNodePosition (string guimeshroadeditorctrl) @@ -6564,6 +8413,7 @@ public string fn_GuiMeshRoadEditorCtrl_getNodePosition (string guimeshroadeditor } /// /// ) +/// /// public float fn_GuiMeshRoadEditorCtrl_getNodeWidth (string guimeshroadeditorctrl) @@ -6578,6 +8428,7 @@ public float fn_GuiMeshRoadEditorCtrl_getNodeWidth (string guimeshroadeditorctrl } /// /// ) +/// /// public int fn_GuiMeshRoadEditorCtrl_getSelectedRoad (string guimeshroadeditorctrl) @@ -6592,6 +8443,7 @@ public int fn_GuiMeshRoadEditorCtrl_getSelectedRoad (string guimeshroadeditorctr } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_matchTerrainToRoad (string guimeshroadeditorctrl) @@ -6606,6 +8458,7 @@ public void fn_GuiMeshRoadEditorCtrl_matchTerrainToRoad (string guimeshroadedito } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_regenerate (string guimeshroadeditorctrl) @@ -6620,6 +8473,7 @@ public void fn_GuiMeshRoadEditorCtrl_regenerate (string guimeshroadeditorctrl) } /// /// setMode( String mode ) ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setMode (string guimeshroadeditorctrl, string mode) @@ -6637,6 +8491,7 @@ public void fn_GuiMeshRoadEditorCtrl_setMode (string guimeshroadeditorctrl, stri } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodeDepth (string guimeshroadeditorctrl, float depth) @@ -6651,6 +8506,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodeDepth (string guimeshroadeditorctrl, } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodeNormal (string guimeshroadeditorctrl, string normal) @@ -6668,6 +8524,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodeNormal (string guimeshroadeditorctrl } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodePosition (string guimeshroadeditorctrl, string pos) @@ -6685,6 +8542,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodePosition (string guimeshroadeditorct } /// /// ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setNodeWidth (string guimeshroadeditorctrl, float width) @@ -6699,6 +8557,7 @@ public void fn_GuiMeshRoadEditorCtrl_setNodeWidth (string guimeshroadeditorctrl, } /// /// ), ) +/// /// public void fn_GuiMeshRoadEditorCtrl_setSelectedRoad (string guimeshroadeditorctrl, string objName) @@ -6716,6 +8575,7 @@ public void fn_GuiMeshRoadEditorCtrl_setSelectedRoad (string guimeshroadeditorct } /// /// ) +/// /// public string fn_GuiMissionAreaEditorCtrl_getSelectedMissionArea (string guimissionareaeditorctrl) @@ -6733,6 +8593,7 @@ public string fn_GuiMissionAreaEditorCtrl_getSelectedMissionArea (string guimiss } /// /// ), ) +/// /// public void fn_GuiMissionAreaEditorCtrl_setSelectedMissionArea (string guimissionareaeditorctrl, string missionAreaName) @@ -6785,7 +8646,10 @@ public void fn_GuiNavEditorCtrl_setMode (string guinaveditorctrl, string newMode SafeNativeMethods.mwle_fn_GuiNavEditorCtrl_setMode(sbguinaveditorctrl, sbnewMode); } /// -/// (int plotID, float x, float y, bool setAdded = true;) Add a data point to the given plot. @return) +/// (int plotID, float x, float y, bool setAdded = true;) +/// Add a data point to the given plot. +/// @return) +/// /// public string fn_GuiParticleGraphCtrl_addPlotPoint (string guiparticlegraphctrl, int plotID, float x, float y, bool setAdded) @@ -6802,7 +8666,13 @@ public string fn_GuiParticleGraphCtrl_addPlotPoint (string guiparticlegraphctrl, } /// -/// (int plotID, int i, float x, float y) Change a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Change a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public string fn_GuiParticleGraphCtrl_changePlotPoint (string guiparticlegraphctrl, int plotID, int i, float x, float y) @@ -6819,7 +8689,10 @@ public string fn_GuiParticleGraphCtrl_changePlotPoint (string guiparticlegraphct } /// -/// () Clear all of the graphs. @return No return value) +/// () +/// Clear all of the graphs. +/// @return No return value) +/// /// public void fn_GuiParticleGraphCtrl_clearAllGraphs (string guiparticlegraphctrl) @@ -6833,7 +8706,10 @@ public void fn_GuiParticleGraphCtrl_clearAllGraphs (string guiparticlegraphctrl) SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_clearAllGraphs(sbguiparticlegraphctrl); } /// -/// (int plotID) Clear the graph of the given plot. @return No return value) +/// (int plotID) +/// Clear the graph of the given plot. +/// @return No return value) +/// /// public void fn_GuiParticleGraphCtrl_clearGraph (string guiparticlegraphctrl, int plotID) @@ -6847,7 +8723,10 @@ public void fn_GuiParticleGraphCtrl_clearGraph (string guiparticlegraphctrl, int SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_clearGraph(sbguiparticlegraphctrl, plotID); } /// -/// (int plotID) Get the color of the graph passed. @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// (int plotID) +/// Get the color of the graph passed. +/// @return Returns the color of the graph as a string of RGB values formatted as \"R G B\") +/// /// public string fn_GuiParticleGraphCtrl_getGraphColor (string guiparticlegraphctrl, int plotID) @@ -6864,7 +8743,10 @@ public string fn_GuiParticleGraphCtrl_getGraphColor (string guiparticlegraphctrl } /// -/// (int plotID) Get the maximum values of the graph ranges. @return Returns the maximum of the range formatted as \"x-max y-max\") +/// (int plotID) +/// Get the maximum values of the graph ranges. +/// @return Returns the maximum of the range formatted as \"x-max y-max\") +/// /// public string fn_GuiParticleGraphCtrl_getGraphMax (string guiparticlegraphctrl, int plotID) @@ -6881,7 +8763,10 @@ public string fn_GuiParticleGraphCtrl_getGraphMax (string guiparticlegraphctrl, } /// -/// (int plotID) Get the minimum values of the graph ranges. @return Returns the minimum of the range formatted as \"x-min y-min\") +/// (int plotID) +/// Get the minimum values of the graph ranges. +/// @return Returns the minimum of the range formatted as \"x-min y-min\") +/// /// public string fn_GuiParticleGraphCtrl_getGraphMin (string guiparticlegraphctrl, int plotID) @@ -6898,7 +8783,10 @@ public string fn_GuiParticleGraphCtrl_getGraphMin (string guiparticlegraphctrl, } /// -/// (int plotID) Get the name of the graph passed. @return Returns the name of the plot) +/// (int plotID) +/// Get the name of the graph passed. +/// @return Returns the name of the plot) +/// /// public string fn_GuiParticleGraphCtrl_getGraphName (string guiparticlegraphctrl, int plotID) @@ -6915,7 +8803,12 @@ public string fn_GuiParticleGraphCtrl_getGraphName (string guiparticlegraphctrl, } /// -/// (int plotID, float x, float y) Gets the index of the point passed on the plotID passed (graph ID). @param plotID The plot you wish to check. @param x,y The coordinates of the point to get. @return Returns the index of the point.) +/// (int plotID, float x, float y) +/// Gets the index of the point passed on the plotID passed (graph ID). +/// @param plotID The plot you wish to check. +/// @param x,y The coordinates of the point to get. +/// @return Returns the index of the point.) +/// /// public string fn_GuiParticleGraphCtrl_getPlotIndex (string guiparticlegraphctrl, int plotID, float x, float y) @@ -6932,7 +8825,10 @@ public string fn_GuiParticleGraphCtrl_getPlotIndex (string guiparticlegraphctrl, } /// -/// (int plotID, int samples) Get a data point from the plot specified, samples from the start of the graph. @return The data point ID) +/// (int plotID, int samples) +/// Get a data point from the plot specified, samples from the start of the graph. +/// @return The data point ID) +/// /// public string fn_GuiParticleGraphCtrl_getPlotPoint (string guiparticlegraphctrl, int plotID, int samples) @@ -6949,7 +8845,10 @@ public string fn_GuiParticleGraphCtrl_getPlotPoint (string guiparticlegraphctrl, } /// -/// () Gets the selected Plot (a.k.a. graph). @return The plot's ID.) +/// () +/// Gets the selected Plot (a.k.a. graph). +/// @return The plot's ID.) +/// /// public string fn_GuiParticleGraphCtrl_getSelectedPlot (string guiparticlegraphctrl) @@ -6966,7 +8865,10 @@ public string fn_GuiParticleGraphCtrl_getSelectedPlot (string guiparticlegraphct } /// -/// () Gets the selected Point on the Plot (a.k.a. graph). @return The last selected point ID) +/// () +/// Gets the selected Point on the Plot (a.k.a. graph). +/// @return The last selected point ID) +/// /// public string fn_GuiParticleGraphCtrl_getSelectedPoint (string guiparticlegraphctrl) @@ -6983,7 +8885,13 @@ public string fn_GuiParticleGraphCtrl_getSelectedPoint (string guiparticlegraphc } /// -/// (int plotID, int i, float x, float y) Insert a data point to the given plot and plot position. @param plotID The plot you want to access @param i The data point. @param x,y The plot position. @return No return value.) +/// (int plotID, int i, float x, float y) +/// Insert a data point to the given plot and plot position. +/// @param plotID The plot you want to access +/// @param i The data point. +/// @param x,y The plot position. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_insertPlotPoint (string guiparticlegraphctrl, int plotID, int i, float x, float y) @@ -6997,7 +8905,9 @@ public void fn_GuiParticleGraphCtrl_insertPlotPoint (string guiparticlegraphctrl SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_insertPlotPoint(sbguiparticlegraphctrl, plotID, i, x, y); } /// -/// (int plotID, int samples) @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// (int plotID, int samples) +/// @return Returns true or false whether or not the point in the plot passed is an existing point.) +/// /// public string fn_GuiParticleGraphCtrl_isExistingPoint (string guiparticlegraphctrl, int plotID, int samples) @@ -7014,7 +8924,10 @@ public string fn_GuiParticleGraphCtrl_isExistingPoint (string guiparticlegraphct } /// -/// () This will reset the currently selected point to nothing. @return No return value.) +/// () +/// This will reset the currently selected point to nothing. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_resetSelectedPoint (string guiparticlegraphctrl) @@ -7028,7 +8941,11 @@ public void fn_GuiParticleGraphCtrl_resetSelectedPoint (string guiparticlegraphc SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_resetSelectedPoint(sbguiparticlegraphctrl); } /// -/// (bool autoMax) Set whether the max will automatically be set when adding points (ie if you add a value over the current max, the max is increased to that value). @return No return value.) +/// (bool autoMax) +/// Set whether the max will automatically be set when adding points +/// (ie if you add a value over the current max, the max is increased to that value). +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setAutoGraphMax (string guiparticlegraphctrl, bool autoMax) @@ -7042,7 +8959,10 @@ public void fn_GuiParticleGraphCtrl_setAutoGraphMax (string guiparticlegraphctrl SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setAutoGraphMax(sbguiparticlegraphctrl, autoMax); } /// -/// (bool autoRemove) Set whether or not a point should be deleted when you drag another one over it. @return No return value.) +/// (bool autoRemove) +/// Set whether or not a point should be deleted when you drag another one over it. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setAutoRemove (string guiparticlegraphctrl, bool autoRemove) @@ -7056,7 +8976,10 @@ public void fn_GuiParticleGraphCtrl_setAutoRemove (string guiparticlegraphctrl, SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setAutoRemove(sbguiparticlegraphctrl, autoRemove); } /// -/// (int plotID, bool isHidden) Set whether the graph number passed is hidden or not. @return No return value.) +/// (int plotID, bool isHidden) +/// Set whether the graph number passed is hidden or not. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphHidden (string guiparticlegraphctrl, int plotID, bool isHidden) @@ -7070,7 +8993,12 @@ public void fn_GuiParticleGraphCtrl_setGraphHidden (string guiparticlegraphctrl, SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphHidden(sbguiparticlegraphctrl, plotID, isHidden); } /// -/// (int plotID, float maxX, float maxY) Set the max values of the graph of plotID. @param plotID The plot to modify @param maxX,maxY The maximum bound of the value range. @return No return value.) +/// (int plotID, float maxX, float maxY) +/// Set the max values of the graph of plotID. +/// @param plotID The plot to modify +/// @param maxX,maxY The maximum bound of the value range. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMax (string guiparticlegraphctrl, int plotID, float maxX, float maxY) @@ -7084,7 +9012,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMax (string guiparticlegraphctrl, in SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMax(sbguiparticlegraphctrl, plotID, maxX, maxY); } /// -/// (int plotID, float maxX) Set the max X value of the graph of plotID. @param plotID The plot to modify. @param maxX The maximum x value. @return No return Value.) +/// (int plotID, float maxX) +/// Set the max X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxX The maximum x value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMaxX (string guiparticlegraphctrl, int plotID, float maxX) @@ -7098,7 +9031,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMaxX (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMaxX(sbguiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float maxY) Set the max Y value of the graph of plotID. @param plotID The plot to modify. @param maxY The maximum y value. @return No return Value.) +/// (int plotID, float maxY) +/// Set the max Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param maxY The maximum y value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMaxY (string guiparticlegraphctrl, int plotID, float maxX) @@ -7112,7 +9050,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMaxY (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMaxY(sbguiparticlegraphctrl, plotID, maxX); } /// -/// (int plotID, float minX, float minY) Set the min values of the graph of plotID. @param plotID The plot to modify @param minX,minY The minimum bound of the value range. @return No return value.) +/// (int plotID, float minX, float minY) +/// Set the min values of the graph of plotID. +/// @param plotID The plot to modify +/// @param minX,minY The minimum bound of the value range. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMin (string guiparticlegraphctrl, int plotID, float minX, float minY) @@ -7126,7 +9069,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMin (string guiparticlegraphctrl, in SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMin(sbguiparticlegraphctrl, plotID, minX, minY); } /// -/// (int plotID, float minX) Set the min X value of the graph of plotID. @param plotID The plot to modify. @param minX The minimum x value. @return No return Value.) +/// (int plotID, float minX) +/// Set the min X value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minX The minimum x value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMinX (string guiparticlegraphctrl, int plotID, float minX) @@ -7140,7 +9088,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMinX (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMinX(sbguiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, float minY) Set the min Y value of the graph of plotID. @param plotID The plot to modify. @param minY The minimum y value. @return No return Value.) +/// (int plotID, float minY) +/// Set the min Y value of the graph of plotID. +/// @param plotID The plot to modify. +/// @param minY The minimum y value. +/// @return No return Value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphMinY (string guiparticlegraphctrl, int plotID, float minX) @@ -7154,7 +9107,12 @@ public void fn_GuiParticleGraphCtrl_setGraphMinY (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphMinY(sbguiparticlegraphctrl, plotID, minX); } /// -/// (int plotID, string graphName) Set the name of the given plot. @param plotID The plot to modify. @param graphName The name to set on the plot. @return No return value.) +/// (int plotID, string graphName) +/// Set the name of the given plot. +/// @param plotID The plot to modify. +/// @param graphName The name to set on the plot. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setGraphName (string guiparticlegraphctrl, int plotID, string graphName) @@ -7171,7 +9129,10 @@ public void fn_GuiParticleGraphCtrl_setGraphName (string guiparticlegraphctrl, i SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setGraphName(sbguiparticlegraphctrl, plotID, sbgraphName); } /// -/// (bool clamped) Set whether the x position of the selected graph point should be clamped @return No return value.) +/// (bool clamped) +/// Set whether the x position of the selected graph point should be clamped +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setPointXMovementClamped (string guiparticlegraphctrl, bool autoRemove) @@ -7185,7 +9146,10 @@ public void fn_GuiParticleGraphCtrl_setPointXMovementClamped (string guiparticle SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setPointXMovementClamped(sbguiparticlegraphctrl, autoRemove); } /// -/// (bool renderAll) Set whether or not a position should be rendered on every point or just the last selected. @return No return value.) +/// (bool renderAll) +/// Set whether or not a position should be rendered on every point or just the last selected. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setRenderAll (string guiparticlegraphctrl, bool autoRemove) @@ -7199,7 +9163,10 @@ public void fn_GuiParticleGraphCtrl_setRenderAll (string guiparticlegraphctrl, b SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setRenderAll(sbguiparticlegraphctrl, autoRemove); } /// -/// (bool renderGraphTooltip) Set whether or not to render the graph tooltip. @return No return value.) +/// (bool renderGraphTooltip) +/// Set whether or not to render the graph tooltip. +/// @return No return value.) +/// /// public void fn_GuiParticleGraphCtrl_setRenderGraphTooltip (string guiparticlegraphctrl, bool autoRemove) @@ -7213,7 +9180,10 @@ public void fn_GuiParticleGraphCtrl_setRenderGraphTooltip (string guiparticlegra SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setRenderGraphTooltip(sbguiparticlegraphctrl, autoRemove); } /// -/// (int plotID) Set the selected plot (a.k.a. graph). @return No return value ) +/// (int plotID) +/// Set the selected plot (a.k.a. graph). +/// @return No return value ) +/// /// public void fn_GuiParticleGraphCtrl_setSelectedPlot (string guiparticlegraphctrl, int plotID) @@ -7227,7 +9197,10 @@ public void fn_GuiParticleGraphCtrl_setSelectedPlot (string guiparticlegraphctrl SafeNativeMethods.mwle_fn_GuiParticleGraphCtrl_setSelectedPlot(sbguiparticlegraphctrl, plotID); } /// -/// (int point) Set the selected point on the graph. @return No return value) +/// (int point) +/// Set the selected point on the graph. +/// @return No return value) +/// /// public void fn_GuiParticleGraphCtrl_setSelectedPoint (string guiparticlegraphctrl, int point) @@ -7242,6 +9215,7 @@ public void fn_GuiParticleGraphCtrl_setSelectedPoint (string guiparticlegraphctr } /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void fn_GuiPopUpMenuCtrl_add (string guipopupmenuctrl, string name, int idNum, uint scheme) @@ -7259,6 +9233,7 @@ public void fn_GuiPopUpMenuCtrl_add (string guipopupmenuctrl, string name, int i } /// /// (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void fn_GuiPopUpMenuCtrl_addScheme (string guipopupmenuctrl, uint id, string fontColor, string fontColorHL, string fontColorSEL) @@ -7282,6 +9257,7 @@ public void fn_GuiPopUpMenuCtrl_addScheme (string guipopupmenuctrl, uint id, str } /// /// ( int id, string text ) ) +/// /// public void fn_GuiPopUpMenuCtrl_changeTextById (string guipopupmenuctrl, int id, string text) @@ -7299,6 +9275,7 @@ public void fn_GuiPopUpMenuCtrl_changeTextById (string guipopupmenuctrl, int id, } /// /// Clear the popup list.) +/// /// public void fn_GuiPopUpMenuCtrl_clear (string guipopupmenuctrl) @@ -7313,6 +9290,7 @@ public void fn_GuiPopUpMenuCtrl_clear (string guipopupmenuctrl) } /// /// (S32 entry)) +/// /// public void fn_GuiPopUpMenuCtrl_clearEntry (string guipopupmenuctrl, int entry) @@ -7326,7 +9304,9 @@ public void fn_GuiPopUpMenuCtrl_clearEntry (string guipopupmenuctrl, int entry) SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrl_clearEntry(sbguipopupmenuctrl, entry); } /// -/// (string text) Returns the position of the first entry containing the specified text.) +/// (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int fn_GuiPopUpMenuCtrl_findText (string guipopupmenuctrl, string text) @@ -7344,6 +9324,7 @@ public int fn_GuiPopUpMenuCtrl_findText (string guipopupmenuctrl, string text) } /// /// ) +/// /// public void fn_GuiPopUpMenuCtrl_forceClose (string guipopupmenuctrl) @@ -7358,6 +9339,7 @@ public void fn_GuiPopUpMenuCtrl_forceClose (string guipopupmenuctrl) } /// /// ) +/// /// public void fn_GuiPopUpMenuCtrl_forceOnAction (string guipopupmenuctrl) @@ -7372,6 +9354,7 @@ public void fn_GuiPopUpMenuCtrl_forceOnAction (string guipopupmenuctrl) } /// /// ) +/// /// public int fn_GuiPopUpMenuCtrl_getSelected (string guipopupmenuctrl) @@ -7386,6 +9369,7 @@ public int fn_GuiPopUpMenuCtrl_getSelected (string guipopupmenuctrl) } /// /// ) +/// /// public string fn_GuiPopUpMenuCtrl_getText (string guipopupmenuctrl) @@ -7403,6 +9387,7 @@ public string fn_GuiPopUpMenuCtrl_getText (string guipopupmenuctrl) } /// /// (int id)) +/// /// public string fn_GuiPopUpMenuCtrl_getTextById (string guipopupmenuctrl, int id) @@ -7420,6 +9405,7 @@ public string fn_GuiPopUpMenuCtrl_getTextById (string guipopupmenuctrl, int id) } /// /// (bool doReplaceText)) +/// /// public void fn_GuiPopUpMenuCtrl_replaceText (string guipopupmenuctrl, bool doReplaceText) @@ -7433,7 +9419,11 @@ public void fn_GuiPopUpMenuCtrl_replaceText (string guipopupmenuctrl, bool doRep SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrl_replaceText(sbguipopupmenuctrl, doReplaceText); } /// -/// (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void fn_GuiPopUpMenuCtrl_setEnumContent (string guipopupmenuctrl, string className, string enumName) @@ -7454,6 +9444,7 @@ public void fn_GuiPopUpMenuCtrl_setEnumContent (string guipopupmenuctrl, string } /// /// ([scriptCallback=true])) +/// /// public void fn_GuiPopUpMenuCtrl_setFirstSelected (string guipopupmenuctrl, bool scriptCallback) @@ -7468,6 +9459,7 @@ public void fn_GuiPopUpMenuCtrl_setFirstSelected (string guipopupmenuctrl, bool } /// /// ) +/// /// public void fn_GuiPopUpMenuCtrl_setNoneSelected (string guipopupmenuctrl) @@ -7482,6 +9474,7 @@ public void fn_GuiPopUpMenuCtrl_setNoneSelected (string guipopupmenuctrl) } /// /// (int id, [scriptCallback=true])) +/// /// public void fn_GuiPopUpMenuCtrl_setSelected (string guipopupmenuctrl, int id, bool scriptCallback) @@ -7496,6 +9489,7 @@ public void fn_GuiPopUpMenuCtrl_setSelected (string guipopupmenuctrl, int id, bo } /// /// Get the size of the menu - the number of entries in it.) +/// /// public int fn_GuiPopUpMenuCtrl_size (string guipopupmenuctrl) @@ -7510,6 +9504,7 @@ public int fn_GuiPopUpMenuCtrl_size (string guipopupmenuctrl) } /// /// Sort the list alphabetically.) +/// /// public void fn_GuiPopUpMenuCtrl_sort (string guipopupmenuctrl) @@ -7524,6 +9519,7 @@ public void fn_GuiPopUpMenuCtrl_sort (string guipopupmenuctrl) } /// /// Sort the list by ID.) +/// /// public void fn_GuiPopUpMenuCtrl_sortID (string guipopupmenuctrl) @@ -7538,6 +9534,7 @@ public void fn_GuiPopUpMenuCtrl_sortID (string guipopupmenuctrl) } /// /// , -1, 0), (string name, int idNum, int scheme=0)) +/// /// public void fn_GuiPopUpMenuCtrlEx_add (string guipopupmenuctrlex, string name, int idNum, uint scheme) @@ -7555,6 +9552,7 @@ public void fn_GuiPopUpMenuCtrlEx_add (string guipopupmenuctrlex, string name, i } /// /// (S32 entry)) +/// /// public void fn_GuiPopUpMenuCtrlEx_clearEntry (string guipopupmenuctrlex, int entry) @@ -7568,7 +9566,11 @@ public void fn_GuiPopUpMenuCtrlEx_clearEntry (string guipopupmenuctrlex, int ent SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_clearEntry(sbguipopupmenuctrlex, entry); } /// -/// (string text) Returns the id of the first entry containing the specified text or -1 if not found. @param text String value used for the query @return Numerical ID of entry containing the text.) +/// (string text) +/// Returns the id of the first entry containing the specified text or -1 if not found. +/// @param text String value used for the query +/// @return Numerical ID of entry containing the text.) +/// /// public int fn_GuiPopUpMenuCtrlEx_findText (string guipopupmenuctrlex, string text) @@ -7585,7 +9587,10 @@ public int fn_GuiPopUpMenuCtrlEx_findText (string guipopupmenuctrlex, string tex return SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_findText(sbguipopupmenuctrlex, sbtext); } /// -/// @brief Get color of an entry's box @param id ID number of entry to query @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// @brief Get color of an entry's box +/// @param id ID number of entry to query +/// @return ColorI in the format of \"Red Green Blue Alpha\", each of with is a value between 0 - 255) +/// /// public string fn_GuiPopUpMenuCtrlEx_getColorById (string guipopupmenuctrlex, int id) @@ -7602,7 +9607,9 @@ public string fn_GuiPopUpMenuCtrlEx_getColorById (string guipopupmenuctrlex, int } /// -/// @brief Flag that causes each new text addition to replace the current entry @param True to turn on replacing, false to disable it) +/// @brief Flag that causes each new text addition to replace the current entry +/// @param True to turn on replacing, false to disable it) +/// /// public void fn_GuiPopUpMenuCtrlEx_replaceText (string guipopupmenuctrlex, int boolVal) @@ -7616,7 +9623,12 @@ public void fn_GuiPopUpMenuCtrlEx_replaceText (string guipopupmenuctrlex, int bo SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_replaceText(sbguipopupmenuctrlex, boolVal); } /// -/// @brief This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away. @param class Name of the class containing the enum @param enum Name of the enum value to acces) +/// @brief This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away. +/// @param class Name of the class containing the enum +/// @param enum Name of the enum value to acces) +/// /// public void fn_GuiPopUpMenuCtrlEx_setEnumContent (string guipopupmenuctrlex, string className, string enumName) @@ -7636,7 +9648,9 @@ public void fn_GuiPopUpMenuCtrlEx_setEnumContent (string guipopupmenuctrlex, str SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_setEnumContent(sbguipopupmenuctrlex, sbclassName, sbenumName); } /// -/// ([scriptCallback=true]) @hide) +/// ([scriptCallback=true]) +/// @hide) +/// /// public void fn_GuiPopUpMenuCtrlEx_setFirstSelected (string guipopupmenuctrlex, bool scriptCallback) @@ -7650,7 +9664,9 @@ public void fn_GuiPopUpMenuCtrlEx_setFirstSelected (string guipopupmenuctrlex, b SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_setFirstSelected(sbguipopupmenuctrlex, scriptCallback); } /// -/// (int id, [scriptCallback=true]) @hide) +/// (int id, [scriptCallback=true]) +/// @hide) +/// /// public void fn_GuiPopUpMenuCtrlEx_setSelected (string guipopupmenuctrlex, int id, bool scriptCallback) @@ -7664,7 +9680,9 @@ public void fn_GuiPopUpMenuCtrlEx_setSelected (string guipopupmenuctrlex, int id SafeNativeMethods.mwle_fn_GuiPopUpMenuCtrlEx_setSelected(sbguipopupmenuctrlex, id, scriptCallback); } /// -/// @brief Get the size of the menu @return Number of entries in the menu) +/// @brief Get the size of the menu +/// @return Number of entries in the menu) +/// /// public int fn_GuiPopUpMenuCtrlEx_size (string guipopupmenuctrlex) @@ -7679,6 +9697,7 @@ public int fn_GuiPopUpMenuCtrlEx_size (string guipopupmenuctrlex) } /// /// deleteNode() ) +/// /// public void fn_GuiRiverEditorCtrl_deleteNode (string guirivereditorctrl) @@ -7693,6 +9712,7 @@ public void fn_GuiRiverEditorCtrl_deleteNode (string guirivereditorctrl) } /// /// ) +/// /// public string fn_GuiRiverEditorCtrl_getMode (string guirivereditorctrl) @@ -7710,6 +9730,7 @@ public string fn_GuiRiverEditorCtrl_getMode (string guirivereditorctrl) } /// /// ) +/// /// public float fn_GuiRiverEditorCtrl_getNodeDepth (string guirivereditorctrl) @@ -7724,6 +9745,7 @@ public float fn_GuiRiverEditorCtrl_getNodeDepth (string guirivereditorctrl) } /// /// ) +/// /// public string fn_GuiRiverEditorCtrl_getNodeNormal (string guirivereditorctrl) @@ -7741,6 +9763,7 @@ public string fn_GuiRiverEditorCtrl_getNodeNormal (string guirivereditorctrl) } /// /// ) +/// /// public string fn_GuiRiverEditorCtrl_getNodePosition (string guirivereditorctrl) @@ -7758,6 +9781,7 @@ public string fn_GuiRiverEditorCtrl_getNodePosition (string guirivereditorctrl) } /// /// ) +/// /// public float fn_GuiRiverEditorCtrl_getNodeWidth (string guirivereditorctrl) @@ -7772,6 +9796,7 @@ public float fn_GuiRiverEditorCtrl_getNodeWidth (string guirivereditorctrl) } /// /// ) +/// /// public int fn_GuiRiverEditorCtrl_getSelectedRiver (string guirivereditorctrl) @@ -7786,6 +9811,7 @@ public int fn_GuiRiverEditorCtrl_getSelectedRiver (string guirivereditorctrl) } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_regenerate (string guirivereditorctrl) @@ -7800,6 +9826,7 @@ public void fn_GuiRiverEditorCtrl_regenerate (string guirivereditorctrl) } /// /// setMode( String mode ) ) +/// /// public void fn_GuiRiverEditorCtrl_setMode (string guirivereditorctrl, string mode) @@ -7817,6 +9844,7 @@ public void fn_GuiRiverEditorCtrl_setMode (string guirivereditorctrl, string mod } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodeDepth (string guirivereditorctrl, float depth) @@ -7831,6 +9859,7 @@ public void fn_GuiRiverEditorCtrl_setNodeDepth (string guirivereditorctrl, float } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodeNormal (string guirivereditorctrl, string normal) @@ -7848,6 +9877,7 @@ public void fn_GuiRiverEditorCtrl_setNodeNormal (string guirivereditorctrl, stri } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodePosition (string guirivereditorctrl, string pos) @@ -7865,6 +9895,7 @@ public void fn_GuiRiverEditorCtrl_setNodePosition (string guirivereditorctrl, st } /// /// ) +/// /// public void fn_GuiRiverEditorCtrl_setNodeWidth (string guirivereditorctrl, float width) @@ -7879,6 +9910,7 @@ public void fn_GuiRiverEditorCtrl_setNodeWidth (string guirivereditorctrl, float } /// /// ), ) +/// /// public void fn_GuiRiverEditorCtrl_setSelectedRiver (string guirivereditorctrl, string objName) @@ -7896,6 +9928,7 @@ public void fn_GuiRiverEditorCtrl_setSelectedRiver (string guirivereditorctrl, s } /// /// deleteNode() ) +/// /// public void fn_GuiRoadEditorCtrl_deleteNode (string guiroadeditorctrl) @@ -7910,6 +9943,7 @@ public void fn_GuiRoadEditorCtrl_deleteNode (string guiroadeditorctrl) } /// /// ) +/// /// public void fn_GuiRoadEditorCtrl_deleteRoad (string guiroadeditorctrl) @@ -7924,6 +9958,7 @@ public void fn_GuiRoadEditorCtrl_deleteRoad (string guiroadeditorctrl) } /// /// ) +/// /// public string fn_GuiRoadEditorCtrl_getMode (string guiroadeditorctrl) @@ -7941,6 +9976,7 @@ public string fn_GuiRoadEditorCtrl_getMode (string guiroadeditorctrl) } /// /// ) +/// /// public string fn_GuiRoadEditorCtrl_getNodePosition (string guiroadeditorctrl) @@ -7958,6 +9994,7 @@ public string fn_GuiRoadEditorCtrl_getNodePosition (string guiroadeditorctrl) } /// /// ) +/// /// public float fn_GuiRoadEditorCtrl_getNodeWidth (string guiroadeditorctrl) @@ -7972,6 +10009,7 @@ public float fn_GuiRoadEditorCtrl_getNodeWidth (string guiroadeditorctrl) } /// /// ) +/// /// public int fn_GuiRoadEditorCtrl_getSelectedNode (string guiroadeditorctrl) @@ -7986,6 +10024,7 @@ public int fn_GuiRoadEditorCtrl_getSelectedNode (string guiroadeditorctrl) } /// /// ) +/// /// public int fn_GuiRoadEditorCtrl_getSelectedRoad (string guiroadeditorctrl) @@ -8000,6 +10039,7 @@ public int fn_GuiRoadEditorCtrl_getSelectedRoad (string guiroadeditorctrl) } /// /// setMode( String mode ) ) +/// /// public void fn_GuiRoadEditorCtrl_setMode (string guiroadeditorctrl, string mode) @@ -8017,6 +10057,7 @@ public void fn_GuiRoadEditorCtrl_setMode (string guiroadeditorctrl, string mode) } /// /// ) +/// /// public void fn_GuiRoadEditorCtrl_setNodePosition (string guiroadeditorctrl, string pos) @@ -8034,6 +10075,7 @@ public void fn_GuiRoadEditorCtrl_setNodePosition (string guiroadeditorctrl, stri } /// /// ) +/// /// public void fn_GuiRoadEditorCtrl_setNodeWidth (string guiroadeditorctrl, float width) @@ -8048,6 +10090,7 @@ public void fn_GuiRoadEditorCtrl_setNodeWidth (string guiroadeditorctrl, float w } /// /// ), ) +/// /// public void fn_GuiRoadEditorCtrl_setSelectedRoad (string guiroadeditorctrl, string pathRoad) @@ -8065,6 +10108,7 @@ public void fn_GuiRoadEditorCtrl_setSelectedRoad (string guiroadeditorctrl, stri } /// /// Return a Point2F containing the position of the origin.) +/// /// public string fn_GuiTerrPreviewCtrl_getOrigin (string guiterrpreviewctrl) @@ -8082,6 +10126,7 @@ public string fn_GuiTerrPreviewCtrl_getOrigin (string guiterrpreviewctrl) } /// /// Return a Point2F representing the position of the root.) +/// /// public string fn_GuiTerrPreviewCtrl_getRoot (string guiterrpreviewctrl) @@ -8099,6 +10144,7 @@ public string fn_GuiTerrPreviewCtrl_getRoot (string guiterrpreviewctrl) } /// /// Returns a 4-tuple containing: root_x root_y origin_x origin_y) +/// /// public string fn_GuiTerrPreviewCtrl_getValue (string guiterrpreviewctrl) @@ -8116,6 +10162,7 @@ public string fn_GuiTerrPreviewCtrl_getValue (string guiterrpreviewctrl) } /// /// Reset the view of the terrain.) +/// /// public void fn_GuiTerrPreviewCtrl_reset (string guiterrpreviewctrl) @@ -8129,7 +10176,9 @@ public void fn_GuiTerrPreviewCtrl_reset (string guiterrpreviewctrl) SafeNativeMethods.mwle_fn_GuiTerrPreviewCtrl_reset(sbguiterrpreviewctrl); } /// -/// (float x, float y) Set the origin of the view.) +/// (float x, float y) +/// Set the origin of the view.) +/// /// public void fn_GuiTerrPreviewCtrl_setOrigin (string guiterrpreviewctrl, string pos) @@ -8147,6 +10196,7 @@ public void fn_GuiTerrPreviewCtrl_setOrigin (string guiterrpreviewctrl, string p } /// /// Add the origin to the root and reset the origin.) +/// /// public void fn_GuiTerrPreviewCtrl_setRoot (string guiterrpreviewctrl) @@ -8160,7 +10210,9 @@ public void fn_GuiTerrPreviewCtrl_setRoot (string guiterrpreviewctrl) SafeNativeMethods.mwle_fn_GuiTerrPreviewCtrl_setRoot(sbguiterrpreviewctrl); } /// -/// Accepts a 4-tuple in the same form as getValue returns. @see GuiTerrPreviewCtrl::getValue()) +/// Accepts a 4-tuple in the same form as getValue returns. +/// @see GuiTerrPreviewCtrl::getValue()) +/// /// public void fn_GuiTerrPreviewCtrl_setValue (string guiterrpreviewctrl, string tuple) @@ -8178,6 +10230,7 @@ public void fn_GuiTerrPreviewCtrl_setValue (string guiterrpreviewctrl, string tu } /// /// textEditCtrl.selectText( %startBlock, %endBlock ) ) +/// /// public void fn_GuiTextEditCtrl_selectText (string guitexteditctrl, int startBlock, int endBlock) @@ -8192,6 +10245,7 @@ public void fn_GuiTextEditCtrl_selectText (string guitexteditctrl, int startBloc } /// /// ( [tick = true] ) - This will set this object to either be processing ticks or not ) +/// /// public void fn_GuiTickCtrl_setProcessTicks (string guitickctrl, bool tick) @@ -8206,6 +10260,7 @@ public void fn_GuiTickCtrl_setProcessTicks (string guitickctrl, bool tick) } /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void fn_GuiToolboxButtonCtrl_setHoverBitmap (string guitoolboxbuttonctrl, string name) @@ -8223,6 +10278,7 @@ public void fn_GuiToolboxButtonCtrl_setHoverBitmap (string guitoolboxbuttonctrl, } /// /// ( filepath name ) sets the bitmap that shows when the button is disabled) +/// /// public void fn_GuiToolboxButtonCtrl_setLoweredBitmap (string guitoolboxbuttonctrl, string name) @@ -8240,6 +10296,7 @@ public void fn_GuiToolboxButtonCtrl_setLoweredBitmap (string guitoolboxbuttonctr } /// /// ( filepath name ) sets the bitmap that shows when the button is active) +/// /// public void fn_GuiToolboxButtonCtrl_setNormalBitmap (string guitoolboxbuttonctrl, string name) @@ -8257,6 +10314,7 @@ public void fn_GuiToolboxButtonCtrl_setNormalBitmap (string guitoolboxbuttonctrl } /// /// addChildSelectionByValue(TreeItemId parent, value)) +/// /// public void fn_GuiTreeViewCtrl_addChildSelectionByValue (string guitreeviewctrl, int id, string tableEntry) @@ -8274,6 +10332,7 @@ public void fn_GuiTreeViewCtrl_addChildSelectionByValue (string guitreeviewctrl, } /// /// (builds an icon table)) +/// /// public bool fn_GuiTreeViewCtrl_buildIconTable (string guitreeviewctrl, string icons) @@ -8291,6 +10350,7 @@ public bool fn_GuiTreeViewCtrl_buildIconTable (string guitreeviewctrl, string ic } /// /// Build the visible tree) +/// /// public void fn_GuiTreeViewCtrl_buildVisibleTree (string guitreeviewctrl, bool forceFullUpdate) @@ -8305,6 +10365,7 @@ public void fn_GuiTreeViewCtrl_buildVisibleTree (string guitreeviewctrl, bool fo } /// /// For internal use. ) +/// /// public void fn_GuiTreeViewCtrl_cancelRename (string guitreeviewctrl) @@ -8319,6 +10380,7 @@ public void fn_GuiTreeViewCtrl_cancelRename (string guitreeviewctrl) } /// /// () - empty tree) +/// /// public void fn_GuiTreeViewCtrl_clear (string guitreeviewctrl) @@ -8333,6 +10395,7 @@ public void fn_GuiTreeViewCtrl_clear (string guitreeviewctrl) } /// /// (TreeItemId item, string newText, string newValue)) +/// /// public bool fn_GuiTreeViewCtrl_editItem (string guitreeviewctrl, int item, string newText, string newValue) @@ -8353,6 +10416,7 @@ public bool fn_GuiTreeViewCtrl_editItem (string guitreeviewctrl, int item, strin } /// /// (TreeItemId item, bool expand=true)) +/// /// public bool fn_GuiTreeViewCtrl_expandItem (string guitreeviewctrl, int id, bool expand) @@ -8367,6 +10431,7 @@ public bool fn_GuiTreeViewCtrl_expandItem (string guitreeviewctrl, int id, bool } /// /// (find item by object id and returns the mId)) +/// /// public int fn_GuiTreeViewCtrl_findItemByObjectId (string guitreeviewctrl, int itemId) @@ -8381,6 +10446,7 @@ public int fn_GuiTreeViewCtrl_findItemByObjectId (string guitreeviewctrl, int it } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getChild (string guitreeviewctrl, int itemId) @@ -8395,6 +10461,7 @@ public int fn_GuiTreeViewCtrl_getChild (string guitreeviewctrl, int itemId) } /// /// Get id for root item.) +/// /// public int fn_GuiTreeViewCtrl_getFirstRootItem (string guitreeviewctrl) @@ -8409,6 +10476,7 @@ public int fn_GuiTreeViewCtrl_getFirstRootItem (string guitreeviewctrl) } /// /// ) +/// /// public int fn_GuiTreeViewCtrl_getItemCount (string guitreeviewctrl) @@ -8423,6 +10491,7 @@ public int fn_GuiTreeViewCtrl_getItemCount (string guitreeviewctrl) } /// /// (TreeItemId item)) +/// /// public string fn_GuiTreeViewCtrl_getItemText (string guitreeviewctrl, int index) @@ -8440,6 +10509,7 @@ public string fn_GuiTreeViewCtrl_getItemText (string guitreeviewctrl, int index) } /// /// (TreeItemId item)) +/// /// public string fn_GuiTreeViewCtrl_getItemValue (string guitreeviewctrl, int itemId) @@ -8457,6 +10527,7 @@ public string fn_GuiTreeViewCtrl_getItemValue (string guitreeviewctrl, int itemI } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getNextSibling (string guitreeviewctrl, int itemId) @@ -8471,6 +10542,7 @@ public int fn_GuiTreeViewCtrl_getNextSibling (string guitreeviewctrl, int itemId } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getParentItem (string guitreeviewctrl, int itemId) @@ -8485,6 +10557,7 @@ public int fn_GuiTreeViewCtrl_getParentItem (string guitreeviewctrl, int itemId) } /// /// (TreeItemId item)) +/// /// public int fn_GuiTreeViewCtrl_getPrevSibling (string guitreeviewctrl, int itemId) @@ -8499,6 +10572,7 @@ public int fn_GuiTreeViewCtrl_getPrevSibling (string guitreeviewctrl, int itemId } /// /// ( int index=0 ) - Return the selected item at the given index.) +/// /// public int fn_GuiTreeViewCtrl_getSelectedItem (string guitreeviewctrl, int index) @@ -8513,6 +10587,7 @@ public int fn_GuiTreeViewCtrl_getSelectedItem (string guitreeviewctrl, int index } /// /// returns a space seperated list of mulitple item ids) +/// /// public string fn_GuiTreeViewCtrl_getSelectedItemList (string guitreeviewctrl) @@ -8530,6 +10605,7 @@ public string fn_GuiTreeViewCtrl_getSelectedItemList (string guitreeviewctrl) } /// /// ) +/// /// public int fn_GuiTreeViewCtrl_getSelectedItemsCount (string guitreeviewctrl) @@ -8544,6 +10620,7 @@ public int fn_GuiTreeViewCtrl_getSelectedItemsCount (string guitreeviewctrl) } /// /// ( int index=0 ) - Return the currently selected SimObject at the given index in inspector mode or -1) +/// /// public int fn_GuiTreeViewCtrl_getSelectedObject (string guitreeviewctrl, int index) @@ -8558,6 +10635,7 @@ public int fn_GuiTreeViewCtrl_getSelectedObject (string guitreeviewctrl, int ind } /// /// Returns a space sperated list of all selected object ids.) +/// /// public string fn_GuiTreeViewCtrl_getSelectedObjectList (string guitreeviewctrl) @@ -8575,6 +10653,7 @@ public string fn_GuiTreeViewCtrl_getSelectedObjectList (string guitreeviewctrl) } /// /// (TreeItemId item,Delimiter=none) gets the text from the current node to the root, concatenating at each branch upward, with a specified delimiter optionally) +/// /// public string fn_GuiTreeViewCtrl_getTextToRoot (string guitreeviewctrl, int itemId, string delimiter) @@ -8595,6 +10674,7 @@ public string fn_GuiTreeViewCtrl_getTextToRoot (string guitreeviewctrl, int item } /// /// ( int id ) - Returns true if the given item contains child items. ) +/// /// public bool fn_GuiTreeViewCtrl_isParentItem (string guitreeviewctrl, int id) @@ -8609,6 +10689,7 @@ public bool fn_GuiTreeViewCtrl_isParentItem (string guitreeviewctrl, int id) } /// /// (TreeItemId item, bool mark=true)) +/// /// public bool fn_GuiTreeViewCtrl_markItem (string guitreeviewctrl, int id, bool mark) @@ -8623,6 +10704,7 @@ public bool fn_GuiTreeViewCtrl_markItem (string guitreeviewctrl, int id, bool ma } /// /// (TreeItemId item)) +/// /// public void fn_GuiTreeViewCtrl_moveItemDown (string guitreeviewctrl, int index) @@ -8637,6 +10719,7 @@ public void fn_GuiTreeViewCtrl_moveItemDown (string guitreeviewctrl, int index) } /// /// (TreeItemId item)) +/// /// public void fn_GuiTreeViewCtrl_moveItemUp (string guitreeviewctrl, int index) @@ -8651,6 +10734,7 @@ public void fn_GuiTreeViewCtrl_moveItemUp (string guitreeviewctrl, int index) } /// /// For internal use. ) +/// /// public void fn_GuiTreeViewCtrl_onRenameValidate (string guitreeviewctrl) @@ -8665,6 +10749,7 @@ public void fn_GuiTreeViewCtrl_onRenameValidate (string guitreeviewctrl) } /// /// (SimSet obj, bool okToEdit=true) Set the root of the tree view to the specified object, or to the root set.) +/// /// public void fn_GuiTreeViewCtrl_open (string guitreeviewctrl, string objName, bool okToEdit) @@ -8682,6 +10767,7 @@ public void fn_GuiTreeViewCtrl_open (string guitreeviewctrl, string objName, boo } /// /// removeAllChildren(TreeItemId parent)) +/// /// public void fn_GuiTreeViewCtrl_removeAllChildren (string guitreeviewctrl, int itemId) @@ -8696,6 +10782,7 @@ public void fn_GuiTreeViewCtrl_removeAllChildren (string guitreeviewctrl, int it } /// /// removeChildSelectionByValue(TreeItemId parent, value)) +/// /// public void fn_GuiTreeViewCtrl_removeChildSelectionByValue (string guitreeviewctrl, int id, string tableEntry) @@ -8713,6 +10800,7 @@ public void fn_GuiTreeViewCtrl_removeChildSelectionByValue (string guitreeviewct } /// /// (TreeItemId item)) +/// /// public bool fn_GuiTreeViewCtrl_removeItem (string guitreeviewctrl, int itemId) @@ -8727,6 +10815,7 @@ public bool fn_GuiTreeViewCtrl_removeItem (string guitreeviewctrl, int itemId) } /// /// (deselects an item)) +/// /// public void fn_GuiTreeViewCtrl_removeSelection (string guitreeviewctrl, int id) @@ -8741,6 +10830,7 @@ public void fn_GuiTreeViewCtrl_removeSelection (string guitreeviewctrl, int id) } /// /// (TreeItemId item)) +/// /// public void fn_GuiTreeViewCtrl_scrollVisible (string guitreeviewctrl, int itemId) @@ -8755,6 +10845,7 @@ public void fn_GuiTreeViewCtrl_scrollVisible (string guitreeviewctrl, int itemId } /// /// (show item by object id. returns true if sucessful.)) +/// /// public int fn_GuiTreeViewCtrl_scrollVisibleByObjectId (string guitreeviewctrl, int itemId) @@ -8769,6 +10860,7 @@ public int fn_GuiTreeViewCtrl_scrollVisibleByObjectId (string guitreeviewctrl, i } /// /// (TreeItemId item, bool select=true)) +/// /// public bool fn_GuiTreeViewCtrl_selectItem (string guitreeviewctrl, int id, bool select) @@ -8783,6 +10875,7 @@ public bool fn_GuiTreeViewCtrl_selectItem (string guitreeviewctrl, int id, bool } /// /// ( bool value=true ) - Enable/disable debug output. ) +/// /// public void fn_GuiTreeViewCtrl_setDebug (string guitreeviewctrl, bool value) @@ -8797,6 +10890,7 @@ public void fn_GuiTreeViewCtrl_setDebug (string guitreeviewctrl, bool value) } /// /// ( int id, int normalImage, int expandedImage ) - Sets the normal and expanded images to show for the given item. ) +/// /// public void fn_GuiTreeViewCtrl_setItemImages (string guitreeviewctrl, int id, sbyte normalImage, sbyte expandedImage) @@ -8811,6 +10905,7 @@ public void fn_GuiTreeViewCtrl_setItemImages (string guitreeviewctrl, int id, sb } /// /// ( int id, string text ) - Set the tooltip to show for the given item. ) +/// /// public void fn_GuiTreeViewCtrl_setItemTooltip (string guitreeviewctrl, int id, string text) @@ -8828,6 +10923,7 @@ public void fn_GuiTreeViewCtrl_setItemTooltip (string guitreeviewctrl, int id, s } /// /// ( TreeItemId id ) - Show the rename text field for the given item (only one at a time). ) +/// /// public void fn_GuiTreeViewCtrl_showItemRenameCtrl (string guitreeviewctrl, int id) @@ -8842,6 +10938,7 @@ public void fn_GuiTreeViewCtrl_showItemRenameCtrl (string guitreeviewctrl, int i } /// /// ( int parent, bool traverseHierarchy=false, bool parentsFirst=false, bool caseSensitive=true ) - Sorts all items of the given parent (or root). With 'hierarchy', traverses hierarchy. ) +/// /// public void fn_GuiTreeViewCtrl_sort (string guitreeviewctrl, int parent, bool traverseHierarchy, bool parentsFirst, bool caseSensitive) @@ -8856,6 +10953,7 @@ public void fn_GuiTreeViewCtrl_sort (string guitreeviewctrl, int parent, bool tr } /// /// loadVars( searchString ) ) +/// /// public void fn_GuiVariableInspector_loadVars (string guivariableinspector, string searchString) @@ -8872,7 +10970,15 @@ public void fn_GuiVariableInspector_loadVars (string guivariableinspector, strin SafeNativeMethods.mwle_fn_GuiVariableInspector_loadVars(sbguivariableinspector, sbsearchString); } /// -/// Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param fileName The file name and path for the input PNG. @param padding The padding between characters. @param kerning The kerning between characters. @ingroup Font ) +/// Import an image strip from exportCachedFont. Call with the +/// same parameters you called exportCachedFont. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param fileName The file name and path for the input PNG. +/// @param padding The padding between characters. +/// @param kerning The kerning between characters. +/// @ingroup Font ) +/// /// public void fn_importCachedFont (string faceName, int fontSize, string fileName, int padding, int kerning) @@ -8889,7 +10995,17 @@ public void fn_importCachedFont (string faceName, int fontSize, string fileName, SafeNativeMethods.mwle_fn_importCachedFont(sbfaceName, fontSize, sbfileName, padding, kerning); } /// -/// @brief Start a search for items at the given position and within the given radius, filtering by mask. @param pos Center position for the search @param radius Search radius @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for items at the given position and within the given radius, filtering by mask. +/// +/// @param pos Center position for the search +/// @param radius Search radius +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void fn_initContainerRadiusSearch (string pos, float radius, uint mask, bool useClientContainer) @@ -8903,7 +11019,15 @@ public void fn_initContainerRadiusSearch (string pos, float radius, uint mask, b SafeNativeMethods.mwle_fn_initContainerRadiusSearch(sbpos, radius, mask, useClientContainer); } /// -/// @brief Start a search for all items of the types specified by the bitset mask. @param mask Bitmask of object types to include in the search @param useClientContainer Optionally indicates the search should be within the client container. @see containerSearchNext @ingroup Game) +/// @brief Start a search for all items of the types specified by the bitset mask. +/// +/// @param mask Bitmask of object types to include in the search +/// @param useClientContainer Optionally indicates the search should be within the +/// client container. +/// +/// @see containerSearchNext +/// @ingroup Game) +/// /// public void fn_initContainerTypeSearch (uint mask, bool useClientContainer) @@ -8914,7 +11038,10 @@ public void fn_initContainerTypeSearch (uint mask, bool useClientContainer) SafeNativeMethods.mwle_fn_initContainerTypeSearch(mask, useClientContainer); } /// -/// () @brief Initializes variables that track device and vendor information/IDs @ingroup Rendering) +/// () +/// @brief Initializes variables that track device and vendor information/IDs +/// @ingroup Rendering) +/// /// public void fn_initDisplayDeviceInfo () @@ -8926,7 +11053,14 @@ public void fn_initDisplayDeviceInfo () SafeNativeMethods.mwle_fn_initDisplayDeviceInfo(); } /// -/// Test whether the character at the given position is an alpha-numeric character. Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. @see isspace @ingroup Strings ) +/// Test whether the character at the given position is an alpha-numeric character. +/// Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9). +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is an alpha-numeric character; false otherwise. +/// @see isspace +/// @ingroup Strings ) +/// /// public bool fn_isalnum (string str, int index) @@ -8940,7 +11074,9 @@ public bool fn_isalnum (string str, int index) return SafeNativeMethods.mwle_fn_isalnum(sbstr, index)>=1; } /// -/// @brief Returns true if the passed identifier is the name of a declared class. @ingroup Console) +/// @brief Returns true if the passed identifier is the name of a declared class. +/// @ingroup Console) +/// /// public bool fn_isClass (string identifier) @@ -8954,7 +11090,10 @@ public bool fn_isClass (string identifier) return SafeNativeMethods.mwle_fn_isClass(sbidentifier)>=1; } /// -/// () Returns true if the calling script is a tools script. @hide) +/// () +/// Returns true if the calling script is a tools script. +/// @hide) +/// /// public bool fn_isCurrentScriptToolScript () @@ -8966,7 +11105,10 @@ public bool fn_isCurrentScriptToolScript () return SafeNativeMethods.mwle_fn_isCurrentScriptToolScript()>=1; } /// -/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. @return True if this is a debug build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality. +/// @return True if this is a debug build; false otherwise. +/// @ingroup Platform ) +/// /// public bool fn_isDebugBuild () @@ -8978,7 +11120,15 @@ public bool fn_isDebugBuild () return SafeNativeMethods.mwle_fn_isDebugBuild()>=1; } /// -/// ) , (string varName) @brief Determines if a variable exists and contains a value @param varName Name of the variable to search for @return True if the variable was defined in script, false if not @tsexample isDefined( \"$myVar\" ); @endtsexample @ingroup Scripting) +/// ) , (string varName) +/// @brief Determines if a variable exists and contains a value +/// @param varName Name of the variable to search for +/// @return True if the variable was defined in script, false if not +/// @tsexample +/// isDefined( \"$myVar\" ); +/// @endtsexample +/// @ingroup Scripting) +/// /// public bool fn_isDefined (string varName, string varValue) @@ -8996,6 +11146,7 @@ public bool fn_isDefined (string varName, string varValue) } /// /// ) +/// /// public bool fn_isDemo () @@ -9007,7 +11158,15 @@ public bool fn_isDemo () return SafeNativeMethods.mwle_fn_isDemo()>=1; } /// -/// @brief Determines if a specified directory exists or not @param directory String containing path in the form of \"foo/bar\" @return Returns true if the directory was found. @note Do not include a trailing slash '/'. @ingroup FileSystem) +/// @brief Determines if a specified directory exists or not +/// +/// @param directory String containing path in the form of \"foo/bar\" +/// @return Returns true if the directory was found. +/// +/// @note Do not include a trailing slash '/'. +/// +/// @ingroup FileSystem) +/// /// public bool fn_IsDirectory (string directory) @@ -9022,6 +11181,7 @@ public bool fn_IsDirectory (string directory) } /// /// isEventPending(%scheduleId);) +/// /// public bool fn_isEventPending (int scheduleId) @@ -9032,7 +11192,13 @@ public bool fn_isEventPending (int scheduleId) return SafeNativeMethods.mwle_fn_isEventPending(scheduleId)>=1; } /// -/// @brief Determines if the specified file exists or not @param fileName The path to the file. @return Returns true if the file was found. @ingroup FileSystem) +/// @brief Determines if the specified file exists or not +/// +/// @param fileName The path to the file. +/// @return Returns true if the file was found. +/// +/// @ingroup FileSystem) +/// /// public bool fn_isFile (string fileName) @@ -9046,7 +11212,12 @@ public bool fn_isFile (string fileName) return SafeNativeMethods.mwle_fn_isFile(sbfileName)>=1; } /// -/// (string funcName) @brief Determines if a function exists or not @param funcName String containing name of the function @return True if the function exists, false if not @ingroup Scripting) +/// (string funcName) +/// @brief Determines if a function exists or not +/// @param funcName String containing name of the function +/// @return True if the function exists, false if not +/// @ingroup Scripting) +/// /// public bool fn_isFunction (string funcName) @@ -9061,6 +11232,7 @@ public bool fn_isFunction (string funcName) } /// /// isJoystickDetected()) +/// /// public bool fn_isJoystickDetected () @@ -9072,7 +11244,11 @@ public bool fn_isJoystickDetected () return SafeNativeMethods.mwle_fn_isJoystickDetected()>=1; } /// -/// () @brief Queries input manager to see if a joystick is enabled @return 1 if a joystick exists and is enabled, 0 if it's not. @ingroup Input) +/// () +/// @brief Queries input manager to see if a joystick is enabled +/// @return 1 if a joystick exists and is enabled, 0 if it's not. +/// @ingroup Input) +/// /// public bool fn_isJoystickEnabled () @@ -9085,6 +11261,7 @@ public bool fn_isJoystickEnabled () } /// /// isKoreanBuild()) +/// /// public bool fn_isKoreanBuild () @@ -9096,7 +11273,12 @@ public bool fn_isKoreanBuild () return SafeNativeMethods.mwle_fn_isKoreanBuild()>=1; } /// -/// @brief Returns true if the class is derived from the super class. If either class doesn't exist this returns false. @param className The class name. @param superClassName The super class to look for. @ingroup Console) +/// @brief Returns true if the class is derived from the super class. +/// If either class doesn't exist this returns false. +/// @param className The class name. +/// @param superClassName The super class to look for. +/// @ingroup Console) +/// /// public bool fn_isMemberOfClass (string className, string superClassName) @@ -9113,7 +11295,13 @@ public bool fn_isMemberOfClass (string className, string superClassName) return SafeNativeMethods.mwle_fn_isMemberOfClass(sbclassName, sbsuperClassName)>=1; } /// -/// (string namespace, string method) @brief Determines if a class/namespace method exists @param namespace Class or namespace, such as Player @param method Name of the function to search for @return True if the method exists, false if not @ingroup Scripting) +/// (string namespace, string method) +/// @brief Determines if a class/namespace method exists +/// @param namespace Class or namespace, such as Player +/// @param method Name of the function to search for +/// @return True if the method exists, false if not +/// @ingroup Scripting) +/// /// public bool fn_isMethod (string nameSpace, string method) @@ -9131,6 +11319,7 @@ public bool fn_isMethod (string nameSpace, string method) } /// /// isObject(object)) +/// /// public bool fn_isObject (string objectName) @@ -9160,7 +11349,11 @@ public bool fn_isPackage (string identifier) return SafeNativeMethods.mwle_fn_isPackage(sbidentifier)>=1; } /// -/// (string queueName) @brief Determines if a dispatcher queue exists @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Determines if a dispatcher queue exists +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public bool fn_isQueueRegistered (string queueName) @@ -9174,7 +11367,10 @@ public bool fn_isQueueRegistered (string queueName) return SafeNativeMethods.mwle_fn_isQueueRegistered(sbqueueName)>=1; } /// -/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. @return True if this is a shipping build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release. +/// @return True if this is a shipping build; false otherwise. +/// @ingroup Platform ) +/// /// public bool fn_isShippingBuild () @@ -9186,7 +11382,14 @@ public bool fn_isShippingBuild () return SafeNativeMethods.mwle_fn_isShippingBuild()>=1; } /// -/// Test whether the character at the given position is a whitespace character. Characters such as tab, space, or newline are considered whitespace. @param str The string to test. @param index The index of a character in @a str. @return True if the character at the given index in @a str is a whitespace character; false otherwise. @see isalnum @ingroup Strings ) +/// Test whether the character at the given position is a whitespace character. +/// Characters such as tab, space, or newline are considered whitespace. +/// @param str The string to test. +/// @param index The index of a character in @a str. +/// @return True if the character at the given index in @a str is a whitespace character; false otherwise. +/// @see isalnum +/// @ingroup Strings ) +/// /// public bool fn_isspace (string str, int index) @@ -9200,7 +11403,10 @@ public bool fn_isspace (string str, int index) return SafeNativeMethods.mwle_fn_isspace(sbstr, index)>=1; } /// -/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. @return True if this is a tool build; false otherwise. @ingroup Platform ) +/// Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality. +/// @return True if this is a tool build; false otherwise. +/// @ingroup Platform ) +/// /// public bool fn_isToolBuild () @@ -9212,7 +11418,12 @@ public bool fn_isToolBuild () return SafeNativeMethods.mwle_fn_isToolBuild()>=1; } /// -/// ( string name ) @brief Return true if the given name makes for a valid object name. @param name Name of object @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character @ingroup Console) +/// ( string name ) +/// @brief Return true if the given name makes for a valid object name. +/// @param name Name of object +/// @return True if name is allowed, false if denied (usually because it starts with a number, _, or invalid character +/// @ingroup Console) +/// /// public bool fn_isValidObjectName (string name) @@ -9227,6 +11438,7 @@ public bool fn_isValidObjectName (string name) } /// /// ) +/// /// public bool fn_isWebDemo () @@ -9238,7 +11450,13 @@ public bool fn_isWebDemo () return SafeNativeMethods.mwle_fn_isWebDemo()>=1; } /// -/// @brief Determines if a file name can be written to using File I/O @param fileName Name and path of file to check @return Returns true if the file can be written to. @ingroup FileSystem) +/// @brief Determines if a file name can be written to using File I/O +/// +/// @param fileName Name and path of file to check +/// @return Returns true if the file can be written to. +/// +/// @ingroup FileSystem) +/// /// public bool fn_isWriteableFileName (string fileName) @@ -9252,7 +11470,13 @@ public bool fn_isWriteableFileName (string fileName) return SafeNativeMethods.mwle_fn_isWriteableFileName(sbfileName)>=1; } /// -/// ( int controllerID ) @brief Checks to see if an Xbox 360 controller is connected @param controllerID Zero-based index of the controller to check. @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput hasn't been initialized. @ingroup Input) +/// ( int controllerID ) +/// @brief Checks to see if an Xbox 360 controller is connected +/// @param controllerID Zero-based index of the controller to check. +/// @return 1 if the controller is connected, 0 if it isn't, and 205 if XInput +/// hasn't been initialized. +/// @ingroup Input) +/// /// public bool fn_isXInputConnected (int controllerID) @@ -9263,7 +11487,14 @@ public bool fn_isXInputConnected (int controllerID) return SafeNativeMethods.mwle_fn_isXInputConnected(controllerID)>=1; } /// -/// , ), (string filename, [string languageName]) @brief Adds a language to the table @param filename Name and path to the language file @param languageName Optional name to assign to the new language entry @return True If file was successfully found and language created ) +/// , ), +/// (string filename, [string languageName]) +/// @brief Adds a language to the table +/// @param filename Name and path to the language file +/// @param languageName Optional name to assign to the new language entry +/// @return True If file was successfully found and language created +/// ) +/// /// public int fn_LangTable_addLanguage (string langtable, string filename, string languageName) @@ -9283,7 +11514,10 @@ public int fn_LangTable_addLanguage (string langtable, string filename, string l return SafeNativeMethods.mwle_fn_LangTable_addLanguage(sblangtable, sbfilename, sblanguageName); } /// -/// () @brief Get the ID of the current language table @return Numerical ID of the current language table) +/// () +/// @brief Get the ID of the current language table +/// @return Numerical ID of the current language table) +/// /// public int fn_LangTable_getCurrentLanguage (string langtable) @@ -9297,7 +11531,11 @@ public int fn_LangTable_getCurrentLanguage (string langtable) return SafeNativeMethods.mwle_fn_LangTable_getCurrentLanguage(sblangtable); } /// -/// (int language) @brief Return the readable name of the language table @param language Numerical ID of the language table to access @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// (int language) +/// @brief Return the readable name of the language table +/// @param language Numerical ID of the language table to access +/// @return String containing the name of the table, NULL if ID was invalid or name was never specified) +/// /// public string fn_LangTable_getLangName (string langtable, int langId) @@ -9314,7 +11552,10 @@ public string fn_LangTable_getLangName (string langtable, int langId) } /// -/// () @brief Used to find out how many languages are in the table @return Size of the vector containing the languages, numerical) +/// () +/// @brief Used to find out how many languages are in the table +/// @return Size of the vector containing the languages, numerical) +/// /// public int fn_LangTable_getNumLang (string langtable) @@ -9328,7 +11569,13 @@ public int fn_LangTable_getNumLang (string langtable) return SafeNativeMethods.mwle_fn_LangTable_getNumLang(sblangtable); } /// -/// (string filename) @brief Grabs a string from the specified table If an invalid is passed, the function will attempt to to grab from the default table @param filename Name of the language table to access @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// (string filename) +/// @brief Grabs a string from the specified table +/// If an invalid is passed, the function will attempt to +/// to grab from the default table +/// @param filename Name of the language table to access +/// @return Text from the specified language table, \"\" if ID was invalid and default table is not set) +/// /// public string fn_LangTable_getString (string langtable, uint id) @@ -9345,7 +11592,10 @@ public string fn_LangTable_getString (string langtable, uint id) } /// -/// (int language) @brief Sets the current language table for grabbing text @param language ID of the table) +/// (int language) +/// @brief Sets the current language table for grabbing text +/// @param language ID of the table) +/// /// public void fn_LangTable_setCurrentLanguage (string langtable, int langId) @@ -9359,7 +11609,10 @@ public void fn_LangTable_setCurrentLanguage (string langtable, int langId) SafeNativeMethods.mwle_fn_LangTable_setCurrentLanguage(sblangtable, langId); } /// -/// (int language) @brief Sets the default language table @param language ID of the table) +/// (int language) +/// @brief Sets the default language table +/// @param language ID of the table) +/// /// public void fn_LangTable_setDefaultLanguage (string langtable, int langId) @@ -9374,6 +11627,7 @@ public void fn_LangTable_setDefaultLanguage (string langtable, int langId) } /// /// Stops the light animation. ) +/// /// public void fn_LightBase_pauseAnimation (string lightbase) @@ -9387,7 +11641,11 @@ public void fn_LightBase_pauseAnimation (string lightbase) SafeNativeMethods.mwle_fn_LightBase_pauseAnimation(sblightbase); } /// -/// ), ( [LightAnimData anim] )\t Plays a light animation on the light. If no LightAnimData is passed the existing one is played. @hide) +/// ), ( [LightAnimData anim] )\t +/// Plays a light animation on the light. If no LightAnimData is passed the +/// existing one is played. +/// @hide) +/// /// public void fn_LightBase_playAnimation (string lightbase, string anim) @@ -9404,7 +11662,15 @@ public void fn_LightBase_playAnimation (string lightbase, string anim) SafeNativeMethods.mwle_fn_LightBase_playAnimation(sblightbase, sbanim); } /// -/// Will generate static lighting for the scene if supported by the active light manager. If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps will be regenerated only if the lighting cache files can be written. @param completeCallbackFn The name of the function to execute when the lighting is complete. @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". @return Returns true if the scene lighting process was started. @ingroup Lighting ) +/// Will generate static lighting for the scene if supported by the active light manager. +/// If mode is \"forceAlways\", the lightmaps will be regenerated regardless of whether +/// lighting cache files can be written to. If mode is \"forceWritable\", then the lightmaps +/// will be regenerated only if the lighting cache files can be written. +/// @param completeCallbackFn The name of the function to execute when the lighting is complete. +/// @param mode One of \"forceAlways\", \"forceWritable\" or \"loadOnly\". +/// @return Returns true if the scene lighting process was started. +/// @ingroup Lighting ) +/// /// public bool fn_lightScene (string completeCallbackFn, string mode) @@ -9421,7 +11687,10 @@ public bool fn_lightScene (string completeCallbackFn, string mode) return SafeNativeMethods.mwle_fn_lightScene(sbcompleteCallbackFn, sbmode)>=1; } /// -/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. @ingroup GFX @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details. +/// @ingroup GFX +/// @see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources ) +/// /// public void fn_listGFXResources (bool unflaggedOnly) @@ -9432,7 +11701,29 @@ public void fn_listGFXResources (bool unflaggedOnly) SafeNativeMethods.mwle_fn_listGFXResources(unflaggedOnly); } /// -/// , ), (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) Load all light instances from a COLLADA (.dae) file and add to the scene. @param filename COLLADA filename to load lights from @param parentGroup (optional) name of an existing simgroup to add the new lights to (defaults to MissionGroup) @param baseObject (optional) name of an object to use as the origin (useful if you are loading the lights for a collada scene and have moved or rotated the geometry) @return true if successful, false otherwise @tsexample // load the lights in room.dae loadColladaLights( \"art/shapes/collada/room.dae\" ); // load the lights in room.dae and add them to the RoomLights group loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); // load the lights in room.dae and use the transform of the \"Room\" object as the origin loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); @endtsexample @note Currently for editor use only @ingroup Editors @internal) +/// , ), +/// (string filename, SimGroup parentGroup=MissionGroup, SimObject baseObject=-1) +/// Load all light instances from a COLLADA (.dae) file and add to the scene. +/// @param filename COLLADA filename to load lights from +/// @param parentGroup (optional) name of an existing simgroup to add the new +/// lights to (defaults to MissionGroup) +/// @param baseObject (optional) name of an object to use as the origin (useful +/// if you are loading the lights for a collada scene and have moved or rotated +/// the geometry) +/// @return true if successful, false otherwise +/// @tsexample +/// // load the lights in room.dae +/// loadColladaLights( \"art/shapes/collada/room.dae\" ); +/// // load the lights in room.dae and add them to the RoomLights group +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"RoomLights\" ); +/// // load the lights in room.dae and use the transform of the \"Room\" +/// object as the origin +/// loadColladaLights( \"art/shapes/collada/room.dae\", \"\", \"Room\" ); +/// @endtsexample +/// @note Currently for editor use only +/// @ingroup Editors +/// @internal) +/// /// public bool fn_loadColladaLights (string filename, string parentGroup, string baseObject) @@ -9452,7 +11743,10 @@ public bool fn_loadColladaLights (string filename, string parentGroup, string ba return SafeNativeMethods.mwle_fn_loadColladaLights(sbfilename, sbparentGroup, sbbaseObject)>=1; } /// -/// @brief Loads a serialized object from a file. @param Name and path to text file containing the object @ingroup Console) +/// @brief Loads a serialized object from a file. +/// @param Name and path to text file containing the object +/// @ingroup Console) +/// /// public string fn_loadObject (string filename) @@ -9469,7 +11763,11 @@ public string fn_loadObject (string filename) } /// -/// (bool isLocked) @brief Lock or unlock the mouse to the window. When true, prevents the mouse from leaving the bounds of the game window. @ingroup Input) +/// (bool isLocked) +/// @brief Lock or unlock the mouse to the window. +/// When true, prevents the mouse from leaving the bounds of the game window. +/// @ingroup Input) +/// /// public void fn_lockMouse (bool isLocked) @@ -9534,7 +11832,16 @@ public void fn_logWarning (string message) SafeNativeMethods.mwle_fn_logWarning(sbmessage); } /// -/// Remove leading whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. @tsexample ltrim( \" string \" ); // Returns \"string \". @endtsexample @see rtrim @see trim @ingroup Strings ) +/// Remove leading whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed. +/// @tsexample +/// ltrim( \" string \" ); // Returns \"string \". +/// @endtsexample +/// @see rtrim +/// @see trim +/// @ingroup Strings ) +/// /// public string fn_ltrim (string str) @@ -9551,7 +11858,10 @@ public string fn_ltrim (string str) } /// -/// Return the value of 2*PI (full-circle in radians). @returns The value of 2*PI. @ingroup Math ) +/// Return the value of 2*PI (full-circle in radians). +/// @returns The value of 2*PI. +/// @ingroup Math ) +/// /// public float fn_m2Pi () @@ -9563,7 +11873,11 @@ public float fn_m2Pi () return SafeNativeMethods.mwle_fn_m2Pi(); } /// -/// Calculate absolute value of specified value. @param v Input Value. @returns Absolute value of specified value. @ingroup Math ) +/// Calculate absolute value of specified value. +/// @param v Input Value. +/// @returns Absolute value of specified value. +/// @ingroup Math ) +/// /// public float fn_mAbs (float v) @@ -9574,7 +11888,11 @@ public float fn_mAbs (float v) return SafeNativeMethods.mwle_fn_mAbs(v); } /// -/// Calculate the arc-cosine of v. @param v Input Value (in radians). @returns The arc-cosine of the input value. @ingroup Math ) +/// Calculate the arc-cosine of v. +/// @param v Input Value (in radians). +/// @returns The arc-cosine of the input value. +/// @ingroup Math ) +/// /// public float fn_mAcos (float v) @@ -9585,7 +11903,15 @@ public float fn_mAcos (float v) return SafeNativeMethods.mwle_fn_mAcos(v); } /// -/// ), @brief Converts a relative file path to a full path For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" @param path Name of file or path to check @param cwd Optional current working directory from which to build the full path. @return String containing non-relative directory of path @ingroup FileSystem) +/// ), +/// @brief Converts a relative file path to a full path +/// +/// For example, \"./console.log\" becomes \"C:/Torque/t3d/examples/FPS Example/game/console.log\" +/// @param path Name of file or path to check +/// @param cwd Optional current working directory from which to build the full path. +/// @return String containing non-relative directory of path +/// @ingroup FileSystem) +/// /// public string fn_makeFullPath (string path, string cwd) @@ -9605,7 +11931,16 @@ public string fn_makeFullPath (string path, string cwd) } /// -/// ), @brief Turns a full or local path to a relative one For example, \"./game/art\" becomes \"game/art\" @param path Full path (may include a file) to convert @param to Optional base path used for the conversion. If not supplied the current working directory is used. @returns String containing relative path @ingroup FileSystem) +/// ), +/// @brief Turns a full or local path to a relative one +/// +/// For example, \"./game/art\" becomes \"game/art\" +/// @param path Full path (may include a file) to convert +/// @param to Optional base path used for the conversion. If not supplied the current +/// working directory is used. +/// @returns String containing relative path +/// @ingroup FileSystem) +/// /// public string fn_makeRelativePath (string path, string to) @@ -9625,7 +11960,11 @@ public string fn_makeRelativePath (string path, string to) } /// -/// Calculate the arc-sine of v. @param v Input Value (in radians). @returns The arc-sine of the input value. @ingroup Math ) +/// Calculate the arc-sine of v. +/// @param v Input Value (in radians). +/// @returns The arc-sine of the input value. +/// @ingroup Math ) +/// /// public float fn_mAsin (float v) @@ -9636,7 +11975,12 @@ public float fn_mAsin (float v) return SafeNativeMethods.mwle_fn_mAsin(v); } /// -/// Calculate the arc-tangent (slope) of a line defined by rise and run. @param rise of line. @param run of line. @returns The arc-tangent (slope) of a line defined by rise and run. @ingroup Math ) +/// Calculate the arc-tangent (slope) of a line defined by rise and run. +/// @param rise of line. +/// @param run of line. +/// @returns The arc-tangent (slope) of a line defined by rise and run. +/// @ingroup Math ) +/// /// public float fn_mAtan (float rise, float run) @@ -9648,6 +11992,7 @@ public float fn_mAtan (float rise, float run) } /// /// Dumps a formatted list of the currently allocated material instances for this material to the console. ) +/// /// public void fn_Material_dumpInstances (string material) @@ -9662,6 +12007,7 @@ public void fn_Material_dumpInstances (string material) } /// /// Flushes all material instances that use this material. ) +/// /// public void fn_Material_flush (string material) @@ -9676,6 +12022,7 @@ public void fn_Material_flush (string material) } /// /// ) +/// /// public string fn_Material_getAnimFlags (string material, uint id) @@ -9693,6 +12040,7 @@ public string fn_Material_getAnimFlags (string material, uint id) } /// /// Get filename of material) +/// /// public string fn_Material_getFilename (string material) @@ -9710,6 +12058,7 @@ public string fn_Material_getFilename (string material) } /// /// Returns true if this Material was automatically generated by MaterialList::mapMaterials() ) +/// /// public bool fn_Material_isAutoGenerated (string material) @@ -9724,6 +12073,7 @@ public bool fn_Material_isAutoGenerated (string material) } /// /// Reloads all material instances that use this material. ) +/// /// public void fn_Material_reload (string material) @@ -9738,6 +12088,7 @@ public void fn_Material_reload (string material) } /// /// setAutoGenerated(bool isAutoGenerated): Set whether or not the Material is autogenerated. ) +/// /// public void fn_Material_setAutoGenerated (string material, bool isAutoGenerated) @@ -9751,7 +12102,12 @@ public void fn_Material_setAutoGenerated (string material, bool isAutoGenerated) SafeNativeMethods.mwle_fn_Material_setAutoGenerated(sbmaterial, isAutoGenerated); } /// -/// Create a transform from the given translation and orientation. @param position The translation vector for the transform. @param orientation The axis and rotation that orients the transform. @return A transform based on the given position and orientation. @ingroup Matrices ) +/// Create a transform from the given translation and orientation. +/// @param position The translation vector for the transform. +/// @param orientation The axis and rotation that orients the transform. +/// @return A transform based on the given position and orientation. +/// @ingroup Matrices ) +/// /// public string fn_MatrixCreate (string position, string orientation) @@ -9771,7 +12127,11 @@ public string fn_MatrixCreate (string position, string orientation) } /// -/// @Create a matrix from the given rotations. @param Vector3F X, Y, and Z rotation in *radians*. @return A transform based on the given orientation. @ingroup Matrices ) +/// @Create a matrix from the given rotations. +/// @param Vector3F X, Y, and Z rotation in *radians*. +/// @return A transform based on the given orientation. +/// @ingroup Matrices ) +/// /// public string fn_MatrixCreateFromEuler (string angles) @@ -9788,7 +12148,13 @@ public string fn_MatrixCreateFromEuler (string angles) } /// -/// @brief Multiply the given point by the given transform assuming that w=1. This function will multiply the given vector such that translation with take effect. @param transform A transform. @param point A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the given point by the given transform assuming that w=1. +/// This function will multiply the given vector such that translation with take effect. +/// @param transform A transform. +/// @param point A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public string fn_MatrixMulPoint (string transform, string point) @@ -9808,7 +12174,12 @@ public string fn_MatrixMulPoint (string transform, string point) } /// -/// @brief Multiply the two matrices. @param left First transform. @param right Right transform. @return Concatenation of the two transforms. @ingroup Matrices ) +/// @brief Multiply the two matrices. +/// @param left First transform. +/// @param right Right transform. +/// @return Concatenation of the two transforms. +/// @ingroup Matrices ) +/// /// public string fn_MatrixMultiply (string left, string right) @@ -9828,7 +12199,14 @@ public string fn_MatrixMultiply (string left, string right) } /// -/// @brief Multiply the vector by the transform assuming that w=0. This function will multiply the given vector by the given transform such that translation will not affect the vector. @param transform A transform. @param vector A vector. @return The transformed vector. @ingroup Matrices) +/// @brief Multiply the vector by the transform assuming that w=0. +/// This function will multiply the given vector by the given transform such that translation will +/// not affect the vector. +/// @param transform A transform. +/// @param vector A vector. +/// @return The transformed vector. +/// @ingroup Matrices) +/// /// public string fn_MatrixMulVector (string transform, string vector) @@ -9848,7 +12226,11 @@ public string fn_MatrixMulVector (string transform, string vector) } /// -/// Round v up to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v up to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int fn_mCeil (float v) @@ -9859,7 +12241,13 @@ public int fn_mCeil (float v) return SafeNativeMethods.mwle_fn_mCeil(v); } /// -/// Clamp the specified value between two bounds. @param v Input value. @param min Minimum Bound. @param max Maximum Bound. @returns The specified value clamped to the specified bounds. @ingroup Math ) +/// Clamp the specified value between two bounds. +/// @param v Input value. +/// @param min Minimum Bound. +/// @param max Maximum Bound. +/// @returns The specified value clamped to the specified bounds. +/// @ingroup Math ) +/// /// public float fn_mClamp (float v, float min, float max) @@ -9870,7 +12258,11 @@ public float fn_mClamp (float v, float min, float max) return SafeNativeMethods.mwle_fn_mClamp(v, min, max); } /// -/// Calculate the cosine of v. @param v Input Value (in radians). @returns The cosine of the input value. @ingroup Math ) +/// Calculate the cosine of v. +/// @param v Input Value (in radians). +/// @returns The cosine of the input value. +/// @ingroup Math ) +/// /// public float fn_mCos (float v) @@ -9881,7 +12273,11 @@ public float fn_mCos (float v) return SafeNativeMethods.mwle_fn_mCos(v); } /// -/// Convert specified degrees into radians. @param degrees Input Value (in degrees). @returns The specified degrees value converted to radians. @ingroup Math ) +/// Convert specified degrees into radians. +/// @param degrees Input Value (in degrees). +/// @returns The specified degrees value converted to radians. +/// @ingroup Math ) +/// /// public float fn_mDegToRad (float degrees) @@ -9893,6 +12289,7 @@ public float fn_mDegToRad (float degrees) } /// /// ( SimObject obj )) +/// /// public void fn_MECreateUndoAction_addObject (string mecreateundoaction, string obj) @@ -9910,6 +12307,7 @@ public void fn_MECreateUndoAction_addObject (string mecreateundoaction, string o } /// /// ( SimObject obj )) +/// /// public void fn_MEDeleteUndoAction_deleteObject (string medeleteundoaction, string obj) @@ -9927,6 +12325,7 @@ public void fn_MEDeleteUndoAction_deleteObject (string medeleteundoaction, strin } /// /// (GuiCanvas, pos)) +/// /// public void fn_MenuBar_attachToCanvas (string menubar, string canvas, int pos) @@ -9944,6 +12343,7 @@ public void fn_MenuBar_attachToCanvas (string menubar, string canvas, int pos) } /// /// (object, pos) insert object at position) +/// /// public void fn_MenuBar_insert (string menubar, string pObject, int pos) @@ -9961,6 +12361,7 @@ public void fn_MenuBar_insert (string menubar, string pObject, int pos) } /// /// ()) +/// /// public void fn_MenuBar_removeFromCanvas (string menubar) @@ -9975,6 +12376,7 @@ public void fn_MenuBar_removeFromCanvas (string menubar) } /// /// () Increment the reference count for this message) +/// /// public void fn_Message_addReference (string message) @@ -9989,6 +12391,7 @@ public void fn_Message_addReference (string message) } /// /// () Decrement the reference count for this message) +/// /// public void fn_Message_freeReference (string message) @@ -10003,6 +12406,7 @@ public void fn_Message_freeReference (string message) } /// /// () Get message type (script class name or C++ class name if no script defined class)) +/// /// public string fn_Message_getType (string message) @@ -10019,7 +12423,16 @@ public string fn_Message_getType (string message) } /// -/// Display a modal message box using the platform's native message box implementation. @param title The title to display on the message box window. @param message The text message to display in the box. @param buttons Which buttons to put on the message box. @param icons Which icon to show next to the message. @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. @tsexample messageBox( \"Error\", \"\" ); @endtsexample @ingroup Platform ) +/// Display a modal message box using the platform's native message box implementation. +/// @param title The title to display on the message box window. +/// @param message The text message to display in the box. +/// @param buttons Which buttons to put on the message box. +/// @param icons Which icon to show next to the message. +/// @return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed. +/// @tsexample +/// messageBox( \"Error\", \"\" ); @endtsexample +/// @ingroup Platform ) +/// /// public int fn_messageBox (string title, string message, int buttons, int icons) @@ -10036,7 +12449,10 @@ public int fn_messageBox (string title, string message, int buttons, int icons) return SafeNativeMethods.mwle_fn_messageBox(sbtitle, sbmessage, buttons, icons); } /// -/// ), (string filename, string header=NULL) Dump the message vector to a file, optionally prefixing a header. @hide) +/// ), (string filename, string header=NULL) +/// Dump the message vector to a file, optionally prefixing a header. +/// @hide) +/// /// public void fn_MessageVector_dump (string messagevector, string filename, string header) @@ -10056,7 +12472,12 @@ public void fn_MessageVector_dump (string messagevector, string filename, string SafeNativeMethods.mwle_fn_MessageVector_dump(sbmessagevector, sbfilename, sbheader); } /// -/// Formats the specified number to the given number of decimal places. @param v Number to format. @param precision Number of decimal places to format to (1-9). @returns Number formatted to the specified number of decimal places. @ingroup Math ) +/// Formats the specified number to the given number of decimal places. +/// @param v Number to format. +/// @param precision Number of decimal places to format to (1-9). +/// @returns Number formatted to the specified number of decimal places. +/// @ingroup Math ) +/// /// public string fn_mFloatLength (float v, uint precision) @@ -10070,7 +12491,11 @@ public string fn_mFloatLength (float v, uint precision) } /// -/// Round v down to the nearest integer. @param v Number to convert to integer. @returns Number converted to integer. @ingroup Math ) +/// Round v down to the nearest integer. +/// @param v Number to convert to integer. +/// @returns Number converted to integer. +/// @ingroup Math ) +/// /// public int fn_mFloor (float v) @@ -10081,7 +12506,12 @@ public int fn_mFloor (float v) return SafeNativeMethods.mwle_fn_mFloor(v); } /// -/// Calculate the remainder of v/d. @param v Input Value. @param d Divisor Value. @returns The remainder of v/d. @ingroup Math ) +/// Calculate the remainder of v/d. +/// @param v Input Value. +/// @param d Divisor Value. +/// @returns The remainder of v/d. +/// @ingroup Math ) +/// /// public float fn_mFMod (float v, float d) @@ -10092,7 +12522,11 @@ public float fn_mFMod (float v, float d) return SafeNativeMethods.mwle_fn_mFMod(v, d); } /// -/// Returns whether the value is an exact power of two. @param v Input value. @returns Whether the specified value is an exact power of two. @ingroup Math ) +/// Returns whether the value is an exact power of two. +/// @param v Input value. +/// @returns Whether the specified value is an exact power of two. +/// @ingroup Math ) +/// /// public bool fn_mIsPow2 (int v) @@ -10103,7 +12537,13 @@ public bool fn_mIsPow2 (int v) return SafeNativeMethods.mwle_fn_mIsPow2(v)>=1; } /// -/// Calculate linearly interpolated value between two specified numbers using specified normalized time. @param v1 Interpolate From Input value. @param v2 Interpolate To Input value. @param time Normalized time used to interpolate values (0-1). @returns The interpolated value between the two specified values at normalized time t. @ingroup Math ) +/// Calculate linearly interpolated value between two specified numbers using specified normalized time. +/// @param v1 Interpolate From Input value. +/// @param v2 Interpolate To Input value. +/// @param time Normalized time used to interpolate values (0-1). +/// @returns The interpolated value between the two specified values at normalized time t. +/// @ingroup Math ) +/// /// public float fn_mLerp (float v1, float v2, float time) @@ -10114,7 +12554,11 @@ public float fn_mLerp (float v1, float v2, float time) return SafeNativeMethods.mwle_fn_mLerp(v1, v2, time); } /// -/// Calculate the natural logarithm of v. @param v Input Value. @returns The natural logarithm of the input value. @ingroup Math ) +/// Calculate the natural logarithm of v. +/// @param v Input Value. +/// @returns The natural logarithm of the input value. +/// @ingroup Math ) +/// /// public float fn_mLog (float v) @@ -10125,7 +12569,10 @@ public float fn_mLog (float v) return SafeNativeMethods.mwle_fn_mLog(v); } /// -/// Return the value of PI (half-circle in radians). @returns The value of PI. @ingroup Math ) +/// Return the value of PI (half-circle in radians). +/// @returns The value of PI. +/// @ingroup Math ) +/// /// public float fn_mPi () @@ -10137,7 +12584,12 @@ public float fn_mPi () return SafeNativeMethods.mwle_fn_mPi(); } /// -/// Calculate b raised to the p-th power. @param v Input Value. @param p Power to raise value by. @returns v raised to the p-th power. @ingroup Math ) +/// Calculate b raised to the p-th power. +/// @param v Input Value. +/// @param p Power to raise value by. +/// @returns v raised to the p-th power. +/// @ingroup Math ) +/// /// public float fn_mPow (float v, float p) @@ -10148,7 +12600,11 @@ public float fn_mPow (float v, float p) return SafeNativeMethods.mwle_fn_mPow(v, p); } /// -/// Convert specified radians into degrees. @param radians Input Value (in radians). @returns The specified radians value converted to degrees. @ingroup Math ) +/// Convert specified radians into degrees. +/// @param radians Input Value (in radians). +/// @returns The specified radians value converted to degrees. +/// @ingroup Math ) +/// /// public float fn_mRadToDeg (float radians) @@ -10159,7 +12615,12 @@ public float fn_mRadToDeg (float radians) return SafeNativeMethods.mwle_fn_mRadToDeg(radians); } /// -/// Round v to the nth decimal place or the nearest whole number by default. @param v Value to roundn @param n Number of decimal places to round to, 0 by defaultn @return The rounded value as a S32. @ingroup Math ) +/// Round v to the nth decimal place or the nearest whole number by default. +/// @param v Value to roundn +/// @param n Number of decimal places to round to, 0 by defaultn +/// @return The rounded value as a S32. +/// @ingroup Math ) +/// /// public float fn_mRound (float v, int n) @@ -10170,7 +12631,11 @@ public float fn_mRound (float v, int n) return SafeNativeMethods.mwle_fn_mRound(v, n); } /// -/// Clamp the specified value between 0 and 1 (inclusive). @param v Input value. @returns The specified value clamped between 0 and 1 (inclusive). @ingroup Math ) +/// Clamp the specified value between 0 and 1 (inclusive). +/// @param v Input value. +/// @returns The specified value clamped between 0 and 1 (inclusive). +/// @ingroup Math ) +/// /// public float fn_mSaturate (float v) @@ -10181,7 +12646,11 @@ public float fn_mSaturate (float v) return SafeNativeMethods.mwle_fn_mSaturate(v); } /// -/// Calculate the sine of v. @param v Input Value (in radians). @returns The sine of the input value. @ingroup Math ) +/// Calculate the sine of v. +/// @param v Input Value (in radians). +/// @returns The sine of the input value. +/// @ingroup Math ) +/// /// public float fn_mSin (float v) @@ -10192,7 +12661,15 @@ public float fn_mSin (float v) return SafeNativeMethods.mwle_fn_mSin(v); } /// -/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. @ingroup Math ) +/// Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions +/// (being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any. +/// @ingroup Math ) +/// /// public string fn_mSolveCubic (float a, float b, float c, float d) @@ -10206,7 +12683,14 @@ public string fn_mSolveCubic (float a, float b, float c, float d) } /// -/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. @ingroup Math ) +/// Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @returns A triple, containing: (sol x0 x1). (sol) is the number of solutions +/// (being 0, 1, or 2), and (x0) and (x1) are the solutions, if any. +/// @ingroup Math ) +/// /// public string fn_mSolveQuadratic (float a, float b, float c) @@ -10220,7 +12704,16 @@ public string fn_mSolveQuadratic (float a, float b, float c) } /// -/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. @param a First Coefficient. @param b Second Coefficient. @param c Third Coefficient. @param d Fourth Coefficient. @param e Fifth Coefficient. @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. @ingroup Math ) +/// Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. +/// @param a First Coefficient. +/// @param b Second Coefficient. +/// @param c Third Coefficient. +/// @param d Fourth Coefficient. +/// @param e Fifth Coefficient. +/// @returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions +/// (being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any. +/// @ingroup Math ) +/// /// public string fn_mSolveQuartic (float a, float b, float c, float d, float e) @@ -10234,7 +12727,11 @@ public string fn_mSolveQuartic (float a, float b, float c, float d, float e) } /// -/// Calculate the square-root of v. @param v Input Value. @returns The square-root of the input value. @ingroup Math ) +/// Calculate the square-root of v. +/// @param v Input Value. +/// @returns The square-root of the input value. +/// @ingroup Math ) +/// /// public float fn_mSqrt (float v) @@ -10245,7 +12742,11 @@ public float fn_mSqrt (float v) return SafeNativeMethods.mwle_fn_mSqrt(v); } /// -/// Calculate the tangent of v. @param v Input Value (in radians). @returns The tangent of the input value. @ingroup Math ) +/// Calculate the tangent of v. +/// @param v Input Value (in radians). +/// @returns The tangent of the input value. +/// @ingroup Math ) +/// /// public float fn_mTan (float v) @@ -10257,6 +12758,7 @@ public float fn_mTan (float v) } /// /// nameToID(object)) +/// /// public int fn_nameToID (string objectName) @@ -10270,17 +12772,44 @@ public int fn_nameToID (string objectName) return SafeNativeMethods.mwle_fn_nameToID(sbobjectName); } /// -/// ( string str, string token, string delimiters ) Tokenize a string using a set of delimiting characters. This function first skips all leading charaters in @a str that are contained in @a delimiters. From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str until the function returns \"\". @param str A string. @param token The name of the variable in which to store the current token. This variable is set in the scope in which nextToken is called. @param delimiters A string of characters. Each character is considered a delimiter. @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. @tsexample // Prints: // a // b // c %str = \"a b c\"; while ( %str !$= \"\" ) { // First time, stores \"a\" in the variable %token and sets %str to \"b c\". %str = nextToken( %str, \"token\", \" \" ); echo( %token ); } @endtsexample @ingroup Strings ) +/// ( string str, string token, string delimiters ) +/// Tokenize a string using a set of delimiting characters. +/// This function first skips all leading charaters in @a str that are contained in @a delimiters. +/// From that position, it then scans for the next character in @a str that is contained in @a delimiters and stores all characters +/// from the starting position up to the first delimiter in a variable in the current scope called @a token. Finally, it +/// skips all characters in @a delimiters after the token and then returns the remaining string contents in @a str. +/// To scan out all tokens in a string, call this function repeatedly by passing the result it returns each time as the new @a str +/// until the function returns \"\". +/// @param str A string. +/// @param token The name of the variable in which to store the current token. This variable is set in the +/// scope in which nextToken is called. +/// @param delimiters A string of characters. Each character is considered a delimiter. +/// @return The remainder of @a str after the token has been parsed out or \"\" if no more tokens were found in @a str. +/// @tsexample +/// // Prints: +/// // a +/// // b +/// // c +/// %str = \"a b c\"; +/// while ( %str !$= \"\" ) +/// { +/// // First time, stores \"a\" in the variable %token and sets %str to \"b c\". +/// %str = nextToken( %str, \"token\", \" \" ); +/// echo( %token ); +/// } +/// @endtsexample +/// @ingroup Strings ) +/// /// -public string fn_nextToken (string str, string token, string delim) +public string fn_nextToken (string str1, string token, string delim) { if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_nextToken'" + string.Format("\"{0}\" \"{1}\" \"{2}\" ",str,token,delim)); +System.Console.WriteLine("----------------->Extern Call 'fn_nextToken'" + string.Format("\"{0}\" \"{1}\" \"{2}\" ",str1,token,delim)); var returnbuff = new StringBuilder(16384); -StringBuilder sbstr = null; -if (str != null) - sbstr = new StringBuilder(str, 1024); +StringBuilder sbstr1 = null; +if (str1 != null) + sbstr1 = new StringBuilder(str1, 1024); StringBuilder sbtoken = null; if (token != null) sbtoken = new StringBuilder(token, 1024); @@ -10288,12 +12817,17 @@ public string fn_nextToken (string str, string token, string delim) if (delim != null) sbdelim = new StringBuilder(delim, 1024); -SafeNativeMethods.mwle_fn_nextToken(sbstr, sbtoken, sbdelim, returnbuff); +SafeNativeMethods.mwle_fn_nextToken(sbstr1, sbtoken, sbdelim, returnbuff); return returnbuff.ToString(); } /// -/// @brief Open the given @a file through the system. This will usually open the file in its associated application. @param file %Path of the file to open. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given @a file through the system. This will usually open the file in its +/// associated application. +/// @param file %Path of the file to open. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void fn_openFile (string file) @@ -10307,7 +12841,11 @@ public void fn_openFile (string file) SafeNativeMethods.mwle_fn_openFile(sbfile); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void fn_openFolder (string path) @@ -10321,7 +12859,13 @@ public void fn_openFolder (string path) SafeNativeMethods.mwle_fn_openFolder(sbpath); } /// -/// @brief Combines two separate strings containing a file path and file name together into a single string @param path String containing file path @param file String containing file name @return String containing concatenated file name and path @ingroup FileSystem) +/// @brief Combines two separate strings containing a file path and file name together into a single string +/// +/// @param path String containing file path +/// @param file String containing file name +/// @return String containing concatenated file name and path +/// @ingroup FileSystem) +/// /// public string fn_pathConcat (string path, string file) @@ -10341,7 +12885,14 @@ public string fn_pathConcat (string path, string file) } /// -/// @brief Copy a file to a new location. @param fromFile %Path of the file to copy. @param toFile %Path where to copy @a fromFile to. @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. @return True if the file was successfully copied, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Copy a file to a new location. +/// @param fromFile %Path of the file to copy. +/// @param toFile %Path where to copy @a fromFile to. +/// @param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile. +/// @return True if the file was successfully copied, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_pathCopy (string fromFile, string toFile, bool noOverwrite) @@ -10358,7 +12909,23 @@ public bool fn_pathCopy (string fromFile, string toFile, bool noOverwrite) return SafeNativeMethods.mwle_fn_pathCopy(sbfromFile, sbtoFile, noOverwrite)>=1; } /// -/// @brief Load all Path information from the mission. This function is usually called from the loadMissionStage2() server-side function after the mission file has loaded. Internally it places all Paths into the server's PathManager. From this point the Paths are ready for transmission to the clients. @tsexample // Inform the engine to load all Path information from the mission. pathOnMissionLoadDone(); @endtsexample @see NetConnection::transmitPaths() @see NetConnection::clearPaths() @see Path @ingroup Networking) +/// @brief Load all Path information from the mission. +/// +/// This function is usually called from the loadMissionStage2() server-side function +/// after the mission file has loaded. Internally it places all Paths into the server's +/// PathManager. From this point the Paths are ready for transmission to the clients. +/// +/// @tsexample +/// // Inform the engine to load all Path information from the mission. +/// pathOnMissionLoadDone(); +/// @endtsexample +/// +/// @see NetConnection::transmitPaths() +/// @see NetConnection::clearPaths() +/// @see Path +/// +/// @ingroup Networking) +/// /// public void fn_pathOnMissionLoadDone () @@ -10370,7 +12937,9 @@ public void fn_pathOnMissionLoadDone () SafeNativeMethods.mwle_fn_pathOnMissionLoadDone(); } /// -/// () Clears all the tracked objects without saving them. ) +/// () +/// Clears all the tracked objects without saving them. ) +/// /// public void fn_PersistenceManager_clearAll (string persistencemanager) @@ -10384,7 +12953,9 @@ public void fn_PersistenceManager_clearAll (string persistencemanager) SafeNativeMethods.mwle_fn_PersistenceManager_clearAll(sbpersistencemanager); } /// -/// ( fileName ) Delete all of the objects that are created from the given file. ) +/// ( fileName ) +/// Delete all of the objects that are created from the given file. ) +/// /// public void fn_PersistenceManager_deleteObjectsFromFile (string persistencemanager, string fileName) @@ -10401,7 +12972,9 @@ public void fn_PersistenceManager_deleteObjectsFromFile (string persistencemanag SafeNativeMethods.mwle_fn_PersistenceManager_deleteObjectsFromFile(sbpersistencemanager, sbfileName); } /// -/// ( index ) Returns the ith dirty object. ) +/// ( index ) +/// Returns the ith dirty object. ) +/// /// public int fn_PersistenceManager_getDirtyObject (string persistencemanager, int index) @@ -10415,7 +12988,9 @@ public int fn_PersistenceManager_getDirtyObject (string persistencemanager, int return SafeNativeMethods.mwle_fn_PersistenceManager_getDirtyObject(sbpersistencemanager, index); } /// -/// () Returns the number of dirty objects. ) +/// () +/// Returns the number of dirty objects. ) +/// /// public int fn_PersistenceManager_getDirtyObjectCount (string persistencemanager) @@ -10429,7 +13004,9 @@ public int fn_PersistenceManager_getDirtyObjectCount (string persistencemanager) return SafeNativeMethods.mwle_fn_PersistenceManager_getDirtyObjectCount(sbpersistencemanager); } /// -/// () Returns true if the manager has dirty objects to save. ) +/// () +/// Returns true if the manager has dirty objects to save. ) +/// /// public bool fn_PersistenceManager_hasDirty (string persistencemanager) @@ -10443,7 +13020,9 @@ public bool fn_PersistenceManager_hasDirty (string persistencemanager) return SafeNativeMethods.mwle_fn_PersistenceManager_hasDirty(sbpersistencemanager)>=1; } /// -/// (SimObject object) Returns true if the SimObject is on the dirty list.) +/// (SimObject object) +/// Returns true if the SimObject is on the dirty list.) +/// /// public bool fn_PersistenceManager_isDirty (string persistencemanager, string objName) @@ -10460,7 +13039,9 @@ public bool fn_PersistenceManager_isDirty (string persistencemanager, string obj return SafeNativeMethods.mwle_fn_PersistenceManager_isDirty(sbpersistencemanager, sbobjName)>=1; } /// -/// () Prints the dirty list to the console.) +/// () +/// Prints the dirty list to the console.) +/// /// public void fn_PersistenceManager_listDirty (string persistencemanager) @@ -10474,7 +13055,9 @@ public void fn_PersistenceManager_listDirty (string persistencemanager) SafeNativeMethods.mwle_fn_PersistenceManager_listDirty(sbpersistencemanager); } /// -/// (SimObject object) Remove a SimObject from the dirty list.) +/// (SimObject object) +/// Remove a SimObject from the dirty list.) +/// /// public void fn_PersistenceManager_removeDirty (string persistencemanager, string objName) @@ -10491,7 +13074,9 @@ public void fn_PersistenceManager_removeDirty (string persistencemanager, string SafeNativeMethods.mwle_fn_PersistenceManager_removeDirty(sbpersistencemanager, sbobjName); } /// -/// (SimObject object, string fieldName) Remove a specific field from an object declaration.) +/// (SimObject object, string fieldName) +/// Remove a specific field from an object declaration.) +/// /// public void fn_PersistenceManager_removeField (string persistencemanager, string objName, string fieldName) @@ -10511,7 +13096,10 @@ public void fn_PersistenceManager_removeField (string persistencemanager, string SafeNativeMethods.mwle_fn_PersistenceManager_removeField(sbpersistencemanager, sbobjName, sbfieldName); } /// -/// ) , (SimObject object, [filename]) Remove an existing SimObject from a file (can optionally specify a different file than \ the one it was created in.) +/// ) , (SimObject object, [filename]) +/// Remove an existing SimObject from a file (can optionally specify a different file than \ +/// the one it was created in.) +/// /// public void fn_PersistenceManager_removeObjectFromFile (string persistencemanager, string objName, string filename) @@ -10531,7 +13119,9 @@ public void fn_PersistenceManager_removeObjectFromFile (string persistencemanage SafeNativeMethods.mwle_fn_PersistenceManager_removeObjectFromFile(sbpersistencemanager, sbobjName, sbfilename); } /// -/// () Saves all of the SimObject's on the dirty list to their respective files.) +/// () +/// Saves all of the SimObject's on the dirty list to their respective files.) +/// /// public bool fn_PersistenceManager_saveDirty (string persistencemanager) @@ -10545,7 +13135,9 @@ public bool fn_PersistenceManager_saveDirty (string persistencemanager) return SafeNativeMethods.mwle_fn_PersistenceManager_saveDirty(sbpersistencemanager)>=1; } /// -/// (SimObject object) Save a dirty SimObject to it's file.) +/// (SimObject object) +/// Save a dirty SimObject to it's file.) +/// /// public bool fn_PersistenceManager_saveDirtyObject (string persistencemanager, string objName) @@ -10562,7 +13154,9 @@ public bool fn_PersistenceManager_saveDirtyObject (string persistencemanager, st return SafeNativeMethods.mwle_fn_PersistenceManager_saveDirtyObject(sbpersistencemanager, sbobjName)>=1; } /// -/// ), (SimObject object, [filename]) Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// ), (SimObject object, [filename]) +/// Mark an existing SimObject as dirty (will be written out when saveDirty() is called).) +/// /// public void fn_PersistenceManager_setDirty (string persistencemanager, string objName, string fileName) @@ -10582,7 +13176,11 @@ public void fn_PersistenceManager_setDirty (string persistencemanager, string ob SafeNativeMethods.mwle_fn_PersistenceManager_setDirty(sbpersistencemanager, sbobjName, sbfileName); } /// -/// @brief Loads some information to have readily available at simulation time. Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. This function should be used while a level is loading in order to shorten the amount of time to create a PhysicsDebris in game.) +/// @brief Loads some information to have readily available at simulation time. +/// Forces generation of shaders, materials, and other data used by the %PhysicsDebris object. +/// This function should be used while a level is loading in order to shorten +/// the amount of time to create a PhysicsDebris in game.) +/// /// public void fn_PhysicsDebrisData_preload (string physicsdebrisdata) @@ -10597,6 +13195,7 @@ public void fn_PhysicsDebrisData_preload (string physicsdebrisdata) } /// /// physicsDebugDraw( bool enable )) +/// /// public void fn_physicsDebugDraw (bool enable) @@ -10608,6 +13207,7 @@ public void fn_physicsDebugDraw (bool enable) } /// /// physicsDestroy()) +/// /// public void fn_physicsDestroy () @@ -10620,6 +13220,7 @@ public void fn_physicsDestroy () } /// /// physicsDestroyWorld( String worldName )) +/// /// public void fn_physicsDestroyWorld (string worldName) @@ -10634,6 +13235,7 @@ public void fn_physicsDestroyWorld (string worldName) } /// /// physicsGetTimeScale()) +/// /// public float fn_physicsGetTimeScale () @@ -10646,6 +13248,7 @@ public float fn_physicsGetTimeScale () } /// /// ), physicsInit( [string library] )) +/// /// public bool fn_physicsInit (string library) @@ -10660,6 +13263,7 @@ public bool fn_physicsInit (string library) } /// /// physicsInitWorld( String worldName )) +/// /// public bool fn_physicsInitWorld (string worldName) @@ -10673,7 +13277,10 @@ public bool fn_physicsInitWorld (string worldName) return SafeNativeMethods.mwle_fn_physicsInitWorld(sbworldName)>=1; } /// -/// physicsPluginPresent() @brief Returns true if a physics plugin exists and is initialized. @ingroup Physics ) +/// physicsPluginPresent() +/// @brief Returns true if a physics plugin exists and is initialized. +/// @ingroup Physics ) +/// /// public bool fn_physicsPluginPresent () @@ -10686,6 +13293,7 @@ public bool fn_physicsPluginPresent () } /// /// physicsRestoreState()) +/// /// public void fn_physicsRestoreState () @@ -10698,6 +13306,7 @@ public void fn_physicsRestoreState () } /// /// physicsSetTimeScale( F32 scale )) +/// /// public void fn_physicsSetTimeScale (float scale) @@ -10709,6 +13318,7 @@ public void fn_physicsSetTimeScale (float scale) } /// /// physicsStopSimulation( String worldName )) +/// /// public bool fn_physicsSimulationEnabled () @@ -10721,6 +13331,7 @@ public bool fn_physicsSimulationEnabled () } /// /// physicsStartSimulation( String worldName )) +/// /// public void fn_physicsStartSimulation (string worldName) @@ -10735,6 +13346,7 @@ public void fn_physicsStartSimulation (string worldName) } /// /// physicsStopSimulation( String worldName )) +/// /// public void fn_physicsStopSimulation (string worldName) @@ -10749,6 +13361,7 @@ public void fn_physicsStopSimulation (string worldName) } /// /// physicsStoreState()) +/// /// public void fn_physicsStoreState () @@ -10760,7 +13373,11 @@ public void fn_physicsStoreState () SafeNativeMethods.mwle_fn_physicsStoreState(); } /// -/// (string filename) @brief Begin playback of a journal from a specified field. @param filename Name and path of file journal file @ingroup Platform) +/// (string filename) +/// @brief Begin playback of a journal from a specified field. +/// @param filename Name and path of file journal file +/// @ingroup Platform) +/// /// public void fn_playJournal (string filename) @@ -10774,7 +13391,10 @@ public void fn_playJournal (string filename) SafeNativeMethods.mwle_fn_playJournal(sbfilename); } /// -/// THEORA, 30.0f, Point2I::Zero ), Load a journal file and capture it video. @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Load a journal file and capture it video. +/// @ingroup Rendering ) +/// /// public void fn_playJournalToVideo (string journalFile, string videoFile, string encoder, float framerate, string resolution) @@ -10797,7 +13417,12 @@ public void fn_playJournalToVideo (string journalFile, string videoFile, string SafeNativeMethods.mwle_fn_playJournalToVideo(sbjournalFile, sbvideoFile, sbencoder, framerate, sbresolution); } /// -/// () @brief Pop and restore the last setting of $instantGroup off the stack. @note Currently only used for editors @ingroup Editors @internal) +/// () +/// @brief Pop and restore the last setting of $instantGroup off the stack. +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void fn_popInstantGroup () @@ -10809,7 +13434,12 @@ public void fn_popInstantGroup () SafeNativeMethods.mwle_fn_popInstantGroup(); } /// -/// Populate the font cache for all fonts with Unicode code points in the specified range. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for all fonts with Unicode code points in the specified range. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void fn_populateAllFontCacheRange (uint rangeStart, uint rangeEnd) @@ -10820,7 +13450,9 @@ public void fn_populateAllFontCacheRange (uint rangeStart, uint rangeEnd) SafeNativeMethods.mwle_fn_populateAllFontCacheRange(rangeStart, rangeEnd); } /// -/// Populate the font cache for all fonts with characters from the specified string. @ingroup Font ) +/// Populate the font cache for all fonts with characters from the specified string. +/// @ingroup Font ) +/// /// public void fn_populateAllFontCacheString (string stringx) @@ -10834,7 +13466,14 @@ public void fn_populateAllFontCacheString (string stringx) SafeNativeMethods.mwle_fn_populateAllFontCacheString(sbstringx); } /// -/// Populate the font cache for the specified font with Unicode code points in the specified range. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param rangeStart The start Unicode point. @param rangeEnd The end Unicode point. @note We only support BMP-0, so code points range from 0 to 65535. @ingroup Font ) +/// Populate the font cache for the specified font with Unicode code points in the specified range. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param rangeStart The start Unicode point. +/// @param rangeEnd The end Unicode point. +/// @note We only support BMP-0, so code points range from 0 to 65535. +/// @ingroup Font ) +/// /// public void fn_populateFontCacheRange (string faceName, int fontSize, uint rangeStart, uint rangeEnd) @@ -10848,7 +13487,12 @@ public void fn_populateFontCacheRange (string faceName, int fontSize, uint range SafeNativeMethods.mwle_fn_populateFontCacheRange(sbfaceName, fontSize, rangeStart, rangeEnd); } /// -/// Populate the font cache for the specified font with characters from the specified string. @param faceName The name of the font face. @param fontSize The size of the font in pixels. @param string The string to populate. @ingroup Font ) +/// Populate the font cache for the specified font with characters from the specified string. +/// @param faceName The name of the font face. +/// @param fontSize The size of the font in pixels. +/// @param string The string to populate. +/// @ingroup Font ) +/// /// public void fn_populateFontCacheString (string faceName, int fontSize, string stringx) @@ -10866,6 +13510,7 @@ public void fn_populateFontCacheString (string faceName, int fontSize, string st } /// /// (GuiCanvas, pos, title)) +/// /// public void fn_PopupMenu_attachToMenuBar (string popupmenu, string canvasName, int pos, string title) @@ -10886,6 +13531,7 @@ public void fn_PopupMenu_attachToMenuBar (string popupmenu, string canvasName, i } /// /// (pos, checked)) +/// /// public void fn_PopupMenu_checkItem (string popupmenu, int pos, bool checkedx) @@ -10900,6 +13546,7 @@ public void fn_PopupMenu_checkItem (string popupmenu, int pos, bool checkedx) } /// /// (firstPos, lastPos, checkPos)) +/// /// public void fn_PopupMenu_checkRadioItem (string popupmenu, int firstPos, int lastPos, int checkPos) @@ -10914,6 +13561,7 @@ public void fn_PopupMenu_checkRadioItem (string popupmenu, int firstPos, int las } /// /// (pos, enabled)) +/// /// public void fn_PopupMenu_enableItem (string popupmenu, int pos, bool enabled) @@ -10928,6 +13576,7 @@ public void fn_PopupMenu_enableItem (string popupmenu, int pos, bool enabled) } /// /// ()) +/// /// public int fn_PopupMenu_getItemCount (string popupmenu) @@ -10942,6 +13591,7 @@ public int fn_PopupMenu_getItemCount (string popupmenu) } /// /// , ), (pos[, title][, accelerator])) +/// /// public int fn_PopupMenu_insertItem (string popupmenu, int pos, string title, string accelerator) @@ -10962,6 +13612,7 @@ public int fn_PopupMenu_insertItem (string popupmenu, int pos, string title, str } /// /// (pos, title, subMenu)) +/// /// public int fn_PopupMenu_insertSubMenu (string popupmenu, int pos, string title, string subMenu) @@ -10982,6 +13633,7 @@ public int fn_PopupMenu_insertSubMenu (string popupmenu, int pos, string title, } /// /// (pos)) +/// /// public bool fn_PopupMenu_isItemChecked (string popupmenu, int pos) @@ -10996,6 +13648,7 @@ public bool fn_PopupMenu_isItemChecked (string popupmenu, int pos) } /// /// ()) +/// /// public void fn_PopupMenu_removeFromMenuBar (string popupmenu) @@ -11010,6 +13663,7 @@ public void fn_PopupMenu_removeFromMenuBar (string popupmenu) } /// /// (pos)) +/// /// public void fn_PopupMenu_removeItem (string popupmenu, int pos) @@ -11024,6 +13678,7 @@ public void fn_PopupMenu_removeItem (string popupmenu, int pos) } /// /// ), (pos, title[, accelerator])) +/// /// public bool fn_PopupMenu_setItem (string popupmenu, int pos, string title, string accelerator) @@ -11044,6 +13699,7 @@ public bool fn_PopupMenu_setItem (string popupmenu, int pos, string title, strin } /// /// (Canvas,[x, y])) +/// /// public void fn_PopupMenu_showPopup (string popupmenu, string canvasName, int x, int y) @@ -11060,7 +13716,9 @@ public void fn_PopupMenu_showPopup (string popupmenu, string canvasName, int x, SafeNativeMethods.mwle_fn_PopupMenu_showPopup(sbpopupmenu, sbcanvasName, x, y); } /// -/// Preload all datablocks in client mode. (Server parameter is set to false). This will take some time to complete.) +/// Preload all datablocks in client mode. +/// (Server parameter is set to false). This will take some time to complete.) +/// /// public void fn_preloadClientDataBlocks () @@ -11072,7 +13730,11 @@ public void fn_preloadClientDataBlocks () SafeNativeMethods.mwle_fn_preloadClientDataBlocks(); } /// -/// @brief Dumps current profiling stats to the console window. @note Markers disabled with profilerMarkerEnable() will be skipped over. If the profiler is currently running, it will be disabled. @ingroup Debugging) +/// @brief Dumps current profiling stats to the console window. +/// @note Markers disabled with profilerMarkerEnable() will be skipped over. +/// If the profiler is currently running, it will be disabled. +/// @ingroup Debugging) +/// /// public void fn_profilerDump () @@ -11084,7 +13746,15 @@ public void fn_profilerDump () SafeNativeMethods.mwle_fn_profilerDump(); } /// -/// @brief Dumps current profiling stats to a file. @note If the profiler is currently running, it will be disabled. @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). Will attempt to create the file if it does not already exist. @tsexample profilerDumpToFile( \"C:/Torque/log1.txt\" ); @endtsexample @ingroup Debugging ) +/// @brief Dumps current profiling stats to a file. +/// @note If the profiler is currently running, it will be disabled. +/// @param fileName Name and path of file to save profiling stats to. Must use forward slashes (/). +/// Will attempt to create the file if it does not already exist. +/// @tsexample +/// profilerDumpToFile( \"C:/Torque/log1.txt\" ); +/// @endtsexample +/// @ingroup Debugging ) +/// /// public void fn_profilerDumpToFile (string fileName) @@ -11098,7 +13768,14 @@ public void fn_profilerDumpToFile (string fileName) SafeNativeMethods.mwle_fn_profilerDumpToFile(sbfileName); } /// -/// @brief Enables or disables the profiler. Data is only gathered while the profiler is enabled. @note Profiler is not available in shipping builds. T3D has predefined profiling areas surrounded by markers, but you may need to define additional markers (in C++) around areas you wish to profile, by using the PROFILE_START( markerName ); and PROFILE_END(); macros. @ingroup Debugging ) +/// @brief Enables or disables the profiler. +/// Data is only gathered while the profiler is enabled. +/// @note Profiler is not available in shipping builds. +/// T3D has predefined profiling areas surrounded by markers, +/// but you may need to define additional markers (in C++) around areas you wish to profile, +/// by using the PROFILE_START( markerName ); and PROFILE_END(); macros. +/// @ingroup Debugging ) +/// /// public void fn_profilerEnable (bool enable) @@ -11109,7 +13786,13 @@ public void fn_profilerEnable (bool enable) SafeNativeMethods.mwle_fn_profilerEnable(enable); } /// -/// @brief Enable or disable a specific profile. @param enable Optional paramater to enable or disable the profile. @param markerName Name of a specific marker to enable or disable. @note Calling this function will first call profilerReset(), clearing all data from profiler. All profile markers are enabled by default. @ingroup Debugging) +/// @brief Enable or disable a specific profile. +/// @param enable Optional paramater to enable or disable the profile. +/// @param markerName Name of a specific marker to enable or disable. +/// @note Calling this function will first call profilerReset(), clearing all data from profiler. +/// All profile markers are enabled by default. +/// @ingroup Debugging) +/// /// public void fn_profilerMarkerEnable (string markerName, bool enable) @@ -11123,7 +13806,11 @@ public void fn_profilerMarkerEnable (string markerName, bool enable) SafeNativeMethods.mwle_fn_profilerMarkerEnable(sbmarkerName, enable); } /// -/// @brief Resets the profiler, clearing it of all its data. If the profiler is currently running, it will first be disabled. All markers will retain their current enabled/disabled status. @ingroup Debugging ) +/// @brief Resets the profiler, clearing it of all its data. +/// If the profiler is currently running, it will first be disabled. +/// All markers will retain their current enabled/disabled status. +/// @ingroup Debugging ) +/// /// public void fn_profilerReset () @@ -11135,7 +13822,13 @@ public void fn_profilerReset () SafeNativeMethods.mwle_fn_profilerReset(); } /// -/// ) , ([group]) @brief Pushes the current $instantGroup on a stack and sets it to the given value (or clears it). @note Currently only used for editors @ingroup Editors @internal) +/// ) , ([group]) +/// @brief Pushes the current $instantGroup on a stack +/// and sets it to the given value (or clears it). +/// @note Currently only used for editors +/// @ingroup Editors +/// @internal) +/// /// public void fn_pushInstantGroup (string group) @@ -11150,6 +13843,7 @@ public void fn_pushInstantGroup (string group) } /// /// queryAllServers(...); ) +/// /// public void fn_queryAllServers (uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags) @@ -11167,6 +13861,8 @@ public void fn_queryAllServers (uint lanPort, uint flags, string gameType, strin } /// /// queryLanServers(...); ) +/// +/// /// public void fn_queryLanServers (uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags) @@ -11184,6 +13880,7 @@ public void fn_queryLanServers (uint lanPort, uint flags, string gameType, strin } /// /// queryMasterServer(...); ) +/// /// public void fn_queryMasterServer (uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags) @@ -11201,6 +13898,7 @@ public void fn_queryMasterServer (uint lanPort, uint flags, string gameType, str } /// /// querySingleServer(...); ) +/// /// public void fn_querySingleServer (string addrText, byte flags) @@ -11214,6 +13912,43 @@ public void fn_querySingleServer (string addrText, byte flags) SafeNativeMethods.mwle_fn_querySingleServer(sbaddrText, flags); } /// +/// Shut down the engine and exit its process. +/// This function cleanly uninitializes the engine and then exits back to the system with a process +/// exit status indicating a clean exit. +/// @see quitWithErrorMessage +/// @ingroup Platform ) +/// +/// + +public void fn_quit () +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_quit'"); + + +SafeNativeMethods.mwle_fn_quit(); +} +/// +/// Display an error message box showing the given @a message and then shut down the engine and exit its process. +/// This function cleanly uninitialized the engine and then exits back to the system with a process +/// exit status indicating an error. +/// @param message The message to log to the console and show in an error message box. +/// @see quit +/// @ingroup Platform ) +/// +/// + +public void fn_quitWithErrorMessage (string message) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fn_quitWithErrorMessage'" + string.Format("\"{0}\" ",message)); +StringBuilder sbmessage = null; +if (message != null) + sbmessage = new StringBuilder(message, 1024); + +SafeNativeMethods.mwle_fn_quitWithErrorMessage(sbmessage); +} +/// /// readXMLObj.readFile();) /// /// @@ -11238,7 +13973,10 @@ public void fn_realQuit () SafeNativeMethods.mwle_fn_realQuit(); } /// -/// Close the current Redbook device. @brief Deprecated @internal) +/// Close the current Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookClose () @@ -11250,7 +13988,10 @@ public bool fn_redbookClose () return SafeNativeMethods.mwle_fn_redbookClose()>=1; } /// -/// get the number of redbook devices. @brief Deprecated @internal) +/// get the number of redbook devices. +/// @brief Deprecated +/// @internal) +/// /// public int fn_redbookGetDeviceCount () @@ -11262,7 +14003,10 @@ public int fn_redbookGetDeviceCount () return SafeNativeMethods.mwle_fn_redbookGetDeviceCount(); } /// -/// (int index) Get name of specified Redbook device. @brief Deprecated @internal) +/// (int index) Get name of specified Redbook device. +/// @brief Deprecated +/// @internal) +/// /// public string fn_redbookGetDeviceName (int index) @@ -11276,7 +14020,10 @@ public string fn_redbookGetDeviceName (int index) } /// -/// Get a string explaining the last redbook error. @brief Deprecated @internal) +/// Get a string explaining the last redbook error. +/// @brief Deprecated +/// @internal) +/// /// public string fn_redbookGetLastError () @@ -11291,7 +14038,10 @@ public string fn_redbookGetLastError () } /// -/// Return the number of tracks. @brief Deprecated @internal) +/// Return the number of tracks. +/// @brief Deprecated +/// @internal) +/// /// public int fn_redbookGetTrackCount () @@ -11303,7 +14053,10 @@ public int fn_redbookGetTrackCount () return SafeNativeMethods.mwle_fn_redbookGetTrackCount(); } /// -/// Get the volume. @brief Deprecated @internal) +/// Get the volume. +/// @brief Deprecated +/// @internal) +/// /// public float fn_redbookGetVolume () @@ -11315,7 +14068,10 @@ public float fn_redbookGetVolume () return SafeNativeMethods.mwle_fn_redbookGetVolume(); } /// -/// ), (string device=NULL) @brief Deprecated @internal) +/// ), (string device=NULL) +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookOpen (string device) @@ -11329,7 +14085,10 @@ public bool fn_redbookOpen (string device) return SafeNativeMethods.mwle_fn_redbookOpen(sbdevice)>=1; } /// -/// (int track) Play the selected track. @brief Deprecated @internal) +/// (int track) Play the selected track. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookPlay (int track) @@ -11340,7 +14099,10 @@ public bool fn_redbookPlay (int track) return SafeNativeMethods.mwle_fn_redbookPlay(track)>=1; } /// -/// (float volume) Set playback volume. @brief Deprecated @internal) +/// (float volume) Set playback volume. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookSetVolume (float volume) @@ -11351,7 +14113,10 @@ public bool fn_redbookSetVolume (float volume) return SafeNativeMethods.mwle_fn_redbookSetVolume(volume)>=1; } /// -/// Stop playing. @brief Deprecated @internal) +/// Stop playing. +/// @brief Deprecated +/// @internal) +/// /// public bool fn_redbookStop () @@ -11363,7 +14128,12 @@ public bool fn_redbookStop () return SafeNativeMethods.mwle_fn_redbookStop()>=1; } /// -/// (string queueName, string listener) @brief Registers an event message @param queueName String containing the name of queue to attach listener to @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Registers an event message +/// @param queueName String containing the name of queue to attach listener to +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public bool fn_registerMessageListener (string queueName, string listenerName) @@ -11380,7 +14150,11 @@ public bool fn_registerMessageListener (string queueName, string listenerName) return SafeNativeMethods.mwle_fn_registerMessageListener(sbqueueName, sblistenerName)>=1; } /// -/// (string queueName) @brief Registeres a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Registeres a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void fn_registerMessageQueue (string queueName) @@ -11394,7 +14168,9 @@ public void fn_registerMessageQueue (string queueName) SafeNativeMethods.mwle_fn_registerMessageQueue(sbqueueName); } /// -/// @brief Flushes all procedural shaders and re-initializes all active material instances. @ingroup Materials) +/// @brief Flushes all procedural shaders and re-initializes all active material instances. +/// @ingroup Materials) +/// /// public void fn_reInitMaterials () @@ -11406,7 +14182,15 @@ public void fn_reInitMaterials () SafeNativeMethods.mwle_fn_reInitMaterials(); } /// -/// Force the resource at specified input path to be reloaded @param path Path to the resource to be reloaded @tsexample reloadResource( \"art/shapes/box.dts\" ); @endtsexample @note Currently used by editors only @ingroup Editors @internal) +/// Force the resource at specified input path to be reloaded +/// @param path Path to the resource to be reloaded +/// @tsexample +/// reloadResource( \"art/shapes/box.dts\" ); +/// @endtsexample +/// @note Currently used by editors only +/// @ingroup Editors +/// @internal) +/// /// public void fn_reloadResource (string path) @@ -11420,7 +14204,9 @@ public void fn_reloadResource (string path) SafeNativeMethods.mwle_fn_reloadResource(sbpath); } /// -/// Reload all the textures from disk. @ingroup GFX ) +/// Reload all the textures from disk. +/// @ingroup GFX ) +/// /// public void fn_reloadTextures () @@ -11432,7 +14218,19 @@ public void fn_reloadTextures () SafeNativeMethods.mwle_fn_reloadTextures(); } /// -/// Remove the field in @a text at the given @a index. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field in @a text. @return A new string with the field at the given index removed or the original string if @a index is out of range. @tsexample removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" @endtsexample @see removeWord @see removeRecord @ingroup FieldManip ) +/// Remove the field in @a text at the given @a index. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field in @a text. +/// @return A new string with the field at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeField( \"a b\" TAB \"c d\" TAB \"e f\", 1 ) // Returns \"a b\" TAB \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string fn_removeField (string text, int index) @@ -11449,7 +14247,10 @@ public string fn_removeField (string text, int index) } /// -/// Removes an existing global macro by name. @see addGlobalShaderMacro @ingroup Rendering ) +/// Removes an existing global macro by name. +/// @see addGlobalShaderMacro +/// @ingroup Rendering ) +/// /// public void fn_removeGlobalShaderMacro (string name) @@ -11463,7 +14264,19 @@ public void fn_removeGlobalShaderMacro (string name) SafeNativeMethods.mwle_fn_removeGlobalShaderMacro(sbname); } /// -/// Remove the record in @a text at the given @a index. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record in @a text. @return A new string with the record at the given @a index removed or the original string if @a index is out of range. @tsexample removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" @endtsexample @see removeWord @see removeField @ingroup FieldManip ) +/// Remove the record in @a text at the given @a index. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record in @a text. +/// @return A new string with the record at the given @a index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeRecord( \"a b\" NL \"c d\" NL \"e f\", 1 ) // Returns \"a b\" NL \"e f\" +/// @endtsexample +/// @see removeWord +/// @see removeField +/// @ingroup FieldManip ) +/// /// public string fn_removeRecord (string text, int index) @@ -11480,7 +14293,15 @@ public string fn_removeRecord (string text, int index) } /// -/// @brief Remove a tagged string from the Net String Table @param tag The tag associated with the string @see \\ref syntaxDataTypes under Tagged %Strings @see addTaggedString() @see getTaggedString() @ingroup Networking) +/// @brief Remove a tagged string from the Net String Table +/// +/// @param tag The tag associated with the string +/// +/// @see \\ref syntaxDataTypes under Tagged %Strings +/// @see addTaggedString() +/// @see getTaggedString() +/// @ingroup Networking) +/// /// public void fn_removeTaggedString (int tag) @@ -11491,7 +14312,19 @@ public void fn_removeTaggedString (int tag) SafeNativeMethods.mwle_fn_removeTaggedString(tag); } /// -/// Remove the word in @a text at the given @a index. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word in @a text. @return A new string with the word at the given index removed or the original string if @a index is out of range. @tsexample removeWord( \"a b c d\", 2 ) // Returns \"a b d\" @endtsexample @see removeField @see removeRecord @ingroup FieldManip ) +/// Remove the word in @a text at the given @a index. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word in @a text. +/// @return A new string with the word at the given index removed or the original string if @a index is +/// out of range. +/// @tsexample +/// removeWord( \"a b c d\", 2 ) // Returns \"a b d\" +/// @endtsexample +/// @see removeField +/// @see removeRecord +/// @ingroup FieldManip ) +/// /// public string fn_removeWord (string text, int index) @@ -11508,7 +14341,12 @@ public string fn_removeWord (string text, int index) } /// -/// @brief Renames the given @a file. @param from %Path of the file to rename from. @param frome %Path of the file to rename to. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Renames the given @a file. +/// @param from %Path of the file to rename from. +/// @param frome %Path of the file to rename to. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_renameFile (string from, string to) @@ -11525,7 +14363,10 @@ public bool fn_renameFile (string from, string to) return SafeNativeMethods.mwle_fn_renameFile(sbfrom, sbto)>=1; } /// -/// () @brief Reset FPS stats (fps::) @ingroup Game) +/// () +/// @brief Reset FPS stats (fps::) +/// @ingroup Game) +/// /// public void fn_resetFPSTracker () @@ -11537,7 +14378,11 @@ public void fn_resetFPSTracker () SafeNativeMethods.mwle_fn_resetFPSTracker(); } /// -/// @brief Deactivates and then activates the currently active light manager. This causes most shaders to be regenerated and is often used when global rendering changes have occured. @ingroup Lighting ) +/// @brief Deactivates and then activates the currently active light manager. +/// This causes most shaders to be regenerated and is often used when global +/// rendering changes have occured. +/// @ingroup Lighting ) +/// /// public void fn_resetLightManager () @@ -11549,7 +14394,12 @@ public void fn_resetLightManager () SafeNativeMethods.mwle_fn_resetLightManager(); } /// -/// () @brief Rebuilds the XInput section of the InputManager Requests a full refresh of events for all controllers. Useful when called at the beginning of game code after actionMaps are set up to hook up all appropriate events. @ingroup Input) +/// () +/// @brief Rebuilds the XInput section of the InputManager +/// Requests a full refresh of events for all controllers. Useful when called at the beginning +/// of game code after actionMaps are set up to hook up all appropriate events. +/// @ingroup Input) +/// /// public void fn_resetXInput () @@ -11561,7 +14411,16 @@ public void fn_resetXInput () SafeNativeMethods.mwle_fn_resetXInput(); } /// -/// Return all but the first word in @a text. @param text A list of words separated by newlines, spaces, and/or tabs. @return @a text with the first word removed. @note This is equal to @tsexample_nopar getWords( text, 1 ) @endtsexample @see getWords @ingroup FieldManip ) +/// Return all but the first word in @a text. +/// @param text A list of words separated by newlines, spaces, and/or tabs. +/// @return @a text with the first word removed. +/// @note This is equal to +/// @tsexample_nopar +/// getWords( text, 1 ) +/// @endtsexample +/// @see getWords +/// @ingroup FieldManip ) +/// /// public string fn_restWords (string text) @@ -11578,7 +14437,16 @@ public string fn_restWords (string text) } /// -/// Remove trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. @tsexample rtrim( \" string \" ); // Returns \" string\". @endtsexample @see ltrim @see trim @ingroup Strings ) +/// Remove trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// rtrim( \" string \" ); // Returns \" string\". +/// @endtsexample +/// @see ltrim +/// @see trim +/// @ingroup Strings ) +/// /// public string fn_rtrim (string str) @@ -11595,7 +14463,18 @@ public string fn_rtrim (string str) } /// -/// (string device, float xRumble, float yRumble) @brief Activates the vibration motors in the specified controller. The controller will constantly at it's xRumble and yRumble intensities until changed or told to stop. Valid inputs for xRumble/yRumble are [0 - 1]. @param device Name of the device to rumble. @param xRumble Intensity to apply to the left motor. @param yRumble Intensity to apply to the right motor. @note in an Xbox 360 controller, the left motor is low-frequency, while the right motor is high-frequency. @ingroup Input) +/// (string device, float xRumble, float yRumble) +/// @brief Activates the vibration motors in the specified controller. +/// The controller will constantly at it's xRumble and yRumble intensities until +/// changed or told to stop. +/// Valid inputs for xRumble/yRumble are [0 - 1]. +/// @param device Name of the device to rumble. +/// @param xRumble Intensity to apply to the left motor. +/// @param yRumble Intensity to apply to the right motor. +/// @note in an Xbox 360 controller, the left motor is low-frequency, +/// while the right motor is high-frequency. +/// @ingroup Input) +/// /// public void fn_rumble (string device, float xRumble, float yRumble) @@ -11609,7 +14488,10 @@ public void fn_rumble (string device, float xRumble, float yRumble) SafeNativeMethods.mwle_fn_rumble(sbdevice, xRumble, yRumble); } /// -/// (string filename) Save the journal to the specified file. @ingroup Platform) +/// (string filename) +/// Save the journal to the specified file. +/// @ingroup Platform) +/// /// public void fn_saveJournal (string filename) @@ -11623,7 +14505,11 @@ public void fn_saveJournal (string filename) SafeNativeMethods.mwle_fn_saveJournal(sbfilename); } /// -/// @brief Serialize the object to a file. @param object The object to serialize. @param filename The file name and path. @ingroup Console) +/// @brief Serialize the object to a file. +/// @param object The object to serialize. +/// @param filename The file name and path. +/// @ingroup Console) +/// /// public bool fn_saveObject (string objectx, string filename) @@ -11640,7 +14526,12 @@ public bool fn_saveObject (string objectx, string filename) return SafeNativeMethods.mwle_fn_saveObject(sbobjectx, sbfilename)>=1; } /// -/// Dump the current zoning states of all zone spaces in the scene to the console. @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states are dumped as is. @note Only valid on the client. @ingroup Game ) +/// Dump the current zoning states of all zone spaces in the scene to the console. +/// @param updateFirst If true, zoning states are brought up to date first; if false, the zoning states +/// are dumped as is. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public void fn_sceneDumpZoneStates (bool updateFirst) @@ -11651,7 +14542,12 @@ public void fn_sceneDumpZoneStates (bool updateFirst) SafeNativeMethods.mwle_fn_sceneDumpZoneStates(updateFirst); } /// -/// Return the SceneObject that contains the given zone. @param zoneId ID of zone. @return A SceneObject or NULL if the given @a zoneId is invalid. @note Only valid on the client. @ingroup Game ) +/// Return the SceneObject that contains the given zone. +/// @param zoneId ID of zone. +/// @return A SceneObject or NULL if the given @a zoneId is invalid. +/// @note Only valid on the client. +/// @ingroup Game ) +/// /// public string fn_sceneGetZoneOwner (uint zoneId) @@ -11665,7 +14561,13 @@ public string fn_sceneGetZoneOwner (uint zoneId) } /// -/// Takes a screenshot with optional tiling to produce huge screenshots. @param file The output image file path. @param format Either JPEG or PNG. @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. @ingroup GFX ) +/// Takes a screenshot with optional tiling to produce huge screenshots. +/// @param file The output image file path. +/// @param format Either JPEG or PNG. +/// @param tileCount If greater than 1 will tile the current screen size to take a large format screenshot. +/// @param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects. +/// @ingroup GFX ) +/// /// public void fn_screenShot (string file, string format, uint tileCount, float tileOverlap) @@ -11682,7 +14584,11 @@ public void fn_screenShot (string file, string format, uint tileCount, float til SafeNativeMethods.mwle_fn_screenShot(sbfile, sbformat, tileCount, tileOverlap); } /// -/// @brief Open the given folder in the system's file manager. @param path full path to a directory. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Open the given folder in the system's file manager. +/// @param path full path to a directory. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public void fn_selectFile (string path) @@ -11713,7 +14619,11 @@ public bool fn_setClipboard (string text) return SafeNativeMethods.mwle_fn_setClipboard(sbtext)>=1; } /// -/// (string LangTable) @brief Sets the primary LangTable used by the game @param LangTable ID of the core LangTable @ingroup Localization) +/// (string LangTable) +/// @brief Sets the primary LangTable used by the game +/// @param LangTable ID of the core LangTable +/// @ingroup Localization) +/// /// public void fn_setCoreLangTable (string lgTable) @@ -11727,7 +14637,13 @@ public void fn_setCoreLangTable (string lgTable) SafeNativeMethods.mwle_fn_setCoreLangTable(sblgTable); } /// -/// @brief Set the current working directory. @param path The absolute or relative (to the current working directory) path of the directory which should be made the new working directory. @return True if the working directory was successfully changed to @a path, false otherwise. @note Only present in a Tools build of Torque. @ingroup FileSystem) +/// @brief Set the current working directory. +/// @param path The absolute or relative (to the current working directory) path of the directory which should be made the new +/// working directory. +/// @return True if the working directory was successfully changed to @a path, false otherwise. +/// @note Only present in a Tools build of Torque. +/// @ingroup FileSystem) +/// /// public bool fn_setCurrentDirectory (string path) @@ -11741,7 +14657,10 @@ public bool fn_setCurrentDirectory (string path) return SafeNativeMethods.mwle_fn_setCurrentDirectory(sbpath)>=1; } /// -/// @brief Set the default FOV for a camera. @param defaultFOV The default field of view in degrees @ingroup CameraSystem) +/// @brief Set the default FOV for a camera. +/// @param defaultFOV The default field of view in degrees +/// @ingroup CameraSystem) +/// /// public void fn_setDefaultFov (float defaultFOV) @@ -11752,7 +14671,9 @@ public void fn_setDefaultFov (float defaultFOV) SafeNativeMethods.mwle_fn_setDefaultFov(defaultFOV); } /// -/// Sets the clients far clipping. ) +/// Sets the clients far clipping. +/// ) +/// /// public void fn_setFarClippingDistance (float dist) @@ -11763,7 +14684,21 @@ public void fn_setFarClippingDistance (float dist) SafeNativeMethods.mwle_fn_setFarClippingDistance(dist); } /// -/// Replace the field in @a text at the given @a index with @a replacement. Fields in @a text must be separated by newlines and/or tabs. @param text A list of fields separated by newlines and/or tabs. @param index The zero-based index of the field to replace. @param replacement The string with which to replace the field. @return A new string with the field at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" @endtsexample @see getField @see setWord @see setRecord @ingroup FieldManip ) +/// Replace the field in @a text at the given @a index with @a replacement. +/// Fields in @a text must be separated by newlines and/or tabs. +/// @param text A list of fields separated by newlines and/or tabs. +/// @param index The zero-based index of the field to replace. +/// @param replacement The string with which to replace the field. +/// @return A new string with the field at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setField( \"a b\" TAB \"c d\" TAB \"e f\", 1, \"g h\" ) // Returns \"a b\" TAB \"g h\" TAB \"e f\" +/// @endtsexample +/// @see getField +/// @see setWord +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string fn_setField (string text, int index, string replacement) @@ -11798,7 +14733,10 @@ public int fn_SetFogVolumeQuality (uint new_quality) return SafeNativeMethods.mwle_fn_SetFogVolumeQuality(new_quality); } /// -/// @brief Set the FOV of the camera. @param FOV The camera's new FOV in degrees @ingroup CameraSystem) +/// @brief Set the FOV of the camera. +/// @param FOV The camera's new FOV in degrees +/// @ingroup CameraSystem) +/// /// public void fn_setFov (float FOV) @@ -11810,6 +14748,7 @@ public void fn_setFov (float FOV) } /// /// @brief .) +/// /// public void fn_setFrustumOffset (string offset) @@ -11823,7 +14762,10 @@ public void fn_setFrustumOffset (string offset) SafeNativeMethods.mwle_fn_setFrustumOffset(sboffset); } /// -/// Finds and activates the named light manager. @return Returns true if the light manager is found and activated. @ingroup Lighting ) +/// Finds and activates the named light manager. +/// @return Returns true if the light manager is found and activated. +/// @ingroup Lighting ) +/// /// public bool fn_setLightManager (string name) @@ -11837,7 +14779,22 @@ public bool fn_setLightManager (string name) return SafeNativeMethods.mwle_fn_setLightManager(sbname)>=1; } /// -/// @brief Determines how log files are written. Sets the operational mode of the console logging system. @param mode Parameter specifying the logging mode. This can be: - 1: Open and close the console log file for each seperate string of output. This will ensure that all parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. - 2: Keep the log file open and write to it continuously. This will make the system operate faster but if the process crashes, parts of the output may not have been written to disk yet and will be missing from the log. Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been issued to the console system into the newly created log file. @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. @ingroup Logging ) +/// @brief Determines how log files are written. +/// Sets the operational mode of the console logging system. +/// @param mode Parameter specifying the logging mode. This can be: +/// - 1: Open and close the console log file for each seperate string of output. This will ensure that all +/// parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes. +/// - 2: Keep the log file open and write to it continuously. This will make the system operate faster but +/// if the process crashes, parts of the output may not have been written to disk yet and will be missing from +/// the log. +/// +/// Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be +/// combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been +/// issued to the console system into the newly created log file. +/// +/// @note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead. +/// @ingroup Logging ) +/// /// public void fn_setLogMode (int mode) @@ -11848,7 +14805,18 @@ public void fn_setLogMode (int mode) SafeNativeMethods.mwle_fn_setLogMode(mode); } /// -/// (int port, bool bind=true) @brief Set the network port for the game to use. @param port The port to use. @param bind True if bind() should be called on the port. @returns True if the port was successfully opened. This will trigger a windows firewall prompt. If you don't have firewall tunneling tech you can set this to false to avoid the prompt. @ingroup Networking) +/// (int port, bool bind=true) +/// @brief Set the network port for the game to use. +/// +/// @param port The port to use. +/// @param bind True if bind() should be called on the port. +/// +/// @returns True if the port was successfully opened. +/// +/// This will trigger a windows firewall prompt. +/// If you don't have firewall tunneling tech you can set this to false to avoid the prompt. +/// @ingroup Networking) +/// /// public bool fn_setNetPort (int port, bool bind) @@ -11859,7 +14827,15 @@ public bool fn_setNetPort (int port, bool bind) return SafeNativeMethods.mwle_fn_setNetPort(port, bind)>=1; } /// -/// @brief Sets the pixel shader version for the active device. This can be used to force a lower pixel shader version than is supported by the device for testing or performance optimization. @param version The floating point shader version number. @note This will only affect shaders/materials created after the call and should be used before the game begins. @see $pref::Video::forcedPixVersion @ingroup GFX ) +/// @brief Sets the pixel shader version for the active device. +/// This can be used to force a lower pixel shader version than is supported by +/// the device for testing or performance optimization. +/// @param version The floating point shader version number. +/// @note This will only affect shaders/materials created after the call +/// and should be used before the game begins. +/// @see $pref::Video::forcedPixVersion +/// @ingroup GFX ) +/// /// public void fn_setPixelShaderVersion (float version) @@ -11870,7 +14846,13 @@ public void fn_setPixelShaderVersion (float version) SafeNativeMethods.mwle_fn_setPixelShaderVersion(version); } /// -/// Set the current seed for the random number generator. Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to the same sequence of pseudo-random numbers. If -1, the current timestamp will be used as the seed which is a good basis for randomization. @ingroup Random ) +/// Set the current seed for the random number generator. +/// Based on this seed, a repeatable sequence of numbers will be produced by getRandom(). +/// @param seed The seed with which to initialize the randon number generator with. The same seed will always leed to +/// the same sequence of pseudo-random numbers. +/// If -1, the current timestamp will be used as the seed which is a good basis for randomization. +/// @ingroup Random ) +/// /// public void fn_setRandomSeed (int seed) @@ -11881,7 +14863,21 @@ public void fn_setRandomSeed (int seed) SafeNativeMethods.mwle_fn_setRandomSeed(seed); } /// -/// Replace the record in @a text at the given @a index with @a replacement. Records in @a text must be separated by newlines. @param text A list of records separated by newlines. @param index The zero-based index of the record to replace. @param replacement The string with which to replace the record. @return A new string with the record at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" @endtsexample @see getRecord @see setWord @see setField @ingroup FieldManip ) +/// Replace the record in @a text at the given @a index with @a replacement. +/// Records in @a text must be separated by newlines. +/// @param text A list of records separated by newlines. +/// @param index The zero-based index of the record to replace. +/// @param replacement The string with which to replace the record. +/// @return A new string with the record at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setRecord( \"a b\" NL \"c d\" NL \"e f\", 1, \"g h\" ) // Returns \"a b\" NL \"g h\" NL \"e f\" +/// @endtsexample +/// @see getRecord +/// @see setWord +/// @see setField +/// @ingroup FieldManip ) +/// /// public string fn_setRecord (string text, int index, string replacement) @@ -11901,7 +14897,9 @@ public string fn_setRecord (string text, int index, string replacement) } /// -/// Set the reflection texture format. @ingroup GFX ) +/// Set the reflection texture format. +/// @ingroup GFX ) +/// /// public void fn_setReflectFormat (int format) @@ -11913,6 +14911,7 @@ public void fn_setReflectFormat (int format) } /// /// setServerInfo(...); ) +/// /// public bool fn_setServerInfo (uint index) @@ -11924,6 +14923,7 @@ public bool fn_setServerInfo (uint index) } /// /// ), string sShadowSystemName) +/// /// public bool fn_setShadowManager (string sShadowSystemName) @@ -11938,6 +14938,7 @@ public bool fn_setShadowManager (string sShadowSystemName) } /// /// ), ) +/// /// public string fn_setShadowVizLight (string name) @@ -11955,6 +14956,7 @@ public string fn_setShadowVizLight (string name) } /// /// settingObj.beginGroup(groupName, fromStart = false);) +/// /// public void fn_Settings_beginGroup (string settings, string groupName, bool includeDefaults) @@ -11972,6 +14974,7 @@ public void fn_Settings_beginGroup (string settings, string groupName, bool incl } /// /// settingObj.clearGroups();) +/// /// public void fn_Settings_clearGroups (string settings) @@ -11986,6 +14989,7 @@ public void fn_Settings_clearGroups (string settings) } /// /// settingObj.endGroup();) +/// /// public void fn_Settings_endGroup (string settings) @@ -12000,6 +15004,7 @@ public void fn_Settings_endGroup (string settings) } /// /// , false, false), settingObj.findFirstValue();) +/// /// public string fn_Settings_findFirstValue (string settings, string pattern, bool deepSearch, bool includeDefaults) @@ -12020,6 +15025,7 @@ public string fn_Settings_findFirstValue (string settings, string pattern, bool } /// /// settingObj.findNextValue();) +/// /// public string fn_Settings_findNextValue (string settings) @@ -12037,6 +15043,7 @@ public string fn_Settings_findNextValue (string settings) } /// /// settingObj.getCurrentGroups();) +/// /// public string fn_Settings_getCurrentGroups (string settings) @@ -12054,6 +15061,7 @@ public string fn_Settings_getCurrentGroups (string settings) } /// /// %success = settingObj.read();) +/// /// public bool fn_Settings_read (string settings) @@ -12068,6 +15076,7 @@ public bool fn_Settings_read (string settings) } /// /// settingObj.remove(settingName, includeDefaults = false);) +/// /// public void fn_Settings_remove (string settings, string settingName, bool includeDefaults) @@ -12085,6 +15094,7 @@ public void fn_Settings_remove (string settings, string settingName, bool includ } /// /// settingObj.setDefaultValue(settingName, value);) +/// /// public void fn_Settings_setDefaultValue (string settings, string settingName, string value) @@ -12105,6 +15115,7 @@ public void fn_Settings_setDefaultValue (string settings, string settingName, st } /// /// ), settingObj.setValue(settingName, value);) +/// /// public void fn_Settings_setValue (string settings, string settingName, string value) @@ -12125,6 +15136,7 @@ public void fn_Settings_setValue (string settings, string settingName, string va } /// /// ), settingObj.value(settingName, defaultValue);) +/// /// public string fn_Settings_value (string settings, string settingName, string defaultValue) @@ -12147,7 +15159,13 @@ public string fn_Settings_value (string settings, string settingName, string def } /// -/// (string varName, string value) @brief Sets the value of the named variable. @param varName Name of the variable to locate @param value New value of the variable @return True if variable was successfully found and set @ingroup Scripting) +/// (string varName, string value) +/// @brief Sets the value of the named variable. +/// @param varName Name of the variable to locate +/// @param value New value of the variable +/// @return True if variable was successfully found and set +/// @ingroup Scripting) +/// /// public void fn_setVariable (string varName, string value) @@ -12164,7 +15182,21 @@ public void fn_setVariable (string varName, string value) SafeNativeMethods.mwle_fn_setVariable(sbvarName, sbvalue); } /// -/// Replace the word in @a text at the given @a index with @a replacement. Words in @a text must be separated by newlines, spaces, and/or tabs. @param text A whitespace-separated list of words. @param index The zero-based index of the word to replace. @param replacement The string with which to replace the word. @return A new string with the word at the given @a index replaced by @a replacement or the original string if @a index is out of range. @tsexample setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" @endtsexample @see getWord @see setField @see setRecord @ingroup FieldManip ) +/// Replace the word in @a text at the given @a index with @a replacement. +/// Words in @a text must be separated by newlines, spaces, and/or tabs. +/// @param text A whitespace-separated list of words. +/// @param index The zero-based index of the word to replace. +/// @param replacement The string with which to replace the word. +/// @return A new string with the word at the given @a index replaced by @a replacement or the original +/// string if @a index is out of range. +/// @tsexample +/// setWord( \"a b c d\", 2, \"f\" ) // Returns \"a b f d\" +/// @endtsexample +/// @see getWord +/// @see setField +/// @see setRecord +/// @ingroup FieldManip ) +/// /// public string fn_setWord (string text, int index, string replacement) @@ -12184,7 +15216,12 @@ public string fn_setWord (string text, int index, string replacement) } /// -/// @brief Set the zoom speed of the camera. This affects how quickly the camera changes from one field of view to another. @param speed The camera's zoom speed in ms per 90deg FOV change @ingroup CameraSystem) +/// @brief Set the zoom speed of the camera. +/// This affects how quickly the camera changes from one field of view +/// to another. +/// @param speed The camera's zoom speed in ms per 90deg FOV change +/// @ingroup CameraSystem) +/// /// public void fn_setZoomSpeed (int speed) @@ -12195,7 +15232,25 @@ public void fn_setZoomSpeed (int speed) SafeNativeMethods.mwle_fn_setZoomSpeed(speed); } /// -/// Try to create a new sound device using the given properties. If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, if this function fails, it will not restore the previously active device but rather leave the sound system in an uninitialized state. Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized playback and then resume normal playback once the device has been created. In the core scripts, sound is automatically set up during startup in the sfxStartup() function. @param provider The name of the device provider as returned by sfxGetAvailableDevices(). @param device The name of the device as returned by sfxGetAvailableDevices(). @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. @return True if the initialization was successful, false if not. @note This function must be called before any of the sound playback functions can be used. @see sfxGetAvailableDevices @see sfxGetDeviceInfo @see sfxDeleteDevice @ref SFX_devices @ingroup SFX ) +/// Try to create a new sound device using the given properties. +/// If a sound device is currently initialized, it will be uninitialized first. However, be aware that in this case, +/// if this function fails, it will not restore the previously active device but rather leave the sound system in an +/// uninitialized state. +/// Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized +/// playback and then resume normal playback once the device has been created. +/// In the core scripts, sound is automatically set up during startup in the sfxStartup() function. +/// @param provider The name of the device provider as returned by sfxGetAvailableDevices(). +/// @param device The name of the device as returned by sfxGetAvailableDevices(). +/// @param useHardware Whether to enabled hardware mixing on the device or not. Only relevant if supported by the given device. +/// @param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default. +/// @return True if the initialization was successful, false if not. +/// @note This function must be called before any of the sound playback functions can be used. +/// @see sfxGetAvailableDevices +/// @see sfxGetDeviceInfo +/// @see sfxDeleteDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public bool fn_sfxCreateDevice (string provider, string device, bool useHardware, int maxBuffers) @@ -12212,7 +15267,13 @@ public bool fn_sfxCreateDevice (string provider, string device, bool useHardware return SafeNativeMethods.mwle_fn_sfxCreateDevice(sbprovider, sbdevice, useHardware, maxBuffers)>=1; } /// -/// , , , ), ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) Creates a new paused sound source using a profile or a description and filename. The return value is the source which must be released by delete(). @hide ) +/// , , , ), +/// ( SFXTrack track | ( SFXDescription description, string filename ) [, float x, float y, float z ] ) +/// Creates a new paused sound source using a profile or a description +/// and filename. The return value is the source which must be +/// released by delete(). +/// @hide ) +/// /// public int fn_sfxCreateSource (string SFXType, string filename, string x, string y, string z) @@ -12238,7 +15299,14 @@ public int fn_sfxCreateSource (string SFXType, string filename, string x, string return SafeNativeMethods.mwle_fn_sfxCreateSource(sbSFXType, sbfilename, sbx, sby, sbz); } /// -/// Delete the currently active sound device and release all its resources. SFXSources that are still playing will be transitioned to virtualized playback mode. When creating a new device, they will automatically transition back to normal playback. In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. @see sfxCreateDevice @ref SFX_devices @ingroup SFX ) +/// Delete the currently active sound device and release all its resources. +/// SFXSources that are still playing will be transitioned to virtualized playback mode. +/// When creating a new device, they will automatically transition back to normal playback. +/// In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function. +/// @see sfxCreateDevice +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public void fn_sfxDeleteDevice () @@ -12250,7 +15318,11 @@ public void fn_sfxDeleteDevice () SafeNativeMethods.mwle_fn_sfxDeleteDevice(); } /// -/// Mark the given @a source for deletion as soon as it moves into stopped state. This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). @param source A sound source. @ingroup SFX ) +/// Mark the given @a source for deletion as soon as it moves into stopped state. +/// This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce). +/// @param source A sound source. +/// @ingroup SFX ) +/// /// public void fn_sfxDeleteWhenStopped (string source) @@ -12264,7 +15336,14 @@ public void fn_sfxDeleteWhenStopped (string source) SafeNativeMethods.mwle_fn_sfxDeleteWhenStopped(sbsource); } /// -/// Dump information about all current SFXSource instances to the console. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @see SFXSource @see sfxDumpSourcesToString @ingroup SFX ) +/// Dump information about all current SFXSource instances to the console. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @see SFXSource +/// @see sfxDumpSourcesToString +/// @ingroup SFX ) +/// /// public void fn_sfxDumpSources (bool includeGroups) @@ -12275,7 +15354,15 @@ public void fn_sfxDumpSources (bool includeGroups) SafeNativeMethods.mwle_fn_sfxDumpSources(includeGroups); } /// -/// Dump information about all current SFXSource instances to a string. The dump includes information about the playback status for each source, volume levels, virtualization, etc. @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump. @return A string containing a dump of information about all currently instantiated SFXSources. @see SFXSource @see sfxDumpSources @ingroup SFX ) +/// Dump information about all current SFXSource instances to a string. +/// The dump includes information about the playback status for each source, volume levels, virtualization, etc. +/// @param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. +/// Otherwise only instances of subclasses of SFXSources are included in the dump. +/// @return A string containing a dump of information about all currently instantiated SFXSources. +/// @see SFXSource +/// @see sfxDumpSources +/// @ingroup SFX ) +/// /// public string fn_sfxDumpSourcesToString (bool includeGroups) @@ -12289,7 +15376,19 @@ public string fn_sfxDumpSourcesToString (bool includeGroups) } /// -/// Return a newline-separated list of all active states. @return A list of the form @verbatim stateName1 NL stateName2 NL stateName3 ... @endverbatim where each element is the name of an active state object. @tsexample // Disable all active states. foreach$( %state in sfxGetActiveStates() ) %state.disable(); @endtsexample @ingroup SFX ) +/// Return a newline-separated list of all active states. +/// @return A list of the form +/// @verbatim +/// stateName1 NL stateName2 NL stateName3 ... +/// @endverbatim +/// where each element is the name of an active state object. +/// @tsexample +/// // Disable all active states. +/// foreach$( %state in sfxGetActiveStates() ) +/// %state.disable(); +/// @endtsexample +/// @ingroup SFX ) +/// /// public string fn_sfxGetActiveStates () @@ -12304,7 +15403,29 @@ public string fn_sfxGetActiveStates () } /// -/// Get a list of all available sound devices. The return value will be a newline-separated list of entries where each line describes one available sound device. Each such line will have the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. @return A newline-separated list of information about all available sound devices. @see sfxCreateDevice @see sfxGetDeviceInfo @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @ref SFX_devices @ingroup SFX ) +/// Get a list of all available sound devices. +/// The return value will be a newline-separated list of entries where each line describes one available sound +/// device. Each such line will have the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// @return A newline-separated list of information about all available sound devices. +/// @see sfxCreateDevice +/// @see sfxGetDeviceInfo +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string fn_sfxGetAvailableDevices () @@ -12319,7 +15440,36 @@ public string fn_sfxGetAvailableDevices () } /// -/// Return information about the currently active sound device. The return value is a tab-delimited string of the following format: @verbatim provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps @endverbatim - provider: The name of the device provider (e.g. \"FMOD\"). - device: The name of the device as returned by the device layer. - hasHardware: Whether the device supports hardware mixing or not. - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. - caps: A bitfield of capability flags. @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. @see sfxCreateDevice @see sfxGetAvailableDevices @see $SFX::DEVICE_INFO_PROVIDER @see $SFX::DEVICE_INFO_NAME @see $SFX::DEVICE_INFO_USEHARDWARE @see $SFX::DEVICE_INFO_MAXBUFFERS @see $SFX::DEVICE_INFO_CAPS @see $SFX::DEVICE_CAPS_REVERB @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT @see $SFX::DEVICE_CAPS_OCCLUSION @see $SFX::DEVICE_CAPS_DSPEFFECTS @see $SFX::DEVICE_CAPS_MULTILISTENER @see $SFX::DEVICE_CAPS_FMODDESIGNER @ref SFX_devices @ingroup SFX ) +/// Return information about the currently active sound device. +/// The return value is a tab-delimited string of the following format: +/// @verbatim +/// provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps +/// @endverbatim +/// - provider: The name of the device provider (e.g. \"FMOD\"). +/// - device: The name of the device as returned by the device layer. +/// - hasHardware: Whether the device supports hardware mixing or not. +/// - numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer. If this limit +/// limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization +/// will start culling voices and put them into virtualized playback mode. Voice virtualization may or may not +/// be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system. +/// - caps: A bitfield of capability flags. +/// @return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized. +/// @see sfxCreateDevice +/// @see sfxGetAvailableDevices +/// @see $SFX::DEVICE_INFO_PROVIDER +/// @see $SFX::DEVICE_INFO_NAME +/// @see $SFX::DEVICE_INFO_USEHARDWARE +/// @see $SFX::DEVICE_INFO_MAXBUFFERS +/// @see $SFX::DEVICE_INFO_CAPS +/// @see $SFX::DEVICE_CAPS_REVERB +/// @see $SFX::DEVICE_CAPS_VOICEMANAGEMENT +/// @see $SFX::DEVICE_CAPS_OCCLUSION +/// @see $SFX::DEVICE_CAPS_DSPEFFECTS +/// @see $SFX::DEVICE_CAPS_MULTILISTENER +/// @see $SFX::DEVICE_CAPS_FMODDESIGNER +/// @ref SFX_devices +/// @ingroup SFX ) +/// /// public string fn_sfxGetDeviceInfo () @@ -12334,7 +15484,12 @@ public string fn_sfxGetDeviceInfo () } /// -/// Get the falloff curve type currently being applied to 3D sounds. @return The current distance model type. @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the falloff curve type currently being applied to 3D sounds. +/// @return The current distance model type. +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public int fn_sfxGetDistanceModel () @@ -12346,7 +15501,12 @@ public int fn_sfxGetDistanceModel () return SafeNativeMethods.mwle_fn_sfxGetDistanceModel(); } /// -/// Get the current global doppler effect setting. @return The current global doppler effect scale factor (>=0). @see sfxSetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Get the current global doppler effect setting. +/// @return The current global doppler effect scale factor (>=0). +/// @see sfxSetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public float fn_sfxGetDopplerFactor () @@ -12358,7 +15518,14 @@ public float fn_sfxGetDopplerFactor () return SafeNativeMethods.mwle_fn_sfxGetDopplerFactor(); } /// -/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. @return The current scale factor for logarithmic 3D sound falloff curves. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model. +/// @return The current scale factor for logarithmic 3D sound falloff curves. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public float fn_sfxGetRolloffFactor () @@ -12370,7 +15537,10 @@ public float fn_sfxGetRolloffFactor () return SafeNativeMethods.mwle_fn_sfxGetRolloffFactor(); } /// -/// , , ), Start playing the given source or create a new source for the given track and play it. @hide ) +/// , , ), +/// Start playing the given source or create a new source for the given track and play it. +/// @hide ) +/// /// public int fn_sfxPlay (string trackName, string pointOrX, string y, string z) @@ -12393,7 +15563,11 @@ public int fn_sfxPlay (string trackName, string pointOrX, string y, string z) return SafeNativeMethods.mwle_fn_sfxPlay(sbtrackName, sbpointOrX, sby, sbz); } /// -/// , , , -1.0f), SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) Create a new play-once source for the given profile or description+filename and start playback of the source. @hide ) +/// , , , -1.0f), +/// SFXSource sfxPlayOnce( ( SFXTrack track | SFXDescription description, string filename ) [, float x, float y, float z, float fadeInTime=-1 ] ) +/// Create a new play-once source for the given profile or description+filename and start playback of the source. +/// @hide ) +/// /// public int fn_sfxPlayOnce (string SFXType, string filename, string x, string y, string z, float fadeInTime) @@ -12419,7 +15593,11 @@ public int fn_sfxPlayOnce (string SFXType, string filename, string x, string y, return SafeNativeMethods.mwle_fn_sfxPlayOnce(sbSFXType, sbfilename, sbx, sby, sbz, fadeInTime); } /// -/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. @param model The distance model to use for 3D sound. @note This setting takes effect globally and is applied to all 3D sounds. @ingroup SFX ) +/// Set the falloff curve type to use for distance-based volume attenuation of 3D sounds. +/// @param model The distance model to use for 3D sound. +/// @note This setting takes effect globally and is applied to all 3D sounds. +/// @ingroup SFX ) +/// /// public void fn_sfxSetDistanceModel (int model) @@ -12430,7 +15608,13 @@ public void fn_sfxSetDistanceModel (int model) SafeNativeMethods.mwle_fn_sfxSetDistanceModel(model); } /// -/// Set the global doppler effect scale factor. @param value The new doppler shift scale factor. @pre @a value must be >= 0. @see sfxGetDopplerFactor @ref SFXSource_doppler @ingroup SFX ) +/// Set the global doppler effect scale factor. +/// @param value The new doppler shift scale factor. +/// @pre @a value must be >= 0. +/// @see sfxGetDopplerFactor +/// @ref SFXSource_doppler +/// @ingroup SFX ) +/// /// public void fn_sfxSetDopplerFactor (float value) @@ -12441,7 +15625,16 @@ public void fn_sfxSetDopplerFactor (float value) SafeNativeMethods.mwle_fn_sfxSetDopplerFactor(value); } /// -/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. @param value The new scale factor for logarithmic 3D sound falloff curves. @pre @a value must be > 0. @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. @see sfxGetDistanceModel @see SFXDistanceModel @ref SFXSource_volume @ref SFX_3d @ingroup SFX ) +/// Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model. +/// @param value The new scale factor for logarithmic 3D sound falloff curves. +/// @pre @a value must be > 0. +/// @note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear. +/// @see sfxGetDistanceModel +/// @see SFXDistanceModel +/// @ref SFXSource_volume +/// @ref SFX_3d +/// @ingroup SFX ) +/// /// public void fn_sfxSetRolloffFactor (float value) @@ -12452,7 +15645,11 @@ public void fn_sfxSetRolloffFactor (float value) SafeNativeMethods.mwle_fn_sfxSetRolloffFactor(value); } /// -/// ), ( vector position [, vector direction ] ) Set the position and orientation of a 3D sound source. @hide ) +/// ), +/// ( vector position [, vector direction ] ) +/// Set the position and orientation of a 3D sound source. +/// @hide ) +/// /// public void fn_SFXSource_setTransform (string sfxsource, string position, string direction) @@ -12472,7 +15669,11 @@ public void fn_SFXSource_setTransform (string sfxsource, string position, string SafeNativeMethods.mwle_fn_SFXSource_setTransform(sbsfxsource, sbposition, sbdirection); } /// -/// Stop playback of the given @a source. This is equivalent to calling SFXSource::stop(). @param source The source to put into stopped state. @ingroup SFX ) +/// Stop playback of the given @a source. +/// This is equivalent to calling SFXSource::stop(). +/// @param source The source to put into stopped state. +/// @ingroup SFX ) +/// /// public void fn_sfxStop (string source) @@ -12486,7 +15687,15 @@ public void fn_sfxStop (string source) SafeNativeMethods.mwle_fn_sfxStop(sbsource); } /// -/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. The advantage of this function over directly calling delete() is that it will correctly handle volume fades that may be configured on the source. Whereas calling delete() would immediately stop playback and delete the source, this functionality will wait for the fade-out to play and only then stop the source and delete it. @param source A sound source. @ref SFXSource_fades @ingroup SFX ) +/// Stop playback of the given @a source (if it is not already stopped) and delete the @a source. +/// The advantage of this function over directly calling delete() is that it will correctly +/// handle volume fades that may be configured on the source. Whereas calling delete() would immediately +/// stop playback and delete the source, this functionality will wait for the fade-out to play and only then +/// stop the source and delete it. +/// @param source A sound source. +/// @ref SFXSource_fades +/// @ingroup SFX ) +/// /// public void fn_sfxStopAndDelete (string source) @@ -12500,7 +15709,13 @@ public void fn_sfxStopAndDelete (string source) SafeNativeMethods.mwle_fn_sfxStopAndDelete(sbsource); } /// -/// , ), (string executable, string args, string directory) @brief Launches an outside executable or batch file @param executable Name of the executable or batch file @param args Optional list of arguments, in string format, to pass to the executable @param directory Optional string containing path to output or shell @ingroup Platform) +/// , ), (string executable, string args, string directory) +/// @brief Launches an outside executable or batch file +/// @param executable Name of the executable or batch file +/// @param args Optional list of arguments, in string format, to pass to the executable +/// @param directory Optional string containing path to output or shell +/// @ingroup Platform) +/// /// public bool fn_shellExecute (string executable, string args, string directory) @@ -12520,7 +15735,10 @@ public bool fn_shellExecute (string executable, string args, string directory) return SafeNativeMethods.mwle_fn_shellExecute(sbexecutable, sbargs, sbdirectory)>=1; } /// -/// (idx) Get the component corresponding to the given index. @param idx An integer index value corresponding to the desired component. @return The id of the component at the given index as an integer) +/// (idx) Get the component corresponding to the given index. +/// @param idx An integer index value corresponding to the desired component. +/// @return The id of the component at the given index as an integer) +/// /// public int fn_SimComponent_getComponent (string simcomponent, int idx) @@ -12534,7 +15752,9 @@ public int fn_SimComponent_getComponent (string simcomponent, int idx) return SafeNativeMethods.mwle_fn_SimComponent_getComponent(sbsimcomponent, idx); } /// -/// () Get the current component count @return The number of components in the list as an integer) +/// () Get the current component count +/// @return The number of components in the list as an integer) +/// /// public int fn_SimComponent_getComponentCount (string simcomponent) @@ -12548,7 +15768,9 @@ public int fn_SimComponent_getComponentCount (string simcomponent) return SafeNativeMethods.mwle_fn_SimComponent_getComponentCount(sbsimcomponent); } /// -/// () Check whether SimComponent is currently a template @return true if is a template and false if not) +/// () Check whether SimComponent is currently a template +/// @return true if is a template and false if not) +/// /// public bool fn_SimComponent_getIsTemplate (string simcomponent) @@ -12562,7 +15784,9 @@ public bool fn_SimComponent_getIsTemplate (string simcomponent) return SafeNativeMethods.mwle_fn_SimComponent_getIsTemplate(sbsimcomponent)>=1; } /// -/// () Check whether SimComponent is currently enabled @return true if enabled and false if not) +/// () Check whether SimComponent is currently enabled +/// @return true if enabled and false if not) +/// /// public bool fn_SimComponent_isEnabled (string simcomponent) @@ -12576,7 +15800,10 @@ public bool fn_SimComponent_isEnabled (string simcomponent) return SafeNativeMethods.mwle_fn_SimComponent_isEnabled(sbsimcomponent)>=1; } /// -/// (enabled) Sets or unsets the enabled flag @param enabled Boolean value @return No return value) +/// (enabled) Sets or unsets the enabled flag +/// @param enabled Boolean value +/// @return No return value) +/// /// public void fn_SimComponent_setEnabled (string simcomponent, bool enabled) @@ -12590,7 +15817,10 @@ public void fn_SimComponent_setEnabled (string simcomponent, bool enabled) SafeNativeMethods.mwle_fn_SimComponent_setEnabled(sbsimcomponent, enabled); } /// -/// (template) Sets or unsets the template flag @param template Boolean value @return No return value) +/// (template) Sets or unsets the template flag +/// @param template Boolean value +/// @return No return value) +/// /// public void fn_SimComponent_setIsTemplate (string simcomponent, bool templateFlag) @@ -12605,6 +15835,7 @@ public void fn_SimComponent_setIsTemplate (string simcomponent, bool templateFla } /// /// Reload the datablock. This can only be used with a local client configuration. ) +/// /// public void fn_SimDataBlock_reloadOnLocalClient (string simdatablock) @@ -13237,6 +16468,7 @@ public void fn_SimObject_setSuperClassNamespace (string simobject, string name) } /// /// () - Try to bind unresolved persistent IDs in the set. ) +/// /// public void fn_SimPersistSet_resolvePersistentIds (string simpersistset) @@ -13251,6 +16483,7 @@ public void fn_SimPersistSet_resolvePersistentIds (string simpersistset) } /// /// addPoint( F32 value, F32 time ) ) +/// /// public void fn_SimResponseCurve_addPoint (string simresponsecurve, float value, float time) @@ -13265,6 +16498,7 @@ public void fn_SimResponseCurve_addPoint (string simresponsecurve, float value, } /// /// clear() ) +/// /// public void fn_SimResponseCurve_clear (string simresponsecurve) @@ -13279,6 +16513,7 @@ public void fn_SimResponseCurve_clear (string simresponsecurve) } /// /// getValue( F32 time ) ) +/// /// public float fn_SimResponseCurve_getValue (string simresponsecurve, float time) @@ -13293,6 +16528,7 @@ public float fn_SimResponseCurve_getValue (string simresponsecurve, float time) } /// /// () Delete all objects in the set. ) +/// /// public void fn_SimSet_deleteAllObjects (string simset) @@ -13306,7 +16542,9 @@ public void fn_SimSet_deleteAllObjects (string simset) SafeNativeMethods.mwle_fn_SimSet_deleteAllObjects(sbsimset); } /// -/// () Get the number of direct and indirect child objects contained in the set. @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// () Get the number of direct and indirect child objects contained in the set. +/// @return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set. ) +/// /// public int fn_SimSet_getFullCount (string simset) @@ -13320,7 +16558,9 @@ public int fn_SimSet_getFullCount (string simset) return SafeNativeMethods.mwle_fn_SimSet_getFullCount(sbsimset); } /// -/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// ( string callbackFunction ) Sort the objects in the set using the given comparison function. +/// @param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. ) +/// /// public void fn_SimSet_sort (string simset, string callbackFunction) @@ -13337,7 +16577,12 @@ public void fn_SimSet_sort (string simset, string callbackFunction) SafeNativeMethods.mwle_fn_SimSet_sort(sbsimset, sbcallbackFunction); } /// -/// (string attributeName) @brief Get float attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of a float. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get float attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of a float. +/// @deprecated Use attribute().) +/// /// public float fn_SimXMLDocument_attributeF32 (string simxmldocument, string attributeName) @@ -13354,7 +16599,12 @@ public float fn_SimXMLDocument_attributeF32 (string simxmldocument, string attri return SafeNativeMethods.mwle_fn_SimXMLDocument_attributeF32(sbsimxmldocument, sbattributeName); } /// -/// (string attributeName) @brief Get int attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The value of the given attribute in the form of an integer. @deprecated Use attribute().) +/// (string attributeName) +/// @brief Get int attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The value of the given attribute in the form of an integer. +/// @deprecated Use attribute().) +/// /// public int fn_SimXMLDocument_attributeS32 (string simxmldocument, string attributeName) @@ -13371,7 +16621,11 @@ public int fn_SimXMLDocument_attributeS32 (string simxmldocument, string attribu return SafeNativeMethods.mwle_fn_SimXMLDocument_attributeS32(sbsimxmldocument, sbattributeName); } /// -/// @brief Determines the memory consumption of a class or object. @param objectOrClass The object or class being measured. @return Returns the total size of an object in bytes. @ingroup Debugging) +/// @brief Determines the memory consumption of a class or object. +/// @param objectOrClass The object or class being measured. +/// @return Returns the total size of an object in bytes. +/// @ingroup Debugging) +/// /// public int fn_sizeof (string objectOrClass) @@ -13386,6 +16640,7 @@ public int fn_sizeof (string objectOrClass) } /// /// ) +/// /// public void fn_SkyBox_postApply (string skybox) @@ -13399,7 +16654,25 @@ public void fn_SkyBox_postApply (string skybox) SafeNativeMethods.mwle_fn_SkyBox_postApply(sbskybox); } /// -/// @brief Prevents mouse movement from being processed In the source, whenever a mouse move event occurs GameTSCtrl::onMouseMove() is called. Whenever snapToggle() is called, it will flag a variable that can prevent this from happening: gSnapLine. This variable is not exposed to script, so you need to call this function to trigger it. @tsexample // Snapping is off by default, so we will toggle // it on first: PlayGui.snapToggle(); // Mouse movement should be disabled // Let's turn it back on PlayGui.snapToggle(); @endtsexample @ingroup GuiGame) +/// @brief Prevents mouse movement from being processed +/// +/// In the source, whenever a mouse move event occurs +/// GameTSCtrl::onMouseMove() is called. Whenever snapToggle() +/// is called, it will flag a variable that can prevent this +/// from happening: gSnapLine. This variable is not exposed to +/// script, so you need to call this function to trigger it. +/// +/// @tsexample +/// // Snapping is off by default, so we will toggle +/// // it on first: +/// PlayGui.snapToggle(); +/// // Mouse movement should be disabled +/// // Let's turn it back on +/// PlayGui.snapToggle(); +/// @endtsexample +/// +/// @ingroup GuiGame) +/// /// public void fn_snapToggle () @@ -13411,7 +16684,9 @@ public void fn_snapToggle () SafeNativeMethods.mwle_fn_snapToggle(); } /// -/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) @hide) +/// ,,,,) ,spawnObject(class [, dataBlock, name, properties, script,modelName]) +/// @hide) +/// /// public int fn_spawnObject (string spawnClass, string spawnDataBlock, string spawnName, string spawnProperties, string spawnScript, string modelName) @@ -13440,7 +16715,11 @@ public int fn_spawnObject (string spawnClass, string spawnDataBlock, string spaw return SafeNativeMethods.mwle_fn_spawnObject(sbspawnClass, sbspawnDataBlock, sbspawnName, sbspawnProperties, sbspawnScript, sbmodelName); } /// -/// ([string additionalProps]) Spawns the object based on the SpawnSphere's class, datablock, properties, and script settings. Allows you to pass in extra properties. @hide ) +/// ([string additionalProps]) Spawns the object based on the SpawnSphere's +/// class, datablock, properties, and script settings. Allows you to pass in +/// extra properties. +/// @hide ) +/// /// public int fn_SpawnSphere_spawnObject (string spawnsphere, string additionalProps) @@ -13457,7 +16736,14 @@ public int fn_SpawnSphere_spawnObject (string spawnsphere, string additionalProp return SafeNativeMethods.mwle_fn_SpawnSphere_spawnObject(sbspawnsphere, sbadditionalProps); } /// -/// Activates the shape replicator. @tsexample // Call the function StartClientReplication() @endtsexample @ingroup Foliage ) +/// Activates the shape replicator. +/// @tsexample +/// // Call the function +/// StartClientReplication() +/// @endtsexample +/// @ingroup Foliage +/// ) +/// /// public void fn_StartClientReplication () @@ -13469,7 +16755,11 @@ public void fn_StartClientReplication () SafeNativeMethods.mwle_fn_StartClientReplication(); } /// -/// @brief Start watching resources for file changes Typically this is called during initializeCore(). @see stopFileChangeNotifications() @ingroup FileSystem) +/// @brief Start watching resources for file changes +/// Typically this is called during initializeCore(). +/// @see stopFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void fn_startFileChangeNotifications () @@ -13481,7 +16771,13 @@ public void fn_startFileChangeNotifications () SafeNativeMethods.mwle_fn_startFileChangeNotifications(); } /// -/// Activates the foliage replicator. @tsexample // Call the function StartFoliageReplication(); @endtsexample @ingroup Foliage) +/// Activates the foliage replicator. +/// @tsexample +/// // Call the function +/// StartFoliageReplication(); +/// @endtsexample +/// @ingroup Foliage) +/// /// public void fn_StartFoliageReplication () @@ -13494,6 +16790,7 @@ public void fn_StartFoliageReplication () } /// /// startHeartbeat(...); ) +/// /// public void fn_startHeartbeat () @@ -13506,6 +16803,7 @@ public void fn_startHeartbeat () } /// /// startPrecisionTimer() - Create and start a high resolution platform timer. Returns the timer id. ) +/// /// public int fn_startPrecisionTimer () @@ -13517,7 +16815,18 @@ public int fn_startPrecisionTimer () return SafeNativeMethods.mwle_fn_startPrecisionTimer(); } /// -/// Test whether the given string begins with the given prefix. @param str The string to test. @param prefix The potential prefix of @a str. @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account. @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. @tsexample startsWith( \"TEST123\", \"test\" ) // Returns true. @endtsexample @see endsWith @ingroup Strings ) +/// Test whether the given string begins with the given prefix. +/// @param str The string to test. +/// @param prefix The potential prefix of @a str. +/// @param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will +/// not be taken into account. +/// @return True if the first characters in @a str match the complete contents of @a prefix; false otherwise. +/// @tsexample +/// startsWith( \"TEST123\", \"test\" ) // Returns true. +/// @endtsexample +/// @see endsWith +/// @ingroup Strings ) +/// /// public bool fn_startsWith (string str, string prefix, bool caseSensitive) @@ -13534,7 +16843,11 @@ public bool fn_startsWith (string str, string prefix, bool caseSensitive) return SafeNativeMethods.mwle_fn_startsWith(sbstr, sbprefix, caseSensitive)>=1; } /// -/// THEORA, 30.0f, Point2I::Zero ), Begins a video capture session. @see stopVideoCapture @ingroup Rendering ) +/// THEORA, 30.0f, Point2I::Zero ), +/// Begins a video capture session. +/// @see stopVideoCapture +/// @ingroup Rendering ) +/// /// public void fn_startVideoCapture (string canvas, string filename, string encoder, float framerate, string resolution) @@ -13558,6 +16871,7 @@ public void fn_startVideoCapture (string canvas, string filename, string encoder } /// /// @internal) +/// /// public bool fn_StaticShape_getPoweredState (string staticshape) @@ -13571,7 +16885,9 @@ public bool fn_StaticShape_getPoweredState (string staticshape) return SafeNativeMethods.mwle_fn_StaticShape_getPoweredState(sbstaticshape)>=1; } /// -/// (bool isPowered) @internal) +/// (bool isPowered) +/// @internal) +/// /// public void fn_StaticShape_setPoweredState (string staticshape, bool isPowered) @@ -13585,7 +16901,11 @@ public void fn_StaticShape_setPoweredState (string staticshape, bool isPowered) SafeNativeMethods.mwle_fn_StaticShape_setPoweredState(sbstaticshape, isPowered); } /// -/// @brief Stop watching resources for file changes Typically this is called during shutdownCore(). @see startFileChangeNotifications() @ingroup FileSystem) +/// @brief Stop watching resources for file changes +/// Typically this is called during shutdownCore(). +/// @see startFileChangeNotifications() +/// @ingroup FileSystem) +/// /// public void fn_stopFileChangeNotifications () @@ -13598,6 +16918,7 @@ public void fn_stopFileChangeNotifications () } /// /// stopHeartbeat(...); ) +/// /// public void fn_stopHeartbeat () @@ -13610,6 +16931,7 @@ public void fn_stopHeartbeat () } /// /// stopPrecisionTimer( S32 id ) - Stop and destroy timer with the passed id. Returns the elapsed milliseconds. ) +/// /// public int fn_stopPrecisionTimer (int id) @@ -13620,7 +16942,10 @@ public int fn_stopPrecisionTimer (int id) return SafeNativeMethods.mwle_fn_stopPrecisionTimer(id); } /// -/// () @brief Stops the rendering sampler @ingroup Rendering) +/// () +/// @brief Stops the rendering sampler +/// @ingroup Rendering) +/// /// public void fn_stopSampling () @@ -13633,6 +16958,7 @@ public void fn_stopSampling () } /// /// stopServerQuery(...); ) +/// /// public void fn_stopServerQuery () @@ -13644,7 +16970,10 @@ public void fn_stopServerQuery () SafeNativeMethods.mwle_fn_stopServerQuery(); } /// -/// Stops the video capture session. @see startVideoCapture @ingroup Rendering ) +/// Stops the video capture session. +/// @see startVideoCapture +/// @ingroup Rendering ) +/// /// public void fn_stopVideoCapture () @@ -13656,7 +16985,11 @@ public void fn_stopVideoCapture () SafeNativeMethods.mwle_fn_stopVideoCapture(); } /// -/// Return the integer character code value corresponding to the first character in the given string. @param chr a (one-character) string. @return the UTF32 code value for the first character in the given string. @ingroup Strings ) +/// Return the integer character code value corresponding to the first character in the given string. +/// @param chr a (one-character) string. +/// @return the UTF32 code value for the first character in the given string. +/// @ingroup Strings ) +/// /// public int fn_strasc (string chr) @@ -13670,7 +17003,13 @@ public int fn_strasc (string chr) return SafeNativeMethods.mwle_fn_strasc(sbchr); } /// -/// Find the first occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strrchr @ingroup Strings ) +/// Find the first occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strrchr +/// @ingroup Strings ) +/// /// public string fn_strchr (string str, string chr) @@ -13690,7 +17029,16 @@ public string fn_strchr (string str, string chr) } /// -/// Find the first occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strchrpos( \"test\", \"s\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the first occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strchrpos( \"test\", \"s\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strchrpos (string str, string chr, int start) @@ -13707,7 +17055,19 @@ public int fn_strchrpos (string str, string chr, int start) return SafeNativeMethods.mwle_fn_strchrpos(sbstr, sbchr, start); } /// -/// Compares two strings using case-b>sensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >1 otherwise. @tsexample if( strcmp( %var, \"foobar\" ) == 0 ) echo( \"%var is equal to 'foobar'\" ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using case-b>sensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >1 otherwise. +/// @tsexample +/// if( strcmp( %var, \"foobar\" ) == 0 ) +/// echo( \"%var is equal to 'foobar'\" ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int fn_strcmp (string str1, string str2) @@ -13724,7 +17084,16 @@ public int fn_strcmp (string str1, string str2) return SafeNativeMethods.mwle_fn_strcmp(sbstr1, sbstr2); } /// -/// Format the given value as a string using printf-style formatting. @param format A printf-style format string. @param value The value argument matching the given format string. @tsexample // Convert the given integer value to a string in a hex notation. %hex = strformat( \"%x\", %value ); @endtsexample @ingroup Strings @see http://en.wikipedia.org/wiki/Printf ) +/// Format the given value as a string using printf-style formatting. +/// @param format A printf-style format string. +/// @param value The value argument matching the given format string. +/// @tsexample +/// // Convert the given integer value to a string in a hex notation. +/// %hex = strformat( \"%x\", %value ); +/// @endtsexample +/// @ingroup Strings +/// @see http://en.wikipedia.org/wiki/Printf ) +/// /// public string fn_strformat (string format, string value) @@ -13744,7 +17113,19 @@ public string fn_strformat (string format, string value) } /// -/// Compares two strings using case-b>insensitive/b> comparison. @param str1 The first string. @param str2 The second string. @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >0 otherwise. @tsexample if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) echo( \"this is always true\" ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using case-b>insensitive/b> comparison. +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if both strings are equal, a value 0 if the first character different in str1 has a smaller character code +/// value than the character at the same position in str2, and a value >0 otherwise. +/// @tsexample +/// if( stricmp( \"FOObar\", \"foobar\" ) == 0 ) +/// echo( \"this is always true\" ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int fn_stricmp (string str1, string str2) @@ -13761,7 +17142,35 @@ public int fn_stricmp (string str1, string str2) return SafeNativeMethods.mwle_fn_stricmp(sbstr1, sbstr2); } /// -/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see stricmp @see strnatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>insensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see stricmp +/// @see strnatcmp +/// @ingroup Strings ) +/// /// public int fn_strinatcmp (string str1, string str2) @@ -13778,7 +17187,15 @@ public int fn_strinatcmp (string str1, string str2) return SafeNativeMethods.mwle_fn_strinatcmp(sbstr1, sbstr2); } /// -/// Remove all occurrences of characters contained in @a chars from @a str. @param str The string to filter characters out from. @param chars A string of characters to filter out from @a str. @return A version of @a str with all occurrences of characters contained in @a chars filtered out. @tsexample stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". @endtsexample @ingroup Strings ) +/// Remove all occurrences of characters contained in @a chars from @a str. +/// @param str The string to filter characters out from. +/// @param chars A string of characters to filter out from @a str. +/// @return A version of @a str with all occurrences of characters contained in @a chars filtered out. +/// @tsexample +/// stripChars( \"teststring\", \"se\" ); // Returns \"tttring\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_stripChars (string str, string chars) @@ -13798,7 +17215,18 @@ public string fn_stripChars (string str, string chars) } /// -/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. @param inString String to strip TorqueML control characters from. @tsexample // Define the string to strip TorqueML control characters from %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; // Request the stripped version of the string %strippedString = StripMLControlChars(%string); @endtsexample @return Version of the inputted string with all TorqueML characters removed. @see References @ingroup GuiCore) +/// @brief Strip TorqueML control characters from the specified string, returning a 'clean' version. +/// @param inString String to strip TorqueML control characters from. +/// @tsexample +/// // Define the string to strip TorqueML control characters from +/// %string = \"font:Arial:24>How Now color:c43c12>Brown color:000000>Cow\"; +/// // Request the stripped version of the string +/// %strippedString = StripMLControlChars(%string); +/// @endtsexample +/// @return Version of the inputted string with all TorqueML characters removed. +/// @see References +/// @ingroup GuiCore) +/// /// public string fn_StripMLControlChars (string inString) @@ -13815,7 +17243,15 @@ public string fn_StripMLControlChars (string inString) } /// -/// Strip a numeric suffix from the given string. @param str The string from which to strip its numeric suffix. @return The string @a str without its number suffix or the original string @a str if it has no such suffix. @tsexample stripTrailingNumber( \"test123\" ) // Returns \"test\". @endtsexample @see getTrailingNumber @ingroup Strings ) +/// Strip a numeric suffix from the given string. +/// @param str The string from which to strip its numeric suffix. +/// @return The string @a str without its number suffix or the original string @a str if it has no such suffix. +/// @tsexample +/// stripTrailingNumber( \"test123\" ) // Returns \"test\". +/// @endtsexample +/// @see getTrailingNumber +/// @ingroup Strings ) +/// /// public string fn_stripTrailingNumber (string str) @@ -13832,7 +17268,19 @@ public string fn_stripTrailingNumber (string str) } /// -/// Match a pattern against a string. @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match any number of characters and '?' to match a single character. @param str The string which should be matched against @a pattern. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches the given @a pattern. @tsexample strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. @endtsexample @see strIsMatchMultipleExpr @ingroup Strings ) +/// Match a pattern against a string. +/// @param pattern The wildcard pattern to match against. The pattern can include characters, '*' to match +/// any number of characters and '?' to match a single character. +/// @param str The string which should be matched against @a pattern. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches the given @a pattern. +/// @tsexample +/// strIsMatchExpr( \"f?o*R\", \"foobar\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchMultipleExpr +/// @ingroup Strings ) +/// /// public bool fn_strIsMatchExpr (string pattern, string str, bool caseSensitive) @@ -13849,7 +17297,19 @@ public bool fn_strIsMatchExpr (string pattern, string str, bool caseSensitive) return SafeNativeMethods.mwle_fn_strIsMatchExpr(sbpattern, sbstr, caseSensitive)>=1; } /// -/// Match a multiple patterns against a single string. @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match any number of characters and '?' to match a single character. Each of the patterns is tried in turn. @param str The string which should be matched against @a patterns. @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string. If false, differences in casing are ignored. @return True if @a str matches any of the given @a patterns. @tsexample strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. @endtsexample @see strIsMatchExpr @ingroup Strings ) +/// Match a multiple patterns against a single string. +/// @param patterns A tab-separated list of patterns. Each pattern can include charaters, '*' to match +/// any number of characters and '?' to match a single character. Each of the patterns is tried in turn. +/// @param str The string which should be matched against @a patterns. +/// @param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against +/// this string. If false, differences in casing are ignored. +/// @return True if @a str matches any of the given @a patterns. +/// @tsexample +/// strIsMatchMultipleExpr( \"*.cs *.gui *.mis\", \"mymission.mis\" ) // Returns true. +/// @endtsexample +/// @see strIsMatchExpr +/// @ingroup Strings ) +/// /// public bool fn_strIsMatchMultipleExpr (string patterns, string str, bool caseSensitive) @@ -13866,7 +17326,12 @@ public bool fn_strIsMatchMultipleExpr (string patterns, string str, bool caseSen return SafeNativeMethods.mwle_fn_strIsMatchMultipleExpr(sbpatterns, sbstr, caseSensitive)>=1; } /// -/// Get the length of the given string in bytes. @note This does b>not/b> return a true character count for strings with multi-byte characters! @param str A string. @return The length of the given string in bytes. @ingroup Strings ) +/// Get the length of the given string in bytes. +/// @note This does b>not/b> return a true character count for strings with multi-byte characters! +/// @param str A string. +/// @return The length of the given string in bytes. +/// @ingroup Strings ) +/// /// public int fn_strlen (string str) @@ -13880,7 +17345,15 @@ public int fn_strlen (string str) return SafeNativeMethods.mwle_fn_strlen(sbstr); } /// -/// Return an all lower-case version of the given string. @param str A string. @return A version of @a str with all characters converted to lower-case. @tsexample strlwr( \"TesT1\" ) // Returns \"test1\" @endtsexample @see strupr @ingroup Strings ) +/// Return an all lower-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to lower-case. +/// @tsexample +/// strlwr( \"TesT1\" ) // Returns \"test1\" +/// @endtsexample +/// @see strupr +/// @ingroup Strings ) +/// /// public string fn_strlwr (string str) @@ -13897,7 +17370,35 @@ public string fn_strlwr (string str) } /// -/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". @param str1 The first string. @param str2 The second string. @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value 0 if @a str1 comes before @a str2 in a natural order. @tsexample // Bubble sort 10 elements of %array using natural order do { %swapped = false; for( %i = 0; %i 10 - 1; %i ++ ) if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) { %temp = %array[ %i ]; %array[ %i ] = %array[ %i + 1 ]; %array[ %i + 1 ] = %temp; %swapped = true; } } while( %swapped ); @endtsexample @see strcmp @see strinatcmp @ingroup Strings ) +/// Compares two strings using \"natural order\" case-b>sensitive/b> comparison. +/// Natural order means that rather than solely comparing single character code values, strings are ordered in a +/// natural way. For example, the string \"hello10\" is considered greater than the string \"hello2\" even though +/// the first numeric character in \"hello10\" actually has a smaller character value than the corresponding character +/// in \"hello2\". However, since 10 is greater than 2, strnatcmp will put \"hello10\" after \"hello2\". +/// @param str1 The first string. +/// @param str2 The second string. +/// @return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value +/// 0 if @a str1 comes before @a str2 in a natural order. +/// @tsexample +/// // Bubble sort 10 elements of %array using natural order +/// do +/// { +/// %swapped = false; +/// for( %i = 0; %i 10 - 1; %i ++ ) +/// if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 ) +/// { +/// %temp = %array[ %i ]; +/// %array[ %i ] = %array[ %i + 1 ]; +/// %array[ %i + 1 ] = %temp; +/// %swapped = true; +/// } +/// } +/// while( %swapped ); +/// @endtsexample +/// @see strcmp +/// @see strinatcmp +/// @ingroup Strings ) +/// /// public int fn_strnatcmp (string str1, string str2) @@ -13914,7 +17415,15 @@ public int fn_strnatcmp (string str1, string str2) return SafeNativeMethods.mwle_fn_strnatcmp(sbstr1, sbstr2); } /// -/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. @param haystack The string to search. @param needle The string to search for. @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. @tsexample strpos( \"b ab\", \"b\", 1 ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the start of @a needle in @a haystack searching from left to right beginning at the given offset. +/// @param haystack The string to search. +/// @param needle The string to search for. +/// @return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found. +/// @tsexample +/// strpos( \"b ab\", \"b\", 1 ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strpos (string haystack, string needle, int offset) @@ -13931,7 +17440,13 @@ public int fn_strpos (string haystack, string needle, int offset) return SafeNativeMethods.mwle_fn_strpos(sbhaystack, sbneedle, offset); } /// -/// Find the last occurrence of the given character in @a str. @param str The string to search. @param chr The character to search for. Only the first character from the string is taken. @return The remainder of the input string starting with the given character or the empty string if the character could not be found. @see strchr @ingroup Strings ) +/// Find the last occurrence of the given character in @a str. +/// @param str The string to search. +/// @param chr The character to search for. Only the first character from the string is taken. +/// @return The remainder of the input string starting with the given character or the empty string if the character could not be found. +/// @see strchr +/// @ingroup Strings ) +/// /// public string fn_strrchr (string str, string chr) @@ -13951,7 +17466,16 @@ public string fn_strrchr (string str, string chr) } /// -/// Find the last occurrence of the given character in the given string. @param str The string to search. @param chr The character to look for. Only the first character of this string will be searched for. @param start The index into @a str at which to start searching for the given character. @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. @tsexample strrchrpos( \"test\", \"t\" ) // Returns 3. @endtsexample @ingroup Strings ) +/// Find the last occurrence of the given character in the given string. +/// @param str The string to search. +/// @param chr The character to look for. Only the first character of this string will be searched for. +/// @param start The index into @a str at which to start searching for the given character. +/// @return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character. +/// @tsexample +/// strrchrpos( \"test\", \"t\" ) // Returns 3. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strrchrpos (string str, string chr, int start) @@ -13968,7 +17492,17 @@ public int fn_strrchrpos (string str, string chr, int start) return SafeNativeMethods.mwle_fn_strrchrpos(sbstr, sbchr, start); } /// -/// ), Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. @param str The string to repeat multiple times. @param numTimes The number of times to repeat @a str in the result string. @param delimiter The string to put between each repetition of @a str. @return A string containing @a str repeated @a numTimes times. @tsexample strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". @endtsexample @ingroup Strings ) +/// ), +/// Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter. +/// @param str The string to repeat multiple times. +/// @param numTimes The number of times to repeat @a str in the result string. +/// @param delimiter The string to put between each repetition of @a str. +/// @return A string containing @a str repeated @a numTimes times. +/// @tsexample +/// strrepeat( \"a\", 5, \"b\" ) // Returns \"ababababa\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_strrepeat (string str, int numTimes, string delimiter) @@ -13988,7 +17522,16 @@ public string fn_strrepeat (string str, int numTimes, string delimiter) } /// -/// Replace all occurrences of @a from in @a source with @a to. @param source The string in which to replace the occurrences of @a from. @param from The string to replace in @a source. @param to The string with which to replace occurrences of @from. @return A string with all occurrences of @a from in @a source replaced by @a to. @tsexample strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". @endtsexample @ingroup Strings ) +/// Replace all occurrences of @a from in @a source with @a to. +/// @param source The string in which to replace the occurrences of @a from. +/// @param from The string to replace in @a source. +/// @param to The string with which to replace occurrences of @from. +/// @return A string with all occurrences of @a from in @a source replaced by @a to. +/// @tsexample +/// strreplace( \"aabbccbb\", \"bb\", \"ee\" ) // Returns \"aaeeccee\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_strreplace (string source, string from, string to) @@ -14011,7 +17554,15 @@ public string fn_strreplace (string source, string from, string to) } /// -/// Find the start of @a substring in the given @a string searching from left to right. @param string The string to search. @param substring The string to search for. @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. @tsexample strstr( \"abcd\", \"c\" ) // Returns 2. @endtsexample @ingroup Strings ) +/// Find the start of @a substring in the given @a string searching from left to right. +/// @param string The string to search. +/// @param substring The string to search for. +/// @return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found. +/// @tsexample +/// strstr( \"abcd\", \"c\" ) // Returns 2. +/// @endtsexample +/// @ingroup Strings ) +/// /// public int fn_strstr (string stringx, string substring) @@ -14029,6 +17580,7 @@ public int fn_strstr (string stringx, string substring) } /// /// strToPlayerName(string); ) +/// /// public string fn_strToPlayerName (string ptr) @@ -14045,7 +17597,15 @@ public string fn_strToPlayerName (string ptr) } /// -/// Return an all upper-case version of the given string. @param str A string. @return A version of @a str with all characters converted to upper-case. @tsexample strupr( \"TesT1\" ) // Returns \"TEST1\" @endtsexample @see strlwr @ingroup Strings ) +/// Return an all upper-case version of the given string. +/// @param str A string. +/// @return A version of @a str with all characters converted to upper-case. +/// @tsexample +/// strupr( \"TesT1\" ) // Returns \"TEST1\" +/// @endtsexample +/// @see strlwr +/// @ingroup Strings ) +/// /// public string fn_strupr (string str) @@ -14063,6 +17623,7 @@ public string fn_strupr (string str) } /// /// animate( F32 duration, F32 startAzimuth, F32 endAzimuth, F32 startElevation, F32 endElevation )) +/// /// public void fn_Sun_animate (string sun, float duration, float startAzimuth, float endAzimuth, float startElevation, float endElevation) @@ -14077,6 +17638,7 @@ public void fn_Sun_animate (string sun, float duration, float startAzimuth, floa } /// /// ) +/// /// public void fn_Sun_apply (string sun) @@ -14090,7 +17652,13 @@ public void fn_Sun_apply (string sun) SafeNativeMethods.mwle_fn_Sun_apply(sbsun); } /// -/// @brief Initializes and open the telnet console. @param port Port to listen on for console connections (0 will shut down listening). @param consolePass Password for read/write access to console. @param listenPass Password for read access to console. @param remoteEcho [optional] Enable echoing back to the client, off by default. @ingroup Debugging) +/// @brief Initializes and open the telnet console. +/// @param port Port to listen on for console connections (0 will shut down listening). +/// @param consolePass Password for read/write access to console. +/// @param listenPass Password for read access to console. +/// @param remoteEcho [optional] Enable echoing back to the client, off by default. +/// @ingroup Debugging) +/// /// public void fn_telnetSetParameters (int port, string consolePass, string listenPass, bool remoteEcho) @@ -14108,6 +17676,7 @@ public void fn_telnetSetParameters (int port, string consolePass, string listenP } /// /// png), (string filename, [string format]) - export the terrain block's heightmap to a bitmap file (default: png) ) +/// /// public bool fn_TerrainBlock_exportHeightMap (string terrainblock, string fileNameStr, string format) @@ -14128,6 +17697,7 @@ public bool fn_TerrainBlock_exportHeightMap (string terrainblock, string fileNam } /// /// png), (string filePrefix, [string format]) - export the terrain block's layer maps to bitmap files (default: png) ) +/// /// public bool fn_TerrainBlock_exportLayerMaps (string terrainblock, string filePrefixStr, string format) @@ -14147,7 +17717,9 @@ public bool fn_TerrainBlock_exportLayerMaps (string terrainblock, string filePre return SafeNativeMethods.mwle_fn_TerrainBlock_exportLayerMaps(sbterrainblock, sbfilePrefixStr, sbformat)>=1; } /// -/// ( string matName ) Adds a new material. ) +/// ( string matName ) +/// Adds a new material. ) +/// /// public int fn_TerrainEditor_addMaterial (string terraineditor, string matName) @@ -14165,6 +17737,7 @@ public int fn_TerrainEditor_addMaterial (string terraineditor, string matName) } /// /// ), (TerrainBlock terrain)) +/// /// public void fn_TerrainEditor_attachTerrain (string terraineditor, string terrain) @@ -14181,21 +17754,23 @@ public void fn_TerrainEditor_attachTerrain (string terraineditor, string terrain SafeNativeMethods.mwle_fn_TerrainEditor_attachTerrain(sbterraineditor, sbterrain); } /// -/// (float minHeight, float maxHeight, float minSlope, float maxSlope)) +/// (F32 minHeight, F32 maxHeight, F32 minSlope, F32 maxSlope , F32 coverage)) +/// /// -public void fn_TerrainEditor_autoMaterialLayer (string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope) +public void fn_TerrainEditor_autoMaterialLayer (string terraineditor, float minHeight, float maxHeight, float minSlope, float maxSlope, float coverage) { if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_TerrainEditor_autoMaterialLayer'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" \"{4}\" ",terraineditor,minHeight,maxHeight,minSlope,maxSlope)); +System.Console.WriteLine("----------------->Extern Call 'fn_TerrainEditor_autoMaterialLayer'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" \"{4}\" \"{5}\" ",terraineditor,minHeight,maxHeight,minSlope,maxSlope,coverage)); StringBuilder sbterraineditor = null; if (terraineditor != null) sbterraineditor = new StringBuilder(terraineditor, 1024); -SafeNativeMethods.mwle_fn_TerrainEditor_autoMaterialLayer(sbterraineditor, minHeight, maxHeight, minSlope, maxSlope); +SafeNativeMethods.mwle_fn_TerrainEditor_autoMaterialLayer(sbterraineditor, minHeight, maxHeight, minSlope, maxSlope, coverage); } /// /// ) +/// /// public void fn_TerrainEditor_clearSelection (string terraineditor) @@ -14210,6 +17785,7 @@ public void fn_TerrainEditor_clearSelection (string terraineditor) } /// /// (int num)) +/// /// public string fn_TerrainEditor_getActionName (string terraineditor, uint index) @@ -14227,6 +17803,7 @@ public string fn_TerrainEditor_getActionName (string terraineditor, uint index) } /// /// ) +/// /// public int fn_TerrainEditor_getActiveTerrain (string terraineditor) @@ -14241,6 +17818,7 @@ public int fn_TerrainEditor_getActiveTerrain (string terraineditor) } /// /// Returns a Point2I.) +/// /// public string fn_TerrainEditor_getBrushPos (string terraineditor) @@ -14258,6 +17836,7 @@ public string fn_TerrainEditor_getBrushPos (string terraineditor) } /// /// ()) +/// /// public float fn_TerrainEditor_getBrushPressure (string terraineditor) @@ -14272,6 +17851,7 @@ public float fn_TerrainEditor_getBrushPressure (string terraineditor) } /// /// ()) +/// /// public string fn_TerrainEditor_getBrushSize (string terraineditor) @@ -14289,6 +17869,7 @@ public string fn_TerrainEditor_getBrushSize (string terraineditor) } /// /// ()) +/// /// public float fn_TerrainEditor_getBrushSoftness (string terraineditor) @@ -14303,6 +17884,7 @@ public float fn_TerrainEditor_getBrushSoftness (string terraineditor) } /// /// ()) +/// /// public string fn_TerrainEditor_getBrushType (string terraineditor) @@ -14320,6 +17902,7 @@ public string fn_TerrainEditor_getBrushType (string terraineditor) } /// /// ) +/// /// public string fn_TerrainEditor_getCurrentAction (string terraineditor) @@ -14337,6 +17920,7 @@ public string fn_TerrainEditor_getCurrentAction (string terraineditor) } /// /// Returns the current material count. ) +/// /// public int fn_TerrainEditor_getMaterialCount (string terraineditor) @@ -14351,6 +17935,7 @@ public int fn_TerrainEditor_getMaterialCount (string terraineditor) } /// /// ( string name ) - Returns the index of the material with the given name or -1. ) +/// /// public int fn_TerrainEditor_getMaterialIndex (string terraineditor, string name) @@ -14368,6 +17953,7 @@ public int fn_TerrainEditor_getMaterialIndex (string terraineditor, string name) } /// /// ( int index ) - Returns the name of the material at the given index. ) +/// /// public string fn_TerrainEditor_getMaterialName (string terraineditor, int index) @@ -14385,6 +17971,7 @@ public string fn_TerrainEditor_getMaterialName (string terraineditor, int index) } /// /// () gets the list of current terrain materials.) +/// /// public string fn_TerrainEditor_getMaterials (string terraineditor) @@ -14402,6 +17989,7 @@ public string fn_TerrainEditor_getMaterials (string terraineditor) } /// /// ) +/// /// public int fn_TerrainEditor_getNumActions (string terraineditor) @@ -14416,6 +18004,7 @@ public int fn_TerrainEditor_getNumActions (string terraineditor) } /// /// ) +/// /// public int fn_TerrainEditor_getNumTextures (string terraineditor) @@ -14430,6 +18019,7 @@ public int fn_TerrainEditor_getNumTextures (string terraineditor) } /// /// ) +/// /// public float fn_TerrainEditor_getSlopeLimitMaxAngle (string terraineditor) @@ -14444,6 +18034,7 @@ public float fn_TerrainEditor_getSlopeLimitMaxAngle (string terraineditor) } /// /// ) +/// /// public float fn_TerrainEditor_getSlopeLimitMinAngle (string terraineditor) @@ -14458,6 +18049,7 @@ public float fn_TerrainEditor_getSlopeLimitMinAngle (string terraineditor) } /// /// (S32 index)) +/// /// public int fn_TerrainEditor_getTerrainBlock (string terraineditor, int index) @@ -14472,6 +18064,7 @@ public int fn_TerrainEditor_getTerrainBlock (string terraineditor, int index) } /// /// ()) +/// /// public int fn_TerrainEditor_getTerrainBlockCount (string terraineditor) @@ -14486,6 +18079,7 @@ public int fn_TerrainEditor_getTerrainBlockCount (string terraineditor) } /// /// () gets the list of current terrain materials for all terrain blocks.) +/// /// public string fn_TerrainEditor_getTerrainBlocksMaterialList (string terraineditor) @@ -14502,7 +18096,12 @@ public string fn_TerrainEditor_getTerrainBlocksMaterialList (string terrainedito } /// -/// , , ), (x/y/z) Gets the terrain block that is located under the given world point. @param x/y/z The world coordinates (floating point values) you wish to query at. These can be formatted as either a string (\"x y z\") or separately as (x, y, z) @return Returns the ID of the requested terrain block (0 if not found).) +/// , , ), +/// (x/y/z) Gets the terrain block that is located under the given world point. +/// @param x/y/z The world coordinates (floating point values) you wish to query at. +/// These can be formatted as either a string (\"x y z\") or separately as (x, y, z) +/// @return Returns the ID of the requested terrain block (0 if not found).) +/// /// public int fn_TerrainEditor_getTerrainUnderWorldPoint (string terraineditor, string ptOrX, string Y, string Z) @@ -14526,6 +18125,7 @@ public int fn_TerrainEditor_getTerrainUnderWorldPoint (string terraineditor, str } /// /// ) +/// /// public void fn_TerrainEditor_markEmptySquares (string terraineditor) @@ -14540,6 +18140,7 @@ public void fn_TerrainEditor_markEmptySquares (string terraineditor) } /// /// ) +/// /// public void fn_TerrainEditor_mirrorTerrain (string terraineditor, int mirrorIndex) @@ -14554,6 +18155,7 @@ public void fn_TerrainEditor_mirrorTerrain (string terraineditor, int mirrorInde } /// /// ), (string action=NULL)) +/// /// public void fn_TerrainEditor_processAction (string terraineditor, string action) @@ -14571,6 +18173,7 @@ public void fn_TerrainEditor_processAction (string terraineditor, string action) } /// /// ( int index ) - Remove the material at the given index. ) +/// /// public void fn_TerrainEditor_removeMaterial (string terraineditor, int index) @@ -14584,7 +18187,9 @@ public void fn_TerrainEditor_removeMaterial (string terraineditor, int index) SafeNativeMethods.mwle_fn_TerrainEditor_removeMaterial(sbterraineditor, index); } /// -/// ( int index, int order ) - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// ( int index, int order ) +/// - Reorder material at the given index to the new position, changing the order in which it is rendered / blended. ) +/// /// public void fn_TerrainEditor_reorderMaterial (string terraineditor, int index, int orderPos) @@ -14599,6 +18204,7 @@ public void fn_TerrainEditor_reorderMaterial (string terraineditor, int index, i } /// /// (bool clear)) +/// /// public void fn_TerrainEditor_resetSelWeights (string terraineditor, bool clear) @@ -14613,6 +18219,7 @@ public void fn_TerrainEditor_resetSelWeights (string terraineditor, bool clear) } /// /// (string action_name)) +/// /// public void fn_TerrainEditor_setAction (string terraineditor, string action_name) @@ -14630,6 +18237,7 @@ public void fn_TerrainEditor_setAction (string terraineditor, string action_name } /// /// Location) +/// /// public void fn_TerrainEditor_setBrushPos (string terraineditor, string pos) @@ -14647,6 +18255,7 @@ public void fn_TerrainEditor_setBrushPos (string terraineditor, string pos) } /// /// (float pressure)) +/// /// public void fn_TerrainEditor_setBrushPressure (string terraineditor, float pressure) @@ -14661,6 +18270,7 @@ public void fn_TerrainEditor_setBrushPressure (string terraineditor, float press } /// /// (int w [, int h])) +/// /// public void fn_TerrainEditor_setBrushSize (string terraineditor, int w, int h) @@ -14675,6 +18285,7 @@ public void fn_TerrainEditor_setBrushSize (string terraineditor, int w, int h) } /// /// (float softness)) +/// /// public void fn_TerrainEditor_setBrushSoftness (string terraineditor, float softness) @@ -14688,7 +18299,9 @@ public void fn_TerrainEditor_setBrushSoftness (string terraineditor, float softn SafeNativeMethods.mwle_fn_TerrainEditor_setBrushSoftness(sbterraineditor, softness); } /// -/// (string type) One of box, ellipse, selection.) +/// (string type) +/// One of box, ellipse, selection.) +/// /// public void fn_TerrainEditor_setBrushType (string terraineditor, string type) @@ -14706,6 +18319,7 @@ public void fn_TerrainEditor_setBrushType (string terraineditor, string type) } /// /// ) +/// /// public float fn_TerrainEditor_setSlopeLimitMaxAngle (string terraineditor, float angle) @@ -14720,6 +18334,7 @@ public float fn_TerrainEditor_setSlopeLimitMaxAngle (string terraineditor, float } /// /// ) +/// /// public float fn_TerrainEditor_setSlopeLimitMinAngle (string terraineditor, float angle) @@ -14734,6 +18349,7 @@ public float fn_TerrainEditor_setSlopeLimitMinAngle (string terraineditor, float } /// /// (bool overlayEnable) - sets the terraformer current heightmap to draw as an overlay over the current terrain.) +/// /// public void fn_TerrainEditor_setTerraformOverlay (string terraineditor, bool overlayEnable) @@ -14747,7 +18363,9 @@ public void fn_TerrainEditor_setTerraformOverlay (string terraineditor, bool ove SafeNativeMethods.mwle_fn_TerrainEditor_setTerraformOverlay(sbterraineditor, overlayEnable); } /// -/// ( int index, string matName ) Changes the material name at the index. ) +/// ( int index, string matName ) +/// Changes the material name at the index. ) +/// /// public bool fn_TerrainEditor_updateMaterial (string terraineditor, uint index, string matName) @@ -14765,6 +18383,7 @@ public bool fn_TerrainEditor_updateMaterial (string terraineditor, uint index, s } /// /// ( TerrainBlock obj, F32 factor, U32 steps )) +/// /// public void fn_TerrainSmoothAction_smooth (string terrainsmoothaction, string terrain, float factor, uint steps) @@ -14782,6 +18401,7 @@ public void fn_TerrainSmoothAction_smooth (string terrainsmoothaction, string te } /// /// () ) +/// /// public void fn_TerrainSolderEdgesAction_solder (string terrainsolderedgesaction) @@ -14796,6 +18416,7 @@ public void fn_TerrainSolderEdgesAction_solder (string terrainsolderedgesaction) } /// /// testBridge(arg1, arg2, arg3)) +/// /// public string fn_testJavaScriptBridge (string arg1, string arg2, string arg3) @@ -14819,6 +18440,7 @@ public string fn_testJavaScriptBridge (string arg1, string arg2, string arg3) } /// /// Pause playback of the video. ) +/// /// public void fn_TheoraTextureObject_pause (string theoratextureobject) @@ -14833,6 +18455,7 @@ public void fn_TheoraTextureObject_pause (string theoratextureobject) } /// /// Start playback of the video. ) +/// /// public void fn_TheoraTextureObject_play (string theoratextureobject) @@ -14847,6 +18470,7 @@ public void fn_TheoraTextureObject_play (string theoratextureobject) } /// /// Stop playback of the video. ) +/// /// public void fn_TheoraTextureObject_stop (string theoratextureobject) @@ -14860,7 +18484,13 @@ public void fn_TheoraTextureObject_stop (string theoratextureobject) SafeNativeMethods.mwle_fn_TheoraTextureObject_stop(sbtheoratextureobject); } /// -/// Enable or disable tracing in the script code VM. When enabled, the script code runtime will trace the invocation and returns from all functions that are called and log them to the console. This is helpful in observing the flow of the script program. @param enable New setting for script trace execution, on by default. @ingroup Debugging ) +/// Enable or disable tracing in the script code VM. +/// When enabled, the script code runtime will trace the invocation and returns +/// from all functions that are called and log them to the console. This is helpful in +/// observing the flow of the script program. +/// @param enable New setting for script trace execution, on by default. +/// @ingroup Debugging ) +/// /// public void fn_trace (bool enable) @@ -14871,7 +18501,14 @@ public void fn_trace (bool enable) SafeNativeMethods.mwle_fn_trace(enable); } /// -/// Remove leading and trailing whitespace from the string. @param str A string. @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. @tsexample trim( \" string \" ); // Returns \"string\". @endtsexample @ingroup Strings ) +/// Remove leading and trailing whitespace from the string. +/// @param str A string. +/// @return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed. +/// @tsexample +/// trim( \" string \" ); // Returns \"string\". +/// @endtsexample +/// @ingroup Strings ) +/// /// public string fn_trim (string str) @@ -14889,6 +18526,7 @@ public string fn_trim (string str) } /// /// tsUpdateImposterImages( bool forceupdate )) +/// /// public void fn_tsUpdateImposterImages (bool forceUpdate) @@ -14900,6 +18538,7 @@ public void fn_tsUpdateImposterImages (bool forceUpdate) } /// /// ), action.addToManager([undoManager])) +/// /// public void fn_UndoAction_addToManager (string undoaction, string undoManager) @@ -14917,6 +18556,7 @@ public void fn_UndoAction_addToManager (string undoaction, string undoManager) } /// /// () - Reo action contained in undo. ) +/// /// public void fn_UndoAction_redo (string undoaction) @@ -14931,6 +18571,7 @@ public void fn_UndoAction_redo (string undoaction) } /// /// () - Undo action contained in undo. ) +/// /// public void fn_UndoAction_undo (string undoaction) @@ -14945,6 +18586,7 @@ public void fn_UndoAction_undo (string undoaction) } /// /// Clears the undo manager.) +/// /// public void fn_UndoManager_clearAll (string undomanager) @@ -14959,6 +18601,7 @@ public void fn_UndoManager_clearAll (string undomanager) } /// /// UndoManager.getNextRedoName();) +/// /// public string fn_UndoManager_getNextRedoName (string undomanager) @@ -14976,6 +18619,7 @@ public string fn_UndoManager_getNextRedoName (string undomanager) } /// /// UndoManager.getNextUndoName();) +/// /// public string fn_UndoManager_getNextUndoName (string undomanager) @@ -14993,6 +18637,7 @@ public string fn_UndoManager_getNextUndoName (string undomanager) } /// /// (index)) +/// /// public int fn_UndoManager_getRedoAction (string undomanager, int index) @@ -15007,6 +18652,7 @@ public int fn_UndoManager_getRedoAction (string undomanager, int index) } /// /// ) +/// /// public int fn_UndoManager_getRedoCount (string undomanager) @@ -15021,6 +18667,7 @@ public int fn_UndoManager_getRedoCount (string undomanager) } /// /// (index)) +/// /// public string fn_UndoManager_getRedoName (string undomanager, int index) @@ -15038,6 +18685,7 @@ public string fn_UndoManager_getRedoName (string undomanager, int index) } /// /// (index)) +/// /// public int fn_UndoManager_getUndoAction (string undomanager, int index) @@ -15052,6 +18700,7 @@ public int fn_UndoManager_getUndoAction (string undomanager, int index) } /// /// ) +/// /// public int fn_UndoManager_getUndoCount (string undomanager) @@ -15066,6 +18715,7 @@ public int fn_UndoManager_getUndoCount (string undomanager) } /// /// (index)) +/// /// public string fn_UndoManager_getUndoName (string undomanager, int index) @@ -15083,6 +18733,7 @@ public string fn_UndoManager_getUndoName (string undomanager, int index) } /// /// ( bool discard=false ) - Pop the current CompoundUndoAction off the stack. ) +/// /// public void fn_UndoManager_popCompound (string undomanager, bool discard) @@ -15097,6 +18748,7 @@ public void fn_UndoManager_popCompound (string undomanager, bool discard) } /// /// \"\"), ( string name=\"\" ) - Push a CompoundUndoAction onto the compound stack for assembly. ) +/// /// public string fn_UndoManager_pushCompound (string undomanager, string name) @@ -15117,6 +18769,7 @@ public string fn_UndoManager_pushCompound (string undomanager, string name) } /// /// UndoManager.redo();) +/// /// public void fn_UndoManager_redo (string undomanager) @@ -15131,6 +18784,7 @@ public void fn_UndoManager_redo (string undomanager) } /// /// UndoManager.undo();) +/// /// public void fn_UndoManager_undo (string undomanager) @@ -15144,21 +18798,12 @@ public void fn_UndoManager_undo (string undomanager) SafeNativeMethods.mwle_fn_UndoManager_undo(sbundomanager); } /// -/// , false), ([searchString[, bool skipInteractive]]) @brief Run unit tests, or just the tests that prefix match against the searchString. @ingroup Console) -/// - -public void fn_unitTest_runTests (string searchString, bool skip) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fn_unitTest_runTests'" + string.Format("\"{0}\" \"{1}\" ",searchString,skip)); -StringBuilder sbsearchString = null; -if (searchString != null) - sbsearchString = new StringBuilder(searchString, 1024); - -SafeNativeMethods.mwle_fn_unitTest_runTests(sbsearchString, skip); -} -/// -/// (string queueName, string listener) @brief Unregisters an event message @param queueName String containing the name of queue @param listener Name of event messenger @ingroup Messaging) +/// (string queueName, string listener) +/// @brief Unregisters an event message +/// @param queueName String containing the name of queue +/// @param listener Name of event messenger +/// @ingroup Messaging) +/// /// public void fn_unregisterMessageListener (string queueName, string listenerName) @@ -15175,7 +18820,11 @@ public void fn_unregisterMessageListener (string queueName, string listenerName) SafeNativeMethods.mwle_fn_unregisterMessageListener(sbqueueName, sblistenerName); } /// -/// (string queueName) @brief Unregisters a dispatcher queue @param queueName String containing the name of queue @ingroup Messaging) +/// (string queueName) +/// @brief Unregisters a dispatcher queue +/// @param queueName String containing the name of queue +/// @ingroup Messaging) +/// /// public void fn_unregisterMessageQueue (string queueName) @@ -15189,7 +18838,28 @@ public void fn_unregisterMessageQueue (string queueName) SafeNativeMethods.mwle_fn_unregisterMessageQueue(sbqueueName); } /// -/// Add two vectors. @param a The first vector. @param b The second vector. @return The vector @a a + @a b. @tsexample //----------------------------------------------------------------------------- // // VectorAdd( %a, %b ); // // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a + b = ( ax + bx, ay + by, az + bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; // %r = \"1 1 0\"; %r = VectorAdd( %a, %b ); @endtsexample @ingroup Vectors) +/// Add two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a + @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorAdd( %a, %b ); +/// // +/// // The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a + b = ( ax + bx, ay + by, az + bz ) +/// // +/// //----------------------------------------------------------------------------- +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// // %r = \"( 1 + 0, 0 + 1, 0 + 0 )\"; +/// // %r = \"1 1 0\"; +/// %r = VectorAdd( %a, %b ); +/// @endtsexample +/// @ingroup Vectors) +/// /// public string fn_VectorAdd (string a, string b) @@ -15209,7 +18879,30 @@ public string fn_VectorAdd (string a, string b) } /// -/// Calculcate the cross product of two vectors. @param a The first vector. @param b The second vector. @return The cross product @a x @a b. @tsexample //----------------------------------------------------------------------------- // // VectorCross( %a, %b ); // // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; // %r = \"1 -1 -2\"; %r = VectorCross( %a, %b ); @endtsexample @ingroup Vectors ) +/// Calculcate the cross product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The cross product @a x @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorCross( %a, %b ); +/// // +/// // The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )\"; +/// // %r = \"1 -1 -2\"; +/// %r = VectorCross( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorCross (string a, string b) @@ -15229,7 +18922,32 @@ public string fn_VectorCross (string a, string b) } /// -/// Compute the distance between two vectors. @param a The first vector. @param b The second vector. @return The length( @a b - @a a ). @tsexample //----------------------------------------------------------------------------- // // VectorDist( %a, %b ); // // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is // // a -> b = ||( b - a )|| // = ||( bx - ax, by - ay, bz - az )|| // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); // %r = mSqrt( 3 ); %r = VectorDist( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the distance between two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The length( @a b - @a a ). +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDist( %a, %b ); +/// // +/// // The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is +/// // +/// // a -> b = ||( b - a )|| +/// // = ||( bx - ax, by - ay, bz - az )|| +/// // = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) ); +/// // %r = mSqrt( 3 ); +/// %r = VectorDist( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float fn_VectorDist (string a, string b) @@ -15246,7 +18964,30 @@ public float fn_VectorDist (string a, string b) return SafeNativeMethods.mwle_fn_VectorDist(sba, sbb); } /// -/// Compute the dot product of two vectors. @param a The first vector. @param b The second vector. @return The dot product @a a * @a b. @tsexample //----------------------------------------------------------------------------- // // VectorDot( %a, %b ); // // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: // // a . b = ( ax * bx + ay * by + az * bz ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; // %r = 2; %r = VectorDot( %a, %b ); @endtsexample @ingroup Vectors ) +/// Compute the dot product of two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The dot product @a a * @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorDot( %a, %b ); +/// // +/// // The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is: +/// // +/// // a . b = ( ax * bx + ay * by + az * bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// +/// // %r = \"( 1 * 2 + 1 * 0 + 0 * 1 )\"; +/// // %r = 2; +/// %r = VectorDot( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float fn_VectorDot (string a, string b) @@ -15263,7 +19004,29 @@ public float fn_VectorDot (string a, string b) return SafeNativeMethods.mwle_fn_VectorDot(sba, sbb); } /// -/// Calculate the magnitude of the given vector. @param v A vector. @return The length of vector @a v. @tsexample //----------------------------------------------------------------------------- // // VectorLen( %a ); // // The length or magnitude of vector a, (ax, ay, az), is: // // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); // %r = mSqrt( 2 ); // %r = 1.414; %r = VectorLen( %a ); @endtsexample @ingroup Vectors ) +/// Calculate the magnitude of the given vector. +/// @param v A vector. +/// @return The length of vector @a v. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLen( %a ); +/// // +/// // The length or magnitude of vector a, (ax, ay, az), is: +/// // +/// // ||a|| = Sqrt( ax * ax + ay * ay + az * az ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// +/// // %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 ); +/// // %r = mSqrt( 2 ); +/// // %r = 1.414; +/// %r = VectorLen( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public float fn_VectorLen (string v) @@ -15277,7 +19040,35 @@ public float fn_VectorLen (string v) return SafeNativeMethods.mwle_fn_VectorLen(sbv); } /// -/// Linearly interpolate between two vectors by @a t. @param a Vector to start interpolation from. @param b Vector to interpolate to. @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector between @a a and @a b is returned. @return An interpolated vector between @a a and @a b. @tsexample //----------------------------------------------------------------------------- // // VectorLerp( %a, %b ); // // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is // weighted by the interpolation factor, t, is // // r = a + t * ( b - a ) // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %b = \"2 0 1\"; %v = \"0.25\"; // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; // %r = \"1.25 0.75 0.25\"; %r = VectorLerp( %a, %b ); @endtsexample @ingroup Vectors ) +/// Linearly interpolate between two vectors by @a t. +/// @param a Vector to start interpolation from. +/// @param b Vector to interpolate to. +/// @param t Interpolation factor (0-1). At zero, @a a is returned and at one, @a b is returned. In between, an interpolated vector +/// between @a a and @a b is returned. +/// @return An interpolated vector between @a a and @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorLerp( %a, %b ); +/// // +/// // The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is +/// // weighted by the interpolation factor, t, is +/// // +/// // r = a + t * ( b - a ) +/// // = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %b = \"2 0 1\"; +/// %v = \"0.25\"; +/// +/// // %r = \"( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )\"; +/// // %r = \"1.25 0.75 0.25\"; +/// %r = VectorLerp( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorLerp (string a, string b, float t) @@ -15297,7 +19088,30 @@ public string fn_VectorLerp (string a, string b, float t) } /// -/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. @param v The vector to normalize. @return The vector @a v scaled to length 1. @tsexample //----------------------------------------------------------------------------- // // VectorNormalize( %a ); // // The normalized vector a, (ax, ay, az), is: // // a^ = a / ||a|| // = ( ax / ||a||, ay / ||a||, az / ||a|| ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %l = 1.414; // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; // %r = \"0.707 0.707 0\"; %r = VectorNormalize( %a ); @endtsexample @ingroup Vectors ) +/// Brings a vector into its unit form, i.e. such that it has the magnitute 1. +/// @param v The vector to normalize. +/// @return The vector @a v scaled to length 1. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorNormalize( %a ); +/// // +/// // The normalized vector a, (ax, ay, az), is: +/// // +/// // a^ = a / ||a|| +/// // = ( ax / ||a||, ay / ||a||, az / ||a|| ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %l = 1.414; +/// +/// // %r = \"( 1 / 1.141, 1 / 1.141, 0 / 1.141 )\"; +/// // %r = \"0.707 0.707 0\"; +/// %r = VectorNormalize( %a ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorNormalize (string v) @@ -15314,7 +19128,11 @@ public string fn_VectorNormalize (string v) } /// -/// Create an orthogonal basis from the given vector. @param aaf The vector to create the orthogonal basis from. @return A matrix representing the orthogonal basis. @ingroup Vectors ) +/// Create an orthogonal basis from the given vector. +/// @param aaf The vector to create the orthogonal basis from. +/// @return A matrix representing the orthogonal basis. +/// @ingroup Vectors ) +/// /// public string fn_VectorOrthoBasis (string aa) @@ -15332,6 +19150,7 @@ public string fn_VectorOrthoBasis (string aa) } /// /// (Vector3F, float) rotate a vector in 2d) +/// /// public string fn_VectorRot (string v, float angle) @@ -15348,7 +19167,30 @@ public string fn_VectorRot (string v, float angle) } /// -/// Scales a vector by a scalar. @param a The vector to scale. @param scalar The scale factor. @return The vector @a a * @a scalar. @tsexample //----------------------------------------------------------------------------- // // VectorScale( %a, %v ); // // Scaling vector a, (ax, ay, az), but the scalar, v, is: // // a * v = ( ax * v, ay * v, az * v ) // //----------------------------------------------------------------------------- %a = \"1 1 0\"; %v = \"2\"; // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; // %r = \"2 2 0\"; %r = VectorScale( %a, %v ); @endtsexample @ingroup Vectors ) +/// Scales a vector by a scalar. +/// @param a The vector to scale. +/// @param scalar The scale factor. +/// @return The vector @a a * @a scalar. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorScale( %a, %v ); +/// // +/// // Scaling vector a, (ax, ay, az), but the scalar, v, is: +/// // +/// // a * v = ( ax * v, ay * v, az * v ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 1 0\"; +/// %v = \"2\"; +/// +/// // %r = \"( 1 * 2, 1 * 2, 0 * 2 )\"; +/// // %r = \"2 2 0\"; +/// %r = VectorScale( %a, %v ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorScale (string a, float scalar) @@ -15365,7 +19207,30 @@ public string fn_VectorScale (string a, float scalar) } /// -/// Subtract two vectors. @param a The first vector. @param b The second vector. @return The vector @a a - @a b. @tsexample //----------------------------------------------------------------------------- // // VectorSub( %a, %b ); // // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: // // a - b = ( ax - bx, ay - by, az - bz ) // //----------------------------------------------------------------------------- %a = \"1 0 0\"; %b = \"0 1 0\"; // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; // %r = \"1 -1 0\"; %r = VectorSub( %a, %b ); @endtsexample @ingroup Vectors ) +/// Subtract two vectors. +/// @param a The first vector. +/// @param b The second vector. +/// @return The vector @a a - @a b. +/// @tsexample +/// //----------------------------------------------------------------------------- +/// // +/// // VectorSub( %a, %b ); +/// // +/// // The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is: +/// // +/// // a - b = ( ax - bx, ay - by, az - bz ) +/// // +/// //----------------------------------------------------------------------------- +/// +/// %a = \"1 0 0\"; +/// %b = \"0 1 0\"; +/// +/// // %r = \"( 1 - 0, 0 - 1, 0 - 0 )\"; +/// // %r = \"1 -1 0\"; +/// %r = VectorSub( %a, %b ); +/// @endtsexample +/// @ingroup Vectors ) +/// /// public string fn_VectorSub (string a, string b) @@ -15410,6 +19275,7 @@ public void fn_WalkaboutUpdateMesh (int meshid, int objid, bool remove) } /// /// ) +/// /// public void fn_WorldEditor_addUndoState (string worldeditor) @@ -15423,7 +19289,9 @@ public void fn_WorldEditor_addUndoState (string worldeditor) SafeNativeMethods.mwle_fn_WorldEditor_addUndoState(sbworldeditor); } /// -/// (int axis) Align all selected objects along the given axis.) +/// (int axis) +/// Align all selected objects along the given axis.) +/// /// public void fn_WorldEditor_alignByAxis (string worldeditor, int boundsAxis) @@ -15437,7 +19305,9 @@ public void fn_WorldEditor_alignByAxis (string worldeditor, int boundsAxis) SafeNativeMethods.mwle_fn_WorldEditor_alignByAxis(sbworldeditor, boundsAxis); } /// -/// (int boundsAxis) Align all selected objects against the given bounds axis.) +/// (int boundsAxis) +/// Align all selected objects against the given bounds axis.) +/// /// public void fn_WorldEditor_alignByBounds (string worldeditor, int boundsAxis) @@ -15452,6 +19322,7 @@ public void fn_WorldEditor_alignByBounds (string worldeditor, int boundsAxis) } /// /// ) +/// /// public bool fn_WorldEditor_canPasteSelection (string worldeditor) @@ -15466,6 +19337,7 @@ public bool fn_WorldEditor_canPasteSelection (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_clearIgnoreList (string worldeditor) @@ -15480,6 +19352,7 @@ public void fn_WorldEditor_clearIgnoreList (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_clearSelection (string worldeditor) @@ -15494,6 +19367,7 @@ public void fn_WorldEditor_clearSelection (string worldeditor) } /// /// ( String path ) - Export the combined geometry of all selected objects to the specified path in collada format. ) +/// /// public void fn_WorldEditor_colladaExportSelection (string worldeditor, string path) @@ -15511,6 +19385,7 @@ public void fn_WorldEditor_colladaExportSelection (string worldeditor, string pa } /// /// ) +/// /// public void fn_WorldEditor_copySelection (string worldeditor) @@ -15525,6 +19400,7 @@ public void fn_WorldEditor_copySelection (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_cutSelection (string worldeditor) @@ -15539,6 +19415,7 @@ public void fn_WorldEditor_cutSelection (string worldeditor) } /// /// ( bool skipUndo = false )) +/// /// public void fn_WorldEditor_dropSelection (string worldeditor, bool skipUndo) @@ -15553,6 +19430,7 @@ public void fn_WorldEditor_dropSelection (string worldeditor, bool skipUndo) } /// /// () - Replace selected Prefab objects with a SimGroup containing all children objects defined in the .prefab. ) +/// /// public void fn_WorldEditor_explodeSelectedPrefab (string worldeditor) @@ -15567,6 +19445,7 @@ public void fn_WorldEditor_explodeSelectedPrefab (string worldeditor) } /// /// () - Return the currently active WorldEditorSelection object. ) +/// /// public int fn_WorldEditor_getActiveSelection (string worldeditor) @@ -15581,6 +19460,7 @@ public int fn_WorldEditor_getActiveSelection (string worldeditor) } /// /// (int index)) +/// /// public int fn_WorldEditor_getSelectedObject (string worldeditor, int index) @@ -15595,6 +19475,7 @@ public int fn_WorldEditor_getSelectedObject (string worldeditor, int index) } /// /// ) +/// /// public string fn_WorldEditor_getSelectionCentroid (string worldeditor) @@ -15612,6 +19493,7 @@ public string fn_WorldEditor_getSelectionCentroid (string worldeditor) } /// /// ) +/// /// public string fn_WorldEditor_getSelectionExtent (string worldeditor) @@ -15629,6 +19511,7 @@ public string fn_WorldEditor_getSelectionExtent (string worldeditor) } /// /// ) +/// /// public float fn_WorldEditor_getSelectionRadius (string worldeditor) @@ -15643,6 +19526,7 @@ public float fn_WorldEditor_getSelectionRadius (string worldeditor) } /// /// () - Return the number of objects currently selected in the editor.) +/// /// public int fn_WorldEditor_getSelectionSize (string worldeditor) @@ -15656,7 +19540,9 @@ public int fn_WorldEditor_getSelectionSize (string worldeditor) return SafeNativeMethods.mwle_fn_WorldEditor_getSelectionSize(sbworldeditor); } /// -/// getSoftSnap() Is soft snapping always on?) +/// getSoftSnap() +/// Is soft snapping always on?) +/// /// public bool fn_WorldEditor_getSoftSnap (string worldeditor) @@ -15670,7 +19556,9 @@ public bool fn_WorldEditor_getSoftSnap (string worldeditor) return SafeNativeMethods.mwle_fn_WorldEditor_getSoftSnap(sbworldeditor)>=1; } /// -/// getSoftSnapBackfaceTolerance() The fraction of the soft snap radius that backfaces may be included.) +/// getSoftSnapBackfaceTolerance() +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public float fn_WorldEditor_getSoftSnapBackfaceTolerance (string worldeditor) @@ -15684,7 +19572,9 @@ public float fn_WorldEditor_getSoftSnapBackfaceTolerance (string worldeditor) return SafeNativeMethods.mwle_fn_WorldEditor_getSoftSnapBackfaceTolerance(sbworldeditor); } /// -/// getSoftSnapSize() Get the absolute size to trigger a soft snap.) +/// getSoftSnapSize() +/// Get the absolute size to trigger a soft snap.) +/// /// public float fn_WorldEditor_getSoftSnapSize (string worldeditor) @@ -15699,6 +19589,7 @@ public float fn_WorldEditor_getSoftSnapSize (string worldeditor) } /// /// (Object obj, bool hide)) +/// /// public void fn_WorldEditor_hideObject (string worldeditor, string obj, bool hide) @@ -15716,6 +19607,7 @@ public void fn_WorldEditor_hideObject (string worldeditor, string obj, bool hide } /// /// (bool hide)) +/// /// public void fn_WorldEditor_hideSelection (string worldeditor, bool hide) @@ -15730,6 +19622,7 @@ public void fn_WorldEditor_hideSelection (string worldeditor, bool hide) } /// /// ) +/// /// public void fn_WorldEditor_invalidateSelectionCentroid (string worldeditor) @@ -15744,6 +19637,7 @@ public void fn_WorldEditor_invalidateSelectionCentroid (string worldeditor) } /// /// (bool lock)) +/// /// public void fn_WorldEditor_lockSelection (string worldeditor, bool lockx) @@ -15758,6 +19652,7 @@ public void fn_WorldEditor_lockSelection (string worldeditor, bool lockx) } /// /// ( string filename ) - Save selected objects to a .prefab file and replace them in the level with a Prefab object. ) +/// /// public void fn_WorldEditor_makeSelectionPrefab (string worldeditor, string filename) @@ -15775,6 +19670,7 @@ public void fn_WorldEditor_makeSelectionPrefab (string worldeditor, string filen } /// /// ( Object A, Object B ) ) +/// /// public void fn_WorldEditor_mountRelative (string worldeditor, string objA, string objB) @@ -15795,6 +19691,7 @@ public void fn_WorldEditor_mountRelative (string worldeditor, string objA, strin } /// /// ) +/// /// public void fn_WorldEditor_pasteSelection (string worldeditor) @@ -15809,6 +19706,7 @@ public void fn_WorldEditor_pasteSelection (string worldeditor) } /// /// ( int objID )) +/// /// public void fn_WorldEditor_redirectConsole (string worldeditor, int objID) @@ -15823,6 +19721,7 @@ public void fn_WorldEditor_redirectConsole (string worldeditor, int objID) } /// /// ) +/// /// public void fn_WorldEditor_resetSelectedRotation (string worldeditor) @@ -15837,6 +19736,7 @@ public void fn_WorldEditor_resetSelectedRotation (string worldeditor) } /// /// ) +/// /// public void fn_WorldEditor_resetSelectedScale (string worldeditor) @@ -15851,6 +19751,7 @@ public void fn_WorldEditor_resetSelectedScale (string worldeditor) } /// /// (SimObject obj)) +/// /// public void fn_WorldEditor_selectObject (string worldeditor, string objName) @@ -15868,6 +19769,7 @@ public void fn_WorldEditor_selectObject (string worldeditor, string objName) } /// /// ( id set ) - Set the currently active WorldEditorSelection object. ) +/// /// public void fn_WorldEditor_setActiveSelection (string worldeditor, string selection) @@ -15884,7 +19786,9 @@ public void fn_WorldEditor_setActiveSelection (string worldeditor, string select SafeNativeMethods.mwle_fn_WorldEditor_setActiveSelection(sbworldeditor, sbselection); } /// -/// setSoftSnap(bool) Allow soft snapping all of the time.) +/// setSoftSnap(bool) +/// Allow soft snapping all of the time.) +/// /// public void fn_WorldEditor_setSoftSnap (string worldeditor, bool enable) @@ -15898,7 +19802,9 @@ public void fn_WorldEditor_setSoftSnap (string worldeditor, bool enable) SafeNativeMethods.mwle_fn_WorldEditor_setSoftSnap(sbworldeditor, enable); } /// -/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) The fraction of the soft snap radius that backfaces may be included.) +/// setSoftSnapBackfaceTolerance(F32 with range of 0..1) +/// The fraction of the soft snap radius that backfaces may be included.) +/// /// public void fn_WorldEditor_setSoftSnapBackfaceTolerance (string worldeditor, float range) @@ -15912,7 +19818,9 @@ public void fn_WorldEditor_setSoftSnapBackfaceTolerance (string worldeditor, flo SafeNativeMethods.mwle_fn_WorldEditor_setSoftSnapBackfaceTolerance(sbworldeditor, range); } /// -/// setSoftSnapSize(F32) Set the absolute size to trigger a soft snap.) +/// setSoftSnapSize(F32) +/// Set the absolute size to trigger a soft snap.) +/// /// public void fn_WorldEditor_setSoftSnapSize (string worldeditor, float size) @@ -15926,7 +19834,9 @@ public void fn_WorldEditor_setSoftSnapSize (string worldeditor, float size) SafeNativeMethods.mwle_fn_WorldEditor_setSoftSnapSize(sbworldeditor, size); } /// -/// softSnapDebugRender(bool) Toggle soft snapping debug rendering.) +/// softSnapDebugRender(bool) +/// Toggle soft snapping debug rendering.) +/// /// public void fn_WorldEditor_softSnapDebugRender (string worldeditor, bool enable) @@ -15940,7 +19850,9 @@ public void fn_WorldEditor_softSnapDebugRender (string worldeditor, bool enable) SafeNativeMethods.mwle_fn_WorldEditor_softSnapDebugRender(sbworldeditor, enable); } /// -/// softSnapRender(bool) Render the soft snapping bounds.) +/// softSnapRender(bool) +/// Render the soft snapping bounds.) +/// /// public void fn_WorldEditor_softSnapRender (string worldeditor, bool enable) @@ -15954,7 +19866,9 @@ public void fn_WorldEditor_softSnapRender (string worldeditor, bool enable) SafeNativeMethods.mwle_fn_WorldEditor_softSnapRender(sbworldeditor, enable); } /// -/// softSnapRenderTriangle(bool) Render the soft snapped triangle.) +/// softSnapRenderTriangle(bool) +/// Render the soft snapped triangle.) +/// /// public void fn_WorldEditor_softSnapRenderTriangle (string worldeditor, bool enable) @@ -15968,7 +19882,9 @@ public void fn_WorldEditor_softSnapRenderTriangle (string worldeditor, bool enab SafeNativeMethods.mwle_fn_WorldEditor_softSnapRenderTriangle(sbworldeditor, enable); } /// -/// softSnapSizeByBounds(bool) Use selection bounds size as soft snap bounds.) +/// softSnapSizeByBounds(bool) +/// Use selection bounds size as soft snap bounds.) +/// /// public void fn_WorldEditor_softSnapSizeByBounds (string worldeditor, bool enable) @@ -15982,7 +19898,9 @@ public void fn_WorldEditor_softSnapSizeByBounds (string worldeditor, bool enable SafeNativeMethods.mwle_fn_WorldEditor_softSnapSizeByBounds(sbworldeditor, enable); } /// -/// transformSelection(...) Transform selection by given parameters.) +/// transformSelection(...) +/// Transform selection by given parameters.) +/// /// public void fn_WorldEditor_transformSelection (string worldeditor, bool position, string point, bool relativePos, bool rotate, string rotation, bool relativeRot, bool rotLocal, int scaleType, string scale, bool sRelative, bool sLocal) @@ -16006,6 +19924,7 @@ public void fn_WorldEditor_transformSelection (string worldeditor, bool position } /// /// (SimObject obj)) +/// /// public void fn_WorldEditor_unselectObject (string worldeditor, string objName) @@ -16022,7 +19941,9 @@ public void fn_WorldEditor_unselectObject (string worldeditor, string objName) SafeNativeMethods.mwle_fn_WorldEditor_unselectObject(sbworldeditor, sbobjName); } /// -/// Force all cached fonts to serialize themselves to the cache. @ingroup Font ) +/// Force all cached fonts to serialize themselves to the cache. +/// @ingroup Font ) +/// /// public void fn_writeFontCache () @@ -16034,7 +19955,9 @@ public void fn_writeFontCache () SafeNativeMethods.mwle_fn_writeFontCache(); } /// -/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) @hide) +/// ( ActionMap, bind, bool, 5, 10, actionMap.bind( device, action, [modifier spec, mod...], command ) +/// @hide) +/// /// public bool fnActionMap_bind (string actionmap, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9) @@ -16072,7 +19995,29 @@ public bool fnActionMap_bind (string actionmap, string a2, string a3, string a4, return SafeNativeMethods.mwle_fnActionMap_bind(sbactionmap, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9)>=1; } /// -/// ), @brief Associates a make command and optional break command to a specified input device action. Must include parenthesis and semicolon in the make and break command strings. @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. @param makeCmd The command to execute when the device/action is made. @param breakCmd [optional] The command to execute when the device or action is unmade. @return True the bind was successful, false if the device was unknown or description failed. @tsexample // Print to the console when the spacebar is pressed function onSpaceDown() { echo(\"Space bar down!\"); } // Print to the console when the spacebar is released function onSpaceUp() { echo(\"Space bar up!\"); } // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); @endtsexample) +/// ), +/// @brief Associates a make command and optional break command to a specified input device action. +/// Must include parenthesis and semicolon in the make and break command strings. +/// @param device The device to bind to. Can be a keyboard, mouse, joystick or gamepad. +/// @param action The device action to bind to. The action is dependant upon the device. Specify a key for keyboards. +/// @param makeCmd The command to execute when the device/action is made. +/// @param breakCmd [optional] The command to execute when the device or action is unmade. +/// @return True the bind was successful, false if the device was unknown or description failed. +/// @tsexample +/// // Print to the console when the spacebar is pressed +/// function onSpaceDown() +/// { +/// echo(\"Space bar down!\"); +/// } +/// // Print to the console when the spacebar is released +/// function onSpaceUp() +/// { +/// echo(\"Space bar up!\"); +/// } +/// // Bind the commands onSpaceDown() and onSpaceUp() to spacebar events +/// moveMap.bindCmd(keyboard, \"space\", \"onSpaceDown();\", \"onSpaceUp();\"); +/// @endtsexample) +/// /// public bool fnActionMap_bindCmd (string actionmap, string device, string action, string makeCmd, string breakCmd) @@ -16098,7 +20043,9 @@ public bool fnActionMap_bindCmd (string actionmap, string device, string action, return SafeNativeMethods.mwle_fnActionMap_bindCmd(sbactionmap, sbdevice, sbaction, sbmakeCmd, sbbreakCmd)>=1; } /// -/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) @hide) +/// ( ActionMap, bindObj, bool, 6, 11, (device, action, [modifier spec, mod...], command, object) +/// @hide) +/// /// public bool fnActionMap_bindObj (string actionmap, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10) @@ -16139,7 +20086,24 @@ public bool fnActionMap_bindObj (string actionmap, string a2, string a3, string return SafeNativeMethods.mwle_fnActionMap_bindObj(sbactionmap, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10)>=1; } /// -/// @brief Gets the ActionMap binding for the specified command. Use getField() on the return value to get the device and action of the binding. @param command The function to search bindings for. @return The binding against the specified command. Returns an empty string(\"\") if a binding wasn't found. @tsexample // Find what the function \"jump()\" is bound to in moveMap %bind = moveMap.getBinding( \"jump\" ); if ( %bind !$= \"\" ) { // Find out what device is used in the binding %device = getField( %bind, 0 ); // Find out what action (such as a key) is used in the binding %action = getField( %bind, 1 ); } @endtsexample @see getField) +/// @brief Gets the ActionMap binding for the specified command. +/// Use getField() on the return value to get the device and action of the binding. +/// @param command The function to search bindings for. +/// @return The binding against the specified command. Returns an empty string(\"\") +/// if a binding wasn't found. +/// @tsexample +/// // Find what the function \"jump()\" is bound to in moveMap +/// %bind = moveMap.getBinding( \"jump\" ); +/// if ( %bind !$= \"\" ) +/// { +/// // Find out what device is used in the binding +/// %device = getField( %bind, 0 ); +/// // Find out what action (such as a key) is used in the binding +/// %action = getField( %bind, 1 ); +/// } +/// @endtsexample +/// @see getField) +/// /// public string fnActionMap_getBinding (string actionmap, string command) @@ -16159,7 +20123,18 @@ public string fnActionMap_getBinding (string actionmap, string command) } /// -/// @brief Gets ActionMap command for the device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The command against the specified device and action. @tsexample // Find what function is bound to a device\'s action // In this example, \"jump()\" was assigned to the space key in another script %command = moveMap.getCommand(\"keyboard\", \"space\"); // Should print \"jump\" in the console echo(%command) @endtsexample) +/// @brief Gets ActionMap command for the device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The command against the specified device and action. +/// @tsexample +/// // Find what function is bound to a device\'s action +/// // In this example, \"jump()\" was assigned to the space key in another script +/// %command = moveMap.getCommand(\"keyboard\", \"space\"); +/// // Should print \"jump\" in the console +/// echo(%command) +/// @endtsexample) +/// /// public string fnActionMap_getCommand (string actionmap, string device, string action) @@ -16182,7 +20157,15 @@ public string fnActionMap_getCommand (string actionmap, string device, string ac } /// -/// @brief Gets the Dead zone for the specified device and action. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone or an empty string(\"\") if the mapping was not found. @tsexample %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Gets the Dead zone for the specified device and action. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return The dead zone for the specified device and action. Returns \"0 0\" if there is no dead zone +/// or an empty string(\"\") if the mapping was not found. +/// @tsexample +/// %deadZone = moveMap.getDeadZone( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public string fnActionMap_getDeadZone (string actionmap, string device, string action) @@ -16205,7 +20188,14 @@ public string fnActionMap_getDeadZone (string actionmap, string device, string a } /// -/// @brief Get any scaling on the specified device and action. @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return Any scaling applied to the specified device and action. @tsexample %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); @endtsexample) +/// @brief Get any scaling on the specified device and action. +/// @param device The device that was bound. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return Any scaling applied to the specified device and action. +/// @tsexample +/// %scale = %moveMap.getScale( \"gamepad\", \"thumbrx\"); +/// @endtsexample) +/// /// public float fnActionMap_getScale (string actionmap, string device, string action) @@ -16225,7 +20215,16 @@ public float fnActionMap_getScale (string actionmap, string device, string actio return SafeNativeMethods.mwle_fnActionMap_getScale(sbactionmap, sbdevice, sbaction); } /// -/// @brief Determines if the specified device and action is inverted. Should only be used for scrolling devices or gamepad/joystick axes. @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. @return True if the specified device and action is inverted. @tsexample %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) echo(\"Mouse's xAxis is inverted\"); @endtsexample) +/// @brief Determines if the specified device and action is inverted. +/// Should only be used for scrolling devices or gamepad/joystick axes. +/// @param device The device that was bound. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action that was bound. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the specified device and action is inverted. +/// @tsexample +/// %if ( moveMap.isInverted( \"mouse\", \"xaxis\")) +/// echo(\"Mouse's xAxis is inverted\"); +/// @endtsexample) +/// /// public bool fnActionMap_isInverted (string actionmap, string device, string action) @@ -16245,7 +20244,14 @@ public bool fnActionMap_isInverted (string actionmap, string device, string acti return SafeNativeMethods.mwle_fnActionMap_isInverted(sbactionmap, sbdevice, sbaction)>=1; } /// -/// @brief Pop the ActionMap off the %ActionMap stack. Deactivates an %ActionMap and removes it from the @ActionMap stack. @tsexample // Deactivate moveMap moveMap.pop(); @endtsexample @see ActionMap) +/// @brief Pop the ActionMap off the %ActionMap stack. +/// Deactivates an %ActionMap and removes it from the @ActionMap stack. +/// @tsexample +/// // Deactivate moveMap +/// moveMap.pop(); +/// @endtsexample +/// @see ActionMap) +/// /// public void fnActionMap_pop (string actionmap) @@ -16259,7 +20265,14 @@ public void fnActionMap_pop (string actionmap) SafeNativeMethods.mwle_fnActionMap_pop(sbactionmap); } /// -/// @brief Push the ActionMap onto the %ActionMap stack. Activates an ActionMap and placees it at the top of the ActionMap stack. @tsexample // Make moveMap the active action map moveMap.push(); @endtsexample @see ActionMap) +/// @brief Push the ActionMap onto the %ActionMap stack. +/// Activates an ActionMap and placees it at the top of the ActionMap stack. +/// @tsexample +/// // Make moveMap the active action map +/// moveMap.push(); +/// @endtsexample +/// @see ActionMap) +/// /// public void fnActionMap_push (string actionmap) @@ -16273,7 +20286,15 @@ public void fnActionMap_push (string actionmap) SafeNativeMethods.mwle_fnActionMap_push(sbactionmap); } /// -/// @brief Saves the ActionMap to a file or dumps it to the console. @param fileName The file path to save the ActionMap to. If a filename is not specified the ActionMap will be dumped to the console. @param append Whether to write the ActionMap at the end of the file or overwrite it. @tsexample // Write out the actionmap into the config.cs file moveMap.save( \"scripts/client/config.cs\" ); @endtsexample) +/// @brief Saves the ActionMap to a file or dumps it to the console. +/// @param fileName The file path to save the ActionMap to. If a filename is not specified +/// the ActionMap will be dumped to the console. +/// @param append Whether to write the ActionMap at the end of the file or overwrite it. +/// @tsexample +/// // Write out the actionmap into the config.cs file +/// moveMap.save( \"scripts/client/config.cs\" ); +/// @endtsexample) +/// /// public void fnActionMap_save (string actionmap, string fileName, bool append) @@ -16290,7 +20311,14 @@ public void fnActionMap_save (string actionmap, string fileName, bool append) SafeNativeMethods.mwle_fnActionMap_save(sbactionmap, sbfileName, append); } /// -/// @brief Removes the binding on an input device and action. @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbind(\"keyboard\", \"space\"); @endtsexample) +/// @brief Removes the binding on an input device and action. +/// @param device The device to unbind from. Can be a keyboard, mouse, joystick or a gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbind(\"keyboard\", \"space\"); +/// @endtsexample) +/// /// public bool fnActionMap_unbind (string actionmap, string device, string action) @@ -16310,7 +20338,15 @@ public bool fnActionMap_unbind (string actionmap, string device, string action) return SafeNativeMethods.mwle_fnActionMap_unbind(sbactionmap, sbdevice, sbaction)>=1; } /// -/// @brief Remove any object-binding on an input device and action. @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. @param obj The object to perform unbind against. @return True if the unbind was successful, false if the device was unknown or description failed. @tsexample moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); @endtsexample) +/// @brief Remove any object-binding on an input device and action. +/// @param device The device to bind to. Can be keyboard, mouse, joystick or gamepad. +/// @param action The device action to unbind from. The action is dependant upon the device. Specify a key for keyboards. +/// @param obj The object to perform unbind against. +/// @return True if the unbind was successful, false if the device was unknown or description failed. +/// @tsexample +/// moveMap.unbindObj(\"keyboard\", \"numpad1\", \"rangeChange\", %player); +/// @endtsexample) +/// /// public bool fnActionMap_unbindObj (string actionmap, string device, string action, string obj) @@ -16333,7 +20369,8 @@ public bool fnActionMap_unbindObj (string actionmap, string device, string actio return SafeNativeMethods.mwle_fnActionMap_unbindObj(sbactionmap, sbdevice, sbaction, sbobj)>=1; } /// -/// ) +/// ) +/// /// public void fnAIPlayer_AISearchSimSet (string aiplayer, float fOV, float farDist, string ObjToSearch, string result) @@ -16353,7 +20390,53 @@ public void fnAIPlayer_AISearchSimSet (string aiplayer, float fOV, float farDist SafeNativeMethods.mwle_fnAIPlayer_AISearchSimSet(sbaiplayer, fOV, farDist, sbObjToSearch, sbresult); } /// -/// @brief Use this to stop aiming at an object or a point. @see setAimLocation() @see setAimObject()) +/// @brief Check whether an object is within a specified veiw cone. +/// @obj Object to check. (If blank, it will check the current target). +/// @fov view angle in degrees.(Defaults to 45) +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// + +public bool fnAIPlayer_checkInFoV (string aiplayer, string obj, float fov, bool checkEnabled) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnAIPlayer_checkInFoV'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" ",aiplayer,obj,fov,checkEnabled)); +StringBuilder sbaiplayer = null; +if (aiplayer != null) + sbaiplayer = new StringBuilder(aiplayer, 1024); +StringBuilder sbobj = null; +if (obj != null) + sbobj = new StringBuilder(obj, 1024); + +return SafeNativeMethods.mwle_fnAIPlayer_checkInFoV(sbaiplayer, sbobj, fov, checkEnabled)>=1; +} +/// +/// @brief Check whether an object is in line of sight. +/// @obj Object to check. (If blank, it will check the current target). +/// @useMuzzle Use muzzle position. Otherwise use eye position. (defaults to false). +/// @checkEnabled check whether the object can take damage and if so is still alive.(Defaults to false)) +/// +/// + +public bool fnAIPlayer_checkInLos (string aiplayer, string obj, bool useMuzzle, bool checkEnabled) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnAIPlayer_checkInLos'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" ",aiplayer,obj,useMuzzle,checkEnabled)); +StringBuilder sbaiplayer = null; +if (aiplayer != null) + sbaiplayer = new StringBuilder(aiplayer, 1024); +StringBuilder sbobj = null; +if (obj != null) + sbobj = new StringBuilder(obj, 1024); + +return SafeNativeMethods.mwle_fnAIPlayer_checkInLos(sbaiplayer, sbobj, useMuzzle, checkEnabled)>=1; +} +/// +/// @brief Use this to stop aiming at an object or a point. +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public void fnAIPlayer_clearAim (string aiplayer) @@ -16444,7 +20527,18 @@ public void fnAIPlayer_followObject (string aiplayer, uint obj, float radius) SafeNativeMethods.mwle_fnAIPlayer_followObject(sbaiplayer, obj, radius); } /// -/// @brief Returns the point the AIPlayer is aiming at. This will reflect the position set by setAimLocation(), or the position of the object that the bot is now aiming at. If the bot is not aiming at anything, this value will change to whatever point the bot's current line-of-sight intercepts. @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". @see setAimLocation() @see setAimObject()) +/// @brief Returns the point the AIPlayer is aiming at. +/// +/// This will reflect the position set by setAimLocation(), +/// or the position of the object that the bot is now aiming at. +/// If the bot is not aiming at anything, this value will +/// change to whatever point the bot's current line-of-sight intercepts. +/// +/// @return World space coordinates of the object AI is aiming at. Formatted as \"X Y Z\". +/// +/// @see setAimLocation() +/// @see setAimObject()) +/// /// public string fnAIPlayer_getAimLocation (string aiplayer) @@ -16461,7 +20555,13 @@ public string fnAIPlayer_getAimLocation (string aiplayer) } /// -/// @brief Gets the object the AIPlayer is targeting. @return Returns -1 if no object is being aimed at, or the SimObjectID of the object the AIPlayer is aiming at. @see setAimObject()) +/// @brief Gets the object the AIPlayer is targeting. +/// +/// @return Returns -1 if no object is being aimed at, +/// or the SimObjectID of the object the AIPlayer is aiming at. +/// +/// @see setAimObject()) +/// /// public int fnAIPlayer_getAimObject (string aiplayer) @@ -16475,7 +20575,14 @@ public int fnAIPlayer_getAimObject (string aiplayer) return SafeNativeMethods.mwle_fnAIPlayer_getAimObject(sbaiplayer); } /// -/// @brief Get the AIPlayer's current destination. @return Returns a point containing the \"x y z\" position of the AIPlayer's current move destination. If no move destination has yet been set, this returns \"0 0 0\". @see setMoveDestination()) +/// @brief Get the AIPlayer's current destination. +/// +/// @return Returns a point containing the \"x y z\" position +/// of the AIPlayer's current move destination. If no move destination +/// has yet been set, this returns \"0 0 0\". +/// +/// @see setMoveDestination()) +/// /// public string fnAIPlayer_getMoveDestination (string aiplayer) @@ -16492,7 +20599,12 @@ public string fnAIPlayer_getMoveDestination (string aiplayer) } /// -/// @brief Gets the move speed of an AI object. @return A speed multiplier between 0.0 and 1.0. @see setMoveSpeed()) +/// @brief Gets the move speed of an AI object. +/// +/// @return A speed multiplier between 0.0 and 1.0. +/// +/// @see setMoveSpeed()) +/// /// public float fnAIPlayer_getMoveSpeed (string aiplayer) @@ -16579,7 +20691,12 @@ public void fnAIPlayer_repath (string aiplayer) SafeNativeMethods.mwle_fnAIPlayer_repath(sbaiplayer); } /// -/// @brief Tells the AIPlayer to aim at the location provided. @param target An \"x y z\" position in the game world to target. @see getAimLocation()) +/// @brief Tells the AIPlayer to aim at the location provided. +/// +/// @param target An \"x y z\" position in the game world to target. +/// +/// @see getAimLocation()) +/// /// public void fnAIPlayer_setAimLocation (string aiplayer, string target) @@ -16596,7 +20713,18 @@ public void fnAIPlayer_setAimLocation (string aiplayer, string target) SafeNativeMethods.mwle_fnAIPlayer_setAimLocation(sbaiplayer, sbtarget); } /// -/// @brief Tells the AI to move to the location provided @param goal Coordinates in world space representing location to move to. @param slowDown A boolean value. If set to true, the bot will slow down when it gets within 5-meters of its move destination. If false, the bot will stop abruptly when it reaches the move destination. By default, this is true. @note Upon reaching a move destination, the bot will clear its move destination and calls to getMoveDestination will return \"0 0 0\". @see getMoveDestination()) +/// @brief Tells the AI to move to the location provided +/// +/// @param goal Coordinates in world space representing location to move to. +/// @param slowDown A boolean value. If set to true, the bot will slow down +/// when it gets within 5-meters of its move destination. If false, the bot +/// will stop abruptly when it reaches the move destination. By default, this is true. +/// +/// @note Upon reaching a move destination, the bot will clear its move destination and +/// calls to getMoveDestination will return \"0 0 0\". +/// +/// @see getMoveDestination()) +/// /// public void fnAIPlayer_setMoveDestination (string aiplayer, string goal, bool slowDown) @@ -16613,7 +20741,14 @@ public void fnAIPlayer_setMoveDestination (string aiplayer, string goal, bool sl SafeNativeMethods.mwle_fnAIPlayer_setMoveDestination(sbaiplayer, sbgoal, slowDown); } /// -/// @brief Sets the move speed for an AI object. @param speed A speed multiplier between 0.0 and 1.0. This is multiplied by the AIPlayer's base movement rates (as defined in its PlayerData datablock) @see getMoveDestination()) +/// @brief Sets the move speed for an AI object. +/// +/// @param speed A speed multiplier between 0.0 and 1.0. +/// This is multiplied by the AIPlayer's base movement rates (as defined in +/// its PlayerData datablock) +/// +/// @see getMoveDestination()) +/// /// public void fnAIPlayer_setMoveSpeed (string aiplayer, float speed) @@ -16670,6 +20805,7 @@ public bool fnAIPlayer_setPathDestination (string aiplayer, string goal) } /// /// @brief Tells the AIPlayer to stop moving.) +/// /// public void fnAIPlayer_stop (string aiplayer) @@ -16684,6 +20820,7 @@ public void fnAIPlayer_stop (string aiplayer) } /// /// @brief Activate a turret from a deactive state.) +/// /// public void fnAITurretShape_activateTurret (string aiturretshape) @@ -16697,7 +20834,10 @@ public void fnAITurretShape_activateTurret (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_activateTurret(sbaiturretshape); } /// -/// @brief Adds object to the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to ignore.) +/// @brief Adds object to the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to ignore.) +/// /// public void fnAITurretShape_addToIgnoreList (string aiturretshape, string obj) @@ -16715,6 +20855,7 @@ public void fnAITurretShape_addToIgnoreList (string aiturretshape, string obj) } /// /// @brief Deactivate a turret from an active state.) +/// /// public void fnAITurretShape_deactivateTurret (string aiturretshape) @@ -16728,7 +20869,9 @@ public void fnAITurretShape_deactivateTurret (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_deactivateTurret(sbaiturretshape); } /// -/// @brief Get the turret's current target. @returns The object that is the target's current target, or 0 if no target.) +/// @brief Get the turret's current target. +/// @returns The object that is the target's current target, or 0 if no target.) +/// /// public string fnAITurretShape_getTarget (string aiturretshape) @@ -16745,7 +20888,9 @@ public string fnAITurretShape_getTarget (string aiturretshape) } /// -/// @brief Get the turret's defined projectile velocity that helps with target leading. @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// @brief Get the turret's defined projectile velocity that helps with target leading. +/// @returns The defined weapon projectile speed, or 0 if leading is disabled.) +/// /// public float fnAITurretShape_getWeaponLeadVelocity (string aiturretshape) @@ -16759,7 +20904,9 @@ public float fnAITurretShape_getWeaponLeadVelocity (string aiturretshape) return SafeNativeMethods.mwle_fnAITurretShape_getWeaponLeadVelocity(sbaiturretshape); } /// -/// @brief Indicates if the turret has a target. @returns True if the turret has a target.) +/// @brief Indicates if the turret has a target. +/// @returns True if the turret has a target.) +/// /// public bool fnAITurretShape_hasTarget (string aiturretshape) @@ -16774,6 +20921,7 @@ public bool fnAITurretShape_hasTarget (string aiturretshape) } /// /// @brief Recenter the turret's weapon.) +/// /// public void fnAITurretShape_recenterTurret (string aiturretshape) @@ -16787,7 +20935,10 @@ public void fnAITurretShape_recenterTurret (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_recenterTurret(sbaiturretshape); } /// -/// @brief Removes object from the turret's ignore list. All objects in this list will be ignored by the turret's targeting. @param obj The ShapeBase object to once again allow for targeting.) +/// @brief Removes object from the turret's ignore list. +/// All objects in this list will be ignored by the turret's targeting. +/// @param obj The ShapeBase object to once again allow for targeting.) +/// /// public void fnAITurretShape_removeFromIgnoreList (string aiturretshape, string obj) @@ -16804,7 +20955,9 @@ public void fnAITurretShape_removeFromIgnoreList (string aiturretshape, string o SafeNativeMethods.mwle_fnAITurretShape_removeFromIgnoreList(sbaiturretshape, sbobj); } /// -/// @brief Resets the turret's target tracking. Only resets the internal target tracking. Does not modify the turret's facing.) +/// @brief Resets the turret's target tracking. +/// Only resets the internal target tracking. Does not modify the turret's facing.) +/// /// public void fnAITurretShape_resetTarget (string aiturretshape) @@ -16818,7 +20971,9 @@ public void fnAITurretShape_resetTarget (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_resetTarget(sbaiturretshape); } /// -/// @brief Set the firing state of the turret's guns. @param fire Set to true to activate all guns. False to deactivate them.) +/// @brief Set the firing state of the turret's guns. +/// @param fire Set to true to activate all guns. False to deactivate them.) +/// /// public void fnAITurretShape_setAllGunsFiring (string aiturretshape, bool fire) @@ -16832,7 +20987,10 @@ public void fnAITurretShape_setAllGunsFiring (string aiturretshape, bool fire) SafeNativeMethods.mwle_fnAITurretShape_setAllGunsFiring(sbaiturretshape, fire); } /// -/// @brief Set the firing state of the given gun slot. @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. @param fire Set to true to activate the gun. False to deactivate it.) +/// @brief Set the firing state of the given gun slot. +/// @param slot The gun to modify. Valid range is 0-3 that corresponds to the weapon mount point. +/// @param fire Set to true to activate the gun. False to deactivate it.) +/// /// public void fnAITurretShape_setGunSlotFiring (string aiturretshape, int slot, bool fire) @@ -16846,7 +21004,14 @@ public void fnAITurretShape_setGunSlotFiring (string aiturretshape, int slot, bo SafeNativeMethods.mwle_fnAITurretShape_setGunSlotFiring(sbaiturretshape, slot, fire); } /// -/// @brief Set the turret's current state. Normally the turret's state comes from updating the state machine but this method allows you to override this and jump to the requested state immediately. @param newState The name of the new state. @param force Is true then force the full processing of the new state even if it is the same as the current state. If false then only the time out value is reset and the state's script method is called, if any.) +/// @brief Set the turret's current state. +/// Normally the turret's state comes from updating the state machine but this method +/// allows you to override this and jump to the requested state immediately. +/// @param newState The name of the new state. +/// @param force Is true then force the full processing of the new state even if it is the +/// same as the current state. If false then only the time out value is reset and the state's +/// script method is called, if any.) +/// /// public void fnAITurretShape_setTurretState (string aiturretshape, string newState, bool force) @@ -16863,7 +21028,12 @@ public void fnAITurretShape_setTurretState (string aiturretshape, string newStat SafeNativeMethods.mwle_fnAITurretShape_setTurretState(sbaiturretshape, sbnewState, force); } /// -/// @brief Set the turret's projectile velocity to help lead the target. This value normally comes from AITurretShapeData::weaponLeadVelocity but this method allows you to override the datablock value. This can be useful if the turret changes ammunition, uses a different weapon than the default, is damaged, etc. @note Setting this to 0 will disable target leading.) +/// @brief Set the turret's projectile velocity to help lead the target. +/// This value normally comes from AITurretShapeData::weaponLeadVelocity but this method +/// allows you to override the datablock value. This can be useful if the turret changes +/// ammunition, uses a different weapon than the default, is damaged, etc. +/// @note Setting this to 0 will disable target leading.) +/// /// public void fnAITurretShape_setWeaponLeadVelocity (string aiturretshape, float velocity) @@ -16878,6 +21048,7 @@ public void fnAITurretShape_setWeaponLeadVelocity (string aiturretshape, float v } /// /// @brief Begin scanning for a target.) +/// /// public void fnAITurretShape_startScanForTargets (string aiturretshape) @@ -16892,6 +21063,7 @@ public void fnAITurretShape_startScanForTargets (string aiturretshape) } /// /// @brief Have the turret track the current target.) +/// /// public void fnAITurretShape_startTrackingTarget (string aiturretshape) @@ -16905,7 +21077,10 @@ public void fnAITurretShape_startTrackingTarget (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_startTrackingTarget(sbaiturretshape); } /// -/// @brief Stop scanning for targets. @note Only impacts the scanning for new targets. Does not effect a turret's current target lock.) +/// @brief Stop scanning for targets. +/// @note Only impacts the scanning for new targets. Does not effect a turret's current +/// target lock.) +/// /// public void fnAITurretShape_stopScanForTargets (string aiturretshape) @@ -16920,6 +21095,7 @@ public void fnAITurretShape_stopScanForTargets (string aiturretshape) } /// /// @brief Stop the turret from tracking the current target.) +/// /// public void fnAITurretShape_stopTrackingTarget (string aiturretshape) @@ -16933,7 +21109,11 @@ public void fnAITurretShape_stopTrackingTarget (string aiturretshape) SafeNativeMethods.mwle_fnAITurretShape_stopTrackingTarget(sbaiturretshape); } /// -/// ), Adds a new element to the end of an array (same as push_back()). @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array (same as push_back()). +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void fnArrayObject_add (string arrayobject, string key, string value) @@ -16953,7 +21133,9 @@ public void fnArrayObject_add (string arrayobject, string key, string value) SafeNativeMethods.mwle_fnArrayObject_add(sbarrayobject, sbkey, sbvalue); } /// -/// Appends the target array to the array object. @param target ArrayObject to append to the end of this array ) +/// Appends the target array to the array object. +/// @param target ArrayObject to append to the end of this array ) +/// /// public bool fnArrayObject_append (string arrayobject, string target) @@ -16971,6 +21153,7 @@ public bool fnArrayObject_append (string arrayobject, string target) } /// /// Get the number of elements in the array. ) +/// /// public int fnArrayObject_count (string arrayobject) @@ -16984,7 +21167,9 @@ public int fnArrayObject_count (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_count(sbarrayobject); } /// -/// Get the number of times a particular key is found in the array. @param key Key value to count ) +/// Get the number of times a particular key is found in the array. +/// @param key Key value to count ) +/// /// public int fnArrayObject_countKey (string arrayobject, string key) @@ -17001,7 +21186,9 @@ public int fnArrayObject_countKey (string arrayobject, string key) return SafeNativeMethods.mwle_fnArrayObject_countKey(sbarrayobject, sbkey); } /// -/// Get the number of times a particular value is found in the array. @param value Array element value to count ) +/// Get the number of times a particular value is found in the array. +/// @param value Array element value to count ) +/// /// public int fnArrayObject_countValue (string arrayobject, string value) @@ -17018,7 +21205,9 @@ public int fnArrayObject_countValue (string arrayobject, string value) return SafeNativeMethods.mwle_fnArrayObject_countValue(sbarrayobject, sbvalue); } /// -/// Removes elements with matching keys from array. @param target ArrayObject containing keys to remove from this array ) +/// Removes elements with matching keys from array. +/// @param target ArrayObject containing keys to remove from this array ) +/// /// public bool fnArrayObject_crop (string arrayobject, string target) @@ -17035,7 +21224,9 @@ public bool fnArrayObject_crop (string arrayobject, string target) return SafeNativeMethods.mwle_fnArrayObject_crop(sbarrayobject, sbtarget)>=1; } /// -/// Alters array into an exact duplicate of the target array. @param target ArrayObject to duplicate ) +/// Alters array into an exact duplicate of the target array. +/// @param target ArrayObject to duplicate ) +/// /// public bool fnArrayObject_duplicate (string arrayobject, string target) @@ -17053,6 +21244,7 @@ public bool fnArrayObject_duplicate (string arrayobject, string target) } /// /// Echos the array contents to the console ) +/// /// public void fnArrayObject_echo (string arrayobject) @@ -17067,6 +21259,7 @@ public void fnArrayObject_echo (string arrayobject) } /// /// Emptys all elements from an array ) +/// /// public void fnArrayObject_empty (string arrayobject) @@ -17080,7 +21273,9 @@ public void fnArrayObject_empty (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_empty(sbarrayobject); } /// -/// Removes an element at a specific position from the array. @param index 0-based index of the element to remove ) +/// Removes an element at a specific position from the array. +/// @param index 0-based index of the element to remove ) +/// /// public void fnArrayObject_erase (string arrayobject, int index) @@ -17095,6 +21290,7 @@ public void fnArrayObject_erase (string arrayobject, int index) } /// /// Gets the current pointer index ) +/// /// public int fnArrayObject_getCurrent (string arrayobject) @@ -17108,7 +21304,10 @@ public int fnArrayObject_getCurrent (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_getCurrent(sbarrayobject); } /// -/// Search the array from the current position for the key @param value Array key to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the key +/// @param value Array key to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int fnArrayObject_getIndexFromKey (string arrayobject, string key) @@ -17125,7 +21324,10 @@ public int fnArrayObject_getIndexFromKey (string arrayobject, string key) return SafeNativeMethods.mwle_fnArrayObject_getIndexFromKey(sbarrayobject, sbkey); } /// -/// Search the array from the current position for the element @param value Array value to search for @return Index of the first element found, or -1 if none ) +/// Search the array from the current position for the element +/// @param value Array value to search for +/// @return Index of the first element found, or -1 if none ) +/// /// public int fnArrayObject_getIndexFromValue (string arrayobject, string value) @@ -17142,7 +21344,11 @@ public int fnArrayObject_getIndexFromValue (string arrayobject, string value) return SafeNativeMethods.mwle_fnArrayObject_getIndexFromValue(sbarrayobject, sbvalue); } /// -/// Get the key of the array element at the submitted index. @param index 0-based index of the array element to get @return The key associated with the array element at the specified index, or \"\" if the index is out of range ) +/// Get the key of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The key associated with the array element at the +/// specified index, or \"\" if the index is out of range ) +/// /// public string fnArrayObject_getKey (string arrayobject, int index) @@ -17159,7 +21365,11 @@ public string fnArrayObject_getKey (string arrayobject, int index) } /// -/// Get the value of the array element at the submitted index. @param index 0-based index of the array element to get @return The value of the array element at the specified index, or \"\" if the index is out of range ) +/// Get the value of the array element at the submitted index. +/// @param index 0-based index of the array element to get +/// @return The value of the array element at the specified index, +/// or \"\" if the index is out of range ) +/// /// public string fnArrayObject_getValue (string arrayobject, int index) @@ -17176,7 +21386,13 @@ public string fnArrayObject_getValue (string arrayobject, int index) } /// -/// Adds a new element to a specified position in the array. - @a index = 0 will insert an element at the start of the array (same as push_front()) - @a index = %array.count() will insert an element at the end of the array (same as push_back()) @param key Key for the new element @param value Value for the new element @param index 0-based index at which to insert the new element ) +/// Adds a new element to a specified position in the array. +/// - @a index = 0 will insert an element at the start of the array (same as push_front()) +/// - @a index = %array.count() will insert an element at the end of the array (same as push_back()) +/// @param key Key for the new element +/// @param value Value for the new element +/// @param index 0-based index at which to insert the new element ) +/// /// public void fnArrayObject_insert (string arrayobject, string key, string value, int index) @@ -17196,7 +21412,9 @@ public void fnArrayObject_insert (string arrayobject, string key, string value, SafeNativeMethods.mwle_fnArrayObject_insert(sbarrayobject, sbkey, sbvalue, index); } /// -/// Moves array pointer to start of array @return Returns the new array pointer ) +/// Moves array pointer to start of array +/// @return Returns the new array pointer ) +/// /// public int fnArrayObject_moveFirst (string arrayobject) @@ -17210,7 +21428,9 @@ public int fnArrayObject_moveFirst (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_moveFirst(sbarrayobject); } /// -/// Moves array pointer to end of array @return Returns the new array pointer ) +/// Moves array pointer to end of array +/// @return Returns the new array pointer ) +/// /// public int fnArrayObject_moveLast (string arrayobject) @@ -17224,7 +21444,9 @@ public int fnArrayObject_moveLast (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_moveLast(sbarrayobject); } /// -/// Moves array pointer to next position @return Returns the new array pointer, or -1 if already at the end ) +/// Moves array pointer to next position +/// @return Returns the new array pointer, or -1 if already at the end ) +/// /// public int fnArrayObject_moveNext (string arrayobject) @@ -17238,7 +21460,9 @@ public int fnArrayObject_moveNext (string arrayobject) return SafeNativeMethods.mwle_fnArrayObject_moveNext(sbarrayobject); } /// -/// Moves array pointer to prev position @return Returns the new array pointer, or -1 if already at the start ) +/// Moves array pointer to prev position +/// @return Returns the new array pointer, or -1 if already at the start ) +/// /// public int fnArrayObject_movePrev (string arrayobject) @@ -17253,6 +21477,7 @@ public int fnArrayObject_movePrev (string arrayobject) } /// /// Removes the last element from the array ) +/// /// public void fnArrayObject_pop_back (string arrayobject) @@ -17267,6 +21492,7 @@ public void fnArrayObject_pop_back (string arrayobject) } /// /// Removes the first element from the array ) +/// /// public void fnArrayObject_pop_front (string arrayobject) @@ -17280,7 +21506,11 @@ public void fnArrayObject_pop_front (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_pop_front(sbarrayobject); } /// -/// ), Adds a new element to the end of an array. @param key Key for the new element @param value Value for the new element ) +/// ), +/// Adds a new element to the end of an array. +/// @param key Key for the new element +/// @param value Value for the new element ) +/// /// public void fnArrayObject_push_back (string arrayobject, string key, string value) @@ -17300,7 +21530,9 @@ public void fnArrayObject_push_back (string arrayobject, string key, string valu SafeNativeMethods.mwle_fnArrayObject_push_back(sbarrayobject, sbkey, sbvalue); } /// -/// ), Adds a new element to the front of an array ) +/// ), +/// Adds a new element to the front of an array ) +/// /// public void fnArrayObject_push_front (string arrayobject, string key, string value) @@ -17320,7 +21552,9 @@ public void fnArrayObject_push_front (string arrayobject, string key, string val SafeNativeMethods.mwle_fnArrayObject_push_front(sbarrayobject, sbkey, sbvalue); } /// -/// Sets the current pointer index. @param index New 0-based pointer index ) +/// Sets the current pointer index. +/// @param index New 0-based pointer index ) +/// /// public void fnArrayObject_setCurrent (string arrayobject, int index) @@ -17334,7 +21568,10 @@ public void fnArrayObject_setCurrent (string arrayobject, int index) SafeNativeMethods.mwle_fnArrayObject_setCurrent(sbarrayobject, index); } /// -/// Set the key at the given index. @param key New key value @param index 0-based index of the array element to update ) +/// Set the key at the given index. +/// @param key New key value +/// @param index 0-based index of the array element to update ) +/// /// public void fnArrayObject_setKey (string arrayobject, string key, int index) @@ -17351,7 +21588,10 @@ public void fnArrayObject_setKey (string arrayobject, string key, int index) SafeNativeMethods.mwle_fnArrayObject_setKey(sbarrayobject, sbkey, index); } /// -/// Set the value at the given index. @param value New array element value @param index 0-based index of the array element to update ) +/// Set the value at the given index. +/// @param value New array element value +/// @param index 0-based index of the array element to update ) +/// /// public void fnArrayObject_setValue (string arrayobject, string value, int index) @@ -17368,7 +21608,9 @@ public void fnArrayObject_setValue (string arrayobject, string value, int index) SafeNativeMethods.mwle_fnArrayObject_setValue(sbarrayobject, sbvalue, index); } /// -/// Alpha sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sort (string arrayobject, bool ascending) @@ -17383,6 +21625,7 @@ public void fnArrayObject_sort (string arrayobject, bool ascending) } /// /// Alpha sorts the array by value in ascending order ) +/// /// public void fnArrayObject_sorta (string arrayobject) @@ -17397,6 +21640,7 @@ public void fnArrayObject_sorta (string arrayobject) } /// /// Alpha sorts the array by value in descending order ) +/// /// public void fnArrayObject_sortd (string arrayobject) @@ -17410,7 +21654,16 @@ public void fnArrayObject_sortd (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_sortd(sbarrayobject); } /// -/// Sorts the array by value in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @tsexample function mySortCallback(%a, %b) { return strcmp( %a.name, %b.name ); } %array.sortf( \"mySortCallback\" ); @endtsexample ) +/// Sorts the array by value in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @tsexample +/// function mySortCallback(%a, %b) +/// { +/// return strcmp( %a.name, %b.name ); +/// } +/// %array.sortf( \"mySortCallback\" ); +/// @endtsexample ) +/// /// public void fnArrayObject_sortf (string arrayobject, string functionName) @@ -17427,7 +21680,10 @@ public void fnArrayObject_sortf (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortf(sbarrayobject, sbfunctionName); } /// -/// Sorts the array by value in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by value in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void fnArrayObject_sortfd (string arrayobject, string functionName) @@ -17444,7 +21700,10 @@ public void fnArrayObject_sortfd (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortfd(sbarrayobject, sbfunctionName); } /// -/// Sorts the array by key in ascending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in ascending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void fnArrayObject_sortfk (string arrayobject, string functionName) @@ -17461,7 +21720,10 @@ public void fnArrayObject_sortfk (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortfk(sbarrayobject, sbfunctionName); } /// -/// Sorts the array by key in descending order using the given callback function. @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. @see sortf ) +/// Sorts the array by key in descending order using the given callback function. +/// @param functionName Name of a function that takes two arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal. +/// @see sortf ) +/// /// public void fnArrayObject_sortfkd (string arrayobject, string functionName) @@ -17478,7 +21740,9 @@ public void fnArrayObject_sortfkd (string arrayobject, string functionName) SafeNativeMethods.mwle_fnArrayObject_sortfkd(sbarrayobject, sbfunctionName); } /// -/// Alpha sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Alpha sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sortk (string arrayobject, bool ascending) @@ -17493,6 +21757,7 @@ public void fnArrayObject_sortk (string arrayobject, bool ascending) } /// /// Alpha sorts the array by key in ascending order ) +/// /// public void fnArrayObject_sortka (string arrayobject) @@ -17507,6 +21772,7 @@ public void fnArrayObject_sortka (string arrayobject) } /// /// Alpha sorts the array by key in descending order ) +/// /// public void fnArrayObject_sortkd (string arrayobject) @@ -17520,7 +21786,9 @@ public void fnArrayObject_sortkd (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_sortkd(sbarrayobject); } /// -/// Numerically sorts the array by value @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by value +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sortn (string arrayobject, bool ascending) @@ -17535,6 +21803,7 @@ public void fnArrayObject_sortn (string arrayobject, bool ascending) } /// /// Numerically sorts the array by value in ascending order ) +/// /// public void fnArrayObject_sortna (string arrayobject) @@ -17549,6 +21818,7 @@ public void fnArrayObject_sortna (string arrayobject) } /// /// Numerically sorts the array by value in descending order ) +/// /// public void fnArrayObject_sortnd (string arrayobject) @@ -17562,7 +21832,9 @@ public void fnArrayObject_sortnd (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_sortnd(sbarrayobject); } /// -/// Numerically sorts the array by key @param ascending [optional] True for ascending sort, false for descending sort ) +/// Numerically sorts the array by key +/// @param ascending [optional] True for ascending sort, false for descending sort ) +/// /// public void fnArrayObject_sortnk (string arrayobject, bool ascending) @@ -17577,6 +21849,7 @@ public void fnArrayObject_sortnk (string arrayobject, bool ascending) } /// /// Numerical sorts the array by key in ascending order ) +/// /// public void fnArrayObject_sortnka (string arrayobject) @@ -17591,6 +21864,7 @@ public void fnArrayObject_sortnka (string arrayobject) } /// /// Numerical sorts the array by key in descending order ) +/// /// public void fnArrayObject_sortnkd (string arrayobject) @@ -17605,6 +21879,7 @@ public void fnArrayObject_sortnkd (string arrayobject) } /// /// Removes any elements that have duplicated keys (leaving the first instance) ) +/// /// public void fnArrayObject_uniqueKey (string arrayobject) @@ -17619,6 +21894,7 @@ public void fnArrayObject_uniqueKey (string arrayobject) } /// /// Removes any elements that have duplicated values (leaving the first instance) ) +/// /// public void fnArrayObject_uniqueValue (string arrayobject) @@ -17632,7 +21908,10 @@ public void fnArrayObject_uniqueValue (string arrayobject) SafeNativeMethods.mwle_fnArrayObject_uniqueValue(sbarrayobject); } /// -/// Move the camera to fully view the given radius. @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). @param radius The radius to view.) +/// Move the camera to fully view the given radius. +/// @note For this operation to take affect a valid edit orbit point must first be specified. See Camera::setEditOrbitPoint(). +/// @param radius The radius to view.) +/// /// public void fnCamera_autoFitRadius (string camera, float radius) @@ -17646,7 +21925,10 @@ public void fnCamera_autoFitRadius (string camera, float radius) SafeNativeMethods.mwle_fnCamera_autoFitRadius(sbcamera, radius); } /// -/// Get the angular velocity for a Newton mode camera. @returns The angular velocity in the form of \"x y z\". @note Only returns useful results when Camera::newtonRotation is set to true.) +/// Get the angular velocity for a Newton mode camera. +/// @returns The angular velocity in the form of \"x y z\". +/// @note Only returns useful results when Camera::newtonRotation is set to true.) +/// /// public string fnCamera_getAngularVelocity (string camera) @@ -17663,7 +21945,9 @@ public string fnCamera_getAngularVelocity (string camera) } /// -/// Returns the current camera control mode. @see CameraMotionMode) +/// Returns the current camera control mode. +/// @see CameraMotionMode) +/// /// public int fnCamera_getMode (string camera) @@ -17677,7 +21961,10 @@ public int fnCamera_getMode (string camera) return SafeNativeMethods.mwle_fnCamera_getMode(sbcamera); } /// -/// Get the camera's offset from its orbit or tracking point. The offset is added to the camera's position when set to CameraMode::OrbitObject. @returns The offset in the form of \"x y z\".) +/// Get the camera's offset from its orbit or tracking point. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @returns The offset in the form of \"x y z\".) +/// /// public string fnCamera_getOffset (string camera) @@ -17694,7 +21981,9 @@ public string fnCamera_getOffset (string camera) } /// -/// Get the camera's position in the world. @returns The position in the form of \"x y z\".) +/// Get the camera's position in the world. +/// @returns The position in the form of \"x y z\".) +/// /// public string fnCamera_getPosition (string camera) @@ -17711,7 +22000,9 @@ public string fnCamera_getPosition (string camera) } /// -/// Get the camera's Euler rotation in radians. @returns The rotation in radians in the form of \"x y z\".) +/// Get the camera's Euler rotation in radians. +/// @returns The rotation in radians in the form of \"x y z\".) +/// /// public string fnCamera_getRotation (string camera) @@ -17728,7 +22019,10 @@ public string fnCamera_getRotation (string camera) } /// -/// Get the velocity for the camera. @returns The camera's velocity in the form of \"x y z\". @note Only useful when the Camera is in Newton mode.) +/// Get the velocity for the camera. +/// @returns The camera's velocity in the form of \"x y z\". +/// @note Only useful when the Camera is in Newton mode.) +/// /// public string fnCamera_getVelocity (string camera) @@ -17745,7 +22039,9 @@ public string fnCamera_getVelocity (string camera) } /// -/// Is the camera in edit orbit mode? @returns true if the camera is in edit orbit mode.) +/// Is the camera in edit orbit mode? +/// @returns true if the camera is in edit orbit mode.) +/// /// public bool fnCamera_isEditOrbitMode (string camera) @@ -17759,7 +22055,9 @@ public bool fnCamera_isEditOrbitMode (string camera) return SafeNativeMethods.mwle_fnCamera_isEditOrbitMode(sbcamera)>=1; } /// -/// Is this a Newton Fly mode camera with damped rotation? @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// Is this a Newton Fly mode camera with damped rotation? +/// @returns true if the camera uses a damped rotation. i.e. Camera::newtonRotation is set to true.) +/// /// public bool fnCamera_isRotationDamped (string camera) @@ -17773,7 +22071,9 @@ public bool fnCamera_isRotationDamped (string camera) return SafeNativeMethods.mwle_fnCamera_isRotationDamped(sbcamera)>=1; } /// -/// Point the camera at the specified position. Does not work in Orbit or Track modes. @param point The position to point the camera at.) +/// Point the camera at the specified position. Does not work in Orbit or Track modes. +/// @param point The position to point the camera at.) +/// /// public void fnCamera_lookAt (string camera, string point) @@ -17790,7 +22090,10 @@ public void fnCamera_lookAt (string camera, string point) SafeNativeMethods.mwle_fnCamera_lookAt(sbcamera, sbpoint); } /// -/// Set the angular drag for a Newton mode camera. @param drag The angular drag applied while the camera is rotating. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular drag for a Newton mode camera. +/// @param drag The angular drag applied while the camera is rotating. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void fnCamera_setAngularDrag (string camera, float drag) @@ -17804,7 +22107,10 @@ public void fnCamera_setAngularDrag (string camera, float drag) SafeNativeMethods.mwle_fnCamera_setAngularDrag(sbcamera, drag); } /// -/// Set the angular force for a Newton mode camera. @param force The angular force applied when attempting to rotate the camera. @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular force for a Newton mode camera. +/// @param force The angular force applied when attempting to rotate the camera. +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void fnCamera_setAngularForce (string camera, float force) @@ -17818,7 +22124,10 @@ public void fnCamera_setAngularForce (string camera, float force) SafeNativeMethods.mwle_fnCamera_setAngularForce(sbcamera, force); } /// -/// Set the angular velocity for a Newton mode camera. @param velocity The angular velocity infor form of \"x y z\". @note Only takes affect when Camera::newtonRotation is set to true.) +/// Set the angular velocity for a Newton mode camera. +/// @param velocity The angular velocity infor form of \"x y z\". +/// @note Only takes affect when Camera::newtonRotation is set to true.) +/// /// public void fnCamera_setAngularVelocity (string camera, string velocity) @@ -17835,7 +22144,10 @@ public void fnCamera_setAngularVelocity (string camera, string velocity) SafeNativeMethods.mwle_fnCamera_setAngularVelocity(sbcamera, sbvelocity); } /// -/// Set the Newton mode camera brake multiplier when trigger[1] is active. @param multiplier The brake multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera brake multiplier when trigger[1] is active. +/// @param multiplier The brake multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setBrakeMultiplier (string camera, float multiplier) @@ -17849,7 +22161,10 @@ public void fnCamera_setBrakeMultiplier (string camera, float multiplier) SafeNativeMethods.mwle_fnCamera_setBrakeMultiplier(sbcamera, multiplier); } /// -/// Set the drag for a Newton mode camera. @param drag The drag applied to the camera while moving. @note Only used when Camera is in Newton mode.) +/// Set the drag for a Newton mode camera. +/// @param drag The drag applied to the camera while moving. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setDrag (string camera, float drag) @@ -17863,7 +22178,10 @@ public void fnCamera_setDrag (string camera, float drag) SafeNativeMethods.mwle_fnCamera_setDrag(sbcamera, drag); } /// -/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). @note This method is generally used only within the World Editor and other tools. To orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// Set the editor camera to orbit around a point set with Camera::setEditOrbitPoint(). +/// @note This method is generally used only within the World Editor and other tools. To +/// orbit about an object or point within a game, see Camera::setOrbitMode() and its helper methods.) +/// /// public void fnCamera_setEditOrbitMode (string camera) @@ -17877,7 +22195,9 @@ public void fnCamera_setEditOrbitMode (string camera) SafeNativeMethods.mwle_fnCamera_setEditOrbitMode(sbcamera); } /// -/// Set the editor camera's orbit point. @param point The point the camera will orbit in the form of \"x y z\".) +/// Set the editor camera's orbit point. +/// @param point The point the camera will orbit in the form of \"x y z\".) +/// /// public void fnCamera_setEditOrbitPoint (string camera, string point) @@ -17894,7 +22214,10 @@ public void fnCamera_setEditOrbitPoint (string camera, string point) SafeNativeMethods.mwle_fnCamera_setEditOrbitPoint(sbcamera, sbpoint); } /// -/// Set the force applied to a Newton mode camera while moving. @param force The force applied to the camera while attempting to move. @note Only used when Camera is in Newton mode.) +/// Set the force applied to a Newton mode camera while moving. +/// @param force The force applied to the camera while attempting to move. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setFlyForce (string camera, float force) @@ -17908,7 +22231,11 @@ public void fnCamera_setFlyForce (string camera, float force) SafeNativeMethods.mwle_fnCamera_setFlyForce(sbcamera, force); } /// -/// Set the camera to fly freely. Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode and Camera::newtonRotation.) +/// Set the camera to fly freely. +/// Allows the camera to have 6 degrees of freedom. Provides for instantaneous motion +/// and rotation unless one of the Newton fields has been set to true. See Camera::newtonMode +/// and Camera::newtonRotation.) +/// /// public void fnCamera_setFlyMode (string camera) @@ -17922,7 +22249,10 @@ public void fnCamera_setFlyMode (string camera) SafeNativeMethods.mwle_fnCamera_setFlyMode(sbcamera); } /// -/// Set the mass for a Newton mode camera. @param mass The mass used during ease-in and ease-out calculations. @note Only used when Camera is in Newton mode.) +/// Set the mass for a Newton mode camera. +/// @param mass The mass used during ease-in and ease-out calculations. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setMass (string camera, float mass) @@ -17936,7 +22266,11 @@ public void fnCamera_setMass (string camera, float mass) SafeNativeMethods.mwle_fnCamera_setMass(sbcamera, mass); } /// -/// Set the camera to fly freely, but with ease-in and ease-out. This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but activates the ease-in and ease-out on the camera's movement. To also activate Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// Set the camera to fly freely, but with ease-in and ease-out. +/// This method allows for the same 6 degrees of freedom as Camera::setFlyMode() but +/// activates the ease-in and ease-out on the camera's movement. To also activate +/// Newton mode for the camera's rotation, set Camera::newtonRotation to true.) +/// /// public void fnCamera_setNewtonFlyMode (string camera) @@ -17950,7 +22284,10 @@ public void fnCamera_setNewtonFlyMode (string camera) SafeNativeMethods.mwle_fnCamera_setNewtonFlyMode(sbcamera); } /// -/// Set the camera's offset. The offset is added to the camera's position when set to CameraMode::OrbitObject. @param offset The distance to offset the camera by in the form of \"x y z\".) +/// Set the camera's offset. +/// The offset is added to the camera's position when set to CameraMode::OrbitObject. +/// @param offset The distance to offset the camera by in the form of \"x y z\".) +/// /// public void fnCamera_setOffset (string camera, string offset) @@ -17967,10 +22304,21 @@ public void fnCamera_setOffset (string camera, string offset) SafeNativeMethods.mwle_fnCamera_setOffset(sbcamera, sboffset); } /// -/// Set the camera to orbit around the given object, or if none is given, around the given point. @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitObject() @see Camera::setOrbitPoint()) +/// Set the camera to orbit around the given object, or if none is given, around the given point. +/// @param orbitObject The object to orbit around. If no object is given (0 or blank string is passed in) use the orbitPoint instead +/// @param orbitPoint The point to orbit around when no object is given. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObj [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitObject() +/// @see Camera::setOrbitPoint()) +/// /// -public bool fnCamera_setOrbitMode (string camera, string orbitObject, string orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj, string offset, bool lockedx) +public void fnCamera_setOrbitMode (string camera, string orbitObject, string orbitPoint, float minDistance, float maxDistance, float initDistance, bool ownClientObj, string offset, bool lockedx) { if(Debugging) System.Console.WriteLine("----------------->Extern Call 'fnCamera_setOrbitMode'" + string.Format("\"{0}\" \"{1}\" \"{2}\" \"{3}\" \"{4}\" \"{5}\" \"{6}\" \"{7}\" \"{8}\" ",camera,orbitObject,orbitPoint,minDistance,maxDistance,initDistance,ownClientObj,offset,lockedx)); @@ -17987,10 +22335,21 @@ public bool fnCamera_setOrbitMode (string camera, string orbitObject, string orb if (offset != null) sboffset = new StringBuilder(offset, 1024); -return SafeNativeMethods.mwle_fnCamera_setOrbitMode(sbcamera, sborbitObject, sborbitPoint, minDistance, maxDistance, initDistance, ownClientObj, sboffset, lockedx)>=1; +SafeNativeMethods.mwle_fnCamera_setOrbitMode(sbcamera, sborbitObject, sborbitPoint, minDistance, maxDistance, initDistance, ownClientObj, sboffset, lockedx); } /// -/// Set the camera to orbit around a given object. @param orbitObject The object to orbit around. @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @returns false if the given object could not be found. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given object. +/// @param orbitObject The object to orbit around. +/// @param rotation The initial camera rotation about the object in radians in the form of \"x y z\". +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param ownClientObject [optional] Are we orbiting an object that is owned by us? Default is false. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @returns false if the given object could not be found. +/// @see Camera::setOrbitMode()) +/// /// public bool fnCamera_setOrbitObject (string camera, string orbitObject, string rotation, float minDistance, float maxDistance, float initDistance, bool ownClientObject, string offset, bool lockedx) @@ -18013,7 +22372,15 @@ public bool fnCamera_setOrbitObject (string camera, string orbitObject, string r return SafeNativeMethods.mwle_fnCamera_setOrbitObject(sbcamera, sborbitObject, sbrotation, minDistance, maxDistance, initDistance, ownClientObject, sboffset, lockedx)>=1; } /// -/// Set the camera to orbit around a given point. @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). @param minDistance The minimum distance allowed to the orbit object or point. @param maxDistance The maximum distance allowed from the orbit object or point. @param initDistance The initial distance from the orbit object or point. @param offset [optional] An offset added to the camera's position. Default is no offset. @param locked [optional] Indicates the camera does not receive input from the player. Default is false. @see Camera::setOrbitMode()) +/// Set the camera to orbit around a given point. +/// @param orbitPoint The point to orbit around. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform(). +/// @param minDistance The minimum distance allowed to the orbit object or point. +/// @param maxDistance The maximum distance allowed from the orbit object or point. +/// @param initDistance The initial distance from the orbit object or point. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @param locked [optional] Indicates the camera does not receive input from the player. Default is false. +/// @see Camera::setOrbitMode()) +/// /// public void fnCamera_setOrbitPoint (string camera, string orbitPoint, float minDistance, float maxDistance, float initDistance, string offset, bool lockedx) @@ -18033,7 +22400,10 @@ public void fnCamera_setOrbitPoint (string camera, string orbitPoint, float minD SafeNativeMethods.mwle_fnCamera_setOrbitPoint(sbcamera, sborbitPoint, minDistance, maxDistance, initDistance, sboffset, lockedx); } /// -/// Set the camera's Euler rotation in radians. @param rot The rotation in radians in the form of \"x y z\". @note Rotation around the Y axis is ignored ) +/// Set the camera's Euler rotation in radians. +/// @param rot The rotation in radians in the form of \"x y z\". +/// @note Rotation around the Y axis is ignored ) +/// /// public void fnCamera_setRotation (string camera, string rot) @@ -18050,7 +22420,10 @@ public void fnCamera_setRotation (string camera, string rot) SafeNativeMethods.mwle_fnCamera_setRotation(sbcamera, sbrot); } /// -/// Set the Newton mode camera speed multiplier when trigger[0] is active. @param multiplier The speed multiplier to apply. @note Only used when Camera is in Newton mode.) +/// Set the Newton mode camera speed multiplier when trigger[0] is active. +/// @param multiplier The speed multiplier to apply. +/// @note Only used when Camera is in Newton mode.) +/// /// public void fnCamera_setSpeedMultiplier (string camera, float multiplier) @@ -18064,7 +22437,11 @@ public void fnCamera_setSpeedMultiplier (string camera, float multiplier) SafeNativeMethods.mwle_fnCamera_setSpeedMultiplier(sbcamera, multiplier); } /// -/// Set the camera to track a given object. @param trackObject The object to track. @param offset [optional] An offset added to the camera's position. Default is no offset. @returns false if the given object could not be found.) +/// Set the camera to track a given object. +/// @param trackObject The object to track. +/// @param offset [optional] An offset added to the camera's position. Default is no offset. +/// @returns false if the given object could not be found.) +/// /// public bool fnCamera_setTrackObject (string camera, string trackObject, string offset) @@ -18084,7 +22461,12 @@ public bool fnCamera_setTrackObject (string camera, string trackObject, string o return SafeNativeMethods.mwle_fnCamera_setTrackObject(sbcamera, sbtrackObject, sboffset)>=1; } /// -/// Set if there is a valid editor camera orbit point. When validPoint is set to false the Camera operates as if it is in Fly mode rather than an Orbit mode. @param validPoint Indicates the validity of the orbit point. @note Only used when Camera is in Edit Orbit Mode.) +/// Set if there is a valid editor camera orbit point. +/// When validPoint is set to false the Camera operates as if it is +/// in Fly mode rather than an Orbit mode. +/// @param validPoint Indicates the validity of the orbit point. +/// @note Only used when Camera is in Edit Orbit Mode.) +/// /// public void fnCamera_setValidEditOrbitPoint (string camera, bool validPoint) @@ -18098,7 +22480,10 @@ public void fnCamera_setValidEditOrbitPoint (string camera, bool validPoint) SafeNativeMethods.mwle_fnCamera_setValidEditOrbitPoint(sbcamera, validPoint); } /// -/// Set the velocity for the camera. @param velocity The camera's velocity in the form of \"x y z\". @note Only affects the Camera when in Newton mode.) +/// Set the velocity for the camera. +/// @param velocity The camera's velocity in the form of \"x y z\". +/// @note Only affects the Camera when in Newton mode.) +/// /// public void fnCamera_setVelocity (string camera, string velocity) @@ -18115,20 +22500,6 @@ public void fnCamera_setVelocity (string camera, string velocity) SafeNativeMethods.mwle_fnCamera_setVelocity(sbcamera, sbvelocity); } /// -/// Change coverage of the cloudlayer.) -/// - -public void fnCloudLayer_ChangeCoverage (string cloudlayer, float newCoverage) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fnCloudLayer_ChangeCoverage'" + string.Format("\"{0}\" \"{1}\" ",cloudlayer,newCoverage)); -StringBuilder sbcloudlayer = null; -if (cloudlayer != null) - sbcloudlayer = new StringBuilder(cloudlayer, 1024); - -SafeNativeMethods.mwle_fnCloudLayer_ChangeCoverage(sbcloudlayer, newCoverage); -} -/// /// @brief Returns true if someone is already using this cover point.) /// /// @@ -18144,7 +22515,9 @@ public bool fnCoverPoint_isOccupied (string coverpoint) return SafeNativeMethods.mwle_fnCoverPoint_isOccupied(sbcoverpoint)>=1; } /// -/// Returns the script filename of where the CubemapData object was defined. This is used by the material editor. ) +/// Returns the script filename of where the CubemapData object was +/// defined. This is used by the material editor. ) +/// /// public string fnCubemapData_getFilename (string cubemapdata) @@ -18162,6 +22535,7 @@ public string fnCubemapData_getFilename (string cubemapdata) } /// /// Update the assigned cubemaps faces. ) +/// /// public void fnCubemapData_updateFaces (string cubemapdata) @@ -18175,7 +22549,26 @@ public void fnCubemapData_updateFaces (string cubemapdata) SafeNativeMethods.mwle_fnCubemapData_updateFaces(sbcubemapdata); } /// -/// 1.0 1.0 1.0, 1.0 0.0 0.0), @brief Manually set this piece of debris at the given position with the given velocity. Usually you do not manually create Debris objects as they are generated through other means, such as an Explosion. This method exists when you do manually create a Debris object and want to have it start moving. @param inputPosition Position to place the debris. @param inputVelocity Velocity to move the debris after it has been placed. @return Always returns true. @tsexample // Define the position %position = \"1.0 1.0 1.0\"; // Define the velocity %velocity = \"1.0 0.0 0.0\"; // Inform the debris object of its new position and velocity %debris.init(%position,%velocity); @endtsexample) +/// 1.0 1.0 1.0, 1.0 0.0 0.0), +/// @brief Manually set this piece of debris at the given position with the given velocity. +/// +/// Usually you do not manually create Debris objects as they are generated through other means, +/// such as an Explosion. This method exists when you do manually create a Debris object and +/// want to have it start moving. +/// +/// @param inputPosition Position to place the debris. +/// @param inputVelocity Velocity to move the debris after it has been placed. +/// @return Always returns true. +/// +/// @tsexample +/// // Define the position +/// %position = \"1.0 1.0 1.0\"; +/// // Define the velocity +/// %velocity = \"1.0 0.0 0.0\"; +/// // Inform the debris object of its new position and velocity +/// %debris.init(%position,%velocity); +/// @endtsexample) +/// /// public bool fnDebris_init (string debris, string inputPosition, string inputVelocity) @@ -18196,6 +22589,7 @@ public bool fnDebris_init (string debris, string inputPosition, string inputVelo } /// /// Draws an axis aligned box primitive within the two 3d points. ) +/// /// public void fnDebugDrawer_drawBox (string debugdrawer, string a, string b, string color) @@ -18219,6 +22613,7 @@ public void fnDebugDrawer_drawBox (string debugdrawer, string a, string b, strin } /// /// Draws a line primitive between two 3d points. ) +/// /// public void fnDebugDrawer_drawLine (string debugdrawer, string a, string b, string color) @@ -18242,6 +22637,7 @@ public void fnDebugDrawer_drawLine (string debugdrawer, string a, string b, stri } /// /// Sets the \"time to live\" (TTL) for the last rendered primitive. ) +/// /// public void fnDebugDrawer_setLastTTL (string debugdrawer, uint ms) @@ -18256,6 +22652,7 @@ public void fnDebugDrawer_setLastTTL (string debugdrawer, uint ms) } /// /// Sets the z buffer reading state for the last rendered primitive. ) +/// /// public void fnDebugDrawer_setLastZTest (string debugdrawer, bool enabled) @@ -18270,6 +22667,7 @@ public void fnDebugDrawer_setLastZTest (string debugdrawer, bool enabled) } /// /// Toggles the rendering of DebugDrawer primitives. ) +/// /// public void fnDebugDrawer_toggleDrawing (string debugdrawer) @@ -18284,6 +22682,7 @@ public void fnDebugDrawer_toggleDrawing (string debugdrawer) } /// /// Toggles freeze mode which keeps the currently rendered primitives from expiring. ) +/// /// public void fnDebugDrawer_toggleFreeze (string debugdrawer) @@ -18297,7 +22696,13 @@ public void fnDebugDrawer_toggleFreeze (string debugdrawer) SafeNativeMethods.mwle_fnDebugDrawer_toggleFreeze(sbdebugdrawer); } /// -/// Recompute the imagemap sub-texture rectangles for this DecalData. @tsexample // Inform the decal object to reload its imagemap and frame data. %decalData.texRows = 4; %decalData.postApply(); @endtsexample) +/// Recompute the imagemap sub-texture rectangles for this DecalData. +/// @tsexample +/// // Inform the decal object to reload its imagemap and frame data. +/// %decalData.texRows = 4; +/// %decalData.postApply(); +/// @endtsexample) +/// /// public void fnDecalData_postApply (string decaldata) @@ -18311,7 +22716,12 @@ public void fnDecalData_postApply (string decaldata) SafeNativeMethods.mwle_fnDecalData_postApply(sbdecaldata); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit the material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// the material and other fields ( not including nodes ) +/// to client objects. +/// ) +/// /// public void fnDecalRoad_postApply (string decalroad) @@ -18325,7 +22735,10 @@ public void fnDecalRoad_postApply (string decalroad) SafeNativeMethods.mwle_fnDecalRoad_postApply(sbdecalroad); } /// -/// Intended as a helper to developers and editor scripts. Force DecalRoad to update it's spline and reclip geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force DecalRoad to update it's spline and reclip geometry. +/// ) +/// /// public void fnDecalRoad_regenerate (string decalroad) @@ -18339,7 +22752,13 @@ public void fnDecalRoad_regenerate (string decalroad) SafeNativeMethods.mwle_fnDecalRoad_regenerate(sbdecalroad); } /// -/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method @param methodName The method's name as a string @param argi Any arguments to pass to the method @return No return value @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// ( DynamicConsoleMethodComponent, callMethod, void, 3, 64 , (methodName, argi) Calls script defined method +/// @param methodName The method's name as a string +/// @param argi Any arguments to pass to the method +/// @return No return value +/// @note %obj.callMethod( %methodName, %arg1, %arg2, ... );) +/// +/// /// public void fnDynamicConsoleMethodComponent_callMethod (string dynamicconsolemethodcomponent, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21, string a22, string a23, string a24, string a25, string a26, string a27, string a28, string a29, string a30, string a31, string a32, string a33, string a34, string a35, string a36, string a37, string a38, string a39, string a40, string a41, string a42, string a43, string a44, string a45, string a46, string a47, string a48, string a49, string a50, string a51, string a52, string a53, string a54, string a55, string a56, string a57, string a58, string a59, string a60, string a61, string a62, string a63) @@ -18540,6 +22959,7 @@ public void fnDynamicConsoleMethodComponent_callMethod (string dynamicconsolemet } /// /// ) +/// /// public int fnEditTSCtrl_getDisplayType (string edittsctrl) @@ -18554,6 +22974,7 @@ public int fnEditTSCtrl_getDisplayType (string edittsctrl) } /// /// ) +/// /// public int fnEditTSCtrl_getGizmo (string edittsctrl) @@ -18568,6 +22989,7 @@ public int fnEditTSCtrl_getGizmo (string edittsctrl) } /// /// Return the FOV for orthographic views. ) +/// /// public float fnEditTSCtrl_getOrthoFOV (string edittsctrl) @@ -18582,6 +23004,7 @@ public float fnEditTSCtrl_getOrthoFOV (string edittsctrl) } /// /// ) +/// /// public bool fnEditTSCtrl_isMiddleMouseDown (string edittsctrl) @@ -18596,6 +23019,7 @@ public bool fnEditTSCtrl_isMiddleMouseDown (string edittsctrl) } /// /// ) +/// /// public void fnEditTSCtrl_renderBox (string edittsctrl, string pos, string size) @@ -18616,6 +23040,7 @@ public void fnEditTSCtrl_renderBox (string edittsctrl, string pos, string size) } /// /// ) +/// /// public void fnEditTSCtrl_renderCircle (string edittsctrl, string pos, string normal, float radius, int segments) @@ -18636,6 +23061,7 @@ public void fnEditTSCtrl_renderCircle (string edittsctrl, string pos, string nor } /// /// ) +/// /// public void fnEditTSCtrl_renderLine (string edittsctrl, string start, string end, float lineWidth) @@ -18656,6 +23082,7 @@ public void fnEditTSCtrl_renderLine (string edittsctrl, string start, string end } /// /// ) +/// /// public void fnEditTSCtrl_renderSphere (string edittsctrl, string pos, float radius, int sphereLevel) @@ -18673,6 +23100,7 @@ public void fnEditTSCtrl_renderSphere (string edittsctrl, string pos, float radi } /// /// ) +/// /// public void fnEditTSCtrl_renderTriangle (string edittsctrl, string a, string b, string c) @@ -18696,6 +23124,7 @@ public void fnEditTSCtrl_renderTriangle (string edittsctrl, string a, string b, } /// /// ) +/// /// public void fnEditTSCtrl_setDisplayType (string edittsctrl, int displayType) @@ -18710,6 +23139,7 @@ public void fnEditTSCtrl_setDisplayType (string edittsctrl, int displayType) } /// /// Set the FOV for to use for orthographic views. ) +/// /// public void fnEditTSCtrl_setOrthoFOV (string edittsctrl, float fov) @@ -18723,7 +23153,91 @@ public void fnEditTSCtrl_setOrthoFOV (string edittsctrl, float fov) SafeNativeMethods.mwle_fnEditTSCtrl_setOrthoFOV(sbedittsctrl, fov); } /// -/// @brief Launches the OS file browser After an Execute() call, the chosen file name and path is available in one of two areas. If only a single file selection is permitted, the results will be stored in the @a fileName attribute. If multiple file selection is permitted, the results will be stored in the @a files array. The total number of files in the array will be stored in the @a fileCount attribute. @tsexample // NOTE: This is not he preferred class to use, but this still works // Create the file dialog %baseFileDialog = new FileDialog() { // Allow browsing of all file types filters = \"*.*\"; // No default file defaultFile = ; // Set default path relative to project defaultPath = \"./\"; // Set the title title = \"Durpa\"; // Allow changing of path you are browsing changePath = true; }; // Launch the file dialog %baseFileDialog.Execute(); // Don't forget to cleanup %baseFileDialog.delete(); // A better alternative is to use the // derived classes which are specific to file open and save // Create a dialog dedicated to opening files %openFileDlg = new OpenFileDialog() { // Look for jpg image files // First part is the descriptor|second part is the extension Filters = \"Jepg Files|*.jpg\"; // Allow browsing through other folders ChangePath = true; // Only allow opening of one file at a time MultipleFiles = false; }; // Launch the open file dialog %result = %openFileDlg.Execute(); // Obtain the chosen file name and path if ( %result ) { %seletedFile = %openFileDlg.file; } else { %selectedFile = \"\"; } // Cleanup %openFileDlg.delete(); // Create a dialog dedicated to saving a file %saveFileDlg = new SaveFileDialog() { // Only allow for saving of COLLADA files Filters = \"COLLADA Files (*.dae)|*.dae|\"; // Default save path to where the WorldEditor last saved DefaultPath = $pref::WorldEditor::LastPath; // No default file specified DefaultFile = \"\"; // Do not allow the user to change to a new directory ChangePath = false; // Prompt the user if they are going to overwrite an existing file OverwritePrompt = true; }; // Launch the save file dialog %result = %saveFileDlg.Execute(); // Obtain the file name %selectedFile = \"\"; if ( %result ) %selectedFile = %saveFileDlg.file; // Cleanup %saveFileDlg.delete(); @endtsexample @return True if the file was selected was successfully found (opened) or declared (saved).) +/// @brief Launches the OS file browser +/// +/// After an Execute() call, the chosen file name and path is available in one of two areas. +/// If only a single file selection is permitted, the results will be stored in the @a fileName +/// attribute. +/// +/// If multiple file selection is permitted, the results will be stored in the +/// @a files array. The total number of files in the array will be stored in the +/// @a fileCount attribute. +/// +/// @tsexample +/// // NOTE: This is not he preferred class to use, but this still works +/// // Create the file dialog +/// %baseFileDialog = new FileDialog() +/// { +/// // Allow browsing of all file types +/// filters = \"*.*\"; +/// // No default file +/// defaultFile = ; +/// // Set default path relative to project +/// defaultPath = \"./\"; +/// // Set the title +/// title = \"Durpa\"; +/// // Allow changing of path you are browsing +/// changePath = true; +/// }; +/// // Launch the file dialog +/// %baseFileDialog.Execute(); +/// +/// // Don't forget to cleanup +/// %baseFileDialog.delete(); +/// +/// // A better alternative is to use the +/// // derived classes which are specific to file open and save +/// // Create a dialog dedicated to opening files +/// %openFileDlg = new OpenFileDialog() +/// { +/// // Look for jpg image files +/// // First part is the descriptor|second part is the extension +/// Filters = \"Jepg Files|*.jpg\"; +/// // Allow browsing through other folders +/// ChangePath = true; +/// // Only allow opening of one file at a time +/// MultipleFiles = false; +/// }; +/// // Launch the open file dialog +/// %result = %openFileDlg.Execute(); +/// // Obtain the chosen file name and path +/// if ( %result ) +/// { +/// %seletedFile = %openFileDlg.file; +/// } +/// else +/// { +/// %selectedFile = \"\"; +/// } +/// // Cleanup +/// %openFileDlg.delete(); +/// +/// // Create a dialog dedicated to saving a file +/// %saveFileDlg = new SaveFileDialog() +/// { +/// // Only allow for saving of COLLADA files +/// Filters = \"COLLADA Files (*.dae)|*.dae|\"; +/// // Default save path to where the WorldEditor last saved +/// DefaultPath = $pref::WorldEditor::LastPath; +/// // No default file specified +/// DefaultFile = \"\"; +/// // Do not allow the user to change to a new directory +/// ChangePath = false; +/// // Prompt the user if they are going to overwrite an existing file +/// OverwritePrompt = true; +/// }; +/// // Launch the save file dialog +/// %result = %saveFileDlg.Execute(); +/// // Obtain the file name +/// %selectedFile = \"\"; +/// if ( %result ) +/// %selectedFile = %saveFileDlg.file; +/// // Cleanup +/// %saveFileDlg.delete(); +/// @endtsexample +/// +/// @return True if the file was selected was successfully found (opened) or declared (saved).) +/// /// public bool fnFileDialog_Execute (string filedialog) @@ -18737,7 +23251,32 @@ public bool fnFileDialog_Execute (string filedialog) return SafeNativeMethods.mwle_fnFileDialog_Execute(sbfiledialog)>=1; } /// -/// @brief Close the file. It is EXTREMELY important that you call this function when you are finished reading or writing to a file. Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. Remember: Open, Read/Write, Close, Delete...in that order! @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); // Close the file when finished %fileWrite.close(); // Cleanup the file object %fileWrite.delete(); @endtsexample) +/// @brief Close the file. +/// +/// It is EXTREMELY important that you call this function when you are finished reading or writing to a file. +/// Failing to do so is not only a bad programming practice, but could result in bad data or corrupt files. +/// Remember: Open, Read/Write, Close, Delete...in that order! +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// // Close the file when finished +/// %fileWrite.close(); +/// // Cleanup the file object +/// %fileWrite.delete(); +/// @endtsexample) +/// /// public void fnFileObject_close (string fileobject) @@ -18751,7 +23290,25 @@ public void fnFileObject_close (string fileobject) SafeNativeMethods.mwle_fnFileObject_close(sbfileobject); } /// -/// @brief Determines if the parser for this FileObject has reached the end of the file @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Keep reading until we reach the end of the file while( !%fileRead.isEOF() ) { %line = %fileRead.readline(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); @endtsexample @return True if the parser has reached the end of the file, false otherwise) +/// @brief Determines if the parser for this FileObject has reached the end of the file +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Keep reading until we reach the end of the file +/// while( !%fileRead.isEOF() ) +/// { +/// %line = %fileRead.readline(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise) +/// /// public bool fnFileObject_isEOF (string fileobject) @@ -18765,7 +23322,23 @@ public bool fnFileObject_isEOF (string fileobject) return SafeNativeMethods.mwle_fnFileObject_isEOF(sbfileobject)>=1; } /// -/// @brief Open a specified file for writing, adding data to the end of the file There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. @param filename Path, name, and extension of file to append to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created // If it does exist, whatever we write will be added to the end %result = %fileWrite.OpenForAppend(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing, adding data to the end of the file +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text. Unlike openForWrite(), +/// which will erase an existing file if it is opened, openForAppend() preserves data in an existing file and adds to it. +/// +/// @param filename Path, name, and extension of file to append to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// // If it does exist, whatever we write will be added to the end +/// %result = %fileWrite.OpenForAppend(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool fnFileObject_openForAppend (string fileobject, string filename) @@ -18782,7 +23355,21 @@ public bool fnFileObject_openForAppend (string fileobject, string filename) return SafeNativeMethods.mwle_fnFileObject_openForAppend(sbfileobject, sbfilename)>=1; } /// -/// @brief Open a specified file for reading There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %result = %fileRead.OpenForRead(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for reading +/// +/// There is no limit as to what kind of file you can read. Any format and data contained within is accessible, not just text +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %result = %fileRead.OpenForRead(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool fnFileObject_openForRead (string fileobject, string filename) @@ -18799,7 +23386,21 @@ public bool fnFileObject_openForRead (string fileobject, string filename) return SafeNativeMethods.mwle_fnFileObject_openForRead(sbfileobject, sbfilename)>=1; } /// -/// @brief Open a specified file for writing There is no limit as to what kind of file you can write. Any format and data is allowable, not just text @param filename Path, name, and extension of file to write to @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %result = %fileWrite.OpenForWrite(\"./test.txt\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Open a specified file for writing +/// +/// There is no limit as to what kind of file you can write. Any format and data is allowable, not just text +/// +/// @param filename Path, name, and extension of file to write to +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %result = %fileWrite.OpenForWrite(\"./test.txt\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public bool fnFileObject_openForWrite (string fileobject, string filename) @@ -18816,7 +23417,31 @@ public bool fnFileObject_openForWrite (string fileobject, string filename) return SafeNativeMethods.mwle_fnFileObject_openForWrite(sbfileobject, sbfilename)>=1; } /// -/// @brief Read a line from the file without moving the stream position. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. @param filename Path, name, and extension of file to be read @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Peek the first line %line = %fileRead.peekLine(); // Print the line we just peeked echo(%line); // If we peek again... %line = %fileRead.peekLine(); // We will get the same output as the first time // since the stream did not move forward echo(%line); @endtsexample @return String containing the line of data that was just peeked) +/// @brief Read a line from the file without moving the stream position. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. Unlike readLine, the parser does not move forward after reading. +/// +/// @param filename Path, name, and extension of file to be read +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Peek the first line +/// %line = %fileRead.peekLine(); +/// // Print the line we just peeked +/// echo(%line); +/// // If we peek again... +/// %line = %fileRead.peekLine(); +/// // We will get the same output as the first time +/// // since the stream did not move forward +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just peeked) +/// /// public string fnFileObject_peekLine (string fileobject) @@ -18833,7 +23458,24 @@ public string fnFileObject_peekLine (string fileobject) } /// -/// @brief Read a line from file. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file object for reading %fileRead = new FileObject(); // Open a text file, if it exists %fileRead.OpenForRead(\"./test.txt\"); // Read in the first line %line = %fileRead.readline(); // Print the line we just read echo(%line); @endtsexample @return String containing the line of data that was just read) +/// @brief Read a line from file. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file object for reading +/// %fileRead = new FileObject(); +/// // Open a text file, if it exists +/// %fileRead.OpenForRead(\"./test.txt\"); +/// // Read in the first line +/// %line = %fileRead.readline(); +/// // Print the line we just read +/// echo(%line); +/// @endtsexample +/// +/// @return String containing the line of data that was just read) +/// /// public string fnFileObject_readLine (string fileobject) @@ -18850,7 +23492,24 @@ public string fnFileObject_readLine (string fileobject) } /// -/// @brief Write a line to the file, if it was opened for writing. There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param text The data we are writing out to file. @tsexample // Create a file object for writing %fileWrite = new FileObject(); // Open a file to write to, if it does not exist it will be created %fileWrite.OpenForWrite(\"./test.txt\"); // Write a line to the text files %fileWrite.writeLine(\"READ. READ CODE. CODE\"); @endtsexample @return True if file was successfully opened, false otherwise) +/// @brief Write a line to the file, if it was opened for writing. +/// +/// There is no limit as to what kind of text you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param text The data we are writing out to file. +/// +/// @tsexample +/// // Create a file object for writing +/// %fileWrite = new FileObject(); +/// // Open a file to write to, if it does not exist it will be created +/// %fileWrite.OpenForWrite(\"./test.txt\"); +/// // Write a line to the text files +/// %fileWrite.writeLine(\"READ. READ CODE. CODE\"); +/// @endtsexample +/// +/// @return True if file was successfully opened, false otherwise) +/// /// public void fnFileObject_writeLine (string fileobject, string text) @@ -18867,7 +23526,19 @@ public void fnFileObject_writeLine (string fileobject, string text) SafeNativeMethods.mwle_fnFileObject_writeLine(sbfileobject, sbtext); } /// -/// @brief Close the file. You can no longer read or write to it unless you open it again. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see open()) +/// @brief Close the file. You can no longer read or write to it unless you open it again. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see open()) +/// /// public void fnFileStreamObject_close (string filestreamobject) @@ -18881,7 +23552,34 @@ public void fnFileStreamObject_close (string filestreamobject) SafeNativeMethods.mwle_fnFileStreamObject_close(sbfilestreamobject); } /// -/// @brief Open a file for reading, writing, reading and writing, or appending Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting at the end of the files existing contents. @param filename Name of file to open @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the file was successfully opened, false if something went wrong @see close()) +/// @brief Open a file for reading, writing, reading and writing, or appending +/// +/// Using \"Read\" for the open mode allows you to parse the contents of file, but not making modifications. \"Write\" will create a new +/// file if it does not exist, or erase the contents of an existing file when opened. Write also allows you to modify the contents of the file. +/// +/// \"ReadWrite\" will provide the ability to parse data (read it in) and manipulate data (write it out) interchangeably. Keep in mind the stream can +/// move during each operation. Finally, \"WriteAppend\" will open a file if it exists, but will not clear the contents. You can write new data starting +/// at the end of the files existing contents. +/// +/// @param filename Name of file to open +/// @param openMode One of \"Read\", \"Write\", \"ReadWrite\" or \"WriteAppend\" +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the file was successfully opened, false if something went wrong +/// +/// @see close()) +/// /// public bool fnFileStreamObject_open (string filestreamobject, string filename, string openMode) @@ -18901,7 +23599,10 @@ public bool fnFileStreamObject_open (string filestreamobject, string filename, s return SafeNativeMethods.mwle_fnFileStreamObject_open(sbfilestreamobject, sbfilename, sbopenMode)>=1; } /// -/// @brief Set whether the vehicle should temporarily use the createHoverHeight specified in the datablock.This can help avoid problems with spawning. @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// @brief Set whether the vehicle should temporarily use the createHoverHeight +/// specified in the datablock.This can help avoid problems with spawning. +/// @param enabled true to use the datablock createHoverHeight, false otherwise ) +/// /// public void fnFlyingVehicle_useCreateHeight (string flyingvehicle, bool enabled) @@ -18916,6 +23617,7 @@ public void fnFlyingVehicle_useCreateHeight (string flyingvehicle, bool enabled) } /// /// .) +/// /// public void fnForest_addItem (string forest, string data, string position, float rotation, float scale) @@ -18936,6 +23638,7 @@ public void fnForest_addItem (string forest, string data, string position, float } /// /// .) +/// /// public void fnForest_addItemWithTransform (string forest, string data, string trans, float scale) @@ -18955,7 +23658,16 @@ public void fnForest_addItemWithTransform (string forest, string data, string tr SafeNativeMethods.mwle_fnForest_addItemWithTransform(sbforest, sbdata, sbtrans, scale); } /// -/// @brief Mounts the wind emitter to another scene object @param objectID Unique ID of the object wind emitter should attach to @tsexample // Wind emitter previously created and named %windEmitter // Going to attach it to the player, making him a walking wind storm %windEmitter.attachToObject(%player); @endtsexample) +/// @brief Mounts the wind emitter to another scene object +/// +/// @param objectID Unique ID of the object wind emitter should attach to +/// +/// @tsexample +/// // Wind emitter previously created and named %windEmitter +/// // Going to attach it to the player, making him a walking wind storm +/// %windEmitter.attachToObject(%player); +/// @endtsexample) +/// /// public void fnForestWindEmitter_attachToObject (string forestwindemitter, uint objectID) @@ -18969,21 +23681,14 @@ public void fnForestWindEmitter_attachToObject (string forestwindemitter, uint o SafeNativeMethods.mwle_fnForestWindEmitter_attachToObject(sbforestwindemitter, objectID); } /// -/// @brief Mounts the wind emitter to another scene object @param ) -/// - -public void fnForestWindEmitter_resetWind (string forestwindemitter, int randomSeed) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fnForestWindEmitter_resetWind'" + string.Format("\"{0}\" \"{1}\" ",forestwindemitter,randomSeed)); -StringBuilder sbforestwindemitter = null; -if (forestwindemitter != null) - sbforestwindemitter = new StringBuilder(forestwindemitter, 1024); - -SafeNativeMethods.mwle_fnForestWindEmitter_resetWind(sbforestwindemitter, randomSeed); -} -/// -/// @brief Apply an impulse to this object as defined by a world position and velocity vector. @param pos impulse world position @param vel impulse velocity (impulse force F = m * v) @return Always true @note Not all objects that derrive from GameBase have this defined.) +/// @brief Apply an impulse to this object as defined by a world position and velocity vector. +/// +/// @param pos impulse world position +/// @param vel impulse velocity (impulse force F = m * v) +/// @return Always true +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public bool fnGameBase_applyImpulse (string gamebase, string pos, string vel) @@ -19003,7 +23708,14 @@ public bool fnGameBase_applyImpulse (string gamebase, string pos, string vel) return SafeNativeMethods.mwle_fnGameBase_applyImpulse(sbgamebase, sbpos, sbvel)>=1; } /// -/// @brief Applies a radial impulse to the object using the given origin and force. @param origin World point of origin of the radial impulse. @param radius The radius of the impulse area. @param magnitude The strength of the impulse. @note Not all objects that derrive from GameBase have this defined.) +/// @brief Applies a radial impulse to the object using the given origin and force. +/// +/// @param origin World point of origin of the radial impulse. +/// @param radius The radius of the impulse area. +/// @param magnitude The strength of the impulse. +/// +/// @note Not all objects that derrive from GameBase have this defined.) +/// /// public void fnGameBase_applyRadialImpulse (string gamebase, string origin, float radius, float magnitude) @@ -19020,7 +23732,10 @@ public void fnGameBase_applyRadialImpulse (string gamebase, string origin, float SafeNativeMethods.mwle_fnGameBase_applyRadialImpulse(sbgamebase, sborigin, radius, magnitude); } /// -/// @brief Get the datablock used by this object. @return the datablock this GameBase is using. @see setDataBlock()) +/// @brief Get the datablock used by this object. +/// @return the datablock this GameBase is using. +/// @see setDataBlock()) +/// /// public int fnGameBase_getDataBlock (string gamebase) @@ -19034,7 +23749,11 @@ public int fnGameBase_getDataBlock (string gamebase) return SafeNativeMethods.mwle_fnGameBase_getDataBlock(sbgamebase); } /// -/// @brief Assign this GameBase to use the specified datablock. @param data new datablock to use @return true if successful, false if failed. @see getDataBlock()) +/// @brief Assign this GameBase to use the specified datablock. +/// @param data new datablock to use +/// @return true if successful, false if failed. +/// @see getDataBlock()) +/// /// public bool fnGameBase_setDataBlock (string gamebase, string data) @@ -19051,7 +23770,36 @@ public bool fnGameBase_setDataBlock (string gamebase, string data) return SafeNativeMethods.mwle_fnGameBase_setDataBlock(sbgamebase, sbdata)>=1; } /// -/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. Ghosts represent objects on the server that are in scope for the client. These need to be synchronized with the client in order for the client to see and interact with them. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mod paths, this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Called by the server during phase 2 of the mission download to start sending ghosts to the client. +/// +/// Ghosts represent objects on the server that are in scope for the client. These need +/// to be synchronized with the client in order for the client to see and interact with them. +/// This is typically done during the standard mission start phase 2 when following Torque's +/// example mission startup sequence. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mod paths, this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void fnGameConnection_activateGhosting (string gameconnection) @@ -19065,7 +23813,10 @@ public void fnGameConnection_activateGhosting (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_activateGhosting(sbgameconnection); } /// -/// @brief Sets the size of the chase camera's matrix queue. @note This sets the queue size across all GameConnections. @note This is not currently hooked up.) +/// @brief Sets the size of the chase camera's matrix queue. +/// @note This sets the queue size across all GameConnections. +/// @note This is not currently hooked up.) +/// /// public bool fnGameConnection_chaseCam (string gameconnection, int size) @@ -19079,7 +23830,10 @@ public bool fnGameConnection_chaseCam (string gameconnection, int size) return SafeNativeMethods.mwle_fnGameConnection_chaseCam(sbgameconnection, size)>=1; } /// -/// @brief Clear the connection's camera object reference. @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// @brief Clear the connection's camera object reference. +/// +/// @see GameConnection::setCameraObject() and GameConnection::getCameraObject()) +/// /// public void fnGameConnection_clearCameraObject (string gameconnection) @@ -19093,7 +23847,9 @@ public void fnGameConnection_clearCameraObject (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_clearCameraObject(sbgameconnection); } /// -/// @brief Clear any display device. A display device may define a number of properties that are used during rendering.) +/// @brief Clear any display device. +/// A display device may define a number of properties that are used during rendering.) +/// /// public void fnGameConnection_clearDisplayDevice (string gameconnection) @@ -19107,7 +23863,26 @@ public void fnGameConnection_clearDisplayDevice (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_clearDisplayDevice(sbgameconnection); } /// -/// ), @brief On the server, disconnect a client and pass along an optional reason why. This method performs two operations: it disconnects a client connection from the server, and it deletes the connection object. The optional reason is sent in the disconnect packet and is often displayed to the user so they know why they've been disconnected. @param reason [optional] The reason why the user has been disconnected from the server. @tsexample function kick(%client) { messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); if (!%client.isAIControlled()) BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); %client.delete(\"You have been kicked from this server\"); } @endtsexample) +/// ), +/// @brief On the server, disconnect a client and pass along an optional reason why. +/// +/// This method performs two operations: it disconnects a client connection from the server, +/// and it deletes the connection object. The optional reason is sent in the disconnect packet +/// and is often displayed to the user so they know why they've been disconnected. +/// +/// @param reason [optional] The reason why the user has been disconnected from the server. +/// +/// @tsexample +/// function kick(%client) +/// { +/// messageAll( 'MsgAdminForce', '\\c2The Admin has kicked %1.', %client.playerName); +/// +/// if (!%client.isAIControlled()) +/// BanList::add(%client.guid, %client.getAddress(), $Pref::Server::KickBanTime); +/// %client.delete(\"You have been kicked from this server\"); +/// } +/// @endtsexample) +/// /// public void fnGameConnection_delete (string gameconnection, string reason) @@ -19124,7 +23899,10 @@ public void fnGameConnection_delete (string gameconnection, string reason) SafeNativeMethods.mwle_fnGameConnection_delete(sbgameconnection, sbreason); } /// -/// @brief Returns the connection's camera object used when not viewing through the control object. @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// @brief Returns the connection's camera object used when not viewing through the control object. +/// +/// @see GameConnection::setCameraObject() and GameConnection::clearCameraObject()) +/// /// public string fnGameConnection_getCameraObject (string gameconnection) @@ -19142,6 +23920,7 @@ public string fnGameConnection_getCameraObject (string gameconnection) } /// /// @brief Returns the default field of view as used by the control object's camera.) +/// /// public float fnGameConnection_getControlCameraDefaultFov (string gameconnection) @@ -19156,6 +23935,7 @@ public float fnGameConnection_getControlCameraDefaultFov (string gameconnection) } /// /// @brief Returns the field of view as used by the control object's camera.) +/// /// public float fnGameConnection_getControlCameraFov (string gameconnection) @@ -19169,7 +23949,12 @@ public float fnGameConnection_getControlCameraFov (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_getControlCameraFov(sbgameconnection); } /// -/// @brief On the server, returns the object that the client is controlling. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @see GameConnection::setControlObject()) +/// @brief On the server, returns the object that the client is controlling. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @see GameConnection::setControlObject()) +/// /// public string fnGameConnection_getControlObject (string gameconnection) @@ -19186,7 +23971,11 @@ public string fnGameConnection_getControlObject (string gameconnection) } /// -/// @brief Get the connection's control scheme absolute rotation property. @return True if the connection's control object should use an absolute rotation control scheme. @see GameConnection::setControlSchemeParameters()) +/// @brief Get the connection's control scheme absolute rotation property. +/// +/// @return True if the connection's control object should use an absolute rotation control scheme. +/// @see GameConnection::setControlSchemeParameters()) +/// /// public bool fnGameConnection_getControlSchemeAbsoluteRotation (string gameconnection) @@ -19200,7 +23989,9 @@ public bool fnGameConnection_getControlSchemeAbsoluteRotation (string gameconnec return SafeNativeMethods.mwle_fnGameConnection_getControlSchemeAbsoluteRotation(sbgameconnection)>=1; } /// -/// @brief On the client, get the control object's damage flash level. @return flash level) +/// @brief On the client, get the control object's damage flash level. +/// @return flash level) +/// /// public float fnGameConnection_getDamageFlash (string gameconnection) @@ -19214,7 +24005,9 @@ public float fnGameConnection_getDamageFlash (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_getDamageFlash(sbgameconnection); } /// -/// @brief On the client, get the control object's white-out level. @return white-out level) +/// @brief On the client, get the control object's white-out level. +/// @return white-out level) +/// /// public float fnGameConnection_getWhiteOut (string gameconnection) @@ -19228,7 +24021,9 @@ public float fnGameConnection_getWhiteOut (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_getWhiteOut(sbgameconnection); } /// -/// @brief Returns true if this connection is AI controlled. @see AIConnection) +/// @brief Returns true if this connection is AI controlled. +/// @see AIConnection) +/// /// public bool fnGameConnection_isAIControlled (string gameconnection) @@ -19242,7 +24037,10 @@ public bool fnGameConnection_isAIControlled (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isAIControlled(sbgameconnection)>=1; } /// -/// @brief Returns true if the object being controlled by the client is making use of a rotation damped camera. @see Camera) +/// @brief Returns true if the object being controlled by the client is making use +/// of a rotation damped camera. +/// @see Camera) +/// /// public bool fnGameConnection_isControlObjectRotDampedCamera (string gameconnection) @@ -19256,7 +24054,10 @@ public bool fnGameConnection_isControlObjectRotDampedCamera (string gameconnecti return SafeNativeMethods.mwle_fnGameConnection_isControlObjectRotDampedCamera(sbgameconnection)>=1; } /// -/// @brief Returns true if a previously recorded demo file is now playing. @see GameConnection::playDemo()) +/// @brief Returns true if a previously recorded demo file is now playing. +/// +/// @see GameConnection::playDemo()) +/// /// public bool fnGameConnection_isDemoPlaying (string gameconnection) @@ -19270,7 +24071,10 @@ public bool fnGameConnection_isDemoPlaying (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isDemoPlaying(sbgameconnection)>=1; } /// -/// @brief Returns true if a demo file is now being recorded. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief Returns true if a demo file is now being recorded. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool fnGameConnection_isDemoRecording (string gameconnection) @@ -19284,7 +24088,11 @@ public bool fnGameConnection_isDemoRecording (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isDemoRecording(sbgameconnection)>=1; } /// -/// @brief Returns true if this connection is in first person mode. @note Transition to first person occurs over time via mCameraPos, so this won't immediately return true after a set.) +/// @brief Returns true if this connection is in first person mode. +/// +/// @note Transition to first person occurs over time via mCameraPos, so this +/// won't immediately return true after a set.) +/// /// public bool fnGameConnection_isFirstPerson (string gameconnection) @@ -19298,7 +24106,9 @@ public bool fnGameConnection_isFirstPerson (string gameconnection) return SafeNativeMethods.mwle_fnGameConnection_isFirstPerson(sbgameconnection)>=1; } /// -/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. @note The list is sent to the console.) +/// @brief List all of the classes that this connection knows about, and what their IDs are. Useful for debugging network problems. +/// @note The list is sent to the console.) +/// /// public void fnGameConnection_listClassIDs (string gameconnection) @@ -19313,6 +24123,7 @@ public void fnGameConnection_listClassIDs (string gameconnection) } /// /// ) +/// /// public bool fnGameConnection_LoadDatablocksFromFile (string gameconnection, uint crc) @@ -19326,7 +24137,20 @@ public bool fnGameConnection_LoadDatablocksFromFile (string gameconnection, uint return SafeNativeMethods.mwle_fnGameConnection_LoadDatablocksFromFile(sbgameconnection, crc)>=1; } /// -/// @brief Used on the server to play a 2D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @tsexample function ServerPlay2D(%profile) { // Play the given sound profile on every client. // The sounds will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play2D(%profile); } @endtsexample) +/// @brief Used on the server to play a 2D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// +/// @tsexample +/// function ServerPlay2D(%profile) +/// { +/// // Play the given sound profile on every client. +/// // The sounds will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play2D(%profile); +/// } +/// @endtsexample) +/// /// public bool fnGameConnection_play2D (string gameconnection, string profile) @@ -19343,7 +24167,21 @@ public bool fnGameConnection_play2D (string gameconnection, string profile) return SafeNativeMethods.mwle_fnGameConnection_play2D(sbgameconnection, sbprofile)>=1; } /// -/// @brief Used on the server to play a 3D sound that is not attached to any object. @param profile The SFXProfile that defines the sound to play. @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". @tsexample function ServerPlay3D(%profile,%transform) { // Play the given sound profile at the given position on every client // The sound will be transmitted as an event, not attached to any object. for(%idx = 0; %idx ClientGroup.getCount(); %idx++) ClientGroup.getObject(%idx).play3D(%profile,%transform); } @endtsexample) +/// @brief Used on the server to play a 3D sound that is not attached to any object. +/// +/// @param profile The SFXProfile that defines the sound to play. +/// @param location The position and orientation of the 3D sound given in the form of \"x y z ax ay az aa\". +/// +/// @tsexample +/// function ServerPlay3D(%profile,%transform) +/// { +/// // Play the given sound profile at the given position on every client +/// // The sound will be transmitted as an event, not attached to any object. +/// for(%idx = 0; %idx ClientGroup.getCount(); %idx++) +/// ClientGroup.getObject(%idx).play3D(%profile,%transform); +/// } +/// @endtsexample) +/// /// public bool fnGameConnection_play3D (string gameconnection, string profile, string location) @@ -19363,7 +24201,19 @@ public bool fnGameConnection_play3D (string gameconnection, string profile, stri return SafeNativeMethods.mwle_fnGameConnection_play3D(sbgameconnection, sbprofile, sblocation)>=1; } /// -/// @brief On the client, play back a previously recorded game session. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @returns True if the playback was successful. False if there was an issue, such as not being able to open the demo file for playback. @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// @brief On the client, play back a previously recorded game session. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @returns True if the playback was successful. False if there was an issue, such as +/// not being able to open the demo file for playback. +/// +/// @see GameConnection::startRecording(), GameConnection::stopRecording()) +/// /// public bool fnGameConnection_playDemo (string gameconnection, string demoFileName) @@ -19380,7 +24230,27 @@ public bool fnGameConnection_playDemo (string gameconnection, string demoFileNam return SafeNativeMethods.mwle_fnGameConnection_playDemo(sbgameconnection, sbdemoFileName)>=1; } /// -/// @brief On the server, resets the connection to indicate that ghosting has been disabled. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that ghosts are no longer being transmitted. On the client end, all ghost information will be deleted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, resets the connection to indicate that ghosting has been disabled. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that ghosts are no longer being transmitted. On the client end, all ghost +/// information will be deleted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public void fnGameConnection_resetGhosting (string gameconnection) @@ -19394,7 +24264,11 @@ public void fnGameConnection_resetGhosting (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_resetGhosting(sbgameconnection); } /// -/// @brief On the server, sets the client's 3D display to fade to black. @param doFade Set to true to fade to black, and false to fade from black. @param timeMS Time it takes to perform the fade as measured in ms. @note Not currently hooked up, and is not synchronized over the network.) +/// @brief On the server, sets the client's 3D display to fade to black. +/// @param doFade Set to true to fade to black, and false to fade from black. +/// @param timeMS Time it takes to perform the fade as measured in ms. +/// @note Not currently hooked up, and is not synchronized over the network.) +/// /// public void fnGameConnection_setBlackOut (string gameconnection, bool doFade, int timeMS) @@ -19408,7 +24282,11 @@ public void fnGameConnection_setBlackOut (string gameconnection, bool doFade, in SafeNativeMethods.mwle_fnGameConnection_setBlackOut(sbgameconnection, doFade, timeMS); } /// -/// @brief On the server, set the connection's camera object used when not viewing through the control object. @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// @brief On the server, set the connection's camera object used when not viewing +/// through the control object. +/// +/// @see GameConnection::getCameraObject() and GameConnection::clearCameraObject()) +/// /// public bool fnGameConnection_setCameraObject (string gameconnection, string camera) @@ -19425,7 +24303,14 @@ public bool fnGameConnection_setCameraObject (string gameconnection, string came return SafeNativeMethods.mwle_fnGameConnection_setCameraObject(sbgameconnection, sbcamera)>=1; } /// -/// (GameConnection, setConnectArgs, void, 3, 17, (const char* args) @brief On the client, pass along a variable set of parameters to the server. Once the connection is established with the server, the server calls its onConnect() method with the client's passed in parameters as aruments. @see GameConnection::onConnect()) +/// (GameConnection, setConnectArgs, void, 3, 17, +/// (const char* args) @brief On the client, pass along a variable set of parameters to the server. +/// +/// Once the connection is established with the server, the server calls its onConnect() method +/// with the client's passed in parameters as aruments. +/// +/// @see GameConnection::onConnect()) +/// /// public void fnGameConnection_setConnectArgs (string gameconnection, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16) @@ -19484,7 +24369,12 @@ public void fnGameConnection_setConnectArgs (string gameconnection, string a2, s SafeNativeMethods.mwle_fnGameConnection_setConnectArgs(sbgameconnection, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16); } /// -/// @brief On the server, sets the control object's camera's field of view. @param newFOV New field of view (in degrees) to force the control object's camera to use. This value is clamped to be within the range of 1 to 179 degrees. @note When transmitted over the network to the client, the resolution is limited to one degree. Any fraction is dropped.) +/// @brief On the server, sets the control object's camera's field of view. +/// @param newFOV New field of view (in degrees) to force the control object's camera to use. This value +/// is clamped to be within the range of 1 to 179 degrees. +/// @note When transmitted over the network to the client, the resolution is limited to +/// one degree. Any fraction is dropped.) +/// /// public void fnGameConnection_setControlCameraFov (string gameconnection, float newFOV) @@ -19498,7 +24388,12 @@ public void fnGameConnection_setControlCameraFov (string gameconnection, float n SafeNativeMethods.mwle_fnGameConnection_setControlCameraFov(sbgameconnection, newFOV); } /// -/// @brief On the server, sets the object that the client will control. By default the control object is an instance of the Player class, but can also be an instance of Camera (when editing the mission, for example), or any other ShapeBase derived class as appropriate for the game. @param ctrlObj The GameBase object on the server to control.) +/// @brief On the server, sets the object that the client will control. +/// By default the control object is an instance of the Player class, but can also be an instance +/// of Camera (when editing the mission, for example), or any other ShapeBase derived class as +/// appropriate for the game. +/// @param ctrlObj The GameBase object on the server to control.) +/// /// public bool fnGameConnection_setControlObject (string gameconnection, string ctrlObj) @@ -19515,7 +24410,11 @@ public bool fnGameConnection_setControlObject (string gameconnection, string ctr return SafeNativeMethods.mwle_fnGameConnection_setControlObject(sbgameconnection, sbctrlObj)>=1; } /// -/// @brief Set the control scheme that may be used by a connection's control object. @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// @brief Set the control scheme that may be used by a connection's control object. +/// +/// @param absoluteRotation Use absolute rotation values from client, likely through ExtendedMove. +/// @param addYawToAbsRot Add relative yaw control to the absolute rotation calculation. Only useful when absoluteRotation is true. ) +/// /// public void fnGameConnection_setControlSchemeParameters (string gameconnection, bool absoluteRotation, bool addYawToAbsRot, bool addPitchToAbsRot) @@ -19529,7 +24428,10 @@ public void fnGameConnection_setControlSchemeParameters (string gameconnection, SafeNativeMethods.mwle_fnGameConnection_setControlSchemeParameters(sbgameconnection, absoluteRotation, addYawToAbsRot, addPitchToAbsRot); } /// -/// @brief On the server, sets this connection into or out of first person mode. @param firstPerson Set to true to put the connection into first person mode.) +/// @brief On the server, sets this connection into or out of first person mode. +/// +/// @param firstPerson Set to true to put the connection into first person mode.) +/// /// public void fnGameConnection_setFirstPerson (string gameconnection, bool firstPerson) @@ -19543,7 +24445,16 @@ public void fnGameConnection_setFirstPerson (string gameconnection, bool firstPe SafeNativeMethods.mwle_fnGameConnection_setFirstPerson(sbgameconnection, firstPerson); } /// -/// @brief On the client, set the password that will be passed to the server. On the server, this password is compared with what is stored in $pref::Server::Password. If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, if the passed in client password and the server password do not match, the CHR_PASSWORD error string is sent back to the client and the connection is immediately terminated. This password checking is performed quite early on in the connection request process so as to minimize the impact of multiple failed attempts -- also known as hacking.) +/// @brief On the client, set the password that will be passed to the server. +/// +/// On the server, this password is compared with what is stored in $pref::Server::Password. +/// If $pref::Server::Password is empty then the client's sent password is ignored. Otherwise, +/// if the passed in client password and the server password do not match, the CHR_PASSWORD +/// error string is sent back to the client and the connection is immediately terminated. +/// +/// This password checking is performed quite early on in the connection request process so as +/// to minimize the impact of multiple failed attempts -- also known as hacking.) +/// /// public void fnGameConnection_setJoinPassword (string gameconnection, string password) @@ -19560,7 +24471,35 @@ public void fnGameConnection_setJoinPassword (string gameconnection, string pass SafeNativeMethods.mwle_fnGameConnection_setJoinPassword(sbgameconnection, sbpassword); } /// -/// @brief On the server, transmits the mission file's CRC value to the client. Typically, during the standard mission start phase 1, the mission file's CRC value on the server is send to the client. This allows the client to determine if the mission has changed since the last time it downloaded this mission and act appropriately, such as rebuilt cached lightmaps. @param CRC The mission file's CRC value on the server. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample) +/// @brief On the server, transmits the mission file's CRC value to the client. +/// +/// Typically, during the standard mission start phase 1, the mission file's CRC value +/// on the server is send to the client. This allows the client to determine if the mission +/// has changed since the last time it downloaded this mission and act appropriately, such as +/// rebuilt cached lightmaps. +/// +/// @param CRC The mission file's CRC value on the server. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample) +/// /// public void fnGameConnection_setMissionCRC (string gameconnection, int CRC) @@ -19574,7 +24513,18 @@ public void fnGameConnection_setMissionCRC (string gameconnection, int CRC) SafeNativeMethods.mwle_fnGameConnection_setMissionCRC(sbgameconnection, CRC); } /// -/// @brief On the client, starts recording the network connection's traffic to a demo file. It is often useful to play back a game session. This could be for producing a demo of the game that will be shown at a later time, or for debugging a game. By recording the entire network stream it is possible to later play game the game exactly as it unfolded during the actual play session. This is because all user control and server results pass through the connection. @param fileName The file name to use for the demo recording. @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// @brief On the client, starts recording the network connection's traffic to a demo file. +/// +/// It is often useful to play back a game session. This could be for producing a +/// demo of the game that will be shown at a later time, or for debugging a game. +/// By recording the entire network stream it is possible to later play game the game +/// exactly as it unfolded during the actual play session. This is because all user +/// control and server results pass through the connection. +/// +/// @param fileName The file name to use for the demo recording. +/// +/// @see GameConnection::stopRecording(), GameConnection::playDemo()) +/// /// public void fnGameConnection_startRecording (string gameconnection, string fileName) @@ -19591,7 +24541,10 @@ public void fnGameConnection_startRecording (string gameconnection, string fileN SafeNativeMethods.mwle_fnGameConnection_startRecording(sbgameconnection, sbfileName); } /// -/// @brief On the client, stops the recording of a connection's network traffic to a file. @see GameConnection::startRecording(), GameConnection::playDemo()) +/// @brief On the client, stops the recording of a connection's network traffic to a file. +/// +/// @see GameConnection::startRecording(), GameConnection::playDemo()) +/// /// public void fnGameConnection_stopRecording (string gameconnection) @@ -19605,7 +24558,44 @@ public void fnGameConnection_stopRecording (string gameconnection) SafeNativeMethods.mwle_fnGameConnection_stopRecording(sbgameconnection); } /// -/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. SimDataBlocks, also known as just datablocks, need to be transmitted to the client prior to the client entering the game world. These represent the static data that most objects in the world reference. This is typically done during the standard mission start phase 1 when following Torque's example mission startup sequence. When the datablocks have all been transmitted, onDataBlocksDone() is called to move the mission start process to the next phase. @param sequence The sequence is common between the server and client and ensures that the client is acting on the most recent mission start process. If an errant network packet (one that was lost but has now been found) is received by the client with an incorrect sequence, it is just ignored. This sequence number is updated on the server every time a mission is loaded. @tsexample function serverCmdMissionStartPhase1Ack(%client, %seq) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 0) return; %client.currentPhase = 1; // Start with the CRC %client.setMissionCRC( $missionCRC ); // Send over the datablocks... // OnDataBlocksDone will get called when have confirmation // that they've all been received. %client.transmitDataBlocks($missionSequence); } @endtsexample @see GameConnection::onDataBlocksDone()) +/// @brief Sent by the server during phase 1 of the mission download to send the datablocks to the client. +/// +/// SimDataBlocks, also known as just datablocks, need to be transmitted to the client +/// prior to the client entering the game world. These represent the static data that +/// most objects in the world reference. This is typically done during the standard +/// mission start phase 1 when following Torque's example mission startup sequence. +/// +/// When the datablocks have all been transmitted, onDataBlocksDone() is called to move +/// the mission start process to the next phase. +/// +/// @param sequence The sequence is common between the server and client and ensures +/// that the client is acting on the most recent mission start process. If an errant +/// network packet (one that was lost but has now been found) is received by the client +/// with an incorrect sequence, it is just ignored. This sequence number is updated on +/// the server every time a mission is loaded. +/// +/// @tsexample +/// function serverCmdMissionStartPhase1Ack(%client, %seq) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 0) +/// return; +/// %client.currentPhase = 1; +/// +/// // Start with the CRC +/// %client.setMissionCRC( $missionCRC ); +/// +/// // Send over the datablocks... +/// // OnDataBlocksDone will get called when have confirmation +/// // that they've all been received. +/// %client.transmitDataBlocks($missionSequence); +/// } +/// @endtsexample +/// +/// @see GameConnection::onDataBlocksDone()) +/// /// public void fnGameConnection_transmitDataBlocks (string gameconnection, int sequence) @@ -19619,7 +24609,11 @@ public void fnGameConnection_transmitDataBlocks (string gameconnection, int sequ SafeNativeMethods.mwle_fnGameConnection_transmitDataBlocks(sbgameconnection, sequence); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields to client objects. +/// ) +/// /// public void fnGroundPlane_postApply (string groundplane) @@ -19634,6 +24628,7 @@ public void fnGroundPlane_postApply (string groundplane) } /// /// ( GuiAutoCompleteCtrl, add, void, 3, 5, (string name, int idNum, int scheme=0)) +/// /// public void fnGuiAutoCompleteCtrl_add (string guiautocompletectrl, string a2, string a3, string a4) @@ -19657,6 +24652,7 @@ public void fnGuiAutoCompleteCtrl_add (string guiautocompletectrl, string a2, st } /// /// ( GuiAutoCompleteCtrl, addScheme, void, 6, 6, (int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL)) +/// /// public void fnGuiAutoCompleteCtrl_addScheme (string guiautocompletectrl, string a2, string a3, string a4, string a5) @@ -19683,6 +24679,7 @@ public void fnGuiAutoCompleteCtrl_addScheme (string guiautocompletectrl, string } /// /// ( GuiAutoCompleteCtrl, changeTextById, void, 4, 4, ( int id, string text ) ) +/// /// public void fnGuiAutoCompleteCtrl_changeTextById (string guiautocompletectrl, string a2, string a3) @@ -19703,6 +24700,7 @@ public void fnGuiAutoCompleteCtrl_changeTextById (string guiautocompletectrl, st } /// /// ( GuiAutoCompleteCtrl, clear, void, 2, 2, Clear the popup list.) +/// /// public void fnGuiAutoCompleteCtrl_clear (string guiautocompletectrl) @@ -19717,6 +24715,7 @@ public void fnGuiAutoCompleteCtrl_clear (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, clearEntry, void, 3, 3, (S32 entry)) +/// /// public void fnGuiAutoCompleteCtrl_clearEntry (string guiautocompletectrl, string a2) @@ -19733,7 +24732,9 @@ public void fnGuiAutoCompleteCtrl_clearEntry (string guiautocompletectrl, string SafeNativeMethods.mwle_fnGuiAutoCompleteCtrl_clearEntry(sbguiautocompletectrl, sba2); } /// -/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) Returns the position of the first entry containing the specified text.) +/// ( GuiAutoCompleteCtrl, findText, S32, 3, 3, (string text) +/// Returns the position of the first entry containing the specified text.) +/// /// public int fnGuiAutoCompleteCtrl_findText (string guiautocompletectrl, string a2) @@ -19751,6 +24752,7 @@ public int fnGuiAutoCompleteCtrl_findText (string guiautocompletectrl, string a2 } /// /// ( GuiAutoCompleteCtrl, forceClose, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_forceClose (string guiautocompletectrl) @@ -19765,6 +24767,7 @@ public void fnGuiAutoCompleteCtrl_forceClose (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, forceOnAction, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_forceOnAction (string guiautocompletectrl) @@ -19779,6 +24782,7 @@ public void fnGuiAutoCompleteCtrl_forceOnAction (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, getSelected, S32, 2, 2, ) +/// /// public int fnGuiAutoCompleteCtrl_getSelected (string guiautocompletectrl) @@ -19793,6 +24797,7 @@ public int fnGuiAutoCompleteCtrl_getSelected (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, getText, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_getText (string guiautocompletectrl) @@ -19807,6 +24812,7 @@ public void fnGuiAutoCompleteCtrl_getText (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, getTextById, const char*, 3, 3, (int id)) +/// /// public string fnGuiAutoCompleteCtrl_getTextById (string guiautocompletectrl, string a2) @@ -19827,6 +24833,7 @@ public string fnGuiAutoCompleteCtrl_getTextById (string guiautocompletectrl, str } /// /// ( GuiAutoCompleteCtrl, replaceText, void, 3, 3, (bool doReplaceText)) +/// /// public void fnGuiAutoCompleteCtrl_replaceText (string guiautocompletectrl, string a2) @@ -19843,7 +24850,11 @@ public void fnGuiAutoCompleteCtrl_replaceText (string guiautocompletectrl, strin SafeNativeMethods.mwle_fnGuiAutoCompleteCtrl_replaceText(sbguiautocompletectrl, sba2); } /// -/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) This fills the popup with a classrep's field enumeration type info. More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away..) +/// ( GuiAutoCompleteCtrl, setEnumContent, void, 4, 4, (string class, string enum) +/// This fills the popup with a classrep's field enumeration type info. +/// More of a helper function than anything. If console access to the field list is added, +/// at least for the enumerated types, then this should go away..) +/// /// public void fnGuiAutoCompleteCtrl_setEnumContent (string guiautocompletectrl, string a2, string a3) @@ -19864,6 +24875,7 @@ public void fnGuiAutoCompleteCtrl_setEnumContent (string guiautocompletectrl, st } /// /// ( GuiAutoCompleteCtrl, setFirstSelected, void, 2, 3, ([scriptCallback=true])) +/// /// public void fnGuiAutoCompleteCtrl_setFirstSelected (string guiautocompletectrl, string a2) @@ -19881,6 +24893,7 @@ public void fnGuiAutoCompleteCtrl_setFirstSelected (string guiautocompletectrl, } /// /// ( GuiAutoCompleteCtrl, setNoneSelected, void, 2, 2, ) +/// /// public void fnGuiAutoCompleteCtrl_setNoneSelected (string guiautocompletectrl) @@ -19895,6 +24908,7 @@ public void fnGuiAutoCompleteCtrl_setNoneSelected (string guiautocompletectrl) } /// /// ( GuiAutoCompleteCtrl, setSelected, void, 3, 4, (int id, [scriptCallback=true])) +/// /// public void fnGuiAutoCompleteCtrl_setSelected (string guiautocompletectrl, string a2, string a3) @@ -19915,6 +24929,7 @@ public void fnGuiAutoCompleteCtrl_setSelected (string guiautocompletectrl, strin } /// /// ( GuiAutoCompleteCtrl, size, S32, 2, 2, Get the size of the menu - the number of entries in it.) +/// /// public int fnGuiAutoCompleteCtrl_size (string guiautocompletectrl) @@ -19929,6 +24944,7 @@ public int fnGuiAutoCompleteCtrl_size (string guiautocompletectrl) } /// /// (GuiAutoCompleteCtrl, sort, void, 2, 2, Sort the list alphabetically.) +/// /// public void fnGuiAutoCompleteCtrl_sort (string guiautocompletectrl) @@ -19943,6 +24959,7 @@ public void fnGuiAutoCompleteCtrl_sort (string guiautocompletectrl) } /// /// (GuiAutoCompleteCtrl, sortID, void, 2, 2, Sort the list by ID.) +/// /// public void fnGuiAutoCompleteCtrl_sortID (string guiautocompletectrl) @@ -19957,6 +24974,7 @@ public void fnGuiAutoCompleteCtrl_sortID (string guiautocompletectrl) } /// /// Reset scrolling. ) +/// /// public void fnGuiAutoScrollCtrl_reset (string guiautoscrollctrl) @@ -19970,7 +24988,9 @@ public void fnGuiAutoScrollCtrl_reset (string guiautoscrollctrl) SafeNativeMethods.mwle_fnGuiAutoScrollCtrl_reset(sbguiautoscrollctrl); } /// -/// Set the bitmap to show on the button. @param path Path to the texture file in any of the supported formats. ) +/// Set the bitmap to show on the button. +/// @param path Path to the texture file in any of the supported formats. ) +/// /// public void fnGuiBitmapButtonCtrl_setBitmap (string guibitmapbuttonctrl, string path) @@ -19987,7 +25007,10 @@ public void fnGuiBitmapButtonCtrl_setBitmap (string guibitmapbuttonctrl, string SafeNativeMethods.mwle_fnGuiBitmapButtonCtrl_setBitmap(sbguibitmapbuttonctrl, sbpath); } /// -/// Set the offset of the bitmap within the control. @param x The x-axis offset of the image. @param y The y-axis offset of the image.) +/// Set the offset of the bitmap within the control. +/// @param x The x-axis offset of the image. +/// @param y The y-axis offset of the image.) +/// /// public void fnGuiBitmapCtrl_setValue (string guibitmapctrl, int x, int y) @@ -20001,7 +25024,9 @@ public void fnGuiBitmapCtrl_setValue (string guibitmapctrl, int x, int y) SafeNativeMethods.mwle_fnGuiBitmapCtrl_setValue(sbguibitmapctrl, x, y); } /// -/// Get the text display on the button's label (if any). @return The button's label. ) +/// Get the text display on the button's label (if any). +/// @return The button's label. ) +/// /// public string fnGuiButtonBaseCtrl_getText (string guibuttonbasectrl) @@ -20018,7 +25043,10 @@ public string fnGuiButtonBaseCtrl_getText (string guibuttonbasectrl) } /// -/// Simulate a click on the button. This method will trigger the button's action just as if the button had been pressed by the user. ) +/// Simulate a click on the button. +/// This method will trigger the button's action just as if the button had been pressed by the +/// user. ) +/// /// public void fnGuiButtonBaseCtrl_performClick (string guibuttonbasectrl) @@ -20032,7 +25060,9 @@ public void fnGuiButtonBaseCtrl_performClick (string guibuttonbasectrl) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_performClick(sbguibuttonbasectrl); } /// -/// Reset the mousing state of the button. This method should not generally be called. ) +/// Reset the mousing state of the button. +/// This method should not generally be called. ) +/// /// public void fnGuiButtonBaseCtrl_resetState (string guibuttonbasectrl) @@ -20046,7 +25076,12 @@ public void fnGuiButtonBaseCtrl_resetState (string guibuttonbasectrl) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_resetState(sbguibuttonbasectrl); } /// -/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, toggling a button on will toggle all other radio buttons in its group to off. @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the button. To do that, use performClick(). ) +/// For toggle or radio buttons, set whether the button is currently activated or not. For radio buttons, +/// toggling a button on will toggle all other radio buttons in its group to off. +/// @param isOn If true, the button will be toggled on (if not already); if false, it will be toggled off. +/// @note Toggling the state of a button with this method will em>not/em> not trigger the action associated with the +/// button. To do that, use performClick(). ) +/// /// public void fnGuiButtonBaseCtrl_setStateOn (string guibuttonbasectrl, bool isOn) @@ -20060,7 +25095,12 @@ public void fnGuiButtonBaseCtrl_setStateOn (string guibuttonbasectrl, bool isOn) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_setStateOn(sbguibuttonbasectrl, isOn); } /// -/// Set the text displayed on the button's label. @param text The text to display as the button's text label. @note Not all buttons render text labels. @see getText @see setTextID ) +/// Set the text displayed on the button's label. +/// @param text The text to display as the button's text label. +/// @note Not all buttons render text labels. +/// @see getText +/// @see setTextID ) +/// /// public void fnGuiButtonBaseCtrl_setText (string guibuttonbasectrl, string text) @@ -20077,7 +25117,17 @@ public void fnGuiButtonBaseCtrl_setText (string guibuttonbasectrl, string text) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_setText(sbguibuttonbasectrl, sbtext); } /// -/// Set the text displayed on the button's label using a string from the string table assigned to the control. @param id Name of the variable that contains the integer string ID. Used to look up string in table. @note Not all buttons render text labels. @see setText @see getText @see GuiControl::langTableMod @see LangTable @ref Gui_i18n ) +/// Set the text displayed on the button's label using a string from the string table +/// assigned to the control. +/// @param id Name of the variable that contains the integer string ID. Used to look up +/// string in table. +/// @note Not all buttons render text labels. +/// @see setText +/// @see getText +/// @see GuiControl::langTableMod +/// @see LangTable +/// @ref Gui_i18n ) +/// /// public void fnGuiButtonBaseCtrl_setTextID (string guibuttonbasectrl, string id) @@ -20094,7 +25144,10 @@ public void fnGuiButtonBaseCtrl_setTextID (string guibuttonbasectrl, string id) SafeNativeMethods.mwle_fnGuiButtonBaseCtrl_setTextID(sbguibuttonbasectrl, sbid); } /// -/// Translate a coordinate from canvas window-space to screen-space. @param coordinate The coordinate in window-space. @return The given coordinate translated to screen-space. ) +/// Translate a coordinate from canvas window-space to screen-space. +/// @param coordinate The coordinate in window-space. +/// @return The given coordinate translated to screen-space. ) +/// /// public string fnGuiCanvas_clientToScreen (string guicanvas, string coordinate) @@ -20114,7 +25167,11 @@ public string fnGuiCanvas_clientToScreen (string guicanvas, string coordinate) } /// -/// @brief Turns on the mouse off. @tsexample Canvas.cursorOff(); @endtsexample) +/// @brief Turns on the mouse off. +/// @tsexample +/// Canvas.cursorOff(); +/// @endtsexample) +/// /// public void fnGuiCanvas_cursorOff (string guicanvas) @@ -20128,7 +25185,11 @@ public void fnGuiCanvas_cursorOff (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_cursorOff(sbguicanvas); } /// -/// @brief Turns on the mouse cursor. @tsexample Canvas.cursorOn(); @endtsexample) +/// @brief Turns on the mouse cursor. +/// @tsexample +/// Canvas.cursorOn(); +/// @endtsexample) +/// /// public void fnGuiCanvas_cursorOn (string guicanvas) @@ -20142,7 +25203,11 @@ public void fnGuiCanvas_cursorOn (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_cursorOn(sbguicanvas); } /// -/// @brief Find the first monitor index that matches the given name. The actual match algorithm depends on the implementation. @param name The name to search for. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Find the first monitor index that matches the given name. +/// The actual match algorithm depends on the implementation. +/// @param name The name to search for. +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int fnGuiCanvas_findFirstMatchingMonitor (string guicanvas, string name) @@ -20159,7 +25224,14 @@ public int fnGuiCanvas_findFirstMatchingMonitor (string guicanvas, string name) return SafeNativeMethods.mwle_fnGuiCanvas_findFirstMatchingMonitor(sbguicanvas, sbname); } /// -/// @brief Get the GuiControl which is being used as the content. @tsexample Canvas.getContent(); @endtsexample @return ID of current content control) +/// @brief Get the GuiControl which is being used as the content. +/// +/// @tsexample +/// Canvas.getContent(); +/// @endtsexample +/// +/// @return ID of current content control) +/// /// public int fnGuiCanvas_getContent (string guicanvas) @@ -20173,7 +25245,13 @@ public int fnGuiCanvas_getContent (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getContent(sbguicanvas); } /// -/// @brief Get the current position of the cursor. @param param Description @tsexample %cursorPos = Canvas.getCursorPos(); @endtsexample @return Screen coordinates of mouse cursor, in format \"X Y\") +/// @brief Get the current position of the cursor. +/// @param param Description +/// @tsexample +/// %cursorPos = Canvas.getCursorPos(); +/// @endtsexample +/// @return Screen coordinates of mouse cursor, in format \"X Y\") +/// /// public string fnGuiCanvas_getCursorPos (string guicanvas) @@ -20190,7 +25268,14 @@ public string fnGuiCanvas_getCursorPos (string guicanvas) } /// -/// @brief Returns the dimensions of the canvas @tsexample %extent = Canvas.getExtent(); @endtsexample @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// @brief Returns the dimensions of the canvas +/// +/// @tsexample +/// %extent = Canvas.getExtent(); +/// @endtsexample +/// +/// @return Width and height of canvas. Formatted as numerical values in a single string \"# #\") +/// /// public string fnGuiCanvas_getExtent (string guicanvas) @@ -20207,7 +25292,11 @@ public string fnGuiCanvas_getExtent (string guicanvas) } /// -/// @brief Gets information on the specified mode of this device. @param modeId Index of the mode to get data from. @return A video mode string given an adapter and mode index. @see GuiCanvas::getVideoMode()) +/// @brief Gets information on the specified mode of this device. +/// @param modeId Index of the mode to get data from. +/// @return A video mode string given an adapter and mode index. +/// @see GuiCanvas::getVideoMode()) +/// /// public string fnGuiCanvas_getMode (string guicanvas, int modeId) @@ -20224,7 +25313,16 @@ public string fnGuiCanvas_getMode (string guicanvas, int modeId) } /// -/// @brief Gets the number of modes available on this device. @param param Description @tsexample %modeCount = Canvas.getModeCount() @endtsexample @return The number of video modes supported by the device) +/// @brief Gets the number of modes available on this device. +/// +/// @param param Description +/// +/// @tsexample +/// %modeCount = Canvas.getModeCount() +/// @endtsexample +/// +/// @return The number of video modes supported by the device) +/// /// public int fnGuiCanvas_getModeCount (string guicanvas) @@ -20238,7 +25336,10 @@ public int fnGuiCanvas_getModeCount (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getModeCount(sbguicanvas); } /// -/// @brief Gets the number of monitors attached to the system. @return The number of monitors attached to the system, including the default monoitor.) +/// @brief Gets the number of monitors attached to the system. +/// +/// @return The number of monitors attached to the system, including the default monoitor.) +/// /// public int fnGuiCanvas_getMonitorCount (string guicanvas) @@ -20252,7 +25353,10 @@ public int fnGuiCanvas_getMonitorCount (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getMonitorCount(sbguicanvas); } /// -/// @brief Gets the name of the requested monitor. @param index The monitor index. @return The name of the requested monitor.) +/// @brief Gets the name of the requested monitor. +/// @param index The monitor index. +/// @return The name of the requested monitor.) +/// /// public string fnGuiCanvas_getMonitorName (string guicanvas, int index) @@ -20269,7 +25373,10 @@ public string fnGuiCanvas_getMonitorName (string guicanvas, int index) } /// -/// @brief Gets the region of the requested monitor. @param index The monitor index. @return The rectangular region of the requested monitor.) +/// @brief Gets the region of the requested monitor. +/// @param index The monitor index. +/// @return The rectangular region of the requested monitor.) +/// /// public string fnGuiCanvas_getMonitorRect (string guicanvas, int index) @@ -20286,7 +25393,13 @@ public string fnGuiCanvas_getMonitorRect (string guicanvas, int index) } /// -/// @brief Gets the gui control under the mouse. @tsexample %underMouse = Canvas.getMouseControl(); @endtsexample @return ID of the gui control, if one was found. NULL otherwise) +/// @brief Gets the gui control under the mouse. +/// @tsexample +/// %underMouse = Canvas.getMouseControl(); +/// @endtsexample +/// +/// @return ID of the gui control, if one was found. NULL otherwise) +/// /// public int fnGuiCanvas_getMouseControl (string guicanvas) @@ -20300,7 +25413,21 @@ public int fnGuiCanvas_getMouseControl (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_getMouseControl(sbguicanvas); } /// -/// @brief Gets the current screen mode as a string. The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). You will need to parse out each one for individual use. @tsexample %screenWidth = getWord(Canvas.getVideoMode(), 0); %screenHeight = getWord(Canvas.getVideoMode(), 1); %isFullscreen = getWord(Canvas.getVideoMode(), 2); %bitdepth = getWord(Canvas.getVideoMode(), 3); %refreshRate = getWord(Canvas.getVideoMode(), 4); @endtsexample @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// @brief Gets the current screen mode as a string. +/// +/// The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). +/// You will need to parse out each one for individual use. +/// +/// @tsexample +/// %screenWidth = getWord(Canvas.getVideoMode(), 0); +/// %screenHeight = getWord(Canvas.getVideoMode(), 1); +/// %isFullscreen = getWord(Canvas.getVideoMode(), 2); +/// %bitdepth = getWord(Canvas.getVideoMode(), 3); +/// %refreshRate = getWord(Canvas.getVideoMode(), 4); +/// @endtsexample +/// +/// @return String formatted with screen width, screen height, screen mode, bit depth, and refresh rate.) +/// /// public string fnGuiCanvas_getVideoMode (string guicanvas) @@ -20317,7 +25444,9 @@ public string fnGuiCanvas_getVideoMode (string guicanvas) } /// -/// Get the current position of the platform window associated with the canvas. @return The window position of the canvas in screen-space. ) +/// Get the current position of the platform window associated with the canvas. +/// @return The window position of the canvas in screen-space. ) +/// /// public string fnGuiCanvas_getWindowPosition (string guicanvas) @@ -20334,7 +25463,12 @@ public string fnGuiCanvas_getWindowPosition (string guicanvas) } /// -/// @brief Disable rendering of the cursor. @tsexample Canvas.hideCursor(); @endtsexample) +/// @brief Disable rendering of the cursor. +/// +/// @tsexample +/// Canvas.hideCursor(); +/// @endtsexample) +/// /// public void fnGuiCanvas_hideCursor (string guicanvas) @@ -20348,7 +25482,30 @@ public void fnGuiCanvas_hideCursor (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_hideCursor(sbguicanvas); } /// -/// @brief Determines if mouse cursor is enabled. @tsexample // Is cursor on? if(Canvas.isCursorOn()) echo(\"Canvas cursor is on\"); @endtsexample @return Returns true if the cursor is on.) +/// ( GuiCanvas, hideWindow, void, 2, 2, ) +/// +/// + +public void fnGuiCanvas_hideWindow (string guicanvas) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnGuiCanvas_hideWindow'" + string.Format("\"{0}\" ",guicanvas)); +StringBuilder sbguicanvas = null; +if (guicanvas != null) + sbguicanvas = new StringBuilder(guicanvas, 1024); + +SafeNativeMethods.mwle_fnGuiCanvas_hideWindow(sbguicanvas); +} +/// +/// @brief Determines if mouse cursor is enabled. +/// +/// @tsexample +/// // Is cursor on? +/// if(Canvas.isCursorOn()) +/// echo(\"Canvas cursor is on\"); +/// @endtsexample +/// @return Returns true if the cursor is on.) +/// /// public bool fnGuiCanvas_isCursorOn (string guicanvas) @@ -20362,7 +25519,15 @@ public bool fnGuiCanvas_isCursorOn (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_isCursorOn(sbguicanvas)>=1; } /// -/// @brief Determines if mouse cursor is rendering. @tsexample // Is cursor rendering? if(Canvas.isCursorShown()) echo(\"Canvas cursor is rendering\"); @endtsexample @return Returns true if the cursor is rendering.) +/// @brief Determines if mouse cursor is rendering. +/// +/// @tsexample +/// // Is cursor rendering? +/// if(Canvas.isCursorShown()) +/// echo(\"Canvas cursor is rendering\"); +/// @endtsexample +/// @return Returns true if the cursor is rendering.) +/// /// public bool fnGuiCanvas_isCursorShown (string guicanvas) @@ -20376,7 +25541,14 @@ public bool fnGuiCanvas_isCursorShown (string guicanvas) return SafeNativeMethods.mwle_fnGuiCanvas_isCursorShown(sbguicanvas)>=1; } /// -/// @brief This turns on/off front-buffer rendering. @param enable True if all rendering should be done to the front buffer @tsexample Canvas.renderFront(false); @endtsexample) +/// @brief This turns on/off front-buffer rendering. +/// +/// @param enable True if all rendering should be done to the front buffer +/// +/// @tsexample +/// Canvas.renderFront(false); +/// @endtsexample) +/// /// public void fnGuiCanvas_renderFront (string guicanvas, bool enable) @@ -20390,7 +25562,15 @@ public void fnGuiCanvas_renderFront (string guicanvas, bool enable) SafeNativeMethods.mwle_fnGuiCanvas_renderFront(sbguicanvas, enable); } /// -/// @brief Force canvas to redraw. If the elapsed time is greater than the time since the last paint then the repaint will be skipped. @param elapsedMS The optional elapsed time in milliseconds. @tsexample Canvas.repaint(); @endtsexample) +/// @brief Force canvas to redraw. +/// If the elapsed time is greater than the time since the last paint +/// then the repaint will be skipped. +/// @param elapsedMS The optional elapsed time in milliseconds. +/// +/// @tsexample +/// Canvas.repaint(); +/// @endtsexample) +/// /// public void fnGuiCanvas_repaint (string guicanvas, int elapsedMS) @@ -20404,7 +25584,12 @@ public void fnGuiCanvas_repaint (string guicanvas, int elapsedMS) SafeNativeMethods.mwle_fnGuiCanvas_repaint(sbguicanvas, elapsedMS); } /// -/// @brief Reset the update regions for the canvas. @tsexample Canvas.reset(); @endtsexample) +/// @brief Reset the update regions for the canvas. +/// +/// @tsexample +/// Canvas.reset(); +/// @endtsexample) +/// /// public void fnGuiCanvas_reset (string guicanvas) @@ -20418,7 +25603,10 @@ public void fnGuiCanvas_reset (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_reset(sbguicanvas); } /// -/// Translate a coordinate from screen-space to canvas window-space. @param coordinate The coordinate in screen-space. @return The given coordinate translated to window-space. ) +/// Translate a coordinate from screen-space to canvas window-space. +/// @param coordinate The coordinate in screen-space. +/// @return The given coordinate translated to window-space. ) +/// /// public string fnGuiCanvas_screenToClient (string guicanvas, string coordinate) @@ -20438,7 +25626,14 @@ public string fnGuiCanvas_screenToClient (string guicanvas, string coordinate) } /// -/// @brief Set the content of the canvas to a specified control. @param ctrl ID or name of GuiControl to set content to @tsexample Canvas.setContent(PlayGui); @endtsexample) +/// @brief Set the content of the canvas to a specified control. +/// +/// @param ctrl ID or name of GuiControl to set content to +/// +/// @tsexample +/// Canvas.setContent(PlayGui); +/// @endtsexample) +/// /// public void fnGuiCanvas_setContent (string guicanvas, string ctrl) @@ -20455,7 +25650,14 @@ public void fnGuiCanvas_setContent (string guicanvas, string ctrl) SafeNativeMethods.mwle_fnGuiCanvas_setContent(sbguicanvas, sbctrl); } /// -/// @brief Sets the cursor for the canvas. @param cursor Name of the GuiCursor to use @tsexample Canvas.setCursor(\"DefaultCursor\"); @endtsexample) +/// @brief Sets the cursor for the canvas. +/// +/// @param cursor Name of the GuiCursor to use +/// +/// @tsexample +/// Canvas.setCursor(\"DefaultCursor\"); +/// @endtsexample) +/// /// public void fnGuiCanvas_setCursor (string guicanvas, string cursor) @@ -20473,6 +25675,7 @@ public void fnGuiCanvas_setCursor (string guicanvas, string cursor) } /// /// (bool shown) - Enabled when a context menu/popup menu is shown.) +/// /// public void fnGuiCanvas_setPopupShown (string guicanvas, bool shown) @@ -20486,7 +25689,9 @@ public void fnGuiCanvas_setPopupShown (string guicanvas, bool shown) SafeNativeMethods.mwle_fnGuiCanvas_setPopupShown(sbguicanvas, shown); } /// -/// Set the position of the platform window associated with the canvas. @param position The new position of the window in screen-space. ) +/// Set the position of the platform window associated with the canvas. +/// @param position The new position of the window in screen-space. ) +/// /// public void fnGuiCanvas_setWindowPosition (string guicanvas, string position) @@ -20503,7 +25708,14 @@ public void fnGuiCanvas_setWindowPosition (string guicanvas, string position) SafeNativeMethods.mwle_fnGuiCanvas_setWindowPosition(sbguicanvas, sbposition); } /// -/// @brief Change the title of the OS window. @param newTitle String containing the new name @tsexample Canvas.setWindowTitle(\"Documentation Rocks!\"); @endtsexample) +/// @brief Change the title of the OS window. +/// +/// @param newTitle String containing the new name +/// +/// @tsexample +/// Canvas.setWindowTitle(\"Documentation Rocks!\"); +/// @endtsexample) +/// /// public void fnGuiCanvas_setWindowTitle (string guicanvas, string newTitle) @@ -20520,7 +25732,12 @@ public void fnGuiCanvas_setWindowTitle (string guicanvas, string newTitle) SafeNativeMethods.mwle_fnGuiCanvas_setWindowTitle(sbguicanvas, sbnewTitle); } /// -/// @brief Enable rendering of the cursor. @tsexample Canvas.showCursor(); @endtsexample) +/// @brief Enable rendering of the cursor. +/// +/// @tsexample +/// Canvas.showCursor(); +/// @endtsexample) +/// /// public void fnGuiCanvas_showCursor (string guicanvas) @@ -20534,7 +25751,28 @@ public void fnGuiCanvas_showCursor (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_showCursor(sbguicanvas); } /// -/// @brief toggle canvas from fullscreen to windowed mode or back. @tsexample // If we are in windowed mode, the following will put is in fullscreen Canvas.toggleFullscreen(); @endtsexample) +/// ( GuiCanvas, showWindow, void, 2, 2, ) +/// +/// + +public void fnGuiCanvas_showWindow (string guicanvas) +{ +if(Debugging) +System.Console.WriteLine("----------------->Extern Call 'fnGuiCanvas_showWindow'" + string.Format("\"{0}\" ",guicanvas)); +StringBuilder sbguicanvas = null; +if (guicanvas != null) + sbguicanvas = new StringBuilder(guicanvas, 1024); + +SafeNativeMethods.mwle_fnGuiCanvas_showWindow(sbguicanvas); +} +/// +/// @brief toggle canvas from fullscreen to windowed mode or back. +/// +/// @tsexample +/// // If we are in windowed mode, the following will put is in fullscreen +/// Canvas.toggleFullscreen(); +/// @endtsexample) +/// /// public void fnGuiCanvas_toggleFullscreen (string guicanvas) @@ -20548,7 +25786,9 @@ public void fnGuiCanvas_toggleFullscreen (string guicanvas) SafeNativeMethods.mwle_fnGuiCanvas_toggleFullscreen(sbguicanvas); } /// -/// Test whether the checkbox is currently checked. @return True if the checkbox is currently ticked, false otherwise. ) +/// Test whether the checkbox is currently checked. +/// @return True if the checkbox is currently ticked, false otherwise. ) +/// /// public bool fnGuiCheckBoxCtrl_isStateOn (string guicheckboxctrl) @@ -20562,7 +25802,11 @@ public bool fnGuiCheckBoxCtrl_isStateOn (string guicheckboxctrl) return SafeNativeMethods.mwle_fnGuiCheckBoxCtrl_isStateOn(sbguicheckboxctrl)>=1; } /// -/// Set whether the checkbox is ticked or not. @param newState If true the box will be checked, if false, it will be unchecked. @note This method will @b not trigger the command associated with the control. To toggle the checkbox state as if the user had clicked the control, use performClick(). ) +/// Set whether the checkbox is ticked or not. +/// @param newState If true the box will be checked, if false, it will be unchecked. +/// @note This method will @b not trigger the command associated with the control. To toggle the +/// checkbox state as if the user had clicked the control, use performClick(). ) +/// /// public void fnGuiCheckBoxCtrl_setStateOn (string guicheckboxctrl, bool newState) @@ -20576,7 +25820,12 @@ public void fnGuiCheckBoxCtrl_setStateOn (string guicheckboxctrl, bool newState) SafeNativeMethods.mwle_fnGuiCheckBoxCtrl_setStateOn(sbguicheckboxctrl, newState); } /// -/// @brief Set the image rendered in this control. @param filename The image name you want to set @tsexample ChunkedBitmap.setBitmap(\"images/background.png\"); @endtsexample) +/// @brief Set the image rendered in this control. +/// @param filename The image name you want to set +/// @tsexample +/// ChunkedBitmap.setBitmap(\"images/background.png\"); +/// @endtsexample) +/// /// public void fnGuiChunkedBitmapCtrl_setBitmap (string guichunkedbitmapctrl, string filename) @@ -20593,7 +25842,14 @@ public void fnGuiChunkedBitmapCtrl_setBitmap (string guichunkedbitmapctrl, strin SafeNativeMethods.mwle_fnGuiChunkedBitmapCtrl_setBitmap(sbguichunkedbitmapctrl, sbfilename); } /// -/// Returns the current time, in seconds. @return timeInseconds Current time, in seconds @tsexample // Get the current time from the GuiClockHud control %timeInSeconds = %guiClockHud.getTime(); @endtsexample ) +/// Returns the current time, in seconds. +/// @return timeInseconds Current time, in seconds +/// @tsexample +/// // Get the current time from the GuiClockHud control +/// %timeInSeconds = %guiClockHud.getTime(); +/// @endtsexample +/// ) +/// /// public float fnGuiClockHud_getTime (string guiclockhud) @@ -20607,7 +25863,12 @@ public float fnGuiClockHud_getTime (string guiclockhud) return SafeNativeMethods.mwle_fnGuiClockHud_getTime(sbguiclockhud); } /// -/// @brief Sets a time for a countdown clock. Setting the time like this will cause the clock to count backwards from the specified time. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @see setTime ) +/// @brief Sets a time for a countdown clock. +/// Setting the time like this will cause the clock to count backwards from the specified time. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @see setTime +/// ) +/// /// public void fnGuiClockHud_setReverseTime (string guiclockhud, float timeInSeconds) @@ -20621,7 +25882,16 @@ public void fnGuiClockHud_setReverseTime (string guiclockhud, float timeInSecond SafeNativeMethods.mwle_fnGuiClockHud_setReverseTime(sbguiclockhud, timeInSeconds); } /// -/// Sets the current base time for the clock. @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) @tsexample // Define the time, in seconds %timeInSeconds = 120; // Change the time on the GuiClockHud control %guiClockHud.setTime(%timeInSeconds); @endtsexample ) +/// Sets the current base time for the clock. +/// @param timeInSeconds Time to set the clock, in seconds (IE: 00:02 would be 120) +/// @tsexample +/// // Define the time, in seconds +/// %timeInSeconds = 120; +/// // Change the time on the GuiClockHud control +/// %guiClockHud.setTime(%timeInSeconds); +/// @endtsexample +/// ) +/// /// public void fnGuiClockHud_setTime (string guiclockhud, float timeInSeconds) @@ -20635,7 +25905,13 @@ public void fnGuiClockHud_setTime (string guiclockhud, float timeInSeconds) SafeNativeMethods.mwle_fnGuiClockHud_setTime(sbguiclockhud, timeInSeconds); } /// -/// Add the given control as a child to this control. This is synonymous to calling SimGroup::addObject. @param control The control to add as a child. @note The control will retain its current position and size. @see SimGroup::addObject @ref GuiControl_Hierarchy ) +/// Add the given control as a child to this control. +/// This is synonymous to calling SimGroup::addObject. +/// @param control The control to add as a child. +/// @note The control will retain its current position and size. +/// @see SimGroup::addObject +/// @ref GuiControl_Hierarchy ) +/// /// public void fnGuiControl_addGuiControl (string guicontrol, string control) @@ -20653,6 +25929,7 @@ public void fnGuiControl_addGuiControl (string guicontrol, string control) } /// /// Returns if the control's background color can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextBackColor (string guicontrol) @@ -20667,6 +25944,7 @@ public bool fnGuiControl_canChangeContextBackColor (string guicontrol) } /// /// Returns if the control's fill color can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextFillColor (string guicontrol) @@ -20681,6 +25959,7 @@ public bool fnGuiControl_canChangeContextFillColor (string guicontrol) } /// /// Returns if the control's font color can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextFontColor (string guicontrol) @@ -20695,6 +25974,7 @@ public bool fnGuiControl_canChangeContextFontColor (string guicontrol) } /// /// Returns if the control's font size can be changed in the game or not. ) +/// /// public bool fnGuiControl_canChangeContextFontSize (string guicontrol) @@ -20709,6 +25989,7 @@ public bool fnGuiControl_canChangeContextFontSize (string guicontrol) } /// /// Returns if the control's window settings can be changed in the game or not. ) +/// /// public bool fnGuiControl_canShowContextWindowSettings (string guicontrol) @@ -20722,7 +26003,9 @@ public bool fnGuiControl_canShowContextWindowSettings (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_canShowContextWindowSettings(sbguicontrol)>=1; } /// -/// Clear this control from being the first responder in its hierarchy chain. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Clear this control from being the first responder in its hierarchy chain. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void fnGuiControl_clearFirstResponder (string guicontrol, bool ignored) @@ -20736,7 +26019,10 @@ public void fnGuiControl_clearFirstResponder (string guicontrol, bool ignored) SafeNativeMethods.mwle_fnGuiControl_clearFirstResponder(sbguicontrol, ignored); } /// -/// Test whether the given control is a direct or indirect child to this control. @param control The potential child control. @return True if the given control is a direct or indirect child to this control. ) +/// Test whether the given control is a direct or indirect child to this control. +/// @param control The potential child control. +/// @return True if the given control is a direct or indirect child to this control. ) +/// /// public bool fnGuiControl_controlIsChild (string guicontrol, string control) @@ -20753,7 +26039,10 @@ public bool fnGuiControl_controlIsChild (string guicontrol, string control) return SafeNativeMethods.mwle_fnGuiControl_controlIsChild(sbguicontrol, sbcontrol)>=1; } /// -/// Test whether the given control is a sibling of this control. @param control The potential sibling control. @return True if the given control is a sibling of this control. ) +/// Test whether the given control is a sibling of this control. +/// @param control The potential sibling control. +/// @return True if the given control is a sibling of this control. ) +/// /// public bool fnGuiControl_controlIsSibling (string guicontrol, string control) @@ -20770,7 +26059,14 @@ public bool fnGuiControl_controlIsSibling (string guicontrol, string control) return SafeNativeMethods.mwle_fnGuiControl_controlIsSibling(sbguicontrol, sbcontrol)>=1; } /// -/// Find the topmost child control located at the given coordinates. @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. @param x The X coordinate in the control's own coordinate space. @param y The Y coordinate in the control's own coordinate space. @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. @see GuiControlProfile::modal @see findHitControls ) +/// Find the topmost child control located at the given coordinates. +/// @note Only children that are both visible and have the 'modal' flag set in their profile will be considered in the search. +/// @param x The X coordinate in the control's own coordinate space. +/// @param y The Y coordinate in the control's own coordinate space. +/// @return The topmost child control at the given coordintes or the control on which the method was called if no matching child could be found. +/// @see GuiControlProfile::modal +/// @see findHitControls ) +/// /// public string fnGuiControl_findHitControl (string guicontrol, int x, int y) @@ -20787,7 +26083,20 @@ public string fnGuiControl_findHitControl (string guicontrol, int x, int y) } /// -/// Find all visible child controls that intersect with the given rectangle. @note Invisible child controls will not be included in the search. @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. @param width The width of the search rectangle in pixels. @param height The height of the search rectangle in pixels. @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. @tsexample // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) %ctrl.setLocked( true ); @endtsexample @see findHitControl ) +/// Find all visible child controls that intersect with the given rectangle. +/// @note Invisible child controls will not be included in the search. +/// @param x The X coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param y The Y coordinate of the rectangle's upper left corner in the control's own coordinate space. +/// @param width The width of the search rectangle in pixels. +/// @param height The height of the search rectangle in pixels. +/// @return A space-separated list of the IDs of all visible control objects intersecting the given rectangle. +/// @tsexample +/// // Lock all controls in the rectangle at x=10 and y=10 and the extent width=100 and height=100. +/// foreach$( %ctrl in %this.findHitControls( 10, 10, 100, 100 ) ) +/// %ctrl.setLocked( true ); +/// @endtsexample +/// @see findHitControl ) +/// /// public string fnGuiControl_findHitControls (string guicontrol, int x, int y, int width, int height) @@ -20805,6 +26114,7 @@ public string fnGuiControl_findHitControls (string guicontrol, int x, int y, int } /// /// Get the alpha fade time for the object. ) +/// /// public int fnGuiControl_getAlphaFadeTime (string guicontrol) @@ -20819,6 +26129,7 @@ public int fnGuiControl_getAlphaFadeTime (string guicontrol) } /// /// Get the alpha for the object. ) +/// /// public float fnGuiControl_getAlphaValue (string guicontrol) @@ -20832,7 +26143,10 @@ public float fnGuiControl_getAlphaValue (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_getAlphaValue(sbguicontrol); } /// -/// Get the aspect ratio of the control's extents. @return The width of the control divided by its height. @see getExtent ) +/// Get the aspect ratio of the control's extents. +/// @return The width of the control divided by its height. +/// @see getExtent ) +/// /// public float fnGuiControl_getAspect (string guicontrol) @@ -20846,7 +26160,9 @@ public float fnGuiControl_getAspect (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_getAspect(sbguicontrol); } /// -/// Get the coordinate of the control's center point relative to its parent. @return The coordinate of the control's center point in parent-relative coordinates. ) +/// Get the coordinate of the control's center point relative to its parent. +/// @return The coordinate of the control's center point in parent-relative coordinates. ) +/// /// public string fnGuiControl_getCenter (string guicontrol) @@ -20864,6 +26180,7 @@ public string fnGuiControl_getCenter (string guicontrol) } /// /// Sets the font size of a control. ) +/// /// public int fnGuiControl_getControlFontSize (string guicontrol) @@ -20878,6 +26195,7 @@ public int fnGuiControl_getControlFontSize (string guicontrol) } /// /// Returns if the control is locked or not. ) +/// /// public bool fnGuiControl_getControlLock (string guicontrol) @@ -20892,6 +26210,7 @@ public bool fnGuiControl_getControlLock (string guicontrol) } /// /// Returns the filename of the texture of the control. ) +/// /// public string fnGuiControl_getControlTextureFile (string guicontrol) @@ -20908,7 +26227,9 @@ public string fnGuiControl_getControlTextureFile (string guicontrol) } /// -/// Get the width and height of the control. @return A point structure containing the width of the control in x and the height in y. ) +/// Get the width and height of the control. +/// @return A point structure containing the width of the control in x and the height in y. ) +/// /// public string fnGuiControl_getExtent (string guicontrol) @@ -20925,7 +26246,13 @@ public string fnGuiControl_getExtent (string guicontrol) } /// -/// Get the first responder set on this GuiControl tree. @return The first responder set on the control's subtree. @see isFirstResponder @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Get the first responder set on this GuiControl tree. +/// @return The first responder set on the control's subtree. +/// @see isFirstResponder +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public string fnGuiControl_getFirstResponder (string guicontrol) @@ -20942,7 +26269,9 @@ public string fnGuiControl_getFirstResponder (string guicontrol) } /// -/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. @Return the center coordinate of the control in root-relative coordinates. ) +/// Get the coordinate of the control's center point in coordinates relative to the root control in its control hierarchy. +/// @Return the center coordinate of the control in root-relative coordinates. ) +/// /// public string fnGuiControl_getGlobalCenter (string guicontrol) @@ -20959,7 +26288,9 @@ public string fnGuiControl_getGlobalCenter (string guicontrol) } /// -/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. @return The control's current position in root-relative coordinates. ) +/// Get the position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @return The control's current position in root-relative coordinates. ) +/// /// public string fnGuiControl_getGlobalPosition (string guicontrol) @@ -20976,7 +26307,10 @@ public string fnGuiControl_getGlobalPosition (string guicontrol) } /// -/// Get the maximum allowed size of the control. @return The maximum size to which the control can be shrunk. @see maxExtent ) +/// Get the maximum allowed size of the control. +/// @return The maximum size to which the control can be shrunk. +/// @see maxExtent ) +/// /// public string fnGuiControl_getMaxExtent (string guicontrol) @@ -20993,7 +26327,10 @@ public string fnGuiControl_getMaxExtent (string guicontrol) } /// -/// Get the minimum allowed size of the control. @return The minimum size to which the control can be shrunk. @see minExtent ) +/// Get the minimum allowed size of the control. +/// @return The minimum size to which the control can be shrunk. +/// @see minExtent ) +/// /// public string fnGuiControl_getMinExtent (string guicontrol) @@ -21011,6 +26348,7 @@ public string fnGuiControl_getMinExtent (string guicontrol) } /// /// Get the mouse over alpha for the object. ) +/// /// public float fnGuiControl_getMouseOverAlphaValue (string guicontrol) @@ -21024,7 +26362,9 @@ public float fnGuiControl_getMouseOverAlphaValue (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_getMouseOverAlphaValue(sbguicontrol); } /// -/// Get the immediate parent control of the control. @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// Get the immediate parent control of the control. +/// @return The immediate parent GuiControl or 0 if the control is not parented to a GuiControl. ) +/// /// public string fnGuiControl_getParent (string guicontrol) @@ -21041,7 +26381,9 @@ public string fnGuiControl_getParent (string guicontrol) } /// -/// Get the control's current position relative to its parent. @return The coordinate of the control in its parent's coordinate space. ) +/// Get the control's current position relative to its parent. +/// @return The coordinate of the control in its parent's coordinate space. ) +/// /// public string fnGuiControl_getPosition (string guicontrol) @@ -21058,7 +26400,10 @@ public string fnGuiControl_getPosition (string guicontrol) } /// -/// Get the canvas on which the control is placed. @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. @see GuiControl_Hierarchy ) +/// Get the canvas on which the control is placed. +/// @return The canvas on which the control's hierarchy is currently placed or 0 if the control is not currently placed on a GuiCanvas. +/// @see GuiControl_Hierarchy ) +/// /// public string fnGuiControl_getRoot (string guicontrol) @@ -21076,6 +26421,7 @@ public string fnGuiControl_getRoot (string guicontrol) } /// /// Get root control ) +/// /// public string fnGuiControl_getRootControl (string guicontrol) @@ -21092,7 +26438,11 @@ public string fnGuiControl_getRootControl (string guicontrol) } /// -/// Test whether the control is currently awake. If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. @return True if the control is awake. @ref GuiControl_Waking ) +/// Test whether the control is currently awake. +/// If a control is awake it means that it is part of the GuiControl hierarchy of a GuiCanvas. +/// @return True if the control is awake. +/// @ref GuiControl_Waking ) +/// /// public bool fnGuiControl_isAwake (string guicontrol) @@ -21107,6 +26457,7 @@ public bool fnGuiControl_isAwake (string guicontrol) } /// /// Returns if the control's alpha value can be changed in the game or not. ) +/// /// public bool fnGuiControl_isContextAlphaEnabled (string guicontrol) @@ -21121,6 +26472,7 @@ public bool fnGuiControl_isContextAlphaEnabled (string guicontrol) } /// /// Returns if the control's alpha fade value can be changed in the game or not. ) +/// /// public bool fnGuiControl_isContextAlphaFadeEnabled (string guicontrol) @@ -21135,6 +26487,7 @@ public bool fnGuiControl_isContextAlphaFadeEnabled (string guicontrol) } /// /// Returns if the control can be locked in the game or not. ) +/// /// public bool fnGuiControl_isContextLockable (string guicontrol) @@ -21149,6 +26502,7 @@ public bool fnGuiControl_isContextLockable (string guicontrol) } /// /// Returns if the control's mouse-over alpha value can be changed in the game or not. ) +/// /// public bool fnGuiControl_isContextMouseOverAlphaEnabled (string guicontrol) @@ -21163,6 +26517,7 @@ public bool fnGuiControl_isContextMouseOverAlphaEnabled (string guicontrol) } /// /// Returns if the control can be moved in the game or not. ) +/// /// public bool fnGuiControl_isContextMovable (string guicontrol) @@ -21176,7 +26531,12 @@ public bool fnGuiControl_isContextMovable (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isContextMovable(sbguicontrol)>=1; } /// -/// Test whether the control is the current first responder. @return True if the control is the current first responder. @see makeFirstResponder @see setFirstResponder @ref GuiControl_FirstResponders ) +/// Test whether the control is the current first responder. +/// @return True if the control is the current first responder. +/// @see makeFirstResponder +/// @see setFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public bool fnGuiControl_isFirstResponder (string guicontrol) @@ -21190,7 +26550,9 @@ public bool fnGuiControl_isFirstResponder (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isFirstResponder(sbguicontrol)>=1; } /// -/// Indicates if the mouse is locked in this control. @return True if the mouse is currently locked. ) +/// Indicates if the mouse is locked in this control. +/// @return True if the mouse is currently locked. ) +/// /// public bool fnGuiControl_isMouseLocked (string guicontrol) @@ -21204,7 +26566,12 @@ public bool fnGuiControl_isMouseLocked (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isMouseLocked(sbguicontrol)>=1; } /// -/// Test whether the control is currently set to be visible. @return True if the control is currently set to be visible. @note This method does not tell anything about whether the control is actually visible to the user at the moment. @ref GuiControl_VisibleActive ) +/// Test whether the control is currently set to be visible. +/// @return True if the control is currently set to be visible. +/// @note This method does not tell anything about whether the control is actually visible to +/// the user at the moment. +/// @ref GuiControl_VisibleActive ) +/// /// public bool fnGuiControl_isVisible (string guicontrol) @@ -21218,7 +26585,13 @@ public bool fnGuiControl_isVisible (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_isVisible(sbguicontrol)>=1; } /// -/// Test whether the given point lies within the rectangle of the control. @param x X coordinate of the point in parent-relative coordinates. @param y Y coordinate of the point in parent-relative coordinates. @return True if the point is within the control, false if not. @see getExtent @see getPosition ) +/// Test whether the given point lies within the rectangle of the control. +/// @param x X coordinate of the point in parent-relative coordinates. +/// @param y Y coordinate of the point in parent-relative coordinates. +/// @return True if the point is within the control, false if not. +/// @see getExtent +/// @see getPosition ) +/// /// public bool fnGuiControl_pointInControl (string guicontrol, int x, int y) @@ -21247,7 +26620,9 @@ public void fnGuiControl_refresh (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_refresh(sbguicontrol); } /// -/// Removes the plus cursor. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Removes the plus cursor. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void fnGuiControl_resetCur (string guicontrol) @@ -21261,7 +26636,13 @@ public void fnGuiControl_resetCur (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_resetCur(sbguicontrol); } /// -/// Resize and reposition the control using the give coordinates and dimensions. Child controls will resize according to their layout behaviors. @param x The new X coordinate of the control in its parent's coordinate space. @param y The new Y coordinate of the control in its parent's coordinate space. @param width The new width to which the control should be resized. @param height The new height to which the control should be resized. ) +/// Resize and reposition the control using the give coordinates and dimensions. Child controls +/// will resize according to their layout behaviors. +/// @param x The new X coordinate of the control in its parent's coordinate space. +/// @param y The new Y coordinate of the control in its parent's coordinate space. +/// @param width The new width to which the control should be resized. +/// @param height The new height to which the control should be resized. ) +/// /// public void fnGuiControl_resize (string guicontrol, int x, int y, int width, int height) @@ -21276,6 +26657,7 @@ public void fnGuiControl_resize (string guicontrol, int x, int y, int width, int } /// /// ) +/// /// public void fnGuiControl_setActive (string guicontrol, bool state) @@ -21289,7 +26671,9 @@ public void fnGuiControl_setActive (string guicontrol, bool state) SafeNativeMethods.mwle_fnGuiControl_setActive(sbguicontrol, state); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void fnGuiControl_setAlphaFadeTime (string guicontrol, int fadeTime) @@ -21303,7 +26687,9 @@ public void fnGuiControl_setAlphaFadeTime (string guicontrol, int fadeTime) SafeNativeMethods.mwle_fnGuiControl_setAlphaFadeTime(sbguicontrol, fadeTime); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void fnGuiControl_setAlphaValue (string guicontrol, float alpha) @@ -21317,7 +26703,10 @@ public void fnGuiControl_setAlphaValue (string guicontrol, float alpha) SafeNativeMethods.mwle_fnGuiControl_setAlphaValue(sbguicontrol, alpha); } /// -/// Set the control's position by its center point. @param x The X coordinate of the new center point of the control relative to the control's parent. @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// Set the control's position by its center point. +/// @param x The X coordinate of the new center point of the control relative to the control's parent. +/// @param y The Y coordinate of the new center point of the control relative to the control's parent. ) +/// /// public void fnGuiControl_setCenter (string guicontrol, int x, int y) @@ -21332,6 +26721,7 @@ public void fnGuiControl_setCenter (string guicontrol, int x, int y) } /// /// Displays the option to set the alpha of the control in the game when true. ) +/// /// public void fnGuiControl_setContextAlpha (string guicontrol, bool alpha) @@ -21346,6 +26736,7 @@ public void fnGuiControl_setContextAlpha (string guicontrol, bool alpha) } /// /// Displays the option to set the alpha fade value of the control in the game when true. ) +/// /// public void fnGuiControl_setContextAlphaFade (string guicontrol, bool fade) @@ -21360,6 +26751,7 @@ public void fnGuiControl_setContextAlphaFade (string guicontrol, bool fade) } /// /// Displays the option to set the background color of the control in the game when true. ) +/// /// public void fnGuiControl_setContextBackColor (string guicontrol, bool backColor) @@ -21374,6 +26766,7 @@ public void fnGuiControl_setContextBackColor (string guicontrol, bool backColor) } /// /// Displays the option to set the fill color of the control in the game when true. ) +/// /// public void fnGuiControl_setContextFillColor (string guicontrol, bool fillColor) @@ -21388,6 +26781,7 @@ public void fnGuiControl_setContextFillColor (string guicontrol, bool fillColor) } /// /// Displays the option to set the font color of the control in the game when true. ) +/// /// public void fnGuiControl_setContextFontColor (string guicontrol, bool fontColor) @@ -21402,6 +26796,7 @@ public void fnGuiControl_setContextFontColor (string guicontrol, bool fontColor) } /// /// Displays the option to set the font size of the control in the game when true. ) +/// /// public void fnGuiControl_setContextFontSize (string guicontrol, bool fontSize) @@ -21416,6 +26811,7 @@ public void fnGuiControl_setContextFontSize (string guicontrol, bool fontSize) } /// /// Displays the option to lock the control in the game when true. ) +/// /// public void fnGuiControl_setContextLockControl (string guicontrol, bool lockx) @@ -21430,6 +26826,7 @@ public void fnGuiControl_setContextLockControl (string guicontrol, bool lockx) } /// /// Displays the option to set the mouse-over alpha of the control in the game when true. ) +/// /// public void fnGuiControl_setContextMouseOverAlpha (string guicontrol, bool mouseOver) @@ -21444,6 +26841,7 @@ public void fnGuiControl_setContextMouseOverAlpha (string guicontrol, bool mouse } /// /// Displays the option to move the control in the game when true. ) +/// /// public void fnGuiControl_setContextMoveControl (string guicontrol, bool move) @@ -21458,6 +26856,7 @@ public void fnGuiControl_setContextMoveControl (string guicontrol, bool move) } /// /// Set control background color. ) +/// /// public void fnGuiControl_setControlBackgroundColor (string guicontrol, string color) @@ -21475,6 +26874,7 @@ public void fnGuiControl_setControlBackgroundColor (string guicontrol, string co } /// /// Set control fill color. ) +/// /// public void fnGuiControl_setControlFillColor (string guicontrol, string color) @@ -21492,6 +26892,7 @@ public void fnGuiControl_setControlFillColor (string guicontrol, string color) } /// /// Set control font color. ) +/// /// public void fnGuiControl_setControlFontColor (string guicontrol, string color) @@ -21509,6 +26910,7 @@ public void fnGuiControl_setControlFontColor (string guicontrol, string color) } /// /// Sets the font size of a control. ) +/// /// public void fnGuiControl_setControlFontSize (string guicontrol, int fontSize) @@ -21523,6 +26925,7 @@ public void fnGuiControl_setControlFontSize (string guicontrol, int fontSize) } /// /// Lock the control. ) +/// /// public void fnGuiControl_setControlLock (string guicontrol, bool lockedx) @@ -21537,6 +26940,7 @@ public void fnGuiControl_setControlLock (string guicontrol, bool lockedx) } /// /// Set control texture. ) +/// /// public void fnGuiControl_setControlTexture (string guicontrol, string fileName) @@ -21553,7 +26957,9 @@ public void fnGuiControl_setControlTexture (string guicontrol, string fileName) SafeNativeMethods.mwle_fnGuiControl_setControlTexture(sbguicontrol, sbfileName); } /// -/// Sets the cursor as a plus. @param ignored Ignored. Supported for backwards-compatibility. ) +/// Sets the cursor as a plus. +/// @param ignored Ignored. Supported for backwards-compatibility. ) +/// /// public void fnGuiControl_setCur (string guicontrol) @@ -21567,7 +26973,12 @@ public void fnGuiControl_setCur (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_setCur(sbguicontrol); } /// -/// Make this control the current first responder. @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. @see GuiControlProfile::canKeyFocus @see isFirstResponder @ref GuiControl_FirstResponders ) +/// Make this control the current first responder. +/// @note Only controls with a profile that has canKeyFocus enabled are able to become first responders. +/// @see GuiControlProfile::canKeyFocus +/// @see isFirstResponder +/// @ref GuiControl_FirstResponders ) +/// /// public void fnGuiControl_setFirstResponder (string guicontrol) @@ -21581,7 +26992,9 @@ public void fnGuiControl_setFirstResponder (string guicontrol) SafeNativeMethods.mwle_fnGuiControl_setFirstResponder(sbguicontrol); } /// -/// Set the alpha for the object. @param value Range 0, 1 for the transparency. ) +/// Set the alpha for the object. +/// @param value Range 0, 1 for the transparency. ) +/// /// public void fnGuiControl_setMouseOverAlphaValue (string guicontrol, float alpha) @@ -21595,7 +27008,10 @@ public void fnGuiControl_setMouseOverAlphaValue (string guicontrol, float alpha) SafeNativeMethods.mwle_fnGuiControl_setMouseOverAlphaValue(sbguicontrol, alpha); } /// -/// Position the control in the local space of the parent control. @param x The new X coordinate of the control relative to its parent's upper left corner. @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// Position the control in the local space of the parent control. +/// @param x The new X coordinate of the control relative to its parent's upper left corner. +/// @param y The new Y coordinate of the control relative to its parent's upper left corner. ) +/// /// public void fnGuiControl_setPosition (string guicontrol, int x, int y) @@ -21609,7 +27025,10 @@ public void fnGuiControl_setPosition (string guicontrol, int x, int y) SafeNativeMethods.mwle_fnGuiControl_setPosition(sbguicontrol, x, y); } /// -/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. @param x The new X coordinate of the control relative to the root's upper left corner. @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// Set position of the control relative to the root of the GuiControl hierarchy it is contained in. +/// @param x The new X coordinate of the control relative to the root's upper left corner. +/// @param y The new Y coordinate of the control relative to the root's upper left corner. ) +/// /// public void fnGuiControl_setPositionGlobal (string guicontrol, int x, int y) @@ -21623,7 +27042,11 @@ public void fnGuiControl_setPositionGlobal (string guicontrol, int x, int y) SafeNativeMethods.mwle_fnGuiControl_setPositionGlobal(sbguicontrol, x, y); } /// -/// Set the control profile for the control to use. The profile used by a control determines a great part of its behavior and appearance. @param profile The new profile the control should use. @ref GuiControl_Profiles ) +/// Set the control profile for the control to use. +/// The profile used by a control determines a great part of its behavior and appearance. +/// @param profile The new profile the control should use. +/// @ref GuiControl_Profiles ) +/// /// public void fnGuiControl_setProfile (string guicontrol, string profile) @@ -21641,6 +27064,7 @@ public void fnGuiControl_setProfile (string guicontrol, string profile) } /// /// Displays the option to set the window settings of the control in the game when true. ) +/// /// public void fnGuiControl_setShowContextWindowSettings (string guicontrol, bool lockx) @@ -21654,7 +27078,9 @@ public void fnGuiControl_setShowContextWindowSettings (string guicontrol, bool l SafeNativeMethods.mwle_fnGuiControl_setShowContextWindowSettings(sbguicontrol, lockx); } /// -/// Set the value associated with the control. @param value The new value for the control. ) +/// Set the value associated with the control. +/// @param value The new value for the control. ) +/// /// public void fnGuiControl_setValue (string guicontrol, string value) @@ -21671,7 +27097,10 @@ public void fnGuiControl_setValue (string guicontrol, string value) SafeNativeMethods.mwle_fnGuiControl_setValue(sbguicontrol, sbvalue); } /// -/// Set whether the control is visible or not. @param state The new visiblity flag state for the control. @ref GuiControl_VisibleActive ) +/// Set whether the control is visible or not. +/// @param state The new visiblity flag state for the control. +/// @ref GuiControl_VisibleActive ) +/// /// public void fnGuiControl_setVisible (string guicontrol, bool state) @@ -21686,6 +27115,7 @@ public void fnGuiControl_setVisible (string guicontrol, bool state) } /// /// Returns true if the control is transparent. ) +/// /// public bool fnGuiControl_transparentControlCheck (string guicontrol) @@ -21699,7 +27129,9 @@ public bool fnGuiControl_transparentControlCheck (string guicontrol) return SafeNativeMethods.mwle_fnGuiControl_transparentControlCheck(sbguicontrol)>=1; } /// -/// Get the currently selected filename. @return The filename of the currently selected file ) +/// Get the currently selected filename. +/// @return The filename of the currently selected file ) +/// /// public string fnGuiDirectoryFileListCtrl_getSelectedFile (string guidirectoryfilelistctrl) @@ -21716,7 +27148,9 @@ public string fnGuiDirectoryFileListCtrl_getSelectedFile (string guidirectoryfil } /// -/// Get the list of selected files. @return A space separated list of selected files ) +/// Get the list of selected files. +/// @return A space separated list of selected files ) +/// /// public string fnGuiDirectoryFileListCtrl_getSelectedFiles (string guidirectoryfilelistctrl) @@ -21734,6 +27168,7 @@ public string fnGuiDirectoryFileListCtrl_getSelectedFiles (string guidirectoryfi } /// /// Update the file list. ) +/// /// public void fnGuiDirectoryFileListCtrl_reload (string guidirectoryfilelistctrl) @@ -21747,7 +27182,9 @@ public void fnGuiDirectoryFileListCtrl_reload (string guidirectoryfilelistctrl) SafeNativeMethods.mwle_fnGuiDirectoryFileListCtrl_reload(sbguidirectoryfilelistctrl); } /// -/// Set the file filter. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the file filter. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public void fnGuiDirectoryFileListCtrl_setFilter (string guidirectoryfilelistctrl, string filter) @@ -21764,7 +27201,10 @@ public void fnGuiDirectoryFileListCtrl_setFilter (string guidirectoryfilelistctr SafeNativeMethods.mwle_fnGuiDirectoryFileListCtrl_setFilter(sbguidirectoryfilelistctrl, sbfilter); } /// -/// Set the search path and file filter. @param path Path in game directory from which to list files. @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// Set the search path and file filter. +/// @param path Path in game directory from which to list files. +/// @param filter Tab-delimited list of file name patterns. Only matched files will be displayed. ) +/// /// public bool fnGuiDirectoryFileListCtrl_setPath (string guidirectoryfilelistctrl, string path, string filter) @@ -21784,7 +27224,10 @@ public bool fnGuiDirectoryFileListCtrl_setPath (string guidirectoryfilelistctrl, return SafeNativeMethods.mwle_fnGuiDirectoryFileListCtrl_setPath(sbguidirectoryfilelistctrl, sbpath, sbfilter)>=1; } /// -/// Start the drag operation. @param x X coordinate for the mouse pointer offset which the drag control should position itself. @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// Start the drag operation. +/// @param x X coordinate for the mouse pointer offset which the drag control should position itself. +/// @param y Y coordinate for the mouse pointer offset which the drag control should position itself.) +/// /// public void fnGuiDragAndDropControl_startDragging (string guidraganddropcontrol, int x, int y) @@ -21799,6 +27242,7 @@ public void fnGuiDragAndDropControl_startDragging (string guidraganddropcontrol, } /// /// Recalculates the position and size of this control and all its children. ) +/// /// public void fnGuiDynamicCtrlArrayControl_refresh (string guidynamicctrlarraycontrol) @@ -21813,6 +27257,7 @@ public void fnGuiDynamicCtrlArrayControl_refresh (string guidynamicctrlarraycont } /// /// Gets the set of GUI controls currently selected in the editor. ) +/// /// public string fnGuiEditCtrl_getSelection (string guieditctrl) @@ -21830,6 +27275,7 @@ public string fnGuiEditCtrl_getSelection (string guieditctrl) } /// /// Gets the GUI controls(s) that are currently in the trash.) +/// /// public string fnGuiEditCtrl_getTrash (string guieditctrl) @@ -21846,7 +27292,10 @@ public string fnGuiEditCtrl_getTrash (string guieditctrl) } /// -/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) Reset the filter to use the specified points, spread equidistantly across the domain. @internal) +/// ( GuiFilterCtrl, setValue, void, 3, 20, (f1, f2, ...) +/// Reset the filter to use the specified points, spread equidistantly across the domain. +/// @internal) +/// /// public void fnGuiFilterCtrl_setValue (string guifilterctrl, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -21914,15 +27363,11 @@ public void fnGuiFilterCtrl_setValue (string guifilterctrl, string a2, string a3 SafeNativeMethods.mwle_fnGuiFilterCtrl_setValue(sbguifilterctrl, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// Recalculates the position and size of this control and all its children. ) +/// Get the ID of this form's menu. +/// @return The ID of the form menu ) /// /// - -/// -/// Get the ID of this form's menu. @return The ID of the form menu ) -/// - public int fnGuiFormCtrl_getMenuID (string guiformctrl) { if(Debugging) @@ -21934,7 +27379,9 @@ public int fnGuiFormCtrl_getMenuID (string guiformctrl) return SafeNativeMethods.mwle_fnGuiFormCtrl_getMenuID(sbguiformctrl); } /// -/// Sets the title of the form. @param caption Form caption ) +/// Sets the title of the form. +/// @param caption Form caption ) +/// /// public void fnGuiFormCtrl_setCaption (string guiformctrl, string caption) @@ -21952,6 +27399,7 @@ public void fnGuiFormCtrl_setCaption (string guiformctrl, string caption) } /// /// Add a new column. ) +/// /// public void fnGuiFrameSetCtrl_addColumn (string guiframesetctrl) @@ -21966,6 +27414,7 @@ public void fnGuiFrameSetCtrl_addColumn (string guiframesetctrl) } /// /// Add a new row. ) +/// /// public void fnGuiFrameSetCtrl_addRow (string guiframesetctrl) @@ -21979,7 +27428,11 @@ public void fnGuiFrameSetCtrl_addRow (string guiframesetctrl) SafeNativeMethods.mwle_fnGuiFrameSetCtrl_addRow(sbguiframesetctrl); } /// -/// dynamic ), Override the i>borderEnable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderEnable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void fnGuiFrameSetCtrl_frameBorder (string guiframesetctrl, int index, string state) @@ -21996,7 +27449,12 @@ public void fnGuiFrameSetCtrl_frameBorder (string guiframesetctrl, int index, st SafeNativeMethods.mwle_fnGuiFrameSetCtrl_frameBorder(sbguiframesetctrl, index, sbstate); } /// -/// Set the minimum width and height for the frame. It will not be possible for the user to resize the frame smaller than this. @param index Index of the frame to modify @param width Minimum width in pixels @param height Minimum height in pixels ) +/// Set the minimum width and height for the frame. It will not be possible +/// for the user to resize the frame smaller than this. +/// @param index Index of the frame to modify +/// @param width Minimum width in pixels +/// @param height Minimum height in pixels ) +/// /// public void fnGuiFrameSetCtrl_frameMinExtent (string guiframesetctrl, int index, int width, int height) @@ -22010,7 +27468,11 @@ public void fnGuiFrameSetCtrl_frameMinExtent (string guiframesetctrl, int index, SafeNativeMethods.mwle_fnGuiFrameSetCtrl_frameMinExtent(sbguiframesetctrl, index, width, height); } /// -/// dynamic ), Override the i>borderMovable/i> setting for this frame. @param index Index of the frame to modify @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// dynamic ), +/// Override the i>borderMovable/i> setting for this frame. +/// @param index Index of the frame to modify +/// @param state New borderEnable state: \"on\", \"off\" or \"dynamic\" ) +/// /// public void fnGuiFrameSetCtrl_frameMovable (string guiframesetctrl, int index, string state) @@ -22027,7 +27489,11 @@ public void fnGuiFrameSetCtrl_frameMovable (string guiframesetctrl, int index, s SafeNativeMethods.mwle_fnGuiFrameSetCtrl_frameMovable(sbguiframesetctrl, index, sbstate); } /// -/// Set the padding for this frame. Padding introduces blank space on the inside edge of the frame. @param index Index of the frame to modify @param padding Frame top, bottom, left, and right padding ) +/// Set the padding for this frame. Padding introduces blank space on the inside +/// edge of the frame. +/// @param index Index of the frame to modify +/// @param padding Frame top, bottom, left, and right padding ) +/// /// public void fnGuiFrameSetCtrl_framePadding (string guiframesetctrl, int index, string padding) @@ -22044,7 +27510,9 @@ public void fnGuiFrameSetCtrl_framePadding (string guiframesetctrl, int index, s SafeNativeMethods.mwle_fnGuiFrameSetCtrl_framePadding(sbguiframesetctrl, index, sbpadding); } /// -/// Get the number of columns. @return The number of columns ) +/// Get the number of columns. +/// @return The number of columns ) +/// /// public int fnGuiFrameSetCtrl_getColumnCount (string guiframesetctrl) @@ -22058,7 +27526,10 @@ public int fnGuiFrameSetCtrl_getColumnCount (string guiframesetctrl) return SafeNativeMethods.mwle_fnGuiFrameSetCtrl_getColumnCount(sbguiframesetctrl); } /// -/// Get the horizontal offset of a column. @param index Index of the column to query @return Column offset in pixels ) +/// Get the horizontal offset of a column. +/// @param index Index of the column to query +/// @return Column offset in pixels ) +/// /// public int fnGuiFrameSetCtrl_getColumnOffset (string guiframesetctrl, int index) @@ -22072,7 +27543,9 @@ public int fnGuiFrameSetCtrl_getColumnOffset (string guiframesetctrl, int index) return SafeNativeMethods.mwle_fnGuiFrameSetCtrl_getColumnOffset(sbguiframesetctrl, index); } /// -/// Get the padding for this frame. @param index Index of the frame to query ) +/// Get the padding for this frame. +/// @param index Index of the frame to query ) +/// /// public string fnGuiFrameSetCtrl_getFramePadding (string guiframesetctrl, int index) @@ -22089,7 +27562,9 @@ public string fnGuiFrameSetCtrl_getFramePadding (string guiframesetctrl, int ind } /// -/// Get the number of rows. @return The number of rows ) +/// Get the number of rows. +/// @return The number of rows ) +/// /// public int fnGuiFrameSetCtrl_getRowCount (string guiframesetctrl) @@ -22103,7 +27578,10 @@ public int fnGuiFrameSetCtrl_getRowCount (string guiframesetctrl) return SafeNativeMethods.mwle_fnGuiFrameSetCtrl_getRowCount(sbguiframesetctrl); } /// -/// Get the vertical offset of a row. @param index Index of the row to query @return Row offset in pixels ) +/// Get the vertical offset of a row. +/// @param index Index of the row to query +/// @return Row offset in pixels ) +/// /// public int fnGuiFrameSetCtrl_getRowOffset (string guiframesetctrl, int index) @@ -22118,6 +27596,7 @@ public int fnGuiFrameSetCtrl_getRowOffset (string guiframesetctrl, int index) } /// /// Remove the last (rightmost) column. ) +/// /// public void fnGuiFrameSetCtrl_removeColumn (string guiframesetctrl) @@ -22132,6 +27611,7 @@ public void fnGuiFrameSetCtrl_removeColumn (string guiframesetctrl) } /// /// Remove the last (bottom) row. ) +/// /// public void fnGuiFrameSetCtrl_removeRow (string guiframesetctrl) @@ -22145,7 +27625,12 @@ public void fnGuiFrameSetCtrl_removeRow (string guiframesetctrl) SafeNativeMethods.mwle_fnGuiFrameSetCtrl_removeRow(sbguiframesetctrl); } /// -/// Set the horizontal offset of a column. Note that column offsets must always be in increasing order, and therefore this offset must be between the offsets of the colunns either side. @param index Index of the column to modify @param offset New column offset ) +/// Set the horizontal offset of a column. +/// Note that column offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the colunns either side. +/// @param index Index of the column to modify +/// @param offset New column offset ) +/// /// public void fnGuiFrameSetCtrl_setColumnOffset (string guiframesetctrl, int index, int offset) @@ -22159,7 +27644,12 @@ public void fnGuiFrameSetCtrl_setColumnOffset (string guiframesetctrl, int index SafeNativeMethods.mwle_fnGuiFrameSetCtrl_setColumnOffset(sbguiframesetctrl, index, offset); } /// -/// Set the vertical offset of a row. Note that row offsets must always be in increasing order, and therefore this offset must be between the offsets of the rows either side. @param index Index of the row to modify @param offset New row offset ) +/// Set the vertical offset of a row. +/// Note that row offsets must always be in increasing order, and therefore +/// this offset must be between the offsets of the rows either side. +/// @param index Index of the row to modify +/// @param offset New row offset ) +/// /// public void fnGuiFrameSetCtrl_setRowOffset (string guiframesetctrl, int index, int offset) @@ -22174,6 +27664,7 @@ public void fnGuiFrameSetCtrl_setRowOffset (string guiframesetctrl, int index, i } /// /// Recalculates child control sizes. ) +/// /// public void fnGuiFrameSetCtrl_updateSizes (string guiframesetctrl) @@ -22188,6 +27679,7 @@ public void fnGuiFrameSetCtrl_updateSizes (string guiframesetctrl) } /// /// Activates the current row. The script callback of the current row will be called (if it has one). ) +/// /// public void fnGuiGameListMenuCtrl_activateRow (string guigamelistmenuctrl) @@ -22201,7 +27693,14 @@ public void fnGuiGameListMenuCtrl_activateRow (string guigamelistmenuctrl) SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_activateRow(sbguigamelistmenuctrl); } /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param useHighlightIcon [optional] Does this row use the highlight icon?. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param useHighlightIcon [optional] Does this row use the highlight icon?. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void fnGuiGameListMenuCtrl_addRow (string guigamelistmenuctrl, string label, string callback, int icon, int yPad, bool useHighlightIcon, bool enabled) @@ -22221,7 +27720,9 @@ public void fnGuiGameListMenuCtrl_addRow (string guigamelistmenuctrl, string lab SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_addRow(sbguigamelistmenuctrl, sblabel, sbcallback, icon, yPad, useHighlightIcon, enabled); } /// -/// Gets the number of rows on the control. @return (int) The number of rows on the control. ) +/// Gets the number of rows on the control. +/// @return (int) The number of rows on the control. ) +/// /// public int fnGuiGameListMenuCtrl_getRowCount (string guigamelistmenuctrl) @@ -22235,7 +27736,10 @@ public int fnGuiGameListMenuCtrl_getRowCount (string guigamelistmenuctrl) return SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_getRowCount(sbguigamelistmenuctrl); } /// -/// Gets the label displayed on the specified row. @param row Index of the row to get the label of. @return The label for the row. ) +/// Gets the label displayed on the specified row. +/// @param row Index of the row to get the label of. +/// @return The label for the row. ) +/// /// public string fnGuiGameListMenuCtrl_getRowLabel (string guigamelistmenuctrl, int row) @@ -22252,7 +27756,9 @@ public string fnGuiGameListMenuCtrl_getRowLabel (string guigamelistmenuctrl, int } /// -/// Gets the index of the currently selected row. @return Index of the selected row. ) +/// Gets the index of the currently selected row. +/// @return Index of the selected row. ) +/// /// public int fnGuiGameListMenuCtrl_getSelectedRow (string guigamelistmenuctrl) @@ -22266,7 +27772,10 @@ public int fnGuiGameListMenuCtrl_getSelectedRow (string guigamelistmenuctrl) return SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_getSelectedRow(sbguigamelistmenuctrl); } /// -/// Determines if the specified row is enabled or disabled. @param row The row to set the enabled status of. @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// Determines if the specified row is enabled or disabled. +/// @param row The row to set the enabled status of. +/// @return True if the specified row is enabled. False if the row is not enabled or the given index was not valid. ) +/// /// public bool fnGuiGameListMenuCtrl_isRowEnabled (string guigamelistmenuctrl, int row) @@ -22280,7 +27789,10 @@ public bool fnGuiGameListMenuCtrl_isRowEnabled (string guigamelistmenuctrl, int return SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_isRowEnabled(sbguigamelistmenuctrl, row)>=1; } /// -/// Sets a row's enabled status according to the given parameters. @param row The index to check for validity. @param enabled Indicate true to enable the row or false to disable it. ) +/// Sets a row's enabled status according to the given parameters. +/// @param row The index to check for validity. +/// @param enabled Indicate true to enable the row or false to disable it. ) +/// /// public void fnGuiGameListMenuCtrl_setRowEnabled (string guigamelistmenuctrl, int row, bool enabled) @@ -22294,7 +27806,10 @@ public void fnGuiGameListMenuCtrl_setRowEnabled (string guigamelistmenuctrl, int SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_setRowEnabled(sbguigamelistmenuctrl, row, enabled); } /// -/// Sets the label on the given row. @param row Index of the row to set the label on. @param label Text to set as the label of the row. ) +/// Sets the label on the given row. +/// @param row Index of the row to set the label on. +/// @param label Text to set as the label of the row. ) +/// /// public void fnGuiGameListMenuCtrl_setRowLabel (string guigamelistmenuctrl, int row, string label) @@ -22311,7 +27826,9 @@ public void fnGuiGameListMenuCtrl_setRowLabel (string guigamelistmenuctrl, int r SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_setRowLabel(sbguigamelistmenuctrl, row, sblabel); } /// -/// Sets the selected row. Only rows that are enabled can be selected. @param row Index of the row to set as selected. ) +/// Sets the selected row. Only rows that are enabled can be selected. +/// @param row Index of the row to set as selected. ) +/// /// public void fnGuiGameListMenuCtrl_setSelected (string guigamelistmenuctrl, int row) @@ -22325,7 +27842,15 @@ public void fnGuiGameListMenuCtrl_setSelected (string guigamelistmenuctrl, int r SafeNativeMethods.mwle_fnGuiGameListMenuCtrl_setSelected(sbguigamelistmenuctrl, row); } /// -/// Add a row to the list control. @param label The text to display on the row as a label. @param options A tab separated list of options. @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. @param callback Name of a script function to use as a callback when this row is activated. @param icon [optional] Index of the icon to use as a marker. @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. @param enabled [optional] If this row is initially enabled. ) +/// Add a row to the list control. +/// @param label The text to display on the row as a label. +/// @param options A tab separated list of options. +/// @param wrapOptions Specify true to allow options to wrap at each end or false to prevent wrapping. +/// @param callback Name of a script function to use as a callback when this row is activated. +/// @param icon [optional] Index of the icon to use as a marker. +/// @param yPad [optional] An extra amount of height padding before the row. Does nothing on the first row. +/// @param enabled [optional] If this row is initially enabled. ) +/// /// public void fnGuiGameListOptionsCtrl_addRow (string guigamelistoptionsctrl, string label, string options, bool wrapOptions, string callback, int icon, int yPad, bool enabled) @@ -22348,7 +27873,10 @@ public void fnGuiGameListOptionsCtrl_addRow (string guigamelistoptionsctrl, stri SafeNativeMethods.mwle_fnGuiGameListOptionsCtrl_addRow(sbguigamelistoptionsctrl, sblabel, sboptions, wrapOptions, sbcallback, icon, yPad, enabled); } /// -/// Gets the text for the currently selected option of the given row. @param row Index of the row to get the option from. @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// Gets the text for the currently selected option of the given row. +/// @param row Index of the row to get the option from. +/// @return A string representing the text currently displayed as the selected option on the given row. If there is no such displayed text then the empty string is returned. ) +/// /// public string fnGuiGameListOptionsCtrl_getCurrentOption (string guigamelistoptionsctrl, int row) @@ -22365,7 +27893,11 @@ public string fnGuiGameListOptionsCtrl_getCurrentOption (string guigamelistoptio } /// -/// Set the row's current option to the one specified @param row Index of the row to set an option on. @param option The option to be made active. @return True if the row contained the option and was set, false otherwise. ) +/// Set the row's current option to the one specified +/// @param row Index of the row to set an option on. +/// @param option The option to be made active. +/// @return True if the row contained the option and was set, false otherwise. ) +/// /// public bool fnGuiGameListOptionsCtrl_selectOption (string guigamelistoptionsctrl, int row, string option) @@ -22382,7 +27914,10 @@ public bool fnGuiGameListOptionsCtrl_selectOption (string guigamelistoptionsctrl return SafeNativeMethods.mwle_fnGuiGameListOptionsCtrl_selectOption(sbguigamelistoptionsctrl, row, sboption)>=1; } /// -/// Sets the list of options on the given row. @param row Index of the row to set options on. @param optionsList A tab separated list of options for the control. ) +/// Sets the list of options on the given row. +/// @param row Index of the row to set options on. +/// @param optionsList A tab separated list of options for the control. ) +/// /// public void fnGuiGameListOptionsCtrl_setOptions (string guigamelistoptionsctrl, int row, string optionsList) @@ -22399,7 +27934,16 @@ public void fnGuiGameListOptionsCtrl_setOptions (string guigamelistoptionsctrl, SafeNativeMethods.mwle_fnGuiGameListOptionsCtrl_setOptions(sbguigamelistoptionsctrl, row, sboptionsList); } /// -/// Sets up the given plotting curve to automatically plot the value of the @a variable with a frequency of @a updateFrequency. @param plotId Index of the plotting curve. Must be 0=plotId6. @param variable Name of the global variable. @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). @tsexample // Plot FPS counter at 1 second intervals. %graph.addAutoPlot( 0, \"fps::real\", 1000 ); @endtsexample ) +/// Sets up the given plotting curve to automatically plot the value of the @a variable with a +/// frequency of @a updateFrequency. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param variable Name of the global variable. +/// @param updateFrequency Frequency with which to add new data points to the plotting curve (in milliseconds). +/// @tsexample +/// // Plot FPS counter at 1 second intervals. +/// %graph.addAutoPlot( 0, \"fps::real\", 1000 ); +/// @endtsexample ) +/// /// public void fnGuiGraphCtrl_addAutoPlot (string guigraphctrl, int plotId, string variable, int updateFrequency) @@ -22416,7 +27960,13 @@ public void fnGuiGraphCtrl_addAutoPlot (string guigraphctrl, int plotId, string SafeNativeMethods.mwle_fnGuiGraphCtrl_addAutoPlot(sbguigraphctrl, plotId, sbvariable, updateFrequency); } /// -/// Add a data point to the plot's curve. @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. @param value Value of the data point to add to the curve. @note Data values are added to the @b left end of the plotting curve. @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If this limit is exceeded, data points on the right end of the curve are culled. ) +/// Add a data point to the plot's curve. +/// @param plotId Index of the plotting curve to which to add the data point. Must be 0=plotId6. +/// @param value Value of the data point to add to the curve. +/// @note Data values are added to the @b left end of the plotting curve. +/// @note A maximum number of 200 data points can be added to any single plotting curve at any one time. If +/// this limit is exceeded, data points on the right end of the curve are culled. ) +/// /// public void fnGuiGraphCtrl_addDatum (string guigraphctrl, int plotId, float value) @@ -22430,7 +27980,11 @@ public void fnGuiGraphCtrl_addDatum (string guigraphctrl, int plotId, float valu SafeNativeMethods.mwle_fnGuiGraphCtrl_addDatum(sbguigraphctrl, plotId, value); } /// -/// Get a data point on the given plotting curve. @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. @param index Index of the data point on the curve. @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// Get a data point on the given plotting curve. +/// @param plotId Index of the plotting curve from which to fetch the data point. Must be 0=plotId6. +/// @param index Index of the data point on the curve. +/// @return The value of the data point or -1 if @a plotId or @a index are out of range. ) +/// /// public float fnGuiGraphCtrl_getDatum (string guigraphctrl, int plotId, int index) @@ -22444,7 +27998,9 @@ public float fnGuiGraphCtrl_getDatum (string guigraphctrl, int plotId, int index return SafeNativeMethods.mwle_fnGuiGraphCtrl_getDatum(sbguigraphctrl, plotId, index); } /// -/// Stop automatic variable plotting for the given curve. @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// Stop automatic variable plotting for the given curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. ) +/// /// public void fnGuiGraphCtrl_removeAutoPlot (string guigraphctrl, int plotId) @@ -22458,7 +28014,11 @@ public void fnGuiGraphCtrl_removeAutoPlot (string guigraphctrl, int plotId) SafeNativeMethods.mwle_fnGuiGraphCtrl_removeAutoPlot(sbguigraphctrl, plotId); } /// -/// Change the charting type of the given plotting curve. @param plotId Index of the plotting curve. Must be 0=plotId6. @param graphType Charting type to use for the curve. @note Instead of calling this method, you can directly assign to #plotType. ) +/// Change the charting type of the given plotting curve. +/// @param plotId Index of the plotting curve. Must be 0=plotId6. +/// @param graphType Charting type to use for the curve. +/// @note Instead of calling this method, you can directly assign to #plotType. ) +/// /// public void fnGuiGraphCtrl_setGraphType (string guigraphctrl, int plotId, int graphType) @@ -22472,7 +28032,17 @@ public void fnGuiGraphCtrl_setGraphType (string guigraphctrl, int plotId, int gr SafeNativeMethods.mwle_fnGuiGraphCtrl_setGraphType(sbguigraphctrl, plotId, graphType); } /// -/// @brief Set the bitmap to use for the button portion of this control. @param buttonFilename Filename for the image @tsexample // Define the button filename %buttonFilename = \"pearlButton\"; // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); @endtsexample @see GuiControl @see GuiButtonCtrl) +/// @brief Set the bitmap to use for the button portion of this control. +/// @param buttonFilename Filename for the image +/// @tsexample +/// // Define the button filename +/// %buttonFilename = \"pearlButton\"; +/// // Inform the GuiIconButtonCtrl control to update its main button graphic to the defined bitmap +/// %thisGuiIconButtonCtrl.setBitmap(%buttonFilename); +/// @endtsexample +/// @see GuiControl +/// @see GuiButtonCtrl) +/// /// public void fnGuiIconButtonCtrl_setBitmap (string guiiconbuttonctrl, string buttonFilename) @@ -22489,7 +28059,14 @@ public void fnGuiIconButtonCtrl_setBitmap (string guiiconbuttonctrl, string butt SafeNativeMethods.mwle_fnGuiIconButtonCtrl_setBitmap(sbguiiconbuttonctrl, sbbuttonFilename); } /// -/// @brief Clears the imagelist @tsexample // Inform the GuiImageList control to clear itself. %isFinished = %thisGuiImageList.clear(); @endtsexample @return Returns true when finished. @see SimObject) +/// @brief Clears the imagelist +/// @tsexample +/// // Inform the GuiImageList control to clear itself. +/// %isFinished = %thisGuiImageList.clear(); +/// @endtsexample +/// @return Returns true when finished. +/// @see SimObject) +/// /// public bool fnGuiImageList_clear (string guiimagelist) @@ -22503,7 +28080,14 @@ public bool fnGuiImageList_clear (string guiimagelist) return SafeNativeMethods.mwle_fnGuiImageList_clear(sbguiimagelist)>=1; } /// -/// @brief Gets the number of images in the list. @tsexample // Request the number of images from the GuiImageList control. %imageCount = %thisGuiImageList.count(); @endtsexample @return Number of images in the control. @see SimObject) +/// @brief Gets the number of images in the list. +/// @tsexample +/// // Request the number of images from the GuiImageList control. +/// %imageCount = %thisGuiImageList.count(); +/// @endtsexample +/// @return Number of images in the control. +/// @see SimObject) +/// /// public int fnGuiImageList_count (string guiimagelist) @@ -22517,7 +28101,17 @@ public int fnGuiImageList_count (string guiimagelist) return SafeNativeMethods.mwle_fnGuiImageList_count(sbguiimagelist); } /// -/// @brief Get a path to the texture at the specified index. @param index Index of the image in the list. @tsexample // Define the image index/n %index = \"5\"; // Request the image path location from the control. %imagePath = %thisGuiImageList.getImage(%index); @endtsexample @return File path to the image map for the specified index. @see SimObject) +/// @brief Get a path to the texture at the specified index. +/// @param index Index of the image in the list. +/// @tsexample +/// // Define the image index/n +/// %index = \"5\"; +/// // Request the image path location from the control. +/// %imagePath = %thisGuiImageList.getImage(%index); +/// @endtsexample +/// @return File path to the image map for the specified index. +/// @see SimObject) +/// /// public string fnGuiImageList_getImage (string guiimagelist, int index) @@ -22534,7 +28128,17 @@ public string fnGuiImageList_getImage (string guiimagelist, int index) } /// -/// @brief Retrieves the imageindex of a specified texture in the list. @param imagePath Imagemap including filepath of image to search for @tsexample // Define the imagemap to search for %imagePath = \"./game/client/data/images/thisImage\"; // Request the index entry for the defined imagemap %imageIndex = %thisGuiImageList.getIndex(%imagePath); @endtsexample @return Index of the imagemap matching the defined image path. @see SimObject) +/// @brief Retrieves the imageindex of a specified texture in the list. +/// @param imagePath Imagemap including filepath of image to search for +/// @tsexample +/// // Define the imagemap to search for +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the index entry for the defined imagemap +/// %imageIndex = %thisGuiImageList.getIndex(%imagePath); +/// @endtsexample +/// @return Index of the imagemap matching the defined image path. +/// @see SimObject) +/// /// public int fnGuiImageList_getIndex (string guiimagelist, string imagePath) @@ -22551,7 +28155,17 @@ public int fnGuiImageList_getIndex (string guiimagelist, string imagePath) return SafeNativeMethods.mwle_fnGuiImageList_getIndex(sbguiimagelist, sbimagePath); } /// -/// @brief Insert an image into imagelist- returns the image index or -1 for failure. @param imagePath Imagemap, with path, to add to the list. @tsexample // Define the imagemap to add to the list %imagePath = \"./game/client/data/images/thisImage\"; // Request the GuiImageList control to add the defined image to its list. %imageIndex = %thisGuiImageList.insert(%imagePath); @endtsexample @return The index of the newly inserted imagemap, or -1 if the insertion failed. @see SimObject) +/// @brief Insert an image into imagelist- returns the image index or -1 for failure. +/// @param imagePath Imagemap, with path, to add to the list. +/// @tsexample +/// // Define the imagemap to add to the list +/// %imagePath = \"./game/client/data/images/thisImage\"; +/// // Request the GuiImageList control to add the defined image to its list. +/// %imageIndex = %thisGuiImageList.insert(%imagePath); +/// @endtsexample +/// @return The index of the newly inserted imagemap, or -1 if the insertion failed. +/// @see SimObject) +/// /// public int fnGuiImageList_insert (string guiimagelist, string imagePath) @@ -22568,7 +28182,17 @@ public int fnGuiImageList_insert (string guiimagelist, string imagePath) return SafeNativeMethods.mwle_fnGuiImageList_insert(sbguiimagelist, sbimagePath); } /// -/// @brief Removes an image from the list by index. @param index Image index to remove. @tsexample // Define the image index. %imageIndex = \"4\"; // Inform the GuiImageList control to remove the image at the defined index. %wasSuccessful = %thisGuiImageList.remove(%imageIndex); @endtsexample @return True if the operation was successful, false if it was not. @see SimObject) +/// @brief Removes an image from the list by index. +/// @param index Image index to remove. +/// @tsexample +/// // Define the image index. +/// %imageIndex = \"4\"; +/// // Inform the GuiImageList control to remove the image at the defined index. +/// %wasSuccessful = %thisGuiImageList.remove(%imageIndex); +/// @endtsexample +/// @return True if the operation was successful, false if it was not. +/// @see SimObject) +/// /// public bool fnGuiImageList_remove (string guiimagelist, int index) @@ -22583,6 +28207,7 @@ public bool fnGuiImageList_remove (string guiimagelist, int index) } /// /// ( GuiInspectorTypeBitMask32, applyBit, void, 2,2, apply(); ) +/// /// public void fnGuiInspectorTypeBitMask32_applyBit (string guiinspectortypebitmask32) @@ -22597,6 +28222,7 @@ public void fnGuiInspectorTypeBitMask32_applyBit (string guiinspectortypebitmask } /// /// ( GuiInspectorTypeFileName, apply, void, 3,3, apply(newValue); ) +/// /// public void fnGuiInspectorTypeFileName_apply (string guiinspectortypefilename, string a2) @@ -22613,7 +28239,17 @@ public void fnGuiInspectorTypeFileName_apply (string guiinspectortypefilename, s SafeNativeMethods.mwle_fnGuiInspectorTypeFileName_apply(sbguiinspectortypefilename, sba2); } /// -/// @brief Checks if there is an item with the exact text of what is passed in, and if so the item is removed from the list and adds that item's data to the filtered list. @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. @tsexample // Define the itemName that we wish to add to the filtered item list. %itemName = \"This Item Name\"; // Add the item name to the filtered item list. %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); @endtsexample @see GuiControl) +/// @brief Checks if there is an item with the exact text of what is passed in, and if so +/// the item is removed from the list and adds that item's data to the filtered list. +/// @param itemName Name of the item that we wish to add to the filtered item list of the GuiListBoxCtrl. +/// @tsexample +/// // Define the itemName that we wish to add to the filtered item list. +/// %itemName = \"This Item Name\"; +/// // Add the item name to the filtered item list. +/// %thisGuiListBoxCtrl.addFilteredItem(%filteredItemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_addFilteredItem (string guilistboxctrl, string newItem) @@ -22630,7 +28266,22 @@ public void fnGuiListBoxCtrl_addFilteredItem (string guilistboxctrl, string newI SafeNativeMethods.mwle_fnGuiListBoxCtrl_addFilteredItem(sbguilistboxctrl, sbnewItem); } /// -/// ), @brief Adds an item to the end of the list with an optional color. @param newItem New item to add to the list. @param color Optional color parameter to add to the new item. @tsexample // Define the item to add to the list. %newItem = \"Gideon's Blue Coat\"; // Define the optional color for the new list item. %color = \"0.0 0.0 1.0\"; // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. %thisGuiListBoxCtrl.addItem(%newItem,%color); @endtsexample @return If not void, return value and description @see GuiControl @hide) +/// ), +/// @brief Adds an item to the end of the list with an optional color. +/// @param newItem New item to add to the list. +/// @param color Optional color parameter to add to the new item. +/// @tsexample +/// // Define the item to add to the list. +/// %newItem = \"Gideon's Blue Coat\"; +/// // Define the optional color for the new list item. +/// %color = \"0.0 0.0 1.0\"; +/// // Inform the GuiListBoxCtrl object to add the item to the end of the list with the defined color. +/// %thisGuiListBoxCtrl.addItem(%newItem,%color); +/// @endtsexample +/// @return If not void, return value and description +/// @see GuiControl +/// @hide) +/// /// public int fnGuiListBoxCtrl_addItem (string guilistboxctrl, string newItem, string color) @@ -22650,7 +28301,16 @@ public int fnGuiListBoxCtrl_addItem (string guilistboxctrl, string newItem, stri return SafeNativeMethods.mwle_fnGuiListBoxCtrl_addItem(sbguilistboxctrl, sbnewItem, sbcolor); } /// -/// @brief Removes any custom coloring from an item at the defined index id in the list. @param index Index id for the item to clear any custom color from. @tsexample // Define the index id %index = \"4\"; // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry %thisGuiListBoxCtrl.clearItemColor(%index); @endtsexample @see GuiControl) +/// @brief Removes any custom coloring from an item at the defined index id in the list. +/// @param index Index id for the item to clear any custom color from. +/// @tsexample +/// // Define the index id +/// %index = \"4\"; +/// // Request the GuiListBoxCtrl object to remove any custom coloring from the defined index entry +/// %thisGuiListBoxCtrl.clearItemColor(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_clearItemColor (string guilistboxctrl, int index) @@ -22664,7 +28324,13 @@ public void fnGuiListBoxCtrl_clearItemColor (string guilistboxctrl, int index) SafeNativeMethods.mwle_fnGuiListBoxCtrl_clearItemColor(sbguilistboxctrl, index); } /// -/// @brief Clears all the items in the listbox. @tsexample // Inform the GuiListBoxCtrl object to clear all items from its list. %thisGuiListBoxCtrl.clearItems(); @endtsexample @see GuiControl) +/// @brief Clears all the items in the listbox. +/// @tsexample +/// // Inform the GuiListBoxCtrl object to clear all items from its list. +/// %thisGuiListBoxCtrl.clearItems(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_clearItems (string guilistboxctrl) @@ -22678,7 +28344,14 @@ public void fnGuiListBoxCtrl_clearItems (string guilistboxctrl) SafeNativeMethods.mwle_fnGuiListBoxCtrl_clearItems(sbguilistboxctrl); } /// -/// @brief Sets all currently selected items to unselected. Detailed description @tsexample // Inform the GuiListBoxCtrl object to set all of its items to unselected./n %thisGuiListBoxCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Sets all currently selected items to unselected. +/// Detailed description +/// @tsexample +/// // Inform the GuiListBoxCtrl object to set all of its items to unselected./n +/// %thisGuiListBoxCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_clearSelection (string guilistboxctrl) @@ -22692,7 +28365,16 @@ public void fnGuiListBoxCtrl_clearSelection (string guilistboxctrl) SafeNativeMethods.mwle_fnGuiListBoxCtrl_clearSelection(sbguilistboxctrl); } /// -/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. @param itemIndex Index id location to remove the item from. @tsexample // Define the index id we want to remove from the list %itemIndex = \"8\"; // Inform the GuiListBoxCtrl object to remove the item at the defined index id. %thisGuiListBoxCtrl.deleteItem(%itemIndex); @endtsexample @see References) +/// @brief Removes the list entry at the requested index id from the control and clears the memory associated with it. +/// @param itemIndex Index id location to remove the item from. +/// @tsexample +/// // Define the index id we want to remove from the list +/// %itemIndex = \"8\"; +/// // Inform the GuiListBoxCtrl object to remove the item at the defined index id. +/// %thisGuiListBoxCtrl.deleteItem(%itemIndex); +/// @endtsexample +/// @see References) +/// /// public void fnGuiListBoxCtrl_deleteItem (string guilistboxctrl, int itemIndex) @@ -22706,7 +28388,13 @@ public void fnGuiListBoxCtrl_deleteItem (string guilistboxctrl, int itemIndex) SafeNativeMethods.mwle_fnGuiListBoxCtrl_deleteItem(sbguilistboxctrl, itemIndex); } /// -/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. @tsexample \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet %thisGuiListBox.doMirror(); @endtsexample @see GuiCore) +/// @brief Informs the GuiListBoxCtrl object to mirror the contents of the GuiListBoxCtrl stored in the mirrorSet field. +/// @tsexample +/// \\ Inform the object to mirror the object located at %thisGuiListBox.mirrorSet +/// %thisGuiListBox.doMirror(); +/// @endtsexample +/// @see GuiCore) +/// /// public void fnGuiListBoxCtrl_doMirror (string guilistboxctrl) @@ -22720,7 +28408,20 @@ public void fnGuiListBoxCtrl_doMirror (string guilistboxctrl) SafeNativeMethods.mwle_fnGuiListBoxCtrl_doMirror(sbguilistboxctrl); } /// -/// @brief Returns index of item with matching text or -1 if none found. @param findText Text in the list to find. @param isCaseSensitive If true, the search will be case sensitive. @tsexample // Define the text we wish to find in the list. %findText = \"Hickory Smoked Gideon\"/n/n // Define if this is a case sensitive search or not. %isCaseSensitive = \"false\"; // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); @endtsexample @return Index id of item with matching text or -1 if none found. @see GuiControl) +/// @brief Returns index of item with matching text or -1 if none found. +/// @param findText Text in the list to find. +/// @param isCaseSensitive If true, the search will be case sensitive. +/// @tsexample +/// // Define the text we wish to find in the list. +/// %findText = \"Hickory Smoked Gideon\"/n/n +/// // Define if this is a case sensitive search or not. +/// %isCaseSensitive = \"false\"; +/// // Ask the GuiListBoxCtrl object what item id in the list matches the requested text. +/// %matchingId = %thisGuiListBoxCtrl.findItemText(%findText,%isCaseSensitive); +/// @endtsexample +/// @return Index id of item with matching text or -1 if none found. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_findItemText (string guilistboxctrl, string findText, bool bCaseSensitive) @@ -22737,7 +28438,14 @@ public int fnGuiListBoxCtrl_findItemText (string guilistboxctrl, string findText return SafeNativeMethods.mwle_fnGuiListBoxCtrl_findItemText(sbguilistboxctrl, sbfindText, bCaseSensitive); } /// -/// @brief Returns the number of items in the list. @tsexample // Request the number of items in the list of the GuiListBoxCtrl object. %listItemCount = %thisGuiListBoxCtrl.getItemCount(); @endtsexample @return The number of items in the list. @see GuiControl) +/// @brief Returns the number of items in the list. +/// @tsexample +/// // Request the number of items in the list of the GuiListBoxCtrl object. +/// %listItemCount = %thisGuiListBoxCtrl.getItemCount(); +/// @endtsexample +/// @return The number of items in the list. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getItemCount (string guilistboxctrl) @@ -22751,7 +28459,17 @@ public int fnGuiListBoxCtrl_getItemCount (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getItemCount(sbguilistboxctrl); } /// -/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. @param index Index id to request the associated item from. @tsexample // Define the index id %index = \"12\"; // Request the item from the GuiListBoxCtrl object %object = %thisGuiListBoxCtrl.getItemObject(%index); @endtsexample @return The object associated with the item in the list. @see References) +/// @brief Returns the object associated with an item. This only makes sense if you are mirroring a simset. +/// @param index Index id to request the associated item from. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Request the item from the GuiListBoxCtrl object +/// %object = %thisGuiListBoxCtrl.getItemObject(%index); +/// @endtsexample +/// @return The object associated with the item in the list. +/// @see References) +/// /// public string fnGuiListBoxCtrl_getItemObject (string guilistboxctrl, int index) @@ -22768,7 +28486,17 @@ public string fnGuiListBoxCtrl_getItemObject (string guilistboxctrl, int index) } /// -/// @brief Returns the text of the item at the specified index. @param index Index id to return the item text from. @tsexample // Define the index id entry to request the text from %index = \"12\"; // Request the item id text from the GuiListBoxCtrl object. %text = %thisGuiListBoxCtrl.getItemText(%index); @endtsexample @return The text of the requested index id. @see GuiControl) +/// @brief Returns the text of the item at the specified index. +/// @param index Index id to return the item text from. +/// @tsexample +/// // Define the index id entry to request the text from +/// %index = \"12\"; +/// // Request the item id text from the GuiListBoxCtrl object. +/// %text = %thisGuiListBoxCtrl.getItemText(%index); +/// @endtsexample +/// @return The text of the requested index id. +/// @see GuiControl) +/// /// public string fnGuiListBoxCtrl_getItemText (string guilistboxctrl, int index) @@ -22785,7 +28513,14 @@ public string fnGuiListBoxCtrl_getItemText (string guilistboxctrl, int index) } /// -/// @brief Request the item index for the item that was last clicked. @tsexample // Request the item index for the last clicked item in the list %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); @endtsexample @return Index id for the last clicked item in the list. @see GuiControl) +/// @brief Request the item index for the item that was last clicked. +/// @tsexample +/// // Request the item index for the last clicked item in the list +/// %lastClickedIndex = %thisGuiListBoxCtrl.getLastClickItem(); +/// @endtsexample +/// @return Index id for the last clicked item in the list. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getLastClickItem (string guilistboxctrl) @@ -22799,7 +28534,14 @@ public int fnGuiListBoxCtrl_getLastClickItem (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getLastClickItem(sbguilistboxctrl); } /// -/// @brief Returns the number of items currently selected. @tsexample // Request the number of currently selected items %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); @endtsexample @return Number of currently selected items. @see GuiControl) +/// @brief Returns the number of items currently selected. +/// @tsexample +/// // Request the number of currently selected items +/// %selectedItemCount = %thisGuiListBoxCtrl.getSelCount(); +/// @endtsexample +/// @return Number of currently selected items. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getSelCount (string guilistboxctrl) @@ -22813,7 +28555,14 @@ public int fnGuiListBoxCtrl_getSelCount (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getSelCount(sbguilistboxctrl); } /// -/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. @tsexample // Request the index id of the currently selected item %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); @endtsexample @return The selected items index or -1 if none selected. @see GuiControl) +/// @brief Returns the selected items index or -1 if none selected. If multiple selections exist it returns the first selected item. +/// @tsexample +/// // Request the index id of the currently selected item +/// %selectedItemId = %thisGuiListBoxCtrl.getSelectedItem(); +/// @endtsexample +/// @return The selected items index or -1 if none selected. +/// @see GuiControl) +/// /// public int fnGuiListBoxCtrl_getSelectedItem (string guilistboxctrl) @@ -22827,7 +28576,14 @@ public int fnGuiListBoxCtrl_getSelectedItem (string guilistboxctrl) return SafeNativeMethods.mwle_fnGuiListBoxCtrl_getSelectedItem(sbguilistboxctrl); } /// -/// @brief Returns a space delimited list of the selected items indexes in the list. @tsexample // Request a space delimited list of the items in the GuiListBoxCtrl object. %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); @endtsexample @return Space delimited list of the selected items indexes in the list @see GuiControl) +/// @brief Returns a space delimited list of the selected items indexes in the list. +/// @tsexample +/// // Request a space delimited list of the items in the GuiListBoxCtrl object. +/// %selectionList = %thisGuiListBoxCtrl.getSelectedItems(); +/// @endtsexample +/// @return Space delimited list of the selected items indexes in the list +/// @see GuiControl) +/// /// public string fnGuiListBoxCtrl_getSelectedItems (string guilistboxctrl) @@ -22844,7 +28600,20 @@ public string fnGuiListBoxCtrl_getSelectedItems (string guilistboxctrl) } /// -/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. @param text Text item to add. @param index Index id to insert the list item text at. @tsexample // Define the text to insert %text = \"Secret Agent Gideon\"; // Define the index entry to insert the text at %index = \"14\"; // In form the GuiListBoxCtrl object to insert the text at the defined index. %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); @endtsexample @return If successful will return the index id assigned. If unsuccessful, will return -1. @see GuiControl) +/// @brief Inserts an item into the list at the specified index and returns the index assigned or -1 on error. +/// @param text Text item to add. +/// @param index Index id to insert the list item text at. +/// @tsexample +/// // Define the text to insert +/// %text = \"Secret Agent Gideon\"; +/// // Define the index entry to insert the text at +/// %index = \"14\"; +/// // In form the GuiListBoxCtrl object to insert the text at the defined index. +/// %assignedId = %thisGuiListBoxCtrl.insertItem(%text,%index); +/// @endtsexample +/// @return If successful will return the index id assigned. If unsuccessful, will return -1. +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_insertItem (string guilistboxctrl, string text, int index) @@ -22861,7 +28630,16 @@ public void fnGuiListBoxCtrl_insertItem (string guilistboxctrl, string text, int SafeNativeMethods.mwle_fnGuiListBoxCtrl_insertItem(sbguilistboxctrl, sbtext, index); } /// -/// @brief Removes an item of the entered name from the filtered items list. @param itemName Name of the item to remove from the filtered list. @tsexample // Define the itemName that you wish to remove. %itemName = \"This Item Name\"; // Remove the itemName from the GuiListBoxCtrl %thisGuiListBoxCtrl.removeFilteredItem(%itemName); @endtsexample @see GuiControl) +/// @brief Removes an item of the entered name from the filtered items list. +/// @param itemName Name of the item to remove from the filtered list. +/// @tsexample +/// // Define the itemName that you wish to remove. +/// %itemName = \"This Item Name\"; +/// // Remove the itemName from the GuiListBoxCtrl +/// %thisGuiListBoxCtrl.removeFilteredItem(%itemName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_removeFilteredItem (string guilistboxctrl, string itemName) @@ -22878,7 +28656,16 @@ public void fnGuiListBoxCtrl_removeFilteredItem (string guilistboxctrl, string i SafeNativeMethods.mwle_fnGuiListBoxCtrl_removeFilteredItem(sbguilistboxctrl, sbitemName); } /// -/// @brief Sets the currently selected item at the specified index. @param indexId Index Id to set selected. @tsexample // Define the index id that we wish to select. %selectId = \"4\"; // Inform the GuiListBoxCtrl object to set the requested index as selected. %thisGuiListBoxCtrl.setCurSel(%selectId); @endtsexample @see GuiControl) +/// @brief Sets the currently selected item at the specified index. +/// @param indexId Index Id to set selected. +/// @tsexample +/// // Define the index id that we wish to select. +/// %selectId = \"4\"; +/// // Inform the GuiListBoxCtrl object to set the requested index as selected. +/// %thisGuiListBoxCtrl.setCurSel(%selectId); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setCurSel (string guilistboxctrl, int indexId) @@ -22892,7 +28679,19 @@ public void fnGuiListBoxCtrl_setCurSel (string guilistboxctrl, int indexId) SafeNativeMethods.mwle_fnGuiListBoxCtrl_setCurSel(sbguilistboxctrl, indexId); } /// -/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list @param indexStart Index Id to start selection. @param indexStop Index Id to end selection. @tsexample // Set start id %indexStart = \"3\"; // Set end id %indexEnd = \"6\"; // Request the GuiListBoxCtrl object to select the defined range. %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); @endtsexample @see GuiControl) +/// @brief Sets the current selection range from index start to stop. If no stop is specified it sets from start index to the end of the list +/// @param indexStart Index Id to start selection. +/// @param indexStop Index Id to end selection. +/// @tsexample +/// // Set start id +/// %indexStart = \"3\"; +/// // Set end id +/// %indexEnd = \"6\"; +/// // Request the GuiListBoxCtrl object to select the defined range. +/// %thisGuiListBoxCtrl.setCurSelRange(%indexStart,%indexEnd); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setCurSelRange (string guilistboxctrl, int indexStart, int indexStop) @@ -22906,7 +28705,19 @@ public void fnGuiListBoxCtrl_setCurSelRange (string guilistboxctrl, int indexSta SafeNativeMethods.mwle_fnGuiListBoxCtrl_setCurSelRange(sbguilistboxctrl, indexStart, indexStop); } /// -/// @brief Sets the color of a single list entry at the specified index id. @param index Index id to modify the color of in the list. @param color Color value to set the list entry to. @tsexample // Define the index id value %index = \"5\"; // Define the color value %color = \"1.0 0.0 0.0\"; // Inform the GuiListBoxCtrl object to change the color of the requested index %thisGuiListBoxCtrl.setItemColor(%index,%color); @endtsexample @see GuiControl) +/// @brief Sets the color of a single list entry at the specified index id. +/// @param index Index id to modify the color of in the list. +/// @param color Color value to set the list entry to. +/// @tsexample +/// // Define the index id value +/// %index = \"5\"; +/// // Define the color value +/// %color = \"1.0 0.0 0.0\"; +/// // Inform the GuiListBoxCtrl object to change the color of the requested index +/// %thisGuiListBoxCtrl.setItemColor(%index,%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setItemColor (string guilistboxctrl, int index, string color) @@ -22923,7 +28734,19 @@ public void fnGuiListBoxCtrl_setItemColor (string guilistboxctrl, int index, str SafeNativeMethods.mwle_fnGuiListBoxCtrl_setItemColor(sbguilistboxctrl, index, sbcolor); } /// -/// @brief Sets the items text at the specified index. @param index Index id to set the item text at. @param newtext Text to change the list item at index id to. @tsexample // Define the index id/n %index = \"12\"; // Define the text to set the list item to %newtext = \"Gideon's Fancy Goggles\"; // Inform the GuiListBoxCtrl object to change the text at the requested index %thisGuiListBoxCtrl.setItemText(%index,%newText); @endtsexample @see GuiControl) +/// @brief Sets the items text at the specified index. +/// @param index Index id to set the item text at. +/// @param newtext Text to change the list item at index id to. +/// @tsexample +/// // Define the index id/n +/// %index = \"12\"; +/// // Define the text to set the list item to +/// %newtext = \"Gideon's Fancy Goggles\"; +/// // Inform the GuiListBoxCtrl object to change the text at the requested index +/// %thisGuiListBoxCtrl.setItemText(%index,%newText); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setItemText (string guilistboxctrl, int index, string newtext) @@ -22940,7 +28763,19 @@ public void fnGuiListBoxCtrl_setItemText (string guilistboxctrl, int index, stri SafeNativeMethods.mwle_fnGuiListBoxCtrl_setItemText(sbguilistboxctrl, index, sbnewtext); } /// -/// @brief Set the tooltip text to display for the given list item. @param index Index id to change the tooltip text @param text Text for the tooltip. @tsexample // Define the index id %index = \"12\"; // Define the tooltip text %tooltip = \"Gideon's goggles can see through space and time.\" // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); @endtsexample @see GuiControl) +/// @brief Set the tooltip text to display for the given list item. +/// @param index Index id to change the tooltip text +/// @param text Text for the tooltip. +/// @tsexample +/// // Define the index id +/// %index = \"12\"; +/// // Define the tooltip text +/// %tooltip = \"Gideon's goggles can see through space and time.\" +/// // Inform the GuiListBoxCtrl object to set the tooltop for the item at the defined index id +/// %thisGuiListBoxCtrl.setItemToolTip(%index,%tooltip); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setItemTooltip (string guilistboxctrl, int index, string text) @@ -22957,7 +28792,16 @@ public void fnGuiListBoxCtrl_setItemTooltip (string guilistboxctrl, int index, s SafeNativeMethods.mwle_fnGuiListBoxCtrl_setItemTooltip(sbguilistboxctrl, index, sbtext); } /// -/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. @param allowMultSelections Boolean variable to set the use of multiple selections or not. @tsexample // Define the multiple selection use state. %allowMultSelections = \"true\"; // Set the allow multiple selection state on the GuiListBoxCtrl object. %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); @endtsexample @see GuiControl) +/// @brief Enable or disable multiple selections for this GuiListBoxCtrl object. +/// @param allowMultSelections Boolean variable to set the use of multiple selections or not. +/// @tsexample +/// // Define the multiple selection use state. +/// %allowMultSelections = \"true\"; +/// // Set the allow multiple selection state on the GuiListBoxCtrl object. +/// %thisGuiListBoxCtrl.setMultipleSelection(%allowMultSelections); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setMultipleSelection (string guilistboxctrl, bool allowMultSelections) @@ -22971,7 +28815,20 @@ public void fnGuiListBoxCtrl_setMultipleSelection (string guilistboxctrl, bool a SafeNativeMethods.mwle_fnGuiListBoxCtrl_setMultipleSelection(sbguilistboxctrl, allowMultSelections); } /// -/// @brief Sets the item at the index specified to selected or not. Detailed description @param index Item index to set selected or unselected. @param setSelected Boolean selection state to set the requested item index. @tsexample // Define the index %index = \"5\"; // Define the selection state %selected = \"true\" // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. %thisGuiListBoxCtrl.setSelected(%index,%selected); @endtsexample @see GuiControl) +/// @brief Sets the item at the index specified to selected or not. +/// Detailed description +/// @param index Item index to set selected or unselected. +/// @param setSelected Boolean selection state to set the requested item index. +/// @tsexample +/// // Define the index +/// %index = \"5\"; +/// // Define the selection state +/// %selected = \"true\" +/// // Inform the GuiListBoxCtrl object of the new selection state for the requested index entry. +/// %thisGuiListBoxCtrl.setSelected(%index,%selected); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiListBoxCtrl_setSelected (string guilistboxctrl, int index, bool setSelected) @@ -22986,6 +28843,7 @@ public void fnGuiListBoxCtrl_setSelected (string guilistboxctrl, int index, bool } /// /// Deletes the preview model.) +/// /// public void fnGuiMaterialPreview_deleteModel (string guimaterialpreview) @@ -23000,6 +28858,7 @@ public void fnGuiMaterialPreview_deleteModel (string guimaterialpreview) } /// /// Resets the viewport to default zoom, pan, rotate and lighting.) +/// /// public void fnGuiMaterialPreview_reset (string guimaterialpreview) @@ -23014,6 +28873,7 @@ public void fnGuiMaterialPreview_reset (string guimaterialpreview) } /// /// Sets the color of the ambient light in the scene.) +/// /// public void fnGuiMaterialPreview_setAmbientLightColor (string guimaterialpreview, string color) @@ -23031,6 +28891,7 @@ public void fnGuiMaterialPreview_setAmbientLightColor (string guimaterialpreview } /// /// Sets the color of the light in the scene.) +/// /// public void fnGuiMaterialPreview_setLightColor (string guimaterialpreview, string color) @@ -23047,7 +28908,9 @@ public void fnGuiMaterialPreview_setLightColor (string guimaterialpreview, strin SafeNativeMethods.mwle_fnGuiMaterialPreview_setLightColor(sbguimaterialpreview, sbcolor); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display.) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display.) +/// /// public void fnGuiMaterialPreview_setModel (string guimaterialpreview, string shapeName) @@ -23064,7 +28927,10 @@ public void fnGuiMaterialPreview_setModel (string guimaterialpreview, string sha SafeNativeMethods.mwle_fnGuiMaterialPreview_setModel(sbguimaterialpreview, sbshapeName); } /// -/// Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. @param distance The distance to set the orbit to (will be clamped).) +/// Sets the distance at which the camera orbits the object. Clamped to the +/// acceptable range defined in the class by min and max orbit distances. +/// @param distance The distance to set the orbit to (will be clamped).) +/// /// public void fnGuiMaterialPreview_setOrbitDistance (string guimaterialpreview, float distance) @@ -23078,7 +28944,19 @@ public void fnGuiMaterialPreview_setOrbitDistance (string guimaterialpreview, fl SafeNativeMethods.mwle_fnGuiMaterialPreview_setOrbitDistance(sbguimaterialpreview, distance); } /// -/// @brief Adds a new menu to the menu bar. @param menuText Text to display for the new menu item. @param menuId ID for the new menu item. @tsexample // Define the menu text %menuText = \"New Menu\"; // Define the menu ID. %menuId = \"2\"; // Inform the GuiMenuBar control to add the new menu %thisGuiMenuBar.addMenu(%menuText,%menuId); @endtsexample @see GuiTickCtrl) +/// @brief Adds a new menu to the menu bar. +/// @param menuText Text to display for the new menu item. +/// @param menuId ID for the new menu item. +/// @tsexample +/// // Define the menu text +/// %menuText = \"New Menu\"; +/// // Define the menu ID. +/// %menuId = \"2\"; +/// // Inform the GuiMenuBar control to add the new menu +/// %thisGuiMenuBar.addMenu(%menuText,%menuId); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_addMenu (string guimenubar, string menuText, int menuId) @@ -23095,7 +28973,29 @@ public void fnGuiMenuBar_addMenu (string guimenubar, string menuText, int menuId SafeNativeMethods.mwle_fnGuiMenuBar_addMenu(sbguimenubar, sbmenuText, menuId); } /// -/// ,,0,,-1), @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menu Menu name or menu Id to add the new item to. @param menuItemText Text for the new menu item. @param menuItemId Id for the new menu item. @param accelerator Accelerator key for the new menu item. @param checkGroup Check group to include this menu item in. @tsexample // Define the menu we wish to add the item to %targetMenu = \"New Menu\"; or %menu = \"4\"; // Define the text for the new menu item %menuItemText = \"Menu Item\"; // Define the id for the new menu item %menuItemId = \"3\"; // Set the accelerator key to toggle this menu item with %accelerator = \"n\"; // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. %checkGroup = \"4\"; // Inform the GuiMenuBar control to add the new menu item with the defined fields %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); @endtsexample @see GuiTickCtrl) +/// ,,0,,-1), +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menu Menu name or menu Id to add the new item to. +/// @param menuItemText Text for the new menu item. +/// @param menuItemId Id for the new menu item. +/// @param accelerator Accelerator key for the new menu item. +/// @param checkGroup Check group to include this menu item in. +/// @tsexample +/// // Define the menu we wish to add the item to +/// %targetMenu = \"New Menu\"; or %menu = \"4\"; +/// // Define the text for the new menu item +/// %menuItemText = \"Menu Item\"; +/// // Define the id for the new menu item +/// %menuItemId = \"3\"; +/// // Set the accelerator key to toggle this menu item with +/// %accelerator = \"n\"; +/// // Define the Check Group that this menu item will be in, if we want it to be in a check group. -1 sets it in no check group. +/// %checkGroup = \"4\"; +/// // Inform the GuiMenuBar control to add the new menu item with the defined fields +/// %thisGuiMenuBar.addMenuItem(%menu,%menuItemText,%menuItemId,%accelerator,%checkGroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_addMenuItem (string guimenubar, string targetMenu, string menuItemText, int menuItemId, string accelerator, int checkGroup) @@ -23118,7 +29018,31 @@ public void fnGuiMenuBar_addMenuItem (string guimenubar, string targetMenu, stri SafeNativeMethods.mwle_fnGuiMenuBar_addMenuItem(sbguimenubar, sbtargetMenu, sbmenuItemText, menuItemId, sbaccelerator, checkGroup); } /// -/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for the new submenu @param submenuItemId Id for the new submenu @param accelerator Accelerator key for the new submenu @param checkGroup Which check group the new submenu should be in, or -1 for none. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"New Submenu Item\"; // Define the id for the new submenu %submenuItemId = \"4\"; // Define the accelerator key for the new submenu %accelerator = \"n\"; // Define the checkgroup for the new submenu %checkgroup = \"7\"; // Request the GuiMenuBar control to add the new submenu with the defined information %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); @endtsexample @see GuiTickCtrl) +/// @brief Adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for the new submenu +/// @param submenuItemId Id for the new submenu +/// @param accelerator Accelerator key for the new submenu +/// @param checkGroup Which check group the new submenu should be in, or -1 for none. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"New Submenu Item\"; +/// // Define the id for the new submenu +/// %submenuItemId = \"4\"; +/// // Define the accelerator key for the new submenu +/// %accelerator = \"n\"; +/// // Define the checkgroup for the new submenu +/// %checkgroup = \"7\"; +/// // Request the GuiMenuBar control to add the new submenu with the defined information +/// %thisGuiMenuBar.addSubmenuItem(%menuTarget,%menuItem,%submenuItemText,%submenuItemId,%accelerator,%checkgroup); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_addSubmenuItem (string guimenubar, string menuTarget, string menuItem, string submenuItemText, int submenuItemId, string accelerator, int checkGroup) @@ -23144,7 +29068,16 @@ public void fnGuiMenuBar_addSubmenuItem (string guimenubar, string menuTarget, s SafeNativeMethods.mwle_fnGuiMenuBar_addSubmenuItem(sbguimenubar, sbmenuTarget, sbmenuItem, sbsubmenuItemText, submenuItemId, sbaccelerator, checkGroup); } /// -/// @brief Removes all the menu items from the specified menu. @param menuTarget Menu to remove all items from @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar control to clear all menu items from the defined menu %thisGuiMenuBar.clearMenuItems(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes all the menu items from the specified menu. +/// @param menuTarget Menu to remove all items from +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar control to clear all menu items from the defined menu +/// %thisGuiMenuBar.clearMenuItems(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_clearMenuItems (string guimenubar, string menuTarget) @@ -23161,7 +29094,13 @@ public void fnGuiMenuBar_clearMenuItems (string guimenubar, string menuTarget) SafeNativeMethods.mwle_fnGuiMenuBar_clearMenuItems(sbguimenubar, sbmenuTarget); } /// -/// @brief Clears all the menus from the menu bar. @tsexample // Inform the GuiMenuBar control to clear all menus from itself. %thisGuiMenuBar.clearMenus(); @endtsexample @see GuiTickCtrl) +/// @brief Clears all the menus from the menu bar. +/// @tsexample +/// // Inform the GuiMenuBar control to clear all menus from itself. +/// %thisGuiMenuBar.clearMenus(); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_clearMenus (string guimenubar, int param1, int param2) @@ -23175,7 +29114,19 @@ public void fnGuiMenuBar_clearMenus (string guimenubar, int param1, int param2) SafeNativeMethods.mwle_fnGuiMenuBar_clearMenus(sbguimenubar, param1, param2); } /// -/// @brief Removes all the menu items from the specified submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Inform the GuiMenuBar to remove all submenu items from the defined menu item %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); @endtsexample @see GuiControl) +/// @brief Removes all the menu items from the specified submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Inform the GuiMenuBar to remove all submenu items from the defined menu item +/// %thisGuiMenuBar.clearSubmenuItems(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMenuBar_clearSubmenuItems (string guimenubar, string menuTarget, string menuItem) @@ -23195,7 +29146,16 @@ public void fnGuiMenuBar_clearSubmenuItems (string guimenubar, string menuTarget SafeNativeMethods.mwle_fnGuiMenuBar_clearSubmenuItems(sbguimenubar, sbmenuTarget, sbmenuItem); } /// -/// @brief Removes the specified menu from the menu bar. @param menuTarget Menu to remove from the menu bar @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Inform the GuiMenuBar to remove the defined menu from the menu bar %thisGuiMenuBar.removeMenu(%menuTarget); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu from the menu bar. +/// @param menuTarget Menu to remove from the menu bar +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Inform the GuiMenuBar to remove the defined menu from the menu bar +/// %thisGuiMenuBar.removeMenu(%menuTarget); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_removeMenu (string guimenubar, string menuTarget) @@ -23212,7 +29172,19 @@ public void fnGuiMenuBar_removeMenu (string guimenubar, string menuTarget) SafeNativeMethods.mwle_fnGuiMenuBar_removeMenu(sbguimenubar, sbmenuTarget); } /// -/// @brief Removes the specified menu item from the menu. @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Request the GuiMenuBar control to remove the define menu item %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); @endtsexample @see GuiTickCtrl) +/// @brief Removes the specified menu item from the menu. +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Request the GuiMenuBar control to remove the define menu item +/// %thisGuiMenuBar.removeMenuItem(%menuTarget,%menuItem); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_removeMenuItem (string guimenubar, string menuTarget, string menuItemTarget) @@ -23232,7 +29204,16 @@ public void fnGuiMenuBar_removeMenuItem (string guimenubar, string menuTarget, s SafeNativeMethods.mwle_fnGuiMenuBar_removeMenuItem(sbguimenubar, sbmenuTarget, sbmenuItemTarget); } /// -/// @brief Sets the menu bitmap index for the check mark image. @param bitmapIndex Bitmap index for the check mark image. @tsexample // Define the bitmap index %bitmapIndex = \"2\"; // Inform the GuiMenuBar control of the proper bitmap index for the check mark image %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu bitmap index for the check mark image. +/// @param bitmapIndex Bitmap index for the check mark image. +/// @tsexample +/// // Define the bitmap index +/// %bitmapIndex = \"2\"; +/// // Inform the GuiMenuBar control of the proper bitmap index for the check mark image +/// %thisGuiMenuBar.setCheckmarkBitmapIndex(%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setCheckmarkBitmapIndex (string guimenubar, int bitmapindex) @@ -23246,7 +29227,25 @@ public void fnGuiMenuBar_setCheckmarkBitmapIndex (string guimenubar, int bitmapi SafeNativeMethods.mwle_fnGuiMenuBar_setCheckmarkBitmapIndex(sbguimenubar, bitmapindex); } /// -/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. @param menuTarget Menu to affect @param bitmapindex Bitmap index to set for the menu @param bitmaponly If true, only the bitmap will be rendered @param drawborder If true, a border will be drawn around the menu. @tsexample // Define the menuTarget to affect %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Set the bitmap index %bitmapIndex = \"5\"; // Set if we are only to render the bitmap or not %bitmaponly = \"true\"; // Set if we are rendering a border or not %drawborder = \"true\"; // Inform the GuiMenuBar of the bitmap and rendering changes %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); @endtsexample @see GuiTickCtrl) +/// @brief Sets the bitmap index for the menu and toggles rendering only the bitmap. +/// @param menuTarget Menu to affect +/// @param bitmapindex Bitmap index to set for the menu +/// @param bitmaponly If true, only the bitmap will be rendered +/// @param drawborder If true, a border will be drawn around the menu. +/// @tsexample +/// // Define the menuTarget to affect +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Set the bitmap index +/// %bitmapIndex = \"5\"; +/// // Set if we are only to render the bitmap or not +/// %bitmaponly = \"true\"; +/// // Set if we are rendering a border or not +/// %drawborder = \"true\"; +/// // Inform the GuiMenuBar of the bitmap and rendering changes +/// %thisGuiMenuBar.setMenuBitmapIndex(%menuTarget,%bitmapIndex,%bitmapOnly,%drawBorder); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuBitmapIndex (string guimenubar, string menuTarget, int bitmapindex, bool bitmaponly, bool drawborder) @@ -23263,7 +29262,22 @@ public void fnGuiMenuBar_setMenuBitmapIndex (string guimenubar, string menuTarge SafeNativeMethods.mwle_fnGuiMenuBar_setMenuBitmapIndex(sbguimenubar, sbmenuTarget, bitmapindex, bitmaponly, drawborder); } /// -/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. @param menuTarget Menu to affect the menuItem in @param menuItem Menu item to affect @param bitmapIndex Bitmap index to set the menu item to @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem\" %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the bitmapIndex %bitmapIndex = \"6\"; // Inform the GuiMenuBar control to set the menu item to the defined bitmap %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); @endtsexample @see GuiTickCtrl) +/// @brief Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap. +/// @param menuTarget Menu to affect the menuItem in +/// @param menuItem Menu item to affect +/// @param bitmapIndex Bitmap index to set the menu item to +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem\" +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the bitmapIndex +/// %bitmapIndex = \"6\"; +/// // Inform the GuiMenuBar control to set the menu item to the defined bitmap +/// %thisGuiMenuBar.setMenuItemBitmap(%menuTarget,%menuItem,%bitmapIndex); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemBitmap (string guimenubar, string menuTarget, string menuItemTarget, int bitmapIndex) @@ -23283,7 +29297,18 @@ public void fnGuiMenuBar_setMenuItemBitmap (string guimenubar, string menuTarget SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemBitmap(sbguimenubar, sbmenuTarget, sbmenuItemTarget, bitmapIndex); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to work in @param menuItem Menu item to affect @param checked Whether we are setting it to checked or not @tsexample @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in +/// the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to work in +/// @param menuItem Menu item to affect +/// @param checked Whether we are setting it to checked or not +/// @tsexample +/// +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void fnGuiMenuBar_setMenuItemChecked (string guimenubar, string menuTarget, string menuItemTarget, bool checkedx) @@ -23303,7 +29328,24 @@ public void fnGuiMenuBar_setMenuItemChecked (string guimenubar, string menuTarge SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemChecked(sbguimenubar, sbmenuTarget, sbmenuItemTarget, checkedx); } /// -/// @brief sets the menu item to enabled or disabled based on the enable parameter. The specified menu and menu item can either be text or ids. Detailed description @param menuTarget Menu to work in @param menuItemTarget The menu item inside of the menu to enable or disable @param enabled Boolean enable / disable value. @tsexample // Define the menu %menu = \"New Menu\"; or %menu = \"4\"; // Define the menu item %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the enabled state %enabled = \"true\"; // Inform the GuiMenuBar control to set the enabled state of the requested menu item %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); @endtsexample @see GuiTickCtrl) +/// @brief sets the menu item to enabled or disabled based on the enable parameter. +/// The specified menu and menu item can either be text or ids. +/// Detailed description +/// @param menuTarget Menu to work in +/// @param menuItemTarget The menu item inside of the menu to enable or disable +/// @param enabled Boolean enable / disable value. +/// @tsexample +/// // Define the menu +/// %menu = \"New Menu\"; or %menu = \"4\"; +/// // Define the menu item +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the enabled state +/// %enabled = \"true\"; +/// // Inform the GuiMenuBar control to set the enabled state of the requested menu item +/// %thisGuiMenuBar.setMenuItemEnable(%menu,%menuItme,%enabled); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemEnable (string guimenubar, string menuTarget, string menuItemTarget, bool enabled) @@ -23323,7 +29365,22 @@ public void fnGuiMenuBar_setMenuItemEnable (string guimenubar, string menuTarget SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemEnable(sbguimenubar, sbmenuTarget, sbmenuItemTarget, enabled); } /// -/// @brief Sets the given menu item to be a submenu. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param isSubmenu Whether or not the menuItem will become a subMenu or not @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define whether or not the Menu Item is a sub menu or not %isSubmenu = \"true\"; // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); @endtsexample @see GuiTickCtrl) +/// @brief Sets the given menu item to be a submenu. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param isSubmenu Whether or not the menuItem will become a subMenu or not +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define whether or not the Menu Item is a sub menu or not +/// %isSubmenu = \"true\"; +/// // Inform the GuiMenuBar control to set the defined menu item to be a submenu or not. +/// %thisGuiMenuBar.setMenuItemSubmenuState(%menuTarget,%menuItem,%isSubmenu); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemSubmenuState (string guimenubar, string menuTarget, string menuItem, bool isSubmenu) @@ -23343,7 +29400,22 @@ public void fnGuiMenuBar_setMenuItemSubmenuState (string guimenubar, string menu SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemSubmenuState(sbguimenubar, sbmenuTarget, sbmenuItem, isSubmenu); } /// -/// @brief Sets the text of the specified menu item to the new string. @param menuTarget Menu to affect @param menuItem Menu item in the menu to change the text at @param newMenuItemText New menu text @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the new text for the menu item %newMenuItemText = \"Very New Menu Item\"; // Inform the GuiMenuBar control to change the defined menu item with the new text %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu item to the new string. +/// @param menuTarget Menu to affect +/// @param menuItem Menu item in the menu to change the text at +/// @param newMenuItemText New menu text +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the new text for the menu item +/// %newMenuItemText = \"Very New Menu Item\"; +/// // Inform the GuiMenuBar control to change the defined menu item with the new text +/// %thisGuiMenuBar.setMenuItemText(%menuTarget,%menuItem,%newMenuItemText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemText (string guimenubar, string menuTarget, string menuItemTarget, string newMenuItemText) @@ -23366,7 +29438,23 @@ public void fnGuiMenuBar_setMenuItemText (string guimenubar, string menuTarget, SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemText(sbguimenubar, sbmenuTarget, sbmenuItemTarget, sbnewMenuItemText); } /// -/// @brief Brief Description. Detailed description @param menuTarget Menu to affect the menu item in @param menuItem Menu item to affect @param isVisible Visible state to set the menu item to. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; // Define the visibility state %isVisible = \"true\"; // Inform the GuiMenuBarControl of the visibility state of the defined menu item %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); @endtsexample @see GuiTickCtrl) +/// @brief Brief Description. +/// Detailed description +/// @param menuTarget Menu to affect the menu item in +/// @param menuItem Menu item to affect +/// @param isVisible Visible state to set the menu item to. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"2\"; +/// // Define the visibility state +/// %isVisible = \"true\"; +/// // Inform the GuiMenuBarControl of the visibility state of the defined menu item +/// %thisGuiMenuBar.setMenuItemVisible(%menuTarget,%menuItem,%isVisible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuItemVisible (string guimenubar, string menuTarget, string menuItemTarget, bool isVisible) @@ -23386,7 +29474,23 @@ public void fnGuiMenuBar_setMenuItemVisible (string guimenubar, string menuTarge SafeNativeMethods.mwle_fnGuiMenuBar_setMenuItemVisible(sbguimenubar, sbmenuTarget, sbmenuItemTarget, isVisible); } /// -/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. Detailed description @param horizontalMargin Number of pixels on the left and right side of a menu's text. @param verticalMargin Number of pixels on the top and bottom of a menu's text. @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. @tsexample // Define the horizontalMargin %horizontalMargin = \"5\"; // Define the verticalMargin %verticalMargin = \"5\"; // Define the bitmapToTextSpacing %bitmapToTextSpacing = \"12\"; // Inform the GuiMenuBar control to set its margins based on the defined values. %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); @endtsexample @see GuiTickCtrl) +/// @brief Sets the menu rendering margins: horizontal, vertical, bitmap spacing. +/// Detailed description +/// @param horizontalMargin Number of pixels on the left and right side of a menu's text. +/// @param verticalMargin Number of pixels on the top and bottom of a menu's text. +/// @param bitmapToTextSpacing Number of pixels between a menu's bitmap and text. +/// @tsexample +/// // Define the horizontalMargin +/// %horizontalMargin = \"5\"; +/// // Define the verticalMargin +/// %verticalMargin = \"5\"; +/// // Define the bitmapToTextSpacing +/// %bitmapToTextSpacing = \"12\"; +/// // Inform the GuiMenuBar control to set its margins based on the defined values. +/// %thisGuiMenuBar.setMenuMargins(%horizontalMargin,%verticalMargin,%bitmapToTextSpacing); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuMargins (string guimenubar, int horizontalMargin, int verticalMargin, int bitmapToTextSpacing) @@ -23400,7 +29504,19 @@ public void fnGuiMenuBar_setMenuMargins (string guimenubar, int horizontalMargin SafeNativeMethods.mwle_fnGuiMenuBar_setMenuMargins(sbguimenubar, horizontalMargin, verticalMargin, bitmapToTextSpacing); } /// -/// @brief Sets the text of the specified menu to the new string. @param menuTarget Menu to affect @param newMenuText New menu text @tsexample // Define the menu to affect %menu = \"New Menu\"; or %menu = \"3\"; // Define the text to change the menu to %newMenuText = \"Still a New Menu\"; // Inform the GuiMenuBar control to change the defined menu to the defined text %thisGuiMenuBar.setMenuText(%menu,%newMenuText); @endtsexample @see GuiTickCtrl) +/// @brief Sets the text of the specified menu to the new string. +/// @param menuTarget Menu to affect +/// @param newMenuText New menu text +/// @tsexample +/// // Define the menu to affect +/// %menu = \"New Menu\"; or %menu = \"3\"; +/// // Define the text to change the menu to +/// %newMenuText = \"Still a New Menu\"; +/// // Inform the GuiMenuBar control to change the defined menu to the defined text +/// %thisGuiMenuBar.setMenuText(%menu,%newMenuText); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuText (string guimenubar, string menuTarget, string newMenuText) @@ -23420,7 +29536,19 @@ public void fnGuiMenuBar_setMenuText (string guimenubar, string menuTarget, stri SafeNativeMethods.mwle_fnGuiMenuBar_setMenuText(sbguimenubar, sbmenuTarget, sbnewMenuText); } /// -/// @brief Sets the whether or not to display the specified menu. @param menuTarget Menu item to affect @param visible Whether the menu item will be visible or not @tsexample // Define the menu to work with %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; // Define if the menu should be visible or not %visible = \"true\"; // Inform the GuiMenuBar control of the new visibility state for the defined menu %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); @endtsexample @see GuiTickCtrl) +/// @brief Sets the whether or not to display the specified menu. +/// @param menuTarget Menu item to affect +/// @param visible Whether the menu item will be visible or not +/// @tsexample +/// // Define the menu to work with +/// %menuTarget = \"New Menu\"; or %menuTarget = \"4\"; +/// // Define if the menu should be visible or not +/// %visible = \"true\"; +/// // Inform the GuiMenuBar control of the new visibility state for the defined menu +/// %thisGuiMenuBar.setMenuVisible(%menuTarget,%visible); +/// @endtsexample +/// @see GuiTickCtrl) +/// /// public void fnGuiMenuBar_setMenuVisible (string guimenubar, string menuTarget, bool visible) @@ -23437,7 +29565,28 @@ public void fnGuiMenuBar_setMenuVisible (string guimenubar, string menuTarget, b SafeNativeMethods.mwle_fnGuiMenuBar_setMenuVisible(sbguimenubar, sbmenuTarget, visible); } /// -/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()). Any other menu items in the menu with the same check group become unchecked if they are checked. @param menuTarget Menu to affect a submenu in @param menuItem Menu item to affect @param submenuItemText Text to show for submenu @param checked Whether or not this submenu item will be checked. @tsexample // Define the menuTarget %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; // Define the menuItem %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; // Define the text for the new submenu %submenuItemText = \"Submenu Item\"; // Define if this submenu item should be checked or not %checked = \"true\"; // Inform the GuiMenuBar control to set the checked state of the defined submenu item %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); @endtsexample @return If not void, return value and description @see References) +/// @brief Sets the menu item bitmap to a check mark, which by default is the first element in the +/// bitmap array (although this may be changed with setCheckmarkBitmapIndex()). +/// Any other menu items in the menu with the same check group become unchecked if they are checked. +/// @param menuTarget Menu to affect a submenu in +/// @param menuItem Menu item to affect +/// @param submenuItemText Text to show for submenu +/// @param checked Whether or not this submenu item will be checked. +/// @tsexample +/// // Define the menuTarget +/// %menuTarget = \"New Menu\"; or %menuTarget = \"3\"; +/// // Define the menuItem +/// %menuItem = \"New Menu Item\"; or %menuItem = \"5\"; +/// // Define the text for the new submenu +/// %submenuItemText = \"Submenu Item\"; +/// // Define if this submenu item should be checked or not +/// %checked = \"true\"; +/// // Inform the GuiMenuBar control to set the checked state of the defined submenu item +/// %thisGuiMenuBar.setSubmenuItemChecked(%menuTarget,%menuItem,%submenuItemText,%checked); +/// @endtsexample +/// @return If not void, return value and description +/// @see References) +/// /// public void fnGuiMenuBar_setSubmenuItemChecked (string guimenubar, string menuTarget, string menuItemTarget, string submenuItemText, bool checkedx) @@ -23460,7 +29609,20 @@ public void fnGuiMenuBar_setSubmenuItemChecked (string guimenubar, string menuTa SafeNativeMethods.mwle_fnGuiMenuBar_setSubmenuItemChecked(sbguimenubar, sbmenuTarget, sbmenuItemTarget, sbsubmenuItemText, checkedx); } /// -/// @brief Push a line onto the back of the list. @param item The GUI element being pushed into the control @tsexample // All messages are stored in this HudMessageVector, the actual // MainChatHud only displays the contents of this vector. new MessageVector(HudMessageVector); // Attach the MessageVector to the chat control chatHud.attach(HudMessageVector); @endtsexample @return Value) +/// @brief Push a line onto the back of the list. +/// +/// @param item The GUI element being pushed into the control +/// +/// @tsexample +/// // All messages are stored in this HudMessageVector, the actual +/// // MainChatHud only displays the contents of this vector. +/// new MessageVector(HudMessageVector); +/// // Attach the MessageVector to the chat control +/// chatHud.attach(HudMessageVector); +/// @endtsexample +/// +/// @return Value) +/// /// public bool fnGuiMessageVectorCtrl_attach (string guimessagevectorctrl, string item) @@ -23477,7 +29639,18 @@ public bool fnGuiMessageVectorCtrl_attach (string guimessagevectorctrl, string i return SafeNativeMethods.mwle_fnGuiMessageVectorCtrl_attach(sbguimessagevectorctrl, sbitem)>=1; } /// -/// @brief Stop listing messages from the MessageVector previously attached to, if any. Detailed description @param param Description @tsexample // Deatch the MessageVector from HudMessageVector // HudMessageVector will no longer render the text chatHud.detach(); @endtsexample) +/// @brief Stop listing messages from the MessageVector previously attached to, if any. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Deatch the MessageVector from HudMessageVector +/// // HudMessageVector will no longer render the text +/// chatHud.detach(); +/// @endtsexample) +/// /// public void fnGuiMessageVectorCtrl_detach (string guimessagevectorctrl) @@ -23492,6 +29665,7 @@ public void fnGuiMessageVectorCtrl_detach (string guimessagevectorctrl) } /// /// @brief Set the MissionArea to edit.) +/// /// public void fnGuiMissionAreaCtrl_setMissionArea (string guimissionareactrl, string area) @@ -23509,6 +29683,7 @@ public void fnGuiMissionAreaCtrl_setMissionArea (string guimissionareactrl, stri } /// /// @brief Update the terrain bitmap.) +/// /// public void fnGuiMissionAreaCtrl_updateTerrain (string guimissionareactrl) @@ -23522,7 +29697,19 @@ public void fnGuiMissionAreaCtrl_updateTerrain (string guimissionareactrl) SafeNativeMethods.mwle_fnGuiMissionAreaCtrl_updateTerrain(sbguimissionareactrl); } /// -/// @brief Appends the text in the control with additional text. Also . @param text New text to append to the existing text. @param reformat If true, the control will also be visually reset (defaults to true). @tsexample // Define new text to add %text = \"New Text to Add\"; // Set reformat boolean %reformat = \"true\"; // Inform the control to add the new text %thisGuiMLTextCtrl.addText(%text,%reformat); @endtsexample @see GuiControl) +/// @brief Appends the text in the control with additional text. Also . +/// @param text New text to append to the existing text. +/// @param reformat If true, the control will also be visually reset (defaults to true). +/// @tsexample +/// // Define new text to add +/// %text = \"New Text to Add\"; +/// // Set reformat boolean +/// %reformat = \"true\"; +/// // Inform the control to add the new text +/// %thisGuiMLTextCtrl.addText(%text,%reformat); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_addText (string guimltextctrl, string text, bool reformat) @@ -23539,7 +29726,17 @@ public void fnGuiMLTextCtrl_addText (string guimltextctrl, string text, bool ref SafeNativeMethods.mwle_fnGuiMLTextCtrl_addText(sbguimltextctrl, sbtext, reformat); } /// -/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. @tsexample // Define new text to add %newText = \"BACON!\"; // Add the new text to the control %thisGuiMLTextCtrl.addText(%newText); // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. %thisGuiMLTextCtrl.forceReflow(); @endtsexample @see GuiControl) +/// @brief Forces the text control to reflow the text after new text is added, possibly resizing the control. +/// @tsexample +/// // Define new text to add +/// %newText = \"BACON!\"; +/// // Add the new text to the control +/// %thisGuiMLTextCtrl.addText(%newText); +/// // Inform the GuiMLTextCtrl object to force a reflow to ensure the added text fits properly. +/// %thisGuiMLTextCtrl.forceReflow(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_forceReflow (string guimltextctrl) @@ -23553,7 +29750,14 @@ public void fnGuiMLTextCtrl_forceReflow (string guimltextctrl) SafeNativeMethods.mwle_fnGuiMLTextCtrl_forceReflow(sbguimltextctrl); } /// -/// @brief Returns the text from the control, including TorqueML characters. @tsexample // Get the text displayed in the control %controlText = %thisGuiMLTextCtrl.getText(); @endtsexample @return Text string displayed in the control, including any TorqueML characters. @see GuiControl) +/// @brief Returns the text from the control, including TorqueML characters. +/// @tsexample +/// // Get the text displayed in the control +/// %controlText = %thisGuiMLTextCtrl.getText(); +/// @endtsexample +/// @return Text string displayed in the control, including any TorqueML characters. +/// @see GuiControl) +/// /// public string fnGuiMLTextCtrl_getText (string guimltextctrl) @@ -23570,7 +29774,13 @@ public string fnGuiMLTextCtrl_getText (string guimltextctrl) } /// -/// @brief Scroll to the bottom of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its bottom %thisGuiMLTextCtrl.scrollToBottom(); @endtsexample @see GuiControl) +/// @brief Scroll to the bottom of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its bottom +/// %thisGuiMLTextCtrl.scrollToBottom(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_scrollToBottom (string guimltextctrl) @@ -23584,7 +29794,17 @@ public void fnGuiMLTextCtrl_scrollToBottom (string guimltextctrl) SafeNativeMethods.mwle_fnGuiMLTextCtrl_scrollToBottom(sbguimltextctrl); } /// -/// @brief Scroll down to a specified tag. Detailed description @param tagID TagID to scroll the control to @tsexample // Define the TagID we want to scroll the control to %tagId = \"4\"; // Inform the GuiMLTextCtrl to scroll to the defined TagID %thisGuiMLTextCtrl.scrollToTag(%tagId); @endtsexample @see GuiControl) +/// @brief Scroll down to a specified tag. +/// Detailed description +/// @param tagID TagID to scroll the control to +/// @tsexample +/// // Define the TagID we want to scroll the control to +/// %tagId = \"4\"; +/// // Inform the GuiMLTextCtrl to scroll to the defined TagID +/// %thisGuiMLTextCtrl.scrollToTag(%tagId); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_scrollToTag (string guimltextctrl, int tagID) @@ -23598,7 +29818,13 @@ public void fnGuiMLTextCtrl_scrollToTag (string guimltextctrl, int tagID) SafeNativeMethods.mwle_fnGuiMLTextCtrl_scrollToTag(sbguimltextctrl, tagID); } /// -/// @brief Scroll to the top of the text. @tsexample // Inform GuiMLTextCtrl object to scroll to its top %thisGuiMLTextCtrl.scrollToTop(); @endtsexample @see GuiControl) +/// @brief Scroll to the top of the text. +/// @tsexample +/// // Inform GuiMLTextCtrl object to scroll to its top +/// %thisGuiMLTextCtrl.scrollToTop(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_scrollToTop (string guimltextctrl, int param1, int param2) @@ -23612,7 +29838,16 @@ public void fnGuiMLTextCtrl_scrollToTop (string guimltextctrl, int param1, int p SafeNativeMethods.mwle_fnGuiMLTextCtrl_scrollToTop(sbguimltextctrl, param1, param2); } /// -/// @brief Sets the alpha value of the control. @param alphaVal n - 1.0 floating value for the alpha @tsexample // Define the alphe value %alphaVal = \"0.5\"; // Inform the control to update its alpha value. %thisGuiMLTextCtrl.setAlpha(%alphaVal); @endtsexample @see GuiControl) +/// @brief Sets the alpha value of the control. +/// @param alphaVal n - 1.0 floating value for the alpha +/// @tsexample +/// // Define the alphe value +/// %alphaVal = \"0.5\"; +/// // Inform the control to update its alpha value. +/// %thisGuiMLTextCtrl.setAlpha(%alphaVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_setAlpha (string guimltextctrl, float alphaVal) @@ -23626,7 +29861,17 @@ public void fnGuiMLTextCtrl_setAlpha (string guimltextctrl, float alphaVal) SafeNativeMethods.mwle_fnGuiMLTextCtrl_setAlpha(sbguimltextctrl, alphaVal); } /// -/// @brief Change the text cursor's position to a new defined offset within the text in the control. @param newPos Offset to place cursor. @tsexample // Define cursor offset position %position = \"23\"; // Inform the GuiMLTextCtrl object to move the cursor to the new position. %thisGuiMLTextCtrl.setCursorPosition(%position); @endtsexample @return Returns true if the cursor position moved, or false if the position was not changed. @see GuiControl) +/// @brief Change the text cursor's position to a new defined offset within the text in the control. +/// @param newPos Offset to place cursor. +/// @tsexample +/// // Define cursor offset position +/// %position = \"23\"; +/// // Inform the GuiMLTextCtrl object to move the cursor to the new position. +/// %thisGuiMLTextCtrl.setCursorPosition(%position); +/// @endtsexample +/// @return Returns true if the cursor position moved, or false if the position was not changed. +/// @see GuiControl) +/// /// public bool fnGuiMLTextCtrl_setCursorPosition (string guimltextctrl, int newPos) @@ -23640,7 +29885,16 @@ public bool fnGuiMLTextCtrl_setCursorPosition (string guimltextctrl, int newPos) return SafeNativeMethods.mwle_fnGuiMLTextCtrl_setCursorPosition(sbguimltextctrl, newPos)>=1; } /// -/// @brief Set the text contained in the control. @param text The text to display in the control. @tsexample // Define the text to display %text = \"Nifty Control Text\"; // Set the text displayed within the control %thisGuiMLTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Set the text contained in the control. +/// @param text The text to display in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Nifty Control Text\"; +/// // Set the text displayed within the control +/// %thisGuiMLTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiMLTextCtrl_setText (string guimltextctrl, string text) @@ -23777,7 +30031,14 @@ public void fnGuiNavEditorCtrl_spawnPlayer (string guinaveditorctrl) SafeNativeMethods.mwle_fnGuiNavEditorCtrl_spawnPlayer(sbguinaveditorctrl); } /// -/// @brief Return the current multiplier for camera zooming and rotation. @tsexample // Request the current camera zooming and rotation multiplier value %multiplier = %thisGuiObjectView.getCameraSpeed(); @endtsexample @return Camera zooming / rotation multiplier value. @see GuiControl) +/// @brief Return the current multiplier for camera zooming and rotation. +/// @tsexample +/// // Request the current camera zooming and rotation multiplier value +/// %multiplier = %thisGuiObjectView.getCameraSpeed(); +/// @endtsexample +/// @return Camera zooming / rotation multiplier value. +/// @see GuiControl) +/// /// public float fnGuiObjectView_getCameraSpeed (string guiobjectview) @@ -23791,7 +30052,14 @@ public float fnGuiObjectView_getCameraSpeed (string guiobjectview) return SafeNativeMethods.mwle_fnGuiObjectView_getCameraSpeed(sbguiobjectview); } /// -/// @brief Return the model displayed in this view. @tsexample // Request the displayed model name from the GuiObjectView object. %modelName = %thisGuiObjectView.getModel(); @endtsexample @return Name of the displayed model. @see GuiControl) +/// @brief Return the model displayed in this view. +/// @tsexample +/// // Request the displayed model name from the GuiObjectView object. +/// %modelName = %thisGuiObjectView.getModel(); +/// @endtsexample +/// @return Name of the displayed model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getModel (string guiobjectview) @@ -23808,7 +30076,14 @@ public string fnGuiObjectView_getModel (string guiobjectview) } /// -/// @brief Return the name of the mounted model. @tsexample // Request the name of the mounted model from the GuiObjectView object %mountedModelName = %thisGuiObjectView.getMountedModel(); @endtsexample @return Name of the mounted model. @see GuiControl) +/// @brief Return the name of the mounted model. +/// @tsexample +/// // Request the name of the mounted model from the GuiObjectView object +/// %mountedModelName = %thisGuiObjectView.getMountedModel(); +/// @endtsexample +/// @return Name of the mounted model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getMountedModel (string guiobjectview) @@ -23825,7 +30100,14 @@ public string fnGuiObjectView_getMountedModel (string guiobjectview) } /// -/// @brief Return the name of skin used on the mounted model. @tsexample // Request the skin name from the model mounted on to the main model in the control %mountModelSkin = %thisGuiObjectView.getMountSkin(); @endtsexample @return Name of the skin used on the mounted model. @see GuiControl) +/// @brief Return the name of skin used on the mounted model. +/// @tsexample +/// // Request the skin name from the model mounted on to the main model in the control +/// %mountModelSkin = %thisGuiObjectView.getMountSkin(); +/// @endtsexample +/// @return Name of the skin used on the mounted model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getMountSkin (string guiobjectview, int param1, int param2) @@ -23842,7 +30124,14 @@ public string fnGuiObjectView_getMountSkin (string guiobjectview, int param1, in } /// -/// @brief Return the current distance at which the camera orbits the object. @tsexample // Request the current orbit distance %orbitDistance = %thisGuiObjectView.getOrbitDistance(); @endtsexample @return The distance at which the camera orbits the object. @see GuiControl) +/// @brief Return the current distance at which the camera orbits the object. +/// @tsexample +/// // Request the current orbit distance +/// %orbitDistance = %thisGuiObjectView.getOrbitDistance(); +/// @endtsexample +/// @return The distance at which the camera orbits the object. +/// @see GuiControl) +/// /// public float fnGuiObjectView_getOrbitDistance (string guiobjectview) @@ -23856,7 +30145,14 @@ public float fnGuiObjectView_getOrbitDistance (string guiobjectview) return SafeNativeMethods.mwle_fnGuiObjectView_getOrbitDistance(sbguiobjectview); } /// -/// @brief Return the name of skin used on the primary model. @tsexample // Request the name of the skin used on the primary model in the control %skinName = %thisGuiObjectView.getSkin(); @endtsexample @return Name of the skin used on the primary model. @see GuiControl) +/// @brief Return the name of skin used on the primary model. +/// @tsexample +/// // Request the name of the skin used on the primary model in the control +/// %skinName = %thisGuiObjectView.getSkin(); +/// @endtsexample +/// @return Name of the skin used on the primary model. +/// @see GuiControl) +/// /// public string fnGuiObjectView_getSkin (string guiobjectview) @@ -23873,7 +30169,16 @@ public string fnGuiObjectView_getSkin (string guiobjectview) } /// -/// @brief Sets the multiplier for the camera rotation and zoom speed. @param factor Multiplier for camera rotation and zoom speed. @tsexample // Set the factor value %factor = \"0.75\"; // Inform the GuiObjectView object to set the camera speed. %thisGuiObjectView.setCameraSpeed(%factor); @endtsexample @see GuiControl) +/// @brief Sets the multiplier for the camera rotation and zoom speed. +/// @param factor Multiplier for camera rotation and zoom speed. +/// @tsexample +/// // Set the factor value +/// %factor = \"0.75\"; +/// // Inform the GuiObjectView object to set the camera speed. +/// %thisGuiObjectView.setCameraSpeed(%factor); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setCameraSpeed (string guiobjectview, float factor) @@ -23887,7 +30192,16 @@ public void fnGuiObjectView_setCameraSpeed (string guiobjectview, float factor) SafeNativeMethods.mwle_fnGuiObjectView_setCameraSpeed(sbguiobjectview, factor); } /// -/// @brief Set the light ambient color on the sun object used to render the model. @param color Ambient color of sunlight. @tsexample // Define the sun ambient color value %color = \"1.0 0.4 0.6\"; // Inform the GuiObjectView object to set the sun ambient color to the requested value %thisGuiObjectView.setLightAmbient(%color); @endtsexample @see GuiControl) +/// @brief Set the light ambient color on the sun object used to render the model. +/// @param color Ambient color of sunlight. +/// @tsexample +/// // Define the sun ambient color value +/// %color = \"1.0 0.4 0.6\"; +/// // Inform the GuiObjectView object to set the sun ambient color to the requested value +/// %thisGuiObjectView.setLightAmbient(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setLightAmbient (string guiobjectview, string color) @@ -23904,7 +30218,16 @@ public void fnGuiObjectView_setLightAmbient (string guiobjectview, string color) SafeNativeMethods.mwle_fnGuiObjectView_setLightAmbient(sbguiobjectview, sbcolor); } /// -/// @brief Set the light color on the sun object used to render the model. @param color Color of sunlight. @tsexample // Set the color value for the sun %color = \"1.0 0.4 0.5\"; // Inform the GuiObjectView object to change the sun color to the defined value %thisGuiObjectView.setLightColor(%color); @endtsexample @see GuiControl) +/// @brief Set the light color on the sun object used to render the model. +/// @param color Color of sunlight. +/// @tsexample +/// // Set the color value for the sun +/// %color = \"1.0 0.4 0.5\"; +/// // Inform the GuiObjectView object to change the sun color to the defined value +/// %thisGuiObjectView.setLightColor(%color); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setLightColor (string guiobjectview, string color) @@ -23921,7 +30244,16 @@ public void fnGuiObjectView_setLightColor (string guiobjectview, string color) SafeNativeMethods.mwle_fnGuiObjectView_setLightColor(sbguiobjectview, sbcolor); } /// -/// @brief Set the light direction from which to light the model. @param direction XYZ direction from which the light will shine on the model @tsexample // Set the light direction %direction = \"1.0 0.2 0.4\" // Inform the GuiObjectView object to change the light direction to the defined value %thisGuiObjectView.setLightDirection(%direction); @endtsexample @see GuiControl) +/// @brief Set the light direction from which to light the model. +/// @param direction XYZ direction from which the light will shine on the model +/// @tsexample +/// // Set the light direction +/// %direction = \"1.0 0.2 0.4\" +/// // Inform the GuiObjectView object to change the light direction to the defined value +/// %thisGuiObjectView.setLightDirection(%direction); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setLightDirection (string guiobjectview, string direction) @@ -23938,7 +30270,16 @@ public void fnGuiObjectView_setLightDirection (string guiobjectview, string dire SafeNativeMethods.mwle_fnGuiObjectView_setLightDirection(sbguiobjectview, sbdirection); } /// -/// @brief Sets the model to be displayed in this control. @param shapeName Name of the model to display. @tsexample // Define the model we want to display %shapeName = \"gideon.dts\"; // Tell the GuiObjectView object to display the defined model %thisGuiObjectView.setModel(%shapeName); @endtsexample @see GuiControl) +/// @brief Sets the model to be displayed in this control. +/// @param shapeName Name of the model to display. +/// @tsexample +/// // Define the model we want to display +/// %shapeName = \"gideon.dts\"; +/// // Tell the GuiObjectView object to display the defined model +/// %thisGuiObjectView.setModel(%shapeName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setModel (string guiobjectview, string shapeName) @@ -23955,7 +30296,22 @@ public void fnGuiObjectView_setModel (string guiobjectview, string shapeName) SafeNativeMethods.mwle_fnGuiObjectView_setModel(sbguiobjectview, sbshapeName); } /// -/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. Detailed description @param shapeName Name of the model to mount. @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. @tsexample // Set the shapeName to mount %shapeName = \"GideonGlasses.dts\" // Set the mount node of the primary model in the control to mount the new shape at %mountNodeIndexOrName = \"3\"; //OR: %mountNodeIndexOrName = \"Face\"; // Inform the GuiObjectView object to mount the shape at the specified node. %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); @endtsexample @see GuiControl) +/// @brief Mounts the given model to the specified mount point of the primary model displayed in this control. +/// Detailed description +/// @param shapeName Name of the model to mount. +/// @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to \"mountN\" in your shape where N is the number passed here. +/// @tsexample +/// // Set the shapeName to mount +/// %shapeName = \"GideonGlasses.dts\" +/// // Set the mount node of the primary model in the control to mount the new shape at +/// %mountNodeIndexOrName = \"3\"; +/// //OR: +/// %mountNodeIndexOrName = \"Face\"; +/// // Inform the GuiObjectView object to mount the shape at the specified node. +/// %thisGuiObjectView.setMount(%shapeName,%mountNodeIndexOrName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setMount (string guiobjectview, string shapeName, string mountNodeIndexOrName) @@ -23975,7 +30331,16 @@ public void fnGuiObjectView_setMount (string guiobjectview, string shapeName, st SafeNativeMethods.mwle_fnGuiObjectView_setMount(sbguiobjectview, sbshapeName, sbmountNodeIndexOrName); } /// -/// @brief Sets the model to be mounted on the primary model. @param shapeName Name of the model to mount. @tsexample // Define the model name to mount %modelToMount = \"GideonGlasses.dts\"; // Inform the GuiObjectView object to mount the defined model to the existing model in the control %thisGuiObjectView.setMountedModel(%modelToMount); @endtsexample @see GuiControl) +/// @brief Sets the model to be mounted on the primary model. +/// @param shapeName Name of the model to mount. +/// @tsexample +/// // Define the model name to mount +/// %modelToMount = \"GideonGlasses.dts\"; +/// // Inform the GuiObjectView object to mount the defined model to the existing model in the control +/// %thisGuiObjectView.setMountedModel(%modelToMount); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setMountedModel (string guiobjectview, string shapeName) @@ -23992,7 +30357,16 @@ public void fnGuiObjectView_setMountedModel (string guiobjectview, string shapeN SafeNativeMethods.mwle_fnGuiObjectView_setMountedModel(sbguiobjectview, sbshapeName); } /// -/// @brief Sets the skin to use on the mounted model. @param skinName Name of the skin to set on the model mounted to the main model in the control @tsexample // Define the name of the skin %skinName = \"BronzeGlasses\"; // Inform the GuiObjectView Control of the skin to use on the mounted model %thisGuiObjectViewCtrl.setMountSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the mounted model. +/// @param skinName Name of the skin to set on the model mounted to the main model in the control +/// @tsexample +/// // Define the name of the skin +/// %skinName = \"BronzeGlasses\"; +/// // Inform the GuiObjectView Control of the skin to use on the mounted model +/// %thisGuiObjectViewCtrl.setMountSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setMountSkin (string guiobjectview, string skinName) @@ -24009,7 +30383,17 @@ public void fnGuiObjectView_setMountSkin (string guiobjectview, string skinName) SafeNativeMethods.mwle_fnGuiObjectView_setMountSkin(sbguiobjectview, sbskinName); } /// -/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. Detailed description @param distance The distance to set the orbit to (will be clamped). @tsexample // Define the orbit distance value %orbitDistance = \"1.5\"; // Inform the GuiObjectView object to set the orbit distance to the defined value %thisGuiObjectView.setOrbitDistance(%orbitDistance); @endtsexample @see GuiControl) +/// @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances. +/// Detailed description +/// @param distance The distance to set the orbit to (will be clamped). +/// @tsexample +/// // Define the orbit distance value +/// %orbitDistance = \"1.5\"; +/// // Inform the GuiObjectView object to set the orbit distance to the defined value +/// %thisGuiObjectView.setOrbitDistance(%orbitDistance); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setOrbitDistance (string guiobjectview, float distance) @@ -24023,7 +30407,18 @@ public void fnGuiObjectView_setOrbitDistance (string guiobjectview, float distan SafeNativeMethods.mwle_fnGuiObjectView_setOrbitDistance(sbguiobjectview, distance); } /// -/// @brief Sets the animation to play for the viewed object. @param indexOrName The index or name of the animation to play. @tsexample // Set the animation index value, or animation sequence name. %indexVal = \"3\"; //OR: %indexVal = \"idle\"; // Inform the GuiObjectView object to set the animation sequence of the object in the control. %thisGuiObjectVew.setSeq(%indexVal); @endtsexample @see GuiControl) +/// @brief Sets the animation to play for the viewed object. +/// @param indexOrName The index or name of the animation to play. +/// @tsexample +/// // Set the animation index value, or animation sequence name. +/// %indexVal = \"3\"; +/// //OR: +/// %indexVal = \"idle\"; +/// // Inform the GuiObjectView object to set the animation sequence of the object in the control. +/// %thisGuiObjectVew.setSeq(%indexVal); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setSeq (string guiobjectview, string indexOrName) @@ -24040,7 +30435,16 @@ public void fnGuiObjectView_setSeq (string guiobjectview, string indexOrName) SafeNativeMethods.mwle_fnGuiObjectView_setSeq(sbguiobjectview, sbindexOrName); } /// -/// @brief Sets the skin to use on the model being displayed. @param skinName Name of the skin to use. @tsexample // Define the skin we want to apply to the main model in the control %skinName = \"disco_gideon\"; // Inform the GuiObjectView control to update the skin the to defined skin %thisGuiObjectView.setSkin(%skinName); @endtsexample @see GuiControl) +/// @brief Sets the skin to use on the model being displayed. +/// @param skinName Name of the skin to use. +/// @tsexample +/// // Define the skin we want to apply to the main model in the control +/// %skinName = \"disco_gideon\"; +/// // Inform the GuiObjectView control to update the skin the to defined skin +/// %thisGuiObjectView.setSkin(%skinName); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiObjectView_setSkin (string guiobjectview, string skinName) @@ -24057,7 +30461,9 @@ public void fnGuiObjectView_setSkin (string guiobjectview, string skinName) SafeNativeMethods.mwle_fnGuiObjectView_setSkin(sbguiobjectview, sbskinName); } /// -/// Collapse or un-collapse the control. @param collapse True to collapse the control, false to un-collapse it ) +/// Collapse or un-collapse the control. +/// @param collapse True to collapse the control, false to un-collapse it ) +/// /// public void fnGuiPaneControl_setCollapsed (string guipanecontrol, bool collapse) @@ -24071,7 +30477,12 @@ public void fnGuiPaneControl_setCollapsed (string guipanecontrol, bool collapse) SafeNativeMethods.mwle_fnGuiPaneControl_setCollapsed(sbguipanecontrol, collapse); } /// -/// @brief Add a category to the list. Acts as a separator between entries, allowing for sub-lists @param text Name of the new category) +/// @brief Add a category to the list. +/// +/// Acts as a separator between entries, allowing for sub-lists +/// +/// @param text Name of the new category) +/// /// public void fnGuiPopUpMenuCtrlEx_addCategory (string guipopupmenuctrlex, string text) @@ -24088,7 +30499,12 @@ public void fnGuiPopUpMenuCtrlEx_addCategory (string guipopupmenuctrlex, string SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_addCategory(sbguipopupmenuctrlex, sbtext); } /// -/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. @param id Numerical id associated with this scheme @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// @brief Create a new scheme and add it to the list of choices for when a new text entry is added. +/// @param id Numerical id associated with this scheme +/// @param fontColor The base text font color. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorHL Color of text when being highlighted. Formatted as \"Red Green Blue\", each a numerical between 0 and 255. +/// @param fontColorSel Color of text when being selected. Formatted as \"Red Green Blue\", each a numerical between 0 and 255.) +/// /// public void fnGuiPopUpMenuCtrlEx_addScheme (string guipopupmenuctrlex, int id, string fontColor, string fontColorHL, string fontColorSEL) @@ -24112,6 +30528,7 @@ public void fnGuiPopUpMenuCtrlEx_addScheme (string guipopupmenuctrlex, int id, s } /// /// @brief Clear the popup list.) +/// /// public void fnGuiPopUpMenuCtrlEx_clear (string guipopupmenuctrlex) @@ -24126,6 +30543,7 @@ public void fnGuiPopUpMenuCtrlEx_clear (string guipopupmenuctrlex) } /// /// @brief Manually force this control to collapse and close.) +/// /// public void fnGuiPopUpMenuCtrlEx_forceClose (string guipopupmenuctrlex) @@ -24140,6 +30558,7 @@ public void fnGuiPopUpMenuCtrlEx_forceClose (string guipopupmenuctrlex) } /// /// @brief Manually for the onAction function, which updates everything in this control.) +/// /// public void fnGuiPopUpMenuCtrlEx_forceOnAction (string guipopupmenuctrlex) @@ -24153,7 +30572,9 @@ public void fnGuiPopUpMenuCtrlEx_forceOnAction (string guipopupmenuctrlex) SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_forceOnAction(sbguipopupmenuctrlex); } /// -/// @brief Get the current selection of the menu. @return Returns the ID of the currently selected entry) +/// @brief Get the current selection of the menu. +/// @return Returns the ID of the currently selected entry) +/// /// public int fnGuiPopUpMenuCtrlEx_getSelected (string guipopupmenuctrlex) @@ -24167,7 +30588,19 @@ public int fnGuiPopUpMenuCtrlEx_getSelected (string guipopupmenuctrlex) return SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_getSelected(sbguipopupmenuctrlex); } /// -/// @brief Get the. Detailed description @param param Description @tsexample // Comment code(); @endtsexample @return Returns current text in string format) +/// @brief Get the. +/// +/// Detailed description +/// +/// @param param Description +/// +/// @tsexample +/// // Comment +/// code(); +/// @endtsexample +/// +/// @return Returns current text in string format) +/// /// public string fnGuiPopUpMenuCtrlEx_getText (string guipopupmenuctrlex) @@ -24184,7 +30617,10 @@ public string fnGuiPopUpMenuCtrlEx_getText (string guipopupmenuctrlex) } /// -/// @brief Get the text of an entry based on an ID. @param id The ID assigned to the entry being queried @return String contained by the specified entry, NULL if empty or bad ID) +/// @brief Get the text of an entry based on an ID. +/// @param id The ID assigned to the entry being queried +/// @return String contained by the specified entry, NULL if empty or bad ID) +/// /// public string fnGuiPopUpMenuCtrlEx_getTextById (string guipopupmenuctrlex, int id) @@ -24202,6 +30638,7 @@ public string fnGuiPopUpMenuCtrlEx_getTextById (string guipopupmenuctrlex, int i } /// /// @brief Clears selection in the menu.) +/// /// public void fnGuiPopUpMenuCtrlEx_setNoneSelected (string guipopupmenuctrlex, int param) @@ -24215,7 +30652,9 @@ public void fnGuiPopUpMenuCtrlEx_setNoneSelected (string guipopupmenuctrlex, int SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_setNoneSelected(sbguipopupmenuctrlex, param); } /// -/// @brief Set the current text to a specified value. @param text String containing new text to set) +/// @brief Set the current text to a specified value. +/// @param text String containing new text to set) +/// /// public void fnGuiPopUpMenuCtrlEx_setText (string guipopupmenuctrlex, string text) @@ -24233,6 +30672,7 @@ public void fnGuiPopUpMenuCtrlEx_setText (string guipopupmenuctrlex, string text } /// /// @brief Sort the list alphabetically.) +/// /// public void fnGuiPopUpMenuCtrlEx_sort (string guipopupmenuctrlex) @@ -24247,6 +30687,7 @@ public void fnGuiPopUpMenuCtrlEx_sort (string guipopupmenuctrlex) } /// /// @brief Sort the list by ID.) +/// /// public void fnGuiPopUpMenuCtrlEx_sortID (string guipopupmenuctrlex) @@ -24260,7 +30701,11 @@ public void fnGuiPopUpMenuCtrlEx_sortID (string guipopupmenuctrlex) SafeNativeMethods.mwle_fnGuiPopUpMenuCtrlEx_sortID(sbguipopupmenuctrlex); } /// -/// Set the bitmap to use for rendering the progress bar. @param filename ~Path to the bitmap file. @note Directly assign to #bitmap rather than using this method. @see GuiProgressBitmapCtrl::setBitmap ) +/// Set the bitmap to use for rendering the progress bar. +/// @param filename ~Path to the bitmap file. +/// @note Directly assign to #bitmap rather than using this method. +/// @see GuiProgressBitmapCtrl::setBitmap ) +/// /// public void fnGuiProgressBitmapCtrl_setBitmap (string guiprogressbitmapctrl, string filename) @@ -24277,7 +30722,9 @@ public void fnGuiProgressBitmapCtrl_setBitmap (string guiprogressbitmapctrl, str SafeNativeMethods.mwle_fnGuiProgressBitmapCtrl_setBitmap(sbguiprogressbitmapctrl, sbfilename); } /// -/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// Collapse the rollout if it is currently expanded. This will make the rollout's child control invisible. +/// @note The rollout will animate to collapsed state. To instantly collapse without animation, use instantCollapse(). ) +/// /// public void fnGuiRolloutCtrl_collapse (string guirolloutctrl) @@ -24291,7 +30738,9 @@ public void fnGuiRolloutCtrl_collapse (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_collapse(sbguirolloutctrl); } /// -/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// Expand the rollout if it is currently collapsed. This will make the rollout's child control visible. +/// @note The rollout will animate to expanded state. To instantly expand without animation, use instantExpand(). ) +/// /// public void fnGuiRolloutCtrl_expand (string guirolloutctrl) @@ -24306,6 +30755,7 @@ public void fnGuiRolloutCtrl_expand (string guirolloutctrl) } /// /// Instantly collapse the rollout without animation. To smoothly slide the rollout to collapsed state, use collapse(). ) +/// /// public void fnGuiRolloutCtrl_instantCollapse (string guirolloutctrl) @@ -24320,6 +30770,7 @@ public void fnGuiRolloutCtrl_instantCollapse (string guirolloutctrl) } /// /// Instantly expand the rollout without animation. To smoothly slide the rollout to expanded state, use expand(). ) +/// /// public void fnGuiRolloutCtrl_instantExpand (string guirolloutctrl) @@ -24333,7 +30784,9 @@ public void fnGuiRolloutCtrl_instantExpand (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_instantExpand(sbguirolloutctrl); } /// -/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. @return True if the rollout is expanded, false if not. ) +/// Determine whether the rollout is currently expanded, i.e. whether the child control is visible. +/// @return True if the rollout is expanded, false if not. ) +/// /// public bool fnGuiRolloutCtrl_isExpanded (string guirolloutctrl) @@ -24347,7 +30800,9 @@ public bool fnGuiRolloutCtrl_isExpanded (string guirolloutctrl) return SafeNativeMethods.mwle_fnGuiRolloutCtrl_isExpanded(sbguirolloutctrl)>=1; } /// -/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of the rollout size. ) +/// Resize the rollout to exactly fit around its child control. This can be used to manually trigger a recomputation of +/// the rollout size. ) +/// /// public void fnGuiRolloutCtrl_sizeToContents (string guirolloutctrl) @@ -24361,7 +30816,9 @@ public void fnGuiRolloutCtrl_sizeToContents (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_sizeToContents(sbguirolloutctrl); } /// -/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. ) +/// Toggle the current collapse state of the rollout. If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. ) +/// /// public void fnGuiRolloutCtrl_toggleCollapse (string guirolloutctrl) @@ -24375,7 +30832,11 @@ public void fnGuiRolloutCtrl_toggleCollapse (string guirolloutctrl) SafeNativeMethods.mwle_fnGuiRolloutCtrl_toggleCollapse(sbguirolloutctrl); } /// -/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it is currently collapsed, then expand it. @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will smoothly slide into the opposite state. ) +/// Toggle the current expansion state of the rollout If it is currently expanded, then collapse it. If it +/// is currently collapsed, then expand it. +/// @param instant If true, the rollout will toggle its state without animation. Otherwise, the rollout will +/// smoothly slide into the opposite state. ) +/// /// public void fnGuiRolloutCtrl_toggleExpanded (string guirolloutctrl, bool instantly) @@ -24390,6 +30851,7 @@ public void fnGuiRolloutCtrl_toggleExpanded (string guirolloutctrl, bool instant } /// /// Refresh sizing and positioning of child controls. ) +/// /// public void fnGuiScrollCtrl_computeSizes (string guiscrollctrl) @@ -24403,7 +30865,9 @@ public void fnGuiScrollCtrl_computeSizes (string guiscrollctrl) SafeNativeMethods.mwle_fnGuiScrollCtrl_computeSizes(sbguiscrollctrl); } /// -/// Get the current coordinates of the scrolled content. @return The current position of the scrolled content. ) +/// Get the current coordinates of the scrolled content. +/// @return The current position of the scrolled content. ) +/// /// public string fnGuiScrollCtrl_getScrollPosition (string guiscrollctrl) @@ -24420,7 +30884,9 @@ public string fnGuiScrollCtrl_getScrollPosition (string guiscrollctrl) } /// -/// Get the current X coordinate of the scrolled content. @return The current X coordinate of the scrolled content. ) +/// Get the current X coordinate of the scrolled content. +/// @return The current X coordinate of the scrolled content. ) +/// /// public int fnGuiScrollCtrl_getScrollPositionX (string guiscrollctrl) @@ -24434,7 +30900,9 @@ public int fnGuiScrollCtrl_getScrollPositionX (string guiscrollctrl) return SafeNativeMethods.mwle_fnGuiScrollCtrl_getScrollPositionX(sbguiscrollctrl); } /// -/// Get the current Y coordinate of the scrolled content. @return The current Y coordinate of the scrolled content. ) +/// Get the current Y coordinate of the scrolled content. +/// @return The current Y coordinate of the scrolled content. ) +/// /// public int fnGuiScrollCtrl_getScrollPositionY (string guiscrollctrl) @@ -24449,6 +30917,7 @@ public int fnGuiScrollCtrl_getScrollPositionY (string guiscrollctrl) } /// /// Scroll all the way to the bottom of the vertical scrollbar and the left of the horizontal bar. ) +/// /// public void fnGuiScrollCtrl_scrollToBottom (string guiscrollctrl) @@ -24462,7 +30931,9 @@ public void fnGuiScrollCtrl_scrollToBottom (string guiscrollctrl) SafeNativeMethods.mwle_fnGuiScrollCtrl_scrollToBottom(sbguiscrollctrl); } /// -/// Scroll the control so that the given child @a control is visible. @param control A child control. ) +/// Scroll the control so that the given child @a control is visible. +/// @param control A child control. ) +/// /// public void fnGuiScrollCtrl_scrollToObject (string guiscrollctrl, string control) @@ -24480,6 +30951,7 @@ public void fnGuiScrollCtrl_scrollToObject (string guiscrollctrl, string control } /// /// Scroll all the way to the top of the vertical and left of the horizontal scrollbar. ) +/// /// public void fnGuiScrollCtrl_scrollToTop (string guiscrollctrl) @@ -24493,7 +30965,10 @@ public void fnGuiScrollCtrl_scrollToTop (string guiscrollctrl) SafeNativeMethods.mwle_fnGuiScrollCtrl_scrollToTop(sbguiscrollctrl); } /// -/// Set the position of the scrolled content. @param x Position on X axis. @param y Position on y axis. ) +/// Set the position of the scrolled content. +/// @param x Position on X axis. +/// @param y Position on y axis. ) +/// /// public void fnGuiScrollCtrl_setScrollPosition (string guiscrollctrl, int x, int y) @@ -24508,6 +30983,7 @@ public void fnGuiScrollCtrl_setScrollPosition (string guiscrollctrl, int x, int } /// /// Add a new thread (initially without any sequence set) ) +/// /// public void fnGuiShapeEdPreview_addThread (string guishapeedpreview) @@ -24521,7 +30997,9 @@ public void fnGuiShapeEdPreview_addThread (string guishapeedpreview) SafeNativeMethods.mwle_fnGuiShapeEdPreview_addThread(sbguishapeedpreview); } /// -/// Compute the bounding box of the shape using the current detail and node transforms @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// Compute the bounding box of the shape using the current detail and node transforms +/// @return the bounding box \"min.x min.y min.z max.x max.y max.z\" ) +/// /// public string fnGuiShapeEdPreview_computeShapeBounds (string guishapeedpreview) @@ -24538,7 +31016,11 @@ public string fnGuiShapeEdPreview_computeShapeBounds (string guishapeedpreview) } /// -/// Export the current shape and all mounted objects to COLLADA (.dae). Note that animation is not exported, and all geometry is combined into a single mesh. @param path Destination filename ) +/// Export the current shape and all mounted objects to COLLADA (.dae). +/// Note that animation is not exported, and all geometry is combined into a +/// single mesh. +/// @param path Destination filename ) +/// /// public void fnGuiShapeEdPreview_exportToCollada (string guishapeedpreview, string path) @@ -24556,6 +31038,7 @@ public void fnGuiShapeEdPreview_exportToCollada (string guishapeedpreview, strin } /// /// Adjust the camera position and zoom to fit the shape within the view. ) +/// /// public void fnGuiShapeEdPreview_fitToShape (string guishapeedpreview) @@ -24570,6 +31053,7 @@ public void fnGuiShapeEdPreview_fitToShape (string guishapeedpreview) } /// /// Return whether the named object is currently hidden ) +/// /// public bool fnGuiShapeEdPreview_getMeshHidden (string guishapeedpreview, string name) @@ -24586,7 +31070,10 @@ public bool fnGuiShapeEdPreview_getMeshHidden (string guishapeedpreview, string return SafeNativeMethods.mwle_fnGuiShapeEdPreview_getMeshHidden(sbguishapeedpreview, sbname)>=1; } /// -/// Get the playback direction of the sequence playing on this mounted shape @param slot mounted shape slot @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// Get the playback direction of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return direction of the sequence (-1=reverse, 0=paused, 1=forward) ) +/// /// public float fnGuiShapeEdPreview_getMountThreadDir (string guishapeedpreview, int slot) @@ -24600,7 +31087,10 @@ public float fnGuiShapeEdPreview_getMountThreadDir (string guishapeedpreview, in return SafeNativeMethods.mwle_fnGuiShapeEdPreview_getMountThreadDir(sbguishapeedpreview, slot); } /// -/// Get the playback position of the sequence playing on this mounted shape @param slot mounted shape slot @return playback position of the sequence (0-1) ) +/// Get the playback position of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return playback position of the sequence (0-1) ) +/// /// public float fnGuiShapeEdPreview_getMountThreadPos (string guishapeedpreview, int slot) @@ -24614,7 +31104,10 @@ public float fnGuiShapeEdPreview_getMountThreadPos (string guishapeedpreview, in return SafeNativeMethods.mwle_fnGuiShapeEdPreview_getMountThreadPos(sbguishapeedpreview, slot); } /// -/// Get the name of the sequence playing on this mounted shape @param slot mounted shape slot @return name of the sequence (if any) ) +/// Get the name of the sequence playing on this mounted shape +/// @param slot mounted shape slot +/// @return name of the sequence (if any) ) +/// /// public string fnGuiShapeEdPreview_getMountThreadSequence (string guishapeedpreview, int slot) @@ -24631,7 +31124,9 @@ public string fnGuiShapeEdPreview_getMountThreadSequence (string guishapeedprevi } /// -/// Get the number of threads @return the number of threads ) +/// Get the number of threads +/// @return the number of threads ) +/// /// public int fnGuiShapeEdPreview_getThreadCount (string guishapeedpreview) @@ -24646,6 +31141,7 @@ public int fnGuiShapeEdPreview_getThreadCount (string guishapeedpreview) } /// /// Get the name of the sequence assigned to the active thread ) +/// /// public string fnGuiShapeEdPreview_getThreadSequence (string guishapeedpreview) @@ -24662,7 +31158,12 @@ public string fnGuiShapeEdPreview_getThreadSequence (string guishapeedpreview) } /// -/// Mount a shape onto the main shape at the specified node @param shapePath path to the shape to mount @param nodeName name of the node on the main shape to mount to @param type type of mounting to use (Object, Image or Wheel) @param slot mount slot ) +/// Mount a shape onto the main shape at the specified node +/// @param shapePath path to the shape to mount +/// @param nodeName name of the node on the main shape to mount to +/// @param type type of mounting to use (Object, Image or Wheel) +/// @param slot mount slot ) +/// /// public bool fnGuiShapeEdPreview_mountShape (string guishapeedpreview, string shapePath, string nodeName, string type, int slot) @@ -24686,6 +31187,7 @@ public bool fnGuiShapeEdPreview_mountShape (string guishapeedpreview, string sha } /// /// Refresh the shape (used when the shape meshes or nodes have been added or removed) ) +/// /// public void fnGuiShapeEdPreview_refreshShape (string guishapeedpreview) @@ -24700,6 +31202,7 @@ public void fnGuiShapeEdPreview_refreshShape (string guishapeedpreview) } /// /// Refreshes thread sequences (in case of removed/renamed sequences ) +/// /// public void fnGuiShapeEdPreview_refreshThreadSequences (string guishapeedpreview) @@ -24713,7 +31216,9 @@ public void fnGuiShapeEdPreview_refreshThreadSequences (string guishapeedpreview SafeNativeMethods.mwle_fnGuiShapeEdPreview_refreshThreadSequences(sbguishapeedpreview); } /// -/// Removes the specifed thread @param slot index of the thread to remove ) +/// Removes the specifed thread +/// @param slot index of the thread to remove ) +/// /// public void fnGuiShapeEdPreview_removeThread (string guishapeedpreview, int slot) @@ -24728,6 +31233,7 @@ public void fnGuiShapeEdPreview_removeThread (string guishapeedpreview, int slot } /// /// Show or hide all objects in the shape ) +/// /// public void fnGuiShapeEdPreview_setAllMeshesHidden (string guishapeedpreview, bool hidden) @@ -24742,6 +31248,7 @@ public void fnGuiShapeEdPreview_setAllMeshesHidden (string guishapeedpreview, bo } /// /// Show or hide the named object in the shape ) +/// /// public void fnGuiShapeEdPreview_setMeshHidden (string guishapeedpreview, string name, bool hidden) @@ -24758,7 +31265,10 @@ public void fnGuiShapeEdPreview_setMeshHidden (string guishapeedpreview, string SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMeshHidden(sbguishapeedpreview, sbname, hidden); } /// -/// Sets the model to be displayed in this control @param shapeName Name of the model to display. @return True if the model was loaded successfully, false otherwise. ) +/// Sets the model to be displayed in this control +/// @param shapeName Name of the model to display. +/// @return True if the model was loaded successfully, false otherwise. ) +/// /// public bool fnGuiShapeEdPreview_setModel (string guishapeedpreview, string shapePath) @@ -24775,7 +31285,10 @@ public bool fnGuiShapeEdPreview_setModel (string guishapeedpreview, string shape return SafeNativeMethods.mwle_fnGuiShapeEdPreview_setModel(sbguishapeedpreview, sbshapePath)>=1; } /// -/// Set the node a shape is mounted to. @param slot mounted shape slot @param nodename name of the node to mount to ) +/// Set the node a shape is mounted to. +/// @param slot mounted shape slot +/// @param nodename name of the node to mount to ) +/// /// public void fnGuiShapeEdPreview_setMountNode (string guishapeedpreview, int slot, string nodeName) @@ -24792,7 +31305,10 @@ public void fnGuiShapeEdPreview_setMountNode (string guishapeedpreview, int slot SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountNode(sbguishapeedpreview, slot, sbnodeName); } /// -/// Set the playback direction of the shape mounted in the specified slot @param slot mounted shape slot @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// Set the playback direction of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param dir playback direction (-1=backwards, 0=paused, 1=forwards) ) +/// /// public void fnGuiShapeEdPreview_setMountThreadDir (string guishapeedpreview, int slot, float dir) @@ -24806,7 +31322,10 @@ public void fnGuiShapeEdPreview_setMountThreadDir (string guishapeedpreview, int SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountThreadDir(sbguishapeedpreview, slot, dir); } /// -/// Set the sequence position of the shape mounted in the specified slot @param slot mounted shape slot @param pos sequence position (0-1) ) +/// Set the sequence position of the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param pos sequence position (0-1) ) +/// /// public void fnGuiShapeEdPreview_setMountThreadPos (string guishapeedpreview, int slot, float pos) @@ -24820,7 +31339,10 @@ public void fnGuiShapeEdPreview_setMountThreadPos (string guishapeedpreview, int SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountThreadPos(sbguishapeedpreview, slot, pos); } /// -/// Set the sequence to play for the shape mounted in the specified slot @param slot mounted shape slot @param name name of the sequence to play ) +/// Set the sequence to play for the shape mounted in the specified slot +/// @param slot mounted shape slot +/// @param name name of the sequence to play ) +/// /// public void fnGuiShapeEdPreview_setMountThreadSequence (string guishapeedpreview, int slot, string name) @@ -24837,7 +31359,9 @@ public void fnGuiShapeEdPreview_setMountThreadSequence (string guishapeedpreview SafeNativeMethods.mwle_fnGuiShapeEdPreview_setMountThreadSequence(sbguishapeedpreview, slot, sbname); } /// -/// Set the camera orbit position @param pos Position in the form \"x y z\" ) +/// Set the camera orbit position +/// @param pos Position in the form \"x y z\" ) +/// /// public void fnGuiShapeEdPreview_setOrbitPos (string guishapeedpreview, string pos) @@ -24854,7 +31378,12 @@ public void fnGuiShapeEdPreview_setOrbitPos (string guishapeedpreview, string po SafeNativeMethods.mwle_fnGuiShapeEdPreview_setOrbitPos(sbguishapeedpreview, sbpos); } /// -/// Sets the sequence to play for the active thread. @param name name of the sequence to play @param duration transition duration (0 for no transition) @param pos position in the new sequence to transition to @param play if true, the new sequence will play during the transition ) +/// Sets the sequence to play for the active thread. +/// @param name name of the sequence to play +/// @param duration transition duration (0 for no transition) +/// @param pos position in the new sequence to transition to +/// @param play if true, the new sequence will play during the transition ) +/// /// public void fnGuiShapeEdPreview_setThreadSequence (string guishapeedpreview, string name, float duration, float pos, bool play) @@ -24871,7 +31400,9 @@ public void fnGuiShapeEdPreview_setThreadSequence (string guishapeedpreview, str SafeNativeMethods.mwle_fnGuiShapeEdPreview_setThreadSequence(sbguishapeedpreview, sbname, duration, pos, play); } /// -/// Set the time scale of all threads @param scale new time scale value ) +/// Set the time scale of all threads +/// @param scale new time scale value ) +/// /// public void fnGuiShapeEdPreview_setTimeScale (string guishapeedpreview, float scale) @@ -24886,6 +31417,7 @@ public void fnGuiShapeEdPreview_setTimeScale (string guishapeedpreview, float sc } /// /// Unmount all shapes ) +/// /// public void fnGuiShapeEdPreview_unmountAll (string guishapeedpreview) @@ -24899,7 +31431,9 @@ public void fnGuiShapeEdPreview_unmountAll (string guishapeedpreview) SafeNativeMethods.mwle_fnGuiShapeEdPreview_unmountAll(sbguishapeedpreview); } /// -/// Unmount the shape in the specified slot @param slot mounted shape slot ) +/// Unmount the shape in the specified slot +/// @param slot mounted shape slot ) +/// /// public void fnGuiShapeEdPreview_unmountShape (string guishapeedpreview, int slot) @@ -24914,6 +31448,7 @@ public void fnGuiShapeEdPreview_unmountShape (string guishapeedpreview, int slot } /// /// Refresh the shape node transforms (used when a node transform has been modified externally) ) +/// /// public void fnGuiShapeEdPreview_updateNodeTransforms (string guishapeedpreview) @@ -24927,7 +31462,9 @@ public void fnGuiShapeEdPreview_updateNodeTransforms (string guishapeedpreview) SafeNativeMethods.mwle_fnGuiShapeEdPreview_updateNodeTransforms(sbguishapeedpreview); } /// -/// Get the current value of the slider based on the position of the thumb. @return Slider position (from range.x to range.y). ) +/// Get the current value of the slider based on the position of the thumb. +/// @return Slider position (from range.x to range.y). ) +/// /// public float fnGuiSliderCtrl_getValue (string guisliderctrl) @@ -24941,7 +31478,10 @@ public float fnGuiSliderCtrl_getValue (string guisliderctrl) return SafeNativeMethods.mwle_fnGuiSliderCtrl_getValue(sbguisliderctrl); } /// -/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful for scrubbing type sliders where the slider position is sync'd to a changing value. When the user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// Returns true if the thumb is currently being dragged by the user. This method is mainly useful +/// for scrubbing type sliders where the slider position is sync'd to a changing value. When the +/// user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. ) +/// /// public bool fnGuiSliderCtrl_isThumbBeingDragged (string guisliderctrl) @@ -24955,7 +31495,10 @@ public bool fnGuiSliderCtrl_isThumbBeingDragged (string guisliderctrl) return SafeNativeMethods.mwle_fnGuiSliderCtrl_isThumbBeingDragged(sbguisliderctrl)>=1; } /// -/// Set position of the thumb on the slider. @param pos New slider position (from range.x to range.y) @param doCallback If true, the altCommand callback will be invoked ) +/// Set position of the thumb on the slider. +/// @param pos New slider position (from range.x to range.y) +/// @param doCallback If true, the altCommand callback will be invoked ) +/// /// public void fnGuiSliderCtrl_setValue (string guisliderctrl, float pos, bool doCallback) @@ -24969,7 +31512,14 @@ public void fnGuiSliderCtrl_setValue (string guisliderctrl, float pos, bool doCa SafeNativeMethods.mwle_fnGuiSliderCtrl_setValue(sbguisliderctrl, pos, doCallback); } /// -/// Prevents control from restacking - useful when adding or removing child controls @param freeze True to freeze the control, false to unfreeze it @tsexample %stackCtrl.freeze(true); // add controls to stack %stackCtrl.freeze(false); @endtsexample ) +/// Prevents control from restacking - useful when adding or removing child controls +/// @param freeze True to freeze the control, false to unfreeze it +/// @tsexample +/// %stackCtrl.freeze(true); +/// // add controls to stack +/// %stackCtrl.freeze(false); +/// @endtsexample ) +/// /// public void fnGuiStackControl_freeze (string guistackcontrol, bool freeze) @@ -24984,6 +31534,7 @@ public void fnGuiStackControl_freeze (string guistackcontrol, bool freeze) } /// /// Return whether or not this control is frozen ) +/// /// public bool fnGuiStackControl_isFrozen (string guistackcontrol) @@ -24998,6 +31549,7 @@ public bool fnGuiStackControl_isFrozen (string guistackcontrol) } /// /// Restack the child controls. ) +/// /// public void fnGuiStackControl_updateStack (string guistackcontrol) @@ -25011,7 +31563,11 @@ public void fnGuiStackControl_updateStack (string guistackcontrol) SafeNativeMethods.mwle_fnGuiStackControl_updateStack(sbguistackcontrol); } /// -/// Set the color of the swatch control. @param newColor The new color string given to the swatch control in float format \"r g b a\". @note It's also important to note that when setColor is called causes the control's altCommand field to be executed. ) +/// Set the color of the swatch control. +/// @param newColor The new color string given to the swatch control in float format \"r g b a\". +/// @note It's also important to note that when setColor is called causes +/// the control's altCommand field to be executed. ) +/// /// public void fnGuiSwatchButtonCtrl_setColor (string guiswatchbuttonctrl, string newColor) @@ -25028,7 +31584,10 @@ public void fnGuiSwatchButtonCtrl_setColor (string guiswatchbuttonctrl, string n SafeNativeMethods.mwle_fnGuiSwatchButtonCtrl_setColor(sbguiswatchbuttonctrl, sbnewColor); } /// -/// ), Add a new tab page to the control. @param title Title text for the tab page header. ) +/// ), +/// Add a new tab page to the control. +/// @param title Title text for the tab page header. ) +/// /// public void fnGuiTabBookCtrl_addPage (string guitabbookctrl, string title) @@ -25045,7 +31604,9 @@ public void fnGuiTabBookCtrl_addPage (string guitabbookctrl, string title) SafeNativeMethods.mwle_fnGuiTabBookCtrl_addPage(sbguitabbookctrl, sbtitle); } /// -/// Get the index of the currently selected tab page. @return Index of the selected tab page or -1 if no tab page is selected. ) +/// Get the index of the currently selected tab page. +/// @return Index of the selected tab page or -1 if no tab page is selected. ) +/// /// public int fnGuiTabBookCtrl_getSelectedPage (string guitabbookctrl) @@ -25059,7 +31620,9 @@ public int fnGuiTabBookCtrl_getSelectedPage (string guitabbookctrl) return SafeNativeMethods.mwle_fnGuiTabBookCtrl_getSelectedPage(sbguitabbookctrl); } /// -/// Set the selected tab page. @param index Index of the tab page. ) +/// Set the selected tab page. +/// @param index Index of the tab page. ) +/// /// public void fnGuiTabBookCtrl_selectPage (string guitabbookctrl, int index) @@ -25201,6 +31764,7 @@ public void fnGuiTableControl_setSelectedRow (string guitablecontrol, int rowNum } /// /// Select this page in its tab book. ) +/// /// public void fnGuiTabPageCtrl_select (string guitabpagectrl) @@ -25214,7 +31778,16 @@ public void fnGuiTabPageCtrl_select (string guitabpagectrl) SafeNativeMethods.mwle_fnGuiTabPageCtrl_select(sbguitabpagectrl); } /// -/// @brief Sets the text in the control. @param text Text to display in the control. @tsexample // Set the text to show in the control %text = \"Gideon - Destroyer of World\"; // Inform the GuiTextCtrl control to change its text to the defined value %thisGuiTextCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to display in the control. +/// @tsexample +/// // Set the text to show in the control +/// %text = \"Gideon - Destroyer of World\"; +/// // Inform the GuiTextCtrl control to change its text to the defined value +/// %thisGuiTextCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextCtrl_setText (string guitextctrl, string text) @@ -25231,7 +31804,15 @@ public void fnGuiTextCtrl_setText (string guitextctrl, string text) SafeNativeMethods.mwle_fnGuiTextCtrl_setText(sbguitextctrl, sbtext); } /// -/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. @param textID Name of variable text should be mapped to @tsexample // Inform the GuiTextCtrl control of the textID to use %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); @endtsexample @see GuiControl @see Localization) +/// @brief Maps the text ctrl to a variable used in localization, rather than raw text. +/// @param textID Name of variable text should be mapped to +/// @tsexample +/// // Inform the GuiTextCtrl control of the textID to use +/// %thisGuiTextCtrl.setTextID(\"STR_QUIT\"); +/// @endtsexample +/// @see GuiControl +/// @see Localization) +/// /// public void fnGuiTextCtrl_setTextID (string guitextctrl, string textID) @@ -25248,7 +31829,13 @@ public void fnGuiTextCtrl_setTextID (string guitextctrl, string textID) SafeNativeMethods.mwle_fnGuiTextCtrl_setTextID(sbguitextctrl, sbtextID); } /// -/// @brief Unselects all selected text in the control. @tsexample // Inform the control to unselect all of its selected text %thisGuiTextEditCtrl.clearSelectedText(); @endtsexample @see GuiControl) +/// @brief Unselects all selected text in the control. +/// @tsexample +/// // Inform the control to unselect all of its selected text +/// %thisGuiTextEditCtrl.clearSelectedText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_clearSelectedText (string guitexteditctrl) @@ -25262,7 +31849,13 @@ public void fnGuiTextEditCtrl_clearSelectedText (string guitexteditctrl) SafeNativeMethods.mwle_fnGuiTextEditCtrl_clearSelectedText(sbguitexteditctrl); } /// -/// @brief Force a validation to occur. @tsexample // Inform the control to force a validation of its text. %thisGuiTextEditCtrl.forceValidateText(); @endtsexample @see GuiControl) +/// @brief Force a validation to occur. +/// @tsexample +/// // Inform the control to force a validation of its text. +/// %thisGuiTextEditCtrl.forceValidateText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_forceValidateText (string guitexteditctrl) @@ -25276,7 +31869,14 @@ public void fnGuiTextEditCtrl_forceValidateText (string guitexteditctrl) SafeNativeMethods.mwle_fnGuiTextEditCtrl_forceValidateText(sbguitexteditctrl); } /// -/// @brief Returns the current position of the text cursor in the control. @tsexample // Acquire the cursor position in the control %position = %thisGuiTextEditCtrl.getCursorPost(); @endtsexample @return Text cursor position within the control. @see GuiControl) +/// @brief Returns the current position of the text cursor in the control. +/// @tsexample +/// // Acquire the cursor position in the control +/// %position = %thisGuiTextEditCtrl.getCursorPost(); +/// @endtsexample +/// @return Text cursor position within the control. +/// @see GuiControl) +/// /// public int fnGuiTextEditCtrl_getCursorPos (string guitexteditctrl) @@ -25290,7 +31890,14 @@ public int fnGuiTextEditCtrl_getCursorPos (string guitexteditctrl) return SafeNativeMethods.mwle_fnGuiTextEditCtrl_getCursorPos(sbguitexteditctrl); } /// -/// @brief Acquires the current text displayed in this control. @tsexample // Acquire the value of the text control. %text = %thisGuiTextEditCtrl.getText(); @endtsexample @return The current text within the control. @see GuiControl) +/// @brief Acquires the current text displayed in this control. +/// @tsexample +/// // Acquire the value of the text control. +/// %text = %thisGuiTextEditCtrl.getText(); +/// @endtsexample +/// @return The current text within the control. +/// @see GuiControl) +/// /// public string fnGuiTextEditCtrl_getText (string guitexteditctrl) @@ -25307,7 +31914,14 @@ public string fnGuiTextEditCtrl_getText (string guitexteditctrl) } /// -/// @brief Checks to see if all text in the control has been selected. @tsexample // Check to see if all text has been selected or not. %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); @endtsexample @return True if all text in the control is selected, otherwise false. @see GuiControl) +/// @brief Checks to see if all text in the control has been selected. +/// @tsexample +/// // Check to see if all text has been selected or not. +/// %allSelected = %thisGuiTextEditCtrl.isAllTextSelected(); +/// @endtsexample +/// @return True if all text in the control is selected, otherwise false. +/// @see GuiControl) +/// /// public bool fnGuiTextEditCtrl_isAllTextSelected (string guitexteditctrl) @@ -25321,7 +31935,13 @@ public bool fnGuiTextEditCtrl_isAllTextSelected (string guitexteditctrl) return SafeNativeMethods.mwle_fnGuiTextEditCtrl_isAllTextSelected(sbguitexteditctrl)>=1; } /// -/// @brief Selects all text within the control. @tsexample // Inform the control to select all of its text. %thisGuiTextEditCtrl.selectAllText(); @endtsexample @see GuiControl) +/// @brief Selects all text within the control. +/// @tsexample +/// // Inform the control to select all of its text. +/// %thisGuiTextEditCtrl.selectAllText(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_selectAllText (string guitexteditctrl) @@ -25335,7 +31955,16 @@ public void fnGuiTextEditCtrl_selectAllText (string guitexteditctrl) SafeNativeMethods.mwle_fnGuiTextEditCtrl_selectAllText(sbguitexteditctrl); } /// -/// @brief Sets the text cursor at the defined position within the control. @param position Text position to set the text cursor. @tsexample // Define the cursor position %position = \"12\"; // Inform the GuiTextEditCtrl control to place the text cursor at the defined position %thisGuiTextEditCtrl.setCursorPos(%position); @endtsexample @see GuiControl) +/// @brief Sets the text cursor at the defined position within the control. +/// @param position Text position to set the text cursor. +/// @tsexample +/// // Define the cursor position +/// %position = \"12\"; +/// // Inform the GuiTextEditCtrl control to place the text cursor at the defined position +/// %thisGuiTextEditCtrl.setCursorPos(%position); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_setCursorPos (string guitexteditctrl, int position) @@ -25349,7 +31978,16 @@ public void fnGuiTextEditCtrl_setCursorPos (string guitexteditctrl, int position SafeNativeMethods.mwle_fnGuiTextEditCtrl_setCursorPos(sbguitexteditctrl, position); } /// -/// @brief Sets the text in the control. @param text Text to place in the control. @tsexample // Define the text to display %text = \"Text!\" // Inform the GuiTextEditCtrl to display the defined text %thisGuiTextEditCtrl.setText(%text); @endtsexample @see GuiControl) +/// @brief Sets the text in the control. +/// @param text Text to place in the control. +/// @tsexample +/// // Define the text to display +/// %text = \"Text!\" +/// // Inform the GuiTextEditCtrl to display the defined text +/// %thisGuiTextEditCtrl.setText(%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextEditCtrl_setText (string guitexteditctrl, string text) @@ -25366,7 +32004,25 @@ public void fnGuiTextEditCtrl_setText (string guitexteditctrl, string text) SafeNativeMethods.mwle_fnGuiTextEditCtrl_setText(sbguitexteditctrl, sbtext); } /// -/// ,-1), @brief Adds a new row at end of the list with the defined id and text. If index is used, then the new row is inserted at the row location of 'index'. @param id Id of the new row. @param text Text to display at the new row. @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. @tsexample // Define the id %id = \"4\"; // Define the text to display %text = \"Display Text\" // Define the index (optional) %index = \"2\" // Inform the GuiTextListCtrl control to add the new row with the defined information. %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); @endtsexample @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. @see References) +/// ,-1), +/// @brief Adds a new row at end of the list with the defined id and text. +/// If index is used, then the new row is inserted at the row location of 'index'. +/// @param id Id of the new row. +/// @param text Text to display at the new row. +/// @param index Index to insert the new row at. If not used, new row will be placed at the end of the list. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text to display +/// %text = \"Display Text\" +/// // Define the index (optional) +/// %index = \"2\" +/// // Inform the GuiTextListCtrl control to add the new row with the defined information. +/// %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index); +/// @endtsexample +/// @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list. +/// @see References) +/// /// public int fnGuiTextListCtrl_addRow (string guitextlistctrl, int id, string text, int index) @@ -25383,7 +32039,13 @@ public int fnGuiTextListCtrl_addRow (string guitextlistctrl, int id, string text return SafeNativeMethods.mwle_fnGuiTextListCtrl_addRow(sbguitextlistctrl, id, sbtext, index); } /// -/// @brief Clear the list. @tsexample // Inform the GuiTextListCtrl control to clear its contents %thisGuiTextListCtrl.clear(); @endtsexample @see GuiControl) +/// @brief Clear the list. +/// @tsexample +/// // Inform the GuiTextListCtrl control to clear its contents +/// %thisGuiTextListCtrl.clear(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_clear (string guitextlistctrl) @@ -25397,7 +32059,13 @@ public void fnGuiTextListCtrl_clear (string guitextlistctrl) SafeNativeMethods.mwle_fnGuiTextListCtrl_clear(sbguitextlistctrl); } /// -/// @brief Set the selection to nothing. @tsexample // Deselect anything that is currently selected %thisGuiTextListCtrl.clearSelection(); @endtsexample @see GuiControl) +/// @brief Set the selection to nothing. +/// @tsexample +/// // Deselect anything that is currently selected +/// %thisGuiTextListCtrl.clearSelection(); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_clearSelection (string guitextlistctrl) @@ -25412,6 +32080,7 @@ public void fnGuiTextListCtrl_clearSelection (string guitextlistctrl) } /// /// ) +/// /// public int fnGuiTextListCtrl_findColumnTextIndex (string guitextlistctrl, int columnId, string columnText) @@ -25428,7 +32097,17 @@ public int fnGuiTextListCtrl_findColumnTextIndex (string guitextlistctrl, int co return SafeNativeMethods.mwle_fnGuiTextListCtrl_findColumnTextIndex(sbguitextlistctrl, columnId, sbcolumnText); } /// -/// @brief Find needle in the list, and return the row number it was found in. @param needle Text to find in the list. @tsexample // Define the text to find in the list %needle = \"Text To Find\"; // Request the row number that contains the defined text to find %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); @endtsexample @return Row number that the defined text was found in, @see GuiControl) +/// @brief Find needle in the list, and return the row number it was found in. +/// @param needle Text to find in the list. +/// @tsexample +/// // Define the text to find in the list +/// %needle = \"Text To Find\"; +/// // Request the row number that contains the defined text to find +/// %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle); +/// @endtsexample +/// @return Row number that the defined text was found in, +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_findTextIndex (string guitextlistctrl, string needle) @@ -25445,7 +32124,17 @@ public int fnGuiTextListCtrl_findTextIndex (string guitextlistctrl, string needl return SafeNativeMethods.mwle_fnGuiTextListCtrl_findTextIndex(sbguitextlistctrl, sbneedle); } /// -/// @brief Get the row ID for an index. @param index Index to get the RowID at @tsexample // Define the index %index = \"3\"; // Request the row ID at the defined index %rowId = %thisGuiTextListCtrl.getRowId(%index); @endtsexample @return RowId at the defined index. @see GuiControl) +/// @brief Get the row ID for an index. +/// @param index Index to get the RowID at +/// @tsexample +/// // Define the index +/// %index = \"3\"; +/// // Request the row ID at the defined index +/// %rowId = %thisGuiTextListCtrl.getRowId(%index); +/// @endtsexample +/// @return RowId at the defined index. +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getRowId (string guitextlistctrl, int index) @@ -25459,7 +32148,16 @@ public int fnGuiTextListCtrl_getRowId (string guitextlistctrl, int index) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getRowId(sbguitextlistctrl, index); } /// -/// @brief Get the row number for a specified id. @param id Id to get the row number at @tsexample // Define the id %id = \"4\"; // Request the row number from the GuiTextListCtrl control at the defined id. %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); @endtsexample @see GuiControl) +/// @brief Get the row number for a specified id. +/// @param id Id to get the row number at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Request the row number from the GuiTextListCtrl control at the defined id. +/// %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getRowNumById (string guitextlistctrl, int id) @@ -25473,7 +32171,17 @@ public int fnGuiTextListCtrl_getRowNumById (string guitextlistctrl, int id) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getRowNumById(sbguitextlistctrl, id); } /// -/// @brief Get the text of the row with the specified index. @param index Row index to acquire the text at. @tsexample // Define the row index %index = \"5\"; // Request the text from the row at the defined index %rowText = %thisGuiTextListCtrl.getRowText(%index); @endtsexample @return Text at the defined row index. @see GuiControl) +/// @brief Get the text of the row with the specified index. +/// @param index Row index to acquire the text at. +/// @tsexample +/// // Define the row index +/// %index = \"5\"; +/// // Request the text from the row at the defined index +/// %rowText = %thisGuiTextListCtrl.getRowText(%index); +/// @endtsexample +/// @return Text at the defined row index. +/// @see GuiControl) +/// /// public string fnGuiTextListCtrl_getRowText (string guitextlistctrl, int index) @@ -25490,7 +32198,16 @@ public string fnGuiTextListCtrl_getRowText (string guitextlistctrl, int index) } /// -/// @brief Get the text of a row with the specified id. @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to return the text at the defined row id %rowText = %thisGuiTextListCtrl.getRowTextById(%id); @endtsexample @return Row text at the requested row id. @see GuiControl) +/// @brief Get the text of a row with the specified id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to return the text at the defined row id +/// %rowText = %thisGuiTextListCtrl.getRowTextById(%id); +/// @endtsexample +/// @return Row text at the requested row id. +/// @see GuiControl) +/// /// public string fnGuiTextListCtrl_getRowTextById (string guitextlistctrl, int id) @@ -25507,7 +32224,14 @@ public string fnGuiTextListCtrl_getRowTextById (string guitextlistctrl, int id) } /// -/// @brief Get the ID of the currently selected item. @tsexample // Acquire the ID of the selected item in the list. %id = %thisGuiTextListCtrl.getSelectedId(); @endtsexample @return The id of the selected item in the list. @see GuiControl) +/// @brief Get the ID of the currently selected item. +/// @tsexample +/// // Acquire the ID of the selected item in the list. +/// %id = %thisGuiTextListCtrl.getSelectedId(); +/// @endtsexample +/// @return The id of the selected item in the list. +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getSelectedId (string guitextlistctrl) @@ -25521,7 +32245,14 @@ public int fnGuiTextListCtrl_getSelectedId (string guitextlistctrl) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getSelectedId(sbguitextlistctrl); } /// -/// @brief Returns the selected row index (not the row ID). @tsexample // Acquire the selected row index %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); @endtsexample @return Index of the selected row @see GuiControl) +/// @brief Returns the selected row index (not the row ID). +/// @tsexample +/// // Acquire the selected row index +/// %rowIndex = %thisGuiTextListCtrl.getSelectedRow(); +/// @endtsexample +/// @return Index of the selected row +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_getSelectedRow (string guitextlistctrl) @@ -25535,7 +32266,17 @@ public int fnGuiTextListCtrl_getSelectedRow (string guitextlistctrl) return SafeNativeMethods.mwle_fnGuiTextListCtrl_getSelectedRow(sbguitextlistctrl); } /// -/// @brief Check if the specified row is currently active or not. @param rowNum Row number to check the active state. @tsexample // Define the row number %rowNum = \"5\"; // Request the active state of the defined row number from the GuiTextListCtrl control. %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); @endtsexample @return Active state of the defined row number. @see GuiControl) +/// @brief Check if the specified row is currently active or not. +/// @param rowNum Row number to check the active state. +/// @tsexample +/// // Define the row number +/// %rowNum = \"5\"; +/// // Request the active state of the defined row number from the GuiTextListCtrl control. +/// %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum); +/// @endtsexample +/// @return Active state of the defined row number. +/// @see GuiControl) +/// /// public bool fnGuiTextListCtrl_isRowActive (string guitextlistctrl, int rowNum) @@ -25549,7 +32290,16 @@ public bool fnGuiTextListCtrl_isRowActive (string guitextlistctrl, int rowNum) return SafeNativeMethods.mwle_fnGuiTextListCtrl_isRowActive(sbguitextlistctrl, rowNum)>=1; } /// -/// @brief Remove a row from the table, based on its index. @param index Row index to remove from the list. @tsexample // Define the row index %index = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined row index %thisGuiTextListCtrl.removeRow(%index); @endtsexample @see GuiControl) +/// @brief Remove a row from the table, based on its index. +/// @param index Row index to remove from the list. +/// @tsexample +/// // Define the row index +/// %index = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined row index +/// %thisGuiTextListCtrl.removeRow(%index); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_removeRow (string guitextlistctrl, int index) @@ -25563,7 +32313,16 @@ public void fnGuiTextListCtrl_removeRow (string guitextlistctrl, int index) SafeNativeMethods.mwle_fnGuiTextListCtrl_removeRow(sbguitextlistctrl, index); } /// -/// @brief Remove row with the specified id. @param id Id to remove the row entry at @tsexample // Define the id %id = \"4\"; // Inform the GuiTextListCtrl control to remove the row at the defined id %thisGuiTextListCtrl.removeRowById(%id); @endtsexample @see GuiControl) +/// @brief Remove row with the specified id. +/// @param id Id to remove the row entry at +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Inform the GuiTextListCtrl control to remove the row at the defined id +/// %thisGuiTextListCtrl.removeRowById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_removeRowById (string guitextlistctrl, int id) @@ -25577,7 +32336,14 @@ public void fnGuiTextListCtrl_removeRowById (string guitextlistctrl, int id) SafeNativeMethods.mwle_fnGuiTextListCtrl_removeRowById(sbguitextlistctrl, id); } /// -/// @brief Get the number of rows. @tsexample // Get the number of rows in the list %rowCount = %thisGuiTextListCtrl.rowCount(); @endtsexample @return Number of rows in the list. @see GuiControl) +/// @brief Get the number of rows. +/// @tsexample +/// // Get the number of rows in the list +/// %rowCount = %thisGuiTextListCtrl.rowCount(); +/// @endtsexample +/// @return Number of rows in the list. +/// @see GuiControl) +/// /// public int fnGuiTextListCtrl_rowCount (string guitextlistctrl) @@ -25591,7 +32357,16 @@ public int fnGuiTextListCtrl_rowCount (string guitextlistctrl) return SafeNativeMethods.mwle_fnGuiTextListCtrl_rowCount(sbguitextlistctrl); } /// -/// @brief Scroll so the specified row is visible @param rowNum Row number to make visible @tsexample // Define the row number to make visible %rowNum = \"4\"; // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. %thisGuiTextListCtrl.scrollVisible(%rowNum); @endtsexample @see GuiControl) +/// @brief Scroll so the specified row is visible +/// @param rowNum Row number to make visible +/// @tsexample +/// // Define the row number to make visible +/// %rowNum = \"4\"; +/// // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible. +/// %thisGuiTextListCtrl.scrollVisible(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_scrollVisible (string guitextlistctrl, int rowNum) @@ -25605,7 +32380,19 @@ public void fnGuiTextListCtrl_scrollVisible (string guitextlistctrl, int rowNum) SafeNativeMethods.mwle_fnGuiTextListCtrl_scrollVisible(sbguitextlistctrl, rowNum); } /// -/// @brief Mark a specified row as active/not. @param rowNum Row number to change the active state. @param active Boolean active state to set the row number. @tsexample // Define the row number %rowNum = \"4\"; // Define the boolean active state %active = \"true\"; // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. %thisGuiTextListCtrl.setRowActive(%rowNum,%active); @endtsexample @see GuiControl) +/// @brief Mark a specified row as active/not. +/// @param rowNum Row number to change the active state. +/// @param active Boolean active state to set the row number. +/// @tsexample +/// // Define the row number +/// %rowNum = \"4\"; +/// // Define the boolean active state +/// %active = \"true\"; +/// // Informthe GuiTextListCtrl control to set the defined active state at the defined row number. +/// %thisGuiTextListCtrl.setRowActive(%rowNum,%active); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setRowActive (string guitextlistctrl, int rowNum, bool active) @@ -25619,7 +32406,19 @@ public void fnGuiTextListCtrl_setRowActive (string guitextlistctrl, int rowNum, SafeNativeMethods.mwle_fnGuiTextListCtrl_setRowActive(sbguitextlistctrl, rowNum, active); } /// -/// @brief Sets the text at the defined id. @param id Id to change. @param text Text to use at the Id. @tsexample // Define the id %id = \"4\"; // Define the text %text = \"Text To Display\"; // Inform the GuiTextListCtrl control to display the defined text at the defined id %thisGuiTextListCtrl.setRowById(%id,%text); @endtsexample @see GuiControl) +/// @brief Sets the text at the defined id. +/// @param id Id to change. +/// @param text Text to use at the Id. +/// @tsexample +/// // Define the id +/// %id = \"4\"; +/// // Define the text +/// %text = \"Text To Display\"; +/// // Inform the GuiTextListCtrl control to display the defined text at the defined id +/// %thisGuiTextListCtrl.setRowById(%id,%text); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setRowById (string guitextlistctrl, int id, string text) @@ -25636,7 +32435,16 @@ public void fnGuiTextListCtrl_setRowById (string guitextlistctrl, int id, string SafeNativeMethods.mwle_fnGuiTextListCtrl_setRowById(sbguitextlistctrl, id, sbtext); } /// -/// @brief Finds the specified entry by id, then marks its row as selected. @param id Entry within the text list to make selected. @tsexample // Define the id %id = \"5\"; // Inform the GuiTextListCtrl control to set the defined id entry as selected %thisGuiTextListCtrl.setSelectedById(%id); @endtsexample @see GuiControl) +/// @brief Finds the specified entry by id, then marks its row as selected. +/// @param id Entry within the text list to make selected. +/// @tsexample +/// // Define the id +/// %id = \"5\"; +/// // Inform the GuiTextListCtrl control to set the defined id entry as selected +/// %thisGuiTextListCtrl.setSelectedById(%id); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setSelectedById (string guitextlistctrl, int id) @@ -25650,7 +32458,15 @@ public void fnGuiTextListCtrl_setSelectedById (string guitextlistctrl, int id) SafeNativeMethods.mwle_fnGuiTextListCtrl_setSelectedById(sbguitextlistctrl, id); } /// -/// @briefSelects the specified row. @param rowNum Row number to set selected. @tsexample // Define the row number to set selected %rowNum = \"4\"; %guiTextListCtrl.setSelectedRow(%rowNum); @endtsexample @see GuiControl) +/// @briefSelects the specified row. +/// @param rowNum Row number to set selected. +/// @tsexample +/// // Define the row number to set selected +/// %rowNum = \"4\"; +/// %guiTextListCtrl.setSelectedRow(%rowNum); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_setSelectedRow (string guitextlistctrl, int rowNum) @@ -25664,7 +32480,19 @@ public void fnGuiTextListCtrl_setSelectedRow (string guitextlistctrl, int rowNum SafeNativeMethods.mwle_fnGuiTextListCtrl_setSelectedRow(sbguitextlistctrl, rowNum); } /// -/// @brief Performs a standard (alphabetical) sort on the values in the specified column. @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sort(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Performs a standard (alphabetical) sort on the values in the specified column. +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sort(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_sort (string guitextlistctrl, int columnId, bool increasing) @@ -25678,7 +32506,20 @@ public void fnGuiTextListCtrl_sort (string guitextlistctrl, int columnId, bool i SafeNativeMethods.mwle_fnGuiTextListCtrl_sort(sbguitextlistctrl, columnId, increasing); } /// -/// @brief Perform a numerical sort on the values in the specified column. Detailed description @param columnId Column ID to perform the sort on. @param increasing If false, sort will be performed in reverse. @tsexample // Define the columnId %id = \"1\"; // Define if we are increasing or not %increasing = \"false\"; // Inform the GuiTextListCtrl to perform the sort operation %thisGuiTextListCtrl.sortNumerical(%id,%increasing); @endtsexample @see GuiControl) +/// @brief Perform a numerical sort on the values in the specified column. +/// Detailed description +/// @param columnId Column ID to perform the sort on. +/// @param increasing If false, sort will be performed in reverse. +/// @tsexample +/// // Define the columnId +/// %id = \"1\"; +/// // Define if we are increasing or not +/// %increasing = \"false\"; +/// // Inform the GuiTextListCtrl to perform the sort operation +/// %thisGuiTextListCtrl.sortNumerical(%id,%increasing); +/// @endtsexample +/// @see GuiControl) +/// /// public void fnGuiTextListCtrl_sortNumerical (string guitextlistctrl, int columnID, bool increasing) @@ -25692,7 +32533,9 @@ public void fnGuiTextListCtrl_sortNumerical (string guitextlistctrl, int columnI SafeNativeMethods.mwle_fnGuiTextListCtrl_sortNumerical(sbguitextlistctrl, columnID, increasing); } /// -/// Get the current playback time. @return The elapsed playback time in seconds. ) +/// Get the current playback time. +/// @return The elapsed playback time in seconds. ) +/// /// public float fnGuiTheoraCtrl_getCurrentTime (string guitheoractrl) @@ -25706,7 +32549,9 @@ public float fnGuiTheoraCtrl_getCurrentTime (string guitheoractrl) return SafeNativeMethods.mwle_fnGuiTheoraCtrl_getCurrentTime(sbguitheoractrl); } /// -/// Test whether the video has finished playing. @return True if the video has finished playing, false otherwise. ) +/// Test whether the video has finished playing. +/// @return True if the video has finished playing, false otherwise. ) +/// /// public bool fnGuiTheoraCtrl_isPlaybackDone (string guitheoractrl) @@ -25720,7 +32565,9 @@ public bool fnGuiTheoraCtrl_isPlaybackDone (string guitheoractrl) return SafeNativeMethods.mwle_fnGuiTheoraCtrl_isPlaybackDone(sbguitheoractrl)>=1; } /// -/// Pause playback of the video. If the video is not currently playing, the call is ignored. While stopped, the control displays the last frame. ) +/// Pause playback of the video. If the video is not currently playing, the call is ignored. +/// While stopped, the control displays the last frame. ) +/// /// public void fnGuiTheoraCtrl_pause (string guitheoractrl) @@ -25735,6 +32582,7 @@ public void fnGuiTheoraCtrl_pause (string guitheoractrl) } /// /// Start playing the video. If the video is already playing, the call is ignored. ) +/// /// public void fnGuiTheoraCtrl_play (string guitheoractrl) @@ -25748,7 +32596,10 @@ public void fnGuiTheoraCtrl_play (string guitheoractrl) SafeNativeMethods.mwle_fnGuiTheoraCtrl_play(sbguitheoractrl); } /// -/// Set the video file to play. If a video is already playing, playback is stopped and the new video file is loaded. @param filename The video file to load. ) +/// Set the video file to play. If a video is already playing, playback is stopped and +/// the new video file is loaded. +/// @param filename The video file to load. ) +/// /// public void fnGuiTheoraCtrl_setFile (string guitheoractrl, string filename) @@ -25765,7 +32616,9 @@ public void fnGuiTheoraCtrl_setFile (string guitheoractrl, string filename) SafeNativeMethods.mwle_fnGuiTheoraCtrl_setFile(sbguitheoractrl, sbfilename); } /// -/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. While stopped, the control renders empty with just the background color. ) +/// Stop playback of the video. The next call to play() will then start playback from the beginning of the video. +/// While stopped, the control renders empty with just the background color. ) +/// /// public void fnGuiTheoraCtrl_stop (string guitheoractrl) @@ -25779,7 +32632,12 @@ public void fnGuiTheoraCtrl_stop (string guitheoractrl) SafeNativeMethods.mwle_fnGuiTheoraCtrl_stop(sbguitheoractrl); } /// -/// Add an item/object to the current selection. @param id ID of item/object to add to the selection. @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, the control will defer refreshing the tree and wait until addSelection() is called with this parameter set to true. ) +/// Add an item/object to the current selection. +/// @param id ID of item/object to add to the selection. +/// @param isLastSelection Whether there are more pending items/objects to be added to the selection. If false, +/// the control will defer refreshing the tree and wait until addSelection() is called with this parameter set +/// to true. ) +/// /// public void fnGuiTreeViewCtrl_addSelection (string guitreeviewctrl, int id, bool isLastSelection) @@ -25793,7 +32651,10 @@ public void fnGuiTreeViewCtrl_addSelection (string guitreeviewctrl, int id, bool SafeNativeMethods.mwle_fnGuiTreeViewCtrl_addSelection(sbguitreeviewctrl, id, isLastSelection); } /// -/// Clear the current item filtering pattern. @see setFilterText @see getFilterText ) +/// Clear the current item filtering pattern. +/// @see setFilterText +/// @see getFilterText ) +/// /// public void fnGuiTreeViewCtrl_clearFilterText (string guitreeviewctrl) @@ -25808,6 +32669,7 @@ public void fnGuiTreeViewCtrl_clearFilterText (string guitreeviewctrl) } /// /// Unselect all currently selected items. ) +/// /// public void fnGuiTreeViewCtrl_clearSelection (string guitreeviewctrl) @@ -25822,6 +32684,7 @@ public void fnGuiTreeViewCtrl_clearSelection (string guitreeviewctrl) } /// /// Delete all items/objects in the current selection. ) +/// /// public void fnGuiTreeViewCtrl_deleteSelection (string guitreeviewctrl) @@ -25835,7 +32698,12 @@ public void fnGuiTreeViewCtrl_deleteSelection (string guitreeviewctrl) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_deleteSelection(sbguitreeviewctrl); } /// -/// Get the child item of the given parent item whose text matches @a childName. @param parentId Item ID of the parent in which to look for the child. @param childName Text of the child item to find. @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. @note This method does not recurse, i.e. it only looks for direct children. ) +/// Get the child item of the given parent item whose text matches @a childName. +/// @param parentId Item ID of the parent in which to look for the child. +/// @param childName Text of the child item to find. +/// @return ID of the child item or -1 if no child in @a parentId has the given text @a childName. +/// @note This method does not recurse, i.e. it only looks for direct children. ) +/// /// public int fnGuiTreeViewCtrl_findChildItemByName (string guitreeviewctrl, int parentId, string childName) @@ -25852,7 +32720,10 @@ public int fnGuiTreeViewCtrl_findChildItemByName (string guitreeviewctrl, int pa return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_findChildItemByName(sbguitreeviewctrl, parentId, sbchildName); } /// -/// Get the ID of the item whose text matches the given @a text. @param text Item text to match. @return ID of the item or -1 if no item matches the given text. ) +/// Get the ID of the item whose text matches the given @a text. +/// @param text Item text to match. +/// @return ID of the item or -1 if no item matches the given text. ) +/// /// public int fnGuiTreeViewCtrl_findItemByName (string guitreeviewctrl, string text) @@ -25869,7 +32740,10 @@ public int fnGuiTreeViewCtrl_findItemByName (string guitreeviewctrl, string text return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_findItemByName(sbguitreeviewctrl, sbtext); } /// -/// Get the ID of the item whose value matches @a value. @param value Value text to match. @return ID of the item or -1 if no item has the given value. ) +/// Get the ID of the item whose value matches @a value. +/// @param value Value text to match. +/// @return ID of the item or -1 if no item has the given value. ) +/// /// public int fnGuiTreeViewCtrl_findItemByValue (string guitreeviewctrl, string value) @@ -25886,7 +32760,12 @@ public int fnGuiTreeViewCtrl_findItemByValue (string guitreeviewctrl, string val return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_findItemByValue(sbguitreeviewctrl, sbvalue); } /// -/// Get the current filter expression. Only tree items whose text matches this expression are displayed. By default, the expression is empty and all items are shown. @return The current filter pattern or an empty string if no filter pattern is currently active. @see setFilterText @see clearFilterText ) +/// Get the current filter expression. Only tree items whose text matches this expression +/// are displayed. By default, the expression is empty and all items are shown. +/// @return The current filter pattern or an empty string if no filter pattern is currently active. +/// @see setFilterText +/// @see clearFilterText ) +/// /// public string fnGuiTreeViewCtrl_getFilterText (string guitreeviewctrl) @@ -25903,7 +32782,9 @@ public string fnGuiTreeViewCtrl_getFilterText (string guitreeviewctrl) } /// -/// Call SimObject::setHidden( @a state ) on all objects in the current selection. @param state Visibility state to set objects in selection to. ) +/// Call SimObject::setHidden( @a state ) on all objects in the current selection. +/// @param state Visibility state to set objects in selection to. ) +/// /// public void fnGuiTreeViewCtrl_hideSelection (string guitreeviewctrl, bool state) @@ -25917,7 +32798,16 @@ public void fnGuiTreeViewCtrl_hideSelection (string guitreeviewctrl, bool state) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_hideSelection(sbguitreeviewctrl, state); } /// -/// , , 0, 0 ), Add a new item to the tree. @param parentId Item ID of parent to which to add the item as a child. 0 is root item. @param text Text to display on the item in the tree. @param value Behind-the-scenes value of the item. @param icon @param normalImage @param expandedImage @return The ID of the newly added item. ) +/// , , 0, 0 ), +/// Add a new item to the tree. +/// @param parentId Item ID of parent to which to add the item as a child. 0 is root item. +/// @param text Text to display on the item in the tree. +/// @param value Behind-the-scenes value of the item. +/// @param icon +/// @param normalImage +/// @param expandedImage +/// @return The ID of the newly added item. ) +/// /// public int fnGuiTreeViewCtrl_insertItem (string guitreeviewctrl, int parentId, string text, string value, string icon, int normalImage, int expandedImage) @@ -25941,6 +32831,7 @@ public int fnGuiTreeViewCtrl_insertItem (string guitreeviewctrl, int parentId, s } /// /// Inserts object as a child to the given parent. ) +/// /// public int fnGuiTreeViewCtrl_insertObject (string guitreeviewctrl, int parentId, string obj, bool OKToEdit) @@ -25957,7 +32848,10 @@ public int fnGuiTreeViewCtrl_insertObject (string guitreeviewctrl, int parentId, return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_insertObject(sbguitreeviewctrl, parentId, sbobj, OKToEdit); } /// -/// Check whether the given item is currently selected in the tree. @param id Item/object ID. @return True if the given item/object is currently selected in the tree. ) +/// Check whether the given item is currently selected in the tree. +/// @param id Item/object ID. +/// @return True if the given item/object is currently selected in the tree. ) +/// /// public bool fnGuiTreeViewCtrl_isItemSelected (string guitreeviewctrl, int id) @@ -25971,7 +32865,10 @@ public bool fnGuiTreeViewCtrl_isItemSelected (string guitreeviewctrl, int id) return SafeNativeMethods.mwle_fnGuiTreeViewCtrl_isItemSelected(sbguitreeviewctrl, id)>=1; } /// -/// Set whether the current selection can be changed by the user or not. @param lock If true, the current selection is frozen and cannot be changed. If false, the selection may be modified. ) +/// Set whether the current selection can be changed by the user or not. +/// @param lock If true, the current selection is frozen and cannot be changed. If false, +/// the selection may be modified. ) +/// /// public void fnGuiTreeViewCtrl_lockSelection (string guitreeviewctrl, bool lockx) @@ -25985,7 +32882,12 @@ public void fnGuiTreeViewCtrl_lockSelection (string guitreeviewctrl, bool lockx) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_lockSelection(sbguitreeviewctrl, lockx); } /// -/// Set the pattern by which to filter items in the tree. Only items in the tree whose text matches this pattern are displayed. @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. @see getFilterText @see clearFilterText ) +/// Set the pattern by which to filter items in the tree. Only items in the tree whose text +/// matches this pattern are displayed. +/// @param pattern New pattern based on which visible items in the tree should be filtered. If empty, all items become visible. +/// @see getFilterText +/// @see clearFilterText ) +/// /// public void fnGuiTreeViewCtrl_setFilterText (string guitreeviewctrl, string pattern) @@ -26003,6 +32905,7 @@ public void fnGuiTreeViewCtrl_setFilterText (string guitreeviewctrl, string patt } /// /// Toggle the hidden state of all objects in the current selection. ) +/// /// public void fnGuiTreeViewCtrl_toggleHideSelection (string guitreeviewctrl) @@ -26017,6 +32920,7 @@ public void fnGuiTreeViewCtrl_toggleHideSelection (string guitreeviewctrl) } /// /// Toggle the locked state of all objects in the current selection. ) +/// /// public void fnGuiTreeViewCtrl_toggleLockSelection (string guitreeviewctrl) @@ -26030,7 +32934,10 @@ public void fnGuiTreeViewCtrl_toggleLockSelection (string guitreeviewctrl) SafeNativeMethods.mwle_fnGuiTreeViewCtrl_toggleLockSelection(sbguitreeviewctrl); } /// -/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. @param radius Radius in world-space units which should fit in the view. @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area. +/// @param radius Radius in world-space units which should fit in the view. +/// @return The distance from the viewpoint at which the given radius would be fully visible. ) +/// /// public float fnGuiTSCtrl_calculateViewDistance (string guitsctrl, float radius) @@ -26045,6 +32952,7 @@ public float fnGuiTSCtrl_calculateViewDistance (string guitsctrl, float radius) } /// /// ) +/// /// public string fnGuiTSCtrl_getClickVector (string guitsctrl, string mousePoint) @@ -26065,6 +32973,7 @@ public string fnGuiTSCtrl_getClickVector (string guitsctrl, string mousePoint) } /// /// ) +/// /// public string fnGuiTSCtrl_getWorldPosition (string guitsctrl, string mousePoint) @@ -26084,7 +32993,9 @@ public string fnGuiTSCtrl_getWorldPosition (string guitsctrl, string mousePoint) } /// -/// Get the ratio between world-space units and pixels. @return The amount of world-space units covered by the extent of a single pixel. ) +/// Get the ratio between world-space units and pixels. +/// @return The amount of world-space units covered by the extent of a single pixel. ) +/// /// public string fnGuiTSCtrl_getWorldToScreenScale (string guitsctrl) @@ -26101,7 +33012,10 @@ public string fnGuiTSCtrl_getWorldToScreenScale (string guitsctrl) } /// -/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. @param worldPosition The world-space position to transform to screen-space. @return The ) +/// Transform world-space coordinates to screen-space (x, y, depth) coordinates. +/// @param worldPosition The world-space position to transform to screen-space. +/// @return The ) +/// /// public string fnGuiTSCtrl_project (string guitsctrl, string worldPosition) @@ -26121,7 +33035,11 @@ public string fnGuiTSCtrl_project (string guitsctrl, string worldPosition) } /// -/// Transform 3D screen-space coordinates (x, y, depth) to world space. This method can be, for example, used to find the world-space position relating to the current mouse cursor position. @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. @return The world-space position corresponding to the given screen-space coordinates. ) +/// Transform 3D screen-space coordinates (x, y, depth) to world space. +/// This method can be, for example, used to find the world-space position relating to the current mouse cursor position. +/// @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards. +/// @return The world-space position corresponding to the given screen-space coordinates. ) +/// /// public string fnGuiTSCtrl_unproject (string guitsctrl, string screenPosition) @@ -26142,6 +33060,7 @@ public string fnGuiTSCtrl_unproject (string guitsctrl, string screenPosition) } /// /// ) +/// /// public void fnGuiWindowCtrl_attachTo (string guiwindowctrl, string window) @@ -26159,6 +33078,7 @@ public void fnGuiWindowCtrl_attachTo (string guiwindowctrl, string window) } /// /// Puts the guiwindow back on the main canvas. ) +/// /// public void fnGuiWindowCtrl_ClosePopOut (string guiwindowctrl) @@ -26173,6 +33093,7 @@ public void fnGuiWindowCtrl_ClosePopOut (string guiwindowctrl) } /// /// Returns the title of the window. ) +/// /// public string fnGuiWindowCtrl_getWindowTitle (string guiwindowctrl) @@ -26190,6 +33111,7 @@ public string fnGuiWindowCtrl_getWindowTitle (string guiwindowctrl) } /// /// Returns if the title can be set or not. ) +/// /// public bool fnGuiWindowCtrl_isTitleSet (string guiwindowctrl) @@ -26204,6 +33126,7 @@ public bool fnGuiWindowCtrl_isTitleSet (string guiwindowctrl) } /// /// Puts the guiwindow on a new canvas. ) +/// /// public void fnGuiWindowCtrl_OpenPopOut (string guiwindowctrl) @@ -26218,6 +33141,7 @@ public void fnGuiWindowCtrl_OpenPopOut (string guiwindowctrl) } /// /// Bring the window to the front. ) +/// /// public void fnGuiWindowCtrl_selectWindow (string guiwindowctrl) @@ -26232,6 +33156,7 @@ public void fnGuiWindowCtrl_selectWindow (string guiwindowctrl) } /// /// Set the window's collapsing state. ) +/// /// public void fnGuiWindowCtrl_setCollapseGroup (string guiwindowctrl, bool state) @@ -26246,6 +33171,7 @@ public void fnGuiWindowCtrl_setCollapseGroup (string guiwindowctrl, bool state) } /// /// Displays the option to set the title of the window. ) +/// /// public void fnGuiWindowCtrl_setContextTitle (string guiwindowctrl, bool title) @@ -26260,6 +33186,7 @@ public void fnGuiWindowCtrl_setContextTitle (string guiwindowctrl, bool title) } /// /// Sets the title of the window. ) +/// /// public void fnGuiWindowCtrl_setWindowTitle (string guiwindowctrl, string title) @@ -26277,6 +33204,7 @@ public void fnGuiWindowCtrl_setWindowTitle (string guiwindowctrl, string title) } /// /// Toggle the window collapsing. ) +/// /// public void fnGuiWindowCtrl_toggleCollapseGroup (string guiwindowctrl) @@ -26290,7 +33218,28 @@ public void fnGuiWindowCtrl_toggleCollapseGroup (string guiwindowctrl) SafeNativeMethods.mwle_fnGuiWindowCtrl_toggleCollapseGroup(sbguiwindowctrl); } /// -/// ), @brief Send a GET command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Send the GET command to the server %httpObj.get(%url,%URI,%query); @endtsexample ) +/// ), +/// @brief Send a GET command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Optional. Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// If you were building the URL manually, this is the text that follows the question mark. For example: http://www.google.com/ig/api?b>weather=Las-Vegas,US/b> +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Send the GET command to the server +/// %httpObj.get(%url,%URI,%query); +/// @endtsexample +/// ) +/// /// public void fnHTTPObject_get (string httpobject, string Address, string requirstURI, string query) @@ -26313,7 +33262,31 @@ public void fnHTTPObject_get (string httpobject, string Address, string requirst SafeNativeMethods.mwle_fnHTTPObject_get(sbhttpobject, sbAddress, sbrequirstURI, sbquery); } /// -/// @brief Send POST command to a server to send or retrieve data. @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). @param requirstURI Specific location on the server to access (IE: \"index.php\".) @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. @param post Submission data to be processed. @note The post() method is currently non-functional. @tsexample // Create an HTTP object for communications %httpObj = new HTTPObject(); // Specify a URL to transmit to %url = \"www.garagegames.com:80\"; // Specify a URI to communicate with %URI = \"/index.php\"; // Specify a query to send. %query = \"\"; // Specify the submission data. %post = \"\"; // Send the POST command to the server %httpObj.POST(%url,%URI,%query,%post); @endtsexample ) +/// @brief Send POST command to a server to send or retrieve data. +/// +/// @param Address HTTP web address to send this get call to. Be sure to include the port at the end (IE: \"www.garagegames.com:80\"). +/// @param requirstURI Specific location on the server to access (IE: \"index.php\".) +/// @param query Actual data to transmit to the server. Can be anything required providing it sticks with limitations of the HTTP protocol. +/// @param post Submission data to be processed. +/// +/// @note The post() method is currently non-functional. +/// +/// @tsexample +/// // Create an HTTP object for communications +/// %httpObj = new HTTPObject(); +/// // Specify a URL to transmit to +/// %url = \"www.garagegames.com:80\"; +/// // Specify a URI to communicate with +/// %URI = \"/index.php\"; +/// // Specify a query to send. +/// %query = \"\"; +/// // Specify the submission data. +/// %post = \"\"; +/// // Send the POST command to the server +/// %httpObj.POST(%url,%URI,%query,%post); +/// @endtsexample +/// ) +/// /// public void fnHTTPObject_post (string httpobject, string Address, string requirstURI, string query, string post) @@ -26339,7 +33312,15 @@ public void fnHTTPObject_post (string httpobject, string Address, string requirs SafeNativeMethods.mwle_fnHTTPObject_post(sbhttpobject, sbAddress, sbrequirstURI, sbquery, sbpost); } /// -/// @brief Get the normal of the surface on which the object is stuck. @return Returns The XYZ normal from where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the normal of the surface on which the object is stuck. +/// @return Returns The XYZ normal from where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string fnItem_getLastStickyNormal (string item) @@ -26356,7 +33337,15 @@ public string fnItem_getLastStickyNormal (string item) } /// -/// @brief Get the position on the surface on which this Item is stuck. @return Returns The XYZ position of where this Item is stuck. @tsexample // Acquire the position where this Item is currently stuck %stuckPosition = %item.getLastStickPos(); @endtsexample @note Server side only. ) +/// @brief Get the position on the surface on which this Item is stuck. +/// @return Returns The XYZ position of where this Item is stuck. +/// @tsexample +/// // Acquire the position where this Item is currently stuck +/// %stuckPosition = %item.getLastStickPos(); +/// @endtsexample +/// @note Server side only. +/// ) +/// /// public string fnItem_getLastStickyPos (string item) @@ -26373,7 +33362,14 @@ public string fnItem_getLastStickyPos (string item) } /// -/// @brief Is the object at rest (ie, no longer moving)? @return True if the object is at rest, false if it is not. @tsexample // Query the item on if it is or is not at rest. %isAtRest = %item.isAtRest(); @endtsexample ) +/// @brief Is the object at rest (ie, no longer moving)? +/// @return True if the object is at rest, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not at rest. +/// %isAtRest = %item.isAtRest(); +/// @endtsexample +/// ) +/// /// public bool fnItem_isAtRest (string item) @@ -26387,7 +33383,15 @@ public bool fnItem_isAtRest (string item) return SafeNativeMethods.mwle_fnItem_isAtRest(sbitem)>=1; } /// -/// @brief Is the object still rotating? @return True if the object is still rotating, false if it is not. @tsexample // Query the item on if it is or is not rotating. %isRotating = %itemData.isRotating(); @endtsexample @see rotate ) +/// @brief Is the object still rotating? +/// @return True if the object is still rotating, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not rotating. +/// %isRotating = %itemData.isRotating(); +/// @endtsexample +/// @see rotate +/// ) +/// /// public bool fnItem_isRotating (string item) @@ -26401,7 +33405,15 @@ public bool fnItem_isRotating (string item) return SafeNativeMethods.mwle_fnItem_isRotating(sbitem)>=1; } /// -/// @brief Is the object static (ie, non-movable)? @return True if the object is static, false if it is not. @tsexample // Query the item on if it is or is not static. %isStatic = %itemData.isStatic(); @endtsexample @see static ) +/// @brief Is the object static (ie, non-movable)? +/// @return True if the object is static, false if it is not. +/// @tsexample +/// // Query the item on if it is or is not static. +/// %isStatic = %itemData.isStatic(); +/// @endtsexample +/// @see static +/// ) +/// /// public bool fnItem_isStatic (string item) @@ -26415,7 +33427,23 @@ public bool fnItem_isStatic (string item) return SafeNativeMethods.mwle_fnItem_isStatic(sbitem)>=1; } /// -/// @brief Temporarily disable collisions against a specific ShapeBase object. This is useful to prevent a player from immediately picking up an Item they have just thrown. Only one object may be on the timeout list at a time. The timeout is defined as 15 ticks. @param objectID ShapeBase object ID to disable collisions against. @return Returns true if the ShapeBase object requested could be found, false if it could not. @tsexample // Set the ShapeBase Object ID to disable collisions against %ignoreColObj = %player.getID(); // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. %item.setCollisionTimeout(%ignoreColObj); @endtsexample ) +/// @brief Temporarily disable collisions against a specific ShapeBase object. +/// +/// This is useful to prevent a player from immediately picking up an Item they have +/// just thrown. Only one object may be on the timeout list at a time. The timeout is +/// defined as 15 ticks. +/// +/// @param objectID ShapeBase object ID to disable collisions against. +/// @return Returns true if the ShapeBase object requested could be found, false if it could not. +/// +/// @tsexample +/// // Set the ShapeBase Object ID to disable collisions against +/// %ignoreColObj = %player.getID(); +/// // Inform this Item object to ignore collisions temproarily against the %ignoreColObj. +/// %item.setCollisionTimeout(%ignoreColObj); +/// @endtsexample +/// ) +/// /// public bool fnItem_setCollisionTimeout (string item, int ignoreColObj) @@ -26430,6 +33458,7 @@ public bool fnItem_setCollisionTimeout (string item, int ignoreColObj) } /// /// ( LevelInfo, setNearClip, void, 3, 3, ( F32 nearClip )) +/// /// public void fnLevelInfo_setNearClip (string levelinfo, string a2) @@ -26446,7 +33475,19 @@ public void fnLevelInfo_setNearClip (string levelinfo, string a2) SafeNativeMethods.mwle_fnLevelInfo_setNearClip(sblevelinfo, sba2); } /// -/// @brief Toggles the light on and off @param state Turns the light on (true) or off (false) @tsexample // Disable the light CrystalLight.setLightEnabled(false); // Renable the light CrystalLight.setLightEnabled(true); @endtsexample) +/// @brief Toggles the light on and off +/// +/// @param state Turns the light on (true) or off (false) +/// +/// @tsexample +/// // Disable the light +/// CrystalLight.setLightEnabled(false); +/// // Renable the light +/// CrystalLight.setLightEnabled(true); +/// +/// @endtsexample +/// ) +/// /// public void fnLightBase_setLightEnabled (string lightbase, bool state) @@ -26460,7 +33501,22 @@ public void fnLightBase_setLightEnabled (string lightbase, bool state) SafeNativeMethods.mwle_fnLightBase_setLightEnabled(sblightbase, state); } /// -/// @brief Force an inspectPostApply call for the benefit of tweaking via the console Normally this functionality is only exposed to objects via the World Editor, once changes have been made. Exposing apply to script allows you to make changes to it on the fly without the World Editor. @note This is intended for debugging and tweaking, not for game play @tsexample // Change a property of the light description RocketLauncherLightDesc.brightness = 10; // Make it so RocketLauncherLightDesc.apply(); @endtsexample) +/// @brief Force an inspectPostApply call for the benefit of tweaking via the console +/// +/// Normally this functionality is only exposed to objects via the World Editor, once changes have been made. +/// Exposing apply to script allows you to make changes to it on the fly without the World Editor. +/// +/// @note This is intended for debugging and tweaking, not for game play +/// +/// @tsexample +/// // Change a property of the light description +/// RocketLauncherLightDesc.brightness = 10; +/// // Make it so +/// RocketLauncherLightDesc.apply(); +/// +/// @endtsexample +/// ) +/// /// public void fnLightDescription_apply (string lightdescription) @@ -26474,7 +33530,10 @@ public void fnLightDescription_apply (string lightdescription) SafeNativeMethods.mwle_fnLightDescription_apply(sblightdescription); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply +/// ) +/// /// public void fnLightFlareData_apply (string lightflaredata) @@ -26488,7 +33547,9 @@ public void fnLightFlareData_apply (string lightflaredata) SafeNativeMethods.mwle_fnLightFlareData_apply(sblightflaredata); } /// -/// Creates a LightningStrikeEvent which strikes a specific object. @note This method is currently unimplemented. ) +/// Creates a LightningStrikeEvent which strikes a specific object. +/// @note This method is currently unimplemented. ) +/// /// public void fnLightning_strikeObject (string lightning, string pSB) @@ -26505,7 +33566,13 @@ public void fnLightning_strikeObject (string lightning, string pSB) SafeNativeMethods.mwle_fnLightning_strikeObject(sblightning, sbpSB); } /// -/// Creates a LightningStrikeEvent which attempts to strike and damage a random object in range of the Lightning object. @tsexample // Generate a damaging lightning strike effect on all clients %lightning.strikeRandomPoint(); @endtsexample ) +/// Creates a LightningStrikeEvent which attempts to strike and damage a random +/// object in range of the Lightning object. +/// @tsexample +/// // Generate a damaging lightning strike effect on all clients +/// %lightning.strikeRandomPoint(); +/// @endtsexample ) +/// /// public void fnLightning_strikeRandomPoint (string lightning) @@ -26519,7 +33586,14 @@ public void fnLightning_strikeRandomPoint (string lightning) SafeNativeMethods.mwle_fnLightning_strikeRandomPoint(sblightning); } /// -/// @brief Creates a LightningStrikeEvent that triggers harmless lightning bolts on all clients. No objects will be damaged by these bolts. @tsexample // Generate a harmless lightning strike effect on all clients %lightning.warningFlashes(); @endtsexample ) +/// @brief Creates a LightningStrikeEvent that triggers harmless lightning +/// bolts on all clients. +/// No objects will be damaged by these bolts. +/// @tsexample +/// // Generate a harmless lightning strike effect on all clients +/// %lightning.warningFlashes(); +/// @endtsexample ) +/// /// public void fnLightning_warningFlashes (string lightning) @@ -26533,7 +33607,11 @@ public void fnLightning_warningFlashes (string lightning) SafeNativeMethods.mwle_fnLightning_warningFlashes(sblightning); } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void fnMeshRoad_postApply (string meshroad) @@ -26547,7 +33625,10 @@ public void fnMeshRoad_postApply (string meshroad) SafeNativeMethods.mwle_fnMeshRoad_postApply(sbmeshroad); } /// -/// Intended as a helper to developers and editor scripts. Force MeshRoad to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force MeshRoad to recreate its geometry. +/// ) +/// /// public void fnMeshRoad_regenerate (string meshroad) @@ -26561,7 +33642,10 @@ public void fnMeshRoad_regenerate (string meshroad) SafeNativeMethods.mwle_fnMeshRoad_regenerate(sbmeshroad); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void fnMeshRoad_setNodeDepth (string meshroad, int idx, float meters) @@ -26575,7 +33659,11 @@ public void fnMeshRoad_setNodeDepth (string meshroad, int idx, float meters) SafeNativeMethods.mwle_fnMeshRoad_setNodeDepth(sbmeshroad, idx, meters); } /// -/// Clear all messages in the vector @tsexample HudMessageVector.clear(); @endtsexample) +/// Clear all messages in the vector +/// @tsexample +/// HudMessageVector.clear(); +/// @endtsexample) +/// /// public void fnMessageVector_clear (string messagevector) @@ -26589,7 +33677,14 @@ public void fnMessageVector_clear (string messagevector) SafeNativeMethods.mwle_fnMessageVector_clear(sbmessagevector); } /// -/// Delete the line at the specified position. @param deletePos Position in the vector containing the line to be deleted @tsexample // Delete the first line (index 0) in the vector... HudMessageVector.deleteLine(0); @endtsexample @return False if deletePos is greater than the number of lines in the current vector) +/// Delete the line at the specified position. +/// @param deletePos Position in the vector containing the line to be deleted +/// @tsexample +/// // Delete the first line (index 0) in the vector... +/// HudMessageVector.deleteLine(0); +/// @endtsexample +/// @return False if deletePos is greater than the number of lines in the current vector) +/// /// public bool fnMessageVector_deleteLine (string messagevector, int deletePos) @@ -26603,7 +33698,15 @@ public bool fnMessageVector_deleteLine (string messagevector, int deletePos) return SafeNativeMethods.mwle_fnMessageVector_deleteLine(sbmessagevector, deletePos)>=1; } /// -/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate a line of text tagged with the value \"1\", then delete it. %taggedLine = HudMessageVector.getLineIndexByTag(1); HudMessageVector.deleteLine(%taggedLine); @endtsexample @return Line with matching tag, other wise -1) +/// Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate a line of text tagged with the value \"1\", then delete it. +/// %taggedLine = HudMessageVector.getLineIndexByTag(1); +/// HudMessageVector.deleteLine(%taggedLine); +/// @endtsexample +/// @return Line with matching tag, other wise -1) +/// /// public int fnMessageVector_getLineIndexByTag (string messagevector, int tag) @@ -26617,7 +33720,20 @@ public int fnMessageVector_getLineIndexByTag (string messagevector, int tag) return SafeNativeMethods.mwle_fnMessageVector_getLineIndexByTag(sbmessagevector, tag); } /// -/// Get the tag of a specified line. @param pos Position in vector to grab tag from @tsexample // Remove all lines that do not have a tag value of 1. while( HudMessageVector.getNumLines()) { %tag = HudMessageVector.getLineTag(1); if(%tag != 1) %tag.delete(); HudMessageVector.popFrontLine(); } @endtsexample @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// Get the tag of a specified line. +/// @param pos Position in vector to grab tag from +/// @tsexample +/// // Remove all lines that do not have a tag value of 1. +/// while( HudMessageVector.getNumLines()) +/// { +/// %tag = HudMessageVector.getLineTag(1); +/// if(%tag != 1) +/// %tag.delete(); +/// HudMessageVector.popFrontLine(); +/// } +/// @endtsexample +/// @return Tag value of a given line, if the position is greater than the number of lines return 0) +/// /// public int fnMessageVector_getLineTag (string messagevector, int pos) @@ -26631,7 +33747,15 @@ public int fnMessageVector_getLineTag (string messagevector, int pos) return SafeNativeMethods.mwle_fnMessageVector_getLineTag(sbmessagevector, pos); } /// -/// Get the text at a specified line. @param pos Position in vector to grab text from @tsexample // Print a line of text at position 1. %text = HudMessageVector.getLineText(1); echo(%text); @endtsexample @return Text at specified line, if the position is greater than the number of lines return \"\") +/// Get the text at a specified line. +/// @param pos Position in vector to grab text from +/// @tsexample +/// // Print a line of text at position 1. +/// %text = HudMessageVector.getLineText(1); +/// echo(%text); +/// @endtsexample +/// @return Text at specified line, if the position is greater than the number of lines return \"\") +/// /// public string fnMessageVector_getLineText (string messagevector, int pos) @@ -26648,7 +33772,15 @@ public string fnMessageVector_getLineText (string messagevector, int pos) } /// -/// Scan through the lines in the vector, returning the first line that has a matching tag. @param tag Numerical value assigned to a message when it was added or inserted @tsexample // Locate text in the vector tagged with the value \"1\", then print it %taggedText = HudMessageVector.getLineTextByTag(1); echo(%taggedText); @endtsexample @return Text from a line with matching tag, other wise \"\") +/// Scan through the lines in the vector, returning the first line that has a matching tag. +/// @param tag Numerical value assigned to a message when it was added or inserted +/// @tsexample +/// // Locate text in the vector tagged with the value \"1\", then print it +/// %taggedText = HudMessageVector.getLineTextByTag(1); +/// echo(%taggedText); +/// @endtsexample +/// @return Text from a line with matching tag, other wise \"\") +/// /// public string fnMessageVector_getLineTextByTag (string messagevector, int tag) @@ -26665,7 +33797,13 @@ public string fnMessageVector_getLineTextByTag (string messagevector, int tag) } /// -/// Get the number of lines in the vector. @tsexample // Find out how many lines have been stored in HudMessageVector %chatLines = HudMessageVector.getNumLines(); echo(%chatLines); @endtsexample) +/// Get the number of lines in the vector. +/// @tsexample +/// // Find out how many lines have been stored in HudMessageVector +/// %chatLines = HudMessageVector.getNumLines(); +/// echo(%chatLines); +/// @endtsexample) +/// /// public int fnMessageVector_getNumLines (string messagevector) @@ -26679,7 +33817,15 @@ public int fnMessageVector_getNumLines (string messagevector) return SafeNativeMethods.mwle_fnMessageVector_getNumLines(sbmessagevector); } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.insertLine(1, \"Hello World\", 0); @endtsexample @return False if insertPos is greater than the number of lines in the current vector) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.insertLine(1, \"Hello World\", 0); +/// @endtsexample +/// @return False if insertPos is greater than the number of lines in the current vector) +/// /// public bool fnMessageVector_insertLine (string messagevector, int insertPos, string msg, int tag) @@ -26696,7 +33842,12 @@ public bool fnMessageVector_insertLine (string messagevector, int insertPos, str return SafeNativeMethods.mwle_fnMessageVector_insertLine(sbmessagevector, insertPos, sbmsg, tag)>=1; } /// -/// Pop a line from the back of the list; destroys the line. @tsexample HudMessageVector.popBackLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the back of the list; destroys the line. +/// @tsexample +/// HudMessageVector.popBackLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool fnMessageVector_popBackLine (string messagevector) @@ -26710,7 +33861,12 @@ public bool fnMessageVector_popBackLine (string messagevector) return SafeNativeMethods.mwle_fnMessageVector_popBackLine(sbmessagevector)>=1; } /// -/// Pop a line from the front of the vector, destroying the line. @tsexample HudMessageVector.popFrontLine(); @endtsexample @return False if there are no lines to pop (underflow), true otherwise) +/// Pop a line from the front of the vector, destroying the line. +/// @tsexample +/// HudMessageVector.popFrontLine(); +/// @endtsexample +/// @return False if there are no lines to pop (underflow), true otherwise) +/// /// public bool fnMessageVector_popFrontLine (string messagevector) @@ -26724,7 +33880,14 @@ public bool fnMessageVector_popFrontLine (string messagevector) return SafeNativeMethods.mwle_fnMessageVector_popFrontLine(sbmessagevector)>=1; } /// -/// Push a line onto the back of the list. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushBackLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the back of the list. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushBackLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void fnMessageVector_pushBackLine (string messagevector, string msg, int tag) @@ -26741,7 +33904,14 @@ public void fnMessageVector_pushBackLine (string messagevector, string msg, int SafeNativeMethods.mwle_fnMessageVector_pushBackLine(sbmessagevector, sbmsg, tag); } /// -/// Push a line onto the front of the vector. @param msg Text that makes up the message @param tag Numerical value associated with this message, useful for searching. @tsexample // Add the message... HudMessageVector.pushFrontLine(\"Hello World\", 0); @endtsexample) +/// Push a line onto the front of the vector. +/// @param msg Text that makes up the message +/// @param tag Numerical value associated with this message, useful for searching. +/// @tsexample +/// // Add the message... +/// HudMessageVector.pushFrontLine(\"Hello World\", 0); +/// @endtsexample) +/// /// public void fnMessageVector_pushFrontLine (string messagevector, string msg, int tag) @@ -26759,6 +33929,7 @@ public void fnMessageVector_pushFrontLine (string messagevector, string msg, int } /// /// Returns 4 fields: starting x, starting y, extents x, extents y.) +/// /// public string fnMissionArea_getArea (string missionarea) @@ -26775,7 +33946,11 @@ public string fnMissionArea_getArea (string missionarea) } /// -/// Intended as a helper to developers and editor scripts. Force trigger an inspectPostApply. This will transmit material and other fields ( not including nodes ) to client objects. ) +/// Intended as a helper to developers and editor scripts. +/// Force trigger an inspectPostApply. This will transmit +/// material and other fields ( not including nodes ) to client objects. +/// ) +/// /// public void fnMissionArea_postApply (string missionarea) @@ -26789,7 +33964,14 @@ public void fnMissionArea_postApply (string missionarea) SafeNativeMethods.mwle_fnMissionArea_postApply(sbmissionarea); } /// -/// @brief - Defines the size of the MissionArea param x Starting X coordinate position for MissionArea param y Starting Y coordinate position for MissionArea param width New width of the MissionArea param height New height of the MissionArea @note Only the server object may be set. ) +/// @brief - Defines the size of the MissionArea +/// param x Starting X coordinate position for MissionArea +/// param y Starting Y coordinate position for MissionArea +/// param width New width of the MissionArea +/// param height New height of the MissionArea +/// @note Only the server object may be set. +/// ) +/// /// public void fnMissionArea_setArea (string missionarea, int x, int y, int width, int height) @@ -27191,7 +34373,15 @@ public int fnNavPath_size (string navpath) return SafeNativeMethods.mwle_fnNavPath_size(sbnavpath); } /// -/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. This method is normally only called when a NetConnection class is first constructed. It need only be manually called if the global variables that set the packet rate or size have changed. @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize have been changed since a NetConnection has been created, this method must be called on all connections for them to follow the new rates or size.) +/// @brief Ensures that all configured packet rates and sizes meet minimum requirements. +/// +/// This method is normally only called when a NetConnection class is first constructed. It need +/// only be manually called if the global variables that set the packet rate or size have changed. +/// +/// @note If @$pref::Net::PacketRateToServer, @$pref::Net::PacketRateToClient or @$pref::Net::PacketSize +/// have been changed since a NetConnection has been created, this method must be called on +/// all connections for them to follow the new rates or size.) +/// /// public void fnNetConnection_checkMaxRate (string netconnection) @@ -27205,7 +34395,27 @@ public void fnNetConnection_checkMaxRate (string netconnection) SafeNativeMethods.mwle_fnNetConnection_checkMaxRate(sbnetconnection); } /// -/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. Typically when a mission has ended on the server, all connected clients are informed of this change and their connections are reset back to a starting state. This method resets a connection on the server to indicate that motion spline paths have not been transmitted. @tsexample // Inform the clients for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) { // clear ghosts and paths from all clients %cl = ClientGroup.getObject(%clientIndex); %cl.endMission(); %cl.resetGhosting(); %cl.clearPaths(); } @endtsexample @see transmitPaths() @see Path) +/// @brief On the server, resets the connection to indicate that motion spline paths have not been transmitted. +/// +/// Typically when a mission has ended on the server, all connected clients are informed of this change +/// and their connections are reset back to a starting state. This method resets a connection on the +/// server to indicate that motion spline paths have not been transmitted. +/// +/// @tsexample +/// // Inform the clients +/// for (%clientIndex = 0; %clientIndex ClientGroup.getCount(); %clientIndex++) +/// { +/// // clear ghosts and paths from all clients +/// %cl = ClientGroup.getObject(%clientIndex); +/// %cl.endMission(); +/// %cl.resetGhosting(); +/// %cl.clearPaths(); +/// } +/// @endtsexample +/// +/// @see transmitPaths() +/// @see Path) +/// /// public void fnNetConnection_clearPaths (string netconnection) @@ -27219,7 +34429,23 @@ public void fnNetConnection_clearPaths (string netconnection) SafeNativeMethods.mwle_fnNetConnection_clearPaths(sbnetconnection); } /// -/// @brief Connects to the remote address. Attempts to connect with another NetConnection on the given address. Typically once connected, a game's information is passed along from the server to the client, followed by the player entering the game world. The actual procedure is dependent on the NetConnection subclass that is used. i.e. GameConnection. @param remoteAddress The address to connect to in the form of IP:address>:port although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also substitue the word i>broadcast/i> for the address to broadcast the connect request over the local subnet. @see NetConnection::connectLocal() to connect to a server running within the same process as the client. ) +/// @brief Connects to the remote address. +/// +/// Attempts to connect with another NetConnection on the given address. Typically once +/// connected, a game's information is passed along from the server to the client, followed +/// by the player entering the game world. The actual procedure is dependent on +/// the NetConnection subclass that is used. i.e. GameConnection. +/// +/// @param remoteAddress The address to connect to in the form of IP:address>:port +/// although the i>IP:/i> portion is optional. The i>address/i> portion may be in the form +/// of w.x.y.z or as a host name, in which case a DNS lookup will be performed. You may also +/// substitue the word i>broadcast/i> for the address to broadcast the connect request over +/// the local subnet. +/// +/// @see NetConnection::connectLocal() to connect to a server running within the same process +/// as the client. +/// ) +/// /// public void fnNetConnection_connect (string netconnection, string remoteAddress) @@ -27236,7 +34462,13 @@ public void fnNetConnection_connect (string netconnection, string remoteAddress) SafeNativeMethods.mwle_fnNetConnection_connect(sbnetconnection, sbremoteAddress); } /// -/// @brief Connects with the server that is running within the same process as the client. @returns An error text message upon failure, or an empty string when successful. @see See @ref local_connections for a description of local connections and their use. See NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// @brief Connects with the server that is running within the same process as the client. +/// +/// @returns An error text message upon failure, or an empty string when successful. +/// +/// @see See @ref local_connections for a description of local connections and their use. See +/// NetConnection::connect() to connect to a server running in another process (on the same machine or not).) +/// /// public string fnNetConnection_connectLocal (string netconnection) @@ -27253,7 +34485,13 @@ public string fnNetConnection_connectLocal (string netconnection) } /// -/// @brief Returns the far end network address for the connection. The address will be in one of the following forms: - b>IP:Broadcast:port>/b> for broadcast type addresses - b>IP:address>:port>/b> for IP addresses - b>local/b> when connected locally (server and client running in same process) +/// @brief Returns the far end network address for the connection. +/// +/// The address will be in one of the following forms: +/// - b>IP:Broadcast:port>/b> for broadcast type addresses +/// - b>IP:address>:port>/b> for IP addresses +/// - b>local/b> when connected locally (server and client running in same process) +/// /// public string fnNetConnection_getAddress (string netconnection) @@ -27270,7 +34508,16 @@ public string fnNetConnection_getAddress (string netconnection) } /// -/// @brief On server or client, convert a real id to the ghost id for this connection. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server or client to discover an object's ghost ID based on its real SimObject ID. @param realID The real SimObject ID of the object. @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On server or client, convert a real id to the ghost id for this connection. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server or client to discover an object's ghost ID based on its real SimObject ID. +/// +/// @param realID The real SimObject ID of the object. +/// @returns The ghost ID of the object for this connection, or -1 if it could not be resolved. +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_getGhostID (string netconnection, int realID) @@ -27303,7 +34550,10 @@ public int fnNetConnection_GetGhostIndex (string netconnection, string obj) return SafeNativeMethods.mwle_fnNetConnection_GetGhostIndex(sbnetconnection, sbobj); } /// -/// @brief Provides the number of active ghosts on the connection. @returns The number of active ghosts. @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief Provides the number of active ghosts on the connection. +/// @returns The number of active ghosts. +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_getGhostsActive (string netconnection) @@ -27317,7 +34567,10 @@ public int fnNetConnection_getGhostsActive (string netconnection) return SafeNativeMethods.mwle_fnNetConnection_getGhostsActive(sbnetconnection); } /// -/// @brief Returns the percentage of packets lost per tick. @note This method is not yet hooked up.) +/// @brief Returns the percentage of packets lost per tick. +/// +/// @note This method is not yet hooked up.) +/// /// public int fnNetConnection_getPacketLoss (string netconnection) @@ -27331,7 +34584,12 @@ public int fnNetConnection_getPacketLoss (string netconnection) return SafeNativeMethods.mwle_fnNetConnection_getPacketLoss(sbnetconnection); } /// -/// @brief Returns the average round trip time (in ms) for the connection. The round trip time is recalculated every time a notify packet is received. Notify packets are used to information the connection that the far end successfully received the sent packet.) +/// @brief Returns the average round trip time (in ms) for the connection. +/// +/// The round trip time is recalculated every time a notify packet is received. Notify +/// packets are used to information the connection that the far end successfully received +/// the sent packet.) +/// /// public int fnNetConnection_getPing (string netconnection) @@ -27361,7 +34619,21 @@ public int fnNetConnection_ResolveGhost (string netconnection, int ghostIndex) return SafeNativeMethods.mwle_fnNetConnection_ResolveGhost(sbnetconnection, ghostIndex); } /// -/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the client to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = ServerConnection.resolveGhostID( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the client, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the client to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = ServerConnection.resolveGhostID( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_resolveGhostID (string netconnection, int ghostID) @@ -27375,7 +34647,21 @@ public int fnNetConnection_resolveGhostID (string netconnection, int ghostID) return SafeNativeMethods.mwle_fnNetConnection_resolveGhostID(sbnetconnection, ghostID); } /// -/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. Torque's network ghosting system only exchanges ghost ID's between the server and client. Use this method on the server to discover an object's local SimObject ID when you only have a ghost ID. @param ghostID The ghost ID of the object as sent by the server. @returns The SimObject ID of the object, or 0 if it could not be resolved. @tsexample %object = %client.resolveObjectFromGhostIndex( %ghostId ); @endtsexample @see @ref ghosting_scoping for a description of the ghosting system.) +/// @brief On the server, convert a ghost ID from this connection to a real SimObject ID. +/// +/// Torque's network ghosting system only exchanges ghost ID's between the server and client. Use +/// this method on the server to discover an object's local SimObject ID when you only have a +/// ghost ID. +/// +/// @param ghostID The ghost ID of the object as sent by the server. +/// @returns The SimObject ID of the object, or 0 if it could not be resolved. +/// +/// @tsexample +/// %object = %client.resolveObjectFromGhostIndex( %ghostId ); +/// @endtsexample +/// +/// @see @ref ghosting_scoping for a description of the ghosting system.) +/// /// public int fnNetConnection_resolveObjectFromGhostIndex (string netconnection, int ghostID) @@ -27389,7 +34675,12 @@ public int fnNetConnection_resolveObjectFromGhostIndex (string netconnection, in return SafeNativeMethods.mwle_fnNetConnection_resolveObjectFromGhostIndex(sbnetconnection, ghostID); } /// -/// @brief Simulate network issues on the connection for testing. @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute integer, measured in ms.) +/// @brief Simulate network issues on the connection for testing. +/// +/// @param packetLoss The fraction of packets that will be lost. Ranges from 0.0 (no loss) to 1.0 (complete loss) +/// @param delay Delays packets being transmitted by simulating a particular ping. This is an absolute +/// integer, measured in ms.) +/// /// public void fnNetConnection_setSimulatedNetParams (string netconnection, float packetLoss, int delay) @@ -27403,7 +34694,44 @@ public void fnNetConnection_setSimulatedNetParams (string netconnection, float p SafeNativeMethods.mwle_fnNetConnection_setSimulatedNetParams(sbnetconnection, packetLoss, delay); } /// -/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. The server transmits all spline motion paths that are within the mission (Path) separate from other objects. This is due to the potentially large number of nodes within each path, which may saturate a packet sent to the client. By managing this step separately, Torque has finer control over how packets are organised vs. doing it during the ghosting stage. Internally a PathManager is used to track all paths defined within a mission on the server, and each one is transmitted using a PathManagerEvent. The client side collects these events and builds the given paths within its own PathManager. This is typically done during the standard mission start phase 2 when following Torque's example mission startup sequence. When a mission is ended, all paths need to be cleared from their respective path managers. @tsexample function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) { // Make sure to ignore calls from a previous mission load if (%seq != $missionSequence || !$MissionRunning) return; if (%client.currentPhase != 1.5) return; %client.currentPhase = 2; // Set the player datablock choice %client.playerDB = %playerDB; // Update mission paths (SimPath), this needs to get there before the objects. %client.transmitPaths(); // Start ghosting objects to the client %client.activateGhosting(); } @endtsexample @see clearPaths() @see Path) +/// @brief Sent by the server during phase 2 of the mission download to update motion spline paths. +/// +/// The server transmits all spline motion paths that are within the mission (Path) separate from +/// other objects. This is due to the potentially large number of nodes within each path, which may +/// saturate a packet sent to the client. By managing this step separately, Torque has finer control +/// over how packets are organised vs. doing it during the ghosting stage. +/// +/// Internally a PathManager is used to track all paths defined within a mission on the server, and each +/// one is transmitted using a PathManagerEvent. The client side collects these events and builds the +/// given paths within its own PathManager. This is typically done during the standard mission start +/// phase 2 when following Torque's example mission startup sequence. +/// +/// When a mission is ended, all paths need to be cleared from their respective path managers. +/// +/// @tsexample +/// function serverCmdMissionStartPhase2Ack(%client, %seq, %playerDB) +/// { +/// // Make sure to ignore calls from a previous mission load +/// if (%seq != $missionSequence || !$MissionRunning) +/// return; +/// if (%client.currentPhase != 1.5) +/// return; +/// %client.currentPhase = 2; +/// +/// // Set the player datablock choice +/// %client.playerDB = %playerDB; +/// +/// // Update mission paths (SimPath), this needs to get there before the objects. +/// %client.transmitPaths(); +/// +/// // Start ghosting objects to the client +/// %client.activateGhosting(); +/// } +/// @endtsexample +/// +/// @see clearPaths() +/// @see Path) +/// /// public void fnNetConnection_transmitPaths (string netconnection) @@ -27417,7 +34745,12 @@ public void fnNetConnection_transmitPaths (string netconnection) SafeNativeMethods.mwle_fnNetConnection_transmitPaths(sbnetconnection); } /// -/// @brief Undo the effects of a scopeToClient() call. @param client The connection to remove this object's scoping from @see scopeToClient()) +/// @brief Undo the effects of a scopeToClient() call. +/// +/// @param client The connection to remove this object's scoping from +/// +/// @see scopeToClient()) +/// /// public void fnNetObject_clearScopeToClient (string netobject, string client) @@ -27434,7 +34767,22 @@ public void fnNetObject_clearScopeToClient (string netobject, string client) SafeNativeMethods.mwle_fnNetObject_clearScopeToClient(sbnetobject, sbclient); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. @returns the SimObject ID of the client object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %clientObject = %node.getClientObject(); if(isObject(%clientObject) %clientObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Networking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns the SimObject ID of the client object. +/// +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %clientObject = %node.getClientObject(); +/// if(isObject(%clientObject) +/// %clientObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int fnNetObject_getClientObject (string netobject) @@ -27448,7 +34796,14 @@ public int fnNetObject_getClientObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_getClientObject(sbnetobject); } /// -/// @brief Get the ghost index of this object from the server. @returns The ghost ID of this NetObject on the server @tsexample %ghostID = LocalClientConnection.getGhostId( %serverObject ); @endtsexample) +/// @brief Get the ghost index of this object from the server. +/// +/// @returns The ghost ID of this NetObject on the server +/// +/// @tsexample +/// %ghostID = LocalClientConnection.getGhostId( %serverObject ); +/// @endtsexample) +/// /// public int fnNetObject_getGhostID (string netobject) @@ -27462,7 +34817,21 @@ public int fnNetObject_getGhostID (string netobject) return SafeNativeMethods.mwle_fnNetObject_getGhostID(sbnetobject); } /// -/// @brief Returns a pointer to the client object when on a local connection. Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. @returns The SimObject ID of the server object. @tsexample // Psuedo-code, some values left out for this example %node = new ParticleEmitterNode(){}; %serverObject = %node.getServerObject(); if(isObject(%serverObject) %serverObject.setTransform(\"0 0 0\"); @endtsexample @see @ref local_connections) +/// @brief Returns a pointer to the client object when on a local connection. +/// +/// Short-Circuit-Netorking: this is only valid for a local-client / singleplayer situation. +/// +/// @returns The SimObject ID of the server object. +/// @tsexample +/// // Psuedo-code, some values left out for this example +/// %node = new ParticleEmitterNode(){}; +/// %serverObject = %node.getServerObject(); +/// if(isObject(%serverObject) +/// %serverObject.setTransform(\"0 0 0\"); +/// @endtsexample +/// +/// @see @ref local_connections) +/// /// public int fnNetObject_getServerObject (string netobject) @@ -27476,7 +34845,9 @@ public int fnNetObject_getServerObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_getServerObject(sbnetobject); } /// -/// @brief Called to check if an object resides on the clientside. @return True if the object resides on the client, false otherwise.) +/// @brief Called to check if an object resides on the clientside. +/// @return True if the object resides on the client, false otherwise.) +/// /// public bool fnNetObject_isClientObject (string netobject) @@ -27490,7 +34861,9 @@ public bool fnNetObject_isClientObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_isClientObject(sbnetobject)>=1; } /// -/// @brief Checks if an object resides on the server. @return True if the object resides on the server, false otherwise.) +/// @brief Checks if an object resides on the server. +/// @return True if the object resides on the server, false otherwise.) +/// /// public bool fnNetObject_isServerObject (string netobject) @@ -27504,7 +34877,29 @@ public bool fnNetObject_isServerObject (string netobject) return SafeNativeMethods.mwle_fnNetObject_isServerObject(sbnetobject)>=1; } /// -/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. @param client The connection this object will always be scoped to @tsexample // Called to create new cameras in TorqueScript // %this - The active GameConnection // %spawnPoint - The spawn point location where we creat the camera function GameConnection::spawnCamera(%this, %spawnPoint) { // If this connection's camera exists if(isObject(%this.camera)) { // Add it to the mission group to be cleaned up later MissionCleanup.add( %this.camera ); // Force it to scope to the client side %this.camera.scopeToClient(%this); } } @endtsexample @see clearScopeToClient()) +/// @brief Cause the NetObject to be forced as scoped on the specified NetConnection. +/// +/// @param client The connection this object will always be scoped to +/// +/// @tsexample +/// // Called to create new cameras in TorqueScript +/// // %this - The active GameConnection +/// // %spawnPoint - The spawn point location where we creat the camera +/// function GameConnection::spawnCamera(%this, %spawnPoint) +/// { +/// // If this connection's camera exists +/// if(isObject(%this.camera)) +/// { +/// // Add it to the mission group to be cleaned up later +/// MissionCleanup.add( %this.camera ); +/// // Force it to scope to the client side +/// %this.camera.scopeToClient(%this); +/// } +/// } +/// @endtsexample +/// +/// @see clearScopeToClient()) +/// /// public void fnNetObject_scopeToClient (string netobject, string client) @@ -27521,7 +34916,12 @@ public void fnNetObject_scopeToClient (string netobject, string client) SafeNativeMethods.mwle_fnNetObject_scopeToClient(sbnetobject, sbclient); } /// -/// @brief Always scope this object on all connections. The object is marked as ScopeAlways and is immediately ghosted to all active connections. This function has no effect if the object is not marked as Ghostable.) +/// @brief Always scope this object on all connections. +/// +/// The object is marked as ScopeAlways and is immediately ghosted to +/// all active connections. This function has no effect if the object +/// is not marked as Ghostable.) +/// /// public void fnNetObject_setScopeAlways (string netobject) @@ -27535,7 +34935,16 @@ public void fnNetObject_setScopeAlways (string netobject) SafeNativeMethods.mwle_fnNetObject_setScopeAlways(sbnetobject); } /// -/// Reloads this particle. @tsexample // Get the editor's current particle %particle = PE_ParticleEditor.currParticle // Change a particle value %particle.setFieldValue( %propertyField, %value ); // Reload it %particle.reload(); @endtsexample ) +/// Reloads this particle. +/// @tsexample +/// // Get the editor's current particle +/// %particle = PE_ParticleEditor.currParticle +/// // Change a particle value +/// %particle.setFieldValue( %propertyField, %value ); +/// // Reload it +/// %particle.reload(); +/// @endtsexample ) +/// /// public void fnParticleData_reload (string particledata) @@ -27549,7 +34958,16 @@ public void fnParticleData_reload (string particledata) SafeNativeMethods.mwle_fnParticleData_reload(sbparticledata); } /// -/// Reloads the ParticleData datablocks and other fields used by this emitter. @tsexample // Get the editor's current particle emitter %emitter = PE_EmitterEditor.currEmitter // Change a field value %emitter.setFieldValue( %propertyField, %value ); // Reload this emitter %emitter.reload(); @endtsexample) +/// Reloads the ParticleData datablocks and other fields used by this emitter. +/// @tsexample +/// // Get the editor's current particle emitter +/// %emitter = PE_EmitterEditor.currEmitter +/// // Change a field value +/// %emitter.setFieldValue( %propertyField, %value ); +/// // Reload this emitter +/// %emitter.reload(); +/// @endtsexample) +/// /// public void fnParticleEmitterData_reload (string particleemitterdata) @@ -27563,7 +34981,9 @@ public void fnParticleEmitterData_reload (string particleemitterdata) SafeNativeMethods.mwle_fnParticleEmitterData_reload(sbparticleemitterdata); } /// -/// Turns the emitter on or off. @param active New emitter state ) +/// Turns the emitter on or off. +/// @param active New emitter state ) +/// /// public void fnParticleEmitterNode_setActive (string particleemitternode, bool active) @@ -27577,7 +34997,13 @@ public void fnParticleEmitterNode_setActive (string particleemitternode, bool ac SafeNativeMethods.mwle_fnParticleEmitterNode_setActive(sbparticleemitternode, active); } /// -/// Assigns the datablock for this emitter node. @param emitterDatablock ParticleEmitterData datablock to assign @tsexample // Assign a new emitter datablock %emitter.setEmitterDatablock( %emitterDatablock ); @endtsexample ) +/// Assigns the datablock for this emitter node. +/// @param emitterDatablock ParticleEmitterData datablock to assign +/// @tsexample +/// // Assign a new emitter datablock +/// %emitter.setEmitterDatablock( %emitterDatablock ); +/// @endtsexample ) +/// /// public void fnParticleEmitterNode_setEmitterDataBlock (string particleemitternode, string emitterDatablock) @@ -27594,7 +35020,12 @@ public void fnParticleEmitterNode_setEmitterDataBlock (string particleemitternod SafeNativeMethods.mwle_fnParticleEmitterNode_setEmitterDataBlock(sbparticleemitternode, sbemitterDatablock); } /// -/// Removes the knot at the front of the camera's path. @tsexample // Remove the first knot in the camera's path. %pathCamera.popFront(); @endtsexample) +/// Removes the knot at the front of the camera's path. +/// @tsexample +/// // Remove the first knot in the camera's path. +/// %pathCamera.popFront(); +/// @endtsexample) +/// /// public void fnPathCamera_popFront (string pathcamera) @@ -27608,7 +35039,25 @@ public void fnPathCamera_popFront (string pathcamera) SafeNativeMethods.mwle_fnPathCamera_popFront(sbpathcamera); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the back of its path %pathCamera.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the back of its path +/// %pathCamera.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void fnPathCamera_pushBack (string pathcamera, string transform, float speed, string type, string path) @@ -27631,7 +35080,25 @@ public void fnPathCamera_pushBack (string pathcamera, string transform, float sp SafeNativeMethods.mwle_fnPathCamera_pushBack(sbpathcamera, sbtransform, speed, sbtype, sbpath); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path camera's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the path camera to add a new knot to the front of its path %pathCamera.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path camera's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the path camera to add a new knot to the front of its path +/// %pathCamera.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void fnPathCamera_pushFront (string pathcamera, string transform, float speed, string type, string path) @@ -27654,7 +35121,20 @@ public void fnPathCamera_pushFront (string pathcamera, string transform, float s SafeNativeMethods.mwle_fnPathCamera_pushFront(sbpathcamera, sbtransform, speed, sbtype, sbpath); } /// -/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. What specifically occurs is a new knot is created from the camera's current transform. Then the current path is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement state is set to Forward. The camera is now ready for a new path to be defined. @param speed Speed for the camera to move along its path after being reset. @tsexample //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. %speed = \"0.50\"; // Inform the path camera to start a new path at // the camera's current position, and set the new // path's speed value. %pathCamera.reset(%speed); @endtsexample) +/// @brief Clear the camera's path and set the camera's current transform as the start of the new path. +/// What specifically occurs is a new knot is created from the camera's current transform. Then the current path +/// is cleared and the new knot is pushed onto the path. Any previous target is cleared and the camera's movement +/// state is set to Forward. The camera is now ready for a new path to be defined. +/// @param speed Speed for the camera to move along its path after being reset. +/// @tsexample +/// //Determine the new movement speed of this camera. If not set, the speed will default to 1.0. +/// %speed = \"0.50\"; +/// // Inform the path camera to start a new path at +/// // the camera's current position, and set the new +/// // path's speed value. +/// %pathCamera.reset(%speed); +/// @endtsexample) +/// /// public void fnPathCamera_reset (string pathcamera, float speed) @@ -27668,7 +35148,15 @@ public void fnPathCamera_reset (string pathcamera, float speed) SafeNativeMethods.mwle_fnPathCamera_reset(sbpathcamera, speed); } /// -/// Set the current position of the camera along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. @tsexample // Set the camera on a position along its path from 0.0 - 1.0. %position = \"0.35\"; // Force the pathCamera to its new position along the path. %pathCamera.setPosition(%position); @endtsexample) +/// Set the current position of the camera along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the camera. +/// @tsexample +/// // Set the camera on a position along its path from 0.0 - 1.0. +/// %position = \"0.35\"; +/// // Force the pathCamera to its new position along the path. +/// %pathCamera.setPosition(%position); +/// @endtsexample) +/// /// public void fnPathCamera_setPosition (string pathcamera, float position) @@ -27682,7 +35170,17 @@ public void fnPathCamera_setPosition (string pathcamera, float position) SafeNativeMethods.mwle_fnPathCamera_setPosition(sbpathcamera, position); } /// -/// forward), Set the movement state for this path camera. @param newState New movement state type for this camera. Forward, Backward or Stop. @tsexample // Set the state type (forward, backward, stop). // In this example, the camera will travel from the first node // to the last node (or target if given with setTarget()) %state = \"forward\"; // Inform the pathCamera to change its movement state to the defined value. %pathCamera.setState(%state); @endtsexample) +/// forward), Set the movement state for this path camera. +/// @param newState New movement state type for this camera. Forward, Backward or Stop. +/// @tsexample +/// // Set the state type (forward, backward, stop). +/// // In this example, the camera will travel from the first node +/// // to the last node (or target if given with setTarget()) +/// %state = \"forward\"; +/// // Inform the pathCamera to change its movement state to the defined value. +/// %pathCamera.setState(%state); +/// @endtsexample) +/// /// public void fnPathCamera_setState (string pathcamera, string newState) @@ -27699,7 +35197,18 @@ public void fnPathCamera_setState (string pathcamera, string newState) SafeNativeMethods.mwle_fnPathCamera_setState(sbpathcamera, sbnewState); } /// -/// @brief Set the movement target for this camera along its path. The camera will attempt to move along the path to the given target in the direction provided by setState() (the default is forwards). Once the camera moves past this target it will come to a stop, and the target state will be cleared. @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. @tsexample // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. %position = \"0.50\"; // Inform the pathCamera of the new target position it will move to. %pathCamera.setTarget(%position); @endtsexample) +/// @brief Set the movement target for this camera along its path. +/// The camera will attempt to move along the path to the given target in the direction provided +/// by setState() (the default is forwards). Once the camera moves past this target it will come +/// to a stop, and the target state will be cleared. +/// @param position Target position, between 0.0 (path start) and 1.0 (path end), for the camera to move to along its path. +/// @tsexample +/// // Set the position target, between 0.0 (path start) and 1.0 (path end), for this camera to move to. +/// %position = \"0.50\"; +/// // Inform the pathCamera of the new target position it will move to. +/// %pathCamera.setTarget(%position); +/// @endtsexample) +/// /// public void fnPathCamera_setTarget (string pathcamera, float position) @@ -27713,7 +35222,14 @@ public void fnPathCamera_setTarget (string pathcamera, float position) SafeNativeMethods.mwle_fnPathCamera_setTarget(sbpathcamera, position); } /// -/// Activate the physical zone's effects. @tsexample // Activate effects for a specific physical zone. %thisPhysicalZone.activate(); @endtsexample @ingroup Datablocks ) +/// Activate the physical zone's effects. +/// @tsexample +/// // Activate effects for a specific physical zone. +/// %thisPhysicalZone.activate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void fnPhysicalZone_activate (string physicalzone) @@ -27727,7 +35243,14 @@ public void fnPhysicalZone_activate (string physicalzone) SafeNativeMethods.mwle_fnPhysicalZone_activate(sbphysicalzone); } /// -/// Deactivate the physical zone's effects. @tsexample // Deactivate effects for a specific physical zone. %thisPhysicalZone.deactivate(); @endtsexample @ingroup Datablocks ) +/// Deactivate the physical zone's effects. +/// @tsexample +/// // Deactivate effects for a specific physical zone. +/// %thisPhysicalZone.deactivate(); +/// @endtsexample +/// @ingroup Datablocks +/// ) +/// /// public void fnPhysicalZone_deactivate (string physicalzone) @@ -27741,7 +35264,14 @@ public void fnPhysicalZone_deactivate (string physicalzone) SafeNativeMethods.mwle_fnPhysicalZone_deactivate(sbphysicalzone); } /// -/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. Performs a physics ray cast of the provided length and direction. The %PhysicsForce will attach itself to the first dynamic PhysicsBody the ray collides with. On every tick, the attached body will be attracted towards the position of the %PhysicsForce. A %PhysicsForce can only be attached to one body at a time. @note To determine if an %attach was successful, check isAttached() immediately after calling this function.n) +/// @brief Attempts to associate the PhysicsForce with a PhysicsBody. +/// Performs a physics ray cast of the provided length and direction. The %PhysicsForce +/// will attach itself to the first dynamic PhysicsBody the ray collides with. +/// On every tick, the attached body will be attracted towards the position of the %PhysicsForce. +/// A %PhysicsForce can only be attached to one body at a time. +/// @note To determine if an %attach was successful, check isAttached() immediately after +/// calling this function.n) +/// /// public void fnPhysicsForce_attach (string physicsforce, string start, string direction, float maxDist) @@ -27761,7 +35291,11 @@ public void fnPhysicsForce_attach (string physicsforce, string start, string dir SafeNativeMethods.mwle_fnPhysicsForce_attach(sbphysicsforce, sbstart, sbdirection, maxDist); } /// -/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. @param force Optional force to apply to the attached PhysicsBody before detaching. @note Has no effect if the %PhysicsForce is not attached to anything.) +/// @brief Disassociates the PhysicsForce from any attached PhysicsBody. +/// @param force Optional force to apply to the attached PhysicsBody +/// before detaching. +/// @note Has no effect if the %PhysicsForce is not attached to anything.) +/// /// public void fnPhysicsForce_detach (string physicsforce, string force) @@ -27778,7 +35312,9 @@ public void fnPhysicsForce_detach (string physicsforce, string force) SafeNativeMethods.mwle_fnPhysicsForce_detach(sbphysicsforce, sbforce); } /// -/// @brief Returns true if the %PhysicsForce is currently attached to an object. @see PhysicsForce::attach()) +/// @brief Returns true if the %PhysicsForce is currently attached to an object. +/// @see PhysicsForce::attach()) +/// /// public bool fnPhysicsForce_isAttached (string physicsforce) @@ -27792,7 +35328,12 @@ public bool fnPhysicsForce_isAttached (string physicsforce) return SafeNativeMethods.mwle_fnPhysicsForce_isAttached(sbphysicsforce)>=1; } /// -/// @brief Disables rendering and physical simulation. Calling destroy() will also spawn any explosions, debris, and/or destroyedShape defined for it, as well as remove it from the scene graph. Destroyed objects are only created on the server. Ghosting will later update the client. @note This does not actually delete the PhysicsShape. ) +/// @brief Disables rendering and physical simulation. +/// Calling destroy() will also spawn any explosions, debris, and/or destroyedShape +/// defined for it, as well as remove it from the scene graph. +/// Destroyed objects are only created on the server. Ghosting will later update the client. +/// @note This does not actually delete the PhysicsShape. ) +/// /// public void fnPhysicsShape_destroy (string physicsshape) @@ -27807,6 +35348,7 @@ public void fnPhysicsShape_destroy (string physicsshape) } /// /// @brief Returns if a PhysicsShape has been destroyed or not. ) +/// /// public bool fnPhysicsShape_isDestroyed (string physicsshape) @@ -27820,7 +35362,11 @@ public bool fnPhysicsShape_isDestroyed (string physicsshape) return SafeNativeMethods.mwle_fnPhysicsShape_isDestroyed(sbphysicsshape)>=1; } /// -/// @brief Restores the shape to its state before being destroyed. Re-enables rendering and physical simulation on the object and adds it to the client's scene graph. Has no effect if the shape is not destroyed.) +/// @brief Restores the shape to its state before being destroyed. +/// Re-enables rendering and physical simulation on the object and +/// adds it to the client's scene graph. +/// Has no effect if the shape is not destroyed.) +/// /// public void fnPhysicsShape_restore (string physicsshape) @@ -27834,7 +35380,19 @@ public void fnPhysicsShape_restore (string physicsshape) SafeNativeMethods.mwle_fnPhysicsShape_restore(sbphysicsshape); } /// -/// @brief Allow all poses a chance to occur. This method resets any poses that have manually been blocked from occuring. This includes the regular pose states such as sprinting, crouch, being prone and swimming. It also includes being able to jump and jet jump. While this is allowing these poses to occur it doesn't mean that they all can due to other conditions. We're just not manually blocking them from being allowed. @see allowJumping() @see allowJetJumping() @see allowSprinting() @see allowCrouching() @see allowProne() @see allowSwimming() ) +/// @brief Allow all poses a chance to occur. +/// This method resets any poses that have manually been blocked from occuring. +/// This includes the regular pose states such as sprinting, crouch, being prone +/// and swimming. It also includes being able to jump and jet jump. While this +/// is allowing these poses to occur it doesn't mean that they all can due to other +/// conditions. We're just not manually blocking them from being allowed. +/// @see allowJumping() +/// @see allowJetJumping() +/// @see allowSprinting() +/// @see allowCrouching() +/// @see allowProne() +/// @see allowSwimming() ) +/// /// public void fnPlayer_allowAllPoses (string player) @@ -27848,7 +35406,13 @@ public void fnPlayer_allowAllPoses (string player) SafeNativeMethods.mwle_fnPlayer_allowAllPoses(sbplayer); } /// -/// @brief Set if the Player is allowed to crouch. The default is to allow crouching unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow crouching at any time. @param state Set to true to allow crouching, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to crouch. +/// The default is to allow crouching unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow crouching +/// at any time. +/// @param state Set to true to allow crouching, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowCrouching (string player, bool state) @@ -27862,7 +35426,13 @@ public void fnPlayer_allowCrouching (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowCrouching(sbplayer, state); } /// -/// @brief Set if the Player is allowed to jet jump. The default is to allow jet jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jet jumping at any time. @param state Set to true to allow jet jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jet jump. +/// The default is to allow jet jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jet jumping +/// at any time. +/// @param state Set to true to allow jet jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowJetJumping (string player, bool state) @@ -27876,7 +35446,13 @@ public void fnPlayer_allowJetJumping (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowJetJumping(sbplayer, state); } /// -/// @brief Set if the Player is allowed to jump. The default is to allow jumping unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow jumping at any time. @param state Set to true to allow jumping, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to jump. +/// The default is to allow jumping unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow jumping +/// at any time. +/// @param state Set to true to allow jumping, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowJumping (string player, bool state) @@ -27890,7 +35466,13 @@ public void fnPlayer_allowJumping (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowJumping(sbplayer, state); } /// -/// @brief Set if the Player is allowed to go prone. The default is to allow being prone unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow going prone at any time. @param state Set to true to allow being prone, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to go prone. +/// The default is to allow being prone unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow going prone +/// at any time. +/// @param state Set to true to allow being prone, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowProne (string player, bool state) @@ -27904,7 +35486,13 @@ public void fnPlayer_allowProne (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowProne(sbplayer, state); } /// -/// @brief Set if the Player is allowed to sprint. The default is to allow sprinting unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow sprinting at any time. @param state Set to true to allow sprinting, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to sprint. +/// The default is to allow sprinting unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow sprinting +/// at any time. +/// @param state Set to true to allow sprinting, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowSprinting (string player, bool state) @@ -27918,7 +35506,13 @@ public void fnPlayer_allowSprinting (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowSprinting(sbplayer, state); } /// -/// @brief Set if the Player is allowed to swim. The default is to allow swimming unless there are other environmental concerns that prevent it. This method is mainly used to explicitly disallow swimming at any time. @param state Set to true to allow swimming, false to disable it. @see allowAllPoses() ) +/// @brief Set if the Player is allowed to swim. +/// The default is to allow swimming unless there are other environmental concerns +/// that prevent it. This method is mainly used to explicitly disallow swimming +/// at any time. +/// @param state Set to true to allow swimming, false to disable it. +/// @see allowAllPoses() ) +/// /// public void fnPlayer_allowSwimming (string player, bool state) @@ -27932,7 +35526,21 @@ public void fnPlayer_allowSwimming (string player, bool state) SafeNativeMethods.mwle_fnPlayer_allowSwimming(sbplayer, state); } /// -/// @brief Check if it is safe to dismount at this position. Internally this method casts a ray from oldPos to pos to determine if it hits the terrain, an interior object, a water object, another player, a static shape, a vehicle (exluding the one currently mounted), or physical zone. If this ray is in the clear, then the player's bounding box is also checked for a collision at the pos position. If this displaced bounding box is also in the clear, then checkDismountPoint() returns true. @param oldPos The player's current position @param pos The dismount position to check @return True if the dismount position is clear, false if not @note The player must be already mounted for this method to not assert.) +/// @brief Check if it is safe to dismount at this position. +/// +/// Internally this method casts a ray from oldPos to pos to determine if it hits the +/// terrain, an interior object, a water object, another player, a static shape, +/// a vehicle (exluding the one currently mounted), or physical zone. If this ray +/// is in the clear, then the player's bounding box is also checked for a collision at +/// the pos position. If this displaced bounding box is also in the clear, then +/// checkDismountPoint() returns true. +/// +/// @param oldPos The player's current position +/// @param pos The dismount position to check +/// @return True if the dismount position is clear, false if not +/// +/// @note The player must be already mounted for this method to not assert.) +/// /// public bool fnPlayer_checkDismountPoint (string player, string oldPos, string pos) @@ -27952,7 +35560,23 @@ public bool fnPlayer_checkDismountPoint (string player, string oldPos, string po return SafeNativeMethods.mwle_fnPlayer_checkDismountPoint(sbplayer, sboldPos, sbpos)>=1; } /// -/// @brief Clears the player's current control object. Returns control to the player. This internally calls Player::setControlObject(0). @tsexample %player.clearControlObject(); echo(%player.getControlObject()); //-- Returns 0, player assumes control %player.setControlObject(%vehicle); echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. @endtsexample @note If the player does not have a control object, the player will receive all moves from its GameConnection. If you're looking to remove control from the player itself (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer control to another object, such as a camera. @see setControlObject() @see getControlObject() @see GameConnection::setControlObject()) +/// @brief Clears the player's current control object. +/// Returns control to the player. This internally calls +/// Player::setControlObject(0). +/// @tsexample +/// %player.clearControlObject(); +/// echo(%player.getControlObject()); //-- Returns 0, player assumes control +/// %player.setControlObject(%vehicle); +/// echo(%player.getControlObject()); //-- Returns %vehicle, player controls the vehicle now. +/// @endtsexample +/// @note If the player does not have a control object, the player will receive all moves +/// from its GameConnection. If you're looking to remove control from the player itself +/// (i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer +/// control to another object, such as a camera. +/// @see setControlObject() +/// @see getControlObject() +/// @see GameConnection::setControlObject()) +/// /// public void fnPlayer_clearControlObject (string player) @@ -27966,7 +35590,12 @@ public void fnPlayer_clearControlObject (string player) SafeNativeMethods.mwle_fnPlayer_clearControlObject(sbplayer); } /// -/// @brief Get the current object we are controlling. @return ID of the ShapeBase object we control, or 0 if not controlling an object. @see setControlObject() @see clearControlObject()) +/// @brief Get the current object we are controlling. +/// @return ID of the ShapeBase object we control, or 0 if not controlling an +/// object. +/// @see setControlObject() +/// @see clearControlObject()) +/// /// public int fnPlayer_getControlObject (string player) @@ -27980,7 +35609,59 @@ public int fnPlayer_getControlObject (string player) return SafeNativeMethods.mwle_fnPlayer_getControlObject(sbplayer); } /// -/// @brief Get the named damage location and modifier for a given world position. the Player object can simulate different hit locations based on a pre-defined set of PlayerData defined percentages. These hit percentages divide up the Player's bounding box into different regions. The diagram below demonstrates how the various PlayerData properties split up the bounding volume: img src=\"images/player_damageloc.png\"> While you may pass in any world position and getDamageLocation() will provide a best-fit location, you should be aware that this can produce some interesting results. For example, any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even if the world position is high in the sky. Therefore it may be wise to keep the passed in point to somewhere on the surface of, or within, the Player's bounding volume. @note This method will not return an accurate location when the player is prone or swimming. @param pos A world position for which to retrieve a body region on this player. @return a string containing two words (space separated strings), where the first is a location and the second is a modifier. Posible locations:ul> li>head/li> li>torso/li> li>legs/li>/ul> Head modifiers:ul> li>left_back/li> li>middle_back/li> li>right_back/li> li>left_middle/li> li>middle_middle/li> li>right_middle/li> li>left_front/li> li>middle_front/li> li>right_front/li>/ul> Legs/Torso modifiers:ul> li>front_left/li> li>front_right/li> li>back_left/li> li>back_right/li>/ul> @see PlayerData::boxHeadPercentage @see PlayerData::boxHeadFrontPercentage @see PlayerData::boxHeadBackPercentage @see PlayerData::boxHeadLeftPercentage @see PlayerData::boxHeadRightPercentage @see PlayerData::boxTorsoPercentage ) +/// @brief Get the named damage location and modifier for a given world position. +/// +/// the Player object can simulate different hit locations based on a pre-defined set +/// of PlayerData defined percentages. These hit percentages divide up the Player's +/// bounding box into different regions. The diagram below demonstrates how the various +/// PlayerData properties split up the bounding volume: +/// +/// img src=\"images/player_damageloc.png\"> +/// +/// While you may pass in any world position and getDamageLocation() will provide a best-fit +/// location, you should be aware that this can produce some interesting results. For example, +/// any position that is above PlayerData::boxHeadPercentage will be considered a 'head' hit, even +/// if the world position is high in the sky. Therefore it may be wise to keep the passed in point +/// to somewhere on the surface of, or within, the Player's bounding volume. +/// +/// @note This method will not return an accurate location when the player is +/// prone or swimming. +/// +/// @param pos A world position for which to retrieve a body region on this player. +/// +/// @return a string containing two words (space separated strings), where the +/// first is a location and the second is a modifier. +/// +/// Posible locations:ul> +/// li>head/li> +/// li>torso/li> +/// li>legs/li>/ul> +/// +/// Head modifiers:ul> +/// li>left_back/li> +/// li>middle_back/li> +/// li>right_back/li> +/// li>left_middle/li> +/// li>middle_middle/li> +/// li>right_middle/li> +/// li>left_front/li> +/// li>middle_front/li> +/// li>right_front/li>/ul> +/// +/// Legs/Torso modifiers:ul> +/// li>front_left/li> +/// li>front_right/li> +/// li>back_left/li> +/// li>back_right/li>/ul> +/// +/// @see PlayerData::boxHeadPercentage +/// @see PlayerData::boxHeadFrontPercentage +/// @see PlayerData::boxHeadBackPercentage +/// @see PlayerData::boxHeadLeftPercentage +/// @see PlayerData::boxHeadRightPercentage +/// @see PlayerData::boxTorsoPercentage +/// ) +/// /// public string fnPlayer_getDamageLocation (string player, string pos) @@ -28000,7 +35681,9 @@ public string fnPlayer_getDamageLocation (string player, string pos) } /// -/// @brief Get the number of death animations available to this player. Death animations are assumed to be named death1-N using consecutive indices. ) +/// @brief Get the number of death animations available to this player. +/// Death animations are assumed to be named death1-N using consecutive indices. ) +/// /// public int fnPlayer_getNumDeathAnimations (string player) @@ -28014,7 +35697,17 @@ public int fnPlayer_getNumDeathAnimations (string player) return SafeNativeMethods.mwle_fnPlayer_getNumDeathAnimations(sbplayer); } /// -/// @brief Get the name of the player's current pose. The pose is one of the following:ul> li>Stand - Standard movement pose./li> li>Sprint - Sprinting pose./li> li>Crouch - Crouch pose./li> li>Prone - Prone pose./li> li>Swim - Swimming pose./li>/ul> @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// @brief Get the name of the player's current pose. +/// +/// The pose is one of the following:ul> +/// li>Stand - Standard movement pose./li> +/// li>Sprint - Sprinting pose./li> +/// li>Crouch - Crouch pose./li> +/// li>Prone - Prone pose./li> +/// li>Swim - Swimming pose./li>/ul> +/// +/// @return The current pose; one of: \"Stand\", \"Sprint\", \"Crouch\", \"Prone\", \"Swim\" ) +/// /// public string fnPlayer_getPose (string player) @@ -28031,7 +35724,16 @@ public string fnPlayer_getPose (string player) } /// -/// @brief Get the name of the player's current state. The state is one of the following:ul> li>Dead - The Player is dead./li> li>Mounted - The Player is mounted to an object such as a vehicle./li> li>Move - The Player is free to move. The usual state./li> li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// @brief Get the name of the player's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The Player is dead./li> +/// li>Mounted - The Player is mounted to an object such as a vehicle./li> +/// li>Move - The Player is free to move. The usual state./li> +/// li>Recover - The Player is recovering from a fall. See PlayerData::recoverDelay./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Move\", \"Recover\" ) +/// /// public string fnPlayer_getState (string player) @@ -28048,7 +35750,58 @@ public string fnPlayer_getState (string player) } /// -/// @brief Set the main action sequence to play for this player. @param name Name of the action sequence to set @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). When set to true no callback is made. @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's spine nodes to animate. @return True if succesful, false if failed @note The spine nodes for the Player's shape are named as follows:ul> li>Bip01 Pelvis/li> li>Bip01 Spine/li> li>Bip01 Spine1/li> li>Bip01 Spine2/li> li>Bip01 Neck/li> li>Bip01 Head/li>/ul> You cannot use setActionThread() to have the Player play one of the motion determined action animation sequences. These sequences are chosen based on how the Player moves and the Player's current pose. The names of these sequences are:ul> li>root/li> li>run/li> li>side/li> li>side_right/li> li>crouch_root/li> li>crouch_forward/li> li>crouch_backward/li> li>crouch_side/li> li>crouch_right/li> li>prone_root/li> li>prone_forward/li> li>prone_backward/li> li>swim_root/li> li>swim_forward/li> li>swim_backward/li> li>swim_left/li> li>swim_right/li> li>fall/li> li>jump/li> li>standjump/li> li>land/li> li>jet/li>/ul> If the player moves in any direction then the animation sequence set using this method will be cancelled and the chosen mation-based sequence will take over. This makes great for times when the Player cannot move, such as when mounted, or when it doesn't matter if the action sequence changes, such as waving and saluting. @tsexample // Place the player in a sitting position after being mounted %player.setActionThread( \"sitting\", true, true ); @endtsexample) +/// @brief Set the main action sequence to play for this player. +/// @param name Name of the action sequence to set +/// @param hold Set to false to get a callback on the datablock when the sequence ends (PlayerData::animationDone()). +/// When set to true no callback is made. +/// @param fsp True if first person and none of the spine nodes in the shape should animate. False will allow the shape's +/// spine nodes to animate. +/// @return True if succesful, false if failed +/// +/// @note The spine nodes for the Player's shape are named as follows:ul> +/// li>Bip01 Pelvis/li> +/// li>Bip01 Spine/li> +/// li>Bip01 Spine1/li> +/// li>Bip01 Spine2/li> +/// li>Bip01 Neck/li> +/// li>Bip01 Head/li>/ul> +/// +/// You cannot use setActionThread() to have the Player play one of the motion +/// determined action animation sequences. These sequences are chosen based on how +/// the Player moves and the Player's current pose. The names of these sequences are:ul> +/// li>root/li> +/// li>run/li> +/// li>side/li> +/// li>side_right/li> +/// li>crouch_root/li> +/// li>crouch_forward/li> +/// li>crouch_backward/li> +/// li>crouch_side/li> +/// li>crouch_right/li> +/// li>prone_root/li> +/// li>prone_forward/li> +/// li>prone_backward/li> +/// li>swim_root/li> +/// li>swim_forward/li> +/// li>swim_backward/li> +/// li>swim_left/li> +/// li>swim_right/li> +/// li>fall/li> +/// li>jump/li> +/// li>standjump/li> +/// li>land/li> +/// li>jet/li>/ul> +/// +/// If the player moves in any direction then the animation sequence set using this +/// method will be cancelled and the chosen mation-based sequence will take over. This makes +/// great for times when the Player cannot move, such as when mounted, or when it doesn't matter +/// if the action sequence changes, such as waving and saluting. +/// +/// @tsexample +/// // Place the player in a sitting position after being mounted +/// %player.setActionThread( \"sitting\", true, true ); +/// @endtsexample) +/// /// public bool fnPlayer_setActionThread (string player, string name, bool hold, bool fsp) @@ -28065,7 +35818,12 @@ public bool fnPlayer_setActionThread (string player, string name, bool hold, boo return SafeNativeMethods.mwle_fnPlayer_setActionThread(sbplayer, sbname, hold, fsp)>=1; } /// -/// @brief Set the sequence that controls the player's arms (dynamically adjusted to match look direction). @param name Name of the sequence to play on the player's arms. @return true if successful, false if failed. @note By default the 'look' sequence is used, if available.) +/// @brief Set the sequence that controls the player's arms (dynamically adjusted +/// to match look direction). +/// @param name Name of the sequence to play on the player's arms. +/// @return true if successful, false if failed. +/// @note By default the 'look' sequence is used, if available.) +/// /// public bool fnPlayer_setArmThread (string player, string name) @@ -28082,7 +35840,23 @@ public bool fnPlayer_setArmThread (string player, string name) return SafeNativeMethods.mwle_fnPlayer_setArmThread(sbplayer, sbname)>=1; } /// -/// @brief Set the object to be controlled by this player It is possible to have the moves sent to the Player object from the GameConnection to be passed along to another object. This happens, for example when a player is mounted to a vehicle. The move commands pass through the Player and on to the vehicle (while the player remains stationary within the vehicle). With setControlObject() you can have the Player pass along its moves to any object. One possible use is for a player to move a remote controlled vehicle. In this case the player does not mount the vehicle directly, but still wants to be able to control it. @param obj Object to control with this player @return True if the object is valid, false if not @see getControlObject() @see clearControlObject() @see GameConnection::setControlObject()) +/// @brief Set the object to be controlled by this player +/// +/// It is possible to have the moves sent to the Player object from the +/// GameConnection to be passed along to another object. This happens, for example +/// when a player is mounted to a vehicle. The move commands pass through the Player +/// and on to the vehicle (while the player remains stationary within the vehicle). +/// With setControlObject() you can have the Player pass along its moves to any object. +/// One possible use is for a player to move a remote controlled vehicle. In this case +/// the player does not mount the vehicle directly, but still wants to be able to control it. +/// +/// @param obj Object to control with this player +/// @return True if the object is valid, false if not +/// +/// @see getControlObject() +/// @see clearControlObject() +/// @see GameConnection::setControlObject()) +/// /// public bool fnPlayer_setControlObject (string player, string obj) @@ -28099,7 +35873,9 @@ public bool fnPlayer_setControlObject (string player, string obj) return SafeNativeMethods.mwle_fnPlayer_setControlObject(sbplayer, sbobj)>=1; } /// -/// Test whether the portal connects interior zones to the outdoor zone. @return True if the portal is an exterior portal. ) +/// Test whether the portal connects interior zones to the outdoor zone. +/// @return True if the portal is an exterior portal. ) +/// /// public bool fnPortal_isExteriorPortal (string portal) @@ -28113,7 +35889,9 @@ public bool fnPortal_isExteriorPortal (string portal) return SafeNativeMethods.mwle_fnPortal_isExteriorPortal(sbportal)>=1; } /// -/// Test whether the portal connects interior zones only. @return True if the portal is an interior portal. ) +/// Test whether the portal connects interior zones only. +/// @return True if the portal is an interior portal. ) +/// /// public bool fnPortal_isInteriorPortal (string portal) @@ -28128,6 +35906,7 @@ public bool fnPortal_isInteriorPortal (string portal) } /// /// Remove all shader macros. ) +/// /// public void fnPostEffect_clearShaderMacros (string posteffect) @@ -28142,6 +35921,7 @@ public void fnPostEffect_clearShaderMacros (string posteffect) } /// /// Disables the effect. ) +/// /// public void fnPostEffect_disable (string posteffect) @@ -28155,7 +35935,9 @@ public void fnPostEffect_disable (string posteffect) SafeNativeMethods.mwle_fnPostEffect_disable(sbposteffect); } /// -/// Dumps this PostEffect shader's disassembly to a temporary text file. @return Full path to the dumped file or an empty string if failed. ) +/// Dumps this PostEffect shader's disassembly to a temporary text file. +/// @return Full path to the dumped file or an empty string if failed. ) +/// /// public string fnPostEffect_dumpShaderDisassembly (string posteffect) @@ -28173,6 +35955,7 @@ public string fnPostEffect_dumpShaderDisassembly (string posteffect) } /// /// Enables the effect. ) +/// /// public void fnPostEffect_enable (string posteffect) @@ -28187,6 +35970,7 @@ public void fnPostEffect_enable (string posteffect) } /// /// @return Width over height of the backbuffer. ) +/// /// public float fnPostEffect_getAspectRatio (string posteffect) @@ -28201,6 +35985,7 @@ public float fnPostEffect_getAspectRatio (string posteffect) } /// /// @return True if the effect is enabled. ) +/// /// public bool fnPostEffect_isEnabled (string posteffect) @@ -28215,6 +36000,7 @@ public bool fnPostEffect_isEnabled (string posteffect) } /// /// Reloads the effect shader and textures. ) +/// /// public void fnPostEffect_reload (string posteffect) @@ -28228,7 +36014,9 @@ public void fnPostEffect_reload (string posteffect) SafeNativeMethods.mwle_fnPostEffect_reload(sbposteffect); } /// -/// Remove a shader macro. This will usually be called within the preProcess callback. @param key Macro to remove. ) +/// Remove a shader macro. This will usually be called within the preProcess callback. +/// @param key Macro to remove. ) +/// /// public void fnPostEffect_removeShaderMacro (string posteffect, string key) @@ -28245,7 +36033,23 @@ public void fnPostEffect_removeShaderMacro (string posteffect, string key) SafeNativeMethods.mwle_fnPostEffect_removeShaderMacro(sbposteffect, sbkey); } /// -/// Sets the value of a uniform defined in the shader. This will usually be called within the setShaderConsts callback. Array type constants are not supported. @param name Name of the constanst, prefixed with '$'. @param value Value to set, space seperate values with more than one element. @tsexample function MyPfx::setShaderConsts( %this ) { // example float4 uniform %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); // example float1 uniform %this.setShaderConst( \"$strength\", \"3.0\" ); // example integer uniform %this.setShaderConst( \"$loops\", \"5\" ); } @endtsexample ) +/// Sets the value of a uniform defined in the shader. This will usually +/// be called within the setShaderConsts callback. Array type constants are +/// not supported. +/// @param name Name of the constanst, prefixed with '$'. +/// @param value Value to set, space seperate values with more than one element. +/// @tsexample +/// function MyPfx::setShaderConsts( %this ) +/// { +/// // example float4 uniform +/// %this.setShaderConst( \"$colorMod\", \"1.0 0.9 1.0 1.0\" ); +/// // example float1 uniform +/// %this.setShaderConst( \"$strength\", \"3.0\" ); +/// // example integer uniform +/// %this.setShaderConst( \"$loops\", \"5\" ); +/// } +/// @endtsexample ) +/// /// public void fnPostEffect_setShaderConst (string posteffect, string name, string value) @@ -28265,7 +36069,23 @@ public void fnPostEffect_setShaderConst (string posteffect, string name, string SafeNativeMethods.mwle_fnPostEffect_setShaderConst(sbposteffect, sbname, sbvalue); } /// -/// ), Adds a macro to the effect's shader or sets an existing one's value. This will usually be called within the onAdd or preProcess callback. @param key lval of the macro. @param value rval of the macro, or may be empty. @tsexample function MyPfx::onAdd( %this ) { %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); // In the shader looks like... // #define NUM_SAMPLES 10 // #define HIGH_QUALITY_MODE } @endtsexample ) +/// ), +/// Adds a macro to the effect's shader or sets an existing one's value. +/// This will usually be called within the onAdd or preProcess callback. +/// @param key lval of the macro. +/// @param value rval of the macro, or may be empty. +/// @tsexample +/// function MyPfx::onAdd( %this ) +/// { +/// %this.setShaderMacro( \"NUM_SAMPLES\", \"10\" ); +/// %this.setShaderMacro( \"HIGH_QUALITY_MODE\" ); +/// +/// // In the shader looks like... +/// // #define NUM_SAMPLES 10 +/// // #define HIGH_QUALITY_MODE +/// } +/// @endtsexample ) +/// /// public void fnPostEffect_setShaderMacro (string posteffect, string key, string value) @@ -28285,7 +36105,12 @@ public void fnPostEffect_setShaderMacro (string posteffect, string key, string v SafeNativeMethods.mwle_fnPostEffect_setShaderMacro(sbposteffect, sbkey, sbvalue); } /// -/// This is used to set the texture file and load the texture on a running effect. If the texture file is not different from the current file nothing is changed. If the texture cannot be found a null texture is assigned. @param index The texture stage index. @param filePath The file name of the texture to set. ) +/// This is used to set the texture file and load the texture on a running effect. +/// If the texture file is not different from the current file nothing is changed. If +/// the texture cannot be found a null texture is assigned. +/// @param index The texture stage index. +/// @param filePath The file name of the texture to set. ) +/// /// public void fnPostEffect_setTexture (string posteffect, int index, string filePath) @@ -28302,7 +36127,9 @@ public void fnPostEffect_setTexture (string posteffect, int index, string filePa SafeNativeMethods.mwle_fnPostEffect_setTexture(sbposteffect, index, sbfilePath); } /// -/// Toggles the effect between enabled / disabled. @return True if effect is enabled. ) +/// Toggles the effect between enabled / disabled. +/// @return True if effect is enabled. ) +/// /// public bool fnPostEffect_toggle (string posteffect) @@ -28316,7 +36143,20 @@ public bool fnPostEffect_toggle (string posteffect) return SafeNativeMethods.mwle_fnPostEffect_toggle(sbposteffect)>=1; } /// -/// Smoothly change the maximum number of drops in the effect (from current value to #numDrops * @a percentage). This method can be used to simulate a storm building or fading in intensity as the number of drops in the Precipitation box changes. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @param seconds Length of time (in seconds) over which to increase the drops percentage value. Set to 0 to change instantly. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %seconds = 5.0; // The length of time over which to make the change. %precipitation.modifyStorm( %percentage, %seconds ); @endtsexample ) +/// Smoothly change the maximum number of drops in the effect (from current +/// value to #numDrops * @a percentage). +/// This method can be used to simulate a storm building or fading in intensity +/// as the number of drops in the Precipitation box changes. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @param seconds Length of time (in seconds) over which to increase the drops +/// percentage value. Set to 0 to change instantly. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.modifyStorm( %percentage, %seconds ); +/// @endtsexample ) +/// /// public void fnPrecipitation_modifyStorm (string precipitation, float percentage, float seconds) @@ -28330,7 +36170,17 @@ public void fnPrecipitation_modifyStorm (string precipitation, float percentage, SafeNativeMethods.mwle_fnPrecipitation_modifyStorm(sbprecipitation, percentage, seconds); } /// -/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. The change occurs instantly (use modifyStorm() to change the number of drops over a period of time. @param percentage New maximum number of drops value (as a percentage of #numDrops). Valid range is 0-1. @tsexample %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display %precipitation.setPercentage( %percentage ); @endtsexample @see modifyStorm ) +/// Sets the maximum number of drops in the effect, as a percentage of #numDrops. +/// The change occurs instantly (use modifyStorm() to change the number of drops +/// over a period of time. +/// @param percentage New maximum number of drops value (as a percentage of +/// #numDrops). Valid range is 0-1. +/// @tsexample +/// %percentage = 0.5; // The percentage, from 0 to 1, of the maximum drops to display +/// %precipitation.setPercentage( %percentage ); +/// @endtsexample +/// @see modifyStorm ) +/// /// public void fnPrecipitation_setPercentage (string precipitation, float percentage) @@ -28344,7 +36194,18 @@ public void fnPrecipitation_setPercentage (string precipitation, float percentag SafeNativeMethods.mwle_fnPrecipitation_setPercentage(sbprecipitation, percentage); } /// -/// Smoothly change the turbulence parameters over a period of time. @param max New #maxTurbulence value. Set to 0 to disable turbulence. @param speed New #turbulenceSpeed value. @param seconds Length of time (in seconds) over which to interpolate the turbulence settings. Set to 0 to change instantly. @tsexample %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. %speed = 5.0; // The new speed of the turbulance effect. %seconds = 5.0; // The length of time over which to make the change. %precipitation.setTurbulence( %turbulence, %speed, %seconds ); @endtsexample ) +/// Smoothly change the turbulence parameters over a period of time. +/// @param max New #maxTurbulence value. Set to 0 to disable turbulence. +/// @param speed New #turbulenceSpeed value. +/// @param seconds Length of time (in seconds) over which to interpolate the +/// turbulence settings. Set to 0 to change instantly. +/// @tsexample +/// %turbulence = 0.5; // Set the new turbulence value. Set to 0 to disable turbulence. +/// %speed = 5.0; // The new speed of the turbulance effect. +/// %seconds = 5.0; // The length of time over which to make the change. +/// %precipitation.setTurbulence( %turbulence, %speed, %seconds ); +/// @endtsexample ) +/// /// public void fnPrecipitation_setTurbulence (string precipitation, float max, float speed, float seconds) @@ -28358,7 +36219,19 @@ public void fnPrecipitation_setTurbulence (string precipitation, float max, floa SafeNativeMethods.mwle_fnPrecipitation_setTurbulence(sbprecipitation, max, speed, seconds); } /// -/// @brief Updates the projectile's positional and collision information. This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. Also responsible for applying gravity, determining collisions, triggering explosions, emitting trail particles, and calculating bounces if necessary. @param seconds Amount of time, in seconds since the simulation's start, to advance. @tsexample // Tell the projectile to process a simulation event, and provide the amount of time // that has passed since the simulation began. %seconds = 2.0; %projectile.presimulate(%seconds); @endtsexample @note This function is not called if the SimObject::hidden is true.) +/// @brief Updates the projectile's positional and collision information. +/// This function will first delete the projectile if it is a server object and is outside it's ProjectileData::lifetime. +/// Also responsible for applying gravity, determining collisions, triggering explosions, +/// emitting trail particles, and calculating bounces if necessary. +/// @param seconds Amount of time, in seconds since the simulation's start, to advance. +/// @tsexample +/// // Tell the projectile to process a simulation event, and provide the amount of time +/// // that has passed since the simulation began. +/// %seconds = 2.0; +/// %projectile.presimulate(%seconds); +/// @endtsexample +/// @note This function is not called if the SimObject::hidden is true.) +/// /// public void fnProjectile_presimulate (string projectile, float seconds) @@ -28373,6 +36246,7 @@ public void fnProjectile_presimulate (string projectile, float seconds) } /// /// @brief Manually cause the mine to explode.) +/// /// public void fnProximityMine_explode (string proximitymine) @@ -28387,6 +36261,7 @@ public void fnProximityMine_explode (string proximitymine) } /// /// Returns the bin type string. ) +/// /// public string fnRenderBinManager_getBinType (string renderbinmanager) @@ -28404,6 +36279,7 @@ public string fnRenderBinManager_getBinType (string renderbinmanager) } /// /// A utility method for forcing a network update.) +/// /// public void fnRenderMeshExample_postApply (string rendermeshexample) @@ -28418,6 +36294,7 @@ public void fnRenderMeshExample_postApply (string rendermeshexample) } /// /// Add as a render bin manager to the pass. ) +/// /// public void fnRenderPassManager_addManager (string renderpassmanager, string renderBin) @@ -28435,6 +36312,7 @@ public void fnRenderPassManager_addManager (string renderpassmanager, string ren } /// /// Returns the render bin manager at the index or null if the index is out of range. ) +/// /// public string fnRenderPassManager_getManager (string renderpassmanager, int index) @@ -28452,6 +36330,7 @@ public string fnRenderPassManager_getManager (string renderpassmanager, int inde } /// /// Returns the total number of bin managers. ) +/// /// public int fnRenderPassManager_getManagerCount (string renderpassmanager) @@ -28466,6 +36345,7 @@ public int fnRenderPassManager_getManagerCount (string renderpassmanager) } /// /// Removes a render bin manager. ) +/// /// public void fnRenderPassManager_removeManager (string renderpassmanager, string renderBin) @@ -28483,6 +36363,7 @@ public void fnRenderPassManager_removeManager (string renderpassmanager, string } /// /// @brief Disables the token.) +/// /// public void fnRenderPassStateToken_disable (string renderpassstatetoken) @@ -28497,6 +36378,7 @@ public void fnRenderPassStateToken_disable (string renderpassstatetoken) } /// /// @brief Enables the token. ) +/// /// public void fnRenderPassStateToken_enable (string renderpassstatetoken) @@ -28511,6 +36393,7 @@ public void fnRenderPassStateToken_enable (string renderpassstatetoken) } /// /// @brief Toggles the token from enabled to disabled or vice versa. ) +/// /// public void fnRenderPassStateToken_toggle (string renderpassstatetoken) @@ -28525,6 +36408,7 @@ public void fnRenderPassStateToken_toggle (string renderpassstatetoken) } /// /// @brief Forces the client to jump to the RigidShape's transform rather then warp to it.) +/// /// public void fnRigidShape_forceClientTransform (string rigidshape) @@ -28538,7 +36422,16 @@ public void fnRigidShape_forceClientTransform (string rigidshape) SafeNativeMethods.mwle_fnRigidShape_forceClientTransform(sbrigidshape); } /// -/// @brief Enables or disables the physics simulation on the RigidShape object. @param isFrozen Boolean frozen state to set the object. @tsexample // Define the frozen state. %isFrozen = \"true\"; // Inform the object of the defined frozen state %thisRigidShape.freezeSim(%isFrozen); @endtsexample @see ShapeBaseData) +/// @brief Enables or disables the physics simulation on the RigidShape object. +/// @param isFrozen Boolean frozen state to set the object. +/// @tsexample +/// // Define the frozen state. +/// %isFrozen = \"true\"; +/// // Inform the object of the defined frozen state +/// %thisRigidShape.freezeSim(%isFrozen); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void fnRigidShape_freezeSim (string rigidshape, bool isFrozen) @@ -28552,7 +36445,13 @@ public void fnRigidShape_freezeSim (string rigidshape, bool isFrozen) SafeNativeMethods.mwle_fnRigidShape_freezeSim(sbrigidshape, isFrozen); } /// -/// @brief Clears physic forces from the shape and sets it at rest. @tsexample // Inform the RigidShape object to reset. %thisRigidShape.reset(); @endtsexample @see ShapeBaseData) +/// @brief Clears physic forces from the shape and sets it at rest. +/// @tsexample +/// // Inform the RigidShape object to reset. +/// %thisRigidShape.reset(); +/// @endtsexample +/// @see ShapeBaseData) +/// /// public void fnRigidShape_reset (string rigidshape) @@ -28566,7 +36465,10 @@ public void fnRigidShape_reset (string rigidshape) SafeNativeMethods.mwle_fnRigidShape_reset(sbrigidshape); } /// -/// Intended as a helper to developers and editor scripts. Force River to recreate its geometry. ) +/// Intended as a helper to developers and editor scripts. +/// Force River to recreate its geometry. +/// ) +/// /// public void fnRiver_regenerate (string river) @@ -28580,7 +36482,10 @@ public void fnRiver_regenerate (string river) SafeNativeMethods.mwle_fnRiver_regenerate(sbriver); } /// -/// Intended as a helper to developers and editor scripts. BatchSize is not currently used. ) +/// Intended as a helper to developers and editor scripts. +/// BatchSize is not currently used. +/// ) +/// /// public void fnRiver_setBatchSize (string river, float meters) @@ -28594,7 +36499,10 @@ public void fnRiver_setBatchSize (string river, float meters) SafeNativeMethods.mwle_fnRiver_setBatchSize(sbriver, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SubdivideLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SubdivideLength field. +/// ) +/// /// public void fnRiver_setMaxDivisionSize (string river, float meters) @@ -28608,7 +36516,10 @@ public void fnRiver_setMaxDivisionSize (string river, float meters) SafeNativeMethods.mwle_fnRiver_setMaxDivisionSize(sbriver, meters); } /// -/// Intended as a helper to developers and editor scripts. @see SegmentLength field. ) +/// Intended as a helper to developers and editor scripts. +/// @see SegmentLength field. +/// ) +/// /// public void fnRiver_setMetersPerSegment (string river, float meters) @@ -28622,7 +36533,10 @@ public void fnRiver_setMetersPerSegment (string river, float meters) SafeNativeMethods.mwle_fnRiver_setMetersPerSegment(sbriver, meters); } /// -/// Intended as a helper to developers and editor scripts. Sets the depth in meters of a particular node. ) +/// Intended as a helper to developers and editor scripts. +/// Sets the depth in meters of a particular node. +/// ) +/// /// public void fnRiver_setNodeDepth (string river, int idx, float meters) @@ -28636,7 +36550,9 @@ public void fnRiver_setNodeDepth (string river, int idx, float meters) SafeNativeMethods.mwle_fnRiver_setNodeDepth(sbriver, idx, meters); } /// -/// Apply a full network update of all fields to all clients. ) +/// Apply a full network update of all fields to all clients. +/// ) +/// /// public void fnScatterSky_applyChanges (string scattersky) @@ -28650,7 +36566,10 @@ public void fnScatterSky_applyChanges (string scattersky) SafeNativeMethods.mwle_fnScatterSky_applyChanges(sbscattersky); } /// -/// Get Euler rotation of this object. @return the orientation of the object in the form of rotations around the X, Y and Z axes in degrees. ) +/// Get Euler rotation of this object. +/// @return the orientation of the object in the form of rotations around the +/// X, Y and Z axes in degrees. ) +/// /// public string fnSceneObject_getEulerRotation (string sceneobject) @@ -28667,7 +36586,10 @@ public string fnSceneObject_getEulerRotation (string sceneobject) } /// -/// Get the direction this object is facing. @return a vector indicating the direction this object is facing. @note This is the object's y axis. ) +/// Get the direction this object is facing. +/// @return a vector indicating the direction this object is facing. +/// @note This is the object's y axis. ) +/// /// public string fnSceneObject_getForwardVector (string sceneobject) @@ -28684,7 +36606,9 @@ public string fnSceneObject_getForwardVector (string sceneobject) } /// -/// Get the object's inverse transform. @return the inverse transform of the object ) +/// Get the object's inverse transform. +/// @return the inverse transform of the object ) +/// /// public string fnSceneObject_getInverseTransform (string sceneobject) @@ -28701,7 +36625,10 @@ public string fnSceneObject_getInverseTransform (string sceneobject) } /// -/// Get the object mounted at a particular slot. @param slot mount slot index to query @return ID of the object mounted in the slot, or 0 if no object. ) +/// Get the object mounted at a particular slot. +/// @param slot mount slot index to query +/// @return ID of the object mounted in the slot, or 0 if no object. ) +/// /// public int fnSceneObject_getMountedObject (string sceneobject, int slot) @@ -28715,7 +36642,9 @@ public int fnSceneObject_getMountedObject (string sceneobject, int slot) return SafeNativeMethods.mwle_fnSceneObject_getMountedObject(sbsceneobject, slot); } /// -/// Get the number of objects mounted to us. @return the number of mounted objects. ) +/// Get the number of objects mounted to us. +/// @return the number of mounted objects. ) +/// /// public int fnSceneObject_getMountedObjectCount (string sceneobject) @@ -28729,7 +36658,10 @@ public int fnSceneObject_getMountedObjectCount (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_getMountedObjectCount(sbsceneobject); } /// -/// @brief Get the mount node index of the object mounted at our given slot. @param slot mount slot index to query @return index of the mount node used by the object mounted in this slot. ) +/// @brief Get the mount node index of the object mounted at our given slot. +/// @param slot mount slot index to query +/// @return index of the mount node used by the object mounted in this slot. ) +/// /// public int fnSceneObject_getMountedObjectNode (string sceneobject, int slot) @@ -28743,7 +36675,10 @@ public int fnSceneObject_getMountedObjectNode (string sceneobject, int slot) return SafeNativeMethods.mwle_fnSceneObject_getMountedObjectNode(sbsceneobject, slot); } /// -/// @brief Get the object mounted at our given node index. @param node mount node index to query @return ID of the first object mounted at the node, or 0 if none found. ) +/// @brief Get the object mounted at our given node index. +/// @param node mount node index to query +/// @return ID of the first object mounted at the node, or 0 if none found. ) +/// /// public int fnSceneObject_getMountNodeObject (string sceneobject, int node) @@ -28757,7 +36692,10 @@ public int fnSceneObject_getMountNodeObject (string sceneobject, int node) return SafeNativeMethods.mwle_fnSceneObject_getMountNodeObject(sbsceneobject, node); } /// -/// Get the object's bounding box (relative to the object's origin). @return six fields, two Point3Fs, containing the min and max points of the objectbox. ) +/// Get the object's bounding box (relative to the object's origin). +/// @return six fields, two Point3Fs, containing the min and max points of the +/// objectbox. ) +/// /// public string fnSceneObject_getObjectBox (string sceneobject) @@ -28774,7 +36712,9 @@ public string fnSceneObject_getObjectBox (string sceneobject) } /// -/// @brief Get the object we are mounted to. @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// @brief Get the object we are mounted to. +/// @return the SimObjectID of the object we're mounted to, or 0 if not mounted. ) +/// /// public int fnSceneObject_getObjectMount (string sceneobject) @@ -28788,7 +36728,9 @@ public int fnSceneObject_getObjectMount (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_getObjectMount(sbsceneobject); } /// -/// Get the object's world position. @return the current world position of the object ) +/// Get the object's world position. +/// @return the current world position of the object ) +/// /// public string fnSceneObject_getPosition (string sceneobject) @@ -28805,7 +36747,10 @@ public string fnSceneObject_getPosition (string sceneobject) } /// -/// Get the right vector of the object. @return a vector indicating the right direction of this object. @note This is the object's x axis. ) +/// Get the right vector of the object. +/// @return a vector indicating the right direction of this object. +/// @note This is the object's x axis. ) +/// /// public string fnSceneObject_getRightVector (string sceneobject) @@ -28822,7 +36767,9 @@ public string fnSceneObject_getRightVector (string sceneobject) } /// -/// Get the object's scale. @return object scale as a Point3F ) +/// Get the object's scale. +/// @return object scale as a Point3F ) +/// /// public string fnSceneObject_getScale (string sceneobject) @@ -28839,7 +36786,9 @@ public string fnSceneObject_getScale (string sceneobject) } /// -/// Get the object's transform. @return the current transform of the object ) +/// Get the object's transform. +/// @return the current transform of the object ) +/// /// public string fnSceneObject_getTransform (string sceneobject) @@ -28856,7 +36805,9 @@ public string fnSceneObject_getTransform (string sceneobject) } /// -/// Return the type mask for this object. @return The numeric type mask for the object. ) +/// Return the type mask for this object. +/// @return The numeric type mask for the object. ) +/// /// public int fnSceneObject_getType (string sceneobject) @@ -28870,7 +36821,10 @@ public int fnSceneObject_getType (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_getType(sbsceneobject); } /// -/// Get the up vector of the object. @return a vector indicating the up direction of this object. @note This is the object's z axis. ) +/// Get the up vector of the object. +/// @return a vector indicating the up direction of this object. +/// @note This is the object's z axis. ) +/// /// public string fnSceneObject_getUpVector (string sceneobject) @@ -28887,7 +36841,10 @@ public string fnSceneObject_getUpVector (string sceneobject) } /// -/// Get the object's world bounding box. @return six fields, two Point3Fs, containing the min and max points of the worldbox. ) +/// Get the object's world bounding box. +/// @return six fields, two Point3Fs, containing the min and max points of the +/// worldbox. ) +/// /// public string fnSceneObject_getWorldBox (string sceneobject) @@ -28904,7 +36861,9 @@ public string fnSceneObject_getWorldBox (string sceneobject) } /// -/// Get the center of the object's world bounding box. @return the center of the world bounding box for this object. ) +/// Get the center of the object's world bounding box. +/// @return the center of the world bounding box for this object. ) +/// /// public string fnSceneObject_getWorldBoxCenter (string sceneobject) @@ -28921,7 +36880,11 @@ public string fnSceneObject_getWorldBoxCenter (string sceneobject) } /// -/// Check if this object has a global bounds set. If global bounds are set to be true, then the object is assumed to have an infinitely large bounding box for collision and rendering purposes. @return true if the object has a global bounds. ) +/// Check if this object has a global bounds set. +/// If global bounds are set to be true, then the object is assumed to have an +/// infinitely large bounding box for collision and rendering purposes. +/// @return true if the object has a global bounds. ) +/// /// public bool fnSceneObject_isGlobalBounds (string sceneobject) @@ -28935,7 +36898,9 @@ public bool fnSceneObject_isGlobalBounds (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_isGlobalBounds(sbsceneobject)>=1; } /// -/// @brief Check if we are mounted to another object. @return true if mounted to another object, false if not mounted. ) +/// @brief Check if we are mounted to another object. +/// @return true if mounted to another object, false if not mounted. ) +/// /// public bool fnSceneObject_isMounted (string sceneobject) @@ -28949,7 +36914,13 @@ public bool fnSceneObject_isMounted (string sceneobject) return SafeNativeMethods.mwle_fnSceneObject_isMounted(sbsceneobject)>=1; } /// -/// @brief Mount objB to this object at the desired slot with optional transform. @param objB Object to mount onto us @param slot Mount slot ID @param txfm (optional) mount offset transform @return true if successful, false if failed (objB is not valid) ) +/// @brief Mount objB to this object at the desired slot with optional transform. +/// +/// @param objB Object to mount onto us +/// @param slot Mount slot ID +/// @param txfm (optional) mount offset transform +/// @return true if successful, false if failed (objB is not valid) ) +/// /// public bool fnSceneObject_mountObject (string sceneobject, string objB, int slot, string txfm) @@ -28969,7 +36940,9 @@ public bool fnSceneObject_mountObject (string sceneobject, string objB, int slot return SafeNativeMethods.mwle_fnSceneObject_mountObject(sbsceneobject, sbobjB, slot, sbtxfm)>=1; } /// -/// Set the object's scale. @param scale object scale to set ) +/// Set the object's scale. +/// @param scale object scale to set ) +/// /// public void fnSceneObject_setScale (string sceneobject, string scale) @@ -28986,7 +36959,9 @@ public void fnSceneObject_setScale (string sceneobject, string scale) SafeNativeMethods.mwle_fnSceneObject_setScale(sbsceneobject, sbscale); } /// -/// Set the object's transform (orientation and position). @param txfm object transform to set ) +/// Set the object's transform (orientation and position). +/// @param txfm object transform to set ) +/// /// public void fnSceneObject_setTransform (string sceneobject, string txfm) @@ -29003,7 +36978,9 @@ public void fnSceneObject_setTransform (string sceneobject, string txfm) SafeNativeMethods.mwle_fnSceneObject_setTransform(sbsceneobject, sbtxfm); } /// -/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Adds a new counter or updates an existing counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_TickCounterAdd (string sceneobject, string countername, uint interval) @@ -29020,7 +36997,9 @@ public bool fnSceneObject_TickCounterAdd (string sceneobject, string countername return SafeNativeMethods.mwle_fnSceneObject_TickCounterAdd(sbsceneobject, sbcountername, interval)>=1; } /// -/// @brief returns the interval for a counter. @return true if successful, false if failed ) +/// @brief returns the interval for a counter. +/// @return true if successful, false if failed ) +/// /// public uint fnSceneObject_TickCounterGetInterval (string sceneobject, string countername) @@ -29037,7 +37016,9 @@ public uint fnSceneObject_TickCounterGetInterval (string sceneobject, string cou return SafeNativeMethods.mwle_fnSceneObject_TickCounterGetInterval(sbsceneobject, sbcountername); } /// -/// @brief Checks to see if the counter exists. @return true if successful, false if failed ) +/// @brief Checks to see if the counter exists. +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_TickCounterHas (string sceneobject, string countername) @@ -29054,7 +37035,9 @@ public bool fnSceneObject_TickCounterHas (string sceneobject, string countername return SafeNativeMethods.mwle_fnSceneObject_TickCounterHas(sbsceneobject, sbcountername)>=1; } /// -/// @brief Removes a counter to be tracked via ticks. @return true if successful, false if failed ) +/// @brief Removes a counter to be tracked via ticks. +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_TickCounterRemove (string sceneobject, string countername) @@ -29071,7 +37054,9 @@ public bool fnSceneObject_TickCounterRemove (string sceneobject, string countern return SafeNativeMethods.mwle_fnSceneObject_TickCounterRemove(sbsceneobject, sbcountername)>=1; } /// -/// @brief resets the current count for a counter. @return true if successful, false if failed ) +/// @brief resets the current count for a counter. +/// @return true if successful, false if failed ) +/// /// public void fnSceneObject_TickCounterReset (string sceneobject, string countername) @@ -29088,7 +37073,8 @@ public void fnSceneObject_TickCounterReset (string sceneobject, string counterna SafeNativeMethods.mwle_fnSceneObject_TickCounterReset(sbsceneobject, sbcountername); } /// -/// @brief Clears all counters from the object.) +/// @brief Clears all counters from the object.) +/// /// public void fnSceneObject_TickCountersClear (string sceneobject) @@ -29102,7 +37088,9 @@ public void fnSceneObject_TickCountersClear (string sceneobject) SafeNativeMethods.mwle_fnSceneObject_TickCountersClear(sbsceneobject); } /// -/// @brief Adds a new counter to be tracked via ticks. ) +/// @brief Adds a new counter to be tracked via ticks. +/// ) +/// /// public void fnSceneObject_TickCounterSuspend (string sceneobject, string countername, bool suspend) @@ -29120,6 +37108,7 @@ public void fnSceneObject_TickCounterSuspend (string sceneobject, string counter } /// /// Unmount us from the currently mounted object if any. ) +/// /// public void fnSceneObject_unmount (string sceneobject) @@ -29133,7 +37122,11 @@ public void fnSceneObject_unmount (string sceneobject) SafeNativeMethods.mwle_fnSceneObject_unmount(sbsceneobject); } /// -/// @brief Unmount an object from ourselves. @param target object to unmount @return true if successful, false if failed ) +/// @brief Unmount an object from ourselves. +/// +/// @param target object to unmount +/// @return true if successful, false if failed ) +/// /// public bool fnSceneObject_unmountObject (string sceneobject, string target) @@ -29150,7 +37143,12 @@ public bool fnSceneObject_unmountObject (string sceneobject, string target) return SafeNativeMethods.mwle_fnSceneObject_unmountObject(sbsceneobject, sbtarget)>=1; } /// -/// @brief Is this object wanting to receive tick notifications. If this object is set to receive tick notifications then its onInterpolateTick() and onProcessTick() callbacks are called. @return True if object wants tick notifications ) +/// @brief Is this object wanting to receive tick notifications. +/// +/// If this object is set to receive tick notifications then its onInterpolateTick() and +/// onProcessTick() callbacks are called. +/// @return True if object wants tick notifications ) +/// /// public bool fnScriptTickObject_isProcessingTicks (string scripttickobject) @@ -29164,7 +37162,10 @@ public bool fnScriptTickObject_isProcessingTicks (string scripttickobject) return SafeNativeMethods.mwle_fnScriptTickObject_isProcessingTicks(sbscripttickobject)>=1; } /// -/// @brief Sets this object as either tick processing or not. @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// @brief Sets this object as either tick processing or not. +/// +/// @param tick This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true.) +/// /// public void fnScriptTickObject_setProcessTicks (string scripttickobject, bool tick) @@ -29179,6 +37180,7 @@ public void fnScriptTickObject_setProcessTicks (string scripttickobject, bool ti } /// /// (Settings, write, bool, 2, 2, %success = settingObj.write();) +/// /// public bool fnSettings_write (string settings) @@ -29192,7 +37194,10 @@ public bool fnSettings_write (string settings) return SafeNativeMethods.mwle_fnSettings_write(sbsettings)>=1; } /// -/// Get the index of the playlist slot currently processed by the controller. @return The slot index currently being played. @see SFXPlayList ) +/// Get the index of the playlist slot currently processed by the controller. +/// @return The slot index currently being played. +/// @see SFXPlayList ) +/// /// public int fnSFXController_getCurrentSlot (string sfxcontroller) @@ -29206,7 +37211,9 @@ public int fnSFXController_getCurrentSlot (string sfxcontroller) return SafeNativeMethods.mwle_fnSFXController_getCurrentSlot(sbsfxcontroller); } /// -/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. @param index Index of the playlist slot. ) +/// Set the index of the playlist slot to play by the controller. This can be used to seek in the playlist. +/// @param index Index of the playlist slot. ) +/// /// public void fnSFXController_setCurrentSlot (string sfxcontroller, int index) @@ -29220,7 +37227,11 @@ public void fnSFXController_setCurrentSlot (string sfxcontroller, int index) SafeNativeMethods.mwle_fnSFXController_setCurrentSlot(sbsfxcontroller, index); } /// -/// Get the sound source object from the emitter. @return The sound source used by the emitter or null. @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts actually hold on to %SFXSources. ) +/// Get the sound source object from the emitter. +/// @return The sound source used by the emitter or null. +/// @note This method will return null when called on the server-side SFXEmitter object. Only client-side ghosts +/// actually hold on to %SFXSources. ) +/// /// public string fnSFXEmitter_getSource (string sfxemitter) @@ -29237,7 +37248,9 @@ public string fnSFXEmitter_getSource (string sfxemitter) } /// -/// Manually start playback of the emitter's sound. If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// Manually start playback of the emitter's sound. +/// If this is called on the server-side object, the play command will be related to all client-side ghosts. ) +/// /// public void fnSFXEmitter_play (string sfxemitter) @@ -29251,7 +37264,9 @@ public void fnSFXEmitter_play (string sfxemitter) SafeNativeMethods.mwle_fnSFXEmitter_play(sbsfxemitter); } /// -/// Manually stop playback of the emitter's sound. If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// Manually stop playback of the emitter's sound. +/// If this is called on the server-side object, the stop command will be related to all client-side ghosts. ) +/// /// public void fnSFXEmitter_stop (string sfxemitter) @@ -29265,7 +37280,9 @@ public void fnSFXEmitter_stop (string sfxemitter) SafeNativeMethods.mwle_fnSFXEmitter_stop(sbsfxemitter); } /// -/// Get the name of the parameter. @return The paramete name. ) +/// Get the name of the parameter. +/// @return The paramete name. ) +/// /// public string fnSFXParameter_getParameterName (string sfxparameter) @@ -29282,7 +37299,9 @@ public string fnSFXParameter_getParameterName (string sfxparameter) } /// -/// Reset the parameter's value to its default. @see SFXParameter::defaultValue ) +/// Reset the parameter's value to its default. +/// @see SFXParameter::defaultValue ) +/// /// public void fnSFXParameter_reset (string sfxparameter) @@ -29296,7 +37315,9 @@ public void fnSFXParameter_reset (string sfxparameter) SafeNativeMethods.mwle_fnSFXParameter_reset(sbsfxparameter); } /// -/// Return the length of the sound data in seconds. @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// Return the length of the sound data in seconds. +/// @return The length of the sound data in seconds or 0 if the sound referenced by the profile could not be found. ) +/// /// public float fnSFXProfile_getSoundDuration (string sfxprofile) @@ -29310,7 +37331,10 @@ public float fnSFXProfile_getSoundDuration (string sfxprofile) return SafeNativeMethods.mwle_fnSFXProfile_getSoundDuration(sbsfxprofile); } /// -/// Get the total play time (in seconds) of the sound data attached to the sound. @return @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// Get the total play time (in seconds) of the sound data attached to the sound. +/// @return +/// @note Be aware that for looped sounds, this will not return the total playback time of the sound. ) +/// /// public float fnSFXSound_getDuration (string sfxsound) @@ -29324,7 +37348,9 @@ public float fnSFXSound_getDuration (string sfxsound) return SafeNativeMethods.mwle_fnSFXSound_getDuration(sbsfxsound); } /// -/// Get the current playback position in seconds. @return The current play cursor offset. ) +/// Get the current playback position in seconds. +/// @return The current play cursor offset. ) +/// /// public float fnSFXSound_getPosition (string sfxsound) @@ -29338,7 +37364,12 @@ public float fnSFXSound_getPosition (string sfxsound) return SafeNativeMethods.mwle_fnSFXSound_getPosition(sbsfxsound); } /// -/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. For streamed sounds, this will be false during playback when the stream queue for the sound is starved and waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to return false. @return True if the sound is ready for playback. ) +/// Test whether the sound data associated with the sound has been fully loaded and is ready for playback. +/// For streamed sounds, this will be false during playback when the stream queue for the sound is starved and +/// waiting for data. For buffered sounds, only an initial loading phase will potentially cause isReady to +/// return false. +/// @return True if the sound is ready for playback. ) +/// /// public bool fnSFXSound_isReady (string sfxsound) @@ -29352,7 +37383,11 @@ public bool fnSFXSound_isReady (string sfxsound) return SafeNativeMethods.mwle_fnSFXSound_isReady(sbsfxsound)>=1; } /// -/// Set the current playback position in seconds. If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, playback will resume at the given position when play() is called. @param position The new position of the play cursor (in seconds). ) +/// Set the current playback position in seconds. +/// If the source is currently playing, playback will jump to the new position. If playback is stopped or paused, +/// playback will resume at the given position when play() is called. +/// @param position The new position of the play cursor (in seconds). ) +/// /// public void fnSFXSound_setPosition (string sfxsound, float position) @@ -29366,7 +37401,32 @@ public void fnSFXSound_setPosition (string sfxsound, float position) SafeNativeMethods.mwle_fnSFXSound_setPosition(sbsfxsound, position); } /// -/// Add a notification marker called @a name at @a pos seconds of playback. @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there may be a delay between the play cursor actually passing the position and the callback being triggered. @note For looped sounds, the marker will trigger on each iteration. @tsexample // Create a new source. $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); // Assign a class to the source. $source.class = \"BackgroundMusic\"; // Add a playback marker at one minute into playback. $source.addMarker( \"first\", 60 ); // Define the callback function. This function will be called when the playback position passes the one minute mark. function BackgroundMusic::onMarkerPassed( %this, %markerName ) { if( %markerName $= \"first\" ) echo( \"Playback has passed the 60 seconds mark.\" ); } // Play the sound. $source.play(); @endtsexample ) +/// Add a notification marker called @a name at @a pos seconds of playback. +/// @param name Symbolic name for the marker that will be passed to the onMarkerPassed() callback. +/// @param pos Playback position in seconds when the notification should trigger. Note that this is a soft limit and there +/// may be a delay between the play cursor actually passing the position and the callback being triggered. +/// @note For looped sounds, the marker will trigger on each iteration. +/// @tsexample +/// // Create a new source. +/// $source = sfxCreateSource( AudioMusicLoop2D, \"art/sound/backgroundMusic\" ); +/// +/// // Assign a class to the source. +/// $source.class = \"BackgroundMusic\"; +/// +/// // Add a playback marker at one minute into playback. +/// $source.addMarker( \"first\", 60 ); +/// +/// // Define the callback function. This function will be called when the playback position passes the one minute mark. +/// function BackgroundMusic::onMarkerPassed( %this, %markerName ) +/// { +/// if( %markerName $= \"first\" ) +/// echo( \"Playback has passed the 60 seconds mark.\" ); +/// } +/// +/// // Play the sound. +/// $source.play(); +/// @endtsexample ) +/// /// public void fnSFXSource_addMarker (string sfxsource, string name, float pos) @@ -29383,7 +37443,11 @@ public void fnSFXSource_addMarker (string sfxsource, string name, float pos) SafeNativeMethods.mwle_fnSFXSource_addMarker(sbsfxsource, sbname, pos); } /// -/// Attach @a parameter to the source, Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter will also trigger an initial read-out of the parameter's current value. @param parameter The parameter to attach to the source. ) +/// Attach @a parameter to the source, +/// Once attached, the source will react to value changes of the given @a parameter. Attaching a parameter +/// will also trigger an initial read-out of the parameter's current value. +/// @param parameter The parameter to attach to the source. ) +/// /// public void fnSFXSource_addParameter (string sfxsource, string parameter) @@ -29400,7 +37464,12 @@ public void fnSFXSource_addParameter (string sfxsource, string parameter) SafeNativeMethods.mwle_fnSFXSource_addParameter(sbsfxsource, sbparameter); } /// -/// Get the final effective volume level of the source. This method returns the volume level as it is after source group volume modulation, fades, and distance-based volume attenuation have been applied to the base volume level. @return The effective volume of the source. @ref SFXSource_volume ) +/// Get the final effective volume level of the source. +/// This method returns the volume level as it is after source group volume modulation, fades, and distance-based +/// volume attenuation have been applied to the base volume level. +/// @return The effective volume of the source. +/// @ref SFXSource_volume ) +/// /// public float fnSFXSource_getAttenuatedVolume (string sfxsource) @@ -29414,7 +37483,12 @@ public float fnSFXSource_getAttenuatedVolume (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getAttenuatedVolume(sbsfxsource); } /// -/// Get the fade-in time set on the source. This will initially be SFXDescription::fadeInTime. @return The fade-in time set on the source in seconds. @see SFXDescription::fadeInTime @ref SFXSource_fades ) +/// Get the fade-in time set on the source. +/// This will initially be SFXDescription::fadeInTime. +/// @return The fade-in time set on the source in seconds. +/// @see SFXDescription::fadeInTime +/// @ref SFXSource_fades ) +/// /// public float fnSFXSource_getFadeInTime (string sfxsource) @@ -29428,7 +37502,12 @@ public float fnSFXSource_getFadeInTime (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getFadeInTime(sbsfxsource); } /// -/// Get the fade-out time set on the source. This will initially be SFXDescription::fadeOutTime. @return The fade-out time set on the source in seconds. @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Get the fade-out time set on the source. +/// This will initially be SFXDescription::fadeOutTime. +/// @return The fade-out time set on the source in seconds. +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public float fnSFXSource_getFadeOutTime (string sfxsource) @@ -29442,7 +37521,17 @@ public float fnSFXSource_getFadeOutTime (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getFadeOutTime(sbsfxsource); } /// -/// Get the parameter at the given index. @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). @return The parameter at the given @a index or null if @a index is out of range. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameterCount ) +/// Get the parameter at the given index. +/// @param index Index of the parameter to fetch. Must be 0=index=getParameterCount(). +/// @return The parameter at the given @a index or null if @a index is out of range. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameterCount ) +/// /// public string fnSFXSource_getParameter (string sfxsource, int index) @@ -29459,7 +37548,17 @@ public string fnSFXSource_getParameter (string sfxsource, int index) } /// -/// Get the number of SFXParameters that are attached to the source. @return The number of parameters attached to the source. @tsexample // Print the name ofo each parameter attached to %source. %numParams = %source.getParameterCount(); for( %i = 0; %i %numParams; %i ++ ) echo( %source.getParameter( %i ).getParameterName() ); @endtsexample @see getParameter @see addParameter ) +/// Get the number of SFXParameters that are attached to the source. +/// @return The number of parameters attached to the source. +/// @tsexample +/// // Print the name ofo each parameter attached to %source. +/// %numParams = %source.getParameterCount(); +/// for( %i = 0; %i %numParams; %i ++ ) +/// echo( %source.getParameter( %i ).getParameterName() ); +/// @endtsexample +/// @see getParameter +/// @see addParameter ) +/// /// public int fnSFXSource_getParameterCount (string sfxsource) @@ -29473,7 +37572,12 @@ public int fnSFXSource_getParameterCount (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getParameterCount(sbsfxsource); } /// -/// Get the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @return The current pitch scale factor of the source. @see setPitch @see SFXDescription::pitch ) +/// Get the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @return The current pitch scale factor of the source. +/// @see setPitch +/// @see SFXDescription::pitch ) +/// /// public float fnSFXSource_getPitch (string sfxsource) @@ -29487,7 +37591,9 @@ public float fnSFXSource_getPitch (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getPitch(sbsfxsource); } /// -/// Get the current playback status. @return Te current playback status ) +/// Get the current playback status. +/// @return Te current playback status ) +/// /// public int fnSFXSource_getStatus (string sfxsource) @@ -29501,7 +37607,14 @@ public int fnSFXSource_getStatus (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getStatus(sbsfxsource); } /// -/// Get the current base volume level of the source. This is not the final effective volume that the source is playing at but rather the starting volume level before source group modulation, fades, or distance-based volume attenuation are applied. @return The current base volume level. @see setVolume @see SFXDescription::volume @ref SFXSource_volume ) +/// Get the current base volume level of the source. +/// This is not the final effective volume that the source is playing at but rather the starting +/// volume level before source group modulation, fades, or distance-based volume attenuation are applied. +/// @return The current base volume level. +/// @see setVolume +/// @see SFXDescription::volume +/// @ref SFXSource_volume ) +/// /// public float fnSFXSource_getVolume (string sfxsource) @@ -29515,7 +37628,12 @@ public float fnSFXSource_getVolume (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_getVolume(sbsfxsource); } /// -/// Test whether the source is currently paused. @return True if the source is in paused state, false otherwise. @see pause @see getStatus @see SFXStatus ) +/// Test whether the source is currently paused. +/// @return True if the source is in paused state, false otherwise. +/// @see pause +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool fnSFXSource_isPaused (string sfxsource) @@ -29529,7 +37647,12 @@ public bool fnSFXSource_isPaused (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_isPaused(sbsfxsource)>=1; } /// -/// Test whether the source is currently playing. @return True if the source is in playing state, false otherwise. @see play @see getStatus @see SFXStatus ) +/// Test whether the source is currently playing. +/// @return True if the source is in playing state, false otherwise. +/// @see play +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool fnSFXSource_isPlaying (string sfxsource) @@ -29543,7 +37666,12 @@ public bool fnSFXSource_isPlaying (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_isPlaying(sbsfxsource)>=1; } /// -/// Test whether the source is currently stopped. @return True if the source is in stopped state, false otherwise. @see stop @see getStatus @see SFXStatus ) +/// Test whether the source is currently stopped. +/// @return True if the source is in stopped state, false otherwise. +/// @see stop +/// @see getStatus +/// @see SFXStatus ) +/// /// public bool fnSFXSource_isStopped (string sfxsource) @@ -29557,7 +37685,13 @@ public bool fnSFXSource_isStopped (string sfxsource) return SafeNativeMethods.mwle_fnSFXSource_isStopped(sbsfxsource)>=1; } /// -/// Pause playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately to paused state but will rather remain in playing state until the fade-out time has expired.. ) +/// Pause playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately to paused state but will +/// rather remain in playing state until the fade-out time has expired.. ) +/// /// public void fnSFXSource_pause (string sfxsource, float fadeOutTime) @@ -29571,7 +37705,13 @@ public void fnSFXSource_pause (string sfxsource, float fadeOutTime) SafeNativeMethods.mwle_fnSFXSource_pause(sbsfxsource, fadeOutTime); } /// -/// Start playback of the source. If the sound data for the source has not yet been fully loaded, there will be a delay after calling play and playback will start after the data has become available. @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime set in the source's associated description is used. Pass 0 to disable a fade-in effect that may be configured on the description. ) +/// Start playback of the source. +/// If the sound data for the source has not yet been fully loaded, there will be a delay after calling +/// play and playback will start after the data has become available. +/// @param fadeInTime Seconds for the sound to reach full volume. If -1, the SFXDescription::fadeInTime +/// set in the source's associated description is used. Pass 0 to disable a fade-in effect that may +/// be configured on the description. ) +/// /// public void fnSFXSource_play (string sfxsource, float fadeInTime) @@ -29585,7 +37725,11 @@ public void fnSFXSource_play (string sfxsource, float fadeInTime) SafeNativeMethods.mwle_fnSFXSource_play(sbsfxsource, fadeInTime); } /// -/// Detach @a parameter from the source. Once detached, the source will no longer react to value changes of the given @a parameter. If the parameter is not attached to the source, the method will do nothing. @param parameter The parameter to detach from the source. ) +/// Detach @a parameter from the source. +/// Once detached, the source will no longer react to value changes of the given @a parameter. +/// If the parameter is not attached to the source, the method will do nothing. +/// @param parameter The parameter to detach from the source. ) +/// /// public void fnSFXSource_removeParameter (string sfxsource, string parameter) @@ -29602,7 +37746,12 @@ public void fnSFXSource_removeParameter (string sfxsource, string parameter) SafeNativeMethods.mwle_fnSFXSource_removeParameter(sbsfxsource, sbparameter); } /// -/// Set up the 3D volume cone for the source. @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. @note This method has no effect on the source if the source is not 3D. ) +/// Set up the 3D volume cone for the source. +/// @param innerAngle Angle of the inner sound cone in degrees (@ref SFXDescription::coneInsideAngle). Must be 0=innerAngle=360. +/// @param outerAngle Angle of the outer sound cone in degrees (@ref SFXDescription::coneOutsideAngle). Must be 0=outerAngle=360. +/// @param outsideVolume Volume scale factor outside of outer cone (@ref SFXDescription::coneOutsideVolume). Must be 0=outsideVolume=1. +/// @note This method has no effect on the source if the source is not 3D. ) +/// /// public void fnSFXSource_setCone (string sfxsource, float innerAngle, float outerAngle, float outsideVolume) @@ -29616,7 +37765,13 @@ public void fnSFXSource_setCone (string sfxsource, float innerAngle, float outer SafeNativeMethods.mwle_fnSFXSource_setCone(sbsfxsource, innerAngle, outerAngle, outsideVolume); } /// -/// Set the fade time parameters of the source. @param fadeInTime The new fade-in time in seconds. @param fadeOutTime The new fade-out time in seconds. @see SFXDescription::fadeInTime @see SFXDescription::fadeOutTime @ref SFXSource_fades ) +/// Set the fade time parameters of the source. +/// @param fadeInTime The new fade-in time in seconds. +/// @param fadeOutTime The new fade-out time in seconds. +/// @see SFXDescription::fadeInTime +/// @see SFXDescription::fadeOutTime +/// @ref SFXSource_fades ) +/// /// public void fnSFXSource_setFadeTimes (string sfxsource, float fadeInTime, float fadeOutTime) @@ -29630,7 +37785,12 @@ public void fnSFXSource_setFadeTimes (string sfxsource, float fadeInTime, float SafeNativeMethods.mwle_fnSFXSource_setFadeTimes(sbsfxsource, fadeInTime, fadeOutTime); } /// -/// Set the pitch scale of the source. Pitch determines the playback speed of the source (default: 1). @param pitch The new pitch scale factor. @see getPitch @see SFXDescription::pitch ) +/// Set the pitch scale of the source. +/// Pitch determines the playback speed of the source (default: 1). +/// @param pitch The new pitch scale factor. +/// @see getPitch +/// @see SFXDescription::pitch ) +/// /// public void fnSFXSource_setPitch (string sfxsource, float pitch) @@ -29644,7 +37804,13 @@ public void fnSFXSource_setPitch (string sfxsource, float pitch) SafeNativeMethods.mwle_fnSFXSource_setPitch(sbsfxsource, pitch); } /// -/// Set the base volume level for the source. This volume will be the starting point for source group volume modulation, fades, and distance-based volume attenuation. @param volume The new base volume level for the source. Must be 0>=volume=1. @see getVolume @ref SFXSource_volume ) +/// Set the base volume level for the source. +/// This volume will be the starting point for source group volume modulation, fades, and distance-based +/// volume attenuation. +/// @param volume The new base volume level for the source. Must be 0>=volume=1. +/// @see getVolume +/// @ref SFXSource_volume ) +/// /// public void fnSFXSource_setVolume (string sfxsource, float volume) @@ -29658,7 +37824,13 @@ public void fnSFXSource_setVolume (string sfxsource, float volume) SafeNativeMethods.mwle_fnSFXSource_setVolume(sbsfxsource, volume); } /// -/// Stop playback of the source. @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be configured on the description. Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but will rather remain in playing state until the fade-out time has expired. ) +/// Stop playback of the source. +/// @param fadeOutTime Seconds for the sound to fade down to zero volume. If -1, the SFXDescription::fadeOutTime +/// set in the source's associated description is used. Pass 0 to disable a fade-out effect that may be +/// configured on the description. +/// Be aware that if a fade-out effect is used, the source will not immediately transtion to stopped state but +/// will rather remain in playing state until the fade-out time has expired. ) +/// /// public void fnSFXSource_stop (string sfxsource, float fadeOutTime) @@ -29672,7 +37844,11 @@ public void fnSFXSource_stop (string sfxsource, float fadeOutTime) SafeNativeMethods.mwle_fnSFXSource_stop(sbsfxsource, fadeOutTime); } /// -/// Increase the activation count on the state. If the state isn't already active and it is not disabled, the state will be activated. @see isActive @see deactivate ) +/// Increase the activation count on the state. +/// If the state isn't already active and it is not disabled, the state will be activated. +/// @see isActive +/// @see deactivate ) +/// /// public void fnSFXState_activate (string sfxstate) @@ -29686,7 +37862,11 @@ public void fnSFXState_activate (string sfxstate) SafeNativeMethods.mwle_fnSFXState_activate(sbsfxstate); } /// -/// Decrease the activation count on the state. If the count reaches zero and the state was not disabled, the state will be deactivated. @see isActive @see activate ) +/// Decrease the activation count on the state. +/// If the count reaches zero and the state was not disabled, the state will be deactivated. +/// @see isActive +/// @see activate ) +/// /// public void fnSFXState_deactivate (string sfxstate) @@ -29700,7 +37880,10 @@ public void fnSFXState_deactivate (string sfxstate) SafeNativeMethods.mwle_fnSFXState_deactivate(sbsfxstate); } /// -/// Increase the disabling count of the state. If the state is currently active, it will be deactivated. @see isDisabled ) +/// Increase the disabling count of the state. +/// If the state is currently active, it will be deactivated. +/// @see isDisabled ) +/// /// public void fnSFXState_disable (string sfxstate) @@ -29714,7 +37897,11 @@ public void fnSFXState_disable (string sfxstate) SafeNativeMethods.mwle_fnSFXState_disable(sbsfxstate); } /// -/// Decrease the disabling count of the state. If the disabling count reaches zero while the activation count is still non-zero, the state will be reactivated again. @see isDisabled ) +/// Decrease the disabling count of the state. +/// If the disabling count reaches zero while the activation count is still non-zero, +/// the state will be reactivated again. +/// @see isDisabled ) +/// /// public void fnSFXState_enable (string sfxstate) @@ -29728,7 +37915,11 @@ public void fnSFXState_enable (string sfxstate) SafeNativeMethods.mwle_fnSFXState_enable(sbsfxstate); } /// -/// Test whether the state is currently active. This is true when the activation count is >0 and the disabling count is =0. @return True if the state is currently active. @see activate ) +/// Test whether the state is currently active. +/// This is true when the activation count is >0 and the disabling count is =0. +/// @return True if the state is currently active. +/// @see activate ) +/// /// public bool fnSFXState_isActive (string sfxstate) @@ -29742,7 +37933,11 @@ public bool fnSFXState_isActive (string sfxstate) return SafeNativeMethods.mwle_fnSFXState_isActive(sbsfxstate)>=1; } /// -/// Test whether the state is currently disabled. This is true when the disabling count of the state is non-zero. @return True if the state is disabled. @see disable ) +/// Test whether the state is currently disabled. +/// This is true when the disabling count of the state is non-zero. +/// @return True if the state is disabled. +/// @see disable ) +/// /// public bool fnSFXState_isDisabled (string sfxstate) @@ -29756,7 +37951,13 @@ public bool fnSFXState_isDisabled (string sfxstate) return SafeNativeMethods.mwle_fnSFXState_isDisabled(sbsfxstate)>=1; } /// -/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. @tsexample // Rebuild the shader instances from ShaderData CloudLayerShader CloudLayerShader.reload(); @endtsexample) +/// @brief Rebuilds all the vertex and pixel shader instances created from this ShaderData. +/// +/// @tsexample +/// // Rebuild the shader instances from ShaderData CloudLayerShader +/// CloudLayerShader.reload(); +/// @endtsexample) +/// /// public void fnShaderData_reload (string shaderdata) @@ -29770,7 +37971,10 @@ public void fnShaderData_reload (string shaderdata) SafeNativeMethods.mwle_fnShaderData_reload(sbshaderdata); } /// -/// @brief Increment the current damage level by the specified amount. @param amount value to add to current damage level ) +/// @brief Increment the current damage level by the specified amount. +/// +/// @param amount value to add to current damage level ) +/// /// public void fnShapeBase_applyDamage (string shapebase, float amount) @@ -29784,7 +37988,12 @@ public void fnShapeBase_applyDamage (string shapebase, float amount) SafeNativeMethods.mwle_fnShapeBase_applyDamage(sbshapebase, amount); } /// -/// @brief Apply an impulse to the object. @param pos world position of the impulse @param vec impulse momentum (velocity * mass) @return true ) +/// @brief Apply an impulse to the object. +/// +/// @param pos world position of the impulse +/// @param vec impulse momentum (velocity * mass) +/// @return true ) +/// /// public bool fnShapeBase_applyImpulse (string shapebase, string pos, string vec) @@ -29804,7 +38013,13 @@ public bool fnShapeBase_applyImpulse (string shapebase, string pos, string vec) return SafeNativeMethods.mwle_fnShapeBase_applyImpulse(sbshapebase, sbpos, sbvec)>=1; } /// -/// @brief Repair damage by the specified amount. Note that the damage level is only reduced by repairRate per tick, so it may take several ticks for the total repair to complete. @param amount total repair value (subtracted from damage level over time) ) +/// @brief Repair damage by the specified amount. +/// +/// Note that the damage level is only reduced by repairRate per tick, so it may +/// take several ticks for the total repair to complete. +/// +/// @param amount total repair value (subtracted from damage level over time) ) +/// /// public void fnShapeBase_applyRepair (string shapebase, float amount) @@ -29819,6 +38034,7 @@ public void fnShapeBase_applyRepair (string shapebase, float amount) } /// /// @brief Explodes an object into pieces.) +/// /// public void fnShapeBase_blowUp (string shapebase) @@ -29832,7 +38048,11 @@ public void fnShapeBase_blowUp (string shapebase) SafeNativeMethods.mwle_fnShapeBase_blowUp(sbshapebase); } /// -/// @brief Check if this object can cloak. @return true @note Not implemented as it always returns true.) +/// @brief Check if this object can cloak. +/// @return true +/// +/// @note Not implemented as it always returns true.) +/// /// public bool fnShapeBase_canCloak (string shapebase) @@ -29846,7 +38066,24 @@ public bool fnShapeBase_canCloak (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_canCloak(sbshapebase)>=1; } /// -/// @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void fnShapeBase_changeMaterial (string shapebase, string mapTo, string oldMat, string newMat) @@ -29869,7 +38106,13 @@ public void fnShapeBase_changeMaterial (string shapebase, string mapTo, string o SafeNativeMethods.mwle_fnShapeBase_changeMaterial(sbshapebase, sbmapTo, sboldMat, sbnewMat); } /// -/// @brief Destroy an animation thread, which prevents it from playing. @param slot thread slot to destroy @return true if successful, false if failed @see playThread ) +/// @brief Destroy an animation thread, which prevents it from playing. +/// +/// @param slot thread slot to destroy +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_destroyThread (string shapebase, int slot) @@ -29883,7 +38126,10 @@ public bool fnShapeBase_destroyThread (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_destroyThread(sbshapebase, slot)>=1; } /// -/// @brief Print a list of visible and hidden meshes in the shape to the console for debugging purposes. @note Only in a SHIPPING build.) +/// @brief Print a list of visible and hidden meshes in the shape to the console +/// for debugging purposes. +/// @note Only in a SHIPPING build.) +/// /// public void fnShapeBase_dumpMeshVisibility (string shapebase) @@ -29897,7 +38143,12 @@ public void fnShapeBase_dumpMeshVisibility (string shapebase) SafeNativeMethods.mwle_fnShapeBase_dumpMeshVisibility(sbshapebase); } /// -/// @brief Get the position at which the AI should stand to repair things. If the shape defines a node called \"AIRepairNode\", this method will return the current world position of that node, otherwise \"0 0 0\". @return the AI repair position ) +/// @brief Get the position at which the AI should stand to repair things. +/// +/// If the shape defines a node called \"AIRepairNode\", this method will +/// return the current world position of that node, otherwise \"0 0 0\". +/// @return the AI repair position ) +/// /// public string fnShapeBase_getAIRepairPoint (string shapebase) @@ -29914,7 +38165,10 @@ public string fnShapeBase_getAIRepairPoint (string shapebase) } /// -/// @brief Returns the vertical field of view in degrees for this object if used as a camera. @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// @brief Returns the vertical field of view in degrees for this object if used as a camera. +/// +/// @return current FOV as defined in ShapeBaseData::cameraDefaultFov ) +/// /// public float fnShapeBase_getCameraFov (string shapebase) @@ -29928,7 +38182,15 @@ public float fnShapeBase_getCameraFov (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getCameraFov(sbshapebase); } /// -/// @brief Get the client (if any) that controls this object. The controlling client is the one that will send moves to us to act on. @return the ID of the controlling GameConnection, or 0 if this object is not controlled by any client. @see GameConnection) +/// @brief Get the client (if any) that controls this object. +/// +/// The controlling client is the one that will send moves to us to act on. +/// +/// @return the ID of the controlling GameConnection, or 0 if this object is not +/// controlled by any client. +/// +/// @see GameConnection) +/// /// public int fnShapeBase_getControllingClient (string shapebase) @@ -29942,7 +38204,11 @@ public int fnShapeBase_getControllingClient (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getControllingClient(sbshapebase); } /// -/// @brief Get the object (if any) that controls this object. @return the ID of the controlling ShapeBase object, or 0 if this object is not controlled by another object. ) +/// @brief Get the object (if any) that controls this object. +/// +/// @return the ID of the controlling ShapeBase object, or 0 if this object is +/// not controlled by another object. ) +/// /// public int fnShapeBase_getControllingObject (string shapebase) @@ -29956,7 +38222,12 @@ public int fnShapeBase_getControllingObject (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getControllingObject(sbshapebase); } /// -/// @brief Get the damage flash level. @return flash level @see setDamageFlash ) +/// @brief Get the damage flash level. +/// +/// @return flash level +/// +/// @see setDamageFlash ) +/// /// public float fnShapeBase_getDamageFlash (string shapebase) @@ -29970,7 +38241,12 @@ public float fnShapeBase_getDamageFlash (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDamageFlash(sbshapebase); } /// -/// @brief Get the object's current damage level. @return damage level @see setDamageLevel()) +/// @brief Get the object's current damage level. +/// +/// @return damage level +/// +/// @see setDamageLevel()) +/// /// public float fnShapeBase_getDamageLevel (string shapebase) @@ -29984,7 +38260,12 @@ public float fnShapeBase_getDamageLevel (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDamageLevel(sbshapebase); } /// -/// @brief Get the object's current damage level as a percentage of maxDamage. @return damageLevel / datablock.maxDamage @see setDamageLevel()) +/// @brief Get the object's current damage level as a percentage of maxDamage. +/// +/// @return damageLevel / datablock.maxDamage +/// +/// @see setDamageLevel()) +/// /// public float fnShapeBase_getDamagePercent (string shapebase) @@ -29998,7 +38279,12 @@ public float fnShapeBase_getDamagePercent (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDamagePercent(sbshapebase); } /// -/// @brief Get the object's damage state. @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" @see setDamageState()) +/// @brief Get the object's damage state. +/// +/// @return the damage state; one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// +/// @see setDamageState()) +/// /// public string fnShapeBase_getDamageState (string shapebase) @@ -30015,7 +38301,10 @@ public string fnShapeBase_getDamageState (string shapebase) } /// -/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. @return Default FOV ) +/// @brief Returns the default vertical field of view in degrees for this object if used as a camera. +/// +/// @return Default FOV ) +/// /// public float fnShapeBase_getDefaultCameraFov (string shapebase) @@ -30029,7 +38318,12 @@ public float fnShapeBase_getDefaultCameraFov (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getDefaultCameraFov(sbshapebase); } /// -/// @brief Get the object's current energy level. @return energy level @see setEnergyLevel()) +/// @brief Get the object's current energy level. +/// +/// @return energy level +/// +/// @see setEnergyLevel()) +/// /// public float fnShapeBase_getEnergyLevel (string shapebase) @@ -30043,7 +38337,11 @@ public float fnShapeBase_getEnergyLevel (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getEnergyLevel(sbshapebase); } /// -/// @brief Get the object's current energy level as a percentage of maxEnergy. @return energyLevel / datablock.maxEnergy @see setEnergyLevel()) +/// @brief Get the object's current energy level as a percentage of maxEnergy. +/// @return energyLevel / datablock.maxEnergy +/// +/// @see setEnergyLevel()) +/// /// public float fnShapeBase_getEnergyPercent (string shapebase) @@ -30057,7 +38355,17 @@ public float fnShapeBase_getEnergyPercent (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getEnergyPercent(sbshapebase); } /// -/// @brief Get the position of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current world position, otherwise it will return the object's current world position. @return the eye position for this object @see getEyeVector @see getEyeTransform ) +/// @brief Get the position of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current world position, otherwise it will return the object's current +/// world position. +/// +/// @return the eye position for this object +/// +/// @see getEyeVector +/// @see getEyeTransform ) +/// /// public string fnShapeBase_getEyePoint (string shapebase) @@ -30074,7 +38382,17 @@ public string fnShapeBase_getEyePoint (string shapebase) } /// -/// @brief Get the 'eye' transform for this object. If the object model has a node called 'eye', this method will return that node's current transform, otherwise it will return the object's current transform. @return the eye transform for this object @see getEyeVector @see getEyePoint ) +/// @brief Get the 'eye' transform for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current transform, otherwise it will return the object's current +/// transform. +/// +/// @return the eye transform for this object +/// +/// @see getEyeVector +/// @see getEyePoint ) +/// /// public string fnShapeBase_getEyeTransform (string shapebase) @@ -30091,7 +38409,17 @@ public string fnShapeBase_getEyeTransform (string shapebase) } /// -/// @brief Get the forward direction of the 'eye' for this object. If the object model has a node called 'eye', this method will return that node's current forward direction vector, otherwise it will return the object's current forward direction vector. @return the eye vector for this object @see getEyePoint @see getEyeTransform ) +/// @brief Get the forward direction of the 'eye' for this object. +/// +/// If the object model has a node called 'eye', this method will return that +/// node's current forward direction vector, otherwise it will return the +/// object's current forward direction vector. +/// +/// @return the eye vector for this object +/// +/// @see getEyePoint +/// @see getEyeTransform ) +/// /// public string fnShapeBase_getEyeVector (string shapebase) @@ -30108,7 +38436,11 @@ public string fnShapeBase_getEyeVector (string shapebase) } /// -/// @brief Get the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current alt trigger state ) +/// @brief Get the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current alt trigger state ) +/// /// public bool fnShapeBase_getImageAltTrigger (string shapebase, int slot) @@ -30122,7 +38454,11 @@ public bool fnShapeBase_getImageAltTrigger (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageAltTrigger(sbshapebase, slot)>=1; } /// -/// @brief Get the ammo state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current ammo state ) +/// @brief Get the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current ammo state ) +/// /// public bool fnShapeBase_getImageAmmo (string shapebase, int slot) @@ -30136,7 +38472,12 @@ public bool fnShapeBase_getImageAmmo (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageAmmo(sbshapebase, slot)>=1; } /// -/// @brief Get the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to query @param trigger Generic trigger number @return the Image's current generic trigger state ) +/// @brief Get the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @param trigger Generic trigger number +/// @return the Image's current generic trigger state ) +/// /// public bool fnShapeBase_getImageGenericTrigger (string shapebase, int slot, int trigger) @@ -30150,7 +38491,11 @@ public bool fnShapeBase_getImageGenericTrigger (string shapebase, int slot, int return SafeNativeMethods.mwle_fnShapeBase_getImageGenericTrigger(sbshapebase, slot, trigger)>=1; } /// -/// @brief Get the loaded state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current loaded state ) +/// @brief Get the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current loaded state ) +/// /// public bool fnShapeBase_getImageLoaded (string shapebase, int slot) @@ -30164,7 +38509,11 @@ public bool fnShapeBase_getImageLoaded (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageLoaded(sbshapebase, slot)>=1; } /// -/// @brief Get the script animation prefix of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current script animation prefix ) +/// @brief Get the script animation prefix of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current script animation prefix ) +/// /// public string fnShapeBase_getImageScriptAnimPrefix (string shapebase, int slot) @@ -30181,7 +38530,12 @@ public string fnShapeBase_getImageScriptAnimPrefix (string shapebase, int slot) } /// -/// @brief Get the skin tag ID for the Image mounted in the specified slot. @param slot Image slot to query @return the skinTag value passed to mountImage when the image was mounted ) +/// @brief Get the skin tag ID for the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the skinTag value passed to mountImage when the image was +/// mounted ) +/// /// public int fnShapeBase_getImageSkinTag (string shapebase, int slot) @@ -30195,7 +38549,11 @@ public int fnShapeBase_getImageSkinTag (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageSkinTag(sbshapebase, slot); } /// -/// @brief Get the name of the current state of the Image in the specified slot. @param slot Image slot to query @return name of the current Image state, or \"Error\" if slot is invalid ) +/// @brief Get the name of the current state of the Image in the specified slot. +/// +/// @param slot Image slot to query +/// @return name of the current Image state, or \"Error\" if slot is invalid ) +/// /// public string fnShapeBase_getImageState (string shapebase, int slot) @@ -30212,7 +38570,11 @@ public string fnShapeBase_getImageState (string shapebase, int slot) } /// -/// @brief Get the target state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current target state ) +/// @brief Get the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current target state ) +/// /// public bool fnShapeBase_getImageTarget (string shapebase, int slot) @@ -30226,7 +38588,11 @@ public bool fnShapeBase_getImageTarget (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageTarget(sbshapebase, slot)>=1; } /// -/// @brief Get the trigger state of the Image mounted in the specified slot. @param slot Image slot to query @return the Image's current trigger state ) +/// @brief Get the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return the Image's current trigger state ) +/// /// public bool fnShapeBase_getImageTrigger (string shapebase, int slot) @@ -30240,7 +38606,19 @@ public bool fnShapeBase_getImageTrigger (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getImageTrigger(sbshapebase, slot)>=1; } /// -/// @brief Get the world position this object is looking at. Casts a ray from the eye and returns information about what the ray hits. @param distance maximum distance of the raycast @param typeMask typeMask of objects to include for raycast collision testing @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit @tsexample %lookat = %obj.getLookAtPoint(); echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); @endtsexample ) +/// @brief Get the world position this object is looking at. +/// +/// Casts a ray from the eye and returns information about what the ray hits. +/// +/// @param distance maximum distance of the raycast +/// @param typeMask typeMask of objects to include for raycast collision testing +/// @return look-at information as \"Object HitX HitY HitZ [Material]\" or empty string for no hit +/// +/// @tsexample +/// %lookat = %obj.getLookAtPoint(); +/// echo( \"Looking at: \" @ getWords( %lookat, 1, 3 ) ); +/// @endtsexample ) +/// /// public string fnShapeBase_getLookAtPoint (string shapebase, float distance, uint typeMask) @@ -30257,7 +38635,9 @@ public string fnShapeBase_getLookAtPoint (string shapebase, float distance, uint } /// -/// Get the object's maxDamage level. @return datablock.maxDamage) +/// Get the object's maxDamage level. +/// @return datablock.maxDamage) +/// /// public float fnShapeBase_getMaxDamage (string shapebase) @@ -30271,7 +38651,10 @@ public float fnShapeBase_getMaxDamage (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getMaxDamage(sbshapebase); } /// -/// @brief Get the model filename used by this shape. @return the shape filename ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename ) +/// /// public string fnShapeBase_getModelFile (string shapebase) @@ -30288,7 +38671,12 @@ public string fnShapeBase_getModelFile (string shapebase) } /// -/// @brief Get the Image mounted in the specified slot. @param slot Image slot to query @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 if no Image is mounted there. ) +/// @brief Get the Image mounted in the specified slot. +/// +/// @param slot Image slot to query +/// @return ID of the ShapeBaseImageData datablock mounted in the slot, or 0 +/// if no Image is mounted there. ) +/// /// public int fnShapeBase_getMountedImage (string shapebase, int slot) @@ -30302,7 +38690,13 @@ public int fnShapeBase_getMountedImage (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getMountedImage(sbshapebase, slot); } /// -/// @brief Get the first slot the given datablock is mounted to on this object. @param image ShapeBaseImageData datablock to query @return index of the first slot the Image is mounted in, or -1 if the Image is not mounted in any slot on this object. ) +/// @brief Get the first slot the given datablock is mounted to on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return index of the first slot the Image is mounted in, or -1 if the Image +/// is not mounted in any slot on this object. ) +/// +/// /// public int fnShapeBase_getMountSlot (string shapebase, string image) @@ -30319,7 +38713,15 @@ public int fnShapeBase_getMountSlot (string shapebase, string image) return SafeNativeMethods.mwle_fnShapeBase_getMountSlot(sbshapebase, sbimage); } /// -/// @brief Get the muzzle position of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle position is the position of that node in world space. If no such node is specified, the slot's mount node is used instead. @param slot Image slot to query @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// @brief Get the muzzle position of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// position is the position of that node in world space. If no such node +/// is specified, the slot's mount node is used instead. +/// +/// @param slot Image slot to query +/// @return the muzzle position, or \"0 0 0\" if the slot is invalid ) +/// /// public string fnShapeBase_getMuzzlePoint (string shapebase, int slot) @@ -30336,7 +38738,20 @@ public string fnShapeBase_getMuzzlePoint (string shapebase, int slot) } /// -/// @brief Get the muzzle vector of the Image mounted in the specified slot. If the Image shape contains a node called 'muzzlePoint', then the muzzle vector is the forward direction vector of that node's transform in world space. If no such node is specified, the slot's mount node is used instead. If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) is set in the Image, the muzzle vector is computed to point at whatever object is right in front of the object's 'eye' node. @param slot Image slot to query @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// @brief Get the muzzle vector of the Image mounted in the specified slot. +/// +/// If the Image shape contains a node called 'muzzlePoint', then the muzzle +/// vector is the forward direction vector of that node's transform in world +/// space. If no such node is specified, the slot's mount node is used +/// instead. +/// +/// If the correctMuzzleVector flag (correctMuzzleVectorTP in 3rd person) +/// is set in the Image, the muzzle vector is computed to point at whatever +/// object is right in front of the object's 'eye' node. +/// +/// @param slot Image slot to query +/// @return the muzzle vector, or \"0 1 0\" if the slot is invalid ) +/// /// public string fnShapeBase_getMuzzleVector (string shapebase, int slot) @@ -30353,7 +38768,20 @@ public string fnShapeBase_getMuzzleVector (string shapebase, int slot) } /// -/// @brief Get the Image that will be mounted next in the specified slot. Calling mountImage when an Image is already mounted does one of two things: ol>li>Mount the new Image immediately, the old Image is discarded and whatever state it was in is ignored./li> li>If the current Image state does not allow Image changes, the new Image is marked as pending, and will not be mounted until the current state completes. eg. if the user changes weapons, you may wish to ensure that the current weapon firing state plays to completion first./li>/ol> This command retrieves the ID of the pending Image (2nd case above). @param slot Image slot to query @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// @brief Get the Image that will be mounted next in the specified slot. +/// +/// Calling mountImage when an Image is already mounted does one of two things: +/// ol>li>Mount the new Image immediately, the old Image is discarded and +/// whatever state it was in is ignored./li> +/// li>If the current Image state does not allow Image changes, the new +/// Image is marked as pending, and will not be mounted until the current +/// state completes. eg. if the user changes weapons, you may wish to ensure +/// that the current weapon firing state plays to completion first./li>/ol> +/// This command retrieves the ID of the pending Image (2nd case above). +/// +/// @param slot Image slot to query +/// @return ID of the pending ShapeBaseImageData datablock, or 0 if none. ) +/// /// public int fnShapeBase_getPendingImage (string shapebase, int slot) @@ -30367,7 +38795,12 @@ public int fnShapeBase_getPendingImage (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_getPendingImage(sbshapebase, slot); } /// -/// @brief Get the current recharge rate. @return the recharge rate (per tick) @see setRechargeRate()) +/// @brief Get the current recharge rate. +/// +/// @return the recharge rate (per tick) +/// +/// @see setRechargeRate()) +/// /// public float fnShapeBase_getRechargeRate (string shapebase) @@ -30381,7 +38814,12 @@ public float fnShapeBase_getRechargeRate (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getRechargeRate(sbshapebase); } /// -/// @brief Get the per-tick repair amount. @return the current value to be subtracted from damage level each tick @see setRepairRate ) +/// @brief Get the per-tick repair amount. +/// +/// @return the current value to be subtracted from damage level each tick +/// +/// @see setRepairRate ) +/// /// public float fnShapeBase_getRepairRate (string shapebase) @@ -30395,7 +38833,15 @@ public float fnShapeBase_getRepairRate (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getRepairRate(sbshapebase); } /// -/// @brief Get the name of the shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @return the name of the shape @see setShapeName()) +/// @brief Get the name of the shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @return the name of the shape +/// +/// @see setShapeName()) +/// /// public string fnShapeBase_getShapeName (string shapebase) @@ -30412,7 +38858,13 @@ public string fnShapeBase_getShapeName (string shapebase) } /// -/// @brief Get the name of the skin applied to this shape. @return the name of the skin @see skin @see setSkinName()) +/// @brief Get the name of the skin applied to this shape. +/// +/// @return the name of the skin +/// +/// @see skin +/// @see setSkinName()) +/// /// public string fnShapeBase_getSkinName (string shapebase) @@ -30429,7 +38881,11 @@ public string fnShapeBase_getSkinName (string shapebase) } /// -/// @brief Get the world transform of the specified mount slot. @param slot Image slot to query @return the mount transform ) +/// @brief Get the world transform of the specified mount slot. +/// +/// @param slot Image slot to query +/// @return the mount transform ) +/// /// public string fnShapeBase_getSlotTransform (string shapebase, int slot) @@ -30446,7 +38902,12 @@ public string fnShapeBase_getSlotTransform (string shapebase, int slot) } /// -/// @brief Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// @brief Get the number of materials in the shape. +/// +/// @return the number of materials in the shape. +/// +/// @see getTargetName()) +/// /// public int fnShapeBase_getTargetCount (string shapebase) @@ -30460,7 +38921,13 @@ public int fnShapeBase_getTargetCount (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getTargetCount(sbshapebase); } /// -/// @brief Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// @brief Get the name of the indexed shape material. +/// +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// +/// @see getTargetCount()) +/// /// public string fnShapeBase_getTargetName (string shapebase, int index) @@ -30477,7 +38944,10 @@ public string fnShapeBase_getTargetName (string shapebase, int index) } /// -/// @brief Get the object's current velocity. @return the current velocity ) +/// @brief Get the object's current velocity. +/// +/// @return the current velocity ) +/// /// public string fnShapeBase_getVelocity (string shapebase) @@ -30494,7 +38964,12 @@ public string fnShapeBase_getVelocity (string shapebase) } /// -/// @brief Get the white-out level. @return white-out level @see setWhiteOut ) +/// @brief Get the white-out level. +/// +/// @return white-out level +/// +/// @see setWhiteOut ) +/// /// public float fnShapeBase_getWhiteOut (string shapebase) @@ -30508,7 +38983,12 @@ public float fnShapeBase_getWhiteOut (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_getWhiteOut(sbshapebase); } /// -/// @brief Check if the given state exists on the mounted Image. @param slot Image slot to query @param state Image state to check for @return true if the Image has the requested state defined. ) +/// @brief Check if the given state exists on the mounted Image. +/// +/// @param slot Image slot to query +/// @param state Image state to check for +/// @return true if the Image has the requested state defined. ) +/// /// public bool fnShapeBase_hasImageState (string shapebase, int slot, string state) @@ -30525,7 +39005,12 @@ public bool fnShapeBase_hasImageState (string shapebase, int slot, string state) return SafeNativeMethods.mwle_fnShapeBase_hasImageState(sbshapebase, slot, sbstate)>=1; } /// -/// @brief Check if this object is cloaked. @return true if cloaked, false if not @see setCloaked()) +/// @brief Check if this object is cloaked. +/// +/// @return true if cloaked, false if not +/// +/// @see setCloaked()) +/// /// public bool fnShapeBase_isCloaked (string shapebase) @@ -30539,7 +39024,13 @@ public bool fnShapeBase_isCloaked (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isCloaked(sbshapebase)>=1; } /// -/// @brief Check if the object is in the Destroyed damage state. @return true if damage state is \"Destroyed\", false if not @see isDisabled() @see isEnabled()) +/// @brief Check if the object is in the Destroyed damage state. +/// +/// @return true if damage state is \"Destroyed\", false if not +/// +/// @see isDisabled() +/// @see isEnabled()) +/// /// public bool fnShapeBase_isDestroyed (string shapebase) @@ -30553,7 +39044,13 @@ public bool fnShapeBase_isDestroyed (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isDestroyed(sbshapebase)>=1; } /// -/// @brief Check if the object is in the Disabled or Destroyed damage state. @return true if damage state is not \"Enabled\", false if it is @see isDestroyed() @see isEnabled()) +/// @brief Check if the object is in the Disabled or Destroyed damage state. +/// +/// @return true if damage state is not \"Enabled\", false if it is +/// +/// @see isDestroyed() +/// @see isEnabled()) +/// /// public bool fnShapeBase_isDisabled (string shapebase) @@ -30567,7 +39064,13 @@ public bool fnShapeBase_isDisabled (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isDisabled(sbshapebase)>=1; } /// -/// @brief Check if the object is in the Enabled damage state. @return true if damage state is \"Enabled\", false if not @see isDestroyed() @see isDisabled()) +/// @brief Check if the object is in the Enabled damage state. +/// +/// @return true if damage state is \"Enabled\", false if not +/// +/// @see isDestroyed() +/// @see isDisabled()) +/// /// public bool fnShapeBase_isEnabled (string shapebase) @@ -30581,7 +39084,9 @@ public bool fnShapeBase_isEnabled (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isEnabled(sbshapebase)>=1; } /// -/// Check if the object is hidden. @return true if the object is hidden, false if visible. ) +/// Check if the object is hidden. +/// @return true if the object is hidden, false if visible. ) +/// /// public bool fnShapeBase_isHidden (string shapebase) @@ -30595,7 +39100,11 @@ public bool fnShapeBase_isHidden (string shapebase) return SafeNativeMethods.mwle_fnShapeBase_isHidden(sbshapebase)>=1; } /// -/// @brief Check if the current Image state is firing. @param slot Image slot to query @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// @brief Check if the current Image state is firing. +/// +/// @param slot Image slot to query +/// @return true if the current Image state in this slot has the 'stateFire' flag set. ) +/// /// public bool fnShapeBase_isImageFiring (string shapebase, int slot) @@ -30609,7 +39118,11 @@ public bool fnShapeBase_isImageFiring (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_isImageFiring(sbshapebase, slot)>=1; } /// -/// @brief Check if the given datablock is mounted to any slot on this object. @param image ShapeBaseImageData datablock to query @return true if the Image is mounted to any slot, false otherwise. ) +/// @brief Check if the given datablock is mounted to any slot on this object. +/// +/// @param image ShapeBaseImageData datablock to query +/// @return true if the Image is mounted to any slot, false otherwise. ) +/// /// public bool fnShapeBase_isImageMounted (string shapebase, string image) @@ -30626,7 +39139,26 @@ public bool fnShapeBase_isImageMounted (string shapebase, string image) return SafeNativeMethods.mwle_fnShapeBase_isImageMounted(sbshapebase, sbimage)>=1; } /// -/// ), @brief Mount a new Image. @param image the Image to mount @param slot Image slot to mount into (valid range is 0 - 3) @param loaded initial loaded state for the Image @param skinTag tagged string to reskin the mounted Image @return true if successful, false if failed @tsexample %player.mountImage( PistolImage, 1 ); %player.mountImage( CrossbowImage, 0, false ); %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); @endtsexample @see unmountImage() @see getMountedImage() @see getPendingImage() @see isImageMounted()) +/// ), +/// @brief Mount a new Image. +/// +/// @param image the Image to mount +/// @param slot Image slot to mount into (valid range is 0 - 3) +/// @param loaded initial loaded state for the Image +/// @param skinTag tagged string to reskin the mounted Image +/// @return true if successful, false if failed +/// +/// @tsexample +/// %player.mountImage( PistolImage, 1 ); +/// %player.mountImage( CrossbowImage, 0, false ); +/// %player.mountImage( RocketLauncherImage, 0, true, 'blue' ); +/// @endtsexample +/// +/// @see unmountImage() +/// @see getMountedImage() +/// @see getPendingImage() +/// @see isImageMounted()) +/// /// public bool fnShapeBase_mountImage (string shapebase, string image, int slot, bool loaded, string skinTag) @@ -30646,7 +39178,15 @@ public bool fnShapeBase_mountImage (string shapebase, string image, int slot, bo return SafeNativeMethods.mwle_fnShapeBase_mountImage(sbshapebase, sbimage, slot, loaded, sbskinTag)>=1; } /// -/// @brief Pause an animation thread. If restarted using playThread, the animation will resume from the paused position. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Pause an animation thread. +/// +/// If restarted using playThread, the animation +/// will resume from the paused position. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_pauseThread (string shapebase, int slot) @@ -30660,7 +39200,13 @@ public bool fnShapeBase_pauseThread (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_pauseThread(sbshapebase, slot)>=1; } /// -/// @brief Attach a sound to this shape and start playing it. @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play @return true if the sound was attached successfully, false if failed @see stopAudio()) +/// @brief Attach a sound to this shape and start playing it. +/// +/// @param slot Audio slot index for the sound (valid range is 0 - 3) @param track SFXTrack to play +/// @return true if the sound was attached successfully, false if failed +/// +/// @see stopAudio()) +/// /// public bool fnShapeBase_playAudio (string shapebase, int slot, string track) @@ -30677,7 +39223,28 @@ public bool fnShapeBase_playAudio (string shapebase, int slot, string track) return SafeNativeMethods.mwle_fnShapeBase_playAudio(sbshapebase, slot, sbtrack)>=1; } /// -/// ), @brief Start a new animation thread, or restart one that has been paused or stopped. @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not specified, the paused or stopped thread in this slot will be resumed. @return true if successful, false if failed @tsexample %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed %obj.pauseThread( 0 ); // Pause the sequence %obj.playThread( 0 ); // Resume playback %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 @endtsexample @see pauseThread() @see stopThread() @see setThreadDir() @see setThreadTimeScale() @see destroyThread()) +/// ), +/// @brief Start a new animation thread, or restart one that has been paused or +/// stopped. +/// +/// @param slot thread slot to play. Valid range is 0 - 3) @param name name of the animation sequence to play in this slot. If not +/// specified, the paused or stopped thread in this slot will be resumed. +/// @return true if successful, false if failed +/// +/// @tsexample +/// %obj.playThread( 0, \"ambient\" ); // Play the ambient sequence in slot 0 +/// %obj.setThreadTimeScale( 0, 0.5 ); // Play at half-speed +/// %obj.pauseThread( 0 ); // Pause the sequence +/// %obj.playThread( 0 ); // Resume playback +/// %obj.playThread( 0, \"spin\" ); // Replace the sequence in slot 0 +/// @endtsexample +/// +/// @see pauseThread() +/// @see stopThread() +/// @see setThreadDir() +/// @see setThreadTimeScale() +/// @see destroyThread()) +/// /// public bool fnShapeBase_playThread (string shapebase, int slot, string name) @@ -30694,7 +39261,13 @@ public bool fnShapeBase_playThread (string shapebase, int slot, string name) return SafeNativeMethods.mwle_fnShapeBase_playThread(sbshapebase, slot, sbname)>=1; } /// -/// @brief Set the hidden state on all the shape meshes. This allows you to hide all meshes in the shape, for example, and then only enable a few. @param hide new hidden state for all meshes ) +/// @brief Set the hidden state on all the shape meshes. +/// +/// This allows you to hide all meshes in the shape, for example, and then only +/// enable a few. +/// +/// @param hide new hidden state for all meshes ) +/// /// public void fnShapeBase_setAllMeshesHidden (string shapebase, bool hide) @@ -30708,7 +39281,10 @@ public void fnShapeBase_setAllMeshesHidden (string shapebase, bool hide) SafeNativeMethods.mwle_fnShapeBase_setAllMeshesHidden(sbshapebase, hide); } /// -/// @brief Set the vertical field of view in degrees for this object if used as a camera. @param fov new FOV value ) +/// @brief Set the vertical field of view in degrees for this object if used as a camera. +/// +/// @param fov new FOV value ) +/// /// public void fnShapeBase_setCameraFov (string shapebase, float fov) @@ -30722,7 +39298,14 @@ public void fnShapeBase_setCameraFov (string shapebase, float fov) SafeNativeMethods.mwle_fnShapeBase_setCameraFov(sbshapebase, fov); } /// -/// @brief Set the cloaked state of this object. When an object is cloaked it is not rendered. @param cloak true to cloak the object, false to uncloak @see isCloaked()) +/// @brief Set the cloaked state of this object. +/// +/// When an object is cloaked it is not rendered. +/// +/// @param cloak true to cloak the object, false to uncloak +/// +/// @see isCloaked()) +/// /// public void fnShapeBase_setCloaked (string shapebase, bool cloak) @@ -30736,7 +39319,17 @@ public void fnShapeBase_setCloaked (string shapebase, bool cloak) SafeNativeMethods.mwle_fnShapeBase_setCloaked(sbshapebase, cloak); } /// -/// @brief Set the damage flash level. Damage flash may be used as a postfx effect to flash the screen when the client is damaged. @note Relies on the flash postFx. @param level flash level (0-1) @see getDamageFlash()) +/// @brief Set the damage flash level. +/// +/// Damage flash may be used as a postfx effect to flash the screen when the +/// client is damaged. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getDamageFlash()) +/// /// public void fnShapeBase_setDamageFlash (string shapebase, float level) @@ -30750,7 +39343,13 @@ public void fnShapeBase_setDamageFlash (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setDamageFlash(sbshapebase, level); } /// -/// @brief Set the object's current damage level. @param level new damage level @see getDamageLevel() @see getDamagePercent()) +/// @brief Set the object's current damage level. +/// +/// @param level new damage level +/// +/// @see getDamageLevel() +/// @see getDamagePercent()) +/// /// public void fnShapeBase_setDamageLevel (string shapebase, float level) @@ -30764,7 +39363,13 @@ public void fnShapeBase_setDamageLevel (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setDamageLevel(sbshapebase, level); } /// -/// @brief Set the object's damage state. @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" @return true if successful, false if failed @see getDamageState()) +/// @brief Set the object's damage state. +/// +/// @param state should be one of \"Enabled\", \"Disabled\", \"Destroyed\" +/// @return true if successful, false if failed +/// +/// @see getDamageState()) +/// /// public bool fnShapeBase_setDamageState (string shapebase, string state) @@ -30781,7 +39386,17 @@ public bool fnShapeBase_setDamageState (string shapebase, string state) return SafeNativeMethods.mwle_fnShapeBase_setDamageState(sbshapebase, sbstate)>=1; } /// -/// @brief Set the damage direction vector. Currently this is only used to initialise the explosion if this object is blown up. @param vec damage direction vector @tsexample %obj.setDamageVector( \"0 0 1\" ); @endtsexample ) +/// @brief Set the damage direction vector. +/// +/// Currently this is only used to initialise the explosion if this object +/// is blown up. +/// +/// @param vec damage direction vector +/// +/// @tsexample +/// %obj.setDamageVector( \"0 0 1\" ); +/// @endtsexample ) +/// /// public void fnShapeBase_setDamageVector (string shapebase, string vec) @@ -30798,7 +39413,13 @@ public void fnShapeBase_setDamageVector (string shapebase, string vec) SafeNativeMethods.mwle_fnShapeBase_setDamageVector(sbshapebase, sbvec); } /// -/// @brief Set this object's current energy level. @param level new energy level @see getEnergyLevel() @see getEnergyPercent()) +/// @brief Set this object's current energy level. +/// +/// @param level new energy level +/// +/// @see getEnergyLevel() +/// @see getEnergyPercent()) +/// /// public void fnShapeBase_setEnergyLevel (string shapebase, float level) @@ -30812,7 +39433,10 @@ public void fnShapeBase_setEnergyLevel (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setEnergyLevel(sbshapebase, level); } /// -/// @brief Add or remove this object from the scene. When removed from the scene, the object will not be processed or rendered. @param show False to hide the object, true to re-show it ) +/// @brief Add or remove this object from the scene. +/// When removed from the scene, the object will not be processed or rendered. +/// @param show False to hide the object, true to re-show it ) +/// /// public void fnShapeBase_setHidden (string shapebase, bool show) @@ -30826,7 +39450,12 @@ public void fnShapeBase_setHidden (string shapebase, bool show) SafeNativeMethods.mwle_fnShapeBase_setHidden(sbshapebase, show); } /// -/// @brief Set the alt trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new alt trigger state for the Image @return the Image's new alt trigger state ) +/// @brief Set the alt trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new alt trigger state for the Image +/// @return the Image's new alt trigger state ) +/// /// public bool fnShapeBase_setImageAltTrigger (string shapebase, int slot, bool state) @@ -30840,7 +39469,12 @@ public bool fnShapeBase_setImageAltTrigger (string shapebase, int slot, bool sta return SafeNativeMethods.mwle_fnShapeBase_setImageAltTrigger(sbshapebase, slot, state)>=1; } /// -/// @brief Set the ammo state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new ammo state for the Image @return the Image's new ammo state ) +/// @brief Set the ammo state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new ammo state for the Image +/// @return the Image's new ammo state ) +/// /// public bool fnShapeBase_setImageAmmo (string shapebase, int slot, bool state) @@ -30854,7 +39488,13 @@ public bool fnShapeBase_setImageAmmo (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageAmmo(sbshapebase, slot, state)>=1; } /// -/// @brief Set the generic trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param trigger Generic trigger number @param state new generic trigger state for the Image @return the Image's new generic trigger state or -1 if there was a problem. ) +/// @brief Set the generic trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param trigger Generic trigger number +/// @param state new generic trigger state for the Image +/// @return the Image's new generic trigger state or -1 if there was a problem. ) +/// /// public int fnShapeBase_setImageGenericTrigger (string shapebase, int slot, int trigger, bool state) @@ -30868,7 +39508,12 @@ public int fnShapeBase_setImageGenericTrigger (string shapebase, int slot, int t return SafeNativeMethods.mwle_fnShapeBase_setImageGenericTrigger(sbshapebase, slot, trigger, state); } /// -/// @brief Set the loaded state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new loaded state for the Image @return the Image's new loaded state ) +/// @brief Set the loaded state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new loaded state for the Image +/// @return the Image's new loaded state ) +/// /// public bool fnShapeBase_setImageLoaded (string shapebase, int slot, bool state) @@ -30882,7 +39527,13 @@ public bool fnShapeBase_setImageLoaded (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageLoaded(sbshapebase, slot, state)>=1; } /// -/// @brief Set the script animation prefix for the Image mounted in the specified slot. This is used to further modify the prefix used when deciding which animation sequence to play while this image is mounted. @param slot Image slot to modify @param prefix The prefix applied to the image ) +/// @brief Set the script animation prefix for the Image mounted in the specified slot. +/// This is used to further modify the prefix used when deciding which animation sequence to +/// play while this image is mounted. +/// +/// @param slot Image slot to modify +/// @param prefix The prefix applied to the image ) +/// /// public void fnShapeBase_setImageScriptAnimPrefix (string shapebase, int slot, string prefix) @@ -30899,7 +39550,12 @@ public void fnShapeBase_setImageScriptAnimPrefix (string shapebase, int slot, st SafeNativeMethods.mwle_fnShapeBase_setImageScriptAnimPrefix(sbshapebase, slot, sbprefix); } /// -/// @brief Set the target state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new target state for the Image @return the Image's new target state ) +/// @brief Set the target state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new target state for the Image +/// @return the Image's new target state ) +/// /// public bool fnShapeBase_setImageTarget (string shapebase, int slot, bool state) @@ -30913,7 +39569,12 @@ public bool fnShapeBase_setImageTarget (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageTarget(sbshapebase, slot, state)>=1; } /// -/// @brief Set the trigger state of the Image mounted in the specified slot. @param slot Image slot to modify @param state new trigger state for the Image @return the Image's new trigger state ) +/// @brief Set the trigger state of the Image mounted in the specified slot. +/// +/// @param slot Image slot to modify +/// @param state new trigger state for the Image +/// @return the Image's new trigger state ) +/// /// public bool fnShapeBase_setImageTrigger (string shapebase, int slot, bool state) @@ -30927,21 +39588,11 @@ public bool fnShapeBase_setImageTrigger (string shapebase, int slot, bool state) return SafeNativeMethods.mwle_fnShapeBase_setImageTrigger(sbshapebase, slot, state)>=1; } /// -/// @brief Setup the invincible effect. This effect is used for HUD feedback to the user that they are invincible. @note Currently not implemented @param time duration in seconds for the invincible effect @param speed speed at which the invincible effect progresses ) -/// - -public void fnShapeBase_setInvincibleMode (string shapebase, float time, float speed) -{ -if(Debugging) -System.Console.WriteLine("----------------->Extern Call 'fnShapeBase_setInvincibleMode'" + string.Format("\"{0}\" \"{1}\" \"{2}\" ",shapebase,time,speed)); -StringBuilder sbshapebase = null; -if (shapebase != null) - sbshapebase = new StringBuilder(shapebase, 1024); - -SafeNativeMethods.mwle_fnShapeBase_setInvincibleMode(sbshapebase, time, speed); -} -/// -/// @brief Set the hidden state on the named shape mesh. @param name name of the mesh to hide/show @param hide new hidden state for the mesh ) +/// @brief Set the hidden state on the named shape mesh. +/// +/// @param name name of the mesh to hide/show +/// @param hide new hidden state for the mesh ) +/// /// public void fnShapeBase_setMeshHidden (string shapebase, string name, bool hide) @@ -30958,7 +39609,15 @@ public void fnShapeBase_setMeshHidden (string shapebase, string name, bool hide) SafeNativeMethods.mwle_fnShapeBase_setMeshHidden(sbshapebase, sbname, hide); } /// -/// @brief Set the recharge rate. The recharge rate is added to the object's current energy level each tick, up to the maxEnergy level set in the ShapeBaseData datablock. @param rate the recharge rate (per tick) @see getRechargeRate()) +/// @brief Set the recharge rate. +/// +/// The recharge rate is added to the object's current energy level each tick, +/// up to the maxEnergy level set in the ShapeBaseData datablock. +/// +/// @param rate the recharge rate (per tick) +/// +/// @see getRechargeRate()) +/// /// public void fnShapeBase_setRechargeRate (string shapebase, float rate) @@ -30972,7 +39631,17 @@ public void fnShapeBase_setRechargeRate (string shapebase, float rate) SafeNativeMethods.mwle_fnShapeBase_setRechargeRate(sbshapebase, rate); } /// -/// @brief Set amount to repair damage by each tick. Note that this value is separate to the repairRate field in ShapeBaseData. This value will be subtracted from the damage level each tick, whereas the ShapeBaseData field limits how much of the applyRepair value is subtracted each tick. Both repair types can be active at the same time. @param rate value to subtract from damage level each tick (must be > 0) @see getRepairRate()) +/// @brief Set amount to repair damage by each tick. +/// +/// Note that this value is separate to the repairRate field in ShapeBaseData. +/// This value will be subtracted from the damage level each tick, whereas the +/// ShapeBaseData field limits how much of the applyRepair value is subtracted +/// each tick. Both repair types can be active at the same time. +/// +/// @param rate value to subtract from damage level each tick (must be > 0) +/// +/// @see getRepairRate()) +/// /// public void fnShapeBase_setRepairRate (string shapebase, float rate) @@ -30986,7 +39655,15 @@ public void fnShapeBase_setRepairRate (string shapebase, float rate) SafeNativeMethods.mwle_fnShapeBase_setRepairRate(sbshapebase, rate); } /// -/// @brief Set the name of this shape. @note This is the name of the shape object that is sent to the client, not the DTS or DAE model filename. @param name new name for the shape @see getShapeName()) +/// @brief Set the name of this shape. +/// +/// @note This is the name of the shape object that is sent to the client, +/// not the DTS or DAE model filename. +/// +/// @param name new name for the shape +/// +/// @see getShapeName()) +/// /// public void fnShapeBase_setShapeName (string shapebase, string name) @@ -31003,7 +39680,16 @@ public void fnShapeBase_setShapeName (string shapebase, string name) SafeNativeMethods.mwle_fnShapeBase_setShapeName(sbshapebase, sbname); } /// -/// @brief Apply a new skin to this shape. 'Skinning' the shape effectively renames the material targets, allowing different materials to be used on different instances of the same model. @param name name of the skin to apply @see skin @see getSkinName()) +/// @brief Apply a new skin to this shape. +/// +/// 'Skinning' the shape effectively renames the material targets, allowing +/// different materials to be used on different instances of the same model. +/// +/// @param name name of the skin to apply +/// +/// @see skin +/// @see getSkinName()) +/// /// public void fnShapeBase_setSkinName (string shapebase, string name) @@ -31020,7 +39706,14 @@ public void fnShapeBase_setSkinName (string shapebase, string name) SafeNativeMethods.mwle_fnShapeBase_setSkinName(sbshapebase, sbname); } /// -/// @brief Set the playback direction of an animation thread. @param slot thread slot to modify @param fwd true to play the animation forwards, false to play backwards @return true if successful, false if failed @see playThread() ) +/// @brief Set the playback direction of an animation thread. +/// +/// @param slot thread slot to modify +/// @param fwd true to play the animation forwards, false to play backwards +/// @return true if successful, false if failed +/// +/// @see playThread() ) +/// /// public bool fnShapeBase_setThreadDir (string shapebase, int slot, bool fwd) @@ -31034,7 +39727,14 @@ public bool fnShapeBase_setThreadDir (string shapebase, int slot, bool fwd) return SafeNativeMethods.mwle_fnShapeBase_setThreadDir(sbshapebase, slot, fwd)>=1; } /// -/// @brief Set the position within an animation thread. @param slot thread slot to modify @param pos position within thread @return true if successful, false if failed @see playThread ) +/// @brief Set the position within an animation thread. +/// +/// @param slot thread slot to modify +/// @param pos position within thread +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_setThreadPosition (string shapebase, int slot, float pos) @@ -31048,7 +39748,14 @@ public bool fnShapeBase_setThreadPosition (string shapebase, int slot, float pos return SafeNativeMethods.mwle_fnShapeBase_setThreadPosition(sbshapebase, slot, pos)>=1; } /// -/// @brief Set the playback time scale of an animation thread. @param slot thread slot to modify @param scale new thread time scale (1=normal speed, 0.5=half speed etc) @return true if successful, false if failed @see playThread ) +/// @brief Set the playback time scale of an animation thread. +/// +/// @param slot thread slot to modify +/// @param scale new thread time scale (1=normal speed, 0.5=half speed etc) +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_setThreadTimeScale (string shapebase, int slot, float scale) @@ -31062,7 +39769,11 @@ public bool fnShapeBase_setThreadTimeScale (string shapebase, int slot, float sc return SafeNativeMethods.mwle_fnShapeBase_setThreadTimeScale(sbshapebase, slot, scale)>=1; } /// -/// @brief Set the object's velocity. @param vel new velocity for the object @return true ) +/// @brief Set the object's velocity. +/// +/// @param vel new velocity for the object +/// @return true ) +/// /// public bool fnShapeBase_setVelocity (string shapebase, string vel) @@ -31079,7 +39790,17 @@ public bool fnShapeBase_setVelocity (string shapebase, string vel) return SafeNativeMethods.mwle_fnShapeBase_setVelocity(sbshapebase, sbvel)>=1; } /// -/// @brief Set the white-out level. White-out may be used as a postfx effect to brighten the screen in response to a game event. @note Relies on the flash postFx. @param level flash level (0-1) @see getWhiteOut()) +/// @brief Set the white-out level. +/// +/// White-out may be used as a postfx effect to brighten the screen in response +/// to a game event. +/// +/// @note Relies on the flash postFx. +/// +/// @param level flash level (0-1) +/// +/// @see getWhiteOut()) +/// /// public void fnShapeBase_setWhiteOut (string shapebase, float level) @@ -31093,7 +39814,21 @@ public void fnShapeBase_setWhiteOut (string shapebase, float level) SafeNativeMethods.mwle_fnShapeBase_setWhiteOut(sbshapebase, level); } /// -/// @brief Fade the object in or out without removing it from the scene. A faded out object is still in the scene and can still be collided with, so if you want to disable collisions for this shape after it fades out use setHidden to temporarily remove this shape from the scene. @note Items have the ability to light their surroundings. When an Item with an active light is fading out, the light it emits is correspondingly reduced until it goes out. Likewise, when the item fades in, the light is turned-up till it reaches it's normal brightntess. @param time duration of the fade effect in ms @param delay delay in ms before the fade effect begins @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// @brief Fade the object in or out without removing it from the scene. +/// +/// A faded out object is still in the scene and can still be collided with, +/// so if you want to disable collisions for this shape after it fades out +/// use setHidden to temporarily remove this shape from the scene. +/// +/// @note Items have the ability to light their surroundings. When an Item with +/// an active light is fading out, the light it emits is correspondingly +/// reduced until it goes out. Likewise, when the item fades in, the light is +/// turned-up till it reaches it's normal brightntess. +/// +/// @param time duration of the fade effect in ms +/// @param delay delay in ms before the fade effect begins +/// @param fadeOut true to fade-out to invisible, false to fade-in to full visibility ) +/// /// public void fnShapeBase_startFade (string shapebase, int time, int delay, bool fadeOut) @@ -31107,7 +39842,13 @@ public void fnShapeBase_startFade (string shapebase, int time, int delay, bool f SafeNativeMethods.mwle_fnShapeBase_startFade(sbshapebase, time, delay, fadeOut); } /// -/// @brief Stop a sound started with playAudio. @param slot audio slot index (started with playAudio) @return true if the sound was stopped successfully, false if failed @see playAudio()) +/// @brief Stop a sound started with playAudio. +/// +/// @param slot audio slot index (started with playAudio) +/// @return true if the sound was stopped successfully, false if failed +/// +/// @see playAudio()) +/// /// public bool fnShapeBase_stopAudio (string shapebase, int slot) @@ -31121,7 +39862,15 @@ public bool fnShapeBase_stopAudio (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_stopAudio(sbshapebase, slot)>=1; } /// -/// @brief Stop an animation thread. If restarted using playThread, the animation will start from the beginning again. @param slot thread slot to stop @return true if successful, false if failed @see playThread ) +/// @brief Stop an animation thread. +/// +/// If restarted using playThread, the animation +/// will start from the beginning again. +/// @param slot thread slot to stop +/// @return true if successful, false if failed +/// +/// @see playThread ) +/// /// public bool fnShapeBase_stopThread (string shapebase, int slot) @@ -31135,7 +39884,13 @@ public bool fnShapeBase_stopThread (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_stopThread(sbshapebase, slot)>=1; } /// -/// @brief Unmount the mounted Image in the specified slot. @param slot Image slot to unmount @return true if successful, false if failed @see mountImage()) +/// @brief Unmount the mounted Image in the specified slot. +/// +/// @param slot Image slot to unmount +/// @return true if successful, false if failed +/// +/// @see mountImage()) +/// /// public bool fnShapeBase_unmountImage (string shapebase, int slot) @@ -31149,7 +39904,17 @@ public bool fnShapeBase_unmountImage (string shapebase, int slot) return SafeNativeMethods.mwle_fnShapeBase_unmountImage(sbshapebase, slot)>=1; } /// -/// @brief Check if there is the space at the given transform is free to spawn into. The shape's bounding box volume is used to check for collisions at the given world transform. Only interior and static objects are checked for collision. @param txfm Deploy transform to check @return True if the space is free, false if there is already something in the way. @note This is a server side only check, and is not actually limited to spawning.) +/// @brief Check if there is the space at the given transform is free to spawn into. +/// +/// The shape's bounding box volume is used to check for collisions at the given world +/// transform. Only interior and static objects are checked for collision. +/// +/// @param txfm Deploy transform to check +/// @return True if the space is free, false if there is already something in +/// the way. +/// +/// @note This is a server side only check, and is not actually limited to spawning.) +/// /// public bool fnShapeBaseData_checkDeployPos (string shapebasedata, string txfm) @@ -31166,7 +39931,11 @@ public bool fnShapeBaseData_checkDeployPos (string shapebasedata, string txfm) return SafeNativeMethods.mwle_fnShapeBaseData_checkDeployPos(sbshapebasedata, sbtxfm)>=1; } /// -/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). @param pos Desired transform position @param normal Vector of desired direction @return The deploy transform ) +/// @brief Helper method to get a transform from a position and vector (suitable for use with setTransform). +/// @param pos Desired transform position +/// @param normal Vector of desired direction +/// @return The deploy transform ) +/// /// public string fnShapeBaseData_getDeployTransform (string shapebasedata, string pos, string normal) @@ -31189,7 +39958,11 @@ public string fnShapeBaseData_getDeployTransform (string shapebasedata, string p } /// -/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); Adds additional components to current list. @param Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, addComponents, bool, 3, 64, %obj.addComponents( %compObjName, %compObjName2, ... ); +/// Adds additional components to current list. +/// @param Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool fnSimComponent_addComponents (string simcomponent, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21, string a22, string a23, string a24, string a25, string a26, string a27, string a28, string a29, string a30, string a31, string a32, string a33, string a34, string a35, string a36, string a37, string a38, string a39, string a40, string a41, string a42, string a43, string a44, string a45, string a46, string a47, string a48, string a49, string a50, string a51, string a52, string a53, string a54, string a55, string a56, string a57, string a58, string a59, string a60, string a61, string a62, string a63) @@ -31389,7 +40162,11 @@ public bool fnSimComponent_addComponents (string simcomponent, string a2, string return SafeNativeMethods.mwle_fnSimComponent_addComponents(sbsimcomponent, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19, sba20, sba21, sba22, sba23, sba24, sba25, sba26, sba27, sba28, sba29, sba30, sba31, sba32, sba33, sba34, sba35, sba36, sba37, sba38, sba39, sba40, sba41, sba42, sba43, sba44, sba45, sba46, sba47, sba48, sba49, sba50, sba51, sba52, sba53, sba54, sba55, sba56, sba57, sba58, sba59, sba60, sba61, sba62, sba63)>=1; } /// -/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); Removes components by name from current list. @param objNamex Up to 62 component names @return Returns true on success, false otherwise.) +/// ( SimComponent, removeComponents, bool, 3, 64, %obj.removeComponents( %compObjName, %compObjName2, ... ); +/// Removes components by name from current list. +/// @param objNamex Up to 62 component names +/// @return Returns true on success, false otherwise.) +/// /// public bool fnSimComponent_removeComponents (string simcomponent, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19, string a20, string a21, string a22, string a23, string a24, string a25, string a26, string a27, string a28, string a29, string a30, string a31, string a32, string a33, string a34, string a35, string a36, string a37, string a38, string a39, string a40, string a41, string a42, string a43, string a44, string a45, string a46, string a47, string a48, string a49, string a50, string a51, string a52, string a53, string a54, string a55, string a56, string a57, string a58, string a59, string a60, string a61, string a62, string a63) @@ -32155,7 +40932,32 @@ public void fnSimObject_signal (string simobject, string a2, string a3) SafeNativeMethods.mwle_fnSimObject_signal(sbsimobject, sba2, sba3); } /// -/// @brief Sets the internal message variable. SimpleNetObject is set up to automatically transmit this new message to all connected clients. It will appear in the clients' console. @param msg The new message to send @tsexample // On the server, create a new SimpleNetObject. This is a ghost always // object so it will be immediately ghosted to all connected clients. $s = new SimpleNetObject(); // All connected clients will see the following in their console: // // Got message: Hello World! // Now again on the server, change the message. This will cause it to // be sent to all connected clients. $s.setMessage(\"A new message from me!\"); // All connected clients will now see in their console: // // Go message: A new message from me! @endtsexample ) +/// @brief Sets the internal message variable. +/// +/// SimpleNetObject is set up to automatically transmit this new message to +/// all connected clients. It will appear in the clients' console. +/// +/// @param msg The new message to send +/// +/// @tsexample +/// // On the server, create a new SimpleNetObject. This is a ghost always +/// // object so it will be immediately ghosted to all connected clients. +/// $s = new SimpleNetObject(); +/// +/// // All connected clients will see the following in their console: +/// // +/// // Got message: Hello World! +/// +/// // Now again on the server, change the message. This will cause it to +/// // be sent to all connected clients. +/// $s.setMessage(\"A new message from me!\"); +/// +/// // All connected clients will now see in their console: +/// // +/// // Go message: A new message from me! +/// @endtsexample +/// ) +/// /// public void fnSimpleNetObject_setMessage (string simplenetobject, string msg) @@ -32172,7 +40974,10 @@ public void fnSimpleNetObject_setMessage (string simplenetobject, string msg) SafeNativeMethods.mwle_fnSimpleNetObject_setMessage(sbsimplenetobject, sbmsg); } /// -/// Test whether the given object may be added to the set. @param obj The object to test for potential membership. @return True if the object may be added to the set, false otherwise. ) +/// Test whether the given object may be added to the set. +/// @param obj The object to test for potential membership. +/// @return True if the object may be added to the set, false otherwise. ) +/// /// public bool fnSimSet_acceptsAsChild (string simset, string obj) @@ -32189,7 +40994,10 @@ public bool fnSimSet_acceptsAsChild (string simset, string obj) return SafeNativeMethods.mwle_fnSimSet_acceptsAsChild(sbsimset, sbobj)>=1; } /// -/// ( SimSet, add, void, 3, 0, ( SimObject objects... ) Add the given objects to the set. @param objects The objects to add to the set. ) +/// ( SimSet, add, void, 3, 0, +/// ( SimObject objects... ) Add the given objects to the set. +/// @param objects The objects to add to the set. ) +/// /// public void fnSimSet_add (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32257,7 +41065,9 @@ public void fnSimSet_add (string simset, string a2, string a3, string a4, string SafeNativeMethods.mwle_fnSimSet_add(sbsimset, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// Make the given object the first object in the set. @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// Make the given object the first object in the set. +/// @param obj The object to bring to the frontmost position. Must be contained in the set. ) +/// /// public void fnSimSet_bringToFront (string simset, string obj) @@ -32274,7 +41084,13 @@ public void fnSimSet_bringToFront (string simset, string obj) SafeNativeMethods.mwle_fnSimSet_bringToFront(sbsimset, sbobj); } /// -/// ( SimSet, callOnChildren, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method recurses into all SimSets that are children to the set. @see callOnChildrenNoRecurse ) +/// ( SimSet, callOnChildren, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method recurses into all SimSets that are children to the set. +/// @see callOnChildrenNoRecurse ) +/// /// public void fnSimSet_callOnChildren (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32342,7 +41158,13 @@ public void fnSimSet_callOnChildren (string simset, string a2, string a3, string SafeNativeMethods.mwle_fnSimSet_callOnChildren(sbsimset, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, ( string method, string args... ) Call a method on all objects contained in the set. @param method The name of the method to call. @param args The arguments to the method. @note This method does not recurse into child SimSets. @see callOnChildren ) +/// ( SimSet, callOnChildrenNoRecurse, void, 3, 0, +/// ( string method, string args... ) Call a method on all objects contained in the set. +/// @param method The name of the method to call. +/// @param args The arguments to the method. +/// @note This method does not recurse into child SimSets. +/// @see callOnChildren ) +/// /// public void fnSimSet_callOnChildrenNoRecurse (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32411,6 +41233,7 @@ public void fnSimSet_callOnChildrenNoRecurse (string simset, string a2, string a } /// /// Remove all objects from the set. ) +/// /// public void fnSimSet_clear (string simset) @@ -32424,7 +41247,11 @@ public void fnSimSet_clear (string simset) SafeNativeMethods.mwle_fnSimSet_clear(sbsimset); } /// -/// Find an object in the set by its internal name. @param internalName The internal name of the object to look for. @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. @return The object with the given internal name or 0 if no match was found. ) +/// Find an object in the set by its internal name. +/// @param internalName The internal name of the object to look for. +/// @param searchChildren If true, SimSets contained in the set will be recursively searched for the object. +/// @return The object with the given internal name or 0 if no match was found. ) +/// /// public string fnSimSet_findObjectByInternalName (string simset, string internalName, bool searchChildren) @@ -32444,7 +41271,9 @@ public string fnSimSet_findObjectByInternalName (string simset, string internalN } /// -/// Get the number of objects contained in the set. @return The number of objects contained in the set. ) +/// Get the number of objects contained in the set. +/// @return The number of objects contained in the set. ) +/// /// public int fnSimSet_getCount (string simset) @@ -32458,7 +41287,10 @@ public int fnSimSet_getCount (string simset) return SafeNativeMethods.mwle_fnSimSet_getCount(sbsimset); } /// -/// Get the object at the given index. @param index The object index. @return The object at the given index or -1 if index is out of range. ) +/// Get the object at the given index. +/// @param index The object index. +/// @return The object at the given index or -1 if index is out of range. ) +/// /// public string fnSimSet_getObject (string simset, uint index) @@ -32475,7 +41307,10 @@ public string fnSimSet_getObject (string simset, uint index) } /// -/// Return the index of the given object in this set. @param obj The object for which to return the index. Must be contained in the set. @return The index of the object or -1 if the object is not contained in the set. ) +/// Return the index of the given object in this set. +/// @param obj The object for which to return the index. Must be contained in the set. +/// @return The index of the object or -1 if the object is not contained in the set. ) +/// /// public int fnSimSet_getObjectIndex (string simset, string obj) @@ -32492,7 +41327,9 @@ public int fnSimSet_getObjectIndex (string simset, string obj) return SafeNativeMethods.mwle_fnSimSet_getObjectIndex(sbsimset, sbobj); } /// -/// Return a random object from the set. @return A randomly selected object from the set or -1 if the set is empty. ) +/// Return a random object from the set. +/// @return A randomly selected object from the set or -1 if the set is empty. ) +/// /// public string fnSimSet_getRandom (string simset) @@ -32509,7 +41346,10 @@ public string fnSimSet_getRandom (string simset) } /// -/// Test whether the given object belongs to the set. @param obj The object. @return True if the object is contained in the set; false otherwise. ) +/// Test whether the given object belongs to the set. +/// @param obj The object. +/// @return True if the object is contained in the set; false otherwise. ) +/// /// public bool fnSimSet_isMember (string simset, string obj) @@ -32527,6 +41367,7 @@ public bool fnSimSet_isMember (string simset, string obj) } /// /// Dump a list of all objects contained in the set to the console. ) +/// /// public void fnSimSet_listObjects (string simset) @@ -32540,7 +41381,9 @@ public void fnSimSet_listObjects (string simset) SafeNativeMethods.mwle_fnSimSet_listObjects(sbsimset); } /// -/// Make the given object the last object in the set. @param obj The object to bring to the last position. Must be contained in the set. ) +/// Make the given object the last object in the set. +/// @param obj The object to bring to the last position. Must be contained in the set. ) +/// /// public void fnSimSet_pushToBack (string simset, string obj) @@ -32557,7 +41400,10 @@ public void fnSimSet_pushToBack (string simset, string obj) SafeNativeMethods.mwle_fnSimSet_pushToBack(sbsimset, sbobj); } /// -/// ( SimSet, remove, void, 3, 0, ( SimObject objects... ) Remove the given objects from the set. @param objects The objects to remove from the set. ) +/// ( SimSet, remove, void, 3, 0, +/// ( SimObject objects... ) Remove the given objects from the set. +/// @param objects The objects to remove from the set. ) +/// /// public void fnSimSet_remove (string simset, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -32625,7 +41471,10 @@ public void fnSimSet_remove (string simset, string a2, string a3, string a4, str SafeNativeMethods.mwle_fnSimSet_remove(sbsimset, sba2, sba3, sba4, sba5, sba6, sba7, sba8, sba9, sba10, sba11, sba12, sba13, sba14, sba15, sba16, sba17, sba18, sba19); } /// -/// Make sure child1 is ordered right before child2 in the set. @param child1 The first child. The object must already be contained in the set. @param child2 The second child. The object must already be contained in the set. ) +/// Make sure child1 is ordered right before child2 in the set. +/// @param child1 The first child. The object must already be contained in the set. +/// @param child2 The second child. The object must already be contained in the set. ) +/// /// public void fnSimSet_reorderChild (string simset, string child1, string child2) @@ -32645,7 +41494,24 @@ public void fnSimSet_reorderChild (string simset, string child1, string child2) SafeNativeMethods.mwle_fnSimSet_reorderChild(sbsimset, sbchild1, sbchild2); } /// -/// @brief Add the given comment as a child of the document. @param comment String containing the comment. @tsexample // Create a new XML document with a header, a comment and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addComment(\"This is a test comment\"); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // !--This is a test comment--> // NewElement /> @endtsexample @see readComment()) +/// @brief Add the given comment as a child of the document. +/// @param comment String containing the comment. +/// +/// @tsexample +/// // Create a new XML document with a header, a comment and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addComment(\"This is a test comment\"); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // !--This is a test comment--> +/// // NewElement /> +/// @endtsexample +/// +/// @see readComment()) +/// /// public void fnSimXMLDocument_addComment (string simxmldocument, string comment) @@ -32662,7 +41528,34 @@ public void fnSimXMLDocument_addComment (string simxmldocument, string comment) SafeNativeMethods.mwle_fnSimXMLDocument_addComment(sbsimxmldocument, sbcomment); } /// -/// @brief Add the given text as a child of current Element. Use getData() to retrieve any text from the current Element. addData() and addText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added data. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addData(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getData() @see addText() @see getText() @see removeText()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getData() to retrieve any text from the current Element. +/// +/// addData() and addText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added data. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addData(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public void fnSimXMLDocument_addData (string simxmldocument, string text) @@ -32679,7 +41572,24 @@ public void fnSimXMLDocument_addData (string simxmldocument, string text) SafeNativeMethods.mwle_fnSimXMLDocument_addData(sbsimxmldocument, sbtext); } /// -/// @brief Add a XML header to a document. Sometimes called a declaration, you typically add a standard header to the document before adding any elements. SimXMLDocument always produces the following header: ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> @tsexample // Create a new XML document with just a header and single element. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement /> @endtsexample) +/// @brief Add a XML header to a document. +/// +/// Sometimes called a declaration, you typically add a standard header to +/// the document before adding any elements. SimXMLDocument always produces +/// the following header: +/// ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// +/// @tsexample +/// // Create a new XML document with just a header and single element. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement /> +/// @endtsexample) +/// /// public void fnSimXMLDocument_addHeader (string simxmldocument) @@ -32693,7 +41603,17 @@ public void fnSimXMLDocument_addHeader (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_addHeader(sbsimxmldocument); } /// -/// @brief Create a new element with the given name as child of current Element's parent and push it onto the Element stack making it the current one. @note This differs from pushNewElement() in that it adds the new Element to the current Element's parent (or document if there is no parent Element). This makes the new Element a sibling of the current one. @param name XML tag for the new Element. @see pushNewElement()) +/// @brief Create a new element with the given name as child of current Element's +/// parent and push it onto the Element stack making it the current one. +/// +/// @note This differs from pushNewElement() in that it adds the new Element to the +/// current Element's parent (or document if there is no parent Element). This makes +/// the new Element a sibling of the current one. +/// +/// @param name XML tag for the new Element. +/// +/// @see pushNewElement()) +/// /// public void fnSimXMLDocument_addNewElement (string simxmldocument, string name) @@ -32710,7 +41630,33 @@ public void fnSimXMLDocument_addNewElement (string simxmldocument, string name) SafeNativeMethods.mwle_fnSimXMLDocument_addNewElement(sbsimxmldocument, sbname); } /// -/// @brief Add the given text as a child of current Element. Use getText() to retrieve any text from the current Element and removeText() to clear any text. addText() and addData() may be used interchangeably. @param text String containing the text. @tsexample // Create a new XML document with a header and single element // with some added text. %x = new SimXMLDocument(); %x.addHeader(); %x.addNewElement(\"NewElement\"); %x.addText(\"Some text\"); %x.saveFile(\"test.xml\"); // Produces the following file: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> @endtsexample @see getText() @see removeText() @see addData() @see getData()) +/// @brief Add the given text as a child of current Element. +/// +/// Use getText() to retrieve any text from the current Element and removeText() +/// to clear any text. +/// +/// addText() and addData() may be used interchangeably. +/// +/// @param text String containing the text. +/// +/// @tsexample +/// // Create a new XML document with a header and single element +/// // with some added text. +/// %x = new SimXMLDocument(); +/// %x.addHeader(); +/// %x.addNewElement(\"NewElement\"); +/// %x.addText(\"Some text\"); +/// %x.saveFile(\"test.xml\"); +/// // Produces the following file: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// @endtsexample +/// +/// @see getText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public void fnSimXMLDocument_addText (string simxmldocument, string text) @@ -32727,7 +41673,10 @@ public void fnSimXMLDocument_addText (string simxmldocument, string text) SafeNativeMethods.mwle_fnSimXMLDocument_addText(sbsimxmldocument, sbtext); } /// -/// @brief Get a string attribute from the current Element on the stack. @param attributeName Name of attribute to retrieve. @return The attribute string if found. Otherwise returns an empty string.) +/// @brief Get a string attribute from the current Element on the stack. +/// @param attributeName Name of attribute to retrieve. +/// @return The attribute string if found. Otherwise returns an empty string.) +/// /// public string fnSimXMLDocument_attribute (string simxmldocument, string attributeName) @@ -32747,7 +41696,10 @@ public string fnSimXMLDocument_attribute (string simxmldocument, string attribut } /// -/// @brief Tests if the requested attribute exists. @param attributeName Name of attribute being queried for. @return True if the attribute exists.) +/// @brief Tests if the requested attribute exists. +/// @param attributeName Name of attribute being queried for. +/// @return True if the attribute exists.) +/// /// public bool fnSimXMLDocument_attributeExists (string simxmldocument, string attributeName) @@ -32764,7 +41716,12 @@ public bool fnSimXMLDocument_attributeExists (string simxmldocument, string attr return SafeNativeMethods.mwle_fnSimXMLDocument_attributeExists(sbsimxmldocument, sbattributeName)>=1; } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using reset() @see reset()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using reset() +/// +/// @see reset()) +/// /// public void fnSimXMLDocument_clear (string simxmldocument) @@ -32779,6 +41736,7 @@ public void fnSimXMLDocument_clear (string simxmldocument) } /// /// @brief Clear the last error description.) +/// /// public void fnSimXMLDocument_clearError (string simxmldocument) @@ -32792,7 +41750,10 @@ public void fnSimXMLDocument_clearError (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_clearError(sbsimxmldocument); } /// -/// @brief Get the Element's value if it exists. Usually returns the text from the Element. @return The value from the Element, or an empty string if none is found.) +/// @brief Get the Element's value if it exists. +/// Usually returns the text from the Element. +/// @return The value from the Element, or an empty string if none is found.) +/// /// public string fnSimXMLDocument_elementValue (string simxmldocument) @@ -32809,7 +41770,12 @@ public string fnSimXMLDocument_elementValue (string simxmldocument) } /// -/// @brief Obtain the name of the current Element's first attribute. @return String containing the first attribute's name, or an empty string if none is found. @see nextAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Obtain the name of the current Element's first attribute. +/// @return String containing the first attribute's name, or an empty string if none is found. +/// @see nextAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string fnSimXMLDocument_firstAttribute (string simxmldocument) @@ -32826,7 +41792,39 @@ public string fnSimXMLDocument_firstAttribute (string simxmldocument) } /// -/// @brief Gets the text from the current Element. Use addData() to add text to the current Element. getData() and getText() may be used interchangeably. As there is no difference between data and text, you may also use removeText() to clear any data from the current Element. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some data/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's data ('Some data' in this example) // into 'result' %result = %x.getData(); echo( %result ); @endtsexample @see addData() @see addText() @see getText() @see removeText()) +/// @brief Gets the text from the current Element. +/// +/// Use addData() to add text to the current Element. +/// +/// getData() and getText() may be used interchangeably. As there is no +/// difference between data and text, you may also use removeText() to clear +/// any data from the current Element. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some data/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's data ('Some data' in this example) +/// // into 'result' +/// %result = %x.getData(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addData() +/// @see addText() +/// @see getText() +/// @see removeText()) +/// /// public string fnSimXMLDocument_getData (string simxmldocument) @@ -32843,7 +41841,9 @@ public string fnSimXMLDocument_getData (string simxmldocument) } /// -/// @brief Get last error description. @return A string of the last error message.) +/// @brief Get last error description. +/// @return A string of the last error message.) +/// /// public string fnSimXMLDocument_getErrorDesc (string simxmldocument) @@ -32860,7 +41860,38 @@ public string fnSimXMLDocument_getErrorDesc (string simxmldocument) } /// -/// @brief Gets the text from the current Element. Use addText() to add text to the current Element and removeText() to clear any text. getText() and getData() may be used interchangeably. @return String containing the text in the current Element. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample @see addText() @see removeText() @see addData() @see getData()) +/// @brief Gets the text from the current Element. +/// +/// Use addText() to add text to the current Element and removeText() +/// to clear any text. +/// +/// getText() and getData() may be used interchangeably. +/// +/// @return String containing the text in the current Element. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample +/// +/// @see addText() +/// @see removeText() +/// @see addData() +/// @see getData()) +/// /// public string fnSimXMLDocument_getText (string simxmldocument) @@ -32877,7 +41908,12 @@ public string fnSimXMLDocument_getText (string simxmldocument) } /// -/// @brief Obtain the name of the current Element's last attribute. @return String containing the last attribute's name, or an empty string if none is found. @see prevAttribute() @see firstAttribute() @see lastAttribute()) +/// @brief Obtain the name of the current Element's last attribute. +/// @return String containing the last attribute's name, or an empty string if none is found. +/// @see prevAttribute() +/// @see firstAttribute() +/// @see lastAttribute()) +/// /// public string fnSimXMLDocument_lastAttribute (string simxmldocument) @@ -32894,7 +41930,11 @@ public string fnSimXMLDocument_lastAttribute (string simxmldocument) } /// -/// @brief Load in given filename and prepare it for use. @note Clears the current document's contents. @param fileName Name and path of XML document @return True if the file was loaded successfully.) +/// @brief Load in given filename and prepare it for use. +/// @note Clears the current document's contents. +/// @param fileName Name and path of XML document +/// @return True if the file was loaded successfully.) +/// /// public bool fnSimXMLDocument_loadFile (string simxmldocument, string fileName) @@ -32911,7 +41951,12 @@ public bool fnSimXMLDocument_loadFile (string simxmldocument, string fileName) return SafeNativeMethods.mwle_fnSimXMLDocument_loadFile(sbsimxmldocument, sbfileName)>=1; } /// -/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). @return String containing the next attribute's name, or an empty string if none is found. @see firstAttribute() @see lastAttribute() @see prevAttribute()) +/// @brief Get the name of the next attribute for the current Element after a call to firstAttribute(). +/// @return String containing the next attribute's name, or an empty string if none is found. +/// @see firstAttribute() +/// @see lastAttribute() +/// @see prevAttribute()) +/// /// public string fnSimXMLDocument_nextAttribute (string simxmldocument) @@ -32928,7 +41973,10 @@ public string fnSimXMLDocument_nextAttribute (string simxmldocument) } /// -/// @brief Put the next sibling Element with the given name on the stack, making it the current one. @param name String containing name of the next sibling. @return True if the Element was found and made the current one.) +/// @brief Put the next sibling Element with the given name on the stack, making it the current one. +/// @param name String containing name of the next sibling. +/// @return True if the Element was found and made the current one.) +/// /// public bool fnSimXMLDocument_nextSiblingElement (string simxmldocument, string name) @@ -32945,7 +41993,10 @@ public bool fnSimXMLDocument_nextSiblingElement (string simxmldocument, string n return SafeNativeMethods.mwle_fnSimXMLDocument_nextSiblingElement(sbsimxmldocument, sbname)>=1; } /// -/// @brief Create a document from a XML string. @note Clears the current document's contents. @param xmlString Valid XML to parse and store as a document.) +/// @brief Create a document from a XML string. +/// @note Clears the current document's contents. +/// @param xmlString Valid XML to parse and store as a document.) +/// /// public void fnSimXMLDocument_parse (string simxmldocument, string xmlString) @@ -32963,6 +42014,7 @@ public void fnSimXMLDocument_parse (string simxmldocument, string xmlString) } /// /// @brief Pop the last Element off the stack.) +/// /// public void fnSimXMLDocument_popElement (string simxmldocument) @@ -32976,7 +42028,12 @@ public void fnSimXMLDocument_popElement (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_popElement(sbsimxmldocument); } /// -/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). @return String containing the previous attribute's name, or an empty string if none is found. @see lastAttribute() @see firstAttribute() @see nextAttribute()) +/// @brief Get the name of the previous attribute for the current Element after a call to lastAttribute(). +/// @return String containing the previous attribute's name, or an empty string if none is found. +/// @see lastAttribute() +/// @see firstAttribute() +/// @see nextAttribute()) +/// /// public string fnSimXMLDocument_prevAttribute (string simxmldocument) @@ -32993,7 +42050,10 @@ public string fnSimXMLDocument_prevAttribute (string simxmldocument) } /// -/// @brief Push the child Element at the given index onto the stack, making it the current one. @param index Numerical index of Element being pushed. @return True if the Element was found and made the current one.) +/// @brief Push the child Element at the given index onto the stack, making it the current one. +/// @param index Numerical index of Element being pushed. +/// @return True if the Element was found and made the current one.) +/// /// public bool fnSimXMLDocument_pushChildElement (string simxmldocument, int index) @@ -33007,7 +42067,29 @@ public bool fnSimXMLDocument_pushChildElement (string simxmldocument, int index) return SafeNativeMethods.mwle_fnSimXMLDocument_pushChildElement(sbsimxmldocument, index)>=1; } /// -/// @brief Push the first child Element with the given name onto the stack, making it the current Element. @param name String containing name of the child Element. @return True if the Element was found and made the current one. @tsexample // Using the following test.xml file as an example: // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> // NewElement>Some text/NewElement> // Load in the file %x = new SimXMLDocument(); %x.loadFile(\"test.xml\"); // Make the first Element the current one %x.pushFirstChildElement(\"NewElement\"); // Store the current Element's text ('Some text' in this example) // into 'result' %result = %x.getText(); echo( %result ); @endtsexample) +/// @brief Push the first child Element with the given name onto the stack, making it the current Element. +/// +/// @param name String containing name of the child Element. +/// @return True if the Element was found and made the current one. +/// +/// @tsexample +/// // Using the following test.xml file as an example: +/// // ?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?> +/// // NewElement>Some text/NewElement> +/// +/// // Load in the file +/// %x = new SimXMLDocument(); +/// %x.loadFile(\"test.xml\"); +/// +/// // Make the first Element the current one +/// %x.pushFirstChildElement(\"NewElement\"); +/// +/// // Store the current Element's text ('Some text' in this example) +/// // into 'result' +/// %result = %x.getText(); +/// echo( %result ); +/// @endtsexample) +/// /// public bool fnSimXMLDocument_pushFirstChildElement (string simxmldocument, string name) @@ -33024,7 +42106,16 @@ public bool fnSimXMLDocument_pushFirstChildElement (string simxmldocument, strin return SafeNativeMethods.mwle_fnSimXMLDocument_pushFirstChildElement(sbsimxmldocument, sbname)>=1; } /// -/// @brief Create a new element with the given name as child of current Element and push it onto the Element stack making it the current one. @note This differs from addNewElement() in that it adds the new Element as a child of the current Element (or a child of the document if no Element exists). @param name XML tag for the new Element. @see addNewElement()) +/// @brief Create a new element with the given name as child of current Element +/// and push it onto the Element stack making it the current one. +/// +/// @note This differs from addNewElement() in that it adds the new Element as a +/// child of the current Element (or a child of the document if no Element exists). +/// +/// @param name XML tag for the new Element. +/// +/// @see addNewElement()) +/// /// public void fnSimXMLDocument_pushNewElement (string simxmldocument, string name) @@ -33041,7 +42132,18 @@ public void fnSimXMLDocument_pushNewElement (string simxmldocument, string name) SafeNativeMethods.mwle_fnSimXMLDocument_pushNewElement(sbsimxmldocument, sbname); } /// -/// Gives the comment at the specified index, if any. Unlike addComment() that only works at the document level, readComment() may read comments from the document or any child Element. The current Element (or document if no Elements have been pushed to the stack) is the parent for any comments, and the provided index is the number of comments in to read back. @param index Comment index number to query from the current Element stack @return String containing the comment, or an empty string if no comment is found. @see addComment()) +/// Gives the comment at the specified index, if any. +/// +/// Unlike addComment() that only works at the document level, readComment() may read +/// comments from the document or any child Element. The current Element (or document +/// if no Elements have been pushed to the stack) is the parent for any comments, and the +/// provided index is the number of comments in to read back. +/// +/// @param index Comment index number to query from the current Element stack +/// @return String containing the comment, or an empty string if no comment is found. +/// +/// @see addComment()) +/// /// public string fnSimXMLDocument_readComment (string simxmldocument, int index) @@ -33058,7 +42160,18 @@ public string fnSimXMLDocument_readComment (string simxmldocument, int index) } /// -/// @brief Remove any text on the current Element. Use getText() to retrieve any text from the current Element and addText() to add text to the current Element. As getData() and addData() are equivalent to getText() and addText(), removeText() will also remove any data from the current Element. @see addText() @see getText() @see addData() @see getData()) +/// @brief Remove any text on the current Element. +/// +/// Use getText() to retrieve any text from the current Element and addText() +/// to add text to the current Element. As getData() and addData() are equivalent +/// to getText() and addText(), removeText() will also remove any data from the +/// current Element. +/// +/// @see addText() +/// @see getText() +/// @see addData() +/// @see getData()) +/// /// public void fnSimXMLDocument_removeText (string simxmldocument) @@ -33072,7 +42185,12 @@ public void fnSimXMLDocument_removeText (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_removeText(sbsimxmldocument); } /// -/// @brief Set this document to its default state. Clears all Elements from the documents. Equivalent to using clear() @see clear()) +/// @brief Set this document to its default state. +/// +/// Clears all Elements from the documents. Equivalent to using clear() +/// +/// @see clear()) +/// /// public void fnSimXMLDocument_reset (string simxmldocument) @@ -33086,7 +42204,10 @@ public void fnSimXMLDocument_reset (string simxmldocument) SafeNativeMethods.mwle_fnSimXMLDocument_reset(sbsimxmldocument); } /// -/// @brief Save document to the given file name. @param fileName Path and name of XML file to save to. @return True if the file was successfully saved.) +/// @brief Save document to the given file name. +/// @param fileName Path and name of XML file to save to. +/// @return True if the file was successfully saved.) +/// /// public bool fnSimXMLDocument_saveFile (string simxmldocument, string fileName) @@ -33103,7 +42224,10 @@ public bool fnSimXMLDocument_saveFile (string simxmldocument, string fileName) return SafeNativeMethods.mwle_fnSimXMLDocument_saveFile(sbsimxmldocument, sbfileName)>=1; } /// -/// @brief Set the attribute of the current Element on the stack to the given value. @param attributeName Name of attribute being changed @param value New value to assign to the attribute) +/// @brief Set the attribute of the current Element on the stack to the given value. +/// @param attributeName Name of attribute being changed +/// @param value New value to assign to the attribute) +/// /// public void fnSimXMLDocument_setAttribute (string simxmldocument, string attributeName, string value) @@ -33123,7 +42247,9 @@ public void fnSimXMLDocument_setAttribute (string simxmldocument, string attribu SafeNativeMethods.mwle_fnSimXMLDocument_setAttribute(sbsimxmldocument, sbattributeName, sbvalue); } /// -/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. @param objectID ID of SimObject being copied.) +/// @brief Add the given SimObject's fields as attributes of the current Element on the stack. +/// @param objectID ID of SimObject being copied.) +/// /// public void fnSimXMLDocument_setObjectAttributes (string simxmldocument, string objectID) @@ -33140,7 +42266,10 @@ public void fnSimXMLDocument_setObjectAttributes (string simxmldocument, string SafeNativeMethods.mwle_fnSimXMLDocument_setObjectAttributes(sbsimxmldocument, sbobjectID); } /// -/// @brief Copy from another StreamObject into this StreamObject @param other The StreamObject to copy from. @return True if the copy was successful.) +/// @brief Copy from another StreamObject into this StreamObject +/// @param other The StreamObject to copy from. +/// @return True if the copy was successful.) +/// /// public bool fnStreamObject_copyFrom (string streamobject, string other) @@ -33157,7 +42286,36 @@ public bool fnStreamObject_copyFrom (string streamobject, string other) return SafeNativeMethods.mwle_fnStreamObject_copyFrom(sbstreamobject, sbother)>=1; } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains two lines of text repeated: // Hello World // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Get the position of the stream %position = %fsObject.getPosition(); // Print the current position // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline echo(%position); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see setPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains two lines of text repeated: +/// // Hello World +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Get the position of the stream +/// %position = %fsObject.getPosition(); +/// // Print the current position +/// // Should be 13, 10 for the words, 1 for the space, 1 for the null terminator, and 1 for the newline +/// echo(%position); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see setPosition()) +/// /// public int fnStreamObject_getPosition (string streamobject) @@ -33171,7 +42329,36 @@ public int fnStreamObject_getPosition (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_getPosition(sbstreamobject); } /// -/// @brief Gets a printable string form of the stream's status @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Get the status and print it %status = %fsObject.getStatus(); echo(%status); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing status constant, one of the following: OK - Stream is active and no file errors IOError - Something went wrong during read or writing the stream EOS - End of Stream reached (mostly for reads) IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn Closed - Tried to operate on a closed stream (or detached filter) UnknownError - Catch all for an error of some kind Invalid - Entire stream is invalid) +/// @brief Gets a printable string form of the stream's status +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Get the status and print it +/// %status = %fsObject.getStatus(); +/// echo(%status); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing status constant, one of the following: +/// +/// OK - Stream is active and no file errors +/// +/// IOError - Something went wrong during read or writing the stream +/// +/// EOS - End of Stream reached (mostly for reads) +/// +/// IllegalCall - An unsupported operation used. Always w/ accompanied by AssertWarn +/// +/// Closed - Tried to operate on a closed stream (or detached filter) +/// +/// UnknownError - Catch all for an error of some kind +/// +/// Invalid - Entire stream is invalid) +/// /// public string fnStreamObject_getStatus (string streamobject) @@ -33188,7 +42375,30 @@ public string fnStreamObject_getStatus (string streamobject) } /// -/// @brief Gets the size of the stream The size is dependent on the type of stream being used. If it is a file stream, returned value will be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject.open(\"./test.txt\", \"read\"); // Found out how large the file stream is // Then print it to the console // Should be 22 %streamSize = %fsObject.getStreamSize(); echo(%streamSize); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Size of stream, in bytes) +/// @brief Gets the size of the stream +/// +/// The size is dependent on the type of stream being used. If it is a file stream, returned value will +/// be the size of the file. If it is a memory stream, it will be the size of the allocated buffer. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Found out how large the file stream is +/// // Then print it to the console +/// // Should be 22 +/// %streamSize = %fsObject.getStreamSize(); +/// echo(%streamSize); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Size of stream, in bytes) +/// /// public int fnStreamObject_getStreamSize (string streamobject) @@ -33202,7 +42412,32 @@ public int fnStreamObject_getStreamSize (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_getStreamSize(sbstreamobject); } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOS. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOF() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOS()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOS. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOF() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOS()) +/// /// public bool fnStreamObject_isEOF (string streamobject) @@ -33216,7 +42451,32 @@ public bool fnStreamObject_isEOF (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_isEOF(sbstreamobject)>=1; } /// -/// @brief Tests if the stream has reached the end of the file This is an alternative name for isEOF. Both functions are interchangeable. This simply exists for those familiar with some C++ file I/O standards. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading %fsObject.open(\"./test.txt\", \"read\"); // Keep reading until we reach the end of the file while( !%fsObject.isEOS() ) { %line = %fsObject.readLine(); echo(%line); } // Made it to the end echo(\"Finished reading file\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return True if the parser has reached the end of the file, false otherwise @see isEOF()) +/// @brief Tests if the stream has reached the end of the file +/// +/// This is an alternative name for isEOF. Both functions are interchangeable. This simply exists +/// for those familiar with some C++ file I/O standards. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Keep reading until we reach the end of the file +/// while( !%fsObject.isEOS() ) +/// { +/// %line = %fsObject.readLine(); +/// echo(%line); +/// } +/// // Made it to the end +/// echo(\"Finished reading file\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return True if the parser has reached the end of the file, false otherwise +/// +/// @see isEOF()) +/// /// public bool fnStreamObject_isEOS (string streamobject) @@ -33230,7 +42490,30 @@ public bool fnStreamObject_isEOS (string streamobject) return SafeNativeMethods.mwle_fnStreamObject_isEOS(sbstreamobject)>=1; } /// -/// @brief Read a line from the stream. Emphasis on *line*, as in you cannot parse individual characters or chunks of data. There is no limitation as to what kind of data you can read. @tsexample // Create a file stream object for reading // This file contains the following two lines: // HelloWorld // HelloWorld %fsObject = new FileStreamObject(); %fsObject.open(\"./test.txt\", \"read\"); // Read in the first line %line = %fsObject.readLine(); // Print the line we just read echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return String containing the line of data that was just read @see writeLine()) +/// @brief Read a line from the stream. +/// +/// Emphasis on *line*, as in you cannot parse individual characters or chunks of data. +/// There is no limitation as to what kind of data you can read. +/// +/// @tsexample +/// // Create a file stream object for reading +/// // This file contains the following two lines: +/// // HelloWorld +/// // HelloWorld +/// %fsObject = new FileStreamObject(); +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Read in the first line +/// %line = %fsObject.readLine(); +/// // Print the line we just read +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return String containing the line of data that was just read +/// +/// @see writeLine()) +/// /// public string fnStreamObject_readLine (string streamobject) @@ -33247,7 +42530,15 @@ public string fnStreamObject_readLine (string streamobject) } /// -/// @brief Read in a string up to the given maximum number of characters. @param maxLength The maximum number of characters to read in. @return The string that was read from the stream. @see writeLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string up to the given maximum number of characters. +/// @param maxLength The maximum number of characters to read in. +/// @return The string that was read from the stream. +/// @see writeLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string fnStreamObject_readLongString (string streamobject, int maxLength) @@ -33264,7 +42555,14 @@ public string fnStreamObject_readLongString (string streamobject, int maxLength) } /// -/// @brief Read a string up to a maximum of 256 characters @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read a string up to a maximum of 256 characters +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string fnStreamObject_readString (string streamobject) @@ -33281,7 +42579,16 @@ public string fnStreamObject_readString (string streamobject) } /// -/// @brief Read in a string and place it on the string table. @param caseSensitive If false then case will not be taken into account when attempting to match the read in string with what is already in the string table. @return The string that was read from the stream. @see writeString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Read in a string and place it on the string table. +/// @param caseSensitive If false then case will not be taken into account when attempting +/// to match the read in string with what is already in the string table. +/// @return The string that was read from the stream. +/// @see writeString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public string fnStreamObject_readSTString (string streamobject, bool caseSensitive) @@ -33298,7 +42605,35 @@ public string fnStreamObject_readSTString (string streamobject, bool caseSensiti } /// -/// @brief Gets the position in the stream The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. For StreamObject, when you read in the line the position is increased by the number of characters parsed, the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. @tsexample // Create a file stream object for reading %fsObject = new FileStreamObject(); // Open a file for reading // This file contains the following two lines: // 11111111111 // Hello World %fsObject.open(\"./test.txt\", \"read\"); // Skip ahead by 12, which will bypass the first line entirely %fsObject.setPosition(12); // Read in the next line %line = %fsObject.readLine(); // Print the line just read in, should be \"Hello World\" echo(%line); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @return Number of bytes which stream has parsed so far, null terminators and newlines are included @see getPosition()) +/// @brief Gets the position in the stream +/// +/// The easiest way to visualize this is to think of a cursor in a text file. If you have moved the cursor by +/// five characters, the current position is 5. If you move ahead 10 more characters, the position is now 15. +/// For StreamObject, when you read in the line the position is increased by the number of characters parsed, +/// the null terminator, and a newline. Using setPosition allows you to skip to specific points of the file. +/// +/// @tsexample +/// // Create a file stream object for reading +/// %fsObject = new FileStreamObject(); +/// // Open a file for reading +/// // This file contains the following two lines: +/// // 11111111111 +/// // Hello World +/// %fsObject.open(\"./test.txt\", \"read\"); +/// // Skip ahead by 12, which will bypass the first line entirely +/// %fsObject.setPosition(12); +/// // Read in the next line +/// %line = %fsObject.readLine(); +/// // Print the line just read in, should be \"Hello World\" +/// echo(%line); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @return Number of bytes which stream has parsed so far, null terminators and newlines are included +/// +/// @see getPosition()) +/// /// public bool fnStreamObject_setPosition (string streamobject, int newPosition) @@ -33312,7 +42647,29 @@ public bool fnStreamObject_setPosition (string streamobject, int newPosition) return SafeNativeMethods.mwle_fnStreamObject_setPosition(sbstreamobject, newPosition)>=1; } /// -/// @brief Write a line to the stream, if it was opened for writing. There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. Be careful of what you write, as whitespace, current values, and literals will be preserved. @param line The data we are writing out to file. @tsexample // Create a file stream %fsObject = new FileStreamObject(); // Open the file for writing // If it does not exist, it is created. If it does exist, the file is cleared %fsObject.open(\"./test.txt\", \"write\"); // Write a line to the file %fsObject.writeLine(\"Hello World\"); // Write another line to the file %fsObject.writeLine(\"Documentation Rocks!\"); // Always remember to close a file stream when finished %fsObject.close(); @endtsexample @see readLine()) +/// @brief Write a line to the stream, if it was opened for writing. +/// +/// There is no limit as to what kind of data you can write. Any format and data is allowable, not just text. +/// Be careful of what you write, as whitespace, current values, and literals will be preserved. +/// +/// @param line The data we are writing out to file. +/// +/// @tsexample +/// // Create a file stream +/// %fsObject = new FileStreamObject(); +/// // Open the file for writing +/// // If it does not exist, it is created. If it does exist, the file is cleared +/// %fsObject.open(\"./test.txt\", \"write\"); +/// // Write a line to the file +/// %fsObject.writeLine(\"Hello World\"); +/// // Write another line to the file +/// %fsObject.writeLine(\"Documentation Rocks!\"); +/// // Always remember to close a file stream when finished +/// %fsObject.close(); +/// @endtsexample +/// +/// @see readLine()) +/// /// public void fnStreamObject_writeLine (string streamobject, string line) @@ -33329,7 +42686,15 @@ public void fnStreamObject_writeLine (string streamobject, string line) SafeNativeMethods.mwle_fnStreamObject_writeLine(sbstreamobject, sbline); } /// -/// @brief Write out a string up to the maximum number of characters. @param maxLength The maximum number of characters that will be written. @param string The string to write out to the stream. @see readLongString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string up to the maximum number of characters. +/// @param maxLength The maximum number of characters that will be written. +/// @param string The string to write out to the stream. +/// @see readLongString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void fnStreamObject_writeLongString (string streamobject, int maxLength, string stringx) @@ -33346,7 +42711,16 @@ public void fnStreamObject_writeLongString (string streamobject, int maxLength, SafeNativeMethods.mwle_fnStreamObject_writeLongString(sbstreamobject, maxLength, sbstringx); } /// -/// @brief Write out a string with a default maximum length of 256 characters. @param string The string to write out to the stream @param maxLength The maximum string length to write out with a default of 256 characters. This value should not be larger than 256 as it is written to the stream as a single byte. @see readString() @note When working with these particular string reading and writing methods, the stream begins with the length of the string followed by the string itself, and does not include a NULL terminator.) +/// @brief Write out a string with a default maximum length of 256 characters. +/// @param string The string to write out to the stream +/// @param maxLength The maximum string length to write out with a default of 256 characters. This +/// value should not be larger than 256 as it is written to the stream as a single byte. +/// @see readString() +/// +/// @note When working with these particular string reading and writing methods, the stream +/// begins with the length of the string followed by the string itself, and does not include +/// a NULL terminator.) +/// /// public void fnStreamObject_writeString (string streamobject, string stringx, int maxLength) @@ -33363,7 +42737,18 @@ public void fnStreamObject_writeString (string streamobject, string stringx, int SafeNativeMethods.mwle_fnStreamObject_writeString(sbstreamobject, sbstringx, maxLength); } /// -/// @brief Connect to the given address. @param address Server address (including port) to connect to. @tsexample // Set the address. %address = \"www.garagegames.com:80\"; // Inform this TCPObject to connect to the specified address. %thisTCPObj.connect(%address); @endtsexample) +/// @brief Connect to the given address. +/// +/// @param address Server address (including port) to connect to. +/// +/// @tsexample +/// // Set the address. +/// %address = \"www.garagegames.com:80\"; +/// +/// // Inform this TCPObject to connect to the specified address. +/// %thisTCPObj.connect(%address); +/// @endtsexample) +/// /// public void fnTCPObject_connect (string tcpobject, string address) @@ -33380,7 +42765,13 @@ public void fnTCPObject_connect (string tcpobject, string address) SafeNativeMethods.mwle_fnTCPObject_connect(sbtcpobject, sbaddress); } /// -/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. @tsexample // Inform this TCPObject to disconnect from anything it is currently connected to. %thisTCPObj.disconnect(); @endtsexample) +/// @brief Disconnect from whatever this TCPObject is currently connected to, if anything. +/// +/// @tsexample +/// // Inform this TCPObject to disconnect from anything it is currently connected to. +/// %thisTCPObj.disconnect(); +/// @endtsexample) +/// /// public void fnTCPObject_disconnect (string tcpobject) @@ -33394,10 +42785,37 @@ public void fnTCPObject_disconnect (string tcpobject) SafeNativeMethods.mwle_fnTCPObject_disconnect(sbtcpobject); } /// -/// @brief Start listening on the specified port for connections. This method starts a listener which looks for incoming TCP connections to a port. You must overload the onConnectionRequest callback to create a new TCPObject to read, write, or reject the new connection. @param port Port for this TCPObject to start listening for connections on. @tsexample // Create a listener on port 8080. new TCPObject( TCPListener ); TCPListener.listen( 8080 ); function TCPListener::onConnectionRequest( %this, %address, %id ) { // Create a new object to manage the connection. new TCPObject( TCPClient, %id ); } function TCPClient::onLine( %this, %line ) { // Print the line of text from client. echo( %line ); } @endtsexample) +/// @brief Start listening on the specified port for connections. +/// +/// This method starts a listener which looks for incoming TCP connections to a port. +/// You must overload the onConnectionRequest callback to create a new TCPObject to +/// read, write, or reject the new connection. +/// +/// @param port Port for this TCPObject to start listening for connections on. +/// +/// @tsexample +/// +/// // Create a listener on port 8080. +/// new TCPObject( TCPListener ); +/// TCPListener.listen( 8080 ); +/// +/// function TCPListener::onConnectionRequest( %this, %address, %id ) +/// { +/// // Create a new object to manage the connection. +/// new TCPObject( TCPClient, %id ); +/// } +/// +/// function TCPClient::onLine( %this, %line ) +/// { +/// // Print the line of text from client. +/// echo( %line ); +/// } +/// +/// @endtsexample) +/// /// -public void fnTCPObject_listen (string tcpobject, int port) +public void fnTCPObject_listen (string tcpobject, uint port) { if(Debugging) System.Console.WriteLine("----------------->Extern Call 'fnTCPObject_listen'" + string.Format("\"{0}\" \"{1}\" ",tcpobject,port)); @@ -33408,7 +42826,23 @@ public void fnTCPObject_listen (string tcpobject, int port) SafeNativeMethods.mwle_fnTCPObject_listen(sbtcpobject, port); } /// -/// @brief Transmits the data string to the connected computer. This method is used to send text data to the connected computer regardless if we initiated the connection using connect(), or listening to a port using listen(). @param data The data string to send. @tsexample // Set the command data %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" // Send the command to the connected server. %thisTCPObj.send(%data); @endtsexample) +/// @brief Transmits the data string to the connected computer. +/// +/// This method is used to send text data to the connected computer regardless if we initiated the +/// connection using connect(), or listening to a port using listen(). +/// +/// @param data The data string to send. +/// +/// @tsexample +/// // Set the command data +/// %data = \"GET \" @ $RSSFeed::serverURL @ \" HTTP/1.0\\r\\"; +/// %data = %data @ \"Host: \" @ $RSSFeed::serverName @ \"\\r\\"; +/// %data = %data @ \"User-Agent: \" @ $RSSFeed::userAgent @ \"\\r\\\r\\" +/// +/// // Send the command to the connected server. +/// %thisTCPObj.send(%data); +/// @endtsexample) +/// /// public void fnTCPObject_send (string tcpobject, string data) @@ -33425,7 +42859,12 @@ public void fnTCPObject_send (string tcpobject, string data) SafeNativeMethods.mwle_fnTCPObject_send(sbtcpobject, sbdata); } /// -/// @brief Saves the terrain block's terrain file to the specified file name. @param fileName Name and path of file to save terrain data to. @return True if file save was successful, false otherwise) +/// @brief Saves the terrain block's terrain file to the specified file name. +/// +/// @param fileName Name and path of file to save terrain data to. +/// +/// @return True if file save was successful, false otherwise) +/// /// public bool fnTerrainBlock_save (string terrainblock, string fileName) @@ -33443,6 +42882,7 @@ public bool fnTerrainBlock_save (string terrainblock, string fileName) } /// /// ) +/// /// public void fnTimeOfDay_addTimeOfDayEvent (string timeofday, float elevation, string identifier) @@ -33460,6 +42900,7 @@ public void fnTimeOfDay_addTimeOfDayEvent (string timeofday, float elevation, st } /// /// ) +/// /// public void fnTimeOfDay_animate (string timeofday, float elevation, float degreesPerSecond) @@ -33474,6 +42915,7 @@ public void fnTimeOfDay_animate (string timeofday, float elevation, float degree } /// /// ) +/// /// public void fnTimeOfDay_setDayLength (string timeofday, float seconds) @@ -33488,6 +42930,7 @@ public void fnTimeOfDay_setDayLength (string timeofday, float seconds) } /// /// ) +/// /// public void fnTimeOfDay_setPlay (string timeofday, bool enabled) @@ -33502,6 +42945,7 @@ public void fnTimeOfDay_setPlay (string timeofday, bool enabled) } /// /// ) +/// /// public void fnTimeOfDay_setTimeOfDay (string timeofday, float time) @@ -33515,7 +42959,9 @@ public void fnTimeOfDay_setTimeOfDay (string timeofday, float time) SafeNativeMethods.mwle_fnTimeOfDay_setTimeOfDay(sbtimeofday, time); } /// -/// @brief Get the number of objects that are within the Trigger's bounds. @see getObject()) +/// @brief Get the number of objects that are within the Trigger's bounds. +/// @see getObject()) +/// /// public int fnTrigger_getNumObjects (string trigger) @@ -33529,7 +42975,11 @@ public int fnTrigger_getNumObjects (string trigger) return SafeNativeMethods.mwle_fnTrigger_getNumObjects(sbtrigger); } /// -/// @brief Retrieve the requested object that is within the Trigger's bounds. @param index Index of the object to get (range is 0 to getNumObjects()-1) @returns The SimObjectID of the object, or -1 if the requested index is invalid. @see getNumObjects()) +/// @brief Retrieve the requested object that is within the Trigger's bounds. +/// @param index Index of the object to get (range is 0 to getNumObjects()-1) +/// @returns The SimObjectID of the object, or -1 if the requested index is invalid. +/// @see getNumObjects()) +/// /// public int fnTrigger_getObject (string trigger, int index) @@ -33543,7 +42993,11 @@ public int fnTrigger_getObject (string trigger, int index) return SafeNativeMethods.mwle_fnTrigger_getObject(sbtrigger, index); } /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool fnTSAttachable_attachObject (string tsattachable, string obj) @@ -33560,7 +43014,14 @@ public bool fnTSAttachable_attachObject (string tsattachable, string obj) return SafeNativeMethods.mwle_fnTSAttachable_attachObject(sbtsattachable, sbobj)>=1; } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void fnTSAttachable_detachAll (string tsattachable) @@ -33574,7 +43035,11 @@ public void fnTSAttachable_detachAll (string tsattachable) SafeNativeMethods.mwle_fnTSAttachable_detachAll(sbtsattachable); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool fnTSAttachable_detachObject (string tsattachable, string obj) @@ -33592,6 +43057,7 @@ public bool fnTSAttachable_detachObject (string tsattachable, string obj) } /// /// Returns the attachment at the passed index value.) +/// /// public string fnTSAttachable_getAttachment (string tsattachable, int index) @@ -33609,6 +43075,7 @@ public string fnTSAttachable_getAttachment (string tsattachable, int index) } /// /// Returns the number of objects that are currently attached.) +/// /// public int fnTSAttachable_getNumAttachments (string tsattachable) @@ -33622,7 +43089,25 @@ public int fnTSAttachable_getNumAttachments (string tsattachable) return SafeNativeMethods.mwle_fnTSAttachable_getNumAttachments(sbtsattachable); } /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void fnTSDynamic_changeMaterial (string tsdynamic, string mapTo, string oldMat, string newMat) @@ -33645,7 +43130,15 @@ public void fnTSDynamic_changeMaterial (string tsdynamic, string mapTo, string o SafeNativeMethods.mwle_fnTSDynamic_changeMaterial(sbtsdynamic, sbmapTo, sboldMat, sbnewMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string fnTSDynamic_getModelFile (string tsdynamic) @@ -33662,7 +43155,10 @@ public string fnTSDynamic_getModelFile (string tsdynamic) } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int fnTSDynamic_getTargetCount (string tsdynamic) @@ -33676,7 +43172,11 @@ public int fnTSDynamic_getTargetCount (string tsdynamic) return SafeNativeMethods.mwle_fnTSDynamic_getTargetCount(sbtsdynamic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string fnTSDynamic_getTargetName (string tsdynamic, int index) @@ -33694,6 +43194,7 @@ public string fnTSDynamic_getTargetName (string tsdynamic, int index) } /// /// Returns the looping state for the shape.) +/// /// public bool fnTSPathShape_getLooping (string tspathshape) @@ -33708,6 +43209,7 @@ public bool fnTSPathShape_getLooping (string tspathshape) } /// /// Returns the number of nodes on the shape's path.) +/// /// public int fnTSPathShape_getNodeCount (string tspathshape) @@ -33722,6 +43224,7 @@ public int fnTSPathShape_getNodeCount (string tspathshape) } /// /// Get the current position of the shape along the path (0.0 - lastNode - 1).) +/// /// public float fnTSPathShape_getPathPosition (string tspathshape) @@ -33735,7 +43238,12 @@ public float fnTSPathShape_getPathPosition (string tspathshape) return SafeNativeMethods.mwle_fnTSPathShape_getPathPosition(sbtspathshape); } /// -/// Removes the knot at the front of the shape's path. @tsexample // Remove the first knot in the shape's path. %pathShape.popFront(); @endtsexample) +/// Removes the knot at the front of the shape's path. +/// @tsexample +/// // Remove the first knot in the shape's path. +/// %pathShape.popFront(); +/// @endtsexample) +/// /// public void fnTSPathShape_popFront (string tspathshape) @@ -33749,7 +43257,25 @@ public void fnTSPathShape_popFront (string tspathshape) SafeNativeMethods.mwle_fnTSPathShape_popFront(sbtspathshape); } /// -/// Normal, Linear), @brief Adds a new knot to the back of a shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\" // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the back of its path %pathShape.pushBack(%transform,%speed,%type,%path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the back of a shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X Pos_Y Pos_Z Rot_X Rot_Y Rot_Z Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\" +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the back of its path +/// %pathShape.pushBack(%transform,%speed,%type,%path); +/// @endtsexample) +/// /// public void fnTSPathShape_pushBack (string tspathshape, string transform, float speed, string type, string path) @@ -33772,7 +43298,25 @@ public void fnTSPathShape_pushBack (string tspathshape, string transform, float SafeNativeMethods.mwle_fnTSPathShape_pushBack(sbtspathshape, sbtransform, speed, sbtype, sbpath); } /// -/// Normal, Linear), @brief Adds a new knot to the front of a path shape's path. @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() @param speed Speed setting for this knot. @param type Knot type (Normal, Position Only, Kink). @param path %Path type (Linear, Spline). @tsexample // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" // Speed setting for knot. %speed = \"1.0\"; // Knot type. (Normal, Position Only, Kink) %type = \"Normal\"; // Path Type. (Linear, Spline) %path = \"Linear\"; // Inform the shape to add a new knot to the front of its path %pathShape.pushFront(%transform, %speed, %type, %path); @endtsexample) +/// Normal, Linear), +/// @brief Adds a new knot to the front of a path shape's path. +/// @param transform Transform for the new knot. In the form of \"x y z ax ay az aa\" such as returned by SceneObject::getTransform() +/// @param speed Speed setting for this knot. +/// @param type Knot type (Normal, Position Only, Kink). +/// @param path %Path type (Linear, Spline). +/// @tsexample +/// // Transform vector for new knot. (Pos_X,Pos_Y,Pos_Z,Rot_X,Rot_Y,Rot_Z,Angle) +/// %transform = \"15.0 5.0 5.0 1.4 1.0 0.2 1.0\" +/// // Speed setting for knot. +/// %speed = \"1.0\"; +/// // Knot type. (Normal, Position Only, Kink) +/// %type = \"Normal\"; +/// // Path Type. (Linear, Spline) +/// %path = \"Linear\"; +/// // Inform the shape to add a new knot to the front of its path +/// %pathShape.pushFront(%transform, %speed, %type, %path); +/// @endtsexample) +/// /// public void fnTSPathShape_pushFront (string tspathshape, string transform, float speed, string type, string path) @@ -33795,7 +43339,13 @@ public void fnTSPathShape_pushFront (string tspathshape, string transform, float SafeNativeMethods.mwle_fnTSPathShape_pushFront(sbtspathshape, sbtransform, speed, sbtype, sbpath); } /// -/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. When makeFirstKnot is true a new knot is created and pushed onto the path. @param speed Speed for the first knot if created. @param makeFirstKnot Initialize a new path with the current shape transform. @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// @brief Clear the shapes's path and optionally initializes the first node with the shapes current transform and speed. +/// The shapes movement is stopped and any current path is cleared. The target and position values are both reset to 0. +/// When makeFirstKnot is true a new knot is created and pushed onto the path. +/// @param speed Speed for the first knot if created. +/// @param makeFirstKnot Initialize a new path with the current shape transform. +/// @param initFromPath Initialize the knot type and smoothing values from the current path.) +/// /// public void fnTSPathShape_reset (string tspathshape, float speed, bool makeFirstKnot, bool initFromPath) @@ -33809,7 +43359,9 @@ public void fnTSPathShape_reset (string tspathshape, float speed, bool makeFirst SafeNativeMethods.mwle_fnTSPathShape_reset(sbtspathshape, speed, makeFirstKnot, initFromPath); } /// -/// Sets whether the path should loop or stop at the last node. @param isLooping New loop flag true/false.) +/// Sets whether the path should loop or stop at the last node. +/// @param isLooping New loop flag true/false.) +/// /// public void fnTSPathShape_setLooping (string tspathshape, bool isLooping) @@ -33823,7 +43375,9 @@ public void fnTSPathShape_setLooping (string tspathshape, bool isLooping) SafeNativeMethods.mwle_fnTSPathShape_setLooping(sbtspathshape, isLooping); } /// -/// Set the movement state for this shape. @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// Set the movement state for this shape. +/// @param newState New movement state type for this shape. Forward, Backward or Stop.) +/// /// public void fnTSPathShape_setMoveState (string tspathshape, int newState) @@ -33837,7 +43391,9 @@ public void fnTSPathShape_setMoveState (string tspathshape, int newState) SafeNativeMethods.mwle_fnTSPathShape_setMoveState(sbtspathshape, newState); } /// -/// Set the current position of the shape along the path. @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// Set the current position of the shape along the path. +/// @param position Position along the path, from 0.0 (path start) - 1.0 (path end), to place the shape.) +/// /// public void fnTSPathShape_setPathPosition (string tspathshape, float position) @@ -33851,7 +43407,13 @@ public void fnTSPathShape_setPathPosition (string tspathshape, float position) SafeNativeMethods.mwle_fnTSPathShape_setPathPosition(sbtspathshape, position); } /// -/// @brief Set the movement target for this shape along its path. The shape will attempt to move along the path to the given target without going past the loop node. Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target state will be cleared. @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the shape to move to along its path.) +/// @brief Set the movement target for this shape along its path. +/// The shape will attempt to move along the path to the given target without going past the loop node. +/// Once the shape arrives at the target,the onTargetReached() callback will be triggered and the target +/// state will be cleared. +/// @param position Target position, between 0.0 (path start) and nodeCount - 1 (path end), for the +/// shape to move to along its path.) +/// /// public void fnTSPathShape_setTarget (string tspathshape, float position) @@ -33865,7 +43427,32 @@ public void fnTSPathShape_setTarget (string tspathshape, float position) SafeNativeMethods.mwle_fnTSPathShape_setTarget(sbtspathshape, position); } /// -/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls may optionally be converted to boxes, spheres and/or capsules based on their volume. @param size size for this detail level @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, 26-dop, convex hulls. See the Shape Editor documentation for more details about these types. @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the whole shape), or the name of an object in the shape @param depth maximum split recursion depth (hulls only) @param merge volume % threshold used to merge hulls together (hulls only) @param concavity volume % threshold used to detect concavity (hulls only) @param maxVerts maximum number of vertices per hull (hulls only) @param boxMaxError max % volume difference for a hull to be converted to a box (hulls only) @param sphereMaxError max % volume difference for a hull to be converted to a sphere (hulls only) @param capsuleMaxError max % volume difference for a hull to be converted to a capsule (hulls only) @return true if successful, false otherwise @tsexample %this.addCollisionDetail( -1, \"box\", \"bounds\" ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); @endtsexample ) +/// Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls +/// may optionally be converted to boxes, spheres and/or capsules based on their +/// volume. +/// @param size size for this detail level +/// @param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, +/// 26-dop, convex hulls. See the Shape Editor documentation for more details +/// about these types. +/// @param target geometry to fit collision mesh(es) to; either \"bounds\" (for the +/// whole shape), or the name of an object in the shape +/// @param depth maximum split recursion depth (hulls only) +/// @param merge volume % threshold used to merge hulls together (hulls only) +/// @param concavity volume % threshold used to detect concavity (hulls only) +/// @param maxVerts maximum number of vertices per hull (hulls only) +/// @param boxMaxError max % volume difference for a hull to be converted to a +/// box (hulls only) +/// @param sphereMaxError max % volume difference for a hull to be converted to +/// a sphere (hulls only) +/// @param capsuleMaxError max % volume difference for a hull to be converted to +/// a capsule (hulls only) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addCollisionDetail( -1, \"box\", \"bounds\" ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 ); +/// %this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addCollisionDetail (string tsshapeconstructor, int size, string type, string target, int depth, float merge, float concavity, int maxVerts, float boxMaxError, float sphereMaxError, float capsuleMaxError) @@ -33885,7 +43472,35 @@ public bool fnTSShapeConstructor_addCollisionDetail (string tsshapeconstructor, return SafeNativeMethods.mwle_fnTSShapeConstructor_addCollisionDetail(sbtsshapeconstructor, size, sbtype, sbtarget, depth, merge, concavity, maxVerts, boxMaxError, sphereMaxError, capsuleMaxError)>=1; } /// -/// Add (or edit) an imposter detail level to the shape. If the shape already contains an imposter detail level, this command will simply change the imposter settings @param size size of the imposter detail level @param equatorSteps defines the number of snapshots to take around the equator. Imagine the object being rotated around the vertical axis, then a snapshot taken at regularly spaced intervals. @param polarSteps defines the number of snapshots taken between the poles (top and bottom), at each equator step. eg. At each equator snapshot, snapshots are taken at regular intervals between the poles. @param dl the detail level to use when generating the snapshots. Note that this is an array index rather than a detail size. So if an object has detail sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots using detail size 150. @param dim defines the size of the imposter images in pixels. The larger the number, the more detailed the billboard will be. @param includePoles flag indicating whether to include the \"pole\" snapshots. ie. the views from the top and bottom of the object. @param polar_angle if pole snapshots are active (@a includePoles is true), this parameter defines the camera angle (in degrees) within which to render the pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot taken at the pole (looking directly down or up at the object) will be rendered when the camera is within 25 degrees of the pole. @return true if successful, false otherwise @tsexample %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level @endtsexample ) +/// Add (or edit) an imposter detail level to the shape. +/// If the shape already contains an imposter detail level, this command will +/// simply change the imposter settings +/// @param size size of the imposter detail level +/// @param equatorSteps defines the number of snapshots to take around the +/// equator. Imagine the object being rotated around the vertical axis, then +/// a snapshot taken at regularly spaced intervals. +/// @param polarSteps defines the number of snapshots taken between the poles +/// (top and bottom), at each equator step. eg. At each equator snapshot, +/// snapshots are taken at regular intervals between the poles. +/// @param dl the detail level to use when generating the snapshots. Note that +/// this is an array index rather than a detail size. So if an object has detail +/// sizes of: 200, 150, and 40, then setting @a dl to 1 will generate the snapshots +/// using detail size 150. +/// @param dim defines the size of the imposter images in pixels. The larger the +/// number, the more detailed the billboard will be. +/// @param includePoles flag indicating whether to include the \"pole\" snapshots. +/// ie. the views from the top and bottom of the object. +/// @param polar_angle if pole snapshots are active (@a includePoles is true), this +/// parameter defines the camera angle (in degrees) within which to render the +/// pole snapshot. eg. if polar_angle is set to 25 degrees, then the snapshot +/// taken at the pole (looking directly down or up at the object) will be rendered +/// when the camera is within 25 degrees of the pole. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addImposter( 2, 4, 0, 0, 64, false, 0 ); +/// %this.addImposter( 2, 4, 2, 0, 64, true, 10 ); // this command would edit the existing imposter detail level +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_addImposter (string tsshapeconstructor, int size, int equatorSteps, int polarSteps, int dl, int dim, bool includePoles, float polarAngle) @@ -33899,7 +43514,21 @@ public int fnTSShapeConstructor_addImposter (string tsshapeconstructor, int size return SafeNativeMethods.mwle_fnTSShapeConstructor_addImposter(sbtsshapeconstructor, size, equatorSteps, polarSteps, dl, dim, includePoles, polarAngle); } /// -/// Add geometry from another DTS or DAE shape file into this shape. Any materials required by the source mesh are also copied into this shape.br> @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param srcShape name of a shape file (DTS or DAE) that contains the mesh @param srcMesh the full name (object name + detail size) of the mesh to copy from the DTS/DAE file into this shape/li> @return true if successful, false otherwise @tsexample %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); @endtsexample ) +/// Add geometry from another DTS or DAE shape file into this shape. +/// Any materials required by the source mesh are also copied into this shape.br> +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param srcShape name of a shape file (DTS or DAE) that contains the mesh +/// @param srcMesh the full name (object name + detail size) of the mesh to +/// copy from the DTS/DAE file into this shape/li> +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"ColMesh-1\", \"./collision.dts\", \"ColMesh\", \"Col-1\" ); +/// %this.addMesh( \"SimpleShape10\", \"./testShape.dae\", \"MyMesh2\", ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addMesh (string tsshapeconstructor, string meshName, string srcShape, string srcMesh) @@ -33922,7 +43551,21 @@ public bool fnTSShapeConstructor_addMesh (string tsshapeconstructor, string mesh return SafeNativeMethods.mwle_fnTSShapeConstructor_addMesh(sbtsshapeconstructor, sbmeshName, sbsrcShape, sbsrcMesh)>=1; } /// -/// Add a new node. @param name name for the new node (must not already exist) @param parentName name of an existing node to be the parent of the new node. If empty (\"\"), the new node will be at the root level of the node hierarchy. @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); @endtsexample ) +/// Add a new node. +/// @param name name for the new node (must not already exist) +/// @param parentName name of an existing node to be the parent of the new node. +/// If empty (\"\"), the new node will be at the root level of the node hierarchy. +/// @param txfm (optional) transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addNode( \"Nose\", \"Bip01 Head\", \"0 2 2 0 0 1 0\" ); +/// %this.addNode( \"myRoot\", \"\", \"0 0 4 0 0 1 1.57\" ); +/// %this.addNode( \"Nodes\", \"Bip01 Head\", \"0 2 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addNode (string tsshapeconstructor, string name, string parentName, string txfm, bool isWorld) @@ -33945,7 +43588,29 @@ public bool fnTSShapeConstructor_addNode (string tsshapeconstructor, string name return SafeNativeMethods.mwle_fnTSShapeConstructor_addNode(sbtsshapeconstructor, sbname, sbparentName, sbtxfm, isWorld)>=1; } /// -/// Add a new mesh primitive to the shape. @param meshName full name (object name + detail size) of the new mesh. If no detail size is present at the end of the name, a value of 2 is used.br> An underscore before the number at the end of the name will be interpreted as a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". @param type one of: \"box\", \"sphere\", \"capsule\" @param params mesh primitive parameters: ul> li>for box: \"size_x size_y size_z\"/li> li>for sphere: \"radius\"/li> li>for capsule: \"height radius\"/li> /ul> /ul> @param txfm local transform offset from the node for this mesh @param nodeName name of the node to attach the new mesh to (will change the object's node if adding a new mesh to an existing object) @return true if successful, false otherwise @tsexample %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); @endtsexample ) +/// Add a new mesh primitive to the shape. +/// @param meshName full name (object name + detail size) of the new mesh. If +/// no detail size is present at the end of the name, a value of 2 is used.br> +/// An underscore before the number at the end of the name will be interpreted as +/// a negative sign. eg. \"MyMesh_4\" will be interpreted as \"MyMesh-4\". +/// @param type one of: \"box\", \"sphere\", \"capsule\" +/// @param params mesh primitive parameters: +/// ul> +/// li>for box: \"size_x size_y size_z\"/li> +/// li>for sphere: \"radius\"/li> +/// li>for capsule: \"height radius\"/li> +/// /ul> +/// /ul> +/// @param txfm local transform offset from the node for this mesh +/// @param nodeName name of the node to attach the new mesh to (will change the +/// object's node if adding a new mesh to an existing object) +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addMesh( \"Box4\", \"box\", \"2 4 2\", \"0 2 0 0 0 1 0\", \"eye\" ); +/// %this.addMesh( \"Sphere256\", \"sphere\", \"2\", \"0 0 0 0 0 1 0\", \"root\" ); +/// %this.addMesh( \"MyCapsule-1\", \"capsule\", \"2 5\", \"0 0 2 0 0 1 0\", \"base01\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addPrimitive (string tsshapeconstructor, string meshName, string type, string paramsx, string txfm, string nodeName) @@ -33974,7 +43639,34 @@ public bool fnTSShapeConstructor_addPrimitive (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_addPrimitive(sbtsshapeconstructor, sbmeshName, sbtype, sbparamsx, sbtxfm, sbnodeName)>=1; } /// -/// Add a new sequence to the shape. @param source the name of an existing sequence, or the name of a DTS or DAE shape or DSQ sequence file. When the shape file contains more than one sequence, the desired sequence can be specified by appending the name to the end of the shape file. eg. \"myShape.dts run\" would select the \"run\" sequence from the \"myShape.dts\" file. @param name name of the new sequence @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose rotation to the target shape root pose. @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if the source sequence data has a different root-pose to the target shape, such as if one character was in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by the source sequence have keyframes added, but setting this flag will also add keyframes for nodes that are not animated, but have a different root-pose position to the target shape root pose. @return true if successful, false otherwise @tsexample %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); %this.addSequence( \"./myPlayer.dae run\", \"run\" ); %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end @endtsexample ) +/// Add a new sequence to the shape. +/// @param source the name of an existing sequence, or the name of a DTS or DAE +/// shape or DSQ sequence file. When the shape file contains more than one +/// sequence, the desired sequence can be specified by appending the name to the +/// end of the shape file. eg. \"myShape.dts run\" would select the \"run\" +/// sequence from the \"myShape.dts\" file. +/// @param name name of the new sequence +/// @param start (optional) first frame to copy. Defaults to 0, the first frame in the sequence. +/// @param end (optional) last frame to copy. Defaults to -1, the last frame in the sequence. +/// @param padRot (optional) copy root-pose rotation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually rotated by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose rotation to the target shape root pose. +/// @param padTrans (optional) copy root-pose translation keys for non-animated nodes. This is useful if +/// the source sequence data has a different root-pose to the target shape, such as if one character was +/// in the T pose, and the other had arms at the side. Normally only nodes that are actually moved by +/// the source sequence have keyframes added, but setting this flag will also add keyframes for nodes +/// that are not animated, but have a different root-pose position to the target shape root pose. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addSequence( \"./testShape.dts ambient\", \"ambient\" ); +/// %this.addSequence( \"./myPlayer.dae run\", \"run\" ); +/// %this.addSequence( \"./player_look.dsq\", \"look\", 0, -1 ); // start to end +/// %this.addSequence( \"walk\", \"walk_shortA\", 0, 4 ); // start to frame 4 +/// %this.addSequence( \"walk\", \"walk_shortB\", 4, -1 ); // frame 4 to end +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addSequence (string tsshapeconstructor, string source, string name, int start, int end, bool padRot, bool padTrans) @@ -33994,7 +43686,16 @@ public bool fnTSShapeConstructor_addSequence (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_addSequence(sbtsshapeconstructor, sbsource, sbname, start, end, padRot, padTrans)>=1; } /// -/// Add a new trigger to the sequence. @param name name of the sequence to modify @param keyframe keyframe of the new trigger @param state of the new trigger @return true if successful, false otherwise @tsexample %this.addTrigger( \"walk\", 3, 1 ); %this.addTrigger( \"walk\", 5, -1 ); @endtsexample ) +/// Add a new trigger to the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the new trigger +/// @param state of the new trigger +/// @return true if successful, false otherwise +/// @tsexample +/// %this.addTrigger( \"walk\", 3, 1 ); +/// %this.addTrigger( \"walk\", 5, -1 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_addTrigger (string tsshapeconstructor, string name, int keyframe, int state) @@ -34011,7 +43712,14 @@ public bool fnTSShapeConstructor_addTrigger (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_addTrigger(sbtsshapeconstructor, sbname, keyframe, state)>=1; } /// -/// Dump the shape hierarchy to the console or to a file. Useful for reviewing the result of a series of construction commands. @param filename Destination filename. If not specified, dump to console. @tsexample %this.dumpShape(); // dump to console %this.dumpShape( \"./dump.txt\" ); // dump to file @endtsexample ) +/// Dump the shape hierarchy to the console or to a file. Useful for reviewing +/// the result of a series of construction commands. +/// @param filename Destination filename. If not specified, dump to console. +/// @tsexample +/// %this.dumpShape(); // dump to console +/// %this.dumpShape( \"./dump.txt\" ); // dump to file +/// @endtsexample ) +/// /// public void fnTSShapeConstructor_dumpShape (string tsshapeconstructor, string filename) @@ -34028,7 +43736,9 @@ public void fnTSShapeConstructor_dumpShape (string tsshapeconstructor, string fi SafeNativeMethods.mwle_fnTSShapeConstructor_dumpShape(sbtsshapeconstructor, sbfilename); } /// -/// Get the bounding box for the shape. @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// Get the bounding box for the shape. +/// @return Bounding box \"minX minY minZ maxX maxY maxZ\" ) +/// /// public string fnTSShapeConstructor_getBounds (string tsshapeconstructor) @@ -34045,7 +43755,9 @@ public string fnTSShapeConstructor_getBounds (string tsshapeconstructor) } /// -/// Get the total number of detail levels in the shape. @return the number of detail levels in the shape ) +/// Get the total number of detail levels in the shape. +/// @return the number of detail levels in the shape ) +/// /// public int fnTSShapeConstructor_getDetailLevelCount (string tsshapeconstructor) @@ -34059,7 +43771,15 @@ public int fnTSShapeConstructor_getDetailLevelCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getDetailLevelCount(sbtsshapeconstructor); } /// -/// Get the index of the detail level with a given size. @param size size of the detail level to lookup @return index of the detail level with the desired size, or -1 if no such detail exists @tsexample if ( %this.getDetailLevelSize( 32 ) == -1 ) echo( \"Error: This shape does not have a detail level at size 32\" ); @endtsexample ) +/// Get the index of the detail level with a given size. +/// @param size size of the detail level to lookup +/// @return index of the detail level with the desired size, or -1 if no such +/// detail exists +/// @tsexample +/// if ( %this.getDetailLevelSize( 32 ) == -1 ) +/// echo( \"Error: This shape does not have a detail level at size 32\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getDetailLevelIndex (string tsshapeconstructor, int size) @@ -34073,7 +43793,16 @@ public int fnTSShapeConstructor_getDetailLevelIndex (string tsshapeconstructor, return SafeNativeMethods.mwle_fnTSShapeConstructor_getDetailLevelIndex(sbtsshapeconstructor, size); } /// -/// Get the name of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level name @tsexample // print the names of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getDetailLevelName( %i ) ); @endtsexample ) +/// Get the name of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level name +/// @tsexample +/// // print the names of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getDetailLevelName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getDetailLevelName (string tsshapeconstructor, int index) @@ -34090,7 +43819,16 @@ public string fnTSShapeConstructor_getDetailLevelName (string tsshapeconstructor } /// -/// Get the size of the indexed detail level. @param index detail level index (valid range is 0 - getDetailLevelCount()-1) @return the detail level size @tsexample // print the sizes of all detail levels in the shape %count = %this.getDetailLevelCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); @endtsexample ) +/// Get the size of the indexed detail level. +/// @param index detail level index (valid range is 0 - getDetailLevelCount()-1) +/// @return the detail level size +/// @tsexample +/// // print the sizes of all detail levels in the shape +/// %count = %this.getDetailLevelCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Detail\" @ %i @ \" has size \" @ %this.getDetailLevelSize( %i ) ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getDetailLevelSize (string tsshapeconstructor, int index) @@ -34104,7 +43842,10 @@ public int fnTSShapeConstructor_getDetailLevelSize (string tsshapeconstructor, i return SafeNativeMethods.mwle_fnTSShapeConstructor_getDetailLevelSize(sbtsshapeconstructor, index); } /// -/// Get the index of the imposter (auto-billboard) detail level (if any). @return imposter detail level index, or -1 if the shape does not use imposters. ) +/// Get the index of the imposter (auto-billboard) detail level (if any). +/// @return imposter detail level index, or -1 if the shape does not use +/// imposters. ) +/// /// public int fnTSShapeConstructor_getImposterDetailLevel (string tsshapeconstructor) @@ -34118,7 +43859,26 @@ public int fnTSShapeConstructor_getImposterDetailLevel (string tsshapeconstructo return SafeNativeMethods.mwle_fnTSShapeConstructor_getImposterDetailLevel(sbtsshapeconstructor); } /// -/// Get the settings used to generate imposters for the indexed detail level. @param index index of the detail level to query (does not need to be an imposter detail level @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: dl> dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> dt>eqSteps/dt>dd>number of steps around the equator/dd> dt>pSteps/dt>dd>number of steps between the poles/dd> dt>dl/dt>dd>index of the detail level used to generate imposters/dd> dt>dim/dt>dd>size (in pixels) of each imposter image/dd> dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> dt>angle/dt>dd>angle at which to display pole images/dd> /dl> @tsexample // print the imposter detail level settings %index = %this.getImposterDetailLevel(); if ( %index != -1 ) echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); @endtsexample ) +/// Get the settings used to generate imposters for the indexed detail level. +/// @param index index of the detail level to query (does not need to be an +/// imposter detail level +/// @return string of the form: \"valid eqSteps pSteps dl dim poles angle\", where: +/// dl> +/// dt>valid/dt>dd>1 if this detail level generates imposters, 0 otherwise/dd> +/// dt>eqSteps/dt>dd>number of steps around the equator/dd> +/// dt>pSteps/dt>dd>number of steps between the poles/dd> +/// dt>dl/dt>dd>index of the detail level used to generate imposters/dd> +/// dt>dim/dt>dd>size (in pixels) of each imposter image/dd> +/// dt>poles/dt>dd>1 to include pole images, 0 otherwise/dd> +/// dt>angle/dt>dd>angle at which to display pole images/dd> +/// /dl> +/// @tsexample +/// // print the imposter detail level settings +/// %index = %this.getImposterDetailLevel(); +/// if ( %index != -1 ) +/// echo( \"Imposter settings: \" @ %this.getImposterSettings( %index ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getImposterSettings (string tsshapeconstructor, int index) @@ -34135,7 +43895,13 @@ public string fnTSShapeConstructor_getImposterSettings (string tsshapeconstructo } /// -/// Get the number of meshes (detail levels) for the specified object. @param name name of the object to query @return the number of meshes for this object. @tsexample %count = %this.getMeshCount( \"SimpleShape\" ); @endtsexample ) +/// Get the number of meshes (detail levels) for the specified object. +/// @param name name of the object to query +/// @return the number of meshes for this object. +/// @tsexample +/// %count = %this.getMeshCount( \"SimpleShape\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getMeshCount (string tsshapeconstructor, string name) @@ -34152,7 +43918,14 @@ public int fnTSShapeConstructor_getMeshCount (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_getMeshCount(sbtsshapeconstructor, sbname); } /// -/// Get the name of the material attached to a mesh. Note that only the first material used by the mesh is returned. @param name full name (object name + detail size) of the mesh to query @return name of the material attached to the mesh (suitable for use with the Material mapTo field) @tsexample echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the name of the material attached to a mesh. Note that only the first +/// material used by the mesh is returned. +/// @param name full name (object name + detail size) of the mesh to query +/// @return name of the material attached to the mesh (suitable for use with the Material mapTo field) +/// @tsexample +/// echo( \"Mesh material is \" @ %this.sgetMeshMaterial( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getMeshMaterial (string tsshapeconstructor, string name) @@ -34172,7 +43945,22 @@ public string fnTSShapeConstructor_getMeshMaterial (string tsshapeconstructor, s } /// -/// Get the name of the indexed mesh (detail level) for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh name. @tsexample // print the names of all meshes in the shape %objCount = %this.getObjectCount(); for ( %i = 0; %i %objCount; %i++ ) { %objName = %this.getObjectName( %i ); %meshCount = %this.getMeshCount( %objName ); for ( %j = 0; %j %meshCount; %j++ ) echo( %this.getMeshName( %objName, %j ) ); } @endtsexample ) +/// Get the name of the indexed mesh (detail level) for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh name. +/// @tsexample +/// // print the names of all meshes in the shape +/// %objCount = %this.getObjectCount(); +/// for ( %i = 0; %i %objCount; %i++ ) +/// { +/// %objName = %this.getObjectName( %i ); +/// %meshCount = %this.getMeshCount( %objName ); +/// for ( %j = 0; %j %meshCount; %j++ ) +/// echo( %this.getMeshName( %objName, %j ) ); +/// } +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getMeshName (string tsshapeconstructor, string name, int index) @@ -34192,7 +43980,18 @@ public string fnTSShapeConstructor_getMeshName (string tsshapeconstructor, strin } /// -/// Get the detail level size of the indexed mesh for the specified object. @param name name of the object to query @param index index of the mesh (valid range is 0 - getMeshCount()-1) @return the mesh detail level size. @tsexample // print sizes for all detail levels of this object %objName = \"trunk\"; %count = %this.getMeshCount( %objName ); for ( %i = 0; %i %count; %i++ ) echo( %this.getMeshSize( %objName, %i ) ); @endtsexample ) +/// Get the detail level size of the indexed mesh for the specified object. +/// @param name name of the object to query +/// @param index index of the mesh (valid range is 0 - getMeshCount()-1) +/// @return the mesh detail level size. +/// @tsexample +/// // print sizes for all detail levels of this object +/// %objName = \"trunk\"; +/// %count = %this.getMeshCount( %objName ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getMeshSize( %objName, %i ) ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getMeshSize (string tsshapeconstructor, string name, int index) @@ -34209,7 +44008,16 @@ public int fnTSShapeConstructor_getMeshSize (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_getMeshSize(sbtsshapeconstructor, sbname, index); } /// -/// Get the display type of the mesh. @param name name of the mesh to query @return the string returned is one of: dl>dt>normal/dt>dd>a normal 3D mesh/dd> dt>billboard/dt>dd>a mesh that always faces the camera/dd> dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> @tsexample echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); @endtsexample ) +/// Get the display type of the mesh. +/// @param name name of the mesh to query +/// @return the string returned is one of: +/// dl>dt>normal/dt>dd>a normal 3D mesh/dd> +/// dt>billboard/dt>dd>a mesh that always faces the camera/dd> +/// dt>billboardzaxis/dt>dd>a mesh that always faces the camera in the Z-axis/dd>/dl> +/// @tsexample +/// echo( \"Mesh type is \" @ %this.getMeshType( \"SimpleShape128\" ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getMeshType (string tsshapeconstructor, string name) @@ -34229,7 +44037,13 @@ public string fnTSShapeConstructor_getMeshType (string tsshapeconstructor, strin } /// -/// Get the number of children of this node. @param name name of the node to query. @return the number of child nodes. @tsexample %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the number of children of this node. +/// @param name name of the node to query. +/// @return the number of child nodes. +/// @tsexample +/// %count = %this.getNodeChildCount( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeChildCount (string tsshapeconstructor, string name) @@ -34246,7 +44060,32 @@ public int fnTSShapeConstructor_getNodeChildCount (string tsshapeconstructor, st return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeChildCount(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed child node. @param name name of the parent node to query. @param index index of the child node (valid range is 0 - getNodeChildName()-1). @return the name of the indexed child node. @tsexample function dumpNode( %shape, %name, %indent ) { echo( %indent @ %name ); %count = %shape.getNodeChildCount( %name ); for ( %i = 0; %i %count; %i++ ) dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); } function dumpShape( %shape ) { // recursively dump node hierarchy %count = %shape.getNodeCount(); for ( %i = 0; %i %count; %i++ ) { // dump top level nodes %name = %shape.getNodeName( %i ); if ( %shape.getNodeParentName( %name ) $= ) dumpNode( %shape, %name, \"\" ); } } @endtsexample ) +/// Get the name of the indexed child node. +/// @param name name of the parent node to query. +/// @param index index of the child node (valid range is 0 - getNodeChildName()-1). +/// @return the name of the indexed child node. +/// @tsexample +/// function dumpNode( %shape, %name, %indent ) +/// { +/// echo( %indent @ %name ); +/// %count = %shape.getNodeChildCount( %name ); +/// for ( %i = 0; %i %count; %i++ ) +/// dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ \" \" ); +/// } +/// function dumpShape( %shape ) +/// { +/// // recursively dump node hierarchy +/// %count = %shape.getNodeCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// { +/// // dump top level nodes +/// %name = %shape.getNodeName( %i ); +/// if ( %shape.getNodeParentName( %name ) $= ) +/// dumpNode( %shape, %name, \"\" ); +/// } +/// } +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeChildName (string tsshapeconstructor, string name, int index) @@ -34266,7 +44105,12 @@ public string fnTSShapeConstructor_getNodeChildName (string tsshapeconstructor, } /// -/// Get the total number of nodes in the shape. @return the number of nodes in the shape. @tsexample %count = %this.getNodeCount(); @endtsexample ) +/// Get the total number of nodes in the shape. +/// @return the number of nodes in the shape. +/// @tsexample +/// %count = %this.getNodeCount(); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeCount (string tsshapeconstructor) @@ -34280,7 +44124,14 @@ public int fnTSShapeConstructor_getNodeCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeCount(sbtsshapeconstructor); } /// -/// Get the index of the node. @param name name of the node to lookup. @return the index of the named node, or -1 if no such node exists. @tsexample // get the index of Bip01 Pelvis node in the shape %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); @endtsexample ) +/// Get the index of the node. +/// @param name name of the node to lookup. +/// @return the index of the named node, or -1 if no such node exists. +/// @tsexample +/// // get the index of Bip01 Pelvis node in the shape +/// %index = %this.getNodeIndex( \"Bip01 Pelvis\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeIndex (string tsshapeconstructor, string name) @@ -34297,7 +44148,16 @@ public int fnTSShapeConstructor_getNodeIndex (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeIndex(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed node. @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). @return the name of the indexed node, or \"\" if no such node exists. @tsexample // print the names of all the nodes in the shape %count = %this.getNodeCount(); for (%i = 0; %i %count; %i++) echo(%i SPC %this.getNodeName(%i)); @endtsexample ) +/// Get the name of the indexed node. +/// @param index index of the node to lookup (valid range is 0 - getNodeCount()-1). +/// @return the name of the indexed node, or \"\" if no such node exists. +/// @tsexample +/// // print the names of all the nodes in the shape +/// %count = %this.getNodeCount(); +/// for (%i = 0; %i %count; %i++) +/// echo(%i SPC %this.getNodeName(%i)); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeName (string tsshapeconstructor, int index) @@ -34314,7 +44174,13 @@ public string fnTSShapeConstructor_getNodeName (string tsshapeconstructor, int i } /// -/// Get the number of geometry objects attached to this node. @param name name of the node to query. @return the number of attached objects. @tsexample %count = %this.getNodeObjectCount( \"Bip01 Head\" ); @endtsexample ) +/// Get the number of geometry objects attached to this node. +/// @param name name of the node to query. +/// @return the number of attached objects. +/// @tsexample +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getNodeObjectCount (string tsshapeconstructor, string name) @@ -34331,7 +44197,17 @@ public int fnTSShapeConstructor_getNodeObjectCount (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_getNodeObjectCount(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed object. @param name name of the node to query. @param index index of the object (valid range is 0 - getNodeObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects attached to the node %count = %this.getNodeObjectCount( \"Bip01 Head\" ); for ( %i = 0; %i %count; %i++ ) echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param name name of the node to query. +/// @param index index of the object (valid range is 0 - getNodeObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects attached to the node +/// %count = %this.getNodeObjectCount( \"Bip01 Head\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %this.getNodeObjectName( \"Bip01 Head\", %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeObjectName (string tsshapeconstructor, string name, int index) @@ -34351,7 +44227,14 @@ public string fnTSShapeConstructor_getNodeObjectName (string tsshapeconstructor, } /// -/// Get the name of the node's parent. If the node has no parent (ie. it is at the root level), return an empty string. @param name name of the node to query. @return the name of the node's parent, or \"\" if the node is at the root level @tsexample echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); @endtsexample ) +/// Get the name of the node's parent. If the node has no parent (ie. it is at +/// the root level), return an empty string. +/// @param name name of the node to query. +/// @return the name of the node's parent, or \"\" if the node is at the root level +/// @tsexample +/// echo( \"Bip01 Pelvis parent = \" @ %this.getNodeParentName( \"Bip01 Pelvis \") ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeParentName (string tsshapeconstructor, string name) @@ -34371,7 +44254,16 @@ public string fnTSShapeConstructor_getNodeParentName (string tsshapeconstructor, } /// -/// Get the base (ie. not animated) transform of a node. @param name name of the node to query. @param isWorld true to get the global transform, false (or omitted) to get the local-to-parent transform. @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". @tsexample %ret = %this.getNodeTransform( \"mount0\" ); %this.setNodeTransform( \"mount4\", %ret ); @endtsexample ) +/// Get the base (ie. not animated) transform of a node. +/// @param name name of the node to query. +/// @param isWorld true to get the global transform, false (or omitted) to get +/// the local-to-parent transform. +/// @return the node transform in the form \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\". +/// @tsexample +/// %ret = %this.getNodeTransform( \"mount0\" ); +/// %this.setNodeTransform( \"mount4\", %ret ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getNodeTransform (string tsshapeconstructor, string name, bool isWorld) @@ -34391,7 +44283,12 @@ public string fnTSShapeConstructor_getNodeTransform (string tsshapeconstructor, } /// -/// Get the total number of objects in the shape. @return the number of objects in the shape. @tsexample %count = %this.getObjectCount(); @endtsexample ) +/// Get the total number of objects in the shape. +/// @return the number of objects in the shape. +/// @tsexample +/// %count = %this.getObjectCount(); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getObjectCount (string tsshapeconstructor) @@ -34405,7 +44302,13 @@ public int fnTSShapeConstructor_getObjectCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getObjectCount(sbtsshapeconstructor); } /// -/// Get the index of the first object with the given name. @param name name of the object to get. @return the index of the named object. @tsexample %index = %this.getObjectIndex( \"Head\" ); @endtsexample ) +/// Get the index of the first object with the given name. +/// @param name name of the object to get. +/// @return the index of the named object. +/// @tsexample +/// %index = %this.getObjectIndex( \"Head\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getObjectIndex (string tsshapeconstructor, string name) @@ -34422,7 +44325,16 @@ public int fnTSShapeConstructor_getObjectIndex (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_getObjectIndex(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed object. @param index index of the object to get (valid range is 0 - getObjectCount()-1). @return the name of the indexed object. @tsexample // print the names of all objects in the shape %count = %this.getObjectCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getObjectName( %i ) ); @endtsexample ) +/// Get the name of the indexed object. +/// @param index index of the object to get (valid range is 0 - getObjectCount()-1). +/// @return the name of the indexed object. +/// @tsexample +/// // print the names of all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getObjectName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getObjectName (string tsshapeconstructor, int index) @@ -34439,7 +44351,14 @@ public string fnTSShapeConstructor_getObjectName (string tsshapeconstructor, int } /// -/// Get the name of the node this object is attached to. @param name name of the object to get. @return the name of the attached node, or an empty string if this object is not attached to a node (usually the case for skinned meshes). @tsexample echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); @endtsexample ) +/// Get the name of the node this object is attached to. +/// @param name name of the object to get. +/// @return the name of the attached node, or an empty string if this +/// object is not attached to a node (usually the case for skinned meshes). +/// @tsexample +/// echo( \"Hand is attached to \" @ %this.getObjectNode( \"Hand\" ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getObjectNode (string tsshapeconstructor, string name) @@ -34459,7 +44378,24 @@ public string fnTSShapeConstructor_getObjectNode (string tsshapeconstructor, str } /// -/// Get information about blended sequences. @param name name of the sequence to query @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: dl> dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference frame (empty for blend sequences embedded in DTS files)/dd> dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences embedded in DTS files)/dd> /dl> @note Note that only sequences set to be blends using the setSequenceBlend command will contain the blendSeq and blendFrame information. @tsexample %blendData = %this.getSequenceBlend( \"look\" ); if ( getField( %blendData, 0 ) ) echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); @endtsexample ) +/// Get information about blended sequences. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"isBlend blendSeq blendFrame\", where: +/// dl> +/// dt>blend_flag/dt>dd>a boolean flag indicating whether this sequence is a blend/dd> +/// dt>blend_seq_name/dt>dd>the name of the sequence that contains the reference +/// frame (empty for blend sequences embedded in DTS files)/dd> +/// dt>blend_seq_frame/dt>dd>the blend reference frame (empty for blend sequences +/// embedded in DTS files)/dd> +/// /dl> +/// @note Note that only sequences set to be blends using the setSequenceBlend +/// command will contain the blendSeq and blendFrame information. +/// @tsexample +/// %blendData = %this.getSequenceBlend( \"look\" ); +/// if ( getField( %blendData, 0 ) ) +/// echo( \"look is a blend, reference: \" @ getField( %blendData, 1 ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceBlend (string tsshapeconstructor, string name) @@ -34479,7 +44415,9 @@ public string fnTSShapeConstructor_getSequenceBlend (string tsshapeconstructor, } /// -/// Get the total number of sequences in the shape. @return the number of sequences in the shape ) +/// Get the total number of sequences in the shape. +/// @return the number of sequences in the shape ) +/// /// public int fnTSShapeConstructor_getSequenceCount (string tsshapeconstructor) @@ -34493,7 +44431,14 @@ public int fnTSShapeConstructor_getSequenceCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceCount(sbtsshapeconstructor); } /// -/// Check if this sequence is cyclic (looping). @param name name of the sequence to query @return true if this sequence is cyclic, false if not @tsexample if ( !%this.getSequenceCyclic( \"ambient\" ) ) error( \"ambient sequence is not cyclic!\" ); @endtsexample ) +/// Check if this sequence is cyclic (looping). +/// @param name name of the sequence to query +/// @return true if this sequence is cyclic, false if not +/// @tsexample +/// if ( !%this.getSequenceCyclic( \"ambient\" ) ) +/// error( \"ambient sequence is not cyclic!\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_getSequenceCyclic (string tsshapeconstructor, string name) @@ -34510,7 +44455,13 @@ public bool fnTSShapeConstructor_getSequenceCyclic (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceCyclic(sbtsshapeconstructor, sbname)>=1; } /// -/// Get the number of keyframes in the sequence. @param name name of the sequence to query @return number of keyframes in the sequence @tsexample echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); @endtsexample ) +/// Get the number of keyframes in the sequence. +/// @param name name of the sequence to query +/// @return number of keyframes in the sequence +/// @tsexample +/// echo( \"Run has \" @ %this.getSequenceFrameCount( \"run\" ) @ \" keyframes\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getSequenceFrameCount (string tsshapeconstructor, string name) @@ -34527,7 +44478,16 @@ public int fnTSShapeConstructor_getSequenceFrameCount (string tsshapeconstructor return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceFrameCount(sbtsshapeconstructor, sbname); } /// -/// Get the ground speed of the sequence. @note Note that only the first 2 ground frames of the sequence are examined; the speed is assumed to be constant throughout the sequence. @param name name of the sequence to query @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" @tsexample %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); echo( \"Run moves at \" @ %speed @ \" units per frame\" ); @endtsexample ) +/// Get the ground speed of the sequence. +/// @note Note that only the first 2 ground frames of the sequence are +/// examined; the speed is assumed to be constant throughout the sequence. +/// @param name name of the sequence to query +/// @return string of the form: \"trans.x trans.y trans.z rot.x rot.y rot.z\" +/// @tsexample +/// %speed = VectorLen( getWords( %this.getSequenceGroundSpeed( \"run\" ), 0, 2 ) ); +/// echo( \"Run moves at \" @ %speed @ \" units per frame\" ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceGroundSpeed (string tsshapeconstructor, string name) @@ -34547,7 +44507,15 @@ public string fnTSShapeConstructor_getSequenceGroundSpeed (string tsshapeconstru } /// -/// Find the index of the sequence with the given name. @param name name of the sequence to lookup @return index of the sequence with matching name, or -1 if not found @tsexample // Check if a given sequence exists in the shape if ( %this.getSequenceIndex( \"walk\" ) == -1 ) echo( \"Could not find 'walk' sequence\" ); @endtsexample ) +/// Find the index of the sequence with the given name. +/// @param name name of the sequence to lookup +/// @return index of the sequence with matching name, or -1 if not found +/// @tsexample +/// // Check if a given sequence exists in the shape +/// if ( %this.getSequenceIndex( \"walk\" ) == -1 ) +/// echo( \"Could not find 'walk' sequence\" ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getSequenceIndex (string tsshapeconstructor, string name) @@ -34564,7 +44532,16 @@ public int fnTSShapeConstructor_getSequenceIndex (string tsshapeconstructor, str return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequenceIndex(sbtsshapeconstructor, sbname); } /// -/// Get the name of the indexed sequence. @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) @return the name of the sequence @tsexample // print the name of all sequences in the shape %count = %this.getSequenceCount(); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getSequenceName( %i ) ); @endtsexample ) +/// Get the name of the indexed sequence. +/// @param index index of the sequence to query (valid range is 0 - getSequenceCount()-1) +/// @return the name of the sequence +/// @tsexample +/// // print the name of all sequences in the shape +/// %count = %this.getSequenceCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getSequenceName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceName (string tsshapeconstructor, int index) @@ -34581,7 +44558,10 @@ public string fnTSShapeConstructor_getSequenceName (string tsshapeconstructor, i } /// -/// Get the priority setting of the sequence. @param name name of the sequence to query @return priority value of the sequence ) +/// Get the priority setting of the sequence. +/// @param name name of the sequence to query +/// @return priority value of the sequence ) +/// /// public float fnTSShapeConstructor_getSequencePriority (string tsshapeconstructor, string name) @@ -34598,7 +44578,24 @@ public float fnTSShapeConstructor_getSequencePriority (string tsshapeconstructor return SafeNativeMethods.mwle_fnTSShapeConstructor_getSequencePriority(sbtsshapeconstructor, sbname); } /// -/// Get information about where the sequence data came from. For example, whether it was loaded from an external DSQ file. @param name name of the sequence to query @return TAB delimited string of the form: \"from reserved start end total\", where: dl> dt>from/dt>dd>the source of the animation data, such as the path to a DSQ file, or the name of an existing sequence in the shape. This field will be empty for sequences already embedded in the DTS or DAE file./dd> dt>reserved/dt>dd>reserved value/dd> dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> dt>total/dt>dd>the total number of frames in the source sequence/dd> /dl> @tsexample // print the source for the walk animation echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); @endtsexample ) +/// Get information about where the sequence data came from. +/// For example, whether it was loaded from an external DSQ file. +/// @param name name of the sequence to query +/// @return TAB delimited string of the form: \"from reserved start end total\", where: +/// dl> +/// dt>from/dt>dd>the source of the animation data, such as the path to +/// a DSQ file, or the name of an existing sequence in the shape. This field +/// will be empty for sequences already embedded in the DTS or DAE file./dd> +/// dt>reserved/dt>dd>reserved value/dd> +/// dt>start/dt>dd>the first frame in the source sequence used to create this sequence/dd> +/// dt>end/dt>dd>the last frame in the source sequence used to create this sequence/dd> +/// dt>total/dt>dd>the total number of frames in the source sequence/dd> +/// /dl> +/// @tsexample +/// // print the source for the walk animation +/// echo( \"walk source:\" SPC getField( %this.getSequenceSource( \"walk\" ), 0 ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getSequenceSource (string tsshapeconstructor, string name) @@ -34618,7 +44615,12 @@ public string fnTSShapeConstructor_getSequenceSource (string tsshapeconstructor, } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @tsexample %count = %this.getTargetCount(); @endtsexample ) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @tsexample +/// %count = %this.getTargetCount(); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_getTargetCount (string tsshapeconstructor) @@ -34632,7 +44634,15 @@ public int fnTSShapeConstructor_getTargetCount (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_getTargetCount(sbtsshapeconstructor); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @tsexample %count = %this.getTargetCount(); for ( %i = 0; %i %count; %i++ ) echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); @endtsexample ) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @tsexample +/// %count = %this.getTargetCount(); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( \"Target \" @ %i @ \": \" @ %this.getTargetName( %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getTargetName (string tsshapeconstructor, int index) @@ -34649,7 +44659,17 @@ public string fnTSShapeConstructor_getTargetName (string tsshapeconstructor, int } /// -/// Get information about the indexed trigger @param name name of the sequence to query @param index index of the trigger (valid range is 0 - getTriggerCount()-1) @return string of the form \"frame state\" @tsexample // print all triggers in the sequence %count = %this.getTriggerCount( \"back\" ); for ( %i = 0; %i %count; %i++ ) echo( %i SPC %this.getTrigger( \"back\", %i ) ); @endtsexample ) +/// Get information about the indexed trigger +/// @param name name of the sequence to query +/// @param index index of the trigger (valid range is 0 - getTriggerCount()-1) +/// @return string of the form \"frame state\" +/// @tsexample +/// // print all triggers in the sequence +/// %count = %this.getTriggerCount( \"back\" ); +/// for ( %i = 0; %i %count; %i++ ) +/// echo( %i SPC %this.getTrigger( \"back\", %i ) ); +/// @endtsexample ) +/// /// public string fnTSShapeConstructor_getTrigger (string tsshapeconstructor, string name, int index) @@ -34669,7 +44689,10 @@ public string fnTSShapeConstructor_getTrigger (string tsshapeconstructor, string } /// -/// Get the number of triggers in the specified sequence. @param name name of the sequence to query @return number of triggers in the sequence ) +/// Get the number of triggers in the specified sequence. +/// @param name name of the sequence to query +/// @return number of triggers in the sequence ) +/// /// public int fnTSShapeConstructor_getTriggerCount (string tsshapeconstructor, string name) @@ -34686,7 +44709,9 @@ public int fnTSShapeConstructor_getTriggerCount (string tsshapeconstructor, stri return SafeNativeMethods.mwle_fnTSShapeConstructor_getTriggerCount(sbtsshapeconstructor, sbname); } /// -/// Notify game objects that this shape file has changed, allowing them to update internal data if needed. ) +/// Notify game objects that this shape file has changed, allowing them to update +/// internal data if needed. ) +/// /// public void fnTSShapeConstructor_notifyShapeChanged (string tsshapeconstructor) @@ -34700,7 +44725,13 @@ public void fnTSShapeConstructor_notifyShapeChanged (string tsshapeconstructor) SafeNativeMethods.mwle_fnTSShapeConstructor_notifyShapeChanged(sbtsshapeconstructor); } /// -/// Remove the detail level (including all meshes in the detail level) @param size size of the detail level to remove @return true if successful, false otherwise @tsexample %this.removeDetailLevel( 2 ); @endtsexample ) +/// Remove the detail level (including all meshes in the detail level) +/// @param size size of the detail level to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeDetailLevel( 2 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeDetailLevel (string tsshapeconstructor, int index) @@ -34714,7 +44745,9 @@ public bool fnTSShapeConstructor_removeDetailLevel (string tsshapeconstructor, i return SafeNativeMethods.mwle_fnTSShapeConstructor_removeDetailLevel(sbtsshapeconstructor, index)>=1; } /// -/// () Remove the imposter detail level (if any) from the shape. @return true if successful, false otherwise ) +/// () Remove the imposter detail level (if any) from the shape. +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_removeImposter (string tsshapeconstructor) @@ -34728,7 +44761,14 @@ public bool fnTSShapeConstructor_removeImposter (string tsshapeconstructor) return SafeNativeMethods.mwle_fnTSShapeConstructor_removeImposter(sbtsshapeconstructor)>=1; } /// -/// Remove a mesh from the shape. If all geometry is removed from an object, the object is also removed. @param name full name (object name + detail size) of the mesh to remove @return true if successful, false otherwise @tsexample %this.removeMesh( \"SimpleShape128\" ); @endtsexample ) +/// Remove a mesh from the shape. +/// If all geometry is removed from an object, the object is also removed. +/// @param name full name (object name + detail size) of the mesh to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeMesh( \"SimpleShape128\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeMesh (string tsshapeconstructor, string name) @@ -34745,7 +44785,16 @@ public bool fnTSShapeConstructor_removeMesh (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_removeMesh(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove a node from the shape. The named node is removed from the shape, including from any sequences that use the node. Child nodes and objects attached to the node are re-assigned to the node's parent. @param name name of the node to remove. @return true if successful, false otherwise. @tsexample %this.removeNode( \"Nose\" ); @endtsexample ) +/// Remove a node from the shape. +/// The named node is removed from the shape, including from any sequences that +/// use the node. Child nodes and objects attached to the node are re-assigned +/// to the node's parent. +/// @param name name of the node to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.removeNode( \"Nose\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeNode (string tsshapeconstructor, string name) @@ -34762,7 +44811,16 @@ public bool fnTSShapeConstructor_removeNode (string tsshapeconstructor, string n return SafeNativeMethods.mwle_fnTSShapeConstructor_removeNode(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove an object (including all meshes for that object) from the shape. @param name name of the object to remove. @return true if successful, false otherwise. @tsexample // clear all objects in the shape %count = %this.getObjectCount(); for ( %i = %count-1; %i >= 0; %i-- ) %this.removeObject( %this.getObjectName(%i) ); @endtsexample ) +/// Remove an object (including all meshes for that object) from the shape. +/// @param name name of the object to remove. +/// @return true if successful, false otherwise. +/// @tsexample +/// // clear all objects in the shape +/// %count = %this.getObjectCount(); +/// for ( %i = %count-1; %i >= 0; %i-- ) +/// %this.removeObject( %this.getObjectName(%i) ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeObject (string tsshapeconstructor, string name) @@ -34779,7 +44837,10 @@ public bool fnTSShapeConstructor_removeObject (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_removeObject(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove the sequence from the shape. @param name name of the sequence to remove @return true if successful, false otherwise ) +/// Remove the sequence from the shape. +/// @param name name of the sequence to remove +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_removeSequence (string tsshapeconstructor, string name) @@ -34796,7 +44857,15 @@ public bool fnTSShapeConstructor_removeSequence (string tsshapeconstructor, stri return SafeNativeMethods.mwle_fnTSShapeConstructor_removeSequence(sbtsshapeconstructor, sbname)>=1; } /// -/// Remove a trigger from the sequence. @param name name of the sequence to modify @param keyframe keyframe of the trigger to remove @param state of the trigger to remove @return true if successful, false otherwise @tsexample %this.removeTrigger( \"walk\", 3, 1 ); @endtsexample ) +/// Remove a trigger from the sequence. +/// @param name name of the sequence to modify +/// @param keyframe keyframe of the trigger to remove +/// @param state of the trigger to remove +/// @return true if successful, false otherwise +/// @tsexample +/// %this.removeTrigger( \"walk\", 3, 1 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_removeTrigger (string tsshapeconstructor, string name, int keyframe, int state) @@ -34813,7 +44882,16 @@ public bool fnTSShapeConstructor_removeTrigger (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_removeTrigger(sbtsshapeconstructor, sbname, keyframe, state)>=1; } /// -/// Rename a detail level. @note Note that detail level names must be unique, so this command will fail if there is already a detail level with the desired name @param oldName current name of the detail level @param newName new name of the detail level @return true if successful, false otherwise @tsexample %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); @endtsexample ) +/// Rename a detail level. +/// @note Note that detail level names must be unique, so this command will +/// fail if there is already a detail level with the desired name +/// @param oldName current name of the detail level +/// @param newName new name of the detail level +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameDetailLevel( \"detail-1\", \"collision-1\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameDetailLevel (string tsshapeconstructor, string oldName, string newName) @@ -34833,7 +44911,16 @@ public bool fnTSShapeConstructor_renameDetailLevel (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_renameDetailLevel(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Rename a node. @note Note that node names must be unique, so this command will fail if there is already a node with the desired name @param oldName current name of the node @param newName new name of the node @return true if successful, false otherwise @tsexample %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); @endtsexample ) +/// Rename a node. +/// @note Note that node names must be unique, so this command will fail if +/// there is already a node with the desired name +/// @param oldName current name of the node +/// @param newName new name of the node +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameNode( \"Bip01 L Hand\", \"mount5\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameNode (string tsshapeconstructor, string oldName, string newName) @@ -34853,7 +44940,16 @@ public bool fnTSShapeConstructor_renameNode (string tsshapeconstructor, string o return SafeNativeMethods.mwle_fnTSShapeConstructor_renameNode(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Rename an object. @note Note that object names must be unique, so this command will fail if there is already an object with the desired name @param oldName current name of the object @param newName new name of the object @return true if successful, false otherwise @tsexample %this.renameObject( \"MyBox\", \"Box\" ); @endtsexample ) +/// Rename an object. +/// @note Note that object names must be unique, so this command will fail if +/// there is already an object with the desired name +/// @param oldName current name of the object +/// @param newName new name of the object +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameObject( \"MyBox\", \"Box\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameObject (string tsshapeconstructor, string oldName, string newName) @@ -34873,7 +44969,16 @@ public bool fnTSShapeConstructor_renameObject (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_renameObject(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Rename a sequence. @note Note that sequence names must be unique, so this command will fail if there is already a sequence with the desired name @param oldName current name of the sequence @param newName new name of the sequence @return true if successful, false otherwise @tsexample %this.renameSequence( \"walking\", \"walk\" ); @endtsexample ) +/// Rename a sequence. +/// @note Note that sequence names must be unique, so this command will fail +/// if there is already a sequence with the desired name +/// @param oldName current name of the sequence +/// @param newName new name of the sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.renameSequence( \"walking\", \"walk\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_renameSequence (string tsshapeconstructor, string oldName, string newName) @@ -34893,7 +44998,12 @@ public bool fnTSShapeConstructor_renameSequence (string tsshapeconstructor, stri return SafeNativeMethods.mwle_fnTSShapeConstructor_renameSequence(sbtsshapeconstructor, sboldName, sbnewName)>=1; } /// -/// Save the shape (with all current changes) to a new DTS file. @param filename Destination filename. @tsexample %this.saveShape( \"./myShape.dts\" ); @endtsexample ) +/// Save the shape (with all current changes) to a new DTS file. +/// @param filename Destination filename. +/// @tsexample +/// %this.saveShape( \"./myShape.dts\" ); +/// @endtsexample ) +/// /// public void fnTSShapeConstructor_saveShape (string tsshapeconstructor, string filename) @@ -34910,7 +45020,10 @@ public void fnTSShapeConstructor_saveShape (string tsshapeconstructor, string fi SafeNativeMethods.mwle_fnTSShapeConstructor_saveShape(sbtsshapeconstructor, sbfilename); } /// -/// Set the shape bounds to the given bounding box. @param Bounding box \"minX minY minZ maxX maxY maxZ\" @return true if successful, false otherwise ) +/// Set the shape bounds to the given bounding box. +/// @param Bounding box \"minX minY minZ maxX maxY maxZ\" +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_setBounds (string tsshapeconstructor, string bbox) @@ -34927,7 +45040,16 @@ public bool fnTSShapeConstructor_setBounds (string tsshapeconstructor, string bb return SafeNativeMethods.mwle_fnTSShapeConstructor_setBounds(sbtsshapeconstructor, sbbbox)>=1; } /// -/// Change the size of a detail level. @note Note that detail levels are always sorted in decreasing size order, so this command may cause detail level indices to change. @param index index of the detail level to modify @param newSize new size for the detail level @return new index for this detail level @tsexample %this.setDetailLevelSize( 2, 256 ); @endtsexample ) +/// Change the size of a detail level. +/// @note Note that detail levels are always sorted in decreasing size order, +/// so this command may cause detail level indices to change. +/// @param index index of the detail level to modify +/// @param newSize new size for the detail level +/// @return new index for this detail level +/// @tsexample +/// %this.setDetailLevelSize( 2, 256 ); +/// @endtsexample ) +/// /// public int fnTSShapeConstructor_setDetailLevelSize (string tsshapeconstructor, int index, int newSize) @@ -34941,7 +45063,17 @@ public int fnTSShapeConstructor_setDetailLevelSize (string tsshapeconstructor, i return SafeNativeMethods.mwle_fnTSShapeConstructor_setDetailLevelSize(sbtsshapeconstructor, index, newSize); } /// -/// Set the name of the material attached to the mesh. @param meshName full name (object name + detail size) of the mesh to modify @param matName name of the material to attach. This could be the base name of the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a Material object already defined in script. @return true if successful, false otherwise @tsexample // set the mesh material %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); @endtsexample ) +/// Set the name of the material attached to the mesh. +/// @param meshName full name (object name + detail size) of the mesh to modify +/// @param matName name of the material to attach. This could be the base name of +/// the diffuse texture (eg. \"test_mat\" for \"test_mat.jpg\"), or the name of a +/// Material object already defined in script. +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh material +/// %this.setMeshMaterial( \"SimpleShape128\", \"test_mat\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setMeshMaterial (string tsshapeconstructor, string meshName, string matName) @@ -34961,7 +45093,14 @@ public bool fnTSShapeConstructor_setMeshMaterial (string tsshapeconstructor, str return SafeNativeMethods.mwle_fnTSShapeConstructor_setMeshMaterial(sbtsshapeconstructor, sbmeshName, sbmatName)>=1; } /// -/// Change the detail level size of the named mesh. @param name full name (object name + current size ) of the mesh to modify @param size new detail level size @return true if successful, false otherwise. @tsexample %this.setMeshSize( \"SimpleShape128\", 64 ); @endtsexample ) +/// Change the detail level size of the named mesh. +/// @param name full name (object name + current size ) of the mesh to modify +/// @param size new detail level size +/// @return true if successful, false otherwise. +/// @tsexample +/// %this.setMeshSize( \"SimpleShape128\", 64 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setMeshSize (string tsshapeconstructor, string name, int size) @@ -34978,7 +45117,15 @@ public bool fnTSShapeConstructor_setMeshSize (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_setMeshSize(sbtsshapeconstructor, sbname, size)>=1; } /// -/// Set the display type for the mesh. @param name full name (object name + detail size) of the mesh to modify @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" @return true if successful, false otherwise @tsexample // set the mesh to be a billboard %this.setMeshType( \"SimpleShape64\", \"billboard\" ); @endtsexample ) +/// Set the display type for the mesh. +/// @param name full name (object name + detail size) of the mesh to modify +/// @param type the new type for the mesh: \"normal\", \"billboard\" or \"billboardzaxis\" +/// @return true if successful, false otherwise +/// @tsexample +/// // set the mesh to be a billboard +/// %this.setMeshType( \"SimpleShape64\", \"billboard\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setMeshType (string tsshapeconstructor, string name, string type) @@ -34998,7 +45145,14 @@ public bool fnTSShapeConstructor_setMeshType (string tsshapeconstructor, string return SafeNativeMethods.mwle_fnTSShapeConstructor_setMeshType(sbtsshapeconstructor, sbname, sbtype)>=1; } /// -/// Set the parent of a node. @param name name of the node to modify @param parentName name of the parent node to set (use \"\" to move the node to the root level) @return true if successful, false if failed @tsexample %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); @endtsexample ) +/// Set the parent of a node. +/// @param name name of the node to modify +/// @param parentName name of the parent node to set (use \"\" to move the node to the root level) +/// @return true if successful, false if failed +/// @tsexample +/// %this.setNodeParent( \"Bip01 Pelvis\", \"start01\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setNodeParent (string tsshapeconstructor, string name, string parentName) @@ -35018,7 +45172,20 @@ public bool fnTSShapeConstructor_setNodeParent (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_setNodeParent(sbtsshapeconstructor, sbname, sbparentName)>=1; } /// -/// Set the base transform of a node. That is, the transform of the node when in the root (not-animated) pose. @param name name of the node to modify @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" @param isworld (optional) flag to set the local-to-parent or the global transform. If false, or not specified, the position and orientation are treated as relative to the node's parent. @return true if successful, false otherwise @tsexample %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); @endtsexample ) +/// Set the base transform of a node. That is, the transform of the node when +/// in the root (not-animated) pose. +/// @param name name of the node to modify +/// @param txfm transform string of the form: \"pos.x pos.y pos.z rot.x rot.y rot.z rot.angle\" +/// @param isworld (optional) flag to set the local-to-parent or the global +/// transform. If false, or not specified, the position and orientation are +/// treated as relative to the node's parent. +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setNodeTransform( \"mount0\", \"0 0 1 0 0 1 0\" ); +/// %this.setNodeTransform( \"mount0\", \"0 0 0 0 0 1 1.57\" ); +/// %this.setNodeTransform( \"mount0\", \"1 0 0 0 0 1 0\", true ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setNodeTransform (string tsshapeconstructor, string name, string txfm, bool isWorld) @@ -35038,7 +45205,16 @@ public bool fnTSShapeConstructor_setNodeTransform (string tsshapeconstructor, st return SafeNativeMethods.mwle_fnTSShapeConstructor_setNodeTransform(sbtsshapeconstructor, sbname, sbtxfm, isWorld)>=1; } /// -/// Set the node an object is attached to. When the shape is rendered, the object geometry is rendered at the node's current transform. @param objName name of the object to modify @param nodeName name of the node to attach the object to @return true if successful, false otherwise @tsexample %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); @endtsexample ) +/// Set the node an object is attached to. +/// When the shape is rendered, the object geometry is rendered at the node's +/// current transform. +/// @param objName name of the object to modify +/// @param nodeName name of the node to attach the object to +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setObjectNode( \"Hand\", \"Bip01 LeftHand\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setObjectNode (string tsshapeconstructor, string objName, string nodeName) @@ -35058,7 +45234,19 @@ public bool fnTSShapeConstructor_setObjectNode (string tsshapeconstructor, strin return SafeNativeMethods.mwle_fnTSShapeConstructor_setObjectNode(sbtsshapeconstructor, sbobjName, sbnodeName)>=1; } /// -/// Mark a sequence as a blend or non-blend. A blend sequence is one that will be added on top of any other playing sequences. This is done by storing the animated node transforms relative to a reference frame, rather than as absolute transforms. @param name name of the sequence to modify @param blend true to make the sequence a blend, false for a non-blend @param blendSeq the name of the sequence that contains the blend reference frame @param blendFrame the reference frame in the blendSeq sequence @return true if successful, false otherwise @tsexample %this.setSequenceBlend( \"look\", true, \"root\", 0 ); @endtsexample ) +/// Mark a sequence as a blend or non-blend. +/// A blend sequence is one that will be added on top of any other playing +/// sequences. This is done by storing the animated node transforms relative +/// to a reference frame, rather than as absolute transforms. +/// @param name name of the sequence to modify +/// @param blend true to make the sequence a blend, false for a non-blend +/// @param blendSeq the name of the sequence that contains the blend reference frame +/// @param blendFrame the reference frame in the blendSeq sequence +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceBlend( \"look\", true, \"root\", 0 ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setSequenceBlend (string tsshapeconstructor, string name, bool blend, string blendSeq, int blendFrame) @@ -35078,7 +45266,15 @@ public bool fnTSShapeConstructor_setSequenceBlend (string tsshapeconstructor, st return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequenceBlend(sbtsshapeconstructor, sbname, blend, sbblendSeq, blendFrame)>=1; } /// -/// Mark a sequence as cyclic or non-cyclic. @param name name of the sequence to modify @param cyclic true to make the sequence cyclic, false for non-cyclic @return true if successful, false otherwise @tsexample %this.setSequenceCyclic( \"ambient\", true ); %this.setSequenceCyclic( \"shoot\", false ); @endtsexample ) +/// Mark a sequence as cyclic or non-cyclic. +/// @param name name of the sequence to modify +/// @param cyclic true to make the sequence cyclic, false for non-cyclic +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceCyclic( \"ambient\", true ); +/// %this.setSequenceCyclic( \"shoot\", false ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setSequenceCyclic (string tsshapeconstructor, string name, bool cyclic) @@ -35095,7 +45291,22 @@ public bool fnTSShapeConstructor_setSequenceCyclic (string tsshapeconstructor, s return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequenceCyclic(sbtsshapeconstructor, sbname, cyclic)>=1; } /// -/// Set the translation and rotation ground speed of the sequence. The ground speed of the sequence is set by generating ground transform keyframes. The ground translational and rotational speed is assumed to be constant for the duration of the sequence. Existing ground frames for the sequence (if any) will be replaced. @param name name of the sequence to modify @param transSpeed translational speed (trans.x trans.y trans.z) in Torque units per frame @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in radians per frame. Default is \"0 0 0\" @return true if successful, false otherwise @tsexample %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); @endtsexample ) +/// Set the translation and rotation ground speed of the sequence. +/// The ground speed of the sequence is set by generating ground transform +/// keyframes. The ground translational and rotational speed is assumed to +/// be constant for the duration of the sequence. Existing ground frames for +/// the sequence (if any) will be replaced. +/// @param name name of the sequence to modify +/// @param transSpeed translational speed (trans.x trans.y trans.z) in +/// Torque units per frame +/// @param rotSpeed (optional) rotational speed (rot.x rot.y rot.z) in +/// radians per frame. Default is \"0 0 0\" +/// @return true if successful, false otherwise +/// @tsexample +/// %this.setSequenceGroundSpeed( \"run\", \"5 0 0\" ); +/// %this.setSequenceGroundSpeed( \"spin\", \"0 0 0\", \"4 0 0\" ); +/// @endtsexample ) +/// /// public bool fnTSShapeConstructor_setSequenceGroundSpeed (string tsshapeconstructor, string name, string transSpeed, string rotSpeed) @@ -35118,7 +45329,11 @@ public bool fnTSShapeConstructor_setSequenceGroundSpeed (string tsshapeconstruct return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequenceGroundSpeed(sbtsshapeconstructor, sbname, sbtransSpeed, sbrotSpeed)>=1; } /// -/// Set the sequence priority. @param name name of the sequence to modify @param priority new priority value @return true if successful, false otherwise ) +/// Set the sequence priority. +/// @param name name of the sequence to modify +/// @param priority new priority value +/// @return true if successful, false otherwise ) +/// /// public bool fnTSShapeConstructor_setSequencePriority (string tsshapeconstructor, string name, float priority) @@ -35135,7 +45350,10 @@ public bool fnTSShapeConstructor_setSequencePriority (string tsshapeconstructor, return SafeNativeMethods.mwle_fnTSShapeConstructor_setSequencePriority(sbtsshapeconstructor, sbname, priority)>=1; } /// -/// Write the current change set to a TSShapeConstructor script file. The name of the script file is the same as the model, but with .cs extension. eg. myShape.cs for myShape.dts or myShape.dae. ) +/// Write the current change set to a TSShapeConstructor script file. The +/// name of the script file is the same as the model, but with .cs extension. +/// eg. myShape.cs for myShape.dts or myShape.dae. ) +/// /// public void fnTSShapeConstructor_writeChangeSet (string tsshapeconstructor) @@ -35149,7 +45367,25 @@ public void fnTSShapeConstructor_writeChangeSet (string tsshapeconstructor) SafeNativeMethods.mwle_fnTSShapeConstructor_writeChangeSet(sbtsshapeconstructor); } /// -/// ,NULL,NULL), @brief Change one of the materials on the shape. This method changes materials per mapTo with others. The material that is being replaced is mapped to unmapped_mat as a part of this transition. @note Warning, right now this only sort of works. It doesn't do a live update like it should. @param mapTo the name of the material target to remap (from getTargetName) @param oldMat the old Material that was mapped @param newMat the new Material to map @tsexample // remap the first material in the shape %mapTo = %obj.getTargetName( 0 ); %obj.changeMaterial( %mapTo, 0, MyMaterial ); @endtsexample ) +/// ,NULL,NULL), +/// @brief Change one of the materials on the shape. +/// +/// This method changes materials per mapTo with others. The material that +/// is being replaced is mapped to unmapped_mat as a part of this transition. +/// +/// @note Warning, right now this only sort of works. It doesn't do a live +/// update like it should. +/// +/// @param mapTo the name of the material target to remap (from getTargetName) +/// @param oldMat the old Material that was mapped +/// @param newMat the new Material to map +/// +/// @tsexample +/// // remap the first material in the shape +/// %mapTo = %obj.getTargetName( 0 ); +/// %obj.changeMaterial( %mapTo, 0, MyMaterial ); +/// @endtsexample ) +/// /// public void fnTSStatic_changeMaterial (string tsstatic, string mapTo, string oldMat, string newMat) @@ -35172,7 +45408,15 @@ public void fnTSStatic_changeMaterial (string tsstatic, string mapTo, string old SafeNativeMethods.mwle_fnTSStatic_changeMaterial(sbtsstatic, sbmapTo, sboldMat, sbnewMat); } /// -/// @brief Get the model filename used by this shape. @return the shape filename @tsexample // Acquire the model filename used on this shape. %modelFilename = %obj.getModelFile(); @endtsexample ) +/// @brief Get the model filename used by this shape. +/// +/// @return the shape filename +/// @tsexample +/// // Acquire the model filename used on this shape. +/// %modelFilename = %obj.getModelFile(); +/// @endtsexample +/// ) +/// /// public string fnTSStatic_getModelFile (string tsstatic) @@ -35189,7 +45433,10 @@ public string fnTSStatic_getModelFile (string tsstatic) } /// -/// Get the number of materials in the shape. @return the number of materials in the shape. @see getTargetName()) +/// Get the number of materials in the shape. +/// @return the number of materials in the shape. +/// @see getTargetName()) +/// /// public int fnTSStatic_getTargetCount (string tsstatic) @@ -35203,7 +45450,11 @@ public int fnTSStatic_getTargetCount (string tsstatic) return SafeNativeMethods.mwle_fnTSStatic_getTargetCount(sbtsstatic); } /// -/// Get the name of the indexed shape material. @param index index of the material to get (valid range is 0 - getTargetCount()-1). @return the name of the indexed material. @see getTargetCount()) +/// Get the name of the indexed shape material. +/// @param index index of the material to get (valid range is 0 - getTargetCount()-1). +/// @return the name of the indexed material. +/// @see getTargetCount()) +/// /// public string fnTSStatic_getTargetName (string tsstatic, int index) @@ -35220,7 +45471,9 @@ public string fnTSStatic_getTargetName (string tsstatic, int index) } /// -/// @brief Does the turret respawn after it has been destroyed. @returns True if the turret respawns.) +/// @brief Does the turret respawn after it has been destroyed. +/// @returns True if the turret respawns.) +/// /// public bool fnTurretShape_doRespawn (string turretshape) @@ -35234,7 +45487,9 @@ public bool fnTurretShape_doRespawn (string turretshape) return SafeNativeMethods.mwle_fnTurretShape_doRespawn(sbturretshape)>=1; } /// -/// @brief Get if the turret is allowed to fire through moves. @return True if the turret is allowed to fire through moves. ) +/// @brief Get if the turret is allowed to fire through moves. +/// @return True if the turret is allowed to fire through moves. ) +/// /// public bool fnTurretShape_getAllowManualFire (string turretshape) @@ -35248,7 +45503,9 @@ public bool fnTurretShape_getAllowManualFire (string turretshape) return SafeNativeMethods.mwle_fnTurretShape_getAllowManualFire(sbturretshape)>=1; } /// -/// @brief Get if the turret is allowed to rotate through moves. @return True if the turret is allowed to rotate through moves. ) +/// @brief Get if the turret is allowed to rotate through moves. +/// @return True if the turret is allowed to rotate through moves. ) +/// /// public bool fnTurretShape_getAllowManualRotation (string turretshape) @@ -35262,7 +45519,15 @@ public bool fnTurretShape_getAllowManualRotation (string turretshape) return SafeNativeMethods.mwle_fnTurretShape_getAllowManualRotation(sbturretshape)>=1; } /// -/// @brief Get the name of the turret's current state. The state is one of the following:ul> li>Dead - The TurretShape is destroyed./li> li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> li>Ready - The TurretShape is free to move. The usual state./li>/ul> @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// @brief Get the name of the turret's current state. +/// +/// The state is one of the following:ul> +/// li>Dead - The TurretShape is destroyed./li> +/// li>Mounted - The TurretShape is mounted to an object such as a vehicle./li> +/// li>Ready - The TurretShape is free to move. The usual state./li>/ul> +/// +/// @return The current state; one of: \"Dead\", \"Mounted\", \"Ready\" ) +/// /// public string fnTurretShape_getState (string turretshape) @@ -35279,7 +45544,10 @@ public string fnTurretShape_getState (string turretshape) } /// -/// @brief Get Euler rotation of this turret's heading and pitch nodes. @return the orientation of the turret's heading and pitch nodes in the form of rotations around the X, Y and Z axes in degrees. ) +/// @brief Get Euler rotation of this turret's heading and pitch nodes. +/// @return the orientation of the turret's heading and pitch nodes in the +/// form of rotations around the X, Y and Z axes in degrees. ) +/// /// public string fnTurretShape_getTurretEulerRotation (string turretshape) @@ -35296,7 +45564,9 @@ public string fnTurretShape_getTurretEulerRotation (string turretshape) } /// -/// @brief Set if the turret is allowed to fire through moves. @param allow If true then the turret may be fired through moves.) +/// @brief Set if the turret is allowed to fire through moves. +/// @param allow If true then the turret may be fired through moves.) +/// /// public void fnTurretShape_setAllowManualFire (string turretshape, bool allow) @@ -35310,7 +45580,9 @@ public void fnTurretShape_setAllowManualFire (string turretshape, bool allow) SafeNativeMethods.mwle_fnTurretShape_setAllowManualFire(sbturretshape, allow); } /// -/// @brief Set if the turret is allowed to rotate through moves. @param allow If true then the turret may be rotated through moves.) +/// @brief Set if the turret is allowed to rotate through moves. +/// @param allow If true then the turret may be rotated through moves.) +/// /// public void fnTurretShape_setAllowManualRotation (string turretshape, bool allow) @@ -35324,7 +45596,10 @@ public void fnTurretShape_setAllowManualRotation (string turretshape, bool allow SafeNativeMethods.mwle_fnTurretShape_setAllowManualRotation(sbturretshape, allow); } /// -/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. @param rot The rotation in degrees. The pitch is the X component and the heading is the Z component. The Y component is ignored.) +/// @brief Set Euler rotation of this turret's heading and pitch nodes in degrees. +/// @param rot The rotation in degrees. The pitch is the X component and the +/// heading is the Z component. The Y component is ignored.) +/// /// public void fnTurretShape_setTurretEulerRotation (string turretshape, string rot) @@ -35419,7 +45694,11 @@ public void fnVolumetricFog_SetFogModulation (string volumetricfog, float new_st SafeNativeMethods.mwle_fnVolumetricFog_SetFogModulation(sbvolumetricfog, new_strenght, sbnew_speed1, sbnew_speed2); } /// -/// Attaches an object to this one. @param obj The scene object to attach to us @return true if successful, false if failed. This function will fail if the object passed is invalid or is not located directly above and within RayLength of this shape.) +/// Attaches an object to this one. +/// @param obj The scene object to attach to us +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not located directly above and within RayLength of this shape.) +/// /// public bool fnWalkableShape_attachObject (string walkableshape, string obj) @@ -35436,7 +45715,14 @@ public bool fnWalkableShape_attachObject (string walkableshape, string obj) return SafeNativeMethods.mwle_fnWalkableShape_attachObject(sbwalkableshape, sbobj)>=1; } /// -/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of the objects may be re-attached on the next tick. @tsexample // Dump all riders %attachableObj.UseAutoAttach = false %attachableObj.detachAll(); = false @endtsexample) +/// Detaches all attached objects. Note: if UseAutoAttach is true when this is called, all of +/// the objects may be re-attached on the next tick. +/// @tsexample +/// // Dump all riders +/// %attachableObj.UseAutoAttach = false +/// %attachableObj.detachAll(); = false +/// @endtsexample) +/// /// public void fnWalkableShape_detachAll (string walkableshape) @@ -35450,7 +45736,11 @@ public void fnWalkableShape_detachAll (string walkableshape) SafeNativeMethods.mwle_fnWalkableShape_detachAll(sbwalkableshape); } /// -/// Detaches an object from this one. @param obj The scene object to be detached @return true if successful, false if failed. This function will fail if the object passed is invalid or is not currently attached to this shape.) +/// Detaches an object from this one. +/// @param obj The scene object to be detached +/// @return true if successful, false if failed. This function will fail if the object passed +/// is invalid or is not currently attached to this shape.) +/// /// public bool fnWalkableShape_detachObject (string walkableshape, string obj) @@ -35468,6 +45758,7 @@ public bool fnWalkableShape_detachObject (string walkableshape, string obj) } /// /// Returns the attachment at the passed index value.) +/// /// public string fnWalkableShape_getAttachment (string walkableshape, int index) @@ -35485,6 +45776,7 @@ public string fnWalkableShape_getAttachment (string walkableshape, int index) } /// /// Returns the number of objects that are currently attached.) +/// /// public int fnWalkableShape_getNumAttachments (string walkableshape) @@ -35498,7 +45790,9 @@ public int fnWalkableShape_getNumAttachments (string walkableshape) return SafeNativeMethods.mwle_fnWalkableShape_getNumAttachments(sbwalkableshape); } /// -/// @brief Get the number of wheels on this vehicle. @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// @brief Get the number of wheels on this vehicle. +/// @return the number of wheels (equal to the number of hub nodes defined in the model) ) +/// /// public int fnWheeledVehicle_getWheelCount (string wheeledvehicle) @@ -35512,7 +45806,13 @@ public int fnWheeledVehicle_getWheelCount (string wheeledvehicle) return SafeNativeMethods.mwle_fnWheeledVehicle_getWheelCount(sbwheeledvehicle); } /// -/// @brief Set whether the wheel is powered (has torque applied from the engine). A rear wheel drive car for example would set the front wheels to false, and the rear wheels to true. @param wheel index of the wheel to set (hub node #) @param powered flag indicating whether to power the wheel or not @return true if successful, false if failed ) +/// @brief Set whether the wheel is powered (has torque applied from the engine). +/// A rear wheel drive car for example would set the front wheels to false, +/// and the rear wheels to true. +/// @param wheel index of the wheel to set (hub node #) +/// @param powered flag indicating whether to power the wheel or not +/// @return true if successful, false if failed ) +/// /// public bool fnWheeledVehicle_setWheelPowered (string wheeledvehicle, int wheel, bool powered) @@ -35526,7 +45826,14 @@ public bool fnWheeledVehicle_setWheelPowered (string wheeledvehicle, int wheel, return SafeNativeMethods.mwle_fnWheeledVehicle_setWheelPowered(sbwheeledvehicle, wheel, powered)>=1; } /// -/// @brief Set the WheeledVehicleSpring datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param spring WheeledVehicleSpring datablock @return true if successful, false if failed @tsexample %obj.setWheelSpring( 0, FrontSpring ); @endtsexample ) +/// @brief Set the WheeledVehicleSpring datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param spring WheeledVehicleSpring datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelSpring( 0, FrontSpring ); +/// @endtsexample ) +/// /// public bool fnWheeledVehicle_setWheelSpring (string wheeledvehicle, int wheel, string spring) @@ -35543,7 +45850,16 @@ public bool fnWheeledVehicle_setWheelSpring (string wheeledvehicle, int wheel, s return SafeNativeMethods.mwle_fnWheeledVehicle_setWheelSpring(sbwheeledvehicle, wheel, sbspring)>=1; } /// -/// @brief Set how much the wheel is affected by steering. The steering factor controls how much the wheel is rotated by the vehicle steering. For example, most cars would have their front wheels set to 1.0, and their rear wheels set to 0 since only the front wheels should turn. Negative values will turn the wheel in the opposite direction to the steering angle. @param wheel index of the wheel to set (hub node #) @param steering steering factor from -1 (full inverse) to 1 (full) @return true if successful, false if failed ) +/// @brief Set how much the wheel is affected by steering. +/// The steering factor controls how much the wheel is rotated by the vehicle +/// steering. For example, most cars would have their front wheels set to 1.0, +/// and their rear wheels set to 0 since only the front wheels should turn. +/// Negative values will turn the wheel in the opposite direction to the steering +/// angle. +/// @param wheel index of the wheel to set (hub node #) +/// @param steering steering factor from -1 (full inverse) to 1 (full) +/// @return true if successful, false if failed ) +/// /// public bool fnWheeledVehicle_setWheelSteering (string wheeledvehicle, int wheel, float steering) @@ -35557,7 +45873,14 @@ public bool fnWheeledVehicle_setWheelSteering (string wheeledvehicle, int wheel, return SafeNativeMethods.mwle_fnWheeledVehicle_setWheelSteering(sbwheeledvehicle, wheel, steering)>=1; } /// -/// @brief Set the WheeledVehicleTire datablock for this wheel. @param wheel index of the wheel to set (hub node #) @param tire WheeledVehicleTire datablock @return true if successful, false if failed @tsexample %obj.setWheelTire( 0, FrontTire ); @endtsexample ) +/// @brief Set the WheeledVehicleTire datablock for this wheel. +/// @param wheel index of the wheel to set (hub node #) +/// @param tire WheeledVehicleTire datablock +/// @return true if successful, false if failed +/// @tsexample +/// %obj.setWheelTire( 0, FrontTire ); +/// @endtsexample ) +/// /// public bool fnWheeledVehicle_setWheelTire (string wheeledvehicle, int wheel, string tire) @@ -35575,6 +45898,7 @@ public bool fnWheeledVehicle_setWheelTire (string wheeledvehicle, int wheel, str } /// /// Create a ConvexShape from the given polyhedral object. ) +/// /// public string fnWorldEditor_createConvexShapeFrom (string worldeditor, string polyObject) @@ -35595,6 +45919,7 @@ public string fnWorldEditor_createConvexShapeFrom (string worldeditor, string po } /// /// Grab the geometry from @a geometryProvider, create a @a className object, and assign it the extracted geometry. ) +/// /// public string fnWorldEditor_createPolyhedralObject (string worldeditor, string className, string geometryProvider) @@ -35618,6 +45943,7 @@ public string fnWorldEditor_createPolyhedralObject (string worldeditor, string c } /// /// Get the soft snap alignment. ) +/// /// public int fnWorldEditor_getSoftSnapAlignment (string worldeditor) @@ -35632,6 +45958,7 @@ public int fnWorldEditor_getSoftSnapAlignment (string worldeditor) } /// /// Get the terrain snap alignment. ) +/// /// public int fnWorldEditor_getTerrainSnapAlignment (string worldeditor) @@ -35646,6 +45973,7 @@ public int fnWorldEditor_getTerrainSnapAlignment (string worldeditor) } /// /// ( WorldEditor, ignoreObjClass, void, 3, 0, (string class_name, ...)) +/// /// public void fnWorldEditor_ignoreObjClass (string worldeditor, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10, string a11, string a12, string a13, string a14, string a15, string a16, string a17, string a18, string a19) @@ -35714,6 +46042,7 @@ public void fnWorldEditor_ignoreObjClass (string worldeditor, string a2, string } /// /// Set the soft snap alignment. ) +/// /// public void fnWorldEditor_setSoftSnapAlignment (string worldeditor, int type) @@ -35728,6 +46057,7 @@ public void fnWorldEditor_setSoftSnapAlignment (string worldeditor, int type) } /// /// Set the terrain snap alignment. ) +/// /// public void fnWorldEditor_setTerrainSnapAlignment (string worldeditor, int alignment) @@ -35742,6 +46072,7 @@ public void fnWorldEditor_setTerrainSnapAlignment (string worldeditor, int align } /// /// ( WorldEditorSelection, containsGlobalBounds, bool, 2, 2, () - True if an object with global bounds is contained in the selection. ) +/// /// public bool fnWorldEditorSelection_containsGlobalBounds (string worldeditorselection) @@ -35756,6 +46087,7 @@ public bool fnWorldEditorSelection_containsGlobalBounds (string worldeditorselec } /// /// ( WorldEditorSelection, getBoxCentroid, const char*, 2, 2, () - Return the center of the bounding box around the selection. ) +/// /// public string fnWorldEditorSelection_getBoxCentroid (string worldeditorselection) @@ -35773,6 +46105,7 @@ public string fnWorldEditorSelection_getBoxCentroid (string worldeditorselection } /// /// ( WorldEditorSelection, getCentroid, const char*, 2, 2, () - Return the median of all object positions in the selection. ) +/// /// public string fnWorldEditorSelection_getCentroid (string worldeditorselection) @@ -35790,6 +46123,7 @@ public string fnWorldEditorSelection_getCentroid (string worldeditorselection) } /// /// ( WorldEditorSelection, offset, void, 3, 4, ( vector delta, float gridSnap=0 ) - Move all objects in the selection by the given delta. ) +/// /// public void fnWorldEditorSelection_offset (string worldeditorselection, string a2, string a3) @@ -35810,6 +46144,7 @@ public void fnWorldEditorSelection_offset (string worldeditorselection, string a } /// /// ( WorldEditorSelection, subtract, void, 3, 3, ( SimSet ) - Remove all objects in the given set from this selection. ) +/// /// public void fnWorldEditorSelection_subtract (string worldeditorselection, string a2) @@ -35827,6 +46162,7 @@ public void fnWorldEditorSelection_subtract (string worldeditorselection, string } /// /// ( WorldEditorSelection, union, void, 3, 3, ( SimSet set ) - Add all objects in the given set to this selection. ) +/// /// public void fnWorldEditorSelection_union (string worldeditorselection, string a2) @@ -35843,7 +46179,14 @@ public void fnWorldEditorSelection_union (string worldeditorselection, string a2 SafeNativeMethods.mwle_fnWorldEditorSelection_union(sbworldeditorselection, sba2); } /// -/// @brief Add a file to the zip archive @param filename The path and name of the file to add to the zip archive. @param pathInZip The path and name to be given to the file within the zip archive. @param replace If a file already exists within the zip archive at the same location as this new file, this parameter indicates if it should be replaced. By default, it will be replaced. @return True if the file was successfully added to the zip archive.) +/// @brief Add a file to the zip archive +/// +/// @param filename The path and name of the file to add to the zip archive. +/// @param pathInZip The path and name to be given to the file within the zip archive. +/// @param replace If a file already exists within the zip archive at the same location as this +/// new file, this parameter indicates if it should be replaced. By default, it will be replaced. +/// @return True if the file was successfully added to the zip archive.) +/// /// public bool fnZipObject_addFile (string zipobject, string filename, string pathInZip, bool replace) @@ -35863,7 +46206,9 @@ public bool fnZipObject_addFile (string zipobject, string filename, string pathI return SafeNativeMethods.mwle_fnZipObject_addFile(sbzipobject, sbfilename, sbpathInZip, replace)>=1; } /// -/// @brief Close an already opened zip archive. @see openArchive()) +/// @brief Close an already opened zip archive. +/// @see openArchive()) +/// /// public void fnZipObject_closeArchive (string zipobject) @@ -35877,7 +46222,11 @@ public void fnZipObject_closeArchive (string zipobject) SafeNativeMethods.mwle_fnZipObject_closeArchive(sbzipobject); } /// -/// @brief Close a previously opened file within the zip archive. @param stream The StreamObject of a previously opened file within the zip archive. @see openFileForRead() @see openFileForWrite()) +/// @brief Close a previously opened file within the zip archive. +/// @param stream The StreamObject of a previously opened file within the zip archive. +/// @see openFileForRead() +/// @see openFileForWrite()) +/// /// public void fnZipObject_closeFile (string zipobject, string stream) @@ -35894,7 +46243,19 @@ public void fnZipObject_closeFile (string zipobject, string stream) SafeNativeMethods.mwle_fnZipObject_closeFile(sbzipobject, sbstream); } /// -/// @brief Deleted the given file from the zip archive @param pathInZip The path and name of the file to be deleted from the zip archive. @return True of the file was successfully deleted. @note Files that have been deleted from the archive will still show up with a getFileEntryCount() until you close the archive. If you need to have the file count up to date with only valid files within the archive, you could close and then open the archive again. @see getFileEntryCount() @see closeArchive() @see openArchive()) +/// @brief Deleted the given file from the zip archive +/// @param pathInZip The path and name of the file to be deleted from the zip archive. +/// @return True of the file was successfully deleted. +/// +/// @note Files that have been deleted from the archive will still show up with a +/// getFileEntryCount() until you close the archive. If you need to have the file +/// count up to date with only valid files within the archive, you could close and then +/// open the archive again. +/// +/// @see getFileEntryCount() +/// @see closeArchive() +/// @see openArchive()) +/// /// public bool fnZipObject_deleteFile (string zipobject, string pathInZip) @@ -35911,7 +46272,11 @@ public bool fnZipObject_deleteFile (string zipobject, string pathInZip) return SafeNativeMethods.mwle_fnZipObject_deleteFile(sbzipobject, sbpathInZip)>=1; } /// -/// @brief Extact a file from the zip archive and save it to the requested location. @param pathInZip The path and name of the file to be extracted within the zip archive. @param filename The path and name to give the extracted file. @return True if the file was successfully extracted.) +/// @brief Extact a file from the zip archive and save it to the requested location. +/// @param pathInZip The path and name of the file to be extracted within the zip archive. +/// @param filename The path and name to give the extracted file. +/// @return True if the file was successfully extracted.) +/// /// public bool fnZipObject_extractFile (string zipobject, string pathInZip, string filename) @@ -35931,7 +46296,22 @@ public bool fnZipObject_extractFile (string zipobject, string pathInZip, string return SafeNativeMethods.mwle_fnZipObject_extractFile(sbzipobject, sbpathInZip, sbfilename)>=1; } /// -/// @brief Get information on the requested file within the zip archive. This methods provides five different pieces of information for the requested file: ul>li>filename - The path and name of the file within the zip archive/li> li>uncompressed size/li> li>compressed size/li> li>compression method/li> li>CRC32/li>/ul> Use getFileEntryCount() to obtain the total number of files within the archive. @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. @see getFileEntryCount()) +/// @brief Get information on the requested file within the zip archive. +/// +/// This methods provides five different pieces of information for the requested file: +/// ul>li>filename - The path and name of the file within the zip archive/li> +/// li>uncompressed size/li> +/// li>compressed size/li> +/// li>compression method/li> +/// li>CRC32/li>/ul> +/// +/// Use getFileEntryCount() to obtain the total number of files within the archive. +/// +/// @param index The index of the file within the zip archive. Use getFileEntryCount() to determine the number of files. +/// @return A tab delimited list of information on the requested file, or an empty string if the file could not be found. +/// +/// @see getFileEntryCount()) +/// /// public string fnZipObject_getFileEntry (string zipobject, int index) @@ -35948,7 +46328,20 @@ public string fnZipObject_getFileEntry (string zipobject, int index) } /// -/// @brief Get the number of files within the zip archive. Use getFileEntry() to retrive information on each file within the archive. @return The number of files within the zip archive. @note The returned count will include any files that have been deleted from the archive using deleteFile(). To clear out all deleted files, you could close and then open the archive again. @see getFileEntry() @see closeArchive() @see openArchive()) +/// @brief Get the number of files within the zip archive. +/// +/// Use getFileEntry() to retrive information on each file within the archive. +/// +/// @return The number of files within the zip archive. +/// +/// @note The returned count will include any files that have been deleted from +/// the archive using deleteFile(). To clear out all deleted files, you could +/// close and then open the archive again. +/// +/// @see getFileEntry() +/// @see closeArchive() +/// @see openArchive()) +/// /// public int fnZipObject_getFileEntryCount (string zipobject) @@ -35962,7 +46355,23 @@ public int fnZipObject_getFileEntryCount (string zipobject) return SafeNativeMethods.mwle_fnZipObject_getFileEntryCount(sbzipobject); } /// -/// read ), @brief Open a zip archive for manipulation. Once a zip archive is opened use the various ZipObject methods for working with the files within the archive. Be sure to close the archive when you are done with it. @param filename The path and file name of the zip archive to open. @param accessMode One of read, write or readwrite @return True is the archive was successfully opened. @note If you wish to make any changes to the archive, be sure to open it with a write or readwrite access mode. @see closeArchive()) +/// read ), +/// @brief Open a zip archive for manipulation. +/// +/// Once a zip archive is opened use the various ZipObject methods for +/// working with the files within the archive. Be sure to close the archive when +/// you are done with it. +/// +/// @param filename The path and file name of the zip archive to open. +/// @param accessMode One of read, write or readwrite +/// +/// @return True is the archive was successfully opened. +/// +/// @note If you wish to make any changes to the archive, be sure to open it +/// with a write or readwrite access mode. +/// +/// @see closeArchive()) +/// /// public bool fnZipObject_openArchive (string zipobject, string filename, string accessMode) @@ -35982,7 +46391,18 @@ public bool fnZipObject_openArchive (string zipobject, string filename, string a return SafeNativeMethods.mwle_fnZipObject_openArchive(sbzipobject, sbfilename, sbaccessMode)>=1; } /// -/// @brief Open a file within the zip archive for reading. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for reading. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string fnZipObject_openFileForRead (string zipobject, string filename) @@ -36002,7 +46422,18 @@ public string fnZipObject_openFileForRead (string zipobject, string filename) } /// -/// @brief Open a file within the zip archive for writing to. Be sure to close the file when you are done with it. @param filename The path and name of the file to open within the zip archive. @return A standard StreamObject is returned for working with the file. @note You must first open the zip archive before working with files within it. @see closeFile() @see openArchive()) +/// @brief Open a file within the zip archive for writing to. +/// +/// Be sure to close the file when you are done with it. +/// +/// @param filename The path and name of the file to open within the zip archive. +/// +/// @return A standard StreamObject is returned for working with the file. +/// @note You must first open the zip archive before working with files within it. +/// +/// @see closeFile() +/// @see openArchive()) +/// /// public string fnZipObject_openFileForWrite (string zipobject, string filename) @@ -36022,7 +46453,11 @@ public string fnZipObject_openFileForWrite (string zipobject, string filename) } /// -/// Dump a list of all objects assigned to the zone to the console as well as a list of all connected zone spaces. @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of objects are updated on demand, the zone contents can be outdated. ) +/// Dump a list of all objects assigned to the zone to the console as well as a list +/// of all connected zone spaces. +/// @param updateFirst Whether to update the contents of the zone before dumping. Since zoning states of +/// objects are updated on demand, the zone contents can be outdated. ) +/// /// public void fnZone_dumpZoneState (string zone, bool updateFirst) @@ -36036,7 +46471,9 @@ public void fnZone_dumpZoneState (string zone, bool updateFirst) SafeNativeMethods.mwle_fnZone_dumpZoneState(sbzone, updateFirst); } /// -/// Get the unique numeric ID of the zone in its scene. @return The ID of the zone. ) +/// Get the unique numeric ID of the zone in its scene. +/// @return The ID of the zone. ) +/// /// public int fnZone_getZoneId (string zone) diff --git a/Templates/C#-Full/Winterleaf.Engine.Omni/Omni.cs b/Templates/C#-Full/Winterleaf.Engine.Omni/Omni.cs index e884697c..50f2c436 100644 --- a/Templates/C#-Full/Winterleaf.Engine.Omni/Omni.cs +++ b/Templates/C#-Full/Winterleaf.Engine.Omni/Omni.cs @@ -304,14 +304,14 @@ private void bwr_InitializeTorque(object sender, DoWorkEventArgs e) SafeNativeMethods.SetUpDynamicDLL(_mDll); } catch (Exception err) - { + { LastError = err; _mStop = true; if (_ScriptExtensions_Allow) csFactory.Instance.StopMonitoring(); return; - } + } //create a list of pointers for our parameters List myp = new List {Marshal.StringToCoTaskMemAnsi(Assembly.GetExecutingAssembly().Location)}; //Add the pointer to a managed memory string containing the location of the Assembly. diff --git a/Templates/C#-Full/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj b/Templates/C#-Full/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj index c6b4a471..fb20969d 100644 --- a/Templates/C#-Full/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj +++ b/Templates/C#-Full/Winterleaf.Engine.Omni/Winterleaf.Engine.csproj @@ -14,10 +14,14 @@ 512 - SAK - SAK - SAK - SAK + + + + + + + + x86 @@ -193,6 +197,15 @@ + + + + + + + + + @@ -206,5 +219,4 @@ - \ No newline at end of file